2 * collectd - src/utils_db_query.c
3 * Copyright (C) 2008,2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
26 #include "utils_db_query.h"
31 struct udb_result_s; /* {{{ */
32 typedef struct udb_result_s udb_result_t;
36 char *instance_prefix;
42 /* Preparation area */
44 size_t *instances_pos;
46 char **instances_buffer;
52 struct udb_query_s /* {{{ */
58 unsigned int min_version;
59 unsigned int max_version;
61 /* Preparation area */
67 udb_result_t *results;
71 * Config Private functions
73 static int udb_config_set_string (char **ret_string, /* {{{ */
78 if ((ci->values_num != 1)
79 || (ci->values[0].type != OCONFIG_TYPE_STRING))
81 WARNING ("db query utils: The `%s' config option "
82 "needs exactly one string argument.", ci->key);
86 string = strdup (ci->values[0].value.string);
89 ERROR ("db query utils: strdup failed.");
93 if (*ret_string != NULL)
98 } /* }}} int udb_config_set_string */
100 static int udb_config_add_string (char ***ret_array, /* {{{ */
101 size_t *ret_array_len, oconfig_item_t *ci)
107 if (ci->values_num < 1)
109 WARNING ("db query utils: The `%s' config option "
110 "needs at least one argument.", ci->key);
114 for (i = 0; i < ci->values_num; i++)
116 if (ci->values[i].type != OCONFIG_TYPE_STRING)
118 WARNING ("db query utils: Argument %i to the `%s' option "
119 "is not a string.", i + 1, ci->key);
124 array_len = *ret_array_len;
125 array = (char **) realloc (*ret_array,
126 sizeof (char *) * (array_len + ci->values_num));
129 ERROR ("db query utils: realloc failed.");
134 for (i = 0; i < ci->values_num; i++)
136 array[array_len] = strdup (ci->values[i].value.string);
137 if (array[array_len] == NULL)
139 ERROR ("db query utils: strdup failed.");
140 *ret_array_len = array_len;
146 *ret_array_len = array_len;
148 } /* }}} int udb_config_add_string */
150 static int udb_config_set_uint (unsigned int *ret_value, /* {{{ */
155 if ((ci->values_num != 1)
156 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
158 WARNING ("db query utils: The `%s' config option "
159 "needs exactly one numeric argument.", ci->key);
163 tmp = ci->values[0].value.number;
164 if ((tmp < 0.0) || (tmp > ((double) UINT_MAX)))
167 *ret_value = (unsigned int) (tmp + .5);
169 } /* }}} int udb_config_set_uint */
172 * Result private functions
174 static void udb_result_submit (udb_result_t *r, udb_query_t *q) /* {{{ */
176 value_list_t vl = VALUE_LIST_INIT;
179 assert (((size_t) r->ds->ds_num) == r->values_num);
181 DEBUG ("db query utils: udb_result_submit: r->instance_prefix = %s;",
182 (r->instance_prefix == NULL) ? "NULL" : r->instance_prefix);
183 for (i = 0; i < r->instances_num; i++)
185 DEBUG ("db query utils: udb_result_submit: r->instances_buffer[%zu] = %s;",
186 i, r->instances_buffer[i]);
189 vl.values = (value_t *) calloc (r->ds->ds_num, sizeof (value_t));
190 if (vl.values == NULL)
192 ERROR ("db query utils: malloc failed.");
195 vl.values_len = r->ds->ds_num;
197 for (i = 0; i < r->values_num; i++)
203 if (r->ds->ds[i].type == DS_TYPE_COUNTER)
204 vl.values[i].counter = (counter_t) strtoll (r->values_buffer[i],
205 &endptr, /* base = */ 0);
206 else if (r->ds->ds[i].type == DS_TYPE_GAUGE)
207 vl.values[i].gauge = (gauge_t) strtod (r->values_buffer[i], &endptr);
211 if ((endptr == r->values_buffer[i]) || (errno != 0))
213 WARNING ("db query utils: udb_result_submit: Parsing `%s' as %s failed.",
215 (r->ds->ds[i].type == DS_TYPE_COUNTER) ? "counter" : "gauge");
216 vl.values[i].gauge = NAN;
220 sstrncpy (vl.host, q->host, sizeof (vl.host));
221 sstrncpy (vl.plugin, q->plugin, sizeof (vl.plugin));
222 sstrncpy (vl.plugin_instance, q->db_name, sizeof (vl.type_instance));
223 sstrncpy (vl.type, r->type, sizeof (vl.type));
225 if (r->instance_prefix == NULL)
227 strjoin (vl.type_instance, sizeof (vl.type_instance),
228 r->instances_buffer, r->instances_num, "-");
232 char tmp[DATA_MAX_NAME_LEN];
234 strjoin (tmp, sizeof (tmp), r->instances_buffer, r->instances_num, "-");
235 tmp[sizeof (tmp) - 1] = 0;
237 snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
238 r->instance_prefix, tmp);
240 vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
242 plugin_dispatch_values (&vl);
245 } /* }}} void udb_result_submit */
247 static void udb_result_finish_result (udb_result_t *r) /* {{{ */
253 sfree (r->instances_pos);
254 sfree (r->values_pos);
255 sfree (r->instances_buffer);
256 sfree (r->values_buffer);
257 } /* }}} void udb_result_finish_result */
259 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
260 udb_query_t *q, char **column_values)
264 for (i = 0; i < r->instances_num; i++)
265 r->instances_buffer[i] = column_values[r->instances_pos[i]];
267 for (i = 0; i < r->values_num; i++)
268 r->values_buffer[i] = column_values[r->values_pos[i]];
270 udb_result_submit (r, q);
273 } /* }}} int udb_result_handle_result */
275 static int udb_result_prepare_result (udb_result_t *r, /* {{{ */
276 char **column_names, size_t column_num)
283 #define BAIL_OUT(status) \
285 sfree (r->instances_pos); \
286 sfree (r->values_pos); \
287 sfree (r->instances_buffer); \
288 sfree (r->values_buffer); \
291 /* Make sure previous preparations are cleaned up. */
292 udb_result_finish_result (r);
293 r->instances_pos = NULL;
294 r->values_pos = NULL;
296 /* Read `ds' and check number of values {{{ */
297 r->ds = plugin_get_ds (r->type);
300 ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
301 "known by the daemon. See types.db(5) for details.",
306 if (((size_t) r->ds->ds_num) != r->values_num)
308 ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
309 "requires exactly %i value%s, but the configuration specifies %zu.",
311 r->ds->ds_num, (r->ds->ds_num == 1) ? "" : "s",
317 /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
318 * r->values_buffer {{{ */
319 r->instances_pos = (size_t *) calloc (r->instances_num, sizeof (size_t));
320 if (r->instances_pos == NULL)
322 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
326 r->values_pos = (size_t *) calloc (r->values_num, sizeof (size_t));
327 if (r->values_pos == NULL)
329 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
333 r->instances_buffer = (char **) calloc (r->instances_num, sizeof (char *));
334 if (r->instances_buffer == NULL)
336 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
340 r->values_buffer = (char **) calloc (r->values_num, sizeof (char *));
341 if (r->values_buffer == NULL)
343 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
348 /* Determine the position of the instance columns {{{ */
349 for (i = 0; i < r->instances_num; i++)
353 for (j = 0; j < column_num; j++)
355 if (strcasecmp (r->instances[i], column_names[j]) == 0)
357 r->instances_pos[i] = j;
364 ERROR ("db query utils: udb_result_prepare_result: "
365 "Column `%s' could not be found.",
369 } /* }}} for (i = 0; i < r->instances_num; i++) */
371 /* Determine the position of the value columns {{{ */
372 for (i = 0; i < r->values_num; i++)
376 for (j = 0; j < column_num; j++)
378 if (strcasecmp (r->values[i], column_names[j]) == 0)
380 r->values_pos[i] = j;
387 ERROR ("db query utils: udb_result_prepare_result: "
388 "Column `%s' could not be found.",
392 } /* }}} for (i = 0; i < r->values_num; i++) */
396 } /* }}} int udb_result_prepare_result */
398 static void udb_result_free (udb_result_t *r) /* {{{ */
407 for (i = 0; i < r->instances_num; i++)
408 sfree (r->instances[i]);
409 sfree (r->instances);
411 for (i = 0; i < r->values_num; i++)
412 sfree (r->values[i]);
415 udb_result_free (r->next);
418 } /* }}} void udb_result_free */
420 static int udb_result_create (const char *query_name, /* {{{ */
421 udb_result_t **r_head, oconfig_item_t *ci)
427 if (ci->values_num != 0)
429 WARNING ("db query utils: The `Result' block doesn't accept "
430 "any arguments. Ignoring %i argument%s.",
431 ci->values_num, (ci->values_num == 1) ? "" : "s");
434 r = (udb_result_t *) malloc (sizeof (*r));
437 ERROR ("db query utils: malloc failed.");
440 memset (r, 0, sizeof (*r));
442 r->instance_prefix = NULL;
447 /* Fill the `udb_result_t' structure.. */
449 for (i = 0; i < ci->children_num; i++)
451 oconfig_item_t *child = ci->children + i;
453 if (strcasecmp ("Type", child->key) == 0)
454 status = udb_config_set_string (&r->type, child);
455 else if (strcasecmp ("InstancePrefix", child->key) == 0)
456 status = udb_config_set_string (&r->instance_prefix, child);
457 else if (strcasecmp ("InstancesFrom", child->key) == 0)
458 status = udb_config_add_string (&r->instances, &r->instances_num, child);
459 else if (strcasecmp ("ValuesFrom", child->key) == 0)
460 status = udb_config_add_string (&r->values, &r->values_num, child);
463 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
464 query_name, child->key);
472 /* Check that all necessary options have been given. */
477 WARNING ("db query utils: `Type' not given for "
478 "result in query `%s'", query_name);
481 if (r->instances == NULL)
483 WARNING ("db query utils: `InstancesFrom' not given for "
484 "result in query `%s'", query_name);
487 if (r->values == NULL)
489 WARNING ("db query utils: `ValuesFrom' not given for "
490 "result in query `%s'", query_name);
495 } /* while (status == 0) */
503 /* If all went well, add this result to the list of results. */
513 while (last->next != NULL)
520 } /* }}} int udb_result_create */
523 * Query private functions
525 void udb_query_free_one (udb_query_t *q) /* {{{ */
531 sfree (q->statement);
533 udb_result_free (q->results);
536 } /* }}} void udb_query_free_one */
539 * Query public functions
541 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
542 size_t *ret_query_list_len, oconfig_item_t *ci,
543 udb_query_create_callback_t cb)
545 udb_query_t **query_list;
546 size_t query_list_len;
552 if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
554 query_list = *ret_query_list;
555 query_list_len = *ret_query_list_len;
557 if ((ci->values_num != 1)
558 || (ci->values[0].type != OCONFIG_TYPE_STRING))
560 WARNING ("db query utils: The `Query' block "
561 "needs exactly one string argument.");
565 q = (udb_query_t *) malloc (sizeof (*q));
568 ERROR ("db query utils: malloc failed.");
571 memset (q, 0, sizeof (*q));
573 q->max_version = UINT_MAX;
575 status = udb_config_set_string (&q->name, ci);
582 /* Fill the `udb_query_t' structure.. */
583 for (i = 0; i < ci->children_num; i++)
585 oconfig_item_t *child = ci->children + i;
587 if (strcasecmp ("Statement", child->key) == 0)
588 status = udb_config_set_string (&q->statement, child);
589 else if (strcasecmp ("Result", child->key) == 0)
590 status = udb_result_create (q->name, &q->results, child);
591 else if (strcasecmp ("MinVersion", child->key) == 0)
592 status = udb_config_set_uint (&q->min_version, child);
593 else if (strcasecmp ("MaxVersion", child->key) == 0)
594 status = udb_config_set_uint (&q->max_version, child);
595 /* PostgreSQL compatibility code */
596 else if (strcasecmp ("MinPGVersion", child->key) == 0)
598 WARNING ("db query utils: Query `%s': The `MinPGVersion' option is "
599 "deprecated. Please use `MinVersion' instead.",
601 status = udb_config_set_uint (&q->min_version, child);
603 else if (strcasecmp ("MaxPGVersion", child->key) == 0)
605 WARNING ("db query utils: Query `%s': The `MaxPGVersion' option is "
606 "deprecated. Please use `MaxVersion' instead.",
608 status = udb_config_set_uint (&q->max_version, child);
612 status = (*cb) (q, child);
615 WARNING ("db query utils: The configuration callback failed "
616 "to handle `%s'.", child->key);
621 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
622 q->name, child->key);
630 /* Check that all necessary options have been given. */
633 if (q->statement == NULL)
635 WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
638 if (q->results == NULL)
640 WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
644 } /* if (status == 0) */
646 /* If all went well, add this query to the list of queries within the
647 * database structure. */
652 temp = (udb_query_t **) realloc (query_list,
653 sizeof (*query_list) * (query_list_len + 1));
656 ERROR ("db query utils: realloc failed");
662 query_list[query_list_len] = q;
669 udb_query_free_one (q);
673 *ret_query_list = query_list;
674 *ret_query_list_len = query_list_len;
677 } /* }}} int udb_query_create */
679 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
683 if (query_list == NULL)
686 for (i = 0; i < query_list_len; i++)
687 udb_query_free_one (query_list[i]);
690 } /* }}} void udb_query_free */
692 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
693 udb_query_t **src_list, size_t src_list_len,
694 udb_query_t ***dst_list, size_t *dst_list_len)
698 udb_query_t **tmp_list;
702 if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
703 || (dst_list_len == NULL))
705 ERROR ("db query utils: Invalid argument.");
709 if ((ci->values_num != 1)
710 || (ci->values[0].type != OCONFIG_TYPE_STRING))
712 ERROR ("db query utils: The `%s' config option "
713 "needs exactly one string argument.", ci->key);
716 name = ci->values[0].value.string;
719 for (i = 0; i < src_list_len; i++)
720 if (strcasecmp (name, src_list[i]->name) == 0)
728 ERROR ("db query utils: Cannot find query `%s'. Make sure the <%s> "
729 "block is above the database definition!",
734 tmp_list_len = *dst_list_len;
735 tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
736 * sizeof (udb_query_t *));
737 if (tmp_list == NULL)
739 ERROR ("db query utils: realloc failed.");
742 tmp_list[tmp_list_len] = q;
745 *dst_list = tmp_list;
746 *dst_list_len = tmp_list_len;
749 } /* }}} int udb_query_pick_from_list */
751 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
757 } /* }}} const char *udb_query_get_name */
759 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
764 return (q->statement);
765 } /* }}} const char *udb_query_get_statement */
767 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
772 q->user_data = user_data;
773 } /* }}} void udb_query_set_user_data */
775 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
780 return (q->user_data);
781 } /* }}} void *udb_query_get_user_data */
783 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
788 if ((version < q->min_version) || (version > q->max_version))
792 } /* }}} int udb_query_check_version */
794 void udb_query_finish_result (udb_query_t *q) /* {{{ */
806 for (r = q->results; r != NULL; r = r->next)
807 udb_result_finish_result (r);
808 } /* }}} void udb_query_finish_result */
810 int udb_query_handle_result (udb_query_t *q, char **column_values) /* {{{ */
819 if ((q->column_num < 1) || (q->host == NULL) || (q->plugin == NULL)
820 || (q->db_name == NULL))
822 ERROR ("db query utils: Query `%s': Query is not prepared; "
823 "can't handle result.", q->name);
827 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
832 for (i = 0; i < q->column_num; i++)
834 DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
836 q->db_name, q->name, i, column_values[i]);
842 for (r = q->results; r != NULL; r = r->next)
844 status = udb_result_handle_result (r, q, column_values);
851 ERROR ("db query utils: udb_query_handle_result (%s, %s): "
852 "All results failed.", q->db_name, q->name);
857 } /* }}} int udb_query_handle_result */
859 int udb_query_prepare_result (udb_query_t *q, /* {{{ */
860 const char *host, const char *plugin, const char *db_name,
861 char **column_names, size_t column_num)
869 udb_query_finish_result (q);
871 q->column_num = column_num;
872 q->host = strdup (host);
873 q->plugin = strdup (plugin);
874 q->db_name = strdup (db_name);
876 if ((q->host == NULL) || (q->plugin == NULL) || (q->db_name == NULL))
878 ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
879 udb_query_finish_result (q);
883 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
888 for (i = 0; i < column_num; i++)
890 DEBUG ("db query utils: udb_query_prepare_result: "
891 "query = %s; column[%zu] = %s;",
892 q->name, i, column_names[i]);
897 for (r = q->results; r != NULL; r = r->next)
899 status = udb_result_prepare_result (r, column_names, column_num);
902 udb_query_finish_result (q);
908 } /* }}} int udb_query_prepare_result */
910 /* vim: set sw=2 sts=2 et fdm=marker : */