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         ssnprintf(buffer, sizeof(buffer), "%lf",
 196                   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   ssnprintf(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   ssnprintf(buffer, sizeof(buffer), "COLLECTD_INTERVAL=%.3f",
 262             CDTIME_T_TO_DOUBLE(plugin_get_interval()));
 263   putenv(buffer);
 264
 265   ssnprintf(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   char errbuf[1024];
 275
 276 #if HAVE_SETGROUPS
 277   if (getuid() == 0) {
 278     gid_t glist[2];
 279     size_t glist_len;
 280
 281     glist[0] = gid;
 282     glist_len = 1;
 283
 284     if ((gid != egid) && (egid != -1)) {
 285       glist[1] = egid;
 286       glist_len = 2;
 287     }
 288
 289     setgroups(glist_len, glist);
 290   }
 291 #endif /* HAVE_SETGROUPS */
 292
 293   status = setgid(gid);
 294   if (status != 0) {
 295     ERROR("exec plugin: setgid (%i) failed: %s", gid,
 296           sstrerror(errno, errbuf, sizeof(errbuf)));
 297     exit(-1);
 298   }
 299
 300   if (egid != -1) {
 301     status = setegid(egid);
 302     if (status != 0) {
 303       ERROR("exec plugin: setegid (%i) failed: %s", egid,
 304             sstrerror(errno, errbuf, sizeof(errbuf)));
 305       exit(-1);
 306     }
 307   }
 308
 309   status = setuid(uid);
 310   if (status != 0) {
 311     ERROR("exec plugin: setuid (%i) failed: %s", uid,
 312           sstrerror(errno, errbuf, sizeof(errbuf)));
 313     exit(-1);
 314   }
 315
 316   execvp(pl->exec, pl->argv);
 317
 318   ERROR("exec plugin: Failed to execute ``%s'': %s", pl->exec,
 319         sstrerror(errno, errbuf, sizeof(errbuf)));
 320   exit(-1);
 321 } /* void exec_child }}} */
 322
 323 static void reset_signal_mask(void) /* {{{ */
 324 {
 325   sigset_t ss;
 326
 327   sigemptyset(&ss);
 328   sigprocmask(SIG_SETMASK, &ss, /* old mask = */ NULL);
 329 } /* }}} void reset_signal_mask */
 330
 331 static int create_pipe(int fd_pipe[2]) /* {{{ */
 332 {
 333   char errbuf[1024];
 334   int status;
 335
 336   status = pipe(fd_pipe);
 337   if (status != 0) {
 338     ERROR("exec plugin: pipe failed: %s",
 339           sstrerror(errno, errbuf, sizeof(errbuf)));
 340     return (-1);
 341   }
 342
 343   return 0;
 344 } /* }}} int create_pipe */
 345
 346 static void close_pipe(int fd_pipe[2]) /* {{{ */
 347 {
 348   if (fd_pipe[0] != -1)
 349     close(fd_pipe[0]);
 350
 351   if (fd_pipe[1] != -1)
 352     close(fd_pipe[1]);
 353 } /* }}} void close_pipe */
 354
 355 /*
 356  * Get effective group ID from group name.
 357  * Input arguments:
 358  *       pl  :program list struct with group name
 359  *       gid :group id to fallback in case egid cannot be determined.
 360  * Returns:
 361  *       egid effective group id if successfull,
 362  *            -1 if group is not defined/not found.
 363  *            -2 for any buffer allocation error.
 364  */
 365 static int getegr_id(program_list_t *pl, int gid) /* {{{ */
 366 {
 367   if (pl->group == NULL) {
 368     return -1;
 369   }
 370   if (strcmp(pl->group, "") == 0) {
 371     return gid;
 372   }
 373   struct group *gr_ptr = NULL;
 374   struct group gr;
 375
 376   long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
 377   if (grbuf_size <= 0)
 378     grbuf_size = sysconf(_SC_PAGESIZE);
 379   if (grbuf_size <= 0)
 380     grbuf_size = 4096;
 381
 382   char *temp = NULL;
 383   char *grbuf = NULL;
 384
 385   do {
 386     temp = realloc(grbuf, grbuf_size);
 387     if (temp == NULL) {
 388       ERROR("exec plugin: getegr_id for %s: realloc buffer[%ld] failed ",
 389             pl->group, grbuf_size);
 390       sfree(grbuf);
 391       return -2;
 392     }
 393     grbuf = temp;
 394     if (getgrnam_r(pl->group, &gr, grbuf, grbuf_size, &gr_ptr) == 0) {
 395       sfree(grbuf);
 396       if (gr_ptr == NULL) {
 397         ERROR("exec plugin: No such group: `%s'", pl->group);
 398         return -1;
 399       }
 400       return gr.gr_gid;
 401     } else if (errno == ERANGE) {
 402       grbuf_size += grbuf_size; // increment buffer size and try again
 403     } else {
 404       char errbuf[1024];
 405       ERROR("exec plugin: getegr_id failed %s",
 406             sstrerror(errno, errbuf, sizeof(errbuf)));
 407       sfree(grbuf);
 408       return -2;
 409     }
 410   } while (grbuf_size <= MAX_GRBUF_SIZE);
 411   ERROR("exec plugin: getegr_id Max grbuf size reached  for %s", pl->group);
 412   sfree(grbuf);
 413   return -2;
 414 } /* }}} */
 415
 416 /*
 417  * Creates three pipes (one for reading, one for writing and one for errors),
 418  * forks a child, sets up the pipes so that fd_in is connected to STDIN of
 419  * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
 420  * of the child. Then is calls `exec_child'.
 421  */
 422 static int fork_child(program_list_t *pl, int *fd_in, int *fd_out,
 423                       int *fd_err) /* {{{ */
 424 {
 425   int fd_pipe_in[2] = {-1, -1};
 426   int fd_pipe_out[2] = {-1, -1};
 427   int fd_pipe_err[2] = {-1, -1};
 428   char errbuf[1024];
 429   int status;
 430   int pid;
 431
 432   int uid;
 433   int gid;
 434   int egid;
 435
 436   struct passwd *sp_ptr;
 437   struct passwd sp;
 438
 439   if (pl->pid != 0)
 440     return (-1);
 441
 442   long int nambuf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
 443   if (nambuf_size <= 0)
 444     nambuf_size = sysconf(_SC_PAGESIZE);
 445   if (nambuf_size <= 0)
 446     nambuf_size = 4096;
 447   char nambuf[nambuf_size];
 448
 449   if ((create_pipe(fd_pipe_in) == -1) || (create_pipe(fd_pipe_out) == -1) ||
 450       (create_pipe(fd_pipe_err) == -1))
 451     goto failed;
 452
 453   sp_ptr = NULL;
 454   status = getpwnam_r(pl->user, &sp, nambuf, sizeof(nambuf), &sp_ptr);
 455   if (status != 0) {
 456     ERROR("exec plugin: Failed to get user information for user ``%s'': %s",
 457           pl->user, sstrerror(status, errbuf, sizeof(errbuf)));
 458     goto failed;
 459   }
 460
 461   if (sp_ptr == NULL) {
 462     ERROR("exec plugin: No such user: `%s'", pl->user);
 463     goto failed;
 464   }
 465
 466   uid = sp.pw_uid;
 467   gid = sp.pw_gid;
 468   if (uid == 0) {
 469     ERROR("exec plugin: Cowardly refusing to exec program as root.");
 470     goto failed;
 471   }
 472
 473   egid = getegr_id(pl, gid);
 474   if (egid == -2) {
 475     goto failed;
 476   }
 477
 478   pid = fork();
 479   if (pid < 0) {
 480     ERROR("exec plugin: fork failed: %s",
 481           sstrerror(errno, errbuf, sizeof(errbuf)));
 482     goto failed;
 483   } else if (pid == 0) {
 484     int fd_num;
 485
 486     /* Close all file descriptors but the pipe end we need. */
 487     fd_num = getdtablesize();
 488     for (int fd = 0; fd < fd_num; fd++) {
 489       if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]) ||
 490           (fd == fd_pipe_err[1]))
 491         continue;
 492       close(fd);
 493     }
 494
 495     /* Connect the `in' pipe to STDIN */
 496     if (fd_pipe_in[0] != STDIN_FILENO) {
 497       dup2(fd_pipe_in[0], STDIN_FILENO);
 498       close(fd_pipe_in[0]);
 499     }
 500
 501     /* Now connect the `out' pipe to STDOUT */
 502     if (fd_pipe_out[1] != STDOUT_FILENO) {
 503       dup2(fd_pipe_out[1], STDOUT_FILENO);
 504       close(fd_pipe_out[1]);
 505     }
 506
 507     /* Now connect the `err' pipe to STDERR */
 508     if (fd_pipe_err[1] != STDERR_FILENO) {
 509       dup2(fd_pipe_err[1], STDERR_FILENO);
 510       close(fd_pipe_err[1]);
 511     }
 512
 513     set_environment();
 514
 515     /* Unblock all signals */
 516     reset_signal_mask();
 517
 518     exec_child(pl, uid, gid, egid);
 519     /* does not return */
 520   }
 521
 522   close(fd_pipe_in[0]);
 523   close(fd_pipe_out[1]);
 524   close(fd_pipe_err[1]);
 525
 526   if (fd_in != NULL)
 527     *fd_in = fd_pipe_in[1];
 528   else
 529     close(fd_pipe_in[1]);
 530
 531   if (fd_out != NULL)
 532     *fd_out = fd_pipe_out[0];
 533   else
 534     close(fd_pipe_out[0]);
 535
 536   if (fd_err != NULL)
 537     *fd_err = fd_pipe_err[0];
 538   else
 539     close(fd_pipe_err[0]);
 540
 541   return (pid);
 542
 543 failed:
 544   close_pipe(fd_pipe_in);
 545   close_pipe(fd_pipe_out);
 546   close_pipe(fd_pipe_err);
 547
 548   return (-1);
 549 } /* int fork_child }}} */
 550
 551 static int parse_line(char *buffer) /* {{{ */
 552 {
 553   if (strncasecmp("PUTVAL", buffer, strlen("PUTVAL")) == 0)
 554     return (cmd_handle_putval(stdout, buffer));
 555   else if (strncasecmp("PUTNOTIF", buffer, strlen("PUTNOTIF")) == 0)
 556     return (handle_putnotif(stdout, buffer));
 557   else {
 558     ERROR("exec plugin: Unable to parse command, ignoring line: \"%s\"",
 559           buffer);
 560     return (-1);
 561   }
 562 } /* int parse_line }}} */
 563
 564 static void *exec_read_one(void *arg) /* {{{ */
 565 {
 566   program_list_t *pl = (program_list_t *)arg;
 567   int fd, fd_err, highest_fd;
 568   fd_set fdset, copy;
 569   int status;
 570   char buffer[1200]; /* if not completely read */
 571   char buffer_err[1024];
 572   char *pbuffer = buffer;
 573   char *pbuffer_err = buffer_err;
 574
 575   status = fork_child(pl, NULL, &fd, &fd_err);
 576   if (status < 0) {
 577     /* Reset the "running" flag */
 578     pthread_mutex_lock(&pl_lock);
 579     pl->flags &= ~PL_RUNNING;
 580     pthread_mutex_unlock(&pl_lock);
 581     pthread_exit((void *)1);
 582   }
 583   pl->pid = status;
 584
 585   assert(pl->pid != 0);
 586
 587   FD_ZERO(&fdset);
 588   FD_SET(fd, &fdset);
 589   FD_SET(fd_err, &fdset);
 590
 591   /* Determine the highest file descriptor */
 592   highest_fd = (fd > fd_err) ? fd : fd_err;
 593
 594   /* We use a copy of fdset, as select modifies it */
 595   copy = fdset;
 596
 597   while (1) {
 598     int len;
 599
 600     status = select(highest_fd + 1, &copy, NULL, NULL, NULL);
 601     if (status < 0) {
 602       if (errno == EINTR)
 603         continue;
 604       break;
 605     }
 606
 607     if (FD_ISSET(fd, &copy)) {
 608       char *pnl;
 609
 610       len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
 611
 612       if (len < 0) {
 613         if (errno == EAGAIN || errno == EINTR)
 614           continue;
 615         break;
 616       } else if (len == 0)
 617         break; /* We've reached EOF */
 618
 619       pbuffer[len] = '\0';
 620
 621       len += pbuffer - buffer;
 622       pbuffer = buffer;
 623
 624       while ((pnl = strchr(pbuffer, '\n'))) {
 625         *pnl = '\0';
 626         if (*(pnl - 1) == '\r')
 627           *(pnl - 1) = '\0';
 628
 629         parse_line(pbuffer);
 630
 631         pbuffer = ++pnl;
 632       }
 633       /* not completely read ? */
 634       if (pbuffer - buffer < len) {
 635         len -= pbuffer - buffer;
 636         memmove(buffer, pbuffer, len);
 637         pbuffer = buffer + len;
 638       } else
 639         pbuffer = buffer;
 640     } else if (FD_ISSET(fd_err, &copy)) {
 641       char *pnl;
 642
 643       len = read(fd_err, pbuffer_err,
 644                  sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
 645
 646       if (len < 0) {
 647         if (errno == EAGAIN || errno == EINTR)
 648           continue;
 649         break;
 650       } else if (len == 0) {
 651         /* We've reached EOF */
 652         NOTICE("exec plugin: Program `%s' has closed STDERR.", pl->exec);
 653
 654         /* Remove file descriptor form select() set. */
 655         FD_CLR(fd_err, &fdset);
 656         copy = fdset;
 657         highest_fd = fd;
 658
 659         /* Clean up file descriptor */
 660         close(fd_err);
 661         fd_err = -1;
 662         continue;
 663       }
 664
 665       pbuffer_err[len] = '\0';
 666
 667       len += pbuffer_err - buffer_err;
 668       pbuffer_err = buffer_err;
 669
 670       while ((pnl = strchr(pbuffer_err, '\n'))) {
 671         *pnl = '\0';
 672         if (*(pnl - 1) == '\r')
 673           *(pnl - 1) = '\0';
 674
 675         ERROR("exec plugin: exec_read_one: error = %s", pbuffer_err);
 676
 677         pbuffer_err = ++pnl;
 678       }
 679       /* not completely read ? */
 680       if (pbuffer_err - buffer_err < len) {
 681         len -= pbuffer_err - buffer_err;
 682         memmove(buffer_err, pbuffer_err, len);
 683         pbuffer_err = buffer_err + len;
 684       } else
 685         pbuffer_err = buffer_err;
 686     }
 687     /* reset copy */
 688     copy = fdset;
 689   }
 690
 691   DEBUG("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
 692   if (waitpid(pl->pid, &status, 0) > 0)
 693     pl->status = status;
 694
 695   DEBUG("exec plugin: Child %i exited with status %i.", (int)pl->pid,
 696         pl->status);
 697
 698   pl->pid = 0;
 699
 700   pthread_mutex_lock(&pl_lock);
 701   pl->flags &= ~PL_RUNNING;
 702   pthread_mutex_unlock(&pl_lock);
 703
 704   close(fd);
 705   if (fd_err >= 0)
 706     close(fd_err);
 707
 708   pthread_exit((void *)0);
 709   return (NULL);
 710 } /* void *exec_read_one }}} */
 711
 712 static void *exec_notification_one(void *arg) /* {{{ */
 713 {
 714   program_list_t *pl = ((program_list_and_notification_t *)arg)->pl;
 715   notification_t *n = &((program_list_and_notification_t *)arg)->n;
 716   int fd;
 717   FILE *fh;
 718   int pid;
 719   int status;
 720   const char *severity;
 721
 722   pid = fork_child(pl, &fd, NULL, NULL);
 723   if (pid < 0) {
 724     sfree(arg);
 725     pthread_exit((void *)1);
 726   }
 727
 728   fh = fdopen(fd, "w");
 729   if (fh == NULL) {
 730     char errbuf[1024];
 731     ERROR("exec plugin: fdopen (%i) failed: %s", fd,
 732           sstrerror(errno, errbuf, sizeof(errbuf)));
 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 */
 927
 928 /*
 929  * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker
 930  */