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