loader.c File Reference

Module Loader. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/paths.h"
#include <dirent.h>
#include "asterisk/dlinkedlists.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/channel.h"
#include "asterisk/term.h"
#include "asterisk/manager.h"
#include "asterisk/io.h"
#include "asterisk/lock.h"
#include "asterisk/vector.h"
#include "asterisk/app.h"
#include "asterisk/test.h"
#include "asterisk/cli.h"
#include <dlfcn.h>
#include "asterisk/md5.h"
#include "asterisk/utils.h"

Include dependency graph for loader.c:

Go to the source code of this file.

Data Structures
struct	ast_module
struct	ast_module_user
struct	load_order
struct	load_order_entry
struct	load_results_map
struct	load_retries
struct	loadupdate
struct	module_list
struct	module_load_word
struct	module_user_list
struct	reload_queue
struct	reload_queue_item
struct	updaters

Macros
#define	AST_MODULE_LOAD_UNKNOWN_STRING   "Unknown" /* Status string for unknown load status */
#define	RTLD_LOCAL   0
#define	RTLD_NOW   0
#define	STR_APPEND_TEXT(txt, str)

Functions
struct ast_module *	__ast_module_ref (struct ast_module *mod, const char *file, int line, const char *func)
struct ast_module *	__ast_module_running_ref (struct ast_module *mod, const char *file, int line, const char *func)
void	__ast_module_shutdown_ref (struct ast_module *mod, const char *file, int line, const char *func)
void	__ast_module_unref (struct ast_module *mod, const char *file, int line, const char *func)
struct ast_module_user *	__ast_module_user_add (struct ast_module *mod, struct ast_channel *chan)
void	__ast_module_user_hangup_all (struct ast_module *mod)
void	__ast_module_user_remove (struct ast_module *mod, struct ast_module_user *u)
static struct load_order_entry *	add_to_load_order (const char *resource, struct load_order *load_order, int required, int preload, int builtin)
static int	alpha_module_list_create (struct module_vector *alpha_module_list)
int	ast_load_resource (const char *resource_name)
	Load a module. More...
int	ast_loader_register (int(*v)(void))
	Add a procedure to be run when modules have been updated. More...
int	ast_loader_unregister (int(*v)(void))
	Remove a procedure to be run when modules are updated. More...
int	ast_module_check (const char *name)
	Check if module exists. More...
char *	ast_module_helper (const char *line, const char *word, int pos, int state, int rpos, enum ast_module_helper_type type)
	Match modules names for the Asterisk cli. More...
const char *	ast_module_name (const struct ast_module *mod)
	Get the name of a module. More...
void	ast_module_register (const struct ast_module_info *info)
enum ast_module_reload_result	ast_module_reload (const char *name)
	Reload asterisk modules. More...
const char *	ast_module_support_level_to_string (enum ast_module_support_level support_level)
void	ast_module_unregister (const struct ast_module_info *info)
void	ast_process_pending_reloads (void)
	Process reload requests received during startup. More...
int	ast_unload_resource (const char *resource_name, enum ast_module_unload_mode force)
	Unload a module. More...
int	ast_update_module_list (int(*modentry)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level), const char *like)
	Ask for a list of modules, descriptions, use counts and status. More...
int	ast_update_module_list_condition (int(*modentry)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level, void *data, const char *condition), const char *like, void *data, const char *condition)
	Ask for a list of modules, descriptions, use counts and status. More...
int	ast_update_module_list_data (int(*modentry)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level, void *data), const char *like, void *data)
	Ask for a list of modules, descriptions, use counts and status. More...
void	ast_update_use_count (void)
	Notify when usecount has been changed. More...
	AST_VECTOR (module_vector, struct ast_module *)
static struct ast_module *	find_resource (const char *resource, int do_lock)
static char *	get_name_from_resource (const char *resource)
static unsigned int	inspect_module (const struct ast_module *mod)
static int	is_module_loaded (const char *resource_name)
	Check to see if the given resource is loaded. More...
static int	key_matches (const unsigned char *key1, const unsigned char *key2)
static struct ast_module *	load_dlopen (const char *resource_in, const char *so_ext, const char *filename, int flags, unsigned int suppress_logging)
static int	load_dlopen_missing (struct ast_str **list, struct ast_vector_string *deps)
static struct ast_module *	load_dynamic_module (const char *resource_in, unsigned int suppress_logging)
int	load_modules (void)
static enum ast_module_load_result	load_resource (const char *resource_name, unsigned int suppress_logging, struct module_vector *module_priorities, int required, int preload)
static int	load_resource_list (struct load_order *load_order, int *mod_count)
static int	loader_builtin_init (struct load_order *load_order)
static int	loader_config_init (struct load_order *load_order)
static const char *	loadresult2str (enum ast_module_load_result result)
static void	logged_dlclose (const char *name, void *lib)
	dlclose(), with failure logging. More...
static int	module_deps_missing_recursive (struct ast_module *mod, struct module_vector *missingdeps)
	Recursively find required dependencies that are not running. More...
static int	module_deps_process_reqlist (struct ast_module *mod, struct ast_vector_string *vec, struct ast_vector_const_string *missing, int ref_enhancers, int isoptional)
static int	module_deps_reference (struct ast_module *mod, struct ast_vector_const_string *missing)
static void	module_destroy (struct ast_module *mod)
static void	module_load_error (const char *fmt,...)
static void	module_load_helper (const char *word)
static int	module_load_helper_on_file (const char *dir_name, const char *filename, void *obj)
static int	module_matches_helper_type (struct ast_module *mod, enum ast_module_helper_type type)
static int	module_post_register (struct ast_module *mod)
static int	module_reffed_deps_add (struct ast_module *mod, struct ast_module *dep, struct ast_vector_const_string *missing)
static int	module_reffed_deps_add_dep_enhancers (struct ast_module *mod, struct ast_module *dep, struct ast_vector_const_string *missing)
static int	module_vector_cmp (struct ast_module *a, struct ast_module *b)
static int	module_vector_strcasecmp (struct ast_module *a, struct ast_module *b)
int	modules_shutdown (void)
static int	printdigest (const unsigned char *d)
static void	publish_load_message (const char *name, enum ast_module_load_result result)
static void	publish_load_message_type (const char *type, const char *name, const char *status)
static void	publish_reload_message (const char *name, enum ast_module_reload_result result)
static void	publish_unload_message (const char *name, const char *status)
static void	queue_reload_request (const char *module)
static int	resource_list_recursive_decline (struct module_vector *resources, struct ast_module *mod, struct ast_str **printmissing)
static size_t	resource_name_baselen (const char *name)
static int	resource_name_match (const char *name1, size_t baselen1, const char *name2)
static enum ast_module_load_result	start_resource (struct ast_module *mod)
static enum ast_module_load_result	start_resource_attempt (struct ast_module *mod, int *count)
static int	start_resource_list (struct module_vector *resources, int *mod_count)
static void	unload_dynamic_module (struct ast_module *mod)
static int	verify_key (const unsigned char *key)

Variables
static char	buildopt_sum [33] = AST_BUILDOPT_SUM
static struct module_list	builtin_module_list
static int	do_full_reload = 0
static const unsigned char	expected_key []
static const struct load_results_map	load_results []
static unsigned int	loader_ready
static struct module_list	module_list = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }
static int	modules_loaded
	Internal flag to indicate all modules have been initially loaded. More...
static struct reload_queue	reload_queue = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }
static ast_mutex_t	reloadlock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }
static struct ast_module *volatile	resource_being_loaded
static struct ast_str *	startup_error_builder
static struct ast_vector_string	startup_errors
const char *	support_level_map []
static struct updaters	updaters = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }

Detailed Description

Module Loader.

Author

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Kevin P. Fleming kpfle.nosp@m.ming.nosp@m.@digi.nosp@m.um.c.nosp@m.om

Luigi Rizzo rizzo.nosp@m.@ici.nosp@m.r.org

• See ModMngMnt

Definition in file loader.c.

Macro Definition Documentation

AST_MODULE_LOAD_UNKNOWN_STRING

#define AST_MODULE_LOAD_UNKNOWN_STRING   "Unknown" /* Status string for unknown load status */

Definition at line 351 of file loader.c.

Referenced by loadresult2str().

RTLD_LOCAL

#define RTLD_LOCAL   0

Definition at line 124 of file loader.c.

Referenced by load_dlopen(), and load_dynamic_module().

RTLD_NOW

#define RTLD_NOW   0

Definition at line 120 of file loader.c.

Referenced by load_dynamic_module().

STR_APPEND_TEXT

#define STR_APPEND_TEXT	(		txt,
			str
	)

Value:

ast_str_append(str, 0, "%s%s", \
      ast_str_strlen(*(str)) > 0 ? ", " : "", \
      txt)

Used with AST_VECTOR_CALLBACK_VOID to create a comma separated list of module names for error messages.

Definition at line 144 of file loader.c.

Referenced by load_dlopen_missing(), resource_list_recursive_decline(), and start_resource_list().

Function Documentation

__ast_module_ref()

struct ast_module* __ast_module_ref	(	struct ast_module *	mod,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 2698 of file loader.c.

References __ao2_ref(), ast_atomic_fetchadd_int(), ast_update_use_count(), NULL, ast_module::ref_debug, and ast_module::usecount.

Referenced by __ast_module_running_ref(), and __ast_module_shutdown_ref().

{
   if (!mod) {
      return NULL;
   }

   if (mod->ref_debug) {
      __ao2_ref(mod->ref_debug, +1, "", file, line, func);
   }

   ast_atomic_fetchadd_int(&mod->usecount, +1);
   ast_update_use_count();

   return mod;
}

__ast_module_running_ref()

struct ast_module* __ast_module_running_ref	(	struct ast_module *	mod,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 2714 of file loader.c.

References __ast_module_ref(), ast_module::flags, NULL, and ast_module::running.

{
   if (!mod || !mod->flags.running) {
      return NULL;
   }

   return __ast_module_ref(mod, file, line, func);
}

__ast_module_shutdown_ref()

void __ast_module_shutdown_ref	(	struct ast_module *	mod,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 2724 of file loader.c.

References __ast_module_ref(), ast_module::flags, and ast_module::keepuntilshutdown.

{
   if (!mod || mod->flags.keepuntilshutdown) {
      return;
   }

   __ast_module_ref(mod, file, line, func);
   mod->flags.keepuntilshutdown = 1;
}

__ast_module_unref()

void __ast_module_unref	(	struct ast_module *	mod,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 2734 of file loader.c.

References __ao2_ref(), ast_atomic_fetchadd_int(), ast_update_use_count(), ast_module::ref_debug, and ast_module::usecount.

{
   if (!mod) {
      return;
   }

   if (mod->ref_debug) {
      __ao2_ref(mod->ref_debug, -1, "", file, line, func);
   }

   ast_atomic_fetchadd_int(&mod->usecount, -1);
   ast_update_use_count();
}

__ast_module_user_add()

struct ast_module_user* __ast_module_user_add	(	struct ast_module *	mod,
		struct ast_channel *	chan
	)

Definition at line 800 of file loader.c.

References ao2_ref, ast_atomic_fetchadd_int(), ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_update_use_count(), ast_module_user::chan, NULL, ast_module::ref_debug, ast_module::usecount, and ast_module::users.

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

{
   struct ast_module_user *u;

   u = ast_calloc(1, sizeof(*u));
   if (!u) {
      return NULL;
   }

   u->chan = chan;

   AST_LIST_LOCK(&mod->users);
   AST_LIST_INSERT_HEAD(&mod->users, u, entry);
   AST_LIST_UNLOCK(&mod->users);

   if (mod->ref_debug) {
      ao2_ref(mod->ref_debug, +1);
   }

   ast_atomic_fetchadd_int(&mod->usecount, +1);

   ast_update_use_count();

   return u;
}

__ast_module_user_hangup_all()

void __ast_module_user_hangup_all

(

struct ast_module *

mod

)

Definition at line 853 of file loader.c.

References ao2_ref, 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::ref_debug, ast_module::usecount, and ast_module::users.

Referenced by ast_unload_resource().

{
   struct ast_module_user *u;

   AST_LIST_LOCK(&mod->users);
   while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
      if (u->chan) {
         ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
      }

      if (mod->ref_debug) {
         ao2_ref(mod->ref_debug, -1);
      }

      ast_atomic_fetchadd_int(&mod->usecount, -1);
      ast_free(u);
   }
   AST_LIST_UNLOCK(&mod->users);

   ast_update_use_count();
}

__ast_module_user_remove()

void __ast_module_user_remove	(	struct ast_module *	mod,
		struct ast_module_user *	u
	)

Definition at line 826 of file loader.c.

References ao2_ref, ast_atomic_fetchadd_int(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, ast_update_use_count(), ast_module::ref_debug, ast_module::usecount, and ast_module::users.

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

{
   if (!u) {
      return;
   }

   AST_LIST_LOCK(&mod->users);
   u = AST_LIST_REMOVE(&mod->users, u, entry);
   AST_LIST_UNLOCK(&mod->users);
   if (!u) {
      /*
       * Was not in the list.  Either a bad pointer or
       * __ast_module_user_hangup_all() has been called.
       */
      return;
   }

   if (mod->ref_debug) {
      ao2_ref(mod->ref_debug, -1);
   }

   ast_atomic_fetchadd_int(&mod->usecount, -1);
   ast_free(u);

   ast_update_use_count();
}

add_to_load_order()

static struct load_order_entry* add_to_load_order ( const char *  resource, struct load_order *  load_order, int  required, int  preload, int  builtin  )

static

Definition at line 1842 of file loader.c.

References ast_calloc, ast_free, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_strdup, load_order_entry::builtin, NULL, order, load_order_entry::preload, load_order_entry::required, load_order_entry::resource, resource_name_baselen(), and resource_name_match().

Referenced by loader_builtin_init(), and loader_config_init().

{
   struct load_order_entry *order;
   size_t resource_baselen = resource_name_baselen(resource);

   AST_LIST_TRAVERSE(load_order, order, entry) {
      if (!resource_name_match(resource, resource_baselen, order->resource)) {
         /* Make sure we have the proper setting for the required field
            (we might have both load= and required= lines in modules.conf) */
         order->required |= required;
         order->preload |= preload;
         return order;
      }
   }

   order = ast_calloc(1, sizeof(*order));
   if (!order) {
      return NULL;
   }

   order->resource = ast_strdup(resource);
   if (!order->resource) {
      ast_free(order);

      return NULL;
   }
   order->required = required;
   order->preload = preload;
   order->builtin = builtin;
   AST_LIST_INSERT_TAIL(load_order, order, entry);

   return order;
}

alpha_module_list_create()

static int alpha_module_list_create ( struct module_vector *  alpha_module_list )

static

Definition at line 2550 of file loader.c.

References AST_DLLIST_TRAVERSE, AST_VECTOR_ADD_SORTED, AST_VECTOR_INIT, and module_vector_strcasecmp().

Referenced by ast_update_module_list(), ast_update_module_list_condition(), and ast_update_module_list_data().

{
   struct ast_module *cur;

   if (AST_VECTOR_INIT(alpha_module_list, 32)) {
      return -1;
   }

   AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
      if (AST_VECTOR_ADD_SORTED(alpha_module_list, cur, module_vector_strcasecmp)) {
         return -1;
      }
   }

   return 0;
}

ast_load_resource()

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

References AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, ast_test_suite_event_notify, load_resource(), and NULL.

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

{
   int res;
   AST_DLLIST_LOCK(&module_list);
   res = load_resource(resource_name, 0, NULL, 0, 0);
   if (!res) {
      ast_test_suite_event_notify("MODULE_LOAD", "Message: %s", resource_name);
   }
   AST_DLLIST_UNLOCK(&module_list);

   return res;
}

ast_loader_register()

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

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, tmp(), and loadupdate::updater.

{
   struct loadupdate *tmp;

   if (!(tmp = ast_malloc(sizeof(*tmp))))
      return -1;

   tmp->updater = v;
   AST_LIST_LOCK(&updaters);
   AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
   AST_LIST_UNLOCK(&updaters);

   return 0;
}

ast_loader_unregister()

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

{
   struct loadupdate *cur;

   AST_LIST_LOCK(&updaters);
   AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
      if (cur->updater == v)  {
         AST_LIST_REMOVE_CURRENT(entry);
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&updaters);

   return cur ? 0 : -1;
}

ast_module_check()

int ast_module_check

(

const char *

name

)

Check if module exists.

Check if module with the name given is loaded.

Definition at line 2653 of file loader.c.

References ast_strlen_zero, find_resource(), and NULL.

Referenced by ast_ari_asterisk_get_module(), ast_ari_asterisk_load_module(), ast_ari_asterisk_reload_module(), ast_ari_asterisk_unload_module(), AST_TEST_DEFINE(), ifmodule_read(), and manager_modulecheck().

{
   struct ast_module *cur;

   if (ast_strlen_zero(name))
      return 0;       /* FALSE */

   cur = find_resource(name, 1);

   return (cur != NULL);
}

ast_module_helper()

char* ast_module_helper	(	const char *	line,
		const char *	word,
		int	pos,
		int	state,
		int	rpos,
		enum ast_module_helper_type	type
	)

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.
type	The type of action that will be performed by CLI.

Return values

A	possible completion of the partial match.
NULL	if no matches were found.

Definition at line 1374 of file loader.c.

References AST_DLLIST_LOCK, AST_DLLIST_TRAVERSE, AST_DLLIST_UNLOCK, AST_MODULE_HELPER_LOAD, ast_strdup, module_load_helper(), module_matches_helper_type(), NULL, and ast_module::resource.

Referenced by handle_debug(), handle_load(), handle_modlist(), handle_reload(), handle_trace(), and handle_unload().

{
   struct ast_module *mod;
   int which = 0;
   int wordlen = strlen(word);
   char *ret = NULL;

   if (pos != rpos) {
      return NULL;
   }

   if (type == AST_MODULE_HELPER_LOAD) {
      module_load_helper(word);

      return NULL;
   }

   AST_DLLIST_LOCK(&module_list);
   AST_DLLIST_TRAVERSE(&module_list, mod, entry) {
      if (!module_matches_helper_type(mod, type)) {
         continue;
      }

      if (!strncasecmp(word, mod->resource, wordlen) && ++which > state) {
         ret = ast_strdup(mod->resource);
         break;
      }
   }
   AST_DLLIST_UNLOCK(&module_list);

   return ret;
}

ast_module_name()

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

References ast_module::info, ast_module_info::name, and NULL.

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

{
   if (!mod || !mod->info) {
      return NULL;
   }

   return mod->info->name;
}

ast_module_register()

void ast_module_register

(

const struct ast_module_info *

info

)

Definition at line 659 of file loader.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_find, ao2_link, ao2_ref, ao2_t_alloc_options, ast_debug, AST_DLLIST_INSERT_TAIL, AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, AST_LIST_HEAD_INIT, ast_opt_ref_debug, ast_std_calloc(), AST_VECTOR_INIT, ast_module::builtin, builtin_module_list, ast_module::enhances, ast_module::flags, ast_module::info, sip_to_pjsip::info(), loader_ready, ast_module_info::name, NULL, OBJ_SEARCH_KEY, ast_module::optional_modules, ast_module::ref_debug, ast_module::reffed_deps, ast_module::requires, ast_module::resource, resource_being_loaded, ast_module_info::self, and ast_module::users.

Referenced by get_name_from_resource(), and loader_builtin_init().

{
   struct ast_module *mod;

   if (!loader_ready) {
      mod = ast_std_calloc(1, sizeof(*mod) + strlen(info->name) + 1);
      if (!mod) {
         /* We haven't even reached main() yet, if we can't
          * allocate memory at this point just give up. */
         fprintf(stderr, "Allocation failure during startup.\n");
         exit(2);
      }
      strcpy(mod->resource, info->name); /* safe */
      mod->info = info;
      mod->flags.builtin = 1;
      AST_DLLIST_INSERT_TAIL(&builtin_module_list, mod, entry);

      /* ast_module_register for built-in modules is run again during module preload. */
      return;
   }

   /*
    * This lock protects resource_being_loaded as well as the module
    * list.  Normally we already have a lock on module_list when we
    * begin the load but locking again from here prevents corruption
    * if an asterisk module is dlopen'ed from outside the module loader.
    */
   AST_DLLIST_LOCK(&module_list);
   mod = resource_being_loaded;
   if (!mod) {
      AST_DLLIST_UNLOCK(&module_list);
      return;
   }

   ast_debug(5, "Registering module %s\n", info->name);

   /* This tells load_dynamic_module that we're registered. */
   resource_being_loaded = NULL;

   mod->info = info;
   if (ast_opt_ref_debug) {
      mod->ref_debug = ao2_t_alloc_options(0, NULL, AO2_ALLOC_OPT_LOCK_NOLOCK, info->name);
   }
   AST_LIST_HEAD_INIT(&mod->users);
   AST_VECTOR_INIT(&mod->requires, 0);
   AST_VECTOR_INIT(&mod->optional_modules, 0);
   AST_VECTOR_INIT(&mod->enhances, 0);
   AST_VECTOR_INIT(&mod->reffed_deps, 0);

   AST_DLLIST_INSERT_TAIL(&module_list, mod, entry);
   AST_DLLIST_UNLOCK(&module_list);

   /* give the module a copy of its own handle, for later use in registrations and the like */
   *((struct ast_module **) &(info->self)) = mod;

#if defined(HAVE_PERMANENT_DLOPEN)
   if (mod->flags.builtin != 1) {
      struct info_list_obj *obj_tmp = ao2_find(info_list, info->name,
         OBJ_SEARCH_KEY);

      if (!obj_tmp) {
         obj_tmp = info_list_obj_alloc(info->name, info);
         if (obj_tmp) {
            ao2_link(info_list, obj_tmp);
            ao2_ref(obj_tmp, -1);
         }
      } else {
         ao2_ref(obj_tmp, -1);
      }
   }
#endif
}

ast_module_reload()

enum ast_module_reload_result ast_module_reload

(

const char *

name

)

Reload asterisk modules.

Parameters

name	the name of the module to reload

This function reloads the specified module, or if no modules are specified, it will reload all loaded modules.

Note

Modules are reloaded using their reload() functions, not unloading them and loading them again.

Return values

The	ast_module_reload_result status of the module load request

Definition at line 1562 of file loader.c.

References ast_config_AST_CONFIG_DIR, AST_DLLIST_LOCK, AST_DLLIST_TRAVERSE, AST_DLLIST_UNLOCK, ast_lastreloadtime, ast_lock_path(), AST_LOCK_SUCCESS, AST_LOCK_TIMEOUT, ast_log, AST_LOG_WARNING, AST_MODULE_LOAD_SUCCESS, AST_MODULE_RELOAD_ERROR, AST_MODULE_RELOAD_IN_PROGRESS, AST_MODULE_RELOAD_NOT_FOUND, AST_MODULE_RELOAD_NOT_IMPLEMENTED, AST_MODULE_RELOAD_QUEUED, AST_MODULE_RELOAD_SUCCESS, AST_MODULE_RELOAD_UNINITIALIZED, ast_mutex_trylock, ast_mutex_unlock, ast_opt_lock_confdir, ast_sd_notify(), ast_tvnow(), ast_unlock_path(), ast_verb, ast_module::declined, ast_module_info::description, ast_module::flags, ast_module::info, LOG_WARNING, publish_reload_message(), queue_reload_request(), ast_module_info::reload, reloadlock, ast_module::resource, resource_name_baselen(), resource_name_match(), and ast_module::running.

Referenced by action_reload(), action_updateconfig(), ast_ari_asterisk_reload_module(), ast_process_pending_reloads(), handle_cli_moh_reload(), handle_core_reload(), handle_reload(), manager_moduleload(), and monitor_sig_flags().

{
   struct ast_module *cur;
   enum ast_module_reload_result res = AST_MODULE_RELOAD_NOT_FOUND;
   size_t name_baselen = name ? resource_name_baselen(name) : 0;

   /* If we aren't fully booted, we just pretend we reloaded but we queue this
      up to run once we are booted up. */
   if (!modules_loaded) {
      queue_reload_request(name);
      res = AST_MODULE_RELOAD_QUEUED;
      goto module_reload_exit;
   }

   if (ast_mutex_trylock(&reloadlock)) {
      ast_verb(3, "The previous reload command didn't finish yet\n");
      res = AST_MODULE_RELOAD_IN_PROGRESS;
      goto module_reload_exit;
   }
   ast_sd_notify("RELOAD=1");
   ast_lastreloadtime = ast_tvnow();

   if (ast_opt_lock_confdir) {
      int try;
      int lockres;
      for (try = 1, lockres = AST_LOCK_TIMEOUT; try < 6 && (lockres == AST_LOCK_TIMEOUT); try++) {
         lockres = ast_lock_path(ast_config_AST_CONFIG_DIR);
         if (lockres == AST_LOCK_TIMEOUT) {
            ast_log(LOG_WARNING, "Failed to grab lock on %s, try %d\n", ast_config_AST_CONFIG_DIR, try);
         }
      }
      if (lockres != AST_LOCK_SUCCESS) {
         ast_log(AST_LOG_WARNING, "Cannot grab lock on %s\n", ast_config_AST_CONFIG_DIR);
         res = AST_MODULE_RELOAD_ERROR;
         goto module_reload_done;
      }
   }

   AST_DLLIST_LOCK(&module_list);
   AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
      const struct ast_module_info *info = cur->info;

      if (name && resource_name_match(name, name_baselen, cur->resource)) {
         continue;
      }

      if (!cur->flags.running || cur->flags.declined) {
         if (res == AST_MODULE_RELOAD_NOT_FOUND) {
            res = AST_MODULE_RELOAD_UNINITIALIZED;
         }
         if (!name) {
            continue;
         }
         break;
      }

      if (!info->reload) { /* cannot be reloaded */
         if (res == AST_MODULE_RELOAD_NOT_FOUND) {
            res = AST_MODULE_RELOAD_NOT_IMPLEMENTED;
         }
         if (!name) {
            continue;
         }
         break;
      }
      ast_verb(3, "Reloading module '%s' (%s)\n", cur->resource, info->description);
      if (info->reload() == AST_MODULE_LOAD_SUCCESS) {
         res = AST_MODULE_RELOAD_SUCCESS;
      } else if (res == AST_MODULE_RELOAD_NOT_FOUND) {
         res = AST_MODULE_RELOAD_ERROR;
      }
      if (name) {
         break;
      }
   }
   AST_DLLIST_UNLOCK(&module_list);

   if (ast_opt_lock_confdir) {
      ast_unlock_path(ast_config_AST_CONFIG_DIR);
   }
module_reload_done:
   ast_mutex_unlock(&reloadlock);
   ast_sd_notify("READY=1");

module_reload_exit:
   publish_reload_message(name, res);
   return res;
}

ast_module_support_level_to_string()

const char* ast_module_support_level_to_string

(

enum ast_module_support_level

support_level

)

Definition at line 2755 of file loader.c.

Referenced by identify_module(), modlist_modentry(), and process_module_list().

{
   return support_level_map[support_level];
}

ast_module_unregister()

void ast_module_unregister

(

const struct ast_module_info *

info

)

Definition at line 768 of file loader.c.

References ast_debug, AST_DLLIST_LOCK, AST_DLLIST_REMOVE_CURRENT, AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN, AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END, AST_DLLIST_UNLOCK, ast_module::info, module_destroy(), ast_module_info::name, NULL, and ast_module::usecount.

Referenced by get_name_from_resource().

{
   struct ast_module *mod = NULL;

   /* it is assumed that the users list in the module structure
      will already be empty, or we cannot have gotten to this
      point
   */
   AST_DLLIST_LOCK(&module_list);
   AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN(&module_list, mod, entry) {
      if (mod->info == info) {
         AST_DLLIST_REMOVE_CURRENT(entry);
         break;
      }
   }
   AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END;
   AST_DLLIST_UNLOCK(&module_list);

   if (mod && !mod->usecount) {
      /*
       * We are intentionally leaking mod if usecount is not zero.
       * This is necessary if the module is being forcefully unloaded.
       * In addition module_destroy is not safe to run after exit()
       * is called.  ast_module_unregister is run during cleanup of
       * the process when libc releases each module's shared object
       * library.
       */
      ast_debug(5, "Unregistering module %s\n", info->name);
      module_destroy(mod);
   }
}

ast_process_pending_reloads()

void ast_process_pending_reloads

(

void

)

Process reload requests received during startup.

This function requests that the loader execute the pending reload requests that were queued during server startup.

Note

This function will do nothing if the server has not completely started up. Once called, the reload queue is emptied, and further invocations will have no affect.

Definition at line 1407 of file loader.c.

References ast_free, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log, ast_module_reload(), item, LOG_NOTICE, reload_queue_item::module, and NULL.

Referenced by asterisk_daemon().

{
   struct reload_queue_item *item;

   modules_loaded = 1;

   AST_LIST_LOCK(&reload_queue);

   if (do_full_reload) {
      do_full_reload = 0;
      AST_LIST_UNLOCK(&reload_queue);
      ast_log(LOG_NOTICE, "Executing deferred reload request.\n");
      ast_module_reload(NULL);
      return;
   }

   while ((item = AST_LIST_REMOVE_HEAD(&reload_queue, entry))) {
      ast_log(LOG_NOTICE, "Executing deferred reload request for module '%s'.\n", item->module);
      ast_module_reload(item->module);
      ast_free(item);
   }

   AST_LIST_UNLOCK(&reload_queue);
}

ast_unload_resource()

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

References __ast_module_user_hangup_all(), AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, AST_FORCE_FIRM, ast_log, ast_test_suite_event_notify, ast_update_use_count(), ast_verb, ast_module::declined, error(), find_resource(), ast_module::flags, ast_module::info, LOG_WARNING, publish_unload_message(), ast_module::resource, ast_module::running, ast_module_info::unload, unload_dynamic_module(), and ast_module::usecount.

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

{
   struct ast_module *mod;
   int res = -1;
   int error = 0;

   AST_DLLIST_LOCK(&module_list);

   if (!(mod = find_resource(resource_name, 0))) {
      AST_DLLIST_UNLOCK(&module_list);
      ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
      return -1;
   }

   if (!mod->flags.running || mod->flags.declined) {
      ast_log(LOG_WARNING, "Unload failed, '%s' is not loaded.\n", resource_name);
      error = 1;
   }

   if (!error && (mod->usecount > 0)) {
      if (force)
         ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
            resource_name, mod->usecount);
      else {
         ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
            mod->usecount);
         error = 1;
      }
   }

   if (!error) {
      /* Request any channels attached to the module to hangup. */
      __ast_module_user_hangup_all(mod);

      ast_verb(1, "Unloading %s\n", mod->resource);
      res = mod->info->unload();
      if (res) {
         ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
         if (force <= AST_FORCE_FIRM) {
            error = 1;
         } else {
            ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
         }
      }

      if (!error) {
         /*
          * Request hangup on any channels that managed to get attached
          * while we called the module unload function.
          */
         __ast_module_user_hangup_all(mod);
         sched_yield();
      }
   }

   if (!error)
      mod->flags.running = mod->flags.declined = 0;

   AST_DLLIST_UNLOCK(&module_list);

   if (!error) {
      unload_dynamic_module(mod);
      ast_test_suite_event_notify("MODULE_UNLOAD", "Message: %s", resource_name);
      ast_update_use_count();
      publish_unload_message(resource_name, "Success");
   }

   return res;
}

ast_update_module_list()

int ast_update_module_list	(	int(*)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level)	modentry,
		const char *	like
	)

Ask for a list of modules, descriptions, use counts and status.

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

References alpha_module_list_create(), AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_module_info::description, ast_module::flags, ast_module::info, ast_module::resource, ast_module::running, ast_module_info::support_level, and ast_module::usecount.

Referenced by ast_var_Modules(), and handle_modlist().

{
   int total_mod_loaded = 0;
   struct module_vector alpha_module_list;

   AST_DLLIST_LOCK(&module_list);

   if (!alpha_module_list_create(&alpha_module_list)) {
      int idx;

      for (idx = 0; idx < AST_VECTOR_SIZE(&alpha_module_list); idx++) {
         struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);

         total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount,
            cur->flags.running ? "Running" : "Not Running", like, cur->info->support_level);
      }
   }

   AST_DLLIST_UNLOCK(&module_list);
   AST_VECTOR_FREE(&alpha_module_list);

   return total_mod_loaded;
}

ast_update_module_list_condition()

int ast_update_module_list_condition	(	int(*)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level, void *data, const char *condition)	modentry,
		const char *	like,
		void *	data,
		const char *	condition
	)

Ask for a list of modules, descriptions, use counts and status.

Parameters

modentry	A callback to an updater function
like
data	Data passed into the callback for manipulation
condition	The condition to meet

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 conditions met

Since

13.5.0

Definition at line 2622 of file loader.c.

References alpha_module_list_create(), AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_module_info::description, ast_module::flags, ast_module::info, ast_module::resource, ast_module::running, ast_module_info::support_level, and ast_module::usecount.

Referenced by ast_ari_asterisk_get_module().

{
   int conditions_met = 0;
   struct module_vector alpha_module_list;

   AST_DLLIST_LOCK(&module_list);

   if (!alpha_module_list_create(&alpha_module_list)) {
      int idx;

      for (idx = 0; idx < AST_VECTOR_SIZE(&alpha_module_list); idx++) {
         struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);

         conditions_met += modentry(cur->resource, cur->info->description, cur->usecount,
            cur->flags.running? "Running" : "Not Running", like, cur->info->support_level, data,
            condition);
      }
   }

   AST_DLLIST_UNLOCK(&module_list);
   AST_VECTOR_FREE(&alpha_module_list);

   return conditions_met;
}

ast_update_module_list_data()

int ast_update_module_list_data	(	int(*)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level, void *data)	modentry,
		const char *	like,
		void *	data
	)

Ask for a list of modules, descriptions, use counts and status.

Parameters

modentry	A callback to an updater function
like
data	Data passed into the callback for manipulation

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

Since

13.5.0

Definition at line 2594 of file loader.c.

References alpha_module_list_create(), AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_module_info::description, ast_module::flags, ast_module::info, ast_module::resource, ast_module::running, ast_module_info::support_level, and ast_module::usecount.

Referenced by ast_ari_asterisk_list_modules().

{
   int total_mod_loaded = 0;
   struct module_vector alpha_module_list;

   AST_DLLIST_LOCK(&module_list);

   if (!alpha_module_list_create(&alpha_module_list)) {
      int idx;

      for (idx = 0; idx < AST_VECTOR_SIZE(&alpha_module_list); idx++) {
         struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);

         total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount,
            cur->flags.running? "Running" : "Not Running", like, cur->info->support_level, data);
      }
   }

   AST_DLLIST_UNLOCK(&module_list);
   AST_VECTOR_FREE(&alpha_module_list);

   return total_mod_loaded;
}

ast_update_use_count()

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

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, and loadupdate::updater.

Referenced by __ast_module_ref(), __ast_module_unref(), __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_unload_resource(), handle_request_do(), ooh323_hangup(), ooh323_new(), ooh323c_call_thread(), sip_request_call(), start_resource(), and unistim_new().

{
   /* Notify any module monitors that the use count for a
      resource has changed */
   struct loadupdate *m;

   AST_LIST_LOCK(&updaters);
   AST_LIST_TRAVERSE(&updaters, m, entry)
      m->updater();
   AST_LIST_UNLOCK(&updaters);
}

AST_VECTOR()

AST_VECTOR	(	module_vector	,
		struct ast_module *
	)

find_resource()

static struct ast_module * find_resource ( const char *  resource, int  do_lock  )

static

Definition at line 937 of file loader.c.

References AST_DLLIST_LOCK, AST_DLLIST_TRAVERSE, AST_DLLIST_UNLOCK, ast_module::resource, resource_name_baselen(), and resource_name_match().

Referenced by ast_module_check(), ast_unload_resource(), load_dlopen_missing(), load_resource(), loader_config_init(), module_deps_missing_recursive(), module_deps_process_reqlist(), module_load_helper_on_file(), and module_vector_cmp().

{
   struct ast_module *cur;
   size_t resource_baselen = resource_name_baselen(resource);

   if (do_lock) {
      AST_DLLIST_LOCK(&module_list);
   }

   AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
      if (!resource_name_match(resource, resource_baselen, cur->resource)) {
         break;
      }
   }

   if (do_lock) {
      AST_DLLIST_UNLOCK(&module_list);
   }

   return cur;
}

get_name_from_resource()

static char* get_name_from_resource ( const char *  resource )

static

Definition at line 157 of file loader.c.

References ao2_alloc, ao2_find, ao2_ref, AO2_STRING_FIELD_CMP_FN, ast_calloc, ast_copy_string(), ast_free, ast_module_register(), ast_module_unregister(), ast_shutdown_final(), sip_to_pjsip::info(), len(), name, NULL, and OBJ_SEARCH_KEY.

Referenced by load_modules().

{
   int len;
   const char *last_three;
   char *mod_name;

   if (!resource) {
      return NULL;
   }

   len = strlen(resource);
   if (len > 3) {
      last_three = &resource[len-3];
      if (!strcasecmp(last_three, ".so")) {
         mod_name = ast_calloc(1, len - 2);
         if (mod_name) {
            ast_copy_string(mod_name, resource, len - 2);
            return mod_name;
         } else {
            /* Unable to allocate memory. */
            return NULL;
         }
      }
   }

   /* Resource is the name - happens when manually unloading a module. */
   mod_name = ast_calloc(1, len + 1);
   if (mod_name) {
      ast_copy_string(mod_name, resource, len + 1);
      return mod_name;
   }

   /* Unable to allocate memory. */
   return NULL;
}

inspect_module()

static unsigned int inspect_module ( const struct ast_module *  mod )

static

Definition at line 1651 of file loader.c.

References ast_strlen_zero, buildopt_sum, ast_module_info::buildopt_sum, ast_module_info::description, ast_module::info, ast_module_info::key, module_load_error(), ast_module::resource, and verify_key().

Referenced by load_resource().

{
   if (!mod->info->description) {
      module_load_error("Module '%s' does not provide a description.\n", mod->resource);
      return 1;
   }

   if (!mod->info->key) {
      module_load_error("Module '%s' does not provide a license key.\n", mod->resource);
      return 1;
   }

   if (verify_key((unsigned char *) mod->info->key)) {
      module_load_error("Module '%s' did not provide a valid license key.\n", mod->resource);
      return 1;
   }

   if (!ast_strlen_zero(mod->info->buildopt_sum) &&
       strcmp(buildopt_sum, mod->info->buildopt_sum)) {
      module_load_error("Module '%s' was not compiled with the same compile-time options as this version of Asterisk.\n", mod->resource);
      module_load_error("Module '%s' will not be initialized as it may cause instability.\n", mod->resource);
      return 1;
   }

   return 0;
}

is_module_loaded()

static int is_module_loaded ( const char *  resource_name )

static

Check to see if the given resource is loaded.

Parameters

resource_name

Name of the resource, including .so suffix.

Returns

False (0) if module is not loaded.

True (non-zero) if module is loaded.

Definition at line 991 of file loader.c.

References ast_config_AST_MODULE_DIR, ast_module::lib, logged_dlclose(), and PATH_MAX.

Referenced by unload_dynamic_module().

{
   char fn[PATH_MAX] = "";
   void *lib;

   snprintf(fn, sizeof(fn), "%s/%s", ast_config_AST_MODULE_DIR,
      resource_name);

   lib = dlopen(fn, RTLD_LAZY | RTLD_NOLOAD);

   if (lib) {
      logged_dlclose(resource_name, lib);
      return 1;
   }

   return 0;
}

key_matches()

static int key_matches ( const unsigned char *  key1, const unsigned char *  key2  )

static

Definition at line 888 of file loader.c.

Referenced by verify_key().

{
   int x;

   for (x = 0; x < 16; x++) {
      if (key1[x] != key2[x])
         return 0;
   }

   return 1;
}

load_dlopen()

static struct ast_module* load_dlopen ( const char *  resource_in, const char *  so_ext, const char *  filename, int  flags, unsigned int  suppress_logging  )

static

Definition at line 1070 of file loader.c.

References ast_assert, ast_calloc, ast_free, ast_str_buffer(), ast_str_create, ast_str_strlen(), ast_strdupa, c, ast_module::enhances, ast_module::lib, load_dlopen_missing(), logged_dlclose(), module_load_error(), module_post_register(), NULL, ast_module::optional_modules, ast_module::requires, ast_module::resource, RTLD_LOCAL, S_OR, and unload_dynamic_module().

Referenced by load_dynamic_module().

{
   struct ast_module *mod;

   ast_assert(!resource_being_loaded);

   mod = ast_calloc(1, sizeof(*mod) + strlen(resource_in) + strlen(so_ext) + 1);
   if (!mod) {
      return NULL;
   }

   sprintf(mod->resource, "%s%s", resource_in, so_ext); /* safe */

   resource_being_loaded = mod;
   mod->lib = dlopen(filename, flags);
#if defined(HAVE_PERMANENT_DLOPEN)
   manual_mod_reg(mod->lib, mod->resource);
#endif
   if (resource_being_loaded) {
      struct ast_str *list;
      int c = 0;
      const char *dlerror_msg = ast_strdupa(S_OR(dlerror(), ""));

      resource_being_loaded = NULL;
      if (mod->lib) {
         module_load_error("Module '%s' did not register itself during load\n", resource_in);
         logged_dlclose(resource_in, mod->lib);

         goto error_return;
      }

      if (suppress_logging) {
         goto error_return;
      }

      resource_being_loaded = mod;
      mod->lib = dlopen(filename, RTLD_LAZY | RTLD_LOCAL);
#if defined(HAVE_PERMANENT_DLOPEN)
      manual_mod_reg(mod->lib, mod->resource);
#endif
      if (resource_being_loaded) {
         resource_being_loaded = NULL;

         module_load_error("Error loading module '%s': %s\n", resource_in, dlerror_msg);
         logged_dlclose(resource_in, mod->lib);

         goto error_return;
      }

      list = ast_str_create(64);
      if (list) {
         if (module_post_register(mod)) {
            goto loaded_error;
         }

         c = load_dlopen_missing(&list, &mod->requires);
         c += load_dlopen_missing(&list, &mod->enhances);
#ifndef OPTIONAL_API
         c += load_dlopen_missing(&list, &mod->optional_modules);
#endif
      }

      if (list && ast_str_strlen(list)) {
         module_load_error("Error loading module '%s', missing %s: %s\n",
            resource_in, c == 1 ? "dependency" : "dependencies", ast_str_buffer(list));
      } else {
         module_load_error("Error loading module '%s': %s\n", resource_in, dlerror_msg);
      }

loaded_error:
      ast_free(list);
      unload_dynamic_module(mod);

      return NULL;

error_return:
      ast_free(mod);

      return NULL;
   }

   return mod;
}

load_dlopen_missing()

static int load_dlopen_missing ( struct ast_str **  list, struct ast_vector_string *  deps  )

static

Definition at line 1040 of file loader.c.

References AST_VECTOR_GET, AST_VECTOR_SIZE, c, find_resource(), and STR_APPEND_TEXT.

Referenced by load_dlopen().

{
   int i;
   int c = 0;

   for (i = 0; i < AST_VECTOR_SIZE(deps); i++) {
      const char *dep = AST_VECTOR_GET(deps, i);
      if (!find_resource(dep, 0)) {
         STR_APPEND_TEXT(dep, list);
         c++;
      }
   }

   return c;
}

load_dynamic_module()

static struct ast_module* load_dynamic_module ( const char *  resource_in, unsigned int  suppress_logging  )

static

Definition at line 1155 of file loader.c.

References ast_config_AST_MODULE_DIR, AST_MODFLAG_GLOBAL_SYMBOLS, ast_test_flag, ast_module::info, ast_module::lib, load_dlopen(), logged_dlclose(), PATH_MAX, RTLD_LOCAL, and RTLD_NOW.

Referenced by load_resource().

{
   char fn[PATH_MAX];
   struct ast_module *mod;
   size_t resource_in_len = strlen(resource_in);
   const char *so_ext = "";

   if (resource_in_len < 4 || strcasecmp(resource_in + resource_in_len - 3, ".so")) {
      so_ext = ".so";
   }

   snprintf(fn, sizeof(fn), "%s/%s%s", ast_config_AST_MODULE_DIR, resource_in, so_ext);

   /* Try loading in quiet mode first with RTLD_LOCAL.  The majority of modules do not
    * export symbols so this allows the least number of calls to dlopen. */
   mod = load_dlopen(resource_in, so_ext, fn, RTLD_NOW | RTLD_LOCAL, suppress_logging);

   if (!mod || !ast_test_flag(mod->info, AST_MODFLAG_GLOBAL_SYMBOLS)) {
      return mod;
   }

   /* Close the module so we can reopen with correct flags. */
   logged_dlclose(resource_in, mod->lib);

   return load_dlopen(resource_in, so_ext, fn, RTLD_NOW | RTLD_GLOBAL, 0);
}

load_modules()

int load_modules

(

void

)

Provided by loader.c

Definition at line 2338 of file loader.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_list, ast_copy_string(), ast_debug, AST_DLLIST_LOCK, AST_DLLIST_TRAVERSE, AST_DLLIST_UNLOCK, ast_free, AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE, ast_log, AST_MODULE_SUPPORT_DEPRECATED, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_reset(), ast_str_strlen(), ast_strlen_zero, ast_tvdiff_us(), ast_tvnow(), AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, ast_verb, ast_xml_find_element(), ast_xml_get_text(), ast_xml_node_get_children(), ast_xml_xpath_get_first_result(), ast_xml_xpath_results_free(), ast_xmldoc_query(), ast_module::declined, done, ast_module::flags, get_name_from_resource(), ast_module::info, load_resource_list(), loader_builtin_init(), loader_config_init(), LOG_ERROR, LOG_NOTICE, LOG_WARNING, NULL, order, ast_module::resource, load_order_entry::resource, ast_module::running, startup_errors, str, and ast_module_info::support_level.

Referenced by asterisk_daemon().

{
   struct load_order_entry *order;
   unsigned int load_count;
   struct load_order load_order;
   int res = 0;
   int modulecount = 0;
   int i;
   struct ast_module *cur;
#ifdef AST_XML_DOCS
   struct ast_str *warning_msg;
   char deprecated_in[33];
   char removed_in[33];
   char replacement[129];
#endif
   struct timeval start_time = ast_tvnow();
   struct timeval end_time;
   int64_t usElapsed;

   ast_verb(1, "Asterisk Dynamic Loader Starting:\n");

#if defined(HAVE_PERMANENT_DLOPEN)
   info_list = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
      info_list_obj_cmp_fn); /* must not be cleaned at shutdown */
   if (!info_list) {
      fprintf(stderr, "Module info list allocation failure.\n");
      return 1;
   }
#endif

   AST_LIST_HEAD_INIT_NOLOCK(&load_order);
   AST_DLLIST_LOCK(&module_list);

   AST_VECTOR_INIT(&startup_errors, 0);
   startup_error_builder = ast_str_create(64);

   res = loader_builtin_init(&load_order);
   if (res) {
      goto done;
   }

   res = loader_config_init(&load_order);
   if (res) {
      goto done;
   }

   load_count = 0;
   AST_LIST_TRAVERSE(&load_order, order, entry)
      load_count++;

   if (load_count)
      ast_log(LOG_NOTICE, "%u modules will be loaded.\n", load_count);

   res = load_resource_list(&load_order, &modulecount);
   if (res == -1) {
      ast_log(LOG_WARNING, "Some non-required modules failed to load.\n");
      res = 0;
   }

done:
   while ((order = AST_LIST_REMOVE_HEAD(&load_order, entry))) {
      ast_free(order->resource);
      ast_free(order);
   }

#ifdef AST_XML_DOCS
   warning_msg = ast_str_create(512);
#endif

   AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
#ifdef AST_XML_DOCS
      char *mod_name = NULL;
      struct ast_xml_xpath_results *results;
#endif

      if (!cur->flags.running || cur->flags.declined) {
         continue;
      }

#ifdef AST_XML_DOCS
      mod_name = get_name_from_resource(cur->resource);
      if (!warning_msg || !mod_name) {
         /* If we can't allocate memory, we have bigger issues */
         ast_free(mod_name);
         continue;
      }

      /* Clear out the previous values */
      deprecated_in[0] = removed_in[0] = replacement[0] = 0;

      results = ast_xmldoc_query("/docs/module[@name='%s']", mod_name);
      if (results) {
         struct ast_xml_node *deprecated_node, *removed_node, *replacement_node;
         struct ast_xml_node *metadata_nodes = ast_xml_node_get_children(ast_xml_xpath_get_first_result(results));

         deprecated_node = ast_xml_find_element(metadata_nodes, "deprecated_in", NULL, NULL);
         if (deprecated_node) {
            const char *result_tmp = ast_xml_get_text(deprecated_node);
            if (!ast_strlen_zero(result_tmp)) {
               ast_copy_string(deprecated_in, result_tmp, sizeof(deprecated_in));
            }
         }

         removed_node = ast_xml_find_element(metadata_nodes, "removed_in", NULL, NULL);
         if (removed_node) {
            const char *result_tmp = ast_xml_get_text(removed_node);
            if (!ast_strlen_zero(result_tmp)) {
               ast_copy_string(removed_in, result_tmp, sizeof(removed_in));
            }
         }

         replacement_node = ast_xml_find_element(metadata_nodes, "replacement", NULL, NULL);
         if (replacement_node) {
            const char *result_tmp = ast_xml_get_text(replacement_node);
            if (!ast_strlen_zero(result_tmp)) {
               ast_copy_string(replacement, result_tmp, sizeof(replacement));
            }
         }

         ast_xml_xpath_results_free(results);
      }

      ast_str_reset(warning_msg);

      if (cur->info->support_level == AST_MODULE_SUPPORT_DEPRECATED || !ast_strlen_zero(deprecated_in)
         || !ast_strlen_zero(removed_in) || !ast_strlen_zero(replacement)) {
         int already_butted = 0;

         ast_str_append(&warning_msg, -1, "Module '%s' has been loaded", mod_name);
         if (!ast_strlen_zero(deprecated_in)) {
            ast_str_append(&warning_msg, -1, " but %s deprecated in Asterisk version %s",
                cur->info->support_level == AST_MODULE_SUPPORT_DEPRECATED ? "was" : "will be", deprecated_in);
            already_butted = 1;
         }

         if (!ast_strlen_zero(removed_in)) {
            ast_str_append(&warning_msg, -1, " %s will be removed in Asterisk version %s", already_butted ? "and" : "but", removed_in);
         } else {
            ast_str_append(&warning_msg, -1, " %s may be removed in a future release", already_butted ? "and" : "but");
         }

         ast_str_append(&warning_msg, -1, ".");

         if (!ast_strlen_zero(replacement)) {
            ast_str_append(&warning_msg, -1, " Its replacement is '%s'.", replacement);
         }
      }

      if (ast_str_strlen(warning_msg)) {
         ast_log(LOG_WARNING, "%s\n", ast_str_buffer(warning_msg));
      }

      ast_free(mod_name);
#else
      if (cur->info->support_level == AST_MODULE_SUPPORT_DEPRECATED) {
         ast_log(LOG_WARNING, "The deprecated module '%s' has been loaded and is running, it may be removed in a future version\n", cur->resource);
      }
#endif
   }

#ifdef AST_XML_DOCS
   ast_free(warning_msg);
#endif

   AST_DLLIST_UNLOCK(&module_list);


   for (i = 0; i < AST_VECTOR_SIZE(&startup_errors); i++) {
      char *str = AST_VECTOR_GET(&startup_errors, i);

      ast_log(LOG_ERROR, "%s", str);
      ast_free(str);
   }
   AST_VECTOR_FREE(&startup_errors);

   ast_free(startup_error_builder);
   startup_error_builder = NULL;

   end_time = ast_tvnow();
   usElapsed = ast_tvdiff_us(end_time, start_time);

#ifdef AST_XML_DOCS
   ast_debug(1, "Loader time with AST_XML_DOCS: %ld.%06ld\n", usElapsed / 1000000, usElapsed % 1000000);
#else
   ast_debug(1, "Loader time without AST_XML_DOCS: %ld.%06ld\n", usElapsed / 1000000, usElapsed % 1000000);
#endif

   return res;
}

load_resource()

static enum ast_module_load_result load_resource ( const char *  resource_name, unsigned int  suppress_logging, struct module_vector *  module_priorities, int  required, int  preload  )

static

loads a resource based upon resource_name. If global_symbols_only is set only modules with global symbols will be loaded.

If the module_vector is provided (not NULL) the module is found and added to the vector without running the module's load() function. By doing this, modules can be initialized later in order by priority and dependencies.

If the module_vector is not provided, the module's load function will be executed immediately

Definition at line 1763 of file loader.c.

References ast_fully_booted, ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_PRIORITY, AST_MODULE_LOAD_SUCCESS, ast_shutdown_final(), AST_VECTOR_ADD_SORTED, ast_module::declined, find_resource(), ast_module::flags, inspect_module(), load_dynamic_module(), LOG_WARNING, module_load_error(), module_post_register(), module_vector_cmp(), ast_module::preload, publish_load_message(), ast_module::required, ast_module::running, start_resource(), and unload_dynamic_module().

Referenced by ast_load_resource(), and load_resource_list().

{
   struct ast_module *mod;
   enum ast_module_load_result res = AST_MODULE_LOAD_SUCCESS;

   if ((mod = find_resource(resource_name, 0))) {
      if (mod->flags.running) {
         ast_log(LOG_WARNING, "Module '%s' already loaded and running.\n", resource_name);
         return AST_MODULE_LOAD_DECLINE;
      }
   } else {
      mod = load_dynamic_module(resource_name, suppress_logging);
      if (!mod) {
         return required ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_DECLINE;
      }

      if (module_post_register(mod)) {
         goto prestart_error;
      }
   }

   mod->flags.required |= required;
   mod->flags.preload |= preload;

   if (inspect_module(mod)) {
      goto prestart_error;
   }

   mod->flags.declined = 0;

   if (module_priorities) {
      if (AST_VECTOR_ADD_SORTED(module_priorities, mod, module_vector_cmp)) {
         goto prestart_error;
      }
      res = AST_MODULE_LOAD_PRIORITY;
   } else {
      res = start_resource(mod);
   }

   if (ast_fully_booted && !ast_shutdown_final()) {
      publish_load_message(resource_name, res);
   }

   return res;

prestart_error:
   module_load_error("Module '%s' could not be loaded.\n", resource_name);
   unload_dynamic_module(mod);
   res = required ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_DECLINE;
   if (ast_fully_booted && !ast_shutdown_final()) {
      publish_load_message(resource_name, res);
   }
   return res;
}

load_resource_list()

static int load_resource_list ( struct load_order *  load_order, int *  mod_count  )

static

loads modules in order by load_pri, updates mod_count

Returns

-1 on failure to load module, -2 on failure to load required module, otherwise 0

Definition at line 2101 of file loader.c.

References ast_debug, ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_PRIORITY, AST_MODULE_LOAD_SKIP, AST_MODULE_LOAD_SUCCESS, AST_VECTOR_FREE, AST_VECTOR_INIT, load_resource(), LOG_ERROR, module_load_error(), order, load_order_entry::preload, load_order_entry::required, load_order_entry::resource, and start_resource_list().

Referenced by load_modules().

{
   struct module_vector module_priorities;
   struct load_order_entry *order;
   int attempt = 0;
   int count = 0;
   int res = 0;
   int didwork;
   int lasttry = 0;

   if (AST_VECTOR_INIT(&module_priorities, 500)) {
      ast_log(LOG_ERROR, "Failed to initialize module loader.\n");

      return -1;
   }

   while (res != -2) {
      didwork = 0;

      AST_LIST_TRAVERSE_SAFE_BEGIN(load_order, order, entry) {
         enum ast_module_load_result lres;

         /* Suppress log messages unless this is the last pass */
         lres = load_resource(order->resource, !lasttry, &module_priorities, order->required, order->preload);
         ast_debug(3, "PASS %d: %-46s %d\n", attempt, order->resource, lres);
         switch (lres) {
         case AST_MODULE_LOAD_SUCCESS:
         case AST_MODULE_LOAD_SKIP:
            /* We're supplying module_priorities so SUCCESS isn't possible but we
             * still have to test for it.  SKIP is only used when we try to start a
             * module that is missing dependencies. */
            break;
         case AST_MODULE_LOAD_DECLINE:
            res = -1;
            break;
         case AST_MODULE_LOAD_FAILURE:
            /* LOAD_FAILURE only happens for required modules */
            if (lasttry) {
               /* This run is just to print errors. */
               module_load_error("*** Failed to load module %s - Required\n", order->resource);
               fprintf(stderr, "*** Failed to load module %s - Required\n", order->resource);
               res =  -2;
            }
            break;
         case AST_MODULE_LOAD_PRIORITY:
            /* load_resource worked and the module was added to module_priorities */
            AST_LIST_REMOVE_CURRENT(entry);
            ast_free(order->resource);
            ast_free(order);
            didwork = 1;
            break;
         }
      }
      AST_LIST_TRAVERSE_SAFE_END;

      if (!didwork) {
         if (lasttry) {
            break;
         }
         /* We know the next try is going to fail, it's only being performed
          * so we can print errors. */
         lasttry = 1;
      }
      attempt++;
   }

   if (res != -2) {
      res = start_resource_list(&module_priorities, &count);
   }

   if (mod_count) {
      *mod_count += count;
   }
   AST_VECTOR_FREE(&module_priorities);

   return res;
}

loader_builtin_init()

static int loader_builtin_init ( struct load_order *  load_order )

static

Definition at line 2179 of file loader.c.

References add_to_load_order(), AST_DLLIST_REMOVE_HEAD, AST_DLLIST_TRAVERSE, ast_module_register(), ast_module::builtin, builtin_module_list, ast_module::flags, ast_module::info, loader_ready, module_post_register(), and ast_module::resource.

Referenced by load_modules().

{
   struct ast_module *mod;

   /*
    * All built-in modules have registered the first time, now it's time to complete
    * the registration and add them to the priority list.
    */
   loader_ready = 1;

   while ((resource_being_loaded = AST_DLLIST_REMOVE_HEAD(&builtin_module_list, entry))) {
      /* ast_module_register doesn't finish when first run by built-in modules. */
      ast_module_register(resource_being_loaded->info);
   }

   /* Add all built-in modules to the load order. */
   AST_DLLIST_TRAVERSE(&module_list, mod, entry) {
      if (!mod->flags.builtin) {
         continue;
      }

      /* Parse dependendencies from mod->info. */
      if (module_post_register(mod)) {
         return -1;
      }

      /* Built-in modules are not preloaded, most have an early load priority. */
      if (!add_to_load_order(mod->resource, load_order, 0, 0, 1)) {
         return -1;
      }
   }

   return 0;
}

loader_config_init()

static int loader_config_init ( struct load_order *  load_order )

static

Definition at line 2214 of file loader.c.

References add_to_load_order(), ast_config_AST_MODULE_DIR, ast_config_destroy(), ast_config_load2(), ast_debug, ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log, AST_MODULE_CONFIG, ast_true(), ast_variable_browse(), ast_variable_retrieve(), load_order_entry::builtin, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEMISSING, done, find_resource(), LOG_ERROR, LOG_WARNING, ast_variable::name, ast_variable::next, order, load_order_entry::preload, load_order_entry::required, load_order_entry::resource, resource_name_baselen(), resource_name_match(), and ast_variable::value.

Referenced by load_modules().

{
   int res = -1;
   struct load_order_entry *order;
   struct ast_config *cfg;
   struct ast_variable *v;
   struct ast_flags config_flags = { 0 };

   cfg = ast_config_load2(AST_MODULE_CONFIG, "" /* core, can't reload */, config_flags);
   if (cfg == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEINVALID) {
      ast_log(LOG_WARNING, "'%s' invalid or missing.\n", AST_MODULE_CONFIG);

      return -1;
   }

   /* first, find all the modules we have been explicitly requested to load */
   for (v = ast_variable_browse(cfg, "modules"); v; v = v->next) {
      int required;
      int preload = 0;

      if (!strncasecmp(v->name, "preload", strlen("preload"))) {
         preload = 1;
         if (!strcasecmp(v->name, "preload")) {
            required = 0;
         } else if (!strcasecmp(v->name, "preload-require")) {
            required = 1;
         } else {
            ast_log(LOG_ERROR, "Unknown configuration option '%s'", v->name);
            goto done;
         }
      } else if (!strcasecmp(v->name, "load")) {
         required = 0;
      } else if (!strcasecmp(v->name, "require")) {
         required = 1;
      } else if (!strcasecmp(v->name, "noload") || !strcasecmp(v->name, "autoload")) {
         continue;
      } else {
         ast_log(LOG_ERROR, "Unknown configuration option '%s'", v->name);
         goto done;
      }

      if (required) {
         ast_debug(2, "Adding module to required list: %s (%s)\n", v->value, v->name);
      }

      if (!add_to_load_order(v->value, load_order, required, preload, 0)) {
         goto done;
      }
   }

   /* check if 'autoload' is on */
   if (ast_true(ast_variable_retrieve(cfg, "modules", "autoload"))) {
      /* if we are allowed to load dynamic modules, scan the directory for
         for all available modules and add them as well */
      DIR *dir = opendir(ast_config_AST_MODULE_DIR);
      struct dirent *dirent;

      if (dir) {
         while ((dirent = readdir(dir))) {
            int ld = strlen(dirent->d_name);

            /* Must end in .so to load it.  */

            if (ld < 4)
               continue;

            if (strcasecmp(dirent->d_name + ld - 3, ".so"))
               continue;

            /* if there is already a module by this name in the module_list,
               skip this file */
            if (find_resource(dirent->d_name, 0))
               continue;

            if (!add_to_load_order(dirent->d_name, load_order, 0, 0, 0)) {
               closedir(dir);
               goto done;
            }
         }

         closedir(dir);
      } else {
         ast_log(LOG_ERROR, "Unable to open modules directory '%s'.\n", ast_config_AST_MODULE_DIR);
         goto done;
      }
   }

   /* now scan the config for any modules we are prohibited from loading and
      remove them from the load order */
   for (v = ast_variable_browse(cfg, "modules"); v; v = v->next) {
      size_t baselen;

      if (strcasecmp(v->name, "noload")) {
         continue;
      }

      baselen = resource_name_baselen(v->value);
      AST_LIST_TRAVERSE_SAFE_BEGIN(load_order, order, entry) {
         if (!resource_name_match(v->value, baselen, order->resource)) {
            if (order->builtin) {
               ast_log(LOG_ERROR, "%s is a built-in module, you cannot specify 'noload'.\n", v->value);
               goto done;
            }

            if (order->required) {
               ast_log(LOG_ERROR, "%s is configured with '%s' and 'noload', this is impossible.\n",
                  v->value, order->preload ? "preload-require" : "require");
               goto done;
            }
            AST_LIST_REMOVE_CURRENT(entry);
            ast_free(order->resource);
            ast_free(order);
         }
      }
      AST_LIST_TRAVERSE_SAFE_END;
   }

   res = 0;
done:
   ast_config_destroy(cfg);

   return res;
}

loadresult2str()

static const char* loadresult2str ( enum ast_module_load_result  result )

static

Definition at line 1514 of file loader.c.

References ARRAY_LEN, ast_log, AST_MODULE_LOAD_UNKNOWN_STRING, LOG_WARNING, and load_results_map::name.

Referenced by publish_load_message().

{
   int i;
   for (i = 0; i < ARRAY_LEN(load_results); i++) {
      if (load_results[i].result == result) {
         return load_results[i].name;
      }
   }

   ast_log(LOG_WARNING, "Failed to find correct load result status. result %d\n", result);
   return AST_MODULE_LOAD_UNKNOWN_STRING;
}

logged_dlclose()

static void logged_dlclose ( const char *  name, void *  lib  )

static

dlclose(), with failure logging.

Definition at line 962 of file loader.c.

References ast_log, AST_LOG_ERROR, error(), and S_OR.

Referenced by is_module_loaded(), load_dlopen(), load_dynamic_module(), and unload_dynamic_module().

{
   char *error;

   if (!lib) {
      return;
   }

   /* Clear any existing error */
   dlerror();
   if (dlclose(lib)) {
      error = dlerror();
      ast_log(AST_LOG_ERROR, "Failure in dlclose for module '%s': %s\n",
         S_OR(name, "unknown"), S_OR(error, "Unknown error"));
#if defined(HAVE_PERMANENT_DLOPEN)
   } else {
      manual_mod_unreg(name);
#endif
   }
}

module_deps_missing_recursive()

static int module_deps_missing_recursive ( struct ast_module *  mod, struct module_vector *  missingdeps  )

static

Recursively find required dependencies that are not running.

Parameters

mod	Module to scan for dependencies.
missingdeps	Vector listing modules that must be started first.

Return values

0	All dependencies resolved.
-1	Failed to resolve some dependencies.

An error from this function usually means a required module is not even loaded. This function is safe from infinite recursion, but dependency loops are not reported as an error from here. On success missingdeps will contain a list of every module that needs to be running before this module can start. missingdeps is sorted by load priority so any missing dependencies can be started if needed.

Definition at line 566 of file loader.c.

References AST_VECTOR_ADD_SORTED, AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_GET_CMP, AST_VECTOR_INIT, AST_VECTOR_REMOVE, AST_VECTOR_SIZE, find_resource(), module_deps_reference(), and module_vector_cmp().

Referenced by resource_list_recursive_decline(), start_resource(), and start_resource_list().

{
   int i = 0;
   int res = -1;
   struct ast_vector_const_string localdeps;
   struct ast_module *dep;

   /*
    * localdeps stores a copy of all dependencies that mod could not reference.
    * First we discard modules that we've already found. We add all newly found
    * modules to the missingdeps vector then scan them recursively.  This will
    * ensure we quickly run out of stuff to do.
    */
   AST_VECTOR_INIT(&localdeps, 0);
   if (module_deps_reference(mod, &localdeps)) {
      goto clean_return;
   }

   while (i < AST_VECTOR_SIZE(&localdeps)) {
      dep = find_resource(AST_VECTOR_GET(&localdeps, i), 0);
      if (!dep) {
         goto clean_return;
      }

      if (AST_VECTOR_GET_CMP(missingdeps, dep, AST_VECTOR_ELEM_DEFAULT_CMP)) {
         /* Skip common dependency.  We have already searched it. */
         AST_VECTOR_REMOVE(&localdeps, i, 0);
      } else {
         /* missingdeps is the real list so keep it sorted. */
         if (AST_VECTOR_ADD_SORTED(missingdeps, dep, module_vector_cmp)) {
            goto clean_return;
         }
         i++;
      }
   }

   res = 0;
   for (i = 0; !res && i < AST_VECTOR_SIZE(&localdeps); i++) {
      dep = find_resource(AST_VECTOR_GET(&localdeps, i), 0);
      /* We've already confirmed dep is loaded in the first loop. */
      res = module_deps_missing_recursive(dep, missingdeps);
   }

clean_return:
   AST_VECTOR_FREE(&localdeps);

   return res;
}

module_deps_process_reqlist()

static int module_deps_process_reqlist ( struct ast_module *  mod, struct ast_vector_string *  vec, struct ast_vector_const_string *  missing, int  ref_enhancers, int  isoptional  )

static

Definition at line 485 of file loader.c.

References AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, find_resource(), ast_module::flags, module_reffed_deps_add(), module_reffed_deps_add_dep_enhancers(), and ast_module::running.

Referenced by module_deps_reference().

{
   int idx;

   for (idx = 0; idx < AST_VECTOR_SIZE(vec); idx++) {
      const char *depname = AST_VECTOR_GET(vec, idx);
      struct ast_module *dep = find_resource(depname, 0);

      if (!dep || !dep->flags.running) {
         if (isoptional && !dep) {
            continue;
         }

         if (missing && !AST_VECTOR_APPEND(missing, depname)) {
            continue;
         }

         return -1;
      }

      if (module_reffed_deps_add(mod, dep, missing)) {
         return -1;
      }

      if (ref_enhancers && module_reffed_deps_add_dep_enhancers(mod, dep, missing)) {
         return -1;
      }
   }

   return 0;
}

module_deps_reference()

static int module_deps_reference ( struct ast_module *  mod, struct ast_vector_const_string *  missing  )

static

Definition at line 534 of file loader.c.

References ast_module::enhances, module_deps_process_reqlist(), ast_module::optional_modules, and ast_module::requires.

Referenced by module_deps_missing_recursive(), start_resource(), start_resource_attempt(), and start_resource_list().

{
   int res = 0;

   /* Grab references to modules we enhance but not other enhancements. */
   res |= module_deps_process_reqlist(mod, &mod->enhances, missing, 0, 0);

   /* Grab references to modules we require plus enhancements. */
   res |= module_deps_process_reqlist(mod, &mod->requires, missing, 1, 0);

   /* Grab references to optional modules including enhancements. */
   res |= module_deps_process_reqlist(mod, &mod->optional_modules, missing, 1, 1);

   return res;
}

module_destroy()

static void module_destroy ( struct ast_module *  mod )

static

Definition at line 744 of file loader.c.

References ao2_cleanup, ast_free, AST_LIST_HEAD_DESTROY, ast_module_unref, ast_std_free(), AST_VECTOR_CALLBACK_VOID, AST_VECTOR_FREE, ast_module::builtin, ast_module::enhances, ast_module::flags, ast_module::optional_modules, ast_module::ref_debug, ast_module::reffed_deps, ast_module::requires, and ast_module::users.

Referenced by ast_module_unregister(), and modules_shutdown().

{
   AST_VECTOR_CALLBACK_VOID(&mod->requires, ast_free);
   AST_VECTOR_FREE(&mod->requires);

   AST_VECTOR_CALLBACK_VOID(&mod->optional_modules, ast_free);
   AST_VECTOR_FREE(&mod->optional_modules);

   AST_VECTOR_CALLBACK_VOID(&mod->enhances, ast_free);
   AST_VECTOR_FREE(&mod->enhances);

   /* Release references to all dependencies. */
   AST_VECTOR_CALLBACK_VOID(&mod->reffed_deps, ast_module_unref);
   AST_VECTOR_FREE(&mod->reffed_deps);

   AST_LIST_HEAD_DESTROY(&mod->users);
   ao2_cleanup(mod->ref_debug);
   if (mod->flags.builtin) {
      ast_std_free(mod);
   } else {
      ast_free(mod);
   }
}

module_load_error()

static void module_load_error ( const char *  fmt,   ...  )

static

Definition at line 269 of file loader.c.

References ast_free, ast_log, ast_log_ap(), ast_str_buffer(), ast_str_set_va(), ast_strdup, AST_VECTOR_APPEND, copy(), LOG_ERROR, NULL, and startup_errors.

Referenced by inspect_module(), load_dlopen(), load_resource(), load_resource_list(), resource_list_recursive_decline(), start_resource(), start_resource_attempt(), and start_resource_list().

{
   char *copy = NULL;
   va_list ap;

   va_start(ap, fmt);
   if (startup_error_builder) {
      ast_str_set_va(&startup_error_builder, 0, fmt, ap);
      copy = ast_strdup(ast_str_buffer(startup_error_builder));
      if (!copy || AST_VECTOR_APPEND(&startup_errors, copy)) {
         ast_log(LOG_ERROR, "%s", ast_str_buffer(startup_error_builder));
         ast_free(copy);
      }
   } else {
      ast_log_ap(LOG_ERROR, fmt, ap);
   }
   va_end(ap);
}

module_load_helper()

static void module_load_helper ( const char *  word )

static

Definition at line 1361 of file loader.c.

References ast_config_AST_MODULE_DIR, AST_DLLIST_LOCK, AST_DLLIST_UNLOCK, ast_file_read_dirs(), module_load_helper_on_file(), and module_load_word::word.

Referenced by ast_module_helper().

{
   struct module_load_word word_l = {
      .word = word,
      .len = strlen(word),
      .moddir_len = strlen(ast_config_AST_MODULE_DIR),
   };

   AST_DLLIST_LOCK(&module_list);
   ast_file_read_dirs(ast_config_AST_MODULE_DIR, module_load_helper_on_file, &word_l, -1);
   AST_DLLIST_UNLOCK(&module_list);
}

module_load_helper_on_file()

static int module_load_helper_on_file ( const char *  dir_name, const char *  filename, void *  obj  )

static

Definition at line 1329 of file loader.c.

References ast_asprintf, ast_assert, ast_cli_completion_add(), ast_free, ast_strdup, ast_strlen_zero, find_resource(), ast_module::flags, module_load_word::len, module_load_word::moddir_len, NULL, ast_module::running, and module_load_word::word.

Referenced by module_load_helper().

{
   struct module_load_word *word = obj;
   struct ast_module *mod;
   char *filename_merged = NULL;

   /* dir_name will never be shorter than word->moddir_len. */
   dir_name += word->moddir_len;
   if (!ast_strlen_zero(dir_name)) {
      ast_assert(dir_name[0] == '/');

      dir_name += 1;
      if (ast_asprintf(&filename_merged, "%s/%s", dir_name, filename) < 0) {
         /* If we can't allocate the string just give up! */
         return -1;
      }
      filename = filename_merged;
   }

   if (!strncasecmp(filename, word->word, word->len)) {
      /* Don't list files that are already loaded! */
      mod = find_resource(filename, 0);
      if (!mod || !mod->flags.running) {
         ast_cli_completion_add(ast_strdup(filename));
      }
   }

   ast_free(filename_merged);

   return 0;
}

module_matches_helper_type()

static int module_matches_helper_type ( struct ast_module *  mod, enum ast_module_helper_type  type  )

static

Definition at line 1299 of file loader.c.

References ast_assert, AST_MODULE_HELPER_LOADED, AST_MODULE_HELPER_RELOAD, AST_MODULE_HELPER_RUNNING, AST_MODULE_HELPER_UNLOAD, ast_module::declined, ast_module::flags, ast_module::info, ast_module_info::reload, ast_module::running, and ast_module::usecount.

Referenced by ast_module_helper().

{
   switch (type) {
   case AST_MODULE_HELPER_UNLOAD:
      return !mod->usecount && mod->flags.running && !mod->flags.declined;

   case AST_MODULE_HELPER_RELOAD:
      return mod->flags.running && mod->info->reload;

   case AST_MODULE_HELPER_RUNNING:
      return mod->flags.running;

   case AST_MODULE_HELPER_LOADED:
      /* if we have a 'struct ast_module' then we're loaded. */
      return 1;
   default:
      /* This function is not called for AST_MODULE_HELPER_LOAD. */
      /* Unknown ast_module_helper_type. Assume it doesn't match. */
      ast_assert(0);

      return 0;
   }
}

module_post_register()

static int module_post_register ( struct ast_module *  mod )

static

Definition at line 732 of file loader.c.

References ast_vector_string_split(), ast_module::enhances, ast_module_info::enhances, ast_module::info, ast_module::optional_modules, ast_module_info::optional_modules, ast_module::requires, and ast_module_info::requires.

Referenced by load_dlopen(), load_resource(), and loader_builtin_init().

{
   int res;

   /* Split lists from mod->info. */
   res  = ast_vector_string_split(&mod->requires, mod->info->requires, ",", 0, strcasecmp);
   res |= ast_vector_string_split(&mod->optional_modules, mod->info->optional_modules, ",", 0, strcasecmp);
   res |= ast_vector_string_split(&mod->enhances, mod->info->enhances, ",", 0, strcasecmp);

   return res;
}

module_reffed_deps_add()

static int module_reffed_deps_add ( struct ast_module *  mod, struct ast_module *  dep, struct ast_vector_const_string *  missing  )

static

Definition at line 416 of file loader.c.

References ast_module_ref, AST_VECTOR_APPEND, AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_GET_CMP, ast_module::flags, ast_module::info, ast_module_info::name, ast_module::reffed_deps, and ast_module::running.

Referenced by module_deps_process_reqlist(), and module_reffed_deps_add_dep_enhancers().

{
   if (!dep->flags.running) {
      return !missing ? -1 : AST_VECTOR_APPEND(missing, dep->info->name);
   }

   if (AST_VECTOR_GET_CMP(&mod->reffed_deps, dep, AST_VECTOR_ELEM_DEFAULT_CMP)) {
      /* Skip duplicate. */
      return 0;
   }

   if (AST_VECTOR_APPEND(&mod->reffed_deps, dep)) {
      return -1;
   }

   ast_module_ref(dep);

   return 0;
}

module_reffed_deps_add_dep_enhancers()

static int module_reffed_deps_add_dep_enhancers ( struct ast_module *  mod, struct ast_module *  dep, struct ast_vector_const_string *  missing  )

static

Definition at line 448 of file loader.c.

References AST_DLLIST_TRAVERSE, AST_VECTOR_GET_CMP, ast_module::declined, ast_module::enhances, ast_module::flags, ast_module::info, module_reffed_deps_add(), and ast_module_info::name.

Referenced by module_deps_process_reqlist().

{
   struct ast_module *cur;

   AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
      if (cur->flags.declined) {
         continue;
      }

      if (!AST_VECTOR_GET_CMP(&cur->enhances, dep->info->name, !strcasecmp)) {
         /* dep is not enhanced by cur. */
         continue;
      }

      /* dep is enhanced by cur, therefore mod requires cur. */
      if (module_reffed_deps_add(mod, cur, missing)) {
         return -1;
      }
   }

   return 0;
}

module_vector_cmp()

static int module_vector_cmp ( struct ast_module *  a, struct ast_module *  b  )

static

Definition at line 371 of file loader.c.

References AST_MODFLAG_LOAD_ORDER, AST_MODPRI_DEFAULT, ast_test_flag, find_resource(), ast_module::flags, ast_module::info, ast_module_info::load_pri, ast_module::preload, and ast_module::resource.

Referenced by load_resource(), and module_deps_missing_recursive().

{
   int preload_diff = (int)b->flags.preload - (int)a->flags.preload;
   /* if load_pri is not set, default is 128.  Lower is better */
   int a_pri = ast_test_flag(a->info, AST_MODFLAG_LOAD_ORDER)
      ? a->info->load_pri : AST_MODPRI_DEFAULT;
   int b_pri = ast_test_flag(b->info, AST_MODFLAG_LOAD_ORDER)
      ? b->info->load_pri : AST_MODPRI_DEFAULT;

   if (preload_diff) {
      /* -1 preload a but not b */
      /*  0 preload both or neither */
      /*  1 preload b but not a */
      return preload_diff;
   }

   /*
    * Returns comparison values for a vector sorted by priority.
    * <0 a_pri < b_pri
    * =0 a_pri == b_pri
    * >0 a_pri > b_pri
    */
   return a_pri - b_pri;
}

module_vector_strcasecmp()

static int module_vector_strcasecmp ( struct ast_module *  a, struct ast_module *  b  )

static

Definition at line 366 of file loader.c.

References ast_module::resource.

Referenced by alpha_module_list_create().

{
   return strcasecmp(a->resource, b->resource);
}

modules_shutdown()

int modules_shutdown

(

void

)

Provided by loader.c

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.

Definition at line 1182 of file loader.c.

References ast_debug, AST_DLLIST_EMPTY, AST_DLLIST_LOCK, AST_DLLIST_REMOVE_CURRENT, AST_DLLIST_TRAVERSE, AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN, AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END, AST_DLLIST_UNLOCK, ast_module_unref, ast_verb, ast_module::declined, ast_module::flags, ast_module::info, ast_module::keepuntilshutdown, module_destroy(), ast_module::resource, ast_module::running, ast_module_info::unload, and ast_module::usecount.

Referenced by really_quit().

{
   struct ast_module *mod;
   int somethingchanged;
   int res;

   AST_DLLIST_LOCK(&module_list);

   /*!\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. */
   do {
      /* Reset flag before traversing the list */
      somethingchanged = 0;

      AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN(&module_list, mod, entry) {
         if (mod->usecount) {
            ast_debug(1, "Passing on %s: its use count is %d\n",
               mod->resource, mod->usecount);
            continue;
         }
         AST_DLLIST_REMOVE_CURRENT(entry);
         if (mod->flags.running && !mod->flags.declined && mod->info->unload) {
            ast_verb(1, "Unloading %s\n", mod->resource);
            mod->info->unload();
         }
         module_destroy(mod);
         somethingchanged = 1;
      }
      AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END;
      if (!somethingchanged) {
         AST_DLLIST_TRAVERSE(&module_list, mod, entry) {
            if (mod->flags.keepuntilshutdown) {
               ast_module_unref(mod);
               mod->flags.keepuntilshutdown = 0;
               somethingchanged = 1;
            }
         }
      }
   } while (somethingchanged);

   res = AST_DLLIST_EMPTY(&module_list);
   AST_DLLIST_UNLOCK(&module_list);

   return !res;
}

printdigest()

static int printdigest ( const unsigned char *  d )

static

Definition at line 875 of file loader.c.

References ast_debug, and buf.

Referenced by verify_key().

{
   int x, pos;
   char buf[256]; /* large enough so we don't have to worry */

   for (pos = 0, x = 0; x < 16; x++)
      pos += sprintf(buf + pos, " %02hhx", *d++);

   ast_debug(1, "Unexpected signature:%s\n", buf);

   return 0;
}

publish_load_message()

static void publish_load_message ( const char *  name, enum ast_module_load_result  result  )

static

Definition at line 1531 of file loader.c.

References loadresult2str(), publish_load_message_type(), and status.

Referenced by load_resource().

{
   const char *status;

   status = loadresult2str(result);

   publish_load_message_type("Load", name, status);
}

publish_load_message_type()

static void publish_load_message_type ( const char *  type, const char *  name, const char *  status  )

static

Since

12

Definition at line 1475 of file loader.c.

References ao2_cleanup, ast_assert, ast_json_pack(), ast_json_payload_create(), ast_json_ref(), ast_json_unref(), ast_manager_get_generic_type(), ast_manager_get_topic(), ast_strlen_zero, EVENT_FLAG_SYSTEM, NULL, RAII_VAR, stasis_message_create(), and stasis_publish().

Referenced by publish_load_message(), publish_reload_message(), and publish_unload_message().

{
   RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
   RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
   RAII_VAR(struct ast_json *, json_object, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, event_object, NULL, ast_json_unref);

   ast_assert(type != NULL);
   ast_assert(!ast_strlen_zero(name));
   ast_assert(!ast_strlen_zero(status));

   if (!ast_manager_get_generic_type()) {
      return;
   }

   event_object = ast_json_pack("{s:s, s:s}",
         "Module", name,
         "Status", status);
   json_object = ast_json_pack("{s:s, s:i, s:o}",
         "type", type,
         "class_type", EVENT_FLAG_SYSTEM,
         "event", ast_json_ref(event_object));
   if (!json_object) {
      return;
   }

   payload = ast_json_payload_create(json_object);
   if (!payload) {
      return;
   }

   message = stasis_message_create(ast_manager_get_generic_type(), payload);
   if (!message) {
      return;
   }

   stasis_publish(ast_manager_get_topic(), message);
}

publish_reload_message()

static void publish_reload_message ( const char *  name, enum ast_module_reload_result  result  )

static

Since

12

Definition at line 1554 of file loader.c.

References publish_load_message_type(), and S_OR.

Referenced by ast_module_reload().

{
   char res_buffer[8];

   snprintf(res_buffer, sizeof(res_buffer), "%u", result);
   publish_load_message_type("Reload", S_OR(name, "All"), res_buffer);
}

publish_unload_message()

static void publish_unload_message ( const char *  name, const char *  status  )

static

Definition at line 1544 of file loader.c.

References publish_load_message_type().

Referenced by ast_unload_resource().

{
   publish_load_message_type("Unload", name, status);
}

queue_reload_request()

static void queue_reload_request ( const char *  module )

static

Definition at line 1432 of file loader.c.

References ast_calloc, ast_free, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log, ast_strlen_zero, item, LOG_ERROR, and reload_queue_item::module.

Referenced by ast_module_reload().

{
   struct reload_queue_item *item;

   AST_LIST_LOCK(&reload_queue);

   if (do_full_reload) {
      AST_LIST_UNLOCK(&reload_queue);
      return;
   }

   if (ast_strlen_zero(module)) {
      /* A full reload request (when module is NULL) wipes out any previous
         reload requests and causes the queue to ignore future ones */
      while ((item = AST_LIST_REMOVE_HEAD(&reload_queue, entry))) {
         ast_free(item);
      }
      do_full_reload = 1;
   } else {
      /* No reason to add the same module twice */
      AST_LIST_TRAVERSE(&reload_queue, item, entry) {
         if (!strcasecmp(item->module, module)) {
            AST_LIST_UNLOCK(&reload_queue);
            return;
         }
      }
      item = ast_calloc(1, sizeof(*item) + strlen(module) + 1);
      if (!item) {
         ast_log(LOG_ERROR, "Failed to allocate reload queue item.\n");
         AST_LIST_UNLOCK(&reload_queue);
         return;
      }
      strcpy(item->module, module);
      AST_LIST_INSERT_TAIL(&reload_queue, item, entry);
   }
   AST_LIST_UNLOCK(&reload_queue);
}

resource_list_recursive_decline()

static int resource_list_recursive_decline ( struct module_vector *  resources, struct ast_module *  mod, struct ast_str **  printmissing  )

static

Definition at line 1906 of file loader.c.

References ast_module_name(), ast_str_buffer(), ast_str_create, ast_str_reset(), AST_VECTOR_APPEND, AST_VECTOR_CALLBACK_VOID, AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_GET_CMP, AST_VECTOR_INIT, AST_VECTOR_RESET, AST_VECTOR_SIZE, ast_module::declined, ast_module::flags, module_deps_missing_recursive(), module_load_error(), ast_module::required, and STR_APPEND_TEXT.

Referenced by start_resource_list().

{
   struct module_vector missingdeps;
   struct ast_vector_const_string localdeps;
   int i = 0;
   int res = -1;

   mod->flags.declined = 1;
   if (mod->flags.required) {
      module_load_error("Required module %s declined to load.\n", ast_module_name(mod));

      return -2;
   }

   module_load_error("%s declined to load.\n", ast_module_name(mod));

   if (!*printmissing) {
      *printmissing = ast_str_create(64);
      if (!*printmissing) {
         return -1;
      }
   } else {
      ast_str_reset(*printmissing);
   }

   AST_VECTOR_INIT(&missingdeps, 0);
   AST_VECTOR_INIT(&localdeps, 0);

   /* Decline everything that depends on 'mod' from resources so we can
    * print a concise list. */
   while (res != -2 && i < AST_VECTOR_SIZE(resources)) {
      struct ast_module *dep = AST_VECTOR_GET(resources, i);
      i++;

      AST_VECTOR_RESET(&missingdeps, AST_VECTOR_ELEM_CLEANUP_NOOP);
      if (dep->flags.declined || module_deps_missing_recursive(dep, &missingdeps)) {
         continue;
      }

      if (AST_VECTOR_GET_CMP(&missingdeps, mod, AST_VECTOR_ELEM_DEFAULT_CMP)) {
         dep->flags.declined = 1;
         if (dep->flags.required) {
            module_load_error("Cannot load required module %s that depends on %s\n",
               ast_module_name(dep), ast_module_name(mod));
            res = -2;
         } else {
            AST_VECTOR_APPEND(&localdeps, ast_module_name(dep));
         }
      }
   }
   AST_VECTOR_FREE(&missingdeps);

   if (res != -2 && AST_VECTOR_SIZE(&localdeps)) {
      AST_VECTOR_CALLBACK_VOID(&localdeps, STR_APPEND_TEXT, printmissing);
      module_load_error("Declined modules which depend on %s: %s\n",
         ast_module_name(mod), ast_str_buffer(*printmissing));
   }
   AST_VECTOR_FREE(&localdeps);

   return res;
}

resource_name_baselen()

static size_t resource_name_baselen ( const char *  name )

static

Definition at line 917 of file loader.c.

References len().

Referenced by add_to_load_order(), ast_module_reload(), find_resource(), loader_config_init(), and resource_name_match().

{
   size_t len = strlen(name);

   if (len > 3 && !strcasecmp(name + len - 3, ".so")) {
      return len - 3;
   }

   return len;
}

resource_name_match()

static int resource_name_match ( const char *  name1, size_t  baselen1, const char *  name2  )

static

Definition at line 928 of file loader.c.

References resource_name_baselen().

Referenced by add_to_load_order(), ast_module_reload(), find_resource(), and loader_config_init().

{
   if (baselen1 != resource_name_baselen(name2)) {
      return -1;
   }

   return strncasecmp(name1, name2, baselen1);
}

start_resource()

static enum ast_module_load_result start_resource ( struct ast_module *  mod )

static

Definition at line 1678 of file loader.c.

References AST_DLLIST_INSERT_TAIL, AST_DLLIST_LOCK, AST_DLLIST_REMOVE, AST_DLLIST_UNLOCK, ast_fully_booted, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_PRIORITY, AST_MODULE_LOAD_SKIP, AST_MODULE_LOAD_SUCCESS, ast_module_shutdown_ref, ast_update_use_count(), AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, ast_verb, ast_module::builtin, COLOR_BLACK, COLOR_BROWN, ast_module::declined, ast_module_info::description, ast_module::flags, ast_module::info, ast_module_info::load, module_deps_missing_recursive(), module_deps_reference(), module_load_error(), ast_module_info::name, NULL, ast_module::required, ast_module::resource, ast_module::running, term_color(), and tmp().

Referenced by load_resource(), and start_resource_attempt().

{
   char tmp[256];
   enum ast_module_load_result res;

   if (mod->flags.running) {
      return AST_MODULE_LOAD_SUCCESS;
   }

   if (!mod->info->load) {
      mod->flags.declined = 1;

      return mod->flags.required ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_DECLINE;
   }

   if (module_deps_reference(mod, NULL)) {
      struct module_vector missing;
      int i;

      AST_VECTOR_INIT(&missing, 0);
      if (module_deps_missing_recursive(mod, &missing)) {
         module_load_error("%s has one or more unknown dependencies.\n", mod->info->name);
      }
      for (i = 0; i < AST_VECTOR_SIZE(&missing); i++) {
         module_load_error("%s loaded before dependency %s!\n", mod->info->name,
            AST_VECTOR_GET(&missing, i)->info->name);
      }
      AST_VECTOR_FREE(&missing);

      return AST_MODULE_LOAD_DECLINE;
   }

   if (!ast_fully_booted) {
      ast_verb(1, "Loading %s.\n", mod->resource);
   }
   res = mod->info->load();

   switch (res) {
   case AST_MODULE_LOAD_SUCCESS:
      if (!ast_fully_booted) {
         ast_verb(2, "%s => (%s)\n", mod->resource, term_color(tmp, mod->info->description, COLOR_BROWN, COLOR_BLACK, sizeof(tmp)));
      } else {
         ast_verb(1, "Loaded %s => (%s)\n", mod->resource, mod->info->description);
      }

      mod->flags.running = 1;
      if (mod->flags.builtin) {
         /* Built-in modules cannot be unloaded. */
         ast_module_shutdown_ref(mod);
      }

      ast_update_use_count();
      break;
   case AST_MODULE_LOAD_DECLINE:
      mod->flags.declined = 1;
      if (mod->flags.required) {
         res = AST_MODULE_LOAD_FAILURE;
      }
      break;
   case AST_MODULE_LOAD_FAILURE:
      mod->flags.declined = 1;
      break;
   case AST_MODULE_LOAD_SKIP: /* modules should never return this value */
   case AST_MODULE_LOAD_PRIORITY:
      break;
   }

   /* Make sure the newly started module is at the end of the list */
   AST_DLLIST_LOCK(&module_list);
   AST_DLLIST_REMOVE(&module_list, mod, entry);
   AST_DLLIST_INSERT_TAIL(&module_list, mod, entry);
   AST_DLLIST_UNLOCK(&module_list);

   return res;
}

start_resource_attempt()

static enum ast_module_load_result start_resource_attempt ( struct ast_module *  mod, int *  count  )

static

Definition at line 1878 of file loader.c.

References ast_debug, AST_MODFLAG_LOAD_ORDER, AST_MODPRI_DEFAULT, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SKIP, AST_MODULE_LOAD_SUCCESS, ast_test_flag, ast_module::flags, ast_module::info, ast_module_info::load_pri, module_deps_reference(), module_load_error(), NULL, ast_module::required, ast_module::resource, and start_resource().

Referenced by start_resource_list().

{
   enum ast_module_load_result lres;

   /* Try to grab required references. */
   if (module_deps_reference(mod, NULL)) {
      /* We're likely to retry so not an error. */
      ast_debug(1, "Module %s is missing dependencies\n", mod->resource);
      return AST_MODULE_LOAD_SKIP;
   }

   lres = start_resource(mod);
   ast_debug(3, "START: %-46s[%d] %d\n",
      mod->resource,
      ast_test_flag(mod->info, AST_MODFLAG_LOAD_ORDER) ? mod->info->load_pri : AST_MODPRI_DEFAULT,
      lres);

   if (lres == AST_MODULE_LOAD_SUCCESS) {
      (*count)++;
   } else if (lres == AST_MODULE_LOAD_FAILURE) {
      module_load_error("*** Failed to load %smodule %s\n",
         mod->flags.required ? "required " : "",
         mod->resource);
   }

   return lres;
}

start_resource_list()

static int start_resource_list ( struct module_vector *  resources, int *  mod_count  )

static

Definition at line 1969 of file loader.c.

References ast_debug, ast_free, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, ast_module_name(), ast_str_buffer(), ast_str_create, ast_str_reset(), AST_VECTOR_CALLBACK_VOID, AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_REMOVE, AST_VECTOR_REMOVE_CMP_ORDERED, AST_VECTOR_RESET, AST_VECTOR_SIZE, ast_module::declined, ast_module::flags, module_deps_missing_recursive(), module_deps_reference(), module_load_error(), NULL, resource_list_recursive_decline(), start_resource_attempt(), and STR_APPEND_TEXT.

Referenced by load_resource_list().

{
   struct module_vector missingdeps;
   int res = 0;
   struct ast_str *printmissing = NULL;

   AST_VECTOR_INIT(&missingdeps, 0);
   while (res != -2 && AST_VECTOR_SIZE(resources)) {
      struct ast_module *mod = AST_VECTOR_REMOVE(resources, 0, 1);
      enum ast_module_load_result lres;

      if (mod->flags.declined) {
         ast_debug(1, "%s is already declined, skipping\n", ast_module_name(mod));
         continue;
      }

retry_load:
      lres = start_resource_attempt(mod, mod_count);
      if (lres == AST_MODULE_LOAD_SUCCESS) {
         /* No missing dependencies, successful. */
         continue;
      }

      if (lres == AST_MODULE_LOAD_FAILURE) {
         res = -2;
         break;
      }

      if (lres == AST_MODULE_LOAD_DECLINE) {
         res = resource_list_recursive_decline(resources, mod, &printmissing);
         continue;
      }

      if (module_deps_missing_recursive(mod, &missingdeps)) {
         AST_VECTOR_RESET(&missingdeps, AST_VECTOR_ELEM_CLEANUP_NOOP);
         module_load_error("Failed to resolve dependencies for %s\n", ast_module_name(mod));
         res = resource_list_recursive_decline(resources, mod, &printmissing);
         continue;
      }

      if (!AST_VECTOR_SIZE(&missingdeps)) {
         module_load_error("%s load function returned an invalid result. "
            "This is a bug in the module.\n", ast_module_name(mod));
         /* Dependencies were met but the module failed to start and the result
          * code was not AST_MODULE_LOAD_FAILURE or AST_MODULE_LOAD_DECLINE. */
         res = resource_list_recursive_decline(resources, mod, &printmissing);
         continue;
      }

      ast_debug(1, "%s has %d dependencies\n",
         ast_module_name(mod), (int)AST_VECTOR_SIZE(&missingdeps));
      while (AST_VECTOR_SIZE(&missingdeps)) {
         int didwork = 0;
         int i = 0;

         while (i < AST_VECTOR_SIZE(&missingdeps)) {
            struct ast_module *dep = AST_VECTOR_GET(&missingdeps, i);

            if (dep->flags.declined) {
               ast_debug(1, "%s tried to start %s but it's already declined\n",
                  ast_module_name(mod), ast_module_name(dep));
               i++;
               continue;
            }

            ast_debug(1, "%s trying to start %s\n", ast_module_name(mod), ast_module_name(dep));
            lres = start_resource_attempt(dep, mod_count);
            if (lres == AST_MODULE_LOAD_SUCCESS) {
               ast_debug(1, "%s started %s\n", ast_module_name(mod), ast_module_name(dep));
               AST_VECTOR_REMOVE(&missingdeps, i, 1);
               AST_VECTOR_REMOVE_CMP_ORDERED(resources, dep,
                  AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_ELEM_CLEANUP_NOOP);
               didwork++;
               continue;
            }

            if (lres == AST_MODULE_LOAD_FAILURE) {
               module_load_error("Failed to load %s.\n", ast_module_name(dep));
               res = -2;
               goto exitpoint;
            }

            ast_debug(1, "%s failed to start %s\n", ast_module_name(mod), ast_module_name(dep));
            i++;
         }

         if (!didwork) {
            break;
         }
      }

      if (AST_VECTOR_SIZE(&missingdeps)) {
         if (!printmissing) {
            printmissing = ast_str_create(64);
         } else {
            ast_str_reset(printmissing);
         }

         if (printmissing) {
            struct ast_vector_const_string localdeps;

            AST_VECTOR_INIT(&localdeps, 0);
            module_deps_reference(mod, &localdeps);
            AST_VECTOR_CALLBACK_VOID(&localdeps, STR_APPEND_TEXT, &printmissing);
            AST_VECTOR_FREE(&localdeps);
         }

         module_load_error("Failed to load %s due to dependencies: %s.\n",
            ast_module_name(mod),
            printmissing ? ast_str_buffer(printmissing) : "allocation failure creating list");
         res = resource_list_recursive_decline(resources, mod, &printmissing);

         AST_VECTOR_RESET(&missingdeps, AST_VECTOR_ELEM_CLEANUP_NOOP);

         continue;
      }

      /* If we're here it means that we started with missingdeps and they're all loaded
       * now.  It's impossible to reach this point a second time for the same module. */
      goto retry_load;
   }

exitpoint:
   ast_free(printmissing);
   AST_VECTOR_FREE(&missingdeps);

   return res;
}

unload_dynamic_module()

static void unload_dynamic_module ( struct ast_module *  mod )

static

Definition at line 1010 of file loader.c.

References ast_log, ast_module_name(), ast_strdupa, is_module_loaded(), ast_module::lib, LOG_WARNING, logged_dlclose(), and name.

Referenced by ast_unload_resource(), load_dlopen(), and load_resource().

{
#if defined(HAVE_RTLD_NOLOAD)
   char *name = ast_strdupa(ast_module_name(mod));
#endif
   void *lib = mod->lib;

   /* WARNING: the structure pointed to by mod is going to
      disappear when this operation succeeds, so we can't
      dereference it */
   logged_dlclose(ast_module_name(mod), lib);

   /* There are several situations where the module might still be resident
    * in memory.
    *
    * If somehow there was another dlopen() on the same module (unlikely,
    * since that all is supposed to happen in loader.c).
    *
    * Avoid the temptation of repeating the dlclose(). The other code that
    * dlopened the module still has its module reference, and should close
    * it itself. In other situations, dlclose() will happily return success
    * for as many times as you wish to call it.
    */
#if defined(HAVE_RTLD_NOLOAD)
   if (is_module_loaded(name)) {
      ast_log(LOG_WARNING, "Module '%s' could not be completely unloaded\n", name);
   }
#endif
}

verify_key()

static int verify_key ( const unsigned char *  key )

static

Definition at line 900 of file loader.c.

References expected_key, key_matches(), MD5Final(), MD5Init(), MD5Update(), and printdigest().

Referenced by inspect_module().

{
   struct MD5Context c;
   unsigned char digest[16];

   MD5Init(&c);
   MD5Update(&c, key, strlen((char *)key));
   MD5Final(digest, &c);

   if (key_matches(expected_key, digest))
      return 0;

   printdigest(digest);

   return -1;
}

Variable Documentation

buildopt_sum

char buildopt_sum[33] = AST_BUILDOPT_SUM

static

Definition at line 138 of file loader.c.

Referenced by inspect_module().

builtin_module_list

struct module_list builtin_module_list

static

Definition at line 364 of file loader.c.

Referenced by ast_module_register(), and loader_builtin_init().

do_full_reload

int do_full_reload = 0

static

Definition at line 638 of file loader.c.

expected_key

const unsigned char expected_key[]

static

Initial value:

=
{ 0x87, 0x76, 0x79, 0x35, 0x23, 0xea, 0x3a, 0xd3,
  0x25, 0x2a, 0xbb, 0x35, 0x87, 0xe4, 0x22, 0x24 }

Definition at line 134 of file loader.c.

Referenced by verify_key().

load_results

const struct load_results_map load_results[]

static

Definition at line 344 of file loader.c.

loader_ready

unsigned int loader_ready

static

Definition at line 150 of file loader.c.

Referenced by ast_module_register(), and loader_builtin_init().

module_list

struct module_list module_list = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }

static

modules_loaded

int modules_loaded

static

Internal flag to indicate all modules have been initially loaded.

Definition at line 291 of file loader.c.

reload_queue

struct reload_queue reload_queue = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }

static

reloadlock

ast_mutex_t reloadlock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }

static

Definition at line 631 of file loader.c.

Referenced by ast_module_reload().

resource_being_loaded

struct ast_module* volatile resource_being_loaded

static

Definition at line 650 of file loader.c.

Referenced by ast_module_register().

startup_error_builder

struct ast_str* startup_error_builder

static

Definition at line 154 of file loader.c.

startup_errors

struct ast_vector_string startup_errors

static

String container for deferring output of startup errors.

Definition at line 153 of file loader.c.

Referenced by load_modules(), and module_load_error().

support_level_map

const char* support_level_map[]

Definition at line 2748 of file loader.c.

updaters

struct updaters updaters = { .first = NULL, .last = NULL, .lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} } , }

static