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_check_timeout: realloc failed.");
 264         c_avl_iterator_destroy (iter);
 265         sfree (keys);
 266         pthread_mutex_unlock (&cache_lock);
 267         return (-1);
 268       }
 269
 270       keys = tmp;
 271       keys[keys_len] = strdup (key);
 272       if (keys[keys_len] == NULL)
 273       {
 274         ERROR ("uc_check_timeout: strdup failed.");
 275         continue;
 276       }
 277       keys_len++;
 278     }
 279   } /* while (c_avl_iterator_next) */
 280
 281   ce = NULL;
 282
 283   for (i = 0; i < keys_len; i++)
 284   {
 285     int status;
 286
 287     status = ut_check_interesting (keys[i]);
 288
 289     if (status < 0)
 290     {
 291       ERROR ("uc_check_timeout: ut_check_interesting failed.");
 292       sfree (keys[i]);
 293       continue;
 294     }
 295     else if (status == 0) /* ``service'' is uninteresting */
 296     {
 297       DEBUG ("uc_check_timeout: %s is missing but ``uninteresting''",
 298           keys[i]);
 299       status = c_avl_remove (cache_tree, keys[i],
 300           (void *) &key, (void *) &ce);
 301       if (status != 0)
 302       {
 303         ERROR ("uc_check_timeout: c_avl_remove (%s) failed.", keys[i]);
 304       }
 305       sfree (keys[i]);
 306       sfree (key);
 307       cache_free (ce);
 308       continue;
 309     }
 310
 311     /* If we get here, the value is ``interesting''. Query the record from the
 312      * cache and update the state field. */
 313     if (c_avl_get (cache_tree, keys[i], (void *) &ce) != 0)
 314     {
 315       ERROR ("uc_check_timeout: cannot get data for %s from cache", keys[i]);
 316       /* Do not free `keys[i]' so a notification is sent further down. */
 317       continue;
 318     }
 319     assert (ce != NULL);
 320
 321     if (status == 2) /* persist */
 322     {
 323       DEBUG ("uc_check_timeout: %s is missing, sending notification.",
 324           keys[i]);
 325       ce->state = STATE_MISSING;
 326       /* Do not free `keys[i]' so a notification is sent further down. */
 327     }
 328     else if (status == 1) /* do not persist */
 329     {
 330       if (ce->state == STATE_MISSING)
 331       {
 332         DEBUG ("uc_check_timeout: %s is missing but "
 333             "notification has already been sent.",
 334             keys[i]);
 335         /* Set `keys[i]' to NULL to no notification is sent. */
 336         sfree (keys[i]);
 337       }
 338       else /* (ce->state != STATE_MISSING) */
 339       {
 340         DEBUG ("uc_check_timeout: %s is missing, sending one notification.",
 341             keys[i]);
 342         ce->state = STATE_MISSING;
 343         /* Do not free `keys[i]' so a notification is sent further down. */
 344       }
 345     }
 346     else
 347     {
 348       WARNING ("uc_check_timeout: ut_check_interesting (%s) returned "
 349           "invalid status %i.",
 350           keys[i], status);
 351       sfree (keys[i]);
 352     }
 353
 354     /* Make really sure the next iteration doesn't work with this pointer.
 355      * There have been too many bugs in the past.. :/  -- octo */
 356     ce = NULL;
 357   } /* for (keys[i]) */
 358
 359   c_avl_iterator_destroy (iter);
 360
 361   pthread_mutex_unlock (&cache_lock);
 362
 363   for (i = 0; i < keys_len; i++)
 364   {
 365     if (keys[i] == NULL)
 366       continue;
 367
 368     uc_send_notification (keys[i]);
 369     sfree (keys[i]);
 370   }
 371
 372   sfree (keys);
 373
 374   return (0);
 375 } /* int uc_check_timeout */
 376
 377 int uc_update (const data_set_t *ds, const value_list_t *vl)
 378 {
 379   char name[6 * DATA_MAX_NAME_LEN];
 380   cache_entry_t *ce = NULL;
 381   int send_okay_notification = 0;
 382   time_t update_delay = 0;
 383   notification_t n;
 384   int status;
 385   int i;
 386
 387   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 388   {
 389     ERROR ("uc_update: FORMAT_VL failed.");
 390     return (-1);
 391   }
 392
 393   pthread_mutex_lock (&cache_lock);
 394
 395   status = c_avl_get (cache_tree, name, (void *) &ce);
 396   if (status != 0) /* entry does not yet exist */
 397   {
 398     status = uc_insert (ds, vl, name);
 399     pthread_mutex_unlock (&cache_lock);
 400     return (status);
 401   }
 402
 403   assert (ce != NULL);
 404   assert (ce->values_num == ds->ds_num);
 405
 406   if (ce->last_time >= vl->time)
 407   {
 408     pthread_mutex_unlock (&cache_lock);
 409     NOTICE ("uc_update: Value too old: name = %s; value time = %u; "
 410         "last cache update = %u;",
 411         name, (unsigned int) vl->time, (unsigned int) ce->last_time);
 412     return (-1);
 413   }
 414
 415   /* Send a notification (after the lock has been released) if we switch the
 416    * state from something else to `okay'. */
 417   if (ce->state == STATE_MISSING)
 418   {
 419     send_okay_notification = 1;
 420     ce->state = STATE_OKAY;
 421     update_delay = time (NULL) - ce->last_update;
 422   }
 423
 424   for (i = 0; i < ds->ds_num; i++)
 425   {
 426     if (ds->ds[i].type == DS_TYPE_COUNTER)
 427     {
 428       counter_t diff;
 429
 430       /* check if the counter has wrapped around */
 431       if (vl->values[i].counter < ce->values_counter[i])
 432       {
 433         if (ce->values_counter[i] <= 4294967295U)
 434           diff = (4294967295U - ce->values_counter[i])
 435             + vl->values[i].counter;
 436         else
 437           diff = (18446744073709551615ULL - ce->values_counter[i])
 438             + vl->values[i].counter;
 439       }
 440       else /* counter has NOT wrapped around */
 441       {
 442         diff = vl->values[i].counter - ce->values_counter[i];
 443       }
 444
 445       ce->values_gauge[i] = ((double) diff)
 446         / ((double) (vl->time - ce->last_time));
 447       ce->values_counter[i] = vl->values[i].counter;
 448     }
 449     else /* if (ds->ds[i].type == DS_TYPE_GAUGE) */
 450     {
 451       ce->values_gauge[i] = vl->values[i].gauge;
 452     }
 453     DEBUG ("uc_update: %s: ds[%i] = %lf", name, i, ce->values_gauge[i]);
 454   } /* for (i) */
 455
 456   ce->last_time = vl->time;
 457   ce->last_update = time (NULL);
 458   ce->interval = vl->interval;
 459
 460   pthread_mutex_unlock (&cache_lock);
 461
 462   if (send_okay_notification == 0)
 463     return (0);
 464
 465   /* Do not send okay notifications for uninteresting values, i. e. values for
 466    * which no threshold is configured. */
 467   status = ut_check_interesting (name);
 468   if (status <= 0)
 469     return (0);
 470
 471   /* Initialize the notification */
 472   memset (&n, '\0', sizeof (n));
 473   NOTIFICATION_INIT_VL (&n, vl, ds);
 474
 475   n.severity = NOTIF_OKAY;
 476   n.time = vl->time;
 477
 478   ssnprintf (n.message, sizeof (n.message),
 479       "Received a value for %s. It was missing for %u seconds.",
 480       name, (unsigned int) update_delay);
 481
 482   plugin_dispatch_notification (&n);
 483
 484   return (0);
 485 } /* int uc_update */
 486
 487 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num)
 488 {
 489   gauge_t *ret = NULL;
 490   size_t ret_num = 0;
 491   cache_entry_t *ce = NULL;
 492   int status = 0;
 493
 494   pthread_mutex_lock (&cache_lock);
 495
 496   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 497   {
 498     assert (ce != NULL);
 499
 500     /* remove missing values from getval */
 501     if (ce->state == STATE_MISSING)
 502     {
 503       status = -1;
 504     }
 505     else
 506     {
 507       ret_num = ce->values_num;
 508       ret = (gauge_t *) malloc (ret_num * sizeof (gauge_t));
 509       if (ret == NULL)
 510       {
 511         ERROR ("utils_cache: uc_get_rate_by_name: malloc failed.");
 512         status = -1;
 513       }
 514       else
 515       {
 516         memcpy (ret, ce->values_gauge, ret_num * sizeof (gauge_t));
 517       }
 518     }
 519   }
 520   else
 521   {
 522     DEBUG ("utils_cache: uc_get_rate_by_name: No such value: %s", name);
 523     status = -1;
 524   }
 525
 526   pthread_mutex_unlock (&cache_lock);
 527
 528   if (status == 0)
 529   {
 530     *ret_values = ret;
 531     *ret_values_num = ret_num;
 532   }
 533
 534   return (status);
 535 } /* gauge_t *uc_get_rate_by_name */
 536
 537 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
 538 {
 539   char name[6 * DATA_MAX_NAME_LEN];
 540   gauge_t *ret = NULL;
 541   size_t ret_num = 0;
 542   int status;
 543
 544   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 545   {
 546     ERROR ("utils_cache: uc_get_rate: FORMAT_VL failed.");
 547     return (NULL);
 548   }
 549
 550   status = uc_get_rate_by_name (name, &ret, &ret_num);
 551   if (status != 0)
 552     return (NULL);
 553
 554   /* This is important - the caller has no other way of knowing how many
 555    * values are returned. */
 556   if (ret_num != (size_t) ds->ds_num)
 557   {
 558     ERROR ("utils_cache: uc_get_rate: ds[%s] has %i values, "
 559         "but uc_get_rate_by_name returned %zu.",
 560         ds->type, ds->ds_num, ret_num);
 561     sfree (ret);
 562     return (NULL);
 563   }
 564
 565   return (ret);
 566 } /* gauge_t *uc_get_rate */
 567
 568 int uc_get_names (char ***ret_names, time_t **ret_times, size_t *ret_number)
 569 {
 570   c_avl_iterator_t *iter;
 571   char *key;
 572   cache_entry_t *value;
 573
 574   char **names = NULL;
 575   time_t *times = NULL;
 576   size_t number = 0;
 577
 578   int status = 0;
 579
 580   if ((ret_names == NULL) || (ret_number == NULL))
 581     return (-1);
 582
 583   pthread_mutex_lock (&cache_lock);
 584
 585   iter = c_avl_get_iterator (cache_tree);
 586   while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
 587   {
 588     char **temp;
 589
 590     /* remove missing values when list values */
 591     if (value->state == STATE_MISSING)
 592       continue;
 593
 594     if (ret_times != NULL)
 595     {
 596       time_t *tmp_times;
 597
 598       tmp_times = (time_t *) realloc (times, sizeof (time_t) * (number + 1));
 599       if (tmp_times == NULL)
 600       {
 601         status = -1;
 602         break;
 603       }
 604       times = tmp_times;
 605       times[number] = value->last_time;
 606     }
 607
 608     temp = (char **) realloc (names, sizeof (char *) * (number + 1));
 609     if (temp == NULL)
 610     {
 611       status = -1;
 612       break;
 613     }
 614     names = temp;
 615     names[number] = strdup (key);
 616     if (names[number] == NULL)
 617     {
 618       status = -1;
 619       break;
 620     }
 621     number++;
 622   } /* while (c_avl_iterator_next) */
 623
 624   c_avl_iterator_destroy (iter);
 625   pthread_mutex_unlock (&cache_lock);
 626
 627   if (status != 0)
 628   {
 629     size_t i;
 630
 631     for (i = 0; i < number; i++)
 632     {
 633       sfree (names[i]);
 634     }
 635     sfree (names);
 636
 637     return (-1);
 638   }
 639
 640   *ret_names = names;
 641   if (ret_times != NULL)
 642     *ret_times = times;
 643   *ret_number = number;
 644
 645   return (0);
 646 } /* int uc_get_names */
 647
 648 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
 649 {
 650   char name[6 * DATA_MAX_NAME_LEN];
 651   cache_entry_t *ce = NULL;
 652   int ret = STATE_ERROR;
 653
 654   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 655   {
 656     ERROR ("uc_get_state: FORMAT_VL failed.");
 657     return (STATE_ERROR);
 658   }
 659
 660   pthread_mutex_lock (&cache_lock);
 661
 662   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 663   {
 664     assert (ce != NULL);
 665     ret = ce->state;
 666   }
 667
 668   pthread_mutex_unlock (&cache_lock);
 669
 670   return (ret);
 671 } /* int uc_get_state */
 672
 673 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
 674 {
 675   char name[6 * DATA_MAX_NAME_LEN];
 676   cache_entry_t *ce = NULL;
 677   int ret = -1;
 678
 679   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
 680   {
 681     ERROR ("uc_get_state: FORMAT_VL failed.");
 682     return (STATE_ERROR);
 683   }
 684
 685   pthread_mutex_lock (&cache_lock);
 686
 687   if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
 688   {
 689     assert (ce != NULL);
 690     ret = ce->state;
 691     ce->state = state;
 692   }
 693
 694   pthread_mutex_unlock (&cache_lock);
 695
 696   return (ret);
 697 } /* int uc_set_state */
 698 /* vim: set sw=2 ts=8 sts=2 tw=78 : */