2 * collectd - src/exec.c
3 * Copyright (C) 2007,2008 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
26 #include "utils_cmd_putval.h"
27 #include "utils_cmd_putnotif.h"
29 #include <sys/types.h>
36 #define PL_NORMAL 0x01
37 #define PL_NOTIF_ACTION 0x02
38 #define PL_NAGIOS_PLUGIN 0x04
40 #define PL_RUNNING 0x10
46 * Access to this structure is serialized using the `pl_lock' lock and the
47 * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
48 * all functions used to handle notifications MUST NOT write to this structure.
49 * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
51 * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
53 struct program_list_s;
54 typedef struct program_list_s program_list_t;
67 typedef struct program_list_and_notification_s
71 } program_list_and_notification_t;
76 static program_list_t *pl_head = NULL;
77 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
82 static void sigchld_handler (int signal) /* {{{ */
86 while ((pid = waitpid (-1, &status, WNOHANG)) > 0)
89 for (pl = pl_head; pl != NULL; pl = pl->next)
94 } /* while (waitpid) */
95 } /* void sigchld_handler }}} */
97 static int exec_config_exec (oconfig_item_t *ci) /* {{{ */
103 if (ci->children_num != 0)
105 WARNING ("exec plugin: The config option `%s' may not be a block.",
109 if (ci->values_num < 2)
111 WARNING ("exec plugin: The config option `%s' needs at least two "
112 "arguments.", ci->key);
115 if ((ci->values[0].type != OCONFIG_TYPE_STRING)
116 || (ci->values[1].type != OCONFIG_TYPE_STRING))
118 WARNING ("exec plugin: The first two arguments to the `%s' option must "
119 "be string arguments.", ci->key);
123 pl = (program_list_t *) malloc (sizeof (program_list_t));
126 ERROR ("exec plugin: malloc failed.");
129 memset (pl, '\0', sizeof (program_list_t));
131 if (strcasecmp ("NagiosExec", ci->key) == 0)
132 pl->flags |= PL_NAGIOS_PLUGIN;
133 else if (strcasecmp ("NotificationExec", ci->key) == 0)
134 pl->flags |= PL_NOTIF_ACTION;
136 pl->flags |= PL_NORMAL;
138 pl->user = strdup (ci->values[0].value.string);
139 if (pl->user == NULL)
141 ERROR ("exec plugin: strdup failed.");
146 pl->group = strchr (pl->user, ':');
147 if (pl->group != NULL)
153 pl->exec = strdup (ci->values[1].value.string);
154 if (pl->exec == NULL)
156 ERROR ("exec plugin: strdup failed.");
162 pl->argv = (char **) malloc (ci->values_num * sizeof (char *));
163 if (pl->argv == NULL)
165 ERROR ("exec plugin: malloc failed.");
171 memset (pl->argv, '\0', ci->values_num * sizeof (char *));
174 char *tmp = strrchr (ci->values[1].value.string, '/');
176 strncpy (buffer, ci->values[1].value.string, sizeof (buffer));
178 strncpy (buffer, tmp + 1, sizeof (buffer));
179 buffer[sizeof (buffer) - 1] = '\0';
181 pl->argv[0] = strdup (buffer);
182 if (pl->argv[0] == NULL)
184 ERROR ("exec plugin: malloc failed.");
192 for (i = 1; i < (ci->values_num - 1); i++)
194 if (ci->values[i + 1].type == OCONFIG_TYPE_STRING)
196 pl->argv[i] = strdup (ci->values[i + 1].value.string);
200 if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER)
202 snprintf (buffer, sizeof (buffer), "%lf",
203 ci->values[i + 1].value.number);
207 if (ci->values[i + 1].value.boolean)
208 strncpy (buffer, "true", sizeof (buffer));
210 strncpy (buffer, "false", sizeof (buffer));
212 buffer[sizeof (buffer) - 1] = '\0';
214 pl->argv[i] = strdup (buffer);
217 if (pl->argv[i] == NULL)
219 ERROR ("exec plugin: strdup failed.");
224 if (i < (ci->values_num - 1))
237 for (i = 0; pl->argv[i] != NULL; i++)
239 DEBUG ("exec plugin: argv[%i] = %s", i, pl->argv[i]);
246 } /* int exec_config_exec }}} */
248 static int exec_config (oconfig_item_t *ci) /* {{{ */
252 for (i = 0; i < ci->children_num; i++)
254 oconfig_item_t *child = ci->children + i;
255 if ((strcasecmp ("Exec", child->key) == 0)
256 || (strcasecmp ("NagiosExec", 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 exec_child (program_list_t *pl) /* {{{ */
275 struct passwd *sp_ptr;
281 status = getpwnam_r (pl->user, &sp, nambuf, sizeof (nambuf), &sp_ptr);
284 ERROR ("exec plugin: getpwnam_r failed: %s",
285 sstrerror (errno, errbuf, sizeof (errbuf)));
290 ERROR ("exec plugin: No such user: `%s'", pl->user);
298 ERROR ("exec plugin: Cowardly refusing to exec program as root.");
302 /* The group configured in the configfile is set as effective group, because
303 * this way the forked process can (re-)gain the user's primary group. */
305 if (NULL != pl->group)
307 if ('\0' != *pl->group) {
308 struct group *gr_ptr = NULL;
311 status = getgrnam_r (pl->group, &gr, nambuf, sizeof (nambuf), &gr_ptr);
314 ERROR ("exec plugin: getgrnam_r failed: %s",
315 sstrerror (errno, errbuf, sizeof (errbuf)));
320 ERROR ("exec plugin: No such group: `%s'", pl->group);
330 } /* if (pl->group == NULL) */
332 status = setgid (gid);
335 ERROR ("exec plugin: setgid (%i) failed: %s",
336 gid, sstrerror (errno, errbuf, sizeof (errbuf)));
342 status = setegid (egid);
345 ERROR ("exec plugin: setegid (%i) failed: %s",
346 egid, sstrerror (errno, errbuf, sizeof (errbuf)));
351 status = setuid (uid);
354 ERROR ("exec plugin: setuid (%i) failed: %s",
355 uid, sstrerror (errno, errbuf, sizeof (errbuf)));
359 status = execvp (pl->exec, pl->argv);
361 ERROR ("exec plugin: exec failed: %s",
362 sstrerror (errno, errbuf, sizeof (errbuf)));
364 } /* void exec_child }}} */
367 * Creates two pipes (one for reading, ong for writing), forks a child, sets up
368 * the pipes so that fd_in is connected to STDIN of the child and fd_out is
369 * connected to STDOUT and STDERR of the child. Then is calls `exec_child'.
371 static int fork_child (program_list_t *pl, int *fd_in, int *fd_out) /* {{{ */
381 status = pipe (fd_pipe_in);
385 ERROR ("exec plugin: pipe failed: %s",
386 sstrerror (errno, errbuf, sizeof (errbuf)));
390 status = pipe (fd_pipe_out);
394 ERROR ("exec plugin: pipe failed: %s",
395 sstrerror (errno, errbuf, sizeof (errbuf)));
403 ERROR ("exec plugin: fork failed: %s",
404 sstrerror (errno, errbuf, sizeof (errbuf)));
409 close (fd_pipe_in[1]);
410 close (fd_pipe_out[0]);
412 /* If the `out' pipe has the filedescriptor STDIN we have to be careful
413 * with the `dup's below. So, if this is the case we have to handle the
414 * `out' pipe first. */
415 if (fd_pipe_out[1] == STDIN_FILENO)
417 int new_fileno = (fd_pipe_in[0] == STDOUT_FILENO)
418 ? STDERR_FILENO : STDOUT_FILENO;
419 dup2 (fd_pipe_out[1], new_fileno);
420 close (fd_pipe_out[1]);
421 fd_pipe_out[1] = new_fileno;
423 /* Now `fd_pipe_out[1]' is either `STDOUT' or `STDERR', but definitely not
426 /* Connect the `in' pipe to STDIN */
427 if (fd_pipe_in[0] != STDIN_FILENO)
429 dup2 (fd_pipe_in[0], STDIN_FILENO);
430 close (fd_pipe_in[0]);
431 fd_pipe_in[0] = STDIN_FILENO;
434 /* Now connect the `out' pipe to STDOUT and STDERR */
435 if (fd_pipe_out[1] != STDOUT_FILENO)
436 dup2 (fd_pipe_out[1], STDOUT_FILENO);
437 if (fd_pipe_out[1] != STDERR_FILENO)
438 dup2 (fd_pipe_out[1], STDERR_FILENO);
440 /* If the pipe has some FD that's something completely different, close it
442 if ((fd_pipe_out[1] != STDOUT_FILENO) && (fd_pipe_out[1] != STDERR_FILENO))
444 close (fd_pipe_out[1]);
445 fd_pipe_out[1] = STDOUT_FILENO;
449 /* does not return */
452 close (fd_pipe_in[0]);
453 close (fd_pipe_out[1]);
456 *fd_in = fd_pipe_in[1];
458 close (fd_pipe_in[1]);
461 *fd_out = fd_pipe_out[0];
463 close (fd_pipe_out[0]);
466 } /* int fork_child }}} */
468 static int parse_line (char *buffer) /* {{{ */
473 fields[0] = "PUTVAL";
474 fields_num = strsplit (buffer, fields + 1, STATIC_ARRAY_SIZE(fields) - 1);
476 if (strcasecmp (fields[1], "putval") == 0)
477 return (handle_putval (stdout, fields + 1, fields_num));
478 else if (strcasecmp (fields[1], "putnotif") == 0)
479 return (handle_putnotif (stdout, fields + 1, fields_num));
481 /* compatibility code */
482 return (handle_putval (stdout, fields, fields_num + 1));
483 } /* int parse_line }}} */
485 static void *exec_read_one (void *arg) /* {{{ */
487 program_list_t *pl = (program_list_t *) arg;
493 status = fork_child (pl, NULL, &fd);
495 pthread_exit ((void *) 1);
498 assert (pl->pid != 0);
500 fh = fdopen (fd, "r");
504 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
505 sstrerror (errno, errbuf, sizeof (errbuf)));
506 kill (pl->pid, SIGTERM);
509 pthread_exit ((void *) 1);
513 while (fgets (buffer, sizeof (buffer), fh) != NULL)
517 len = strlen (buffer);
519 /* Remove newline from end. */
520 while ((len > 0) && ((buffer[len - 1] == '\n')
521 || (buffer[len - 1] == '\r')))
522 buffer[--len] = '\0';
524 DEBUG ("exec plugin: exec_read_one: buffer = %s", buffer);
526 if (pl->flags & PL_NAGIOS_PLUGIN)
530 } /* while (fgets) */
534 if (waitpid (pl->pid, &status, 0) > 0)
537 DEBUG ("exec plugin: Child %i exited with status %i.",
538 (int) pl->pid, pl->status);
540 if (pl->flags & PL_NAGIOS_PLUGIN)
544 memset (&n, '\0', sizeof (n));
546 n.severity = NOTIF_FAILURE;
548 n.severity = NOTIF_OKAY;
549 else if (pl->status == 1)
550 n.severity = NOTIF_WARNING;
552 strncpy (n.message, buffer, sizeof (n.message));
553 n.message[sizeof (n.message) - 1] = '\0';
555 n.time = time (NULL);
557 strncpy (n.host, hostname_g, sizeof (n.host));
558 n.host[sizeof (n.host) - 1] = '\0';
560 plugin_dispatch_notification (&n);
565 pthread_mutex_lock (&pl_lock);
566 pl->flags &= ~PL_RUNNING;
567 pthread_mutex_unlock (&pl_lock);
569 pthread_exit ((void *) 0);
571 } /* void *exec_read_one }}} */
573 static void *exec_notification_one (void *arg) /* {{{ */
575 program_list_t *pl = ((program_list_and_notification_t *) arg)->pl;
576 const notification_t *n = &((program_list_and_notification_t *) arg)->n;
581 const char *severity;
583 pid = fork_child (pl, &fd, NULL);
585 pthread_exit ((void *) 1);
587 fh = fdopen (fd, "w");
591 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
592 sstrerror (errno, errbuf, sizeof (errbuf)));
593 kill (pl->pid, SIGTERM);
596 pthread_exit ((void *) 1);
599 severity = "FAILURE";
600 if (n->severity == NOTIF_WARNING)
601 severity = "WARNING";
602 else if (n->severity == NOTIF_OKAY)
605 fprintf (fh, "Severity: %s\n"
608 severity, (unsigned int) n->time, n->message);
610 /* Print the optional fields */
611 if (strlen (n->host) > 0)
612 fprintf (fh, "Host: %s\n", n->host);
613 if (strlen (n->plugin) > 0)
614 fprintf (fh, "Plugin: %s\n", n->plugin);
615 if (strlen (n->plugin_instance) > 0)
616 fprintf (fh, "PluginInstance: %s\n", n->plugin_instance);
617 if (strlen (n->type) > 0)
618 fprintf (fh, "Type: %s\n", n->type);
619 if (strlen (n->type_instance) > 0)
620 fprintf (fh, "TypeInstance: %s\n", n->type_instance);
622 /* Newline signalling end of data */
628 waitpid (pid, &status, 0);
630 DEBUG ("exec plugin: Child %i exited with status %i.",
634 pthread_exit ((void *) 0);
636 } /* void *exec_notification_one }}} */
638 static int exec_init (void) /* {{{ */
642 memset (&sa, '\0', sizeof (sa));
643 sa.sa_handler = sigchld_handler;
644 sigaction (SIGCHLD, &sa, NULL);
647 } /* int exec_init }}} */
649 static int exec_read (void) /* {{{ */
653 for (pl = pl_head; pl != NULL; pl = pl->next)
658 /* Only execute `normal' and `nagios' style executables here. */
659 if ((pl->flags & (PL_NAGIOS_PLUGIN | PL_NORMAL)) == 0)
662 pthread_mutex_lock (&pl_lock);
663 /* Skip if a child is already running. */
664 if ((pl->flags & PL_RUNNING) != 0)
666 pthread_mutex_unlock (&pl_lock);
669 pl->flags |= PL_RUNNING;
670 pthread_mutex_unlock (&pl_lock);
672 pthread_attr_init (&attr);
673 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
674 pthread_create (&t, &attr, exec_read_one, (void *) pl);
678 } /* int exec_read }}} */
680 static int exec_notification (const notification_t *n)
683 program_list_and_notification_t *pln;
685 for (pl = pl_head; pl != NULL; pl = pl->next)
690 /* Only execute `notification' style executables here. */
691 if ((pl->flags & PL_NOTIF_ACTION) == 0)
694 /* Skip if a child is already running. */
698 pln = (program_list_and_notification_t *) malloc (sizeof
699 (program_list_and_notification_t));
702 ERROR ("exec plugin: malloc failed.");
707 memcpy (&pln->n, n, sizeof (notification_t));
709 pthread_attr_init (&attr);
710 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
711 pthread_create (&t, &attr, exec_notification_one, (void *) pln);
715 } /* int exec_notification */
717 static int exec_shutdown (void) /* {{{ */
720 program_list_t *next;
729 kill (pl->pid, SIGTERM);
730 INFO ("exec plugin: Sent SIGTERM to %hu", (unsigned short int) pl->pid);
741 } /* int exec_shutdown }}} */
743 void module_register (void)
745 plugin_register_complex_config ("exec", exec_config);
746 plugin_register_init ("exec", exec_init);
747 plugin_register_read ("exec", exec_read);
748 plugin_register_notification ("exec", exec_notification);
749 plugin_register_shutdown ("exec", exec_shutdown);
750 } /* void module_register */
753 * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker