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 */
33 #include "utils_cmd_putval.h"
34 #include "utils_cmd_putnotif.h"
36 #include <sys/types.h>
43 #define PL_NORMAL 0x01
44 #define PL_NOTIF_ACTION 0x02
46 #define PL_RUNNING 0x10
52 * Access to this structure is serialized using the `pl_lock' lock and the
53 * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
54 * all functions used to handle notifications MUST NOT write to this structure.
55 * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
57 * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
59 struct program_list_s;
60 typedef struct program_list_s program_list_t;
73 typedef struct program_list_and_notification_s
77 } program_list_and_notification_t;
82 static program_list_t *pl_head = NULL;
83 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
88 static void sigchld_handler (int __attribute__((unused)) signal) /* {{{ */
92 while ((pid = waitpid (-1, &status, WNOHANG)) > 0)
95 for (pl = pl_head; pl != NULL; pl = pl->next)
100 } /* while (waitpid) */
101 } /* void sigchld_handler }}} */
103 static int exec_config_exec (oconfig_item_t *ci) /* {{{ */
109 if (ci->children_num != 0)
111 WARNING ("exec plugin: The config option `%s' may not be a block.",
115 if (ci->values_num < 2)
117 WARNING ("exec plugin: The config option `%s' needs at least two "
118 "arguments.", ci->key);
121 if ((ci->values[0].type != OCONFIG_TYPE_STRING)
122 || (ci->values[1].type != OCONFIG_TYPE_STRING))
124 WARNING ("exec plugin: The first two arguments to the `%s' option must "
125 "be string arguments.", ci->key);
129 pl = (program_list_t *) malloc (sizeof (program_list_t));
132 ERROR ("exec plugin: malloc failed.");
135 memset (pl, '\0', sizeof (program_list_t));
137 if (strcasecmp ("NotificationExec", ci->key) == 0)
138 pl->flags |= PL_NOTIF_ACTION;
140 pl->flags |= PL_NORMAL;
142 pl->user = strdup (ci->values[0].value.string);
143 if (pl->user == NULL)
145 ERROR ("exec plugin: strdup failed.");
150 pl->group = strchr (pl->user, ':');
151 if (pl->group != NULL)
157 pl->exec = strdup (ci->values[1].value.string);
158 if (pl->exec == NULL)
160 ERROR ("exec plugin: strdup failed.");
166 pl->argv = (char **) malloc (ci->values_num * sizeof (char *));
167 if (pl->argv == NULL)
169 ERROR ("exec plugin: malloc failed.");
175 memset (pl->argv, '\0', ci->values_num * sizeof (char *));
178 char *tmp = strrchr (ci->values[1].value.string, '/');
180 sstrncpy (buffer, ci->values[1].value.string, sizeof (buffer));
182 sstrncpy (buffer, tmp + 1, sizeof (buffer));
184 pl->argv[0] = strdup (buffer);
185 if (pl->argv[0] == NULL)
187 ERROR ("exec plugin: malloc failed.");
195 for (i = 1; i < (ci->values_num - 1); i++)
197 if (ci->values[i + 1].type == OCONFIG_TYPE_STRING)
199 pl->argv[i] = strdup (ci->values[i + 1].value.string);
203 if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER)
205 ssnprintf (buffer, sizeof (buffer), "%lf",
206 ci->values[i + 1].value.number);
210 if (ci->values[i + 1].value.boolean)
211 sstrncpy (buffer, "true", sizeof (buffer));
213 sstrncpy (buffer, "false", sizeof (buffer));
216 pl->argv[i] = strdup (buffer);
219 if (pl->argv[i] == NULL)
221 ERROR ("exec plugin: strdup failed.");
226 if (i < (ci->values_num - 1))
239 for (i = 0; pl->argv[i] != NULL; i++)
241 DEBUG ("exec plugin: argv[%i] = %s", i, pl->argv[i]);
248 } /* int exec_config_exec }}} */
250 static int exec_config (oconfig_item_t *ci) /* {{{ */
254 for (i = 0; i < ci->children_num; i++)
256 oconfig_item_t *child = ci->children + i;
257 if ((strcasecmp ("Exec", child->key) == 0)
258 || (strcasecmp ("NotificationExec", child->key) == 0))
259 exec_config_exec (child);
262 WARNING ("exec plugin: Unknown config option `%s'.", child->key);
267 } /* int exec_config }}} */
269 static void set_environment (void) /* {{{ */
274 ssnprintf (buffer, sizeof (buffer), "%.3f",
275 CDTIME_T_TO_DOUBLE (plugin_get_interval ()));
276 setenv ("COLLECTD_INTERVAL", buffer, /* overwrite = */ 1);
278 ssnprintf (buffer, sizeof (buffer), "%s", hostname_g);
279 setenv ("COLLECTD_HOSTNAME", buffer, /* overwrite = */ 1);
281 ssnprintf (buffer, sizeof (buffer), "COLLECTD_INTERVAL=%.3f",
282 CDTIME_T_TO_DOUBLE (plugin_get_interval ()));
285 ssnprintf (buffer, sizeof (buffer), "COLLECTD_HOSTNAME=%s", hostname_g);
288 } /* }}} void set_environment */
290 __attribute__((noreturn))
291 static void exec_child (program_list_t *pl, int uid, int gid, int egid) /* {{{ */
305 if ((gid != egid) && (egid != -1))
311 setgroups (glist_len, glist);
313 #endif /* HAVE_SETGROUPS */
315 status = setgid (gid);
318 ERROR ("exec plugin: setgid (%i) failed: %s",
319 gid, sstrerror (errno, errbuf, sizeof (errbuf)));
325 status = setegid (egid);
328 ERROR ("exec plugin: setegid (%i) failed: %s",
329 egid, sstrerror (errno, errbuf, sizeof (errbuf)));
334 status = setuid (uid);
337 ERROR ("exec plugin: setuid (%i) failed: %s",
338 uid, sstrerror (errno, errbuf, sizeof (errbuf)));
342 execvp (pl->exec, pl->argv);
344 ERROR ("exec plugin: Failed to execute ``%s'': %s",
345 pl->exec, sstrerror (errno, errbuf, sizeof (errbuf)));
347 } /* void exec_child }}} */
349 static void reset_signal_mask (void) /* {{{ */
353 memset (&ss, 0, sizeof (ss));
355 sigprocmask (SIG_SETMASK, &ss, /* old mask = */ NULL);
356 } /* }}} void reset_signal_mask */
359 * Creates three pipes (one for reading, one for writing and one for errors),
360 * forks a child, sets up the pipes so that fd_in is connected to STDIN of
361 * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
362 * of the child. Then is calls `exec_child'.
364 static int fork_child (program_list_t *pl, int *fd_in, int *fd_out, int *fd_err) /* {{{ */
377 struct passwd *sp_ptr;
384 status = pipe (fd_pipe_in);
387 ERROR ("exec plugin: pipe failed: %s",
388 sstrerror (errno, errbuf, sizeof (errbuf)));
392 status = pipe (fd_pipe_out);
395 ERROR ("exec plugin: pipe failed: %s",
396 sstrerror (errno, errbuf, sizeof (errbuf)));
400 status = pipe (fd_pipe_err);
403 ERROR ("exec plugin: pipe failed: %s",
404 sstrerror (errno, errbuf, sizeof (errbuf)));
409 status = getpwnam_r (pl->user, &sp, nambuf, sizeof (nambuf), &sp_ptr);
412 ERROR ("exec plugin: Failed to get user information for user ``%s'': %s",
413 pl->user, sstrerror (errno, errbuf, sizeof (errbuf)));
418 ERROR ("exec plugin: No such user: `%s'", pl->user);
426 ERROR ("exec plugin: Cowardly refusing to exec program as root.");
430 /* The group configured in the configfile is set as effective group, because
431 * this way the forked process can (re-)gain the user's primary group. */
433 if (NULL != pl->group)
435 if ('\0' != *pl->group) {
436 struct group *gr_ptr = NULL;
439 status = getgrnam_r (pl->group, &gr, nambuf, sizeof (nambuf), &gr_ptr);
442 ERROR ("exec plugin: Failed to get group information "
443 "for group ``%s'': %s", pl->group,
444 sstrerror (errno, errbuf, sizeof (errbuf)));
449 ERROR ("exec plugin: No such group: `%s'", pl->group);
459 } /* if (pl->group == NULL) */
464 ERROR ("exec plugin: fork failed: %s",
465 sstrerror (errno, errbuf, sizeof (errbuf)));
473 /* Close all file descriptors but the pipe end we need. */
474 fd_num = getdtablesize ();
475 for (fd = 0; fd < fd_num; fd++)
477 if ((fd == fd_pipe_in[0])
478 || (fd == fd_pipe_out[1])
479 || (fd == fd_pipe_err[1]))
484 /* Connect the `in' pipe to STDIN */
485 if (fd_pipe_in[0] != STDIN_FILENO)
487 dup2 (fd_pipe_in[0], STDIN_FILENO);
488 close (fd_pipe_in[0]);
491 /* Now connect the `out' pipe to STDOUT */
492 if (fd_pipe_out[1] != STDOUT_FILENO)
494 dup2 (fd_pipe_out[1], STDOUT_FILENO);
495 close (fd_pipe_out[1]);
498 /* Now connect the `err' pipe to STDERR */
499 if (fd_pipe_err[1] != STDERR_FILENO)
501 dup2 (fd_pipe_err[1], STDERR_FILENO);
502 close (fd_pipe_err[1]);
507 /* Unblock all signals */
508 reset_signal_mask ();
510 exec_child (pl, uid, gid, egid);
511 /* does not return */
514 close (fd_pipe_in[0]);
515 close (fd_pipe_out[1]);
516 close (fd_pipe_err[1]);
519 *fd_in = fd_pipe_in[1];
521 close (fd_pipe_in[1]);
524 *fd_out = fd_pipe_out[0];
526 close (fd_pipe_out[0]);
529 *fd_err = fd_pipe_err[0];
531 close (fd_pipe_err[0]);
534 } /* int fork_child }}} */
536 static int parse_line (char *buffer) /* {{{ */
538 if (strncasecmp ("PUTVAL", buffer, strlen ("PUTVAL")) == 0)
539 return (handle_putval (stdout, buffer));
540 else if (strncasecmp ("PUTNOTIF", buffer, strlen ("PUTNOTIF")) == 0)
541 return (handle_putnotif (stdout, buffer));
544 ERROR ("exec plugin: Unable to parse command, ignoring line: \"%s\"",
548 } /* int parse_line }}} */
550 static void *exec_read_one (void *arg) /* {{{ */
552 program_list_t *pl = (program_list_t *) arg;
553 int fd, fd_err, highest_fd;
556 char buffer[1200]; /* if not completely read */
557 char buffer_err[1024];
558 char *pbuffer = buffer;
559 char *pbuffer_err = buffer_err;
561 status = fork_child (pl, NULL, &fd, &fd_err);
564 /* Reset the "running" flag */
565 pthread_mutex_lock (&pl_lock);
566 pl->flags &= ~PL_RUNNING;
567 pthread_mutex_unlock (&pl_lock);
568 pthread_exit ((void *) 1);
572 assert (pl->pid != 0);
576 FD_SET(fd_err, &fdset);
578 /* Determine the highest file descriptor */
579 highest_fd = (fd > fd_err) ? fd : fd_err;
581 /* We use a copy of fdset, as select modifies it */
588 status = select (highest_fd + 1, ©, NULL, NULL, NULL);
596 if (FD_ISSET(fd, ©))
600 len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
604 if (errno == EAGAIN || errno == EINTR) continue;
607 else if (len == 0) break; /* We've reached EOF */
611 len += pbuffer - buffer;
614 while ((pnl = strchr(pbuffer, '\n')))
617 if (*(pnl-1) == '\r' ) *(pnl-1) = '\0';
619 parse_line (pbuffer);
623 /* not completely read ? */
624 if (pbuffer - buffer < len)
626 len -= pbuffer - buffer;
627 memmove(buffer, pbuffer, len);
628 pbuffer = buffer + len;
633 else if (FD_ISSET(fd_err, ©))
637 len = read(fd_err, pbuffer_err, sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
641 if (errno == EAGAIN || errno == EINTR)
647 /* We've reached EOF */
648 NOTICE ("exec plugin: Program `%s' has closed STDERR.", pl->exec);
650 /* Remove file descriptor form select() set. */
651 FD_CLR (fd_err, &fdset);
655 /* Clean up file descriptor */
661 pbuffer_err[len] = '\0';
663 len += pbuffer_err - buffer_err;
664 pbuffer_err = buffer_err;
666 while ((pnl = strchr(pbuffer_err, '\n')))
669 if (*(pnl-1) == '\r' ) *(pnl-1) = '\0';
671 ERROR ("exec plugin: exec_read_one: error = %s", pbuffer_err);
675 /* not completely read ? */
676 if (pbuffer_err - buffer_err < len)
678 len -= pbuffer_err - buffer_err;
679 memmove(buffer_err, pbuffer_err, len);
680 pbuffer_err = buffer_err + len;
683 pbuffer_err = buffer_err;
689 DEBUG ("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
690 if (waitpid (pl->pid, &status, 0) > 0)
693 DEBUG ("exec plugin: Child %i exited with status %i.",
694 (int) pl->pid, pl->status);
698 pthread_mutex_lock (&pl_lock);
699 pl->flags &= ~PL_RUNNING;
700 pthread_mutex_unlock (&pl_lock);
706 pthread_exit ((void *) 0);
708 } /* void *exec_read_one }}} */
710 static void *exec_notification_one (void *arg) /* {{{ */
712 program_list_t *pl = ((program_list_and_notification_t *) arg)->pl;
713 notification_t *n = &((program_list_and_notification_t *) arg)->n;
714 notification_meta_t *meta;
719 const char *severity;
721 pid = fork_child (pl, &fd, NULL, NULL);
724 pthread_exit ((void *) 1);
727 fh = fdopen (fd, "w");
731 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
732 sstrerror (errno, errbuf, sizeof (errbuf)));
733 kill (pl->pid, SIGTERM);
737 pthread_exit ((void *) 1);
740 severity = "FAILURE";
741 if (n->severity == NOTIF_WARNING)
742 severity = "WARNING";
743 else if (n->severity == NOTIF_OKAY)
749 severity, CDTIME_T_TO_DOUBLE (n->time));
751 /* Print the optional fields */
752 if (strlen (n->host) > 0)
753 fprintf (fh, "Host: %s\n", n->host);
754 if (strlen (n->plugin) > 0)
755 fprintf (fh, "Plugin: %s\n", n->plugin);
756 if (strlen (n->plugin_instance) > 0)
757 fprintf (fh, "PluginInstance: %s\n", n->plugin_instance);
758 if (strlen (n->type) > 0)
759 fprintf (fh, "Type: %s\n", n->type);
760 if (strlen (n->type_instance) > 0)
761 fprintf (fh, "TypeInstance: %s\n", n->type_instance);
763 for (meta = n->meta; meta != NULL; meta = meta->next)
765 if (meta->type == NM_TYPE_STRING)
766 fprintf (fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
767 else if (meta->type == NM_TYPE_SIGNED_INT)
768 fprintf (fh, "%s: %"PRIi64"\n", meta->name, meta->nm_value.nm_signed_int);
769 else if (meta->type == NM_TYPE_UNSIGNED_INT)
770 fprintf (fh, "%s: %"PRIu64"\n", meta->name, meta->nm_value.nm_unsigned_int);
771 else if (meta->type == NM_TYPE_DOUBLE)
772 fprintf (fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
773 else if (meta->type == NM_TYPE_BOOLEAN)
774 fprintf (fh, "%s: %s\n", meta->name,
775 meta->nm_value.nm_boolean ? "true" : "false");
778 fprintf (fh, "\n%s\n", n->message);
783 waitpid (pid, &status, 0);
785 DEBUG ("exec plugin: Child %i exited with status %i.",
789 plugin_notification_meta_free (n->meta);
792 pthread_exit ((void *) 0);
794 } /* void *exec_notification_one }}} */
796 static int exec_init (void) /* {{{ */
800 memset (&sa, '\0', sizeof (sa));
801 sa.sa_handler = sigchld_handler;
802 sigaction (SIGCHLD, &sa, NULL);
805 } /* int exec_init }}} */
807 static int exec_read (void) /* {{{ */
811 for (pl = pl_head; pl != NULL; pl = pl->next)
816 /* Only execute `normal' style executables here. */
817 if ((pl->flags & PL_NORMAL) == 0)
820 pthread_mutex_lock (&pl_lock);
821 /* Skip if a child is already running. */
822 if ((pl->flags & PL_RUNNING) != 0)
824 pthread_mutex_unlock (&pl_lock);
827 pl->flags |= PL_RUNNING;
828 pthread_mutex_unlock (&pl_lock);
830 pthread_attr_init (&attr);
831 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
832 plugin_thread_create (&t, &attr, exec_read_one, (void *) pl);
833 pthread_attr_destroy (&attr);
837 } /* int exec_read }}} */
839 static int exec_notification (const notification_t *n, /* {{{ */
840 user_data_t __attribute__((unused)) *user_data)
843 program_list_and_notification_t *pln;
845 for (pl = pl_head; pl != NULL; pl = pl->next)
850 /* Only execute `notification' style executables here. */
851 if ((pl->flags & PL_NOTIF_ACTION) == 0)
854 /* Skip if a child is already running. */
858 pln = (program_list_and_notification_t *) malloc (sizeof
859 (program_list_and_notification_t));
862 ERROR ("exec plugin: malloc failed.");
867 memcpy (&pln->n, n, sizeof (notification_t));
869 /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
870 * will run into an endless loop. */
872 plugin_notification_meta_copy (&pln->n, n);
874 pthread_attr_init (&attr);
875 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
876 plugin_thread_create (&t, &attr, exec_notification_one, (void *) pln);
877 pthread_attr_destroy (&attr);
881 } /* }}} int exec_notification */
883 static int exec_shutdown (void) /* {{{ */
886 program_list_t *next;
895 kill (pl->pid, SIGTERM);
896 INFO ("exec plugin: Sent SIGTERM to %hu", (unsigned short int) pl->pid);
907 } /* int exec_shutdown }}} */
909 void module_register (void)
911 plugin_register_complex_config ("exec", exec_config);
912 plugin_register_init ("exec", exec_init);
913 plugin_register_read ("exec", exec_read);
914 plugin_register_notification ("exec", exec_notification,
915 /* user_data = */ NULL);
916 plugin_register_shutdown ("exec", exec_shutdown);
917 } /* void module_register */
920 * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker