b1d13ee3c19ee279c836741739b521359872c63b
1 /**
2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006-2008 Florian octo Forster
4 * Copyright (C) 2008-2008 Sebastian Harl
5 * Copyright (C) 2009 Mariusz Gronczewski
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 *
20 * Authors:
21 * Florian octo Forster <octo at verplant.org>
22 * Sebastian Harl <sh at tokkee.org>
23 * Mariusz Gronczewski <xani666 at gmail.com>
24 **/
26 #include "collectd.h"
27 #include "plugin.h"
28 #include "common.h"
29 #include "utils_avltree.h"
30 #include "utils_rrdcreate.h"
32 #include <rrd.h>
34 #if HAVE_PTHREAD_H
35 # include <pthread.h>
36 #endif
38 /*
39 * Private types
40 */
41 struct rrd_cache_s
42 {
43 int values_num;
44 char **values;
45 cdtime_t first_value;
46 cdtime_t last_value;
47 int64_t random_variation;
48 enum
49 {
50 FLAG_NONE = 0x00,
51 FLAG_QUEUED = 0x01,
52 FLAG_FLUSHQ = 0x02
53 } flags;
54 };
55 typedef struct rrd_cache_s rrd_cache_t;
57 enum rrd_queue_dir_e
58 {
59 QUEUE_INSERT_FRONT,
60 QUEUE_INSERT_BACK
61 };
62 typedef enum rrd_queue_dir_e rrd_queue_dir_t;
64 struct rrd_queue_s
65 {
66 char *filename;
67 struct rrd_queue_s *next;
68 };
69 typedef struct rrd_queue_s rrd_queue_t;
71 /*
72 * Private variables
73 */
74 static const char *config_keys[] =
75 {
76 "CacheTimeout",
77 "CacheFlush",
78 "DataDir",
79 "StepSize",
80 "HeartBeat",
81 "RRARows",
82 "RRATimespan",
83 "XFF",
84 "WritesPerSecond",
85 "RandomTimeout"
86 };
87 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
89 /* If datadir is zero, the daemon's basedir is used. If stepsize or heartbeat
90 * is zero a default, depending on the `interval' member of the value list is
91 * being used. */
92 static char *datadir = NULL;
93 static double write_rate = 0.0;
94 static rrdcreate_config_t rrdcreate_config =
95 {
96 /* stepsize = */ 0,
97 /* heartbeat = */ 0,
98 /* rrarows = */ 1200,
99 /* xff = */ 0.1,
101 /* timespans = */ NULL,
102 /* timespans_num = */ 0,
104 /* consolidation_functions = */ NULL,
105 /* consolidation_functions_num = */ 0
106 };
108 /* XXX: If you need to lock both, cache_lock and queue_lock, at the same time,
109 * ALWAYS lock `cache_lock' first! */
110 static cdtime_t cache_timeout = 0;
111 static cdtime_t cache_flush_timeout = 0;
112 static cdtime_t random_timeout = TIME_T_TO_CDTIME_T (1);
113 static cdtime_t cache_flush_last;
114 static c_avl_tree_t *cache = NULL;
115 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
117 static rrd_queue_t *queue_head = NULL;
118 static rrd_queue_t *queue_tail = NULL;
119 static rrd_queue_t *flushq_head = NULL;
120 static rrd_queue_t *flushq_tail = NULL;
121 static pthread_t queue_thread;
122 static int queue_thread_running = 1;
123 static pthread_mutex_t queue_lock = PTHREAD_MUTEX_INITIALIZER;
124 static pthread_cond_t queue_cond = PTHREAD_COND_INITIALIZER;
126 #if !HAVE_THREADSAFE_LIBRRD
127 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
128 #endif
130 static int do_shutdown = 0;
132 #if HAVE_THREADSAFE_LIBRRD
133 static int srrd_update (char *filename, char *template,
134 int argc, const char **argv)
135 {
136 int status;
138 optind = 0; /* bug in librrd? */
139 rrd_clear_error ();
141 status = rrd_update_r (filename, template, argc, (void *) argv);
143 if (status != 0)
144 {
145 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
146 filename, rrd_get_error ());
147 }
149 return (status);
150 } /* int srrd_update */
151 /* #endif HAVE_THREADSAFE_LIBRRD */
153 #else /* !HAVE_THREADSAFE_LIBRRD */
154 static int srrd_update (char *filename, char *template,
155 int argc, const char **argv)
156 {
157 int status;
159 int new_argc;
160 char **new_argv;
162 assert (template == NULL);
164 new_argc = 2 + argc;
165 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
166 if (new_argv == NULL)
167 {
168 ERROR ("rrdtool plugin: malloc failed.");
169 return (-1);
170 }
172 new_argv[0] = "update";
173 new_argv[1] = filename;
175 memcpy (new_argv + 2, argv, argc * sizeof (char *));
176 new_argv[new_argc] = NULL;
178 pthread_mutex_lock (&librrd_lock);
179 optind = 0; /* bug in librrd? */
180 rrd_clear_error ();
182 status = rrd_update (new_argc, new_argv);
183 pthread_mutex_unlock (&librrd_lock);
185 if (status != 0)
186 {
187 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
188 filename, rrd_get_error ());
189 }
191 sfree (new_argv);
193 return (status);
194 } /* int srrd_update */
195 #endif /* !HAVE_THREADSAFE_LIBRRD */
197 static int value_list_to_string (char *buffer, int buffer_len,
198 const data_set_t *ds, const value_list_t *vl)
199 {
200 int offset;
201 int status;
202 time_t tt;
203 int i;
205 memset (buffer, '\0', buffer_len);
207 tt = CDTIME_T_TO_TIME_T (vl->time);
208 status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) tt);
209 if ((status < 1) || (status >= buffer_len))
210 return (-1);
211 offset = status;
213 for (i = 0; i < ds->ds_num; i++)
214 {
215 if ((ds->ds[i].type != DS_TYPE_COUNTER)
216 && (ds->ds[i].type != DS_TYPE_GAUGE)
217 && (ds->ds[i].type != DS_TYPE_DERIVE)
218 && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
219 return (-1);
221 if (ds->ds[i].type == DS_TYPE_COUNTER)
222 status = ssnprintf (buffer + offset, buffer_len - offset,
223 ":%llu", vl->values[i].counter);
224 else if (ds->ds[i].type == DS_TYPE_GAUGE)
225 status = ssnprintf (buffer + offset, buffer_len - offset,
226 ":%lf", vl->values[i].gauge);
227 else if (ds->ds[i].type == DS_TYPE_DERIVE)
228 status = ssnprintf (buffer + offset, buffer_len - offset,
229 ":%"PRIi64, vl->values[i].derive);
230 else /*if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */
231 status = ssnprintf (buffer + offset, buffer_len - offset,
232 ":%"PRIu64, vl->values[i].absolute);
234 if ((status < 1) || (status >= (buffer_len - offset)))
235 return (-1);
237 offset += status;
238 } /* for ds->ds_num */
240 return (0);
241 } /* int value_list_to_string */
243 static int value_list_to_filename (char *buffer, int buffer_len,
244 const data_set_t __attribute__((unused)) *ds, const value_list_t *vl)
245 {
246 int offset = 0;
247 int status;
249 if (datadir != NULL)
250 {
251 status = ssnprintf (buffer + offset, buffer_len - offset,
252 "%s/", datadir);
253 if ((status < 1) || (status >= buffer_len - offset))
254 return (-1);
255 offset += status;
256 }
258 status = ssnprintf (buffer + offset, buffer_len - offset,
259 "%s/", vl->host);
260 if ((status < 1) || (status >= buffer_len - offset))
261 return (-1);
262 offset += status;
264 if (strlen (vl->plugin_instance) > 0)
265 status = ssnprintf (buffer + offset, buffer_len - offset,
266 "%s-%s/", vl->plugin, vl->plugin_instance);
267 else
268 status = ssnprintf (buffer + offset, buffer_len - offset,
269 "%s/", vl->plugin);
270 if ((status < 1) || (status >= buffer_len - offset))
271 return (-1);
272 offset += status;
274 if (strlen (vl->type_instance) > 0)
275 status = ssnprintf (buffer + offset, buffer_len - offset,
276 "%s-%s.rrd", vl->type, vl->type_instance);
277 else
278 status = ssnprintf (buffer + offset, buffer_len - offset,
279 "%s.rrd", vl->type);
280 if ((status < 1) || (status >= buffer_len - offset))
281 return (-1);
282 offset += status;
284 return (0);
285 } /* int value_list_to_filename */
287 static void *rrd_queue_thread (void __attribute__((unused)) *data)
288 {
289 struct timeval tv_next_update;
290 struct timeval tv_now;
292 gettimeofday (&tv_next_update, /* timezone = */ NULL);
294 while (42)
295 {
296 rrd_queue_t *queue_entry;
297 rrd_cache_t *cache_entry;
298 char **values;
299 int values_num;
300 int status;
301 int i;
303 values = NULL;
304 values_num = 0;
306 pthread_mutex_lock (&queue_lock);
307 /* Wait for values to arrive */
308 while (42)
309 {
310 struct timespec ts_wait;
312 while ((flushq_head == NULL) && (queue_head == NULL)
313 && (do_shutdown == 0))
314 pthread_cond_wait (&queue_cond, &queue_lock);
316 if ((flushq_head == NULL) && (queue_head == NULL))
317 break;
319 /* Don't delay if there's something to flush */
320 if (flushq_head != NULL)
321 break;
323 /* Don't delay if we're shutting down */
324 if (do_shutdown != 0)
325 break;
327 /* Don't delay if no delay was configured. */
328 if (write_rate <= 0.0)
329 break;
331 gettimeofday (&tv_now, /* timezone = */ NULL);
332 status = timeval_cmp (tv_next_update, tv_now, NULL);
333 /* We're good to go */
334 if (status <= 0)
335 break;
337 /* We're supposed to wait a bit with this update, so we'll
338 * wait for the next addition to the queue or to the end of
339 * the wait period - whichever comes first. */
340 ts_wait.tv_sec = tv_next_update.tv_sec;
341 ts_wait.tv_nsec = 1000 * tv_next_update.tv_usec;
343 status = pthread_cond_timedwait (&queue_cond, &queue_lock,
344 &ts_wait);
345 if (status == ETIMEDOUT)
346 break;
347 } /* while (42) */
349 /* XXX: If you need to lock both, cache_lock and queue_lock, at
350 * the same time, ALWAYS lock `cache_lock' first! */
352 /* We're in the shutdown phase */
353 if ((flushq_head == NULL) && (queue_head == NULL))
354 {
355 pthread_mutex_unlock (&queue_lock);
356 break;
357 }
359 if (flushq_head != NULL)
360 {
361 /* Dequeue the first flush entry */
362 queue_entry = flushq_head;
363 if (flushq_head == flushq_tail)
364 flushq_head = flushq_tail = NULL;
365 else
366 flushq_head = flushq_head->next;
367 }
368 else /* if (queue_head != NULL) */
369 {
370 /* Dequeue the first regular entry */
371 queue_entry = queue_head;
372 if (queue_head == queue_tail)
373 queue_head = queue_tail = NULL;
374 else
375 queue_head = queue_head->next;
376 }
378 /* Unlock the queue again */
379 pthread_mutex_unlock (&queue_lock);
381 /* We now need the cache lock so the entry isn't updated while
382 * we make a copy of it's values */
383 pthread_mutex_lock (&cache_lock);
385 status = c_avl_get (cache, queue_entry->filename,
386 (void *) &cache_entry);
388 if (status == 0)
389 {
390 values = cache_entry->values;
391 values_num = cache_entry->values_num;
393 cache_entry->values = NULL;
394 cache_entry->values_num = 0;
395 cache_entry->flags = FLAG_NONE;
396 }
398 pthread_mutex_unlock (&cache_lock);
400 if (status != 0)
401 {
402 sfree (queue_entry->filename);
403 sfree (queue_entry);
404 continue;
405 }
407 /* Update `tv_next_update' */
408 if (write_rate > 0.0)
409 {
410 gettimeofday (&tv_now, /* timezone = */ NULL);
411 tv_next_update.tv_sec = tv_now.tv_sec;
412 tv_next_update.tv_usec = tv_now.tv_usec
413 + ((suseconds_t) (1000000 * write_rate));
414 while (tv_next_update.tv_usec > 1000000)
415 {
416 tv_next_update.tv_sec++;
417 tv_next_update.tv_usec -= 1000000;
418 }
419 }
421 /* Write the values to the RRD-file */
422 srrd_update (queue_entry->filename, NULL,
423 values_num, (const char **)values);
424 DEBUG ("rrdtool plugin: queue thread: Wrote %i value%s to %s",
425 values_num, (values_num == 1) ? "" : "s",
426 queue_entry->filename);
428 for (i = 0; i < values_num; i++)
429 {
430 sfree (values[i]);
431 }
432 sfree (values);
433 sfree (queue_entry->filename);
434 sfree (queue_entry);
435 } /* while (42) */
437 pthread_exit ((void *) 0);
438 return ((void *) 0);
439 } /* void *rrd_queue_thread */
441 static int rrd_queue_enqueue (const char *filename,
442 rrd_queue_t **head, rrd_queue_t **tail)
443 {
444 rrd_queue_t *queue_entry;
446 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
447 if (queue_entry == NULL)
448 return (-1);
450 queue_entry->filename = strdup (filename);
451 if (queue_entry->filename == NULL)
452 {
453 free (queue_entry);
454 return (-1);
455 }
457 queue_entry->next = NULL;
459 pthread_mutex_lock (&queue_lock);
461 if (*tail == NULL)
462 *head = queue_entry;
463 else
464 (*tail)->next = queue_entry;
465 *tail = queue_entry;
467 pthread_cond_signal (&queue_cond);
468 pthread_mutex_unlock (&queue_lock);
470 return (0);
471 } /* int rrd_queue_enqueue */
473 static int rrd_queue_dequeue (const char *filename,
474 rrd_queue_t **head, rrd_queue_t **tail)
475 {
476 rrd_queue_t *this;
477 rrd_queue_t *prev;
479 pthread_mutex_lock (&queue_lock);
481 prev = NULL;
482 this = *head;
484 while (this != NULL)
485 {
486 if (strcmp (this->filename, filename) == 0)
487 break;
489 prev = this;
490 this = this->next;
491 }
493 if (this == NULL)
494 {
495 pthread_mutex_unlock (&queue_lock);
496 return (-1);
497 }
499 if (prev == NULL)
500 *head = this->next;
501 else
502 prev->next = this->next;
504 if (this->next == NULL)
505 *tail = prev;
507 pthread_mutex_unlock (&queue_lock);
509 sfree (this->filename);
510 sfree (this);
512 return (0);
513 } /* int rrd_queue_dequeue */
515 /* XXX: You must hold "cache_lock" when calling this function! */
516 static void rrd_cache_flush (cdtime_t timeout)
517 {
518 rrd_cache_t *rc;
519 cdtime_t now;
521 char **keys = NULL;
522 int keys_num = 0;
524 char *key;
525 c_avl_iterator_t *iter;
526 int i;
528 DEBUG ("rrdtool plugin: Flushing cache, timeout = %.3f",
529 CDTIME_T_TO_DOUBLE (timeout));
531 now = cdtime ();
532 timeout = TIME_T_TO_CDTIME_T (timeout);
534 /* Build a list of entries to be flushed */
535 iter = c_avl_get_iterator (cache);
536 while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
537 {
538 if (rc->flags != FLAG_NONE)
539 continue;
540 /* timeout == 0 => flush everything */
541 else if ((timeout != 0)
542 && ((now - rc->first_value) < timeout))
543 continue;
544 else if (rc->values_num > 0)
545 {
546 int status;
548 status = rrd_queue_enqueue (key, &queue_head, &queue_tail);
549 if (status == 0)
550 rc->flags = FLAG_QUEUED;
551 }
552 else /* ancient and no values -> waste of memory */
553 {
554 char **tmp = (char **) realloc ((void *) keys,
555 (keys_num + 1) * sizeof (char *));
556 if (tmp == NULL)
557 {
558 char errbuf[1024];
559 ERROR ("rrdtool plugin: "
560 "realloc failed: %s",
561 sstrerror (errno, errbuf,
562 sizeof (errbuf)));
563 c_avl_iterator_destroy (iter);
564 sfree (keys);
565 return;
566 }
567 keys = tmp;
568 keys[keys_num] = key;
569 keys_num++;
570 }
571 } /* while (c_avl_iterator_next) */
572 c_avl_iterator_destroy (iter);
574 for (i = 0; i < keys_num; i++)
575 {
576 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
577 {
578 DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
579 continue;
580 }
582 assert (rc->values == NULL);
583 assert (rc->values_num == 0);
585 sfree (rc);
586 sfree (key);
587 keys[i] = NULL;
588 } /* for (i = 0..keys_num) */
590 sfree (keys);
592 cache_flush_last = now;
593 } /* void rrd_cache_flush */
595 static int rrd_cache_flush_identifier (cdtime_t timeout,
596 const char *identifier)
597 {
598 rrd_cache_t *rc;
599 cdtime_t now;
600 int status;
601 char key[2048];
603 if (identifier == NULL)
604 {
605 rrd_cache_flush (timeout);
606 return (0);
607 }
609 now = cdtime ();
611 if (datadir == NULL)
612 snprintf (key, sizeof (key), "%s.rrd",
613 identifier);
614 else
615 snprintf (key, sizeof (key), "%s/%s.rrd",
616 datadir, identifier);
617 key[sizeof (key) - 1] = 0;
619 status = c_avl_get (cache, key, (void *) &rc);
620 if (status != 0)
621 {
622 INFO ("rrdtool plugin: rrd_cache_flush_identifier: "
623 "c_avl_get (%s) failed. Does that file really exist?",
624 key);
625 return (status);
626 }
628 if (rc->flags == FLAG_FLUSHQ)
629 {
630 status = 0;
631 }
632 else if (rc->flags == FLAG_QUEUED)
633 {
634 rrd_queue_dequeue (key, &queue_head, &queue_tail);
635 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
636 if (status == 0)
637 rc->flags = FLAG_FLUSHQ;
638 }
639 else if ((now - rc->first_value) < timeout)
640 {
641 status = 0;
642 }
643 else if (rc->values_num > 0)
644 {
645 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
646 if (status == 0)
647 rc->flags = FLAG_FLUSHQ;
648 }
650 return (status);
651 } /* int rrd_cache_flush_identifier */
653 static int64_t rrd_get_random_variation (void)
654 {
655 double dbl_timeout;
656 cdtime_t ctm_timeout;
657 double rand_fact;
658 _Bool negative;
659 int64_t ret;
661 if (random_timeout <= 0)
662 return (0);
664 /* Assure that "cache_timeout + random_variation" is never negative. */
665 if (random_timeout > cache_timeout)
666 {
667 INFO ("rrdtool plugin: Adjusting \"RandomTimeout\" to %.3f seconds.",
668 CDTIME_T_TO_DOUBLE (cache_timeout));
669 random_timeout = cache_timeout;
670 }
672 /* This seems a bit complicated, but "random_timeout" is likely larger than
673 * RAND_MAX, so we can't simply use modulo here. */
674 dbl_timeout = CDTIME_T_TO_DOUBLE (random_timeout);
675 rand_fact = ((double) random ())
676 / ((double) RAND_MAX);
677 negative = (_Bool) (random () % 2);
679 ctm_timeout = DOUBLE_TO_CDTIME_T (dbl_timeout * rand_fact);
681 ret = (int64_t) ctm_timeout;
682 if (negative)
683 ret *= -1;
685 return (ret);
686 } /* int64_t rrd_get_random_variation */
688 static int rrd_cache_insert (const char *filename,
689 const char *value, cdtime_t value_time)
690 {
691 rrd_cache_t *rc = NULL;
692 int new_rc = 0;
693 char **values_new;
695 pthread_mutex_lock (&cache_lock);
697 /* This shouldn't happen, but it did happen at least once, so we'll be
698 * careful. */
699 if (cache == NULL)
700 {
701 pthread_mutex_unlock (&cache_lock);
702 WARNING ("rrdtool plugin: cache == NULL.");
703 return (-1);
704 }
706 c_avl_get (cache, filename, (void *) &rc);
708 if (rc == NULL)
709 {
710 rc = malloc (sizeof (*rc));
711 if (rc == NULL)
712 return (-1);
713 rc->values_num = 0;
714 rc->values = NULL;
715 rc->first_value = 0;
716 rc->last_value = 0;
717 rc->random_variation = rrd_get_random_variation ();
718 rc->flags = FLAG_NONE;
719 new_rc = 1;
720 }
722 if (rc->last_value >= value_time)
723 {
724 pthread_mutex_unlock (&cache_lock);
725 DEBUG ("rrdtool plugin: (rc->last_value = %"PRIu64") "
726 ">= (value_time = %"PRIu64")",
727 rc->last_value, value_time);
728 return (-1);
729 }
731 values_new = (char **) realloc ((void *) rc->values,
732 (rc->values_num + 1) * sizeof (char *));
733 if (values_new == NULL)
734 {
735 char errbuf[1024];
736 void *cache_key = NULL;
738 sstrerror (errno, errbuf, sizeof (errbuf));
740 c_avl_remove (cache, filename, &cache_key, NULL);
741 pthread_mutex_unlock (&cache_lock);
743 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
745 sfree (cache_key);
746 sfree (rc->values);
747 sfree (rc);
748 return (-1);
749 }
750 rc->values = values_new;
752 rc->values[rc->values_num] = strdup (value);
753 if (rc->values[rc->values_num] != NULL)
754 rc->values_num++;
756 if (rc->values_num == 1)
757 rc->first_value = value_time;
758 rc->last_value = value_time;
760 /* Insert if this is the first value */
761 if (new_rc == 1)
762 {
763 void *cache_key = strdup (filename);
765 if (cache_key == NULL)
766 {
767 char errbuf[1024];
768 sstrerror (errno, errbuf, sizeof (errbuf));
770 pthread_mutex_unlock (&cache_lock);
772 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
774 sfree (rc->values[0]);
775 sfree (rc->values);
776 sfree (rc);
777 return (-1);
778 }
780 c_avl_insert (cache, cache_key, rc);
781 }
783 DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
784 "values_num = %i; age = %.3f;",
785 filename, rc->values_num,
786 CDTIME_T_TO_DOUBLE (rc->last_value - rc->first_value));
788 if ((rc->last_value - rc->first_value) >= (cache_timeout + rc->random_variation))
789 {
790 /* XXX: If you need to lock both, cache_lock and queue_lock, at
791 * the same time, ALWAYS lock `cache_lock' first! */
792 if (rc->flags == FLAG_NONE)
793 {
794 int status;
796 status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
797 if (status == 0)
798 rc->flags = FLAG_QUEUED;
800 rc->random_variation = rrd_get_random_variation ();
801 }
802 else
803 {
804 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
805 }
806 }
808 if ((cache_timeout > 0) &&
809 ((cdtime () - cache_flush_last) > cache_flush_timeout))
810 rrd_cache_flush (cache_flush_timeout);
812 pthread_mutex_unlock (&cache_lock);
814 return (0);
815 } /* int rrd_cache_insert */
817 static int rrd_cache_destroy (void) /* {{{ */
818 {
819 void *key = NULL;
820 void *value = NULL;
822 int non_empty = 0;
824 pthread_mutex_lock (&cache_lock);
826 if (cache == NULL)
827 {
828 pthread_mutex_unlock (&cache_lock);
829 return (0);
830 }
832 while (c_avl_pick (cache, &key, &value) == 0)
833 {
834 rrd_cache_t *rc;
835 int i;
837 sfree (key);
838 key = NULL;
840 rc = value;
841 value = NULL;
843 if (rc->values_num > 0)
844 non_empty++;
846 for (i = 0; i < rc->values_num; i++)
847 sfree (rc->values[i]);
848 sfree (rc->values);
849 sfree (rc);
850 }
852 c_avl_destroy (cache);
853 cache = NULL;
855 if (non_empty > 0)
856 {
857 INFO ("rrdtool plugin: %i cache %s had values when destroying the cache.",
858 non_empty, (non_empty == 1) ? "entry" : "entries");
859 }
860 else
861 {
862 DEBUG ("rrdtool plugin: No values have been lost "
863 "when destroying the cache.");
864 }
866 pthread_mutex_unlock (&cache_lock);
867 return (0);
868 } /* }}} int rrd_cache_destroy */
870 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
871 {
872 int a = *((int *) a_ptr);
873 int b = *((int *) b_ptr);
875 if (a < b)
876 return (-1);
877 else if (a > b)
878 return (1);
879 else
880 return (0);
881 } /* int rrd_compare_numeric */
883 static int rrd_write (const data_set_t *ds, const value_list_t *vl,
884 user_data_t __attribute__((unused)) *user_data)
885 {
886 struct stat statbuf;
887 char filename[512];
888 char values[512];
889 int status;
891 if (do_shutdown)
892 return (0);
894 if (0 != strcmp (ds->type, vl->type)) {
895 ERROR ("rrdtool plugin: DS type does not match value list type");
896 return -1;
897 }
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 status = cu_rrd_create_file (filename,
910 ds, vl, &rrdcreate_config);
911 if (status != 0)
912 return (-1);
913 }
914 else
915 {
916 char errbuf[1024];
917 ERROR ("stat(%s) failed: %s", filename,
918 sstrerror (errno, errbuf,
919 sizeof (errbuf)));
920 return (-1);
921 }
922 }
923 else if (!S_ISREG (statbuf.st_mode))
924 {
925 ERROR ("stat(%s): Not a regular file!",
926 filename);
927 return (-1);
928 }
930 status = rrd_cache_insert (filename, values, vl->time);
932 return (status);
933 } /* int rrd_write */
935 static int rrd_flush (cdtime_t timeout, const char *identifier,
936 __attribute__((unused)) user_data_t *user_data)
937 {
938 pthread_mutex_lock (&cache_lock);
940 if (cache == NULL) {
941 pthread_mutex_unlock (&cache_lock);
942 return (0);
943 }
945 rrd_cache_flush_identifier (timeout, identifier);
947 pthread_mutex_unlock (&cache_lock);
948 return (0);
949 } /* int rrd_flush */
951 static int rrd_config (const char *key, const char *value)
952 {
953 if (strcasecmp ("CacheTimeout", key) == 0)
954 {
955 double tmp = atof (value);
956 if (tmp < 0)
957 {
958 fprintf (stderr, "rrdtool: `CacheTimeout' must "
959 "be greater than 0.\n");
960 ERROR ("rrdtool: `CacheTimeout' must "
961 "be greater than 0.\n");
962 return (1);
963 }
964 cache_timeout = DOUBLE_TO_CDTIME_T (tmp);
965 }
966 else if (strcasecmp ("CacheFlush", key) == 0)
967 {
968 int tmp = atoi (value);
969 if (tmp < 0)
970 {
971 fprintf (stderr, "rrdtool: `CacheFlush' must "
972 "be greater than 0.\n");
973 ERROR ("rrdtool: `CacheFlush' must "
974 "be greater than 0.\n");
975 return (1);
976 }
977 cache_flush_timeout = tmp;
978 }
979 else if (strcasecmp ("DataDir", key) == 0)
980 {
981 if (datadir != NULL)
982 free (datadir);
983 datadir = strdup (value);
984 if (datadir != NULL)
985 {
986 int len = strlen (datadir);
987 while ((len > 0) && (datadir[len - 1] == '/'))
988 {
989 len--;
990 datadir[len] = '\0';
991 }
992 if (len <= 0)
993 {
994 free (datadir);
995 datadir = NULL;
996 }
997 }
998 }
999 else if (strcasecmp ("StepSize", key) == 0)
1000 {
1001 unsigned long temp = strtoul (value, NULL, 0);
1002 if (temp > 0)
1003 rrdcreate_config.stepsize = temp;
1004 }
1005 else if (strcasecmp ("HeartBeat", key) == 0)
1006 {
1007 int temp = atoi (value);
1008 if (temp > 0)
1009 rrdcreate_config.heartbeat = temp;
1010 }
1011 else if (strcasecmp ("RRARows", key) == 0)
1012 {
1013 int tmp = atoi (value);
1014 if (tmp <= 0)
1015 {
1016 fprintf (stderr, "rrdtool: `RRARows' must "
1017 "be greater than 0.\n");
1018 ERROR ("rrdtool: `RRARows' must "
1019 "be greater than 0.\n");
1020 return (1);
1021 }
1022 rrdcreate_config.rrarows = tmp;
1023 }
1024 else if (strcasecmp ("RRATimespan", key) == 0)
1025 {
1026 char *saveptr = NULL;
1027 char *dummy;
1028 char *ptr;
1029 char *value_copy;
1030 int *tmp_alloc;
1032 value_copy = strdup (value);
1033 if (value_copy == NULL)
1034 return (1);
1036 dummy = value_copy;
1037 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1038 {
1039 dummy = NULL;
1041 tmp_alloc = realloc (rrdcreate_config.timespans,
1042 sizeof (int) * (rrdcreate_config.timespans_num + 1));
1043 if (tmp_alloc == NULL)
1044 {
1045 fprintf (stderr, "rrdtool: realloc failed.\n");
1046 ERROR ("rrdtool: realloc failed.\n");
1047 free (value_copy);
1048 return (1);
1049 }
1050 rrdcreate_config.timespans = tmp_alloc;
1051 rrdcreate_config.timespans[rrdcreate_config.timespans_num] = atoi (ptr);
1052 if (rrdcreate_config.timespans[rrdcreate_config.timespans_num] != 0)
1053 rrdcreate_config.timespans_num++;
1054 } /* while (strtok_r) */
1056 qsort (/* base = */ rrdcreate_config.timespans,
1057 /* nmemb = */ rrdcreate_config.timespans_num,
1058 /* size = */ sizeof (rrdcreate_config.timespans[0]),
1059 /* compar = */ rrd_compare_numeric);
1061 free (value_copy);
1062 }
1063 else if (strcasecmp ("XFF", key) == 0)
1064 {
1065 double tmp = atof (value);
1066 if ((tmp < 0.0) || (tmp >= 1.0))
1067 {
1068 fprintf (stderr, "rrdtool: `XFF' must "
1069 "be in the range 0 to 1 (exclusive).");
1070 ERROR ("rrdtool: `XFF' must "
1071 "be in the range 0 to 1 (exclusive).");
1072 return (1);
1073 }
1074 rrdcreate_config.xff = tmp;
1075 }
1076 else if (strcasecmp ("WritesPerSecond", key) == 0)
1077 {
1078 double wps = atof (value);
1080 if (wps < 0.0)
1081 {
1082 fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
1083 "greater than or equal to zero.");
1084 return (1);
1085 }
1086 else if (wps == 0.0)
1087 {
1088 write_rate = 0.0;
1089 }
1090 else
1091 {
1092 write_rate = 1.0 / wps;
1093 }
1094 }
1095 else if (strcasecmp ("RandomTimeout", key) == 0)
1096 {
1097 double tmp;
1099 tmp = atof (value);
1100 if (tmp < 0.0)
1101 {
1102 fprintf (stderr, "rrdtool: `RandomTimeout' must "
1103 "be greater than or equal to zero.\n");
1104 ERROR ("rrdtool: `RandomTimeout' must "
1105 "be greater then or equal to zero.");
1106 }
1107 else
1108 {
1109 random_timeout = DOUBLE_TO_CDTIME_T (tmp);
1110 }
1111 }
1112 else
1113 {
1114 return (-1);
1115 }
1116 return (0);
1117 } /* int rrd_config */
1119 static int rrd_shutdown (void)
1120 {
1121 pthread_mutex_lock (&cache_lock);
1122 rrd_cache_flush (0);
1123 pthread_mutex_unlock (&cache_lock);
1125 pthread_mutex_lock (&queue_lock);
1126 do_shutdown = 1;
1127 pthread_cond_signal (&queue_cond);
1128 pthread_mutex_unlock (&queue_lock);
1130 if ((queue_thread_running != 0)
1131 && ((queue_head != NULL) || (flushq_head != NULL)))
1132 {
1133 INFO ("rrdtool plugin: Shutting down the queue thread. "
1134 "This may take a while.");
1135 }
1136 else if (queue_thread_running != 0)
1137 {
1138 INFO ("rrdtool plugin: Shutting down the queue thread.");
1139 }
1141 /* Wait for all the values to be written to disk before returning. */
1142 if (queue_thread_running != 0)
1143 {
1144 pthread_join (queue_thread, NULL);
1145 memset (&queue_thread, 0, sizeof (queue_thread));
1146 queue_thread_running = 0;
1147 DEBUG ("rrdtool plugin: queue_thread exited.");
1148 }
1150 rrd_cache_destroy ();
1152 return (0);
1153 } /* int rrd_shutdown */
1155 static int rrd_init (void)
1156 {
1157 static int init_once = 0;
1158 int status;
1160 if (init_once != 0)
1161 return (0);
1162 init_once = 1;
1164 if (rrdcreate_config.heartbeat <= 0)
1165 rrdcreate_config.heartbeat = 2 * rrdcreate_config.stepsize;
1167 /* Set the cache up */
1168 pthread_mutex_lock (&cache_lock);
1170 cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1171 if (cache == NULL)
1172 {
1173 ERROR ("rrdtool plugin: c_avl_create failed.");
1174 return (-1);
1175 }
1177 cache_flush_last = cdtime ();
1178 if (cache_timeout == 0)
1179 {
1180 cache_flush_timeout = 0;
1181 }
1182 else if (cache_flush_timeout < cache_timeout)
1183 cache_flush_timeout = 10 * cache_timeout;
1185 pthread_mutex_unlock (&cache_lock);
1187 status = plugin_thread_create (&queue_thread, /* attr = */ NULL,
1188 rrd_queue_thread, /* args = */ NULL);
1189 if (status != 0)
1190 {
1191 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1192 return (-1);
1193 }
1194 queue_thread_running = 1;
1196 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %lu;"
1197 " heartbeat = %i; rrarows = %i; xff = %lf;",
1198 (datadir == NULL) ? "(null)" : datadir,
1199 rrdcreate_config.stepsize,
1200 rrdcreate_config.heartbeat,
1201 rrdcreate_config.rrarows,
1202 rrdcreate_config.xff);
1204 return (0);
1205 } /* int rrd_init */
1207 void module_register (void)
1208 {
1209 plugin_register_config ("rrdtool", rrd_config,
1210 config_keys, config_keys_num);
1211 plugin_register_init ("rrdtool", rrd_init);
1212 plugin_register_write ("rrdtool", rrd_write, /* user_data = */ NULL);
1213 plugin_register_flush ("rrdtool", rrd_flush, /* user_data = */ NULL);
1214 plugin_register_shutdown ("rrdtool", rrd_shutdown);
1215 }