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;
45 struct udb_query_s /* {{{ */
51 unsigned int min_version;
52 unsigned int max_version;
54 udb_result_t *results;
57 struct udb_result_preparation_area_s /* {{{ */
60 size_t *instances_pos;
62 char **instances_buffer;
65 struct udb_result_preparation_area_s *next;
67 typedef struct udb_result_preparation_area_s udb_result_preparation_area_t;
69 struct udb_query_preparation_area_s /* {{{ */
78 udb_result_preparation_area_t *result_prep_areas;
82 * Config Private functions
84 static int udb_config_set_string (char **ret_string, /* {{{ */
89 if ((ci->values_num != 1)
90 || (ci->values[0].type != OCONFIG_TYPE_STRING))
92 WARNING ("db query utils: The `%s' config option "
93 "needs exactly one string argument.", ci->key);
97 string = strdup (ci->values[0].value.string);
100 ERROR ("db query utils: strdup failed.");
104 if (*ret_string != NULL)
106 *ret_string = string;
109 } /* }}} int udb_config_set_string */
111 static int udb_config_add_string (char ***ret_array, /* {{{ */
112 size_t *ret_array_len, oconfig_item_t *ci)
118 if (ci->values_num < 1)
120 WARNING ("db query utils: The `%s' config option "
121 "needs at least one argument.", ci->key);
125 for (i = 0; i < ci->values_num; i++)
127 if (ci->values[i].type != OCONFIG_TYPE_STRING)
129 WARNING ("db query utils: Argument %i to the `%s' option "
130 "is not a string.", i + 1, ci->key);
135 array_len = *ret_array_len;
136 array = (char **) realloc (*ret_array,
137 sizeof (char *) * (array_len + ci->values_num));
140 ERROR ("db query utils: realloc failed.");
145 for (i = 0; i < ci->values_num; i++)
147 array[array_len] = strdup (ci->values[i].value.string);
148 if (array[array_len] == NULL)
150 ERROR ("db query utils: strdup failed.");
151 *ret_array_len = array_len;
157 *ret_array_len = array_len;
159 } /* }}} int udb_config_add_string */
161 static int udb_config_set_uint (unsigned int *ret_value, /* {{{ */
166 if ((ci->values_num != 1)
167 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
169 WARNING ("db query utils: The `%s' config option "
170 "needs exactly one numeric argument.", ci->key);
174 tmp = ci->values[0].value.number;
175 if ((tmp < 0.0) || (tmp > ((double) UINT_MAX)))
178 *ret_value = (unsigned int) (tmp + .5);
180 } /* }}} int udb_config_set_uint */
183 * Result private functions
185 static int udb_result_submit (udb_result_t *r, /* {{{ */
186 udb_result_preparation_area_t *r_area,
187 udb_query_t const *q, udb_query_preparation_area_t *q_area)
189 value_list_t vl = VALUE_LIST_INIT;
193 assert (r_area->ds != NULL);
194 assert (((size_t) r_area->ds->ds_num) == r->values_num);
195 assert (r->values_num > 0);
197 vl.values = (value_t *) calloc (r->values_num, sizeof (value_t));
198 if (vl.values == NULL)
200 ERROR ("db query utils: malloc failed.");
203 vl.values_len = r_area->ds->ds_num;
205 for (i = 0; i < r->values_num; i++)
207 char *value_str = r_area->values_buffer[i];
209 if (0 != parse_value (value_str, &vl.values[i], r_area->ds->ds[i].type))
211 ERROR ("db query utils: udb_result_submit: Parsing `%s' as %s failed.",
212 value_str, DS_TYPE_TO_STRING (r_area->ds->ds[i].type));
218 if (q_area->interval > 0)
219 vl.interval = q_area->interval;
221 sstrncpy (vl.host, q_area->host, sizeof (vl.host));
222 sstrncpy (vl.plugin, q_area->plugin, sizeof (vl.plugin));
223 sstrncpy (vl.plugin_instance, q_area->db_name, sizeof (vl.plugin_instance));
224 sstrncpy (vl.type, r->type, sizeof (vl.type));
226 /* Set vl.type_instance {{{ */
227 if (r->instances_num <= 0)
229 if (r->instance_prefix == NULL)
230 vl.type_instance[0] = 0;
232 sstrncpy (vl.type_instance, r->instance_prefix,
233 sizeof (vl.type_instance));
235 else /* if ((r->instances_num > 0) */
237 if (r->instance_prefix == NULL)
239 int status = strjoin (vl.type_instance, sizeof (vl.type_instance),
240 r_area->instances_buffer, r->instances_num, "-");
243 ERROR ("udb_result_submit: creating type_instance failed with status %d.",
250 char tmp[DATA_MAX_NAME_LEN];
252 int status = strjoin (tmp, sizeof (tmp), r_area->instances_buffer,
253 r->instances_num, "-");
256 ERROR ("udb_result_submit: creating type_instance failed with status %d.",
260 tmp[sizeof (tmp) - 1] = 0;
262 snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
263 r->instance_prefix, tmp);
266 vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
269 plugin_dispatch_values (&vl);
273 } /* }}} void udb_result_submit */
275 static void udb_result_finish_result (udb_result_t const *r, /* {{{ */
276 udb_result_preparation_area_t *prep_area)
278 if ((r == NULL) || (prep_area == NULL))
281 prep_area->ds = NULL;
282 sfree (prep_area->instances_pos);
283 sfree (prep_area->values_pos);
284 sfree (prep_area->instances_buffer);
285 sfree (prep_area->values_buffer);
286 } /* }}} void udb_result_finish_result */
288 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
289 udb_query_preparation_area_t *q_area,
290 udb_result_preparation_area_t *r_area,
291 udb_query_t const *q, char **column_values)
295 assert (r && q_area && r_area);
297 for (i = 0; i < r->instances_num; i++)
298 r_area->instances_buffer[i] = column_values[r_area->instances_pos[i]];
300 for (i = 0; i < r->values_num; i++)
301 r_area->values_buffer[i] = column_values[r_area->values_pos[i]];
303 return udb_result_submit (r, r_area, q, q_area);
304 } /* }}} int udb_result_handle_result */
306 static int udb_result_prepare_result (udb_result_t const *r, /* {{{ */
307 udb_result_preparation_area_t *prep_area,
308 char **column_names, size_t column_num)
312 if ((r == NULL) || (prep_area == NULL))
315 #define BAIL_OUT(status) \
316 prep_area->ds = NULL; \
317 sfree (prep_area->instances_pos); \
318 sfree (prep_area->values_pos); \
319 sfree (prep_area->instances_buffer); \
320 sfree (prep_area->values_buffer); \
323 /* Make sure previous preparations are cleaned up. */
324 udb_result_finish_result (r, prep_area);
325 prep_area->instances_pos = NULL;
326 prep_area->values_pos = NULL;
328 /* Read `ds' and check number of values {{{ */
329 prep_area->ds = plugin_get_ds (r->type);
330 if (prep_area->ds == NULL)
332 ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
333 "known by the daemon. See types.db(5) for details.",
338 if (((size_t) prep_area->ds->ds_num) != r->values_num)
340 ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
341 "requires exactly %i value%s, but the configuration specifies %zu.",
343 prep_area->ds->ds_num, (prep_area->ds->ds_num == 1) ? "" : "s",
349 /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
350 * r->values_buffer {{{ */
351 if (r->instances_num > 0)
353 prep_area->instances_pos
354 = (size_t *) calloc (r->instances_num, sizeof (size_t));
355 if (prep_area->instances_pos == NULL)
357 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
361 prep_area->instances_buffer
362 = (char **) calloc (r->instances_num, sizeof (char *));
363 if (prep_area->instances_buffer == NULL)
365 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
368 } /* if (r->instances_num > 0) */
370 prep_area->values_pos
371 = (size_t *) calloc (r->values_num, sizeof (size_t));
372 if (prep_area->values_pos == NULL)
374 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
378 prep_area->values_buffer
379 = (char **) calloc (r->values_num, sizeof (char *));
380 if (prep_area->values_buffer == NULL)
382 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
387 /* Determine the position of the instance columns {{{ */
388 for (i = 0; i < r->instances_num; i++)
392 for (j = 0; j < column_num; j++)
394 if (strcasecmp (r->instances[i], column_names[j]) == 0)
396 prep_area->instances_pos[i] = j;
403 ERROR ("db query utils: udb_result_prepare_result: "
404 "Column `%s' could not be found.",
408 } /* }}} for (i = 0; i < r->instances_num; i++) */
410 /* Determine the position of the value columns {{{ */
411 for (i = 0; i < r->values_num; i++)
415 for (j = 0; j < column_num; j++)
417 if (strcasecmp (r->values[i], column_names[j]) == 0)
419 prep_area->values_pos[i] = j;
426 ERROR ("db query utils: udb_result_prepare_result: "
427 "Column `%s' could not be found.",
431 } /* }}} for (i = 0; i < r->values_num; i++) */
435 } /* }}} int udb_result_prepare_result */
437 static void udb_result_free (udb_result_t *r) /* {{{ */
446 for (i = 0; i < r->instances_num; i++)
447 sfree (r->instances[i]);
448 sfree (r->instances);
450 for (i = 0; i < r->values_num; i++)
451 sfree (r->values[i]);
454 udb_result_free (r->next);
457 } /* }}} void udb_result_free */
459 static int udb_result_create (const char *query_name, /* {{{ */
460 udb_result_t **r_head, oconfig_item_t *ci)
466 if (ci->values_num != 0)
468 WARNING ("db query utils: The `Result' block doesn't accept "
469 "any arguments. Ignoring %i argument%s.",
470 ci->values_num, (ci->values_num == 1) ? "" : "s");
473 r = (udb_result_t *) malloc (sizeof (*r));
476 ERROR ("db query utils: malloc failed.");
479 memset (r, 0, sizeof (*r));
481 r->instance_prefix = NULL;
486 /* Fill the `udb_result_t' structure.. */
488 for (i = 0; i < ci->children_num; i++)
490 oconfig_item_t *child = ci->children + i;
492 if (strcasecmp ("Type", child->key) == 0)
493 status = udb_config_set_string (&r->type, child);
494 else if (strcasecmp ("InstancePrefix", child->key) == 0)
495 status = udb_config_set_string (&r->instance_prefix, child);
496 else if (strcasecmp ("InstancesFrom", child->key) == 0)
497 status = udb_config_add_string (&r->instances, &r->instances_num, child);
498 else if (strcasecmp ("ValuesFrom", child->key) == 0)
499 status = udb_config_add_string (&r->values, &r->values_num, child);
502 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
503 query_name, child->key);
511 /* Check that all necessary options have been given. */
516 WARNING ("db query utils: `Type' not given for "
517 "result in query `%s'", query_name);
520 if (r->values == NULL)
522 WARNING ("db query utils: `ValuesFrom' not given for "
523 "result in query `%s'", query_name);
528 } /* while (status == 0) */
536 /* If all went well, add this result to the list of results. */
546 while (last->next != NULL)
553 } /* }}} int udb_result_create */
556 * Query private functions
558 static void udb_query_free_one (udb_query_t *q) /* {{{ */
564 sfree (q->statement);
566 udb_result_free (q->results);
569 } /* }}} void udb_query_free_one */
572 * Query public functions
574 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
575 size_t *ret_query_list_len, oconfig_item_t *ci,
576 udb_query_create_callback_t cb)
578 udb_query_t **query_list;
579 size_t query_list_len;
585 if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
587 query_list = *ret_query_list;
588 query_list_len = *ret_query_list_len;
590 if ((ci->values_num != 1)
591 || (ci->values[0].type != OCONFIG_TYPE_STRING))
593 WARNING ("db query utils: The `Query' block "
594 "needs exactly one string argument.");
598 q = (udb_query_t *) malloc (sizeof (*q));
601 ERROR ("db query utils: malloc failed.");
604 memset (q, 0, sizeof (*q));
606 q->max_version = UINT_MAX;
608 status = udb_config_set_string (&q->name, ci);
615 /* Fill the `udb_query_t' structure.. */
616 for (i = 0; i < ci->children_num; i++)
618 oconfig_item_t *child = ci->children + i;
620 if (strcasecmp ("Statement", child->key) == 0)
621 status = udb_config_set_string (&q->statement, child);
622 else if (strcasecmp ("Result", child->key) == 0)
623 status = udb_result_create (q->name, &q->results, child);
624 else if (strcasecmp ("MinVersion", child->key) == 0)
625 status = udb_config_set_uint (&q->min_version, child);
626 else if (strcasecmp ("MaxVersion", child->key) == 0)
627 status = udb_config_set_uint (&q->max_version, child);
629 /* Call custom callbacks */
632 status = (*cb) (q, child);
635 WARNING ("db query utils: The configuration callback failed "
636 "to handle `%s'.", child->key);
641 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
642 q->name, child->key);
650 /* Check that all necessary options have been given. */
653 if (q->statement == NULL)
655 WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
658 if (q->results == NULL)
660 WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
664 } /* if (status == 0) */
666 /* If all went well, add this query to the list of queries within the
667 * database structure. */
672 temp = (udb_query_t **) realloc (query_list,
673 sizeof (*query_list) * (query_list_len + 1));
676 ERROR ("db query utils: realloc failed");
682 query_list[query_list_len] = q;
689 udb_query_free_one (q);
693 *ret_query_list = query_list;
694 *ret_query_list_len = query_list_len;
697 } /* }}} int udb_query_create */
699 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
703 if (query_list == NULL)
706 for (i = 0; i < query_list_len; i++)
707 udb_query_free_one (query_list[i]);
710 } /* }}} void udb_query_free */
712 int udb_query_pick_from_list_by_name (const char *name, /* {{{ */
713 udb_query_t **src_list, size_t src_list_len,
714 udb_query_t ***dst_list, size_t *dst_list_len)
719 if ((name == NULL) || (src_list == NULL) || (dst_list == NULL)
720 || (dst_list_len == NULL))
722 ERROR ("db query utils: udb_query_pick_from_list_by_name: "
723 "Invalid argument.");
728 for (i = 0; i < src_list_len; i++)
730 udb_query_t **tmp_list;
733 if (strcasecmp (name, src_list[i]->name) != 0)
736 tmp_list_len = *dst_list_len;
737 tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
738 * sizeof (udb_query_t *));
739 if (tmp_list == NULL)
741 ERROR ("db query utils: realloc failed.");
745 tmp_list[tmp_list_len] = src_list[i];
748 *dst_list = tmp_list;
749 *dst_list_len = tmp_list_len;
752 } /* for (i = 0; i < src_list_len; i++) */
756 ERROR ("db query utils: Cannot find query `%s'. Make sure the <Query> "
757 "block is above the database definition!",
763 DEBUG ("db query utils: Added %i versions of query `%s'.",
768 } /* }}} int udb_query_pick_from_list_by_name */
770 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
771 udb_query_t **src_list, size_t src_list_len,
772 udb_query_t ***dst_list, size_t *dst_list_len)
776 if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
777 || (dst_list_len == NULL))
779 ERROR ("db query utils: udb_query_pick_from_list: "
780 "Invalid argument.");
784 if ((ci->values_num != 1)
785 || (ci->values[0].type != OCONFIG_TYPE_STRING))
787 ERROR ("db query utils: The `%s' config option "
788 "needs exactly one string argument.", ci->key);
791 name = ci->values[0].value.string;
793 return (udb_query_pick_from_list_by_name (name,
794 src_list, src_list_len,
795 dst_list, dst_list_len));
796 } /* }}} int udb_query_pick_from_list */
798 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
804 } /* }}} const char *udb_query_get_name */
806 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
811 return (q->statement);
812 } /* }}} const char *udb_query_get_statement */
814 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
819 q->user_data = user_data;
820 } /* }}} void udb_query_set_user_data */
822 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
827 return (q->user_data);
828 } /* }}} void *udb_query_get_user_data */
830 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
835 if ((version < q->min_version) || (version > q->max_version))
839 } /* }}} int udb_query_check_version */
841 void udb_query_finish_result (udb_query_t const *q, /* {{{ */
842 udb_query_preparation_area_t *prep_area)
844 udb_result_preparation_area_t *r_area;
847 if ((q == NULL) || (prep_area == NULL))
850 prep_area->column_num = 0;
851 sfree (prep_area->host);
852 sfree (prep_area->plugin);
853 sfree (prep_area->db_name);
855 prep_area->interval = 0;
857 for (r = q->results, r_area = prep_area->result_prep_areas;
858 r != NULL; r = r->next, r_area = r_area->next)
860 /* this may happen during error conditions of the caller */
863 udb_result_finish_result (r, r_area);
865 } /* }}} void udb_query_finish_result */
867 int udb_query_handle_result (udb_query_t const *q, /* {{{ */
868 udb_query_preparation_area_t *prep_area, char **column_values)
870 udb_result_preparation_area_t *r_area;
875 if ((q == NULL) || (prep_area == NULL))
878 if ((prep_area->column_num < 1) || (prep_area->host == NULL)
879 || (prep_area->plugin == NULL) || (prep_area->db_name == NULL))
881 ERROR ("db query utils: Query `%s': Query is not prepared; "
882 "can't handle result.", q->name);
886 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
891 for (i = 0; i < prep_area->column_num; i++)
893 DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
895 prep_area->db_name, q->name, i, column_values[i]);
901 for (r = q->results, r_area = prep_area->result_prep_areas;
902 r != NULL; r = r->next, r_area = r_area->next)
904 status = udb_result_handle_result (r, prep_area, r_area,
912 ERROR ("db query utils: udb_query_handle_result (%s, %s): "
913 "All results failed.", prep_area->db_name, q->name);
918 } /* }}} int udb_query_handle_result */
920 int udb_query_prepare_result (udb_query_t const *q, /* {{{ */
921 udb_query_preparation_area_t *prep_area,
922 const char *host, const char *plugin, const char *db_name,
923 char **column_names, size_t column_num, cdtime_t interval)
925 udb_result_preparation_area_t *r_area;
929 if ((q == NULL) || (prep_area == NULL))
932 udb_query_finish_result (q, prep_area);
934 prep_area->column_num = column_num;
935 prep_area->host = strdup (host);
936 prep_area->plugin = strdup (plugin);
937 prep_area->db_name = strdup (db_name);
939 prep_area->interval = interval;
941 if ((prep_area->host == NULL) || (prep_area->plugin == NULL)
942 || (prep_area->db_name == NULL))
944 ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
945 udb_query_finish_result (q, prep_area);
949 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
954 for (i = 0; i < column_num; i++)
956 DEBUG ("db query utils: udb_query_prepare_result: "
957 "query = %s; column[%zu] = %s;",
958 q->name, i, column_names[i]);
963 for (r = q->results, r_area = prep_area->result_prep_areas;
964 r != NULL; r = r->next, r_area = r_area->next)
968 ERROR ("db query utils: Query `%s': Invalid number of result "
969 "preparation areas.", q->name);
970 udb_query_finish_result (q, prep_area);
974 status = udb_result_prepare_result (r, r_area, column_names, column_num);
977 udb_query_finish_result (q, prep_area);
983 } /* }}} int udb_query_prepare_result */
985 udb_query_preparation_area_t *
986 udb_query_allocate_preparation_area (udb_query_t *q) /* {{{ */
988 udb_query_preparation_area_t *q_area;
989 udb_result_preparation_area_t **next_r_area;
992 q_area = malloc (sizeof (*q_area));
995 memset (q_area, 0, sizeof (*q_area));
997 next_r_area = &q_area->result_prep_areas;
998 for (r = q->results; r != NULL; r = r->next)
1000 udb_result_preparation_area_t *r_area;
1002 r_area = malloc (sizeof (*r_area));
1005 udb_result_preparation_area_t *a = q_area->result_prep_areas;
1009 udb_result_preparation_area_t *next = a->next;
1018 memset (r_area, 0, sizeof (*r_area));
1020 *next_r_area = r_area;
1021 next_r_area = &r_area->next;
1025 } /* }}} udb_query_preparation_area_t *udb_query_allocate_preparation_area */
1028 udb_query_delete_preparation_area (udb_query_preparation_area_t *q_area) /* {{{ */
1030 udb_result_preparation_area_t *r_area;
1035 r_area = q_area->result_prep_areas;
1036 while (r_area != NULL)
1038 udb_result_preparation_area_t *area = r_area;
1040 r_area = r_area->next;
1042 sfree (area->instances_pos);
1043 sfree (area->values_pos);
1044 sfree (area->instances_buffer);
1045 sfree (area->values_buffer);
1049 sfree (q_area->host);
1050 sfree (q_area->plugin);
1051 sfree (q_area->db_name);
1054 } /* }}} void udb_query_delete_preparation_area */
1056 /* vim: set sw=2 sts=2 et fdm=marker : */