src/table.c

   1 /**
   2  * collectd - src/table.c
   3  * Copyright (C) 2009       Sebastian Harl
   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  *   Sebastian Harl <sh at tokkee.org>
  25  **/
  26
  27 /*
  28  * This module provides generic means to parse and dispatch tabular data.
  29  */
  30
  31 #include "collectd.h"
  32
  33 #include "common.h"
  34
  35 #include "plugin.h"
  36
  37 #define log_err(...) ERROR("table plugin: " __VA_ARGS__)
  38 #define log_warn(...) WARNING("table plugin: " __VA_ARGS__)
  39
  40 /*
  41  * private data types
  42  */
  43
  44 typedef struct {
  45   char *type;
  46   char *instance_prefix;
  47   size_t *instances;
  48   size_t instances_num;
  49   size_t *values;
  50   size_t values_num;
  51
  52   const data_set_t *ds;
  53 } tbl_result_t;
  54
  55 typedef struct {
  56   char *file;
  57   char *sep;
  58   char *plugin_name;
  59   char *instance;
  60
  61   tbl_result_t *results;
  62   size_t results_num;
  63
  64   size_t max_colnum;
  65 } tbl_t;
  66
  67 static void tbl_result_setup(tbl_result_t *res) {
  68   res->type = NULL;
  69
  70   res->instance_prefix = NULL;
  71   res->instances = NULL;
  72   res->instances_num = 0;
  73
  74   res->values = NULL;
  75   res->values_num = 0;
  76
  77   res->ds = NULL;
  78 } /* tbl_result_setup */
  79
  80 static void tbl_result_clear(tbl_result_t *res) {
  81   sfree(res->type);
  82
  83   sfree(res->instance_prefix);
  84   sfree(res->instances);
  85   res->instances_num = 0;
  86
  87   sfree(res->values);
  88   res->values_num = 0;
  89
  90   res->ds = NULL;
  91 } /* tbl_result_clear */
  92
  93 static void tbl_setup(tbl_t *tbl, char *file) {
  94   tbl->file = sstrdup(file);
  95   tbl->sep = NULL;
  96   tbl->plugin_name = NULL;
  97   tbl->instance = NULL;
  98
  99   tbl->results = NULL;
 100   tbl->results_num = 0;
 101
 102   tbl->max_colnum = 0;
 103 } /* tbl_setup */
 104
 105 static void tbl_clear(tbl_t *tbl) {
 106   sfree(tbl->file);
 107   sfree(tbl->sep);
 108   sfree(tbl->plugin_name);
 109   sfree(tbl->instance);
 110
 111   for (size_t i = 0; i < tbl->results_num; ++i)
 112     tbl_result_clear(tbl->results + i);
 113   sfree(tbl->results);
 114   tbl->results_num = 0;
 115
 116   tbl->max_colnum = 0;
 117 } /* tbl_clear */
 118
 119 static tbl_t *tables;
 120 static size_t tables_num;
 121
 122 /*
 123  * configuration handling
 124  */
 125
 126 static int tbl_config_set_s(char *name, char **var, oconfig_item_t *ci) {
 127   if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
 128     log_err("\"%s\" expects a single string argument.", name);
 129     return 1;
 130   }
 131
 132   sfree(*var);
 133   *var = sstrdup(ci->values[0].value.string);
 134   return 0;
 135 } /* tbl_config_set_separator */
 136
 137 static int tbl_config_append_array_i(char *name, size_t **var, size_t *len,
 138                                      oconfig_item_t *ci) {
 139   size_t *tmp;
 140   size_t num;
 141
 142   if (1 > ci->values_num) {
 143     log_err("\"%s\" expects at least one argument.", name);
 144     return 1;
 145   }
 146
 147   num = (size_t)ci->values_num;
 148   for (size_t i = 0; i < num; ++i) {
 149     if (OCONFIG_TYPE_NUMBER != ci->values[i].type) {
 150       log_err("\"%s\" expects numerical arguments only.", name);
 151       return 1;
 152     }
 153   }
 154
 155   tmp = realloc(*var, ((*len) + num) * sizeof(**var));
 156   if (NULL == tmp) {
 157     char errbuf[1024];
 158     log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
 159     return -1;
 160   }
 161   *var = tmp;
 162
 163   for (size_t i = 0; i < num; ++i) {
 164     (*var)[*len] = (size_t)ci->values[i].value.number;
 165     (*len)++;
 166   }
 167
 168   return 0;
 169 } /* tbl_config_append_array_s */
 170
 171 static int tbl_config_result(tbl_t *tbl, oconfig_item_t *ci) {
 172   if (0 != ci->values_num) {
 173     log_err("<Result> does not expect any arguments.");
 174     return 1;
 175   }
 176
 177   tbl_result_t *res =
 178       realloc(tbl->results, (tbl->results_num + 1) * sizeof(*tbl->results));
 179   if (res == NULL) {
 180     char errbuf[1024];
 181     log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
 182     return -1;
 183   }
 184
 185   tbl->results = res;
 186
 187   res = tbl->results + tbl->results_num;
 188   tbl_result_setup(res);
 189
 190   for (int i = 0; i < ci->children_num; ++i) {
 191     oconfig_item_t *c = ci->children + i;
 192
 193     if (0 == strcasecmp(c->key, "Type"))
 194       tbl_config_set_s(c->key, &res->type, c);
 195     else if (0 == strcasecmp(c->key, "InstancePrefix"))
 196       tbl_config_set_s(c->key, &res->instance_prefix, c);
 197     else if (0 == strcasecmp(c->key, "InstancesFrom"))
 198       tbl_config_append_array_i(c->key, &res->instances, &res->instances_num,
 199                                 c);
 200     else if (0 == strcasecmp(c->key, "ValuesFrom"))
 201       tbl_config_append_array_i(c->key, &res->values, &res->values_num, c);
 202     else
 203       log_warn("Ignoring unknown config key \"%s\" "
 204                " in <Result>.",
 205                c->key);
 206   }
 207
 208   int status = 0;
 209   if (NULL == res->type) {
 210     log_err("No \"Type\" option specified for <Result> in table \"%s\".",
 211             tbl->file);
 212     status = 1;
 213   }
 214
 215   if (NULL == res->values) {
 216     log_err("No \"ValuesFrom\" option specified for <Result> in table \"%s\".",
 217             tbl->file);
 218     status = 1;
 219   }
 220
 221   if (0 != status) {
 222     tbl_result_clear(res);
 223     return status;
 224   }
 225
 226   tbl->results_num++;
 227   return 0;
 228 } /* tbl_config_result */
 229
 230 static int tbl_config_table(oconfig_item_t *ci) {
 231   if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
 232     log_err("<Table> expects a single string argument.");
 233     return 1;
 234   }
 235
 236   tbl_t *tbl = realloc(tables, (tables_num + 1) * sizeof(*tables));
 237   if (NULL == tbl) {
 238     char errbuf[1024];
 239     log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
 240     return -1;
 241   }
 242
 243   tables = tbl;
 244
 245   tbl = tables + tables_num;
 246   tbl_setup(tbl, ci->values[0].value.string);
 247
 248   for (size_t i = 0; i < ((size_t)ci->children_num); ++i) {
 249     oconfig_item_t *c = ci->children + i;
 250
 251     if (0 == strcasecmp(c->key, "Separator"))
 252       tbl_config_set_s(c->key, &tbl->sep, c);
 253     else if (0 == strcasecmp(c->key, "Plugin"))
 254       tbl_config_set_s(c->key, &tbl->plugin_name, c);
 255     else if (0 == strcasecmp(c->key, "Instance"))
 256       tbl_config_set_s(c->key, &tbl->instance, c);
 257     else if (0 == strcasecmp(c->key, "Result"))
 258       tbl_config_result(tbl, c);
 259     else
 260       log_warn("Ignoring unknown config key \"%s\" "
 261                "in <Table %s>.",
 262                c->key, tbl->file);
 263   }
 264
 265   int status = 0;
 266   if (NULL == tbl->sep) {
 267     log_err("Table \"%s\" does not specify any separator.", tbl->file);
 268     status = 1;
 269   } else {
 270     strunescape(tbl->sep, strlen(tbl->sep) + 1);
 271   }
 272
 273   if (NULL == tbl->instance) {
 274     tbl->instance = sstrdup(tbl->file);
 275     replace_special(tbl->instance, strlen(tbl->instance));
 276   }
 277
 278   if (NULL == tbl->results) {
 279     assert(tbl->results_num == 0);
 280     log_err("Table \"%s\" does not specify any (valid) results.", tbl->file);
 281     status = 1;
 282   }
 283
 284   if (0 != status) {
 285     tbl_clear(tbl);
 286     return status;
 287   }
 288
 289   for (size_t i = 0; i < tbl->results_num; ++i) {
 290     tbl_result_t *res = tbl->results + i;
 291
 292     for (size_t j = 0; j < res->instances_num; ++j)
 293       if (res->instances[j] > tbl->max_colnum)
 294         tbl->max_colnum = res->instances[j];
 295
 296     for (size_t j = 0; j < res->values_num; ++j)
 297       if (res->values[j] > tbl->max_colnum)
 298         tbl->max_colnum = res->values[j];
 299   }
 300
 301   tables_num++;
 302   return 0;
 303 } /* tbl_config_table */
 304
 305 static int tbl_config(oconfig_item_t *ci) {
 306   for (int i = 0; i < ci->children_num; ++i) {
 307     oconfig_item_t *c = ci->children + i;
 308
 309     if (0 == strcasecmp(c->key, "Table"))
 310       tbl_config_table(c);
 311     else
 312       log_warn("Ignoring unknown config key \"%s\".", c->key);
 313   }
 314   return 0;
 315 } /* tbl_config */
 316
 317 /*
 318  * result handling
 319  */
 320
 321 static int tbl_prepare(tbl_t *tbl) {
 322   for (size_t i = 0; i < tbl->results_num; ++i) {
 323     tbl_result_t *res = tbl->results + i;
 324
 325     res->ds = plugin_get_ds(res->type);
 326     if (NULL == res->ds) {
 327       log_err("Unknown type \"%s\". See types.db(5) for details.", res->type);
 328       return -1;
 329     }
 330
 331     if (res->values_num != res->ds->ds_num) {
 332       log_err("Invalid type \"%s\". Expected %zu data source%s, "
 333               "got %zu.",
 334               res->type, res->values_num, (1 == res->values_num) ? "" : "s",
 335               res->ds->ds_num);
 336       return -1;
 337     }
 338   }
 339   return 0;
 340 } /* tbl_prepare */
 341
 342 static int tbl_finish(tbl_t *tbl) {
 343   for (size_t i = 0; i < tbl->results_num; ++i)
 344     tbl->results[i].ds = NULL;
 345   return 0;
 346 } /* tbl_finish */
 347
 348 static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields,
 349                                size_t fields_num) {
 350   value_list_t vl = VALUE_LIST_INIT;
 351   value_t values[res->values_num];
 352
 353   assert(NULL != res->ds);
 354   assert(res->values_num == res->ds->ds_num);
 355
 356   for (size_t i = 0; i < res->values_num; ++i) {
 357     char *value;
 358
 359     assert(res->values[i] < fields_num);
 360     value = fields[res->values[i]];
 361
 362     if (0 != parse_value(value, &values[i], res->ds->ds[i].type))
 363       return -1;
 364   }
 365
 366   vl.values = values;
 367   vl.values_len = STATIC_ARRAY_SIZE(values);
 368
 369   sstrncpy(vl.plugin, (tbl->plugin_name != NULL) ? tbl->plugin_name : "table",
 370            sizeof(vl.plugin));
 371   sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance));
 372   sstrncpy(vl.type, res->type, sizeof(vl.type));
 373
 374   if (0 == res->instances_num) {
 375     if (NULL != res->instance_prefix)
 376       sstrncpy(vl.type_instance, res->instance_prefix,
 377                sizeof(vl.type_instance));
 378   } else {
 379     char *instances[res->instances_num];
 380     char instances_str[DATA_MAX_NAME_LEN];
 381
 382     for (size_t i = 0; i < res->instances_num; ++i) {
 383       assert(res->instances[i] < fields_num);
 384       instances[i] = fields[res->instances[i]];
 385     }
 386
 387     strjoin(instances_str, sizeof(instances_str), instances,
 388             STATIC_ARRAY_SIZE(instances), "-");
 389     instances_str[sizeof(instances_str) - 1] = '\0';
 390
 391     vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
 392     if (NULL == res->instance_prefix)
 393       strncpy(vl.type_instance, instances_str, sizeof(vl.type_instance));
 394     else
 395       snprintf(vl.type_instance, sizeof(vl.type_instance), "%s-%s",
 396                res->instance_prefix, instances_str);
 397
 398     if ('\0' != vl.type_instance[sizeof(vl.type_instance) - 1]) {
 399       vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
 400       log_warn("Truncated type instance: %s.", vl.type_instance);
 401     }
 402   }
 403
 404   plugin_dispatch_values(&vl);
 405   return 0;
 406 } /* tbl_result_dispatch */
 407
 408 static int tbl_parse_line(tbl_t *tbl, char *line, size_t len) {
 409   char *fields[tbl->max_colnum + 1];
 410   char *ptr, *saveptr;
 411
 412   size_t i = 0;
 413
 414   ptr = line;
 415   saveptr = NULL;
 416   while (NULL != (fields[i] = strtok_r(ptr, tbl->sep, &saveptr))) {
 417     ptr = NULL;
 418     ++i;
 419
 420     if (i > tbl->max_colnum)
 421       break;
 422   }
 423
 424   if (i <= tbl->max_colnum) {
 425     log_warn("Not enough columns in line "
 426              "(expected at least %zu, got %zu).",
 427              tbl->max_colnum + 1, i);
 428     return -1;
 429   }
 430
 431   for (i = 0; i < tbl->results_num; ++i)
 432     if (0 != tbl_result_dispatch(tbl, tbl->results + i, fields,
 433                                  STATIC_ARRAY_SIZE(fields))) {
 434       log_err("Failed to dispatch result.");
 435       continue;
 436     }
 437   return 0;
 438 } /* tbl_parse_line */
 439
 440 static int tbl_read_table(tbl_t *tbl) {
 441   FILE *fh;
 442   char buf[4096];
 443
 444   fh = fopen(tbl->file, "r");
 445   if (NULL == fh) {
 446     char errbuf[1024];
 447     log_err("Failed to open file \"%s\": %s.", tbl->file,
 448             sstrerror(errno, errbuf, sizeof(errbuf)));
 449     return -1;
 450   }
 451
 452   buf[sizeof(buf) - 1] = '\0';
 453   while (NULL != fgets(buf, sizeof(buf), fh)) {
 454     if ('\0' != buf[sizeof(buf) - 1]) {
 455       buf[sizeof(buf) - 1] = '\0';
 456       log_warn("Table %s: Truncated line: %s", tbl->file, buf);
 457     }
 458
 459     if (0 != tbl_parse_line(tbl, buf, sizeof(buf))) {
 460       log_warn("Table %s: Failed to parse line: %s", tbl->file, buf);
 461       continue;
 462     }
 463   }
 464
 465   if (0 != ferror(fh)) {
 466     char errbuf[1024];
 467     log_err("Failed to read from file \"%s\": %s.", tbl->file,
 468             sstrerror(errno, errbuf, sizeof(errbuf)));
 469     fclose(fh);
 470     return -1;
 471   }
 472
 473   fclose(fh);
 474   return 0;
 475 } /* tbl_read_table */
 476
 477 /*
 478  * collectd callbacks
 479  */
 480
 481 static int tbl_read(void) {
 482   int status = -1;
 483
 484   if (0 == tables_num)
 485     return 0;
 486
 487   for (size_t i = 0; i < tables_num; ++i) {
 488     tbl_t *tbl = tables + i;
 489
 490     if (0 != tbl_prepare(tbl)) {
 491       log_err("Failed to prepare and parse table \"%s\".", tbl->file);
 492       continue;
 493     }
 494
 495     if (0 == tbl_read_table(tbl))
 496       status = 0;
 497
 498     tbl_finish(tbl);
 499   }
 500   return status;
 501 } /* tbl_read */
 502
 503 static int tbl_shutdown(void) {
 504   for (size_t i = 0; i < tables_num; ++i)
 505     tbl_clear(&tables[i]);
 506   sfree(tables);
 507   return 0;
 508 } /* tbl_shutdown */
 509
 510 static int tbl_init(void) {
 511   if (0 == tables_num)
 512     return 0;
 513
 514   plugin_register_read("table", tbl_read);
 515   plugin_register_shutdown("table", tbl_shutdown);
 516   return 0;
 517 } /* tbl_init */
 518
 519 void module_register(void) {
 520   plugin_register_complex_config("table", tbl_config);
 521   plugin_register_init("table", tbl_init);
 522 } /* module_register */