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 vl.time = time (NULL);
221 sstrncpy (vl.host, q->host, sizeof (vl.host));
222 sstrncpy (vl.plugin, q->plugin, sizeof (vl.plugin));
223 sstrncpy (vl.plugin_instance, q->db_name, sizeof (vl.type_instance));
224 sstrncpy (vl.type, r->type, sizeof (vl.type));
226 if (r->instance_prefix == NULL)
228 strjoin (vl.type_instance, sizeof (vl.type_instance),
229 r->instances_buffer, r->instances_num, "-");
233 char tmp[DATA_MAX_NAME_LEN];
235 strjoin (tmp, sizeof (tmp), r->instances_buffer, r->instances_num, "-");
236 tmp[sizeof (tmp) - 1] = 0;
238 snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
239 r->instance_prefix, tmp);
241 vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
243 plugin_dispatch_values (&vl);
246 } /* }}} void udb_result_submit */
248 static void udb_result_finish_result (udb_result_t *r) /* {{{ */
254 sfree (r->instances_pos);
255 sfree (r->values_pos);
256 sfree (r->instances_buffer);
257 sfree (r->values_buffer);
258 } /* }}} void udb_result_finish_result */
260 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
261 udb_query_t *q, char **column_values)
265 for (i = 0; i < r->instances_num; i++)
266 r->instances_buffer[i] = column_values[r->instances_pos[i]];
268 for (i = 0; i < r->values_num; i++)
269 r->values_buffer[i] = column_values[r->values_pos[i]];
271 udb_result_submit (r, q);
274 } /* }}} int udb_result_handle_result */
276 static int udb_result_prepare_result (udb_result_t *r, /* {{{ */
277 char **column_names, size_t column_num)
284 #define BAIL_OUT(status) \
286 sfree (r->instances_pos); \
287 sfree (r->values_pos); \
288 sfree (r->instances_buffer); \
289 sfree (r->values_buffer); \
292 /* Make sure previous preparations are cleaned up. */
293 udb_result_finish_result (r);
294 r->instances_pos = NULL;
295 r->values_pos = NULL;
297 /* Read `ds' and check number of values {{{ */
298 r->ds = plugin_get_ds (r->type);
301 ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
302 "known by the daemon. See types.db(5) for details.",
307 if (((size_t) r->ds->ds_num) != r->values_num)
309 ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
310 "requires exactly %i value%s, but the configuration specifies %zu.",
312 r->ds->ds_num, (r->ds->ds_num == 1) ? "" : "s",
318 /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
319 * r->values_buffer {{{ */
320 r->instances_pos = (size_t *) calloc (r->instances_num, sizeof (size_t));
321 if (r->instances_pos == NULL)
323 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
327 r->values_pos = (size_t *) calloc (r->values_num, sizeof (size_t));
328 if (r->values_pos == NULL)
330 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
334 r->instances_buffer = (char **) calloc (r->instances_num, sizeof (char *));
335 if (r->instances_buffer == NULL)
337 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
341 r->values_buffer = (char **) calloc (r->values_num, sizeof (char *));
342 if (r->values_buffer == NULL)
344 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
349 /* Determine the position of the instance columns {{{ */
350 for (i = 0; i < r->instances_num; i++)
354 for (j = 0; j < column_num; j++)
356 if (strcasecmp (r->instances[i], column_names[j]) == 0)
358 r->instances_pos[i] = j;
365 ERROR ("db query utils: udb_result_prepare_result: "
366 "Column `%s' could not be found.",
370 } /* }}} for (i = 0; i < r->instances_num; i++) */
372 /* Determine the position of the value columns {{{ */
373 for (i = 0; i < r->values_num; i++)
377 for (j = 0; j < column_num; j++)
379 if (strcasecmp (r->values[i], column_names[j]) == 0)
381 r->values_pos[i] = j;
388 ERROR ("db query utils: udb_result_prepare_result: "
389 "Column `%s' could not be found.",
393 } /* }}} for (i = 0; i < r->values_num; i++) */
397 } /* }}} int udb_result_prepare_result */
399 static void udb_result_free (udb_result_t *r) /* {{{ */
408 for (i = 0; i < r->instances_num; i++)
409 sfree (r->instances[i]);
410 sfree (r->instances);
412 for (i = 0; i < r->values_num; i++)
413 sfree (r->values[i]);
416 udb_result_free (r->next);
419 } /* }}} void udb_result_free */
421 static int udb_result_create (const char *query_name, /* {{{ */
422 udb_result_t **r_head, oconfig_item_t *ci)
428 if (ci->values_num != 0)
430 WARNING ("db query utils: The `Result' block doesn't accept "
431 "any arguments. Ignoring %i argument%s.",
432 ci->values_num, (ci->values_num == 1) ? "" : "s");
435 r = (udb_result_t *) malloc (sizeof (*r));
438 ERROR ("db query utils: malloc failed.");
441 memset (r, 0, sizeof (*r));
443 r->instance_prefix = NULL;
448 /* Fill the `udb_result_t' structure.. */
450 for (i = 0; i < ci->children_num; i++)
452 oconfig_item_t *child = ci->children + i;
454 if (strcasecmp ("Type", child->key) == 0)
455 status = udb_config_set_string (&r->type, child);
456 else if (strcasecmp ("InstancePrefix", child->key) == 0)
457 status = udb_config_set_string (&r->instance_prefix, child);
458 else if (strcasecmp ("InstancesFrom", child->key) == 0)
459 status = udb_config_add_string (&r->instances, &r->instances_num, child);
460 else if (strcasecmp ("ValuesFrom", child->key) == 0)
461 status = udb_config_add_string (&r->values, &r->values_num, child);
464 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
465 query_name, child->key);
473 /* Check that all necessary options have been given. */
478 WARNING ("db query utils: `Type' not given for "
479 "result in query `%s'", query_name);
482 if (r->instances == NULL)
484 WARNING ("db query utils: `InstancesFrom' not given for "
485 "result in query `%s'", query_name);
488 if (r->values == NULL)
490 WARNING ("db query utils: `ValuesFrom' not given for "
491 "result in query `%s'", query_name);
496 } /* while (status == 0) */
504 /* If all went well, add this result to the list of results. */
514 while (last->next != NULL)
521 } /* }}} int udb_result_create */
524 * Query private functions
526 void udb_query_free_one (udb_query_t *q) /* {{{ */
532 sfree (q->statement);
534 udb_result_free (q->results);
537 } /* }}} void udb_query_free_one */
540 * Query public functions
542 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
543 size_t *ret_query_list_len, oconfig_item_t *ci)
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 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
613 q->name, child->key);
621 /* Check that all necessary options have been given. */
624 if (q->statement == NULL)
626 WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
629 if (q->results == NULL)
631 WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
635 } /* if (status == 0) */
637 /* If all went well, add this query to the list of queries within the
638 * database structure. */
643 temp = (udb_query_t **) realloc (query_list,
644 sizeof (*query_list) * (query_list_len + 1));
647 ERROR ("db query utils: realloc failed");
653 query_list[query_list_len] = q;
660 udb_query_free_one (q);
664 *ret_query_list = query_list;
665 *ret_query_list_len = query_list_len;
668 } /* }}} int udb_query_create */
670 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
674 if (query_list == NULL)
677 for (i = 0; i < query_list_len; i++)
678 udb_query_free_one (query_list[i]);
681 } /* }}} void udb_query_free */
683 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
684 udb_query_t **src_list, size_t src_list_len,
685 udb_query_t ***dst_list, size_t *dst_list_len)
689 udb_query_t **tmp_list;
693 if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
694 || (dst_list_len == NULL))
696 ERROR ("db query utils: Invalid argument.");
700 if ((ci->values_num != 1)
701 || (ci->values[0].type != OCONFIG_TYPE_STRING))
703 ERROR ("db query utils: The `%s' config option "
704 "needs exactly one string argument.", ci->key);
707 name = ci->values[0].value.string;
710 for (i = 0; i < src_list_len; i++)
711 if (strcasecmp (name, src_list[i]->name) == 0)
719 ERROR ("db query utils: Cannot find query `%s'. Make sure the <%s> "
720 "block is above the database definition!",
725 tmp_list_len = *dst_list_len;
726 tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
727 * sizeof (udb_query_t *));
728 if (tmp_list == NULL)
730 ERROR ("db query utils: realloc failed.");
733 tmp_list[tmp_list_len] = q;
736 *dst_list = tmp_list;
737 *dst_list_len = tmp_list_len;
740 } /* }}} int udb_query_pick_from_list */
742 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
748 } /* }}} const char *udb_query_get_name */
750 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
755 return (q->statement);
756 } /* }}} const char *udb_query_get_statement */
758 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
763 q->user_data = user_data;
764 } /* }}} void udb_query_set_user_data */
766 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
771 return (q->user_data);
772 } /* }}} void *udb_query_get_user_data */
774 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
779 if ((version < q->min_version) || (version > q->max_version))
783 } /* }}} int udb_query_check_version */
785 void udb_query_finish_result (udb_query_t *q) /* {{{ */
797 for (r = q->results; r != NULL; r = r->next)
798 udb_result_finish_result (r);
799 } /* }}} void udb_query_finish_result */
801 int udb_query_handle_result (udb_query_t *q, char **column_values) /* {{{ */
810 if ((q->column_num < 1) || (q->host == NULL) || (q->plugin == NULL)
811 || (q->db_name == NULL))
813 ERROR ("db query utils: Query `%s': Query is not prepared; "
814 "can't handle result.", q->name);
818 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
823 for (i = 0; i < q->column_num; i++)
825 DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
827 q->db_name, q->name, i, column_values[i]);
833 for (r = q->results; r != NULL; r = r->next)
835 status = udb_result_handle_result (r, q, column_values);
842 ERROR ("db query utils: udb_query_handle_result (%s, %s): "
843 "All results failed.", q->db_name, q->name);
848 } /* }}} int udb_query_handle_result */
850 int udb_query_prepare_result (udb_query_t *q, /* {{{ */
851 const char *host, const char *plugin, const char *db_name,
852 char **column_names, size_t column_num)
860 udb_query_finish_result (q);
862 q->column_num = column_num;
863 q->host = strdup (host);
864 q->plugin = strdup (plugin);
865 q->db_name = strdup (db_name);
867 if ((q->host == NULL) || (q->plugin == NULL) || (q->db_name == NULL))
869 ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
870 udb_query_finish_result (q);
874 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
879 for (i = 0; i < column_num; i++)
881 DEBUG ("db query utils: udb_query_prepare_result: "
882 "query = %s; column[%zu] = %s;",
883 q->name, i, column_names[i]);
888 for (r = q->results; r != NULL; r = r->next)
890 status = udb_result_prepare_result (r, column_names, column_num);
893 udb_query_finish_result (q);
899 } /* }}} int udb_query_prepare_result */
901 /* vim: set sw=2 sts=2 et fdm=marker : */