#include "asterisk/utils.h"
Go to the source code of this file.
Data Structures | |
struct | ast_module_info |
Defines | |
#define | __MODULE_INFO_GLOBALS |
#define | __MODULE_INFO_SECTION |
#define | AST_MODULE_CONFIG "modules.conf" |
Module configuration file. | |
#define | AST_MODULE_INFO(keystr, flags_to_set, desc, fields...) |
#define | AST_MODULE_INFO_STANDARD(keystr, desc) |
#define | ast_module_user_add(chan) __ast_module_user_add(ast_module_info->self, chan) |
#define | ast_module_user_hangup_all() __ast_module_user_hangup_all(ast_module_info->self) |
#define | ast_module_user_remove(user) __ast_module_user_remove(ast_module_info->self, user) |
#define | ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, ast_module_info->self) |
Register an application. | |
#define | ast_register_application_xml(app, execute) ast_register_application(app, execute, NULL, NULL) |
Register an application using XML documentation. | |
#define | ASTERISK_GPL_KEY "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" |
The text the key() function should return. | |
Enumerations | |
enum | ast_module_flags { AST_MODFLAG_DEFAULT = 0, AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0), AST_MODFLAG_LOAD_ORDER = (1 << 1) } |
enum | ast_module_load_priority { AST_MODPRI_REALTIME_DEPEND = 10, AST_MODPRI_REALTIME_DEPEND2 = 20, AST_MODPRI_REALTIME_DRIVER = 30, AST_MODPRI_TIMING = 40, AST_MODPRI_CHANNEL_DEPEND = 50, AST_MODPRI_CHANNEL_DRIVER = 60, AST_MODPRI_APP_DEPEND = 70, AST_MODPRI_DEVSTATE_PROVIDER = 80, AST_MODPRI_DEVSTATE_PLUGIN = 90, AST_MODPRI_CDR_DRIVER = 100, AST_MODPRI_DEFAULT = 128, AST_MODPRI_DEVSTATE_CONSUMER = 150 } |
enum | ast_module_load_result { AST_MODULE_LOAD_SUCCESS = 0, AST_MODULE_LOAD_DECLINE = 1, AST_MODULE_LOAD_SKIP = 2, AST_MODULE_LOAD_PRIORITY = 3, AST_MODULE_LOAD_FAILURE = -1 } |
enum | ast_module_unload_mode { AST_FORCE_SOFT = 0, AST_FORCE_FIRM = 1, AST_FORCE_HARD = 2 } |
Functions | |
ast_module_user * | __ast_module_user_add (struct ast_module *, struct ast_channel *) |
void | __ast_module_user_hangup_all (struct ast_module *) |
void | __ast_module_user_remove (struct ast_module *, struct ast_module_user *) |
enum ast_module_load_result | ast_load_resource (const char *resource_name) |
Load a module. | |
int | ast_loader_register (int(*updater)(void)) |
Add a procedure to be run when modules have been updated. | |
int | ast_loader_unregister (int(*updater)(void)) |
Remove a procedure to be run when modules are updated. | |
int | ast_module_check (const char *name) |
Check if module with the name given is loaded. | |
char * | ast_module_helper (const char *line, const char *word, int pos, int state, int rpos, int needsreload) |
Match modules names for the Asterisk cli. | |
const char * | ast_module_name (const struct ast_module *mod) |
Get the name of a module. | |
ast_module * | ast_module_ref (struct ast_module *) |
void | ast_module_register (const struct ast_module_info *) |
void | ast_module_shutdown (void) |
Run the unload() callback for all loaded modules. | |
void | ast_module_unref (struct ast_module *) |
void | ast_module_unregister (const struct ast_module_info *) |
int | ast_register_application2 (const char *app, int(*execute)(struct ast_channel *, const char *), const char *synopsis, const char *description, void *mod) |
Register an application. | |
int | ast_unload_resource (const char *resource_name, enum ast_module_unload_mode) |
Unload a module. | |
int | ast_unregister_application (const char *app) |
Unregister an application. | |
int | ast_update_module_list (int(*modentry)(const char *module, const char *description, int usecnt, const char *like), const char *like) |
Ask for a list of modules, descriptions, and use counts. | |
void | ast_update_use_count (void) |
Notify when usecount has been changed. | |
Variables | |
static struct ast_module_info * | ast_module_info |
This file contains the definitons for functions Asterisk modules should provide and some other module related functions.
Definition in file module.h.
#define AST_MODULE_CONFIG "modules.conf" |
#define AST_MODULE_INFO | ( | keystr, | |||
flags_to_set, | |||||
desc, | |||||
fields... | ) |
#define AST_MODULE_INFO_STANDARD | ( | keystr, | |||
desc | ) |
Value:
AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc, \ .load = load_module, \ .unload = unload_module, \ .load_pri = AST_MODPRI_DEFAULT, \ )
#define ast_module_user_add | ( | chan | ) | __ast_module_user_add(ast_module_info->self, chan) |
Definition at line 268 of file module.h.
Referenced by ast_calendar_register(), canmatch(), dundi_query_read(), dundi_result_read(), dundifunc_read(), exec(), exists(), local_new(), login_exec(), matchmore(), nbs_new(), smdi_msg_read(), and smdi_msg_retrieve_read().
#define ast_module_user_hangup_all | ( | ) | __ast_module_user_hangup_all(ast_module_info->self) |
#define ast_module_user_remove | ( | user | ) | __ast_module_user_remove(ast_module_info->self, user) |
Definition at line 269 of file module.h.
Referenced by ast_calendar_unregister(), canmatch(), dundi_query_read(), dundi_result_read(), dundifunc_read(), exec(), exists(), local_hangup(), local_request(), login_exec(), matchmore(), nbs_destroy(), smdi_msg_read(), and smdi_msg_retrieve_read().
#define ast_register_application | ( | app, | |||
execute, | |||||
synopsis, | |||||
description | ) | ast_register_application2(app, execute, synopsis, description, ast_module_info->self) |
Register an application.
app | Short name of the application | |
execute | a function callback to execute the application. It should return non-zero if the channel needs to be hung up. | |
synopsis | a short description (one line synopsis) of the application | |
description | long description with all of the details about the use of the application |
0 | success | |
-1 | failure. |
Definition at line 421 of file module.h.
Referenced by load_module().
#define ast_register_application_xml | ( | app, | |||
execute | ) | ast_register_application(app, execute, NULL, NULL) |
Register an application using XML documentation.
app | Short name of the application | |
execute | a function callback to execute the application. It should return non-zero if the channel needs to be hung up. |
0 | success | |
-1 | failure. |
Definition at line 437 of file module.h.
Referenced by load_module().
#define ASTERISK_GPL_KEY "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" |
enum ast_module_flags |
Definition at line 198 of file module.h.
00198 { 00199 AST_MODFLAG_DEFAULT = 0, 00200 AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0), 00201 AST_MODFLAG_LOAD_ORDER = (1 << 1), 00202 };
Definition at line 204 of file module.h.
00204 { 00205 AST_MODPRI_REALTIME_DEPEND = 10, /*!< Dependency for a realtime driver */ 00206 AST_MODPRI_REALTIME_DEPEND2 = 20, /*!< Second level dependency for a realtime driver (func_curl needs res_curl, but is needed by res_config_curl) */ 00207 AST_MODPRI_REALTIME_DRIVER = 30, /*!< A realtime driver, which provides configuration services for other modules */ 00208 AST_MODPRI_TIMING = 40, /*!< Dependency for a channel (MOH needs timing interfaces to be fully loaded) */ 00209 AST_MODPRI_CHANNEL_DEPEND = 50, /*!< Channel driver dependency (may depend upon realtime, e.g. MOH) */ 00210 AST_MODPRI_CHANNEL_DRIVER = 60, /*!< Channel drivers (provide devicestate) */ 00211 AST_MODPRI_APP_DEPEND = 70, /*!< Dependency for an application */ 00212 AST_MODPRI_DEVSTATE_PROVIDER = 80, /*!< Applications and other modules that _provide_ devicestate (e.g. meetme) */ 00213 AST_MODPRI_DEVSTATE_PLUGIN = 90, /*!< Plugin for a module that provides devstate (e.g. res_calendar_*) */ 00214 AST_MODPRI_CDR_DRIVER = 100, /*!< CDR or CEL backend */ 00215 AST_MODPRI_DEFAULT = 128, /*!< Modules not otherwise defined (such as most apps) will load here */ 00216 AST_MODPRI_DEVSTATE_CONSUMER = 150, /*!< Certain modules, which consume devstate, need to load after all others (e.g. app_queue) */ 00217 };
Definition at line 60 of file module.h.
00060 { 00061 AST_MODULE_LOAD_SUCCESS = 0, /*!< Module loaded and configured */ 00062 AST_MODULE_LOAD_DECLINE = 1, /*!< Module is not configured */ 00063 AST_MODULE_LOAD_SKIP = 2, /*!< Module was skipped for some reason */ 00064 AST_MODULE_LOAD_PRIORITY = 3, /*!< Module is not loaded yet, but is added to prioity heap */ 00065 AST_MODULE_LOAD_FAILURE = -1, /*!< Module could not be loaded properly */ 00066 };
Definition at line 53 of file module.h.
00053 { 00054 AST_FORCE_SOFT = 0, /*!< Softly unload a module, only if not in use */ 00055 AST_FORCE_FIRM = 1, /*!< Firmly unload a module, even if in use */ 00056 AST_FORCE_HARD = 2, /*!< as FIRM, plus dlclose() on the module. Not recommended 00057 as it may cause crashes */ 00058 };
struct ast_module_user* __ast_module_user_add | ( | struct ast_module * | , | |
struct ast_channel * | ||||
) |
Definition at line 208 of file loader.c.
References ast_atomic_fetchadd_int(), ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_update_use_count(), ast_module_user::chan, ast_module_user::entry, ast_module::usecount, and ast_module::users.
Referenced by ast_func_read(), ast_func_read2(), ast_func_write(), and pbx_exec().
00210 { 00211 struct ast_module_user *u = ast_calloc(1, sizeof(*u)); 00212 00213 if (!u) 00214 return NULL; 00215 00216 u->chan = chan; 00217 00218 AST_LIST_LOCK(&mod->users); 00219 AST_LIST_INSERT_HEAD(&mod->users, u, entry); 00220 AST_LIST_UNLOCK(&mod->users); 00221 00222 ast_atomic_fetchadd_int(&mod->usecount, +1); 00223 00224 ast_update_use_count(); 00225 00226 return u; 00227 }
void __ast_module_user_hangup_all | ( | struct ast_module * | ) |
Definition at line 240 of file loader.c.
References ast_atomic_fetchadd_int(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_softhangup(), AST_SOFTHANGUP_APPUNLOAD, ast_update_use_count(), ast_module_user::chan, ast_module_user::entry, ast_module::usecount, and ast_module::users.
Referenced by ast_unload_resource().
00241 { 00242 struct ast_module_user *u; 00243 00244 AST_LIST_LOCK(&mod->users); 00245 while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) { 00246 if (u->chan) { 00247 ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD); 00248 } 00249 ast_atomic_fetchadd_int(&mod->usecount, -1); 00250 ast_free(u); 00251 } 00252 AST_LIST_UNLOCK(&mod->users); 00253 00254 ast_update_use_count(); 00255 }
void __ast_module_user_remove | ( | struct ast_module * | , | |
struct ast_module_user * | ||||
) |
Definition at line 229 of file loader.c.
References ast_atomic_fetchadd_int(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, ast_update_use_count(), ast_module_user::entry, ast_module::usecount, and ast_module::users.
Referenced by ast_func_read(), ast_func_read2(), ast_func_write(), and pbx_exec().
00230 { 00231 AST_LIST_LOCK(&mod->users); 00232 AST_LIST_REMOVE(&mod->users, u, entry); 00233 AST_LIST_UNLOCK(&mod->users); 00234 ast_atomic_fetchadd_int(&mod->usecount, -1); 00235 ast_free(u); 00236 00237 ast_update_use_count(); 00238 }
enum ast_module_load_result ast_load_resource | ( | const char * | resource_name | ) |
Load a module.
resource_name | The name of the module to load. |
Definition at line 891 of file loader.c.
References AST_LIST_LOCK, AST_LIST_UNLOCK, and load_resource().
Referenced by handle_load(), load_module(), and manager_moduleload().
00892 { 00893 int res; 00894 AST_LIST_LOCK(&module_list); 00895 res = load_resource(resource_name, 0, NULL, 0); 00896 AST_LIST_UNLOCK(&module_list); 00897 00898 return res; 00899 }
int ast_loader_register | ( | int(*)(void) | updater | ) |
Add a procedure to be run when modules have been updated.
updater | The function to run when modules have been updated. |
0 | on success | |
-1 | on failure. |
Definition at line 1207 of file loader.c.
References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, and ast_module_user::entry.
01208 { 01209 struct loadupdate *tmp; 01210 01211 if (!(tmp = ast_malloc(sizeof(*tmp)))) 01212 return -1; 01213 01214 tmp->updater = v; 01215 AST_LIST_LOCK(&updaters); 01216 AST_LIST_INSERT_HEAD(&updaters, tmp, entry); 01217 AST_LIST_UNLOCK(&updaters); 01218 01219 return 0; 01220 }
int ast_loader_unregister | ( | int(*)(void) | updater | ) |
Remove a procedure to be run when modules are updated.
updater | The updater function to unregister. |
0 | on success | |
-1 | on failure. |
Definition at line 1222 of file loader.c.
References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_module_user::entry, and loadupdate::updater.
01223 { 01224 struct loadupdate *cur; 01225 01226 AST_LIST_LOCK(&updaters); 01227 AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) { 01228 if (cur->updater == v) { 01229 AST_LIST_REMOVE_CURRENT(entry); 01230 break; 01231 } 01232 } 01233 AST_LIST_TRAVERSE_SAFE_END; 01234 AST_LIST_UNLOCK(&updaters); 01235 01236 return cur ? 0 : -1; 01237 }
int ast_module_check | ( | const char * | name | ) |
Check if module with the name given is loaded.
name | Module name, like "chan_sip.so" |
1 | if true | |
0 | if false |
Definition at line 1194 of file loader.c.
References ast_strlen_zero(), and find_resource().
Referenced by ifmodule_read(), load_module(), manager_modulecheck(), and unload_module().
01195 { 01196 struct ast_module *cur; 01197 01198 if (ast_strlen_zero(name)) 01199 return 0; /* FALSE */ 01200 01201 cur = find_resource(name, 1); 01202 01203 return (cur != NULL); 01204 }
char* ast_module_helper | ( | const char * | line, | |
const char * | word, | |||
int | pos, | |||
int | state, | |||
int | rpos, | |||
int | needsreload | |||
) |
Match modules names for the Asterisk cli.
line | Unused by this function, but this should be the line we are matching. | |
word | The partial name to match. | |
pos | The position the word we are completing is in. | |
state | The possible match to return. | |
rpos | The position we should be matching. This should be the same as pos. | |
needsreload | This should be 1 if we need to reload this module and 0 otherwise. This function will only return modules that are reloadble if this is 1. |
A | possible completion of the partial match. | |
NULL | if no matches were found. |
Definition at line 580 of file loader.c.
References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strdup, ast_module_user::entry, ast_module::info, name, ast_module_info::reload, and ast_module::resource.
Referenced by conf_run(), handle_modlist(), handle_reload(), handle_unload(), and load_module().
00581 { 00582 struct ast_module *cur; 00583 int i, which=0, l = strlen(word); 00584 char *ret = NULL; 00585 00586 if (pos != rpos) 00587 return NULL; 00588 00589 AST_LIST_LOCK(&module_list); 00590 AST_LIST_TRAVERSE(&module_list, cur, entry) { 00591 if (!strncasecmp(word, cur->resource, l) && 00592 (cur->info->reload || !needsreload) && 00593 ++which > state) { 00594 ret = ast_strdup(cur->resource); 00595 break; 00596 } 00597 } 00598 AST_LIST_UNLOCK(&module_list); 00599 00600 if (!ret) { 00601 for (i=0; !ret && reload_classes[i].name; i++) { 00602 if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state) 00603 ret = ast_strdup(reload_classes[i].name); 00604 } 00605 } 00606 00607 return ret; 00608 }
const char* ast_module_name | ( | const struct ast_module * | mod | ) |
Get the name of a module.
mod | A pointer to the module. |
NULL | if mod or mod->info is NULL |
Definition at line 103 of file loader.c.
Referenced by acf_retrieve_docs(), and ast_register_application2().
00104 { 00105 if (!mod || !mod->info) { 00106 return NULL; 00107 } 00108 00109 return mod->info->name; 00110 }
struct ast_module* ast_module_ref | ( | struct ast_module * | ) |
Definition at line 1239 of file loader.c.
References ast_atomic_fetchadd_int(), ast_update_use_count(), and ast_module::usecount.
Referenced by __oh323_new(), agi_handle_command(), alsa_new(), ast_agi_register(), ast_fax_tech_register(), ast_iax2_new(), ast_rtp_instance_new(), ast_srtp_create(), ast_timer_open(), dahdi_new(), dahdi_pri_cc_agent_init(), data_result_generate_node(), fax_session_new(), fax_session_reserve(), find_best_technology(), fn_wrapper(), gtalk_new(), handle_cli_file_convert(), handle_orig(), load_module(), mgcp_new(), moh_alloc(), moh_files_alloc(), mute_add_audiohook(), my_module_ref(), newpvt(), oss_new(), phone_check_exception(), phone_new(), sip_handle_cc(), sip_new(), and skinny_new().
01240 { 01241 if (!mod) { 01242 return NULL; 01243 } 01244 01245 ast_atomic_fetchadd_int(&mod->usecount, +1); 01246 ast_update_use_count(); 01247 01248 return mod; 01249 }
void ast_module_register | ( | const struct ast_module_info * | ) |
Definition at line 146 of file loader.c.
References ast_calloc, AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, embedded_module_list, embedding, ast_module_user::entry, ast_module::info, and ast_module::users.
00147 { 00148 struct ast_module *mod; 00149 00150 if (embedding) { 00151 if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1))) 00152 return; 00153 strcpy(mod->resource, info->name); 00154 } else { 00155 mod = resource_being_loaded; 00156 } 00157 00158 mod->info = info; 00159 AST_LIST_HEAD_INIT(&mod->users); 00160 00161 /* during startup, before the loader has been initialized, 00162 there are no threads, so there is no need to take the lock 00163 on this list to manipulate it. it is also possible that it 00164 might be unsafe to use the list lock at that point... so 00165 let's avoid it altogether 00166 */ 00167 if (embedding) { 00168 AST_LIST_INSERT_TAIL(&embedded_module_list, mod, entry); 00169 } else { 00170 AST_LIST_LOCK(&module_list); 00171 /* it is paramount that the new entry be placed at the tail of 00172 the list, otherwise the code that uses dlopen() to load 00173 dynamic modules won't be able to find out if the module it 00174 just opened was registered or failed to load 00175 */ 00176 AST_LIST_INSERT_TAIL(&module_list, mod, entry); 00177 AST_LIST_UNLOCK(&module_list); 00178 } 00179 00180 /* give the module a copy of its own handle, for later use in registrations and the like */ 00181 *((struct ast_module **) &(info->self)) = mod; 00182 }
void ast_module_shutdown | ( | void | ) |
Run the unload() callback for all loaded modules.
This function should be called when Asterisk is shutting down gracefully.
If we go through the entire list without changing anything, ignore the usecounts and unload, then exit.
Definition at line 480 of file loader.c.
References AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_module::declined, ast_module_user::entry, ast_module::flags, free, ast_module::info, ast_module::running, ast_module_info::unload, ast_module::usecount, and ast_module::users.
Referenced by really_quit().
00481 { 00482 struct ast_module *mod; 00483 int somethingchanged = 1, final = 0; 00484 00485 AST_LIST_LOCK(&module_list); 00486 00487 /*!\note Some resources, like timers, are started up dynamically, and thus 00488 * may be still in use, even if all channels are dead. We must therefore 00489 * check the usecount before asking modules to unload. */ 00490 do { 00491 if (!somethingchanged) { 00492 /*!\note If we go through the entire list without changing 00493 * anything, ignore the usecounts and unload, then exit. */ 00494 final = 1; 00495 } 00496 00497 /* Reset flag before traversing the list */ 00498 somethingchanged = 0; 00499 00500 AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) { 00501 if (!final && mod->usecount) { 00502 continue; 00503 } 00504 AST_LIST_REMOVE_CURRENT(entry); 00505 if (mod->flags.running && !mod->flags.declined && mod->info->unload) { 00506 mod->info->unload(); 00507 } 00508 AST_LIST_HEAD_DESTROY(&mod->users); 00509 free(mod); 00510 somethingchanged = 1; 00511 } 00512 AST_LIST_TRAVERSE_SAFE_END; 00513 } while (somethingchanged && !final); 00514 00515 AST_LIST_UNLOCK(&module_list); 00516 }
void ast_module_unref | ( | struct ast_module * | ) |
Definition at line 1251 of file loader.c.
References ast_atomic_fetchadd_int(), ast_update_use_count(), and ast_module::usecount.
Referenced by agi_handle_command(), alsa_hangup(), ast_agi_unregister(), ast_bridge_check(), ast_fax_tech_unregister(), ast_rtp_instance_new(), ast_smdi_interface_destroy(), ast_srtp_destroy(), ast_timer_close(), dahdi_destroy_channel_bynum(), dahdi_hangup(), dahdi_pri_cc_agent_destructor(), dahdi_pri_cc_agent_init(), data_result_generate_node(), destroy(), destroy_bridge(), destroy_callback(), destroy_session(), filestream_destructor(), gtalk_hangup(), handle_cli_file_convert(), handle_orig(), iax2_predestroy(), instance_destructor(), local_ast_moh_cleanup(), mgcp_hangup(), my_module_unref(), oh323_hangup(), oss_hangup(), phone_check_exception(), phone_hangup(), sip_cc_monitor_destructor(), sip_hangup(), skinny_hangup(), and smart_bridge_operation().
01252 { 01253 if (!mod) { 01254 return; 01255 } 01256 01257 ast_atomic_fetchadd_int(&mod->usecount, -1); 01258 ast_update_use_count(); 01259 }
void ast_module_unregister | ( | const struct ast_module_info * | ) |
Definition at line 184 of file loader.c.
References ast_free, AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_module_user::entry, ast_module::info, and ast_module::users.
00185 { 00186 struct ast_module *mod = NULL; 00187 00188 /* it is assumed that the users list in the module structure 00189 will already be empty, or we cannot have gotten to this 00190 point 00191 */ 00192 AST_LIST_LOCK(&module_list); 00193 AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) { 00194 if (mod->info == info) { 00195 AST_LIST_REMOVE_CURRENT(entry); 00196 break; 00197 } 00198 } 00199 AST_LIST_TRAVERSE_SAFE_END; 00200 AST_LIST_UNLOCK(&module_list); 00201 00202 if (mod) { 00203 AST_LIST_HEAD_DESTROY(&mod->users); 00204 ast_free(mod); 00205 } 00206 }
int ast_register_application2 | ( | const char * | app, | |
int(*)(struct ast_channel *, const char *) | execute, | |||
const char * | synopsis, | |||
const char * | description, | |||
void * | mod | |||
) |
Register an application.
app | Short name of the application | |
execute | a function callback to execute the application. It should return non-zero if the channel needs to be hung up. | |
synopsis | a short description (one line synopsis) of the application | |
description | long description with all of the details about the use of the application | |
mod | module this application belongs to |
0 | success | |
-1 | failure. |
Definition at line 5821 of file pbx.c.
References ast_app::arguments, ast_calloc, ast_free, ast_log(), ast_module_name(), AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, AST_STATIC_DOC, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), ast_verb, AST_XML_DOC, ast_xmldoc_build_arguments(), ast_xmldoc_build_description(), ast_xmldoc_build_seealso(), ast_xmldoc_build_synopsis(), ast_xmldoc_build_syntax(), COLOR_BRCYAN, ast_app::docsrc, ast_app::execute, ast_app::list, LOG_WARNING, ast_app::module, ast_app::name, ast_app::seealso, ast_app::syntax, and term_color().
Referenced by ast_cc_init(), ast_features_init(), and load_pbx().
05822 { 05823 struct ast_app *tmp, *cur = NULL; 05824 char tmps[80]; 05825 int length, res; 05826 #ifdef AST_XML_DOCS 05827 char *tmpxml; 05828 #endif 05829 05830 AST_RWLIST_WRLOCK(&apps); 05831 AST_RWLIST_TRAVERSE(&apps, tmp, list) { 05832 if (!(res = strcasecmp(app, tmp->name))) { 05833 ast_log(LOG_WARNING, "Already have an application '%s'\n", app); 05834 AST_RWLIST_UNLOCK(&apps); 05835 return -1; 05836 } else if (res < 0) 05837 break; 05838 } 05839 05840 length = sizeof(*tmp) + strlen(app) + 1; 05841 05842 if (!(tmp = ast_calloc(1, length))) { 05843 AST_RWLIST_UNLOCK(&apps); 05844 return -1; 05845 } 05846 05847 if (ast_string_field_init(tmp, 128)) { 05848 AST_RWLIST_UNLOCK(&apps); 05849 ast_free(tmp); 05850 return -1; 05851 } 05852 05853 strcpy(tmp->name, app); 05854 tmp->execute = execute; 05855 tmp->module = mod; 05856 05857 #ifdef AST_XML_DOCS 05858 /* Try to lookup the docs in our XML documentation database */ 05859 if (ast_strlen_zero(synopsis) && ast_strlen_zero(description)) { 05860 /* load synopsis */ 05861 tmpxml = ast_xmldoc_build_synopsis("application", app, ast_module_name(tmp->module)); 05862 ast_string_field_set(tmp, synopsis, tmpxml); 05863 ast_free(tmpxml); 05864 05865 /* load description */ 05866 tmpxml = ast_xmldoc_build_description("application", app, ast_module_name(tmp->module)); 05867 ast_string_field_set(tmp, description, tmpxml); 05868 ast_free(tmpxml); 05869 05870 /* load syntax */ 05871 tmpxml = ast_xmldoc_build_syntax("application", app, ast_module_name(tmp->module)); 05872 ast_string_field_set(tmp, syntax, tmpxml); 05873 ast_free(tmpxml); 05874 05875 /* load arguments */ 05876 tmpxml = ast_xmldoc_build_arguments("application", app, ast_module_name(tmp->module)); 05877 ast_string_field_set(tmp, arguments, tmpxml); 05878 ast_free(tmpxml); 05879 05880 /* load seealso */ 05881 tmpxml = ast_xmldoc_build_seealso("application", app, ast_module_name(tmp->module)); 05882 ast_string_field_set(tmp, seealso, tmpxml); 05883 ast_free(tmpxml); 05884 tmp->docsrc = AST_XML_DOC; 05885 } else { 05886 #endif 05887 ast_string_field_set(tmp, synopsis, synopsis); 05888 ast_string_field_set(tmp, description, description); 05889 #ifdef AST_XML_DOCS 05890 tmp->docsrc = AST_STATIC_DOC; 05891 } 05892 #endif 05893 05894 /* Store in alphabetical order */ 05895 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) { 05896 if (strcasecmp(tmp->name, cur->name) < 0) { 05897 AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list); 05898 break; 05899 } 05900 } 05901 AST_RWLIST_TRAVERSE_SAFE_END; 05902 if (!cur) 05903 AST_RWLIST_INSERT_TAIL(&apps, tmp, list); 05904 05905 ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps))); 05906 05907 AST_RWLIST_UNLOCK(&apps); 05908 05909 return 0; 05910 }
int ast_unload_resource | ( | const char * | resource_name, | |
enum | ast_module_unload_mode | |||
) |
Unload a module.
resource_name | The name of the module to unload. | |
ast_module_unload_mode | The force flag. This should be set using one of the AST_FORCE flags. |
0 | on success. | |
-1 | on error. |
Definition at line 518 of file loader.c.
References __ast_module_user_hangup_all(), AST_FORCE_FIRM, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_update_use_count(), ast_module::declined, find_resource(), ast_module::flags, ast_module::info, ast_module::lib, LOG_WARNING, ast_module_info::restore_globals, ast_module::running, unload_dynamic_module(), and ast_module::usecount.
Referenced by handle_unload(), manager_moduleload(), and unload_module().
00519 { 00520 struct ast_module *mod; 00521 int res = -1; 00522 int error = 0; 00523 00524 AST_LIST_LOCK(&module_list); 00525 00526 if (!(mod = find_resource(resource_name, 0))) { 00527 AST_LIST_UNLOCK(&module_list); 00528 ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name); 00529 return -1; 00530 } 00531 00532 if (!mod->flags.running || mod->flags.declined) { 00533 ast_log(LOG_WARNING, "Unload failed, '%s' is not loaded.\n", resource_name); 00534 error = 1; 00535 } 00536 00537 if (!error && (mod->usecount > 0)) { 00538 if (force) 00539 ast_log(LOG_WARNING, "Warning: Forcing removal of module '%s' with use count %d\n", 00540 resource_name, mod->usecount); 00541 else { 00542 ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name, 00543 mod->usecount); 00544 error = 1; 00545 } 00546 } 00547 00548 if (!error) { 00549 __ast_module_user_hangup_all(mod); 00550 res = mod->info->unload(); 00551 00552 if (res) { 00553 ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name); 00554 if (force <= AST_FORCE_FIRM) 00555 error = 1; 00556 else 00557 ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n"); 00558 } 00559 } 00560 00561 if (!error) 00562 mod->flags.running = mod->flags.declined = 0; 00563 00564 AST_LIST_UNLOCK(&module_list); 00565 00566 if (!error && !mod->lib && mod->info && mod->info->restore_globals) 00567 mod->info->restore_globals(); 00568 00569 #ifdef LOADABLE_MODULES 00570 if (!error) 00571 unload_dynamic_module(mod); 00572 #endif 00573 00574 if (!error) 00575 ast_update_use_count(); 00576 00577 return res; 00578 }
int ast_unregister_application | ( | const char * | app | ) |
Unregister an application.
app | name of the application (does not have to be the same string as the one that was registered) |
0 | success | |
-1 | failure |
Definition at line 7164 of file pbx.c.
References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_string_field_free_memory, ast_verb, ast_app::list, ast_app::name, and unreference_cached_app().
Referenced by __unload_module(), load_module(), and unload_module().
07165 { 07166 struct ast_app *tmp; 07167 07168 AST_RWLIST_WRLOCK(&apps); 07169 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) { 07170 if (!strcasecmp(app, tmp->name)) { 07171 unreference_cached_app(tmp); 07172 AST_RWLIST_REMOVE_CURRENT(list); 07173 ast_verb(2, "Unregistered application '%s'\n", tmp->name); 07174 ast_string_field_free_memory(tmp); 07175 ast_free(tmp); 07176 break; 07177 } 07178 } 07179 AST_RWLIST_TRAVERSE_SAFE_END; 07180 AST_RWLIST_UNLOCK(&apps); 07181 07182 return tmp ? 0 : -1; 07183 }
int ast_update_module_list | ( | int(*)(const char *module, const char *description, int usecnt, const char *like) | modentry, | |
const char * | like | |||
) |
Ask for a list of modules, descriptions, and use counts.
modentry | A callback to an updater function. | |
like | For each of the modules loaded, modentry will be executed with the resource, description, and usecount values of each particular module. |
Definition at line 1173 of file loader.c.
References AST_LIST_TRAVERSE, AST_LIST_TRYLOCK, AST_LIST_UNLOCK, ast_module_info::description, ast_module_user::entry, ast_module::info, ast_module::resource, and ast_module::usecount.
Referenced by ast_var_Modules(), and handle_modlist().
01175 { 01176 struct ast_module *cur; 01177 int unlock = -1; 01178 int total_mod_loaded = 0; 01179 01180 if (AST_LIST_TRYLOCK(&module_list)) 01181 unlock = 0; 01182 01183 AST_LIST_TRAVERSE(&module_list, cur, entry) { 01184 total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like); 01185 } 01186 01187 if (unlock) 01188 AST_LIST_UNLOCK(&module_list); 01189 01190 return total_mod_loaded; 01191 }
void ast_update_use_count | ( | void | ) |
Notify when usecount has been changed.
This function calulates use counts and notifies anyone trying to keep track of them. It should be called whenever your module's usecount changes.
Definition at line 1161 of file loader.c.
References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_module_user::entry, and loadupdate::updater.
Referenced by __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_module_ref(), ast_module_unref(), ast_unload_resource(), handle_request_do(), oh323_request(), sip_request_call(), start_resource(), and unistim_new().
01162 { 01163 /* Notify any module monitors that the use count for a 01164 resource has changed */ 01165 struct loadupdate *m; 01166 01167 AST_LIST_LOCK(&updaters); 01168 AST_LIST_TRAVERSE(&updaters, m, entry) 01169 m->updater(); 01170 AST_LIST_UNLOCK(&updaters); 01171 }
struct ast_module_info* ast_module_info [static] |