2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2008 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>
20 * Sebastian Harl <sh at tokkee.org>
33 #include "configfile.h"
34 #include "utils_avltree.h"
35 #include "utils_llist.h"
36 #include "utils_cache.h"
37 #include "utils_threshold.h"
46 int (*callback) (void);
47 enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
49 typedef struct read_func_s read_func_t;
54 static llist_t *list_init;
55 static llist_t *list_read;
56 static llist_t *list_write;
57 static llist_t *list_flush;
58 static llist_t *list_shutdown;
59 static llist_t *list_log;
60 static llist_t *list_notification;
62 static c_avl_tree_t *data_sets;
64 static char *plugindir = NULL;
66 static int read_loop = 1;
67 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
68 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
69 static pthread_t *read_threads = NULL;
70 static int read_threads_num = 0;
75 static const char *plugin_get_dir (void)
77 if (plugindir == NULL)
83 static int register_callback (llist_t **list, const char *name, void *callback)
89 && ((*list = llist_create ()) == NULL))
92 le = llist_search (*list, name);
99 le = llentry_create (key, callback);
106 llist_append (*list, le);
110 le->value = callback;
114 } /* int register_callback */
116 static int plugin_unregister (llist_t *list, const char *name)
120 e = llist_search (list, name);
125 llist_remove (list, e);
130 } /* int plugin_unregister */
133 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
134 * object, but it will bitch about a shared object not having a
135 * ``module_register'' symbol..
137 static int plugin_load_file (char *file)
140 void (*reg_handle) (void);
142 DEBUG ("file = %s", file);
145 lt_dlerror (); /* clear errors */
147 if ((dlh = lt_dlopen (file)) == NULL)
149 const char *error = lt_dlerror ();
151 ERROR ("lt_dlopen failed: %s", error);
152 fprintf (stderr, "lt_dlopen failed: %s\n", error);
156 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
158 WARNING ("Couldn't find symbol ``module_register'' in ``%s'': %s\n",
159 file, lt_dlerror ());
169 static void *plugin_read_thread (void *args)
176 pthread_mutex_lock (&read_lock);
178 while (read_loop != 0)
180 le = llist_head (list_read);
183 while ((read_loop != 0) && (le != NULL))
185 rf = (read_func_t *) le->value;
187 if (rf->needs_read != TODO)
193 /* We will do this read function */
194 rf->needs_read = ACTIVE;
196 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
197 (unsigned long int) pthread_self (), le->key);
198 pthread_mutex_unlock (&read_lock);
200 status = rf->callback ();
205 if (rf->wait_time < interval_g)
206 rf->wait_time = interval_g;
207 rf->wait_left = rf->wait_time;
208 rf->wait_time = rf->wait_time * 2;
209 if (rf->wait_time > 86400)
210 rf->wait_time = 86400;
212 NOTICE ("read-function of plugin `%s' "
213 "failed. Will suspend it for %i "
214 "seconds.", le->key, rf->wait_left);
219 rf->wait_time = interval_g;
222 pthread_mutex_lock (&read_lock);
224 rf->needs_read = DONE;
226 } /* while (le != NULL) */
228 if ((read_loop != 0) && (done == 0))
230 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
231 (unsigned long int) pthread_self ());
232 pthread_cond_wait (&read_cond, &read_lock);
234 } /* while (read_loop) */
236 pthread_mutex_unlock (&read_lock);
240 } /* void *plugin_read_thread */
242 static void start_threads (int num)
246 if (read_threads != NULL)
249 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
250 if (read_threads == NULL)
252 ERROR ("plugin: start_threads: calloc failed.");
256 read_threads_num = 0;
257 for (i = 0; i < num; i++)
259 if (pthread_create (read_threads + read_threads_num, NULL,
260 plugin_read_thread, NULL) == 0)
266 ERROR ("plugin: start_threads: pthread_create failed.");
270 } /* void start_threads */
272 static void stop_threads (void)
276 pthread_mutex_lock (&read_lock);
278 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
279 pthread_cond_broadcast (&read_cond);
280 pthread_mutex_unlock (&read_lock);
282 for (i = 0; i < read_threads_num; i++)
284 if (pthread_join (read_threads[i], NULL) != 0)
286 ERROR ("plugin: stop_threads: pthread_join failed.");
288 read_threads[i] = (pthread_t) 0;
290 sfree (read_threads);
291 read_threads_num = 0;
292 } /* void stop_threads */
297 void plugin_set_dir (const char *dir)
299 if (plugindir != NULL)
304 else if ((plugindir = strdup (dir)) == NULL)
307 ERROR ("strdup failed: %s",
308 sstrerror (errno, errbuf, sizeof (errbuf)));
313 int plugin_load (const char *type)
317 char filename[BUFSIZE] = "";
318 char typename[BUFSIZE];
324 DEBUG ("type = %s", type);
326 dir = plugin_get_dir ();
329 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
330 * type when matching the filename */
331 if (ssnprintf (typename, sizeof (typename),
332 "%s.so", type) >= sizeof (typename))
334 WARNING ("snprintf: truncated: `%s.so'", type);
337 typename_len = strlen (typename);
339 if ((dh = opendir (dir)) == NULL)
342 ERROR ("opendir (%s): %s", dir,
343 sstrerror (errno, errbuf, sizeof (errbuf)));
347 while ((de = readdir (dh)) != NULL)
349 if (strncasecmp (de->d_name, typename, typename_len))
352 if (ssnprintf (filename, sizeof (filename),
353 "%s/%s", dir, de->d_name) >= sizeof (filename))
355 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
359 if (lstat (filename, &statbuf) == -1)
362 WARNING ("stat %s: %s", filename,
363 sstrerror (errno, errbuf, sizeof (errbuf)));
366 else if (!S_ISREG (statbuf.st_mode))
368 /* don't follow symlinks */
372 if (plugin_load_file (filename) == 0)
380 fprintf (stderr, "Unable to load plugin %s.\n", type);
386 if (filename[0] == '\0')
387 fprintf (stderr, "Could not find plugin %s.\n", type);
393 * The `register_*' functions follow
395 int plugin_register_config (const char *name,
396 int (*callback) (const char *key, const char *val),
397 const char **keys, int keys_num)
399 cf_register (name, callback, keys, keys_num);
401 } /* int plugin_register_config */
403 int plugin_register_complex_config (const char *type,
404 int (*callback) (oconfig_item_t *))
406 return (cf_register_complex (type, callback));
407 } /* int plugin_register_complex_config */
409 int plugin_register_init (const char *name,
410 int (*callback) (void))
412 return (register_callback (&list_init, name, (void *) callback));
413 } /* plugin_register_init */
415 int plugin_register_read (const char *name,
416 int (*callback) (void))
420 rf = (read_func_t *) malloc (sizeof (read_func_t));
424 ERROR ("plugin_register_read: malloc failed: %s",
425 sstrerror (errno, errbuf, sizeof (errbuf)));
429 memset (rf, '\0', sizeof (read_func_t));
430 rf->wait_time = interval_g;
432 rf->callback = callback;
433 rf->needs_read = DONE;
435 return (register_callback (&list_read, name, (void *) rf));
436 } /* int plugin_register_read */
438 int plugin_register_write (const char *name,
439 int (*callback) (const data_set_t *ds, const value_list_t *vl))
441 return (register_callback (&list_write, name, (void *) callback));
442 } /* int plugin_register_write */
444 int plugin_register_flush (const char *name, int (*callback) (const int))
446 return (register_callback (&list_flush, name, (void *) callback));
447 } /* int plugin_register_flush */
449 int plugin_register_shutdown (char *name,
450 int (*callback) (void))
452 return (register_callback (&list_shutdown, name, (void *) callback));
453 } /* int plugin_register_shutdown */
455 int plugin_register_data_set (const data_set_t *ds)
460 if ((data_sets != NULL)
461 && (c_avl_get (data_sets, ds->type, NULL) == 0))
463 NOTICE ("Replacing DS `%s' with another version.", ds->type);
464 plugin_unregister_data_set (ds->type);
466 else if (data_sets == NULL)
468 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
469 if (data_sets == NULL)
473 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
476 memcpy(ds_copy, ds, sizeof (data_set_t));
478 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
480 if (ds_copy->ds == NULL)
486 for (i = 0; i < ds->ds_num; i++)
487 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
489 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
490 } /* int plugin_register_data_set */
492 int plugin_register_log (char *name,
493 void (*callback) (int priority, const char *msg))
495 return (register_callback (&list_log, name, (void *) callback));
496 } /* int plugin_register_log */
498 int plugin_register_notification (const char *name,
499 int (*callback) (const notification_t *notif))
501 return (register_callback (&list_notification, name, (void *) callback));
502 } /* int plugin_register_log */
504 int plugin_unregister_config (const char *name)
506 cf_unregister (name);
508 } /* int plugin_unregister_config */
510 int plugin_unregister_complex_config (const char *name)
512 cf_unregister_complex (name);
514 } /* int plugin_unregister_complex_config */
516 int plugin_unregister_init (const char *name)
518 return (plugin_unregister (list_init, name));
521 int plugin_unregister_read (const char *name)
525 e = llist_search (list_read, name);
530 llist_remove (list_read, e);
538 int plugin_unregister_write (const char *name)
540 return (plugin_unregister (list_write, name));
543 int plugin_unregister_flush (const char *name)
545 return (plugin_unregister (list_flush, name));
548 int plugin_unregister_shutdown (const char *name)
550 return (plugin_unregister (list_shutdown, name));
553 int plugin_unregister_data_set (const char *name)
557 if (data_sets == NULL)
560 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
567 } /* int plugin_unregister_data_set */
569 int plugin_unregister_log (const char *name)
571 return (plugin_unregister (list_log, name));
574 int plugin_unregister_notification (const char *name)
576 return (plugin_unregister (list_notification, name));
579 void plugin_init_all (void)
581 int (*callback) (void);
585 /* Start read-threads */
586 if (list_read != NULL)
590 rt = global_option_get ("ReadThreads");
592 start_threads ((num > 0) ? num : 5);
595 /* Init the value cache */
598 if (list_init == NULL)
601 le = llist_head (list_init);
604 callback = (int (*) (void)) le->value;
605 status = (*callback) ();
609 ERROR ("Initialization of plugin `%s' "
610 "failed with status %i. "
611 "Plugin will be unloaded.",
613 /* FIXME: Unload _all_ functions */
614 plugin_unregister_read (le->key);
619 } /* void plugin_init_all */
621 void plugin_read_all (void)
628 if (list_read == NULL)
631 pthread_mutex_lock (&read_lock);
633 le = llist_head (list_read);
636 rf = (read_func_t *) le->value;
638 if (rf->needs_read != DONE)
644 if (rf->wait_left > 0)
645 rf->wait_left -= interval_g;
647 if (rf->wait_left <= 0)
649 rf->needs_read = TODO;
655 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
656 pthread_cond_broadcast (&read_cond);
657 pthread_mutex_unlock (&read_lock);
658 } /* void plugin_read_all */
660 int plugin_flush_one (int timeout, const char *name)
662 int (*callback) (int);
666 if (list_flush == NULL)
669 le = llist_search (list_flush, name);
672 callback = (int (*) (int)) le->value;
674 status = (*callback) (timeout);
677 } /* int plugin_flush_ont */
679 void plugin_flush_all (int timeout)
681 int (*callback) (int);
684 if (list_flush == NULL)
687 le = llist_head (list_flush);
690 callback = (int (*) (int)) le->value;
693 (*callback) (timeout);
695 } /* void plugin_flush_all */
697 void plugin_shutdown_all (void)
699 int (*callback) (void);
704 if (list_shutdown == NULL)
707 le = llist_head (list_shutdown);
710 callback = (int (*) (void)) le->value;
712 /* Advance the pointer before calling the callback allows
713 * shutdown functions to unregister themselves. If done the
714 * other way around the memory `le' points to will be freed
715 * after callback returns. */
720 } /* void plugin_shutdown_all */
722 int plugin_dispatch_values (value_list_t *vl)
724 int (*callback) (const data_set_t *, const value_list_t *);
728 if ((vl == NULL) || (*vl->type == '\0')) {
729 ERROR ("plugin_dispatch_values: Invalid value list.");
733 if (list_write == NULL)
735 ERROR ("plugin_dispatch_values: No write callback has been "
736 "registered. Please load at least one plugin "
737 "that provides a write function.");
741 if (data_sets == NULL)
743 ERROR ("plugin_dispatch_values: No data sets registered. "
744 "Could the types database be read? Check "
745 "your `TypesDB' setting!");
749 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
751 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
755 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
757 "plugin = %s; plugin_instance = %s; "
758 "type = %s; type_instance = %s;",
759 (unsigned int) vl->time, vl->interval,
761 vl->plugin, vl->plugin_instance,
762 vl->type, vl->type_instance);
765 assert (0 == strcmp (ds->type, vl->type));
767 if (0 != strcmp (ds->type, vl->type))
768 WARN ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
773 assert (ds->ds_num == vl->values_len);
775 if (ds->ds_num != vl->values_len)
777 ERROR ("plugin_dispatch_values: ds->type = %s: "
778 "(ds->ds_num = %i) != "
779 "(vl->values_len = %i)",
780 ds->type, ds->ds_num, vl->values_len);
785 escape_slashes (vl->host, sizeof (vl->host));
786 escape_slashes (vl->plugin, sizeof (vl->plugin));
787 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
788 escape_slashes (vl->type, sizeof (vl->type));
789 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
791 /* Update the value cache */
793 ut_check_threshold (ds, vl);
795 le = llist_head (list_write);
798 callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
799 (*callback) (ds, vl);
805 } /* int plugin_dispatch_values */
807 int plugin_dispatch_notification (const notification_t *notif)
809 int (*callback) (const notification_t *);
811 /* Possible TODO: Add flap detection here */
813 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
814 "time = %u; host = %s;",
815 notif->severity, notif->message,
816 (unsigned int) notif->time, notif->host);
818 /* Nobody cares for notifications */
819 if (list_notification == NULL)
822 le = llist_head (list_notification);
825 callback = (int (*) (const notification_t *)) le->value;
832 } /* int plugin_dispatch_notification */
834 void plugin_log (int level, const char *format, ...)
839 void (*callback) (int, const char *);
842 if (list_log == NULL)
846 if (level >= LOG_DEBUG)
850 va_start (ap, format);
851 vsnprintf (msg, 512, format, ap);
855 le = llist_head (list_log);
858 callback = (void (*) (int, const char *)) le->value;
859 (*callback) (level, msg);
863 } /* void plugin_log */
865 const data_set_t *plugin_get_ds (const char *name)
869 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
871 DEBUG ("No such dataset registered: %s", name);
876 } /* data_set_t *plugin_get_ds */