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);
136 fprintf (stderr, "lt_dlopen failed: %s\n", error);
140 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
142 WARNING ("Couldn't find symbol ``module_register'' in ``%s'': %s\n",
143 file, lt_dlerror ());
153 static void *plugin_read_thread (void *args)
160 pthread_mutex_lock (&read_lock);
162 while (read_loop != 0)
164 le = llist_head (list_read);
167 while ((read_loop != 0) && (le != NULL))
169 rf = (read_func_t *) le->value;
171 if (rf->needs_read != TODO)
177 /* We will do this read function */
178 rf->needs_read = ACTIVE;
180 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
181 (unsigned long int) pthread_self (), le->key);
182 pthread_mutex_unlock (&read_lock);
184 status = rf->callback ();
189 if (rf->wait_time < interval_g)
190 rf->wait_time = interval_g;
191 rf->wait_left = rf->wait_time;
192 rf->wait_time = rf->wait_time * 2;
193 if (rf->wait_time > 86400)
194 rf->wait_time = 86400;
196 NOTICE ("read-function of plugin `%s' "
197 "failed. Will suspend it for %i "
198 "seconds.", le->key, rf->wait_left);
203 rf->wait_time = interval_g;
206 pthread_mutex_lock (&read_lock);
208 rf->needs_read = DONE;
210 } /* while (le != NULL) */
212 if ((read_loop != 0) && (done == 0))
214 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
215 (unsigned long int) pthread_self ());
216 pthread_cond_wait (&read_cond, &read_lock);
218 } /* while (read_loop) */
220 pthread_mutex_unlock (&read_lock);
223 } /* void *plugin_read_thread */
225 static void start_threads (int num)
229 if (read_threads != NULL)
232 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
233 if (read_threads == NULL)
235 ERROR ("plugin: start_threads: calloc failed.");
239 read_threads_num = 0;
240 for (i = 0; i < num; i++)
242 if (pthread_create (read_threads + read_threads_num, NULL,
243 plugin_read_thread, NULL) == 0)
249 ERROR ("plugin: start_threads: pthread_create failed.");
253 } /* void start_threads */
255 static void stop_threads (void)
259 pthread_mutex_lock (&read_lock);
261 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
262 pthread_cond_broadcast (&read_cond);
263 pthread_mutex_unlock (&read_lock);
265 for (i = 0; i < read_threads_num; i++)
267 if (pthread_join (read_threads[i], NULL) != 0)
269 ERROR ("plugin: stop_threads: pthread_join failed.");
271 read_threads[i] = (pthread_t) 0;
273 sfree (read_threads);
274 read_threads_num = 0;
275 } /* void stop_threads */
280 void plugin_set_dir (const char *dir)
282 if (plugindir != NULL)
287 else if ((plugindir = strdup (dir)) == NULL)
290 ERROR ("strdup failed: %s",
291 sstrerror (errno, errbuf, sizeof (errbuf)));
296 int plugin_load (const char *type)
300 char filename[BUFSIZE] = "";
301 char typename[BUFSIZE];
307 DEBUG ("type = %s", type);
309 dir = plugin_get_dir ();
312 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
313 * type when matching the filename */
314 if (snprintf (typename, BUFSIZE, "%s.so", type) >= BUFSIZE)
316 WARNING ("snprintf: truncated: `%s.so'", type);
319 typename_len = strlen (typename);
321 if ((dh = opendir (dir)) == NULL)
324 ERROR ("opendir (%s): %s", dir,
325 sstrerror (errno, errbuf, sizeof (errbuf)));
329 while ((de = readdir (dh)) != NULL)
331 if (strncasecmp (de->d_name, typename, typename_len))
334 if (snprintf (filename, BUFSIZE, "%s/%s", dir, de->d_name) >= BUFSIZE)
336 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
340 if (lstat (filename, &statbuf) == -1)
343 WARNING ("stat %s: %s", filename,
344 sstrerror (errno, errbuf, sizeof (errbuf)));
347 else if (!S_ISREG (statbuf.st_mode))
349 /* don't follow symlinks */
353 if (plugin_load_file (filename) == 0)
361 fprintf (stderr, "Unable to load plugin %s.\n", type);
367 if (filename[0] == '\0')
368 fprintf (stderr, "Could not find plugin %s.\n", type);
374 * The `register_*' functions follow
376 int plugin_register_config (const char *name,
377 int (*callback) (const char *key, const char *val),
378 const char **keys, int keys_num)
380 cf_register (name, callback, keys, keys_num);
382 } /* int plugin_register_config */
384 int plugin_register_complex_config (const char *type,
385 int (*callback) (oconfig_item_t *))
387 return (cf_register_complex (type, callback));
388 } /* int plugin_register_complex_config */
390 int plugin_register_init (const char *name,
391 int (*callback) (void))
393 return (register_callback (&list_init, name, (void *) callback));
394 } /* plugin_register_init */
396 int plugin_register_read (const char *name,
397 int (*callback) (void))
401 rf = (read_func_t *) malloc (sizeof (read_func_t));
405 ERROR ("plugin_register_read: malloc failed: %s",
406 sstrerror (errno, errbuf, sizeof (errbuf)));
410 memset (rf, '\0', sizeof (read_func_t));
411 rf->wait_time = interval_g;
413 rf->callback = callback;
414 rf->needs_read = DONE;
416 return (register_callback (&list_read, name, (void *) rf));
417 } /* int plugin_register_read */
419 int plugin_register_write (const char *name,
420 int (*callback) (const data_set_t *ds, const value_list_t *vl))
422 return (register_callback (&list_write, name, (void *) callback));
423 } /* int plugin_register_write */
425 int plugin_register_shutdown (char *name,
426 int (*callback) (void))
428 return (register_callback (&list_shutdown, name, (void *) callback));
429 } /* int plugin_register_shutdown */
431 int plugin_register_data_set (const data_set_t *ds)
436 if ((list_data_set != NULL)
437 && (llist_search (list_data_set, ds->type) != NULL))
439 NOTICE ("Replacing DS `%s' with another version.", ds->type);
440 plugin_unregister_data_set (ds->type);
443 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
446 memcpy(ds_copy, ds, sizeof (data_set_t));
448 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
450 if (ds_copy->ds == NULL)
456 for (i = 0; i < ds->ds_num; i++)
457 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
459 return (register_callback (&list_data_set, ds->type, (void *) ds_copy));
460 } /* int plugin_register_data_set */
462 int plugin_register_log (char *name,
463 void (*callback) (int priority, const char *msg))
465 return (register_callback (&list_log, name, (void *) callback));
466 } /* int plugin_register_log */
468 int plugin_unregister_config (const char *name)
470 cf_unregister (name);
472 } /* int plugin_unregister_config */
474 int plugin_unregister_complex_config (const char *name)
476 cf_unregister_complex (name);
478 } /* int plugin_unregister_complex_config */
480 int plugin_unregister_init (const char *name)
482 return (plugin_unregister (list_init, name));
485 int plugin_unregister_read (const char *name)
489 e = llist_search (list_read, name);
494 llist_remove (list_read, e);
501 int plugin_unregister_write (const char *name)
503 return (plugin_unregister (list_write, name));
506 int plugin_unregister_shutdown (const char *name)
508 return (plugin_unregister (list_shutdown, name));
511 int plugin_unregister_data_set (const char *name)
516 if (list_data_set == NULL)
519 e = llist_search (list_data_set, name);
524 llist_remove (list_data_set, e);
525 ds = (data_set_t *) e->value;
532 } /* int plugin_unregister_data_set */
534 int plugin_unregister_log (const char *name)
536 return (plugin_unregister (list_log, name));
539 void plugin_init_all (void)
541 int (*callback) (void);
545 /* Start read-threads */
546 if (list_read != NULL)
550 rt = global_option_get ("ReadThreads");
552 start_threads ((num > 0) ? num : 5);
555 if (list_init == NULL)
558 le = llist_head (list_init);
561 callback = (int (*) (void)) le->value;
562 status = (*callback) ();
566 ERROR ("Initialization of plugin `%s' "
567 "failed with status %i. "
568 "Plugin will be unloaded.",
570 /* FIXME: Unload _all_ functions */
571 plugin_unregister_read (le->key);
576 } /* void plugin_init_all */
578 void plugin_read_all (const int *loop)
583 if (list_read == NULL)
586 pthread_mutex_lock (&read_lock);
588 le = llist_head (list_read);
591 rf = (read_func_t *) le->value;
593 if (rf->needs_read != DONE)
599 if (rf->wait_left > 0)
600 rf->wait_left -= interval_g;
602 if (rf->wait_left <= 0)
604 rf->needs_read = TODO;
610 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
611 pthread_cond_broadcast (&read_cond);
612 pthread_mutex_unlock (&read_lock);
613 } /* void plugin_read_all */
615 void plugin_shutdown_all (void)
617 int (*callback) (void);
622 if (list_shutdown == NULL)
625 le = llist_head (list_shutdown);
628 callback = (int (*) (void)) le->value;
630 /* Advance the pointer before calling the callback allows
631 * shutdown functions to unregister themselves. If done the
632 * other way around the memory `le' points to will be freed
633 * after callback returns. */
638 } /* void plugin_shutdown_all */
640 int plugin_dispatch_values (const char *name, value_list_t *vl)
642 int (*callback) (const data_set_t *, const value_list_t *);
646 if ((list_write == NULL) || (list_data_set == NULL))
649 le = llist_search (list_data_set, name);
652 DEBUG ("No such dataset registered: %s", name);
656 ds = (data_set_t *) le->value;
658 DEBUG ("plugin: plugin_dispatch_values: time = %u; interval = %i; "
660 "plugin = %s; plugin_instance = %s; "
661 "type = %s; type_instance = %s;",
662 (unsigned int) vl->time, vl->interval,
664 vl->plugin, vl->plugin_instance,
665 ds->type, vl->type_instance);
668 assert (ds->ds_num == vl->values_len);
670 if (ds->ds_num != vl->values_len)
672 ERROR ("plugin: ds->type = %s: (ds->ds_num = %i) != "
673 "(vl->values_len = %i)",
674 ds->type, ds->ds_num, vl->values_len);
679 escape_slashes (vl->host, sizeof (vl->host));
680 escape_slashes (vl->plugin, sizeof (vl->plugin));
681 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
682 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
684 le = llist_head (list_write);
687 callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
688 (*callback) (ds, vl);
694 } /* int plugin_dispatch_values */
696 void plugin_log (int level, const char *format, ...)
701 void (*callback) (int, const char *);
704 if (list_log == NULL)
708 if (level >= LOG_DEBUG)
712 va_start (ap, format);
713 vsnprintf (msg, 512, format, ap);
717 le = llist_head (list_log);
720 callback = (void (*) (int, const char *)) le->value;
721 (*callback) (level, msg);
725 } /* void plugin_log */
727 void plugin_complain (int level, complain_t *c, const char *format, ...)
738 if (c->interval < interval_g)
739 c->interval = interval_g;
743 if (c->interval > 86400)
746 c->delay = c->interval / interval_g;
748 va_start (ap, format);
749 vsnprintf (message, 512, format, ap);
753 plugin_log (level, message);
756 void plugin_relief (int level, complain_t *c, const char *format, ...)
761 if (c->interval == 0)
766 va_start (ap, format);
767 vsnprintf (message, 512, format, ap);
771 plugin_log (level, message);
774 const data_set_t *plugin_get_ds (const char *name)
779 le = llist_search (list_data_set, name);
782 DEBUG ("No such dataset registered: %s", name);
786 ds = (data_set_t *) le->value;
789 } /* data_set_t *plugin_get_ds */