1 /**
2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006-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 "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 FLAG_FLUSHQ = 0x02
47 } flags;
48 };
49 typedef struct rrd_cache_s rrd_cache_t;
51 enum rrd_queue_dir_e
52 {
53 QUEUE_INSERT_FRONT,
54 QUEUE_INSERT_BACK
55 };
56 typedef enum rrd_queue_dir_e rrd_queue_dir_t;
58 struct rrd_queue_s
59 {
60 char *filename;
61 struct rrd_queue_s *next;
62 };
63 typedef struct rrd_queue_s rrd_queue_t;
65 /*
66 * Private variables
67 */
68 static int rra_timespans[] =
69 {
70 3600,
71 86400,
72 604800,
73 2678400,
74 31622400
75 };
76 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
78 static int *rra_timespans_custom = NULL;
79 static int rra_timespans_custom_num = 0;
81 static char *rra_types[] =
82 {
83 "AVERAGE",
84 "MIN",
85 "MAX"
86 };
87 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
89 static const char *config_keys[] =
90 {
91 "CacheTimeout",
92 "CacheFlush",
93 "DataDir",
94 "StepSize",
95 "HeartBeat",
96 "RRARows",
97 "RRATimespan",
98 "XFF",
99 "WritesPerSecond"
100 };
101 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
103 /* If datadir is zero, the daemon's basedir is used. If stepsize or heartbeat
104 * is zero a default, depending on the `interval' member of the value list is
105 * being used. */
106 static char *datadir = NULL;
107 static int stepsize = 0;
108 static int heartbeat = 0;
109 static int rrarows = 1200;
110 static double xff = 0.1;
111 static double write_rate = 0.0;
113 /* XXX: If you need to lock both, cache_lock and queue_lock, at the same time,
114 * ALWAYS lock `cache_lock' first! */
115 static int cache_timeout = 0;
116 static int cache_flush_timeout = 0;
117 static time_t cache_flush_last;
118 static c_avl_tree_t *cache = NULL;
119 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
121 static rrd_queue_t *queue_head = NULL;
122 static rrd_queue_t *queue_tail = NULL;
123 static rrd_queue_t *flushq_head = NULL;
124 static rrd_queue_t *flushq_tail = NULL;
125 static pthread_t queue_thread = 0;
126 static pthread_mutex_t queue_lock = PTHREAD_MUTEX_INITIALIZER;
127 static pthread_cond_t queue_cond = PTHREAD_COND_INITIALIZER;
129 #if !HAVE_THREADSAFE_LIBRRD
130 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
131 #endif
133 static int do_shutdown = 0;
135 /* * * * * * * * * *
136 * WARNING: Magic *
137 * * * * * * * * * */
139 static void rra_free (int rra_num, char **rra_def)
140 {
141 int i;
143 for (i = 0; i < rra_num; i++)
144 {
145 sfree (rra_def[i]);
146 }
147 sfree (rra_def);
148 } /* void rra_free */
150 static int rra_get (char ***ret, const value_list_t *vl)
151 {
152 char **rra_def;
153 int rra_num;
155 int *rts;
156 int rts_num;
158 int rra_max;
160 int span;
162 int cdp_num;
163 int cdp_len;
164 int i, j;
166 char buffer[64];
168 /* The stepsize we use here: If it is user-set, use it. If not, use the
169 * interval of the value-list. */
170 int ss;
172 if (rrarows <= 0)
173 {
174 *ret = NULL;
175 return (-1);
176 }
178 ss = (stepsize > 0) ? stepsize : vl->interval;
179 if (ss <= 0)
180 {
181 *ret = NULL;
182 return (-1);
183 }
185 /* Use the configured timespans or fall back to the built-in defaults */
186 if (rra_timespans_custom_num != 0)
187 {
188 rts = rra_timespans_custom;
189 rts_num = rra_timespans_custom_num;
190 }
191 else
192 {
193 rts = rra_timespans;
194 rts_num = rra_timespans_num;
195 }
197 rra_max = rts_num * rra_types_num;
199 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
200 return (-1);
201 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
202 rra_num = 0;
204 cdp_len = 0;
205 for (i = 0; i < rts_num; i++)
206 {
207 span = rts[i];
209 if ((span / ss) < rrarows)
210 span = ss * rrarows;
212 if (cdp_len == 0)
213 cdp_len = 1;
214 else
215 cdp_len = (int) floor (((double) span)
216 / ((double) (rrarows * ss)));
218 cdp_num = (int) ceil (((double) span)
219 / ((double) (cdp_len * ss)));
221 for (j = 0; j < rra_types_num; j++)
222 {
223 if (rra_num >= rra_max)
224 break;
226 if (ssnprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
227 rra_types[j], xff,
228 cdp_len, cdp_num) >= sizeof (buffer))
229 {
230 ERROR ("rra_get: Buffer would have been truncated.");
231 continue;
232 }
234 rra_def[rra_num++] = sstrdup (buffer);
235 }
236 }
238 #if COLLECT_DEBUG
239 DEBUG ("rra_num = %i", rra_num);
240 for (i = 0; i < rra_num; i++)
241 DEBUG (" %s", rra_def[i]);
242 #endif
244 *ret = rra_def;
245 return (rra_num);
246 } /* int rra_get */
248 static void ds_free (int ds_num, char **ds_def)
249 {
250 int i;
252 for (i = 0; i < ds_num; i++)
253 if (ds_def[i] != NULL)
254 free (ds_def[i]);
255 free (ds_def);
256 }
258 static int ds_get (char ***ret, const data_set_t *ds, const value_list_t *vl)
259 {
260 char **ds_def;
261 int ds_num;
263 char min[32];
264 char max[32];
265 char buffer[128];
267 DEBUG ("ds->ds_num = %i", ds->ds_num);
269 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
270 if (ds_def == NULL)
271 {
272 char errbuf[1024];
273 ERROR ("rrdtool plugin: malloc failed: %s",
274 sstrerror (errno, errbuf, sizeof (errbuf)));
275 return (-1);
276 }
277 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
279 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
280 {
281 data_source_t *d = ds->ds + ds_num;
282 char *type;
283 int status;
285 ds_def[ds_num] = NULL;
287 if (d->type == DS_TYPE_COUNTER)
288 type = "COUNTER";
289 else if (d->type == DS_TYPE_GAUGE)
290 type = "GAUGE";
291 else
292 {
293 ERROR ("rrdtool plugin: Unknown DS type: %i",
294 d->type);
295 break;
296 }
298 if (isnan (d->min))
299 {
300 sstrncpy (min, "U", sizeof (min));
301 }
302 else
303 ssnprintf (min, sizeof (min), "%lf", d->min);
305 if (isnan (d->max))
306 {
307 sstrncpy (max, "U", sizeof (max));
308 }
309 else
310 ssnprintf (max, sizeof (max), "%lf", d->max);
312 status = ssnprintf (buffer, sizeof (buffer),
313 "DS:%s:%s:%i:%s:%s",
314 d->name, type,
315 (heartbeat > 0) ? heartbeat : (2 * vl->interval),
316 min, max);
317 if ((status < 1) || (status >= sizeof (buffer)))
318 break;
320 ds_def[ds_num] = sstrdup (buffer);
321 } /* for ds_num = 0 .. ds->ds_num */
323 #if COLLECT_DEBUG
324 {
325 int i;
326 DEBUG ("ds_num = %i", ds_num);
327 for (i = 0; i < ds_num; i++)
328 DEBUG (" %s", ds_def[i]);
329 }
330 #endif
332 if (ds_num != ds->ds_num)
333 {
334 ds_free (ds_num, ds_def);
335 return (-1);
336 }
338 *ret = ds_def;
339 return (ds_num);
340 }
342 #if HAVE_THREADSAFE_LIBRRD
343 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
344 int argc, const char **argv)
345 {
346 int status;
348 optind = 0; /* bug in librrd? */
349 rrd_clear_error ();
351 status = rrd_create_r (filename, pdp_step, last_up, argc, (void *) argv);
353 if (status != 0)
354 {
355 WARNING ("rrdtool plugin: rrd_create_r (%s) failed: %s",
356 filename, rrd_get_error ());
357 }
359 return (status);
360 } /* int srrd_create */
362 static int srrd_update (char *filename, char *template,
363 int argc, const char **argv)
364 {
365 int status;
367 optind = 0; /* bug in librrd? */
368 rrd_clear_error ();
370 status = rrd_update_r (filename, template, argc, (void *) argv);
372 if (status != 0)
373 {
374 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
375 filename, rrd_get_error ());
376 }
378 return (status);
379 } /* int srrd_update */
380 /* #endif HAVE_THREADSAFE_LIBRRD */
382 #else /* !HAVE_THREADSAFE_LIBRRD */
383 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
384 int argc, const char **argv)
385 {
386 int status;
388 int new_argc;
389 char **new_argv;
391 char pdp_step_str[16];
392 char last_up_str[16];
394 new_argc = 6 + argc;
395 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
396 if (new_argv == NULL)
397 {
398 ERROR ("rrdtool plugin: malloc failed.");
399 return (-1);
400 }
402 if (last_up == 0)
403 last_up = time (NULL) - 10;
405 ssnprintf (pdp_step_str, sizeof (pdp_step_str), "%lu", pdp_step);
406 ssnprintf (last_up_str, sizeof (last_up_str), "%u", (unsigned int) last_up);
408 new_argv[0] = "create";
409 new_argv[1] = filename;
410 new_argv[2] = "-s";
411 new_argv[3] = pdp_step_str;
412 new_argv[4] = "-b";
413 new_argv[5] = last_up_str;
415 memcpy (new_argv + 6, argv, argc * sizeof (char *));
416 new_argv[new_argc] = NULL;
418 pthread_mutex_lock (&librrd_lock);
419 optind = 0; /* bug in librrd? */
420 rrd_clear_error ();
422 status = rrd_create (new_argc, new_argv);
423 pthread_mutex_unlock (&librrd_lock);
425 if (status != 0)
426 {
427 WARNING ("rrdtool plugin: rrd_create (%s) failed: %s",
428 filename, rrd_get_error ());
429 }
431 sfree (new_argv);
433 return (status);
434 } /* int srrd_create */
436 static int srrd_update (char *filename, char *template,
437 int argc, const char **argv)
438 {
439 int status;
441 int new_argc;
442 char **new_argv;
444 assert (template == NULL);
446 new_argc = 2 + argc;
447 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
448 if (new_argv == NULL)
449 {
450 ERROR ("rrdtool plugin: malloc failed.");
451 return (-1);
452 }
454 new_argv[0] = "update";
455 new_argv[1] = filename;
457 memcpy (new_argv + 2, argv, argc * sizeof (char *));
458 new_argv[new_argc] = NULL;
460 pthread_mutex_lock (&librrd_lock);
461 optind = 0; /* bug in librrd? */
462 rrd_clear_error ();
464 status = rrd_update (new_argc, new_argv);
465 pthread_mutex_unlock (&librrd_lock);
467 if (status != 0)
468 {
469 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
470 argv[1], rrd_get_error ());
471 }
473 sfree (new_argv);
475 return (status);
476 } /* int srrd_update */
477 #endif /* !HAVE_THREADSAFE_LIBRRD */
479 static int rrd_create_file (char *filename, const data_set_t *ds, const value_list_t *vl)
480 {
481 char **argv;
482 int argc;
483 char **rra_def;
484 int rra_num;
485 char **ds_def;
486 int ds_num;
487 int status = 0;
489 if (check_create_dir (filename))
490 return (-1);
492 if ((rra_num = rra_get (&rra_def, vl)) < 1)
493 {
494 ERROR ("rrd_create_file failed: Could not calculate RRAs");
495 return (-1);
496 }
498 if ((ds_num = ds_get (&ds_def, ds, vl)) < 1)
499 {
500 ERROR ("rrd_create_file failed: Could not calculate DSes");
501 return (-1);
502 }
504 argc = ds_num + rra_num;
506 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
507 {
508 char errbuf[1024];
509 ERROR ("rrd_create failed: %s",
510 sstrerror (errno, errbuf, sizeof (errbuf)));
511 return (-1);
512 }
514 memcpy (argv, ds_def, ds_num * sizeof (char *));
515 memcpy (argv + ds_num, rra_def, rra_num * sizeof (char *));
516 argv[ds_num + rra_num] = NULL;
518 assert (vl->time > 10);
519 status = srrd_create (filename,
520 (stepsize > 0) ? stepsize : vl->interval,
521 vl->time - 10,
522 argc, (const char **)argv);
524 free (argv);
525 ds_free (ds_num, ds_def);
526 rra_free (rra_num, rra_def);
528 return (status);
529 }
531 static int value_list_to_string (char *buffer, int buffer_len,
532 const data_set_t *ds, const value_list_t *vl)
533 {
534 int offset;
535 int status;
536 int i;
538 memset (buffer, '\0', buffer_len);
540 status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
541 if ((status < 1) || (status >= buffer_len))
542 return (-1);
543 offset = status;
545 for (i = 0; i < ds->ds_num; i++)
546 {
547 if ((ds->ds[i].type != DS_TYPE_COUNTER)
548 && (ds->ds[i].type != DS_TYPE_GAUGE))
549 return (-1);
551 if (ds->ds[i].type == DS_TYPE_COUNTER)
552 status = ssnprintf (buffer + offset, buffer_len - offset,
553 ":%llu", vl->values[i].counter);
554 else
555 status = ssnprintf (buffer + offset, buffer_len - offset,
556 ":%lf", vl->values[i].gauge);
558 if ((status < 1) || (status >= (buffer_len - offset)))
559 return (-1);
561 offset += status;
562 } /* for ds->ds_num */
564 return (0);
565 } /* int value_list_to_string */
567 static int value_list_to_filename (char *buffer, int buffer_len,
568 const data_set_t *ds, const value_list_t *vl)
569 {
570 int offset = 0;
571 int status;
573 if (datadir != NULL)
574 {
575 status = ssnprintf (buffer + offset, buffer_len - offset,
576 "%s/", datadir);
577 if ((status < 1) || (status >= buffer_len - offset))
578 return (-1);
579 offset += status;
580 }
582 status = ssnprintf (buffer + offset, buffer_len - offset,
583 "%s/", vl->host);
584 if ((status < 1) || (status >= buffer_len - offset))
585 return (-1);
586 offset += status;
588 if (strlen (vl->plugin_instance) > 0)
589 status = ssnprintf (buffer + offset, buffer_len - offset,
590 "%s-%s/", vl->plugin, vl->plugin_instance);
591 else
592 status = ssnprintf (buffer + offset, buffer_len - offset,
593 "%s/", vl->plugin);
594 if ((status < 1) || (status >= buffer_len - offset))
595 return (-1);
596 offset += status;
598 if (strlen (vl->type_instance) > 0)
599 status = ssnprintf (buffer + offset, buffer_len - offset,
600 "%s-%s.rrd", vl->type, vl->type_instance);
601 else
602 status = ssnprintf (buffer + offset, buffer_len - offset,
603 "%s.rrd", vl->type);
604 if ((status < 1) || (status >= buffer_len - offset))
605 return (-1);
606 offset += status;
608 return (0);
609 } /* int value_list_to_filename */
611 static void *rrd_queue_thread (void *data)
612 {
613 struct timeval tv_next_update;
614 struct timeval tv_now;
616 gettimeofday (&tv_next_update, /* timezone = */ NULL);
618 while (42)
619 {
620 rrd_queue_t *queue_entry;
621 rrd_cache_t *cache_entry;
622 char **values;
623 int values_num;
624 int status;
625 int i;
627 values = NULL;
628 values_num = 0;
630 pthread_mutex_lock (&queue_lock);
631 /* Wait for values to arrive */
632 while (true)
633 {
634 struct timespec ts_wait;
636 while ((flushq_head == NULL) && (queue_head == NULL)
637 && (do_shutdown == 0))
638 pthread_cond_wait (&queue_cond, &queue_lock);
640 if ((flushq_head == NULL) && (queue_head == NULL))
641 break;
643 /* Don't delay if there's something to flush */
644 if (flushq_head != NULL)
645 break;
647 /* Don't delay if we're shutting down */
648 if (do_shutdown != 0)
649 break;
651 /* Don't delay if no delay was configured. */
652 if (write_rate <= 0.0)
653 break;
655 gettimeofday (&tv_now, /* timezone = */ NULL);
656 status = timeval_sub_timespec (&tv_next_update, &tv_now,
657 &ts_wait);
658 /* We're good to go */
659 if (status != 0)
660 break;
662 /* We're supposed to wait a bit with this update, so we'll
663 * wait for the next addition to the queue or to the end of
664 * the wait period - whichever comes first. */
665 ts_wait.tv_sec = tv_next_update.tv_sec;
666 ts_wait.tv_nsec = 1000 * tv_next_update.tv_usec;
668 status = pthread_cond_timedwait (&queue_cond, &queue_lock,
669 &ts_wait);
670 if (status == ETIMEDOUT)
671 break;
672 } /* while (true) */
674 /* XXX: If you need to lock both, cache_lock and queue_lock, at
675 * the same time, ALWAYS lock `cache_lock' first! */
677 /* We're in the shutdown phase */
678 if ((flushq_head == NULL) && (queue_head == NULL))
679 {
680 pthread_mutex_unlock (&queue_lock);
681 break;
682 }
684 if (flushq_head != NULL)
685 {
686 /* Dequeue the first flush entry */
687 queue_entry = flushq_head;
688 if (flushq_head == flushq_tail)
689 flushq_head = flushq_tail = NULL;
690 else
691 flushq_head = flushq_head->next;
692 }
693 else /* if (queue_head != NULL) */
694 {
695 /* Dequeue the first regular entry */
696 queue_entry = queue_head;
697 if (queue_head == queue_tail)
698 queue_head = queue_tail = NULL;
699 else
700 queue_head = queue_head->next;
701 }
703 /* Unlock the queue again */
704 pthread_mutex_unlock (&queue_lock);
706 /* We now need the cache lock so the entry isn't updated while
707 * we make a copy of it's values */
708 pthread_mutex_lock (&cache_lock);
710 status = c_avl_get (cache, queue_entry->filename,
711 (void *) &cache_entry);
713 if (status == 0)
714 {
715 values = cache_entry->values;
716 values_num = cache_entry->values_num;
718 cache_entry->values = NULL;
719 cache_entry->values_num = 0;
720 cache_entry->flags = FLAG_NONE;
721 }
723 pthread_mutex_unlock (&cache_lock);
725 if (status != 0)
726 {
727 sfree (queue_entry->filename);
728 sfree (queue_entry);
729 continue;
730 }
732 /* Update `tv_next_update' */
733 if (write_rate > 0.0)
734 {
735 gettimeofday (&tv_now, /* timezone = */ NULL);
736 tv_next_update.tv_sec = tv_now.tv_sec;
737 tv_next_update.tv_usec = tv_now.tv_usec
738 + ((suseconds_t) (1000000 * write_rate));
739 while (tv_next_update.tv_usec > 1000000)
740 {
741 tv_next_update.tv_sec++;
742 tv_next_update.tv_usec -= 1000000;
743 }
744 }
746 /* Write the values to the RRD-file */
747 srrd_update (queue_entry->filename, NULL,
748 values_num, (const char **)values);
749 DEBUG ("rrdtool plugin: queue thread: Wrote %i values to %s",
750 values_num, queue_entry->filename);
752 for (i = 0; i < values_num; i++)
753 {
754 sfree (values[i]);
755 }
756 sfree (values);
757 sfree (queue_entry->filename);
758 sfree (queue_entry);
759 } /* while (42) */
761 pthread_mutex_lock (&cache_lock);
762 c_avl_destroy (cache);
763 cache = NULL;
764 pthread_mutex_unlock (&cache_lock);
766 pthread_exit ((void *) 0);
767 return ((void *) 0);
768 } /* void *rrd_queue_thread */
770 static int rrd_queue_enqueue (const char *filename,
771 rrd_queue_t **head, rrd_queue_t **tail)
772 {
773 rrd_queue_t *queue_entry;
775 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
776 if (queue_entry == NULL)
777 return (-1);
779 queue_entry->filename = strdup (filename);
780 if (queue_entry->filename == NULL)
781 {
782 free (queue_entry);
783 return (-1);
784 }
786 queue_entry->next = NULL;
788 pthread_mutex_lock (&queue_lock);
790 if (*tail == NULL)
791 *head = queue_entry;
792 else
793 (*tail)->next = queue_entry;
794 *tail = queue_entry;
796 pthread_cond_signal (&queue_cond);
797 pthread_mutex_unlock (&queue_lock);
799 return (0);
800 } /* int rrd_queue_enqueue */
802 static int rrd_queue_dequeue (const char *filename,
803 rrd_queue_t **head, rrd_queue_t **tail)
804 {
805 rrd_queue_t *this;
806 rrd_queue_t *prev;
808 pthread_mutex_lock (&queue_lock);
810 prev = NULL;
811 this = *head;
813 while (this != NULL)
814 {
815 if (strcmp (this->filename, filename) == 0)
816 break;
818 prev = this;
819 this = this->next;
820 }
822 if (this == NULL)
823 {
824 pthread_mutex_unlock (&queue_lock);
825 return (-1);
826 }
828 if (prev == NULL)
829 *head = this->next;
830 else
831 prev->next = this->next;
833 if (this->next == NULL)
834 *tail = prev;
836 pthread_mutex_unlock (&queue_lock);
838 sfree (this->filename);
839 sfree (this);
841 return (0);
842 } /* int rrd_queue_dequeue */
844 static void rrd_cache_flush (int timeout)
845 {
846 rrd_cache_t *rc;
847 time_t now;
849 char **keys = NULL;
850 int keys_num = 0;
852 char *key;
853 c_avl_iterator_t *iter;
854 int i;
856 DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
858 now = time (NULL);
860 /* Build a list of entries to be flushed */
861 iter = c_avl_get_iterator (cache);
862 while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
863 {
864 if (rc->flags != FLAG_NONE)
865 continue;
866 else if ((now - rc->first_value) < timeout)
867 continue;
868 else if (rc->values_num > 0)
869 {
870 int status;
872 status = rrd_queue_enqueue (key, &queue_head, &queue_tail);
873 if (status == 0)
874 rc->flags = FLAG_QUEUED;
875 }
876 else /* ancient and no values -> waste of memory */
877 {
878 char **tmp = (char **) realloc ((void *) keys,
879 (keys_num + 1) * sizeof (char *));
880 if (tmp == NULL)
881 {
882 char errbuf[1024];
883 ERROR ("rrdtool plugin: "
884 "realloc failed: %s",
885 sstrerror (errno, errbuf,
886 sizeof (errbuf)));
887 c_avl_iterator_destroy (iter);
888 sfree (keys);
889 return;
890 }
891 keys = tmp;
892 keys[keys_num] = key;
893 keys_num++;
894 }
895 } /* while (c_avl_iterator_next) */
896 c_avl_iterator_destroy (iter);
898 for (i = 0; i < keys_num; i++)
899 {
900 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
901 {
902 DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
903 continue;
904 }
906 assert (rc->values == NULL);
907 assert (rc->values_num == 0);
909 sfree (rc);
910 sfree (key);
911 keys[i] = NULL;
912 } /* for (i = 0..keys_num) */
914 sfree (keys);
916 cache_flush_last = now;
917 } /* void rrd_cache_flush */
919 static int rrd_cache_flush_identifier (int timeout, const char *identifier)
920 {
921 rrd_cache_t *rc;
922 time_t now;
923 int status;
924 char key[2048];
926 if (identifier == NULL)
927 {
928 rrd_cache_flush (timeout);
929 return (0);
930 }
932 now = time (NULL);
934 if (datadir == NULL)
935 snprintf (key, sizeof (key), "%s.rrd",
936 identifier);
937 else
938 snprintf (key, sizeof (key), "%s/%s.rrd",
939 datadir, identifier);
940 key[sizeof (key) - 1] = 0;
942 status = c_avl_get (cache, key, (void *) &rc);
943 if (status != 0)
944 {
945 WARNING ("rrdtool plugin: rrd_cache_flush_identifier: "
946 "c_avl_get (%s) failed. Does that file really exist?",
947 key);
948 return (status);
949 }
951 if (rc->flags == FLAG_FLUSHQ)
952 {
953 status = 0;
954 }
955 else if (rc->flags == FLAG_QUEUED)
956 {
957 rrd_queue_dequeue (key, &queue_head, &queue_tail);
958 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
959 if (status == 0)
960 rc->flags = FLAG_FLUSHQ;
961 }
962 else if ((now - rc->first_value) < timeout)
963 {
964 status = 0;
965 }
966 else if (rc->values_num > 0)
967 {
968 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
969 if (status == 0)
970 rc->flags = FLAG_FLUSHQ;
971 }
973 return (status);
974 } /* int rrd_cache_flush_identifier */
976 static int rrd_cache_insert (const char *filename,
977 const char *value, time_t value_time)
978 {
979 rrd_cache_t *rc = NULL;
980 int new_rc = 0;
981 char **values_new;
983 pthread_mutex_lock (&cache_lock);
985 /* This shouldn't happen, but it did happen at least once, so we'll be
986 * careful. */
987 if (cache == NULL)
988 {
989 pthread_mutex_unlock (&cache_lock);
990 WARNING ("rrdtool plugin: cache == NULL.");
991 return (-1);
992 }
994 c_avl_get (cache, filename, (void *) &rc);
996 if (rc == NULL)
997 {
998 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
999 if (rc == NULL)
1000 return (-1);
1001 rc->values_num = 0;
1002 rc->values = NULL;
1003 rc->first_value = 0;
1004 rc->last_value = 0;
1005 rc->flags = FLAG_NONE;
1006 new_rc = 1;
1007 }
1009 if (rc->last_value >= value_time)
1010 {
1011 pthread_mutex_unlock (&cache_lock);
1012 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
1013 (unsigned int) rc->last_value,
1014 (unsigned int) value_time);
1015 return (-1);
1016 }
1018 values_new = (char **) realloc ((void *) rc->values,
1019 (rc->values_num + 1) * sizeof (char *));
1020 if (values_new == NULL)
1021 {
1022 char errbuf[1024];
1023 void *cache_key = NULL;
1025 sstrerror (errno, errbuf, sizeof (errbuf));
1027 c_avl_remove (cache, filename, &cache_key, NULL);
1028 pthread_mutex_unlock (&cache_lock);
1030 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
1032 sfree (cache_key);
1033 sfree (rc->values);
1034 sfree (rc);
1035 return (-1);
1036 }
1037 rc->values = values_new;
1039 rc->values[rc->values_num] = strdup (value);
1040 if (rc->values[rc->values_num] != NULL)
1041 rc->values_num++;
1043 if (rc->values_num == 1)
1044 rc->first_value = value_time;
1045 rc->last_value = value_time;
1047 /* Insert if this is the first value */
1048 if (new_rc == 1)
1049 {
1050 void *cache_key = strdup (filename);
1052 if (cache_key == NULL)
1053 {
1054 char errbuf[1024];
1055 sstrerror (errno, errbuf, sizeof (errbuf));
1057 pthread_mutex_unlock (&cache_lock);
1059 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
1061 sfree (rc->values[0]);
1062 sfree (rc->values);
1063 sfree (rc);
1064 return (-1);
1065 }
1067 c_avl_insert (cache, cache_key, rc);
1068 }
1070 DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
1071 "values_num = %i; age = %lu;",
1072 filename, rc->values_num,
1073 (unsigned long)(rc->last_value - rc->first_value));
1075 if ((rc->last_value - rc->first_value) >= cache_timeout)
1076 {
1077 /* XXX: If you need to lock both, cache_lock and queue_lock, at
1078 * the same time, ALWAYS lock `cache_lock' first! */
1079 if (rc->flags == FLAG_NONE)
1080 {
1081 int status;
1083 status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
1084 if (status == 0)
1085 rc->flags = FLAG_QUEUED;
1086 }
1087 else
1088 {
1089 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
1090 }
1091 }
1093 if ((cache_timeout > 0) &&
1094 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
1095 rrd_cache_flush (cache_flush_timeout);
1097 pthread_mutex_unlock (&cache_lock);
1099 return (0);
1100 } /* int rrd_cache_insert */
1102 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
1103 {
1104 int a = *((int *) a_ptr);
1105 int b = *((int *) b_ptr);
1107 if (a < b)
1108 return (-1);
1109 else if (a > b)
1110 return (1);
1111 else
1112 return (0);
1113 } /* int rrd_compare_numeric */
1115 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
1116 {
1117 struct stat statbuf;
1118 char filename[512];
1119 char values[512];
1120 int status;
1122 if (0 != strcmp (ds->type, vl->type)) {
1123 ERROR ("rrdtool plugin: DS type does not match value list type");
1124 return -1;
1125 }
1127 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
1128 return (-1);
1130 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
1131 return (-1);
1133 if (stat (filename, &statbuf) == -1)
1134 {
1135 if (errno == ENOENT)
1136 {
1137 if (rrd_create_file (filename, ds, vl))
1138 return (-1);
1139 }
1140 else
1141 {
1142 char errbuf[1024];
1143 ERROR ("stat(%s) failed: %s", filename,
1144 sstrerror (errno, errbuf,
1145 sizeof (errbuf)));
1146 return (-1);
1147 }
1148 }
1149 else if (!S_ISREG (statbuf.st_mode))
1150 {
1151 ERROR ("stat(%s): Not a regular file!",
1152 filename);
1153 return (-1);
1154 }
1156 status = rrd_cache_insert (filename, values, vl->time);
1158 return (status);
1159 } /* int rrd_write */
1161 static int rrd_flush (int timeout, const char *identifier)
1162 {
1163 pthread_mutex_lock (&cache_lock);
1165 if (cache == NULL) {
1166 pthread_mutex_unlock (&cache_lock);
1167 return (0);
1168 }
1170 rrd_cache_flush_identifier (timeout, identifier);
1172 pthread_mutex_unlock (&cache_lock);
1173 return (0);
1174 } /* int rrd_flush */
1176 static int rrd_config (const char *key, const char *value)
1177 {
1178 if (strcasecmp ("CacheTimeout", key) == 0)
1179 {
1180 int tmp = atoi (value);
1181 if (tmp < 0)
1182 {
1183 fprintf (stderr, "rrdtool: `CacheTimeout' must "
1184 "be greater than 0.\n");
1185 ERROR ("rrdtool: `CacheTimeout' must "
1186 "be greater than 0.\n");
1187 return (1);
1188 }
1189 cache_timeout = tmp;
1190 }
1191 else if (strcasecmp ("CacheFlush", key) == 0)
1192 {
1193 int tmp = atoi (value);
1194 if (tmp < 0)
1195 {
1196 fprintf (stderr, "rrdtool: `CacheFlush' must "
1197 "be greater than 0.\n");
1198 ERROR ("rrdtool: `CacheFlush' must "
1199 "be greater than 0.\n");
1200 return (1);
1201 }
1202 cache_flush_timeout = tmp;
1203 }
1204 else if (strcasecmp ("DataDir", key) == 0)
1205 {
1206 if (datadir != NULL)
1207 free (datadir);
1208 datadir = strdup (value);
1209 if (datadir != NULL)
1210 {
1211 int len = strlen (datadir);
1212 while ((len > 0) && (datadir[len - 1] == '/'))
1213 {
1214 len--;
1215 datadir[len] = '\0';
1216 }
1217 if (len <= 0)
1218 {
1219 free (datadir);
1220 datadir = NULL;
1221 }
1222 }
1223 }
1224 else if (strcasecmp ("StepSize", key) == 0)
1225 {
1226 stepsize = atoi (value);
1227 if (stepsize < 0)
1228 stepsize = 0;
1229 }
1230 else if (strcasecmp ("HeartBeat", key) == 0)
1231 {
1232 heartbeat = atoi (value);
1233 if (heartbeat < 0)
1234 heartbeat = 0;
1235 }
1236 else if (strcasecmp ("RRARows", key) == 0)
1237 {
1238 int tmp = atoi (value);
1239 if (tmp <= 0)
1240 {
1241 fprintf (stderr, "rrdtool: `RRARows' must "
1242 "be greater than 0.\n");
1243 ERROR ("rrdtool: `RRARows' must "
1244 "be greater than 0.\n");
1245 return (1);
1246 }
1247 rrarows = tmp;
1248 }
1249 else if (strcasecmp ("RRATimespan", key) == 0)
1250 {
1251 char *saveptr = NULL;
1252 char *dummy;
1253 char *ptr;
1254 char *value_copy;
1255 int *tmp_alloc;
1257 value_copy = strdup (value);
1258 if (value_copy == NULL)
1259 return (1);
1261 dummy = value_copy;
1262 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1263 {
1264 dummy = NULL;
1266 tmp_alloc = realloc (rra_timespans_custom,
1267 sizeof (int) * (rra_timespans_custom_num + 1));
1268 if (tmp_alloc == NULL)
1269 {
1270 fprintf (stderr, "rrdtool: realloc failed.\n");
1271 ERROR ("rrdtool: realloc failed.\n");
1272 free (value_copy);
1273 return (1);
1274 }
1275 rra_timespans_custom = tmp_alloc;
1276 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
1277 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
1278 rra_timespans_custom_num++;
1279 } /* while (strtok_r) */
1281 qsort (/* base = */ rra_timespans_custom,
1282 /* nmemb = */ rra_timespans_custom_num,
1283 /* size = */ sizeof (rra_timespans_custom[0]),
1284 /* compar = */ rrd_compare_numeric);
1286 free (value_copy);
1287 }
1288 else if (strcasecmp ("XFF", key) == 0)
1289 {
1290 double tmp = atof (value);
1291 if ((tmp < 0.0) || (tmp >= 1.0))
1292 {
1293 fprintf (stderr, "rrdtool: `XFF' must "
1294 "be in the range 0 to 1 (exclusive).");
1295 ERROR ("rrdtool: `XFF' must "
1296 "be in the range 0 to 1 (exclusive).");
1297 return (1);
1298 }
1299 xff = tmp;
1300 }
1301 else if (strcasecmp ("WritesPerSecond", key) == 0)
1302 {
1303 double wps = atof (value);
1305 if (wps < 0.0)
1306 {
1307 fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
1308 "greater than or equal to zero.");
1309 return (1);
1310 }
1311 else if (wps == 0.0)
1312 {
1313 write_rate = 0.0;
1314 }
1315 else
1316 {
1317 write_rate = 1.0 / wps;
1318 }
1319 }
1320 else
1321 {
1322 return (-1);
1323 }
1324 return (0);
1325 } /* int rrd_config */
1327 static int rrd_shutdown (void)
1328 {
1329 pthread_mutex_lock (&cache_lock);
1330 rrd_cache_flush (-1);
1331 pthread_mutex_unlock (&cache_lock);
1333 pthread_mutex_lock (&queue_lock);
1334 do_shutdown = 1;
1335 pthread_cond_signal (&queue_cond);
1336 pthread_mutex_unlock (&queue_lock);
1338 /* Wait for all the values to be written to disk before returning. */
1339 if (queue_thread != 0)
1340 {
1341 pthread_join (queue_thread, NULL);
1342 queue_thread = 0;
1343 DEBUG ("rrdtool plugin: queue_thread exited.");
1344 }
1346 return (0);
1347 } /* int rrd_shutdown */
1349 static int rrd_init (void)
1350 {
1351 int status;
1353 if (stepsize < 0)
1354 stepsize = 0;
1355 if (heartbeat <= 0)
1356 heartbeat = 2 * stepsize;
1358 if ((heartbeat > 0) && (heartbeat < interval_g))
1359 WARNING ("rrdtool plugin: Your `heartbeat' is "
1360 "smaller than your `interval'. This will "
1361 "likely cause problems.");
1362 else if ((stepsize > 0) && (stepsize < interval_g))
1363 WARNING ("rrdtool plugin: Your `stepsize' is "
1364 "smaller than your `interval'. This will "
1365 "create needlessly big RRD-files.");
1367 /* Set the cache up */
1368 pthread_mutex_lock (&cache_lock);
1370 cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1371 if (cache == NULL)
1372 {
1373 ERROR ("rrdtool plugin: c_avl_create failed.");
1374 return (-1);
1375 }
1377 cache_flush_last = time (NULL);
1378 if (cache_timeout < 2)
1379 {
1380 cache_timeout = 0;
1381 cache_flush_timeout = 0;
1382 }
1383 else if (cache_flush_timeout < cache_timeout)
1384 cache_flush_timeout = 10 * cache_timeout;
1386 pthread_mutex_unlock (&cache_lock);
1388 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1389 if (status != 0)
1390 {
1391 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1392 return (-1);
1393 }
1395 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1396 " heartbeat = %i; rrarows = %i; xff = %lf;",
1397 (datadir == NULL) ? "(null)" : datadir,
1398 stepsize, heartbeat, rrarows, xff);
1400 return (0);
1401 } /* int rrd_init */
1403 void module_register (void)
1404 {
1405 plugin_register_config ("rrdtool", rrd_config,
1406 config_keys, config_keys_num);
1407 plugin_register_init ("rrdtool", rrd_init);
1408 plugin_register_write ("rrdtool", rrd_write);
1409 plugin_register_flush ("rrdtool", rrd_flush);
1410 plugin_register_shutdown ("rrdtool", rrd_shutdown);
1411 }