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