2 * collectd - src/meta_data.c
3 * Copyright (C) 2008-2011 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
29 #include "meta_data.h"
37 int64_t mv_signed_int;
38 uint64_t mv_unsigned_int;
42 typedef union meta_value_u meta_value_t;
45 typedef struct meta_entry_s meta_entry_t;
63 static char *md_strdup (const char *orig) /* {{{ */
71 sz = strlen (orig) + 1;
76 memcpy (dest, orig, sz);
79 } /* }}} char *md_strdup */
81 static meta_entry_t *md_entry_alloc (const char *key) /* {{{ */
85 e = calloc (1, sizeof (*e));
88 ERROR ("md_entry_alloc: calloc failed.");
92 e->key = md_strdup (key);
96 ERROR ("md_entry_alloc: md_strdup failed.");
104 } /* }}} meta_entry_t *md_entry_alloc */
106 /* XXX: The lock on md must be held while calling this function! */
107 static meta_entry_t *md_entry_clone_contents (const meta_entry_t *orig) /* {{{ */
112 * - we do not check that orig != NULL here. You should have done it before.
113 * - we do not set copy->next. DO NOT FORGET TO SET copy->next IN YOUR FUNCTION
116 copy = md_entry_alloc (orig->key);
119 copy->type = orig->type;
120 if (copy->type == MD_TYPE_STRING)
121 copy->value.mv_string = strdup (orig->value.mv_string);
123 copy->value = orig->value;
126 } /* }}} meta_entry_t *md_entry_clone_contents */
128 static meta_entry_t *md_entry_clone (const meta_entry_t *orig) /* {{{ */
135 copy = md_entry_clone_contents(orig);
137 copy->next = md_entry_clone (orig->next);
139 } /* }}} meta_entry_t *md_entry_clone */
141 static void md_entry_free (meta_entry_t *e) /* {{{ */
148 if (e->type == MD_TYPE_STRING)
149 free (e->value.mv_string);
152 md_entry_free (e->next);
155 } /* }}} void md_entry_free */
157 static int md_entry_insert (meta_data_t *md, meta_entry_t *e) /* {{{ */
162 if ((md == NULL) || (e == NULL))
165 pthread_mutex_lock (&md->lock);
171 if (strcasecmp (e->key, this->key) == 0)
180 /* This key does not exist yet. */
181 if (md->head == NULL)
185 assert (prev != NULL);
191 else /* (this != NULL) */
198 e->next = this->next;
201 pthread_mutex_unlock (&md->lock);
206 md_entry_free (this);
210 } /* }}} int md_entry_insert */
212 /* XXX: The lock on md must be held while calling this function! */
213 static int md_entry_insert_clone (meta_data_t *md, meta_entry_t *orig) /* {{{ */
220 * - we do not check that md and e != NULL here. You should have done it before.
221 * - we do not use the lock. You should have set it before.
224 e = md_entry_clone_contents(orig);
230 if (strcasecmp (e->key, this->key) == 0)
239 /* This key does not exist yet. */
240 if (md->head == NULL)
244 assert (prev != NULL);
250 else /* (this != NULL) */
257 e->next = this->next;
263 md_entry_free (this);
267 } /* }}} int md_entry_insert_clone */
269 /* XXX: The lock on md must be held while calling this function! */
270 static meta_entry_t *md_entry_lookup (meta_data_t *md, /* {{{ */
275 if ((md == NULL) || (key == NULL))
278 for (e = md->head; e != NULL; e = e->next)
279 if (strcasecmp (key, e->key) == 0)
283 } /* }}} meta_entry_t *md_entry_lookup */
286 * Each value_list_t*, as it is going through the system, is handled by exactly
287 * one thread. Plugins which pass a value_list_t* to another thread, e.g. the
288 * rrdtool plugin, must create a copy first. The meta data within a
289 * value_list_t* is not thread safe and doesn't need to be.
291 * The meta data associated with cache entries are a different story. There, we
292 * need to ensure exclusive locking to prevent leaks and other funky business.
293 * This is ensured by the uc_meta_data_get_*() functions.
299 meta_data_t *meta_data_create (void) /* {{{ */
303 md = calloc (1, sizeof (*md));
306 ERROR ("meta_data_create: calloc failed.");
310 pthread_mutex_init (&md->lock, /* attr = */ NULL);
313 } /* }}} meta_data_t *meta_data_create */
315 meta_data_t *meta_data_clone (meta_data_t *orig) /* {{{ */
322 copy = meta_data_create ();
326 pthread_mutex_lock (&orig->lock);
327 copy->head = md_entry_clone (orig->head);
328 pthread_mutex_unlock (&orig->lock);
331 } /* }}} meta_data_t *meta_data_clone */
333 int meta_data_clone_merge (meta_data_t **dest, meta_data_t *orig) /* {{{ */
341 *dest = meta_data_clone(orig);
345 pthread_mutex_lock (&orig->lock);
346 for (e=orig->head; e != NULL; e = e->next)
348 md_entry_insert_clone((*dest), e);
350 pthread_mutex_unlock (&orig->lock);
353 } /* }}} int meta_data_clone_merge */
355 void meta_data_destroy (meta_data_t *md) /* {{{ */
360 md_entry_free (md->head);
361 pthread_mutex_destroy (&md->lock);
363 } /* }}} void meta_data_destroy */
365 int meta_data_exists (meta_data_t *md, const char *key) /* {{{ */
369 if ((md == NULL) || (key == NULL))
372 pthread_mutex_lock (&md->lock);
374 for (e = md->head; e != NULL; e = e->next)
376 if (strcasecmp (key, e->key) == 0)
378 pthread_mutex_unlock (&md->lock);
383 pthread_mutex_unlock (&md->lock);
385 } /* }}} int meta_data_exists */
387 int meta_data_type (meta_data_t *md, const char *key) /* {{{ */
391 if ((md == NULL) || (key == NULL))
394 pthread_mutex_lock (&md->lock);
396 for (e = md->head; e != NULL; e = e->next)
398 if (strcasecmp (key, e->key) == 0)
400 pthread_mutex_unlock (&md->lock);
405 pthread_mutex_unlock (&md->lock);
407 } /* }}} int meta_data_type */
409 int meta_data_toc (meta_data_t *md, char ***toc) /* {{{ */
411 int i = 0, count = 0;
414 if ((md == NULL) || (toc == NULL))
417 pthread_mutex_lock (&md->lock);
419 for (e = md->head; e != NULL; e = e->next)
424 pthread_mutex_unlock (&md->lock);
428 *toc = calloc(count, sizeof(**toc));
429 for (e = md->head; e != NULL; e = e->next)
430 (*toc)[i++] = strdup(e->key);
432 pthread_mutex_unlock (&md->lock);
434 } /* }}} int meta_data_toc */
436 int meta_data_delete (meta_data_t *md, const char *key) /* {{{ */
441 if ((md == NULL) || (key == NULL))
444 pthread_mutex_lock (&md->lock);
450 if (strcasecmp (key, this->key) == 0)
459 pthread_mutex_unlock (&md->lock);
464 md->head = this->next;
466 prev->next = this->next;
468 pthread_mutex_unlock (&md->lock);
471 md_entry_free (this);
474 } /* }}} int meta_data_delete */
479 int meta_data_add_string (meta_data_t *md, /* {{{ */
480 const char *key, const char *value)
484 if ((md == NULL) || (key == NULL) || (value == NULL))
487 e = md_entry_alloc (key);
491 e->value.mv_string = md_strdup (value);
492 if (e->value.mv_string == NULL)
494 ERROR ("meta_data_add_string: md_strdup failed.");
498 e->type = MD_TYPE_STRING;
500 return (md_entry_insert (md, e));
501 } /* }}} int meta_data_add_string */
503 int meta_data_add_signed_int (meta_data_t *md, /* {{{ */
504 const char *key, int64_t value)
508 if ((md == NULL) || (key == NULL))
511 e = md_entry_alloc (key);
515 e->value.mv_signed_int = value;
516 e->type = MD_TYPE_SIGNED_INT;
518 return (md_entry_insert (md, e));
519 } /* }}} int meta_data_add_signed_int */
521 int meta_data_add_unsigned_int (meta_data_t *md, /* {{{ */
522 const char *key, uint64_t value)
526 if ((md == NULL) || (key == NULL))
529 e = md_entry_alloc (key);
533 e->value.mv_unsigned_int = value;
534 e->type = MD_TYPE_UNSIGNED_INT;
536 return (md_entry_insert (md, e));
537 } /* }}} int meta_data_add_unsigned_int */
539 int meta_data_add_double (meta_data_t *md, /* {{{ */
540 const char *key, double value)
544 if ((md == NULL) || (key == NULL))
547 e = md_entry_alloc (key);
551 e->value.mv_double = value;
552 e->type = MD_TYPE_DOUBLE;
554 return (md_entry_insert (md, e));
555 } /* }}} int meta_data_add_double */
557 int meta_data_add_boolean (meta_data_t *md, /* {{{ */
558 const char *key, _Bool value)
562 if ((md == NULL) || (key == NULL))
565 e = md_entry_alloc (key);
569 e->value.mv_boolean = value;
570 e->type = MD_TYPE_BOOLEAN;
572 return (md_entry_insert (md, e));
573 } /* }}} int meta_data_add_boolean */
578 int meta_data_get_string (meta_data_t *md, /* {{{ */
579 const char *key, char **value)
584 if ((md == NULL) || (key == NULL) || (value == NULL))
587 pthread_mutex_lock (&md->lock);
589 e = md_entry_lookup (md, key);
592 pthread_mutex_unlock (&md->lock);
596 if (e->type != MD_TYPE_STRING)
598 ERROR ("meta_data_get_string: Type mismatch for key `%s'", e->key);
599 pthread_mutex_unlock (&md->lock);
603 temp = md_strdup (e->value.mv_string);
606 pthread_mutex_unlock (&md->lock);
607 ERROR ("meta_data_get_string: md_strdup failed.");
611 pthread_mutex_unlock (&md->lock);
616 } /* }}} int meta_data_get_string */
618 int meta_data_get_signed_int (meta_data_t *md, /* {{{ */
619 const char *key, int64_t *value)
623 if ((md == NULL) || (key == NULL) || (value == NULL))
626 pthread_mutex_lock (&md->lock);
628 e = md_entry_lookup (md, key);
631 pthread_mutex_unlock (&md->lock);
635 if (e->type != MD_TYPE_SIGNED_INT)
637 ERROR ("meta_data_get_signed_int: Type mismatch for key `%s'", e->key);
638 pthread_mutex_unlock (&md->lock);
642 *value = e->value.mv_signed_int;
644 pthread_mutex_unlock (&md->lock);
646 } /* }}} int meta_data_get_signed_int */
648 int meta_data_get_unsigned_int (meta_data_t *md, /* {{{ */
649 const char *key, uint64_t *value)
653 if ((md == NULL) || (key == NULL) || (value == NULL))
656 pthread_mutex_lock (&md->lock);
658 e = md_entry_lookup (md, key);
661 pthread_mutex_unlock (&md->lock);
665 if (e->type != MD_TYPE_UNSIGNED_INT)
667 ERROR ("meta_data_get_unsigned_int: Type mismatch for key `%s'", e->key);
668 pthread_mutex_unlock (&md->lock);
672 *value = e->value.mv_unsigned_int;
674 pthread_mutex_unlock (&md->lock);
676 } /* }}} int meta_data_get_unsigned_int */
678 int meta_data_get_double (meta_data_t *md, /* {{{ */
679 const char *key, double *value)
683 if ((md == NULL) || (key == NULL) || (value == NULL))
686 pthread_mutex_lock (&md->lock);
688 e = md_entry_lookup (md, key);
691 pthread_mutex_unlock (&md->lock);
695 if (e->type != MD_TYPE_DOUBLE)
697 ERROR ("meta_data_get_double: Type mismatch for key `%s'", e->key);
698 pthread_mutex_unlock (&md->lock);
702 *value = e->value.mv_double;
704 pthread_mutex_unlock (&md->lock);
706 } /* }}} int meta_data_get_double */
708 int meta_data_get_boolean (meta_data_t *md, /* {{{ */
709 const char *key, _Bool *value)
713 if ((md == NULL) || (key == NULL) || (value == NULL))
716 pthread_mutex_lock (&md->lock);
718 e = md_entry_lookup (md, key);
721 pthread_mutex_unlock (&md->lock);
725 if (e->type != MD_TYPE_BOOLEAN)
727 ERROR ("meta_data_get_boolean: Type mismatch for key `%s'", e->key);
728 pthread_mutex_unlock (&md->lock);
732 *value = e->value.mv_boolean;
734 pthread_mutex_unlock (&md->lock);
736 } /* }}} int meta_data_get_boolean */
738 /* vim: set sw=2 sts=2 et fdm=marker : */