1 /**
2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006,2007 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 "plugin.h"
24 #include "common.h"
25 #include "utils_avltree.h"
27 #include <rrd.h>
29 #if HAVE_PTHREAD_H
30 # include <pthread.h>
31 #endif
33 /*
34 * Private types
35 */
36 struct rrd_cache_s
37 {
38 int values_num;
39 char **values;
40 time_t first_value;
41 time_t last_value;
42 enum
43 {
44 FLAG_NONE = 0x00,
45 FLAG_QUEUED = 0x01
46 } flags;
47 };
48 typedef struct rrd_cache_s rrd_cache_t;
50 struct rrd_queue_s
51 {
52 char *filename;
53 struct rrd_queue_s *next;
54 };
55 typedef struct rrd_queue_s rrd_queue_t;
57 /*
58 * Private variables
59 */
60 static int rra_timespans[] =
61 {
62 3600,
63 86400,
64 604800,
65 2678400,
66 31622400
67 };
68 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
70 static int *rra_timespans_custom = NULL;
71 static int rra_timespans_custom_num = 0;
73 static char *rra_types[] =
74 {
75 "AVERAGE",
76 "MIN",
77 "MAX"
78 };
79 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
81 static const char *config_keys[] =
82 {
83 "CacheTimeout",
84 "CacheFlush",
85 "DataDir",
86 "StepSize",
87 "HeartBeat",
88 "RRARows",
89 "RRATimespan",
90 "XFF"
91 };
92 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
94 /* If datadir is zero, the daemon's basedir is used. If stepsize or heartbeat
95 * is zero a default, depending on the `interval' member of the value list is
96 * being used. */
97 static char *datadir = NULL;
98 static int stepsize = 0;
99 static int heartbeat = 0;
100 static int rrarows = 1200;
101 static double xff = 0.1;
103 /* XXX: If you need to lock both, cache_lock and queue_lock, at the same time,
104 * ALWAYS lock `cache_lock' first! */
105 static int cache_timeout = 0;
106 static int cache_flush_timeout = 0;
107 static time_t cache_flush_last;
108 static c_avl_tree_t *cache = NULL;
109 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
111 static rrd_queue_t *queue_head = NULL;
112 static rrd_queue_t *queue_tail = NULL;
113 static pthread_t queue_thread = 0;
114 static pthread_mutex_t queue_lock = PTHREAD_MUTEX_INITIALIZER;
115 static pthread_cond_t queue_cond = PTHREAD_COND_INITIALIZER;
117 #if !HAVE_THREADSAFE_LIBRRD
118 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
119 #endif
121 static int do_shutdown = 0;
123 /* * * * * * * * * *
124 * WARNING: Magic *
125 * * * * * * * * * */
127 static void rra_free (int rra_num, char **rra_def)
128 {
129 int i;
131 for (i = 0; i < rra_num; i++)
132 {
133 sfree (rra_def[i]);
134 }
135 sfree (rra_def);
136 } /* void rra_free */
138 static int rra_get (char ***ret, const value_list_t *vl)
139 {
140 char **rra_def;
141 int rra_num;
143 int *rts;
144 int rts_num;
146 int rra_max;
148 int span;
150 int cdp_num;
151 int cdp_len;
152 int i, j;
154 char buffer[64];
156 /* The stepsize we use here: If it is user-set, use it. If not, use the
157 * interval of the value-list. */
158 int ss;
160 if (rrarows <= 0)
161 {
162 *ret = NULL;
163 return (-1);
164 }
166 ss = (stepsize > 0) ? stepsize : vl->interval;
167 if (ss <= 0)
168 {
169 *ret = NULL;
170 return (-1);
171 }
173 /* Use the configured timespans or fall back to the built-in defaults */
174 if (rra_timespans_custom_num != 0)
175 {
176 rts = rra_timespans_custom;
177 rts_num = rra_timespans_custom_num;
178 }
179 else
180 {
181 rts = rra_timespans;
182 rts_num = rra_timespans_num;
183 }
185 rra_max = rts_num * rra_types_num;
187 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
188 return (-1);
189 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
190 rra_num = 0;
192 cdp_len = 0;
193 for (i = 0; i < rts_num; i++)
194 {
195 span = rts[i];
197 if ((span / ss) < rrarows)
198 continue;
200 if (cdp_len == 0)
201 cdp_len = 1;
202 else
203 cdp_len = (int) floor (((double) span)
204 / ((double) (rrarows * ss)));
206 cdp_num = (int) ceil (((double) span)
207 / ((double) (cdp_len * ss)));
209 for (j = 0; j < rra_types_num; j++)
210 {
211 if (rra_num >= rra_max)
212 break;
214 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
215 rra_types[j], xff,
216 cdp_len, cdp_num) >= sizeof (buffer))
217 {
218 ERROR ("rra_get: Buffer would have been truncated.");
219 continue;
220 }
222 rra_def[rra_num++] = sstrdup (buffer);
223 }
224 }
226 #if COLLECT_DEBUG
227 DEBUG ("rra_num = %i", rra_num);
228 for (i = 0; i < rra_num; i++)
229 DEBUG (" %s", rra_def[i]);
230 #endif
232 *ret = rra_def;
233 return (rra_num);
234 } /* int rra_get */
236 static void ds_free (int ds_num, char **ds_def)
237 {
238 int i;
240 for (i = 0; i < ds_num; i++)
241 if (ds_def[i] != NULL)
242 free (ds_def[i]);
243 free (ds_def);
244 }
246 static int ds_get (char ***ret, const data_set_t *ds, const value_list_t *vl)
247 {
248 char **ds_def;
249 int ds_num;
251 char min[32];
252 char max[32];
253 char buffer[128];
255 DEBUG ("ds->ds_num = %i", ds->ds_num);
257 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
258 if (ds_def == NULL)
259 {
260 char errbuf[1024];
261 ERROR ("rrdtool plugin: malloc failed: %s",
262 sstrerror (errno, errbuf, sizeof (errbuf)));
263 return (-1);
264 }
265 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
267 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
268 {
269 data_source_t *d = ds->ds + ds_num;
270 char *type;
271 int status;
273 ds_def[ds_num] = NULL;
275 if (d->type == DS_TYPE_COUNTER)
276 type = "COUNTER";
277 else if (d->type == DS_TYPE_GAUGE)
278 type = "GAUGE";
279 else
280 {
281 ERROR ("rrdtool plugin: Unknown DS type: %i",
282 d->type);
283 break;
284 }
286 if (isnan (d->min))
287 {
288 strcpy (min, "U");
289 }
290 else
291 {
292 snprintf (min, sizeof (min), "%lf", d->min);
293 min[sizeof (min) - 1] = '\0';
294 }
296 if (isnan (d->max))
297 {
298 strcpy (max, "U");
299 }
300 else
301 {
302 snprintf (max, sizeof (max), "%lf", d->max);
303 max[sizeof (max) - 1] = '\0';
304 }
306 status = snprintf (buffer, sizeof (buffer),
307 "DS:%s:%s:%i:%s:%s",
308 d->name, type,
309 (heartbeat > 0) ? heartbeat : (2 * vl->interval),
310 min, max);
311 if ((status < 1) || (status >= sizeof (buffer)))
312 break;
314 ds_def[ds_num] = sstrdup (buffer);
315 } /* for ds_num = 0 .. ds->ds_num */
317 #if COLLECT_DEBUG
318 {
319 int i;
320 DEBUG ("ds_num = %i", ds_num);
321 for (i = 0; i < ds_num; i++)
322 DEBUG (" %s", ds_def[i]);
323 }
324 #endif
326 if (ds_num != ds->ds_num)
327 {
328 ds_free (ds_num, ds_def);
329 return (-1);
330 }
332 *ret = ds_def;
333 return (ds_num);
334 }
336 #if HAVE_THREADSAFE_LIBRRD
337 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
338 int argc, char **argv)
339 {
340 int status;
342 optind = 0; /* bug in librrd? */
343 rrd_clear_error ();
345 status = rrd_create_r (filename, pdp_step, last_up, argc, argv);
347 if (status != 0)
348 {
349 WARNING ("rrdtool plugin: rrd_create_r (%s) failed: %s",
350 filename, rrd_get_error ());
351 }
353 return (status);
354 } /* int srrd_create */
356 static int srrd_update (char *filename, char *template, int argc, char **argv)
357 {
358 int status;
360 optind = 0; /* bug in librrd? */
361 rrd_clear_error ();
363 status = rrd_update_r (filename, template, argc, argv);
365 if (status != 0)
366 {
367 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
368 filename, rrd_get_error ());
369 }
371 return (status);
372 } /* int srrd_update */
373 /* #endif HAVE_THREADSAFE_LIBRRD */
375 #else /* !HAVE_THREADSAFE_LIBRRD */
376 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
377 int argc, char **argv)
378 {
379 int status;
381 int new_argc;
382 char **new_argv;
384 char pdp_step_str[16];
385 char last_up_str[16];
387 new_argc = 6 + argc;
388 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
389 if (new_argv == NULL)
390 {
391 ERROR ("rrdtool plugin: malloc failed.");
392 return (-1);
393 }
395 if (last_up == 0)
396 last_up = time (NULL) - 10;
398 snprintf (pdp_step_str, sizeof (pdp_step_str), "%lu", pdp_step);
399 pdp_step_str[sizeof (pdp_step_str) - 1] = '\0';
400 snprintf (last_up_str, sizeof (last_up_str), "%u", (unsigned int) last_up);
401 last_up_str[sizeof (last_up_str) - 1] = '\0';
403 new_argv[0] = "create";
404 new_argv[1] = filename;
405 new_argv[2] = "-s";
406 new_argv[3] = pdp_step_str;
407 new_argv[4] = "-b";
408 new_argv[5] = last_up_str;
410 memcpy (new_argv + 6, argv, argc * sizeof (char *));
411 new_argv[new_argc] = NULL;
413 pthread_mutex_lock (&librrd_lock);
414 optind = 0; /* bug in librrd? */
415 rrd_clear_error ();
417 status = rrd_create (new_argc, new_argv);
418 pthread_mutex_unlock (&librrd_lock);
420 if (status != 0)
421 {
422 WARNING ("rrdtool plugin: rrd_create (%s) failed: %s",
423 filename, rrd_get_error ());
424 }
426 sfree (new_argv);
428 return (status);
429 } /* int srrd_create */
431 static int srrd_update (char *filename, char *template, int argc, char **argv)
432 {
433 int status;
435 int new_argc;
436 char **new_argv;
438 assert (template == NULL);
440 new_argc = 2 + argc;
441 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
442 if (new_argv == NULL)
443 {
444 ERROR ("rrdtool plugin: malloc failed.");
445 return (-1);
446 }
448 new_argv[0] = "update";
449 new_argv[1] = filename;
451 memcpy (new_argv + 2, argv, argc * sizeof (char *));
452 new_argv[new_argc] = NULL;
454 pthread_mutex_lock (&librrd_lock);
455 optind = 0; /* bug in librrd? */
456 rrd_clear_error ();
458 status = rrd_update (new_argc, new_argv);
459 pthread_mutex_unlock (&librrd_lock);
461 if (status != 0)
462 {
463 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
464 argv[1], rrd_get_error ());
465 }
467 sfree (new_argv);
469 return (status);
470 } /* int srrd_update */
471 #endif /* !HAVE_THREADSAFE_LIBRRD */
473 static int rrd_create_file (char *filename, const data_set_t *ds, const value_list_t *vl)
474 {
475 char **argv;
476 int argc;
477 char **rra_def;
478 int rra_num;
479 char **ds_def;
480 int ds_num;
481 int status = 0;
483 if (check_create_dir (filename))
484 return (-1);
486 if ((rra_num = rra_get (&rra_def, vl)) < 1)
487 {
488 ERROR ("rrd_create_file failed: Could not calculate RRAs");
489 return (-1);
490 }
492 if ((ds_num = ds_get (&ds_def, ds, vl)) < 1)
493 {
494 ERROR ("rrd_create_file failed: Could not calculate DSes");
495 return (-1);
496 }
498 argc = ds_num + rra_num;
500 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
501 {
502 char errbuf[1024];
503 ERROR ("rrd_create failed: %s",
504 sstrerror (errno, errbuf, sizeof (errbuf)));
505 return (-1);
506 }
508 memcpy (argv, ds_def, ds_num * sizeof (char *));
509 memcpy (argv + ds_num, rra_def, rra_num * sizeof (char *));
510 argv[ds_num + rra_num] = NULL;
512 assert (vl->time > 10);
513 status = srrd_create (filename,
514 (stepsize > 0) ? stepsize : vl->interval,
515 vl->time - 10,
516 argc, argv);
518 free (argv);
519 ds_free (ds_num, ds_def);
520 rra_free (rra_num, rra_def);
522 return (status);
523 }
525 static int value_list_to_string (char *buffer, int buffer_len,
526 const data_set_t *ds, const value_list_t *vl)
527 {
528 int offset;
529 int status;
530 int i;
532 memset (buffer, '\0', buffer_len);
534 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
535 if ((status < 1) || (status >= buffer_len))
536 return (-1);
537 offset = status;
539 for (i = 0; i < ds->ds_num; i++)
540 {
541 if ((ds->ds[i].type != DS_TYPE_COUNTER)
542 && (ds->ds[i].type != DS_TYPE_GAUGE))
543 return (-1);
545 if (ds->ds[i].type == DS_TYPE_COUNTER)
546 status = snprintf (buffer + offset, buffer_len - offset,
547 ":%llu", vl->values[i].counter);
548 else
549 status = snprintf (buffer + offset, buffer_len - offset,
550 ":%lf", vl->values[i].gauge);
552 if ((status < 1) || (status >= (buffer_len - offset)))
553 return (-1);
555 offset += status;
556 } /* for ds->ds_num */
558 return (0);
559 } /* int value_list_to_string */
561 static int value_list_to_filename (char *buffer, int buffer_len,
562 const data_set_t *ds, const value_list_t *vl)
563 {
564 int offset = 0;
565 int status;
567 if (datadir != NULL)
568 {
569 status = snprintf (buffer + offset, buffer_len - offset,
570 "%s/", datadir);
571 if ((status < 1) || (status >= buffer_len - offset))
572 return (-1);
573 offset += status;
574 }
576 status = snprintf (buffer + offset, buffer_len - offset,
577 "%s/", vl->host);
578 if ((status < 1) || (status >= buffer_len - offset))
579 return (-1);
580 offset += status;
582 if (strlen (vl->plugin_instance) > 0)
583 status = snprintf (buffer + offset, buffer_len - offset,
584 "%s-%s/", vl->plugin, vl->plugin_instance);
585 else
586 status = snprintf (buffer + offset, buffer_len - offset,
587 "%s/", vl->plugin);
588 if ((status < 1) || (status >= buffer_len - offset))
589 return (-1);
590 offset += status;
592 if (strlen (vl->type_instance) > 0)
593 status = snprintf (buffer + offset, buffer_len - offset,
594 "%s-%s.rrd", ds->type, vl->type_instance);
595 else
596 status = snprintf (buffer + offset, buffer_len - offset,
597 "%s.rrd", ds->type);
598 if ((status < 1) || (status >= buffer_len - offset))
599 return (-1);
600 offset += status;
602 return (0);
603 } /* int value_list_to_filename */
605 static void *rrd_queue_thread (void *data)
606 {
607 while (42)
608 {
609 rrd_queue_t *queue_entry;
610 rrd_cache_t *cache_entry;
611 char **values;
612 int values_num;
613 int i;
615 /* XXX: If you need to lock both, cache_lock and queue_lock, at
616 * the same time, ALWAYS lock `cache_lock' first! */
618 /* wait until an entry is available */
619 pthread_mutex_lock (&queue_lock);
620 while ((queue_head == NULL) && (do_shutdown == 0))
621 pthread_cond_wait (&queue_cond, &queue_lock);
623 /* We're in the shutdown phase */
624 if (queue_head == NULL)
625 {
626 pthread_mutex_unlock (&queue_lock);
627 break;
628 }
630 /* Dequeue the first entry */
631 queue_entry = queue_head;
632 if (queue_head == queue_tail)
633 queue_head = queue_tail = NULL;
634 else
635 queue_head = queue_head->next;
637 /* Unlock the queue again */
638 pthread_mutex_unlock (&queue_lock);
640 /* We now need the cache lock so the entry isn't updated while
641 * we make a copy of it's values */
642 pthread_mutex_lock (&cache_lock);
644 c_avl_get (cache, queue_entry->filename, (void *) &cache_entry);
646 values = cache_entry->values;
647 values_num = cache_entry->values_num;
649 cache_entry->values = NULL;
650 cache_entry->values_num = 0;
651 cache_entry->flags = FLAG_NONE;
653 pthread_mutex_unlock (&cache_lock);
655 /* Write the values to the RRD-file */
656 srrd_update (queue_entry->filename, NULL, values_num, values);
658 for (i = 0; i < values_num; i++)
659 {
660 sfree (values[i]);
661 }
662 sfree (values);
663 sfree (queue_entry->filename);
664 sfree (queue_entry);
665 } /* while (42) */
667 pthread_mutex_lock (&cache_lock);
668 c_avl_destroy (cache);
669 cache = NULL;
670 pthread_mutex_unlock (&cache_lock);
672 pthread_exit ((void *) 0);
673 return ((void *) 0);
674 } /* void *rrd_queue_thread */
676 static int rrd_queue_cache_entry (const char *filename)
677 {
678 rrd_queue_t *queue_entry;
680 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
681 if (queue_entry == NULL)
682 return (-1);
684 queue_entry->filename = strdup (filename);
685 if (queue_entry->filename == NULL)
686 {
687 free (queue_entry);
688 return (-1);
689 }
691 queue_entry->next = NULL;
693 pthread_mutex_lock (&queue_lock);
694 if (queue_tail == NULL)
695 queue_head = queue_entry;
696 else
697 queue_tail->next = queue_entry;
698 queue_tail = queue_entry;
699 pthread_cond_signal (&queue_cond);
700 pthread_mutex_unlock (&queue_lock);
702 DEBUG ("rrdtool plugin: Put `%s' into the update queue", filename);
704 return (0);
705 } /* int rrd_queue_cache_entry */
707 static void rrd_cache_flush (int timeout)
708 {
709 rrd_cache_t *rc;
710 time_t now;
712 char **keys = NULL;
713 int keys_num = 0;
715 char *key;
716 c_avl_iterator_t *iter;
717 int i;
719 DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
721 now = time (NULL);
723 /* Build a list of entries to be flushed */
724 iter = c_avl_get_iterator (cache);
725 while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
726 {
727 if (rc->flags == FLAG_QUEUED)
728 continue;
729 else if ((now - rc->first_value) < timeout)
730 continue;
731 else if (rc->values_num > 0)
732 {
733 if (rrd_queue_cache_entry (key) == 0)
734 rc->flags = FLAG_QUEUED;
735 }
736 else /* ancient and no values -> waste of memory */
737 {
738 keys = (char **) realloc ((void *) keys,
739 (keys_num + 1) * sizeof (char *));
740 if (keys == NULL)
741 {
742 char errbuf[1024];
743 ERROR ("rrdtool plugin: "
744 "realloc failed: %s",
745 sstrerror (errno, errbuf,
746 sizeof (errbuf)));
747 c_avl_iterator_destroy (iter);
748 return;
749 }
750 keys[keys_num] = key;
751 keys_num++;
752 }
753 } /* while (c_avl_iterator_next) */
754 c_avl_iterator_destroy (iter);
756 for (i = 0; i < keys_num; i++)
757 {
758 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
759 {
760 DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
761 continue;
762 }
764 assert (rc->values == NULL);
765 assert (rc->values_num == 0);
767 sfree (rc);
768 sfree (key);
769 keys[i] = NULL;
770 } /* for (i = 0..keys_num) */
772 free (keys);
774 cache_flush_last = now;
775 } /* void rrd_cache_flush */
777 static int rrd_cache_insert (const char *filename,
778 const char *value, time_t value_time)
779 {
780 rrd_cache_t *rc = NULL;
781 int new_rc = 0;
782 char **values_new;
784 pthread_mutex_lock (&cache_lock);
786 c_avl_get (cache, filename, (void *) &rc);
788 if (rc == NULL)
789 {
790 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
791 if (rc == NULL)
792 return (-1);
793 rc->values_num = 0;
794 rc->values = NULL;
795 rc->first_value = 0;
796 rc->last_value = 0;
797 rc->flags = FLAG_NONE;
798 new_rc = 1;
799 }
801 if (rc->last_value >= value_time)
802 {
803 pthread_mutex_unlock (&cache_lock);
804 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
805 (unsigned int) rc->last_value,
806 (unsigned int) value_time);
807 return (-1);
808 }
810 values_new = (char **) realloc ((void *) rc->values,
811 (rc->values_num + 1) * sizeof (char *));
812 if (values_new == NULL)
813 {
814 char errbuf[1024];
815 void *cache_key = NULL;
817 sstrerror (errno, errbuf, sizeof (errbuf));
819 c_avl_remove (cache, filename, &cache_key, NULL);
820 pthread_mutex_unlock (&cache_lock);
822 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
824 sfree (cache_key);
825 sfree (rc->values);
826 sfree (rc);
827 return (-1);
828 }
829 rc->values = values_new;
831 rc->values[rc->values_num] = strdup (value);
832 if (rc->values[rc->values_num] != NULL)
833 rc->values_num++;
835 if (rc->values_num == 1)
836 rc->first_value = value_time;
837 rc->last_value = value_time;
839 /* Insert if this is the first value */
840 if (new_rc == 1)
841 {
842 void *cache_key = strdup (filename);
844 if (cache_key == NULL)
845 {
846 char errbuf[1024];
847 sstrerror (errno, errbuf, sizeof (errbuf));
849 pthread_mutex_unlock (&cache_lock);
851 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
853 sfree (rc->values[0]);
854 sfree (rc->values);
855 sfree (rc);
856 return (-1);
857 }
859 c_avl_insert (cache, cache_key, rc);
860 }
862 DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
863 "values_num = %i; age = %u;",
864 filename, rc->values_num,
865 rc->last_value - rc->first_value);
867 if ((rc->last_value - rc->first_value) >= cache_timeout)
868 {
869 /* XXX: If you need to lock both, cache_lock and queue_lock, at
870 * the same time, ALWAYS lock `cache_lock' first! */
871 if (rc->flags != FLAG_QUEUED)
872 {
873 if (rrd_queue_cache_entry (filename) == 0)
874 rc->flags = FLAG_QUEUED;
875 }
876 else
877 {
878 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
879 }
880 }
882 if ((cache_timeout > 0) &&
883 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
884 rrd_cache_flush (cache_flush_timeout);
887 pthread_mutex_unlock (&cache_lock);
889 return (0);
890 } /* int rrd_cache_insert */
892 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
893 {
894 struct stat statbuf;
895 char filename[512];
896 char values[512];
897 int status;
899 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
900 return (-1);
902 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
903 return (-1);
905 if (stat (filename, &statbuf) == -1)
906 {
907 if (errno == ENOENT)
908 {
909 if (rrd_create_file (filename, ds, vl))
910 return (-1);
911 }
912 else
913 {
914 char errbuf[1024];
915 ERROR ("stat(%s) failed: %s", filename,
916 sstrerror (errno, errbuf,
917 sizeof (errbuf)));
918 return (-1);
919 }
920 }
921 else if (!S_ISREG (statbuf.st_mode))
922 {
923 ERROR ("stat(%s): Not a regular file!",
924 filename);
925 return (-1);
926 }
928 status = rrd_cache_insert (filename, values, vl->time);
930 return (status);
931 } /* int rrd_write */
933 static int rrd_config (const char *key, const char *value)
934 {
935 if (strcasecmp ("CacheTimeout", key) == 0)
936 {
937 int tmp = atoi (value);
938 if (tmp < 0)
939 {
940 fprintf (stderr, "rrdtool: `CacheTimeout' must "
941 "be greater than 0.\n");
942 return (1);
943 }
944 cache_timeout = tmp;
945 }
946 else if (strcasecmp ("CacheFlush", key) == 0)
947 {
948 int tmp = atoi (value);
949 if (tmp < 0)
950 {
951 fprintf (stderr, "rrdtool: `CacheFlush' must "
952 "be greater than 0.\n");
953 return (1);
954 }
955 cache_flush_timeout = tmp;
956 }
957 else if (strcasecmp ("DataDir", key) == 0)
958 {
959 if (datadir != NULL)
960 free (datadir);
961 datadir = strdup (value);
962 if (datadir != NULL)
963 {
964 int len = strlen (datadir);
965 while ((len > 0) && (datadir[len - 1] == '/'))
966 {
967 len--;
968 datadir[len] = '\0';
969 }
970 if (len <= 0)
971 {
972 free (datadir);
973 datadir = NULL;
974 }
975 }
976 }
977 else if (strcasecmp ("StepSize", key) == 0)
978 {
979 stepsize = atoi (value);
980 if (stepsize < 0)
981 stepsize = 0;
982 }
983 else if (strcasecmp ("HeartBeat", key) == 0)
984 {
985 heartbeat = atoi (value);
986 if (heartbeat < 0)
987 heartbeat = 0;
988 }
989 else if (strcasecmp ("RRARows", key) == 0)
990 {
991 int tmp = atoi (value);
992 if (tmp <= 0)
993 {
994 fprintf (stderr, "rrdtool: `RRARows' must "
995 "be greater than 0.\n");
996 return (1);
997 }
998 rrarows = tmp;
999 }
1000 else if (strcasecmp ("RRATimespan", key) == 0)
1001 {
1002 char *saveptr = NULL;
1003 char *dummy;
1004 char *ptr;
1005 char *value_copy;
1006 int *tmp_alloc;
1008 value_copy = strdup (value);
1009 if (value_copy == NULL)
1010 return (1);
1012 dummy = value_copy;
1013 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1014 {
1015 dummy = NULL;
1017 tmp_alloc = realloc (rra_timespans_custom,
1018 sizeof (int) * (rra_timespans_custom_num + 1));
1019 if (tmp_alloc == NULL)
1020 {
1021 fprintf (stderr, "rrdtool: realloc failed.\n");
1022 free (value_copy);
1023 return (1);
1024 }
1025 rra_timespans_custom = tmp_alloc;
1026 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
1027 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
1028 rra_timespans_custom_num++;
1029 } /* while (strtok_r) */
1030 free (value_copy);
1031 }
1032 else if (strcasecmp ("XFF", key) == 0)
1033 {
1034 double tmp = atof (value);
1035 if ((tmp < 0.0) || (tmp >= 1.0))
1036 {
1037 fprintf (stderr, "rrdtool: `XFF' must "
1038 "be in the range 0 to 1 (exclusive).");
1039 return (1);
1040 }
1041 xff = tmp;
1042 }
1043 else
1044 {
1045 return (-1);
1046 }
1047 return (0);
1048 } /* int rrd_config */
1050 static int rrd_shutdown (void)
1051 {
1052 pthread_mutex_lock (&cache_lock);
1053 rrd_cache_flush (-1);
1054 pthread_mutex_unlock (&cache_lock);
1056 pthread_mutex_lock (&queue_lock);
1057 do_shutdown = 1;
1058 pthread_cond_signal (&queue_cond);
1059 pthread_mutex_unlock (&queue_lock);
1061 /* Wait for all the values to be written to disk before returning. */
1062 if (queue_thread != 0)
1063 {
1064 pthread_join (queue_thread, NULL);
1065 queue_thread = 0;
1066 DEBUG ("rrdtool plugin: queue_thread exited.");
1067 }
1069 return (0);
1070 } /* int rrd_shutdown */
1072 static int rrd_init (void)
1073 {
1074 int status;
1076 if (stepsize < 0)
1077 stepsize = 0;
1078 if (heartbeat <= 0)
1079 {
1080 if (stepsize > 0)
1081 heartbeat = 2 * stepsize;
1082 else
1083 heartbeat = 0;
1084 }
1086 if ((heartbeat > 0) && (heartbeat < interval_g))
1087 WARNING ("rrdtool plugin: Your `heartbeat' is "
1088 "smaller than your `interval'. This will "
1089 "likely cause problems.");
1090 else if ((stepsize > 0) && (stepsize < interval_g))
1091 WARNING ("rrdtool plugin: Your `stepsize' is "
1092 "smaller than your `interval'. This will "
1093 "create needlessly big RRD-files.");
1095 /* Set the cache up */
1096 pthread_mutex_lock (&cache_lock);
1098 cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1099 if (cache == NULL)
1100 {
1101 ERROR ("rrdtool plugin: c_avl_create failed.");
1102 return (-1);
1103 }
1105 cache_flush_last = time (NULL);
1106 if (cache_timeout < 2)
1107 {
1108 cache_timeout = 0;
1109 cache_flush_timeout = 0;
1110 }
1111 else if (cache_flush_timeout < cache_timeout)
1112 cache_flush_timeout = 10 * cache_timeout;
1114 pthread_mutex_unlock (&cache_lock);
1116 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1117 if (status != 0)
1118 {
1119 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1120 return (-1);
1121 }
1123 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1124 " heartbeat = %i; rrarows = %i; xff = %lf;",
1125 (datadir == NULL) ? "(null)" : datadir,
1126 stepsize, heartbeat, rrarows, xff);
1128 return (0);
1129 } /* int rrd_init */
1131 void module_register (void)
1132 {
1133 plugin_register_config ("rrdtool", rrd_config,
1134 config_keys, config_keys_num);
1135 plugin_register_init ("rrdtool", rrd_init);
1136 plugin_register_write ("rrdtool", rrd_write);
1137 plugin_register_shutdown ("rrdtool", rrd_shutdown);
1138 }