src/rrdtool.c

   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  **/
  25
  26 #include "collectd.h"
  27 #include "plugin.h"
  28 #include "common.h"
  29 #include "utils_avltree.h"
  30 #include "utils_rrdcreate.h"
  31
  32 #include <rrd.h>
  33
  34 #if HAVE_PTHREAD_H
  35 # include <pthread.h>
  36 #endif
  37
  38 /*
  39  * Private types
  40  */
  41 struct rrd_cache_s
  42 {
  43         int    values_num;
  44         char **values;
  45         time_t first_value;
  46         time_t last_value;
  47         int 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;
  56
  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;
  63
  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;
  70
  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);
  88
  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,
 100
 101         /* timespans = */ NULL,
 102         /* timespans_num = */ 0,
 103
 104         /* consolidation_functions = */ NULL,
 105         /* consolidation_functions_num = */ 0
 106 };
 107
 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 int         cache_timeout = 0;
 111 static int         cache_flush_timeout = 0;
 112 static int         random_timeout = 1;
 113 static time_t      cache_flush_last;
 114 static c_avl_tree_t *cache = NULL;
 115 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
 116
 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;
 125
 126 #if !HAVE_THREADSAFE_LIBRRD
 127 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
 128 #endif
 129
 130 static int do_shutdown = 0;
 131
 132 #if HAVE_THREADSAFE_LIBRRD
 133 static int srrd_update (char *filename, char *template,
 134                 int argc, const char **argv)
 135 {
 136         int status;
 137
 138         optind = 0; /* bug in librrd? */
 139         rrd_clear_error ();
 140
 141         status = rrd_update_r (filename, template, argc, (void *) argv);
 142
 143         if (status != 0)
 144         {
 145                 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
 146                                 filename, rrd_get_error ());
 147         }
 148
 149         return (status);
 150 } /* int srrd_update */
 151 /* #endif HAVE_THREADSAFE_LIBRRD */
 152
 153 #else /* !HAVE_THREADSAFE_LIBRRD */
 154 static int srrd_update (char *filename, char *template,
 155                 int argc, const char **argv)
 156 {
 157         int status;
 158
 159         int new_argc;
 160         char **new_argv;
 161
 162         assert (template == NULL);
 163
 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         }
 171
 172         new_argv[0] = "update";
 173         new_argv[1] = filename;
 174
 175         memcpy (new_argv + 2, argv, argc * sizeof (char *));
 176         new_argv[new_argc] = NULL;
 177
 178         pthread_mutex_lock (&librrd_lock);
 179         optind = 0; /* bug in librrd? */
 180         rrd_clear_error ();
 181
 182         status = rrd_update (new_argc, new_argv);
 183         pthread_mutex_unlock (&librrd_lock);
 184
 185         if (status != 0)
 186         {
 187                 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
 188                                 argv[1], rrd_get_error ());
 189         }
 190
 191         sfree (new_argv);
 192
 193         return (status);
 194 } /* int srrd_update */
 195 #endif /* !HAVE_THREADSAFE_LIBRRD */
 196
 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         int i;
 203
 204         memset (buffer, '\0', buffer_len);
 205
 206         status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
 207         if ((status < 1) || (status >= buffer_len))
 208                 return (-1);
 209         offset = status;
 210
 211         for (i = 0; i < ds->ds_num; i++)
 212         {
 213                 if ((ds->ds[i].type != DS_TYPE_COUNTER)
 214                                 && (ds->ds[i].type != DS_TYPE_GAUGE)
 215                                 && (ds->ds[i].type != DS_TYPE_DERIVE)
 216                                 && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
 217                         return (-1);
 218
 219                 if (ds->ds[i].type == DS_TYPE_COUNTER)
 220                         status = ssnprintf (buffer + offset, buffer_len - offset,
 221                                         ":%llu", vl->values[i].counter);
 222                 else if (ds->ds[i].type == DS_TYPE_GAUGE)
 223                         status = ssnprintf (buffer + offset, buffer_len - offset,
 224                                         ":%lf", vl->values[i].gauge);
 225                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
 226                         status = ssnprintf (buffer + offset, buffer_len - offset,
 227                                         ":%"PRIi64, vl->values[i].derive);
 228                 else /*if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */
 229                         status = ssnprintf (buffer + offset, buffer_len - offset,
 230                                         ":%"PRIu64, vl->values[i].absolute);
 231
 232                 if ((status < 1) || (status >= (buffer_len - offset)))
 233                         return (-1);
 234
 235                 offset += status;
 236         } /* for ds->ds_num */
 237
 238         return (0);
 239 } /* int value_list_to_string */
 240
 241 static int value_list_to_filename (char *buffer, int buffer_len,
 242                 const data_set_t __attribute__((unused)) *ds, const value_list_t *vl)
 243 {
 244         int offset = 0;
 245         int status;
 246
 247         if (datadir != NULL)
 248         {
 249                 status = ssnprintf (buffer + offset, buffer_len - offset,
 250                                 "%s/", datadir);
 251                 if ((status < 1) || (status >= buffer_len - offset))
 252                         return (-1);
 253                 offset += status;
 254         }
 255
 256         status = ssnprintf (buffer + offset, buffer_len - offset,
 257                         "%s/", vl->host);
 258         if ((status < 1) || (status >= buffer_len - offset))
 259                 return (-1);
 260         offset += status;
 261
 262         if (strlen (vl->plugin_instance) > 0)
 263                 status = ssnprintf (buffer + offset, buffer_len - offset,
 264                                 "%s-%s/", vl->plugin, vl->plugin_instance);
 265         else
 266                 status = ssnprintf (buffer + offset, buffer_len - offset,
 267                                 "%s/", vl->plugin);
 268         if ((status < 1) || (status >= buffer_len - offset))
 269                 return (-1);
 270         offset += status;
 271
 272         if (strlen (vl->type_instance) > 0)
 273                 status = ssnprintf (buffer + offset, buffer_len - offset,
 274                                 "%s-%s.rrd", vl->type, vl->type_instance);
 275         else
 276                 status = ssnprintf (buffer + offset, buffer_len - offset,
 277                                 "%s.rrd", vl->type);
 278         if ((status < 1) || (status >= buffer_len - offset))
 279                 return (-1);
 280         offset += status;
 281
 282         return (0);
 283 } /* int value_list_to_filename */
 284
 285 static void *rrd_queue_thread (void __attribute__((unused)) *data)
 286 {
 287         struct timeval tv_next_update;
 288         struct timeval tv_now;
 289
 290         gettimeofday (&tv_next_update, /* timezone = */ NULL);
 291
 292         while (42)
 293         {
 294                 rrd_queue_t *queue_entry;
 295                 rrd_cache_t *cache_entry;
 296                 char **values;
 297                 int    values_num;
 298                 int    status;
 299                 int    i;
 300
 301                 values = NULL;
 302                 values_num = 0;
 303
 304                 pthread_mutex_lock (&queue_lock);
 305                 /* Wait for values to arrive */
 306                 while (true)
 307                 {
 308                   struct timespec ts_wait;
 309
 310                   while ((flushq_head == NULL) && (queue_head == NULL)
 311                       && (do_shutdown == 0))
 312                     pthread_cond_wait (&queue_cond, &queue_lock);
 313
 314                   if ((flushq_head == NULL) && (queue_head == NULL))
 315                     break;
 316
 317                   /* Don't delay if there's something to flush */
 318                   if (flushq_head != NULL)
 319                     break;
 320
 321                   /* Don't delay if we're shutting down */
 322                   if (do_shutdown != 0)
 323                     break;
 324
 325                   /* Don't delay if no delay was configured. */
 326                   if (write_rate <= 0.0)
 327                     break;
 328
 329                   gettimeofday (&tv_now, /* timezone = */ NULL);
 330                   status = timeval_cmp (tv_next_update, tv_now, NULL);
 331                   /* We're good to go */
 332                   if (status <= 0)
 333                     break;
 334
 335                   /* We're supposed to wait a bit with this update, so we'll
 336                    * wait for the next addition to the queue or to the end of
 337                    * the wait period - whichever comes first. */
 338                   ts_wait.tv_sec = tv_next_update.tv_sec;
 339                   ts_wait.tv_nsec = 1000 * tv_next_update.tv_usec;
 340
 341                   status = pthread_cond_timedwait (&queue_cond, &queue_lock,
 342                       &ts_wait);
 343                   if (status == ETIMEDOUT)
 344                     break;
 345                 } /* while (true) */
 346
 347                 /* XXX: If you need to lock both, cache_lock and queue_lock, at
 348                  * the same time, ALWAYS lock `cache_lock' first! */
 349
 350                 /* We're in the shutdown phase */
 351                 if ((flushq_head == NULL) && (queue_head == NULL))
 352                 {
 353                   pthread_mutex_unlock (&queue_lock);
 354                   break;
 355                 }
 356
 357                 if (flushq_head != NULL)
 358                 {
 359                   /* Dequeue the first flush entry */
 360                   queue_entry = flushq_head;
 361                   if (flushq_head == flushq_tail)
 362                     flushq_head = flushq_tail = NULL;
 363                   else
 364                     flushq_head = flushq_head->next;
 365                 }
 366                 else /* if (queue_head != NULL) */
 367                 {
 368                   /* Dequeue the first regular entry */
 369                   queue_entry = queue_head;
 370                   if (queue_head == queue_tail)
 371                     queue_head = queue_tail = NULL;
 372                   else
 373                     queue_head = queue_head->next;
 374                 }
 375
 376                 /* Unlock the queue again */
 377                 pthread_mutex_unlock (&queue_lock);
 378
 379                 /* We now need the cache lock so the entry isn't updated while
 380                  * we make a copy of it's values */
 381                 pthread_mutex_lock (&cache_lock);
 382
 383                 status = c_avl_get (cache, queue_entry->filename,
 384                                 (void *) &cache_entry);
 385
 386                 if (status == 0)
 387                 {
 388                         values = cache_entry->values;
 389                         values_num = cache_entry->values_num;
 390
 391                         cache_entry->values = NULL;
 392                         cache_entry->values_num = 0;
 393                         cache_entry->flags = FLAG_NONE;
 394                 }
 395
 396                 pthread_mutex_unlock (&cache_lock);
 397
 398                 if (status != 0)
 399                 {
 400                         sfree (queue_entry->filename);
 401                         sfree (queue_entry);
 402                         continue;
 403                 }
 404
 405                 /* Update `tv_next_update' */
 406                 if (write_rate > 0.0)
 407                 {
 408                   gettimeofday (&tv_now, /* timezone = */ NULL);
 409                   tv_next_update.tv_sec = tv_now.tv_sec;
 410                   tv_next_update.tv_usec = tv_now.tv_usec
 411                     + ((suseconds_t) (1000000 * write_rate));
 412                   while (tv_next_update.tv_usec > 1000000)
 413                   {
 414                     tv_next_update.tv_sec++;
 415                     tv_next_update.tv_usec -= 1000000;
 416                   }
 417                 }
 418
 419                 /* Write the values to the RRD-file */
 420                 srrd_update (queue_entry->filename, NULL,
 421                                 values_num, (const char **)values);
 422                 DEBUG ("rrdtool plugin: queue thread: Wrote %i value%s to %s",
 423                                 values_num, (values_num == 1) ? "" : "s",
 424                                 queue_entry->filename);
 425
 426                 for (i = 0; i < values_num; i++)
 427                 {
 428                         sfree (values[i]);
 429                 }
 430                 sfree (values);
 431                 sfree (queue_entry->filename);
 432                 sfree (queue_entry);
 433         } /* while (42) */
 434
 435         pthread_exit ((void *) 0);
 436         return ((void *) 0);
 437 } /* void *rrd_queue_thread */
 438
 439 static int rrd_queue_enqueue (const char *filename,
 440     rrd_queue_t **head, rrd_queue_t **tail)
 441 {
 442   rrd_queue_t *queue_entry;
 443
 444   queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
 445   if (queue_entry == NULL)
 446     return (-1);
 447
 448   queue_entry->filename = strdup (filename);
 449   if (queue_entry->filename == NULL)
 450   {
 451     free (queue_entry);
 452     return (-1);
 453   }
 454
 455   queue_entry->next = NULL;
 456
 457   pthread_mutex_lock (&queue_lock);
 458
 459   if (*tail == NULL)
 460     *head = queue_entry;
 461   else
 462     (*tail)->next = queue_entry;
 463   *tail = queue_entry;
 464
 465   pthread_cond_signal (&queue_cond);
 466   pthread_mutex_unlock (&queue_lock);
 467
 468   return (0);
 469 } /* int rrd_queue_enqueue */
 470
 471 static int rrd_queue_dequeue (const char *filename,
 472     rrd_queue_t **head, rrd_queue_t **tail)
 473 {
 474   rrd_queue_t *this;
 475   rrd_queue_t *prev;
 476
 477   pthread_mutex_lock (&queue_lock);
 478
 479   prev = NULL;
 480   this = *head;
 481
 482   while (this != NULL)
 483   {
 484     if (strcmp (this->filename, filename) == 0)
 485       break;
 486
 487     prev = this;
 488     this = this->next;
 489   }
 490
 491   if (this == NULL)
 492   {
 493     pthread_mutex_unlock (&queue_lock);
 494     return (-1);
 495   }
 496
 497   if (prev == NULL)
 498     *head = this->next;
 499   else
 500     prev->next = this->next;
 501
 502   if (this->next == NULL)
 503     *tail = prev;
 504
 505   pthread_mutex_unlock (&queue_lock);
 506
 507   sfree (this->filename);
 508   sfree (this);
 509
 510   return (0);
 511 } /* int rrd_queue_dequeue */
 512
 513 static void rrd_cache_flush (int timeout)
 514 {
 515         rrd_cache_t *rc;
 516         time_t       now;
 517
 518         char **keys = NULL;
 519         int    keys_num = 0;
 520
 521         char *key;
 522         c_avl_iterator_t *iter;
 523         int i;
 524
 525         DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
 526
 527         now = time (NULL);
 528
 529         /* Build a list of entries to be flushed */
 530         iter = c_avl_get_iterator (cache);
 531         while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
 532         {
 533                 if (rc->flags != FLAG_NONE)
 534                         continue;
 535                 else if ((now - rc->first_value) < timeout)
 536                         continue;
 537                 else if (rc->values_num > 0)
 538                 {
 539                         int status;
 540
 541                         status = rrd_queue_enqueue (key, &queue_head,  &queue_tail);
 542                         if (status == 0)
 543                                 rc->flags = FLAG_QUEUED;
 544                 }
 545                 else /* ancient and no values -> waste of memory */
 546                 {
 547                         char **tmp = (char **) realloc ((void *) keys,
 548                                         (keys_num + 1) * sizeof (char *));
 549                         if (tmp == NULL)
 550                         {
 551                                 char errbuf[1024];
 552                                 ERROR ("rrdtool plugin: "
 553                                                 "realloc failed: %s",
 554                                                 sstrerror (errno, errbuf,
 555                                                         sizeof (errbuf)));
 556                                 c_avl_iterator_destroy (iter);
 557                                 sfree (keys);
 558                                 return;
 559                         }
 560                         keys = tmp;
 561                         keys[keys_num] = key;
 562                         keys_num++;
 563                 }
 564         } /* while (c_avl_iterator_next) */
 565         c_avl_iterator_destroy (iter);
 566
 567         for (i = 0; i < keys_num; i++)
 568         {
 569                 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
 570                 {
 571                         DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
 572                         continue;
 573                 }
 574
 575                 assert (rc->values == NULL);
 576                 assert (rc->values_num == 0);
 577
 578                 sfree (rc);
 579                 sfree (key);
 580                 keys[i] = NULL;
 581         } /* for (i = 0..keys_num) */
 582
 583         sfree (keys);
 584
 585         cache_flush_last = now;
 586 } /* void rrd_cache_flush */
 587
 588 static int rrd_cache_flush_identifier (int timeout, const char *identifier)
 589 {
 590   rrd_cache_t *rc;
 591   time_t now;
 592   int status;
 593   char key[2048];
 594
 595   if (identifier == NULL)
 596   {
 597     rrd_cache_flush (timeout);
 598     return (0);
 599   }
 600
 601   now = time (NULL);
 602
 603   if (datadir == NULL)
 604     snprintf (key, sizeof (key), "%s.rrd",
 605         identifier);
 606   else
 607     snprintf (key, sizeof (key), "%s/%s.rrd",
 608         datadir, identifier);
 609   key[sizeof (key) - 1] = 0;
 610
 611   status = c_avl_get (cache, key, (void *) &rc);
 612   if (status != 0)
 613   {
 614     INFO ("rrdtool plugin: rrd_cache_flush_identifier: "
 615         "c_avl_get (%s) failed. Does that file really exist?",
 616         key);
 617     return (status);
 618   }
 619
 620   if (rc->flags == FLAG_FLUSHQ)
 621   {
 622     status = 0;
 623   }
 624   else if (rc->flags == FLAG_QUEUED)
 625   {
 626     rrd_queue_dequeue (key, &queue_head, &queue_tail);
 627     status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
 628     if (status == 0)
 629       rc->flags = FLAG_FLUSHQ;
 630   }
 631   else if ((now - rc->first_value) < timeout)
 632   {
 633     status = 0;
 634   }
 635   else if (rc->values_num > 0)
 636   {
 637     status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
 638     if (status == 0)
 639       rc->flags = FLAG_FLUSHQ;
 640   }
 641
 642   return (status);
 643 } /* int rrd_cache_flush_identifier */
 644
 645 static int rrd_cache_insert (const char *filename,
 646                 const char *value, time_t value_time)
 647 {
 648         rrd_cache_t *rc = NULL;
 649         int new_rc = 0;
 650         char **values_new;
 651
 652         pthread_mutex_lock (&cache_lock);
 653
 654         /* This shouldn't happen, but it did happen at least once, so we'll be
 655          * careful. */
 656         if (cache == NULL)
 657         {
 658                 pthread_mutex_unlock (&cache_lock);
 659                 WARNING ("rrdtool plugin: cache == NULL.");
 660                 return (-1);
 661         }
 662
 663         c_avl_get (cache, filename, (void *) &rc);
 664
 665         if (rc == NULL)
 666         {
 667                 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
 668                 if (rc == NULL)
 669                         return (-1);
 670                 rc->values_num = 0;
 671                 rc->values = NULL;
 672                 rc->first_value = 0;
 673                 rc->last_value = 0;
 674                 rc->random_variation = 0;
 675                 rc->flags = FLAG_NONE;
 676                 new_rc = 1;
 677         }
 678
 679         if (rc->last_value >= value_time)
 680         {
 681                 pthread_mutex_unlock (&cache_lock);
 682                 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
 683                                 (unsigned int) rc->last_value,
 684                                 (unsigned int) value_time);
 685                 return (-1);
 686         }
 687
 688         values_new = (char **) realloc ((void *) rc->values,
 689                         (rc->values_num + 1) * sizeof (char *));
 690         if (values_new == NULL)
 691         {
 692                 char errbuf[1024];
 693                 void *cache_key = NULL;
 694
 695                 sstrerror (errno, errbuf, sizeof (errbuf));
 696
 697                 c_avl_remove (cache, filename, &cache_key, NULL);
 698                 pthread_mutex_unlock (&cache_lock);
 699
 700                 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
 701
 702                 sfree (cache_key);
 703                 sfree (rc->values);
 704                 sfree (rc);
 705                 return (-1);
 706         }
 707         rc->values = values_new;
 708
 709         rc->values[rc->values_num] = strdup (value);
 710         if (rc->values[rc->values_num] != NULL)
 711                 rc->values_num++;
 712
 713         if (rc->values_num == 1)
 714                 rc->first_value = value_time;
 715         rc->last_value = value_time;
 716
 717         /* Insert if this is the first value */
 718         if (new_rc == 1)
 719         {
 720                 void *cache_key = strdup (filename);
 721
 722                 if (cache_key == NULL)
 723                 {
 724                         char errbuf[1024];
 725                         sstrerror (errno, errbuf, sizeof (errbuf));
 726
 727                         pthread_mutex_unlock (&cache_lock);
 728
 729                         ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
 730
 731                         sfree (rc->values[0]);
 732                         sfree (rc->values);
 733                         sfree (rc);
 734                         return (-1);
 735                 }
 736
 737                 c_avl_insert (cache, cache_key, rc);
 738         }
 739
 740         DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
 741                         "values_num = %i; age = %lu;",
 742                         filename, rc->values_num,
 743                         (unsigned long)(rc->last_value - rc->first_value));
 744
 745         if ((rc->last_value + rc->random_variation - rc->first_value) >= cache_timeout)
 746         {
 747                 /* XXX: If you need to lock both, cache_lock and queue_lock, at
 748                  * the same time, ALWAYS lock `cache_lock' first! */
 749                 if (rc->flags == FLAG_NONE)
 750                 {
 751                         int status;
 752
 753                         status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
 754                         if (status == 0)
 755                                 rc->flags = FLAG_QUEUED;
 756
 757                         /* Update the jitter value. Negative values are
 758                          * slightly preferred. */
 759                         if (random_timeout > 0)
 760                         {
 761                                 rc->random_variation = (rand () % (2 * random_timeout))
 762                                         - random_timeout;
 763                         }
 764                         else
 765                         {
 766                                 rc->random_variation = 0;
 767                         }
 768                 }
 769                 else
 770                 {
 771                         DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
 772                 }
 773         }
 774
 775         if ((cache_timeout > 0) &&
 776                         ((time (NULL) - cache_flush_last) > cache_flush_timeout))
 777                 rrd_cache_flush (cache_flush_timeout);
 778
 779         pthread_mutex_unlock (&cache_lock);
 780
 781         return (0);
 782 } /* int rrd_cache_insert */
 783
 784 static int rrd_cache_destroy (void) /* {{{ */
 785 {
 786   void *key = NULL;
 787   void *value = NULL;
 788
 789   int non_empty = 0;
 790
 791   pthread_mutex_lock (&cache_lock);
 792
 793   if (cache == NULL)
 794   {
 795     pthread_mutex_unlock (&cache_lock);
 796     return (0);
 797   }
 798
 799   while (c_avl_pick (cache, &key, &value) == 0)
 800   {
 801     rrd_cache_t *rc;
 802     int i;
 803
 804     sfree (key);
 805     key = NULL;
 806
 807     rc = value;
 808     value = NULL;
 809
 810     if (rc->values_num > 0)
 811       non_empty++;
 812
 813     for (i = 0; i < rc->values_num; i++)
 814       sfree (rc->values[i]);
 815     sfree (rc->values);
 816     sfree (rc);
 817   }
 818
 819   c_avl_destroy (cache);
 820   cache = NULL;
 821
 822   if (non_empty > 0)
 823   {
 824     INFO ("rrdtool plugin: %i cache %s had values when destroying the cache.",
 825         non_empty, (non_empty == 1) ? "entry" : "entries");
 826   }
 827   else
 828   {
 829     DEBUG ("rrdtool plugin: No values have been lost "
 830         "when destroying the cache.");
 831   }
 832
 833   pthread_mutex_unlock (&cache_lock);
 834   return (0);
 835 } /* }}} int rrd_cache_destroy */
 836
 837 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
 838 {
 839         int a = *((int *) a_ptr);
 840         int b = *((int *) b_ptr);
 841
 842         if (a < b)
 843                 return (-1);
 844         else if (a > b)
 845                 return (1);
 846         else
 847                 return (0);
 848 } /* int rrd_compare_numeric */
 849
 850 static int rrd_write (const data_set_t *ds, const value_list_t *vl,
 851                 user_data_t __attribute__((unused)) *user_data)
 852 {
 853         struct stat  statbuf;
 854         char         filename[512];
 855         char         values[512];
 856         int          status;
 857
 858         if (do_shutdown)
 859                 return (0);
 860
 861         if (0 != strcmp (ds->type, vl->type)) {
 862                 ERROR ("rrdtool plugin: DS type does not match value list type");
 863                 return -1;
 864         }
 865
 866         if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
 867                 return (-1);
 868
 869         if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
 870                 return (-1);
 871
 872         if (stat (filename, &statbuf) == -1)
 873         {
 874                 if (errno == ENOENT)
 875                 {
 876                         status = cu_rrd_create_file (filename,
 877                                         ds, vl, &rrdcreate_config);
 878                         if (status != 0)
 879                                 return (-1);
 880                 }
 881                 else
 882                 {
 883                         char errbuf[1024];
 884                         ERROR ("stat(%s) failed: %s", filename,
 885                                         sstrerror (errno, errbuf,
 886                                                 sizeof (errbuf)));
 887                         return (-1);
 888                 }
 889         }
 890         else if (!S_ISREG (statbuf.st_mode))
 891         {
 892                 ERROR ("stat(%s): Not a regular file!",
 893                                 filename);
 894                 return (-1);
 895         }
 896
 897         status = rrd_cache_insert (filename, values, vl->time);
 898
 899         return (status);
 900 } /* int rrd_write */
 901
 902 static int rrd_flush (int timeout, const char *identifier,
 903                 user_data_t __attribute__((unused)) *user_data)
 904 {
 905         pthread_mutex_lock (&cache_lock);
 906
 907         if (cache == NULL) {
 908                 pthread_mutex_unlock (&cache_lock);
 909                 return (0);
 910         }
 911
 912         rrd_cache_flush_identifier (timeout, identifier);
 913
 914         pthread_mutex_unlock (&cache_lock);
 915         return (0);
 916 } /* int rrd_flush */
 917
 918 static int rrd_config (const char *key, const char *value)
 919 {
 920         if (strcasecmp ("CacheTimeout", key) == 0)
 921         {
 922                 int tmp = atoi (value);
 923                 if (tmp < 0)
 924                 {
 925                         fprintf (stderr, "rrdtool: `CacheTimeout' must "
 926                                         "be greater than 0.\n");
 927                         ERROR ("rrdtool: `CacheTimeout' must "
 928                                         "be greater than 0.\n");
 929                         return (1);
 930                 }
 931                 cache_timeout = tmp;
 932         }
 933         else if (strcasecmp ("CacheFlush", key) == 0)
 934         {
 935                 int tmp = atoi (value);
 936                 if (tmp < 0)
 937                 {
 938                         fprintf (stderr, "rrdtool: `CacheFlush' must "
 939                                         "be greater than 0.\n");
 940                         ERROR ("rrdtool: `CacheFlush' must "
 941                                         "be greater than 0.\n");
 942                         return (1);
 943                 }
 944                 cache_flush_timeout = tmp;
 945         }
 946         else if (strcasecmp ("DataDir", key) == 0)
 947         {
 948                 if (datadir != NULL)
 949                         free (datadir);
 950                 datadir = strdup (value);
 951                 if (datadir != NULL)
 952                 {
 953                         int len = strlen (datadir);
 954                         while ((len > 0) && (datadir[len - 1] == '/'))
 955                         {
 956                                 len--;
 957                                 datadir[len] = '\0';
 958                         }
 959                         if (len <= 0)
 960                         {
 961                                 free (datadir);
 962                                 datadir = NULL;
 963                         }
 964                 }
 965         }
 966         else if (strcasecmp ("StepSize", key) == 0)
 967         {
 968                 int temp = atoi (value);
 969                 if (temp > 0)
 970                         rrdcreate_config.stepsize = temp;
 971         }
 972         else if (strcasecmp ("HeartBeat", key) == 0)
 973         {
 974                 int temp = atoi (value);
 975                 if (temp > 0)
 976                         rrdcreate_config.heartbeat = temp;
 977         }
 978         else if (strcasecmp ("RRARows", key) == 0)
 979         {
 980                 int tmp = atoi (value);
 981                 if (tmp <= 0)
 982                 {
 983                         fprintf (stderr, "rrdtool: `RRARows' must "
 984                                         "be greater than 0.\n");
 985                         ERROR ("rrdtool: `RRARows' must "
 986                                         "be greater than 0.\n");
 987                         return (1);
 988                 }
 989                 rrdcreate_config.rrarows = tmp;
 990         }
 991         else if (strcasecmp ("RRATimespan", key) == 0)
 992         {
 993                 char *saveptr = NULL;
 994                 char *dummy;
 995                 char *ptr;
 996                 char *value_copy;
 997                 int *tmp_alloc;
 998
 999                 value_copy = strdup (value);
1000                 if (value_copy == NULL)
1001                         return (1);
1002
1003                 dummy = value_copy;
1004                 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1005                 {
1006                         dummy = NULL;
1007
1008                         tmp_alloc = realloc (rrdcreate_config.timespans,
1009                                         sizeof (int) * (rrdcreate_config.timespans_num + 1));
1010                         if (tmp_alloc == NULL)
1011                         {
1012                                 fprintf (stderr, "rrdtool: realloc failed.\n");
1013                                 ERROR ("rrdtool: realloc failed.\n");
1014                                 free (value_copy);
1015                                 return (1);
1016                         }
1017                         rrdcreate_config.timespans = tmp_alloc;
1018                         rrdcreate_config.timespans[rrdcreate_config.timespans_num] = atoi (ptr);
1019                         if (rrdcreate_config.timespans[rrdcreate_config.timespans_num] != 0)
1020                                 rrdcreate_config.timespans_num++;
1021                 } /* while (strtok_r) */
1022
1023                 qsort (/* base = */ rrdcreate_config.timespans,
1024                                 /* nmemb  = */ rrdcreate_config.timespans_num,
1025                                 /* size   = */ sizeof (rrdcreate_config.timespans[0]),
1026                                 /* compar = */ rrd_compare_numeric);
1027
1028                 free (value_copy);
1029         }
1030         else if (strcasecmp ("XFF", key) == 0)
1031         {
1032                 double tmp = atof (value);
1033                 if ((tmp < 0.0) || (tmp >= 1.0))
1034                 {
1035                         fprintf (stderr, "rrdtool: `XFF' must "
1036                                         "be in the range 0 to 1 (exclusive).");
1037                         ERROR ("rrdtool: `XFF' must "
1038                                         "be in the range 0 to 1 (exclusive).");
1039                         return (1);
1040                 }
1041                 rrdcreate_config.xff = tmp;
1042         }
1043         else if (strcasecmp ("WritesPerSecond", key) == 0)
1044         {
1045                 double wps = atof (value);
1046
1047                 if (wps < 0.0)
1048                 {
1049                         fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
1050                                         "greater than or equal to zero.");
1051                         return (1);
1052                 }
1053                 else if (wps == 0.0)
1054                 {
1055                         write_rate = 0.0;
1056                 }
1057                 else
1058                 {
1059                         write_rate = 1.0 / wps;
1060                 }
1061         }
1062         else if (strcasecmp ("RandomTimeout", key) == 0)
1063         {
1064                 int tmp;
1065
1066                 tmp = atoi (value);
1067                 if (tmp < 0)
1068                 {
1069                         fprintf (stderr, "rrdtool: `RandomTimeout' must "
1070                                         "be greater than or equal to zero.\n");
1071                         ERROR ("rrdtool: `RandomTimeout' must "
1072                                         "be greater then or equal to zero.");
1073                 }
1074                 else
1075                 {
1076                         random_timeout = tmp;
1077                 }
1078         }
1079         else
1080         {
1081                 return (-1);
1082         }
1083         return (0);
1084 } /* int rrd_config */
1085
1086 static int rrd_shutdown (void)
1087 {
1088         pthread_mutex_lock (&cache_lock);
1089         rrd_cache_flush (-1);
1090         pthread_mutex_unlock (&cache_lock);
1091
1092         pthread_mutex_lock (&queue_lock);
1093         do_shutdown = 1;
1094         pthread_cond_signal (&queue_cond);
1095         pthread_mutex_unlock (&queue_lock);
1096
1097         if ((queue_thread_running != 0)
1098                         && ((queue_head != NULL) || (flushq_head != NULL)))
1099         {
1100                 INFO ("rrdtool plugin: Shutting down the queue thread. "
1101                                 "This may take a while.");
1102         }
1103         else if (queue_thread_running != 0)
1104         {
1105                 INFO ("rrdtool plugin: Shutting down the queue thread.");
1106         }
1107
1108         /* Wait for all the values to be written to disk before returning. */
1109         if (queue_thread_running != 0)
1110         {
1111                 pthread_join (queue_thread, NULL);
1112                 memset (&queue_thread, 0, sizeof (queue_thread));
1113                 queue_thread_running = 0;
1114                 DEBUG ("rrdtool plugin: queue_thread exited.");
1115         }
1116
1117         rrd_cache_destroy ();
1118
1119         return (0);
1120 } /* int rrd_shutdown */
1121
1122 static int rrd_init (void)
1123 {
1124         static int init_once = 0;
1125         int status;
1126
1127         if (init_once != 0)
1128                 return (0);
1129         init_once = 1;
1130
1131         if (rrdcreate_config.stepsize < 0)
1132                 rrdcreate_config.stepsize = 0;
1133         if (rrdcreate_config.heartbeat <= 0)
1134                 rrdcreate_config.heartbeat = 2 * rrdcreate_config.stepsize;
1135
1136         if ((rrdcreate_config.heartbeat > 0)
1137                         && (rrdcreate_config.heartbeat < interval_g))
1138                 WARNING ("rrdtool plugin: Your `heartbeat' is "
1139                                 "smaller than your `interval'. This will "
1140                                 "likely cause problems.");
1141         else if ((rrdcreate_config.stepsize > 0)
1142                         && (rrdcreate_config.stepsize < interval_g))
1143                 WARNING ("rrdtool plugin: Your `stepsize' is "
1144                                 "smaller than your `interval'. This will "
1145                                 "create needlessly big RRD-files.");
1146
1147         /* Set the cache up */
1148         pthread_mutex_lock (&cache_lock);
1149
1150         cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1151         if (cache == NULL)
1152         {
1153                 ERROR ("rrdtool plugin: c_avl_create failed.");
1154                 return (-1);
1155         }
1156
1157         cache_flush_last = time (NULL);
1158         if (cache_timeout < 2)
1159         {
1160                 cache_timeout = 0;
1161                 cache_flush_timeout = 0;
1162         }
1163         else if (cache_flush_timeout < cache_timeout)
1164                 cache_flush_timeout = 10 * cache_timeout;
1165
1166         pthread_mutex_unlock (&cache_lock);
1167
1168         status = pthread_create (&queue_thread, /* attr = */ NULL,
1169                         rrd_queue_thread, /* args = */ NULL);
1170         if (status != 0)
1171         {
1172                 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1173                 return (-1);
1174         }
1175         queue_thread_running = 1;
1176
1177         DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1178                         " heartbeat = %i; rrarows = %i; xff = %lf;",
1179                         (datadir == NULL) ? "(null)" : datadir,
1180                         rrdcreate_config.stepsize,
1181                         rrdcreate_config.heartbeat,
1182                         rrdcreate_config.rrarows,
1183                         rrdcreate_config.xff);
1184
1185         return (0);
1186 } /* int rrd_init */
1187
1188 void module_register (void)
1189 {
1190         plugin_register_config ("rrdtool", rrd_config,
1191                         config_keys, config_keys_num);
1192         plugin_register_init ("rrdtool", rrd_init);
1193         plugin_register_write ("rrdtool", rrd_write, /* user_data = */ NULL);
1194         plugin_register_flush ("rrdtool", rrd_flush, /* user_data = */ NULL);
1195         plugin_register_shutdown ("rrdtool", rrd_shutdown);
1196 }