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 strjoin (vl.type_instance, sizeof (vl.type_instance),
240 r_area->instances_buffer, r->instances_num, "-");
244 char tmp[DATA_MAX_NAME_LEN];
246 strjoin (tmp, sizeof (tmp), r_area->instances_buffer,
247 r->instances_num, "-");
248 tmp[sizeof (tmp) - 1] = 0;
250 snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
251 r->instance_prefix, tmp);
254 vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
257 plugin_dispatch_values (&vl);
261 } /* }}} void udb_result_submit */
263 static void udb_result_finish_result (udb_result_t const *r, /* {{{ */
264 udb_result_preparation_area_t *prep_area)
266 if ((r == NULL) || (prep_area == NULL))
269 prep_area->ds = NULL;
270 sfree (prep_area->instances_pos);
271 sfree (prep_area->values_pos);
272 sfree (prep_area->instances_buffer);
273 sfree (prep_area->values_buffer);
274 } /* }}} void udb_result_finish_result */
276 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
277 udb_query_preparation_area_t *q_area,
278 udb_result_preparation_area_t *r_area,
279 udb_query_t const *q, char **column_values)
283 assert (r && q_area && r_area);
285 for (i = 0; i < r->instances_num; i++)
286 r_area->instances_buffer[i] = column_values[r_area->instances_pos[i]];
288 for (i = 0; i < r->values_num; i++)
289 r_area->values_buffer[i] = column_values[r_area->values_pos[i]];
291 return udb_result_submit (r, r_area, q, q_area);
292 } /* }}} int udb_result_handle_result */
294 static int udb_result_prepare_result (udb_result_t const *r, /* {{{ */
295 udb_result_preparation_area_t *prep_area,
296 char **column_names, size_t column_num)
300 if ((r == NULL) || (prep_area == NULL))
303 #define BAIL_OUT(status) \
304 prep_area->ds = NULL; \
305 sfree (prep_area->instances_pos); \
306 sfree (prep_area->values_pos); \
307 sfree (prep_area->instances_buffer); \
308 sfree (prep_area->values_buffer); \
311 /* Make sure previous preparations are cleaned up. */
312 udb_result_finish_result (r, prep_area);
313 prep_area->instances_pos = NULL;
314 prep_area->values_pos = NULL;
316 /* Read `ds' and check number of values {{{ */
317 prep_area->ds = plugin_get_ds (r->type);
318 if (prep_area->ds == NULL)
320 ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
321 "known by the daemon. See types.db(5) for details.",
326 if (((size_t) prep_area->ds->ds_num) != r->values_num)
328 ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
329 "requires exactly %i value%s, but the configuration specifies %zu.",
331 prep_area->ds->ds_num, (prep_area->ds->ds_num == 1) ? "" : "s",
337 /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
338 * r->values_buffer {{{ */
339 if (r->instances_num > 0)
341 prep_area->instances_pos
342 = (size_t *) calloc (r->instances_num, sizeof (size_t));
343 if (prep_area->instances_pos == NULL)
345 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
349 prep_area->instances_buffer
350 = (char **) calloc (r->instances_num, sizeof (char *));
351 if (prep_area->instances_buffer == NULL)
353 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
356 } /* if (r->instances_num > 0) */
358 prep_area->values_pos
359 = (size_t *) calloc (r->values_num, sizeof (size_t));
360 if (prep_area->values_pos == NULL)
362 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
366 prep_area->values_buffer
367 = (char **) calloc (r->values_num, sizeof (char *));
368 if (prep_area->values_buffer == NULL)
370 ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
375 /* Determine the position of the instance columns {{{ */
376 for (i = 0; i < r->instances_num; i++)
380 for (j = 0; j < column_num; j++)
382 if (strcasecmp (r->instances[i], column_names[j]) == 0)
384 prep_area->instances_pos[i] = j;
391 ERROR ("db query utils: udb_result_prepare_result: "
392 "Column `%s' could not be found.",
396 } /* }}} for (i = 0; i < r->instances_num; i++) */
398 /* Determine the position of the value columns {{{ */
399 for (i = 0; i < r->values_num; i++)
403 for (j = 0; j < column_num; j++)
405 if (strcasecmp (r->values[i], column_names[j]) == 0)
407 prep_area->values_pos[i] = j;
414 ERROR ("db query utils: udb_result_prepare_result: "
415 "Column `%s' could not be found.",
419 } /* }}} for (i = 0; i < r->values_num; i++) */
423 } /* }}} int udb_result_prepare_result */
425 static void udb_result_free (udb_result_t *r) /* {{{ */
434 for (i = 0; i < r->instances_num; i++)
435 sfree (r->instances[i]);
436 sfree (r->instances);
438 for (i = 0; i < r->values_num; i++)
439 sfree (r->values[i]);
442 udb_result_free (r->next);
445 } /* }}} void udb_result_free */
447 static int udb_result_create (const char *query_name, /* {{{ */
448 udb_result_t **r_head, oconfig_item_t *ci)
454 if (ci->values_num != 0)
456 WARNING ("db query utils: The `Result' block doesn't accept "
457 "any arguments. Ignoring %i argument%s.",
458 ci->values_num, (ci->values_num == 1) ? "" : "s");
461 r = (udb_result_t *) malloc (sizeof (*r));
464 ERROR ("db query utils: malloc failed.");
467 memset (r, 0, sizeof (*r));
469 r->instance_prefix = NULL;
474 /* Fill the `udb_result_t' structure.. */
476 for (i = 0; i < ci->children_num; i++)
478 oconfig_item_t *child = ci->children + i;
480 if (strcasecmp ("Type", child->key) == 0)
481 status = udb_config_set_string (&r->type, child);
482 else if (strcasecmp ("InstancePrefix", child->key) == 0)
483 status = udb_config_set_string (&r->instance_prefix, child);
484 else if (strcasecmp ("InstancesFrom", child->key) == 0)
485 status = udb_config_add_string (&r->instances, &r->instances_num, child);
486 else if (strcasecmp ("ValuesFrom", child->key) == 0)
487 status = udb_config_add_string (&r->values, &r->values_num, child);
490 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
491 query_name, child->key);
499 /* Check that all necessary options have been given. */
504 WARNING ("db query utils: `Type' not given for "
505 "result in query `%s'", query_name);
508 if (r->values == NULL)
510 WARNING ("db query utils: `ValuesFrom' not given for "
511 "result in query `%s'", query_name);
516 } /* while (status == 0) */
524 /* If all went well, add this result to the list of results. */
534 while (last->next != NULL)
541 } /* }}} int udb_result_create */
544 * Query private functions
546 void udb_query_free_one (udb_query_t *q) /* {{{ */
552 sfree (q->statement);
554 udb_result_free (q->results);
557 } /* }}} void udb_query_free_one */
560 * Query public functions
562 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
563 size_t *ret_query_list_len, oconfig_item_t *ci,
564 udb_query_create_callback_t cb)
566 udb_query_t **query_list;
567 size_t query_list_len;
573 if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
575 query_list = *ret_query_list;
576 query_list_len = *ret_query_list_len;
578 if ((ci->values_num != 1)
579 || (ci->values[0].type != OCONFIG_TYPE_STRING))
581 WARNING ("db query utils: The `Query' block "
582 "needs exactly one string argument.");
586 q = (udb_query_t *) malloc (sizeof (*q));
589 ERROR ("db query utils: malloc failed.");
592 memset (q, 0, sizeof (*q));
594 q->max_version = UINT_MAX;
596 status = udb_config_set_string (&q->name, ci);
603 /* Fill the `udb_query_t' structure.. */
604 for (i = 0; i < ci->children_num; i++)
606 oconfig_item_t *child = ci->children + i;
608 if (strcasecmp ("Statement", child->key) == 0)
609 status = udb_config_set_string (&q->statement, child);
610 else if (strcasecmp ("Result", child->key) == 0)
611 status = udb_result_create (q->name, &q->results, child);
612 else if (strcasecmp ("MinVersion", child->key) == 0)
613 status = udb_config_set_uint (&q->min_version, child);
614 else if (strcasecmp ("MaxVersion", child->key) == 0)
615 status = udb_config_set_uint (&q->max_version, child);
617 /* Call custom callbacks */
620 status = (*cb) (q, child);
623 WARNING ("db query utils: The configuration callback failed "
624 "to handle `%s'.", child->key);
629 WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
630 q->name, child->key);
638 /* Check that all necessary options have been given. */
641 if (q->statement == NULL)
643 WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
646 if (q->results == NULL)
648 WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
652 } /* if (status == 0) */
654 /* If all went well, add this query to the list of queries within the
655 * database structure. */
660 temp = (udb_query_t **) realloc (query_list,
661 sizeof (*query_list) * (query_list_len + 1));
664 ERROR ("db query utils: realloc failed");
670 query_list[query_list_len] = q;
677 udb_query_free_one (q);
681 *ret_query_list = query_list;
682 *ret_query_list_len = query_list_len;
685 } /* }}} int udb_query_create */
687 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
691 if (query_list == NULL)
694 for (i = 0; i < query_list_len; i++)
695 udb_query_free_one (query_list[i]);
698 } /* }}} void udb_query_free */
700 int udb_query_pick_from_list_by_name (const char *name, /* {{{ */
701 udb_query_t **src_list, size_t src_list_len,
702 udb_query_t ***dst_list, size_t *dst_list_len)
707 if ((name == NULL) || (src_list == NULL) || (dst_list == NULL)
708 || (dst_list_len == NULL))
710 ERROR ("db query utils: udb_query_pick_from_list_by_name: "
711 "Invalid argument.");
716 for (i = 0; i < src_list_len; i++)
718 udb_query_t **tmp_list;
721 if (strcasecmp (name, src_list[i]->name) != 0)
724 tmp_list_len = *dst_list_len;
725 tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
726 * sizeof (udb_query_t *));
727 if (tmp_list == NULL)
729 ERROR ("db query utils: realloc failed.");
733 tmp_list[tmp_list_len] = src_list[i];
736 *dst_list = tmp_list;
737 *dst_list_len = tmp_list_len;
740 } /* for (i = 0; i < src_list_len; i++) */
744 ERROR ("db query utils: Cannot find query `%s'. Make sure the <Query> "
745 "block is above the database definition!",
751 DEBUG ("db query utils: Added %i versions of query `%s'.",
756 } /* }}} int udb_query_pick_from_list_by_name */
758 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
759 udb_query_t **src_list, size_t src_list_len,
760 udb_query_t ***dst_list, size_t *dst_list_len)
764 if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
765 || (dst_list_len == NULL))
767 ERROR ("db query utils: udb_query_pick_from_list: "
768 "Invalid argument.");
772 if ((ci->values_num != 1)
773 || (ci->values[0].type != OCONFIG_TYPE_STRING))
775 ERROR ("db query utils: The `%s' config option "
776 "needs exactly one string argument.", ci->key);
779 name = ci->values[0].value.string;
781 return (udb_query_pick_from_list_by_name (name,
782 src_list, src_list_len,
783 dst_list, dst_list_len));
784 } /* }}} int udb_query_pick_from_list */
786 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
792 } /* }}} const char *udb_query_get_name */
794 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
799 return (q->statement);
800 } /* }}} const char *udb_query_get_statement */
802 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
807 q->user_data = user_data;
808 } /* }}} void udb_query_set_user_data */
810 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
815 return (q->user_data);
816 } /* }}} void *udb_query_get_user_data */
818 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
823 if ((version < q->min_version) || (version > q->max_version))
827 } /* }}} int udb_query_check_version */
829 void udb_query_finish_result (udb_query_t const *q, /* {{{ */
830 udb_query_preparation_area_t *prep_area)
832 udb_result_preparation_area_t *r_area;
835 if ((q == NULL) || (prep_area == NULL))
838 prep_area->column_num = 0;
839 sfree (prep_area->host);
840 sfree (prep_area->plugin);
841 sfree (prep_area->db_name);
843 prep_area->interval = 0;
845 for (r = q->results, r_area = prep_area->result_prep_areas;
846 r != NULL; r = r->next, r_area = r_area->next)
848 /* this may happen during error conditions of the caller */
851 udb_result_finish_result (r, r_area);
853 } /* }}} void udb_query_finish_result */
855 int udb_query_handle_result (udb_query_t const *q, /* {{{ */
856 udb_query_preparation_area_t *prep_area, char **column_values)
858 udb_result_preparation_area_t *r_area;
863 if ((q == NULL) || (prep_area == NULL))
866 if ((prep_area->column_num < 1) || (prep_area->host == NULL)
867 || (prep_area->plugin == NULL) || (prep_area->db_name == NULL))
869 ERROR ("db query utils: Query `%s': Query is not prepared; "
870 "can't handle result.", q->name);
874 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
879 for (i = 0; i < prep_area->column_num; i++)
881 DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
883 prep_area->db_name, q->name, i, column_values[i]);
889 for (r = q->results, r_area = prep_area->result_prep_areas;
890 r != NULL; r = r->next, r_area = r_area->next)
892 status = udb_result_handle_result (r, prep_area, r_area,
900 ERROR ("db query utils: udb_query_handle_result (%s, %s): "
901 "All results failed.", prep_area->db_name, q->name);
906 } /* }}} int udb_query_handle_result */
908 int udb_query_prepare_result (udb_query_t const *q, /* {{{ */
909 udb_query_preparation_area_t *prep_area,
910 const char *host, const char *plugin, const char *db_name,
911 char **column_names, size_t column_num, cdtime_t interval)
913 udb_result_preparation_area_t *r_area;
917 if ((q == NULL) || (prep_area == NULL))
920 udb_query_finish_result (q, prep_area);
922 prep_area->column_num = column_num;
923 prep_area->host = strdup (host);
924 prep_area->plugin = strdup (plugin);
925 prep_area->db_name = strdup (db_name);
927 prep_area->interval = interval;
929 if ((prep_area->host == NULL) || (prep_area->plugin == NULL)
930 || (prep_area->db_name == NULL))
932 ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
933 udb_query_finish_result (q, prep_area);
937 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
942 for (i = 0; i < column_num; i++)
944 DEBUG ("db query utils: udb_query_prepare_result: "
945 "query = %s; column[%zu] = %s;",
946 q->name, i, column_names[i]);
951 for (r = q->results, r_area = prep_area->result_prep_areas;
952 r != NULL; r = r->next, r_area = r_area->next)
956 ERROR ("db query utils: Query `%s': Invalid number of result "
957 "preparation areas.", q->name);
958 udb_query_finish_result (q, prep_area);
962 status = udb_result_prepare_result (r, r_area, column_names, column_num);
965 udb_query_finish_result (q, prep_area);
971 } /* }}} int udb_query_prepare_result */
973 udb_query_preparation_area_t *
974 udb_query_allocate_preparation_area (udb_query_t *q) /* {{{ */
976 udb_query_preparation_area_t *q_area;
977 udb_result_preparation_area_t **next_r_area;
980 q_area = malloc (sizeof (*q_area));
983 memset (q_area, 0, sizeof (*q_area));
985 next_r_area = &q_area->result_prep_areas;
986 for (r = q->results; r != NULL; r = r->next)
988 udb_result_preparation_area_t *r_area;
990 r_area = malloc (sizeof (*r_area));
993 udb_result_preparation_area_t *a = q_area->result_prep_areas;
997 udb_result_preparation_area_t *next = a->next;
1006 memset (r_area, 0, sizeof (*r_area));
1008 *next_r_area = r_area;
1009 next_r_area = &r_area->next;
1013 } /* }}} udb_query_preparation_area_t *udb_query_allocate_preparation_area */
1016 udb_query_delete_preparation_area (udb_query_preparation_area_t *q_area) /* {{{ */
1018 udb_result_preparation_area_t *r_area;
1023 r_area = q_area->result_prep_areas;
1024 while (r_area != NULL)
1026 udb_result_preparation_area_t *area = r_area;
1028 r_area = r_area->next;
1030 sfree (area->instances_pos);
1031 sfree (area->values_pos);
1032 sfree (area->instances_buffer);
1033 sfree (area->values_buffer);
1037 sfree (q_area->host);
1038 sfree (q_area->plugin);
1039 sfree (q_area->db_name);
1042 } /* }}} void udb_query_delete_preparation_area */
1044 /* vim: set sw=2 sts=2 et fdm=marker : */