src/utils_db_query.c

   1 /**
   2  * collectd - src/utils_db_query.c
   3  * Copyright (C) 2008,2009  Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26 #include "utils_db_query.h"
  27
  28 /*
  29  * Data types
  30  */
  31 struct udb_result_s; /* {{{ */
  32 typedef struct udb_result_s udb_result_t;
  33 struct udb_result_s
  34 {
  35   char    *type;
  36   char    *instance_prefix;
  37   char   **instances;
  38   size_t   instances_num;
  39   char   **values;
  40   size_t   values_num;
  41
  42   /* Preparation area */
  43   const   data_set_t *ds;
  44   size_t *instances_pos;
  45   size_t *values_pos;
  46   char  **instances_buffer;
  47   char  **values_buffer;
  48
  49   udb_result_t *next;
  50 }; /* }}} */
  51
  52 struct udb_query_s /* {{{ */
  53 {
  54   char *name;
  55   char *statement;
  56   void *user_data;
  57
  58   int legacy_mode;
  59
  60   unsigned int min_version;
  61   unsigned int max_version;
  62
  63   /* Preparation area */
  64   size_t column_num;
  65   char *host;
  66   char *plugin;
  67   char *db_name;
  68
  69   udb_result_t *results;
  70 }; /* }}} */
  71
  72 /*
  73  * Config Private functions
  74  */
  75 static int udb_config_set_string (char **ret_string, /* {{{ */
  76     oconfig_item_t *ci)
  77 {
  78   char *string;
  79
  80   if ((ci->values_num != 1)
  81       || (ci->values[0].type != OCONFIG_TYPE_STRING))
  82   {
  83     WARNING ("db query utils: The `%s' config option "
  84         "needs exactly one string argument.", ci->key);
  85     return (-1);
  86   }
  87
  88   string = strdup (ci->values[0].value.string);
  89   if (string == NULL)
  90   {
  91     ERROR ("db query utils: strdup failed.");
  92     return (-1);
  93   }
  94
  95   if (*ret_string != NULL)
  96     free (*ret_string);
  97   *ret_string = string;
  98
  99   return (0);
 100 } /* }}} int udb_config_set_string */
 101
 102 static int udb_config_add_string (char ***ret_array, /* {{{ */
 103     size_t *ret_array_len, oconfig_item_t *ci)
 104 {
 105   char **array;
 106   size_t array_len;
 107   int i;
 108
 109   if (ci->values_num < 1)
 110   {
 111     WARNING ("db query utils: The `%s' config option "
 112         "needs at least one argument.", ci->key);
 113     return (-1);
 114   }
 115
 116   for (i = 0; i < ci->values_num; i++)
 117   {
 118     if (ci->values[i].type != OCONFIG_TYPE_STRING)
 119     {
 120       WARNING ("db query utils: Argument %i to the `%s' option "
 121           "is not a string.", i + 1, ci->key);
 122       return (-1);
 123     }
 124   }
 125
 126   array_len = *ret_array_len;
 127   array = (char **) realloc (*ret_array,
 128       sizeof (char *) * (array_len + ci->values_num));
 129   if (array == NULL)
 130   {
 131     ERROR ("db query utils: realloc failed.");
 132     return (-1);
 133   }
 134   *ret_array = array;
 135
 136   for (i = 0; i < ci->values_num; i++)
 137   {
 138     array[array_len] = strdup (ci->values[i].value.string);
 139     if (array[array_len] == NULL)
 140     {
 141       ERROR ("db query utils: strdup failed.");
 142       *ret_array_len = array_len;
 143       return (-1);
 144     }
 145     array_len++;
 146   }
 147
 148   *ret_array_len = array_len;
 149   return (0);
 150 } /* }}} int udb_config_add_string */
 151
 152 static int udb_config_set_uint (unsigned int *ret_value, /* {{{ */
 153     oconfig_item_t *ci)
 154 {
 155   double tmp;
 156
 157   if ((ci->values_num != 1)
 158       || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 159   {
 160     WARNING ("db query utils: The `%s' config option "
 161         "needs exactly one numeric argument.", ci->key);
 162     return (-1);
 163   }
 164
 165   tmp = ci->values[0].value.number;
 166   if ((tmp < 0.0) || (tmp > ((double) UINT_MAX)))
 167     return (-ERANGE);
 168
 169   *ret_value = (unsigned int) (tmp + .5);
 170   return (0);
 171 } /* }}} int udb_config_set_uint */
 172
 173 /*
 174  * Result private functions
 175  */
 176 static void udb_result_submit (udb_result_t *r, udb_query_t *q) /* {{{ */
 177 {
 178   value_list_t vl = VALUE_LIST_INIT;
 179   size_t i;
 180
 181   assert (((size_t) r->ds->ds_num) == r->values_num);
 182
 183   DEBUG ("db query utils: udb_result_submit: r->instance_prefix = %s;",
 184       (r->instance_prefix == NULL) ? "NULL" : r->instance_prefix);
 185   for (i = 0; i < r->instances_num; i++)
 186   {
 187     DEBUG ("db query utils: udb_result_submit: r->instances_buffer[%zu] = %s;",
 188         i, r->instances_buffer[i]);
 189   }
 190
 191   vl.values = (value_t *) calloc (r->ds->ds_num, sizeof (value_t));
 192   if (vl.values == NULL)
 193   {
 194     ERROR ("db query utils: malloc failed.");
 195     return;
 196   }
 197   vl.values_len = r->ds->ds_num;
 198
 199   for (i = 0; i < r->values_num; i++)
 200   {
 201     char *endptr;
 202
 203     endptr = NULL;
 204     errno = 0;
 205     if (r->ds->ds[i].type == DS_TYPE_COUNTER)
 206       vl.values[i].counter = (counter_t) strtoll (r->values_buffer[i],
 207           &endptr, /* base = */ 0);
 208     else if (r->ds->ds[i].type == DS_TYPE_GAUGE)
 209       vl.values[i].gauge = (gauge_t) strtod (r->values_buffer[i], &endptr);
 210     else
 211       errno = EINVAL;
 212
 213     if ((endptr == r->values_buffer[i]) || (errno != 0))
 214     {
 215       WARNING ("db query utils: udb_result_submit: Parsing `%s' as %s failed.",
 216           r->values_buffer[i],
 217           (r->ds->ds[i].type == DS_TYPE_COUNTER) ? "counter" : "gauge");
 218       vl.values[i].gauge = NAN;
 219     }
 220   }
 221
 222   sstrncpy (vl.host, q->host, sizeof (vl.host));
 223   sstrncpy (vl.plugin, q->plugin, sizeof (vl.plugin));
 224   sstrncpy (vl.plugin_instance, q->db_name, sizeof (vl.type_instance));
 225   sstrncpy (vl.type, r->type, sizeof (vl.type));
 226
 227   if (r->instance_prefix == NULL)
 228   {
 229     strjoin (vl.type_instance, sizeof (vl.type_instance),
 230         r->instances_buffer, r->instances_num, "-");
 231   }
 232   else
 233   {
 234     char tmp[DATA_MAX_NAME_LEN];
 235
 236     strjoin (tmp, sizeof (tmp), r->instances_buffer, r->instances_num, "-");
 237     tmp[sizeof (tmp) - 1] = 0;
 238
 239     snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
 240         r->instance_prefix, tmp);
 241   }
 242   vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
 243
 244   plugin_dispatch_values (&vl);
 245
 246   sfree (vl.values);
 247 } /* }}} void udb_result_submit */
 248
 249 static void udb_result_finish_result (udb_result_t *r) /* {{{ */
 250 {
 251   if (r == NULL)
 252     return;
 253
 254   r->ds = NULL;
 255   sfree (r->instances_pos);
 256   sfree (r->values_pos);
 257   sfree (r->instances_buffer);
 258   sfree (r->values_buffer);
 259 } /* }}} void udb_result_finish_result */
 260
 261 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
 262     udb_query_t *q, char **column_values)
 263 {
 264   size_t i;
 265
 266   for (i = 0; i < r->instances_num; i++)
 267     r->instances_buffer[i] = column_values[r->instances_pos[i]];
 268
 269   for (i = 0; i < r->values_num; i++)
 270     r->values_buffer[i] = column_values[r->values_pos[i]];
 271
 272   udb_result_submit (r, q);
 273
 274   return (0);
 275 } /* }}} int udb_result_handle_result */
 276
 277 static int udb_result_prepare_result (udb_result_t *r, /* {{{ */
 278     char **column_names, size_t column_num)
 279 {
 280   size_t i;
 281
 282   if (r == NULL)
 283     return (-EINVAL);
 284
 285 #define BAIL_OUT(status) \
 286   r->ds = NULL; \
 287   sfree (r->instances_pos); \
 288   sfree (r->values_pos); \
 289   sfree (r->instances_buffer); \
 290   sfree (r->values_buffer); \
 291   return (status)
 292
 293   /* Make sure previous preparations are cleaned up. */
 294   udb_result_finish_result (r);
 295   r->instances_pos = NULL;
 296   r->values_pos = NULL;
 297
 298   /* Read `ds' and check number of values {{{ */
 299   r->ds = plugin_get_ds (r->type);
 300   if (r->ds == NULL)
 301   {
 302     ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
 303         "known by the daemon. See types.db(5) for details.",
 304         r->type);
 305     BAIL_OUT (-1);
 306   }
 307
 308   if (((size_t) r->ds->ds_num) != r->values_num)
 309   {
 310     ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
 311         "requires exactly %i value%s, but the configuration specifies %zu.",
 312         r->type,
 313         r->ds->ds_num, (r->ds->ds_num == 1) ? "" : "s",
 314         r->values_num);
 315     BAIL_OUT (-1);
 316   }
 317   /* }}} */
 318
 319   /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
 320    * r->values_buffer {{{ */
 321   r->instances_pos = (size_t *) calloc (r->instances_num, sizeof (size_t));
 322   if (r->instances_pos == NULL)
 323   {
 324     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 325     BAIL_OUT (-ENOMEM);
 326   }
 327
 328   r->values_pos = (size_t *) calloc (r->values_num, sizeof (size_t));
 329   if (r->values_pos == NULL)
 330   {
 331     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 332     BAIL_OUT (-ENOMEM);
 333   }
 334
 335   r->instances_buffer = (char **) calloc (r->instances_num, sizeof (char *));
 336   if (r->instances_buffer == NULL)
 337   {
 338     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 339     BAIL_OUT (-ENOMEM);
 340   }
 341
 342   r->values_buffer = (char **) calloc (r->values_num, sizeof (char *));
 343   if (r->values_buffer == NULL)
 344   {
 345     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 346     BAIL_OUT (-ENOMEM);
 347   }
 348   /* }}} */
 349
 350   /* Determine the position of the instance columns {{{ */
 351   for (i = 0; i < r->instances_num; i++)
 352   {
 353     size_t j;
 354
 355     for (j = 0; j < column_num; j++)
 356     {
 357       if (strcasecmp (r->instances[i], column_names[j]) == 0)
 358       {
 359         r->instances_pos[i] = j;
 360         break;
 361       }
 362     }
 363
 364     if (j >= column_num)
 365     {
 366       ERROR ("db query utils: udb_result_prepare_result: "
 367           "Column `%s' could not be found.",
 368           r->instances[i]);
 369       BAIL_OUT (-ENOENT);
 370     }
 371   } /* }}} for (i = 0; i < r->instances_num; i++) */
 372
 373   /* Determine the position of the value columns {{{ */
 374   for (i = 0; i < r->values_num; i++)
 375   {
 376     size_t j;
 377
 378     for (j = 0; j < column_num; j++)
 379     {
 380       if (strcasecmp (r->values[i], column_names[j]) == 0)
 381       {
 382         r->values_pos[i] = j;
 383         break;
 384       }
 385     }
 386
 387     if (j >= column_num)
 388     {
 389       ERROR ("db query utils: udb_result_prepare_result: "
 390           "Column `%s' could not be found.",
 391           r->values[i]);
 392       BAIL_OUT (-ENOENT);
 393     }
 394   } /* }}} for (i = 0; i < r->values_num; i++) */
 395
 396 #undef BAIL_OUT
 397   return (0);
 398 } /* }}} int udb_result_prepare_result */
 399
 400 static void udb_result_free (udb_result_t *r) /* {{{ */
 401 {
 402   size_t i;
 403
 404   if (r == NULL)
 405     return;
 406
 407   sfree (r->type);
 408
 409   for (i = 0; i < r->instances_num; i++)
 410     sfree (r->instances[i]);
 411   sfree (r->instances);
 412
 413   for (i = 0; i < r->values_num; i++)
 414     sfree (r->values[i]);
 415   sfree (r->values);
 416
 417   udb_result_free (r->next);
 418
 419   sfree (r);
 420 } /* }}} void udb_result_free */
 421
 422 static int udb_result_create (const char *query_name, /* {{{ */
 423     udb_result_t **r_head, oconfig_item_t *ci)
 424 {
 425   udb_result_t *r;
 426   int status;
 427   int i;
 428
 429   if (ci->values_num != 0)
 430   {
 431     WARNING ("db query utils: The `Result' block doesn't accept "
 432         "any arguments. Ignoring %i argument%s.",
 433         ci->values_num, (ci->values_num == 1) ? "" : "s");
 434   }
 435
 436   r = (udb_result_t *) malloc (sizeof (*r));
 437   if (r == NULL)
 438   {
 439     ERROR ("db query utils: malloc failed.");
 440     return (-1);
 441   }
 442   memset (r, 0, sizeof (*r));
 443   r->type = NULL;
 444   r->instance_prefix = NULL;
 445   r->instances = NULL;
 446   r->values = NULL;
 447   r->next = NULL;
 448
 449   /* Fill the `udb_result_t' structure.. */
 450   status = 0;
 451   for (i = 0; i < ci->children_num; i++)
 452   {
 453     oconfig_item_t *child = ci->children + i;
 454
 455     if (strcasecmp ("Type", child->key) == 0)
 456       status = udb_config_set_string (&r->type, child);
 457     else if (strcasecmp ("InstancePrefix", child->key) == 0)
 458       status = udb_config_set_string (&r->instance_prefix, child);
 459     else if (strcasecmp ("InstancesFrom", child->key) == 0)
 460       status = udb_config_add_string (&r->instances, &r->instances_num, child);
 461     else if (strcasecmp ("ValuesFrom", child->key) == 0)
 462       status = udb_config_add_string (&r->values, &r->values_num, child);
 463     else
 464     {
 465       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 466           query_name, child->key);
 467       status = -1;
 468     }
 469
 470     if (status != 0)
 471       break;
 472   }
 473
 474   /* Check that all necessary options have been given. */
 475   while (status == 0)
 476   {
 477     if (r->type == NULL)
 478     {
 479       WARNING ("db query utils: `Type' not given for "
 480           "result in query `%s'", query_name);
 481       status = -1;
 482     }
 483     if (r->instances == NULL)
 484     {
 485       WARNING ("db query utils: `InstancesFrom' not given for "
 486           "result in query `%s'", query_name);
 487       status = -1;
 488     }
 489     if (r->values == NULL)
 490     {
 491       WARNING ("db query utils: `ValuesFrom' not given for "
 492           "result in query `%s'", query_name);
 493       status = -1;
 494     }
 495
 496     break;
 497   } /* while (status == 0) */
 498
 499   if (status != 0)
 500   {
 501     udb_result_free (r);
 502     return (-1);
 503   }
 504
 505   /* If all went well, add this result to the list of results. */
 506   if (*r_head == NULL)
 507   {
 508     *r_head = r;
 509   }
 510   else
 511   {
 512     udb_result_t *last;
 513
 514     last = *r_head;
 515     while (last->next != NULL)
 516       last = last->next;
 517
 518     last->next = r;
 519   }
 520
 521   return (0);
 522 } /* }}} int udb_result_create */
 523
 524 /*
 525  * Query private functions
 526  */
 527 void udb_query_free_one (udb_query_t *q) /* {{{ */
 528 {
 529   if (q == NULL)
 530     return;
 531
 532   sfree (q->name);
 533   sfree (q->statement);
 534
 535   udb_result_free (q->results);
 536
 537   sfree (q);
 538 } /* }}} void udb_query_free_one */
 539
 540 /*
 541  * Query public functions
 542  */
 543 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
 544     size_t *ret_query_list_len, oconfig_item_t *ci,
 545     udb_query_create_callback_t cb, int legacy_mode)
 546 {
 547   udb_query_t **query_list;
 548   size_t        query_list_len;
 549
 550   udb_query_t *q;
 551   int status;
 552   int i;
 553
 554   if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
 555     return (-EINVAL);
 556   query_list     = *ret_query_list;
 557   query_list_len = *ret_query_list_len;
 558
 559   if ((ci->values_num != 1)
 560       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 561   {
 562     WARNING ("db query utils: The `Query' block "
 563         "needs exactly one string argument.");
 564     return (-1);
 565   }
 566
 567   q = (udb_query_t *) malloc (sizeof (*q));
 568   if (q == NULL)
 569   {
 570     ERROR ("db query utils: malloc failed.");
 571     return (-1);
 572   }
 573   memset (q, 0, sizeof (*q));
 574   q->legacy_mode = legacy_mode;
 575   q->min_version = 0;
 576   q->max_version = UINT_MAX;
 577
 578   status = udb_config_set_string (&q->name, ci);
 579   if (status != 0)
 580   {
 581     sfree (q);
 582     return (status);
 583   }
 584
 585   /* Fill the `udb_query_t' structure.. */
 586   for (i = 0; i < ci->children_num; i++)
 587   {
 588     oconfig_item_t *child = ci->children + i;
 589
 590     if (strcasecmp ("Statement", child->key) == 0)
 591       status = udb_config_set_string (&q->statement, child);
 592     else if (strcasecmp ("Result", child->key) == 0)
 593       status = udb_result_create (q->name, &q->results, child);
 594     else if (strcasecmp ("MinVersion", child->key) == 0)
 595       status = udb_config_set_uint (&q->min_version, child);
 596     else if (strcasecmp ("MaxVersion", child->key) == 0)
 597       status = udb_config_set_uint (&q->max_version, child);
 598
 599     /* PostgreSQL compatibility code */
 600     else if ((strcasecmp ("Query", child->key) == 0)
 601         && (q->legacy_mode == 1))
 602     {
 603       WARNING ("db query utils: Query `%s': The `Query' option is "
 604           "deprecated. Please use `Statement' instead.",
 605           q->name);
 606       status = udb_config_set_string (&q->statement, child);
 607     }
 608     else if ((strcasecmp ("MinPGVersion", child->key) == 0)
 609         && (q->legacy_mode == 1))
 610     {
 611       WARNING ("db query utils: Query `%s': The `MinPGVersion' option is "
 612           "deprecated. Please use `MinVersion' instead.",
 613           q->name);
 614       status = udb_config_set_uint (&q->min_version, child);
 615     }
 616     else if ((strcasecmp ("MaxPGVersion", child->key) == 0)
 617         && (q->legacy_mode == 1))
 618     {
 619       WARNING ("db query utils: Query `%s': The `MaxPGVersion' option is "
 620           "deprecated. Please use `MaxVersion' instead.",
 621           q->name);
 622       status = udb_config_set_uint (&q->max_version, child);
 623     }
 624
 625     /* Call custom callbacks */
 626     else if (cb != NULL)
 627     {
 628       status = (*cb) (q, child);
 629       if (status != 0)
 630       {
 631         WARNING ("db query utils: The configuration callback failed "
 632             "to handle `%s'.", child->key);
 633       }
 634     }
 635     else
 636     {
 637       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 638           q->name, child->key);
 639       status = -1;
 640     }
 641
 642     if (status != 0)
 643       break;
 644   }
 645
 646   /* Check that all necessary options have been given. */
 647   if (status == 0)
 648   {
 649     if (q->statement == NULL)
 650     {
 651       WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
 652       status = -1;
 653     }
 654     if (q->results == NULL)
 655     {
 656       WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
 657           q->name);
 658       status = -1;
 659     }
 660   } /* if (status == 0) */
 661
 662   /* If all went well, add this query to the list of queries within the
 663    * database structure. */
 664   if (status == 0)
 665   {
 666     udb_query_t **temp;
 667
 668     temp = (udb_query_t **) realloc (query_list,
 669         sizeof (*query_list) * (query_list_len + 1));
 670     if (temp == NULL)
 671     {
 672       ERROR ("db query utils: realloc failed");
 673       status = -1;
 674     }
 675     else
 676     {
 677       query_list = temp;
 678       query_list[query_list_len] = q;
 679       query_list_len++;
 680     }
 681   }
 682
 683   if (status != 0)
 684   {
 685     udb_query_free_one (q);
 686     return (-1);
 687   }
 688
 689   *ret_query_list     = query_list;
 690   *ret_query_list_len = query_list_len;
 691
 692   return (0);
 693 } /* }}} int udb_query_create */
 694
 695 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
 696 {
 697   size_t i;
 698
 699   if (query_list == NULL)
 700     return;
 701
 702   for (i = 0; i < query_list_len; i++)
 703     udb_query_free_one (query_list[i]);
 704
 705   sfree (query_list);
 706 } /* }}} void udb_query_free */
 707
 708 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
 709     udb_query_t **src_list, size_t src_list_len,
 710     udb_query_t ***dst_list, size_t *dst_list_len)
 711 {
 712   const char *name;
 713   udb_query_t *q;
 714   udb_query_t **tmp_list;
 715   size_t tmp_list_len;
 716   size_t i;
 717
 718   if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
 719       || (dst_list_len == NULL))
 720   {
 721     ERROR ("db query utils: Invalid argument.");
 722     return (-EINVAL);
 723   }
 724
 725   if ((ci->values_num != 1)
 726       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 727   {
 728     ERROR ("db query utils: The `%s' config option "
 729         "needs exactly one string argument.", ci->key);
 730     return (-1);
 731   }
 732   name = ci->values[0].value.string;
 733
 734   q = NULL;
 735   for (i = 0; i < src_list_len; i++)
 736     if (strcasecmp (name, src_list[i]->name) == 0)
 737     {
 738       q = src_list[i];
 739       break;
 740     }
 741
 742   if (q == NULL)
 743   {
 744     ERROR ("db query utils: Cannot find query `%s'. Make sure the <%s> "
 745         "block is above the database definition!",
 746         name, ci->key);
 747     return (-ENOENT);
 748   }
 749
 750   tmp_list_len = *dst_list_len;
 751   tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
 752       * sizeof (udb_query_t *));
 753   if (tmp_list == NULL)
 754   {
 755     ERROR ("db query utils: realloc failed.");
 756     return (-ENOMEM);
 757   }
 758   tmp_list[tmp_list_len] = q;
 759   tmp_list_len++;
 760
 761   *dst_list = tmp_list;
 762   *dst_list_len = tmp_list_len;
 763
 764   return (0);
 765 } /* }}} int udb_query_pick_from_list */
 766
 767 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
 768 {
 769   if (q == NULL)
 770     return (NULL);
 771
 772   return (q->name);
 773 } /* }}} const char *udb_query_get_name */
 774
 775 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
 776 {
 777   if (q == NULL)
 778     return (NULL);
 779
 780   return (q->statement);
 781 } /* }}} const char *udb_query_get_statement */
 782
 783 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
 784 {
 785   if (q == NULL)
 786     return;
 787
 788   q->user_data = user_data;
 789 } /* }}} void udb_query_set_user_data */
 790
 791 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
 792 {
 793   if (q == NULL)
 794     return (NULL);
 795
 796   return (q->user_data);
 797 } /* }}} void *udb_query_get_user_data */
 798
 799 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
 800 {
 801   if (q == NULL)
 802     return (-EINVAL);
 803
 804   if ((version < q->min_version) || (version > q->max_version))
 805     return (0);
 806
 807   return (1);
 808 } /* }}} int udb_query_check_version */
 809
 810 void udb_query_finish_result (udb_query_t *q) /* {{{ */
 811 {
 812   udb_result_t *r;
 813
 814   if (q == NULL)
 815     return;
 816
 817   q->column_num = 0;
 818   sfree (q->host);
 819   sfree (q->plugin);
 820   sfree (q->db_name);
 821
 822   for (r = q->results; r != NULL; r = r->next)
 823     udb_result_finish_result (r);
 824 } /* }}} void udb_query_finish_result */
 825
 826 int udb_query_handle_result (udb_query_t *q, char **column_values) /* {{{ */
 827 {
 828   udb_result_t *r;
 829   int success;
 830   int status;
 831
 832   if (q == NULL)
 833     return (-EINVAL);
 834
 835   if ((q->column_num < 1) || (q->host == NULL) || (q->plugin == NULL)
 836       || (q->db_name == NULL))
 837   {
 838     ERROR ("db query utils: Query `%s': Query is not prepared; "
 839         "can't handle result.", q->name);
 840     return (-EINVAL);
 841   }
 842
 843 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
 844   do
 845   {
 846     size_t i;
 847
 848     for (i = 0; i < q->column_num; i++)
 849     {
 850       DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
 851           "column[%zu] = %s;",
 852           q->db_name, q->name, i, column_values[i]);
 853     }
 854   } while (0);
 855 #endif /* }}} */
 856
 857   success = 0;
 858   for (r = q->results; r != NULL; r = r->next)
 859   {
 860     status = udb_result_handle_result (r, q, column_values);
 861     if (status == 0)
 862       success++;
 863   }
 864
 865   if (success == 0)
 866   {
 867     ERROR ("db query utils: udb_query_handle_result (%s, %s): "
 868         "All results failed.", q->db_name, q->name);
 869     return (-1);
 870   }
 871
 872   return (0);
 873 } /* }}} int udb_query_handle_result */
 874
 875 int udb_query_prepare_result (udb_query_t *q, /* {{{ */
 876     const char *host, const char *plugin, const char *db_name,
 877     char **column_names, size_t column_num)
 878 {
 879   udb_result_t *r;
 880   int status;
 881
 882   if (q == NULL)
 883     return (-EINVAL);
 884
 885   udb_query_finish_result (q);
 886
 887   q->column_num = column_num;
 888   q->host = strdup (host);
 889   q->plugin = strdup (plugin);
 890   q->db_name = strdup (db_name);
 891
 892   if ((q->host == NULL) || (q->plugin == NULL) || (q->db_name == NULL))
 893   {
 894     ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
 895     udb_query_finish_result (q);
 896     return (-ENOMEM);
 897   }
 898
 899 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
 900   do
 901   {
 902     size_t i;
 903
 904     for (i = 0; i < column_num; i++)
 905     {
 906       DEBUG ("db query utils: udb_query_prepare_result: "
 907           "query = %s; column[%zu] = %s;",
 908           q->name, i, column_names[i]);
 909     }
 910   } while (0);
 911 #endif
 912
 913   for (r = q->results; r != NULL; r = r->next)
 914   {
 915     status = udb_result_prepare_result (r, column_names, column_num);
 916     if (status != 0)
 917     {
 918       udb_query_finish_result (q);
 919       return (status);
 920     }
 921   }
 922
 923   return (0);
 924 } /* }}} int udb_query_prepare_result */
 925
 926 /* vim: set sw=2 sts=2 et fdm=marker : */