filecount plugin: mark function as static
[collectd.git] / src / exec.c
1 /**
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
6  *
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.
10  *
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.
15  *
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
19  *
20  * Authors:
21  *   Florian octo Forster <octo at collectd.org>
22  *   Sebastian Harl <sh at tokkee.org>
23  *   Peter Holik <peter at holik.at>
24  **/
25
26 #define _DEFAULT_SOURCE
27 #define _BSD_SOURCE /* For setgroups */
28
29 #include "collectd.h"
30
31 #include "common.h"
32 #include "plugin.h"
33
34 #include "utils_cmd_putnotif.h"
35 #include "utils_cmd_putval.h"
36
37 #include <grp.h>
38 #include <pwd.h>
39 #include <signal.h>
40 #include <sys/types.h>
41
42 #ifdef HAVE_SYS_CAPABILITY_H
43 #include <sys/capability.h>
44 #endif
45
46 #define PL_NORMAL 0x01
47 #define PL_NOTIF_ACTION 0x02
48
49 #define PL_RUNNING 0x10
50
51 /*
52  * Private data types
53  */
54 /*
55  * Access to this structure is serialized using the `pl_lock' lock and the
56  * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
57  * all functions used to handle notifications MUST NOT write to this structure.
58  * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
59  * is set.
60  * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
61  */
62 struct program_list_s;
63 typedef struct program_list_s program_list_t;
64 struct program_list_s {
65   char *user;
66   char *group;
67   char *exec;
68   char **argv;
69   int pid;
70   int status;
71   int flags;
72   program_list_t *next;
73 };
74
75 typedef struct program_list_and_notification_s {
76   program_list_t *pl;
77   notification_t n;
78 } program_list_and_notification_t;
79
80 /*
81  * Private variables
82  */
83 static program_list_t *pl_head = NULL;
84 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
85
86 /*
87  * Functions
88  */
89 static void sigchld_handler(int __attribute__((unused)) signal) /* {{{ */
90 {
91   pid_t pid;
92   int status;
93   while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
94     program_list_t *pl;
95     for (pl = pl_head; pl != NULL; pl = pl->next)
96       if (pl->pid == pid)
97         break;
98     if (pl != NULL)
99       pl->status = status;
100   } /* while (waitpid) */
101 } /* void sigchld_handler }}} */
102
103 static int exec_config_exec(oconfig_item_t *ci) /* {{{ */
104 {
105   program_list_t *pl;
106   char buffer[128];
107   int i;
108
109   if (ci->children_num != 0) {
110     WARNING("exec plugin: The config option `%s' may not be a block.", ci->key);
111     return -1;
112   }
113   if (ci->values_num < 2) {
114     WARNING("exec plugin: The config option `%s' needs at least two "
115             "arguments.",
116             ci->key);
117     return -1;
118   }
119   if ((ci->values[0].type != OCONFIG_TYPE_STRING) ||
120       (ci->values[1].type != OCONFIG_TYPE_STRING)) {
121     WARNING("exec plugin: The first two arguments to the `%s' option must "
122             "be string arguments.",
123             ci->key);
124     return -1;
125   }
126
127   pl = calloc(1, sizeof(*pl));
128   if (pl == NULL) {
129     ERROR("exec plugin: calloc failed.");
130     return -1;
131   }
132
133   if (strcasecmp("NotificationExec", ci->key) == 0)
134     pl->flags |= PL_NOTIF_ACTION;
135   else
136     pl->flags |= PL_NORMAL;
137
138   pl->user = strdup(ci->values[0].value.string);
139   if (pl->user == NULL) {
140     ERROR("exec plugin: strdup failed.");
141     sfree(pl);
142     return -1;
143   }
144
145   pl->group = strchr(pl->user, ':');
146   if (pl->group != NULL) {
147     *pl->group = '\0';
148     pl->group++;
149   }
150
151   pl->exec = strdup(ci->values[1].value.string);
152   if (pl->exec == NULL) {
153     ERROR("exec plugin: strdup failed.");
154     sfree(pl->user);
155     sfree(pl);
156     return -1;
157   }
158
159   pl->argv = calloc(ci->values_num, sizeof(*pl->argv));
160   if (pl->argv == NULL) {
161     ERROR("exec plugin: calloc failed.");
162     sfree(pl->exec);
163     sfree(pl->user);
164     sfree(pl);
165     return -1;
166   }
167
168   {
169     char *tmp = strrchr(ci->values[1].value.string, '/');
170     if (tmp == NULL)
171       sstrncpy(buffer, ci->values[1].value.string, sizeof(buffer));
172     else
173       sstrncpy(buffer, tmp + 1, sizeof(buffer));
174   }
175   pl->argv[0] = strdup(buffer);
176   if (pl->argv[0] == NULL) {
177     ERROR("exec plugin: strdup failed.");
178     sfree(pl->argv);
179     sfree(pl->exec);
180     sfree(pl->user);
181     sfree(pl);
182     return -1;
183   }
184
185   for (i = 1; i < (ci->values_num - 1); i++) {
186     if (ci->values[i + 1].type == OCONFIG_TYPE_STRING) {
187       pl->argv[i] = strdup(ci->values[i + 1].value.string);
188     } else {
189       if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER) {
190         snprintf(buffer, sizeof(buffer), "%lf", ci->values[i + 1].value.number);
191       } else {
192         if (ci->values[i + 1].value.boolean)
193           sstrncpy(buffer, "true", sizeof(buffer));
194         else
195           sstrncpy(buffer, "false", sizeof(buffer));
196       }
197
198       pl->argv[i] = strdup(buffer);
199     }
200
201     if (pl->argv[i] == NULL) {
202       ERROR("exec plugin: strdup failed.");
203       break;
204     }
205   } /* for (i) */
206
207   if (i < (ci->values_num - 1)) {
208     while ((--i) >= 0) {
209       sfree(pl->argv[i]);
210     }
211     sfree(pl->argv);
212     sfree(pl->exec);
213     sfree(pl->user);
214     sfree(pl);
215     return -1;
216   }
217
218   for (i = 0; pl->argv[i] != NULL; i++) {
219     DEBUG("exec plugin: argv[%i] = %s", i, pl->argv[i]);
220   }
221
222   pl->next = pl_head;
223   pl_head = pl;
224
225   return 0;
226 } /* int exec_config_exec }}} */
227
228 static int exec_config(oconfig_item_t *ci) /* {{{ */
229 {
230   for (int i = 0; i < ci->children_num; i++) {
231     oconfig_item_t *child = ci->children + i;
232     if ((strcasecmp("Exec", child->key) == 0) ||
233         (strcasecmp("NotificationExec", child->key) == 0))
234       exec_config_exec(child);
235     else {
236       WARNING("exec plugin: Unknown config option `%s'.", child->key);
237     }
238   } /* for (i) */
239
240   return 0;
241 } /* int exec_config }}} */
242
243 static void set_environment(void) /* {{{ */
244 {
245   char buffer[1024];
246
247 #ifdef HAVE_SETENV
248   snprintf(buffer, sizeof(buffer), "%.3f",
249            CDTIME_T_TO_DOUBLE(plugin_get_interval()));
250   setenv("COLLECTD_INTERVAL", buffer, /* overwrite = */ 1);
251
252   sstrncpy(buffer, hostname_g, sizeof(buffer));
253   setenv("COLLECTD_HOSTNAME", buffer, /* overwrite = */ 1);
254 #else
255   snprintf(buffer, sizeof(buffer), "COLLECTD_INTERVAL=%.3f",
256            CDTIME_T_TO_DOUBLE(plugin_get_interval()));
257   putenv(buffer);
258
259   snprintf(buffer, sizeof(buffer), "COLLECTD_HOSTNAME=%s", hostname_g);
260   putenv(buffer);
261 #endif
262 } /* }}} void set_environment */
263
264 __attribute__((noreturn)) static void exec_child(program_list_t *pl, int uid,
265                                                  int gid, int egid) /* {{{ */
266 {
267   int status;
268
269 #if HAVE_SETGROUPS
270   if (getuid() == 0) {
271     gid_t glist[2];
272     size_t glist_len;
273
274     glist[0] = gid;
275     glist_len = 1;
276
277     if ((gid != egid) && (egid != -1)) {
278       glist[1] = egid;
279       glist_len = 2;
280     }
281
282     setgroups(glist_len, glist);
283   }
284 #endif /* HAVE_SETGROUPS */
285
286   status = setgid(gid);
287   if (status != 0) {
288     ERROR("exec plugin: setgid (%i) failed: %s", gid, STRERRNO);
289     exit(-1);
290   }
291
292   if (egid != -1) {
293     status = setegid(egid);
294     if (status != 0) {
295       ERROR("exec plugin: setegid (%i) failed: %s", egid, STRERRNO);
296       exit(-1);
297     }
298   }
299
300   status = setuid(uid);
301   if (status != 0) {
302     ERROR("exec plugin: setuid (%i) failed: %s", uid, STRERRNO);
303     exit(-1);
304   }
305
306   execvp(pl->exec, pl->argv);
307
308   ERROR("exec plugin: Failed to execute ``%s'': %s", pl->exec, STRERRNO);
309   exit(-1);
310 } /* void exec_child }}} */
311
312 static void reset_signal_mask(void) /* {{{ */
313 {
314   sigset_t ss;
315
316   sigemptyset(&ss);
317   sigprocmask(SIG_SETMASK, &ss, /* old mask = */ NULL);
318 } /* }}} void reset_signal_mask */
319
320 static int create_pipe(int fd_pipe[2]) /* {{{ */
321 {
322   int status;
323
324   status = pipe(fd_pipe);
325   if (status != 0) {
326     ERROR("exec plugin: pipe failed: %s", STRERRNO);
327     return -1;
328   }
329
330   return 0;
331 } /* }}} int create_pipe */
332
333 static void close_pipe(int fd_pipe[2]) /* {{{ */
334 {
335   if (fd_pipe[0] != -1)
336     close(fd_pipe[0]);
337
338   if (fd_pipe[1] != -1)
339     close(fd_pipe[1]);
340 } /* }}} void close_pipe */
341
342 /*
343  * Creates three pipes (one for reading, one for writing and one for errors),
344  * forks a child, sets up the pipes so that fd_in is connected to STDIN of
345  * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
346  * of the child. Then is calls `exec_child'.
347  */
348 static int fork_child(program_list_t *pl, int *fd_in, int *fd_out,
349                       int *fd_err) /* {{{ */
350 {
351   int fd_pipe_in[2] = {-1, -1};
352   int fd_pipe_out[2] = {-1, -1};
353   int fd_pipe_err[2] = {-1, -1};
354   int status;
355   int pid;
356
357   int uid;
358   int gid;
359   int egid;
360
361   struct passwd *sp_ptr;
362   struct passwd sp;
363
364   if (pl->pid != 0)
365     return -1;
366
367   long int nambuf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
368   if (nambuf_size <= 0)
369     nambuf_size = sysconf(_SC_PAGESIZE);
370   if (nambuf_size <= 0)
371     nambuf_size = 4096;
372   char nambuf[nambuf_size];
373
374   if ((create_pipe(fd_pipe_in) == -1) || (create_pipe(fd_pipe_out) == -1) ||
375       (create_pipe(fd_pipe_err) == -1))
376     goto failed;
377
378   sp_ptr = NULL;
379   status = getpwnam_r(pl->user, &sp, nambuf, sizeof(nambuf), &sp_ptr);
380   if (status != 0) {
381     ERROR("exec plugin: Failed to get user information for user ``%s'': %s",
382           pl->user, STRERROR(status));
383     goto failed;
384   }
385
386   if (sp_ptr == NULL) {
387     ERROR("exec plugin: No such user: `%s'", pl->user);
388     goto failed;
389   }
390
391   uid = sp.pw_uid;
392   gid = sp.pw_gid;
393   if (uid == 0) {
394     ERROR("exec plugin: Cowardly refusing to exec program as root.");
395     goto failed;
396   }
397
398   /* The group configured in the configfile is set as effective group, because
399    * this way the forked process can (re-)gain the user's primary group. */
400   egid = -1;
401   if (pl->group != NULL) {
402     if (*pl->group != '\0') {
403       struct group *gr_ptr = NULL;
404       struct group gr;
405
406       long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
407       if (grbuf_size <= 0)
408         grbuf_size = sysconf(_SC_PAGESIZE);
409       if (grbuf_size <= 0)
410         grbuf_size = 4096;
411       char grbuf[grbuf_size];
412
413       status = getgrnam_r(pl->group, &gr, grbuf, sizeof(grbuf), &gr_ptr);
414       if (status != 0) {
415         ERROR("exec plugin: Failed to get group information "
416               "for group ``%s'': %s",
417               pl->group, STRERROR(status));
418         goto failed;
419       }
420       if (gr_ptr == NULL) {
421         ERROR("exec plugin: No such group: `%s'", pl->group);
422         goto failed;
423       }
424
425       egid = gr.gr_gid;
426     } else {
427       egid = gid;
428     }
429   } /* if (pl->group == NULL) */
430
431   pid = fork();
432   if (pid < 0) {
433     ERROR("exec plugin: fork failed: %s", STRERRNO);
434     goto failed;
435   } else if (pid == 0) {
436     int fd_num;
437
438     /* Close all file descriptors but the pipe end we need. */
439     fd_num = getdtablesize();
440     for (int fd = 0; fd < fd_num; fd++) {
441       if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]) ||
442           (fd == fd_pipe_err[1]))
443         continue;
444       close(fd);
445     }
446
447     /* Connect the `in' pipe to STDIN */
448     if (fd_pipe_in[0] != STDIN_FILENO) {
449       dup2(fd_pipe_in[0], STDIN_FILENO);
450       close(fd_pipe_in[0]);
451     }
452
453     /* Now connect the `out' pipe to STDOUT */
454     if (fd_pipe_out[1] != STDOUT_FILENO) {
455       dup2(fd_pipe_out[1], STDOUT_FILENO);
456       close(fd_pipe_out[1]);
457     }
458
459     /* Now connect the `err' pipe to STDERR */
460     if (fd_pipe_err[1] != STDERR_FILENO) {
461       dup2(fd_pipe_err[1], STDERR_FILENO);
462       close(fd_pipe_err[1]);
463     }
464
465     set_environment();
466
467     /* Unblock all signals */
468     reset_signal_mask();
469
470     exec_child(pl, uid, gid, egid);
471     /* does not return */
472   }
473
474   close(fd_pipe_in[0]);
475   close(fd_pipe_out[1]);
476   close(fd_pipe_err[1]);
477
478   if (fd_in != NULL)
479     *fd_in = fd_pipe_in[1];
480   else
481     close(fd_pipe_in[1]);
482
483   if (fd_out != NULL)
484     *fd_out = fd_pipe_out[0];
485   else
486     close(fd_pipe_out[0]);
487
488   if (fd_err != NULL)
489     *fd_err = fd_pipe_err[0];
490   else
491     close(fd_pipe_err[0]);
492
493   return pid;
494
495 failed:
496   close_pipe(fd_pipe_in);
497   close_pipe(fd_pipe_out);
498   close_pipe(fd_pipe_err);
499
500   return -1;
501 } /* int fork_child }}} */
502
503 static int parse_line(char *buffer) /* {{{ */
504 {
505   if (strncasecmp("PUTVAL", buffer, strlen("PUTVAL")) == 0)
506     return cmd_handle_putval(stdout, buffer);
507   else if (strncasecmp("PUTNOTIF", buffer, strlen("PUTNOTIF")) == 0)
508     return handle_putnotif(stdout, buffer);
509   else {
510     ERROR("exec plugin: Unable to parse command, ignoring line: \"%s\"",
511           buffer);
512     return -1;
513   }
514 } /* int parse_line }}} */
515
516 static void *exec_read_one(void *arg) /* {{{ */
517 {
518   program_list_t *pl = (program_list_t *)arg;
519   int fd, fd_err, highest_fd;
520   fd_set fdset, copy;
521   int status;
522   char buffer[1200]; /* if not completely read */
523   char buffer_err[1024];
524   char *pbuffer = buffer;
525   char *pbuffer_err = buffer_err;
526
527   status = fork_child(pl, NULL, &fd, &fd_err);
528   if (status < 0) {
529     /* Reset the "running" flag */
530     pthread_mutex_lock(&pl_lock);
531     pl->flags &= ~PL_RUNNING;
532     pthread_mutex_unlock(&pl_lock);
533     pthread_exit((void *)1);
534   }
535   pl->pid = status;
536
537   assert(pl->pid != 0);
538
539   FD_ZERO(&fdset);
540   FD_SET(fd, &fdset);
541   FD_SET(fd_err, &fdset);
542
543   /* Determine the highest file descriptor */
544   highest_fd = (fd > fd_err) ? fd : fd_err;
545
546   /* We use a copy of fdset, as select modifies it */
547   copy = fdset;
548
549   while (1) {
550     int len;
551
552     status = select(highest_fd + 1, &copy, NULL, NULL, NULL);
553     if (status < 0) {
554       if (errno == EINTR)
555         continue;
556       break;
557     }
558
559     if (FD_ISSET(fd, &copy)) {
560       char *pnl;
561
562       len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
563
564       if (len < 0) {
565         if (errno == EAGAIN || errno == EINTR)
566           continue;
567         break;
568       } else if (len == 0)
569         break; /* We've reached EOF */
570
571       pbuffer[len] = '\0';
572
573       len += pbuffer - buffer;
574       pbuffer = buffer;
575
576       while ((pnl = strchr(pbuffer, '\n'))) {
577         *pnl = '\0';
578         if (*(pnl - 1) == '\r')
579           *(pnl - 1) = '\0';
580
581         parse_line(pbuffer);
582
583         pbuffer = ++pnl;
584       }
585       /* not completely read ? */
586       if (pbuffer - buffer < len) {
587         len -= pbuffer - buffer;
588         memmove(buffer, pbuffer, len);
589         pbuffer = buffer + len;
590       } else
591         pbuffer = buffer;
592     } else if (FD_ISSET(fd_err, &copy)) {
593       char *pnl;
594
595       len = read(fd_err, pbuffer_err,
596                  sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
597
598       if (len < 0) {
599         if (errno == EAGAIN || errno == EINTR)
600           continue;
601         break;
602       } else if (len == 0) {
603         /* We've reached EOF */
604         NOTICE("exec plugin: Program `%s' has closed STDERR.", pl->exec);
605
606         /* Remove file descriptor form select() set. */
607         FD_CLR(fd_err, &fdset);
608         copy = fdset;
609         highest_fd = fd;
610
611         /* Clean up file descriptor */
612         close(fd_err);
613         fd_err = -1;
614         continue;
615       }
616
617       pbuffer_err[len] = '\0';
618
619       len += pbuffer_err - buffer_err;
620       pbuffer_err = buffer_err;
621
622       while ((pnl = strchr(pbuffer_err, '\n'))) {
623         *pnl = '\0';
624         if (*(pnl - 1) == '\r')
625           *(pnl - 1) = '\0';
626
627         ERROR("exec plugin: exec_read_one: error = %s", pbuffer_err);
628
629         pbuffer_err = ++pnl;
630       }
631       /* not completely read ? */
632       if (pbuffer_err - buffer_err < len) {
633         len -= pbuffer_err - buffer_err;
634         memmove(buffer_err, pbuffer_err, len);
635         pbuffer_err = buffer_err + len;
636       } else
637         pbuffer_err = buffer_err;
638     }
639     /* reset copy */
640     copy = fdset;
641   }
642
643   DEBUG("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
644   if (waitpid(pl->pid, &status, 0) > 0)
645     pl->status = status;
646
647   DEBUG("exec plugin: Child %i exited with status %i.", (int)pl->pid,
648         pl->status);
649
650   pl->pid = 0;
651
652   pthread_mutex_lock(&pl_lock);
653   pl->flags &= ~PL_RUNNING;
654   pthread_mutex_unlock(&pl_lock);
655
656   close(fd);
657   if (fd_err >= 0)
658     close(fd_err);
659
660   pthread_exit((void *)0);
661   return NULL;
662 } /* void *exec_read_one }}} */
663
664 static void *exec_notification_one(void *arg) /* {{{ */
665 {
666   program_list_t *pl = ((program_list_and_notification_t *)arg)->pl;
667   notification_t *n = &((program_list_and_notification_t *)arg)->n;
668   int fd;
669   FILE *fh;
670   int pid;
671   int status;
672   const char *severity;
673
674   pid = fork_child(pl, &fd, NULL, NULL);
675   if (pid < 0) {
676     sfree(arg);
677     pthread_exit((void *)1);
678   }
679
680   fh = fdopen(fd, "w");
681   if (fh == NULL) {
682     ERROR("exec plugin: fdopen (%i) failed: %s", fd, STRERRNO);
683     kill(pid, SIGTERM);
684     close(fd);
685     sfree(arg);
686     pthread_exit((void *)1);
687   }
688
689   severity = "FAILURE";
690   if (n->severity == NOTIF_WARNING)
691     severity = "WARNING";
692   else if (n->severity == NOTIF_OKAY)
693     severity = "OKAY";
694
695   fprintf(fh, "Severity: %s\n"
696               "Time: %.3f\n",
697           severity, CDTIME_T_TO_DOUBLE(n->time));
698
699   /* Print the optional fields */
700   if (strlen(n->host) > 0)
701     fprintf(fh, "Host: %s\n", n->host);
702   if (strlen(n->plugin) > 0)
703     fprintf(fh, "Plugin: %s\n", n->plugin);
704   if (strlen(n->plugin_instance) > 0)
705     fprintf(fh, "PluginInstance: %s\n", n->plugin_instance);
706   if (strlen(n->type) > 0)
707     fprintf(fh, "Type: %s\n", n->type);
708   if (strlen(n->type_instance) > 0)
709     fprintf(fh, "TypeInstance: %s\n", n->type_instance);
710
711   for (notification_meta_t *meta = n->meta; meta != NULL; meta = meta->next) {
712     if (meta->type == NM_TYPE_STRING)
713       fprintf(fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
714     else if (meta->type == NM_TYPE_SIGNED_INT)
715       fprintf(fh, "%s: %" PRIi64 "\n", meta->name,
716               meta->nm_value.nm_signed_int);
717     else if (meta->type == NM_TYPE_UNSIGNED_INT)
718       fprintf(fh, "%s: %" PRIu64 "\n", meta->name,
719               meta->nm_value.nm_unsigned_int);
720     else if (meta->type == NM_TYPE_DOUBLE)
721       fprintf(fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
722     else if (meta->type == NM_TYPE_BOOLEAN)
723       fprintf(fh, "%s: %s\n", meta->name,
724               meta->nm_value.nm_boolean ? "true" : "false");
725   }
726
727   fprintf(fh, "\n%s\n", n->message);
728
729   fflush(fh);
730   fclose(fh);
731
732   waitpid(pid, &status, 0);
733
734   DEBUG("exec plugin: Child %i exited with status %i.", pid, status);
735
736   if (n->meta != NULL)
737     plugin_notification_meta_free(n->meta);
738   n->meta = NULL;
739   sfree(arg);
740   pthread_exit((void *)0);
741   return NULL;
742 } /* void *exec_notification_one }}} */
743
744 static int exec_init(void) /* {{{ */
745 {
746   struct sigaction sa = {.sa_handler = sigchld_handler};
747
748   sigaction(SIGCHLD, &sa, NULL);
749
750 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_SETUID) && defined(CAP_SETGID)
751   if ((check_capability(CAP_SETUID) != 0) ||
752       (check_capability(CAP_SETGID) != 0)) {
753     if (getuid() == 0)
754       WARNING(
755           "exec plugin: Running collectd as root, but the CAP_SETUID "
756           "or CAP_SETGID capabilities are missing. The plugin's read function "
757           "will probably fail. Is your init system dropping capabilities?");
758     else
759       WARNING(
760           "exec plugin: collectd doesn't have the CAP_SETUID or "
761           "CAP_SETGID capabilities. If you don't want to run collectd as root, "
762           "try running \"setcap 'cap_setuid=ep cap_setgid=ep'\" on the "
763           "collectd binary.");
764   }
765 #endif
766
767   return 0;
768 } /* int exec_init }}} */
769
770 static int exec_read(void) /* {{{ */
771 {
772   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
773     pthread_t t;
774     pthread_attr_t attr;
775
776     /* Only execute `normal' style executables here. */
777     if ((pl->flags & PL_NORMAL) == 0)
778       continue;
779
780     pthread_mutex_lock(&pl_lock);
781     /* Skip if a child is already running. */
782     if ((pl->flags & PL_RUNNING) != 0) {
783       pthread_mutex_unlock(&pl_lock);
784       continue;
785     }
786     pl->flags |= PL_RUNNING;
787     pthread_mutex_unlock(&pl_lock);
788
789     pthread_attr_init(&attr);
790     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
791     int status =
792         plugin_thread_create(&t, &attr, exec_read_one, (void *)pl, "exec read");
793     if (status != 0) {
794       ERROR("exec plugin: plugin_thread_create failed.");
795     }
796     pthread_attr_destroy(&attr);
797   } /* for (pl) */
798
799   return 0;
800 } /* int exec_read }}} */
801
802 static int exec_notification(const notification_t *n, /* {{{ */
803                              user_data_t __attribute__((unused)) * user_data) {
804   program_list_and_notification_t *pln;
805
806   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
807     pthread_t t;
808     pthread_attr_t attr;
809
810     /* Only execute `notification' style executables here. */
811     if ((pl->flags & PL_NOTIF_ACTION) == 0)
812       continue;
813
814     /* Skip if a child is already running. */
815     if (pl->pid != 0)
816       continue;
817
818     pln = malloc(sizeof(*pln));
819     if (pln == NULL) {
820       ERROR("exec plugin: malloc failed.");
821       continue;
822     }
823
824     pln->pl = pl;
825     memcpy(&pln->n, n, sizeof(notification_t));
826
827     /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
828      * will run into an endless loop. */
829     pln->n.meta = NULL;
830     plugin_notification_meta_copy(&pln->n, n);
831
832     pthread_attr_init(&attr);
833     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
834     int status = plugin_thread_create(&t, &attr, exec_notification_one,
835                                       (void *)pln, "exec notify");
836     if (status != 0) {
837       ERROR("exec plugin: plugin_thread_create failed.");
838     }
839     pthread_attr_destroy(&attr);
840   } /* for (pl) */
841
842   return 0;
843 } /* }}} int exec_notification */
844
845 static int exec_shutdown(void) /* {{{ */
846 {
847   program_list_t *pl;
848   program_list_t *next;
849
850   pl = pl_head;
851   while (pl != NULL) {
852     next = pl->next;
853
854     if (pl->pid > 0) {
855       kill(pl->pid, SIGTERM);
856       INFO("exec plugin: Sent SIGTERM to %hu", (unsigned short int)pl->pid);
857     }
858
859     sfree(pl->user);
860     sfree(pl);
861
862     pl = next;
863   } /* while (pl) */
864   pl_head = NULL;
865
866   return 0;
867 } /* int exec_shutdown }}} */
868
869 void module_register(void) {
870   plugin_register_complex_config("exec", exec_config);
871   plugin_register_init("exec", exec_init);
872   plugin_register_read("exec", exec_read);
873   plugin_register_notification("exec", exec_notification,
874                                /* user_data = */ NULL);
875   plugin_register_shutdown("exec", exec_shutdown);
876 } /* void module_register */