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 pthread_mutex_lock (&queue_lock);
628 /* Wait for values to arrive */
629 while (true)
630 {
631 struct timespec ts_wait;
633 while ((flushq_head == NULL) && (queue_head == NULL)
634 && (do_shutdown == 0))
635 pthread_cond_wait (&queue_cond, &queue_lock);
637 if ((flushq_head == NULL) && (queue_head == NULL))
638 break;
640 /* Don't delay if there's something to flush */
641 if (flushq_head != NULL)
642 break;
644 /* Don't delay if we're shutting down */
645 if (do_shutdown != 0)
646 break;
648 /* Don't delay if no delay was configured. */
649 if (write_rate <= 0.0)
650 break;
652 gettimeofday (&tv_now, /* timezone = */ NULL);
653 status = timeval_sub_timespec (&tv_next_update, &tv_now,
654 &ts_wait);
655 /* We're good to go */
656 if (status != 0)
657 break;
659 /* We're supposed to wait a bit with this update, so we'll
660 * wait for the next addition to the queue or to the end of
661 * the wait period - whichever comes first. */
662 ts_wait.tv_sec = tv_next_update.tv_sec;
663 ts_wait.tv_nsec = 1000 * tv_next_update.tv_usec;
665 status = pthread_cond_timedwait (&queue_cond, &queue_lock,
666 &ts_wait);
667 if (status == ETIMEDOUT)
668 break;
669 } /* while (true) */
671 /* XXX: If you need to lock both, cache_lock and queue_lock, at
672 * the same time, ALWAYS lock `cache_lock' first! */
674 /* We're in the shutdown phase */
675 if ((flushq_head == NULL) && (queue_head == NULL))
676 {
677 pthread_mutex_unlock (&queue_lock);
678 break;
679 }
681 if (flushq_head != NULL)
682 {
683 /* Dequeue the first flush entry */
684 queue_entry = flushq_head;
685 if (flushq_head == flushq_tail)
686 flushq_head = flushq_tail = NULL;
687 else
688 flushq_head = flushq_head->next;
689 }
690 else /* if (queue_head != NULL) */
691 {
692 /* Dequeue the first regular entry */
693 queue_entry = queue_head;
694 if (queue_head == queue_tail)
695 queue_head = queue_tail = NULL;
696 else
697 queue_head = queue_head->next;
698 }
700 /* Unlock the queue again */
701 pthread_mutex_unlock (&queue_lock);
703 /* We now need the cache lock so the entry isn't updated while
704 * we make a copy of it's values */
705 pthread_mutex_lock (&cache_lock);
707 status = c_avl_get (cache, queue_entry->filename,
708 (void *) &cache_entry);
710 if (status == 0)
711 {
712 values = cache_entry->values;
713 values_num = cache_entry->values_num;
715 cache_entry->values = NULL;
716 cache_entry->values_num = 0;
717 cache_entry->flags = FLAG_NONE;
718 }
720 pthread_mutex_unlock (&cache_lock);
722 if (status != 0)
723 {
724 sfree (queue_entry->filename);
725 sfree (queue_entry);
726 continue;
727 }
729 /* Update `tv_next_update' */
730 if (write_rate > 0.0)
731 {
732 gettimeofday (&tv_now, /* timezone = */ NULL);
733 tv_next_update.tv_sec = tv_now.tv_sec;
734 tv_next_update.tv_usec = tv_now.tv_usec
735 + ((suseconds_t) (1000000 * write_rate));
736 while (tv_next_update.tv_usec > 1000000)
737 {
738 tv_next_update.tv_sec++;
739 tv_next_update.tv_usec -= 1000000;
740 }
741 }
743 /* Write the values to the RRD-file */
744 srrd_update (queue_entry->filename, NULL,
745 values_num, (const char **)values);
746 DEBUG ("rrdtool plugin: queue thread: Wrote %i values to %s",
747 values_num, queue_entry->filename);
749 for (i = 0; i < values_num; i++)
750 {
751 sfree (values[i]);
752 }
753 sfree (values);
754 sfree (queue_entry->filename);
755 sfree (queue_entry);
756 } /* while (42) */
758 pthread_mutex_lock (&cache_lock);
759 c_avl_destroy (cache);
760 cache = NULL;
761 pthread_mutex_unlock (&cache_lock);
763 pthread_exit ((void *) 0);
764 return ((void *) 0);
765 } /* void *rrd_queue_thread */
767 static int rrd_queue_enqueue (const char *filename,
768 rrd_queue_t **head, rrd_queue_t **tail)
769 {
770 rrd_queue_t *queue_entry;
772 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
773 if (queue_entry == NULL)
774 return (-1);
776 queue_entry->filename = strdup (filename);
777 if (queue_entry->filename == NULL)
778 {
779 free (queue_entry);
780 return (-1);
781 }
783 queue_entry->next = NULL;
785 pthread_mutex_lock (&queue_lock);
787 if (*tail == NULL)
788 *head = queue_entry;
789 else
790 (*tail)->next = queue_entry;
791 *tail = queue_entry;
793 pthread_cond_signal (&queue_cond);
794 pthread_mutex_unlock (&queue_lock);
796 return (0);
797 } /* int rrd_queue_enqueue */
799 static int rrd_queue_dequeue (const char *filename,
800 rrd_queue_t **head, rrd_queue_t **tail)
801 {
802 rrd_queue_t *this;
803 rrd_queue_t *prev;
805 pthread_mutex_lock (&queue_lock);
807 prev = NULL;
808 this = *head;
810 while (this != NULL)
811 {
812 if (strcmp (this->filename, filename) == 0)
813 break;
815 prev = this;
816 this = this->next;
817 }
819 if (this == NULL)
820 {
821 pthread_mutex_unlock (&queue_lock);
822 return (-1);
823 }
825 if (prev == NULL)
826 *head = this->next;
827 else
828 prev->next = this->next;
830 if (this->next == NULL)
831 *tail = prev;
833 pthread_mutex_unlock (&queue_lock);
835 sfree (this->filename);
836 sfree (this);
838 return (0);
839 } /* int rrd_queue_dequeue */
841 static void rrd_cache_flush (int timeout)
842 {
843 rrd_cache_t *rc;
844 time_t now;
846 char **keys = NULL;
847 int keys_num = 0;
849 char *key;
850 c_avl_iterator_t *iter;
851 int i;
853 DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
855 now = time (NULL);
857 /* Build a list of entries to be flushed */
858 iter = c_avl_get_iterator (cache);
859 while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
860 {
861 if (rc->flags != FLAG_NONE)
862 continue;
863 else if ((now - rc->first_value) < timeout)
864 continue;
865 else if (rc->values_num > 0)
866 {
867 int status;
869 status = rrd_queue_enqueue (key, &queue_head, &queue_tail);
870 if (status == 0)
871 rc->flags = FLAG_QUEUED;
872 }
873 else /* ancient and no values -> waste of memory */
874 {
875 char **tmp = (char **) realloc ((void *) keys,
876 (keys_num + 1) * sizeof (char *));
877 if (tmp == NULL)
878 {
879 char errbuf[1024];
880 ERROR ("rrdtool plugin: "
881 "realloc failed: %s",
882 sstrerror (errno, errbuf,
883 sizeof (errbuf)));
884 c_avl_iterator_destroy (iter);
885 sfree (keys);
886 return;
887 }
888 keys = tmp;
889 keys[keys_num] = key;
890 keys_num++;
891 }
892 } /* while (c_avl_iterator_next) */
893 c_avl_iterator_destroy (iter);
895 for (i = 0; i < keys_num; i++)
896 {
897 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
898 {
899 DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
900 continue;
901 }
903 assert (rc->values == NULL);
904 assert (rc->values_num == 0);
906 sfree (rc);
907 sfree (key);
908 keys[i] = NULL;
909 } /* for (i = 0..keys_num) */
911 sfree (keys);
913 cache_flush_last = now;
914 } /* void rrd_cache_flush */
916 static int rrd_cache_flush_identifier (int timeout, const char *identifier)
917 {
918 rrd_cache_t *rc;
919 time_t now;
920 int status;
921 char key[2048];
923 if (identifier == NULL)
924 {
925 rrd_cache_flush (timeout);
926 return (0);
927 }
929 now = time (NULL);
931 if (datadir == NULL)
932 snprintf (key, sizeof (key), "%s.rrd",
933 identifier);
934 else
935 snprintf (key, sizeof (key), "%s/%s.rrd",
936 datadir, identifier);
937 key[sizeof (key) - 1] = 0;
939 status = c_avl_get (cache, key, (void *) &rc);
940 if (status != 0)
941 {
942 WARNING ("rrdtool plugin: rrd_cache_flush_identifier: "
943 "c_avl_get (%s) failed. Does that file really exist?",
944 key);
945 return (status);
946 }
948 if (rc->flags == FLAG_FLUSHQ)
949 {
950 status = 0;
951 }
952 else if (rc->flags == FLAG_QUEUED)
953 {
954 rrd_queue_dequeue (key, &queue_head, &queue_tail);
955 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
956 if (status == 0)
957 rc->flags = FLAG_FLUSHQ;
958 }
959 else if ((now - rc->first_value) < timeout)
960 {
961 status = 0;
962 }
963 else if (rc->values_num > 0)
964 {
965 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
966 if (status == 0)
967 rc->flags = FLAG_FLUSHQ;
968 }
970 return (status);
971 } /* int rrd_cache_flush_identifier */
973 static int rrd_cache_insert (const char *filename,
974 const char *value, time_t value_time)
975 {
976 rrd_cache_t *rc = NULL;
977 int new_rc = 0;
978 char **values_new;
980 pthread_mutex_lock (&cache_lock);
982 /* This shouldn't happen, but it did happen at least once, so we'll be
983 * careful. */
984 if (cache == NULL)
985 {
986 pthread_mutex_unlock (&cache_lock);
987 WARNING ("rrdtool plugin: cache == NULL.");
988 return (-1);
989 }
991 c_avl_get (cache, filename, (void *) &rc);
993 if (rc == NULL)
994 {
995 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
996 if (rc == NULL)
997 return (-1);
998 rc->values_num = 0;
999 rc->values = NULL;
1000 rc->first_value = 0;
1001 rc->last_value = 0;
1002 rc->flags = FLAG_NONE;
1003 new_rc = 1;
1004 }
1006 if (rc->last_value >= value_time)
1007 {
1008 pthread_mutex_unlock (&cache_lock);
1009 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
1010 (unsigned int) rc->last_value,
1011 (unsigned int) value_time);
1012 return (-1);
1013 }
1015 values_new = (char **) realloc ((void *) rc->values,
1016 (rc->values_num + 1) * sizeof (char *));
1017 if (values_new == NULL)
1018 {
1019 char errbuf[1024];
1020 void *cache_key = NULL;
1022 sstrerror (errno, errbuf, sizeof (errbuf));
1024 c_avl_remove (cache, filename, &cache_key, NULL);
1025 pthread_mutex_unlock (&cache_lock);
1027 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
1029 sfree (cache_key);
1030 sfree (rc->values);
1031 sfree (rc);
1032 return (-1);
1033 }
1034 rc->values = values_new;
1036 rc->values[rc->values_num] = strdup (value);
1037 if (rc->values[rc->values_num] != NULL)
1038 rc->values_num++;
1040 if (rc->values_num == 1)
1041 rc->first_value = value_time;
1042 rc->last_value = value_time;
1044 /* Insert if this is the first value */
1045 if (new_rc == 1)
1046 {
1047 void *cache_key = strdup (filename);
1049 if (cache_key == NULL)
1050 {
1051 char errbuf[1024];
1052 sstrerror (errno, errbuf, sizeof (errbuf));
1054 pthread_mutex_unlock (&cache_lock);
1056 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
1058 sfree (rc->values[0]);
1059 sfree (rc->values);
1060 sfree (rc);
1061 return (-1);
1062 }
1064 c_avl_insert (cache, cache_key, rc);
1065 }
1067 DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
1068 "values_num = %i; age = %lu;",
1069 filename, rc->values_num,
1070 (unsigned long)(rc->last_value - rc->first_value));
1072 if ((rc->last_value - rc->first_value) >= cache_timeout)
1073 {
1074 /* XXX: If you need to lock both, cache_lock and queue_lock, at
1075 * the same time, ALWAYS lock `cache_lock' first! */
1076 if (rc->flags == FLAG_NONE)
1077 {
1078 int status;
1080 status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
1081 if (status == 0)
1082 rc->flags = FLAG_QUEUED;
1083 }
1084 else
1085 {
1086 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
1087 }
1088 }
1090 if ((cache_timeout > 0) &&
1091 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
1092 rrd_cache_flush (cache_flush_timeout);
1094 pthread_mutex_unlock (&cache_lock);
1096 return (0);
1097 } /* int rrd_cache_insert */
1099 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
1100 {
1101 int a = *((int *) a_ptr);
1102 int b = *((int *) b_ptr);
1104 if (a < b)
1105 return (-1);
1106 else if (a > b)
1107 return (1);
1108 else
1109 return (0);
1110 } /* int rrd_compare_numeric */
1112 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
1113 {
1114 struct stat statbuf;
1115 char filename[512];
1116 char values[512];
1117 int status;
1119 if (0 != strcmp (ds->type, vl->type)) {
1120 ERROR ("rrdtool plugin: DS type does not match value list type");
1121 return -1;
1122 }
1124 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
1125 return (-1);
1127 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
1128 return (-1);
1130 if (stat (filename, &statbuf) == -1)
1131 {
1132 if (errno == ENOENT)
1133 {
1134 if (rrd_create_file (filename, ds, vl))
1135 return (-1);
1136 }
1137 else
1138 {
1139 char errbuf[1024];
1140 ERROR ("stat(%s) failed: %s", filename,
1141 sstrerror (errno, errbuf,
1142 sizeof (errbuf)));
1143 return (-1);
1144 }
1145 }
1146 else if (!S_ISREG (statbuf.st_mode))
1147 {
1148 ERROR ("stat(%s): Not a regular file!",
1149 filename);
1150 return (-1);
1151 }
1153 status = rrd_cache_insert (filename, values, vl->time);
1155 return (status);
1156 } /* int rrd_write */
1158 static int rrd_flush (int timeout, const char *identifier)
1159 {
1160 pthread_mutex_lock (&cache_lock);
1162 if (cache == NULL) {
1163 pthread_mutex_unlock (&cache_lock);
1164 return (0);
1165 }
1167 rrd_cache_flush_identifier (timeout, identifier);
1169 pthread_mutex_unlock (&cache_lock);
1170 return (0);
1171 } /* int rrd_flush */
1173 static int rrd_config (const char *key, const char *value)
1174 {
1175 if (strcasecmp ("CacheTimeout", key) == 0)
1176 {
1177 int tmp = atoi (value);
1178 if (tmp < 0)
1179 {
1180 fprintf (stderr, "rrdtool: `CacheTimeout' must "
1181 "be greater than 0.\n");
1182 ERROR ("rrdtool: `CacheTimeout' must "
1183 "be greater than 0.\n");
1184 return (1);
1185 }
1186 cache_timeout = tmp;
1187 }
1188 else if (strcasecmp ("CacheFlush", key) == 0)
1189 {
1190 int tmp = atoi (value);
1191 if (tmp < 0)
1192 {
1193 fprintf (stderr, "rrdtool: `CacheFlush' must "
1194 "be greater than 0.\n");
1195 ERROR ("rrdtool: `CacheFlush' must "
1196 "be greater than 0.\n");
1197 return (1);
1198 }
1199 cache_flush_timeout = tmp;
1200 }
1201 else if (strcasecmp ("DataDir", key) == 0)
1202 {
1203 if (datadir != NULL)
1204 free (datadir);
1205 datadir = strdup (value);
1206 if (datadir != NULL)
1207 {
1208 int len = strlen (datadir);
1209 while ((len > 0) && (datadir[len - 1] == '/'))
1210 {
1211 len--;
1212 datadir[len] = '\0';
1213 }
1214 if (len <= 0)
1215 {
1216 free (datadir);
1217 datadir = NULL;
1218 }
1219 }
1220 }
1221 else if (strcasecmp ("StepSize", key) == 0)
1222 {
1223 stepsize = atoi (value);
1224 if (stepsize < 0)
1225 stepsize = 0;
1226 }
1227 else if (strcasecmp ("HeartBeat", key) == 0)
1228 {
1229 heartbeat = atoi (value);
1230 if (heartbeat < 0)
1231 heartbeat = 0;
1232 }
1233 else if (strcasecmp ("RRARows", key) == 0)
1234 {
1235 int tmp = atoi (value);
1236 if (tmp <= 0)
1237 {
1238 fprintf (stderr, "rrdtool: `RRARows' must "
1239 "be greater than 0.\n");
1240 ERROR ("rrdtool: `RRARows' must "
1241 "be greater than 0.\n");
1242 return (1);
1243 }
1244 rrarows = tmp;
1245 }
1246 else if (strcasecmp ("RRATimespan", key) == 0)
1247 {
1248 char *saveptr = NULL;
1249 char *dummy;
1250 char *ptr;
1251 char *value_copy;
1252 int *tmp_alloc;
1254 value_copy = strdup (value);
1255 if (value_copy == NULL)
1256 return (1);
1258 dummy = value_copy;
1259 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1260 {
1261 dummy = NULL;
1263 tmp_alloc = realloc (rra_timespans_custom,
1264 sizeof (int) * (rra_timespans_custom_num + 1));
1265 if (tmp_alloc == NULL)
1266 {
1267 fprintf (stderr, "rrdtool: realloc failed.\n");
1268 ERROR ("rrdtool: realloc failed.\n");
1269 free (value_copy);
1270 return (1);
1271 }
1272 rra_timespans_custom = tmp_alloc;
1273 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
1274 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
1275 rra_timespans_custom_num++;
1276 } /* while (strtok_r) */
1278 qsort (/* base = */ rra_timespans_custom,
1279 /* nmemb = */ rra_timespans_custom_num,
1280 /* size = */ sizeof (rra_timespans_custom[0]),
1281 /* compar = */ rrd_compare_numeric);
1283 free (value_copy);
1284 }
1285 else if (strcasecmp ("XFF", key) == 0)
1286 {
1287 double tmp = atof (value);
1288 if ((tmp < 0.0) || (tmp >= 1.0))
1289 {
1290 fprintf (stderr, "rrdtool: `XFF' must "
1291 "be in the range 0 to 1 (exclusive).");
1292 ERROR ("rrdtool: `XFF' must "
1293 "be in the range 0 to 1 (exclusive).");
1294 return (1);
1295 }
1296 xff = tmp;
1297 }
1298 else if (strcasecmp ("WritesPerSecond", key) == 0)
1299 {
1300 double wps = atof (value);
1302 if (wps < 0.0)
1303 {
1304 fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
1305 "greater than or equal to zero.");
1306 return (1);
1307 }
1308 else if (wps == 0.0)
1309 {
1310 write_rate = 0.0;
1311 }
1312 else
1313 {
1314 write_rate = 1.0 / wps;
1315 }
1316 }
1317 else
1318 {
1319 return (-1);
1320 }
1321 return (0);
1322 } /* int rrd_config */
1324 static int rrd_shutdown (void)
1325 {
1326 pthread_mutex_lock (&cache_lock);
1327 rrd_cache_flush (-1);
1328 pthread_mutex_unlock (&cache_lock);
1330 pthread_mutex_lock (&queue_lock);
1331 do_shutdown = 1;
1332 pthread_cond_signal (&queue_cond);
1333 pthread_mutex_unlock (&queue_lock);
1335 /* Wait for all the values to be written to disk before returning. */
1336 if (queue_thread != 0)
1337 {
1338 pthread_join (queue_thread, NULL);
1339 queue_thread = 0;
1340 DEBUG ("rrdtool plugin: queue_thread exited.");
1341 }
1343 return (0);
1344 } /* int rrd_shutdown */
1346 static int rrd_init (void)
1347 {
1348 int status;
1350 if (stepsize < 0)
1351 stepsize = 0;
1352 if (heartbeat <= 0)
1353 heartbeat = 2 * stepsize;
1355 if ((heartbeat > 0) && (heartbeat < interval_g))
1356 WARNING ("rrdtool plugin: Your `heartbeat' is "
1357 "smaller than your `interval'. This will "
1358 "likely cause problems.");
1359 else if ((stepsize > 0) && (stepsize < interval_g))
1360 WARNING ("rrdtool plugin: Your `stepsize' is "
1361 "smaller than your `interval'. This will "
1362 "create needlessly big RRD-files.");
1364 /* Set the cache up */
1365 pthread_mutex_lock (&cache_lock);
1367 cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1368 if (cache == NULL)
1369 {
1370 ERROR ("rrdtool plugin: c_avl_create failed.");
1371 return (-1);
1372 }
1374 cache_flush_last = time (NULL);
1375 if (cache_timeout < 2)
1376 {
1377 cache_timeout = 0;
1378 cache_flush_timeout = 0;
1379 }
1380 else if (cache_flush_timeout < cache_timeout)
1381 cache_flush_timeout = 10 * cache_timeout;
1383 pthread_mutex_unlock (&cache_lock);
1385 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1386 if (status != 0)
1387 {
1388 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1389 return (-1);
1390 }
1392 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1393 " heartbeat = %i; rrarows = %i; xff = %lf;",
1394 (datadir == NULL) ? "(null)" : datadir,
1395 stepsize, heartbeat, rrarows, xff);
1397 return (0);
1398 } /* int rrd_init */
1400 void module_register (void)
1401 {
1402 plugin_register_config ("rrdtool", rrd_config,
1403 config_keys, config_keys_num);
1404 plugin_register_init ("rrdtool", rrd_init);
1405 plugin_register_write ("rrdtool", rrd_write);
1406 plugin_register_flush ("rrdtool", rrd_flush);
1407 plugin_register_shutdown ("rrdtool", rrd_shutdown);
1408 }