2 * collectd - src/exec.c
3 * Copyright (C) 2007-2010 Florian octo Forster
4 * Copyright (C) 2007-2009 Sebastian Harl
5 * Copyright (C) 2008 Peter Holik
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at collectd.org>
22 * Sebastian Harl <sh at tokkee.org>
23 * Peter Holik <peter at holik.at>
26 #define _DEFAULT_SOURCE
27 #define _BSD_SOURCE /* For setgroups */
34 #include "utils_cmd_putnotif.h"
35 #include "utils_cmd_putval.h"
40 #include <sys/types.h>
43 #ifdef HAVE_SYS_CAPABILITY_H
44 #include <sys/capability.h>
47 #define PL_NORMAL 0x01
48 #define PL_NOTIF_ACTION 0x02
50 #define PL_RUNNING 0x10
56 * Access to this structure is serialized using the `pl_lock' lock and the
57 * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
58 * all functions used to handle notifications MUST NOT write to this structure.
59 * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
61 * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
63 struct program_list_s;
64 typedef struct program_list_s program_list_t;
65 struct program_list_s {
76 typedef struct program_list_and_notification_s {
79 } program_list_and_notification_t;
84 const long int MAX_GRBUF_SIZE = 65536;
89 static program_list_t *pl_head;
90 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
95 static void sigchld_handler(int __attribute__((unused)) signal) /* {{{ */
99 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
101 for (pl = pl_head; pl != NULL; pl = pl->next)
106 } /* while (waitpid) */
107 } /* void sigchld_handler }}} */
109 static int exec_config_exec(oconfig_item_t *ci) /* {{{ */
115 if (ci->children_num != 0) {
116 WARNING("exec plugin: The config option `%s' may not be a block.", ci->key);
119 if (ci->values_num < 2) {
120 WARNING("exec plugin: The config option `%s' needs at least two "
125 if ((ci->values[0].type != OCONFIG_TYPE_STRING) ||
126 (ci->values[1].type != OCONFIG_TYPE_STRING)) {
127 WARNING("exec plugin: The first two arguments to the `%s' option must "
128 "be string arguments.",
133 pl = calloc(1, sizeof(*pl));
135 ERROR("exec plugin: calloc failed.");
139 if (strcasecmp("NotificationExec", ci->key) == 0)
140 pl->flags |= PL_NOTIF_ACTION;
142 pl->flags |= PL_NORMAL;
144 pl->user = strdup(ci->values[0].value.string);
145 if (pl->user == NULL) {
146 ERROR("exec plugin: strdup failed.");
151 pl->group = strchr(pl->user, ':');
152 if (pl->group != NULL) {
157 pl->exec = strdup(ci->values[1].value.string);
158 if (pl->exec == NULL) {
159 ERROR("exec plugin: strdup failed.");
165 pl->argv = calloc(ci->values_num, sizeof(*pl->argv));
166 if (pl->argv == NULL) {
167 ERROR("exec plugin: calloc failed.");
175 char *tmp = strrchr(ci->values[1].value.string, '/');
177 sstrncpy(buffer, ci->values[1].value.string, sizeof(buffer));
179 sstrncpy(buffer, tmp + 1, sizeof(buffer));
181 pl->argv[0] = strdup(buffer);
182 if (pl->argv[0] == NULL) {
183 ERROR("exec plugin: strdup failed.");
191 for (i = 1; i < (ci->values_num - 1); i++) {
192 if (ci->values[i + 1].type == OCONFIG_TYPE_STRING) {
193 pl->argv[i] = strdup(ci->values[i + 1].value.string);
195 if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER) {
196 snprintf(buffer, sizeof(buffer), "%lf", ci->values[i + 1].value.number);
198 if (ci->values[i + 1].value.boolean)
199 sstrncpy(buffer, "true", sizeof(buffer));
201 sstrncpy(buffer, "false", sizeof(buffer));
204 pl->argv[i] = strdup(buffer);
207 if (pl->argv[i] == NULL) {
208 ERROR("exec plugin: strdup failed.");
213 if (i < (ci->values_num - 1)) {
224 for (i = 0; pl->argv[i] != NULL; i++) {
225 DEBUG("exec plugin: argv[%i] = %s", i, pl->argv[i]);
232 } /* int exec_config_exec }}} */
234 static int exec_config(oconfig_item_t *ci) /* {{{ */
236 for (int i = 0; i < ci->children_num; i++) {
237 oconfig_item_t *child = ci->children + i;
238 if ((strcasecmp("Exec", child->key) == 0) ||
239 (strcasecmp("NotificationExec", child->key) == 0))
240 exec_config_exec(child);
242 WARNING("exec plugin: Unknown config option `%s'.", child->key);
247 } /* int exec_config }}} */
249 static void set_environment(void) /* {{{ */
254 snprintf(buffer, sizeof(buffer), "%.3f",
255 CDTIME_T_TO_DOUBLE(plugin_get_interval()));
256 setenv("COLLECTD_INTERVAL", buffer, /* overwrite = */ 1);
258 sstrncpy(buffer, hostname_g, sizeof(buffer));
259 setenv("COLLECTD_HOSTNAME", buffer, /* overwrite = */ 1);
261 snprintf(buffer, sizeof(buffer), "COLLECTD_INTERVAL=%.3f",
262 CDTIME_T_TO_DOUBLE(plugin_get_interval()));
265 snprintf(buffer, sizeof(buffer), "COLLECTD_HOSTNAME=%s", hostname_g);
268 } /* }}} void set_environment */
270 __attribute__((noreturn)) static void exec_child(program_list_t *pl, int uid,
271 int gid, int egid) /* {{{ */
283 if ((gid != egid) && (egid != -1)) {
288 setgroups(glist_len, glist);
290 #endif /* HAVE_SETGROUPS */
292 status = setgid(gid);
294 ERROR("exec plugin: setgid (%i) failed: %s", gid, STRERRNO);
299 status = setegid(egid);
301 ERROR("exec plugin: setegid (%i) failed: %s", egid, STRERRNO);
306 status = setuid(uid);
308 ERROR("exec plugin: setuid (%i) failed: %s", uid, STRERRNO);
312 execvp(pl->exec, pl->argv);
314 ERROR("exec plugin: Failed to execute ``%s'': %s", pl->exec, STRERRNO);
316 } /* void exec_child }}} */
318 static void reset_signal_mask(void) /* {{{ */
323 sigprocmask(SIG_SETMASK, &ss, /* old mask = */ NULL);
324 } /* }}} void reset_signal_mask */
326 static int create_pipe(int fd_pipe[2]) /* {{{ */
330 status = pipe(fd_pipe);
332 ERROR("exec plugin: pipe failed: %s", STRERRNO);
337 } /* }}} int create_pipe */
339 static void close_pipe(int fd_pipe[2]) /* {{{ */
341 if (fd_pipe[0] != -1)
344 if (fd_pipe[1] != -1)
346 } /* }}} void close_pipe */
349 * Get effective group ID from group name.
351 static int getegr_id(program_list_t *pl, int gid) /* {{{ */
354 if (pl->group != NULL) {
355 if (*pl->group != '\0') {
356 struct group *gr_ptr = NULL;
359 long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
361 grbuf_size = sysconf(_SC_PAGESIZE);
369 int getgr_failed = 0;
370 grbuf = malloc(size);
372 ERROR("exec plugin: get group information for '%s' failed: buffer "
379 while ((status = getgrnam_r(pl->group, &gr, grbuf, size, &gr_ptr)) != 0) {
382 if ((size + grbuf_size) < size ||
383 (size + grbuf_size) > MAX_GRBUF_SIZE) {
384 ERROR("exec plugin: get group information for '%s' max buffer "
385 "limit (%ld) reached \n",
386 pl->group, MAX_GRBUF_SIZE);
390 /* grow the buffer by 'grbuf_size' each time getgrnamr fails */
392 temp = realloc(grbuf, size);
394 ERROR("exec plugin: get group information for '%s' realloc() "
395 "buffer to (%ld) failed ",
403 ERROR("exec plugin: default errno: get group information for '%s' "
405 pl->group, STRERRNO);
410 if (gr_ptr == NULL) {
411 ERROR("exec plugin: No such group: `%s'", pl->group);
418 DEBUG("exec plugin: release grbuf memory ");
420 if (getgr_failed > 0) {
421 egid = -2; // arbitrary value to indicate fail
426 } /* if (pl->group == NULL) */
431 * Creates three pipes (one for reading, one for writing and one for errors),
432 * forks a child, sets up the pipes so that fd_in is connected to STDIN of
433 * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
434 * of the child. Then is calls `exec_child'.
436 static int fork_child(program_list_t *pl, int *fd_in, int *fd_out,
437 int *fd_err) /* {{{ */
439 int fd_pipe_in[2] = {-1, -1};
440 int fd_pipe_out[2] = {-1, -1};
441 int fd_pipe_err[2] = {-1, -1};
449 struct passwd *sp_ptr;
455 long int nambuf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
456 if (nambuf_size <= 0)
457 nambuf_size = sysconf(_SC_PAGESIZE);
458 if (nambuf_size <= 0)
460 char nambuf[nambuf_size];
462 if ((create_pipe(fd_pipe_in) == -1) || (create_pipe(fd_pipe_out) == -1) ||
463 (create_pipe(fd_pipe_err) == -1))
467 status = getpwnam_r(pl->user, &sp, nambuf, sizeof(nambuf), &sp_ptr);
469 ERROR("exec plugin: Failed to get user information for user ``%s'': %s",
470 pl->user, STRERROR(status));
474 if (sp_ptr == NULL) {
475 ERROR("exec plugin: No such user: `%s'", pl->user);
482 ERROR("exec plugin: Cowardly refusing to exec program as root.");
486 /* The group configured in the configfile is set as effective group, because
487 * this way the forked process can (re-)gain the user's primary group. */
488 egid = getegr_id(pl, gid);
490 ERROR("exec plugin: getegr_id failed: %s", STRERRNO);
496 ERROR("exec plugin: fork failed: %s", STRERRNO);
498 } else if (pid == 0) {
501 /* Close all file descriptors but the pipe end we need. */
502 fd_num = getdtablesize();
503 for (int fd = 0; fd < fd_num; fd++) {
504 if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]) ||
505 (fd == fd_pipe_err[1]))
510 /* Connect the `in' pipe to STDIN */
511 if (fd_pipe_in[0] != STDIN_FILENO) {
512 dup2(fd_pipe_in[0], STDIN_FILENO);
513 close(fd_pipe_in[0]);
516 /* Now connect the `out' pipe to STDOUT */
517 if (fd_pipe_out[1] != STDOUT_FILENO) {
518 dup2(fd_pipe_out[1], STDOUT_FILENO);
519 close(fd_pipe_out[1]);
522 /* Now connect the `err' pipe to STDERR */
523 if (fd_pipe_err[1] != STDERR_FILENO) {
524 dup2(fd_pipe_err[1], STDERR_FILENO);
525 close(fd_pipe_err[1]);
530 /* Unblock all signals */
533 exec_child(pl, uid, gid, egid);
534 /* does not return */
537 close(fd_pipe_in[0]);
538 close(fd_pipe_out[1]);
539 close(fd_pipe_err[1]);
542 *fd_in = fd_pipe_in[1];
544 close(fd_pipe_in[1]);
547 *fd_out = fd_pipe_out[0];
549 close(fd_pipe_out[0]);
552 *fd_err = fd_pipe_err[0];
554 close(fd_pipe_err[0]);
559 close_pipe(fd_pipe_in);
560 close_pipe(fd_pipe_out);
561 close_pipe(fd_pipe_err);
564 } /* int fork_child }}} */
566 static int parse_line(char *buffer) /* {{{ */
568 if (strncasecmp("PUTVAL", buffer, strlen("PUTVAL")) == 0)
569 return cmd_handle_putval(stdout, buffer);
570 else if (strncasecmp("PUTNOTIF", buffer, strlen("PUTNOTIF")) == 0)
571 return handle_putnotif(stdout, buffer);
573 ERROR("exec plugin: Unable to parse command, ignoring line: \"%s\"",
577 } /* int parse_line }}} */
579 static void *exec_read_one(void *arg) /* {{{ */
581 program_list_t *pl = (program_list_t *)arg;
582 int fd, fd_err, highest_fd;
585 char buffer[1200]; /* if not completely read */
586 char buffer_err[1024];
587 char *pbuffer = buffer;
588 char *pbuffer_err = buffer_err;
590 status = fork_child(pl, NULL, &fd, &fd_err);
592 /* Reset the "running" flag */
593 pthread_mutex_lock(&pl_lock);
594 pl->flags &= ~PL_RUNNING;
595 pthread_mutex_unlock(&pl_lock);
596 pthread_exit((void *)1);
600 assert(pl->pid != 0);
604 FD_SET(fd_err, &fdset);
606 /* Determine the highest file descriptor */
607 highest_fd = (fd > fd_err) ? fd : fd_err;
609 /* We use a copy of fdset, as select modifies it */
615 status = select(highest_fd + 1, ©, NULL, NULL, NULL);
622 if (FD_ISSET(fd, ©)) {
625 len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
628 if (errno == EAGAIN || errno == EINTR)
632 break; /* We've reached EOF */
636 len += pbuffer - buffer;
639 while ((pnl = strchr(pbuffer, '\n'))) {
641 if (*(pnl - 1) == '\r')
648 /* not completely read ? */
649 if (pbuffer - buffer < len) {
650 len -= pbuffer - buffer;
651 memmove(buffer, pbuffer, len);
652 pbuffer = buffer + len;
655 } else if (FD_ISSET(fd_err, ©)) {
658 len = read(fd_err, pbuffer_err,
659 sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
662 if (errno == EAGAIN || errno == EINTR)
665 } else if (len == 0) {
666 /* We've reached EOF */
667 NOTICE("exec plugin: Program `%s' has closed STDERR.", pl->exec);
669 /* Remove file descriptor form select() set. */
670 FD_CLR(fd_err, &fdset);
674 /* Clean up file descriptor */
680 pbuffer_err[len] = '\0';
682 len += pbuffer_err - buffer_err;
683 pbuffer_err = buffer_err;
685 while ((pnl = strchr(pbuffer_err, '\n'))) {
687 if (*(pnl - 1) == '\r')
690 ERROR("exec plugin: exec_read_one: error = %s", pbuffer_err);
694 /* not completely read ? */
695 if (pbuffer_err - buffer_err < len) {
696 len -= pbuffer_err - buffer_err;
697 memmove(buffer_err, pbuffer_err, len);
698 pbuffer_err = buffer_err + len;
700 pbuffer_err = buffer_err;
706 DEBUG("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
707 if (waitpid(pl->pid, &status, 0) > 0)
710 DEBUG("exec plugin: Child %i exited with status %i.", (int)pl->pid,
715 pthread_mutex_lock(&pl_lock);
716 pl->flags &= ~PL_RUNNING;
717 pthread_mutex_unlock(&pl_lock);
723 pthread_exit((void *)0);
725 } /* void *exec_read_one }}} */
727 static void *exec_notification_one(void *arg) /* {{{ */
729 program_list_t *pl = ((program_list_and_notification_t *)arg)->pl;
730 notification_t *n = &((program_list_and_notification_t *)arg)->n;
735 const char *severity;
737 pid = fork_child(pl, &fd, NULL, NULL);
740 pthread_exit((void *)1);
743 fh = fdopen(fd, "w");
745 ERROR("exec plugin: fdopen (%i) failed: %s", fd, STRERRNO);
749 pthread_exit((void *)1);
752 severity = "FAILURE";
753 if (n->severity == NOTIF_WARNING)
754 severity = "WARNING";
755 else if (n->severity == NOTIF_OKAY)
758 fprintf(fh, "Severity: %s\n"
760 severity, CDTIME_T_TO_DOUBLE(n->time));
762 /* Print the optional fields */
763 if (strlen(n->host) > 0)
764 fprintf(fh, "Host: %s\n", n->host);
765 if (strlen(n->plugin) > 0)
766 fprintf(fh, "Plugin: %s\n", n->plugin);
767 if (strlen(n->plugin_instance) > 0)
768 fprintf(fh, "PluginInstance: %s\n", n->plugin_instance);
769 if (strlen(n->type) > 0)
770 fprintf(fh, "Type: %s\n", n->type);
771 if (strlen(n->type_instance) > 0)
772 fprintf(fh, "TypeInstance: %s\n", n->type_instance);
774 for (notification_meta_t *meta = n->meta; meta != NULL; meta = meta->next) {
775 if (meta->type == NM_TYPE_STRING)
776 fprintf(fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
777 else if (meta->type == NM_TYPE_SIGNED_INT)
778 fprintf(fh, "%s: %" PRIi64 "\n", meta->name,
779 meta->nm_value.nm_signed_int);
780 else if (meta->type == NM_TYPE_UNSIGNED_INT)
781 fprintf(fh, "%s: %" PRIu64 "\n", meta->name,
782 meta->nm_value.nm_unsigned_int);
783 else if (meta->type == NM_TYPE_DOUBLE)
784 fprintf(fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
785 else if (meta->type == NM_TYPE_BOOLEAN)
786 fprintf(fh, "%s: %s\n", meta->name,
787 meta->nm_value.nm_boolean ? "true" : "false");
790 fprintf(fh, "\n%s\n", n->message);
795 waitpid(pid, &status, 0);
797 DEBUG("exec plugin: Child %i exited with status %i.", pid, status);
800 plugin_notification_meta_free(n->meta);
803 pthread_exit((void *)0);
805 } /* void *exec_notification_one }}} */
807 static int exec_init(void) /* {{{ */
809 struct sigaction sa = {.sa_handler = sigchld_handler};
811 sigaction(SIGCHLD, &sa, NULL);
813 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_SETUID) && defined(CAP_SETGID)
814 if ((check_capability(CAP_SETUID) != 0) ||
815 (check_capability(CAP_SETGID) != 0)) {
818 "exec plugin: Running collectd as root, but the CAP_SETUID "
819 "or CAP_SETGID capabilities are missing. The plugin's read function "
820 "will probably fail. Is your init system dropping capabilities?");
823 "exec plugin: collectd doesn't have the CAP_SETUID or "
824 "CAP_SETGID capabilities. If you don't want to run collectd as root, "
825 "try running \"setcap 'cap_setuid=ep cap_setgid=ep'\" on the "
831 } /* int exec_init }}} */
833 static int exec_read(void) /* {{{ */
835 for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
839 /* Only execute `normal' style executables here. */
840 if ((pl->flags & PL_NORMAL) == 0)
843 pthread_mutex_lock(&pl_lock);
844 /* Skip if a child is already running. */
845 if ((pl->flags & PL_RUNNING) != 0) {
846 pthread_mutex_unlock(&pl_lock);
849 pl->flags |= PL_RUNNING;
850 pthread_mutex_unlock(&pl_lock);
852 pthread_attr_init(&attr);
853 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
855 plugin_thread_create(&t, &attr, exec_read_one, (void *)pl, "exec read");
857 ERROR("exec plugin: plugin_thread_create failed.");
859 pthread_attr_destroy(&attr);
863 } /* int exec_read }}} */
865 static int exec_notification(const notification_t *n, /* {{{ */
866 user_data_t __attribute__((unused)) * user_data) {
867 program_list_and_notification_t *pln;
869 for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
873 /* Only execute `notification' style executables here. */
874 if ((pl->flags & PL_NOTIF_ACTION) == 0)
877 /* Skip if a child is already running. */
881 pln = malloc(sizeof(*pln));
883 ERROR("exec plugin: malloc failed.");
888 memcpy(&pln->n, n, sizeof(notification_t));
890 /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
891 * will run into an endless loop. */
893 plugin_notification_meta_copy(&pln->n, n);
895 pthread_attr_init(&attr);
896 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
897 int status = plugin_thread_create(&t, &attr, exec_notification_one,
898 (void *)pln, "exec notify");
900 ERROR("exec plugin: plugin_thread_create failed.");
902 pthread_attr_destroy(&attr);
906 } /* }}} int exec_notification */
908 static int exec_shutdown(void) /* {{{ */
911 program_list_t *next;
918 kill(pl->pid, SIGTERM);
919 INFO("exec plugin: Sent SIGTERM to %hu", (unsigned short int)pl->pid);
930 } /* int exec_shutdown }}} */
932 void module_register(void) {
933 plugin_register_complex_config("exec", exec_config);
934 plugin_register_init("exec", exec_init);
935 plugin_register_read("exec", exec_read);
936 plugin_register_notification("exec", exec_notification,
937 /* user_data = */ NULL);
938 plugin_register_shutdown("exec", exec_shutdown);
939 } /* void module_register */