1 /**
2 * collectd - src/exec.c
3 * Copyright (C) 2007,2008 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
26 #include "utils_cmd_putval.h"
27 #include "utils_cmd_putnotif.h"
29 #include <sys/types.h>
30 #include <pwd.h>
31 #include <grp.h>
32 #include <signal.h>
34 #include <pthread.h>
36 #define PL_NORMAL 0x01
37 #define PL_NOTIF_ACTION 0x02
39 #define PL_RUNNING 0x10
41 /*
42 * Private data types
43 */
44 /*
45 * Access to this structure is serialized using the `pl_lock' lock and the
46 * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
47 * all functions used to handle notifications MUST NOT write to this structure.
48 * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
49 * is set.
50 * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
51 */
52 struct program_list_s;
53 typedef struct program_list_s program_list_t;
54 struct program_list_s
55 {
56 char *user;
57 char *group;
58 char *exec;
59 char **argv;
60 int pid;
61 int status;
62 int flags;
63 program_list_t *next;
64 };
66 typedef struct program_list_and_notification_s
67 {
68 program_list_t *pl;
69 notification_t n;
70 } program_list_and_notification_t;
72 /*
73 * Private variables
74 */
75 static program_list_t *pl_head = NULL;
76 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
78 /*
79 * Functions
80 */
81 static void sigchld_handler (int signal) /* {{{ */
82 {
83 pid_t pid;
84 int status;
85 while ((pid = waitpid (-1, &status, WNOHANG)) > 0)
86 {
87 program_list_t *pl;
88 for (pl = pl_head; pl != NULL; pl = pl->next)
89 if (pl->pid == pid)
90 break;
91 if (pl != NULL)
92 pl->status = status;
93 } /* while (waitpid) */
94 } /* void sigchld_handler }}} */
96 static int exec_config_exec (oconfig_item_t *ci) /* {{{ */
97 {
98 program_list_t *pl;
99 char buffer[128];
100 int i;
102 if (ci->children_num != 0)
103 {
104 WARNING ("exec plugin: The config option `%s' may not be a block.",
105 ci->key);
106 return (-1);
107 }
108 if (ci->values_num < 2)
109 {
110 WARNING ("exec plugin: The config option `%s' needs at least two "
111 "arguments.", ci->key);
112 return (-1);
113 }
114 if ((ci->values[0].type != OCONFIG_TYPE_STRING)
115 || (ci->values[1].type != OCONFIG_TYPE_STRING))
116 {
117 WARNING ("exec plugin: The first two arguments to the `%s' option must "
118 "be string arguments.", ci->key);
119 return (-1);
120 }
122 pl = (program_list_t *) malloc (sizeof (program_list_t));
123 if (pl == NULL)
124 {
125 ERROR ("exec plugin: malloc failed.");
126 return (-1);
127 }
128 memset (pl, '\0', sizeof (program_list_t));
130 if (strcasecmp ("NotificationExec", ci->key) == 0)
131 pl->flags |= PL_NOTIF_ACTION;
132 else
133 pl->flags |= PL_NORMAL;
135 pl->user = strdup (ci->values[0].value.string);
136 if (pl->user == NULL)
137 {
138 ERROR ("exec plugin: strdup failed.");
139 sfree (pl);
140 return (-1);
141 }
143 pl->group = strchr (pl->user, ':');
144 if (pl->group != NULL)
145 {
146 *pl->group = '\0';
147 pl->group++;
148 }
150 pl->exec = strdup (ci->values[1].value.string);
151 if (pl->exec == NULL)
152 {
153 ERROR ("exec plugin: strdup failed.");
154 sfree (pl->user);
155 sfree (pl);
156 return (-1);
157 }
159 pl->argv = (char **) malloc (ci->values_num * sizeof (char *));
160 if (pl->argv == NULL)
161 {
162 ERROR ("exec plugin: malloc failed.");
163 sfree (pl->exec);
164 sfree (pl->user);
165 sfree (pl);
166 return (-1);
167 }
168 memset (pl->argv, '\0', ci->values_num * sizeof (char *));
170 {
171 char *tmp = strrchr (ci->values[1].value.string, '/');
172 if (tmp == NULL)
173 strncpy (buffer, ci->values[1].value.string, sizeof (buffer));
174 else
175 strncpy (buffer, tmp + 1, sizeof (buffer));
176 buffer[sizeof (buffer) - 1] = '\0';
177 }
178 pl->argv[0] = strdup (buffer);
179 if (pl->argv[0] == NULL)
180 {
181 ERROR ("exec plugin: malloc failed.");
182 sfree (pl->argv);
183 sfree (pl->exec);
184 sfree (pl->user);
185 sfree (pl);
186 return (-1);
187 }
189 for (i = 1; i < (ci->values_num - 1); i++)
190 {
191 if (ci->values[i + 1].type == OCONFIG_TYPE_STRING)
192 {
193 pl->argv[i] = strdup (ci->values[i + 1].value.string);
194 }
195 else
196 {
197 if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER)
198 {
199 snprintf (buffer, sizeof (buffer), "%lf",
200 ci->values[i + 1].value.number);
201 }
202 else
203 {
204 if (ci->values[i + 1].value.boolean)
205 strncpy (buffer, "true", sizeof (buffer));
206 else
207 strncpy (buffer, "false", sizeof (buffer));
208 }
209 buffer[sizeof (buffer) - 1] = '\0';
211 pl->argv[i] = strdup (buffer);
212 }
214 if (pl->argv[i] == NULL)
215 {
216 ERROR ("exec plugin: strdup failed.");
217 break;
218 }
219 } /* for (i) */
221 if (i < (ci->values_num - 1))
222 {
223 while ((--i) >= 0)
224 {
225 sfree (pl->argv[i]);
226 }
227 sfree (pl->argv);
228 sfree (pl->exec);
229 sfree (pl->user);
230 sfree (pl);
231 return (-1);
232 }
234 for (i = 0; pl->argv[i] != NULL; i++)
235 {
236 DEBUG ("exec plugin: argv[%i] = %s", i, pl->argv[i]);
237 }
239 pl->next = pl_head;
240 pl_head = pl;
242 return (0);
243 } /* int exec_config_exec }}} */
245 static int exec_config (oconfig_item_t *ci) /* {{{ */
246 {
247 int i;
249 for (i = 0; i < ci->children_num; i++)
250 {
251 oconfig_item_t *child = ci->children + i;
252 if ((strcasecmp ("Exec", child->key) == 0)
253 || (strcasecmp ("NotificationExec", child->key) == 0))
254 exec_config_exec (child);
255 else
256 {
257 WARNING ("exec plugin: Unknown config option `%s'.", child->key);
258 }
259 } /* for (i) */
261 return (0);
262 } /* int exec_config }}} */
264 static void exec_child (program_list_t *pl) /* {{{ */
265 {
266 int status;
267 int uid;
268 int gid;
269 int egid;
271 struct passwd *sp_ptr;
272 struct passwd sp;
273 char nambuf[2048];
274 char errbuf[1024];
276 sp_ptr = NULL;
277 status = getpwnam_r (pl->user, &sp, nambuf, sizeof (nambuf), &sp_ptr);
278 if (status != 0)
279 {
280 ERROR ("exec plugin: getpwnam_r failed: %s",
281 sstrerror (errno, errbuf, sizeof (errbuf)));
282 exit (-1);
283 }
284 if (sp_ptr == NULL)
285 {
286 ERROR ("exec plugin: No such user: `%s'", pl->user);
287 exit (-1);
288 }
290 uid = sp.pw_uid;
291 gid = sp.pw_gid;
292 if (uid == 0)
293 {
294 ERROR ("exec plugin: Cowardly refusing to exec program as root.");
295 exit (-1);
296 }
298 /* The group configured in the configfile is set as effective group, because
299 * this way the forked process can (re-)gain the user's primary group. */
300 egid = -1;
301 if (NULL != pl->group)
302 {
303 if ('\0' != *pl->group) {
304 struct group *gr_ptr = NULL;
305 struct group gr;
307 status = getgrnam_r (pl->group, &gr, nambuf, sizeof (nambuf), &gr_ptr);
308 if (0 != status)
309 {
310 ERROR ("exec plugin: getgrnam_r failed: %s",
311 sstrerror (errno, errbuf, sizeof (errbuf)));
312 exit (-1);
313 }
314 if (NULL == gr_ptr)
315 {
316 ERROR ("exec plugin: No such group: `%s'", pl->group);
317 exit (-1);
318 }
320 egid = gr.gr_gid;
321 }
322 else
323 {
324 egid = gid;
325 }
326 } /* if (pl->group == NULL) */
328 #if HAVE_SETGROUPS
329 if (getuid () == 0)
330 {
331 gid_t glist[2];
332 size_t glist_len;
334 glist[0] = gid;
335 glist_len = 1;
337 if ((gid != egid) && (egid != -1))
338 {
339 glist[1] = egid;
340 glist_len = 2;
341 }
343 setgroups (glist_len, glist);
344 }
345 #endif /* HAVE_SETGROUPS */
347 status = setgid (gid);
348 if (status != 0)
349 {
350 ERROR ("exec plugin: setgid (%i) failed: %s",
351 gid, sstrerror (errno, errbuf, sizeof (errbuf)));
352 exit (-1);
353 }
355 if (egid != -1)
356 {
357 status = setegid (egid);
358 if (status != 0)
359 {
360 ERROR ("exec plugin: setegid (%i) failed: %s",
361 egid, sstrerror (errno, errbuf, sizeof (errbuf)));
362 exit (-1);
363 }
364 }
366 status = setuid (uid);
367 if (status != 0)
368 {
369 ERROR ("exec plugin: setuid (%i) failed: %s",
370 uid, sstrerror (errno, errbuf, sizeof (errbuf)));
371 exit (-1);
372 }
374 status = execvp (pl->exec, pl->argv);
376 ERROR ("exec plugin: exec failed: %s",
377 sstrerror (errno, errbuf, sizeof (errbuf)));
378 exit (-1);
379 } /* void exec_child }}} */
381 /*
382 * Creates two pipes (one for reading, ong for writing), forks a child, sets up
383 * the pipes so that fd_in is connected to STDIN of the child and fd_out is
384 * connected to STDOUT and STDERR of the child. Then is calls `exec_child'.
385 */
386 static int fork_child (program_list_t *pl, int *fd_in, int *fd_out) /* {{{ */
387 {
388 int fd_pipe_in[2];
389 int fd_pipe_out[2];
390 int status;
391 int pid;
393 if (pl->pid != 0)
394 return (-1);
396 status = pipe (fd_pipe_in);
397 if (status != 0)
398 {
399 char errbuf[1024];
400 ERROR ("exec plugin: pipe failed: %s",
401 sstrerror (errno, errbuf, sizeof (errbuf)));
402 return (-1);
403 }
405 status = pipe (fd_pipe_out);
406 if (status != 0)
407 {
408 char errbuf[1024];
409 ERROR ("exec plugin: pipe failed: %s",
410 sstrerror (errno, errbuf, sizeof (errbuf)));
411 return (-1);
412 }
414 pid = fork ();
415 if (pid < 0)
416 {
417 char errbuf[1024];
418 ERROR ("exec plugin: fork failed: %s",
419 sstrerror (errno, errbuf, sizeof (errbuf)));
420 return (-1);
421 }
422 else if (pid == 0)
423 {
424 int fd_num;
425 int fd;
427 /* Close all file descriptors but the pipe end we need. */
428 fd_num = getdtablesize ();
429 for (fd = 0; fd < fd_num; fd++)
430 {
431 if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]))
432 continue;
433 close (fd);
434 }
436 /* If the `out' pipe has the filedescriptor STDIN we have to be careful
437 * with the `dup's below. So, if this is the case we have to handle the
438 * `out' pipe first. */
439 if (fd_pipe_out[1] == STDIN_FILENO)
440 {
441 int new_fileno = (fd_pipe_in[0] == STDOUT_FILENO)
442 ? STDERR_FILENO : STDOUT_FILENO;
443 dup2 (fd_pipe_out[1], new_fileno);
444 close (fd_pipe_out[1]);
445 fd_pipe_out[1] = new_fileno;
446 }
447 /* Now `fd_pipe_out[1]' is either `STDOUT' or `STDERR', but definitely not
448 * `STDIN_FILENO'. */
450 /* Connect the `in' pipe to STDIN */
451 if (fd_pipe_in[0] != STDIN_FILENO)
452 {
453 dup2 (fd_pipe_in[0], STDIN_FILENO);
454 close (fd_pipe_in[0]);
455 fd_pipe_in[0] = STDIN_FILENO;
456 }
458 /* Now connect the `out' pipe to STDOUT and STDERR */
459 if (fd_pipe_out[1] != STDOUT_FILENO)
460 dup2 (fd_pipe_out[1], STDOUT_FILENO);
461 if (fd_pipe_out[1] != STDERR_FILENO)
462 dup2 (fd_pipe_out[1], STDERR_FILENO);
464 /* If the pipe has some FD that's something completely different, close it
465 * now. */
466 if ((fd_pipe_out[1] != STDOUT_FILENO) && (fd_pipe_out[1] != STDERR_FILENO))
467 {
468 close (fd_pipe_out[1]);
469 fd_pipe_out[1] = STDOUT_FILENO;
470 }
472 exec_child (pl);
473 /* does not return */
474 }
476 close (fd_pipe_in[0]);
477 close (fd_pipe_out[1]);
479 if (fd_in != NULL)
480 *fd_in = fd_pipe_in[1];
481 else
482 close (fd_pipe_in[1]);
484 if (fd_out != NULL)
485 *fd_out = fd_pipe_out[0];
486 else
487 close (fd_pipe_out[0]);
489 return (pid);
490 } /* int fork_child }}} */
492 static int parse_line (char *buffer) /* {{{ */
493 {
494 char *fields[256];
495 int fields_num;
497 fields[0] = "PUTVAL";
498 fields_num = strsplit (buffer, fields + 1, STATIC_ARRAY_SIZE(fields) - 1);
500 if (strcasecmp (fields[1], "putval") == 0)
501 return (handle_putval (stdout, fields + 1, fields_num));
502 else if (strcasecmp (fields[1], "putnotif") == 0)
503 return (handle_putnotif (stdout, fields + 1, fields_num));
505 /* compatibility code */
506 return (handle_putval (stdout, fields, fields_num + 1));
507 } /* int parse_line }}} */
509 static void *exec_read_one (void *arg) /* {{{ */
510 {
511 program_list_t *pl = (program_list_t *) arg;
512 int fd;
513 FILE *fh;
514 char buffer[1024];
515 int status;
517 status = fork_child (pl, NULL, &fd);
518 if (status < 0)
519 pthread_exit ((void *) 1);
520 pl->pid = status;
522 assert (pl->pid != 0);
524 fh = fdopen (fd, "r");
525 if (fh == NULL)
526 {
527 char errbuf[1024];
528 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
529 sstrerror (errno, errbuf, sizeof (errbuf)));
530 kill (pl->pid, SIGTERM);
531 pl->pid = 0;
532 close (fd);
533 pthread_exit ((void *) 1);
534 }
536 buffer[0] = '\0';
537 while (fgets (buffer, sizeof (buffer), fh) != NULL)
538 {
539 int len;
541 len = strlen (buffer);
543 /* Remove newline from end. */
544 while ((len > 0) && ((buffer[len - 1] == '\n')
545 || (buffer[len - 1] == '\r')))
546 buffer[--len] = '\0';
548 DEBUG ("exec plugin: exec_read_one: buffer = %s", buffer);
550 parse_line (buffer);
551 } /* while (fgets) */
553 fclose (fh);
555 if (waitpid (pl->pid, &status, 0) > 0)
556 pl->status = status;
558 DEBUG ("exec plugin: Child %i exited with status %i.",
559 (int) pl->pid, pl->status);
561 pl->pid = 0;
563 pthread_mutex_lock (&pl_lock);
564 pl->flags &= ~PL_RUNNING;
565 pthread_mutex_unlock (&pl_lock);
567 pthread_exit ((void *) 0);
568 return (NULL);
569 } /* void *exec_read_one }}} */
571 static void *exec_notification_one (void *arg) /* {{{ */
572 {
573 program_list_t *pl = ((program_list_and_notification_t *) arg)->pl;
574 const notification_t *n = &((program_list_and_notification_t *) arg)->n;
575 int fd;
576 FILE *fh;
577 int pid;
578 int status;
579 const char *severity;
581 pid = fork_child (pl, &fd, NULL);
582 if (pid < 0) {
583 sfree (arg);
584 pthread_exit ((void *) 1);
585 }
587 fh = fdopen (fd, "w");
588 if (fh == NULL)
589 {
590 char errbuf[1024];
591 ERROR ("exec plugin: fdopen (%i) failed: %s", fd,
592 sstrerror (errno, errbuf, sizeof (errbuf)));
593 kill (pl->pid, SIGTERM);
594 pl->pid = 0;
595 close (fd);
596 sfree (arg);
597 pthread_exit ((void *) 1);
598 }
600 severity = "FAILURE";
601 if (n->severity == NOTIF_WARNING)
602 severity = "WARNING";
603 else if (n->severity == NOTIF_OKAY)
604 severity = "OKAY";
606 fprintf (fh,
607 "Severity: %s\n"
608 "Time: %u\n",
609 severity, (unsigned int) n->time);
611 /* Print the optional fields */
612 if (strlen (n->host) > 0)
613 fprintf (fh, "Host: %s\n", n->host);
614 if (strlen (n->plugin) > 0)
615 fprintf (fh, "Plugin: %s\n", n->plugin);
616 if (strlen (n->plugin_instance) > 0)
617 fprintf (fh, "PluginInstance: %s\n", n->plugin_instance);
618 if (strlen (n->type) > 0)
619 fprintf (fh, "Type: %s\n", n->type);
620 if (strlen (n->type_instance) > 0)
621 fprintf (fh, "TypeInstance: %s\n", n->type_instance);
623 fprintf (fh, "\n%s\n", n->message);
625 fflush (fh);
626 fclose (fh);
628 waitpid (pid, &status, 0);
630 DEBUG ("exec plugin: Child %i exited with status %i.",
631 pid, status);
633 sfree (arg);
634 pthread_exit ((void *) 0);
635 return (NULL);
636 } /* void *exec_notification_one }}} */
638 static int exec_init (void) /* {{{ */
639 {
640 struct sigaction sa;
642 memset (&sa, '\0', sizeof (sa));
643 sa.sa_handler = sigchld_handler;
644 sigaction (SIGCHLD, &sa, NULL);
646 return (0);
647 } /* int exec_init }}} */
649 static int exec_read (void) /* {{{ */
650 {
651 program_list_t *pl;
653 for (pl = pl_head; pl != NULL; pl = pl->next)
654 {
655 pthread_t t;
656 pthread_attr_t attr;
658 /* Only execute `normal' style executables here. */
659 if ((pl->flags & PL_NORMAL) == 0)
660 continue;
662 pthread_mutex_lock (&pl_lock);
663 /* Skip if a child is already running. */
664 if ((pl->flags & PL_RUNNING) != 0)
665 {
666 pthread_mutex_unlock (&pl_lock);
667 continue;
668 }
669 pl->flags |= PL_RUNNING;
670 pthread_mutex_unlock (&pl_lock);
672 pthread_attr_init (&attr);
673 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
674 pthread_create (&t, &attr, exec_read_one, (void *) pl);
675 } /* for (pl) */
677 return (0);
678 } /* int exec_read }}} */
680 static int exec_notification (const notification_t *n)
681 {
682 program_list_t *pl;
683 program_list_and_notification_t *pln;
685 for (pl = pl_head; pl != NULL; pl = pl->next)
686 {
687 pthread_t t;
688 pthread_attr_t attr;
690 /* Only execute `notification' style executables here. */
691 if ((pl->flags & PL_NOTIF_ACTION) == 0)
692 continue;
694 /* Skip if a child is already running. */
695 if (pl->pid != 0)
696 continue;
698 pln = (program_list_and_notification_t *) malloc (sizeof
699 (program_list_and_notification_t));
700 if (pln == NULL)
701 {
702 ERROR ("exec plugin: malloc failed.");
703 continue;
704 }
706 pln->pl = pl;
707 memcpy (&pln->n, n, sizeof (notification_t));
709 pthread_attr_init (&attr);
710 pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
711 pthread_create (&t, &attr, exec_notification_one, (void *) pln);
712 } /* for (pl) */
714 return (0);
715 } /* int exec_notification */
717 static int exec_shutdown (void) /* {{{ */
718 {
719 program_list_t *pl;
720 program_list_t *next;
722 pl = pl_head;
723 while (pl != NULL)
724 {
725 next = pl->next;
727 if (pl->pid > 0)
728 {
729 kill (pl->pid, SIGTERM);
730 INFO ("exec plugin: Sent SIGTERM to %hu", (unsigned short int) pl->pid);
731 }
733 sfree (pl->user);
734 sfree (pl);
736 pl = next;
737 } /* while (pl) */
738 pl_head = NULL;
740 return (0);
741 } /* int exec_shutdown }}} */
743 void module_register (void)
744 {
745 plugin_register_complex_config ("exec", exec_config);
746 plugin_register_init ("exec", exec_init);
747 plugin_register_read ("exec", exec_read);
748 plugin_register_notification ("exec", exec_notification);
749 plugin_register_shutdown ("exec", exec_shutdown);
750 } /* void module_register */
752 /*
753 * vim:shiftwidth=2:softtabstop=2:tabstop=8:fdm=marker
754 */