2 * collectd - src/utils_cache.c
3 * Copyright (C) 2007-2010 Florian octo Forster
4 * Copyright (C) 2016 Sebastian tokkee Harl
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Florian octo Forster <octo at collectd.org>
26 * Sebastian tokkee Harl <sh at tokkee.org>
32 #include "utils/avltree/avltree.h"
33 #include "utils/common/common.h"
34 #include "utils/metadata/meta_data.h"
35 #include "utils_cache.h"
39 typedef struct cache_entry_s {
40 char name[6 * DATA_MAX_NAME_LEN];
42 gauge_t *values_gauge;
44 /* Time contained in the package
45 * (for calculating rates) */
47 /* Time according to the local clock
48 * (for purging old entries) */
50 /* Interval in which the data is collected
51 * (for purging old entries) */
57 * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
58 * ! 0 ! 1 ! 2 ! 3 ! 4 ! 5 ! 6 ! 7 ! 8 ! ...
59 * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
60 * ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ds0 ! ds1 ! ds2 ! ...
61 * +-----+-----+-----+-----+-----+-----+-----+-----+-----+----
62 * ! t = 0 ! t = 1 ! t = 2 ! ...
63 * +-----------------+-----------------+-----------------+----
66 size_t history_index; /* points to the next position to write to. */
67 size_t history_length;
70 unsigned long callbacks_mask;
74 c_avl_iterator_t *iter;
80 static c_avl_tree_t *cache_tree;
81 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
83 static int cache_compare(const cache_entry_t *a, const cache_entry_t *b) {
85 assert((a != NULL) && (b != NULL));
87 return strcmp(a->name, b->name);
88 } /* int cache_compare */
90 static cache_entry_t *cache_alloc(size_t values_num) {
93 ce = calloc(1, sizeof(*ce));
95 ERROR("utils_cache: cache_alloc: calloc failed.");
98 ce->values_num = values_num;
100 ce->values_gauge = calloc(values_num, sizeof(*ce->values_gauge));
101 ce->values_raw = calloc(values_num, sizeof(*ce->values_raw));
102 if ((ce->values_gauge == NULL) || (ce->values_raw == NULL)) {
103 sfree(ce->values_gauge);
104 sfree(ce->values_raw);
106 ERROR("utils_cache: cache_alloc: calloc failed.");
111 ce->history_length = 0;
115 } /* cache_entry_t *cache_alloc */
117 static void cache_free(cache_entry_t *ce) {
121 sfree(ce->values_gauge);
122 sfree(ce->values_raw);
124 if (ce->meta != NULL) {
125 meta_data_destroy(ce->meta);
129 } /* void cache_free */
131 static void uc_check_range(const data_set_t *ds, cache_entry_t *ce) {
132 for (size_t i = 0; i < ds->ds_num; i++) {
133 if (isnan(ce->values_gauge[i]))
135 else if (ce->values_gauge[i] < ds->ds[i].min)
136 ce->values_gauge[i] = NAN;
137 else if (ce->values_gauge[i] > ds->ds[i].max)
138 ce->values_gauge[i] = NAN;
140 } /* void uc_check_range */
142 static int uc_insert(const data_set_t *ds, const value_list_t *vl,
144 /* `cache_lock' has been locked by `uc_update' */
146 char *key_copy = strdup(key);
147 if (key_copy == NULL) {
148 ERROR("uc_insert: strdup failed.");
152 cache_entry_t *ce = cache_alloc(ds->ds_num);
155 ERROR("uc_insert: cache_alloc (%" PRIsz ") failed.", ds->ds_num);
159 sstrncpy(ce->name, key, sizeof(ce->name));
161 for (size_t i = 0; i < ds->ds_num; i++) {
162 switch (ds->ds[i].type) {
163 case DS_TYPE_COUNTER:
164 ce->values_gauge[i] = NAN;
165 ce->values_raw[i].counter = vl->values[i].counter;
169 ce->values_gauge[i] = vl->values[i].gauge;
170 ce->values_raw[i].gauge = vl->values[i].gauge;
174 ce->values_gauge[i] = NAN;
175 ce->values_raw[i].derive = vl->values[i].derive;
178 case DS_TYPE_ABSOLUTE:
179 ce->values_gauge[i] = NAN;
180 if (vl->interval > 0)
181 ce->values_gauge[i] =
182 ((double)vl->values[i].absolute) / CDTIME_T_TO_DOUBLE(vl->interval);
183 ce->values_raw[i].absolute = vl->values[i].absolute;
187 /* This shouldn't happen. */
188 ERROR("uc_insert: Don't know how to handle data source type %i.",
193 } /* switch (ds->ds[i].type) */
196 /* Prune invalid gauge data */
197 uc_check_range(ds, ce);
199 ce->last_time = vl->time;
200 ce->last_update = cdtime();
201 ce->interval = vl->interval;
202 ce->state = STATE_UNKNOWN;
204 if (vl->meta != NULL) {
205 ce->meta = meta_data_clone(vl->meta);
208 if (c_avl_insert(cache_tree, key_copy, ce) != 0) {
210 ERROR("uc_insert: c_avl_insert failed.");
214 DEBUG("uc_insert: Added %s to the cache.", key);
216 } /* int uc_insert */
219 if (cache_tree == NULL)
221 c_avl_create((int (*)(const void *, const void *))cache_compare);
226 int uc_check_timeout(void) {
231 unsigned long callbacks_mask;
233 size_t expired_num = 0;
235 pthread_mutex_lock(&cache_lock);
236 cdtime_t now = cdtime();
238 /* Build a list of entries to be flushed */
239 c_avl_iterator_t *iter = c_avl_get_iterator(cache_tree);
241 cache_entry_t *ce = NULL;
242 while (c_avl_iterator_next(iter, (void *)&key, (void *)&ce) == 0) {
243 /* If the entry is fresh enough, continue. */
244 if ((now - ce->last_update) < (ce->interval * timeout_g))
247 void *tmp = realloc(expired, (expired_num + 1) * sizeof(*expired));
249 ERROR("uc_check_timeout: realloc failed.");
254 expired[expired_num].key = strdup(key);
255 expired[expired_num].time = ce->last_time;
256 expired[expired_num].interval = ce->interval;
257 expired[expired_num].callbacks_mask = ce->callbacks_mask;
259 if (expired[expired_num].key == NULL) {
260 ERROR("uc_check_timeout: strdup failed.");
265 } /* while (c_avl_iterator_next) */
267 c_avl_iterator_destroy(iter);
268 pthread_mutex_unlock(&cache_lock);
270 if (expired_num == 0) {
275 /* Call the "missing" callback for each value. Do this before removing the
276 * value from the cache, so that callbacks can still access the data stored,
277 * including plugin specific meta data, rates, history, …. This must be done
278 * without holding the lock, otherwise we will run into a deadlock if a
279 * plugin calls the cache interface. */
280 for (size_t i = 0; i < expired_num; i++) {
282 .time = expired[i].time,
283 .interval = expired[i].interval,
286 if (parse_identifier_vl(expired[i].key, &vl) != 0) {
287 ERROR("uc_check_timeout: parse_identifier_vl (\"%s\") failed.",
292 plugin_dispatch_missing(&vl);
294 if (expired[i].callbacks_mask)
295 plugin_dispatch_cache_event(CE_VALUE_EXPIRED, expired[i].callbacks_mask,
296 expired[i].key, &vl);
297 } /* for (i = 0; i < expired_num; i++) */
299 /* Now actually remove all the values from the cache. We don't re-evaluate
300 * the timestamp again, so in theory it is possible we remove a value after
301 * it is updated here. */
302 pthread_mutex_lock(&cache_lock);
303 for (size_t i = 0; i < expired_num; i++) {
305 cache_entry_t *value = NULL;
307 if (c_avl_remove(cache_tree, expired[i].key, (void *)&key,
308 (void *)&value) != 0) {
309 ERROR("uc_check_timeout: c_avl_remove (\"%s\") failed.", expired[i].key);
310 sfree(expired[i].key);
316 sfree(expired[i].key);
317 } /* for (i = 0; i < expired_num; i++) */
318 pthread_mutex_unlock(&cache_lock);
322 } /* int uc_check_timeout */
324 int uc_update(const data_set_t *ds, const value_list_t *vl) {
325 char name[6 * DATA_MAX_NAME_LEN];
327 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
328 ERROR("uc_update: FORMAT_VL failed.");
332 pthread_mutex_lock(&cache_lock);
334 cache_entry_t *ce = NULL;
335 int status = c_avl_get(cache_tree, name, (void *)&ce);
336 if (status != 0) /* entry does not yet exist */
338 status = uc_insert(ds, vl, name);
339 pthread_mutex_unlock(&cache_lock);
342 plugin_dispatch_cache_event(CE_VALUE_NEW, 0 /* mask */, name, vl);
348 assert(ce->values_num == ds->ds_num);
350 if (ce->last_time >= vl->time) {
351 pthread_mutex_unlock(&cache_lock);
352 NOTICE("uc_update: Value too old: name = %s; value time = %.3f; "
353 "last cache update = %.3f;",
354 name, CDTIME_T_TO_DOUBLE(vl->time),
355 CDTIME_T_TO_DOUBLE(ce->last_time));
359 for (size_t i = 0; i < ds->ds_num; i++) {
360 switch (ds->ds[i].type) {
361 case DS_TYPE_COUNTER: {
363 counter_diff(ce->values_raw[i].counter, vl->values[i].counter);
364 ce->values_gauge[i] =
365 ((double)diff) / (CDTIME_T_TO_DOUBLE(vl->time - ce->last_time));
366 ce->values_raw[i].counter = vl->values[i].counter;
370 ce->values_raw[i].gauge = vl->values[i].gauge;
371 ce->values_gauge[i] = vl->values[i].gauge;
374 case DS_TYPE_DERIVE: {
375 derive_t diff = vl->values[i].derive - ce->values_raw[i].derive;
377 ce->values_gauge[i] =
378 ((double)diff) / (CDTIME_T_TO_DOUBLE(vl->time - ce->last_time));
379 ce->values_raw[i].derive = vl->values[i].derive;
382 case DS_TYPE_ABSOLUTE:
383 ce->values_gauge[i] = ((double)vl->values[i].absolute) /
384 (CDTIME_T_TO_DOUBLE(vl->time - ce->last_time));
385 ce->values_raw[i].absolute = vl->values[i].absolute;
389 /* This shouldn't happen. */
390 pthread_mutex_unlock(&cache_lock);
391 ERROR("uc_update: Don't know how to handle data source type %i.",
394 } /* switch (ds->ds[i].type) */
396 DEBUG("uc_update: %s: ds[%" PRIsz "] = %lf", name, i, ce->values_gauge[i]);
399 /* Update the history if it exists. */
400 if (ce->history != NULL) {
401 assert(ce->history_index < ce->history_length);
402 for (size_t i = 0; i < ce->values_num; i++) {
403 size_t hist_idx = (ce->values_num * ce->history_index) + i;
404 ce->history[hist_idx] = ce->values_gauge[i];
407 assert(ce->history_length > 0);
408 ce->history_index = (ce->history_index + 1) % ce->history_length;
411 /* Prune invalid gauge data */
412 uc_check_range(ds, ce);
414 ce->last_time = vl->time;
415 ce->last_update = cdtime();
416 ce->interval = vl->interval;
418 /* Check if cache entry has registered callbacks */
419 unsigned long callbacks_mask = ce->callbacks_mask;
421 pthread_mutex_unlock(&cache_lock);
424 plugin_dispatch_cache_event(CE_VALUE_UPDATE, callbacks_mask, name, vl);
427 } /* int uc_update */
429 int uc_set_callbacks_mask(const char *name, unsigned long mask) {
430 pthread_mutex_lock(&cache_lock);
431 cache_entry_t *ce = NULL;
432 int status = c_avl_get(cache_tree, name, (void *)&ce);
433 if (status != 0) { /* Ouch, just created entry disappeared ?! */
434 ERROR("uc_set_callbacks_mask: Couldn't find %s entry!", name);
435 pthread_mutex_unlock(&cache_lock);
438 DEBUG("uc_set_callbacks_mask: set mask for \"%s\" to %lu.", name, mask);
439 ce->callbacks_mask = mask;
440 pthread_mutex_unlock(&cache_lock);
444 int uc_get_rate_by_name(const char *name, gauge_t **ret_values,
445 size_t *ret_values_num) {
448 cache_entry_t *ce = NULL;
451 pthread_mutex_lock(&cache_lock);
453 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
456 /* remove missing values from getval */
457 if (ce->state == STATE_MISSING) {
458 DEBUG("utils_cache: uc_get_rate_by_name: requested metric \"%s\" is in "
459 "state \"missing\".",
463 ret_num = ce->values_num;
464 ret = malloc(ret_num * sizeof(*ret));
466 ERROR("utils_cache: uc_get_rate_by_name: malloc failed.");
469 memcpy(ret, ce->values_gauge, ret_num * sizeof(gauge_t));
473 DEBUG("utils_cache: uc_get_rate_by_name: No such value: %s", name);
477 pthread_mutex_unlock(&cache_lock);
481 *ret_values_num = ret_num;
485 } /* gauge_t *uc_get_rate_by_name */
487 gauge_t *uc_get_rate(const data_set_t *ds, const value_list_t *vl) {
488 char name[6 * DATA_MAX_NAME_LEN];
493 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
494 ERROR("utils_cache: uc_get_rate: FORMAT_VL failed.");
498 status = uc_get_rate_by_name(name, &ret, &ret_num);
502 /* This is important - the caller has no other way of knowing how many
503 * values are returned. */
504 if (ret_num != ds->ds_num) {
505 ERROR("utils_cache: uc_get_rate: ds[%s] has %" PRIsz " values, "
506 "but uc_get_rate_by_name returned %" PRIsz ".",
507 ds->type, ds->ds_num, ret_num);
513 } /* gauge_t *uc_get_rate */
515 int uc_get_value_by_name(const char *name, value_t **ret_values,
516 size_t *ret_values_num) {
519 cache_entry_t *ce = NULL;
522 pthread_mutex_lock(&cache_lock);
524 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
527 /* remove missing values from getval */
528 if (ce->state == STATE_MISSING) {
531 ret_num = ce->values_num;
532 ret = malloc(ret_num * sizeof(*ret));
534 ERROR("utils_cache: uc_get_value_by_name: malloc failed.");
537 memcpy(ret, ce->values_raw, ret_num * sizeof(value_t));
541 DEBUG("utils_cache: uc_get_value_by_name: No such value: %s", name);
545 pthread_mutex_unlock(&cache_lock);
549 *ret_values_num = ret_num;
553 } /* int uc_get_value_by_name */
555 value_t *uc_get_value(const data_set_t *ds, const value_list_t *vl) {
556 char name[6 * DATA_MAX_NAME_LEN];
561 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
562 ERROR("utils_cache: uc_get_value: FORMAT_VL failed.");
566 status = uc_get_value_by_name(name, &ret, &ret_num);
570 /* This is important - the caller has no other way of knowing how many
571 * values are returned. */
572 if (ret_num != (size_t)ds->ds_num) {
573 ERROR("utils_cache: uc_get_value: ds[%s] has %" PRIsz " values, "
574 "but uc_get_value_by_name returned %" PRIsz ".",
575 ds->type, ds->ds_num, ret_num);
581 } /* value_t *uc_get_value */
583 size_t uc_get_size(void) {
584 size_t size_arrays = 0;
586 pthread_mutex_lock(&cache_lock);
587 size_arrays = (size_t)c_avl_size(cache_tree);
588 pthread_mutex_unlock(&cache_lock);
593 int uc_get_names(char ***ret_names, cdtime_t **ret_times, size_t *ret_number) {
594 c_avl_iterator_t *iter;
596 cache_entry_t *value;
599 cdtime_t *times = NULL;
601 size_t size_arrays = 0;
605 if ((ret_names == NULL) || (ret_number == NULL))
608 pthread_mutex_lock(&cache_lock);
610 size_arrays = (size_t)c_avl_size(cache_tree);
611 if (size_arrays < 1) {
612 /* Handle the "no values" case here, to avoid the error message when
613 * calloc() returns NULL. */
614 pthread_mutex_unlock(&cache_lock);
618 names = calloc(size_arrays, sizeof(*names));
619 times = calloc(size_arrays, sizeof(*times));
620 if ((names == NULL) || (times == NULL)) {
621 ERROR("uc_get_names: calloc failed.");
624 pthread_mutex_unlock(&cache_lock);
628 iter = c_avl_get_iterator(cache_tree);
629 while (c_avl_iterator_next(iter, (void *)&key, (void *)&value) == 0) {
630 /* remove missing values when list values */
631 if (value->state == STATE_MISSING)
634 /* c_avl_size does not return a number smaller than the number of elements
635 * returned by c_avl_iterator_next. */
636 assert(number < size_arrays);
638 if (ret_times != NULL)
639 times[number] = value->last_time;
641 names[number] = strdup(key);
642 if (names[number] == NULL) {
648 } /* while (c_avl_iterator_next) */
650 c_avl_iterator_destroy(iter);
651 pthread_mutex_unlock(&cache_lock);
654 for (size_t i = 0; i < number; i++) {
664 if (ret_times != NULL)
668 *ret_number = number;
671 } /* int uc_get_names */
673 int uc_get_state(const data_set_t *ds, const value_list_t *vl) {
674 char name[6 * DATA_MAX_NAME_LEN];
675 cache_entry_t *ce = NULL;
676 int ret = STATE_ERROR;
678 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
679 ERROR("uc_get_state: FORMAT_VL failed.");
683 pthread_mutex_lock(&cache_lock);
685 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
690 pthread_mutex_unlock(&cache_lock);
693 } /* int uc_get_state */
695 int uc_set_state(const data_set_t *ds, const value_list_t *vl, int state) {
696 char name[6 * DATA_MAX_NAME_LEN];
697 cache_entry_t *ce = NULL;
700 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
701 ERROR("uc_set_state: FORMAT_VL failed.");
705 pthread_mutex_lock(&cache_lock);
707 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
713 pthread_mutex_unlock(&cache_lock);
716 } /* int uc_set_state */
718 int uc_get_history_by_name(const char *name, gauge_t *ret_history,
719 size_t num_steps, size_t num_ds) {
720 cache_entry_t *ce = NULL;
723 pthread_mutex_lock(&cache_lock);
725 status = c_avl_get(cache_tree, name, (void *)&ce);
727 pthread_mutex_unlock(&cache_lock);
731 if (((size_t)ce->values_num) != num_ds) {
732 pthread_mutex_unlock(&cache_lock);
736 /* Check if there are enough values available. If not, increase the buffer
738 if (ce->history_length < num_steps) {
742 realloc(ce->history, sizeof(*ce->history) * num_steps * ce->values_num);
744 pthread_mutex_unlock(&cache_lock);
748 for (size_t i = ce->history_length * ce->values_num;
749 i < (num_steps * ce->values_num); i++)
753 ce->history_length = num_steps;
754 } /* if (ce->history_length < num_steps) */
756 /* Copy the values to the output buffer. */
757 for (size_t i = 0; i < num_steps; i++) {
761 if (i < ce->history_index)
762 src_index = ce->history_index - (i + 1);
764 src_index = ce->history_length + ce->history_index - (i + 1);
765 src_index = src_index * num_ds;
767 dst_index = i * num_ds;
769 memcpy(ret_history + dst_index, ce->history + src_index,
770 sizeof(*ret_history) * num_ds);
773 pthread_mutex_unlock(&cache_lock);
776 } /* int uc_get_history_by_name */
778 int uc_get_history(const data_set_t *ds, const value_list_t *vl,
779 gauge_t *ret_history, size_t num_steps, size_t num_ds) {
780 char name[6 * DATA_MAX_NAME_LEN];
782 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
783 ERROR("utils_cache: uc_get_history: FORMAT_VL failed.");
787 return uc_get_history_by_name(name, ret_history, num_steps, num_ds);
788 } /* int uc_get_history */
790 int uc_get_hits(const data_set_t *ds, const value_list_t *vl) {
791 char name[6 * DATA_MAX_NAME_LEN];
792 cache_entry_t *ce = NULL;
793 int ret = STATE_ERROR;
795 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
796 ERROR("uc_get_hits: FORMAT_VL failed.");
800 pthread_mutex_lock(&cache_lock);
802 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
807 pthread_mutex_unlock(&cache_lock);
810 } /* int uc_get_hits */
812 int uc_set_hits(const data_set_t *ds, const value_list_t *vl, int hits) {
813 char name[6 * DATA_MAX_NAME_LEN];
814 cache_entry_t *ce = NULL;
817 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
818 ERROR("uc_set_hits: FORMAT_VL failed.");
822 pthread_mutex_lock(&cache_lock);
824 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
830 pthread_mutex_unlock(&cache_lock);
833 } /* int uc_set_hits */
835 int uc_inc_hits(const data_set_t *ds, const value_list_t *vl, int step) {
836 char name[6 * DATA_MAX_NAME_LEN];
837 cache_entry_t *ce = NULL;
840 if (FORMAT_VL(name, sizeof(name), vl) != 0) {
841 ERROR("uc_inc_hits: FORMAT_VL failed.");
845 pthread_mutex_lock(&cache_lock);
847 if (c_avl_get(cache_tree, name, (void *)&ce) == 0) {
850 ce->hits = ret + step;
853 pthread_mutex_unlock(&cache_lock);
856 } /* int uc_inc_hits */
861 uc_iter_t *uc_get_iterator(void) {
862 uc_iter_t *iter = calloc(1, sizeof(*iter));
866 pthread_mutex_lock(&cache_lock);
868 iter->iter = c_avl_get_iterator(cache_tree);
869 if (iter->iter == NULL) {
875 } /* uc_iter_t *uc_get_iterator */
877 int uc_iterator_next(uc_iter_t *iter, char **ret_name) {
883 while ((status = c_avl_iterator_next(iter->iter, (void *)&iter->name,
884 (void *)&iter->entry)) == 0) {
885 if (iter->entry->state == STATE_MISSING)
896 if (ret_name != NULL)
897 *ret_name = iter->name;
900 } /* int uc_iterator_next */
902 void uc_iterator_destroy(uc_iter_t *iter) {
906 c_avl_iterator_destroy(iter->iter);
907 pthread_mutex_unlock(&cache_lock);
910 } /* void uc_iterator_destroy */
912 int uc_iterator_get_time(uc_iter_t *iter, cdtime_t *ret_time) {
913 if ((iter == NULL) || (iter->entry == NULL) || (ret_time == NULL))
916 *ret_time = iter->entry->last_time;
918 } /* int uc_iterator_get_name */
920 int uc_iterator_get_values(uc_iter_t *iter, value_t **ret_values,
922 if ((iter == NULL) || (iter->entry == NULL) || (ret_values == NULL) ||
926 calloc(iter->entry->values_num, sizeof(*iter->entry->values_raw));
927 if (*ret_values == NULL)
929 for (size_t i = 0; i < iter->entry->values_num; ++i)
930 (*ret_values)[i] = iter->entry->values_raw[i];
932 *ret_num = iter->entry->values_num;
935 } /* int uc_iterator_get_values */
937 int uc_iterator_get_interval(uc_iter_t *iter, cdtime_t *ret_interval) {
938 if ((iter == NULL) || (iter->entry == NULL) || (ret_interval == NULL))
941 *ret_interval = iter->entry->interval;
943 } /* int uc_iterator_get_name */
945 int uc_iterator_get_meta(uc_iter_t *iter, meta_data_t **ret_meta) {
946 if ((iter == NULL) || (iter->entry == NULL) || (ret_meta == NULL))
949 *ret_meta = meta_data_clone(iter->entry->meta);
952 } /* int uc_iterator_get_meta */
955 * Meta data interface
957 /* XXX: This function will acquire `cache_lock' but will not free it! */
958 static meta_data_t *uc_get_meta(const value_list_t *vl) /* {{{ */
960 char name[6 * DATA_MAX_NAME_LEN];
961 cache_entry_t *ce = NULL;
964 status = FORMAT_VL(name, sizeof(name), vl);
966 ERROR("utils_cache: uc_get_meta: FORMAT_VL failed.");
970 pthread_mutex_lock(&cache_lock);
972 status = c_avl_get(cache_tree, name, (void *)&ce);
974 pthread_mutex_unlock(&cache_lock);
979 if (ce->meta == NULL)
980 ce->meta = meta_data_create();
982 if (ce->meta == NULL)
983 pthread_mutex_unlock(&cache_lock);
986 } /* }}} meta_data_t *uc_get_meta */
988 /* Sorry about this preprocessor magic, but it really makes this file much
990 #define UC_WRAP(wrap_function) \
994 meta = uc_get_meta(vl); \
997 status = wrap_function(meta, key); \
998 pthread_mutex_unlock(&cache_lock); \
1001 int uc_meta_data_exists(const value_list_t *vl,
1002 const char *key) UC_WRAP(meta_data_exists)
1004 int uc_meta_data_delete(const value_list_t *vl,
1005 const char *key) UC_WRAP(meta_data_delete)
1007 /* The second argument is called `toc` in the API, but the macro expects
1009 int uc_meta_data_toc(const value_list_t *vl, char ***key) UC_WRAP(meta_data_toc)
1013 /* We need a new version of this macro because the following functions take
1015 #define UC_WRAP(wrap_function) \
1017 meta_data_t *meta; \
1019 meta = uc_get_meta(vl); \
1022 status = wrap_function(meta, key, value); \
1023 pthread_mutex_unlock(&cache_lock); \
1026 int uc_meta_data_add_string(const value_list_t *vl, const char *key,
1028 UC_WRAP(meta_data_add_string) int uc_meta_data_add_signed_int(
1029 const value_list_t *vl, const char *key, int64_t value)
1030 UC_WRAP(meta_data_add_signed_int) int uc_meta_data_add_unsigned_int(
1031 const value_list_t *vl, const char *key, uint64_t value)
1032 UC_WRAP(meta_data_add_unsigned_int) int uc_meta_data_add_double(
1033 const value_list_t *vl, const char *key, double value)
1034 UC_WRAP(meta_data_add_double) int uc_meta_data_add_boolean(
1035 const value_list_t *vl, const char *key,
1036 bool value) UC_WRAP(meta_data_add_boolean)
1038 int uc_meta_data_get_string(const value_list_t *vl,
1041 UC_WRAP(meta_data_get_string) int uc_meta_data_get_signed_int(
1042 const value_list_t *vl, const char *key,
1044 UC_WRAP(meta_data_get_signed_int) int uc_meta_data_get_unsigned_int(
1045 const value_list_t *vl, const char *key,
1047 UC_WRAP(meta_data_get_unsigned_int) int uc_meta_data_get_double(
1048 const value_list_t *vl,
1049 const char *key, double *value)
1050 UC_WRAP(meta_data_get_double) int uc_meta_data_get_boolean(
1051 const value_list_t *vl,
1052 const char *key, bool *value)
1053 UC_WRAP(meta_data_get_boolean)