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 (ci->values_num != 1 || ci->values[0].type != OCONFIG_TYPE_STRING) {
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) {
149 if (ci->values_num < 1) {
150 log_err("\"%s\" expects at least one argument.", name);
154 size_t num = ci->values_num;
155 for (size_t i = 0; i < num; ++i) {
156 if (OCONFIG_TYPE_NUMBER != ci->values[i].type) {
157 log_err("\"%s\" expects numerical arguments only.", name);
162 size_t *tmp = realloc(*var, ((*len) + num) * sizeof(**var));
164 log_err("realloc failed: %s.", STRERRNO);
169 for (size_t i = 0; i < num; ++i) {
170 (*var)[*len] = (size_t)ci->values[i].value.number;
175 } /* tbl_config_append_array_s */
177 static int tbl_config_result(tbl_t *tbl, oconfig_item_t *ci) {
178 if (ci->values_num != 0) {
179 log_err("<Result> does not expect any arguments.");
184 realloc(tbl->results, (tbl->results_num + 1) * sizeof(*tbl->results));
186 log_err("realloc failed: %s.", STRERRNO);
192 res = tbl->results + tbl->results_num;
193 tbl_result_setup(res);
195 for (int i = 0; i < ci->children_num; ++i) {
196 oconfig_item_t *c = ci->children + i;
198 if (strcasecmp(c->key, "Type") == 0)
199 tbl_config_set_s(c->key, &res->type, c);
200 else if (strcasecmp(c->key, "InstancePrefix") == 0)
201 tbl_config_set_s(c->key, &res->instance_prefix, c);
202 else if (strcasecmp(c->key, "InstancesFrom") == 0)
203 tbl_config_append_array_i(c->key, &res->instances, &res->instances_num,
205 else if (strcasecmp(c->key, "ValuesFrom") == 0)
206 tbl_config_append_array_i(c->key, &res->values, &res->values_num, c);
208 log_warn("Ignoring unknown config key \"%s\" "
214 if (res->type == NULL) {
215 log_err("No \"Type\" option specified for <Result> in table \"%s\".",
220 if (res->values == NULL) {
221 log_err("No \"ValuesFrom\" option specified for <Result> in table \"%s\".",
227 tbl_result_clear(res);
233 } /* tbl_config_result */
235 static int tbl_config_table(oconfig_item_t *ci) {
236 if (ci->values_num != 1 || ci->values[0].type != OCONFIG_TYPE_STRING) {
237 log_err("<Table> expects a single string argument.");
241 tbl_t *tbl = realloc(tables, (tables_num + 1) * sizeof(*tables));
243 log_err("realloc failed: %s.", STRERRNO);
249 tbl = tables + tables_num;
250 tbl_setup(tbl, ci->values[0].value.string);
252 for (int i = 0; i < ci->children_num; i++) {
253 oconfig_item_t *c = ci->children + i;
255 if (strcasecmp(c->key, "Separator") == 0)
256 tbl_config_set_s(c->key, &tbl->sep, c);
257 else if (strcasecmp(c->key, "Plugin") == 0)
258 tbl_config_set_s(c->key, &tbl->plugin_name, c);
259 else if (strcasecmp(c->key, "Instance") == 0)
260 tbl_config_set_s(c->key, &tbl->instance, c);
261 else if (strcasecmp(c->key, "Result") == 0)
262 tbl_config_result(tbl, c);
264 log_warn("Ignoring unknown config key \"%s\" "
270 if (tbl->sep == NULL) {
271 log_err("Table \"%s\" does not specify any separator.", tbl->file);
274 strunescape(tbl->sep, strlen(tbl->sep) + 1);
277 if (tbl->instance == NULL) {
278 tbl->instance = sstrdup(tbl->file);
279 replace_special(tbl->instance, strlen(tbl->instance));
282 if (tbl->results == NULL) {
283 assert(tbl->results_num == 0);
284 log_err("Table \"%s\" does not specify any (valid) results.", tbl->file);
293 for (size_t i = 0; i < tbl->results_num; ++i) {
294 tbl_result_t *res = tbl->results + i;
296 for (size_t j = 0; j < res->instances_num; ++j)
297 if (res->instances[j] > tbl->max_colnum)
298 tbl->max_colnum = res->instances[j];
300 for (size_t j = 0; j < res->values_num; ++j)
301 if (res->values[j] > tbl->max_colnum)
302 tbl->max_colnum = res->values[j];
307 } /* tbl_config_table */
309 static int tbl_config(oconfig_item_t *ci) {
310 for (int i = 0; i < ci->children_num; ++i) {
311 oconfig_item_t *c = ci->children + i;
313 if (strcasecmp(c->key, "Table") == 0)
316 log_warn("Ignoring unknown config key \"%s\".", c->key);
325 static int tbl_prepare(tbl_t *tbl) {
326 for (size_t i = 0; i < tbl->results_num; ++i) {
327 tbl_result_t *res = tbl->results + i;
329 res->ds = plugin_get_ds(res->type);
330 if (res->ds == NULL) {
331 log_err("Unknown type \"%s\". See types.db(5) for details.", res->type);
335 if (res->values_num != res->ds->ds_num) {
336 log_err("Invalid type \"%s\". Expected %" PRIsz " data source%s, "
338 res->type, res->values_num, (1 == res->values_num) ? "" : "s",
346 static int tbl_finish(tbl_t *tbl) {
347 for (size_t i = 0; i < tbl->results_num; ++i)
348 tbl->results[i].ds = NULL;
352 static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields,
354 value_list_t vl = VALUE_LIST_INIT;
355 value_t values[res->values_num];
358 assert(res->values_num == res->ds->ds_num);
360 for (size_t i = 0; i < res->values_num; ++i) {
361 assert(res->values[i] < fields_num);
362 char *value = fields[res->values[i]];
363 if (parse_value(value, &values[i], res->ds->ds[i].type) != 0)
368 vl.values_len = STATIC_ARRAY_SIZE(values);
370 sstrncpy(vl.plugin, (tbl->plugin_name != NULL) ? tbl->plugin_name : "table",
372 sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance));
373 sstrncpy(vl.type, res->type, sizeof(vl.type));
375 if (res->instances_num == 0) {
376 if (res->instance_prefix)
377 sstrncpy(vl.type_instance, res->instance_prefix,
378 sizeof(vl.type_instance));
380 char *instances[res->instances_num];
381 char instances_str[DATA_MAX_NAME_LEN];
383 for (size_t i = 0; i < res->instances_num; ++i) {
384 assert(res->instances[i] < fields_num);
385 instances[i] = fields[res->instances[i]];
388 strjoin(instances_str, sizeof(instances_str), instances,
389 STATIC_ARRAY_SIZE(instances), "-");
390 instances_str[sizeof(instances_str) - 1] = '\0';
393 if (res->instance_prefix == NULL)
394 r = snprintf(vl.type_instance, sizeof(vl.type_instance), "%s",
397 r = snprintf(vl.type_instance, sizeof(vl.type_instance), "%s-%s",
398 res->instance_prefix, instances_str);
399 if ((size_t)r >= sizeof(vl.type_instance))
400 log_warn("Truncated type instance: %s.", vl.type_instance);
403 plugin_dispatch_values(&vl);
405 } /* tbl_result_dispatch */
407 static int tbl_parse_line(tbl_t *tbl, char *line, size_t len) {
408 char *fields[tbl->max_colnum + 1];
412 char *saveptr = NULL;
413 while ((fields[i] = strtok_r(ptr, tbl->sep, &saveptr)) != NULL) {
417 if (i > tbl->max_colnum)
421 if (i <= tbl->max_colnum) {
422 log_warn("Not enough columns in line "
423 "(expected at least %" PRIsz ", got %" PRIsz ").",
424 tbl->max_colnum + 1, i);
428 for (i = 0; i < tbl->results_num; ++i)
429 if (tbl_result_dispatch(tbl, tbl->results + i, fields,
430 STATIC_ARRAY_SIZE(fields)) != 0) {
431 log_err("Failed to dispatch result.");
435 } /* tbl_parse_line */
437 static int tbl_read_table(tbl_t *tbl) {
440 FILE *fh = fopen(tbl->file, "r");
442 log_err("Failed to open file \"%s\": %s.", tbl->file, STRERRNO);
446 buf[sizeof(buf) - 1] = '\0';
447 while (fgets(buf, sizeof(buf), fh) != NULL) {
448 if (buf[sizeof(buf) - 1] != '\0') {
449 buf[sizeof(buf) - 1] = '\0';
450 log_warn("Table %s: Truncated line: %s", tbl->file, buf);
453 if (tbl_parse_line(tbl, buf, sizeof(buf)) != 0) {
454 log_warn("Table %s: Failed to parse line: %s", tbl->file, buf);
459 if (ferror(fh) != 0) {
460 log_err("Failed to read from file \"%s\": %s.", tbl->file, STRERRNO);
467 } /* tbl_read_table */
473 static int tbl_read(void) {
479 for (size_t i = 0; i < tables_num; ++i) {
480 tbl_t *tbl = tables + i;
482 if (tbl_prepare(tbl) != 0) {
483 log_err("Failed to prepare and parse table \"%s\".", tbl->file);
487 if (tbl_read_table(tbl) == 0)
495 static int tbl_shutdown(void) {
496 for (size_t i = 0; i < tables_num; ++i)
497 tbl_clear(&tables[i]);
502 static int tbl_init(void) {
506 plugin_register_read("table", tbl_read);
507 plugin_register_shutdown("table", tbl_shutdown);
511 void module_register(void) {
512 plugin_register_complex_config("table", tbl_config);
513 plugin_register_init("table", tbl_init);
514 } /* module_register */