3 * Copyright (C) 2008-2015 Florian octo Forster
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 * Florian octo Forster <octo at collectd.org>
31 #include "utils_db_query.h"
35 /* libdbi 0.9.0 introduced a new thread-safe interface and marked the old
36 * functions "deprecated". These macros convert the new functions to their old
37 * counterparts for backwards compatibility. */
38 #if !defined(LIBDBI_VERSION) || (LIBDBI_VERSION < 900)
39 #define HAVE_LEGACY_LIBDBI 1
40 #define dbi_initialize_r(a, inst) dbi_initialize(a)
41 #define dbi_shutdown_r(inst) dbi_shutdown()
42 #define dbi_set_verbosity_r(a, inst) dbi_set_verbosity(a)
43 #define dbi_driver_list_r(a, inst) dbi_driver_list(a)
44 #define dbi_driver_open_r(a, inst) dbi_driver_open(a)
50 struct cdbi_driver_option_s /* {{{ */
59 typedef struct cdbi_driver_option_s cdbi_driver_option_t; /* }}} */
61 struct cdbi_database_s /* {{{ */
69 cdbi_driver_option_t *driver_options;
70 size_t driver_options_num;
72 udb_query_preparation_area_t **q_prep_areas;
73 udb_query_t **queries;
78 typedef struct cdbi_database_s cdbi_database_t; /* }}} */
83 #if !defined(HAVE_LEGACY_LIBDBI) || !HAVE_LEGACY_LIBDBI
84 static dbi_inst dbi_instance;
86 static udb_query_t **queries;
87 static size_t queries_num;
88 static cdbi_database_t **databases;
89 static size_t databases_num;
91 static int cdbi_read_database(user_data_t *ud);
96 static const char *cdbi_strerror(dbi_conn conn, /* {{{ */
97 char *buffer, size_t buffer_size) {
102 sstrncpy(buffer, "connection is NULL", buffer_size);
107 status = dbi_conn_error(conn, &msg);
108 if ((status >= 0) && (msg != NULL))
109 snprintf(buffer, buffer_size, "%s (status %i)", msg, status);
111 snprintf(buffer, buffer_size, "dbi_conn_error failed with status %i",
115 } /* }}} const char *cdbi_conn_error */
117 static int cdbi_result_get_field(dbi_result res, /* {{{ */
118 unsigned int index, char *buffer,
119 size_t buffer_size) {
120 unsigned short src_type;
122 src_type = dbi_result_get_field_type_idx(res, index);
123 if (src_type == DBI_TYPE_ERROR) {
124 ERROR("dbi plugin: cdbi_result_get: "
125 "dbi_result_get_field_type_idx failed.");
129 if (src_type == DBI_TYPE_INTEGER) {
132 value = dbi_result_get_longlong_idx(res, index);
133 snprintf(buffer, buffer_size, "%lli", value);
134 } else if (src_type == DBI_TYPE_DECIMAL) {
137 value = dbi_result_get_double_idx(res, index);
138 snprintf(buffer, buffer_size, "%63.15g", value);
139 } else if (src_type == DBI_TYPE_STRING) {
142 value = dbi_result_get_string_idx(res, index);
144 sstrncpy(buffer, "", buffer_size);
145 else if (strcmp("ERROR", value) == 0)
148 sstrncpy(buffer, value, buffer_size);
150 /* DBI_TYPE_BINARY */
151 /* DBI_TYPE_DATETIME */
153 const char *field_name;
155 field_name = dbi_result_get_field_name(res, index);
156 if (field_name == NULL)
157 field_name = "<unknown>";
159 ERROR("dbi plugin: Column `%s': Don't know how to handle "
161 field_name, src_type);
166 } /* }}} int cdbi_result_get_field */
168 static void cdbi_database_free(cdbi_database_t *db) /* {{{ */
174 sfree(db->select_db);
175 sfree(db->plugin_name);
179 for (size_t i = 0; i < db->driver_options_num; i++) {
180 sfree(db->driver_options[i].key);
181 if (!db->driver_options[i].is_numeric)
182 sfree(db->driver_options[i].value.string);
184 sfree(db->driver_options);
186 if (db->q_prep_areas)
187 for (size_t i = 0; i < db->queries_num; ++i)
188 udb_query_delete_preparation_area(db->q_prep_areas[i]);
189 sfree(db->q_prep_areas);
190 /* N.B.: db->queries references objects "owned" by the global queries
191 * variable. Free the array here, but not the content. */
195 } /* }}} void cdbi_database_free */
197 /* Configuration handling functions {{{
200 * <Query "plugin_instance0">
201 * Statement "SELECT name, value FROM table"
204 * InstancesFrom "name"
210 * <Database "plugin_instance1">
213 * DriverOption "hostname" "localhost"
215 * Query "plugin_instance0"
220 static int cdbi_config_add_database_driver_option(cdbi_database_t *db, /* {{{ */
221 oconfig_item_t *ci) {
222 cdbi_driver_option_t *option;
224 if ((ci->values_num != 2) || (ci->values[0].type != OCONFIG_TYPE_STRING) ||
225 ((ci->values[1].type != OCONFIG_TYPE_STRING) &&
226 (ci->values[1].type != OCONFIG_TYPE_NUMBER))) {
227 WARNING("dbi plugin: The `DriverOption' config option "
228 "needs exactly two arguments.");
232 option = realloc(db->driver_options,
233 sizeof(*option) * (db->driver_options_num + 1));
234 if (option == NULL) {
235 ERROR("dbi plugin: realloc failed");
239 db->driver_options = option;
240 option = db->driver_options + db->driver_options_num;
241 memset(option, 0, sizeof(*option));
243 option->key = strdup(ci->values[0].value.string);
244 if (option->key == NULL) {
245 ERROR("dbi plugin: strdup failed.");
249 if (ci->values[1].type == OCONFIG_TYPE_STRING) {
250 option->value.string = strdup(ci->values[1].value.string);
251 if (option->value.string == NULL) {
252 ERROR("dbi plugin: strdup failed.");
257 assert(ci->values[1].type == OCONFIG_TYPE_NUMBER);
258 option->value.numeric = (int)(ci->values[1].value.number + .5);
259 option->is_numeric = true;
262 db->driver_options_num++;
264 } /* }}} int cdbi_config_add_database_driver_option */
266 static int cdbi_config_add_database(oconfig_item_t *ci) /* {{{ */
268 cdtime_t interval = 0;
272 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
273 WARNING("dbi plugin: The `Database' block "
274 "needs exactly one string argument.");
278 db = calloc(1, sizeof(*db));
280 ERROR("dbi plugin: calloc failed.");
284 status = cf_util_get_string(ci, &db->name);
290 /* Fill the `cdbi_database_t' structure.. */
291 for (int i = 0; i < ci->children_num; i++) {
292 oconfig_item_t *child = ci->children + i;
294 if (strcasecmp("Driver", child->key) == 0)
295 status = cf_util_get_string(child, &db->driver);
296 else if (strcasecmp("DriverOption", child->key) == 0)
297 status = cdbi_config_add_database_driver_option(db, child);
298 else if (strcasecmp("SelectDB", child->key) == 0)
299 status = cf_util_get_string(child, &db->select_db);
300 else if (strcasecmp("Query", child->key) == 0)
301 status = udb_query_pick_from_list(child, queries, queries_num,
302 &db->queries, &db->queries_num);
303 else if (strcasecmp("Host", child->key) == 0)
304 status = cf_util_get_string(child, &db->host);
305 else if (strcasecmp("Interval", child->key) == 0)
306 status = cf_util_get_cdtime(child, &interval);
307 else if (strcasecmp("Plugin", child->key) == 0)
308 status = cf_util_get_string(child, &db->plugin_name);
310 WARNING("dbi plugin: Option `%s' not allowed here.", child->key);
318 /* Check that all necessary options have been given. */
319 while (status == 0) {
320 if (db->driver == NULL) {
321 WARNING("dbi plugin: `Driver' not given for database `%s'", db->name);
324 if (db->driver_options_num == 0) {
325 WARNING("dbi plugin: No `DriverOption' given for database `%s'. "
326 "This will likely not work.",
331 } /* while (status == 0) */
333 while ((status == 0) && (db->queries_num > 0)) {
334 db->q_prep_areas = calloc(db->queries_num, sizeof(*db->q_prep_areas));
335 if (db->q_prep_areas == NULL) {
336 WARNING("dbi plugin: calloc failed");
341 for (size_t i = 0; i < db->queries_num; ++i) {
342 db->q_prep_areas[i] = udb_query_allocate_preparation_area(db->queries[i]);
344 if (db->q_prep_areas[i] == NULL) {
345 WARNING("dbi plugin: udb_query_allocate_preparation_area failed");
354 /* If all went well, add this database to the global list of databases. */
356 cdbi_database_t **temp;
358 temp = realloc(databases, sizeof(*databases) * (databases_num + 1));
360 ERROR("dbi plugin: realloc failed");
364 databases[databases_num] = db;
367 char *name = ssnprintf_alloc("dbi:%s", db->name);
368 plugin_register_complex_read(
370 /* name = */ name ? name : db->name,
371 /* callback = */ cdbi_read_database,
372 /* interval = */ interval,
381 cdbi_database_free(db);
386 } /* }}} int cdbi_config_add_database */
388 static int cdbi_config(oconfig_item_t *ci) /* {{{ */
390 for (int i = 0; i < ci->children_num; i++) {
391 oconfig_item_t *child = ci->children + i;
392 if (strcasecmp("Query", child->key) == 0)
393 udb_query_create(&queries, &queries_num, child,
394 /* callback = */ NULL);
395 else if (strcasecmp("Database", child->key) == 0)
396 cdbi_config_add_database(child);
398 WARNING("dbi plugin: Ignoring unknown config option `%s'.", child->key);
400 } /* for (ci->children) */
403 } /* }}} int cdbi_config */
405 /* }}} End of configuration handling functions */
407 static int cdbi_init(void) /* {{{ */
415 if (queries_num == 0) {
416 ERROR("dbi plugin: No <Query> blocks have been found. Without them, "
417 "this plugin can't do anything useful, so we will return an error.");
421 if (databases_num == 0) {
422 ERROR("dbi plugin: No <Database> blocks have been found. Without them, "
423 "this plugin can't do anything useful, so we will return an error.");
427 status = dbi_initialize_r(/* driverdir = */ NULL, &dbi_instance);
429 ERROR("dbi plugin: cdbi_init: dbi_initialize_r failed with status %i.",
432 } else if (status == 0) {
433 ERROR("dbi plugin: `dbi_initialize_r' could not load any drivers. Please "
434 "install at least one `DBD' or check your installation.");
437 DEBUG("dbi plugin: cdbi_init: dbi_initialize_r reports %i driver%s.", status,
438 (status == 1) ? "" : "s");
441 } /* }}} int cdbi_init */
443 static int cdbi_read_database_query(cdbi_database_t *db, /* {{{ */
445 udb_query_preparation_area_t *prep_area) {
446 const char *statement;
450 char **column_values;
453 /* Macro that cleans up dynamically allocated memory and returns the
454 * specified status. */
455 #define BAIL_OUT(status) \
456 if (column_names != NULL) { \
457 sfree(column_names[0]); \
458 sfree(column_names); \
460 if (column_values != NULL) { \
461 sfree(column_values[0]); \
462 sfree(column_values); \
465 dbi_result_free(res); \
471 column_values = NULL;
473 statement = udb_query_get_statement(q);
474 assert(statement != NULL);
476 res = dbi_conn_query(db->connection, statement);
479 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
480 "dbi_conn_query failed: %s",
481 db->name, udb_query_get_name(q),
482 cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
484 } else /* Get the number of columns */
486 unsigned int db_status;
488 db_status = dbi_result_get_numfields(res);
489 if (db_status == DBI_FIELD_ERROR) {
491 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
492 "dbi_result_get_numfields failed: %s",
493 db->name, udb_query_get_name(q),
494 cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
498 column_num = (size_t)db_status;
499 DEBUG("cdbi_read_database_query (%s, %s): There are %" PRIsz " columns.",
500 db->name, udb_query_get_name(q), column_num);
503 /* Allocate `column_names' and `column_values'. {{{ */
504 column_names = calloc(column_num, sizeof(*column_names));
505 if (column_names == NULL) {
506 ERROR("dbi plugin: calloc failed.");
510 column_names[0] = calloc(column_num, DATA_MAX_NAME_LEN);
511 if (column_names[0] == NULL) {
512 ERROR("dbi plugin: calloc failed.");
515 for (size_t i = 1; i < column_num; i++)
516 column_names[i] = column_names[i - 1] + DATA_MAX_NAME_LEN;
518 column_values = calloc(column_num, sizeof(*column_values));
519 if (column_values == NULL) {
520 ERROR("dbi plugin: calloc failed.");
524 column_values[0] = calloc(column_num, DATA_MAX_NAME_LEN);
525 if (column_values[0] == NULL) {
526 ERROR("dbi plugin: calloc failed.");
529 for (size_t i = 1; i < column_num; i++)
530 column_values[i] = column_values[i - 1] + DATA_MAX_NAME_LEN;
533 /* Copy the field names to `column_names' */
534 for (size_t i = 0; i < column_num; i++) /* {{{ */
536 const char *column_name;
538 column_name = dbi_result_get_field_name(res, (unsigned int)(i + 1));
539 if (column_name == NULL) {
540 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
541 "Cannot retrieve name of field %" PRIsz ".",
542 db->name, udb_query_get_name(q), i + 1);
546 sstrncpy(column_names[i], column_name, DATA_MAX_NAME_LEN);
547 } /* }}} for (i = 0; i < column_num; i++) */
549 status = udb_query_prepare_result(
550 q, prep_area, (db->host ? db->host : hostname_g),
551 /* plugin = */ (db->plugin_name != NULL) ? db->plugin_name : "dbi",
552 db->name, column_names, column_num);
555 ERROR("dbi plugin: udb_query_prepare_result failed with status %i.",
560 /* 0 = error; 1 = success; */
561 status = dbi_result_first_row(res); /* {{{ */
564 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
565 "dbi_result_first_row failed: %s. Maybe the statement didn't "
567 db->name, udb_query_get_name(q),
568 cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
569 udb_query_finish_result(q, prep_area);
573 /* Iterate over all rows and call `udb_query_handle_result' with each list of
578 /* Copy the value of the columns to `column_values' */
579 for (size_t i = 0; i < column_num; i++) /* {{{ */
581 status = cdbi_result_get_field(res, (unsigned int)(i + 1),
582 column_values[i], DATA_MAX_NAME_LEN);
585 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
586 "cdbi_result_get_field (%" PRIsz ") failed.",
587 db->name, udb_query_get_name(q), i + 1);
591 } /* }}} for (i = 0; i < column_num; i++) */
593 /* If all values were copied successfully, call `udb_query_handle_result'
594 * to dispatch the row to the daemon. */
595 if (status == 0) /* {{{ */
597 status = udb_query_handle_result(q, prep_area, column_values);
599 ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
600 "udb_query_handle_result failed.",
601 db->name, udb_query_get_name(q));
605 /* Get the next row from the database. */
606 status = dbi_result_next_row(res); /* {{{ */
608 if (dbi_conn_error(db->connection, NULL) != 0) {
610 WARNING("dbi plugin: cdbi_read_database_query (%s, %s): "
611 "dbi_result_next_row failed: %s.",
612 db->name, udb_query_get_name(q),
613 cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
617 } /* }}} while (42) */
619 /* Tell the db query interface that we're done with this query. */
620 udb_query_finish_result(q, prep_area);
622 /* Clean up and return `status = 0' (success) */
625 } /* }}} int cdbi_read_database_query */
627 static int cdbi_connect_database(cdbi_database_t *db) /* {{{ */
633 if (db->connection != NULL) {
634 status = dbi_conn_ping(db->connection);
635 if (status != 0) /* connection is alive */
638 dbi_conn_close(db->connection);
639 db->connection = NULL;
642 driver = dbi_driver_open_r(db->driver, dbi_instance);
643 if (driver == NULL) {
644 ERROR("dbi plugin: cdbi_connect_database: dbi_driver_open_r (%s) failed.",
646 INFO("dbi plugin: Maybe the driver isn't installed? "
647 "Known drivers are:");
648 for (driver = dbi_driver_list_r(NULL, dbi_instance); driver != NULL;
649 driver = dbi_driver_list_r(driver, dbi_instance)) {
650 INFO("dbi plugin: * %s", dbi_driver_get_name(driver));
655 connection = dbi_conn_open(driver);
656 if (connection == NULL) {
657 ERROR("dbi plugin: cdbi_connect_database: dbi_conn_open (%s) failed.",
662 /* Set all the driver options. Because this is a very very very generic
663 * interface, the error handling is kind of long. If an invalid option is
664 * encountered, it will get a list of options understood by the driver and
665 * report that as `INFO'. This way, users hopefully don't have too much
666 * trouble finding out how to configure the plugin correctly.. */
667 for (size_t i = 0; i < db->driver_options_num; i++) {
668 if (db->driver_options[i].is_numeric) {
670 dbi_conn_set_option_numeric(connection, db->driver_options[i].key,
671 db->driver_options[i].value.numeric);
674 ERROR("dbi plugin: cdbi_connect_database (%s): "
675 "dbi_conn_set_option_numeric (\"%s\", %i) failed: %s.",
676 db->name, db->driver_options[i].key,
677 db->driver_options[i].value.numeric,
678 cdbi_strerror(connection, errbuf, sizeof(errbuf)));
681 status = dbi_conn_set_option(connection, db->driver_options[i].key,
682 db->driver_options[i].value.string);
685 ERROR("dbi plugin: cdbi_connect_database (%s): "
686 "dbi_conn_set_option (\"%s\", \"%s\") failed: %s.",
687 db->name, db->driver_options[i].key,
688 db->driver_options[i].value.string,
689 cdbi_strerror(connection, errbuf, sizeof(errbuf)));
694 INFO("dbi plugin: This is a list of all options understood "
695 "by the `%s' driver:",
697 for (const char *opt = dbi_conn_get_option_list(connection, NULL);
698 opt != NULL; opt = dbi_conn_get_option_list(connection, opt)) {
699 INFO("dbi plugin: * %s", opt);
702 dbi_conn_close(connection);
705 } /* for (i = 0; i < db->driver_options_num; i++) */
707 status = dbi_conn_connect(connection);
710 ERROR("dbi plugin: cdbi_connect_database (%s): "
711 "dbi_conn_connect failed: %s",
712 db->name, cdbi_strerror(connection, errbuf, sizeof(errbuf)));
713 dbi_conn_close(connection);
717 if (db->select_db != NULL) {
718 status = dbi_conn_select_db(connection, db->select_db);
722 "dbi plugin: cdbi_connect_database (%s): "
723 "dbi_conn_select_db (%s) failed: %s. Check the `SelectDB' option.",
724 db->name, db->select_db,
725 cdbi_strerror(connection, errbuf, sizeof(errbuf)));
726 dbi_conn_close(connection);
731 db->connection = connection;
733 } /* }}} int cdbi_connect_database */
735 static int cdbi_read_database(user_data_t *ud) /* {{{ */
737 cdbi_database_t *db = (cdbi_database_t *)ud->data;
741 unsigned int db_version;
743 status = cdbi_connect_database(db);
746 assert(db->connection != NULL);
748 db_version = dbi_conn_get_engine_version(db->connection);
749 /* TODO: Complain if `db_version == 0' */
752 for (size_t i = 0; i < db->queries_num; i++) {
753 /* Check if we know the database's version and if so, if this query applies
754 * to that version. */
755 if ((db_version != 0) &&
756 (udb_query_check_version(db->queries[i], db_version) == 0))
759 status = cdbi_read_database_query(db, db->queries[i], db->q_prep_areas[i]);
765 ERROR("dbi plugin: All queries failed for database `%s'.", db->name);
770 } /* }}} int cdbi_read_database */
772 static int cdbi_shutdown(void) /* {{{ */
774 for (size_t i = 0; i < databases_num; i++) {
775 if (databases[i]->connection != NULL) {
776 dbi_conn_close(databases[i]->connection);
777 databases[i]->connection = NULL;
779 cdbi_database_free(databases[i]);
784 udb_query_free(queries, queries_num);
789 } /* }}} int cdbi_shutdown */
791 void module_register(void) /* {{{ */
793 plugin_register_complex_config("dbi", cdbi_config);
794 plugin_register_init("dbi", cdbi_init);
795 plugin_register_shutdown("dbi", cdbi_shutdown);
796 } /* }}} void module_register */