src/utils_cache.c

   1 /**
   2  * collectd - src/utils_cache.c
   3  * Copyright (C) 2007,2008  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 verplant.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 "utils_threshold.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         counter_t *values_counter;
  38         /* Time contained in the package
  39          * (for calculating rates) */
  40         time_t last_time;
  41         /* Time according to the local clock
  42          * (for purging old entries) */
  43         time_t last_update;
  44         /* Interval in which the data is collected
  45          * (for purding old entries) */
  46         int interval;
  47         int state;
  48 } cache_entry_t;
  49
  50 static c_avl_tree_t   *cache_tree = NULL;
  51 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
  52
  53 static int cache_compare (const cache_entry_t *a, const cache_entry_t *b)
  54 {
  55   assert ((a != NULL) && (b != NULL));
  56   return (strcmp (a->name, b->name));
  57 } /* int cache_compare */
  58
  59 static cache_entry_t *cache_alloc (int values_num)
  60 {
  61   cache_entry_t *ce;
  62
  63   ce = (cache_entry_t *) malloc (sizeof (cache_entry_t));
  64   if (ce == NULL)
  65   {
  66     ERROR ("utils_cache: cache_alloc: malloc failed.");
  67     return (NULL);
  68   }
  69   memset (ce, '\0', sizeof (cache_entry_t));
  70   ce->values_num = values_num;
  71
  72   ce->values_gauge = (gauge_t *) calloc (values_num, sizeof (gauge_t));
  73   ce->values_counter = (counter_t *) calloc (values_num, sizeof (counter_t));
  74   if ((ce->values_gauge == NULL) || (ce->values_counter == NULL))
  75   {
  76     sfree (ce->values_gauge);
  77     sfree (ce->values_counter);
  78     sfree (ce);
  79     ERROR ("utils_cache: cache_alloc: calloc failed.");
  80     return (NULL);
  81   }
  82
  83   return (ce);
  84 } /* cache_entry_t *cache_alloc */
  85
  86 static void cache_free (cache_entry_t *ce)
  87 {
  88   if (ce == NULL)
  89     return;
  90
  91   sfree (ce->values_gauge);
  92   sfree (ce->values_counter);
  93   sfree (ce);
  94 } /* void cache_free */
  95
  96 static int uc_send_notification (const char *name)
  97 {
  98   cache_entry_t *ce = NULL;
  99   int status;
 100
 101   char *name_copy;
 102   char *host;
 103   char *plugin;
 104   char *plugin_instance;
 105   char *type;
 106   char *type_instance;
 107
 108   notification_t n;
 109
 110   name_copy = strdup (name);
 111   if (name_copy == NULL)
 112   {
 113     ERROR ("uc_send_notification: strdup failed.");
 114     return (-1);
 115   }
 116
 117   status = parse_identifier (name_copy, &host,
 118       &plugin, &plugin_instance,
 119       &type, &type_instance);
 120   if (status != 0)
 121   {
 122     ERROR ("uc_send_notification: Cannot parse name `%s'", name);
 123     return (-1);
 124   }
 125
 126   /* Copy the associative members */
 127   notification_init (&n, NOTIF_FAILURE, /* host = */ NULL,
 128       host, plugin, plugin_instance, type, type_instance);
 129
 130   sfree (name_copy);
 131   name_copy = host = plugin = plugin_instance = type = type_instance = NULL;
 132
 133   pthread_mutex_lock (&cache_lock);
 134
 135   /*
 136    * Set the time _after_ getting the lock because we don't know how long
 137    * acquiring the lock takes and we will use this time later to decide
 138    * whether or not the state is OKAY.
 139    */
 140   n.time = time (NULL);
 141
 142   status = c_avl_get (cache_tree, name, (void *) &ce);
 143   if (status != 0)
 144   {
 145     pthread_mutex_unlock (&cache_lock);
 146     sfree (name_copy);
 147     return (-1);
 148   }
 149
 150   /* Check if the entry has been updated in the meantime */
 151   if ((n.time - ce->last_update) < (2 * ce->interval))
 152   {
 153     ce->state = STATE_OKAY;
 154     pthread_mutex_unlock (&cache_lock);
 155     sfree (name_copy);
 156     return (-1);
 157   }
 158
 159   ssnprintf (n.message, sizeof (n.message),
 160       "%s has not been updated for %i seconds.", name,
 161       (int) (n.time - ce->last_update));
 162
 163   pthread_mutex_unlock (&cache_lock);
 164
 165   plugin_dispatch_notification (&n);
 166
 167   return (0);
 168 } /* int uc_send_notification */
 169
 170 static int uc_insert (const data_set_t *ds, const value_list_t *vl,
 171     const char *key)
 172 {
 173   int i;
 174   char *key_copy;
 175   cache_entry_t *ce;
 176
 177   /* `cache_lock' has been locked by `uc_update' */
 178
 179   key_copy = strdup (key);
 180   if (key_copy == NULL)
 181   {
 182     ERROR ("uc_insert: strdup failed.");
 183     return (-1);
 184   }
 185
 186   ce = cache_alloc (ds->ds_num);
 187   if (ce == NULL)
 188   {
 189     sfree (key_copy);
 190     ERROR ("uc_insert: cache_alloc (%i) failed.", ds->ds_num);
 191     return (-1);
 192   }
 193
 194   sstrncpy (ce->name, key, sizeof (ce->name));
 195
 196   for (i = 0; i < ds->ds_num; i++)
 197   {
 198     if (ds->ds[i].type == DS_TYPE_COUNTER)
 199     {
 200       ce->values_gauge[i] = NAN;
 201       ce->values_counter[i] = vl->values[i].counter;
 202     }
 203     else /* if (ds->ds[i].type == DS_TYPE_GAUGE) */
 204     {
 205       ce->values_gauge[i] = vl->values[i].gauge;
 206     }
 207   } /* for (i) */
 208
 209   ce->last_time = vl->time;
 210   ce->last_update = time (NULL);
 211   ce->interval = vl->interval;
 212   ce->state = STATE_OKAY;
 213
 214   if (c_avl_insert (cache_tree, key_copy, ce) != 0)
 215   {
 216     sfree (key_copy);
 217     ERROR ("uc_insert: c_avl_insert failed.");
 218     return (-1);
 219   }
 220
 221   DEBUG ("uc_insert: Added %s to the cache.", key);
 222   return (0);
 223 } /* int uc_insert */
 224
 225 int uc_init (void)
 226 {
 227   if (cache_tree == NULL)
 228     cache_tree = c_avl_create ((int (*) (const void *, const void *))
 229         cache_compare);
 230
 231   return (0);
 232 } /* int uc_init */
 233
 234 int uc_check_timeout (void)
 235 {
 236   time_t now;
 237   cache_entry_t *ce;
 238
 239   char **keys = NULL;
 240   int keys_len = 0;
 241
 242   char *key;
 243   c_avl_iterator_t *iter;
 244   int i;
 245
 246   pthread_mutex_lock (&cache_lock);
 247
 248   now = time (NULL);
 249
 250   /* Build a list of entries to be flushed */
 251   iter = c_avl_get_iterator (cache_tree);
 252   while (c_avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
 253   {
 254     /* If entry has not been updated, add to `keys' array */
 255     if ((now - ce->last_update) >= (2 * ce->interval))
 256     {
 257       char **tmp;
 258
 259       tmp = (char **) realloc ((void *) keys,
 260           (keys_len + 1) * sizeof (char *));
 261       if (tmp == NULL)
 262       {
 263         ERROR ("uc_purge: realloc failed.");
 264         c_avl_iterator_destroy (iter);
 265         pthread_mutex_unlock (&cache_lock);
 266         return (-1);
 267       }
 268
 269       keys = tmp;
 270       keys[keys_len] = strdup (key);
 271       if (keys[keys_len] == NULL)
 272       {
 273         ERROR ("uc_check_timeout: strdup failed.");
 274         continue;
 275       }
 276       keys_len++;
 277     }
 278   } /* while (c_avl_iterator_next) */
 279
 280   for (i = 0; i < keys_len; i++)
 281   {
 282     int status;
 283
 284     status = ut_check_interesting (keys[i]);
 285
 286     if (status < 0)
 287     {
 288       ERROR ("uc_check_timeout: ut_check_interesting failed.");
 289       sfree (keys[i]);
 290     }
 291     else if (status == 0) /* ``service'' is uninteresting */
 292     {
 293       ce = NULL;
 294       DEBUG ("uc_check_timeout: %s is missing but ``uninteresting''",
 295           keys[i]);
 296       status = c_avl_remove (cache_tree, keys[i],
 297           (void *) &key, (void *) &ce);
 298       if (status != 0)
 299       {
 300         ERROR ("uc_check_timeout: c_avl_remove (%s) failed.", keys[i]);
 301       }
 302       sfree (keys[i]);
 303       sfree (key);
 304       cache_free (ce);
 305     }
 306
 307     /* If we get here, the value is ``interesting''. Query the record from the
 308      * cache and update the state field. */
 309     if (c_avl_get (cache_tree, keys[i], (void *) &ce) != 0)
 310     {
 311       ERROR ("uc_check_timeout: cannot get data for %s from cache", keys[i]);
 312       /* Do not free `keys[i]' so a notification is sent further down. */
 313       continue;
 314     }
 315     assert (ce != NULL);
 316
 317     if (status == 2) /* persist */
 318     {
 319       DEBUG ("uc_check_timeout: %s is missing, sending notification.",
 320           keys[i]);
 321       ce->state = STATE_MISSING;
 322     }
 323     else if (status == 1) /* do not persist */
 324     {
 325       if (ce->state == STATE_MISSING)
 326       {
 327         DEBUG ("uc_check_timeout: %s is missing but "
 328             "notification has already been sent.",
 329             keys[i]);
 330         sfree (keys[i]);
 331       }
 332       else /* (ce->state != STATE_MISSING) */
 333       {
 334         DEBUG ("uc_check_timeout: %s is missing, sending one notification.",
 335             keys[i]);
 336         ce->state = STATE_MISSING;
 337       }
 338     }
 339     else
 340     {
 341       WARNING ("uc_check_timeout: ut_check_interesting (%s) returned "
 342           "invalid status %i.",
 343           keys[i], status);
 344     }
 345   } /* for (keys[i]) */
 346
 347   c_avl_iterator_destroy (iter);
 348
 349   pthread_mutex_unlock (&cache_lock);
 350
 351   for (i = 0; i < keys_len; i++)
 352   {
 353     if (keys[i] == NULL)
 354       continue;
 355
 356     uc_send_notification (keys[i]);
 357     sfree (keys[i]);
 358   }
 359
 360   sfree (keys);
 361
 362   return (0);
 363 } /* int uc_check_timeout */
 364
 365 int uc_update (const data_set_t *ds, const value_list_t *vl)
 366 {
 367   char name[6 * DATA_MAX_NAME_LEN];
 368   cache_entry_t *ce = NULL;
 369   int send_okay_notification = 0;
 370   time_t update_delay = 0;
 371   notification_t n;
 372   int status;
 373   int i;
 374
 375   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 376   {
 377     ERROR ("uc_update: FORMAT_VL failed.");
 378     return (-1);
 379   }
 380
 381   pthread_mutex_lock (&cache_lock);
 382
 383   status = c_avl_get (cache_tree, name, (void *) &ce);
 384   if (status != 0) /* entry does not yet exist */
 385   {
 386     status = uc_insert (ds, vl, name);
 387     pthread_mutex_unlock (&cache_lock);
 388     return (status);
 389   }
 390
 391   assert (ce != NULL);
 392   assert (ce->values_num == ds->ds_num);
 393
 394   if (ce->last_time >= vl->time)
 395   {
 396     pthread_mutex_unlock (&cache_lock);
 397     NOTICE ("uc_update: Value too old: name = %s; value time = %u; "
 398         "last cache update = %u;",
 399         name, (unsigned int) vl->time, (unsigned int) ce->last_time);
 400     return (-1);
 401   }
 402
 403   /* Send a notification (after the lock has been released) if we switch the
 404    * state from something else to `okay'. */
 405   if (ce->state == STATE_MISSING)
 406   {
 407     send_okay_notification = 1;
 408     ce->state = STATE_OKAY;
 409     update_delay = time (NULL) - ce->last_update;
 410   }
 411
 412   for (i = 0; i < ds->ds_num; i++)
 413   {
 414     if (ds->ds[i].type == DS_TYPE_COUNTER)
 415     {
 416       counter_t diff;
 417
 418       /* check if the counter has wrapped around */
 419       if (vl->values[i].counter < ce->values_counter[i])
 420       {
 421         if (ce->values_counter[i] <= 4294967295U)
 422           diff = (4294967295U - ce->values_counter[i])
 423             + vl->values[i].counter;
 424         else
 425           diff = (18446744073709551615ULL - ce->values_counter[i])
 426             + vl->values[i].counter;
 427       }
 428       else /* counter has NOT wrapped around */
 429       {
 430         diff = vl->values[i].counter - ce->values_counter[i];
 431       }
 432
 433       ce->values_gauge[i] = ((double) diff)
 434         / ((double) (vl->time - ce->last_time));
 435       ce->values_counter[i] = vl->values[i].counter;
 436     }
 437     else /* if (ds->ds[i].type == DS_TYPE_GAUGE) */
 438     {
 439       ce->values_gauge[i] = vl->values[i].gauge;
 440     }
 441     DEBUG ("uc_update: %s: ds[%i] = %lf", name, i, ce->values_gauge[i]);
 442   } /* for (i) */
 443
 444   ce->last_time = vl->time;
 445   ce->last_update = time (NULL);
 446   ce->interval = vl->interval;
 447
 448   pthread_mutex_unlock (&cache_lock);
 449
 450   if (send_okay_notification == 0)
 451     return (0);
 452
 453   /* Do not send okay notifications for uninteresting values, i. e. values for
 454    * which no threshold is configured. */
 455   status = ut_check_interesting (name);
 456   if (status <= 0)
 457     return (0);
 458
 459   /* Initialize the notification */
 460   memset (&n, '\0', sizeof (n));
 461   NOTIFICATION_INIT_VL (&n, vl, ds);
 462
 463   n.severity = NOTIF_OKAY;
 464   n.time = vl->time;
 465
 466   ssnprintf (n.message, sizeof (n.message),
 467       "Received a value for %s. It was missing for %u seconds.",
 468       name, (unsigned int) update_delay);
 469
 470   plugin_dispatch_notification (&n);
 471
 472   return (0);
 473 } /* int uc_update */
 474
 475 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num)
 476 {
 477   gauge_t *ret = NULL;
 478   size_t ret_num = 0;
 479   cache_entry_t *ce = NULL;
 480   int status = 0;
 481
 482   pthread_mutex_lock (&cache_lock);
 483
 484   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 485   {
 486     assert (ce != NULL);
 487
 488     ret_num = ce->values_num;
 489     ret = (gauge_t *) malloc (ret_num * sizeof (gauge_t));
 490     if (ret == NULL)
 491     {
 492       ERROR ("utils_cache: uc_get_rate_by_name: malloc failed.");
 493       status = -1;
 494     }
 495     else
 496     {
 497       memcpy (ret, ce->values_gauge, ret_num * sizeof (gauge_t));
 498     }
 499   }
 500   else
 501   {
 502     DEBUG ("utils_cache: uc_get_rate_by_name: No such value: %s", name);
 503     status = -1;
 504   }
 505
 506   pthread_mutex_unlock (&cache_lock);
 507
 508   if (status == 0)
 509   {
 510     *ret_values = ret;
 511     *ret_values_num = ret_num;
 512   }
 513
 514   return (status);
 515 } /* gauge_t *uc_get_rate_by_name */
 516
 517 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
 518 {
 519   char name[6 * DATA_MAX_NAME_LEN];
 520   gauge_t *ret = NULL;
 521   size_t ret_num = 0;
 522   int status;
 523
 524   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 525   {
 526     ERROR ("utils_cache: uc_get_rate: FORMAT_VL failed.");
 527     return (NULL);
 528   }
 529
 530   status = uc_get_rate_by_name (name, &ret, &ret_num);
 531   if (status != 0)
 532     return (NULL);
 533
 534   /* This is important - the caller has no other way of knowing how many
 535    * values are returned. */
 536   if (ret_num != (size_t) ds->ds_num)
 537   {
 538     ERROR ("utils_cache: uc_get_rate: ds[%s] has %i values, "
 539         "but uc_get_rate_by_name returned %zu.",
 540         ds->type, ds->ds_num, ret_num);
 541     sfree (ret);
 542     return (NULL);
 543   }
 544
 545   return (ret);
 546 } /* gauge_t *uc_get_rate */
 547
 548 int uc_get_names (char ***ret_names, time_t **ret_times, size_t *ret_number)
 549 {
 550   c_avl_iterator_t *iter;
 551   char *key;
 552   cache_entry_t *value;
 553
 554   char **names = NULL;
 555   time_t *times = NULL;
 556   size_t number = 0;
 557
 558   int status = 0;
 559
 560   if ((ret_names == NULL) || (ret_number == NULL))
 561     return (-1);
 562
 563   pthread_mutex_lock (&cache_lock);
 564
 565   iter = c_avl_get_iterator (cache_tree);
 566   while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
 567   {
 568     char **temp;
 569
 570     if (ret_times != NULL)
 571     {
 572       time_t *tmp_times;
 573
 574       tmp_times = (time_t *) realloc (times, sizeof (time_t) * (number + 1));
 575       if (tmp_times == NULL)
 576       {
 577         status = -1;
 578         break;
 579       }
 580       times = tmp_times;
 581       times[number] = value->last_time;
 582     }
 583
 584     temp = (char **) realloc (names, sizeof (char *) * (number + 1));
 585     if (temp == NULL)
 586     {
 587       status = -1;
 588       break;
 589     }
 590     names = temp;
 591     names[number] = strdup (key);
 592     if (names[number] == NULL)
 593     {
 594       status = -1;
 595       break;
 596     }
 597     number++;
 598   } /* while (c_avl_iterator_next) */
 599
 600   c_avl_iterator_destroy (iter);
 601   pthread_mutex_unlock (&cache_lock);
 602
 603   if (status != 0)
 604   {
 605     size_t i;
 606
 607     for (i = 0; i < number; i++)
 608     {
 609       sfree (names[i]);
 610     }
 611     sfree (names);
 612
 613     return (-1);
 614   }
 615
 616   *ret_names = names;
 617   if (ret_times != NULL)
 618     *ret_times = times;
 619   *ret_number = number;
 620
 621   return (0);
 622 } /* int uc_get_names */
 623
 624 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
 625 {
 626   char name[6 * DATA_MAX_NAME_LEN];
 627   cache_entry_t *ce = NULL;
 628   int ret = STATE_ERROR;
 629
 630   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 631   {
 632     ERROR ("uc_get_state: FORMAT_VL failed.");
 633     return (STATE_ERROR);
 634   }
 635
 636   pthread_mutex_lock (&cache_lock);
 637
 638   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 639   {
 640     assert (ce != NULL);
 641     ret = ce->state;
 642   }
 643
 644   pthread_mutex_unlock (&cache_lock);
 645
 646   return (ret);
 647 } /* int uc_get_state */
 648
 649 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
 650 {
 651   char name[6 * DATA_MAX_NAME_LEN];
 652   cache_entry_t *ce = NULL;
 653   int ret = -1;
 654
 655   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 656   {
 657     ERROR ("uc_get_state: FORMAT_VL failed.");
 658     return (STATE_ERROR);
 659   }
 660
 661   pthread_mutex_lock (&cache_lock);
 662
 663   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 664   {
 665     assert (ce != NULL);
 666     ret = ce->state;
 667     ce->state = state;
 668   }
 669
 670   pthread_mutex_unlock (&cache_lock);
 671
 672   return (ret);
 673 } /* int uc_set_state */
 674 /* vim: set sw=2 ts=8 sts=2 tw=78 : */