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;
60 tbl_result_t *results;
66 static void tbl_result_setup(tbl_result_t *res) {
69 res->instance_prefix = NULL;
70 res->instances = NULL;
71 res->instances_num = 0;
77 } /* tbl_result_setup */
79 static void tbl_result_clear(tbl_result_t *res) {
82 sfree(res->instance_prefix);
83 sfree(res->instances);
84 res->instances_num = 0;
90 } /* tbl_result_clear */
92 static void tbl_setup(tbl_t *tbl, char *file) {
93 tbl->file = sstrdup(file);
103 static void tbl_clear(tbl_t *tbl) {
106 sfree(tbl->instance);
108 for (size_t i = 0; i < tbl->results_num; ++i)
109 tbl_result_clear(tbl->results + i);
111 tbl->results_num = 0;
116 static tbl_t *tables;
117 static size_t tables_num;
120 * configuration handling
123 static int tbl_config_set_s(char *name, char **var, oconfig_item_t *ci) {
124 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
125 log_err("\"%s\" expects a single string argument.", name);
130 *var = sstrdup(ci->values[0].value.string);
132 } /* tbl_config_set_separator */
134 static int tbl_config_append_array_i(char *name, size_t **var, size_t *len,
135 oconfig_item_t *ci) {
139 if (1 > ci->values_num) {
140 log_err("\"%s\" expects at least one argument.", name);
144 num = (size_t)ci->values_num;
145 for (size_t i = 0; i < num; ++i) {
146 if (OCONFIG_TYPE_NUMBER != ci->values[i].type) {
147 log_err("\"%s\" expects numerical arguments only.", name);
152 tmp = realloc(*var, ((*len) + num) * sizeof(**var));
155 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
160 for (size_t i = 0; i < num; ++i) {
161 (*var)[*len] = (size_t)ci->values[i].value.number;
166 } /* tbl_config_append_array_s */
168 static int tbl_config_result(tbl_t *tbl, oconfig_item_t *ci) {
169 if (0 != ci->values_num) {
170 log_err("<Result> does not expect any arguments.");
175 realloc(tbl->results, (tbl->results_num + 1) * sizeof(*tbl->results));
178 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
184 res = tbl->results + tbl->results_num;
185 tbl_result_setup(res);
187 for (int i = 0; i < ci->children_num; ++i) {
188 oconfig_item_t *c = ci->children + i;
190 if (0 == strcasecmp(c->key, "Type"))
191 tbl_config_set_s(c->key, &res->type, c);
192 else if (0 == strcasecmp(c->key, "InstancePrefix"))
193 tbl_config_set_s(c->key, &res->instance_prefix, c);
194 else if (0 == strcasecmp(c->key, "InstancesFrom"))
195 tbl_config_append_array_i(c->key, &res->instances, &res->instances_num,
197 else if (0 == strcasecmp(c->key, "ValuesFrom"))
198 tbl_config_append_array_i(c->key, &res->values, &res->values_num, c);
200 log_warn("Ignoring unknown config key \"%s\" "
206 if (NULL == res->type) {
207 log_err("No \"Type\" option specified for <Result> in table \"%s\".",
212 if (NULL == res->values) {
213 log_err("No \"ValuesFrom\" option specified for <Result> in table \"%s\".",
219 tbl_result_clear(res);
225 } /* tbl_config_result */
227 static int tbl_config_table(oconfig_item_t *ci) {
228 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
229 log_err("<Table> expects a single string argument.");
233 tbl_t *tbl = realloc(tables, (tables_num + 1) * sizeof(*tables));
236 log_err("realloc failed: %s.", sstrerror(errno, errbuf, sizeof(errbuf)));
242 tbl = tables + tables_num;
243 tbl_setup(tbl, ci->values[0].value.string);
245 for (size_t i = 0; i < ((size_t)ci->children_num); ++i) {
246 oconfig_item_t *c = ci->children + i;
248 if (0 == strcasecmp(c->key, "Separator"))
249 tbl_config_set_s(c->key, &tbl->sep, c);
250 else if (0 == strcasecmp(c->key, "Instance"))
251 tbl_config_set_s(c->key, &tbl->instance, c);
252 else if (0 == strcasecmp(c->key, "Result"))
253 tbl_config_result(tbl, c);
255 log_warn("Ignoring unknown config key \"%s\" "
261 if (NULL == tbl->sep) {
262 log_err("Table \"%s\" does not specify any separator.", tbl->file);
265 strunescape(tbl->sep, strlen(tbl->sep) + 1);
268 if (NULL == tbl->instance) {
269 tbl->instance = sstrdup(tbl->file);
270 replace_special(tbl->instance, strlen(tbl->instance));
273 if (NULL == tbl->results) {
274 assert(tbl->results_num == 0);
275 log_err("Table \"%s\" does not specify any (valid) results.", tbl->file);
284 for (size_t i = 0; i < tbl->results_num; ++i) {
285 tbl_result_t *res = tbl->results + i;
287 for (size_t j = 0; j < res->instances_num; ++j)
288 if (res->instances[j] > tbl->max_colnum)
289 tbl->max_colnum = res->instances[j];
291 for (size_t j = 0; j < res->values_num; ++j)
292 if (res->values[j] > tbl->max_colnum)
293 tbl->max_colnum = res->values[j];
298 } /* tbl_config_table */
300 static int tbl_config(oconfig_item_t *ci) {
301 for (int i = 0; i < ci->children_num; ++i) {
302 oconfig_item_t *c = ci->children + i;
304 if (0 == strcasecmp(c->key, "Table"))
307 log_warn("Ignoring unknown config key \"%s\".", c->key);
316 static int tbl_prepare(tbl_t *tbl) {
317 for (size_t i = 0; i < tbl->results_num; ++i) {
318 tbl_result_t *res = tbl->results + i;
320 res->ds = plugin_get_ds(res->type);
321 if (NULL == res->ds) {
322 log_err("Unknown type \"%s\". See types.db(5) for details.", res->type);
326 if (res->values_num != res->ds->ds_num) {
327 log_err("Invalid type \"%s\". Expected %zu data source%s, "
329 res->type, res->values_num, (1 == res->values_num) ? "" : "s",
337 static int tbl_finish(tbl_t *tbl) {
338 for (size_t i = 0; i < tbl->results_num; ++i)
339 tbl->results[i].ds = NULL;
343 static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields,
345 value_list_t vl = VALUE_LIST_INIT;
346 value_t values[res->values_num];
348 assert(NULL != res->ds);
349 assert(res->values_num == res->ds->ds_num);
351 for (size_t i = 0; i < res->values_num; ++i) {
354 assert(res->values[i] < fields_num);
355 value = fields[res->values[i]];
357 if (0 != parse_value(value, &values[i], res->ds->ds[i].type))
362 vl.values_len = STATIC_ARRAY_SIZE(values);
364 sstrncpy(vl.plugin, "table", sizeof(vl.plugin));
365 sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance));
366 sstrncpy(vl.type, res->type, sizeof(vl.type));
368 if (0 == res->instances_num) {
369 if (NULL != res->instance_prefix)
370 sstrncpy(vl.type_instance, res->instance_prefix,
371 sizeof(vl.type_instance));
373 char *instances[res->instances_num];
374 char instances_str[DATA_MAX_NAME_LEN];
376 for (size_t i = 0; i < res->instances_num; ++i) {
377 assert(res->instances[i] < fields_num);
378 instances[i] = fields[res->instances[i]];
381 strjoin(instances_str, sizeof(instances_str), instances,
382 STATIC_ARRAY_SIZE(instances), "-");
383 instances_str[sizeof(instances_str) - 1] = '\0';
385 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
386 if (NULL == res->instance_prefix)
387 strncpy(vl.type_instance, instances_str, sizeof(vl.type_instance));
389 snprintf(vl.type_instance, sizeof(vl.type_instance), "%s-%s",
390 res->instance_prefix, instances_str);
392 if ('\0' != vl.type_instance[sizeof(vl.type_instance) - 1]) {
393 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
394 log_warn("Truncated type instance: %s.", vl.type_instance);
398 plugin_dispatch_values(&vl);
400 } /* tbl_result_dispatch */
402 static int tbl_parse_line(tbl_t *tbl, char *line, size_t len) {
403 char *fields[tbl->max_colnum + 1];
410 while (NULL != (fields[i] = strtok_r(ptr, tbl->sep, &saveptr))) {
414 if (i > tbl->max_colnum)
418 if (i <= tbl->max_colnum) {
419 log_warn("Not enough columns in line "
420 "(expected at least %zu, got %zu).",
421 tbl->max_colnum + 1, i);
425 for (i = 0; i < tbl->results_num; ++i)
426 if (0 != tbl_result_dispatch(tbl, tbl->results + i, fields,
427 STATIC_ARRAY_SIZE(fields))) {
428 log_err("Failed to dispatch result.");
432 } /* tbl_parse_line */
434 static int tbl_read_table(tbl_t *tbl) {
438 fh = fopen(tbl->file, "r");
441 log_err("Failed to open file \"%s\": %s.", tbl->file,
442 sstrerror(errno, errbuf, sizeof(errbuf)));
446 buf[sizeof(buf) - 1] = '\0';
447 while (NULL != fgets(buf, sizeof(buf), fh)) {
448 if ('\0' != buf[sizeof(buf) - 1]) {
449 buf[sizeof(buf) - 1] = '\0';
450 log_warn("Table %s: Truncated line: %s", tbl->file, buf);
453 if (0 != tbl_parse_line(tbl, buf, sizeof(buf))) {
454 log_warn("Table %s: Failed to parse line: %s", tbl->file, buf);
459 if (0 != ferror(fh)) {
461 log_err("Failed to read from file \"%s\": %s.", tbl->file,
462 sstrerror(errno, errbuf, sizeof(errbuf)));
469 } /* tbl_read_table */
475 static int tbl_read(void) {
481 for (size_t i = 0; i < tables_num; ++i) {
482 tbl_t *tbl = tables + i;
484 if (0 != tbl_prepare(tbl)) {
485 log_err("Failed to prepare and parse table \"%s\".", tbl->file);
489 if (0 == tbl_read_table(tbl))
497 static int tbl_shutdown(void) {
498 for (size_t i = 0; i < tables_num; ++i)
499 tbl_clear(&tables[i]);
504 static int tbl_init(void) {
508 plugin_register_read("table", tbl_read);
509 plugin_register_shutdown("table", tbl_shutdown);
513 void module_register(void) {
514 plugin_register_complex_config("table", tbl_config);
515 plugin_register_init("table", tbl_init);
516 } /* module_register */
518 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */