src/meta_data.c

   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  **/
  21
  22 #include "collectd.h"
  23 #include "plugin.h"
  24 #include "meta_data.h"
  25
  26 #include <pthread.h>
  27
  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;
  40
  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 };
  50
  51 struct meta_data_s
  52 {
  53   meta_entry_t   *head;
  54   pthread_mutex_t lock;
  55 };
  56
  57 /*
  58  * Private functions
  59  */
  60 static char *md_strdup (const char *orig) /* {{{ */
  61 {
  62   size_t sz;
  63   char *dest;
  64
  65   if (orig == NULL)
  66     return (NULL);
  67
  68   sz = strlen (orig) + 1;
  69   dest = (char *) malloc (sz);
  70   if (dest == NULL)
  71     return (NULL);
  72
  73   memcpy (dest, orig, sz);
  74
  75   return (dest);
  76 } /* }}} char *md_strdup */
  77
  78 static meta_entry_t *md_entry_alloc (const char *key) /* {{{ */
  79 {
  80   meta_entry_t *e;
  81
  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));
  89
  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   }
  97
  98   e->type = 0;
  99   e->next = NULL;
 100
 101   return (e);
 102 } /* }}} meta_entry_t *md_entry_alloc */
 103
 104 static meta_entry_t *md_entry_clone (const meta_entry_t *orig) /* {{{ */
 105 {
 106   meta_entry_t *copy;
 107
 108   if (orig == NULL)
 109     return (NULL);
 110
 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;
 117
 118   copy->next = md_entry_clone (orig->next);
 119   return (copy);
 120 } /* }}} meta_entry_t *md_entry_clone */
 121
 122 static void md_entry_free (meta_entry_t *e) /* {{{ */
 123 {
 124   if (e == NULL)
 125     return;
 126
 127   free (e->key);
 128
 129   if (e->type == MD_TYPE_STRING)
 130     free (e->value.mv_string);
 131
 132   if (e->next != NULL)
 133     md_entry_free (e->next);
 134
 135   free (e);
 136 } /* }}} void md_entry_free */
 137
 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;
 142
 143   if ((md == NULL) || (e == NULL))
 144     return (-EINVAL);
 145
 146   pthread_mutex_lock (&md->lock);
 147
 148   prev = NULL;
 149   this = md->head;
 150   while (this != NULL)
 151   {
 152     if (strcasecmp (e->key, this->key) == 0)
 153       break;
 154
 155     prev = this;
 156     this = this->next;
 157   }
 158
 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     }
 169
 170     e->next = NULL;
 171   }
 172   else /* (this != NULL) */
 173   {
 174     if (prev == NULL)
 175       md->head = e;
 176     else
 177       prev->next = e;
 178
 179     e->next = this->next;
 180   }
 181
 182   pthread_mutex_unlock (&md->lock);
 183
 184   if (this != NULL)
 185   {
 186     this->next = NULL;
 187     md_entry_free (this);
 188   }
 189
 190   return (0);
 191 } /* }}} int md_entry_insert */
 192
 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;
 198
 199   if ((md == NULL) || (key == NULL))
 200     return (NULL);
 201
 202   for (e = md->head; e != NULL; e = e->next)
 203     if (strcasecmp (key, e->key) == 0)
 204       break;
 205
 206   return (e);
 207 } /* }}} meta_entry_t *md_entry_lookup */
 208
 209 /*
 210  * Public functions
 211  */
 212 meta_data_t *meta_data_create (void) /* {{{ */
 213 {
 214   meta_data_t *md;
 215
 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));
 223
 224   md->head = NULL;
 225   pthread_mutex_init (&md->lock, /* attr = */ NULL);
 226
 227   return (md);
 228 } /* }}} meta_data_t *meta_data_create */
 229
 230 meta_data_t *meta_data_clone (meta_data_t *orig) /* {{{ */
 231 {
 232   meta_data_t *copy;
 233
 234   if (orig == NULL)
 235     return (NULL);
 236
 237   copy = meta_data_create ();
 238   if (copy == NULL)
 239     return (NULL);
 240
 241   pthread_mutex_lock (&orig->lock);
 242   copy->head = md_entry_clone (orig->head);
 243   pthread_mutex_unlock (&orig->lock);
 244
 245   return (copy);
 246 } /* }}} meta_data_t *meta_data_clone */
 247
 248 void meta_data_destroy (meta_data_t *md) /* {{{ */
 249 {
 250   if (md == NULL)
 251     return;
 252
 253   pthread_mutex_destroy(&md->lock);
 254   md_entry_free (md->head);
 255   pthread_mutex_destroy (&md->lock);
 256   free (md);
 257 } /* }}} void meta_data_destroy */
 258
 259 int meta_data_exists (meta_data_t *md, const char *key) /* {{{ */
 260 {
 261   meta_entry_t *e;
 262
 263   if ((md == NULL) || (key == NULL))
 264     return (-EINVAL);
 265
 266   pthread_mutex_lock (&md->lock);
 267
 268   for (e = md->head; e != NULL; e = e->next)
 269   {
 270     if (strcasecmp (key, e->key) == 0)
 271     {
 272       pthread_mutex_unlock (&md->lock);
 273       return (1);
 274     }
 275   }
 276
 277   pthread_mutex_unlock (&md->lock);
 278   return (0);
 279 } /* }}} int meta_data_exists */
 280
 281 int meta_data_type (meta_data_t *md, const char *key) /* {{{ */
 282 {
 283   meta_entry_t *e;
 284
 285   if ((md == NULL) || (key == NULL))
 286     return -EINVAL;
 287
 288   pthread_mutex_lock (&md->lock);
 289
 290   for (e = md->head; e != NULL; e = e->next)
 291   {
 292     if (strcasecmp (key, e->key) == 0)
 293     {
 294       pthread_mutex_unlock (&md->lock);
 295       return e->type;
 296     }
 297   }
 298
 299   pthread_mutex_unlock (&md->lock);
 300   return 0;
 301 } /* }}} int meta_data_type */
 302
 303 int meta_data_toc (meta_data_t *md, char ***toc) /* {{{ */
 304 {
 305   int i = 0, count = 0;
 306   meta_entry_t *e;
 307
 308   if ((md == NULL) || (toc == NULL))
 309     return -EINVAL;
 310
 311   pthread_mutex_lock (&md->lock);
 312
 313   for (e = md->head; e != NULL; e = e->next)
 314     ++count;
 315
 316   if (count == 0)
 317   {
 318     pthread_mutex_unlock (&md->lock);
 319     return (count);
 320   }
 321
 322   *toc = calloc(count, sizeof(**toc));
 323   for (e = md->head; e != NULL; e = e->next)
 324     (*toc)[i++] = strdup(e->key);
 325
 326   pthread_mutex_unlock (&md->lock);
 327   return count;
 328 } /* }}} int meta_data_toc */
 329
 330 int meta_data_delete (meta_data_t *md, const char *key) /* {{{ */
 331 {
 332   meta_entry_t *this;
 333   meta_entry_t *prev;
 334
 335   if ((md == NULL) || (key == NULL))
 336     return (-EINVAL);
 337
 338   pthread_mutex_lock (&md->lock);
 339
 340   prev = NULL;
 341   this = md->head;
 342   while (this != NULL)
 343   {
 344     if (strcasecmp (key, this->key) == 0)
 345       break;
 346
 347     prev = this;
 348     this = this->next;
 349   }
 350
 351   if (this == NULL)
 352   {
 353     pthread_mutex_unlock (&md->lock);
 354     return (-ENOENT);
 355   }
 356
 357   if (prev == NULL)
 358     md->head = this->next;
 359   else
 360     prev->next = this->next;
 361
 362   pthread_mutex_unlock (&md->lock);
 363
 364   this->next = NULL;
 365   md_entry_free (this);
 366
 367   return (0);
 368 } /* }}} int meta_data_delete */
 369
 370 /*
 371  * Add functions
 372  */
 373 int meta_data_add_string (meta_data_t *md, /* {{{ */
 374     const char *key, const char *value)
 375 {
 376   meta_entry_t *e;
 377
 378   if ((md == NULL) || (key == NULL) || (value == NULL))
 379     return (-EINVAL);
 380
 381   e = md_entry_alloc (key);
 382   if (e == NULL)
 383     return (-ENOMEM);
 384
 385   e->value.mv_string = md_strdup (value);
 386   if (e->value.mv_string == NULL)
 387   {
 388     ERROR ("meta_data_add_string: md_strdup failed.");
 389     md_entry_free (e);
 390     return (-ENOMEM);
 391   }
 392   e->type = MD_TYPE_STRING;
 393
 394   return (md_entry_insert (md, e));
 395 } /* }}} int meta_data_add_string */
 396
 397 int meta_data_add_signed_int (meta_data_t *md, /* {{{ */
 398     const char *key, int64_t value)
 399 {
 400   meta_entry_t *e;
 401
 402   if ((md == NULL) || (key == NULL))
 403     return (-EINVAL);
 404
 405   e = md_entry_alloc (key);
 406   if (e == NULL)
 407     return (-ENOMEM);
 408
 409   e->value.mv_signed_int = value;
 410   e->type = MD_TYPE_SIGNED_INT;
 411
 412   return (md_entry_insert (md, e));
 413 } /* }}} int meta_data_add_signed_int */
 414
 415 int meta_data_add_unsigned_int (meta_data_t *md, /* {{{ */
 416     const char *key, uint64_t value)
 417 {
 418   meta_entry_t *e;
 419
 420   if ((md == NULL) || (key == NULL))
 421     return (-EINVAL);
 422
 423   e = md_entry_alloc (key);
 424   if (e == NULL)
 425     return (-ENOMEM);
 426
 427   e->value.mv_unsigned_int = value;
 428   e->type = MD_TYPE_UNSIGNED_INT;
 429
 430   return (md_entry_insert (md, e));
 431 } /* }}} int meta_data_add_unsigned_int */
 432
 433 int meta_data_add_double (meta_data_t *md, /* {{{ */
 434     const char *key, double value)
 435 {
 436   meta_entry_t *e;
 437
 438   if ((md == NULL) || (key == NULL))
 439     return (-EINVAL);
 440
 441   e = md_entry_alloc (key);
 442   if (e == NULL)
 443     return (-ENOMEM);
 444
 445   e->value.mv_double = value;
 446   e->type = MD_TYPE_DOUBLE;
 447
 448   return (md_entry_insert (md, e));
 449 } /* }}} int meta_data_add_double */
 450
 451 int meta_data_add_boolean (meta_data_t *md, /* {{{ */
 452     const char *key, _Bool value)
 453 {
 454   meta_entry_t *e;
 455
 456   if ((md == NULL) || (key == NULL))
 457     return (-EINVAL);
 458
 459   e = md_entry_alloc (key);
 460   if (e == NULL)
 461     return (-ENOMEM);
 462
 463   e->value.mv_boolean = value;
 464   e->type = MD_TYPE_BOOLEAN;
 465
 466   return (md_entry_insert (md, e));
 467 } /* }}} int meta_data_add_boolean */
 468
 469 /*
 470  * Get functions
 471  */
 472 int meta_data_get_string (meta_data_t *md, /* {{{ */
 473     const char *key, char **value)
 474 {
 475   meta_entry_t *e;
 476   char *temp;
 477
 478   if ((md == NULL) || (key == NULL) || (value == NULL))
 479     return (-EINVAL);
 480
 481   pthread_mutex_lock (&md->lock);
 482
 483   e = md_entry_lookup (md, key);
 484   if (e == NULL)
 485   {
 486     pthread_mutex_unlock (&md->lock);
 487     return (-ENOENT);
 488   }
 489
 490   if (e->type != MD_TYPE_STRING)
 491   {
 492     ERROR ("meta_data_get_string: Type mismatch for key `%s'", e->key);
 493     pthread_mutex_unlock (&md->lock);
 494     return (-ENOENT);
 495   }
 496
 497   temp = md_strdup (e->value.mv_string);
 498   if (temp == NULL)
 499   {
 500     pthread_mutex_unlock (&md->lock);
 501     ERROR ("meta_data_get_string: md_strdup failed.");
 502     return (-ENOMEM);
 503   }
 504
 505   pthread_mutex_unlock (&md->lock);
 506
 507   *value = temp;
 508
 509   return (0);
 510 } /* }}} int meta_data_get_string */
 511
 512 int meta_data_get_signed_int (meta_data_t *md, /* {{{ */
 513     const char *key, int64_t *value)
 514 {
 515   meta_entry_t *e;
 516
 517   if ((md == NULL) || (key == NULL) || (value == NULL))
 518     return (-EINVAL);
 519
 520   pthread_mutex_lock (&md->lock);
 521
 522   e = md_entry_lookup (md, key);
 523   if (e == NULL)
 524   {
 525     pthread_mutex_unlock (&md->lock);
 526     return (-ENOENT);
 527   }
 528
 529   if (e->type != MD_TYPE_SIGNED_INT)
 530   {
 531     ERROR ("meta_data_get_signed_int: Type mismatch for key `%s'", e->key);
 532     pthread_mutex_unlock (&md->lock);
 533     return (-ENOENT);
 534   }
 535
 536   *value = e->value.mv_signed_int;
 537
 538   pthread_mutex_unlock (&md->lock);
 539   return (0);
 540 } /* }}} int meta_data_get_signed_int */
 541
 542 int meta_data_get_unsigned_int (meta_data_t *md, /* {{{ */
 543     const char *key, uint64_t *value)
 544 {
 545   meta_entry_t *e;
 546
 547   if ((md == NULL) || (key == NULL) || (value == NULL))
 548     return (-EINVAL);
 549
 550   pthread_mutex_lock (&md->lock);
 551
 552   e = md_entry_lookup (md, key);
 553   if (e == NULL)
 554   {
 555     pthread_mutex_unlock (&md->lock);
 556     return (-ENOENT);
 557   }
 558
 559   if (e->type != MD_TYPE_UNSIGNED_INT)
 560   {
 561     ERROR ("meta_data_get_unsigned_int: Type mismatch for key `%s'", e->key);
 562     pthread_mutex_unlock (&md->lock);
 563     return (-ENOENT);
 564   }
 565
 566   *value = e->value.mv_unsigned_int;
 567
 568   pthread_mutex_unlock (&md->lock);
 569   return (0);
 570 } /* }}} int meta_data_get_unsigned_int */
 571
 572 int meta_data_get_double (meta_data_t *md, /* {{{ */
 573     const char *key, double *value)
 574 {
 575   meta_entry_t *e;
 576
 577   if ((md == NULL) || (key == NULL) || (value == NULL))
 578     return (-EINVAL);
 579
 580   pthread_mutex_lock (&md->lock);
 581
 582   e = md_entry_lookup (md, key);
 583   if (e == NULL)
 584   {
 585     pthread_mutex_unlock (&md->lock);
 586     return (-ENOENT);
 587   }
 588
 589   if (e->type != MD_TYPE_DOUBLE)
 590   {
 591     ERROR ("meta_data_get_double: Type mismatch for key `%s'", e->key);
 592     pthread_mutex_unlock (&md->lock);
 593     return (-ENOENT);
 594   }
 595
 596   *value = e->value.mv_double;
 597
 598   pthread_mutex_unlock (&md->lock);
 599   return (0);
 600 } /* }}} int meta_data_get_double */
 601
 602 int meta_data_get_boolean (meta_data_t *md, /* {{{ */
 603     const char *key, _Bool *value)
 604 {
 605   meta_entry_t *e;
 606
 607   if ((md == NULL) || (key == NULL) || (value == NULL))
 608     return (-EINVAL);
 609
 610   pthread_mutex_lock (&md->lock);
 611
 612   e = md_entry_lookup (md, key);
 613   if (e == NULL)
 614   {
 615     pthread_mutex_unlock (&md->lock);
 616     return (-ENOENT);
 617   }
 618
 619   if (e->type != MD_TYPE_BOOLEAN)
 620   {
 621     ERROR ("meta_data_get_boolean: Type mismatch for key `%s'", e->key);
 622     pthread_mutex_unlock (&md->lock);
 623     return (-ENOENT);
 624   }
 625
 626   *value = e->value.mv_boolean;
 627
 628   pthread_mutex_unlock (&md->lock);
 629   return (0);
 630 } /* }}} int meta_data_get_boolean */
 631
 632 /* vim: set sw=2 sts=2 et fdm=marker : */