Mon Jun 27 16:51:16 2011

Asterisk developer's documentation


module.h File Reference

Asterisk module definitions. More...

#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_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.
ast_moduleast_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_infoast_module_info


Detailed Description

Asterisk module definitions.

This file contains the definitons for functions Asterisk modules should provide and some other module related functions.

Definition in file module.h.


Define Documentation

#define __MODULE_INFO_GLOBALS

Definition at line 308 of file module.h.

#define __MODULE_INFO_SECTION

Definition at line 307 of file module.h.

#define AST_MODULE_CONFIG   "modules.conf"

Module configuration file.

Definition at line 51 of file module.h.

Referenced by load_modules().

#define AST_MODULE_INFO ( keystr,
flags_to_set,
desc,
fields...   ) 

Definition at line 365 of file module.h.

#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, \
             )

Definition at line 387 of file module.h.

#define ast_module_user_add ( chan   )     __ast_module_user_add(ast_module_info->self, chan)

Definition at line 259 of file module.h.

Referenced by 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)

Definition at line 261 of file module.h.

Referenced by unload_module().

#define ast_module_user_remove ( user   )     __ast_module_user_remove(ast_module_info->self, user)

Definition at line 260 of file module.h.

Referenced by canmatch(), dundi_query_read(), dundi_result_read(), dundifunc_read(), exec(), exists(), local_hangup(), 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.

Parameters:
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
This registers an application with Asterisk's internal application list.
Note:
The individual applications themselves are responsible for registering and unregistering and unregistering their own CLI commands.
Return values:
0 success
-1 failure.

Definition at line 412 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.

Parameters:
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.
This registers an application with Asterisk's internal application list.
Note:
The individual applications themselves are responsible for registering and unregistering and unregistering their own CLI commands.
Return values:
0 success
-1 failure.

Definition at line 428 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"

The text the key() function should return.

Definition at line 38 of file module.h.


Enumeration Type Documentation

enum ast_module_flags

Enumerator:
AST_MODFLAG_DEFAULT 
AST_MODFLAG_GLOBAL_SYMBOLS 
AST_MODFLAG_LOAD_ORDER 

Definition at line 190 of file module.h.

00190                       {
00191    AST_MODFLAG_DEFAULT = 0,
00192    AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00193    AST_MODFLAG_LOAD_ORDER = (1 << 1),
00194 };

enum ast_module_load_priority

Enumerator:
AST_MODPRI_REALTIME_DEPEND  Dependency for a realtime driver
AST_MODPRI_REALTIME_DEPEND2  Second level dependency for a realtime driver (func_curl needs res_curl, but is needed by res_config_curl)
AST_MODPRI_REALTIME_DRIVER  A realtime driver, which provides configuration services for other modules
AST_MODPRI_CHANNEL_DEPEND  Channel driver dependency (may depend upon realtime, e.g. MOH)
AST_MODPRI_CHANNEL_DRIVER  Channel drivers (provide devicestate)
AST_MODPRI_APP_DEPEND  Dependency for an application
AST_MODPRI_DEVSTATE_PROVIDER  Applications and other modules that _provide_ devicestate (e.g. meetme)
AST_MODPRI_DEVSTATE_PLUGIN  Plugin for a module that provides devstate (e.g. res_calendar_*)
AST_MODPRI_CDR_DRIVER  CDR or CEL backend
AST_MODPRI_DEFAULT  Modules not otherwise defined (such as most apps) will load here
AST_MODPRI_DEVSTATE_CONSUMER  Certain modules, which consume devstate, need to load after all others (e.g. app_queue)

Definition at line 196 of file module.h.

00196                               {
00197    AST_MODPRI_REALTIME_DEPEND =    10,  /*!< Dependency for a realtime driver */
00198    AST_MODPRI_REALTIME_DEPEND2 =   20,  /*!< Second level dependency for a realtime driver (func_curl needs res_curl, but is needed by res_config_curl) */
00199    AST_MODPRI_REALTIME_DRIVER =    30,  /*!< A realtime driver, which provides configuration services for other modules */
00200    AST_MODPRI_CHANNEL_DEPEND =     50,  /*!< Channel driver dependency (may depend upon realtime, e.g. MOH) */
00201    AST_MODPRI_CHANNEL_DRIVER =     60,  /*!< Channel drivers (provide devicestate) */
00202    AST_MODPRI_APP_DEPEND =         70,  /*!< Dependency for an application */
00203    AST_MODPRI_DEVSTATE_PROVIDER =  80,  /*!< Applications and other modules that _provide_ devicestate (e.g. meetme) */
00204    AST_MODPRI_DEVSTATE_PLUGIN =    90,  /*!< Plugin for a module that provides devstate (e.g. res_calendar_*) */
00205    AST_MODPRI_CDR_DRIVER =        100,  /*!< CDR or CEL backend */
00206    AST_MODPRI_DEFAULT =           128,  /*!< Modules not otherwise defined (such as most apps) will load here */
00207    AST_MODPRI_DEVSTATE_CONSUMER = 150,  /*!< Certain modules, which consume devstate, need to load after all others (e.g. app_queue) */
00208 };

enum ast_module_load_result

Enumerator:
AST_MODULE_LOAD_SUCCESS  Module loaded and configured
AST_MODULE_LOAD_DECLINE  Module is not configured
AST_MODULE_LOAD_SKIP  Module was skipped for some reason
AST_MODULE_LOAD_PRIORITY  Module is not loaded yet, but is added to prioity heap
AST_MODULE_LOAD_FAILURE  Module could not be loaded properly

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 };

enum ast_module_unload_mode

Enumerator:
AST_FORCE_SOFT  Softly unload a module, only if not in use
AST_FORCE_FIRM  Firmly unload a module, even if in use
AST_FORCE_HARD  as FIRM, plus dlclose() on the module. Not recommended as it may cause crashes

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 };


Function Documentation

struct ast_module_user* __ast_module_user_add ( struct ast_module ,
struct ast_channel  
)

Definition at line 195 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().

00197 {
00198    struct ast_module_user *u = ast_calloc(1, sizeof(*u));
00199 
00200    if (!u)
00201       return NULL;
00202 
00203    u->chan = chan;
00204 
00205    AST_LIST_LOCK(&mod->users);
00206    AST_LIST_INSERT_HEAD(&mod->users, u, entry);
00207    AST_LIST_UNLOCK(&mod->users);
00208 
00209    ast_atomic_fetchadd_int(&mod->usecount, +1);
00210 
00211    ast_update_use_count();
00212 
00213    return u;
00214 }

void __ast_module_user_hangup_all ( struct ast_module  ) 

Definition at line 227 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().

00228 {
00229    struct ast_module_user *u;
00230 
00231    AST_LIST_LOCK(&mod->users);
00232    while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
00233       ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
00234       ast_atomic_fetchadd_int(&mod->usecount, -1);
00235       ast_free(u);
00236    }
00237    AST_LIST_UNLOCK(&mod->users);
00238 
00239    ast_update_use_count();
00240 }

void __ast_module_user_remove ( struct ast_module ,
struct ast_module_user  
)

Definition at line 216 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().

00217 {
00218    AST_LIST_LOCK(&mod->users);
00219    AST_LIST_REMOVE(&mod->users, u, entry);
00220    AST_LIST_UNLOCK(&mod->users);
00221    ast_atomic_fetchadd_int(&mod->usecount, -1);
00222    ast_free(u);
00223 
00224    ast_update_use_count();
00225 }

enum ast_module_load_result ast_load_resource ( const char *  resource_name  ) 

Load a module.

Parameters:
resource_name The name of the module to load.
This function is run by the PBX to load the modules. It performs all loading and initialization tasks. Basically, to load a module, just give it the name of the module and it will do the rest.

Returns:
See possible enum values for ast_module_load_result.

Definition at line 876 of file loader.c.

References AST_LIST_LOCK, AST_LIST_UNLOCK, and load_resource().

Referenced by handle_load(), load_module(), and manager_moduleload().

00877 {
00878    int res;
00879    AST_LIST_LOCK(&module_list);
00880    res = load_resource(resource_name, 0, NULL, 0);
00881    AST_LIST_UNLOCK(&module_list);
00882 
00883    return res;
00884 }

int ast_loader_register ( int(*)(void)  updater  ) 

Add a procedure to be run when modules have been updated.

Parameters:
updater The function to run when modules have been updated.
This function adds the given function to a linked list of functions to be run when the modules are updated.

Return values:
0 on success
-1 on failure.

Definition at line 1192 of file loader.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, and ast_module_user::entry.

01193 {
01194    struct loadupdate *tmp;
01195 
01196    if (!(tmp = ast_malloc(sizeof(*tmp))))
01197       return -1;
01198 
01199    tmp->updater = v;
01200    AST_LIST_LOCK(&updaters);
01201    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
01202    AST_LIST_UNLOCK(&updaters);
01203 
01204    return 0;
01205 }

int ast_loader_unregister ( int(*)(void)  updater  ) 

Remove a procedure to be run when modules are updated.

Parameters:
updater The updater function to unregister.
This removes the given function from the updater list.

Return values:
0 on success
-1 on failure.

Definition at line 1207 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.

01208 {
01209    struct loadupdate *cur;
01210 
01211    AST_LIST_LOCK(&updaters);
01212    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
01213       if (cur->updater == v)  {
01214          AST_LIST_REMOVE_CURRENT(entry);
01215          break;
01216       }
01217    }
01218    AST_LIST_TRAVERSE_SAFE_END;
01219    AST_LIST_UNLOCK(&updaters);
01220 
01221    return cur ? 0 : -1;
01222 }

int ast_module_check ( const char *  name  ) 

Check if module with the name given is loaded.

Parameters:
name Module name, like "chan_sip.so"
Return values:
1 if true
0 if false

Definition at line 1179 of file loader.c.

References ast_strlen_zero(), and find_resource().

Referenced by ifmodule_read(), load_module(), manager_modulecheck(), and unload_module().

01180 {
01181    struct ast_module *cur;
01182 
01183    if (ast_strlen_zero(name))
01184       return 0;       /* FALSE */
01185 
01186    cur = find_resource(name, 1);
01187 
01188    return (cur != NULL);
01189 }

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.

Parameters:
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.
Return values:
A possible completion of the partial match.
NULL if no matches were found.

Definition at line 565 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().

00566 {
00567    struct ast_module *cur;
00568    int i, which=0, l = strlen(word);
00569    char *ret = NULL;
00570 
00571    if (pos != rpos)
00572       return NULL;
00573 
00574    AST_LIST_LOCK(&module_list);
00575    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00576       if (!strncasecmp(word, cur->resource, l) &&
00577           (cur->info->reload || !needsreload) &&
00578           ++which > state) {
00579          ret = ast_strdup(cur->resource);
00580          break;
00581       }
00582    }
00583    AST_LIST_UNLOCK(&module_list);
00584 
00585    if (!ret) {
00586       for (i=0; !ret && reload_classes[i].name; i++) {
00587          if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
00588             ret = ast_strdup(reload_classes[i].name);
00589       }
00590    }
00591 
00592    return ret;
00593 }

struct ast_module* ast_module_ref ( struct ast_module  ) 

Definition at line 1224 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(), 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(), skinny_new(), and usbradio_new().

01225 {
01226    if (!mod) {
01227       return NULL;
01228    }
01229 
01230    ast_atomic_fetchadd_int(&mod->usecount, +1);
01231    ast_update_use_count();
01232 
01233    return mod;
01234 }

void ast_module_register ( const struct ast_module_info  ) 

Definition at line 133 of file loader.c.

References ast_calloc, AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, embedding, ast_module_user::entry, ast_module::info, and ast_module::users.

00134 {
00135    struct ast_module *mod;
00136 
00137    if (embedding) {
00138       if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1)))
00139          return;
00140       strcpy(mod->resource, info->name);
00141    } else {
00142       mod = resource_being_loaded;
00143    }
00144 
00145    mod->info = info;
00146    AST_LIST_HEAD_INIT(&mod->users);
00147 
00148    /* during startup, before the loader has been initialized,
00149       there are no threads, so there is no need to take the lock
00150       on this list to manipulate it. it is also possible that it
00151       might be unsafe to use the list lock at that point... so
00152       let's avoid it altogether
00153    */
00154    if (embedding) {
00155       AST_LIST_INSERT_TAIL(&embedded_module_list, mod, entry);
00156    } else {
00157       AST_LIST_LOCK(&module_list);
00158       /* it is paramount that the new entry be placed at the tail of
00159          the list, otherwise the code that uses dlopen() to load
00160          dynamic modules won't be able to find out if the module it
00161          just opened was registered or failed to load
00162       */
00163       AST_LIST_INSERT_TAIL(&module_list, mod, entry);
00164       AST_LIST_UNLOCK(&module_list);
00165    }
00166 
00167    /* give the module a copy of its own handle, for later use in registrations and the like */
00168    *((struct ast_module **) &(info->self)) = mod;
00169 }

void ast_module_shutdown ( void   ) 

Run the unload() callback for all loaded modules.

This function should be called when Asterisk is shutting down gracefully.

Note:
Some resources, like timers, are started up dynamically, and thus may be still in use, even if all channels are dead. We must therefore check the usecount before asking modules to unload.

If we go through the entire list without changing anything, ignore the usecounts and unload, then exit.

Definition at line 465 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 quit_handler().

00466 {
00467    struct ast_module *mod;
00468    int somethingchanged = 1, final = 0;
00469 
00470    AST_LIST_LOCK(&module_list);
00471 
00472    /*!\note Some resources, like timers, are started up dynamically, and thus
00473     * may be still in use, even if all channels are dead.  We must therefore
00474     * check the usecount before asking modules to unload. */
00475    do {
00476       if (!somethingchanged) {
00477          /*!\note If we go through the entire list without changing
00478           * anything, ignore the usecounts and unload, then exit. */
00479          final = 1;
00480       }
00481 
00482       /* Reset flag before traversing the list */
00483       somethingchanged = 0;
00484 
00485       AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00486          if (!final && mod->usecount) {
00487             continue;
00488          }
00489          AST_LIST_REMOVE_CURRENT(entry);
00490          if (mod->flags.running && !mod->flags.declined && mod->info->unload) {
00491             mod->info->unload();
00492          }
00493          AST_LIST_HEAD_DESTROY(&mod->users);
00494          free(mod);
00495          somethingchanged = 1;
00496       }
00497       AST_LIST_TRAVERSE_SAFE_END;
00498    } while (somethingchanged && !final);
00499 
00500    AST_LIST_UNLOCK(&module_list);
00501 }

void ast_module_unref ( struct ast_module  ) 

Definition at line 1236 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(), 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(), smart_bridge_operation(), and usbradio_hangup().

01237 {
01238    if (!mod) {
01239       return;
01240    }
01241 
01242    ast_atomic_fetchadd_int(&mod->usecount, -1);
01243    ast_update_use_count();
01244 }

void ast_module_unregister ( const struct ast_module_info  ) 

Definition at line 171 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.

00172 {
00173    struct ast_module *mod = NULL;
00174 
00175    /* it is assumed that the users list in the module structure
00176       will already be empty, or we cannot have gotten to this
00177       point
00178    */
00179    AST_LIST_LOCK(&module_list);
00180    AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00181       if (mod->info == info) {
00182          AST_LIST_REMOVE_CURRENT(entry);
00183          break;
00184       }
00185    }
00186    AST_LIST_TRAVERSE_SAFE_END;
00187    AST_LIST_UNLOCK(&module_list);
00188 
00189    if (mod) {
00190       AST_LIST_HEAD_DESTROY(&mod->users);
00191       ast_free(mod);
00192    }
00193 }

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.

Parameters:
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
This registers an application with Asterisk's internal application list.
Note:
The individual applications themselves are responsible for registering and unregistering and unregistering their own CLI commands.
Return values:
0 success
-1 failure.

Definition at line 5499 of file pbx.c.

References ast_app::arguments, ast_calloc, ast_free, ast_log(), 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().

05500 {
05501    struct ast_app *tmp, *cur = NULL;
05502    char tmps[80];
05503    int length, res;
05504 #ifdef AST_XML_DOCS
05505    char *tmpxml;
05506 #endif
05507 
05508    AST_RWLIST_WRLOCK(&apps);
05509    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
05510       if (!(res = strcasecmp(app, tmp->name))) {
05511          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
05512          AST_RWLIST_UNLOCK(&apps);
05513          return -1;
05514       } else if (res < 0)
05515          break;
05516    }
05517 
05518    length = sizeof(*tmp) + strlen(app) + 1;
05519 
05520    if (!(tmp = ast_calloc(1, length))) {
05521       AST_RWLIST_UNLOCK(&apps);
05522       return -1;
05523    }
05524 
05525    if (ast_string_field_init(tmp, 128)) {
05526       AST_RWLIST_UNLOCK(&apps);
05527       ast_free(tmp);
05528       return -1;
05529    }
05530 
05531 #ifdef AST_XML_DOCS
05532    /* Try to lookup the docs in our XML documentation database */
05533    if (ast_strlen_zero(synopsis) && ast_strlen_zero(description)) {
05534       /* load synopsis */
05535       tmpxml = ast_xmldoc_build_synopsis("application", app);
05536       ast_string_field_set(tmp, synopsis, tmpxml);
05537       ast_free(tmpxml);
05538 
05539       /* load description */
05540       tmpxml = ast_xmldoc_build_description("application", app);
05541       ast_string_field_set(tmp, description, tmpxml);
05542       ast_free(tmpxml);
05543 
05544       /* load syntax */
05545       tmpxml = ast_xmldoc_build_syntax("application", app);
05546       ast_string_field_set(tmp, syntax, tmpxml);
05547       ast_free(tmpxml);
05548 
05549       /* load arguments */
05550       tmpxml = ast_xmldoc_build_arguments("application", app);
05551       ast_string_field_set(tmp, arguments, tmpxml);
05552       ast_free(tmpxml);
05553 
05554       /* load seealso */
05555       tmpxml = ast_xmldoc_build_seealso("application", app);
05556       ast_string_field_set(tmp, seealso, tmpxml);
05557       ast_free(tmpxml);
05558       tmp->docsrc = AST_XML_DOC;
05559    } else {
05560 #endif
05561       ast_string_field_set(tmp, synopsis, synopsis);
05562       ast_string_field_set(tmp, description, description);
05563 #ifdef AST_XML_DOCS
05564       tmp->docsrc = AST_STATIC_DOC;
05565    }
05566 #endif
05567 
05568    strcpy(tmp->name, app);
05569    tmp->execute = execute;
05570    tmp->module = mod;
05571 
05572    /* Store in alphabetical order */
05573    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
05574       if (strcasecmp(tmp->name, cur->name) < 0) {
05575          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
05576          break;
05577       }
05578    }
05579    AST_RWLIST_TRAVERSE_SAFE_END;
05580    if (!cur)
05581       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
05582 
05583    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
05584 
05585    AST_RWLIST_UNLOCK(&apps);
05586 
05587    return 0;
05588 }

int ast_unload_resource ( const char *  resource_name,
enum  ast_module_unload_mode 
)

Unload a module.

Parameters:
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.
This function unloads a module. It will only unload modules that are not in use (usecount not zero), unless AST_FORCE_FIRM or AST_FORCE_HARD is specified. Setting AST_FORCE_FIRM or AST_FORCE_HARD will unload the module regardless of consequences (NOT RECOMMENDED).

Return values:
0 on success.
-1 on error.

Definition at line 503 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().

00504 {
00505    struct ast_module *mod;
00506    int res = -1;
00507    int error = 0;
00508 
00509    AST_LIST_LOCK(&module_list);
00510 
00511    if (!(mod = find_resource(resource_name, 0))) {
00512       AST_LIST_UNLOCK(&module_list);
00513       ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
00514       return -1;
00515    }
00516 
00517    if (!mod->flags.running || mod->flags.declined) {
00518       ast_log(LOG_WARNING, "Unload failed, '%s' is not loaded.\n", resource_name);
00519       error = 1;
00520    }
00521 
00522    if (!error && (mod->usecount > 0)) {
00523       if (force)
00524          ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
00525             resource_name, mod->usecount);
00526       else {
00527          ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
00528             mod->usecount);
00529          error = 1;
00530       }
00531    }
00532 
00533    if (!error) {
00534       __ast_module_user_hangup_all(mod);
00535       res = mod->info->unload();
00536 
00537       if (res) {
00538          ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
00539          if (force <= AST_FORCE_FIRM)
00540             error = 1;
00541          else
00542             ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
00543       }
00544    }
00545 
00546    if (!error)
00547       mod->flags.running = mod->flags.declined = 0;
00548 
00549    AST_LIST_UNLOCK(&module_list);
00550 
00551    if (!error && !mod->lib && mod->info && mod->info->restore_globals)
00552       mod->info->restore_globals();
00553 
00554 #ifdef LOADABLE_MODULES
00555    if (!error)
00556       unload_dynamic_module(mod);
00557 #endif
00558 
00559    if (!error)
00560       ast_update_use_count();
00561 
00562    return res;
00563 }

int ast_unregister_application ( const char *  app  ) 

Unregister an application.

Parameters:
app name of the application (does not have to be the same string as the one that was registered)
This unregisters an application from Asterisk's internal application list.

Return values:
0 success
-1 failure

Definition at line 6822 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().

06823 {
06824    struct ast_app *tmp;
06825 
06826    AST_RWLIST_WRLOCK(&apps);
06827    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
06828       if (!strcasecmp(app, tmp->name)) {
06829          unreference_cached_app(tmp);
06830          AST_RWLIST_REMOVE_CURRENT(list);
06831          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
06832          ast_string_field_free_memory(tmp);
06833          ast_free(tmp);
06834          break;
06835       }
06836    }
06837    AST_RWLIST_TRAVERSE_SAFE_END;
06838    AST_RWLIST_UNLOCK(&apps);
06839 
06840    return tmp ? 0 : -1;
06841 }

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.

Parameters:
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.
Returns:
the number of modules loaded

Definition at line 1158 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().

01160 {
01161    struct ast_module *cur;
01162    int unlock = -1;
01163    int total_mod_loaded = 0;
01164 
01165    if (AST_LIST_TRYLOCK(&module_list))
01166       unlock = 0;
01167  
01168    AST_LIST_TRAVERSE(&module_list, cur, entry) {
01169       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
01170    }
01171 
01172    if (unlock)
01173       AST_LIST_UNLOCK(&module_list);
01174 
01175    return total_mod_loaded;
01176 }

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.

Note:
The ast_module_user_* functions take care of calling this function for you.

Definition at line 1146 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().

01147 {
01148    /* Notify any module monitors that the use count for a
01149       resource has changed */
01150    struct loadupdate *m;
01151 
01152    AST_LIST_LOCK(&updaters);
01153    AST_LIST_TRAVERSE(&updaters, m, entry)
01154       m->updater();
01155    AST_LIST_UNLOCK(&updaters);
01156 }


Variable Documentation

struct ast_module_info* ast_module_info [static]

Definition at line 304 of file module.h.


Generated on Mon Jun 27 16:51:16 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7