src/rrdtool.c

   1 /**
   2  * collectd - src/rrdtool.c
   3  * Copyright (C) 2006-2008  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "plugin.h"
  24 #include "common.h"
  25 #include "utils_avltree.h"
  26 #include "utils_rrdcreate.h"
  27
  28 #include <rrd.h>
  29
  30 #if HAVE_PTHREAD_H
  31 # include <pthread.h>
  32 #endif
  33
  34 /*
  35  * Private types
  36  */
  37 struct rrd_cache_s
  38 {
  39         int    values_num;
  40         char **values;
  41         time_t first_value;
  42         time_t last_value;
  43         enum
  44         {
  45                 FLAG_NONE   = 0x00,
  46                 FLAG_QUEUED = 0x01,
  47                 FLAG_FLUSHQ = 0x02
  48         } flags;
  49 };
  50 typedef struct rrd_cache_s rrd_cache_t;
  51
  52 enum rrd_queue_dir_e
  53 {
  54   QUEUE_INSERT_FRONT,
  55   QUEUE_INSERT_BACK
  56 };
  57 typedef enum rrd_queue_dir_e rrd_queue_dir_t;
  58
  59 struct rrd_queue_s
  60 {
  61         char *filename;
  62         struct rrd_queue_s *next;
  63 };
  64 typedef struct rrd_queue_s rrd_queue_t;
  65
  66 /*
  67  * Private variables
  68  */
  69 static const char *config_keys[] =
  70 {
  71         "CacheTimeout",
  72         "CacheFlush",
  73         "DataDir",
  74         "StepSize",
  75         "HeartBeat",
  76         "RRARows",
  77         "RRATimespan",
  78         "XFF",
  79         "WritesPerSecond"
  80 };
  81 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  82
  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
  85  * being used. */
  86 static char *datadir   = NULL;
  87 static double write_rate = 0.0;
  88 static rrdcreate_config_t rrdcreate_config =
  89 {
  90         /* stepsize = */ 0,
  91         /* heartbeat = */ 0,
  92         /* rrarows = */ 1200,
  93         /* xff = */ 0.1,
  94
  95         /* timespans = */ NULL,
  96         /* timespans_num = */ 0,
  97
  98         /* consolidation_functions = */ NULL,
  99         /* consolidation_functions_num = */ 0
 100 };
 101
 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;
 109
 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;
 117
 118 #if !HAVE_THREADSAFE_LIBRRD
 119 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
 120 #endif
 121
 122 static int do_shutdown = 0;
 123
 124 #if HAVE_THREADSAFE_LIBRRD
 125 static int srrd_update (char *filename, char *template,
 126                 int argc, const char **argv)
 127 {
 128         int status;
 129
 130         optind = 0; /* bug in librrd? */
 131         rrd_clear_error ();
 132
 133         status = rrd_update_r (filename, template, argc, (void *) argv);
 134
 135         if (status != 0)
 136         {
 137                 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
 138                                 filename, rrd_get_error ());
 139         }
 140
 141         return (status);
 142 } /* int srrd_update */
 143 /* #endif HAVE_THREADSAFE_LIBRRD */
 144
 145 #else /* !HAVE_THREADSAFE_LIBRRD */
 146 static int srrd_update (char *filename, char *template,
 147                 int argc, const char **argv)
 148 {
 149         int status;
 150
 151         int new_argc;
 152         char **new_argv;
 153
 154         assert (template == NULL);
 155
 156         new_argc = 2 + argc;
 157         new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
 158         if (new_argv == NULL)
 159         {
 160                 ERROR ("rrdtool plugin: malloc failed.");
 161                 return (-1);
 162         }
 163
 164         new_argv[0] = "update";
 165         new_argv[1] = filename;
 166
 167         memcpy (new_argv + 2, argv, argc * sizeof (char *));
 168         new_argv[new_argc] = NULL;
 169
 170         pthread_mutex_lock (&librrd_lock);
 171         optind = 0; /* bug in librrd? */
 172         rrd_clear_error ();
 173
 174         status = rrd_update (new_argc, new_argv);
 175         pthread_mutex_unlock (&librrd_lock);
 176
 177         if (status != 0)
 178         {
 179                 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
 180                                 argv[1], rrd_get_error ());
 181         }
 182
 183         sfree (new_argv);
 184
 185         return (status);
 186 } /* int srrd_update */
 187 #endif /* !HAVE_THREADSAFE_LIBRRD */
 188
 189 static int value_list_to_string (char *buffer, int buffer_len,
 190                 const data_set_t *ds, const value_list_t *vl)
 191 {
 192         int offset;
 193         int status;
 194         int i;
 195
 196         memset (buffer, '\0', buffer_len);
 197
 198         status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
 199         if ((status < 1) || (status >= buffer_len))
 200                 return (-1);
 201         offset = status;
 202
 203         for (i = 0; i < ds->ds_num; i++)
 204         {
 205                 if ((ds->ds[i].type != DS_TYPE_COUNTER)
 206                                 && (ds->ds[i].type != DS_TYPE_GAUGE))
 207                         return (-1);
 208
 209                 if (ds->ds[i].type == DS_TYPE_COUNTER)
 210                         status = ssnprintf (buffer + offset, buffer_len - offset,
 211                                         ":%llu", vl->values[i].counter);
 212                 else
 213                         status = ssnprintf (buffer + offset, buffer_len - offset,
 214                                         ":%lf", vl->values[i].gauge);
 215
 216                 if ((status < 1) || (status >= (buffer_len - offset)))
 217                         return (-1);
 218
 219                 offset += status;
 220         } /* for ds->ds_num */
 221
 222         return (0);
 223 } /* int value_list_to_string */
 224
 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)
 227 {
 228         int offset = 0;
 229         int status;
 230
 231         if (datadir != NULL)
 232         {
 233                 status = ssnprintf (buffer + offset, buffer_len - offset,
 234                                 "%s/", datadir);
 235                 if ((status < 1) || (status >= buffer_len - offset))
 236                         return (-1);
 237                 offset += status;
 238         }
 239
 240         status = ssnprintf (buffer + offset, buffer_len - offset,
 241                         "%s/", vl->host);
 242         if ((status < 1) || (status >= buffer_len - offset))
 243                 return (-1);
 244         offset += status;
 245
 246         if (strlen (vl->plugin_instance) > 0)
 247                 status = ssnprintf (buffer + offset, buffer_len - offset,
 248                                 "%s-%s/", vl->plugin, vl->plugin_instance);
 249         else
 250                 status = ssnprintf (buffer + offset, buffer_len - offset,
 251                                 "%s/", vl->plugin);
 252         if ((status < 1) || (status >= buffer_len - offset))
 253                 return (-1);
 254         offset += status;
 255
 256         if (strlen (vl->type_instance) > 0)
 257                 status = ssnprintf (buffer + offset, buffer_len - offset,
 258                                 "%s-%s.rrd", vl->type, vl->type_instance);
 259         else
 260                 status = ssnprintf (buffer + offset, buffer_len - offset,
 261                                 "%s.rrd", vl->type);
 262         if ((status < 1) || (status >= buffer_len - offset))
 263                 return (-1);
 264         offset += status;
 265
 266         return (0);
 267 } /* int value_list_to_filename */
 268
 269 static void *rrd_queue_thread (void __attribute__((unused)) *data)
 270 {
 271         struct timeval tv_next_update;
 272         struct timeval tv_now;
 273
 274         gettimeofday (&tv_next_update, /* timezone = */ NULL);
 275
 276         while (42)
 277         {
 278                 rrd_queue_t *queue_entry;
 279                 rrd_cache_t *cache_entry;
 280                 char **values;
 281                 int    values_num;
 282                 int    status;
 283                 int    i;
 284
 285                 pthread_mutex_lock (&queue_lock);
 286                 /* Wait for values to arrive */
 287                 while (true)
 288                 {
 289                   struct timespec ts_wait;
 290
 291                   while ((flushq_head == NULL) && (queue_head == NULL)
 292                       && (do_shutdown == 0))
 293                     pthread_cond_wait (&queue_cond, &queue_lock);
 294
 295                   if ((flushq_head == NULL) && (queue_head == NULL))
 296                     break;
 297
 298                   /* Don't delay if there's something to flush */
 299                   if (flushq_head != NULL)
 300                     break;
 301
 302                   /* Don't delay if we're shutting down */
 303                   if (do_shutdown != 0)
 304                     break;
 305
 306                   /* Don't delay if no delay was configured. */
 307                   if (write_rate <= 0.0)
 308                     break;
 309
 310                   gettimeofday (&tv_now, /* timezone = */ NULL);
 311                   status = timeval_cmp (tv_next_update, tv_now, NULL);
 312                   /* We're good to go */
 313                   if (status <= 0)
 314                     break;
 315
 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;
 321
 322                   status = pthread_cond_timedwait (&queue_cond, &queue_lock,
 323                       &ts_wait);
 324                   if (status == ETIMEDOUT)
 325                     break;
 326                 } /* while (true) */
 327
 328                 /* XXX: If you need to lock both, cache_lock and queue_lock, at
 329                  * the same time, ALWAYS lock `cache_lock' first! */
 330
 331                 /* We're in the shutdown phase */
 332                 if ((flushq_head == NULL) && (queue_head == NULL))
 333                 {
 334                   pthread_mutex_unlock (&queue_lock);
 335                   break;
 336                 }
 337
 338                 if (flushq_head != NULL)
 339                 {
 340                   /* Dequeue the first flush entry */
 341                   queue_entry = flushq_head;
 342                   if (flushq_head == flushq_tail)
 343                     flushq_head = flushq_tail = NULL;
 344                   else
 345                     flushq_head = flushq_head->next;
 346                 }
 347                 else /* if (queue_head != NULL) */
 348                 {
 349                   /* Dequeue the first regular entry */
 350                   queue_entry = queue_head;
 351                   if (queue_head == queue_tail)
 352                     queue_head = queue_tail = NULL;
 353                   else
 354                     queue_head = queue_head->next;
 355                 }
 356
 357                 /* Unlock the queue again */
 358                 pthread_mutex_unlock (&queue_lock);
 359
 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);
 363
 364                 status = c_avl_get (cache, queue_entry->filename,
 365                                 (void *) &cache_entry);
 366
 367                 if (status == 0)
 368                 {
 369                         values = cache_entry->values;
 370                         values_num = cache_entry->values_num;
 371
 372                         cache_entry->values = NULL;
 373                         cache_entry->values_num = 0;
 374                         cache_entry->flags = FLAG_NONE;
 375                 }
 376
 377                 pthread_mutex_unlock (&cache_lock);
 378
 379                 if (status != 0)
 380                 {
 381                         sfree (queue_entry->filename);
 382                         sfree (queue_entry);
 383                         continue;
 384                 }
 385
 386                 /* Update `tv_next_update' */
 387                 if (write_rate > 0.0)
 388                 {
 389                   gettimeofday (&tv_now, /* timezone = */ NULL);
 390                   tv_next_update.tv_sec = tv_now.tv_sec;
 391                   tv_next_update.tv_usec = tv_now.tv_usec
 392                     + ((suseconds_t) (1000000 * write_rate));
 393                   while (tv_next_update.tv_usec > 1000000)
 394                   {
 395                     tv_next_update.tv_sec++;
 396                     tv_next_update.tv_usec -= 1000000;
 397                   }
 398                 }
 399
 400                 /* Write the values to the RRD-file */
 401                 srrd_update (queue_entry->filename, NULL,
 402                                 values_num, (const char **)values);
 403                 DEBUG ("rrdtool plugin: queue thread: Wrote %i values to %s",
 404                                 values_num, queue_entry->filename);
 405
 406                 for (i = 0; i < values_num; i++)
 407                 {
 408                         sfree (values[i]);
 409                 }
 410                 sfree (values);
 411                 sfree (queue_entry->filename);
 412                 sfree (queue_entry);
 413         } /* while (42) */
 414
 415         pthread_mutex_lock (&cache_lock);
 416         c_avl_destroy (cache);
 417         cache = NULL;
 418         pthread_mutex_unlock (&cache_lock);
 419
 420         pthread_exit ((void *) 0);
 421         return ((void *) 0);
 422 } /* void *rrd_queue_thread */
 423
 424 static int rrd_queue_enqueue (const char *filename,
 425     rrd_queue_t **head, rrd_queue_t **tail)
 426 {
 427   rrd_queue_t *queue_entry;
 428
 429   queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
 430   if (queue_entry == NULL)
 431     return (-1);
 432
 433   queue_entry->filename = strdup (filename);
 434   if (queue_entry->filename == NULL)
 435   {
 436     free (queue_entry);
 437     return (-1);
 438   }
 439
 440   queue_entry->next = NULL;
 441
 442   pthread_mutex_lock (&queue_lock);
 443
 444   if (*tail == NULL)
 445     *head = queue_entry;
 446   else
 447     (*tail)->next = queue_entry;
 448   *tail = queue_entry;
 449
 450   pthread_cond_signal (&queue_cond);
 451   pthread_mutex_unlock (&queue_lock);
 452
 453   return (0);
 454 } /* int rrd_queue_enqueue */
 455
 456 static int rrd_queue_dequeue (const char *filename,
 457     rrd_queue_t **head, rrd_queue_t **tail)
 458 {
 459   rrd_queue_t *this;
 460   rrd_queue_t *prev;
 461
 462   pthread_mutex_lock (&queue_lock);
 463
 464   prev = NULL;
 465   this = *head;
 466
 467   while (this != NULL)
 468   {
 469     if (strcmp (this->filename, filename) == 0)
 470       break;
 471
 472     prev = this;
 473     this = this->next;
 474   }
 475
 476   if (this == NULL)
 477   {
 478     pthread_mutex_unlock (&queue_lock);
 479     return (-1);
 480   }
 481
 482   if (prev == NULL)
 483     *head = this->next;
 484   else
 485     prev->next = this->next;
 486
 487   if (this->next == NULL)
 488     *tail = prev;
 489
 490   pthread_mutex_unlock (&queue_lock);
 491
 492   sfree (this->filename);
 493   sfree (this);
 494
 495   return (0);
 496 } /* int rrd_queue_dequeue */
 497
 498 static void rrd_cache_flush (int timeout)
 499 {
 500         rrd_cache_t *rc;
 501         time_t       now;
 502
 503         char **keys = NULL;
 504         int    keys_num = 0;
 505
 506         char *key;
 507         c_avl_iterator_t *iter;
 508         int i;
 509
 510         DEBUG ("rrdtool plugin: Flushing cache, timeout = %i", timeout);
 511
 512         now = time (NULL);
 513
 514         /* Build a list of entries to be flushed */
 515         iter = c_avl_get_iterator (cache);
 516         while (c_avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
 517         {
 518                 if (rc->flags != FLAG_NONE)
 519                         continue;
 520                 else if ((now - rc->first_value) < timeout)
 521                         continue;
 522                 else if (rc->values_num > 0)
 523                 {
 524                         int status;
 525
 526                         status = rrd_queue_enqueue (key, &queue_head,  &queue_tail);
 527                         if (status == 0)
 528                                 rc->flags = FLAG_QUEUED;
 529                 }
 530                 else /* ancient and no values -> waste of memory */
 531                 {
 532                         char **tmp = (char **) realloc ((void *) keys,
 533                                         (keys_num + 1) * sizeof (char *));
 534                         if (tmp == NULL)
 535                         {
 536                                 char errbuf[1024];
 537                                 ERROR ("rrdtool plugin: "
 538                                                 "realloc failed: %s",
 539                                                 sstrerror (errno, errbuf,
 540                                                         sizeof (errbuf)));
 541                                 c_avl_iterator_destroy (iter);
 542                                 sfree (keys);
 543                                 return;
 544                         }
 545                         keys = tmp;
 546                         keys[keys_num] = key;
 547                         keys_num++;
 548                 }
 549         } /* while (c_avl_iterator_next) */
 550         c_avl_iterator_destroy (iter);
 551
 552         for (i = 0; i < keys_num; i++)
 553         {
 554                 if (c_avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
 555                 {
 556                         DEBUG ("rrdtool plugin: c_avl_remove (%s) failed.", keys[i]);
 557                         continue;
 558                 }
 559
 560                 assert (rc->values == NULL);
 561                 assert (rc->values_num == 0);
 562
 563                 sfree (rc);
 564                 sfree (key);
 565                 keys[i] = NULL;
 566         } /* for (i = 0..keys_num) */
 567
 568         sfree (keys);
 569
 570         cache_flush_last = now;
 571 } /* void rrd_cache_flush */
 572
 573 static int rrd_cache_flush_identifier (int timeout, const char *identifier)
 574 {
 575   rrd_cache_t *rc;
 576   time_t now;
 577   int status;
 578   char key[2048];
 579
 580   if (identifier == NULL)
 581   {
 582     rrd_cache_flush (timeout);
 583     return (0);
 584   }
 585
 586   now = time (NULL);
 587
 588   if (datadir == NULL)
 589     snprintf (key, sizeof (key), "%s.rrd",
 590         identifier);
 591   else
 592     snprintf (key, sizeof (key), "%s/%s.rrd",
 593         datadir, identifier);
 594   key[sizeof (key) - 1] = 0;
 595
 596   status = c_avl_get (cache, key, (void *) &rc);
 597   if (status != 0)
 598   {
 599     WARNING ("rrdtool plugin: rrd_cache_flush_identifier: "
 600         "c_avl_get (%s) failed. Does that file really exist?",
 601         key);
 602     return (status);
 603   }
 604
 605   if (rc->flags == FLAG_FLUSHQ)
 606   {
 607     status = 0;
 608   }
 609   else if (rc->flags == FLAG_QUEUED)
 610   {
 611     rrd_queue_dequeue (key, &queue_head, &queue_tail);
 612     status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
 613     if (status == 0)
 614       rc->flags = FLAG_FLUSHQ;
 615   }
 616   else if ((now - rc->first_value) < timeout)
 617   {
 618     status = 0;
 619   }
 620   else if (rc->values_num > 0)
 621   {
 622     status = rrd_queue_enqueue (key, &flushq_head, &flushq_tail);
 623     if (status == 0)
 624       rc->flags = FLAG_FLUSHQ;
 625   }
 626
 627   return (status);
 628 } /* int rrd_cache_flush_identifier */
 629
 630 static int rrd_cache_insert (const char *filename,
 631                 const char *value, time_t value_time)
 632 {
 633         rrd_cache_t *rc = NULL;
 634         int new_rc = 0;
 635         char **values_new;
 636
 637         pthread_mutex_lock (&cache_lock);
 638
 639         /* This shouldn't happen, but it did happen at least once, so we'll be
 640          * careful. */
 641         if (cache == NULL)
 642         {
 643                 pthread_mutex_unlock (&cache_lock);
 644                 WARNING ("rrdtool plugin: cache == NULL.");
 645                 return (-1);
 646         }
 647
 648         c_avl_get (cache, filename, (void *) &rc);
 649
 650         if (rc == NULL)
 651         {
 652                 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
 653                 if (rc == NULL)
 654                         return (-1);
 655                 rc->values_num = 0;
 656                 rc->values = NULL;
 657                 rc->first_value = 0;
 658                 rc->last_value = 0;
 659                 rc->flags = FLAG_NONE;
 660                 new_rc = 1;
 661         }
 662
 663         if (rc->last_value >= value_time)
 664         {
 665                 pthread_mutex_unlock (&cache_lock);
 666                 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
 667                                 (unsigned int) rc->last_value,
 668                                 (unsigned int) value_time);
 669                 return (-1);
 670         }
 671
 672         values_new = (char **) realloc ((void *) rc->values,
 673                         (rc->values_num + 1) * sizeof (char *));
 674         if (values_new == NULL)
 675         {
 676                 char errbuf[1024];
 677                 void *cache_key = NULL;
 678
 679                 sstrerror (errno, errbuf, sizeof (errbuf));
 680
 681                 c_avl_remove (cache, filename, &cache_key, NULL);
 682                 pthread_mutex_unlock (&cache_lock);
 683
 684                 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
 685
 686                 sfree (cache_key);
 687                 sfree (rc->values);
 688                 sfree (rc);
 689                 return (-1);
 690         }
 691         rc->values = values_new;
 692
 693         rc->values[rc->values_num] = strdup (value);
 694         if (rc->values[rc->values_num] != NULL)
 695                 rc->values_num++;
 696
 697         if (rc->values_num == 1)
 698                 rc->first_value = value_time;
 699         rc->last_value = value_time;
 700
 701         /* Insert if this is the first value */
 702         if (new_rc == 1)
 703         {
 704                 void *cache_key = strdup (filename);
 705
 706                 if (cache_key == NULL)
 707                 {
 708                         char errbuf[1024];
 709                         sstrerror (errno, errbuf, sizeof (errbuf));
 710
 711                         pthread_mutex_unlock (&cache_lock);
 712
 713                         ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
 714
 715                         sfree (rc->values[0]);
 716                         sfree (rc->values);
 717                         sfree (rc);
 718                         return (-1);
 719                 }
 720
 721                 c_avl_insert (cache, cache_key, rc);
 722         }
 723
 724         DEBUG ("rrdtool plugin: rrd_cache_insert: file = %s; "
 725                         "values_num = %i; age = %lu;",
 726                         filename, rc->values_num,
 727                         (unsigned long)(rc->last_value - rc->first_value));
 728
 729         if ((rc->last_value - rc->first_value) >= cache_timeout)
 730         {
 731                 /* XXX: If you need to lock both, cache_lock and queue_lock, at
 732                  * the same time, ALWAYS lock `cache_lock' first! */
 733                 if (rc->flags == FLAG_NONE)
 734                 {
 735                         int status;
 736
 737                         status = rrd_queue_enqueue (filename, &queue_head, &queue_tail);
 738                         if (status == 0)
 739                                 rc->flags = FLAG_QUEUED;
 740                 }
 741                 else
 742                 {
 743                         DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
 744                 }
 745         }
 746
 747         if ((cache_timeout > 0) &&
 748                         ((time (NULL) - cache_flush_last) > cache_flush_timeout))
 749                 rrd_cache_flush (cache_flush_timeout);
 750
 751         pthread_mutex_unlock (&cache_lock);
 752
 753         return (0);
 754 } /* int rrd_cache_insert */
 755
 756 static int rrd_compare_numeric (const void *a_ptr, const void *b_ptr)
 757 {
 758         int a = *((int *) a_ptr);
 759         int b = *((int *) b_ptr);
 760
 761         if (a < b)
 762                 return (-1);
 763         else if (a > b)
 764                 return (1);
 765         else
 766                 return (0);
 767 } /* int rrd_compare_numeric */
 768
 769 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
 770 {
 771         struct stat  statbuf;
 772         char         filename[512];
 773         char         values[512];
 774         int          status;
 775
 776         if (0 != strcmp (ds->type, vl->type)) {
 777                 ERROR ("rrdtool plugin: DS type does not match value list type");
 778                 return -1;
 779         }
 780
 781         if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
 782                 return (-1);
 783
 784         if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
 785                 return (-1);
 786
 787         if (stat (filename, &statbuf) == -1)
 788         {
 789                 if (errno == ENOENT)
 790                 {
 791                         status = cu_rrd_create_file (filename,
 792                                         ds, vl, &rrdcreate_config);
 793                         if (status != 0)
 794                                 return (-1);
 795                 }
 796                 else
 797                 {
 798                         char errbuf[1024];
 799                         ERROR ("stat(%s) failed: %s", filename,
 800                                         sstrerror (errno, errbuf,
 801                                                 sizeof (errbuf)));
 802                         return (-1);
 803                 }
 804         }
 805         else if (!S_ISREG (statbuf.st_mode))
 806         {
 807                 ERROR ("stat(%s): Not a regular file!",
 808                                 filename);
 809                 return (-1);
 810         }
 811
 812         status = rrd_cache_insert (filename, values, vl->time);
 813
 814         return (status);
 815 } /* int rrd_write */
 816
 817 static int rrd_flush (int timeout, const char *identifier)
 818 {
 819         pthread_mutex_lock (&cache_lock);
 820
 821         if (cache == NULL) {
 822                 pthread_mutex_unlock (&cache_lock);
 823                 return (0);
 824         }
 825
 826         rrd_cache_flush_identifier (timeout, identifier);
 827
 828         pthread_mutex_unlock (&cache_lock);
 829         return (0);
 830 } /* int rrd_flush */
 831
 832 static int rrd_config (const char *key, const char *value)
 833 {
 834         if (strcasecmp ("CacheTimeout", key) == 0)
 835         {
 836                 int tmp = atoi (value);
 837                 if (tmp < 0)
 838                 {
 839                         fprintf (stderr, "rrdtool: `CacheTimeout' must "
 840                                         "be greater than 0.\n");
 841                         ERROR ("rrdtool: `CacheTimeout' must "
 842                                         "be greater than 0.\n");
 843                         return (1);
 844                 }
 845                 cache_timeout = tmp;
 846         }
 847         else if (strcasecmp ("CacheFlush", key) == 0)
 848         {
 849                 int tmp = atoi (value);
 850                 if (tmp < 0)
 851                 {
 852                         fprintf (stderr, "rrdtool: `CacheFlush' must "
 853                                         "be greater than 0.\n");
 854                         ERROR ("rrdtool: `CacheFlush' must "
 855                                         "be greater than 0.\n");
 856                         return (1);
 857                 }
 858                 cache_flush_timeout = tmp;
 859         }
 860         else if (strcasecmp ("DataDir", key) == 0)
 861         {
 862                 if (datadir != NULL)
 863                         free (datadir);
 864                 datadir = strdup (value);
 865                 if (datadir != NULL)
 866                 {
 867                         int len = strlen (datadir);
 868                         while ((len > 0) && (datadir[len - 1] == '/'))
 869                         {
 870                                 len--;
 871                                 datadir[len] = '\0';
 872                         }
 873                         if (len <= 0)
 874                         {
 875                                 free (datadir);
 876                                 datadir = NULL;
 877                         }
 878                 }
 879         }
 880         else if (strcasecmp ("StepSize", key) == 0)
 881         {
 882                 int temp = atoi (value);
 883                 if (temp > 0)
 884                         rrdcreate_config.stepsize = temp;
 885         }
 886         else if (strcasecmp ("HeartBeat", key) == 0)
 887         {
 888                 int temp = atoi (value);
 889                 if (temp > 0)
 890                         rrdcreate_config.heartbeat = temp;
 891         }
 892         else if (strcasecmp ("RRARows", key) == 0)
 893         {
 894                 int tmp = atoi (value);
 895                 if (tmp <= 0)
 896                 {
 897                         fprintf (stderr, "rrdtool: `RRARows' must "
 898                                         "be greater than 0.\n");
 899                         ERROR ("rrdtool: `RRARows' must "
 900                                         "be greater than 0.\n");
 901                         return (1);
 902                 }
 903                 rrdcreate_config.rrarows = tmp;
 904         }
 905         else if (strcasecmp ("RRATimespan", key) == 0)
 906         {
 907                 char *saveptr = NULL;
 908                 char *dummy;
 909                 char *ptr;
 910                 char *value_copy;
 911                 int *tmp_alloc;
 912
 913                 value_copy = strdup (value);
 914                 if (value_copy == NULL)
 915                         return (1);
 916
 917                 dummy = value_copy;
 918                 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
 919                 {
 920                         dummy = NULL;
 921
 922                         tmp_alloc = realloc (rrdcreate_config.timespans,
 923                                         sizeof (int) * (rrdcreate_config.timespans_num + 1));
 924                         if (tmp_alloc == NULL)
 925                         {
 926                                 fprintf (stderr, "rrdtool: realloc failed.\n");
 927                                 ERROR ("rrdtool: realloc failed.\n");
 928                                 free (value_copy);
 929                                 return (1);
 930                         }
 931                         rrdcreate_config.timespans = tmp_alloc;
 932                         rrdcreate_config.timespans[rrdcreate_config.timespans_num] = atoi (ptr);
 933                         if (rrdcreate_config.timespans[rrdcreate_config.timespans_num] != 0)
 934                                 rrdcreate_config.timespans_num++;
 935                 } /* while (strtok_r) */
 936
 937                 qsort (/* base = */ rrdcreate_config.timespans,
 938                                 /* nmemb  = */ rrdcreate_config.timespans_num,
 939                                 /* size   = */ sizeof (rrdcreate_config.timespans[0]),
 940                                 /* compar = */ rrd_compare_numeric);
 941
 942                 free (value_copy);
 943         }
 944         else if (strcasecmp ("XFF", key) == 0)
 945         {
 946                 double tmp = atof (value);
 947                 if ((tmp < 0.0) || (tmp >= 1.0))
 948                 {
 949                         fprintf (stderr, "rrdtool: `XFF' must "
 950                                         "be in the range 0 to 1 (exclusive).");
 951                         ERROR ("rrdtool: `XFF' must "
 952                                         "be in the range 0 to 1 (exclusive).");
 953                         return (1);
 954                 }
 955                 rrdcreate_config.xff = tmp;
 956         }
 957         else if (strcasecmp ("WritesPerSecond", key) == 0)
 958         {
 959                 double wps = atof (value);
 960
 961                 if (wps < 0.0)
 962                 {
 963                         fprintf (stderr, "rrdtool: `WritesPerSecond' must be "
 964                                         "greater than or equal to zero.");
 965                         return (1);
 966                 }
 967                 else if (wps == 0.0)
 968                 {
 969                         write_rate = 0.0;
 970                 }
 971                 else
 972                 {
 973                         write_rate = 1.0 / wps;
 974                 }
 975         }
 976         else
 977         {
 978                 return (-1);
 979         }
 980         return (0);
 981 } /* int rrd_config */
 982
 983 static int rrd_shutdown (void)
 984 {
 985         pthread_mutex_lock (&cache_lock);
 986         rrd_cache_flush (-1);
 987         pthread_mutex_unlock (&cache_lock);
 988
 989         pthread_mutex_lock (&queue_lock);
 990         do_shutdown = 1;
 991         pthread_cond_signal (&queue_cond);
 992         pthread_mutex_unlock (&queue_lock);
 993
 994         /* Wait for all the values to be written to disk before returning. */
 995         if (queue_thread != 0)
 996         {
 997                 pthread_join (queue_thread, NULL);
 998                 queue_thread = 0;
 999                 DEBUG ("rrdtool plugin: queue_thread exited.");
1000         }
1001
1002         return (0);
1003 } /* int rrd_shutdown */
1004
1005 static int rrd_init (void)
1006 {
1007         int status;
1008
1009         if (rrdcreate_config.stepsize < 0)
1010                 rrdcreate_config.stepsize = 0;
1011         if (rrdcreate_config.heartbeat <= 0)
1012                 rrdcreate_config.heartbeat = 2 * rrdcreate_config.stepsize;
1013
1014         if ((rrdcreate_config.heartbeat > 0)
1015                         && (rrdcreate_config.heartbeat < interval_g))
1016                 WARNING ("rrdtool plugin: Your `heartbeat' is "
1017                                 "smaller than your `interval'. This will "
1018                                 "likely cause problems.");
1019         else if ((rrdcreate_config.stepsize > 0)
1020                         && (rrdcreate_config.stepsize < interval_g))
1021                 WARNING ("rrdtool plugin: Your `stepsize' is "
1022                                 "smaller than your `interval'. This will "
1023                                 "create needlessly big RRD-files.");
1024
1025         /* Set the cache up */
1026         pthread_mutex_lock (&cache_lock);
1027
1028         cache = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1029         if (cache == NULL)
1030         {
1031                 ERROR ("rrdtool plugin: c_avl_create failed.");
1032                 return (-1);
1033         }
1034
1035         cache_flush_last = time (NULL);
1036         if (cache_timeout < 2)
1037         {
1038                 cache_timeout = 0;
1039                 cache_flush_timeout = 0;
1040         }
1041         else if (cache_flush_timeout < cache_timeout)
1042                 cache_flush_timeout = 10 * cache_timeout;
1043
1044         pthread_mutex_unlock (&cache_lock);
1045
1046         status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1047         if (status != 0)
1048         {
1049                 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1050                 return (-1);
1051         }
1052
1053         DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1054                         " heartbeat = %i; rrarows = %i; xff = %lf;",
1055                         (datadir == NULL) ? "(null)" : datadir,
1056                         rrdcreate_config.stepsize,
1057                         rrdcreate_config.heartbeat,
1058                         rrdcreate_config.rrarows,
1059                         rrdcreate_config.xff);
1060
1061         return (0);
1062 } /* int rrd_init */
1063
1064 void module_register (void)
1065 {
1066         plugin_register_config ("rrdtool", rrd_config,
1067                         config_keys, config_keys_num);
1068         plugin_register_init ("rrdtool", rrd_init);
1069         plugin_register_write ("rrdtool", rrd_write);
1070         plugin_register_flush ("rrdtool", rrd_flush);
1071         plugin_register_shutdown ("rrdtool", rrd_shutdown);
1072 }