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 **/
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"
29 #include <assert.h>
30 #include <pthread.h>
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;
50 static c_avl_tree_t *cache_tree = NULL;
51 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
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 */
59 static cache_entry_t *cache_alloc (int values_num)
60 {
61 cache_entry_t *ce;
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;
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 }
83 return (ce);
84 } /* cache_entry_t *cache_alloc */
86 static void cache_free (cache_entry_t *ce)
87 {
88 if (ce == NULL)
89 return;
91 sfree (ce->values_gauge);
92 sfree (ce->values_counter);
93 sfree (ce);
94 } /* void cache_free */
96 static int uc_send_notification (const char *name)
97 {
98 cache_entry_t *ce = NULL;
99 int status;
101 char *name_copy;
102 char *host;
103 char *plugin;
104 char *plugin_instance;
105 char *type;
106 char *type_instance;
108 notification_t n;
110 name_copy = strdup (name);
111 if (name_copy == NULL)
112 {
113 ERROR ("uc_send_notification: strdup failed.");
114 return (-1);
115 }
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 }
126 /* Copy the associative members */
127 notification_init (&n, NOTIF_FAILURE, /* host = */ NULL,
128 host, plugin, plugin_instance, type, type_instance);
130 sfree (name_copy);
131 name_copy = host = plugin = plugin_instance = type = type_instance = NULL;
133 pthread_mutex_lock (&cache_lock);
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);
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 }
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 }
159 ssnprintf (n.message, sizeof (n.message),
160 "%s has not been updated for %i seconds.", name,
161 (int) (n.time - ce->last_update));
163 pthread_mutex_unlock (&cache_lock);
165 plugin_dispatch_notification (&n);
167 return (0);
168 } /* int uc_send_notification */
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;
177 /* `cache_lock' has been locked by `uc_update' */
179 key_copy = strdup (key);
180 if (key_copy == NULL)
181 {
182 ERROR ("uc_insert: strdup failed.");
183 return (-1);
184 }
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 }
194 sstrncpy (ce->name, key, sizeof (ce->name));
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) */
209 ce->last_time = vl->time;
210 ce->last_update = time (NULL);
211 ce->interval = vl->interval;
212 ce->state = STATE_OKAY;
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 }
221 DEBUG ("uc_insert: Added %s to the cache.", key);
222 return (0);
223 } /* int uc_insert */
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);
231 return (0);
232 } /* int uc_init */
234 int uc_check_timeout (void)
235 {
236 time_t now;
237 cache_entry_t *ce;
239 char **keys = NULL;
240 int keys_len = 0;
242 char *key;
243 c_avl_iterator_t *iter;
244 int i;
246 pthread_mutex_lock (&cache_lock);
248 now = time (NULL);
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;
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 }
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) */
281 ce = NULL;
283 for (i = 0; i < keys_len; i++)
284 {
285 int status;
287 status = ut_check_interesting (keys[i]);
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 }
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);
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 } /* for (keys[i]) */
354 c_avl_iterator_destroy (iter);
356 pthread_mutex_unlock (&cache_lock);
358 for (i = 0; i < keys_len; i++)
359 {
360 if (keys[i] == NULL)
361 continue;
363 uc_send_notification (keys[i]);
364 sfree (keys[i]);
365 }
367 sfree (keys);
369 return (0);
370 } /* int uc_check_timeout */
372 int uc_update (const data_set_t *ds, const value_list_t *vl)
373 {
374 char name[6 * DATA_MAX_NAME_LEN];
375 cache_entry_t *ce = NULL;
376 int send_okay_notification = 0;
377 time_t update_delay = 0;
378 notification_t n;
379 int status;
380 int i;
382 if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
383 {
384 ERROR ("uc_update: FORMAT_VL failed.");
385 return (-1);
386 }
388 pthread_mutex_lock (&cache_lock);
390 status = c_avl_get (cache_tree, name, (void *) &ce);
391 if (status != 0) /* entry does not yet exist */
392 {
393 status = uc_insert (ds, vl, name);
394 pthread_mutex_unlock (&cache_lock);
395 return (status);
396 }
398 assert (ce != NULL);
399 assert (ce->values_num == ds->ds_num);
401 if (ce->last_time >= vl->time)
402 {
403 pthread_mutex_unlock (&cache_lock);
404 NOTICE ("uc_update: Value too old: name = %s; value time = %u; "
405 "last cache update = %u;",
406 name, (unsigned int) vl->time, (unsigned int) ce->last_time);
407 return (-1);
408 }
410 /* Send a notification (after the lock has been released) if we switch the
411 * state from something else to `okay'. */
412 if (ce->state == STATE_MISSING)
413 {
414 send_okay_notification = 1;
415 ce->state = STATE_OKAY;
416 update_delay = time (NULL) - ce->last_update;
417 }
419 for (i = 0; i < ds->ds_num; i++)
420 {
421 if (ds->ds[i].type == DS_TYPE_COUNTER)
422 {
423 counter_t diff;
425 /* check if the counter has wrapped around */
426 if (vl->values[i].counter < ce->values_counter[i])
427 {
428 if (ce->values_counter[i] <= 4294967295U)
429 diff = (4294967295U - ce->values_counter[i])
430 + vl->values[i].counter;
431 else
432 diff = (18446744073709551615ULL - ce->values_counter[i])
433 + vl->values[i].counter;
434 }
435 else /* counter has NOT wrapped around */
436 {
437 diff = vl->values[i].counter - ce->values_counter[i];
438 }
440 ce->values_gauge[i] = ((double) diff)
441 / ((double) (vl->time - ce->last_time));
442 ce->values_counter[i] = vl->values[i].counter;
443 }
444 else /* if (ds->ds[i].type == DS_TYPE_GAUGE) */
445 {
446 ce->values_gauge[i] = vl->values[i].gauge;
447 }
448 DEBUG ("uc_update: %s: ds[%i] = %lf", name, i, ce->values_gauge[i]);
449 } /* for (i) */
451 ce->last_time = vl->time;
452 ce->last_update = time (NULL);
453 ce->interval = vl->interval;
455 pthread_mutex_unlock (&cache_lock);
457 if (send_okay_notification == 0)
458 return (0);
460 /* Do not send okay notifications for uninteresting values, i. e. values for
461 * which no threshold is configured. */
462 status = ut_check_interesting (name);
463 if (status <= 0)
464 return (0);
466 /* Initialize the notification */
467 memset (&n, '\0', sizeof (n));
468 NOTIFICATION_INIT_VL (&n, vl, ds);
470 n.severity = NOTIF_OKAY;
471 n.time = vl->time;
473 ssnprintf (n.message, sizeof (n.message),
474 "Received a value for %s. It was missing for %u seconds.",
475 name, (unsigned int) update_delay);
477 plugin_dispatch_notification (&n);
479 return (0);
480 } /* int uc_update */
482 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num)
483 {
484 gauge_t *ret = NULL;
485 size_t ret_num = 0;
486 cache_entry_t *ce = NULL;
487 int status = 0;
489 pthread_mutex_lock (&cache_lock);
491 if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
492 {
493 assert (ce != NULL);
495 ret_num = ce->values_num;
496 ret = (gauge_t *) malloc (ret_num * sizeof (gauge_t));
497 if (ret == NULL)
498 {
499 ERROR ("utils_cache: uc_get_rate_by_name: malloc failed.");
500 status = -1;
501 }
502 else
503 {
504 memcpy (ret, ce->values_gauge, ret_num * sizeof (gauge_t));
505 }
506 }
507 else
508 {
509 DEBUG ("utils_cache: uc_get_rate_by_name: No such value: %s", name);
510 status = -1;
511 }
513 pthread_mutex_unlock (&cache_lock);
515 if (status == 0)
516 {
517 *ret_values = ret;
518 *ret_values_num = ret_num;
519 }
521 return (status);
522 } /* gauge_t *uc_get_rate_by_name */
524 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
525 {
526 char name[6 * DATA_MAX_NAME_LEN];
527 gauge_t *ret = NULL;
528 size_t ret_num = 0;
529 int status;
531 if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
532 {
533 ERROR ("utils_cache: uc_get_rate: FORMAT_VL failed.");
534 return (NULL);
535 }
537 status = uc_get_rate_by_name (name, &ret, &ret_num);
538 if (status != 0)
539 return (NULL);
541 /* This is important - the caller has no other way of knowing how many
542 * values are returned. */
543 if (ret_num != (size_t) ds->ds_num)
544 {
545 ERROR ("utils_cache: uc_get_rate: ds[%s] has %i values, "
546 "but uc_get_rate_by_name returned %zu.",
547 ds->type, ds->ds_num, ret_num);
548 sfree (ret);
549 return (NULL);
550 }
552 return (ret);
553 } /* gauge_t *uc_get_rate */
555 int uc_get_names (char ***ret_names, time_t **ret_times, size_t *ret_number)
556 {
557 c_avl_iterator_t *iter;
558 char *key;
559 cache_entry_t *value;
561 char **names = NULL;
562 time_t *times = NULL;
563 size_t number = 0;
565 int status = 0;
567 if ((ret_names == NULL) || (ret_number == NULL))
568 return (-1);
570 pthread_mutex_lock (&cache_lock);
572 iter = c_avl_get_iterator (cache_tree);
573 while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
574 {
575 char **temp;
577 if (ret_times != NULL)
578 {
579 time_t *tmp_times;
581 tmp_times = (time_t *) realloc (times, sizeof (time_t) * (number + 1));
582 if (tmp_times == NULL)
583 {
584 status = -1;
585 break;
586 }
587 times = tmp_times;
588 times[number] = value->last_time;
589 }
591 temp = (char **) realloc (names, sizeof (char *) * (number + 1));
592 if (temp == NULL)
593 {
594 status = -1;
595 break;
596 }
597 names = temp;
598 names[number] = strdup (key);
599 if (names[number] == NULL)
600 {
601 status = -1;
602 break;
603 }
604 number++;
605 } /* while (c_avl_iterator_next) */
607 c_avl_iterator_destroy (iter);
608 pthread_mutex_unlock (&cache_lock);
610 if (status != 0)
611 {
612 size_t i;
614 for (i = 0; i < number; i++)
615 {
616 sfree (names[i]);
617 }
618 sfree (names);
620 return (-1);
621 }
623 *ret_names = names;
624 if (ret_times != NULL)
625 *ret_times = times;
626 *ret_number = number;
628 return (0);
629 } /* int uc_get_names */
631 int uc_get_state (const data_set_t *ds, const value_list_t *vl)
632 {
633 char name[6 * DATA_MAX_NAME_LEN];
634 cache_entry_t *ce = NULL;
635 int ret = STATE_ERROR;
637 if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
638 {
639 ERROR ("uc_get_state: FORMAT_VL failed.");
640 return (STATE_ERROR);
641 }
643 pthread_mutex_lock (&cache_lock);
645 if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
646 {
647 assert (ce != NULL);
648 ret = ce->state;
649 }
651 pthread_mutex_unlock (&cache_lock);
653 return (ret);
654 } /* int uc_get_state */
656 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
657 {
658 char name[6 * DATA_MAX_NAME_LEN];
659 cache_entry_t *ce = NULL;
660 int ret = -1;
662 if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
663 {
664 ERROR ("uc_get_state: FORMAT_VL failed.");
665 return (STATE_ERROR);
666 }
668 pthread_mutex_lock (&cache_lock);
670 if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
671 {
672 assert (ce != NULL);
673 ret = ce->state;
674 ce->state = state;
675 }
677 pthread_mutex_unlock (&cache_lock);
679 return (ret);
680 } /* int uc_set_state */
681 /* vim: set sw=2 ts=8 sts=2 tw=78 : */