src/utils_cache.c

   1 /**
   2  * collectd - src/utils_cache.c
   3  * Copyright (C) 2007-2010  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  * Author:
  19  *   Florian octo Forster <octo at collectd.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "utils_avltree.h"
  26 #include "utils_cache.h"
  27 #include "meta_data.h"
  28
  29 #include <assert.h>
  30 #include <pthread.h>
  31
  32 typedef struct cache_entry_s
  33 {
  34         char name[6 * DATA_MAX_NAME_LEN];
  35         int        values_num;
  36         gauge_t   *values_gauge;
  37         value_t   *values_raw;
  38         /* Time contained in the package
  39          * (for calculating rates) */
  40         cdtime_t last_time;
  41         /* Time according to the local clock
  42          * (for purging old entries) */
  43         cdtime_t last_update;
  44         /* Interval in which the data is collected
  45          * (for purding old entries) */
  46         cdtime_t interval;
  47         int state;
  48         int hits;
  49
  50         /*
  51          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  52          * !  0  !  1  !  2  !  3  !  4  !  5  !  6  !  7  !  8  ! ...
  53          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  54          * ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ...
  55          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  56          * !      t = 0      !      t = 1      !      t = 2      ! ...
  57          * +-----------------+-----------------+-----------------+----
  58          */
  59         gauge_t *history;
  60         size_t   history_index; /* points to the next position to write to. */
  61         size_t   history_length;
  62
  63         meta_data_t *meta;
  64 } cache_entry_t;
  65
  66 static c_avl_tree_t   *cache_tree = NULL;
  67 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
  68
  69 static int cache_compare (const cache_entry_t *a, const cache_entry_t *b)
  70 {
  71   assert ((a != NULL) && (b != NULL));
  72   return (strcmp (a->name, b->name));
  73 } /* int cache_compare */
  74
  75 static cache_entry_t *cache_alloc (int values_num)
  76 {
  77   cache_entry_t *ce;
  78
  79   ce = (cache_entry_t *) malloc (sizeof (cache_entry_t));
  80   if (ce == NULL)
  81   {
  82     ERROR ("utils_cache: cache_alloc: malloc failed.");
  83     return (NULL);
  84   }
  85   memset (ce, '\0', sizeof (cache_entry_t));
  86   ce->values_num = values_num;
  87
  88   ce->values_gauge = calloc (values_num, sizeof (*ce->values_gauge));
  89   ce->values_raw   = calloc (values_num, sizeof (*ce->values_raw));
  90   if ((ce->values_gauge == NULL) || (ce->values_raw == NULL))
  91   {
  92     sfree (ce->values_gauge);
  93     sfree (ce->values_raw);
  94     sfree (ce);
  95     ERROR ("utils_cache: cache_alloc: calloc failed.");
  96     return (NULL);
  97   }
  98
  99   ce->history = NULL;
 100   ce->history_length = 0;
 101   ce->meta = NULL;
 102
 103   return (ce);
 104 } /* cache_entry_t *cache_alloc */
 105
 106 static void cache_free (cache_entry_t *ce)
 107 {
 108   if (ce == NULL)
 109     return;
 110
 111   sfree (ce->values_gauge);
 112   sfree (ce->values_raw);
 113   sfree (ce->history);
 114   if (ce->meta != NULL)
 115   {
 116     meta_data_destroy (ce->meta);
 117     ce->meta = NULL;
 118   }
 119   sfree (ce);
 120 } /* void cache_free */
 121
 122 static void uc_check_range (const data_set_t *ds, cache_entry_t *ce)
 123 {
 124   int i;
 125
 126   for (i = 0; i < ds->ds_num; i++)
 127   {
 128     if (isnan (ce->values_gauge[i]))
 129       continue;
 130     else if (ce->values_gauge[i] < ds->ds[i].min)
 131       ce->values_gauge[i] = NAN;
 132     else if (ce->values_gauge[i] > ds->ds[i].max)
 133       ce->values_gauge[i] = NAN;
 134   }
 135 } /* void uc_check_range */
 136
 137 static int uc_insert (const data_set_t *ds, const value_list_t *vl,
 138     const char *key)
 139 {
 140   int i;
 141   char *key_copy;
 142   cache_entry_t *ce;
 143
 144   /* `cache_lock' has been locked by `uc_update' */
 145
 146   key_copy = strdup (key);
 147   if (key_copy == NULL)
 148   {
 149     ERROR ("uc_insert: strdup failed.");
 150     return (-1);
 151   }
 152
 153   ce = cache_alloc (ds->ds_num);
 154   if (ce == NULL)
 155   {
 156     sfree (key_copy);
 157     ERROR ("uc_insert: cache_alloc (%i) failed.", ds->ds_num);
 158     return (-1);
 159   }
 160
 161   sstrncpy (ce->name, key, sizeof (ce->name));
 162
 163   for (i = 0; i < ds->ds_num; i++)
 164   {
 165     switch (ds->ds[i].type)
 166     {
 167       case DS_TYPE_COUNTER:
 168         ce->values_gauge[i] = NAN;
 169         ce->values_raw[i].counter = vl->values[i].counter;
 170         break;
 171
 172       case DS_TYPE_GAUGE:
 173         ce->values_gauge[i] = vl->values[i].gauge;
 174         ce->values_raw[i].gauge = vl->values[i].gauge;
 175         break;
 176
 177       case DS_TYPE_DERIVE:
 178         ce->values_gauge[i] = NAN;
 179         ce->values_raw[i].derive = vl->values[i].derive;
 180         break;
 181
 182       case DS_TYPE_ABSOLUTE:
 183         ce->values_gauge[i] = NAN;
 184         if (vl->interval > 0)
 185           ce->values_gauge[i] = ((double) vl->values[i].absolute)
 186             / CDTIME_T_TO_DOUBLE (vl->interval);
 187         ce->values_raw[i].absolute = vl->values[i].absolute;
 188         break;
 189
 190       default:
 191         /* This shouldn't happen. */
 192         ERROR ("uc_insert: Don't know how to handle data source type %i.",
 193             ds->ds[i].type);
 194         sfree (key_copy);
 195         return (-1);
 196     } /* switch (ds->ds[i].type) */
 197   } /* for (i) */
 198
 199   /* Prune invalid gauge data */
 200   uc_check_range (ds, ce);
 201
 202   ce->last_time = vl->time;
 203   ce->last_update = cdtime ();
 204   ce->interval = vl->interval;
 205   ce->state = STATE_OKAY;
 206
 207   if (c_avl_insert (cache_tree, key_copy, ce) != 0)
 208   {
 209     sfree (key_copy);
 210     ERROR ("uc_insert: c_avl_insert failed.");
 211     return (-1);
 212   }
 213
 214   DEBUG ("uc_insert: Added %s to the cache.", key);
 215   return (0);
 216 } /* int uc_insert */
 217
 218 int uc_init (void)
 219 {
 220   if (cache_tree == NULL)
 221     cache_tree = c_avl_create ((int (*) (const void *, const void *))
 222         cache_compare);
 223
 224   return (0);
 225 } /* int uc_init */
 226
 227 int uc_check_timeout (void)
 228 {
 229   cdtime_t now;
 230   cache_entry_t *ce;
 231
 232   char **keys = NULL;
 233   cdtime_t *keys_time = NULL;
 234   cdtime_t *keys_interval = NULL;
 235   int keys_len = 0;
 236
 237   char *key;
 238   c_avl_iterator_t *iter;
 239
 240   int status;
 241   int i;
 242
 243   pthread_mutex_lock (&cache_lock);
 244
 245   now = cdtime ();
 246
 247   /* Build a list of entries to be flushed */
 248   iter = c_avl_get_iterator (cache_tree);
 249   while (c_avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
 250   {
 251     char **tmp;
 252     cdtime_t *tmp_time;
 253
 254     /* If the entry is fresh enough, continue. */
 255     if ((now - ce->last_update) < (ce->interval * timeout_g))
 256       continue;
 257
 258     /* If entry has not been updated, add to `keys' array */
 259     tmp = (char **) realloc ((void *) keys,
 260         (keys_len + 1) * sizeof (char *));
 261     if (tmp == NULL)
 262     {
 263       ERROR ("uc_check_timeout: realloc failed.");
 264       continue;
 265     }
 266     keys = tmp;
 267
 268     tmp_time = realloc (keys_time, (keys_len + 1) * sizeof (*keys_time));
 269     if (tmp_time == NULL)
 270     {
 271       ERROR ("uc_check_timeout: realloc failed.");
 272       continue;
 273     }
 274     keys_time = tmp_time;
 275
 276     tmp_time = realloc (keys_interval, (keys_len + 1) * sizeof (*keys_interval));
 277     if (tmp_time == NULL)
 278     {
 279       ERROR ("uc_check_timeout: realloc failed.");
 280       continue;
 281     }
 282     keys_interval = tmp_time;
 283
 284     keys[keys_len] = strdup (key);
 285     if (keys[keys_len] == NULL)
 286     {
 287       ERROR ("uc_check_timeout: strdup failed.");
 288       continue;
 289     }
 290     keys_time[keys_len] = ce->last_time;
 291     keys_interval[keys_len] = ce->interval;
 292
 293     keys_len++;
 294   } /* while (c_avl_iterator_next) */
 295
 296   c_avl_iterator_destroy (iter);
 297   pthread_mutex_unlock (&cache_lock);
 298
 299   if (keys_len == 0)
 300   {
 301     /* realloc() may have been called for these. */
 302     sfree (keys);
 303     sfree (keys_time);
 304     sfree (keys_interval);
 305     return (0);
 306   }
 307
 308   /* Call the "missing" callback for each value. Do this before removing the
 309    * value from the cache, so that callbacks can still access the data stored,
 310    * including plugin specific meta data, rates, history, …. This must be done
 311    * without holding the lock, otherwise we will run into a deadlock if a
 312    * plugin calls the cache interface. */
 313   for (i = 0; i < keys_len; i++)
 314   {
 315     value_list_t vl = VALUE_LIST_INIT;
 316
 317     vl.values = NULL;
 318     vl.values_len = 0;
 319     vl.meta = NULL;
 320
 321     status = parse_identifier_vl (keys[i], &vl);
 322     if (status != 0)
 323     {
 324       ERROR ("uc_check_timeout: parse_identifier_vl (\"%s\") failed.", keys[i]);
 325       continue;
 326     }
 327
 328     vl.time = keys_time[i];
 329     vl.interval = keys_interval[i];
 330
 331     plugin_dispatch_missing (&vl);
 332   } /* for (i = 0; i < keys_len; i++) */
 333
 334   /* Now actually remove all the values from the cache. We don't re-evaluate
 335    * the timestamp again, so in theory it is possible we remove a value after
 336    * it is updated here. */
 337   pthread_mutex_lock (&cache_lock);
 338   for (i = 0; i < keys_len; i++)
 339   {
 340     key = NULL;
 341     ce = NULL;
 342
 343     status = c_avl_remove (cache_tree, keys[i],
 344         (void *) &key, (void *) &ce);
 345     if (status != 0)
 346     {
 347       ERROR ("uc_check_timeout: c_avl_remove (\"%s\") failed.", keys[i]);
 348       sfree (keys[i]);
 349       continue;
 350     }
 351
 352     sfree (keys[i]);
 353     sfree (key);
 354     cache_free (ce);
 355   } /* for (i = 0; i < keys_len; i++) */
 356   pthread_mutex_unlock (&cache_lock);
 357
 358   sfree (keys);
 359   sfree (keys_time);
 360   sfree (keys_interval);
 361
 362   return (0);
 363 } /* int uc_check_timeout */
 364
 365 int uc_update (const data_set_t *ds, const value_list_t *vl)
 366 {
 367   char name[6 * DATA_MAX_NAME_LEN];
 368   cache_entry_t *ce = NULL;
 369   int status;
 370   int i;
 371
 372   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 373   {
 374     ERROR ("uc_update: FORMAT_VL failed.");
 375     return (-1);
 376   }
 377
 378   pthread_mutex_lock (&cache_lock);
 379
 380   status = c_avl_get (cache_tree, name, (void *) &ce);
 381   if (status != 0) /* entry does not yet exist */
 382   {
 383     status = uc_insert (ds, vl, name);
 384     pthread_mutex_unlock (&cache_lock);
 385     return (status);
 386   }
 387
 388   assert (ce != NULL);
 389   assert (ce->values_num == ds->ds_num);
 390
 391   if (ce->last_time >= vl->time)
 392   {
 393     pthread_mutex_unlock (&cache_lock);
 394     NOTICE ("uc_update: Value too old: name = %s; value time = %.3f; "
 395         "last cache update = %.3f;",
 396         name,
 397         CDTIME_T_TO_DOUBLE (vl->time),
 398         CDTIME_T_TO_DOUBLE (ce->last_time));
 399     return (-1);
 400   }
 401
 402   for (i = 0; i < ds->ds_num; i++)
 403   {
 404     switch (ds->ds[i].type)
 405     {
 406       case DS_TYPE_COUNTER:
 407         {
 408           counter_t diff;
 409
 410           /* check if the counter has wrapped around */
 411           if (vl->values[i].counter < ce->values_raw[i].counter)
 412           {
 413             if (ce->values_raw[i].counter <= 4294967295U)
 414               diff = (4294967295U - ce->values_raw[i].counter)
 415                 + vl->values[i].counter;
 416             else
 417               diff = (18446744073709551615ULL - ce->values_raw[i].counter)
 418                 + vl->values[i].counter;
 419           }
 420           else /* counter has NOT wrapped around */
 421           {
 422             diff = vl->values[i].counter - ce->values_raw[i].counter;
 423           }
 424
 425           ce->values_gauge[i] = ((double) diff)
 426             / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 427           ce->values_raw[i].counter = vl->values[i].counter;
 428         }
 429         break;
 430
 431       case DS_TYPE_GAUGE:
 432         ce->values_raw[i].gauge = vl->values[i].gauge;
 433         ce->values_gauge[i] = vl->values[i].gauge;
 434         break;
 435
 436       case DS_TYPE_DERIVE:
 437         {
 438           derive_t diff;
 439
 440           diff = vl->values[i].derive - ce->values_raw[i].derive;
 441
 442           ce->values_gauge[i] = ((double) diff)
 443             / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 444           ce->values_raw[i].derive = vl->values[i].derive;
 445         }
 446         break;
 447
 448       case DS_TYPE_ABSOLUTE:
 449         ce->values_gauge[i] = ((double) vl->values[i].absolute)
 450           / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 451         ce->values_raw[i].absolute = vl->values[i].absolute;
 452         break;
 453
 454       default:
 455         /* This shouldn't happen. */
 456         pthread_mutex_unlock (&cache_lock);
 457         ERROR ("uc_update: Don't know how to handle data source type %i.",
 458             ds->ds[i].type);
 459         return (-1);
 460     } /* switch (ds->ds[i].type) */
 461
 462     DEBUG ("uc_update: %s: ds[%i] = %lf", name, i, ce->values_gauge[i]);
 463   } /* for (i) */
 464
 465   /* Update the history if it exists. */
 466   if (ce->history != NULL)
 467   {
 468     assert (ce->history_index < ce->history_length);
 469     for (i = 0; i < ce->values_num; i++)
 470     {
 471       size_t hist_idx = (ce->values_num * ce->history_index) + i;
 472       ce->history[hist_idx] = ce->values_gauge[i];
 473     }
 474
 475     assert (ce->history_length > 0);
 476     ce->history_index = (ce->history_index + 1) % ce->history_length;
 477   }
 478
 479   /* Prune invalid gauge data */
 480   uc_check_range (ds, ce);
 481
 482   ce->last_time = vl->time;
 483   ce->last_update = cdtime ();
 484   ce->interval = vl->interval;
 485
 486   pthread_mutex_unlock (&cache_lock);
 487
 488   return (0);
 489 } /* int uc_update */
 490
 491 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num)
 492 {
 493   gauge_t *ret = NULL;
 494   size_t ret_num = 0;
 495   cache_entry_t *ce = NULL;
 496   int status = 0;
 497
 498   pthread_mutex_lock (&cache_lock);
 499
 500   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 501   {
 502     assert (ce != NULL);
 503
 504     /* remove missing values from getval */
 505     if (ce->state == STATE_MISSING)
 506     {
 507       status = -1;
 508     }
 509     else
 510     {
 511       ret_num = ce->values_num;
 512       ret = (gauge_t *) malloc (ret_num * sizeof (gauge_t));
 513       if (ret == NULL)
 514       {
 515         ERROR ("utils_cache: uc_get_rate_by_name: malloc failed.");
 516         status = -1;
 517       }
 518       else
 519       {
 520         memcpy (ret, ce->values_gauge, ret_num * sizeof (gauge_t));
 521       }
 522     }
 523   }
 524   else
 525   {
 526     DEBUG ("utils_cache: uc_get_rate_by_name: No such value: %s", name);
 527     status = -1;
 528   }
 529
 530   pthread_mutex_unlock (&cache_lock);
 531
 532   if (status == 0)
 533   {
 534     *ret_values = ret;
 535     *ret_values_num = ret_num;
 536   }
 537
 538   return (status);
 539 } /* gauge_t *uc_get_rate_by_name */
 540
 541 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
 542 {
 543   char name[6 * DATA_MAX_NAME_LEN];
 544   gauge_t *ret = NULL;
 545   size_t ret_num = 0;
 546   int status;
 547
 548   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 549   {
 550     ERROR ("utils_cache: uc_get_rate: FORMAT_VL failed.");
 551     return (NULL);
 552   }
 553
 554   status = uc_get_rate_by_name (name, &ret, &ret_num);
 555   if (status != 0)
 556     return (NULL);
 557
 558   /* This is important - the caller has no other way of knowing how many
 559    * values are returned. */
 560   if (ret_num != (size_t) ds->ds_num)
 561   {
 562     ERROR ("utils_cache: uc_get_rate: ds[%s] has %i values, "
 563         "but uc_get_rate_by_name returned %zu.",
 564         ds->type, ds->ds_num, ret_num);
 565     sfree (ret);
 566     return (NULL);
 567   }
 568
 569   return (ret);
 570 } /* gauge_t *uc_get_rate */
 571
 572 int uc_get_names (char ***ret_names, cdtime_t **ret_times, size_t *ret_number)
 573 {
 574   c_avl_iterator_t *iter;
 575   char *key;
 576   cache_entry_t *value;
 577
 578   char **names = NULL;
 579   cdtime_t *times = NULL;
 580   size_t number = 0;
 581   size_t size_arrays = 0;
 582
 583   int status = 0;
 584
 585   if ((ret_names == NULL) || (ret_number == NULL))
 586     return (-1);
 587
 588   pthread_mutex_lock (&cache_lock);
 589
 590   size_arrays = (size_t) c_avl_size (cache_tree);
 591   if (size_arrays < 1)
 592   {
 593     /* Handle the "no values" case here, to avoid the error message when
 594      * calloc() returns NULL. */
 595     pthread_mutex_unlock (&cache_lock);
 596     return (0);
 597   }
 598
 599   names = calloc (size_arrays, sizeof (*names));
 600   times = calloc (size_arrays, sizeof (*times));
 601   if ((names == NULL) || (times == NULL))
 602   {
 603     ERROR ("uc_get_names: calloc failed.");
 604     sfree (names);
 605     sfree (times);
 606     pthread_mutex_unlock (&cache_lock);
 607     return (ENOMEM);
 608   }
 609
 610   iter = c_avl_get_iterator (cache_tree);
 611   while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
 612   {
 613     /* remove missing values when list values */
 614     if (value->state == STATE_MISSING)
 615       continue;
 616
 617     /* c_avl_size does not return a number smaller than the number of elements
 618      * returned by c_avl_iterator_next. */
 619     assert (number < size_arrays);
 620
 621     if (ret_times != NULL)
 622       times[number] = value->last_time;
 623
 624     names[number] = strdup (key);
 625     if (names[number] == NULL)
 626     {
 627       status = -1;
 628       break;
 629     }
 630
 631     number++;
 632   } /* while (c_avl_iterator_next) */
 633
 634   c_avl_iterator_destroy (iter);
 635   pthread_mutex_unlock (&cache_lock);
 636
 637   if (status != 0)
 638   {
 639     size_t i;
 640
 641     for (i = 0; i < number; i++)
 642     {
 643       sfree (names[i]);
 644     }
 645     sfree (names);
 646     sfree (times);
 647
 648     return (-1);
 649   }
 650
 651   *ret_names = names;
 652   if (ret_times != NULL)
 653     *ret_times = times;
 654   else
 655     sfree (times);
 656   *ret_number = number;
 657
 658   return (0);
 659 } /* int uc_get_names */
 660
 661 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
 662 {
 663   char name[6 * DATA_MAX_NAME_LEN];
 664   cache_entry_t *ce = NULL;
 665   int ret = STATE_ERROR;
 666
 667   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 668   {
 669     ERROR ("uc_get_state: FORMAT_VL failed.");
 670     return (STATE_ERROR);
 671   }
 672
 673   pthread_mutex_lock (&cache_lock);
 674
 675   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 676   {
 677     assert (ce != NULL);
 678     ret = ce->state;
 679   }
 680
 681   pthread_mutex_unlock (&cache_lock);
 682
 683   return (ret);
 684 } /* int uc_get_state */
 685
 686 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
 687 {
 688   char name[6 * DATA_MAX_NAME_LEN];
 689   cache_entry_t *ce = NULL;
 690   int ret = -1;
 691
 692   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 693   {
 694     ERROR ("uc_get_state: FORMAT_VL failed.");
 695     return (STATE_ERROR);
 696   }
 697
 698   pthread_mutex_lock (&cache_lock);
 699
 700   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 701   {
 702     assert (ce != NULL);
 703     ret = ce->state;
 704     ce->state = state;
 705   }
 706
 707   pthread_mutex_unlock (&cache_lock);
 708
 709   return (ret);
 710 } /* int uc_set_state */
 711
 712 int uc_get_history_by_name (const char *name,
 713     gauge_t *ret_history, size_t num_steps, size_t num_ds)
 714 {
 715   cache_entry_t *ce = NULL;
 716   size_t i;
 717   int status = 0;
 718
 719   pthread_mutex_lock (&cache_lock);
 720
 721   status = c_avl_get (cache_tree, name, (void *) &ce);
 722   if (status != 0)
 723   {
 724     pthread_mutex_unlock (&cache_lock);
 725     return (-ENOENT);
 726   }
 727
 728   if (((size_t) ce->values_num) != num_ds)
 729   {
 730     pthread_mutex_unlock (&cache_lock);
 731     return (-EINVAL);
 732   }
 733
 734   /* Check if there are enough values available. If not, increase the buffer
 735    * size. */
 736   if (ce->history_length < num_steps)
 737   {
 738     gauge_t *tmp;
 739     size_t i;
 740
 741     tmp = realloc (ce->history, sizeof (*ce->history)
 742         * num_steps * ce->values_num);
 743     if (tmp == NULL)
 744     {
 745       pthread_mutex_unlock (&cache_lock);
 746       return (-ENOMEM);
 747     }
 748
 749     for (i = ce->history_length * ce->values_num;
 750         i < (num_steps * ce->values_num);
 751         i++)
 752       tmp[i] = NAN;
 753
 754     ce->history = tmp;
 755     ce->history_length = num_steps;
 756   } /* if (ce->history_length < num_steps) */
 757
 758   /* Copy the values to the output buffer. */
 759   for (i = 0; i < num_steps; i++)
 760   {
 761     size_t src_index;
 762     size_t dst_index;
 763
 764     if (i < ce->history_index)
 765       src_index = ce->history_index - (i + 1);
 766     else
 767       src_index = ce->history_length + ce->history_index - (i + 1);
 768     src_index = src_index * num_ds;
 769
 770     dst_index = i * num_ds;
 771
 772     memcpy (ret_history + dst_index, ce->history + src_index,
 773         sizeof (*ret_history) * num_ds);
 774   }
 775
 776   pthread_mutex_unlock (&cache_lock);
 777
 778   return (0);
 779 } /* int uc_get_history_by_name */
 780
 781 int uc_get_history (const data_set_t *ds, const value_list_t *vl,
 782     gauge_t *ret_history, size_t num_steps, size_t num_ds)
 783 {
 784   char name[6 * DATA_MAX_NAME_LEN];
 785
 786   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 787   {
 788     ERROR ("utils_cache: uc_get_history: FORMAT_VL failed.");
 789     return (-1);
 790   }
 791
 792   return (uc_get_history_by_name (name, ret_history, num_steps, num_ds));
 793 } /* int uc_get_history */
 794
 795 int uc_get_hits (const data_set_t *ds, const value_list_t *vl)
 796 {
 797   char name[6 * DATA_MAX_NAME_LEN];
 798   cache_entry_t *ce = NULL;
 799   int ret = STATE_ERROR;
 800
 801   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 802   {
 803     ERROR ("uc_get_state: FORMAT_VL failed.");
 804     return (STATE_ERROR);
 805   }
 806
 807   pthread_mutex_lock (&cache_lock);
 808
 809   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 810   {
 811     assert (ce != NULL);
 812     ret = ce->hits;
 813   }
 814
 815   pthread_mutex_unlock (&cache_lock);
 816
 817   return (ret);
 818 } /* int uc_get_hits */
 819
 820 int uc_set_hits (const data_set_t *ds, const value_list_t *vl, int hits)
 821 {
 822   char name[6 * DATA_MAX_NAME_LEN];
 823   cache_entry_t *ce = NULL;
 824   int ret = -1;
 825
 826   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 827   {
 828     ERROR ("uc_get_state: FORMAT_VL failed.");
 829     return (STATE_ERROR);
 830   }
 831
 832   pthread_mutex_lock (&cache_lock);
 833
 834   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 835   {
 836     assert (ce != NULL);
 837     ret = ce->hits;
 838     ce->hits = hits;
 839   }
 840
 841   pthread_mutex_unlock (&cache_lock);
 842
 843   return (ret);
 844 } /* int uc_set_hits */
 845
 846 int uc_inc_hits (const data_set_t *ds, const value_list_t *vl, int step)
 847 {
 848   char name[6 * DATA_MAX_NAME_LEN];
 849   cache_entry_t *ce = NULL;
 850   int ret = -1;
 851
 852   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 853   {
 854     ERROR ("uc_get_state: FORMAT_VL failed.");
 855     return (STATE_ERROR);
 856   }
 857
 858   pthread_mutex_lock (&cache_lock);
 859
 860   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 861   {
 862     assert (ce != NULL);
 863     ret = ce->hits;
 864     ce->hits = ret + step;
 865   }
 866
 867   pthread_mutex_unlock (&cache_lock);
 868
 869   return (ret);
 870 } /* int uc_inc_hits */
 871
 872 /*
 873  * Meta data interface
 874  */
 875 /* XXX: This function will acquire `cache_lock' but will not free it! */
 876 static meta_data_t *uc_get_meta (const value_list_t *vl) /* {{{ */
 877 {
 878   char name[6 * DATA_MAX_NAME_LEN];
 879   cache_entry_t *ce = NULL;
 880   int status;
 881
 882   status = FORMAT_VL (name, sizeof (name), vl);
 883   if (status != 0)
 884   {
 885     ERROR ("utils_cache: uc_get_meta: FORMAT_VL failed.");
 886     return (NULL);
 887   }
 888
 889   pthread_mutex_lock (&cache_lock);
 890
 891   status = c_avl_get (cache_tree, name, (void *) &ce);
 892   if (status != 0)
 893   {
 894     pthread_mutex_unlock (&cache_lock);
 895     return (NULL);
 896   }
 897   assert (ce != NULL);
 898
 899   if (ce->meta == NULL)
 900     ce->meta = meta_data_create ();
 901
 902   if (ce->meta == NULL)
 903     pthread_mutex_unlock (&cache_lock);
 904
 905   return (ce->meta);
 906 } /* }}} meta_data_t *uc_get_meta */
 907
 908 /* Sorry about this preprocessor magic, but it really makes this file much
 909  * shorter.. */
 910 #define UC_WRAP(wrap_function) { \
 911   meta_data_t *meta; \
 912   int status; \
 913   meta = uc_get_meta (vl); \
 914   if (meta == NULL) return (-1); \
 915   status = wrap_function (meta, key); \
 916   pthread_mutex_unlock (&cache_lock); \
 917   return (status); \
 918 }
 919 int uc_meta_data_exists (const value_list_t *vl, const char *key)
 920   UC_WRAP (meta_data_exists)
 921
 922 int uc_meta_data_delete (const value_list_t *vl, const char *key)
 923   UC_WRAP (meta_data_delete)
 924 #undef UC_WRAP
 925
 926 /* We need a new version of this macro because the following functions take
 927  * two argumetns. */
 928 #define UC_WRAP(wrap_function) { \
 929   meta_data_t *meta; \
 930   int status; \
 931   meta = uc_get_meta (vl); \
 932   if (meta == NULL) return (-1); \
 933   status = wrap_function (meta, key, value); \
 934   pthread_mutex_unlock (&cache_lock); \
 935   return (status); \
 936 }
 937 int uc_meta_data_add_string (const value_list_t *vl,
 938     const char *key,
 939     const char *value)
 940   UC_WRAP(meta_data_add_string)
 941 int uc_meta_data_add_signed_int (const value_list_t *vl,
 942     const char *key,
 943     int64_t value)
 944   UC_WRAP(meta_data_add_signed_int)
 945 int uc_meta_data_add_unsigned_int (const value_list_t *vl,
 946     const char *key,
 947     uint64_t value)
 948   UC_WRAP(meta_data_add_unsigned_int)
 949 int uc_meta_data_add_double (const value_list_t *vl,
 950     const char *key,
 951     double value)
 952   UC_WRAP(meta_data_add_double)
 953 int uc_meta_data_add_boolean (const value_list_t *vl,
 954     const char *key,
 955     _Bool value)
 956   UC_WRAP(meta_data_add_boolean)
 957
 958 int uc_meta_data_get_string (const value_list_t *vl,
 959     const char *key,
 960     char **value)
 961   UC_WRAP(meta_data_get_string)
 962 int uc_meta_data_get_signed_int (const value_list_t *vl,
 963     const char *key,
 964     int64_t *value)
 965   UC_WRAP(meta_data_get_signed_int)
 966 int uc_meta_data_get_unsigned_int (const value_list_t *vl,
 967     const char *key,
 968     uint64_t *value)
 969   UC_WRAP(meta_data_get_unsigned_int)
 970 int uc_meta_data_get_double (const value_list_t *vl,
 971     const char *key,
 972     double *value)
 973   UC_WRAP(meta_data_get_double)
 974 int uc_meta_data_get_boolean (const value_list_t *vl,
 975     const char *key,
 976     _Bool *value)
 977   UC_WRAP(meta_data_get_boolean)
 978 #undef UC_WRAP
 979
 980 /* vim: set sw=2 ts=8 sts=2 tw=78 : */