Mon Aug 31 12:30:39 2015

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_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

struct 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.
struct 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 317 of file module.h.

#define __MODULE_INFO_SECTION

Definition at line 316 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 374 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 396 of file module.h.

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

Definition at line 270 of file module.h.

#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.

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 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.

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 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"

The text the key() function should return.

Definition at line 38 of file module.h.


Enumeration Type Documentation

Enumerator:
AST_MODFLAG_DEFAULT 
AST_MODFLAG_GLOBAL_SYMBOLS 
AST_MODFLAG_LOAD_ORDER 

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

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_TIMING 

Dependency for a channel (MOH needs timing interfaces to be fully loaded)

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

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

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  
) [read]

Definition at line 209 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::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;
00212 
00213    u = ast_calloc(1, sizeof(*u));
00214    if (!u) {
00215       return NULL;
00216    }
00217 
00218    u->chan = chan;
00219 
00220    AST_LIST_LOCK(&mod->users);
00221    AST_LIST_INSERT_HEAD(&mod->users, u, entry);
00222    AST_LIST_UNLOCK(&mod->users);
00223 
00224    ast_atomic_fetchadd_int(&mod->usecount, +1);
00225 
00226    ast_update_use_count();
00227 
00228    return u;
00229 }

void __ast_module_user_hangup_all ( struct ast_module  ) 

Definition at line 254 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::usecount, and ast_module::users.

Referenced by ast_unload_resource().

00255 {
00256    struct ast_module_user *u;
00257 
00258    AST_LIST_LOCK(&mod->users);
00259    while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
00260       if (u->chan) {
00261          ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
00262       }
00263       ast_atomic_fetchadd_int(&mod->usecount, -1);
00264       ast_free(u);
00265    }
00266    AST_LIST_UNLOCK(&mod->users);
00267 
00268    ast_update_use_count();
00269 }

void __ast_module_user_remove ( struct ast_module ,
struct ast_module_user  
)

Definition at line 231 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::usecount, and ast_module::users.

Referenced by ast_func_read(), ast_func_read2(), ast_func_write(), and pbx_exec().

00232 {
00233    if (!u) {
00234       return;
00235    }
00236 
00237    AST_LIST_LOCK(&mod->users);
00238    u = AST_LIST_REMOVE(&mod->users, u, entry);
00239    AST_LIST_UNLOCK(&mod->users);
00240    if (!u) {
00241       /*
00242        * Was not in the list.  Either a bad pointer or
00243        * __ast_module_user_hangup_all() has been called.
00244        */
00245       return;
00246    }
00247 
00248    ast_atomic_fetchadd_int(&mod->usecount, -1);
00249    ast_free(u);
00250 
00251    ast_update_use_count();
00252 }

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 947 of file loader.c.

References AST_LIST_LOCK, AST_LIST_UNLOCK, ast_test_suite_event_notify, and load_resource().

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

00948 {
00949    int res;
00950    AST_LIST_LOCK(&module_list);
00951    res = load_resource(resource_name, 0, NULL, 0);
00952    if (!res) {
00953       ast_test_suite_event_notify("MODULE_LOAD", "Message: %s", resource_name);
00954    }
00955    AST_LIST_UNLOCK(&module_list);
00956 
00957    return res;
00958 }

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 1268 of file loader.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, and loadupdate::updater.

01269 {
01270    struct loadupdate *tmp;
01271 
01272    if (!(tmp = ast_malloc(sizeof(*tmp))))
01273       return -1;
01274 
01275    tmp->updater = v;
01276    AST_LIST_LOCK(&updaters);
01277    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
01278    AST_LIST_UNLOCK(&updaters);
01279 
01280    return 0;
01281 }

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 1283 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, and loadupdate::updater.

01284 {
01285    struct loadupdate *cur;
01286 
01287    AST_LIST_LOCK(&updaters);
01288    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
01289       if (cur->updater == v)  {
01290          AST_LIST_REMOVE_CURRENT(entry);
01291          break;
01292       }
01293    }
01294    AST_LIST_TRAVERSE_SAFE_END;
01295    AST_LIST_UNLOCK(&updaters);
01296 
01297    return cur ? 0 : -1;
01298 }

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 1255 of file loader.c.

References ast_strlen_zero(), and find_resource().

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

01256 {
01257    struct ast_module *cur;
01258 
01259    if (ast_strlen_zero(name))
01260       return 0;       /* FALSE */
01261 
01262    cur = find_resource(name, 1);
01263 
01264    return (cur != NULL);
01265 }

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 626 of file loader.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strdup, 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().

00627 {
00628    struct ast_module *cur;
00629    int i, which=0, l = strlen(word);
00630    char *ret = NULL;
00631 
00632    if (pos != rpos)
00633       return NULL;
00634 
00635    AST_LIST_LOCK(&module_list);
00636    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00637       if (!strncasecmp(word, cur->resource, l) &&
00638           (cur->info->reload || !needsreload) &&
00639           ++which > state) {
00640          ret = ast_strdup(cur->resource);
00641          break;
00642       }
00643    }
00644    AST_LIST_UNLOCK(&module_list);
00645 
00646    if (!ret) {
00647       for (i=0; !ret && reload_classes[i].name; i++) {
00648          if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
00649             ret = ast_strdup(reload_classes[i].name);
00650       }
00651    }
00652 
00653    return ret;
00654 }

const char* ast_module_name ( const struct ast_module mod  ) 

Get the name of a module.

Parameters:
mod A pointer to the module.
Returns:
the name of the module
Return values:
NULL if mod or mod->info is NULL

Definition at line 104 of file loader.c.

Referenced by acf_retrieve_docs(), ast_register_application2(), and unload_dynamic_module().

00105 {
00106    if (!mod || !mod->info) {
00107       return NULL;
00108    }
00109 
00110    return mod->info->name;
00111 }

struct ast_module* ast_module_ref ( struct ast_module  )  [read]
void ast_module_register ( const struct ast_module_info  ) 

Definition at line 147 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::info, ast_module::resource, and ast_module::users.

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

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 513 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::flags, free, ast_module::info, ast_module::running, ast_module_info::unload, ast_module::usecount, and ast_module::users.

Referenced by really_quit().

00514 {
00515    struct ast_module *mod;
00516    int somethingchanged = 1, final = 0;
00517 
00518    AST_LIST_LOCK(&module_list);
00519 
00520    /*!\note Some resources, like timers, are started up dynamically, and thus
00521     * may be still in use, even if all channels are dead.  We must therefore
00522     * check the usecount before asking modules to unload. */
00523    do {
00524       if (!somethingchanged) {
00525          /*!\note If we go through the entire list without changing
00526           * anything, ignore the usecounts and unload, then exit. */
00527          final = 1;
00528       }
00529 
00530       /* Reset flag before traversing the list */
00531       somethingchanged = 0;
00532 
00533       AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00534          if (!final && mod->usecount) {
00535             continue;
00536          }
00537          AST_LIST_REMOVE_CURRENT(entry);
00538          if (mod->flags.running && !mod->flags.declined && mod->info->unload) {
00539             mod->info->unload();
00540          }
00541          AST_LIST_HEAD_DESTROY(&mod->users);
00542          free(mod);
00543          somethingchanged = 1;
00544       }
00545       AST_LIST_TRAVERSE_SAFE_END;
00546    } while (somethingchanged && !final);
00547 
00548    AST_LIST_UNLOCK(&module_list);
00549 }

void ast_module_unref ( struct ast_module  ) 
void ast_module_unregister ( const struct ast_module_info  ) 

Definition at line 185 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::info, and ast_module::users.

00186 {
00187    struct ast_module *mod = NULL;
00188 
00189    /* it is assumed that the users list in the module structure
00190       will already be empty, or we cannot have gotten to this
00191       point
00192    */
00193    AST_LIST_LOCK(&module_list);
00194    AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00195       if (mod->info == info) {
00196          AST_LIST_REMOVE_CURRENT(entry);
00197          break;
00198       }
00199    }
00200    AST_LIST_TRAVERSE_SAFE_END;
00201    AST_LIST_UNLOCK(&module_list);
00202 
00203    if (mod) {
00204       AST_LIST_HEAD_DESTROY(&mod->users);
00205       ast_free(mod);
00206    }
00207 }

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 6298 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, 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().

06299 {
06300    struct ast_app *tmp, *cur = NULL;
06301    char tmps[80];
06302    int length, res;
06303 #ifdef AST_XML_DOCS
06304    char *tmpxml;
06305 #endif
06306 
06307    AST_RWLIST_WRLOCK(&apps);
06308    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
06309       if (!(res = strcasecmp(app, tmp->name))) {
06310          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
06311          AST_RWLIST_UNLOCK(&apps);
06312          return -1;
06313       } else if (res < 0)
06314          break;
06315    }
06316 
06317    length = sizeof(*tmp) + strlen(app) + 1;
06318 
06319    if (!(tmp = ast_calloc(1, length))) {
06320       AST_RWLIST_UNLOCK(&apps);
06321       return -1;
06322    }
06323 
06324    if (ast_string_field_init(tmp, 128)) {
06325       AST_RWLIST_UNLOCK(&apps);
06326       ast_free(tmp);
06327       return -1;
06328    }
06329 
06330    strcpy(tmp->name, app);
06331    tmp->execute = execute;
06332    tmp->module = mod;
06333 
06334 #ifdef AST_XML_DOCS
06335    /* Try to lookup the docs in our XML documentation database */
06336    if (ast_strlen_zero(synopsis) && ast_strlen_zero(description)) {
06337       /* load synopsis */
06338       tmpxml = ast_xmldoc_build_synopsis("application", app, ast_module_name(tmp->module));
06339       ast_string_field_set(tmp, synopsis, tmpxml);
06340       ast_free(tmpxml);
06341 
06342       /* load description */
06343       tmpxml = ast_xmldoc_build_description("application", app, ast_module_name(tmp->module));
06344       ast_string_field_set(tmp, description, tmpxml);
06345       ast_free(tmpxml);
06346 
06347       /* load syntax */
06348       tmpxml = ast_xmldoc_build_syntax("application", app, ast_module_name(tmp->module));
06349       ast_string_field_set(tmp, syntax, tmpxml);
06350       ast_free(tmpxml);
06351 
06352       /* load arguments */
06353       tmpxml = ast_xmldoc_build_arguments("application", app, ast_module_name(tmp->module));
06354       ast_string_field_set(tmp, arguments, tmpxml);
06355       ast_free(tmpxml);
06356 
06357       /* load seealso */
06358       tmpxml = ast_xmldoc_build_seealso("application", app, ast_module_name(tmp->module));
06359       ast_string_field_set(tmp, seealso, tmpxml);
06360       ast_free(tmpxml);
06361       tmp->docsrc = AST_XML_DOC;
06362    } else {
06363 #endif
06364       ast_string_field_set(tmp, synopsis, synopsis);
06365       ast_string_field_set(tmp, description, description);
06366 #ifdef AST_XML_DOCS
06367       tmp->docsrc = AST_STATIC_DOC;
06368    }
06369 #endif
06370 
06371    /* Store in alphabetical order */
06372    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
06373       if (strcasecmp(tmp->name, cur->name) < 0) {
06374          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
06375          break;
06376       }
06377    }
06378    AST_RWLIST_TRAVERSE_SAFE_END;
06379    if (!cur)
06380       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
06381 
06382    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
06383 
06384    AST_RWLIST_UNLOCK(&apps);
06385 
06386    return 0;
06387 }

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 551 of file loader.c.

References __ast_module_user_hangup_all(), AST_FORCE_FIRM, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_test_suite_event_notify, 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, ast_module_info::unload, unload_dynamic_module(), and ast_module::usecount.

Referenced by handle_unload(), manager_moduleload(), and unload_module().

00552 {
00553    struct ast_module *mod;
00554    int res = -1;
00555    int error = 0;
00556 
00557    AST_LIST_LOCK(&module_list);
00558 
00559    if (!(mod = find_resource(resource_name, 0))) {
00560       AST_LIST_UNLOCK(&module_list);
00561       ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
00562       return -1;
00563    }
00564 
00565    if (!mod->flags.running || mod->flags.declined) {
00566       ast_log(LOG_WARNING, "Unload failed, '%s' is not loaded.\n", resource_name);
00567       error = 1;
00568    }
00569 
00570    if (!error && (mod->usecount > 0)) {
00571       if (force)
00572          ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
00573             resource_name, mod->usecount);
00574       else {
00575          ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
00576             mod->usecount);
00577          error = 1;
00578       }
00579    }
00580 
00581    if (!error) {
00582       /* Request any channels attached to the module to hangup. */
00583       __ast_module_user_hangup_all(mod);
00584 
00585       res = mod->info->unload();
00586       if (res) {
00587          ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
00588          if (force <= AST_FORCE_FIRM) {
00589             error = 1;
00590          } else {
00591             ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
00592          }
00593       }
00594 
00595       if (!error) {
00596          /*
00597           * Request hangup on any channels that managed to get attached
00598           * while we called the module unload function.
00599           */
00600          __ast_module_user_hangup_all(mod);
00601          sched_yield();
00602       }
00603    }
00604 
00605    if (!error)
00606       mod->flags.running = mod->flags.declined = 0;
00607 
00608    AST_LIST_UNLOCK(&module_list);
00609 
00610    if (!error && !mod->lib && mod->info && mod->info->restore_globals)
00611       mod->info->restore_globals();
00612 
00613 #ifdef LOADABLE_MODULES
00614    if (!error) {
00615       unload_dynamic_module(mod);
00616       ast_test_suite_event_notify("MODULE_UNLOAD", "Message: %s", resource_name);
00617    }
00618 #endif
00619 
00620    if (!error)
00621       ast_update_use_count();
00622 
00623    return res;
00624 }

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 7659 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::name, and unreference_cached_app().

Referenced by __unload_module(), cc_shutdown(), features_shutdown(), load_module(), unload_module(), and unload_pbx().

07660 {
07661    struct ast_app *tmp;
07662 
07663    AST_RWLIST_WRLOCK(&apps);
07664    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
07665       if (!strcasecmp(app, tmp->name)) {
07666          unreference_cached_app(tmp);
07667          AST_RWLIST_REMOVE_CURRENT(list);
07668          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
07669          ast_string_field_free_memory(tmp);
07670          ast_free(tmp);
07671          break;
07672       }
07673    }
07674    AST_RWLIST_TRAVERSE_SAFE_END;
07675    AST_RWLIST_UNLOCK(&apps);
07676 
07677    return tmp ? 0 : -1;
07678 }

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 1234 of file loader.c.

References AST_LIST_TRAVERSE, AST_LIST_TRYLOCK, AST_LIST_UNLOCK, ast_module_info::description, ast_module::info, ast_module::resource, and ast_module::usecount.

Referenced by ast_var_Modules(), and handle_modlist().

01236 {
01237    struct ast_module *cur;
01238    int unlock = -1;
01239    int total_mod_loaded = 0;
01240 
01241    if (AST_LIST_TRYLOCK(&module_list))
01242       unlock = 0;
01243  
01244    AST_LIST_TRAVERSE(&module_list, cur, entry) {
01245       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
01246    }
01247 
01248    if (unlock)
01249       AST_LIST_UNLOCK(&module_list);
01250 
01251    return total_mod_loaded;
01252 }

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 1222 of file loader.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, 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().

01223 {
01224    /* Notify any module monitors that the use count for a
01225       resource has changed */
01226    struct loadupdate *m;
01227 
01228    AST_LIST_LOCK(&updaters);
01229    AST_LIST_TRAVERSE(&updaters, m, entry)
01230       m->updater();
01231    AST_LIST_UNLOCK(&updaters);
01232 }


Variable Documentation

struct ast_module_info* ast_module_info [static]

Definition at line 313 of file module.h.


Generated on 31 Aug 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1