2 * collectd - src/plugin.c
3 * Copyright (C) 2005,2006 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
32 #include "configfile.h"
33 #include "utils_llist.h"
42 int (*callback) (void);
43 enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
45 typedef struct read_func_s read_func_t;
50 static llist_t *list_init;
51 static llist_t *list_read;
52 static llist_t *list_write;
53 static llist_t *list_shutdown;
54 static llist_t *list_data_set;
55 static llist_t *list_log;
57 static char *plugindir = NULL;
59 static int read_loop = 1;
60 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
61 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
62 static pthread_t *read_threads = NULL;
63 static int read_threads_num = 0;
68 static const char *plugin_get_dir (void)
70 if (plugindir == NULL)
76 static int register_callback (llist_t **list, const char *name, void *callback)
81 && ((*list = llist_create ()) == NULL))
84 le = llist_search (*list, name);
87 le = llentry_create (name, callback);
91 llist_append (*list, le);
99 } /* int register_callback */
101 static int plugin_unregister (llist_t *list, const char *name)
105 e = llist_search (list, name);
110 llist_remove (list, e);
114 } /* int plugin_unregister */
117 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
118 * object, but it will bitch about a shared object not having a
119 * ``module_register'' symbol..
121 static int plugin_load_file (char *file)
124 void (*reg_handle) (void);
126 DEBUG ("file = %s", file);
129 lt_dlerror (); /* clear errors */
131 if ((dlh = lt_dlopen (file)) == NULL)
133 const char *error = lt_dlerror ();
135 ERROR ("lt_dlopen failed: %s", error);
139 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
141 WARNING ("Couldn't find symbol ``module_register'' in ``%s'': %s\n",
142 file, lt_dlerror ());
152 static void *plugin_read_thread (void *args)
159 pthread_mutex_lock (&read_lock);
161 while (read_loop != 0)
163 le = llist_head (list_read);
166 while ((read_loop != 0) && (le != NULL))
168 rf = (read_func_t *) le->value;
170 if (rf->needs_read != TODO)
176 /* We will do this read function */
177 rf->needs_read = ACTIVE;
179 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
180 (unsigned long int) pthread_self (), le->key);
181 pthread_mutex_unlock (&read_lock);
183 status = rf->callback ();
188 if (rf->wait_time < interval_g)
189 rf->wait_time = interval_g;
190 rf->wait_left = rf->wait_time;
191 rf->wait_time = rf->wait_time * 2;
192 if (rf->wait_time > 86400)
193 rf->wait_time = 86400;
195 NOTICE ("read-function of plugin `%s' "
196 "failed. Will syspend it for %i "
197 "seconds.", le->key, rf->wait_left);
202 rf->wait_time = interval_g;
205 pthread_mutex_lock (&read_lock);
207 rf->needs_read = DONE;
209 } /* while (le != NULL) */
211 if ((read_loop != 0) && (done == 0))
213 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
214 (unsigned long int) pthread_self ());
215 pthread_cond_wait (&read_cond, &read_lock);
217 } /* while (read_loop) */
219 pthread_mutex_unlock (&read_lock);
222 } /* void *plugin_read_thread */
224 static void start_threads (int num)
228 if (read_threads != NULL)
231 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
232 if (read_threads == NULL)
234 ERROR ("plugin: start_threads: calloc failed.");
238 read_threads_num = 0;
239 for (i = 0; i < num; i++)
241 if (pthread_create (read_threads + read_threads_num, NULL,
242 plugin_read_thread, NULL) == 0)
248 ERROR ("plugin: start_threads: pthread_create failed.");
252 } /* void start_threads */
254 static void stop_threads (void)
258 pthread_mutex_lock (&read_lock);
260 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
261 pthread_cond_broadcast (&read_cond);
262 pthread_mutex_unlock (&read_lock);
264 for (i = 0; i < read_threads_num; i++)
266 if (pthread_join (read_threads[i], NULL) != 0)
268 ERROR ("plugin: stop_threads: pthread_join failed.");
270 read_threads[i] = (pthread_t) 0;
272 sfree (read_threads);
273 read_threads_num = 0;
274 } /* void stop_threads */
279 void plugin_set_dir (const char *dir)
281 if (plugindir != NULL)
286 else if ((plugindir = strdup (dir)) == NULL)
289 ERROR ("strdup failed: %s",
290 sstrerror (errno, errbuf, sizeof (errbuf)));
295 int plugin_load (const char *type)
299 char filename[BUFSIZE];
300 char typename[BUFSIZE];
306 DEBUG ("type = %s", type);
308 dir = plugin_get_dir ();
311 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
312 * type when matching the filename */
313 if (snprintf (typename, BUFSIZE, "%s.so", type) >= BUFSIZE)
315 WARNING ("snprintf: truncated: `%s.so'", type);
318 typename_len = strlen (typename);
320 if ((dh = opendir (dir)) == NULL)
323 ERROR ("opendir (%s): %s", dir,
324 sstrerror (errno, errbuf, sizeof (errbuf)));
328 while ((de = readdir (dh)) != NULL)
330 if (strncasecmp (de->d_name, typename, typename_len))
333 if (snprintf (filename, BUFSIZE, "%s/%s", dir, de->d_name) >= BUFSIZE)
335 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
339 if (lstat (filename, &statbuf) == -1)
342 WARNING ("stat %s: %s", filename,
343 sstrerror (errno, errbuf, sizeof (errbuf)));
346 else if (!S_ISREG (statbuf.st_mode))
348 /* don't follow symlinks */
352 if (plugin_load_file (filename) == 0)
366 * The `register_*' functions follow
368 int plugin_register_config (const char *name,
369 int (*callback) (const char *key, const char *val),
370 const char **keys, int keys_num)
372 cf_register (name, callback, keys, keys_num);
374 } /* int plugin_register_config */
376 int plugin_register_init (const char *name,
377 int (*callback) (void))
379 return (register_callback (&list_init, name, (void *) callback));
380 } /* plugin_register_init */
382 int plugin_register_read (const char *name,
383 int (*callback) (void))
387 rf = (read_func_t *) malloc (sizeof (read_func_t));
391 ERROR ("plugin_register_read: malloc failed: %s",
392 sstrerror (errno, errbuf, sizeof (errbuf)));
396 memset (rf, '\0', sizeof (read_func_t));
397 rf->wait_time = interval_g;
399 rf->callback = callback;
400 rf->needs_read = DONE;
402 return (register_callback (&list_read, name, (void *) rf));
403 } /* int plugin_register_read */
405 int plugin_register_write (const char *name,
406 int (*callback) (const data_set_t *ds, const value_list_t *vl))
408 return (register_callback (&list_write, name, (void *) callback));
409 } /* int plugin_register_write */
411 int plugin_register_shutdown (char *name,
412 int (*callback) (void))
414 return (register_callback (&list_shutdown, name, (void *) callback));
415 } /* int plugin_register_shutdown */
417 int plugin_register_data_set (const data_set_t *ds)
422 if ((list_data_set != NULL)
423 && (llist_search (list_data_set, ds->type) != NULL))
425 NOTICE ("Replacing DS `%s' with another version.", ds->type);
426 plugin_unregister_data_set (ds->type);
429 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
432 memcpy(ds_copy, ds, sizeof (data_set_t));
434 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
436 if (ds_copy->ds == NULL)
442 for (i = 0; i < ds->ds_num; i++)
443 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
445 return (register_callback (&list_data_set, ds->type, (void *) ds_copy));
446 } /* int plugin_register_data_set */
448 int plugin_register_log (char *name,
449 void (*callback) (int priority, const char *msg))
451 return (register_callback (&list_log, name, (void *) callback));
452 } /* int plugin_register_log */
454 int plugin_unregister_config (const char *name)
456 cf_unregister (name);
458 } /* int plugin_unregister_config */
460 int plugin_unregister_init (const char *name)
462 return (plugin_unregister (list_init, name));
465 int plugin_unregister_read (const char *name)
469 e = llist_search (list_read, name);
474 llist_remove (list_read, e);
481 int plugin_unregister_write (const char *name)
483 return (plugin_unregister (list_write, name));
486 int plugin_unregister_shutdown (const char *name)
488 return (plugin_unregister (list_shutdown, name));
491 int plugin_unregister_data_set (const char *name)
496 if (list_data_set == NULL)
499 e = llist_search (list_data_set, name);
504 llist_remove (list_data_set, e);
505 ds = (data_set_t *) e->value;
512 } /* int plugin_unregister_data_set */
514 int plugin_unregister_log (const char *name)
516 return (plugin_unregister (list_log, name));
519 void plugin_init_all (void)
521 int (*callback) (void);
525 /* Start read-threads */
526 if (list_read != NULL)
530 rt = global_option_get ("ReadThreads");
532 start_threads ((num > 0) ? num : 5);
535 if (list_init == NULL)
538 le = llist_head (list_init);
541 callback = (int (*) (void)) le->value;
542 status = (*callback) ();
546 ERROR ("Initialization of plugin `%s' "
547 "failed with status %i. "
548 "Plugin will be unloaded.",
550 /* FIXME: Unload _all_ functions */
551 plugin_unregister_read (le->key);
556 } /* void plugin_init_all */
558 void plugin_read_all (const int *loop)
563 if (list_read == NULL)
566 pthread_mutex_lock (&read_lock);
568 le = llist_head (list_read);
571 rf = (read_func_t *) le->value;
573 if (rf->needs_read != DONE)
579 if (rf->wait_left > 0)
580 rf->wait_left -= interval_g;
582 if (rf->wait_left <= 0)
584 rf->needs_read = TODO;
590 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
591 pthread_cond_broadcast (&read_cond);
592 pthread_mutex_unlock (&read_lock);
593 } /* void plugin_read_all */
595 void plugin_shutdown_all (void)
597 int (*callback) (void);
602 if (list_shutdown == NULL)
605 le = llist_head (list_shutdown);
608 callback = (int (*) (void)) le->value;
610 /* Advance the pointer before calling the callback allows
611 * shutdown functions to unregister themselves. If done the
612 * other way around the memory `le' points to will be freed
613 * after callback returns. */
618 } /* void plugin_shutdown_all */
620 int plugin_dispatch_values (const char *name, value_list_t *vl)
622 int (*callback) (const data_set_t *, const value_list_t *);
626 if ((list_write == NULL) || (list_data_set == NULL))
629 le = llist_search (list_data_set, name);
632 DEBUG ("No such dataset registered: %s", name);
636 ds = (data_set_t *) le->value;
638 DEBUG ("plugin: plugin_dispatch_values: time = %u; host = %s; "
639 "plugin = %s; plugin_instance = %s; type = %s; "
640 "type_instance = %s;",
641 (unsigned int) vl->time, vl->host,
642 vl->plugin, vl->plugin_instance,
643 ds->type, vl->type_instance);
646 assert (ds->ds_num == vl->values_len);
648 if (ds->ds_num != vl->values_len)
650 ERROR ("plugin: ds->type = %s: (ds->ds_num = %i) != "
651 "(vl->values_len = %i)",
652 ds->type, ds->ds_num, vl->values_len);
657 escape_slashes (vl->host, sizeof (vl->host));
658 escape_slashes (vl->plugin, sizeof (vl->plugin));
659 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
660 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
662 le = llist_head (list_write);
665 callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
666 (*callback) (ds, vl);
672 } /* int plugin_dispatch_values */
674 void plugin_log (int level, const char *format, ...)
679 void (*callback) (int, const char *);
682 if (list_log == NULL)
686 if (level >= LOG_DEBUG)
690 va_start (ap, format);
691 vsnprintf (msg, 512, format, ap);
695 le = llist_head (list_log);
698 callback = (void (*) (int, const char *)) le->value;
699 (*callback) (level, msg);
703 } /* void plugin_log */
705 void plugin_complain (int level, complain_t *c, const char *format, ...)
716 if (c->interval < interval_g)
717 c->interval = interval_g;
721 if (c->interval > 86400)
724 c->delay = c->interval / interval_g;
726 va_start (ap, format);
727 vsnprintf (message, 512, format, ap);
731 plugin_log (level, message);
734 void plugin_relief (int level, complain_t *c, const char *format, ...)
739 if (c->interval == 0)
744 va_start (ap, format);
745 vsnprintf (message, 512, format, ap);
749 plugin_log (level, message);
752 const data_set_t *plugin_get_ds (const char *name)
757 le = llist_search (list_data_set, name);
760 DEBUG ("No such dataset registered: %s", name);
764 ds = (data_set_t *) le->value;
767 } /* data_set_t *plugin_get_ds */