src/utils_cache.c

   1 /**
   2  * collectd - src/utils_cache.c
   3  * Copyright (C) 2007-2010  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28 #include "common.h"
  29 #include "plugin.h"
  30 #include "utils_avltree.h"
  31 #include "utils_cache.h"
  32 #include "meta_data.h"
  33
  34 #include <assert.h>
  35 #include <pthread.h>
  36
  37 typedef struct cache_entry_s
  38 {
  39         char name[6 * DATA_MAX_NAME_LEN];
  40         int        values_num;
  41         gauge_t   *values_gauge;
  42         value_t   *values_raw;
  43         /* Time contained in the package
  44          * (for calculating rates) */
  45         cdtime_t last_time;
  46         /* Time according to the local clock
  47          * (for purging old entries) */
  48         cdtime_t last_update;
  49         /* Interval in which the data is collected
  50          * (for purding old entries) */
  51         cdtime_t interval;
  52         int state;
  53         int hits;
  54
  55         /*
  56          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  57          * !  0  !  1  !  2  !  3  !  4  !  5  !  6  !  7  !  8  ! ...
  58          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  59          * ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ...
  60          * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
  61          * !      t = 0      !      t = 1      !      t = 2      ! ...
  62          * +-----------------+-----------------+-----------------+----
  63          */
  64         gauge_t *history;
  65         size_t   history_index; /* points to the next position to write to. */
  66         size_t   history_length;
  67
  68         meta_data_t *meta;
  69 } cache_entry_t;
  70
  71 static c_avl_tree_t   *cache_tree = NULL;
  72 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
  73
  74 static int cache_compare (const cache_entry_t *a, const cache_entry_t *b)
  75 {
  76 #if COLLECT_DEBUG
  77   assert ((a != NULL) && (b != NULL));
  78 #endif
  79   return (strcmp (a->name, b->name));
  80 } /* int cache_compare */
  81
  82 static cache_entry_t *cache_alloc (int values_num)
  83 {
  84   cache_entry_t *ce;
  85
  86   ce = (cache_entry_t *) malloc (sizeof (cache_entry_t));
  87   if (ce == NULL)
  88   {
  89     ERROR ("utils_cache: cache_alloc: malloc failed.");
  90     return (NULL);
  91   }
  92   memset (ce, '\0', sizeof (cache_entry_t));
  93   ce->values_num = values_num;
  94
  95   ce->values_gauge = calloc (values_num, sizeof (*ce->values_gauge));
  96   ce->values_raw   = calloc (values_num, sizeof (*ce->values_raw));
  97   if ((ce->values_gauge == NULL) || (ce->values_raw == NULL))
  98   {
  99     sfree (ce->values_gauge);
 100     sfree (ce->values_raw);
 101     sfree (ce);
 102     ERROR ("utils_cache: cache_alloc: calloc failed.");
 103     return (NULL);
 104   }
 105
 106   ce->history = NULL;
 107   ce->history_length = 0;
 108   ce->meta = NULL;
 109
 110   return (ce);
 111 } /* cache_entry_t *cache_alloc */
 112
 113 static void cache_free (cache_entry_t *ce)
 114 {
 115   if (ce == NULL)
 116     return;
 117
 118   sfree (ce->values_gauge);
 119   sfree (ce->values_raw);
 120   sfree (ce->history);
 121   if (ce->meta != NULL)
 122   {
 123     meta_data_destroy (ce->meta);
 124     ce->meta = NULL;
 125   }
 126   sfree (ce);
 127 } /* void cache_free */
 128
 129 static void uc_check_range (const data_set_t *ds, cache_entry_t *ce)
 130 {
 131   int i;
 132
 133   for (i = 0; i < ds->ds_num; i++)
 134   {
 135     if (isnan (ce->values_gauge[i]))
 136       continue;
 137     else if (ce->values_gauge[i] < ds->ds[i].min)
 138       ce->values_gauge[i] = NAN;
 139     else if (ce->values_gauge[i] > ds->ds[i].max)
 140       ce->values_gauge[i] = NAN;
 141   }
 142 } /* void uc_check_range */
 143
 144 static int uc_insert (const data_set_t *ds, const value_list_t *vl,
 145     const char *key)
 146 {
 147   int i;
 148   char *key_copy;
 149   cache_entry_t *ce;
 150
 151   /* `cache_lock' has been locked by `uc_update' */
 152
 153   key_copy = strdup (key);
 154   if (key_copy == NULL)
 155   {
 156     ERROR ("uc_insert: strdup failed.");
 157     return (-1);
 158   }
 159
 160   ce = cache_alloc (ds->ds_num);
 161   if (ce == NULL)
 162   {
 163     sfree (key_copy);
 164     ERROR ("uc_insert: cache_alloc (%i) failed.", ds->ds_num);
 165     return (-1);
 166   }
 167
 168   sstrncpy (ce->name, key, sizeof (ce->name));
 169
 170   for (i = 0; i < ds->ds_num; i++)
 171   {
 172     switch (ds->ds[i].type)
 173     {
 174       case DS_TYPE_COUNTER:
 175         ce->values_gauge[i] = NAN;
 176         ce->values_raw[i].counter = vl->values[i].counter;
 177         break;
 178
 179       case DS_TYPE_GAUGE:
 180         ce->values_gauge[i] = vl->values[i].gauge;
 181         ce->values_raw[i].gauge = vl->values[i].gauge;
 182         break;
 183
 184       case DS_TYPE_DERIVE:
 185         ce->values_gauge[i] = NAN;
 186         ce->values_raw[i].derive = vl->values[i].derive;
 187         break;
 188
 189       case DS_TYPE_ABSOLUTE:
 190         ce->values_gauge[i] = NAN;
 191         if (vl->interval > 0)
 192           ce->values_gauge[i] = ((double) vl->values[i].absolute)
 193             / CDTIME_T_TO_DOUBLE (vl->interval);
 194         ce->values_raw[i].absolute = vl->values[i].absolute;
 195         break;
 196
 197       default:
 198         /* This shouldn't happen. */
 199         ERROR ("uc_insert: Don't know how to handle data source type %i.",
 200             ds->ds[i].type);
 201         return (-1);
 202     } /* switch (ds->ds[i].type) */
 203   } /* for (i) */
 204
 205   /* Prune invalid gauge data */
 206   uc_check_range (ds, ce);
 207
 208   ce->last_time = vl->time;
 209   ce->last_update = cdtime ();
 210   ce->interval = vl->interval;
 211   ce->state = STATE_OKAY;
 212
 213   if (c_avl_insert (cache_tree, key_copy, ce) != 0)
 214   {
 215     sfree (key_copy);
 216     ERROR ("uc_insert: c_avl_insert failed.");
 217     return (-1);
 218   }
 219
 220   DEBUG ("uc_insert: Added %s to the cache.", key);
 221   return (0);
 222 } /* int uc_insert */
 223
 224 int uc_init (void)
 225 {
 226   if (cache_tree == NULL)
 227     cache_tree = c_avl_create ((int (*) (const void *, const void *))
 228         cache_compare);
 229
 230   return (0);
 231 } /* int uc_init */
 232
 233 int uc_check_timeout (void)
 234 {
 235   cdtime_t now;
 236   cache_entry_t *ce;
 237
 238   char **keys = NULL;
 239   cdtime_t *keys_time = NULL;
 240   cdtime_t *keys_interval = NULL;
 241   int keys_len = 0;
 242
 243   char *key;
 244   c_avl_iterator_t *iter;
 245
 246   int status;
 247   int i;
 248
 249   pthread_mutex_lock (&cache_lock);
 250
 251   now = cdtime ();
 252
 253   /* Build a list of entries to be flushed */
 254   iter = c_avl_get_iterator (cache_tree);
 255   while (c_avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
 256   {
 257     char **tmp;
 258     cdtime_t *tmp_time;
 259
 260     /* If the entry is fresh enough, continue. */
 261     if ((now - ce->last_update) < (ce->interval * timeout_g))
 262       continue;
 263
 264     /* If entry has not been updated, add to `keys' array */
 265     tmp = (char **) realloc ((void *) keys,
 266         (keys_len + 1) * sizeof (char *));
 267     if (tmp == NULL)
 268     {
 269       ERROR ("uc_check_timeout: realloc failed.");
 270       continue;
 271     }
 272     keys = tmp;
 273
 274     tmp_time = realloc (keys_time, (keys_len + 1) * sizeof (*keys_time));
 275     if (tmp_time == NULL)
 276     {
 277       ERROR ("uc_check_timeout: realloc failed.");
 278       continue;
 279     }
 280     keys_time = tmp_time;
 281
 282     tmp_time = realloc (keys_interval, (keys_len + 1) * sizeof (*keys_interval));
 283     if (tmp_time == NULL)
 284     {
 285       ERROR ("uc_check_timeout: realloc failed.");
 286       continue;
 287     }
 288     keys_interval = tmp_time;
 289
 290     keys[keys_len] = strdup (key);
 291     if (keys[keys_len] == NULL)
 292     {
 293       ERROR ("uc_check_timeout: strdup failed.");
 294       continue;
 295     }
 296     keys_time[keys_len] = ce->last_time;
 297     keys_interval[keys_len] = ce->interval;
 298
 299     keys_len++;
 300   } /* while (c_avl_iterator_next) */
 301
 302   c_avl_iterator_destroy (iter);
 303   pthread_mutex_unlock (&cache_lock);
 304
 305   if (keys_len == 0)
 306     return (0);
 307
 308   /* Call the "missing" callback for each value. Do this before removing the
 309    * value from the cache, so that callbacks can still access the data stored,
 310    * including plugin specific meta data, rates, history, …. This must be done
 311    * without holding the lock, otherwise we will run into a deadlock if a
 312    * plugin calls the cache interface. */
 313   for (i = 0; i < keys_len; i++)
 314   {
 315     value_list_t vl = VALUE_LIST_INIT;
 316
 317     vl.values = NULL;
 318     vl.values_len = 0;
 319     vl.meta = NULL;
 320
 321     status = parse_identifier_vl (keys[i], &vl);
 322     if (status != 0)
 323     {
 324       ERROR ("uc_check_timeout: parse_identifier_vl (\"%s\") failed.", keys[i]);
 325       cache_free (ce);
 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
 648     return (-1);
 649   }
 650
 651   *ret_names = names;
 652   if (ret_times != NULL)
 653     *ret_times = times;
 654   *ret_number = number;
 655
 656   return (0);
 657 } /* int uc_get_names */
 658
 659 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
 660 {
 661   char name[6 * DATA_MAX_NAME_LEN];
 662   cache_entry_t *ce = NULL;
 663   int ret = STATE_ERROR;
 664
 665   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 666   {
 667     ERROR ("uc_get_state: FORMAT_VL failed.");
 668     return (STATE_ERROR);
 669   }
 670
 671   pthread_mutex_lock (&cache_lock);
 672
 673   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 674   {
 675     assert (ce != NULL);
 676     ret = ce->state;
 677   }
 678
 679   pthread_mutex_unlock (&cache_lock);
 680
 681   return (ret);
 682 } /* int uc_get_state */
 683
 684 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
 685 {
 686   char name[6 * DATA_MAX_NAME_LEN];
 687   cache_entry_t *ce = NULL;
 688   int ret = -1;
 689
 690   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 691   {
 692     ERROR ("uc_get_state: FORMAT_VL failed.");
 693     return (STATE_ERROR);
 694   }
 695
 696   pthread_mutex_lock (&cache_lock);
 697
 698   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 699   {
 700     assert (ce != NULL);
 701     ret = ce->state;
 702     ce->state = state;
 703   }
 704
 705   pthread_mutex_unlock (&cache_lock);
 706
 707   return (ret);
 708 } /* int uc_set_state */
 709
 710 int uc_get_history_by_name (const char *name,
 711     gauge_t *ret_history, size_t num_steps, size_t num_ds)
 712 {
 713   cache_entry_t *ce = NULL;
 714   size_t i;
 715   int status = 0;
 716
 717   pthread_mutex_lock (&cache_lock);
 718
 719   status = c_avl_get (cache_tree, name, (void *) &ce);
 720   if (status != 0)
 721   {
 722     pthread_mutex_unlock (&cache_lock);
 723     return (-ENOENT);
 724   }
 725
 726   if (((size_t) ce->values_num) != num_ds)
 727   {
 728     pthread_mutex_unlock (&cache_lock);
 729     return (-EINVAL);
 730   }
 731
 732   /* Check if there are enough values available. If not, increase the buffer
 733    * size. */
 734   if (ce->history_length < num_steps)
 735   {
 736     gauge_t *tmp;
 737     size_t i;
 738
 739     tmp = realloc (ce->history, sizeof (*ce->history)
 740         * num_steps * ce->values_num);
 741     if (tmp == NULL)
 742     {
 743       pthread_mutex_unlock (&cache_lock);
 744       return (-ENOMEM);
 745     }
 746
 747     for (i = ce->history_length * ce->values_num;
 748         i < (num_steps * ce->values_num);
 749         i++)
 750       tmp[i] = NAN;
 751
 752     ce->history = tmp;
 753     ce->history_length = num_steps;
 754   } /* if (ce->history_length < num_steps) */
 755
 756   /* Copy the values to the output buffer. */
 757   for (i = 0; i < num_steps; i++)
 758   {
 759     size_t src_index;
 760     size_t dst_index;
 761
 762     if (i < ce->history_index)
 763       src_index = ce->history_index - (i + 1);
 764     else
 765       src_index = ce->history_length + ce->history_index - (i + 1);
 766     src_index = src_index * num_ds;
 767
 768     dst_index = i * num_ds;
 769
 770     memcpy (ret_history + dst_index, ce->history + src_index,
 771         sizeof (*ret_history) * num_ds);
 772   }
 773
 774   pthread_mutex_unlock (&cache_lock);
 775
 776   return (0);
 777 } /* int uc_get_history_by_name */
 778
 779 int uc_get_history (const data_set_t *ds, const value_list_t *vl,
 780     gauge_t *ret_history, size_t num_steps, size_t num_ds)
 781 {
 782   char name[6 * DATA_MAX_NAME_LEN];
 783
 784   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 785   {
 786     ERROR ("utils_cache: uc_get_history: FORMAT_VL failed.");
 787     return (-1);
 788   }
 789
 790   return (uc_get_history_by_name (name, ret_history, num_steps, num_ds));
 791 } /* int uc_get_history */
 792
 793 int uc_get_hits (const data_set_t *ds, const value_list_t *vl)
 794 {
 795   char name[6 * DATA_MAX_NAME_LEN];
 796   cache_entry_t *ce = NULL;
 797   int ret = STATE_ERROR;
 798
 799   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 800   {
 801     ERROR ("uc_get_state: FORMAT_VL failed.");
 802     return (STATE_ERROR);
 803   }
 804
 805   pthread_mutex_lock (&cache_lock);
 806
 807   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 808   {
 809     assert (ce != NULL);
 810     ret = ce->hits;
 811   }
 812
 813   pthread_mutex_unlock (&cache_lock);
 814
 815   return (ret);
 816 } /* int uc_get_hits */
 817
 818 int uc_set_hits (const data_set_t *ds, const value_list_t *vl, int hits)
 819 {
 820   char name[6 * DATA_MAX_NAME_LEN];
 821   cache_entry_t *ce = NULL;
 822   int ret = -1;
 823
 824   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 825   {
 826     ERROR ("uc_get_state: FORMAT_VL failed.");
 827     return (STATE_ERROR);
 828   }
 829
 830   pthread_mutex_lock (&cache_lock);
 831
 832   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 833   {
 834     assert (ce != NULL);
 835     ret = ce->hits;
 836     ce->hits = hits;
 837   }
 838
 839   pthread_mutex_unlock (&cache_lock);
 840
 841   return (ret);
 842 } /* int uc_set_hits */
 843
 844 int uc_inc_hits (const data_set_t *ds, const value_list_t *vl, int step)
 845 {
 846   char name[6 * DATA_MAX_NAME_LEN];
 847   cache_entry_t *ce = NULL;
 848   int ret = -1;
 849
 850   if (FORMAT_VL (name, sizeof (name), vl) != 0)
 851   {
 852     ERROR ("uc_get_state: FORMAT_VL failed.");
 853     return (STATE_ERROR);
 854   }
 855
 856   pthread_mutex_lock (&cache_lock);
 857
 858   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 859   {
 860     assert (ce != NULL);
 861     ret = ce->hits;
 862     ce->hits = ret + step;
 863   }
 864
 865   pthread_mutex_unlock (&cache_lock);
 866
 867   return (ret);
 868 } /* int uc_inc_hits */
 869
 870 /*
 871  * Meta data interface
 872  */
 873 /* XXX: This function will acquire `cache_lock' but will not free it! */
 874 static meta_data_t *uc_get_meta (const value_list_t *vl) /* {{{ */
 875 {
 876   char name[6 * DATA_MAX_NAME_LEN];
 877   cache_entry_t *ce = NULL;
 878   int status;
 879
 880   status = FORMAT_VL (name, sizeof (name), vl);
 881   if (status != 0)
 882   {
 883     ERROR ("utils_cache: uc_get_meta: FORMAT_VL failed.");
 884     return (NULL);
 885   }
 886
 887   pthread_mutex_lock (&cache_lock);
 888
 889   status = c_avl_get (cache_tree, name, (void *) &ce);
 890   if (status != 0)
 891   {
 892     pthread_mutex_unlock (&cache_lock);
 893     return (NULL);
 894   }
 895   assert (ce != NULL);
 896
 897   if (ce->meta == NULL)
 898     ce->meta = meta_data_create ();
 899
 900   if (ce->meta == NULL)
 901     pthread_mutex_unlock (&cache_lock);
 902
 903   return (ce->meta);
 904 } /* }}} meta_data_t *uc_get_meta */
 905
 906 /* Sorry about this preprocessor magic, but it really makes this file much
 907  * shorter.. */
 908 #define UC_WRAP(wrap_function) { \
 909   meta_data_t *meta; \
 910   int status; \
 911   meta = uc_get_meta (vl); \
 912   if (meta == NULL) return (-1); \
 913   status = wrap_function (meta, key); \
 914   pthread_mutex_unlock (&cache_lock); \
 915   return (status); \
 916 }
 917 int uc_meta_data_exists (const value_list_t *vl, const char *key)
 918   UC_WRAP (meta_data_exists)
 919
 920 int uc_meta_data_delete (const value_list_t *vl, const char *key)
 921   UC_WRAP (meta_data_delete)
 922 #undef UC_WRAP
 923
 924 /* We need a new version of this macro because the following functions take
 925  * two argumetns. */
 926 #define UC_WRAP(wrap_function) { \
 927   meta_data_t *meta; \
 928   int status; \
 929   meta = uc_get_meta (vl); \
 930   if (meta == NULL) return (-1); \
 931   status = wrap_function (meta, key, value); \
 932   pthread_mutex_unlock (&cache_lock); \
 933   return (status); \
 934 }
 935 int uc_meta_data_add_string (const value_list_t *vl,
 936     const char *key,
 937     const char *value)
 938   UC_WRAP(meta_data_add_string)
 939 int uc_meta_data_add_signed_int (const value_list_t *vl,
 940     const char *key,
 941     int64_t value)
 942   UC_WRAP(meta_data_add_signed_int)
 943 int uc_meta_data_add_unsigned_int (const value_list_t *vl,
 944     const char *key,
 945     uint64_t value)
 946   UC_WRAP(meta_data_add_unsigned_int)
 947 int uc_meta_data_add_double (const value_list_t *vl,
 948     const char *key,
 949     double value)
 950   UC_WRAP(meta_data_add_double)
 951 int uc_meta_data_add_boolean (const value_list_t *vl,
 952     const char *key,
 953     _Bool value)
 954   UC_WRAP(meta_data_add_boolean)
 955
 956 int uc_meta_data_get_string (const value_list_t *vl,
 957     const char *key,
 958     char **value)
 959   UC_WRAP(meta_data_get_string)
 960 int uc_meta_data_get_signed_int (const value_list_t *vl,
 961     const char *key,
 962     int64_t *value)
 963   UC_WRAP(meta_data_get_signed_int)
 964 int uc_meta_data_get_unsigned_int (const value_list_t *vl,
 965     const char *key,
 966     uint64_t *value)
 967   UC_WRAP(meta_data_get_unsigned_int)
 968 int uc_meta_data_get_double (const value_list_t *vl,
 969     const char *key,
 970     double *value)
 971   UC_WRAP(meta_data_get_double)
 972 int uc_meta_data_get_boolean (const value_list_t *vl,
 973     const char *key,
 974     _Bool *value)
 975   UC_WRAP(meta_data_get_boolean)
 976 #undef UC_WRAP
 977
 978 /* vim: set sw=2 ts=8 sts=2 tw=78 : */