1 /**
2 * collectd - src/meta_data.c
3 * Copyright (C) 2008-2011 Florian octo Forster
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 **/
27 #include "collectd.h"
28 #include "plugin.h"
29 #include "meta_data.h"
31 #include <pthread.h>
33 /*
34 * Data types
35 */
36 union meta_value_u
37 {
38 char *mv_string;
39 int64_t mv_signed_int;
40 uint64_t mv_unsigned_int;
41 double mv_double;
42 _Bool mv_boolean;
43 };
44 typedef union meta_value_u meta_value_t;
46 struct meta_entry_s;
47 typedef struct meta_entry_s meta_entry_t;
48 struct meta_entry_s
49 {
50 char *key;
51 meta_value_t value;
52 int type;
53 meta_entry_t *next;
54 };
56 struct meta_data_s
57 {
58 meta_entry_t *head;
59 pthread_mutex_t lock;
60 };
62 /*
63 * Private functions
64 */
65 static char *md_strdup (const char *orig) /* {{{ */
66 {
67 size_t sz;
68 char *dest;
70 if (orig == NULL)
71 return (NULL);
73 sz = strlen (orig) + 1;
74 dest = (char *) malloc (sz);
75 if (dest == NULL)
76 return (NULL);
78 memcpy (dest, orig, sz);
80 return (dest);
81 } /* }}} char *md_strdup */
83 static meta_entry_t *md_entry_alloc (const char *key) /* {{{ */
84 {
85 meta_entry_t *e;
87 e = (meta_entry_t *) malloc (sizeof (*e));
88 if (e == NULL)
89 {
90 ERROR ("md_entry_alloc: malloc failed.");
91 return (NULL);
92 }
93 memset (e, 0, sizeof (*e));
95 e->key = md_strdup (key);
96 if (e->key == NULL)
97 {
98 free (e);
99 ERROR ("md_entry_alloc: md_strdup failed.");
100 return (NULL);
101 }
103 e->type = 0;
104 e->next = NULL;
106 return (e);
107 } /* }}} meta_entry_t *md_entry_alloc */
109 static meta_entry_t *md_entry_clone (const meta_entry_t *orig) /* {{{ */
110 {
111 meta_entry_t *copy;
113 if (orig == NULL)
114 return (NULL);
116 copy = md_entry_alloc (orig->key);
117 if (copy == NULL)
118 return (NULL);
119 copy->type = orig->type;
120 if (copy->type == MD_TYPE_STRING)
121 copy->value.mv_string = strdup (orig->value.mv_string);
122 else
123 copy->value = orig->value;
125 copy->next = md_entry_clone (orig->next);
126 return (copy);
127 } /* }}} meta_entry_t *md_entry_clone */
129 static void md_entry_free (meta_entry_t *e) /* {{{ */
130 {
131 if (e == NULL)
132 return;
134 free (e->key);
136 if (e->type == MD_TYPE_STRING)
137 free (e->value.mv_string);
139 if (e->next != NULL)
140 md_entry_free (e->next);
142 free (e);
143 } /* }}} void md_entry_free */
145 static int md_entry_insert (meta_data_t *md, meta_entry_t *e) /* {{{ */
146 {
147 meta_entry_t *this;
148 meta_entry_t *prev;
150 if ((md == NULL) || (e == NULL))
151 return (-EINVAL);
153 pthread_mutex_lock (&md->lock);
155 prev = NULL;
156 this = md->head;
157 while (this != NULL)
158 {
159 if (strcasecmp (e->key, this->key) == 0)
160 break;
162 prev = this;
163 this = this->next;
164 }
166 if (this == NULL)
167 {
168 /* This key does not exist yet. */
169 if (md->head == NULL)
170 md->head = e;
171 else
172 {
173 assert (prev != NULL);
174 prev->next = e;
175 }
177 e->next = NULL;
178 }
179 else /* (this != NULL) */
180 {
181 if (prev == NULL)
182 md->head = e;
183 else
184 prev->next = e;
186 e->next = this->next;
187 }
189 pthread_mutex_unlock (&md->lock);
191 if (this != NULL)
192 {
193 this->next = NULL;
194 md_entry_free (this);
195 }
197 return (0);
198 } /* }}} int md_entry_insert */
200 /* XXX: The lock on md must be held while calling this function! */
201 static meta_entry_t *md_entry_lookup (meta_data_t *md, /* {{{ */
202 const char *key)
203 {
204 meta_entry_t *e;
206 if ((md == NULL) || (key == NULL))
207 return (NULL);
209 for (e = md->head; e != NULL; e = e->next)
210 if (strcasecmp (key, e->key) == 0)
211 break;
213 return (e);
214 } /* }}} meta_entry_t *md_entry_lookup */
216 /*
217 * Public functions
218 */
219 meta_data_t *meta_data_create (void) /* {{{ */
220 {
221 meta_data_t *md;
223 md = (meta_data_t *) malloc (sizeof (*md));
224 if (md == NULL)
225 {
226 ERROR ("meta_data_create: malloc failed.");
227 return (NULL);
228 }
229 memset (md, 0, sizeof (*md));
231 md->head = NULL;
232 pthread_mutex_init (&md->lock, /* attr = */ NULL);
234 return (md);
235 } /* }}} meta_data_t *meta_data_create */
237 meta_data_t *meta_data_clone (meta_data_t *orig) /* {{{ */
238 {
239 meta_data_t *copy;
241 if (orig == NULL)
242 return (NULL);
244 copy = meta_data_create ();
245 if (copy == NULL)
246 return (NULL);
248 pthread_mutex_lock (&orig->lock);
249 copy->head = md_entry_clone (orig->head);
250 pthread_mutex_unlock (&orig->lock);
252 return (copy);
253 } /* }}} meta_data_t *meta_data_clone */
255 void meta_data_destroy (meta_data_t *md) /* {{{ */
256 {
257 if (md == NULL)
258 return;
260 md_entry_free (md->head);
261 pthread_mutex_destroy (&md->lock);
262 free (md);
263 } /* }}} void meta_data_destroy */
265 int meta_data_exists (meta_data_t *md, const char *key) /* {{{ */
266 {
267 meta_entry_t *e;
269 if ((md == NULL) || (key == NULL))
270 return (-EINVAL);
272 pthread_mutex_lock (&md->lock);
274 for (e = md->head; e != NULL; e = e->next)
275 {
276 if (strcasecmp (key, e->key) == 0)
277 {
278 pthread_mutex_unlock (&md->lock);
279 return (1);
280 }
281 }
283 pthread_mutex_unlock (&md->lock);
284 return (0);
285 } /* }}} int meta_data_exists */
287 int meta_data_type (meta_data_t *md, const char *key) /* {{{ */
288 {
289 meta_entry_t *e;
291 if ((md == NULL) || (key == NULL))
292 return -EINVAL;
294 pthread_mutex_lock (&md->lock);
296 for (e = md->head; e != NULL; e = e->next)
297 {
298 if (strcasecmp (key, e->key) == 0)
299 {
300 pthread_mutex_unlock (&md->lock);
301 return e->type;
302 }
303 }
305 pthread_mutex_unlock (&md->lock);
306 return 0;
307 } /* }}} int meta_data_type */
309 int meta_data_toc (meta_data_t *md, char ***toc) /* {{{ */
310 {
311 int i = 0, count = 0;
312 meta_entry_t *e;
314 if ((md == NULL) || (toc == NULL))
315 return -EINVAL;
317 pthread_mutex_lock (&md->lock);
319 for (e = md->head; e != NULL; e = e->next)
320 ++count;
322 if (count == 0)
323 {
324 pthread_mutex_unlock (&md->lock);
325 return (count);
326 }
328 *toc = calloc(count, sizeof(**toc));
329 for (e = md->head; e != NULL; e = e->next)
330 (*toc)[i++] = strdup(e->key);
332 pthread_mutex_unlock (&md->lock);
333 return count;
334 } /* }}} int meta_data_toc */
336 int meta_data_delete (meta_data_t *md, const char *key) /* {{{ */
337 {
338 meta_entry_t *this;
339 meta_entry_t *prev;
341 if ((md == NULL) || (key == NULL))
342 return (-EINVAL);
344 pthread_mutex_lock (&md->lock);
346 prev = NULL;
347 this = md->head;
348 while (this != NULL)
349 {
350 if (strcasecmp (key, this->key) == 0)
351 break;
353 prev = this;
354 this = this->next;
355 }
357 if (this == NULL)
358 {
359 pthread_mutex_unlock (&md->lock);
360 return (-ENOENT);
361 }
363 if (prev == NULL)
364 md->head = this->next;
365 else
366 prev->next = this->next;
368 pthread_mutex_unlock (&md->lock);
370 this->next = NULL;
371 md_entry_free (this);
373 return (0);
374 } /* }}} int meta_data_delete */
376 /*
377 * Add functions
378 */
379 int meta_data_add_string (meta_data_t *md, /* {{{ */
380 const char *key, const char *value)
381 {
382 meta_entry_t *e;
384 if ((md == NULL) || (key == NULL) || (value == NULL))
385 return (-EINVAL);
387 e = md_entry_alloc (key);
388 if (e == NULL)
389 return (-ENOMEM);
391 e->value.mv_string = md_strdup (value);
392 if (e->value.mv_string == NULL)
393 {
394 ERROR ("meta_data_add_string: md_strdup failed.");
395 md_entry_free (e);
396 return (-ENOMEM);
397 }
398 e->type = MD_TYPE_STRING;
400 return (md_entry_insert (md, e));
401 } /* }}} int meta_data_add_string */
403 int meta_data_add_signed_int (meta_data_t *md, /* {{{ */
404 const char *key, int64_t value)
405 {
406 meta_entry_t *e;
408 if ((md == NULL) || (key == NULL))
409 return (-EINVAL);
411 e = md_entry_alloc (key);
412 if (e == NULL)
413 return (-ENOMEM);
415 e->value.mv_signed_int = value;
416 e->type = MD_TYPE_SIGNED_INT;
418 return (md_entry_insert (md, e));
419 } /* }}} int meta_data_add_signed_int */
421 int meta_data_add_unsigned_int (meta_data_t *md, /* {{{ */
422 const char *key, uint64_t value)
423 {
424 meta_entry_t *e;
426 if ((md == NULL) || (key == NULL))
427 return (-EINVAL);
429 e = md_entry_alloc (key);
430 if (e == NULL)
431 return (-ENOMEM);
433 e->value.mv_unsigned_int = value;
434 e->type = MD_TYPE_UNSIGNED_INT;
436 return (md_entry_insert (md, e));
437 } /* }}} int meta_data_add_unsigned_int */
439 int meta_data_add_double (meta_data_t *md, /* {{{ */
440 const char *key, double value)
441 {
442 meta_entry_t *e;
444 if ((md == NULL) || (key == NULL))
445 return (-EINVAL);
447 e = md_entry_alloc (key);
448 if (e == NULL)
449 return (-ENOMEM);
451 e->value.mv_double = value;
452 e->type = MD_TYPE_DOUBLE;
454 return (md_entry_insert (md, e));
455 } /* }}} int meta_data_add_double */
457 int meta_data_add_boolean (meta_data_t *md, /* {{{ */
458 const char *key, _Bool value)
459 {
460 meta_entry_t *e;
462 if ((md == NULL) || (key == NULL))
463 return (-EINVAL);
465 e = md_entry_alloc (key);
466 if (e == NULL)
467 return (-ENOMEM);
469 e->value.mv_boolean = value;
470 e->type = MD_TYPE_BOOLEAN;
472 return (md_entry_insert (md, e));
473 } /* }}} int meta_data_add_boolean */
475 /*
476 * Get functions
477 */
478 int meta_data_get_string (meta_data_t *md, /* {{{ */
479 const char *key, char **value)
480 {
481 meta_entry_t *e;
482 char *temp;
484 if ((md == NULL) || (key == NULL) || (value == NULL))
485 return (-EINVAL);
487 pthread_mutex_lock (&md->lock);
489 e = md_entry_lookup (md, key);
490 if (e == NULL)
491 {
492 pthread_mutex_unlock (&md->lock);
493 return (-ENOENT);
494 }
496 if (e->type != MD_TYPE_STRING)
497 {
498 ERROR ("meta_data_get_string: Type mismatch for key `%s'", e->key);
499 pthread_mutex_unlock (&md->lock);
500 return (-ENOENT);
501 }
503 temp = md_strdup (e->value.mv_string);
504 if (temp == NULL)
505 {
506 pthread_mutex_unlock (&md->lock);
507 ERROR ("meta_data_get_string: md_strdup failed.");
508 return (-ENOMEM);
509 }
511 pthread_mutex_unlock (&md->lock);
513 *value = temp;
515 return (0);
516 } /* }}} int meta_data_get_string */
518 int meta_data_get_signed_int (meta_data_t *md, /* {{{ */
519 const char *key, int64_t *value)
520 {
521 meta_entry_t *e;
523 if ((md == NULL) || (key == NULL) || (value == NULL))
524 return (-EINVAL);
526 pthread_mutex_lock (&md->lock);
528 e = md_entry_lookup (md, key);
529 if (e == NULL)
530 {
531 pthread_mutex_unlock (&md->lock);
532 return (-ENOENT);
533 }
535 if (e->type != MD_TYPE_SIGNED_INT)
536 {
537 ERROR ("meta_data_get_signed_int: Type mismatch for key `%s'", e->key);
538 pthread_mutex_unlock (&md->lock);
539 return (-ENOENT);
540 }
542 *value = e->value.mv_signed_int;
544 pthread_mutex_unlock (&md->lock);
545 return (0);
546 } /* }}} int meta_data_get_signed_int */
548 int meta_data_get_unsigned_int (meta_data_t *md, /* {{{ */
549 const char *key, uint64_t *value)
550 {
551 meta_entry_t *e;
553 if ((md == NULL) || (key == NULL) || (value == NULL))
554 return (-EINVAL);
556 pthread_mutex_lock (&md->lock);
558 e = md_entry_lookup (md, key);
559 if (e == NULL)
560 {
561 pthread_mutex_unlock (&md->lock);
562 return (-ENOENT);
563 }
565 if (e->type != MD_TYPE_UNSIGNED_INT)
566 {
567 ERROR ("meta_data_get_unsigned_int: Type mismatch for key `%s'", e->key);
568 pthread_mutex_unlock (&md->lock);
569 return (-ENOENT);
570 }
572 *value = e->value.mv_unsigned_int;
574 pthread_mutex_unlock (&md->lock);
575 return (0);
576 } /* }}} int meta_data_get_unsigned_int */
578 int meta_data_get_double (meta_data_t *md, /* {{{ */
579 const char *key, double *value)
580 {
581 meta_entry_t *e;
583 if ((md == NULL) || (key == NULL) || (value == NULL))
584 return (-EINVAL);
586 pthread_mutex_lock (&md->lock);
588 e = md_entry_lookup (md, key);
589 if (e == NULL)
590 {
591 pthread_mutex_unlock (&md->lock);
592 return (-ENOENT);
593 }
595 if (e->type != MD_TYPE_DOUBLE)
596 {
597 ERROR ("meta_data_get_double: Type mismatch for key `%s'", e->key);
598 pthread_mutex_unlock (&md->lock);
599 return (-ENOENT);
600 }
602 *value = e->value.mv_double;
604 pthread_mutex_unlock (&md->lock);
605 return (0);
606 } /* }}} int meta_data_get_double */
608 int meta_data_get_boolean (meta_data_t *md, /* {{{ */
609 const char *key, _Bool *value)
610 {
611 meta_entry_t *e;
613 if ((md == NULL) || (key == NULL) || (value == NULL))
614 return (-EINVAL);
616 pthread_mutex_lock (&md->lock);
618 e = md_entry_lookup (md, key);
619 if (e == NULL)
620 {
621 pthread_mutex_unlock (&md->lock);
622 return (-ENOENT);
623 }
625 if (e->type != MD_TYPE_BOOLEAN)
626 {
627 ERROR ("meta_data_get_boolean: Type mismatch for key `%s'", e->key);
628 pthread_mutex_unlock (&md->lock);
629 return (-ENOENT);
630 }
632 *value = e->value.mv_boolean;
634 pthread_mutex_unlock (&md->lock);
635 return (0);
636 } /* }}} int meta_data_get_boolean */
638 /* vim: set sw=2 sts=2 et fdm=marker : */