src/daemon/utils_cache.c

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