Fix stuck channel in ARI through the introduction of synchronous bridge actions.
[asterisk/asterisk.git] / res / res_odbc.c
index aa2e2c8..bdbe8f2 100644 (file)
  * \arg See also: \ref cdr_odbc
  */
 
+/*! \li \ref res_odbc.c uses the configuration file \ref res_odbc.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_odbc.conf res_odbc.conf
+ * \verbinclude res_odbc.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>generic_odbc</depend>
        <depend>ltdl</depend>
@@ -153,7 +162,7 @@ static void odbc_release_obj2(struct odbc_obj *obj, struct odbc_txn_frame *tx);
 
 AST_THREADSTORAGE(errors_buf);
 
-static struct ast_datastore_info txn_info = {
+static const struct ast_datastore_info txn_info = {
        .type = "ODBC_Transaction",
        .destroy = odbc_txn_free,
 };
@@ -365,6 +374,10 @@ static int mark_transaction_active(struct ast_channel *chan, struct odbc_txn_fra
                chan = tx->owner;
        }
 
+       if (!chan) {
+               return -1;
+       }
+
        ast_channel_lock(chan);
        if (!(txn_store = ast_channel_datastore_find(chan, &txn_info, NULL))) {
                ast_channel_unlock(chan);
@@ -416,7 +429,6 @@ static void odbc_obj_destructor(void *data)
        struct odbc_class *class = obj->parent;
        obj->parent = NULL;
        odbc_obj_disconnect(obj);
-       ast_mutex_destroy(&obj->lock);
        ao2_ref(class, -1);
 }
 
@@ -473,7 +485,7 @@ struct odbc_cache_tables *ast_odbc_find_table(const char *database, const char *
        }
 
        /* Table structure not already cached; build it now. */
-       ast_mutex_lock(&obj->lock);
+       ao2_lock(obj);
        do {
                res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
                if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
@@ -544,7 +556,7 @@ struct odbc_cache_tables *ast_odbc_find_table(const char *database, const char *
                AST_RWLIST_RDLOCK(&(tableptr->columns));
                break;
        } while (1);
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
 
        AST_RWLIST_UNLOCK(&odbc_tables);
 
@@ -591,7 +603,7 @@ SQLHSTMT ast_odbc_direct_execute(struct odbc_obj *obj, SQLHSTMT (*exec_cb)(struc
        int attempt;
        SQLHSTMT stmt;
 
-       ast_mutex_lock(&obj->lock);
+       ao2_lock(obj);
 
        for (attempt = 0; attempt < 2; attempt++) {
                stmt = exec_cb(obj, data);
@@ -609,7 +621,7 @@ SQLHSTMT ast_odbc_direct_execute(struct odbc_obj *obj, SQLHSTMT (*exec_cb)(struc
                }
        }
 
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
 
        return stmt;
 }
@@ -622,7 +634,7 @@ SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_c
        unsigned char state[10], diagnostic[256];
        SQLHSTMT stmt;
 
-       ast_mutex_lock(&obj->lock);
+       ao2_lock(obj);
 
        for (attempt = 0; attempt < 2; attempt++) {
                /* This prepare callback may do more than just prepare -- it may also
@@ -674,7 +686,7 @@ SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_c
                }
        }
 
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
 
        return stmt;
 }
@@ -686,7 +698,7 @@ int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt)
        SQLSMALLINT diagbytes=0;
        unsigned char state[10], diagnostic[256];
 
-       ast_mutex_lock(&obj->lock);
+       ao2_lock(obj);
 
        res = SQLExecute(stmt);
        if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO) && (res != SQL_NO_DATA)) {
@@ -705,7 +717,7 @@ int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt)
                obj->last_used = ast_tvnow();
        }
 
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
 
        return res;
 }
@@ -981,7 +993,7 @@ static char *handle_cli_odbc_show(struct ast_cli_entry *e, int cmd, struct ast_c
                                ast_cli(a->fd, "  Pooled: Yes\n  Limit:  %d\n  Connections in use: %d\n", class->limit, class->count);
 
                                while ((current = ao2_iterator_next(&aoi2))) {
-                                       ast_mutex_lock(&current->lock);
+                                       ao2_lock(current);
 #ifdef DEBUG_THREADS
                                        ast_cli(a->fd, "    - Connection %d: %s (%s:%d %s)\n", ++count,
                                                current->used ? "in use" :
@@ -992,7 +1004,7 @@ static char *handle_cli_odbc_show(struct ast_cli_entry *e, int cmd, struct ast_c
                                                current->used ? "in use" :
                                                current->up && ast_odbc_sanity_check(current) ? "connected" : "disconnected");
 #endif
-                                       ast_mutex_unlock(&current->lock);
+                                       ao2_unlock(current);
                                        ao2_ref(current, -1);
                                }
                                ao2_iterator_destroy(&aoi2);
@@ -1202,13 +1214,13 @@ static int aoro2_class_cb(void *obj, void *arg, int flags)
 static int aoro2_obj_cb(void *vobj, void *arg, int flags)
 {
        struct odbc_obj *obj = vobj;
-       ast_mutex_lock(&obj->lock);
+       ao2_lock(obj);
        if ((arg == NO_TX && !obj->tx) || (arg == EOR_TX && !obj->used) || (arg == USE_TX && obj->tx && !obj->used)) {
                obj->used = 1;
-               ast_mutex_unlock(&obj->lock);
+               ao2_unlock(obj);
                return CMP_MATCH | CMP_STOP;
        }
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
        return 0;
 }
 
@@ -1257,7 +1269,6 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                                return NULL;
                        }
                        ast_assert(ao2_ref(obj, 0) == 1);
-                       ast_mutex_init(&obj->lock);
                        /* obj inherits the outstanding reference to class */
                        obj->parent = class;
                        class = NULL;
@@ -1286,7 +1297,7 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                        return NULL;
                }
 
-               ast_mutex_lock(&obj->lock);
+               ao2_lock(obj);
 
                if (ast_test_flag(&flags, RES_ODBC_INDEPENDENT_CONNECTION)) {
                        /* Ensure this connection has autocommit turned off. */
@@ -1312,7 +1323,6 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                                ast_debug(3, "Unable to allocate object\n");
                                return NULL;
                        }
-                       ast_mutex_init(&obj->lock);
                        /* obj inherits the outstanding reference to class */
                        obj->parent = class;
                        class = NULL;
@@ -1331,7 +1341,7 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                        return NULL;
                }
 
-               ast_mutex_lock(&obj->lock);
+               ao2_lock(obj);
 
                if (SQLSetConnectAttr(obj->con, SQL_ATTR_AUTOCOMMIT, (void *)SQL_AUTOCOMMIT_OFF, 0) == SQL_ERROR) {
                        SQLGetDiagField(SQL_HANDLE_DBC, obj->con, 1, SQL_DIAG_NUMBER, &numfields, SQL_IS_INTEGER, &diagbytes);
@@ -1359,7 +1369,6 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                                ast_debug(3, "Unable to allocate object\n");
                                return NULL;
                        }
-                       ast_mutex_init(&obj->lock);
                        /* obj inherits the outstanding reference to class */
                        obj->parent = class;
                        class = NULL;
@@ -1377,7 +1386,7 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
                        return NULL;
                }
 
-               ast_mutex_lock(&obj->lock);
+               ao2_lock(obj);
 
                if (SQLSetConnectAttr(obj->con, SQL_ATTR_AUTOCOMMIT, (void *)SQL_AUTOCOMMIT_ON, 0) == SQL_ERROR) {
                        SQLGetDiagField(SQL_HANDLE_DBC, obj->con, 1, SQL_DIAG_NUMBER, &numfields, SQL_IS_INTEGER, &diagbytes);
@@ -1425,7 +1434,7 @@ struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags
 #endif
 
        /* We had it locked because of the obj_connects we see here. */
-       ast_mutex_unlock(&obj->lock);
+       ao2_unlock(obj);
 
        ast_assert(class == NULL);
 
@@ -1496,7 +1505,7 @@ static odbc_status odbc_obj_disconnect(struct odbc_obj *obj)
                }
        }
 
-       if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con) == SQL_SUCCESS)) {
+       if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con)) == SQL_SUCCESS) {
                ast_debug(1, "Database handle %p deallocated\n", con);
        } else {
                SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
@@ -1550,7 +1559,7 @@ static odbc_status odbc_obj_connect(struct odbc_obj *obj)
                SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
                obj->parent->last_negative_connect = ast_tvnow();
                ast_log(LOG_WARNING, "res_odbc: Error SQLConnect=%d errno=%d %s\n", res, (int)err, msg);
-               if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con) != SQL_SUCCESS)) {
+               if ((res = SQLFreeHandle(SQL_HANDLE_DBC, con)) != SQL_SUCCESS) {
                        SQLGetDiagRec(SQL_HANDLE_DBC, con, 1, state, &err, msg, 100, &mlen);
                        ast_log(LOG_WARNING, "Unable to deallocate database handle %p? %d errno=%d %s\n", con, res, (int)err, msg);
                }
@@ -1628,7 +1637,7 @@ static int acf_transaction_write(struct ast_channel *chan, const char *cmd, char
                                pbx_builtin_setvar_helper(chan, "ODBC_RESULT", "INVALID_DB");
                                return -1;
                        }
-                       if (!(tx = find_transaction(chan, obj, value, 0))) {
+                       if (!find_transaction(chan, obj, value, 0)) {
                                pbx_builtin_setvar_helper(chan, "ODBC_RESULT", "FAILED_TO_CREATE");
                                return -1;
                        }
@@ -1759,11 +1768,11 @@ static int data_odbc_provider_handler(const struct ast_data_search *search,
                                continue;
                        }
 
-                       ast_mutex_lock(&current->lock);
+                       ao2_lock(current);
                        ast_data_add_str(data_odbc_connection, "status", current->used ? "in use" :
                                        current->up && ast_odbc_sanity_check(current) ? "connected" : "disconnected");
                        ast_data_add_bool(data_odbc_connection, "transactional", current->tx);
-                       ast_mutex_unlock(&current->lock);
+                       ao2_unlock(current);
 
                        if (class->haspool) {
                                ast_data_add_int(data_odbc_connection, "number", ++count);
@@ -1875,6 +1884,16 @@ static int unload_module(void)
        return -1;
 }
 
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
+ * configuration file or other non-critical problem return 
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
 static int load_module(void)
 {
        if (!(class_container = ao2_container_alloc(1, null_hash_fn, ao2_match_by_addr)))