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) {
83 sfree(res->instance_prefix);
84 sfree(res->instances);
85 res->instances_num = 0;
91 } /* tbl_result_clear */
93 static void tbl_setup(tbl_t *tbl, char *file) {
94 tbl->file = sstrdup(file);
96 tbl->plugin_name = NULL;
100 tbl->results_num = 0;
105 static void tbl_clear(tbl_t *tbl) {
108 sfree(tbl->plugin_name);
109 sfree(tbl->instance);
111 for (size_t i = 0; i < tbl->results_num; ++i)
112 tbl_result_clear(tbl->results + i);
114 tbl->results_num = 0;
119 static tbl_t *tables;
120 static size_t tables_num;
123 * configuration handling
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);
133 *var = sstrdup(ci->values[0].value.string);
135 } /* tbl_config_set_separator */
137 static int tbl_config_append_array_i(char *name, size_t **var, size_t *len,
138 oconfig_item_t *ci) {
142 if (1 > ci->values_num) {
143 log_err("\"%s\" expects at least one argument.", name);
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);
155 tmp = realloc(*var, ((*len) + num) * sizeof(**var));
157 log_err("realloc failed: %s.", STRERRNO);
162 for (size_t i = 0; i < num; ++i) {
163 (*var)[*len] = (size_t)ci->values[i].value.number;
168 } /* tbl_config_append_array_s */
170 static int tbl_config_result(tbl_t *tbl, oconfig_item_t *ci) {
175 if (0 != ci->values_num) {
176 log_err("<Result> does not expect any arguments.");
180 res = realloc(tbl->results, (tbl->results_num + 1) * sizeof(*tbl->results));
182 log_err("realloc failed: %s.", STRERRNO);
189 res = tbl->results + tbl->results_num - 1;
190 tbl_result_setup(res);
192 for (int i = 0; i < ci->children_num; ++i) {
193 oconfig_item_t *c = ci->children + i;
195 if (0 == strcasecmp(c->key, "Type"))
196 tbl_config_set_s(c->key, &res->type, c);
197 else if (0 == strcasecmp(c->key, "InstancePrefix"))
198 tbl_config_set_s(c->key, &res->instance_prefix, c);
199 else if (0 == strcasecmp(c->key, "InstancesFrom"))
200 tbl_config_append_array_i(c->key, &res->instances, &res->instances_num,
202 else if (0 == strcasecmp(c->key, "ValuesFrom"))
203 tbl_config_append_array_i(c->key, &res->values, &res->values_num, c);
205 log_warn("Ignoring unknown config key \"%s\" "
210 if (NULL == res->type) {
211 log_err("No \"Type\" option specified for <Result> "
217 if (NULL == res->values) {
218 log_err("No \"ValuesFrom\" option specified for <Result> "
225 tbl_result_clear(res);
230 } /* tbl_config_result */
232 static int tbl_config_table(oconfig_item_t *ci) {
237 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
238 log_err("<Table> expects a single string argument.");
242 tbl = realloc(tables, (tables_num + 1) * sizeof(*tables));
244 log_err("realloc failed: %s.", STRERRNO);
251 tbl = tables + tables_num - 1;
252 tbl_setup(tbl, ci->values[0].value.string);
254 for (size_t i = 0; i < ((size_t)ci->children_num); ++i) {
255 oconfig_item_t *c = ci->children + i;
257 if (0 == strcasecmp(c->key, "Separator"))
258 tbl_config_set_s(c->key, &tbl->sep, c);
259 else if (0 == strcasecmp(c->key, "Plugin"))
260 tbl_config_set_s(c->key, &tbl->plugin_name, c);
261 else if (0 == strcasecmp(c->key, "Instance"))
262 tbl_config_set_s(c->key, &tbl->instance, c);
263 else if (0 == strcasecmp(c->key, "Result"))
264 tbl_config_result(tbl, c);
266 log_warn("Ignoring unknown config key \"%s\" "
271 if (NULL == tbl->sep) {
272 log_err("Table \"%s\" does not specify any separator.", tbl->file);
275 strunescape(tbl->sep, strlen(tbl->sep) + 1);
278 if (NULL == tbl->instance) {
279 tbl->instance = sstrdup(tbl->file);
280 replace_special(tbl->instance, strlen(tbl->instance));
283 if (NULL == tbl->results) {
284 log_err("Table \"%s\" does not specify any (valid) results.", tbl->file);
294 for (size_t i = 0; i < tbl->results_num; ++i) {
295 tbl_result_t *res = tbl->results + i;
297 for (size_t j = 0; j < res->instances_num; ++j)
298 if (res->instances[j] > tbl->max_colnum)
299 tbl->max_colnum = res->instances[j];
301 for (size_t j = 0; j < res->values_num; ++j)
302 if (res->values[j] > tbl->max_colnum)
303 tbl->max_colnum = res->values[j];
306 } /* tbl_config_table */
308 static int tbl_config(oconfig_item_t *ci) {
309 for (int i = 0; i < ci->children_num; ++i) {
310 oconfig_item_t *c = ci->children + i;
312 if (0 == strcasecmp(c->key, "Table"))
315 log_warn("Ignoring unknown config key \"%s\".", c->key);
324 static int tbl_prepare(tbl_t *tbl) {
325 for (size_t i = 0; i < tbl->results_num; ++i) {
326 tbl_result_t *res = tbl->results + i;
328 res->ds = plugin_get_ds(res->type);
329 if (NULL == res->ds) {
330 log_err("Unknown type \"%s\". See types.db(5) for details.", res->type);
334 if (res->values_num != res->ds->ds_num) {
335 log_err("Invalid type \"%s\". Expected %zu data source%s, "
337 res->type, res->values_num, (1 == res->values_num) ? "" : "s",
345 static int tbl_finish(tbl_t *tbl) {
346 for (size_t i = 0; i < tbl->results_num; ++i)
347 tbl->results[i].ds = NULL;
351 static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields,
353 value_list_t vl = VALUE_LIST_INIT;
354 value_t values[res->values_num];
356 assert(NULL != res->ds);
357 assert(res->values_num == res->ds->ds_num);
359 for (size_t i = 0; i < res->values_num; ++i) {
362 assert(res->values[i] < fields_num);
363 value = fields[res->values[i]];
365 if (0 != parse_value(value, &values[i], res->ds->ds[i].type))
370 vl.values_len = STATIC_ARRAY_SIZE(values);
372 sstrncpy(vl.plugin, (tbl->plugin_name != NULL) ? tbl->plugin_name : "table",
374 sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance));
375 sstrncpy(vl.type, res->type, sizeof(vl.type));
377 if (0 == res->instances_num) {
378 if (NULL != res->instance_prefix)
379 sstrncpy(vl.type_instance, res->instance_prefix,
380 sizeof(vl.type_instance));
382 char *instances[res->instances_num];
383 char instances_str[DATA_MAX_NAME_LEN];
385 for (size_t i = 0; i < res->instances_num; ++i) {
386 assert(res->instances[i] < fields_num);
387 instances[i] = fields[res->instances[i]];
390 strjoin(instances_str, sizeof(instances_str), instances,
391 STATIC_ARRAY_SIZE(instances), "-");
392 instances_str[sizeof(instances_str) - 1] = '\0';
394 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
395 if (NULL == res->instance_prefix)
396 strncpy(vl.type_instance, instances_str, sizeof(vl.type_instance));
398 snprintf(vl.type_instance, sizeof(vl.type_instance), "%s-%s",
399 res->instance_prefix, instances_str);
401 if ('\0' != vl.type_instance[sizeof(vl.type_instance) - 1]) {
402 vl.type_instance[sizeof(vl.type_instance) - 1] = '\0';
403 log_warn("Truncated type instance: %s.", vl.type_instance);
407 plugin_dispatch_values(&vl);
409 } /* tbl_result_dispatch */
411 static int tbl_parse_line(tbl_t *tbl, char *line, size_t len) {
412 char *fields[tbl->max_colnum + 1];
419 while (NULL != (fields[i] = strtok_r(ptr, tbl->sep, &saveptr))) {
423 if (i > tbl->max_colnum)
427 if (i <= tbl->max_colnum) {
428 log_warn("Not enough columns in line "
429 "(expected at least %zu, got %zu).",
430 tbl->max_colnum + 1, i);
434 for (i = 0; i < tbl->results_num; ++i)
435 if (0 != tbl_result_dispatch(tbl, tbl->results + i, fields,
436 STATIC_ARRAY_SIZE(fields))) {
437 log_err("Failed to dispatch result.");
441 } /* tbl_parse_line */
443 static int tbl_read_table(tbl_t *tbl) {
447 fh = fopen(tbl->file, "r");
449 log_err("Failed to open file \"%s\": %s.", tbl->file, STRERRNO);
453 buf[sizeof(buf) - 1] = '\0';
454 while (NULL != fgets(buf, sizeof(buf), fh)) {
455 if ('\0' != buf[sizeof(buf) - 1]) {
456 buf[sizeof(buf) - 1] = '\0';
457 log_warn("Table %s: Truncated line: %s", tbl->file, buf);
460 if (0 != tbl_parse_line(tbl, buf, sizeof(buf))) {
461 log_warn("Table %s: Failed to parse line: %s", tbl->file, buf);
466 if (0 != ferror(fh)) {
467 log_err("Failed to read from file \"%s\": %s.", tbl->file, STRERRNO);
474 } /* tbl_read_table */
480 static int tbl_read(void) {
486 for (size_t i = 0; i < tables_num; ++i) {
487 tbl_t *tbl = tables + i;
489 if (0 != tbl_prepare(tbl)) {
490 log_err("Failed to prepare and parse table \"%s\".", tbl->file);
494 if (0 == tbl_read_table(tbl))
502 static int tbl_shutdown(void) {
503 for (size_t i = 0; i < tables_num; ++i)
504 tbl_clear(&tables[i]);
509 static int tbl_init(void) {
513 plugin_register_read("table", tbl_read);
514 plugin_register_shutdown("table", tbl_shutdown);
518 void module_register(void) {
519 plugin_register_complex_config("table", tbl_config);
520 plugin_register_init("table", tbl_init);
521 } /* module_register */