2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006-2008 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
25 #include "utils_avltree.h"
26 #include "utils_rrdcreate.h"
50 typedef struct rrd_cache_s rrd_cache_t;
57 typedef enum rrd_queue_dir_e rrd_queue_dir_t;
62 struct rrd_queue_s *next;
64 typedef struct rrd_queue_s rrd_queue_t;
69 static const char *config_keys[] =
81 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
83 /* If datadir is zero, the daemon's basedir is used. If stepsize or heartbeat
84 * is zero a default, depending on the `interval' member of the value list is
86 static char *datadir = NULL;
87 static double write_rate = 0.0;
88 static rrdcreate_config_t rrdcreate_config =
95 /* timespans = */ NULL,
96 /* timespans_num = */ 0,
98 /* consolidation_functions = */ NULL,
99 /* consolidation_functions_num = */ 0
102 /* XXX: If you need to lock both, cache_lock and queue_lock, at the same time,
103 * ALWAYS lock `cache_lock' first! */
104 static int cache_timeout = 0;
105 static int cache_flush_timeout = 0;
106 static time_t cache_flush_last;
107 static c_avl_tree_t *cache = NULL;
108 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
110 static rrd_queue_t *queue_head = NULL;
111 static rrd_queue_t *queue_tail = NULL;
112 static rrd_queue_t *flushq_head = NULL;
113 static rrd_queue_t *flushq_tail = NULL;
114 static pthread_t queue_thread = 0;
115 static pthread_mutex_t queue_lock = PTHREAD_MUTEX_INITIALIZER;
116 static pthread_cond_t queue_cond = PTHREAD_COND_INITIALIZER;
118 #if !HAVE_THREADSAFE_LIBRRD
119 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
122 static int do_shutdown = 0;
124 #if HAVE_THREADSAFE_LIBRRD
125 static int srrd_update (char *filename, char *template,
126 int argc, const char **argv)
130 optind = 0; /* bug in librrd? */
133 status = rrd_update_r (filename, template, argc, (void *) argv);
137 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
138 filename, rrd_get_error ());
142 } /* int srrd_update */
143 /* #endif HAVE_THREADSAFE_LIBRRD */
145 #else /* !HAVE_THREADSAFE_LIBRRD */
146 static int srrd_update (char *filename, char *template,
147 int argc, const char **argv)
154 assert (template == NULL);
157 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
158 if (new_argv == NULL)
160 ERROR ("rrdtool plugin: malloc failed.");
164 new_argv[0] = "update";
165 new_argv[1] = filename;
167 memcpy (new_argv + 2, argv, argc * sizeof (char *));
168 new_argv[new_argc] = NULL;
170 pthread_mutex_lock (&librrd_lock);
171 optind = 0; /* bug in librrd? */
174 status = rrd_update (new_argc, new_argv);
175 pthread_mutex_unlock (&librrd_lock);
179 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
180 argv[1], rrd_get_error ());
186 } /* int srrd_update */
187 #endif /* !HAVE_THREADSAFE_LIBRRD */
189 static int value_list_to_string (char *buffer, int buffer_len,
190 const data_set_t *ds, const value_list_t *vl)
196 memset (buffer, '\0', buffer_len);
198 status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
199 if ((status < 1) || (status >= buffer_len))
203 for (i = 0; i < ds->ds_num; i++)
205 if ((ds->ds[i].type != DS_TYPE_COUNTER)
206 && (ds->ds[i].type != DS_TYPE_GAUGE))
209 if (ds->ds[i].type == DS_TYPE_COUNTER)
210 status = ssnprintf (buffer + offset, buffer_len - offset,
211 ":%llu", vl->values[i].counter);
213 status = ssnprintf (buffer + offset, buffer_len - offset,
214 ":%lf", vl->values[i].gauge);
216 if ((status < 1) || (status >= (buffer_len - offset)))
220 } /* for ds->ds_num */
223 } /* int value_list_to_string */
225 static int value_list_to_filename (char *buffer, int buffer_len,
226 const data_set_t __attribute__((unused)) *ds, const value_list_t *vl)
233 status = ssnprintf (buffer + offset, buffer_len - offset,
235 if ((status < 1) || (status >= buffer_len - offset))
240 status = ssnprintf (buffer + offset, buffer_len - offset,
242 if ((status < 1) || (status >= buffer_len - offset))
246 if (strlen (vl->plugin_instance) > 0)
247 status = ssnprintf (buffer + offset, buffer_len - offset,
248 "%s-%s/", vl->plugin, vl->plugin_instance);
250 status = ssnprintf (buffer + offset, buffer_len - offset,
252 if ((status < 1) || (status >= buffer_len - offset))
256 if (strlen (vl->type_instance) > 0)
257 status = ssnprintf (buffer + offset, buffer_len - offset,
258 "%s-%s.rrd", vl->type, vl->type_instance);
260 status = ssnprintf (buffer + offset, buffer_len - offset,
262 if ((status < 1) || (status >= buffer_len - offset))
267 } /* int value_list_to_filename */
269 static void *rrd_queue_thread (void __attribute__((unused)) *data)
271 struct timeval tv_next_update;
272 struct timeval tv_now;
274 gettimeofday (&tv_next_update, /* timezone = */ NULL);
278 rrd_queue_t *queue_entry;
279 rrd_cache_t *cache_entry;
284 pthread_mutex_lock (&queue_lock);
285 /* Wait for values to arrive */
288 struct timespec ts_wait;
291 while ((flushq_head == NULL) && (queue_head == NULL)
292 && (do_shutdown == 0))
293 pthread_cond_wait (&queue_cond, &queue_lock);
295 if ((flushq_head == NULL) && (queue_head == NULL))
298 /* Don't delay if there's something to flush */
299 if (flushq_head != NULL)
302 /* Don't delay if we're shutting down */
303 if (do_shutdown != 0)
306 /* Don't delay if no delay was configured. */
307 if (write_rate <= 0.0)
310 gettimeofday (&tv_now, /* timezone = */ NULL);
311 status = timeval_cmp (tv_next_update, tv_now, NULL);
312 /* We're good to go */
316 /* We're supposed to wait a bit with this update, so we'll
317 * wait for the next addition to the queue or to the end of
318 * the wait period - whichever comes first. */
319 ts_wait.tv_sec = tv_next_update.tv_sec;
320 ts_wait.tv_nsec = 1000 * tv_next_update.tv_usec;
322 status = pthread_cond_timedwait (&queue_cond, &queue_lock,
324 if (status == ETIMEDOUT)
328 /* XXX: If you need to lock both, cache_lock and queue_lock, at
329 * the same time, ALWAYS lock `cache_lock' first! */
331 /* We're in the shutdown phase */
332 if ((flushq_head == NULL) && (queue_head == NULL))
334 pthread_mutex_unlock (&queue_lock);
338 if (flushq_head != NULL)
340 /* Dequeue the first flush entry */
341 queue_entry = flushq_head;
342 if (flushq_head == flushq_tail)
343 flushq_head = flushq_tail = NULL;
345 flushq_head = flushq_head->next;
347 else /* if (queue_head != NULL) */
349 /* Dequeue the first regular entry */
350 queue_entry = queue_head;
351 if (queue_head == queue_tail)
352 queue_head = queue_tail = NULL;
354 queue_head = queue_head->next;
357 /* Unlock the queue again */
358 pthread_mutex_unlock (&queue_lock);
360 /* We now need the cache lock so the entry isn't updated while
361 * we make a copy of it's values */
362 pthread_mutex_lock (&cache_lock);
364 c_avl_get (cache, queue_entry->filename, (void *) &cache_entry);
366 values = cache_entry->values;
367 values_num = cache_entry->values_num;
369 cache_entry->values = NULL;
370 cache_entry->values_num = 0;
371 cache_entry->flags = FLAG_NONE;
373 pthread_mutex_unlock (&cache_lock);
375 /* Update `tv_next_update' */
376 if (write_rate > 0.0)
378 gettimeofday (&tv_now, /* timezone = */ NULL);
379 tv_next_update.tv_sec = tv_now.tv_sec;
380 tv_next_update.tv_usec = tv_now.tv_usec
381 + ((suseconds_t) (1000000 * write_rate));
382 while (tv_next_update.tv_usec > 1000000)
384 tv_next_update.tv_sec++;
385 tv_next_update.tv_usec -= 1000000;
389 /* Write the values to the RRD-file */
390 srrd_update (queue_entry->filename, NULL,
391 values_num, (const char **)values);
392 DEBUG ("rrdtool plugin: queue thread: Wrote %i values to %s",
393 values_num, queue_entry->filename);
395 for (i = 0; i < values_num; i++)
400 sfree (queue_entry->filename);
404 pthread_mutex_lock (&cache_lock);
405 c_avl_destroy (cache);
407 pthread_mutex_unlock (&cache_lock);
409 pthread_exit ((void *) 0);
411 } /* void *rrd_queue_thread */
413 static int rrd_queue_enqueue (const char *filename,
414 rrd_queue_t **head, rrd_queue_t **tail)
416 rrd_queue_t *queue_entry;
418 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
419 if (queue_entry == NULL)
422 queue_entry->filename = strdup (filename);
423 if (queue_entry->filename == NULL)
429 queue_entry->next = NULL;
431 pthread_mutex_lock (&queue_lock);
436 (*tail)->next = queue_entry;
439 pthread_cond_signal (&queue_cond);
440 pthread_mutex_unlock (&queue_lock);
443 } /* int rrd_queue_enqueue */
445 static int rrd_queue_dequeue (const char *filename,
446 rrd_queue_t **head, rrd_queue_t **tail)
451 pthread_mutex_lock (&queue_lock);
458 if (strcmp (this->filename, filename) == 0)
467 pthread_mutex_unlock (&queue_lock);
474 prev->next = this->next;
476 if (this->next == NULL)
479 pthread_mutex_unlock (&queue_lock);
481 sfree (this->filename);
485 } /* int rrd_queue_dequeue */
487 static void rrd_cache_flush (int timeout)
496 c_avl_iterator_t *iter;
499 DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
503 /* Build a list of entries to be flushed */
504 iter = c_avl_get_iterator (cache);
505 while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
507 if (rc->flags != FLAG_NONE)
509 else if ((now - rc->first_value) < timeout)
511 else if (rc->values_num > 0)
515 status = rrd_queue_enqueue (key, &queue_head, &queue_tail);
517 rc->flags = FLAG_QUEUED;
519 else /* ancient and no values -> waste of memory */
521 char **tmp = (char **) realloc ((void *) keys,
522 (keys_num + 1) * sizeof (char *));
526 ERROR ("rrdtool plugin: "
527 "realloc failed: %s",
528 sstrerror (errno, errbuf,
530 c_avl_iterator_destroy (iter);
535 keys[keys_num] = key;
538 } /* while (c_avl_iterator_next) */
539 c_avl_iterator_destroy (iter);
541 for (i = 0; i < keys_num; i++)
543 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
545 DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
549 assert (rc->values == NULL);
550 assert (rc->values_num == 0);
555 } /* for (i = 0..keys_num) */
559 cache_flush_last = now;
560 } /* void rrd_cache_flush */
562 static int rrd_cache_flush_identifier (int timeout, const char *identifier)
569 if (identifier == NULL)
571 rrd_cache_flush (timeout);
578 snprintf (key, sizeof (key), "%s.rrd",
581 snprintf (key, sizeof (key), "%s/%s.rrd",
582 datadir, identifier);
583 key[sizeof (key) - 1] = 0;
585 status = c_avl_get (cache, key, (void *) &rc);
588 WARNING ("rrdtool plugin: rrd_cache_flush_identifier: "
589 "c_avl_get (%s) failed. Does that file really exist?",
594 if (rc->flags == FLAG_FLUSHQ)
598 else if (rc->flags == FLAG_QUEUED)
600 rrd_queue_dequeue (key, &queue_head, &queue_tail);
601 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
603 rc->flags = FLAG_FLUSHQ;
605 else if ((now - rc->first_value) < timeout)
609 else if (rc->values_num > 0)
611 status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
613 rc->flags = FLAG_FLUSHQ;
617 } /* int rrd_cache_flush_identifier */
619 static int rrd_cache_insert (const char *filename,
620 const char *value, time_t value_time)
622 rrd_cache_t *rc = NULL;
626 pthread_mutex_lock (&cache_lock);
628 c_avl_get (cache, filename, (void *) &rc);
632 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
639 rc->flags = FLAG_NONE;
643 if (rc->last_value >= value_time)
645 pthread_mutex_unlock (&cache_lock);
646 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
647 (unsigned int) rc->last_value,
648 (unsigned int) value_time);
652 values_new = (char **) realloc ((void *) rc->values,
653 (rc->values_num + 1) * sizeof (char *));
654 if (values_new == NULL)
657 void *cache_key = NULL;
659 sstrerror (errno, errbuf, sizeof (errbuf));
661 c_avl_remove (cache, filename, &cache_key, NULL);
662 pthread_mutex_unlock (&cache_lock);
664 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
671 rc->values = values_new;
673 rc->values[rc->values_num] = strdup (value);
674 if (rc->values[rc->values_num] != NULL)
677 if (rc->values_num == 1)
678 rc->first_value = value_time;
679 rc->last_value = value_time;
681 /* Insert if this is the first value */
684 void *cache_key = strdup (filename);
686 if (cache_key == NULL)
689 sstrerror (errno, errbuf, sizeof (errbuf));
691 pthread_mutex_unlock (&cache_lock);
693 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
695 sfree (rc->values[0]);
701 c_avl_insert (cache, cache_key, rc);
704 DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
705 "values_num = %i; age = %lu;",
706 filename, rc->values_num,
707 (unsigned long)(rc->last_value - rc->first_value));
709 if ((rc->last_value - rc->first_value) >= cache_timeout)
711 /* XXX: If you need to lock both, cache_lock and queue_lock, at
712 * the same time, ALWAYS lock `cache_lock' first! */
713 if (rc->flags == FLAG_NONE)
717 status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
719 rc->flags = FLAG_QUEUED;
723 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
727 if ((cache_timeout > 0) &&
728 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
729 rrd_cache_flush (cache_flush_timeout);
731 pthread_mutex_unlock (&cache_lock);
734 } /* int rrd_cache_insert */
736 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
738 int a = *((int *) a_ptr);
739 int b = *((int *) b_ptr);
747 } /* int rrd_compare_numeric */
749 static int rrd_write (const data_set_t *ds, const value_list_t *vl,
750 user_data_t __attribute__((unused)) *user_data)
757 if (0 != strcmp (ds->type, vl->type)) {
758 ERROR ("rrdtool plugin: DS type does not match value list type");
762 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
765 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
768 if (stat (filename, &statbuf) == -1)
772 status = cu_rrd_create_file (filename,
773 ds, vl, &rrdcreate_config);
780 ERROR ("stat(%s) failed: %s", filename,
781 sstrerror (errno, errbuf,
786 else if (!S_ISREG (statbuf.st_mode))
788 ERROR ("stat(%s): Not a regular file!",
793 status = rrd_cache_insert (filename, values, vl->time);
796 } /* int rrd_write */
798 static int rrd_flush (int timeout, const char *identifier)
800 pthread_mutex_lock (&cache_lock);
803 pthread_mutex_unlock (&cache_lock);
807 rrd_cache_flush_identifier (timeout, identifier);
809 pthread_mutex_unlock (&cache_lock);
811 } /* int rrd_flush */
813 static int rrd_config (const char *key, const char *value)
815 if (strcasecmp ("CacheTimeout", key) == 0)
817 int tmp = atoi (value);
820 fprintf (stderr, "rrdtool: `CacheTimeout' must "
821 "be greater than 0.\n");
822 ERROR ("rrdtool: `CacheTimeout' must "
823 "be greater than 0.\n");
828 else if (strcasecmp ("CacheFlush", key) == 0)
830 int tmp = atoi (value);
833 fprintf (stderr, "rrdtool: `CacheFlush' must "
834 "be greater than 0.\n");
835 ERROR ("rrdtool: `CacheFlush' must "
836 "be greater than 0.\n");
839 cache_flush_timeout = tmp;
841 else if (strcasecmp ("DataDir", key) == 0)
845 datadir = strdup (value);
848 int len = strlen (datadir);
849 while ((len > 0) && (datadir[len - 1] == '/'))
861 else if (strcasecmp ("StepSize", key) == 0)
863 int temp = atoi (value);
865 rrdcreate_config.stepsize = temp;
867 else if (strcasecmp ("HeartBeat", key) == 0)
869 int temp = atoi (value);
871 rrdcreate_config.heartbeat = temp;
873 else if (strcasecmp ("RRARows", key) == 0)
875 int tmp = atoi (value);
878 fprintf (stderr, "rrdtool: `RRARows' must "
879 "be greater than 0.\n");
880 ERROR ("rrdtool: `RRARows' must "
881 "be greater than 0.\n");
884 rrdcreate_config.rrarows = tmp;
886 else if (strcasecmp ("RRATimespan", key) == 0)
888 char *saveptr = NULL;
894 value_copy = strdup (value);
895 if (value_copy == NULL)
899 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
903 tmp_alloc = realloc (rrdcreate_config.timespans,
904 sizeof (int) * (rrdcreate_config.timespans_num + 1));
905 if (tmp_alloc == NULL)
907 fprintf (stderr, "rrdtool: realloc failed.\n");
908 ERROR ("rrdtool: realloc failed.\n");
912 rrdcreate_config.timespans = tmp_alloc;
913 rrdcreate_config.timespans[rrdcreate_config.timespans_num] = atoi (ptr);
914 if (rrdcreate_config.timespans[rrdcreate_config.timespans_num] != 0)
915 rrdcreate_config.timespans_num++;
916 } /* while (strtok_r) */
918 qsort (/* base = */ rrdcreate_config.timespans,
919 /* nmemb = */ rrdcreate_config.timespans_num,
920 /* size = */ sizeof (rrdcreate_config.timespans[0]),
921 /* compar = */ rrd_compare_numeric);
925 else if (strcasecmp ("XFF", key) == 0)
927 double tmp = atof (value);
928 if ((tmp < 0.0) || (tmp >= 1.0))
930 fprintf (stderr, "rrdtool: `XFF' must "
931 "be in the range 0 to 1 (exclusive).");
932 ERROR ("rrdtool: `XFF' must "
933 "be in the range 0 to 1 (exclusive).");
936 rrdcreate_config.xff = tmp;
938 else if (strcasecmp ("WritesPerSecond", key) == 0)
940 double wps = atof (value);
944 fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
945 "greater than or equal to zero.");
954 write_rate = 1.0 / wps;
962 } /* int rrd_config */
964 static int rrd_shutdown (void)
966 pthread_mutex_lock (&cache_lock);
967 rrd_cache_flush (-1);
968 pthread_mutex_unlock (&cache_lock);
970 pthread_mutex_lock (&queue_lock);
972 pthread_cond_signal (&queue_cond);
973 pthread_mutex_unlock (&queue_lock);
975 /* Wait for all the values to be written to disk before returning. */
976 if (queue_thread != 0)
978 pthread_join (queue_thread, NULL);
980 DEBUG ("rrdtool plugin: queue_thread exited.");
984 } /* int rrd_shutdown */
986 static int rrd_init (void)
990 if (rrdcreate_config.stepsize < 0)
991 rrdcreate_config.stepsize = 0;
992 if (rrdcreate_config.heartbeat <= 0)
993 rrdcreate_config.heartbeat = 2 * rrdcreate_config.stepsize;
995 if ((rrdcreate_config.heartbeat > 0)
996 && (rrdcreate_config.heartbeat < interval_g))
997 WARNING ("rrdtool plugin: Your `heartbeat' is "
998 "smaller than your `interval'. This will "
999 "likely cause problems.");
1000 else if ((rrdcreate_config.stepsize > 0)
1001 && (rrdcreate_config.stepsize < interval_g))
1002 WARNING ("rrdtool plugin: Your `stepsize' is "
1003 "smaller than your `interval'. This will "
1004 "create needlessly big RRD-files.");
1006 /* Set the cache up */
1007 pthread_mutex_lock (&cache_lock);
1009 cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1012 ERROR ("rrdtool plugin: c_avl_create failed.");
1016 cache_flush_last = time (NULL);
1017 if (cache_timeout < 2)
1020 cache_flush_timeout = 0;
1022 else if (cache_flush_timeout < cache_timeout)
1023 cache_flush_timeout = 10 * cache_timeout;
1025 pthread_mutex_unlock (&cache_lock);
1027 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1030 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1034 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1035 " heartbeat = %i; rrarows = %i; xff = %lf;",
1036 (datadir == NULL) ? "(null)" : datadir,
1037 rrdcreate_config.stepsize,
1038 rrdcreate_config.heartbeat,
1039 rrdcreate_config.rrarows,
1040 rrdcreate_config.xff);
1043 } /* int rrd_init */
1045 void module_register (void)
1047 plugin_register_config ("rrdtool", rrd_config,
1048 config_keys, config_keys_num);
1049 plugin_register_init ("rrdtool", rrd_init);
1050 plugin_register_write ("rrdtool", rrd_write, /* user_data = */ NULL);
1051 plugin_register_flush ("rrdtool", rrd_flush);
1052 plugin_register_shutdown ("rrdtool", rrd_shutdown);