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