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 verplant.org>
22 * Sebastian Harl <sh at tokkee.org>
23 * Peter Holik <peter at holik.at>
26 #define _BSD_SOURCE /* For setgroups */
32 #include "utils_cmd_putval.h"
33 #include "utils_cmd_putnotif.h"
35 #include <sys/types.h>
42 #define PL_NORMAL 0x01
43 #define PL_NOTIF_ACTION 0x02
45 #define PL_RUNNING 0x10
51 * Access to this structure is serialized using the `pl_lock' lock and the
52 * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
53 * all functions used to handle notifications MUST NOT write to this structure.
54 * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
56 * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
58 struct program_list_s;
59 typedef struct program_list_s program_list_t;
72 typedef struct program_list_and_notification_s
76 } program_list_and_notification_t;
81 static program_list_t *pl_head = NULL;
82 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
87 static void sigchld_handler (int __attribute__((unused)) signal) /* {{{ */
91 while ((pid = waitpid (-1, &status, WNOHANG)) > 0)
94 for (pl = pl_head; pl != NULL; pl = pl->next)
99 } /* while (waitpid) */
100 } /* void sigchld_handler }}} */
102 static int exec_config_exec (oconfig_item_t *ci) /* {{{ */
108 if (ci->children_num != 0)
110 WARNING ("exec plugin: The config option `%s' may not be a block.",
114 if (ci->values_num < 2)
116 WARNING ("exec plugin: The config option `%s' needs at least two "
117 "arguments.", ci->key);
120 if ((ci->values[0].type != OCONFIG_TYPE_STRING)
121 || (ci->values[1].type != OCONFIG_TYPE_STRING))
123 WARNING ("exec plugin: The first two arguments to the `%s' option must "
124 "be string arguments.", ci->key);
128 pl = (program_list_t *) malloc (sizeof (program_list_t));
131 ERROR ("exec plugin: malloc failed.");
134 memset (pl, '\0', sizeof (program_list_t));
136 if (strcasecmp ("NotificationExec", ci->key) == 0)
137 pl->flags |= PL_NOTIF_ACTION;
139 pl->flags |= PL_NORMAL;
141 pl->user = strdup (ci->values[0].value.string);
142 if (pl->user == NULL)
144 ERROR ("exec plugin: strdup failed.");
149 pl->group = strchr (pl->user, ':');
150 if (pl->group != NULL)
156 pl->exec = strdup (ci->values[1].value.string);
157 if (pl->exec == NULL)
159 ERROR ("exec plugin: strdup failed.");
165 pl->argv = (char **) malloc (ci->values_num * sizeof (char *));
166 if (pl->argv == NULL)
168 ERROR ("exec plugin: malloc failed.");
174 memset (pl->argv, '\0', ci->values_num * sizeof (char *));
177 char *tmp = strrchr (ci->values[1].value.string, '/');
179 sstrncpy (buffer, ci->values[1].value.string, sizeof (buffer));
181 sstrncpy (buffer, tmp + 1, sizeof (buffer));
183 pl->argv[0] = strdup (buffer);
184 if (pl->argv[0] == NULL)
186 ERROR ("exec plugin: malloc failed.");
194 for (i = 1; i < (ci->values_num - 1); i++)
196 if (ci->values[i + 1].type == OCONFIG_TYPE_STRING)
198 pl->argv[i] = strdup (ci->values[i + 1].value.string);
202 if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER)
204 ssnprintf (buffer, sizeof (buffer), "%lf",
205 ci->values[i + 1].value.number);
209 if (ci->values[i + 1].value.boolean)
210 sstrncpy (buffer, "true", sizeof (buffer));
212 sstrncpy (buffer, "false", sizeof (buffer));
215 pl->argv[i] = strdup (buffer);
218 if (pl->argv[i] == NULL)
220 ERROR ("exec plugin: strdup failed.");
225 if (i < (ci->values_num - 1))
238 for (i = 0; pl->argv[i] != NULL; i++)
240 DEBUG ("exec plugin: argv[%i] = %s", i, pl->argv[i]);
247 } /* int exec_config_exec }}} */
249 static int exec_config (oconfig_item_t *ci) /* {{{ */
253 for (i = 0; i < ci->children_num; i++)
255 oconfig_item_t *child = ci->children + i;
256 if ((strcasecmp ("Exec", child->key) == 0)
257 || (strcasecmp ("NotificationExec", child->key) == 0))
258 exec_config_exec (child);
261 WARNING ("exec plugin: Unknown config option `%s'.", child->key);
266 } /* int exec_config }}} */
268 static void set_environment (void) /* {{{ */
273 ssnprintf (buffer, sizeof (buffer), "%.3f", CDTIME_T_TO_DOUBLE (interval_g));
274 setenv ("COLLECTD_INTERVAL", buffer, /* overwrite = */ 1);
276 ssnprintf (buffer, sizeof (buffer), "%s", hostname_g);
277 setenv ("COLLECTD_HOSTNAME", buffer, /* overwrite = */ 1);
279 ssnprintf (buffer, sizeof (buffer), "COLLECTD_INTERVAL=%.3f",
280 CDTIME_T_TO_DOUBLE (interval_g));
283 ssnprintf (buffer, sizeof (buffer), "COLLECTD_HOSTNAME=%s", hostname_g);
290 } /* }}} void set_environment */
292 __attribute__((noreturn))
293 static void exec_child (program_list_t *pl) /* {{{ */
300 struct passwd *sp_ptr;
306 status = getpwnam_r (pl->user, &sp, nambuf, sizeof (nambuf), &sp_ptr);
309 ERROR ("exec plugin: Failed to get user information for user ``%s'': %s",
310 pl->user, sstrerror (errno, errbuf, sizeof (errbuf)));
315 ERROR ("exec plugin: No such user: `%s'", pl->user);
323 ERROR ("exec plugin: Cowardly refusing to exec program as root.");
327 /* The group configured in the configfile is set as effective group, because
328 * this way the forked process can (re-)gain the user's primary group. */
330 if (NULL != pl->group)
332 if ('\0' != *pl->group) {
333 struct group *gr_ptr = NULL;
336 status = getgrnam_r (pl->group, &gr, nambuf, sizeof (nambuf), &gr_ptr);
339 ERROR ("exec plugin: Failed to get group information "
340 "for group ``%s'': %s", pl->group,
341 sstrerror (errno, errbuf, sizeof (errbuf)));
346 ERROR ("exec plugin: No such group: `%s'", pl->group);
356 } /* if (pl->group == NULL) */
367 if ((gid != egid) && (egid != -1))
373 setgroups (glist_len, glist);
375 #endif /* HAVE_SETGROUPS */
377 status = setgid (gid);
380 ERROR ("exec plugin: setgid (%i) failed: %s",
381 gid, sstrerror (errno, errbuf, sizeof (errbuf)));
387 status = setegid (egid);
390 ERROR ("exec plugin: setegid (%i) failed: %s",
391 egid, sstrerror (errno, errbuf, sizeof (errbuf)));
396 status = setuid (uid);
399 ERROR ("exec plugin: setuid (%i) failed: %s",
400 uid, sstrerror (errno, errbuf, sizeof (errbuf)));
404 status = execvp (pl->exec, pl->argv);
406 ERROR ("exec plugin: Failed to execute ``%s'': %s",
407 pl->exec, sstrerror (errno, errbuf, sizeof (errbuf)));
409 } /* void exec_child }}} */
411 static void reset_signal_mask (void) /* {{{ */
415 memset (&ss, 0, sizeof (ss));
417 sigprocmask (SIG_SETMASK, &ss, /* old mask = */ NULL);
418 } /* }}} void reset_signal_mask */
421 * Creates three pipes (one for reading, one for writing and one for errors),
422 * forks a child, sets up the pipes so that fd_in is connected to STDIN of
423 * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
424 * of the child. Then is calls `exec_child'.
426 static int fork_child (program_list_t *pl, int *fd_in, int *fd_out, int *fd_err) /* {{{ */
438 status = pipe (fd_pipe_in);
441 ERROR ("exec plugin: pipe failed: %s",
442 sstrerror (errno, errbuf, sizeof (errbuf)));
446 status = pipe (fd_pipe_out);
449 ERROR ("exec plugin: pipe failed: %s",
450 sstrerror (errno, errbuf, sizeof (errbuf)));
454 status = pipe (fd_pipe_err);
457 ERROR ("exec plugin: pipe failed: %s",
458 sstrerror (errno, errbuf, sizeof (errbuf)));
465 ERROR ("exec plugin: fork failed: %s",
466 sstrerror (errno, errbuf, sizeof (errbuf)));
474 /* Close all file descriptors but the pipe end we need. */
475 fd_num = getdtablesize ();
476 for (fd = 0; fd < fd_num; fd++)
478 if ((fd == fd_pipe_in[0])
479 || (fd == fd_pipe_out[1])
480 || (fd == fd_pipe_err[1]))
485 /* Connect the `in' pipe to STDIN */
486 if (fd_pipe_in[0] != STDIN_FILENO)
488 dup2 (fd_pipe_in[0], STDIN_FILENO);
489 close (fd_pipe_in[0]);
492 /* Now connect the `out' pipe to STDOUT */
493 if (fd_pipe_out[1] != STDOUT_FILENO)
495 dup2 (fd_pipe_out[1], STDOUT_FILENO);
496 close (fd_pipe_out[1]);
499 /* Now connect the `out' pipe to STDOUT */
500 if (fd_pipe_err[1] != STDERR_FILENO)
502 dup2 (fd_pipe_err[1], STDERR_FILENO);
503 close (fd_pipe_err[1]);
508 /* Unblock all signals */
509 reset_signal_mask ();
512 /* does not return */
515 close (fd_pipe_in[0]);
516 close (fd_pipe_out[1]);
517 close (fd_pipe_err[1]);
520 *fd_in = fd_pipe_in[1];
522 close (fd_pipe_in[1]);
525 *fd_out = fd_pipe_out[0];
527 close (fd_pipe_out[0]);
530 *fd_err = fd_pipe_err[0];
532 close (fd_pipe_err[0]);
535 } /* int fork_child }}} */
537 static int parse_line (char *buffer) /* {{{ */
539 if (strncasecmp ("PUTVAL", buffer, strlen ("PUTVAL")) == 0)
540 return (handle_putval (stdout, buffer));
541 else if (strncasecmp ("PUTNOTIF", buffer, strlen ("PUTNOTIF")) == 0)
542 return (handle_putnotif (stdout, buffer));
545 ERROR ("exec plugin: Unable to parse command, ignoring line: \"%s\"",
549 } /* int parse_line }}} */
551 static void *exec_read_one (void *arg) /* {{{ */
553 program_list_t *pl = (program_list_t *) arg;
554 int fd, fd_err, highest_fd;
557 char buffer[1200]; /* if not completely read */
558 char buffer_err[1024];
559 char *pbuffer = buffer;
560 char *pbuffer_err = buffer_err;
562 status = fork_child (pl, NULL, &fd, &fd_err);
565 /* Reset the "running" flag */
566 pthread_mutex_lock (&pl_lock);
567 pl->flags &= ~PL_RUNNING;
568 pthread_mutex_unlock (&pl_lock);
569 pthread_exit ((void *) 1);
573 assert (pl->pid != 0);
577 FD_SET(fd_err, &fdset);
579 /* Determine the highest file descriptor */
580 highest_fd = (fd > fd_err) ? fd : fd_err;
582 /* We use a copy of fdset, as select modifies it */
585 while (select(highest_fd + 1, ©, NULL, NULL, NULL ) > 0)
589 if (FD_ISSET(fd, ©))
593 len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
597 if (errno == EAGAIN || errno == EINTR) continue;
600 else if (len == 0) break; /* We've reached EOF */
604 len += pbuffer - buffer;
607 while ((pnl = strchr(pbuffer, '\n')))
610 if (*(pnl-1) == '\r' ) *(pnl-1) = '\0';
612 parse_line (pbuffer);
616 /* not completely read ? */
617 if (pbuffer - buffer < len)
619 len -= pbuffer - buffer;
620 memmove(buffer, pbuffer, len);
621 pbuffer = buffer + len;
626 else if (FD_ISSET(fd_err, ©))
630 len = read(fd_err, pbuffer_err, sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
634 if (errno == EAGAIN || errno == EINTR) continue;
639 /* We've reached EOF */
640 NOTICE ("exec plugin: Program `%s' has closed STDERR.",
643 FD_CLR (fd_err, &fdset);
649 pbuffer_err[len] = '\0';
651 len += pbuffer_err - buffer_err;
652 pbuffer_err = buffer_err;
654 while ((pnl = strchr(pbuffer_err, '\n')))
657 if (*(pnl-1) == '\r' ) *(pnl-1) = '\0';
659 ERROR ("exec plugin: exec_read_one: error = %s", pbuffer_err);
663 /* not completely read ? */
664 if (pbuffer_err - buffer_err < len)
666 len -= pbuffer_err - buffer_err;
667 memmove(buffer_err, pbuffer_err, len);
668 pbuffer_err = buffer_err + len;
671 pbuffer_err = buffer_err;
677 DEBUG ("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
678 if (waitpid (pl->pid, &status, 0) > 0)
681 DEBUG ("exec plugin: Child %i exited with status %i.",
682 (int) pl->pid, pl->status);
686 pthread_mutex_lock (&pl_lock);
687 pl->flags &= ~PL_RUNNING;
688 pthread_mutex_unlock (&pl_lock);
694 pthread_exit ((void *) 0);
696 } /* void *exec_read_one }}} */
698 static void *exec_notification_one (void *arg) /* {{{ */
700 program_list_t *pl = ((program_list_and_notification_t *) arg)->pl;
701 notification_t *n = &((program_list_and_notification_t *) arg)->n;
702 notification_meta_t *meta;
707 const char *severity;
709 pid = fork_child (pl, &fd, NULL, NULL);
712 pthread_exit ((void *) 1);
715 fh = fdopen (fd, "w");
719 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
720 sstrerror (errno, errbuf, sizeof (errbuf)));
721 kill (pl->pid, SIGTERM);
725 pthread_exit ((void *) 1);
728 severity = "FAILURE";
729 if (n->severity == NOTIF_WARNING)
730 severity = "WARNING";
731 else if (n->severity == NOTIF_OKAY)
737 severity, (unsigned int) n->time);
739 /* Print the optional fields */
740 if (strlen (n->host) > 0)
741 fprintf (fh, "Host: %s\n", n->host);
742 if (strlen (n->plugin) > 0)
743 fprintf (fh, "Plugin: %s\n", n->plugin);
744 if (strlen (n->plugin_instance) > 0)
745 fprintf (fh, "PluginInstance: %s\n", n->plugin_instance);
746 if (strlen (n->type) > 0)
747 fprintf (fh, "Type: %s\n", n->type);
748 if (strlen (n->type_instance) > 0)
749 fprintf (fh, "TypeInstance: %s\n", n->type_instance);
751 for (meta = n->meta; meta != NULL; meta = meta->next)
753 if (meta->type == NM_TYPE_STRING)
754 fprintf (fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
755 else if (meta->type == NM_TYPE_SIGNED_INT)
756 fprintf (fh, "%s: %"PRIi64"\n", meta->name, meta->nm_value.nm_signed_int);
757 else if (meta->type == NM_TYPE_UNSIGNED_INT)
758 fprintf (fh, "%s: %"PRIu64"\n", meta->name, meta->nm_value.nm_unsigned_int);
759 else if (meta->type == NM_TYPE_DOUBLE)
760 fprintf (fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
761 else if (meta->type == NM_TYPE_BOOLEAN)
762 fprintf (fh, "%s: %s\n", meta->name,
763 meta->nm_value.nm_boolean ? "true" : "false");
766 fprintf (fh, "\n%s\n", n->message);
771 waitpid (pid, &status, 0);
773 DEBUG ("exec plugin: Child %i exited with status %i.",
777 plugin_notification_meta_free (n->meta);
780 pthread_exit ((void *) 0);
782 } /* void *exec_notification_one }}} */
784 static int exec_init (void) /* {{{ */
788 memset (&sa, '\0', sizeof (sa));
789 sa.sa_handler = sigchld_handler;
790 sigaction (SIGCHLD, &sa, NULL);
793 } /* int exec_init }}} */
795 static int exec_read (void) /* {{{ */
799 for (pl = pl_head; pl != NULL; pl = pl->next)
804 /* Only execute `normal' style executables here. */
805 if ((pl->flags & PL_NORMAL) == 0)
808 pthread_mutex_lock (&pl_lock);
809 /* Skip if a child is already running. */
810 if ((pl->flags & PL_RUNNING) != 0)
812 pthread_mutex_unlock (&pl_lock);
815 pl->flags |= PL_RUNNING;
816 pthread_mutex_unlock (&pl_lock);
818 pthread_attr_init (&attr);
819 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
820 pthread_create (&t, &attr, exec_read_one, (void *) pl);
824 } /* int exec_read }}} */
826 static int exec_notification (const notification_t *n, /* {{{ */
827 user_data_t __attribute__((unused)) *user_data)
830 program_list_and_notification_t *pln;
832 for (pl = pl_head; pl != NULL; pl = pl->next)
837 /* Only execute `notification' style executables here. */
838 if ((pl->flags & PL_NOTIF_ACTION) == 0)
841 /* Skip if a child is already running. */
845 pln = (program_list_and_notification_t *) malloc (sizeof
846 (program_list_and_notification_t));
849 ERROR ("exec plugin: malloc failed.");
854 memcpy (&pln->n, n, sizeof (notification_t));
856 /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
857 * will run into an endless loop. */
859 plugin_notification_meta_copy (&pln->n, n);
861 pthread_attr_init (&attr);
862 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
863 pthread_create (&t, &attr, exec_notification_one, (void *) pln);
867 } /* }}} int exec_notification */
869 static int exec_shutdown (void) /* {{{ */
872 program_list_t *next;
881 kill (pl->pid, SIGTERM);
882 INFO ("exec plugin: Sent SIGTERM to %hu", (unsigned short int) pl->pid);
893 } /* int exec_shutdown }}} */
895 void module_register (void)
897 plugin_register_complex_config ("exec", exec_config);
898 plugin_register_init ("exec", exec_init);
899 plugin_register_read ("exec", exec_read);
900 plugin_register_notification ("exec", exec_notification,
901 /* user_data = */ NULL);
902 plugin_register_shutdown ("exec", exec_shutdown);
903 } /* void module_register */
906 * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker