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