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         cache_free (ce);
 196         return (-1);
 197     } /* switch (ds->ds[i].type) */
 198   } /* for (i) */
 199
 200   /* Prune invalid gauge data */
 201   uc_check_range (ds, ce);
 202
 203   ce->last_time = vl->time;
 204   ce->last_update = cdtime ();
 205   ce->interval = vl->interval;
 206   ce->state = STATE_OKAY;
 207
 208   if (c_avl_insert (cache_tree, key_copy, ce) != 0)
 209   {
 210     sfree (key_copy);
 211     ERROR ("uc_insert: c_avl_insert failed.");
 212     return (-1);
 213   }
 214
 215   DEBUG ("uc_insert: Added %s to the cache.", key);
 216   return (0);
 217 } /* int uc_insert */
 218
 219 int uc_init (void)
 220 {
 221   if (cache_tree == NULL)
 222     cache_tree = c_avl_create ((int (*) (const void *, const void *))
 223         cache_compare);
 224
 225   return (0);
 226 } /* int uc_init */
 227
 228 int uc_check_timeout (void)
 229 {
 230   cdtime_t now;
 231   cache_entry_t *ce;
 232
 233   char **keys = NULL;
 234   cdtime_t *keys_time = NULL;
 235   cdtime_t *keys_interval = NULL;
 236   int keys_len = 0;
 237
 238   char *key;
 239   c_avl_iterator_t *iter;
 240
 241   int status;
 242   int i;
 243
 244   pthread_mutex_lock (&cache_lock);
 245
 246   now = cdtime ();
 247
 248   /* Build a list of entries to be flushed */
 249   iter = c_avl_get_iterator (cache_tree);
 250   while (c_avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
 251   {
 252     char **tmp;
 253     cdtime_t *tmp_time;
 254
 255     /* If the entry is fresh enough, continue. */
 256     if ((now - ce->last_update) < (ce->interval * timeout_g))
 257       continue;
 258
 259     /* If entry has not been updated, add to `keys' array */
 260     tmp = (char **) realloc ((void *) keys,
 261         (keys_len + 1) * sizeof (char *));
 262     if (tmp == NULL)
 263     {
 264       ERROR ("uc_check_timeout: realloc failed.");
 265       continue;
 266     }
 267     keys = tmp;
 268
 269     tmp_time = realloc (keys_time, (keys_len + 1) * sizeof (*keys_time));
 270     if (tmp_time == NULL)
 271     {
 272       ERROR ("uc_check_timeout: realloc failed.");
 273       continue;
 274     }
 275     keys_time = tmp_time;
 276
 277     tmp_time = realloc (keys_interval, (keys_len + 1) * sizeof (*keys_interval));
 278     if (tmp_time == NULL)
 279     {
 280       ERROR ("uc_check_timeout: realloc failed.");
 281       continue;
 282     }
 283     keys_interval = tmp_time;
 284
 285     keys[keys_len] = strdup (key);
 286     if (keys[keys_len] == NULL)
 287     {
 288       ERROR ("uc_check_timeout: strdup failed.");
 289       continue;
 290     }
 291     keys_time[keys_len] = ce->last_time;
 292     keys_interval[keys_len] = ce->interval;
 293
 294     keys_len++;
 295   } /* while (c_avl_iterator_next) */
 296
 297   c_avl_iterator_destroy (iter);
 298   pthread_mutex_unlock (&cache_lock);
 299
 300   if (keys_len == 0)
 301   {
 302     /* realloc() may have been called for these. */
 303     sfree (keys);
 304     sfree (keys_time);
 305     sfree (keys_interval);
 306     return (0);
 307   }
 308
 309   /* Call the "missing" callback for each value. Do this before removing the
 310    * value from the cache, so that callbacks can still access the data stored,
 311    * including plugin specific meta data, rates, history, …. This must be done
 312    * without holding the lock, otherwise we will run into a deadlock if a
 313    * plugin calls the cache interface. */
 314   for (i = 0; i < keys_len; i++)
 315   {
 316     value_list_t vl = VALUE_LIST_INIT;
 317
 318     vl.values = NULL;
 319     vl.values_len = 0;
 320     vl.meta = NULL;
 321
 322     status = parse_identifier_vl (keys[i], &vl);
 323     if (status != 0)
 324     {
 325       ERROR ("uc_check_timeout: parse_identifier_vl (\"%s\") failed.", keys[i]);
 326       continue;
 327     }
 328
 329     vl.time = keys_time[i];
 330     vl.interval = keys_interval[i];
 331
 332     plugin_dispatch_missing (&vl);
 333   } /* for (i = 0; i < keys_len; i++) */
 334
 335   /* Now actually remove all the values from the cache. We don't re-evaluate
 336    * the timestamp again, so in theory it is possible we remove a value after
 337    * it is updated here. */
 338   pthread_mutex_lock (&cache_lock);
 339   for (i = 0; i < keys_len; i++)
 340   {
 341     key = NULL;
 342     ce = NULL;
 343
 344     status = c_avl_remove (cache_tree, keys[i],
 345         (void *) &key, (void *) &ce);
 346     if (status != 0)
 347     {
 348       ERROR ("uc_check_timeout: c_avl_remove (\"%s\") failed.", keys[i]);
 349       sfree (keys[i]);
 350       continue;
 351     }
 352
 353     sfree (keys[i]);
 354     sfree (key);
 355     cache_free (ce);
 356   } /* for (i = 0; i < keys_len; i++) */
 357   pthread_mutex_unlock (&cache_lock);
 358
 359   sfree (keys);
 360   sfree (keys_time);
 361   sfree (keys_interval);
 362
 363   return (0);
 364 } /* int uc_check_timeout */
 365
 366 int uc_update (const data_set_t *ds, const value_list_t *vl)
 367 {
 368   char name[6 * DATA_MAX_NAME_LEN];
 369   cache_entry_t *ce = NULL;
 370   int status;
 371   int i;
 372
 373   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 374   {
 375     ERROR ("uc_update: FORMAT_VL failed.");
 376     return (-1);
 377   }
 378
 379   pthread_mutex_lock (&cache_lock);
 380
 381   status = c_avl_get (cache_tree, name, (void *) &ce);
 382   if (status != 0) /* entry does not yet exist */
 383   {
 384     status = uc_insert (ds, vl, name);
 385     pthread_mutex_unlock (&cache_lock);
 386     return (status);
 387   }
 388
 389   assert (ce != NULL);
 390   assert (ce->values_num == ds->ds_num);
 391
 392   if (ce->last_time >= vl->time)
 393   {
 394     pthread_mutex_unlock (&cache_lock);
 395     NOTICE ("uc_update: Value too old: name = %s; value time = %.3f; "
 396         "last cache update = %.3f;",
 397         name,
 398         CDTIME_T_TO_DOUBLE (vl->time),
 399         CDTIME_T_TO_DOUBLE (ce->last_time));
 400     return (-1);
 401   }
 402
 403   for (i = 0; i < ds->ds_num; i++)
 404   {
 405     switch (ds->ds[i].type)
 406     {
 407       case DS_TYPE_COUNTER:
 408         {
 409           counter_t diff;
 410
 411           /* check if the counter has wrapped around */
 412           if (vl->values[i].counter < ce->values_raw[i].counter)
 413           {
 414             if (ce->values_raw[i].counter <= 4294967295U)
 415               diff = (4294967295U - ce->values_raw[i].counter)
 416                 + vl->values[i].counter;
 417             else
 418               diff = (18446744073709551615ULL - ce->values_raw[i].counter)
 419                 + vl->values[i].counter;
 420           }
 421           else /* counter has NOT wrapped around */
 422           {
 423             diff = vl->values[i].counter - ce->values_raw[i].counter;
 424           }
 425
 426           ce->values_gauge[i] = ((double) diff)
 427             / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 428           ce->values_raw[i].counter = vl->values[i].counter;
 429         }
 430         break;
 431
 432       case DS_TYPE_GAUGE:
 433         ce->values_raw[i].gauge = vl->values[i].gauge;
 434         ce->values_gauge[i] = vl->values[i].gauge;
 435         break;
 436
 437       case DS_TYPE_DERIVE:
 438         {
 439           derive_t diff;
 440
 441           diff = vl->values[i].derive - ce->values_raw[i].derive;
 442
 443           ce->values_gauge[i] = ((double) diff)
 444             / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 445           ce->values_raw[i].derive = vl->values[i].derive;
 446         }
 447         break;
 448
 449       case DS_TYPE_ABSOLUTE:
 450         ce->values_gauge[i] = ((double) vl->values[i].absolute)
 451           / (CDTIME_T_TO_DOUBLE (vl->time - ce->last_time));
 452         ce->values_raw[i].absolute = vl->values[i].absolute;
 453         break;
 454
 455       default:
 456         /* This shouldn't happen. */
 457         pthread_mutex_unlock (&cache_lock);
 458         ERROR ("uc_update: Don't know how to handle data source type %i.",
 459             ds->ds[i].type);
 460         return (-1);
 461     } /* switch (ds->ds[i].type) */
 462
 463     DEBUG ("uc_update: %s: ds[%i] = %lf", name, i, ce->values_gauge[i]);
 464   } /* for (i) */
 465
 466   /* Update the history if it exists. */
 467   if (ce->history != NULL)
 468   {
 469     assert (ce->history_index < ce->history_length);
 470     for (i = 0; i < ce->values_num; i++)
 471     {
 472       size_t hist_idx = (ce->values_num * ce->history_index) + i;
 473       ce->history[hist_idx] = ce->values_gauge[i];
 474     }
 475
 476     assert (ce->history_length > 0);
 477     ce->history_index = (ce->history_index + 1) % ce->history_length;
 478   }
 479
 480   /* Prune invalid gauge data */
 481   uc_check_range (ds, ce);
 482
 483   ce->last_time = vl->time;
 484   ce->last_update = cdtime ();
 485   ce->interval = vl->interval;
 486
 487   pthread_mutex_unlock (&cache_lock);
 488
 489   return (0);
 490 } /* int uc_update */
 491
 492 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num)
 493 {
 494   gauge_t *ret = NULL;
 495   size_t ret_num = 0;
 496   cache_entry_t *ce = NULL;
 497   int status = 0;
 498
 499   pthread_mutex_lock (&cache_lock);
 500
 501   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 502   {
 503     assert (ce != NULL);
 504
 505     /* remove missing values from getval */
 506     if (ce->state == STATE_MISSING)
 507     {
 508       status = -1;
 509     }
 510     else
 511     {
 512       ret_num = ce->values_num;
 513       ret = (gauge_t *) malloc (ret_num * sizeof (gauge_t));
 514       if (ret == NULL)
 515       {
 516         ERROR ("utils_cache: uc_get_rate_by_name: malloc failed.");
 517         status = -1;
 518       }
 519       else
 520       {
 521         memcpy (ret, ce->values_gauge, ret_num * sizeof (gauge_t));
 522       }
 523     }
 524   }
 525   else
 526   {
 527     DEBUG ("utils_cache: uc_get_rate_by_name: No such value: %s", name);
 528     status = -1;
 529   }
 530
 531   pthread_mutex_unlock (&cache_lock);
 532
 533   if (status == 0)
 534   {
 535     *ret_values = ret;
 536     *ret_values_num = ret_num;
 537   }
 538
 539   return (status);
 540 } /* gauge_t *uc_get_rate_by_name */
 541
 542 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
 543 {
 544   char name[6 * DATA_MAX_NAME_LEN];
 545   gauge_t *ret = NULL;
 546   size_t ret_num = 0;
 547   int status;
 548
 549   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 550   {
 551     ERROR ("utils_cache: uc_get_rate: FORMAT_VL failed.");
 552     return (NULL);
 553   }
 554
 555   status = uc_get_rate_by_name (name, &ret, &ret_num);
 556   if (status != 0)
 557     return (NULL);
 558
 559   /* This is important - the caller has no other way of knowing how many
 560    * values are returned. */
 561   if (ret_num != (size_t) ds->ds_num)
 562   {
 563     ERROR ("utils_cache: uc_get_rate: ds[%s] has %i values, "
 564         "but uc_get_rate_by_name returned %zu.",
 565         ds->type, ds->ds_num, ret_num);
 566     sfree (ret);
 567     return (NULL);
 568   }
 569
 570   return (ret);
 571 } /* gauge_t *uc_get_rate */
 572
 573 int uc_get_names (char ***ret_names, cdtime_t **ret_times, size_t *ret_number)
 574 {
 575   c_avl_iterator_t *iter;
 576   char *key;
 577   cache_entry_t *value;
 578
 579   char **names = NULL;
 580   cdtime_t *times = NULL;
 581   size_t number = 0;
 582   size_t size_arrays = 0;
 583
 584   int status = 0;
 585
 586   if ((ret_names == NULL) || (ret_number == NULL))
 587     return (-1);
 588
 589   pthread_mutex_lock (&cache_lock);
 590
 591   size_arrays = (size_t) c_avl_size (cache_tree);
 592   if (size_arrays < 1)
 593   {
 594     /* Handle the "no values" case here, to avoid the error message when
 595      * calloc() returns NULL. */
 596     pthread_mutex_unlock (&cache_lock);
 597     return (0);
 598   }
 599
 600   names = calloc (size_arrays, sizeof (*names));
 601   times = calloc (size_arrays, sizeof (*times));
 602   if ((names == NULL) || (times == NULL))
 603   {
 604     ERROR ("uc_get_names: calloc failed.");
 605     sfree (names);
 606     sfree (times);
 607     pthread_mutex_unlock (&cache_lock);
 608     return (ENOMEM);
 609   }
 610
 611   iter = c_avl_get_iterator (cache_tree);
 612   while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
 613   {
 614     /* remove missing values when list values */
 615     if (value->state == STATE_MISSING)
 616       continue;
 617
 618     /* c_avl_size does not return a number smaller than the number of elements
 619      * returned by c_avl_iterator_next. */
 620     assert (number < size_arrays);
 621
 622     if (ret_times != NULL)
 623       times[number] = value->last_time;
 624
 625     names[number] = strdup (key);
 626     if (names[number] == NULL)
 627     {
 628       status = -1;
 629       break;
 630     }
 631
 632     number++;
 633   } /* while (c_avl_iterator_next) */
 634
 635   c_avl_iterator_destroy (iter);
 636   pthread_mutex_unlock (&cache_lock);
 637
 638   if (status != 0)
 639   {
 640     size_t i;
 641
 642     for (i = 0; i < number; i++)
 643     {
 644       sfree (names[i]);
 645     }
 646     sfree (names);
 647     sfree (times);
 648
 649     return (-1);
 650   }
 651
 652   *ret_names = names;
 653   if (ret_times != NULL)
 654     *ret_times = times;
 655   else
 656     sfree (times);
 657   *ret_number = number;
 658
 659   return (0);
 660 } /* int uc_get_names */
 661
 662 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
 663 {
 664   char name[6 * DATA_MAX_NAME_LEN];
 665   cache_entry_t *ce = NULL;
 666   int ret = STATE_ERROR;
 667
 668   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 669   {
 670     ERROR ("uc_get_state: FORMAT_VL failed.");
 671     return (STATE_ERROR);
 672   }
 673
 674   pthread_mutex_lock (&cache_lock);
 675
 676   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 677   {
 678     assert (ce != NULL);
 679     ret = ce->state;
 680   }
 681
 682   pthread_mutex_unlock (&cache_lock);
 683
 684   return (ret);
 685 } /* int uc_get_state */
 686
 687 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
 688 {
 689   char name[6 * DATA_MAX_NAME_LEN];
 690   cache_entry_t *ce = NULL;
 691   int ret = -1;
 692
 693   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 694   {
 695     ERROR ("uc_get_state: FORMAT_VL failed.");
 696     return (STATE_ERROR);
 697   }
 698
 699   pthread_mutex_lock (&cache_lock);
 700
 701   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 702   {
 703     assert (ce != NULL);
 704     ret = ce->state;
 705     ce->state = state;
 706   }
 707
 708   pthread_mutex_unlock (&cache_lock);
 709
 710   return (ret);
 711 } /* int uc_set_state */
 712
 713 int uc_get_history_by_name (const char *name,
 714     gauge_t *ret_history, size_t num_steps, size_t num_ds)
 715 {
 716   cache_entry_t *ce = NULL;
 717   size_t i;
 718   int status = 0;
 719
 720   pthread_mutex_lock (&cache_lock);
 721
 722   status = c_avl_get (cache_tree, name, (void *) &ce);
 723   if (status != 0)
 724   {
 725     pthread_mutex_unlock (&cache_lock);
 726     return (-ENOENT);
 727   }
 728
 729   if (((size_t) ce->values_num) != num_ds)
 730   {
 731     pthread_mutex_unlock (&cache_lock);
 732     return (-EINVAL);
 733   }
 734
 735   /* Check if there are enough values available. If not, increase the buffer
 736    * size. */
 737   if (ce->history_length < num_steps)
 738   {
 739     gauge_t *tmp;
 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 : */