X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fexec.c;h=88026b662a0be208daa58b24c418357a1c63399a;hb=a94f533;hp=52dd831db7f4f773b18e495f74836ed88d06c24b;hpb=7af919ac4b76af981002875ff7bef99874f745b7;p=collectd.git diff --git a/src/exec.c b/src/exec.c index 52dd831d..88026b66 100644 --- a/src/exec.c +++ b/src/exec.c @@ -1,6 +1,6 @@ /** * collectd - src/exec.c - * Copyright (C) 2007 Florian octo Forster + * Copyright (C) 2007,2008 Florian octo Forster * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the @@ -22,7 +22,9 @@ #include "collectd.h" #include "common.h" #include "plugin.h" + #include "utils_cmd_putval.h" +#include "utils_cmd_putnotif.h" #include #include @@ -31,9 +33,22 @@ #include +#define PL_NORMAL 0x01 +#define PL_NOTIF_ACTION 0x02 + +#define PL_RUNNING 0x10 + /* * Private data types */ +/* + * Access to this structure is serialized using the `pl_lock' lock and the + * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so + * all functions used to handle notifications MUST NOT write to this structure. + * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag + * is set. + * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'. + */ struct program_list_s; typedef struct program_list_s program_list_t; struct program_list_s @@ -41,85 +56,215 @@ struct program_list_s char *user; char *group; char *exec; + char **argv; int pid; + int status; + int flags; program_list_t *next; }; +typedef struct program_list_and_notification_s +{ + program_list_t *pl; + notification_t n; +} program_list_and_notification_t; + /* * Private variables */ -static const char *config_keys[] = -{ - "Exec" -}; -static int config_keys_num = STATIC_ARRAY_SIZE (config_keys); - static program_list_t *pl_head = NULL; +static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER; /* * Functions */ -static int exec_config (const char *key, const char *value) +static void sigchld_handler (int signal) /* {{{ */ { - if (strcasecmp ("Exec", key) == 0) + pid_t pid; + int status; + while ((pid = waitpid (-1, &status, WNOHANG)) > 0) { program_list_t *pl; - pl = (program_list_t *) malloc (sizeof (program_list_t)); - if (pl == NULL) - return (1); - memset (pl, '\0', sizeof (program_list_t)); + for (pl = pl_head; pl != NULL; pl = pl->next) + if (pl->pid == pid) + break; + if (pl != NULL) + pl->status = status; + } /* while (waitpid) */ +} /* void sigchld_handler }}} */ + +static int exec_config_exec (oconfig_item_t *ci) /* {{{ */ +{ + program_list_t *pl; + char buffer[128]; + int i; - pl->user = strdup (value); - if (pl->user == NULL) - { - sfree (pl); - return (1); - } + if (ci->children_num != 0) + { + WARNING ("exec plugin: The config option `%s' may not be a block.", + ci->key); + return (-1); + } + if (ci->values_num < 2) + { + WARNING ("exec plugin: The config option `%s' needs at least two " + "arguments.", ci->key); + return (-1); + } + if ((ci->values[0].type != OCONFIG_TYPE_STRING) + || (ci->values[1].type != OCONFIG_TYPE_STRING)) + { + WARNING ("exec plugin: The first two arguments to the `%s' option must " + "be string arguments.", ci->key); + return (-1); + } + + pl = (program_list_t *) malloc (sizeof (program_list_t)); + if (pl == NULL) + { + ERROR ("exec plugin: malloc failed."); + return (-1); + } + memset (pl, '\0', sizeof (program_list_t)); + + if (strcasecmp ("NotificationExec", ci->key) == 0) + pl->flags |= PL_NOTIF_ACTION; + else + pl->flags |= PL_NORMAL; + + pl->user = strdup (ci->values[0].value.string); + if (pl->user == NULL) + { + ERROR ("exec plugin: strdup failed."); + sfree (pl); + return (-1); + } + + pl->group = strchr (pl->user, ':'); + if (pl->group != NULL) + { + *pl->group = '\0'; + pl->group++; + } + + pl->exec = strdup (ci->values[1].value.string); + if (pl->exec == NULL) + { + ERROR ("exec plugin: strdup failed."); + sfree (pl->user); + sfree (pl); + return (-1); + } + + pl->argv = (char **) malloc (ci->values_num * sizeof (char *)); + if (pl->argv == NULL) + { + ERROR ("exec plugin: malloc failed."); + sfree (pl->exec); + sfree (pl->user); + sfree (pl); + return (-1); + } + memset (pl->argv, '\0', ci->values_num * sizeof (char *)); + + { + char *tmp = strrchr (ci->values[1].value.string, '/'); + if (tmp == NULL) + sstrncpy (buffer, ci->values[1].value.string, sizeof (buffer)); + else + sstrncpy (buffer, tmp + 1, sizeof (buffer)); + } + pl->argv[0] = strdup (buffer); + if (pl->argv[0] == NULL) + { + ERROR ("exec plugin: malloc failed."); + sfree (pl->argv); + sfree (pl->exec); + sfree (pl->user); + sfree (pl); + return (-1); + } - pl->exec = strchr (pl->user, ' '); - if (pl->exec == NULL) + for (i = 1; i < (ci->values_num - 1); i++) + { + if (ci->values[i + 1].type == OCONFIG_TYPE_STRING) { - sfree (pl->user); - sfree (pl); - return (1); + pl->argv[i] = strdup (ci->values[i + 1].value.string); } - while (*pl->exec == ' ') + else { - *pl->exec = '\0'; - pl->exec++; + if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER) + { + ssnprintf (buffer, sizeof (buffer), "%lf", + ci->values[i + 1].value.number); + } + else + { + if (ci->values[i + 1].value.boolean) + sstrncpy (buffer, "true", sizeof (buffer)); + else + sstrncpy (buffer, "false", sizeof (buffer)); + } + + pl->argv[i] = strdup (buffer); } - if (*pl->exec == '\0') + if (pl->argv[i] == NULL) { - sfree (pl->user); - sfree (pl); - return (1); + ERROR ("exec plugin: strdup failed."); + break; } + } /* for (i) */ - pl->next = pl_head; - pl_head = pl; - - pl->group = strchr (pl->user, ':'); - if (NULL != pl->group) { - *pl->group = '\0'; - pl->group++; + if (i < (ci->values_num - 1)) + { + while ((--i) >= 0) + { + sfree (pl->argv[i]); } + sfree (pl->argv); + sfree (pl->exec); + sfree (pl->user); + sfree (pl); + return (-1); } - else + + for (i = 0; pl->argv[i] != NULL; i++) { - return (-1); + DEBUG ("exec plugin: argv[%i] = %s", i, pl->argv[i]); } + pl->next = pl_head; + pl_head = pl; + + return (0); +} /* int exec_config_exec }}} */ + +static int exec_config (oconfig_item_t *ci) /* {{{ */ +{ + int i; + + for (i = 0; i < ci->children_num; i++) + { + oconfig_item_t *child = ci->children + i; + if ((strcasecmp ("Exec", child->key) == 0) + || (strcasecmp ("NotificationExec", child->key) == 0)) + exec_config_exec (child); + else + { + WARNING ("exec plugin: Unknown config option `%s'.", child->key); + } + } /* for (i) */ + return (0); -} /* int exec_config */ +} /* int exec_config }}} */ -static void exec_child (program_list_t *pl) +static void exec_child (program_list_t *pl) /* {{{ */ { int status; int uid; int gid; int egid; - char *arg0; struct passwd *sp_ptr; struct passwd sp; @@ -224,45 +369,63 @@ static void exec_child (program_list_t *pl) exit (-1); } - arg0 = strrchr (pl->exec, '/'); - if (arg0 != NULL) - arg0++; - if ((arg0 == NULL) || (*arg0 == '\0')) - arg0 = pl->exec; - - status = execlp (pl->exec, arg0, (char *) 0); + status = execvp (pl->exec, pl->argv); ERROR ("exec plugin: exec failed: %s", sstrerror (errno, errbuf, sizeof (errbuf))); exit (-1); -} /* void exec_child */ +} /* void exec_child }}} */ -static int fork_child (program_list_t *pl) +/* + * Creates three pipes (one for reading, one for writing and one for errors), + * forks a child, sets up the pipes so that fd_in is connected to STDIN of + * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR + * of the child. Then is calls `exec_child'. + */ +static int fork_child (program_list_t *pl, int *fd_in, int *fd_out, int *fd_err) /* {{{ */ { - int fd_pipe[2]; + int fd_pipe_in[2]; + int fd_pipe_out[2]; + int fd_pipe_err[2]; + char errbuf[1024]; int status; + int pid; if (pl->pid != 0) return (-1); - status = pipe (fd_pipe); + status = pipe (fd_pipe_in); if (status != 0) { - char errbuf[1024]; ERROR ("exec plugin: pipe failed: %s", sstrerror (errno, errbuf, sizeof (errbuf))); return (-1); } - pl->pid = fork (); - if (pl->pid < 0) + status = pipe (fd_pipe_out); + if (status != 0) + { + ERROR ("exec plugin: pipe failed: %s", + sstrerror (errno, errbuf, sizeof (errbuf))); + return (-1); + } + + status = pipe (fd_pipe_err); + if (status != 0) + { + ERROR ("exec plugin: pipe failed: %s", + sstrerror (errno, errbuf, sizeof (errbuf))); + return (-1); + } + + pid = fork (); + if (pid < 0) { - char errbuf[1024]; ERROR ("exec plugin: fork failed: %s", sstrerror (errno, errbuf, sizeof (errbuf))); return (-1); } - else if (pl->pid == 0) + else if (pid == 0) { int fd_num; int fd; @@ -271,53 +434,227 @@ static int fork_child (program_list_t *pl) fd_num = getdtablesize (); for (fd = 0; fd < fd_num; fd++) { - if (fd == fd_pipe[1]) + if ((fd == fd_pipe_in[0]) + || (fd == fd_pipe_out[1]) + || (fd == fd_pipe_err[1])) continue; close (fd); } - /* Connect the pipe to STDOUT and STDERR */ - if (fd_pipe[1] != STDOUT_FILENO) - dup2 (fd_pipe[1], STDOUT_FILENO); - if (fd_pipe[1] != STDERR_FILENO) - dup2 (fd_pipe[1], STDERR_FILENO); - if ((fd_pipe[1] != STDOUT_FILENO) && (fd_pipe[1] != STDERR_FILENO)) - close (fd_pipe[1]); + /* Connect the `in' pipe to STDIN */ + if (fd_pipe_in[0] != STDIN_FILENO) + { + dup2 (fd_pipe_in[0], STDIN_FILENO); + close (fd_pipe_in[0]); + } + + /* Now connect the `out' pipe to STDOUT */ + if (fd_pipe_out[1] != STDOUT_FILENO) + { + dup2 (fd_pipe_out[1], STDOUT_FILENO); + close (fd_pipe_out[1]); + } + + /* Now connect the `out' pipe to STDOUT */ + if (fd_pipe_err[1] != STDERR_FILENO) + { + dup2 (fd_pipe_err[1], STDERR_FILENO); + close (fd_pipe_err[1]); + } exec_child (pl); /* does not return */ } - close (fd_pipe[1]); - return (fd_pipe[0]); -} /* int fork_child */ + close (fd_pipe_in[0]); + close (fd_pipe_out[1]); + close (fd_pipe_err[1]); -static int parse_line (char *buffer) -{ - char *fields[256]; - int fields_num; + if (fd_in != NULL) + *fd_in = fd_pipe_in[1]; + else + close (fd_pipe_in[1]); - fields[0] = "PUTVAL"; - fields_num = strsplit (buffer, &fields[1], STATIC_ARRAY_SIZE(fields) - 1); + if (fd_out != NULL) + *fd_out = fd_pipe_out[0]; + else + close (fd_pipe_out[0]); - handle_putval (stdout, fields, fields_num + 1); - return (0); -} /* int parse_line */ + if (fd_err != NULL) + *fd_err = fd_pipe_err[0]; + else + close (fd_pipe_err[0]); -static void *exec_read_one (void *arg) + return (pid); +} /* int fork_child }}} */ + +static int parse_line (char *buffer) /* {{{ */ +{ + if (strncasecmp ("PUTVAL", buffer, strlen ("PUTVAL")) == 0) + return (handle_putval (stdout, buffer)); +#if !COLLECT_DEBUG +#error "TODO: PUTNOTIF" + else if (strcasecmp (fields[1], "putnotif") == 0) + return (handle_putnotif (stdout, fields + 1, fields_num)); +#endif + else + { + /* For backwards compatibility */ + char tmp[1220]; + /* Let's annoy the user a bit.. */ + INFO ("exec plugin: Prepending `PUTVAL' to this line: %s", buffer); + ssnprintf (tmp, sizeof (tmp), "PUTVAL %s", buffer); + return (handle_putval (stdout, tmp)); + } +} /* int parse_line }}} */ + +static void *exec_read_one (void *arg) /* {{{ */ { program_list_t *pl = (program_list_t *) arg; - int fd; - FILE *fh; - char buffer[1024]; + int fd, fd_err, highest_fd; + fd_set fdset, copy; + int status; + char buffer[1200]; /* if not completely read */ + char buffer_err[1024]; + char *pbuffer = buffer; + char *pbuffer_err = buffer_err; - fd = fork_child (pl); - if (fd < 0) + status = fork_child (pl, NULL, &fd, &fd_err); + if (status < 0) pthread_exit ((void *) 1); + pl->pid = status; assert (pl->pid != 0); - fh = fdopen (fd, "r"); + FD_ZERO( &fdset ); + FD_SET(fd, &fdset); + FD_SET(fd_err, &fdset); + + /* Determine the highest file descriptor */ + highest_fd = (fd > fd_err) ? fd : fd_err; + + /* We use a copy of fdset, as select modifies it */ + copy = fdset; + + while (select(highest_fd + 1, ©, NULL, NULL, NULL ) > 0) + { + int len; + + if (FD_ISSET(fd, ©)) + { + char *pnl; + + len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer)); + + if (len < 0) + { + if (errno == EAGAIN || errno == EINTR) continue; + break; + } + else if (len == 0) break; /* We've reached EOF */ + + pbuffer[len] = '\0'; + + len += pbuffer - buffer; + pbuffer = buffer; + + while ((pnl = strchr(pbuffer, '\n'))) + { + *pnl = '\0'; + if (*(pnl-1) == '\r' ) *(pnl-1) = '\0'; + + parse_line (pbuffer); + + pbuffer = ++pnl; + } + /* not completely read ? */ + if (pbuffer - buffer < len) + { + len -= pbuffer - buffer; + memmove(buffer, pbuffer, len); + pbuffer = buffer + len; + } + else + pbuffer = buffer; + } + else if (FD_ISSET(fd_err, ©)) + { + char *pnl; + + len = read(fd_err, pbuffer_err, sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err)); + + if (len < 0) + { + if (errno == EAGAIN || errno == EINTR) continue; + break; + } + else if (len == 0) break; /* We've reached EOF */ + + pbuffer_err[len] = '\0'; + + len += pbuffer_err - buffer_err; + pbuffer_err = buffer_err; + + while ((pnl = strchr(pbuffer_err, '\n'))) + { + *pnl = '\0'; + if (*(pnl-1) == '\r' ) *(pnl-1) = '\0'; + + ERROR ("exec plugin: exec_read_one: error = %s", pbuffer_err); + + pbuffer_err = ++pnl; + } + /* not completely read ? */ + if (pbuffer_err - buffer_err < len) + { + len -= pbuffer_err - buffer_err; + memmove(buffer_err, pbuffer_err, len); + pbuffer_err = buffer_err + len; + } + else + pbuffer_err = buffer_err; + } + /* reset copy */ + copy = fdset; + } + + if (waitpid (pl->pid, &status, 0) > 0) + pl->status = status; + + DEBUG ("exec plugin: Child %i exited with status %i.", + (int) pl->pid, pl->status); + + pl->pid = 0; + + pthread_mutex_lock (&pl_lock); + pl->flags &= ~PL_RUNNING; + pthread_mutex_unlock (&pl_lock); + + close (fd); + close (fd_err); + + pthread_exit ((void *) 0); + return (NULL); +} /* void *exec_read_one }}} */ + +static void *exec_notification_one (void *arg) /* {{{ */ +{ + program_list_t *pl = ((program_list_and_notification_t *) arg)->pl; + notification_t *n = &((program_list_and_notification_t *) arg)->n; + notification_meta_t *meta; + int fd; + FILE *fh; + int pid; + int status; + const char *severity; + + pid = fork_child (pl, &fd, NULL, NULL); + if (pid < 0) { + sfree (arg); + pthread_exit ((void *) 1); + } + + fh = fdopen (fd, "w"); if (fh == NULL) { char errbuf[1024]; @@ -326,33 +663,76 @@ static void *exec_read_one (void *arg) kill (pl->pid, SIGTERM); pl->pid = 0; close (fd); + sfree (arg); pthread_exit ((void *) 1); } - while (fgets (buffer, sizeof (buffer), fh) != NULL) + severity = "FAILURE"; + if (n->severity == NOTIF_WARNING) + severity = "WARNING"; + else if (n->severity == NOTIF_OKAY) + severity = "OKAY"; + + fprintf (fh, + "Severity: %s\n" + "Time: %u\n", + severity, (unsigned int) n->time); + + /* Print the optional fields */ + if (strlen (n->host) > 0) + fprintf (fh, "Host: %s\n", n->host); + if (strlen (n->plugin) > 0) + fprintf (fh, "Plugin: %s\n", n->plugin); + if (strlen (n->plugin_instance) > 0) + fprintf (fh, "PluginInstance: %s\n", n->plugin_instance); + if (strlen (n->type) > 0) + fprintf (fh, "Type: %s\n", n->type); + if (strlen (n->type_instance) > 0) + fprintf (fh, "TypeInstance: %s\n", n->type_instance); + + for (meta = n->meta; meta != NULL; meta = meta->next) { - int len; - - len = strlen (buffer); + if (meta->type == NM_TYPE_STRING) + fprintf (fh, "%s: %s\n", meta->name, meta->value_string); + else if (meta->type == NM_TYPE_SIGNED_INT) + fprintf (fh, "%s: %"PRIi64"\n", meta->name, meta->value_signed_int); + else if (meta->type == NM_TYPE_UNSIGNED_INT) + fprintf (fh, "%s: %"PRIu64"\n", meta->name, meta->value_unsigned_int); + else if (meta->type == NM_TYPE_DOUBLE) + fprintf (fh, "%s: %e\n", meta->name, meta->value_double); + else if (meta->type == NM_TYPE_BOOLEAN) + fprintf (fh, "%s: %s\n", meta->name, + meta->value_boolean ? "true" : "false"); + } - /* Remove newline from end. */ - while ((len > 0) && ((buffer[len - 1] == '\n') - || (buffer[len - 1] == '\r'))) - buffer[--len] = '\0'; + fprintf (fh, "\n%s\n", n->message); - DEBUG ("exec plugin: exec_read_one: buffer = %s", buffer); + fflush (fh); + fclose (fh); - parse_line (buffer); - } /* while (fgets) */ + waitpid (pid, &status, 0); - fclose (fh); - pl->pid = 0; + DEBUG ("exec plugin: Child %i exited with status %i.", + pid, status); + plugin_notification_meta_free (n); + sfree (arg); pthread_exit ((void *) 0); return (NULL); -} /* void *exec_read_one */ +} /* void *exec_notification_one }}} */ -static int exec_read (void) +static int exec_init (void) /* {{{ */ +{ + struct sigaction sa; + + memset (&sa, '\0', sizeof (sa)); + sa.sa_handler = sigchld_handler; + sigaction (SIGCHLD, &sa, NULL); + + return (0); +} /* int exec_init }}} */ + +static int exec_read (void) /* {{{ */ { program_list_t *pl; @@ -361,8 +741,19 @@ static int exec_read (void) pthread_t t; pthread_attr_t attr; - if (pl->pid != 0) + /* Only execute `normal' style executables here. */ + if ((pl->flags & PL_NORMAL) == 0) + continue; + + pthread_mutex_lock (&pl_lock); + /* Skip if a child is already running. */ + if ((pl->flags & PL_RUNNING) != 0) + { + pthread_mutex_unlock (&pl_lock); continue; + } + pl->flags |= PL_RUNNING; + pthread_mutex_unlock (&pl_lock); pthread_attr_init (&attr); pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED); @@ -370,9 +761,51 @@ static int exec_read (void) } /* for (pl) */ return (0); -} /* int exec_read */ +} /* int exec_read }}} */ + +static int exec_notification (const notification_t *n) +{ + program_list_t *pl; + program_list_and_notification_t *pln; + + for (pl = pl_head; pl != NULL; pl = pl->next) + { + pthread_t t; + pthread_attr_t attr; + + /* Only execute `notification' style executables here. */ + if ((pl->flags & PL_NOTIF_ACTION) == 0) + continue; + + /* Skip if a child is already running. */ + if (pl->pid != 0) + continue; + + pln = (program_list_and_notification_t *) malloc (sizeof + (program_list_and_notification_t)); + if (pln == NULL) + { + ERROR ("exec plugin: malloc failed."); + continue; + } + + pln->pl = pl; + memcpy (&pln->n, n, sizeof (notification_t)); + + /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy' + * will run into an endless loop. */ + pln->n.meta = NULL; + plugin_notification_meta_copy (&pln->n, n); + + pthread_attr_init (&attr); + pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED); + pthread_create (&t, &attr, exec_notification_one, (void *) pln); + } /* for (pl) */ + + return (0); +} /* int exec_notification */ -static int exec_shutdown (void) +static int exec_shutdown (void) /* {{{ */ { program_list_t *pl; program_list_t *next; @@ -396,15 +829,17 @@ static int exec_shutdown (void) pl_head = NULL; return (0); -} /* int exec_shutdown */ +} /* int exec_shutdown }}} */ void module_register (void) { - plugin_register_config ("exec", exec_config, config_keys, config_keys_num); + plugin_register_complex_config ("exec", exec_config); + plugin_register_init ("exec", exec_init); plugin_register_read ("exec", exec_read); + plugin_register_notification ("exec", exec_notification); plugin_register_shutdown ("exec", exec_shutdown); } /* void module_register */ /* - * vim:shiftwidth=2:softtabstop=2:tabstop=8 + * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker */