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