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