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  * Creates three pipes (one for reading, one for writing and one for errors),
 350  * forks a child, sets up the pipes so that fd_in is connected to STDIN of
 351  * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
 352  * of the child. Then is calls `exec_child'.
 353  */
 354 static int fork_child(program_list_t *pl, int *fd_in, int *fd_out,
 355                       int *fd_err) /* {{{ */
 356 {
 357   int fd_pipe_in[2] = {-1, -1};
 358   int fd_pipe_out[2] = {-1, -1};
 359   int fd_pipe_err[2] = {-1, -1};
 360   int status;
 361   int pid;
 362
 363   int uid;
 364   int gid;
 365   int egid;
 366
 367   struct passwd *sp_ptr;
 368   struct passwd sp;
 369
 370   if (pl->pid != 0)
 371     return -1;
 372
 373   long int nambuf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
 374   if (nambuf_size <= 0)
 375     nambuf_size = sysconf(_SC_PAGESIZE);
 376   if (nambuf_size <= 0)
 377     nambuf_size = 4096;
 378   char nambuf[nambuf_size];
 379
 380   if ((create_pipe(fd_pipe_in) == -1) || (create_pipe(fd_pipe_out) == -1) ||
 381       (create_pipe(fd_pipe_err) == -1))
 382     goto failed;
 383
 384   sp_ptr = NULL;
 385   status = getpwnam_r(pl->user, &sp, nambuf, sizeof(nambuf), &sp_ptr);
 386   if (status != 0) {
 387     ERROR("exec plugin: Failed to get user information for user ``%s'': %s",
 388           pl->user, STRERROR(status));
 389     goto failed;
 390   }
 391
 392   if (sp_ptr == NULL) {
 393     ERROR("exec plugin: No such user: `%s'", pl->user);
 394     goto failed;
 395   }
 396
 397   uid = sp.pw_uid;
 398   gid = sp.pw_gid;
 399   if (uid == 0) {
 400     ERROR("exec plugin: Cowardly refusing to exec program as root.");
 401     goto failed;
 402   }
 403
 404   /* The group configured in the configfile is set as effective group, because
 405    * this way the forked process can (re-)gain the user's primary group. */
 406   egid = -1;
 407   if (pl->group != NULL) {
 408     if (*pl->group != '\0') {
 409       struct group *gr_ptr = NULL;
 410       struct group gr;
 411
 412       long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
 413       if (grbuf_size <= 0)
 414         grbuf_size = sysconf(_SC_PAGESIZE);
 415       if (grbuf_size <= 0)
 416         grbuf_size = 4096;
 417
 418       long int size;
 419       size = grbuf_size;
 420       char *temp = NULL;
 421       char *grbuf = NULL;
 422       int getgr_failed = 0;
 423       grbuf = malloc(size);
 424       if (grbuf == NULL) {
 425         ERROR("exec plugin: get group information for '%s' failed: buffer "
 426               "malloc() failed",
 427               pl->group);
 428         getgr_failed = 1;
 429         goto gr_finally;
 430       }
 431       int status;
 432       while ((status = getgrnam_r(pl->group, &gr, grbuf, size, &gr_ptr)) != 0) {
 433         switch (errno) {
 434         case ERANGE:
 435           if ((size + grbuf_size) < size ||
 436               (size + grbuf_size) > MAX_GRBUF_SIZE) {
 437             ERROR("exec plugin: get group information for '%s' max buffer "
 438                   "limit (%ld) reached \n",
 439                   pl->group, MAX_GRBUF_SIZE);
 440             getgr_failed = 1;
 441             goto gr_finally;
 442           }
 443           /* grow the buffer by 'grbuf_size' each time getgrnamr fails */
 444           size += grbuf_size;
 445           temp = realloc(grbuf, size);
 446           if (temp == NULL) {
 447             ERROR("exec plugin: get group information for '%s' realloc() "
 448                   "buffer to (%ld) failed ",
 449                   pl->group, size);
 450             getgr_failed = 1;
 451             goto gr_finally;
 452           }
 453           grbuf = temp;
 454           break;
 455         default:
 456           ERROR("exec plugin: default errno: get group information for '%s' "
 457                 "failed : %s",
 458                 pl->group, sstrerror(status, errbuf, sizeof(errbuf)));
 459           getgr_failed = 1;
 460           goto gr_finally;
 461         }
 462       }
 463       if (gr_ptr == NULL) {
 464         ERROR("exec plugin: No such group: `%s'", pl->group);
 465         getgr_failed = 1;
 466         goto gr_finally;
 467       }
 468       egid = gr.gr_gid;
 469     gr_finally:
 470       free(grbuf);
 471       DEBUG("exec plugin: release grbuf memory ");
 472       grbuf = NULL;
 473       if (getgr_failed > 0) {
 474         goto failed;
 475       }
 476     } else {
 477       egid = gid;
 478     }
 479   } /* if (pl->group == NULL) */
 480
 481   pid = fork();
 482   if (pid < 0) {
 483     ERROR("exec plugin: fork failed: %s", STRERRNO);
 484     goto failed;
 485   } else if (pid == 0) {
 486     int fd_num;
 487
 488     /* Close all file descriptors but the pipe end we need. */
 489     fd_num = getdtablesize();
 490     for (int fd = 0; fd < fd_num; fd++) {
 491       if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]) ||
 492           (fd == fd_pipe_err[1]))
 493         continue;
 494       close(fd);
 495     }
 496
 497     /* Connect the `in' pipe to STDIN */
 498     if (fd_pipe_in[0] != STDIN_FILENO) {
 499       dup2(fd_pipe_in[0], STDIN_FILENO);
 500       close(fd_pipe_in[0]);
 501     }
 502
 503     /* Now connect the `out' pipe to STDOUT */
 504     if (fd_pipe_out[1] != STDOUT_FILENO) {
 505       dup2(fd_pipe_out[1], STDOUT_FILENO);
 506       close(fd_pipe_out[1]);
 507     }
 508
 509     /* Now connect the `err' pipe to STDERR */
 510     if (fd_pipe_err[1] != STDERR_FILENO) {
 511       dup2(fd_pipe_err[1], STDERR_FILENO);
 512       close(fd_pipe_err[1]);
 513     }
 514
 515     set_environment();
 516
 517     /* Unblock all signals */
 518     reset_signal_mask();
 519
 520     exec_child(pl, uid, gid, egid);
 521     /* does not return */
 522   }
 523
 524   close(fd_pipe_in[0]);
 525   close(fd_pipe_out[1]);
 526   close(fd_pipe_err[1]);
 527
 528   if (fd_in != NULL)
 529     *fd_in = fd_pipe_in[1];
 530   else
 531     close(fd_pipe_in[1]);
 532
 533   if (fd_out != NULL)
 534     *fd_out = fd_pipe_out[0];
 535   else
 536     close(fd_pipe_out[0]);
 537
 538   if (fd_err != NULL)
 539     *fd_err = fd_pipe_err[0];
 540   else
 541     close(fd_pipe_err[0]);
 542
 543   return pid;
 544
 545 failed:
 546   close_pipe(fd_pipe_in);
 547   close_pipe(fd_pipe_out);
 548   close_pipe(fd_pipe_err);
 549
 550   return -1;
 551 } /* int fork_child }}} */
 552
 553 static int parse_line(char *buffer) /* {{{ */
 554 {
 555   if (strncasecmp("PUTVAL", buffer, strlen("PUTVAL")) == 0)
 556     return cmd_handle_putval(stdout, buffer);
 557   else if (strncasecmp("PUTNOTIF", buffer, strlen("PUTNOTIF")) == 0)
 558     return handle_putnotif(stdout, buffer);
 559   else {
 560     ERROR("exec plugin: Unable to parse command, ignoring line: \"%s\"",
 561           buffer);
 562     return -1;
 563   }
 564 } /* int parse_line }}} */
 565
 566 static void *exec_read_one(void *arg) /* {{{ */
 567 {
 568   program_list_t *pl = (program_list_t *)arg;
 569   int fd, fd_err, highest_fd;
 570   fd_set fdset, copy;
 571   int status;
 572   char buffer[1200]; /* if not completely read */
 573   char buffer_err[1024];
 574   char *pbuffer = buffer;
 575   char *pbuffer_err = buffer_err;
 576
 577   status = fork_child(pl, NULL, &fd, &fd_err);
 578   if (status < 0) {
 579     /* Reset the "running" flag */
 580     pthread_mutex_lock(&pl_lock);
 581     pl->flags &= ~PL_RUNNING;
 582     pthread_mutex_unlock(&pl_lock);
 583     pthread_exit((void *)1);
 584   }
 585   pl->pid = status;
 586
 587   assert(pl->pid != 0);
 588
 589   FD_ZERO(&fdset);
 590   FD_SET(fd, &fdset);
 591   FD_SET(fd_err, &fdset);
 592
 593   /* Determine the highest file descriptor */
 594   highest_fd = (fd > fd_err) ? fd : fd_err;
 595
 596   /* We use a copy of fdset, as select modifies it */
 597   copy = fdset;
 598
 599   while (1) {
 600     int len;
 601
 602     status = select(highest_fd + 1, &copy, NULL, NULL, NULL);
 603     if (status < 0) {
 604       if (errno == EINTR)
 605         continue;
 606       break;
 607     }
 608
 609     if (FD_ISSET(fd, &copy)) {
 610       char *pnl;
 611
 612       len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
 613
 614       if (len < 0) {
 615         if (errno == EAGAIN || errno == EINTR)
 616           continue;
 617         break;
 618       } else if (len == 0)
 619         break; /* We've reached EOF */
 620
 621       pbuffer[len] = '\0';
 622
 623       len += pbuffer - buffer;
 624       pbuffer = buffer;
 625
 626       while ((pnl = strchr(pbuffer, '\n'))) {
 627         *pnl = '\0';
 628         if (*(pnl - 1) == '\r')
 629           *(pnl - 1) = '\0';
 630
 631         parse_line(pbuffer);
 632
 633         pbuffer = ++pnl;
 634       }
 635       /* not completely read ? */
 636       if (pbuffer - buffer < len) {
 637         len -= pbuffer - buffer;
 638         memmove(buffer, pbuffer, len);
 639         pbuffer = buffer + len;
 640       } else
 641         pbuffer = buffer;
 642     } else if (FD_ISSET(fd_err, &copy)) {
 643       char *pnl;
 644
 645       len = read(fd_err, pbuffer_err,
 646                  sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
 647
 648       if (len < 0) {
 649         if (errno == EAGAIN || errno == EINTR)
 650           continue;
 651         break;
 652       } else if (len == 0) {
 653         /* We've reached EOF */
 654         NOTICE("exec plugin: Program `%s' has closed STDERR.", pl->exec);
 655
 656         /* Remove file descriptor form select() set. */
 657         FD_CLR(fd_err, &fdset);
 658         copy = fdset;
 659         highest_fd = fd;
 660
 661         /* Clean up file descriptor */
 662         close(fd_err);
 663         fd_err = -1;
 664         continue;
 665       }
 666
 667       pbuffer_err[len] = '\0';
 668
 669       len += pbuffer_err - buffer_err;
 670       pbuffer_err = buffer_err;
 671
 672       while ((pnl = strchr(pbuffer_err, '\n'))) {
 673         *pnl = '\0';
 674         if (*(pnl - 1) == '\r')
 675           *(pnl - 1) = '\0';
 676
 677         ERROR("exec plugin: exec_read_one: error = %s", pbuffer_err);
 678
 679         pbuffer_err = ++pnl;
 680       }
 681       /* not completely read ? */
 682       if (pbuffer_err - buffer_err < len) {
 683         len -= pbuffer_err - buffer_err;
 684         memmove(buffer_err, pbuffer_err, len);
 685         pbuffer_err = buffer_err + len;
 686       } else
 687         pbuffer_err = buffer_err;
 688     }
 689     /* reset copy */
 690     copy = fdset;
 691   }
 692
 693   DEBUG("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
 694   if (waitpid(pl->pid, &status, 0) > 0)
 695     pl->status = status;
 696
 697   DEBUG("exec plugin: Child %i exited with status %i.", (int)pl->pid,
 698         pl->status);
 699
 700   pl->pid = 0;
 701
 702   pthread_mutex_lock(&pl_lock);
 703   pl->flags &= ~PL_RUNNING;
 704   pthread_mutex_unlock(&pl_lock);
 705
 706   close(fd);
 707   if (fd_err >= 0)
 708     close(fd_err);
 709
 710   pthread_exit((void *)0);
 711   return NULL;
 712 } /* void *exec_read_one }}} */
 713
 714 static void *exec_notification_one(void *arg) /* {{{ */
 715 {
 716   program_list_t *pl = ((program_list_and_notification_t *)arg)->pl;
 717   notification_t *n = &((program_list_and_notification_t *)arg)->n;
 718   int fd;
 719   FILE *fh;
 720   int pid;
 721   int status;
 722   const char *severity;
 723
 724   pid = fork_child(pl, &fd, NULL, NULL);
 725   if (pid < 0) {
 726     sfree(arg);
 727     pthread_exit((void *)1);
 728   }
 729
 730   fh = fdopen(fd, "w");
 731   if (fh == NULL) {
 732     ERROR("exec plugin: fdopen (%i) failed: %s", fd, STRERRNO);
 733     kill(pid, SIGTERM);
 734     close(fd);
 735     sfree(arg);
 736     pthread_exit((void *)1);
 737   }
 738
 739   severity = "FAILURE";
 740   if (n->severity == NOTIF_WARNING)
 741     severity = "WARNING";
 742   else if (n->severity == NOTIF_OKAY)
 743     severity = "OKAY";
 744
 745   fprintf(fh, "Severity: %s\n"
 746               "Time: %.3f\n",
 747           severity, CDTIME_T_TO_DOUBLE(n->time));
 748
 749   /* Print the optional fields */
 750   if (strlen(n->host) > 0)
 751     fprintf(fh, "Host: %s\n", n->host);
 752   if (strlen(n->plugin) > 0)
 753     fprintf(fh, "Plugin: %s\n", n->plugin);
 754   if (strlen(n->plugin_instance) > 0)
 755     fprintf(fh, "PluginInstance: %s\n", n->plugin_instance);
 756   if (strlen(n->type) > 0)
 757     fprintf(fh, "Type: %s\n", n->type);
 758   if (strlen(n->type_instance) > 0)
 759     fprintf(fh, "TypeInstance: %s\n", n->type_instance);
 760
 761   for (notification_meta_t *meta = n->meta; meta != NULL; meta = meta->next) {
 762     if (meta->type == NM_TYPE_STRING)
 763       fprintf(fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
 764     else if (meta->type == NM_TYPE_SIGNED_INT)
 765       fprintf(fh, "%s: %" PRIi64 "\n", meta->name,
 766               meta->nm_value.nm_signed_int);
 767     else if (meta->type == NM_TYPE_UNSIGNED_INT)
 768       fprintf(fh, "%s: %" PRIu64 "\n", meta->name,
 769               meta->nm_value.nm_unsigned_int);
 770     else if (meta->type == NM_TYPE_DOUBLE)
 771       fprintf(fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
 772     else if (meta->type == NM_TYPE_BOOLEAN)
 773       fprintf(fh, "%s: %s\n", meta->name,
 774               meta->nm_value.nm_boolean ? "true" : "false");
 775   }
 776
 777   fprintf(fh, "\n%s\n", n->message);
 778
 779   fflush(fh);
 780   fclose(fh);
 781
 782   waitpid(pid, &status, 0);
 783
 784   DEBUG("exec plugin: Child %i exited with status %i.", pid, status);
 785
 786   if (n->meta != NULL)
 787     plugin_notification_meta_free(n->meta);
 788   n->meta = NULL;
 789   sfree(arg);
 790   pthread_exit((void *)0);
 791   return NULL;
 792 } /* void *exec_notification_one }}} */
 793
 794 static int exec_init(void) /* {{{ */
 795 {
 796   struct sigaction sa = {.sa_handler = sigchld_handler};
 797
 798   sigaction(SIGCHLD, &sa, NULL);
 799
 800 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_SETUID) && defined(CAP_SETGID)
 801   if ((check_capability(CAP_SETUID) != 0) ||
 802       (check_capability(CAP_SETGID) != 0)) {
 803     if (getuid() == 0)
 804       WARNING(
 805           "exec plugin: Running collectd as root, but the CAP_SETUID "
 806           "or CAP_SETGID capabilities are missing. The plugin's read function "
 807           "will probably fail. Is your init system dropping capabilities?");
 808     else
 809       WARNING(
 810           "exec plugin: collectd doesn't have the CAP_SETUID or "
 811           "CAP_SETGID capabilities. If you don't want to run collectd as root, "
 812           "try running \"setcap 'cap_setuid=ep cap_setgid=ep'\" on the "
 813           "collectd binary.");
 814   }
 815 #endif
 816
 817   return 0;
 818 } /* int exec_init }}} */
 819
 820 static int exec_read(void) /* {{{ */
 821 {
 822   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
 823     pthread_t t;
 824     pthread_attr_t attr;
 825
 826     /* Only execute `normal' style executables here. */
 827     if ((pl->flags & PL_NORMAL) == 0)
 828       continue;
 829
 830     pthread_mutex_lock(&pl_lock);
 831     /* Skip if a child is already running. */
 832     if ((pl->flags & PL_RUNNING) != 0) {
 833       pthread_mutex_unlock(&pl_lock);
 834       continue;
 835     }
 836     pl->flags |= PL_RUNNING;
 837     pthread_mutex_unlock(&pl_lock);
 838
 839     pthread_attr_init(&attr);
 840     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 841     int status =
 842         plugin_thread_create(&t, &attr, exec_read_one, (void *)pl, "exec read");
 843     if (status != 0) {
 844       ERROR("exec plugin: plugin_thread_create failed.");
 845     }
 846     pthread_attr_destroy(&attr);
 847   } /* for (pl) */
 848
 849   return 0;
 850 } /* int exec_read }}} */
 851
 852 static int exec_notification(const notification_t *n, /* {{{ */
 853                              user_data_t __attribute__((unused)) * user_data) {
 854   program_list_and_notification_t *pln;
 855
 856   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
 857     pthread_t t;
 858     pthread_attr_t attr;
 859
 860     /* Only execute `notification' style executables here. */
 861     if ((pl->flags & PL_NOTIF_ACTION) == 0)
 862       continue;
 863
 864     /* Skip if a child is already running. */
 865     if (pl->pid != 0)
 866       continue;
 867
 868     pln = malloc(sizeof(*pln));
 869     if (pln == NULL) {
 870       ERROR("exec plugin: malloc failed.");
 871       continue;
 872     }
 873
 874     pln->pl = pl;
 875     memcpy(&pln->n, n, sizeof(notification_t));
 876
 877     /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
 878      * will run into an endless loop. */
 879     pln->n.meta = NULL;
 880     plugin_notification_meta_copy(&pln->n, n);
 881
 882     pthread_attr_init(&attr);
 883     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 884     int status = plugin_thread_create(&t, &attr, exec_notification_one,
 885                                       (void *)pln, "exec notify");
 886     if (status != 0) {
 887       ERROR("exec plugin: plugin_thread_create failed.");
 888     }
 889     pthread_attr_destroy(&attr);
 890   } /* for (pl) */
 891
 892   return 0;
 893 } /* }}} int exec_notification */
 894
 895 static int exec_shutdown(void) /* {{{ */
 896 {
 897   program_list_t *pl;
 898   program_list_t *next;
 899
 900   pl = pl_head;
 901   while (pl != NULL) {
 902     next = pl->next;
 903
 904     if (pl->pid > 0) {
 905       kill(pl->pid, SIGTERM);
 906       INFO("exec plugin: Sent SIGTERM to %hu", (unsigned short int)pl->pid);
 907     }
 908
 909     sfree(pl->user);
 910     sfree(pl);
 911
 912     pl = next;
 913   } /* while (pl) */
 914   pl_head = NULL;
 915
 916   return 0;
 917 } /* int exec_shutdown }}} */
 918
 919 void module_register(void) {
 920   plugin_register_complex_config("exec", exec_config);
 921   plugin_register_init("exec", exec_init);
 922   plugin_register_read("exec", exec_read);
 923   plugin_register_notification("exec", exec_notification,
 924                                /* user_data = */ NULL);
 925   plugin_register_shutdown("exec", exec_shutdown);
 926 } /* void module_register */