src/postgresql.c

   1 /**
   2  * collectd - src/postgresql.c
   3  * Copyright (C) 2008-2012  Sebastian Harl
   4  * Copyright (C) 2009       Florian Forster
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *   Sebastian Harl <sh at tokkee.org>
  26  *   Florian Forster <octo at collectd.org>
  27  **/
  28
  29 /*
  30  * This module collects PostgreSQL database statistics.
  31  */
  32
  33 #include "collectd.h"
  34 #include "common.h"
  35
  36 #include "configfile.h"
  37 #include "plugin.h"
  38
  39 #include "utils_cache.h"
  40 #include "utils_db_query.h"
  41 #include "utils_complain.h"
  42
  43 #if HAVE_PTHREAD_H
  44 # include <pthread.h>
  45 #endif
  46
  47 #include <pg_config_manual.h>
  48 #include <libpq-fe.h>
  49
  50 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
  51 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
  52 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
  53 #define log_debug(...) DEBUG ("postgresql: " __VA_ARGS__)
  54
  55 #ifndef C_PSQL_DEFAULT_CONF
  56 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
  57 #endif
  58
  59 /* Appends the (parameter, value) pair to the string
  60  * pointed to by 'buf' suitable to be used as argument
  61  * for PQconnectdb(). If value equals NULL, the pair
  62  * is ignored. */
  63 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
  64         if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
  65                 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
  66                 if (0 < s) { \
  67                         buf     += s; \
  68                         buf_len -= s; \
  69                 } \
  70         }
  71
  72 /* Returns the tuple (major, minor, patchlevel)
  73  * for the given version number. */
  74 #define C_PSQL_SERVER_VERSION3(server_version) \
  75         (server_version) / 10000, \
  76         (server_version) / 100 - (int)((server_version) / 10000) * 100, \
  77         (server_version) - (int)((server_version) / 100) * 100
  78
  79 /* Returns true if the given host specifies a
  80  * UNIX domain socket. */
  81 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
  82         ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
  83
  84 /* Returns the tuple (host, delimiter, port) for a
  85  * given (host, port) pair. Depending on the value of
  86  * 'host' a UNIX domain socket or a TCP socket is
  87  * assumed. */
  88 #define C_PSQL_SOCKET3(host, port) \
  89         ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
  90         C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
  91         port
  92
  93 typedef enum {
  94         C_PSQL_PARAM_HOST = 1,
  95         C_PSQL_PARAM_DB,
  96         C_PSQL_PARAM_USER,
  97         C_PSQL_PARAM_INTERVAL,
  98         C_PSQL_PARAM_INSTANCE,
  99 } c_psql_param_t;
 100
 101 /* Parameter configuration. Stored as `user data' in the query objects. */
 102 typedef struct {
 103         c_psql_param_t *params;
 104         int             params_num;
 105 } c_psql_user_data_t;
 106
 107 typedef struct {
 108         char *name;
 109         char *statement;
 110         _Bool store_rates;
 111 } c_psql_writer_t;
 112
 113 typedef struct {
 114         PGconn      *conn;
 115         c_complain_t conn_complaint;
 116
 117         int proto_version;
 118         int server_version;
 119
 120         int max_params_num;
 121
 122         /* user configuration */
 123         udb_query_preparation_area_t **q_prep_areas;
 124         udb_query_t    **queries;
 125         size_t           queries_num;
 126
 127         c_psql_writer_t **writers;
 128         size_t            writers_num;
 129
 130         /* make sure we don't access the database object in parallel */
 131         pthread_mutex_t   db_lock;
 132
 133         cdtime_t interval;
 134
 135         /* writer "caching" settings */
 136         cdtime_t commit_interval;
 137         cdtime_t next_commit;
 138
 139         char *host;
 140         char *port;
 141         char *database;
 142         char *user;
 143         char *password;
 144
 145         char *instance;
 146
 147         char *sslmode;
 148
 149         char *krbsrvname;
 150
 151         char *service;
 152
 153         int ref_cnt;
 154 } c_psql_database_t;
 155
 156 static char *def_queries[] = {
 157         "backends",
 158         "transactions",
 159         "queries",
 160         "query_plans",
 161         "table_states",
 162         "disk_io",
 163         "disk_usage"
 164 };
 165 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
 166
 167 static c_psql_database_t **databases     = NULL;
 168 static size_t              databases_num = 0;
 169
 170 static udb_query_t       **queries       = NULL;
 171 static size_t              queries_num   = 0;
 172
 173 static c_psql_writer_t    *writers       = NULL;
 174 static size_t              writers_num   = 0;
 175
 176 static int c_psql_begin (c_psql_database_t *db)
 177 {
 178         PGresult *r = PQexec (db->conn, "BEGIN");
 179
 180         int status = 1;
 181
 182         if (r != NULL) {
 183                 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
 184                         db->next_commit = cdtime() + db->commit_interval;
 185                         status = 0;
 186                 }
 187                 else
 188                         log_warn ("Failed to initiate ('BEGIN') transaction: %s",
 189                                         PQerrorMessage (db->conn));
 190                 PQclear (r);
 191         }
 192         return status;
 193 } /* c_psql_begin */
 194
 195 static int c_psql_commit (c_psql_database_t *db)
 196 {
 197         PGresult *r = PQexec (db->conn, "COMMIT");
 198
 199         int status = 1;
 200
 201         if (r != NULL) {
 202                 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
 203                         db->next_commit = 0;
 204                         log_debug ("Successfully committed transaction.");
 205                         status = 0;
 206                 }
 207                 else
 208                         log_warn ("Failed to commit transaction: %s",
 209                                         PQerrorMessage (db->conn));
 210                 PQclear (r);
 211         }
 212         return status;
 213 } /* c_psql_commit */
 214
 215 static c_psql_database_t *c_psql_database_new (const char *name)
 216 {
 217         c_psql_database_t **tmp;
 218         c_psql_database_t  *db;
 219
 220         db = (c_psql_database_t *)malloc (sizeof(*db));
 221         if (NULL == db) {
 222                 log_err ("Out of memory.");
 223                 return NULL;
 224         }
 225
 226         tmp = (c_psql_database_t **)realloc (databases,
 227                         (databases_num + 1) * sizeof (*databases));
 228         if (NULL == tmp) {
 229                 log_err ("Out of memory.");
 230                 sfree (db);
 231                 return NULL;
 232         }
 233
 234         databases = tmp;
 235         databases[databases_num] = db;
 236         ++databases_num;
 237
 238         db->conn = NULL;
 239
 240         C_COMPLAIN_INIT (&db->conn_complaint);
 241
 242         db->proto_version = 0;
 243         db->server_version = 0;
 244
 245         db->max_params_num = 0;
 246
 247         db->q_prep_areas   = NULL;
 248         db->queries        = NULL;
 249         db->queries_num    = 0;
 250
 251         db->writers        = NULL;
 252         db->writers_num    = 0;
 253
 254         pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
 255
 256         db->interval   = 0;
 257
 258         db->commit_interval = 0;
 259         db->next_commit     = 0;
 260
 261         db->database   = sstrdup (name);
 262         db->host       = NULL;
 263         db->port       = NULL;
 264         db->user       = NULL;
 265         db->password   = NULL;
 266
 267         db->instance   = sstrdup (name);
 268
 269         db->sslmode    = NULL;
 270
 271         db->krbsrvname = NULL;
 272
 273         db->service    = NULL;
 274
 275         db->ref_cnt    = 0;
 276         return db;
 277 } /* c_psql_database_new */
 278
 279 static void c_psql_database_delete (void *data)
 280 {
 281         size_t i;
 282
 283         c_psql_database_t *db = data;
 284
 285         --db->ref_cnt;
 286         /* readers and writers may access this database */
 287         if (db->ref_cnt > 0)
 288                 return;
 289
 290         /* wait for the lock to be released by the last writer */
 291         pthread_mutex_lock (&db->db_lock);
 292
 293         if (db->next_commit > 0)
 294                 c_psql_commit (db);
 295
 296         PQfinish (db->conn);
 297         db->conn = NULL;
 298
 299         if (db->q_prep_areas)
 300                 for (i = 0; i < db->queries_num; ++i)
 301                         udb_query_delete_preparation_area (db->q_prep_areas[i]);
 302         free (db->q_prep_areas);
 303
 304         sfree (db->queries);
 305         db->queries_num = 0;
 306
 307         sfree (db->writers);
 308         db->writers_num = 0;
 309
 310         pthread_mutex_unlock (&db->db_lock);
 311
 312         pthread_mutex_destroy (&db->db_lock);
 313
 314         sfree (db->database);
 315         sfree (db->host);
 316         sfree (db->port);
 317         sfree (db->user);
 318         sfree (db->password);
 319
 320         sfree (db->instance);
 321
 322         sfree (db->sslmode);
 323
 324         sfree (db->krbsrvname);
 325
 326         sfree (db->service);
 327
 328         /* don't care about freeing or reordering the 'databases' array
 329          * this is done in 'shutdown'; also, don't free the database instance
 330          * object just to make sure that in case anybody accesses it before
 331          * shutdown won't segfault */
 332         return;
 333 } /* c_psql_database_delete */
 334
 335 static int c_psql_connect (c_psql_database_t *db)
 336 {
 337         char  conninfo[4096];
 338         char *buf     = conninfo;
 339         int   buf_len = sizeof (conninfo);
 340         int   status;
 341
 342         if ((! db) || (! db->database))
 343                 return -1;
 344
 345         status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
 346         if (0 < status) {
 347                 buf     += status;
 348                 buf_len -= status;
 349         }
 350
 351         C_PSQL_PAR_APPEND (buf, buf_len, "host",       db->host);
 352         C_PSQL_PAR_APPEND (buf, buf_len, "port",       db->port);
 353         C_PSQL_PAR_APPEND (buf, buf_len, "user",       db->user);
 354         C_PSQL_PAR_APPEND (buf, buf_len, "password",   db->password);
 355         C_PSQL_PAR_APPEND (buf, buf_len, "sslmode",    db->sslmode);
 356         C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
 357         C_PSQL_PAR_APPEND (buf, buf_len, "service",    db->service);
 358
 359         db->conn = PQconnectdb (conninfo);
 360         db->proto_version = PQprotocolVersion (db->conn);
 361         return 0;
 362 } /* c_psql_connect */
 363
 364 static int c_psql_check_connection (c_psql_database_t *db)
 365 {
 366         _Bool init = 0;
 367
 368         if (! db->conn) {
 369                 init = 1;
 370
 371                 /* trigger c_release() */
 372                 if (0 == db->conn_complaint.interval)
 373                         db->conn_complaint.interval = 1;
 374
 375                 c_psql_connect (db);
 376         }
 377
 378         if (CONNECTION_OK != PQstatus (db->conn)) {
 379                 PQreset (db->conn);
 380
 381                 /* trigger c_release() */
 382                 if (0 == db->conn_complaint.interval)
 383                         db->conn_complaint.interval = 1;
 384
 385                 if (CONNECTION_OK != PQstatus (db->conn)) {
 386                         c_complain (LOG_ERR, &db->conn_complaint,
 387                                         "Failed to connect to database %s (%s): %s",
 388                                         db->database, db->instance,
 389                                         PQerrorMessage (db->conn));
 390                         return -1;
 391                 }
 392
 393                 db->proto_version = PQprotocolVersion (db->conn);
 394         }
 395
 396         db->server_version = PQserverVersion (db->conn);
 397
 398         if (c_would_release (&db->conn_complaint)) {
 399                 char *server_host;
 400                 int   server_version;
 401
 402                 server_host    = PQhost (db->conn);
 403                 server_version = PQserverVersion (db->conn);
 404
 405                 c_do_release (LOG_INFO, &db->conn_complaint,
 406                                 "Successfully %sconnected to database %s (user %s) "
 407                                 "at server %s%s%s (server version: %d.%d.%d, "
 408                                 "protocol version: %d, pid: %d)", init ? "" : "re",
 409                                 PQdb (db->conn), PQuser (db->conn),
 410                                 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
 411                                 C_PSQL_SERVER_VERSION3 (server_version),
 412                                 db->proto_version, PQbackendPID (db->conn));
 413
 414                 if (3 > db->proto_version)
 415                         log_warn ("Protocol version %d does not support parameters.",
 416                                         db->proto_version);
 417         }
 418         return 0;
 419 } /* c_psql_check_connection */
 420
 421 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
 422                 udb_query_t *q)
 423 {
 424         return PQexec (db->conn, udb_query_get_statement (q));
 425 } /* c_psql_exec_query_noparams */
 426
 427 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
 428                 udb_query_t *q, c_psql_user_data_t *data)
 429 {
 430         char *params[db->max_params_num];
 431         char  interval[64];
 432         int   i;
 433
 434         if ((data == NULL) || (data->params_num == 0))
 435                 return (c_psql_exec_query_noparams (db, q));
 436
 437         assert (db->max_params_num >= data->params_num);
 438
 439         for (i = 0; i < data->params_num; ++i) {
 440                 switch (data->params[i]) {
 441                         case C_PSQL_PARAM_HOST:
 442                                 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
 443                                         ? "localhost" : db->host;
 444                                 break;
 445                         case C_PSQL_PARAM_DB:
 446                                 params[i] = db->database;
 447                                 break;
 448                         case C_PSQL_PARAM_USER:
 449                                 params[i] = db->user;
 450                                 break;
 451                         case C_PSQL_PARAM_INTERVAL:
 452                                 ssnprintf (interval, sizeof (interval), "%.3f",
 453                                                 (db->interval > 0)
 454                                                 ? CDTIME_T_TO_DOUBLE (db->interval)
 455                                                 : plugin_get_interval ());
 456                                 params[i] = interval;
 457                                 break;
 458                         case C_PSQL_PARAM_INSTANCE:
 459                                 params[i] = db->instance;
 460                                 break;
 461                         default:
 462                                 assert (0);
 463                 }
 464         }
 465
 466         return PQexecParams (db->conn, udb_query_get_statement (q),
 467                         data->params_num, NULL,
 468                         (const char *const *) params,
 469                         NULL, NULL, /* return text data */ 0);
 470 } /* c_psql_exec_query_params */
 471
 472 /* db->db_lock must be locked when calling this function */
 473 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
 474                 udb_query_preparation_area_t *prep_area)
 475 {
 476         PGresult *res;
 477
 478         c_psql_user_data_t *data;
 479
 480         const char *host;
 481
 482         char **column_names;
 483         char **column_values;
 484         int    column_num;
 485
 486         int rows_num;
 487         int status;
 488         int row, col;
 489
 490         /* The user data may hold parameter information, but may be NULL. */
 491         data = udb_query_get_user_data (q);
 492
 493         /* Versions up to `3' don't know how to handle parameters. */
 494         if (3 <= db->proto_version)
 495                 res = c_psql_exec_query_params (db, q, data);
 496         else if ((NULL == data) || (0 == data->params_num))
 497                 res = c_psql_exec_query_noparams (db, q);
 498         else {
 499                 log_err ("Connection to database \"%s\" (%s) does not support "
 500                                 "parameters (protocol version %d) - "
 501                                 "cannot execute query \"%s\".",
 502                                 db->database, db->instance, db->proto_version,
 503                                 udb_query_get_name (q));
 504                 return -1;
 505         }
 506
 507         /* give c_psql_write() a chance to acquire the lock if called recursively
 508          * through dispatch_values(); this will happen if, both, queries and
 509          * writers are configured for a single connection */
 510         pthread_mutex_unlock (&db->db_lock);
 511
 512         column_names = NULL;
 513         column_values = NULL;
 514
 515         if (PGRES_TUPLES_OK != PQresultStatus (res)) {
 516                 pthread_mutex_lock (&db->db_lock);
 517
 518                 if ((CONNECTION_OK != PQstatus (db->conn))
 519                                 && (0 == c_psql_check_connection (db))) {
 520                         PQclear (res);
 521                         return c_psql_exec_query (db, q, prep_area);
 522                 }
 523
 524                 log_err ("Failed to execute SQL query: %s",
 525                                 PQerrorMessage (db->conn));
 526                 log_info ("SQL query was: %s",
 527                                 udb_query_get_statement (q));
 528                 PQclear (res);
 529                 return -1;
 530         }
 531
 532 #define BAIL_OUT(status) \
 533         sfree (column_names); \
 534         sfree (column_values); \
 535         PQclear (res); \
 536         pthread_mutex_lock (&db->db_lock); \
 537         return status
 538
 539         rows_num = PQntuples (res);
 540         if (1 > rows_num) {
 541                 BAIL_OUT (0);
 542         }
 543
 544         column_num = PQnfields (res);
 545         column_names = (char **) calloc (column_num, sizeof (char *));
 546         if (NULL == column_names) {
 547                 log_err ("calloc failed.");
 548                 BAIL_OUT (-1);
 549         }
 550
 551         column_values = (char **) calloc (column_num, sizeof (char *));
 552         if (NULL == column_values) {
 553                 log_err ("calloc failed.");
 554                 BAIL_OUT (-1);
 555         }
 556
 557         for (col = 0; col < column_num; ++col) {
 558                 /* Pointers returned by `PQfname' are freed by `PQclear' via
 559                  * `BAIL_OUT'. */
 560                 column_names[col] = PQfname (res, col);
 561                 if (NULL == column_names[col]) {
 562                         log_err ("Failed to resolve name of column %i.", col);
 563                         BAIL_OUT (-1);
 564                 }
 565         }
 566
 567         if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
 568                         || (0 == strcmp (db->host, "127.0.0.1"))
 569                         || (0 == strcmp (db->host, "localhost")))
 570                 host = hostname_g;
 571         else
 572                 host = db->host;
 573
 574         status = udb_query_prepare_result (q, prep_area, host, "postgresql",
 575                         db->instance, column_names, (size_t) column_num, db->interval);
 576         if (0 != status) {
 577                 log_err ("udb_query_prepare_result failed with status %i.",
 578                                 status);
 579                 BAIL_OUT (-1);
 580         }
 581
 582         for (row = 0; row < rows_num; ++row) {
 583                 for (col = 0; col < column_num; ++col) {
 584                         /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
 585                          * `BAIL_OUT'. */
 586                         column_values[col] = PQgetvalue (res, row, col);
 587                         if (NULL == column_values[col]) {
 588                                 log_err ("Failed to get value at (row = %i, col = %i).",
 589                                                 row, col);
 590                                 break;
 591                         }
 592                 }
 593
 594                 /* check for an error */
 595                 if (col < column_num)
 596                         continue;
 597
 598                 status = udb_query_handle_result (q, prep_area, column_values);
 599                 if (status != 0) {
 600                         log_err ("udb_query_handle_result failed with status %i.",
 601                                         status);
 602                 }
 603         } /* for (row = 0; row < rows_num; ++row) */
 604
 605         udb_query_finish_result (q, prep_area);
 606
 607         BAIL_OUT (0);
 608 #undef BAIL_OUT
 609 } /* c_psql_exec_query */
 610
 611 static int c_psql_read (user_data_t *ud)
 612 {
 613         c_psql_database_t *db;
 614
 615         int success = 0;
 616         int i;
 617
 618         if ((ud == NULL) || (ud->data == NULL)) {
 619                 log_err ("c_psql_read: Invalid user data.");
 620                 return -1;
 621         }
 622
 623         db = ud->data;
 624
 625         assert (NULL != db->database);
 626         assert (NULL != db->instance);
 627         assert (NULL != db->queries);
 628
 629         pthread_mutex_lock (&db->db_lock);
 630
 631         if (0 != c_psql_check_connection (db)) {
 632                 pthread_mutex_unlock (&db->db_lock);
 633                 return -1;
 634         }
 635
 636         for (i = 0; i < db->queries_num; ++i)
 637         {
 638                 udb_query_preparation_area_t *prep_area;
 639                 udb_query_t *q;
 640
 641                 prep_area = db->q_prep_areas[i];
 642                 q = db->queries[i];
 643
 644                 if ((0 != db->server_version)
 645                                 && (udb_query_check_version (q, db->server_version) <= 0))
 646                         continue;
 647
 648                 if (0 == c_psql_exec_query (db, q, prep_area))
 649                         success = 1;
 650         }
 651
 652         pthread_mutex_unlock (&db->db_lock);
 653
 654         if (! success)
 655                 return -1;
 656         return 0;
 657 } /* c_psql_read */
 658
 659 static char *values_name_to_sqlarray (const data_set_t *ds,
 660                 char *string, size_t string_len)
 661 {
 662         char  *str_ptr;
 663         size_t str_len;
 664
 665         int i;
 666
 667         str_ptr = string;
 668         str_len = string_len;
 669
 670         for (i = 0; i < ds->ds_num; ++i) {
 671                 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
 672
 673                 if (status < 1)
 674                         return NULL;
 675                 else if ((size_t)status >= str_len) {
 676                         str_len = 0;
 677                         break;
 678                 }
 679                 else {
 680                         str_ptr += status;
 681                         str_len -= (size_t)status;
 682                 }
 683         }
 684
 685         if (str_len <= 2) {
 686                 log_err ("c_psql_write: Failed to stringify value names");
 687                 return NULL;
 688         }
 689
 690         /* overwrite the first comma */
 691         string[0] = '{';
 692         str_ptr[0] = '}';
 693         str_ptr[1] = '\0';
 694
 695         return string;
 696 } /* values_name_to_sqlarray */
 697
 698 static char *values_type_to_sqlarray (const data_set_t *ds,
 699                 char *string, size_t string_len, _Bool store_rates)
 700 {
 701         char  *str_ptr;
 702         size_t str_len;
 703
 704         int i;
 705
 706         str_ptr = string;
 707         str_len = string_len;
 708
 709         for (i = 0; i < ds->ds_num; ++i) {
 710                 int status;
 711
 712                 if (store_rates)
 713                         status = ssnprintf(str_ptr, str_len, ",'gauge'");
 714                 else
 715                         status = ssnprintf(str_ptr, str_len, ",'%s'",
 716                                         DS_TYPE_TO_STRING (ds->ds[i].type));
 717
 718                 if (status < 1) {
 719                         str_len = 0;
 720                         break;
 721                 }
 722                 else if ((size_t)status >= str_len) {
 723                         str_len = 0;
 724                         break;
 725                 }
 726                 else {
 727                         str_ptr += status;
 728                         str_len -= (size_t)status;
 729                 }
 730         }
 731
 732         if (str_len <= 2) {
 733                 log_err ("c_psql_write: Failed to stringify value types");
 734                 return NULL;
 735         }
 736
 737         /* overwrite the first comma */
 738         string[0] = '{';
 739         str_ptr[0] = '}';
 740         str_ptr[1] = '\0';
 741
 742         return string;
 743 } /* values_type_to_sqlarray */
 744
 745 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
 746                 char *string, size_t string_len, _Bool store_rates)
 747 {
 748         char  *str_ptr;
 749         size_t str_len;
 750
 751         gauge_t *rates = NULL;
 752
 753         int i;
 754
 755         str_ptr = string;
 756         str_len = string_len;
 757
 758         for (i = 0; i < vl->values_len; ++i) {
 759                 int status = 0;
 760
 761                 if ((ds->ds[i].type != DS_TYPE_GAUGE)
 762                                 && (ds->ds[i].type != DS_TYPE_COUNTER)
 763                                 && (ds->ds[i].type != DS_TYPE_DERIVE)
 764                                 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
 765                         log_err ("c_psql_write: Unknown data source type: %i",
 766                                         ds->ds[i].type);
 767                         sfree (rates);
 768                         return NULL;
 769                 }
 770
 771                 if (ds->ds[i].type == DS_TYPE_GAUGE)
 772                         status = ssnprintf (str_ptr, str_len,
 773                                         ",%f", vl->values[i].gauge);
 774                 else if (store_rates) {
 775                         if (rates == NULL)
 776                                 rates = uc_get_rate (ds, vl);
 777
 778                         if (rates == NULL) {
 779                                 log_err ("c_psql_write: Failed to determine rate");
 780                                 return NULL;
 781                         }
 782
 783                         status = ssnprintf (str_ptr, str_len,
 784                                         ",%lf", rates[i]);
 785                 }
 786                 else if (ds->ds[i].type == DS_TYPE_COUNTER)
 787                         status = ssnprintf (str_ptr, str_len,
 788                                         ",%llu", vl->values[i].counter);
 789                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
 790                         status = ssnprintf (str_ptr, str_len,
 791                                         ",%"PRIi64, vl->values[i].derive);
 792                 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
 793                         status = ssnprintf (str_ptr, str_len,
 794                                         ",%"PRIu64, vl->values[i].absolute);
 795
 796                 if (status < 1) {
 797                         str_len = 0;
 798                         break;
 799                 }
 800                 else if ((size_t)status >= str_len) {
 801                         str_len = 0;
 802                         break;
 803                 }
 804                 else {
 805                         str_ptr += status;
 806                         str_len -= (size_t)status;
 807                 }
 808         }
 809
 810         sfree (rates);
 811
 812         if (str_len <= 2) {
 813                 log_err ("c_psql_write: Failed to stringify value list");
 814                 return NULL;
 815         }
 816
 817         /* overwrite the first comma */
 818         string[0] = '{';
 819         str_ptr[0] = '}';
 820         str_ptr[1] = '\0';
 821
 822         return string;
 823 } /* values_to_sqlarray */
 824
 825 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
 826                 user_data_t *ud)
 827 {
 828         c_psql_database_t *db;
 829
 830         char time_str[32];
 831         char values_name_str[1024];
 832         char values_type_str[1024];
 833         char values_str[1024];
 834
 835         const char *params[9];
 836
 837         int success = 0;
 838         int i;
 839
 840         if ((ud == NULL) || (ud->data == NULL)) {
 841                 log_err ("c_psql_write: Invalid user data.");
 842                 return -1;
 843         }
 844
 845         db = ud->data;
 846         assert (db->database != NULL);
 847         assert (db->writers != NULL);
 848
 849         if (cdtime_to_iso8601 (time_str, sizeof (time_str), vl->time) == 0) {
 850                 log_err ("c_psql_write: Failed to convert time to ISO 8601 format");
 851                 return -1;
 852         }
 853
 854         if (values_name_to_sqlarray (ds,
 855                                 values_name_str, sizeof (values_name_str)) == NULL)
 856                 return -1;
 857
 858 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
 859
 860         params[0] = time_str;
 861         params[1] = vl->host;
 862         params[2] = vl->plugin;
 863         params[3] = VALUE_OR_NULL(vl->plugin_instance);
 864         params[4] = vl->type;
 865         params[5] = VALUE_OR_NULL(vl->type_instance);
 866         params[6] = values_name_str;
 867
 868 #undef VALUE_OR_NULL
 869
 870         pthread_mutex_lock (&db->db_lock);
 871
 872         if (0 != c_psql_check_connection (db)) {
 873                 pthread_mutex_unlock (&db->db_lock);
 874                 return -1;
 875         }
 876
 877         if ((db->commit_interval > 0)
 878                         && (db->next_commit == 0))
 879                 c_psql_begin (db);
 880
 881         for (i = 0; i < db->writers_num; ++i) {
 882                 c_psql_writer_t *writer;
 883                 PGresult *res;
 884
 885                 writer = db->writers[i];
 886
 887                 if (values_type_to_sqlarray (ds,
 888                                         values_type_str, sizeof (values_type_str),
 889                                         writer->store_rates) == NULL) {
 890                         pthread_mutex_unlock (&db->db_lock);
 891                         return -1;
 892                 }
 893
 894                 if (values_to_sqlarray (ds, vl,
 895                                         values_str, sizeof (values_str),
 896                                         writer->store_rates) == NULL) {
 897                         pthread_mutex_unlock (&db->db_lock);
 898                         return -1;
 899                 }
 900
 901                 params[7] = values_type_str;
 902                 params[8] = values_str;
 903
 904                 res = PQexecParams (db->conn, writer->statement,
 905                                 STATIC_ARRAY_SIZE (params), NULL,
 906                                 (const char *const *)params,
 907                                 NULL, NULL, /* return text data */ 0);
 908
 909                 if ((PGRES_COMMAND_OK != PQresultStatus (res))
 910                                 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
 911                         PQclear (res);
 912
 913                         if ((CONNECTION_OK != PQstatus (db->conn))
 914                                         && (0 == c_psql_check_connection (db))) {
 915                                 /* try again */
 916                                 res = PQexecParams (db->conn, writer->statement,
 917                                                 STATIC_ARRAY_SIZE (params), NULL,
 918                                                 (const char *const *)params,
 919                                                 NULL, NULL, /* return text data */ 0);
 920
 921                                 if ((PGRES_COMMAND_OK == PQresultStatus (res))
 922                                                 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
 923                                         PQclear (res);
 924                                         success = 1;
 925                                         continue;
 926                                 }
 927                         }
 928
 929                         log_err ("Failed to execute SQL query: %s",
 930                                         PQerrorMessage (db->conn));
 931                         log_info ("SQL query was: '%s', "
 932                                         "params: %s, %s, %s, %s, %s, %s, %s, %s",
 933                                         writer->statement,
 934                                         params[0], params[1], params[2], params[3],
 935                                         params[4], params[5], params[6], params[7]);
 936
 937                         /* this will abort any current transaction -> restart */
 938                         if (db->next_commit > 0)
 939                                 c_psql_commit (db);
 940
 941                         pthread_mutex_unlock (&db->db_lock);
 942                         return -1;
 943                 }
 944
 945                 PQclear (res);
 946                 success = 1;
 947         }
 948
 949         if ((db->next_commit > 0)
 950                         && (cdtime () > db->next_commit))
 951                 c_psql_commit (db);
 952
 953         pthread_mutex_unlock (&db->db_lock);
 954
 955         if (! success)
 956                 return -1;
 957         return 0;
 958 } /* c_psql_write */
 959
 960 /* We cannot flush single identifiers as all we do is to commit the currently
 961  * running transaction, thus making sure that all written data is actually
 962  * visible to everybody. */
 963 static int c_psql_flush (cdtime_t timeout,
 964                 __attribute__((unused)) const char *ident,
 965                 user_data_t *ud)
 966 {
 967         c_psql_database_t **dbs = databases;
 968         size_t dbs_num = databases_num;
 969         size_t i;
 970
 971         if ((ud != NULL) && (ud->data != NULL)) {
 972                 dbs = (void *)&ud->data;
 973                 dbs_num = 1;
 974         }
 975
 976         for (i = 0; i < dbs_num; ++i) {
 977                 c_psql_database_t *db = dbs[i];
 978
 979                 /* don't commit if the timeout is larger than the regular commit
 980                  * interval as in that case all requested data has already been
 981                  * committed */
 982                 if ((db->next_commit > 0) && (db->commit_interval > timeout))
 983                         c_psql_commit (db);
 984         }
 985         return 0;
 986 } /* c_psql_flush */
 987
 988 static int c_psql_shutdown (void)
 989 {
 990         size_t i = 0;
 991
 992         _Bool had_flush = 0;
 993
 994         plugin_unregister_read_group ("postgresql");
 995
 996         for (i = 0; i < databases_num; ++i) {
 997                 c_psql_database_t *db = databases[i];
 998
 999                 if (db->writers_num > 0) {
1000                         char cb_name[DATA_MAX_NAME_LEN];
1001                         ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
1002                                         db->database);
1003
1004                         if (! had_flush) {
1005                                 plugin_unregister_flush ("postgresql");
1006                                 had_flush = 1;
1007                         }
1008
1009                         plugin_unregister_flush (cb_name);
1010                         plugin_unregister_write (cb_name);
1011                 }
1012
1013                 sfree (db);
1014         }
1015
1016         udb_query_free (queries, queries_num);
1017         queries = NULL;
1018         queries_num = 0;
1019
1020         sfree (writers);
1021         writers = NULL;
1022         writers_num = 0;
1023
1024         sfree (databases);
1025         databases = NULL;
1026         databases_num = 0;
1027
1028         return 0;
1029 } /* c_psql_shutdown */
1030
1031 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1032 {
1033         c_psql_user_data_t *data;
1034         const char *param_str;
1035
1036         c_psql_param_t *tmp;
1037
1038         data = udb_query_get_user_data (q);
1039         if (NULL == data) {
1040                 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
1041                 if (NULL == data) {
1042                         log_err ("Out of memory.");
1043                         return -1;
1044                 }
1045                 memset (data, 0, sizeof (*data));
1046                 data->params = NULL;
1047         }
1048
1049         tmp = (c_psql_param_t *) realloc (data->params,
1050                         (data->params_num + 1) * sizeof (c_psql_param_t));
1051         if (NULL == tmp) {
1052                 log_err ("Out of memory.");
1053                 return -1;
1054         }
1055         data->params = tmp;
1056
1057         param_str = ci->values[0].value.string;
1058         if (0 == strcasecmp (param_str, "hostname"))
1059                 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1060         else if (0 == strcasecmp (param_str, "database"))
1061                 data->params[data->params_num] = C_PSQL_PARAM_DB;
1062         else if (0 == strcasecmp (param_str, "username"))
1063                 data->params[data->params_num] = C_PSQL_PARAM_USER;
1064         else if (0 == strcasecmp (param_str, "interval"))
1065                 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1066         else if (0 == strcasecmp (param_str, "instance"))
1067                 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1068         else {
1069                 log_err ("Invalid parameter \"%s\".", param_str);
1070                 return 1;
1071         }
1072
1073         data->params_num++;
1074         udb_query_set_user_data (q, data);
1075
1076         return (0);
1077 } /* config_query_param_add */
1078
1079 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1080 {
1081         if (0 == strcasecmp ("Param", ci->key))
1082                 return config_query_param_add (q, ci);
1083
1084         log_err ("Option not allowed within a Query block: `%s'", ci->key);
1085
1086         return (-1);
1087 } /* config_query_callback */
1088
1089 static int config_add_writer (oconfig_item_t *ci,
1090                 c_psql_writer_t *src_writers, size_t src_writers_num,
1091                 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1092 {
1093         char *name;
1094
1095         size_t i;
1096
1097         if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1098                 return -1;
1099
1100         if ((ci->values_num != 1)
1101                         || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1102                 log_err ("`Writer' expects a single string argument.");
1103                 return 1;
1104         }
1105
1106         name = ci->values[0].value.string;
1107
1108         for (i = 0; i < src_writers_num; ++i) {
1109                 c_psql_writer_t **tmp;
1110
1111                 if (strcasecmp (name, src_writers[i].name) != 0)
1112                         continue;
1113
1114                 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1115                                 sizeof (**dst_writers) * (*dst_writers_num + 1));
1116                 if (tmp == NULL) {
1117                         log_err ("Out of memory.");
1118                         return -1;
1119                 }
1120
1121                 tmp[*dst_writers_num] = src_writers + i;
1122
1123                 *dst_writers = tmp;
1124                 ++(*dst_writers_num);
1125                 break;
1126         }
1127
1128         if (i >= src_writers_num) {
1129                 log_err ("No such writer: `%s'", name);
1130                 return -1;
1131         }
1132
1133         return 0;
1134 } /* config_add_writer */
1135
1136 static int c_psql_config_writer (oconfig_item_t *ci)
1137 {
1138         c_psql_writer_t *writer;
1139         c_psql_writer_t *tmp;
1140
1141         int status = 0;
1142         int i;
1143
1144         if ((ci->values_num != 1)
1145                         || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1146                 log_err ("<Writer> expects a single string argument.");
1147                 return 1;
1148         }
1149
1150         tmp = (c_psql_writer_t *)realloc (writers,
1151                         sizeof (*writers) * (writers_num + 1));
1152         if (tmp == NULL) {
1153                 log_err ("Out of memory.");
1154                 return -1;
1155         }
1156
1157         writers = tmp;
1158         writer  = writers + writers_num;
1159         ++writers_num;
1160
1161         writer->name = sstrdup (ci->values[0].value.string);
1162         writer->statement = NULL;
1163         writer->store_rates = 1;
1164
1165         for (i = 0; i < ci->children_num; ++i) {
1166                 oconfig_item_t *c = ci->children + i;
1167
1168                 if (strcasecmp ("Statement", c->key) == 0)
1169                         status = cf_util_get_string (c, &writer->statement);
1170                 else if (strcasecmp ("StoreRates", c->key) == 0)
1171                         status = cf_util_get_boolean (c, &writer->store_rates);
1172                 else
1173                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
1174         }
1175
1176         if (status != 0) {
1177                 sfree (writer->statement);
1178                 sfree (writer->name);
1179                 sfree (writer);
1180                 return status;
1181         }
1182
1183         return 0;
1184 } /* c_psql_config_writer */
1185
1186 static int c_psql_config_database (oconfig_item_t *ci)
1187 {
1188         c_psql_database_t *db;
1189
1190         char cb_name[DATA_MAX_NAME_LEN];
1191         struct timespec cb_interval = { 0, 0 };
1192         user_data_t ud;
1193
1194         static _Bool have_flush = 0;
1195
1196         int i;
1197
1198         if ((1 != ci->values_num)
1199                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1200                 log_err ("<Database> expects a single string argument.");
1201                 return 1;
1202         }
1203
1204         memset (&ud, 0, sizeof (ud));
1205
1206         db = c_psql_database_new (ci->values[0].value.string);
1207         if (db == NULL)
1208                 return -1;
1209
1210         for (i = 0; i < ci->children_num; ++i) {
1211                 oconfig_item_t *c = ci->children + i;
1212
1213                 if (0 == strcasecmp (c->key, "Host"))
1214                         cf_util_get_string (c, &db->host);
1215                 else if (0 == strcasecmp (c->key, "Port"))
1216                         cf_util_get_service (c, &db->port);
1217                 else if (0 == strcasecmp (c->key, "User"))
1218                         cf_util_get_string (c, &db->user);
1219                 else if (0 == strcasecmp (c->key, "Password"))
1220                         cf_util_get_string (c, &db->password);
1221                 else if (0 == strcasecmp (c->key, "Instance"))
1222                         cf_util_get_string (c, &db->instance);
1223                 else if (0 == strcasecmp (c->key, "SSLMode"))
1224                         cf_util_get_string (c, &db->sslmode);
1225                 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1226                         cf_util_get_string (c, &db->krbsrvname);
1227                 else if (0 == strcasecmp (c->key, "Service"))
1228                         cf_util_get_string (c, &db->service);
1229                 else if (0 == strcasecmp (c->key, "Query"))
1230                         udb_query_pick_from_list (c, queries, queries_num,
1231                                         &db->queries, &db->queries_num);
1232                 else if (0 == strcasecmp (c->key, "Writer"))
1233                         config_add_writer (c, writers, writers_num,
1234                                         &db->writers, &db->writers_num);
1235                 else if (0 == strcasecmp (c->key, "Interval"))
1236                         cf_util_get_cdtime (c, &db->interval);
1237                 else if (strcasecmp ("CommitInterval", c->key) == 0)
1238                         cf_util_get_cdtime (c, &db->commit_interval);
1239                 else
1240                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
1241         }
1242
1243         /* If no `Query' options were given, add the default queries.. */
1244         if ((db->queries_num == 0) && (db->writers_num == 0)){
1245                 for (i = 0; i < def_queries_num; i++)
1246                         udb_query_pick_from_list_by_name (def_queries[i],
1247                                         queries, queries_num,
1248                                         &db->queries, &db->queries_num);
1249         }
1250
1251         if (db->queries_num > 0) {
1252                 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1253                                 db->queries_num, sizeof (*db->q_prep_areas));
1254
1255                 if (db->q_prep_areas == NULL) {
1256                         log_err ("Out of memory.");
1257                         c_psql_database_delete (db);
1258                         return -1;
1259                 }
1260         }
1261
1262         for (i = 0; (size_t)i < db->queries_num; ++i) {
1263                 c_psql_user_data_t *data;
1264                 data = udb_query_get_user_data (db->queries[i]);
1265                 if ((data != NULL) && (data->params_num > db->max_params_num))
1266                         db->max_params_num = data->params_num;
1267
1268                 db->q_prep_areas[i]
1269                         = udb_query_allocate_preparation_area (db->queries[i]);
1270
1271                 if (db->q_prep_areas[i] == NULL) {
1272                         log_err ("Out of memory.");
1273                         c_psql_database_delete (db);
1274                         return -1;
1275                 }
1276         }
1277
1278         ud.data = db;
1279         ud.free_func = c_psql_database_delete;
1280
1281         ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1282
1283         if (db->queries_num > 0) {
1284                 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1285
1286                 ++db->ref_cnt;
1287                 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1288                                 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1289                                 &ud);
1290         }
1291         if (db->writers_num > 0) {
1292                 ++db->ref_cnt;
1293                 plugin_register_write (cb_name, c_psql_write, &ud);
1294
1295                 if (! have_flush) {
1296                         /* flush all */
1297                         plugin_register_flush ("postgresql",
1298                                         c_psql_flush, /* user data = */ NULL);
1299                         have_flush = 1;
1300                 }
1301
1302                 /* flush this connection only */
1303                 ++db->ref_cnt;
1304                 plugin_register_flush (cb_name, c_psql_flush, &ud);
1305         }
1306         else if (db->commit_interval > 0) {
1307                 log_warn ("Database '%s': You do not have any writers assigned to "
1308                                 "this database connection. Setting 'CommitInterval' does "
1309                                 "not have any effect.", db->database);
1310         }
1311         return 0;
1312 } /* c_psql_config_database */
1313
1314 static int c_psql_config (oconfig_item_t *ci)
1315 {
1316         static int have_def_config = 0;
1317
1318         int i;
1319
1320         if (0 == have_def_config) {
1321                 oconfig_item_t *c;
1322
1323                 have_def_config = 1;
1324
1325                 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1326                 if (NULL == c)
1327                         log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1328                 else
1329                         c_psql_config (c);
1330
1331                 if (NULL == queries)
1332                         log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1333                                         "any queries - please check your installation.");
1334         }
1335
1336         for (i = 0; i < ci->children_num; ++i) {
1337                 oconfig_item_t *c = ci->children + i;
1338
1339                 if (0 == strcasecmp (c->key, "Query"))
1340                         udb_query_create (&queries, &queries_num, c,
1341                                         /* callback = */ config_query_callback);
1342                 else if (0 == strcasecmp (c->key, "Writer"))
1343                         c_psql_config_writer (c);
1344                 else if (0 == strcasecmp (c->key, "Database"))
1345                         c_psql_config_database (c);
1346                 else
1347                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
1348         }
1349         return 0;
1350 } /* c_psql_config */
1351
1352 void module_register (void)
1353 {
1354         plugin_register_complex_config ("postgresql", c_psql_config);
1355         plugin_register_shutdown ("postgresql", c_psql_shutdown);
1356 } /* module_register */
1357
1358 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */