2 * collectd - src/table.c
3 * Copyright (C) 2009 Sebastian Harl
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 * Sebastian Harl <sh at tokkee.org>
28 * This module provides generic means to parse and dispatch tabular data.
37 #define log_err(...) ERROR("table plugin: " __VA_ARGS__)
38 #define log_warn(...) WARNING("table plugin: " __VA_ARGS__)
46 char *instance_prefix;
61 tbl_result_t *results;
67 static void tbl_result_setup(tbl_result_t *res) {
70 res->instance_prefix = NULL;
71 res->instances = NULL;
72 res->instances_num = 0;
78 } /* tbl_result_setup */
80 static void tbl_result_clear(tbl_result_t *res) {
87 sfree(res->instance_prefix);
88 sfree(res->instances);
89 res->instances_num = 0;
95 } /* tbl_result_clear */
97 static void tbl_setup(tbl_t *tbl, char *file) {
98 tbl->file = sstrdup(file);
100 tbl->plugin_name = NULL;
101 tbl->instance = NULL;
104 tbl->results_num = 0;
109 static void tbl_clear(tbl_t *tbl) {
116 sfree(tbl->plugin_name);
117 sfree(tbl->instance);
119 /* (tbl->results == NULL) -> (tbl->results_num == 0) */
120 assert((tbl->results != NULL) || (tbl->results_num == 0));
121 for (size_t i = 0; i < tbl->results_num; ++i)
122 tbl_result_clear(tbl->results + i);
124 tbl->results_num = 0;
129 static tbl_t *tables;
130 static size_t tables_num;
133 * configuration handling
136 static int tbl_config_set_s(char *name, char **var, oconfig_item_t *ci) {
137 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
138 log_err("\"%s\" expects a single string argument.", name);
143 *var = sstrdup(ci->values[0].value.string);
145 } /* tbl_config_set_separator */
147 static int tbl_config_append_array_i(char *name, size_t **var, size_t *len,
148 oconfig_item_t *ci) {
152 if (1 > ci->values_num) {
153 log_err("\"%s\" expects at least one argument.", name);
157 num = (size_t)ci->values_num;
158 for (size_t i = 0; i < num; ++i) {
159 if (OCONFIG_TYPE_NUMBER != ci->values[i].type) {
160 log_err("\"%s\" expects numerical arguments only.", name);
165 tmp = realloc(*var, ((*len) + num) * sizeof(**var));
168 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
173 for (size_t i = 0; i < num; ++i) {
174 (*var)[*len] = (size_t)ci->values[i].value.number;
179 } /* tbl_config_append_array_s */
181 static int tbl_config_result(tbl_t *tbl, oconfig_item_t *ci) {
182 if (0 != ci->values_num) {
183 log_err("<Result> does not expect any arguments.");
188 realloc(tbl->results, (tbl->results_num + 1) * sizeof(*tbl->results));
191 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
197 res = tbl->results + tbl->results_num;
198 tbl_result_setup(res);
200 for (int i = 0; i < ci->children_num; ++i) {
201 oconfig_item_t *c = ci->children + i;
203 if (0 == strcasecmp(c->key, "Type"))
204 tbl_config_set_s(c->key, &res->type, c);
205 else if (0 == strcasecmp(c->key, "InstancePrefix"))
206 tbl_config_set_s(c->key, &res->instance_prefix, c);
207 else if (0 == strcasecmp(c->key, "InstancesFrom"))
208 tbl_config_append_array_i(c->key, &res->instances, &res->instances_num,
210 else if (0 == strcasecmp(c->key, "ValuesFrom"))
211 tbl_config_append_array_i(c->key, &res->values, &res->values_num, c);
213 log_warn("Ignoring unknown config key \"%s\" "
219 if (NULL == res->type) {
220 log_err("No \"Type\" option specified for <Result> in table \"%s\".",
225 if (NULL == res->values) {
226 log_err("No \"ValuesFrom\" option specified for <Result> in table \"%s\".",
232 tbl_result_clear(res);
238 } /* tbl_config_result */
240 static int tbl_config_table(oconfig_item_t *ci) {
241 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
242 log_err("<Table> expects a single string argument.");
246 tbl_t *tbl = realloc(tables, (tables_num + 1) * sizeof(*tables));
249 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
255 tbl = tables + tables_num;
256 tbl_setup(tbl, ci->values[0].value.string);
258 for (size_t i = 0; i < ((size_t)ci->children_num); ++i) {
259 oconfig_item_t *c = ci->children + i;
261 if (0 == strcasecmp(c->key, "Separator"))
262 tbl_config_set_s(c->key, &tbl->sep, c);
263 else if (0 == strcasecmp(c->key, "Plugin"))
264 tbl_config_set_s(c->key, &tbl->plugin_name, c);
265 else if (0 == strcasecmp(c->key, "Instance"))
266 tbl_config_set_s(c->key, &tbl->instance, c);
267 else if (0 == strcasecmp(c->key, "Result"))
268 tbl_config_result(tbl, c);
270 log_warn("Ignoring unknown config key \"%s\" "
276 if (NULL == tbl->sep) {
277 log_err("Table \"%s\" does not specify any separator.", tbl->file);
280 strunescape(tbl->sep, strlen(tbl->sep) + 1);
283 if (NULL == tbl->instance) {
284 tbl->instance = sstrdup(tbl->file);
285 replace_special(tbl->instance, strlen(tbl->instance));
288 if (NULL == tbl->results) {
289 assert(tbl->results_num == 0);
290 log_err("Table \"%s\" does not specify any (valid) results.", tbl->file);
299 for (size_t i = 0; i < tbl->results_num; ++i) {
300 tbl_result_t *res = tbl->results + i;
302 for (size_t j = 0; j < res->instances_num; ++j)
303 if (res->instances[j] > tbl->max_colnum)
304 tbl->max_colnum = res->instances[j];
306 for (size_t j = 0; j < res->values_num; ++j)
307 if (res->values[j] > tbl->max_colnum)
308 tbl->max_colnum = res->values[j];
313 } /* tbl_config_table */
315 static int tbl_config(oconfig_item_t *ci) {
316 for (int i = 0; i < ci->children_num; ++i) {
317 oconfig_item_t *c = ci->children + i;
319 if (0 == strcasecmp(c->key, "Table"))
322 log_warn("Ignoring unknown config key \"%s\".", c->key);
331 static int tbl_prepare(tbl_t *tbl) {
332 for (size_t i = 0; i < tbl->results_num; ++i) {
333 tbl_result_t *res = tbl->results + i;
335 res->ds = plugin_get_ds(res->type);
336 if (NULL == res->ds) {
337 log_err("Unknown type \"%s\". See types.db(5) for details.", res->type);
341 if (res->values_num != res->ds->ds_num) {
342 log_err("Invalid type \"%s\". Expected %zu data source%s, "
344 res->type, res->values_num, (1 == res->values_num) ? "" : "s",
352 static int tbl_finish(tbl_t *tbl) {
353 for (size_t i = 0; i < tbl->results_num; ++i)
354 tbl->results[i].ds = NULL;
358 static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields,
360 value_list_t vl = VALUE_LIST_INIT;
361 value_t values[res->values_num];
363 assert(NULL != res->ds);
364 assert(res->values_num == res->ds->ds_num);
366 for (size_t i = 0; i < res->values_num; ++i) {
369 assert(res->values[i] < fields_num);
370 value = fields[res->values[i]];
372 if (0 != parse_value(value, &values[i], res->ds->ds[i].type))
377 vl.values_len = STATIC_ARRAY_SIZE(values);
379 sstrncpy(vl.plugin, (tbl->plugin_name != NULL) ? tbl->plugin_name : "table",
381 sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance));
382 sstrncpy(vl.type, res->type, sizeof(vl.type));
384 if (0 == res->instances_num) {
385 if (NULL != res->instance_prefix)
386 sstrncpy(vl.type_instance, res->instance_prefix,
387 sizeof(vl.type_instance));
389 char *instances[res->instances_num];
390 char instances_str[DATA_MAX_NAME_LEN];
392 for (size_t i = 0; i < res->instances_num; ++i) {
393 assert(res->instances[i] < fields_num);
394 instances[i] = fields[res->instances[i]];
397 strjoin(instances_str, sizeof(instances_str), instances,
398 STATIC_ARRAY_SIZE(instances), "-");
399 instances_str[sizeof(instances_str) - 1] = '\0';
401 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
402 if (NULL == res->instance_prefix)
403 strncpy(vl.type_instance, instances_str, sizeof(vl.type_instance));
405 snprintf(vl.type_instance, sizeof(vl.type_instance), "%s-%s",
406 res->instance_prefix, instances_str);
408 if ('\0' != vl.type_instance[sizeof(vl.type_instance) - 1]) {
409 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
410 log_warn("Truncated type instance: %s.", vl.type_instance);
414 plugin_dispatch_values(&vl);
416 } /* tbl_result_dispatch */
418 static int tbl_parse_line(tbl_t *tbl, char *line, size_t len) {
419 char *fields[tbl->max_colnum + 1];
426 while (NULL != (fields[i] = strtok_r(ptr, tbl->sep, &saveptr))) {
430 if (i > tbl->max_colnum)
434 if (i <= tbl->max_colnum) {
435 log_warn("Not enough columns in line "
436 "(expected at least %zu, got %zu).",
437 tbl->max_colnum + 1, i);
441 for (i = 0; i < tbl->results_num; ++i)
442 if (0 != tbl_result_dispatch(tbl, tbl->results + i, fields,
443 STATIC_ARRAY_SIZE(fields))) {
444 log_err("Failed to dispatch result.");
448 } /* tbl_parse_line */
450 static int tbl_read_table(tbl_t *tbl) {
454 fh = fopen(tbl->file, "r");
457 log_err("Failed to open file \"%s\": %s.", tbl->file,
458 sstrerror(errno, errbuf, sizeof(errbuf)));
462 buf[sizeof(buf) - 1] = '\0';
463 while (NULL != fgets(buf, sizeof(buf), fh)) {
464 if ('\0' != buf[sizeof(buf) - 1]) {
465 buf[sizeof(buf) - 1] = '\0';
466 log_warn("Table %s: Truncated line: %s", tbl->file, buf);
469 if (0 != tbl_parse_line(tbl, buf, sizeof(buf))) {
470 log_warn("Table %s: Failed to parse line: %s", tbl->file, buf);
475 if (0 != ferror(fh)) {
477 log_err("Failed to read from file \"%s\": %s.", tbl->file,
478 sstrerror(errno, errbuf, sizeof(errbuf)));
485 } /* tbl_read_table */
491 static int tbl_read(void) {
497 for (size_t i = 0; i < tables_num; ++i) {
498 tbl_t *tbl = tables + i;
500 if (0 != tbl_prepare(tbl)) {
501 log_err("Failed to prepare and parse table \"%s\".", tbl->file);
505 if (0 == tbl_read_table(tbl))
513 static int tbl_shutdown(void) {
514 for (size_t i = 0; i < tables_num; ++i)
515 tbl_clear(&tables[i]);
520 static int tbl_init(void) {
524 plugin_register_read("table", tbl_read);
525 plugin_register_shutdown("table", tbl_shutdown);
529 void module_register(void) {
530 plugin_register_complex_config("table", tbl_config);
531 plugin_register_init("table", tbl_init);
532 } /* module_register */