1 /**
2 * collectd - src/meta_data.c
3 * Copyright (C) 2008-2011 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 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "plugin.h"
24 #include "meta_data.h"
26 #include <pthread.h>
28 /*
29 * Data types
30 */
31 union meta_value_u
32 {
33 char *mv_string;
34 int64_t mv_signed_int;
35 uint64_t mv_unsigned_int;
36 double mv_double;
37 _Bool mv_boolean;
38 };
39 typedef union meta_value_u meta_value_t;
41 struct meta_entry_s;
42 typedef struct meta_entry_s meta_entry_t;
43 struct meta_entry_s
44 {
45 char *key;
46 meta_value_t value;
47 int type;
48 meta_entry_t *next;
49 };
51 struct meta_data_s
52 {
53 meta_entry_t *head;
54 pthread_mutex_t lock;
55 };
57 /*
58 * Private functions
59 */
60 static char *md_strdup (const char *orig) /* {{{ */
61 {
62 size_t sz;
63 char *dest;
65 if (orig == NULL)
66 return (NULL);
68 sz = strlen (orig) + 1;
69 dest = (char *) malloc (sz);
70 if (dest == NULL)
71 return (NULL);
73 memcpy (dest, orig, sz);
75 return (dest);
76 } /* }}} char *md_strdup */
78 static meta_entry_t *md_entry_alloc (const char *key) /* {{{ */
79 {
80 meta_entry_t *e;
82 e = (meta_entry_t *) malloc (sizeof (*e));
83 if (e == NULL)
84 {
85 ERROR ("md_entry_alloc: malloc failed.");
86 return (NULL);
87 }
88 memset (e, 0, sizeof (*e));
90 e->key = md_strdup (key);
91 if (e->key == NULL)
92 {
93 free (e);
94 ERROR ("md_entry_alloc: md_strdup failed.");
95 return (NULL);
96 }
98 e->type = 0;
99 e->next = NULL;
101 return (e);
102 } /* }}} meta_entry_t *md_entry_alloc */
104 static meta_entry_t *md_entry_clone (const meta_entry_t *orig) /* {{{ */
105 {
106 meta_entry_t *copy;
108 if (orig == NULL)
109 return (NULL);
111 copy = md_entry_alloc (orig->key);
112 copy->type = orig->type;
113 if (copy->type == MD_TYPE_STRING)
114 copy->value.mv_string = strdup (orig->value.mv_string);
115 else
116 copy->value = orig->value;
118 copy->next = md_entry_clone (orig->next);
119 return (copy);
120 } /* }}} meta_entry_t *md_entry_clone */
122 static void md_entry_free (meta_entry_t *e) /* {{{ */
123 {
124 if (e == NULL)
125 return;
127 free (e->key);
129 if (e->type == MD_TYPE_STRING)
130 free (e->value.mv_string);
132 if (e->next != NULL)
133 md_entry_free (e->next);
135 free (e);
136 } /* }}} void md_entry_free */
138 static int md_entry_insert (meta_data_t *md, meta_entry_t *e) /* {{{ */
139 {
140 meta_entry_t *this;
141 meta_entry_t *prev;
143 if ((md == NULL) || (e == NULL))
144 return (-EINVAL);
146 pthread_mutex_lock (&md->lock);
148 prev = NULL;
149 this = md->head;
150 while (this != NULL)
151 {
152 if (strcasecmp (e->key, this->key) == 0)
153 break;
155 prev = this;
156 this = this->next;
157 }
159 if (this == NULL)
160 {
161 /* This key does not exist yet. */
162 if (md->head == NULL)
163 md->head = e;
164 else
165 {
166 assert (prev != NULL);
167 prev->next = e;
168 }
170 e->next = NULL;
171 }
172 else /* (this != NULL) */
173 {
174 if (prev == NULL)
175 md->head = e;
176 else
177 prev->next = e;
179 e->next = this->next;
180 }
182 pthread_mutex_unlock (&md->lock);
184 if (this != NULL)
185 {
186 this->next = NULL;
187 md_entry_free (this);
188 }
190 return (0);
191 } /* }}} int md_entry_insert */
193 /* XXX: The lock on md must be held while calling this function! */
194 static meta_entry_t *md_entry_lookup (meta_data_t *md, /* {{{ */
195 const char *key)
196 {
197 meta_entry_t *e;
199 if ((md == NULL) || (key == NULL))
200 return (NULL);
202 for (e = md->head; e != NULL; e = e->next)
203 if (strcasecmp (key, e->key) == 0)
204 break;
206 return (e);
207 } /* }}} meta_entry_t *md_entry_lookup */
209 /*
210 * Public functions
211 */
212 meta_data_t *meta_data_create (void) /* {{{ */
213 {
214 meta_data_t *md;
216 md = (meta_data_t *) malloc (sizeof (*md));
217 if (md == NULL)
218 {
219 ERROR ("meta_data_create: malloc failed.");
220 return (NULL);
221 }
222 memset (md, 0, sizeof (*md));
224 md->head = NULL;
225 pthread_mutex_init (&md->lock, /* attr = */ NULL);
227 return (md);
228 } /* }}} meta_data_t *meta_data_create */
230 meta_data_t *meta_data_clone (meta_data_t *orig) /* {{{ */
231 {
232 meta_data_t *copy;
234 if (orig == NULL)
235 return (NULL);
237 copy = meta_data_create ();
238 if (copy == NULL)
239 return (NULL);
241 pthread_mutex_lock (&orig->lock);
242 copy->head = md_entry_clone (orig->head);
243 pthread_mutex_unlock (&orig->lock);
245 return (copy);
246 } /* }}} meta_data_t *meta_data_clone */
248 void meta_data_destroy (meta_data_t *md) /* {{{ */
249 {
250 if (md == NULL)
251 return;
253 md_entry_free (md->head);
254 pthread_mutex_destroy (&md->lock);
255 free (md);
256 } /* }}} void meta_data_destroy */
258 int meta_data_exists (meta_data_t *md, const char *key) /* {{{ */
259 {
260 meta_entry_t *e;
262 if ((md == NULL) || (key == NULL))
263 return (-EINVAL);
265 pthread_mutex_lock (&md->lock);
267 for (e = md->head; e != NULL; e = e->next)
268 {
269 if (strcasecmp (key, e->key) == 0)
270 {
271 pthread_mutex_unlock (&md->lock);
272 return (1);
273 }
274 }
276 pthread_mutex_unlock (&md->lock);
277 return (0);
278 } /* }}} int meta_data_exists */
280 int meta_data_type (meta_data_t *md, const char *key) /* {{{ */
281 {
282 meta_entry_t *e;
284 if ((md == NULL) || (key == NULL))
285 return -EINVAL;
287 pthread_mutex_lock (&md->lock);
289 for (e = md->head; e != NULL; e = e->next)
290 {
291 if (strcasecmp (key, e->key) == 0)
292 {
293 pthread_mutex_unlock (&md->lock);
294 return e->type;
295 }
296 }
298 pthread_mutex_unlock (&md->lock);
299 return 0;
300 } /* }}} int meta_data_type */
302 int meta_data_toc (meta_data_t *md, char ***toc) /* {{{ */
303 {
304 int i = 0, count = 0;
305 meta_entry_t *e;
307 if ((md == NULL) || (toc == NULL))
308 return -EINVAL;
310 pthread_mutex_lock (&md->lock);
312 for (e = md->head; e != NULL; e = e->next)
313 ++count;
315 *toc = malloc(count * sizeof(**toc));
316 for (e = md->head; e != NULL; e = e->next)
317 (*toc)[i++] = strdup(e->key);
319 pthread_mutex_unlock (&md->lock);
320 return count;
321 } /* }}} int meta_data_toc */
323 int meta_data_delete (meta_data_t *md, const char *key) /* {{{ */
324 {
325 meta_entry_t *this;
326 meta_entry_t *prev;
328 if ((md == NULL) || (key == NULL))
329 return (-EINVAL);
331 pthread_mutex_lock (&md->lock);
333 prev = NULL;
334 this = md->head;
335 while (this != NULL)
336 {
337 if (strcasecmp (key, this->key) == 0)
338 break;
340 prev = this;
341 this = this->next;
342 }
344 if (this == NULL)
345 {
346 pthread_mutex_unlock (&md->lock);
347 return (-ENOENT);
348 }
350 if (prev == NULL)
351 md->head = this->next;
352 else
353 prev->next = this->next;
355 pthread_mutex_unlock (&md->lock);
357 this->next = NULL;
358 md_entry_free (this);
360 return (0);
361 } /* }}} int meta_data_delete */
363 /*
364 * Add functions
365 */
366 int meta_data_add_string (meta_data_t *md, /* {{{ */
367 const char *key, const char *value)
368 {
369 meta_entry_t *e;
371 if ((md == NULL) || (key == NULL) || (value == NULL))
372 return (-EINVAL);
374 e = md_entry_alloc (key);
375 if (e == NULL)
376 return (-ENOMEM);
378 e->value.mv_string = md_strdup (value);
379 if (e->value.mv_string == NULL)
380 {
381 ERROR ("meta_data_add_string: md_strdup failed.");
382 md_entry_free (e);
383 return (-ENOMEM);
384 }
385 e->type = MD_TYPE_STRING;
387 return (md_entry_insert (md, e));
388 } /* }}} int meta_data_add_string */
390 int meta_data_add_signed_int (meta_data_t *md, /* {{{ */
391 const char *key, int64_t value)
392 {
393 meta_entry_t *e;
395 if ((md == NULL) || (key == NULL))
396 return (-EINVAL);
398 e = md_entry_alloc (key);
399 if (e == NULL)
400 return (-ENOMEM);
402 e->value.mv_signed_int = value;
403 e->type = MD_TYPE_SIGNED_INT;
405 return (md_entry_insert (md, e));
406 } /* }}} int meta_data_add_signed_int */
408 int meta_data_add_unsigned_int (meta_data_t *md, /* {{{ */
409 const char *key, uint64_t value)
410 {
411 meta_entry_t *e;
413 if ((md == NULL) || (key == NULL))
414 return (-EINVAL);
416 e = md_entry_alloc (key);
417 if (e == NULL)
418 return (-ENOMEM);
420 e->value.mv_unsigned_int = value;
421 e->type = MD_TYPE_UNSIGNED_INT;
423 return (md_entry_insert (md, e));
424 } /* }}} int meta_data_add_unsigned_int */
426 int meta_data_add_double (meta_data_t *md, /* {{{ */
427 const char *key, double value)
428 {
429 meta_entry_t *e;
431 if ((md == NULL) || (key == NULL))
432 return (-EINVAL);
434 e = md_entry_alloc (key);
435 if (e == NULL)
436 return (-ENOMEM);
438 e->value.mv_double = value;
439 e->type = MD_TYPE_DOUBLE;
441 return (md_entry_insert (md, e));
442 } /* }}} int meta_data_add_double */
444 int meta_data_add_boolean (meta_data_t *md, /* {{{ */
445 const char *key, _Bool value)
446 {
447 meta_entry_t *e;
449 if ((md == NULL) || (key == NULL))
450 return (-EINVAL);
452 e = md_entry_alloc (key);
453 if (e == NULL)
454 return (-ENOMEM);
456 e->value.mv_boolean = value;
457 e->type = MD_TYPE_BOOLEAN;
459 return (md_entry_insert (md, e));
460 } /* }}} int meta_data_add_boolean */
462 /*
463 * Get functions
464 */
465 int meta_data_get_string (meta_data_t *md, /* {{{ */
466 const char *key, char **value)
467 {
468 meta_entry_t *e;
469 char *temp;
471 if ((md == NULL) || (key == NULL) || (value == NULL))
472 return (-EINVAL);
474 pthread_mutex_lock (&md->lock);
476 e = md_entry_lookup (md, key);
477 if (e == NULL)
478 {
479 pthread_mutex_unlock (&md->lock);
480 return (-ENOENT);
481 }
483 if (e->type != MD_TYPE_STRING)
484 {
485 ERROR ("meta_data_get_signed_int: Type mismatch for key `%s'", e->key);
486 pthread_mutex_unlock (&md->lock);
487 return (-ENOENT);
488 }
490 temp = md_strdup (e->value.mv_string);
491 if (temp == NULL)
492 {
493 pthread_mutex_unlock (&md->lock);
494 ERROR ("meta_data_get_string: md_strdup failed.");
495 return (-ENOMEM);
496 }
498 pthread_mutex_unlock (&md->lock);
500 *value = temp;
502 return (0);
503 } /* }}} int meta_data_get_string */
505 int meta_data_get_signed_int (meta_data_t *md, /* {{{ */
506 const char *key, int64_t *value)
507 {
508 meta_entry_t *e;
510 if ((md == NULL) || (key == NULL) || (value == NULL))
511 return (-EINVAL);
513 pthread_mutex_lock (&md->lock);
515 e = md_entry_lookup (md, key);
516 if (e == NULL)
517 {
518 pthread_mutex_unlock (&md->lock);
519 return (-ENOENT);
520 }
522 if (e->type != MD_TYPE_SIGNED_INT)
523 {
524 ERROR ("meta_data_get_signed_int: Type mismatch for key `%s'", e->key);
525 pthread_mutex_unlock (&md->lock);
526 return (-ENOENT);
527 }
529 *value = e->value.mv_signed_int;
531 pthread_mutex_unlock (&md->lock);
532 return (0);
533 } /* }}} int meta_data_get_signed_int */
535 int meta_data_get_unsigned_int (meta_data_t *md, /* {{{ */
536 const char *key, uint64_t *value)
537 {
538 meta_entry_t *e;
540 if ((md == NULL) || (key == NULL) || (value == NULL))
541 return (-EINVAL);
543 pthread_mutex_lock (&md->lock);
545 e = md_entry_lookup (md, key);
546 if (e == NULL)
547 {
548 pthread_mutex_unlock (&md->lock);
549 return (-ENOENT);
550 }
552 if (e->type != MD_TYPE_UNSIGNED_INT)
553 {
554 ERROR ("meta_data_get_unsigned_int: Type mismatch for key `%s'", e->key);
555 pthread_mutex_unlock (&md->lock);
556 return (-ENOENT);
557 }
559 *value = e->value.mv_unsigned_int;
561 pthread_mutex_unlock (&md->lock);
562 return (0);
563 } /* }}} int meta_data_get_unsigned_int */
565 int meta_data_get_double (meta_data_t *md, /* {{{ */
566 const char *key, double *value)
567 {
568 meta_entry_t *e;
570 if ((md == NULL) || (key == NULL) || (value == NULL))
571 return (-EINVAL);
573 pthread_mutex_lock (&md->lock);
575 e = md_entry_lookup (md, key);
576 if (e == NULL)
577 {
578 pthread_mutex_unlock (&md->lock);
579 return (-ENOENT);
580 }
582 if (e->type != MD_TYPE_DOUBLE)
583 {
584 ERROR ("meta_data_get_double: Type mismatch for key `%s'", e->key);
585 pthread_mutex_unlock (&md->lock);
586 return (-ENOENT);
587 }
589 *value = e->value.mv_double;
591 pthread_mutex_unlock (&md->lock);
592 return (0);
593 } /* }}} int meta_data_get_double */
595 int meta_data_get_boolean (meta_data_t *md, /* {{{ */
596 const char *key, _Bool *value)
597 {
598 meta_entry_t *e;
600 if ((md == NULL) || (key == NULL) || (value == NULL))
601 return (-EINVAL);
603 pthread_mutex_lock (&md->lock);
605 e = md_entry_lookup (md, key);
606 if (e == NULL)
607 {
608 pthread_mutex_unlock (&md->lock);
609 return (-ENOENT);
610 }
612 if (e->type != MD_TYPE_BOOLEAN)
613 {
614 ERROR ("meta_data_get_boolean: Type mismatch for key `%s'", e->key);
615 pthread_mutex_unlock (&md->lock);
616 return (-ENOENT);
617 }
619 *value = e->value.mv_boolean;
621 pthread_mutex_unlock (&md->lock);
622 return (0);
623 } /* }}} int meta_data_get_boolean */
625 /* vim: set sw=2 sts=2 et fdm=marker : */