2 * collectd - src/oracle.c
3 * Copyright (C) 2008,2009 noris network AG
4 * Copyright (C) 2012 Florian octo Forster
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Linking src/oracle.c ("the oracle plugin") statically or dynamically with
20 * other modules is making a combined work based on the oracle plugin. Thus,
21 * the terms and conditions of the GNU General Public License cover the whole
24 * In addition, as a special exception, the copyright holders of the oracle
25 * plugin give you permission to combine the oracle plugin with free software
26 * programs or libraries that are released under the GNU LGPL and with code
27 * included in the standard release of the Oracle® Call Interface (OCI) under
28 * the Oracle® Technology Network (OTN) License (or modified versions of such
29 * code, with unchanged license). You may copy and distribute such a system
30 * following the terms of the GNU GPL for the oracle plugin and the licenses of
31 * the other code concerned.
33 * Note that people who make modified versions of the oracle plugin are not
34 * obligated to grant this special exception for their modified versions; it is
35 * their choice whether to do so. The GNU General Public License gives
36 * permission to release a modified version without this exception; this
37 * exception also makes it possible to release a modified version which carries
38 * forward this exception. However, without this exception the OTN License does
39 * not allow linking with code licensed under the GNU General Public License.
41 * Oracle® is a registered trademark of Oracle Corporation and/or its
42 * affiliates. Other names may be trademarks of their respective owners.
45 * Florian octo Forster <octo at collectd.org>
51 #include "configfile.h"
52 #include "utils_db_query.h"
66 udb_query_preparation_area_t **q_prep_areas;
67 udb_query_t **queries;
70 OCISvcCtx *oci_service_context;
72 typedef struct o_database_s o_database_t;
77 static udb_query_t **queries = NULL;
78 static size_t queries_num = 0;
79 static o_database_t **databases = NULL;
80 static size_t databases_num = 0;
82 OCIEnv *oci_env = NULL;
83 OCIError *oci_error = NULL;
88 static void o_report_error (const char *where, /* {{{ */
89 const char *db_name, const char *query_name,
90 const char *what, OCIError *eh)
95 unsigned int record_number;
99 if (query_name == NULL)
100 query_name = "(none)";
102 /* An operation may cause / return multiple errors. Loop until we have
103 * handled all errors available (with a fail-save limit of 16). */
104 for (record_number = 1; record_number <= 16; record_number++)
106 memset (buffer, 0, sizeof (buffer));
109 status = OCIErrorGet (eh, (ub4) record_number,
110 /* sqlstate = */ NULL,
113 (ub4) sizeof (buffer),
115 buffer[sizeof (buffer) - 1] = 0;
117 if (status == OCI_NO_DATA)
120 if (status == OCI_SUCCESS)
122 size_t buffer_length;
124 buffer_length = strlen (buffer);
125 while ((buffer_length > 0) && (buffer[buffer_length - 1] < 32))
128 buffer[buffer_length] = 0;
131 ERROR ("oracle plugin: %s (db = %s, query = %s): %s failed: %s",
132 where, db_name, query_name, what, buffer);
136 ERROR ("oracle plugin: %s (db = %s, query = %s): %s failed. "
137 "Additionally, OCIErrorGet failed with status %i.",
138 where, db_name, query_name, what, status);
142 } /* }}} void o_report_error */
144 static void o_database_free (o_database_t *db) /* {{{ */
152 sfree (db->connect_id);
153 sfree (db->username);
154 sfree (db->password);
157 if (db->q_prep_areas != NULL)
158 for (i = 0; i < db->queries_num; ++i)
159 udb_query_delete_preparation_area (db->q_prep_areas[i]);
160 free (db->q_prep_areas);
163 } /* }}} void o_database_free */
165 /* Configuration handling functions {{{
168 * <Query "plugin_instance0">
169 * Statement "SELECT name, value FROM table"
172 * InstancesFrom "name"
177 * <Database "plugin_instance1">
181 * Query "plugin_instance0"
186 static int o_config_set_string (char **ret_string, /* {{{ */
191 if ((ci->values_num != 1)
192 || (ci->values[0].type != OCONFIG_TYPE_STRING))
194 WARNING ("oracle plugin: The `%s' config option "
195 "needs exactly one string argument.", ci->key);
199 string = strdup (ci->values[0].value.string);
202 ERROR ("oracle plugin: strdup failed.");
206 if (*ret_string != NULL)
208 *ret_string = string;
211 } /* }}} int o_config_set_string */
213 static int o_config_add_database (oconfig_item_t *ci) /* {{{ */
219 if ((ci->values_num != 1)
220 || (ci->values[0].type != OCONFIG_TYPE_STRING))
222 WARNING ("oracle plugin: The `Database' block "
223 "needs exactly one string argument.");
227 db = (o_database_t *) malloc (sizeof (*db));
230 ERROR ("oracle plugin: malloc failed.");
233 memset (db, 0, sizeof (*db));
235 status = o_config_set_string (&db->name, ci);
242 /* Fill the `o_database_t' structure.. */
243 for (i = 0; i < ci->children_num; i++)
245 oconfig_item_t *child = ci->children + i;
247 if (strcasecmp ("ConnectID", child->key) == 0)
248 status = o_config_set_string (&db->connect_id, child);
249 else if (strcasecmp ("Username", child->key) == 0)
250 status = o_config_set_string (&db->username, child);
251 else if (strcasecmp ("Password", child->key) == 0)
252 status = o_config_set_string (&db->password, child);
253 else if (strcasecmp ("Query", child->key) == 0)
254 status = udb_query_pick_from_list (child, queries, queries_num,
255 &db->queries, &db->queries_num);
258 WARNING ("oracle plugin: Option `%s' not allowed here.", child->key);
266 /* Check that all necessary options have been given. */
269 if (db->connect_id == NULL)
271 WARNING ("oracle plugin: `ConnectID' not given for query `%s'", db->name);
274 if (db->username == NULL)
276 WARNING ("oracle plugin: `Username' not given for query `%s'", db->name);
279 if (db->password == NULL)
281 WARNING ("oracle plugin: `Password' not given for query `%s'", db->name);
286 } /* while (status == 0) */
288 while ((status == 0) && (db->queries_num > 0))
290 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
291 db->queries_num, sizeof (*db->q_prep_areas));
293 if (db->q_prep_areas == NULL)
295 WARNING ("oracle plugin: malloc failed");
300 for (i = 0; i < db->queries_num; ++i)
303 = udb_query_allocate_preparation_area (db->queries[i]);
305 if (db->q_prep_areas[i] == NULL)
307 WARNING ("oracle plugin: udb_query_allocate_preparation_area failed");
316 /* If all went well, add this query to the list of queries within the
317 * database structure. */
322 temp = (o_database_t **) realloc (databases,
323 sizeof (*databases) * (databases_num + 1));
326 ERROR ("oracle plugin: realloc failed");
332 databases[databases_num] = db;
339 o_database_free (db);
344 } /* }}} int o_config_add_database */
346 static int o_config (oconfig_item_t *ci) /* {{{ */
350 for (i = 0; i < ci->children_num; i++)
352 oconfig_item_t *child = ci->children + i;
353 if (strcasecmp ("Query", child->key) == 0)
354 udb_query_create (&queries, &queries_num, child,
355 /* callback = */ NULL, /* legacy mode = */ 0);
356 else if (strcasecmp ("Database", child->key) == 0)
357 o_config_add_database (child);
360 WARNING ("oracle plugin: Ignoring unknown config option `%s'.", child->key);
365 DEBUG ("oracle plugin: o_config: queries_num = %zu; queries[0] = %p; udb_query_get_user_data (queries[0]) = %p;",
366 queries_num, (void *) queries[0], udb_query_get_user_data (queries[0]));
368 } /* for (ci->children) */
371 } /* }}} int o_config */
373 /* }}} End of configuration handling functions */
375 static int o_init (void) /* {{{ */
382 status = OCIEnvCreate (&oci_env,
383 /* mode = */ OCI_THREADED,
384 /* context = */ NULL,
386 /* realloc = */ NULL,
388 /* user_data_size = */ 0,
389 /* user_data_ptr = */ NULL);
392 ERROR ("oracle plugin: OCIEnvCreate failed with status %i.", status);
396 status = OCIHandleAlloc (oci_env, (void *) &oci_error, OCI_HTYPE_ERROR,
397 /* user_data_size = */ 0, /* user_data = */ NULL);
398 if (status != OCI_SUCCESS)
400 ERROR ("oracle plugin: OCIHandleAlloc (OCI_HTYPE_ERROR) failed "
401 "with status %i.", status);
406 } /* }}} int o_init */
408 static int o_read_database_query (o_database_t *db, /* {{{ */
409 udb_query_t *q, udb_query_preparation_area_t *prep_area)
412 char **column_values;
415 OCIStmt *oci_statement;
417 /* List of `OCIDefine' pointers. These defines map columns to the buffer
418 * space declared above. */
419 OCIDefine **oci_defines;
424 oci_statement = udb_query_get_user_data (q);
426 /* Prepare the statement */
427 if (oci_statement == NULL) /* {{{ */
429 const char *statement;
431 statement = udb_query_get_statement (q);
432 assert (statement != NULL);
434 status = OCIHandleAlloc (oci_env, (void *) &oci_statement,
435 OCI_HTYPE_STMT, /* user_data_size = */ 0, /* user_data = */ NULL);
436 if (status != OCI_SUCCESS)
438 o_report_error ("o_read_database_query", db->name,
439 udb_query_get_name (q), "OCIHandleAlloc", oci_error);
440 oci_statement = NULL;
444 status = OCIStmtPrepare (oci_statement, oci_error,
445 (text *) statement, (ub4) strlen (statement),
446 /* language = */ OCI_NTV_SYNTAX,
447 /* mode = */ OCI_DEFAULT);
448 if (status != OCI_SUCCESS)
450 o_report_error ("o_read_database_query", db->name,
451 udb_query_get_name (q), "OCIStmtPrepare", oci_error);
452 OCIHandleFree (oci_statement, OCI_HTYPE_STMT);
453 oci_statement = NULL;
456 udb_query_set_user_data (q, oci_statement);
458 DEBUG ("oracle plugin: o_read_database_query (%s, %s): "
459 "Successfully allocated statement handle.",
460 db->name, udb_query_get_name (q));
463 assert (oci_statement != NULL);
465 /* Execute the statement */
466 status = OCIStmtExecute (db->oci_service_context, /* {{{ */
471 /* snap_in = */ NULL, /* snap_out = */ NULL,
472 /* mode = */ OCI_DEFAULT);
473 if (status != OCI_SUCCESS)
475 o_report_error ("o_read_database_query", db->name, udb_query_get_name (q),
476 "OCIStmtExecute", oci_error);
480 /* Acquire the number of columns returned. */
483 ub4 param_counter = 0;
484 status = OCIAttrGet (oci_statement, OCI_HTYPE_STMT, /* {{{ */
485 ¶m_counter, /* size pointer = */ NULL,
486 OCI_ATTR_PARAM_COUNT, oci_error);
487 if (status != OCI_SUCCESS)
489 o_report_error ("o_read_database_query", db->name,
490 udb_query_get_name (q), "OCIAttrGet", oci_error);
494 column_num = (size_t) param_counter;
495 } while (0); /* }}} */
497 /* Allocate the following buffers:
499 * +---------------+-----------------------------------+
501 * +---------------+-----------------------------------+
502 * ! column_names ! column_num x DATA_MAX_NAME_LEN !
503 * ! column_values ! column_num x DATA_MAX_NAME_LEN !
504 * ! oci_defines ! column_num x sizeof (OCIDefine *) !
505 * +---------------+-----------------------------------+
508 #define NUMBER_BUFFER_SIZE 64
511 if (column_names != NULL) { \
512 sfree (column_names[0]); \
513 sfree (column_names); \
515 if (column_values != NULL) { \
516 sfree (column_values[0]); \
517 sfree (column_values); \
521 #define ALLOC_OR_FAIL(ptr, ptr_size) \
523 size_t alloc_size = (size_t) ((ptr_size)); \
524 (ptr) = malloc (alloc_size); \
525 if ((ptr) == NULL) { \
527 ERROR ("oracle plugin: o_read_database_query: malloc failed."); \
530 memset ((ptr), 0, alloc_size); \
533 /* Initialize everything to NULL so the above works. */
535 column_values = NULL;
538 ALLOC_OR_FAIL (column_names, column_num * sizeof (char *));
539 ALLOC_OR_FAIL (column_names[0], column_num * DATA_MAX_NAME_LEN
541 for (i = 1; i < column_num; i++)
542 column_names[i] = column_names[i - 1] + DATA_MAX_NAME_LEN;
544 ALLOC_OR_FAIL (column_values, column_num * sizeof (char *));
545 ALLOC_OR_FAIL (column_values[0], column_num * DATA_MAX_NAME_LEN
547 for (i = 1; i < column_num; i++)
548 column_values[i] = column_values[i - 1] + DATA_MAX_NAME_LEN;
550 ALLOC_OR_FAIL (oci_defines, column_num * sizeof (OCIDefine *));
551 /* }}} End of buffer allocations. */
553 /* ``Define'' the returned data, i. e. bind the columns to the buffers
554 * allocated above. */
555 for (i = 0; i < column_num; i++) /* {{{ */
558 ub4 column_name_length;
563 status = OCIParamGet (oci_statement, OCI_HTYPE_STMT, oci_error,
564 (void *) &oci_param, (ub4) (i + 1));
565 if (status != OCI_SUCCESS)
567 /* This is probably alright */
568 DEBUG ("oracle plugin: o_read_database_query: status = %#x (= %i);",
570 o_report_error ("o_read_database_query", db->name,
571 udb_query_get_name (q), "OCIParamGet", oci_error);
572 status = OCI_SUCCESS;
577 column_name_length = 0;
578 status = OCIAttrGet (oci_param, OCI_DTYPE_PARAM,
579 &column_name, &column_name_length, OCI_ATTR_NAME, oci_error);
580 if (status != OCI_SUCCESS)
582 OCIDescriptorFree (oci_param, OCI_DTYPE_PARAM);
583 o_report_error ("o_read_database_query", db->name,
584 udb_query_get_name (q), "OCIAttrGet (OCI_ATTR_NAME)", oci_error);
588 OCIDescriptorFree (oci_param, OCI_DTYPE_PARAM);
591 /* Copy the name to column_names. Warning: The ``string'' returned by OCI
592 * may not be null terminated! */
593 memset (column_names[i], 0, DATA_MAX_NAME_LEN);
594 if (column_name_length >= DATA_MAX_NAME_LEN)
595 column_name_length = DATA_MAX_NAME_LEN - 1;
596 memcpy (column_names[i], column_name, column_name_length);
597 column_names[i][column_name_length] = 0;
599 DEBUG ("oracle plugin: o_read_database_query: column_names[%zu] = %s; "
600 "column_name_length = %"PRIu32";",
601 i, column_names[i], (uint32_t) column_name_length);
603 status = OCIDefineByPos (oci_statement,
604 &oci_defines[i], oci_error, (ub4) (i + 1),
605 column_values[i], DATA_MAX_NAME_LEN, SQLT_STR,
606 NULL, NULL, NULL, OCI_DEFAULT);
607 if (status != OCI_SUCCESS)
609 o_report_error ("o_read_database_query", db->name,
610 udb_query_get_name (q), "OCIDefineByPos", oci_error);
613 } /* for (j = 1; j <= param_counter; j++) */
614 /* }}} End of the ``define'' stuff. */
616 status = udb_query_prepare_result (q, prep_area, hostname_g,
617 /* plugin = */ "oracle", db->name, column_names, column_num,
618 /* interval = */ -1);
621 ERROR ("oracle plugin: o_read_database_query (%s, %s): "
622 "udb_query_prepare_result failed.",
623 db->name, udb_query_get_name (q));
628 /* Fetch and handle all the rows that matched the query. */
631 status = OCIStmtFetch2 (oci_statement, oci_error,
632 /* nrows = */ 1, /* orientation = */ OCI_FETCH_NEXT,
633 /* fetch offset = */ 0, /* mode = */ OCI_DEFAULT);
634 if (status == OCI_NO_DATA)
636 status = OCI_SUCCESS;
639 else if ((status != OCI_SUCCESS) && (status != OCI_SUCCESS_WITH_INFO))
641 o_report_error ("o_read_database_query", db->name,
642 udb_query_get_name (q), "OCIStmtFetch2", oci_error);
646 status = udb_query_handle_result (q, prep_area, column_values);
649 WARNING ("oracle plugin: o_read_database_query (%s, %s): "
650 "udb_query_handle_result failed.",
651 db->name, udb_query_get_name (q));
653 } /* }}} while (42) */
655 /* DEBUG ("oracle plugin: o_read_database_query: This statement succeeded: %s", q->statement); */
661 } /* }}} int o_read_database_query */
663 static int o_read_database (o_database_t *db) /* {{{ */
668 if (db->oci_service_context != NULL)
670 OCIServer *server_handle;
671 ub4 connection_status;
673 server_handle = NULL;
674 status = OCIAttrGet ((void *) db->oci_service_context, OCI_HTYPE_SVCCTX,
675 (void *) &server_handle, /* size pointer = */ NULL,
676 OCI_ATTR_SERVER, oci_error);
677 if (status != OCI_SUCCESS)
679 o_report_error ("o_read_database", db->name, NULL, "OCIAttrGet",
684 if (server_handle == NULL)
686 connection_status = OCI_SERVER_NOT_CONNECTED;
688 else /* if (server_handle != NULL) */
690 connection_status = 0;
691 status = OCIAttrGet ((void *) server_handle, OCI_HTYPE_SERVER,
692 (void *) &connection_status, /* size pointer = */ NULL,
693 OCI_ATTR_SERVER_STATUS, oci_error);
694 if (status != OCI_SUCCESS)
696 o_report_error ("o_read_database", db->name, NULL, "OCIAttrGet",
702 if (connection_status != OCI_SERVER_NORMAL)
704 INFO ("oracle plugin: Connection to %s lost. Trying to reconnect.",
706 OCIHandleFree (db->oci_service_context, OCI_HTYPE_SVCCTX);
707 db->oci_service_context = NULL;
709 } /* if (db->oci_service_context != NULL) */
711 if (db->oci_service_context == NULL)
713 status = OCILogon (oci_env, oci_error,
714 &db->oci_service_context,
715 (OraText *) db->username, (ub4) strlen (db->username),
716 (OraText *) db->password, (ub4) strlen (db->password),
717 (OraText *) db->connect_id, (ub4) strlen (db->connect_id));
718 if ((status != OCI_SUCCESS) && (status != OCI_SUCCESS_WITH_INFO))
722 ssnprintf (errfunc, sizeof (errfunc), "OCILogon(\"%s\")", db->connect_id);
724 o_report_error ("o_read_database", db->name, NULL, errfunc, oci_error);
725 DEBUG ("oracle plugin: OCILogon (%s): db->oci_service_context = %p;",
726 db->connect_id, db->oci_service_context);
727 db->oci_service_context = NULL;
730 else if (status == OCI_SUCCESS_WITH_INFO)
732 /* TODO: Print NOTIFY message. */
734 assert (db->oci_service_context != NULL);
737 DEBUG ("oracle plugin: o_read_database: db->connect_id = %s; db->oci_service_context = %p;",
738 db->connect_id, db->oci_service_context);
740 for (i = 0; i < db->queries_num; i++)
741 o_read_database_query (db, db->queries[i], db->q_prep_areas[i]);
744 } /* }}} int o_read_database */
746 static int o_read (void) /* {{{ */
750 for (i = 0; i < databases_num; i++)
751 o_read_database (databases[i]);
754 } /* }}} int o_read */
756 static int o_shutdown (void) /* {{{ */
760 for (i = 0; i < databases_num; i++)
761 if (databases[i]->oci_service_context != NULL)
763 OCIHandleFree (databases[i]->oci_service_context, OCI_HTYPE_SVCCTX);
764 databases[i]->oci_service_context = NULL;
767 for (i = 0; i < queries_num; i++)
769 OCIStmt *oci_statement;
771 oci_statement = udb_query_get_user_data (queries[i]);
772 if (oci_statement != NULL)
774 OCIHandleFree (oci_statement, OCI_HTYPE_STMT);
775 udb_query_set_user_data (queries[i], NULL);
779 OCIHandleFree (oci_env, OCI_HTYPE_ENV);
782 udb_query_free (queries, queries_num);
787 } /* }}} int o_shutdown */
789 void module_register (void) /* {{{ */
791 plugin_register_complex_config ("oracle", o_config);
792 plugin_register_init ("oracle", o_init);
793 plugin_register_read ("oracle", o_read);
794 plugin_register_shutdown ("oracle", o_shutdown);
795 } /* }}} void module_register */
798 * vim: shiftwidth=2 softtabstop=2 et fdm=marker