remove remaining Zaptel references in various places
[asterisk/asterisk.git] / main / loader.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Kevin P. Fleming <kpfleming@digium.com>
8  * Luigi Rizzo <rizzo@icir.org>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief Module Loader
24  * \author Mark Spencer <markster@digium.com>
25  * \author Kevin P. Fleming <kpfleming@digium.com>
26  * \author Luigi Rizzo <rizzo@icir.org>
27  * - See ModMngMnt
28  */
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/_private.h"
35 #include "asterisk/paths.h"     /* use ast_config_AST_MODULE_DIR */
36 #include <dirent.h>
37
38 #include "asterisk/linkedlists.h"
39 #include "asterisk/module.h"
40 #include "asterisk/config.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/term.h"
43 #include "asterisk/manager.h"
44 #include "asterisk/cdr.h"
45 #include "asterisk/enum.h"
46 #include "asterisk/rtp.h"
47 #include "asterisk/http.h"
48 #include "asterisk/lock.h"
49 #include "asterisk/features.h"
50 #include "asterisk/dsp.h"
51 #include "asterisk/udptl.h"
52
53 #include <dlfcn.h>
54
55 #include "asterisk/md5.h"
56 #include "asterisk/utils.h"
57
58 #ifndef RTLD_NOW
59 #define RTLD_NOW 0
60 #endif
61
62 #ifndef RTLD_LOCAL
63 #define RTLD_LOCAL 0
64 #endif
65
66 struct ast_module_user {
67         struct ast_channel *chan;
68         AST_LIST_ENTRY(ast_module_user) entry;
69 };
70
71 AST_LIST_HEAD(module_user_list, ast_module_user);
72
73 static unsigned char expected_key[] =
74 { 0x87, 0x76, 0x79, 0x35, 0x23, 0xea, 0x3a, 0xd3,
75   0x25, 0x2a, 0xbb, 0x35, 0x87, 0xe4, 0x22, 0x24 };
76
77 static char buildopt_sum[33] = AST_BUILDOPT_SUM;
78
79 static unsigned int embedding = 1; /* we always start out by registering embedded modules,
80                                       since they are here before we dlopen() any
81                                    */
82
83 struct ast_module {
84         const struct ast_module_info *info;
85         void *lib;                                      /* the shared lib, or NULL if embedded */
86         int usecount;                                   /* the number of 'users' currently in this module */
87         struct module_user_list users;                  /* the list of users in the module */
88         struct {
89                 unsigned int running:1;
90                 unsigned int declined:1;
91         } flags;
92         AST_LIST_ENTRY(ast_module) entry;
93         char resource[0];
94 };
95
96 static AST_LIST_HEAD_STATIC(module_list, ast_module);
97
98 /*
99  * module_list is cleared by its constructor possibly after
100  * we start accumulating embedded modules, so we need to
101  * use another list (without the lock) to accumulate them.
102  * Then we update the main list when embedding is done.
103  */
104 static struct module_list embedded_module_list;
105
106 struct loadupdate {
107         int (*updater)(void);
108         AST_LIST_ENTRY(loadupdate) entry;
109 };
110
111 static AST_LIST_HEAD_STATIC(updaters, loadupdate);
112
113 AST_MUTEX_DEFINE_STATIC(reloadlock);
114
115 /* when dynamic modules are being loaded, ast_module_register() will
116    need to know what filename the module was loaded from while it
117    is being registered
118 */
119 struct ast_module *resource_being_loaded;
120
121 /* XXX: should we check for duplicate resource names here? */
122
123 void ast_module_register(const struct ast_module_info *info)
124 {
125         struct ast_module *mod;
126
127         if (embedding) {
128                 if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1)))
129                         return;
130                 strcpy(mod->resource, info->name);
131         } else {
132                 mod = resource_being_loaded;
133         }
134
135         mod->info = info;
136         AST_LIST_HEAD_INIT(&mod->users);
137
138         /* during startup, before the loader has been initialized,
139            there are no threads, so there is no need to take the lock
140            on this list to manipulate it. it is also possible that it
141            might be unsafe to use the list lock at that point... so
142            let's avoid it altogether
143         */
144         if (embedding) {
145                 AST_LIST_INSERT_TAIL(&embedded_module_list, mod, entry);
146         } else {
147                 AST_LIST_LOCK(&module_list);
148                 /* it is paramount that the new entry be placed at the tail of
149                    the list, otherwise the code that uses dlopen() to load
150                    dynamic modules won't be able to find out if the module it
151                    just opened was registered or failed to load
152                 */
153                 AST_LIST_INSERT_TAIL(&module_list, mod, entry);
154                 AST_LIST_UNLOCK(&module_list);
155         }
156
157         /* give the module a copy of its own handle, for later use in registrations and the like */
158         *((struct ast_module **) &(info->self)) = mod;
159 }
160
161 void ast_module_unregister(const struct ast_module_info *info)
162 {
163         struct ast_module *mod = NULL;
164
165         /* it is assumed that the users list in the module structure
166            will already be empty, or we cannot have gotten to this
167            point
168         */
169         AST_LIST_LOCK(&module_list);
170         AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
171                 if (mod->info == info) {
172                         AST_LIST_REMOVE_CURRENT(entry);
173                         break;
174                 }
175         }
176         AST_LIST_TRAVERSE_SAFE_END;
177         AST_LIST_UNLOCK(&module_list);
178
179         if (mod) {
180                 AST_LIST_HEAD_DESTROY(&mod->users);
181                 ast_free(mod);
182         }
183 }
184
185 struct ast_module_user *__ast_module_user_add(struct ast_module *mod,
186                                               struct ast_channel *chan)
187 {
188         struct ast_module_user *u = ast_calloc(1, sizeof(*u));
189
190         if (!u)
191                 return NULL;
192
193         u->chan = chan;
194
195         AST_LIST_LOCK(&mod->users);
196         AST_LIST_INSERT_HEAD(&mod->users, u, entry);
197         AST_LIST_UNLOCK(&mod->users);
198
199         ast_atomic_fetchadd_int(&mod->usecount, +1);
200
201         ast_update_use_count();
202
203         return u;
204 }
205
206 void __ast_module_user_remove(struct ast_module *mod, struct ast_module_user *u)
207 {
208         AST_LIST_LOCK(&mod->users);
209         AST_LIST_REMOVE(&mod->users, u, entry);
210         AST_LIST_UNLOCK(&mod->users);
211         ast_atomic_fetchadd_int(&mod->usecount, -1);
212         ast_free(u);
213
214         ast_update_use_count();
215 }
216
217 void __ast_module_user_hangup_all(struct ast_module *mod)
218 {
219         struct ast_module_user *u;
220
221         AST_LIST_LOCK(&mod->users);
222         while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
223                 ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
224                 ast_atomic_fetchadd_int(&mod->usecount, -1);
225                 ast_free(u);
226         }
227         AST_LIST_UNLOCK(&mod->users);
228
229         ast_update_use_count();
230 }
231
232 /*! \note
233  * In addition to modules, the reload command handles some extra keywords
234  * which are listed here together with the corresponding handlers.
235  * This table is also used by the command completion code.
236  */
237 static struct reload_classes {
238         const char *name;
239         int (*reload_fn)(void);
240 } reload_classes[] = {  /* list in alpha order, longest match first for cli completion */
241         { "cdr",        ast_cdr_engine_reload },
242         { "dnsmgr",     dnsmgr_reload },
243         { "extconfig",  read_config_maps },
244         { "enum",       ast_enum_reload },
245         { "manager",    reload_manager },
246         { "rtp",        ast_rtp_reload },
247         { "http",       ast_http_reload },
248         { "logger",     logger_reload },
249         { "features",   ast_features_reload },
250         { "dsp",        ast_dsp_reload},
251         { "udptl",      ast_udptl_reload },
252         { NULL,         NULL }
253 };
254
255 static int printdigest(const unsigned char *d)
256 {
257         int x, pos;
258         char buf[256]; /* large enough so we don't have to worry */
259
260         for (pos = 0, x = 0; x < 16; x++)
261                 pos += sprintf(buf + pos, " %02x", *d++);
262
263         ast_debug(1, "Unexpected signature:%s\n", buf);
264
265         return 0;
266 }
267
268 static int key_matches(const unsigned char *key1, const unsigned char *key2)
269 {
270         int x;
271
272         for (x = 0; x < 16; x++) {
273                 if (key1[x] != key2[x])
274                         return 0;
275         }
276
277         return 1;
278 }
279
280 static int verify_key(const unsigned char *key)
281 {
282         struct MD5Context c;
283         unsigned char digest[16];
284
285         MD5Init(&c);
286         MD5Update(&c, key, strlen((char *)key));
287         MD5Final(digest, &c);
288
289         if (key_matches(expected_key, digest))
290                 return 0;
291
292         printdigest(digest);
293
294         return -1;
295 }
296
297 static int resource_name_match(const char *name1_in, const char *name2_in)
298 {
299         char *name1 = (char *) name1_in;
300         char *name2 = (char *) name2_in;
301
302         /* trim off any .so extensions */
303         if (!strcasecmp(name1 + strlen(name1) - 3, ".so")) {
304                 name1 = ast_strdupa(name1);
305                 name1[strlen(name1) - 3] = '\0';
306         }
307         if (!strcasecmp(name2 + strlen(name2) - 3, ".so")) {
308                 name2 = ast_strdupa(name2);
309                 name2[strlen(name2) - 3] = '\0';
310         }
311
312         return strcasecmp(name1, name2);
313 }
314
315 static struct ast_module *find_resource(const char *resource, int do_lock)
316 {
317         struct ast_module *cur;
318
319         if (do_lock)
320                 AST_LIST_LOCK(&module_list);
321
322         AST_LIST_TRAVERSE(&module_list, cur, entry) {
323                 if (!resource_name_match(resource, cur->resource))
324                         break;
325         }
326
327         if (do_lock)
328                 AST_LIST_UNLOCK(&module_list);
329
330         return cur;
331 }
332
333 #ifdef LOADABLE_MODULES
334 static void unload_dynamic_module(struct ast_module *mod)
335 {
336         void *lib = mod->lib;
337
338         /* WARNING: the structure pointed to by mod is going to
339            disappear when this operation succeeds, so we can't
340            dereference it */
341
342         if (lib)
343                 while (!dlclose(lib));
344 }
345
346 static struct ast_module *load_dynamic_module(const char *resource_in, unsigned int global_symbols_only)
347 {
348         char fn[PATH_MAX] = "";
349         void *lib = NULL;
350         struct ast_module *mod;
351         unsigned int wants_global;
352         int space;      /* room needed for the descriptor */
353         int missing_so = 0;
354
355         space = sizeof(*resource_being_loaded) + strlen(resource_in) + 1;
356         if (strcasecmp(resource_in + strlen(resource_in) - 3, ".so")) {
357                 missing_so = 1;
358                 space += 3;     /* room for the extra ".so" */
359         }
360
361         snprintf(fn, sizeof(fn), "%s/%s%s", ast_config_AST_MODULE_DIR, resource_in, missing_so ? ".so" : "");
362
363         /* make a first load of the module in 'quiet' mode... don't try to resolve
364            any symbols, and don't export any symbols. this will allow us to peek into
365            the module's info block (if available) to see what flags it has set */
366
367         resource_being_loaded = ast_calloc(1, space);
368         if (!resource_being_loaded)
369                 return NULL;
370         strcpy(resource_being_loaded->resource, resource_in);
371         if (missing_so)
372                 strcat(resource_being_loaded->resource, ".so");
373
374         if (!(lib = dlopen(fn, RTLD_LAZY | RTLD_LOCAL))) {
375                 ast_log(LOG_WARNING, "Error loading module '%s': %s\n", resource_in, dlerror());
376                 ast_free(resource_being_loaded);
377                 return NULL;
378         }
379
380         /* the dlopen() succeeded, let's find out if the module
381            registered itself */
382         /* note that this will only work properly as long as
383            ast_module_register() (which is called by the module's
384            constructor) places the new module at the tail of the
385            module_list
386         */
387         if (resource_being_loaded != (mod = AST_LIST_LAST(&module_list))) {
388                 ast_log(LOG_WARNING, "Module '%s' did not register itself during load\n", resource_in);
389                 /* no, it did not, so close it and return */
390                 while (!dlclose(lib));
391                 /* note that the module's destructor will call ast_module_unregister(),
392                    which will free the structure we allocated in resource_being_loaded */
393                 return NULL;
394         }
395
396         wants_global = ast_test_flag(mod->info, AST_MODFLAG_GLOBAL_SYMBOLS);
397
398         /* if we are being asked only to load modules that provide global symbols,
399            and this one does not, then close it and return */
400         if (global_symbols_only && !wants_global) {
401                 while (!dlclose(lib));
402                 return NULL;
403         }
404
405         /* if the system supports RTLD_NOLOAD, we can just 'promote' the flags
406            on the already-opened library to what we want... if not, we have to
407            close it and start over
408         */
409 #if defined(HAVE_RTLD_NOLOAD) && !defined(__Darwin__)
410         if (!dlopen(fn, RTLD_NOLOAD | (wants_global ? RTLD_LAZY | RTLD_GLOBAL : RTLD_NOW | RTLD_LOCAL))) {
411                 ast_log(LOG_WARNING, "Unable to promote flags on module '%s': %s\n", resource_in, dlerror());
412                 while (!dlclose(lib));
413                 ast_free(resource_being_loaded);
414                 return NULL;
415         }
416 #else
417         while (!dlclose(lib));
418         resource_being_loaded = NULL;
419
420         /* start the load process again */
421         resource_being_loaded = ast_calloc(1, space);
422         if (!resource_being_loaded)
423                 return NULL;
424         strcpy(resource_being_loaded->resource, resource_in);
425         if (missing_so)
426                 strcat(resource_being_loaded->resource, ".so");
427
428         if (!(lib = dlopen(fn, wants_global ? RTLD_LAZY | RTLD_GLOBAL : RTLD_NOW | RTLD_LOCAL))) {
429                 ast_log(LOG_WARNING, "Error loading module '%s': %s\n", resource_in, dlerror());
430                 ast_free(resource_being_loaded);
431                 return NULL;
432         }
433
434         /* since the module was successfully opened, and it registered itself
435            the previous time we did that, we're going to assume it worked this
436            time too :) */
437 #endif
438
439         AST_LIST_LAST(&module_list)->lib = lib;
440         resource_being_loaded = NULL;
441
442         return AST_LIST_LAST(&module_list);
443 }
444 #endif
445
446 void ast_module_shutdown(void)
447 {
448         struct ast_module *mod;
449         AST_LIST_HEAD_NOLOCK_STATIC(local_module_list, ast_module);
450
451         /* We have to call the unload() callbacks in reverse order that the modules
452          * exist in the module list so it is the reverse order of how they were
453          * loaded. */
454
455         AST_LIST_LOCK(&module_list);
456         while ((mod = AST_LIST_REMOVE_HEAD(&module_list, entry)))
457                 AST_LIST_INSERT_HEAD(&local_module_list, mod, entry);
458         AST_LIST_UNLOCK(&module_list);
459
460         while ((mod = AST_LIST_REMOVE_HEAD(&local_module_list, entry))) {
461                 if (mod->info->unload)
462                         mod->info->unload();
463                 /* Since this should only be called when shutting down "gracefully",
464                  * all channels should be down before we get to this point, meaning
465                  * there will be no module users left. */
466                 AST_LIST_HEAD_DESTROY(&mod->users);
467                 free(mod);
468         }
469 }
470
471 int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode force)
472 {
473         struct ast_module *mod;
474         int res = -1;
475         int error = 0;
476
477         AST_LIST_LOCK(&module_list);
478
479         if (!(mod = find_resource(resource_name, 0))) {
480                 AST_LIST_UNLOCK(&module_list);
481                 ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
482                 return 0;
483         }
484
485         if (!(mod->flags.running || mod->flags.declined))
486                 error = 1;
487
488         if (!error && (mod->usecount > 0)) {
489                 if (force)
490                         ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
491                                 resource_name, mod->usecount);
492                 else {
493                         ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
494                                 mod->usecount);
495                         error = 1;
496                 }
497         }
498
499         if (!error) {
500                 __ast_module_user_hangup_all(mod);
501                 res = mod->info->unload();
502
503                 if (res) {
504                         ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
505                         if (force <= AST_FORCE_FIRM)
506                                 error = 1;
507                         else
508                                 ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
509                 }
510         }
511
512         if (!error)
513                 mod->flags.running = mod->flags.declined = 0;
514
515         AST_LIST_UNLOCK(&module_list);
516
517         if (!error && !mod->lib && mod->info && mod->info->restore_globals)
518                 mod->info->restore_globals();
519
520 #ifdef LOADABLE_MODULES
521         if (!error)
522                 unload_dynamic_module(mod);
523 #endif
524
525         if (!error)
526                 ast_update_use_count();
527
528         return res;
529 }
530
531 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload)
532 {
533         struct ast_module *cur;
534         int i, which=0, l = strlen(word);
535         char *ret = NULL;
536
537         if (pos != rpos)
538                 return NULL;
539
540         AST_LIST_LOCK(&module_list);
541         AST_LIST_TRAVERSE(&module_list, cur, entry) {
542                 if (!strncasecmp(word, cur->resource, l) &&
543                     (cur->info->reload || !needsreload) &&
544                     ++which > state) {
545                         ret = ast_strdup(cur->resource);
546                         break;
547                 }
548         }
549         AST_LIST_UNLOCK(&module_list);
550
551         if (!ret) {
552                 for (i=0; !ret && reload_classes[i].name; i++) {
553                         if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
554                                 ret = ast_strdup(reload_classes[i].name);
555                 }
556         }
557
558         return ret;
559 }
560
561 int ast_module_reload(const char *name)
562 {
563         struct ast_module *cur;
564         int res = 0; /* return value. 0 = not found, others, see below */
565         int i;
566
567         if (ast_mutex_trylock(&reloadlock)) {
568                 ast_verbose("The previous reload command didn't finish yet\n");
569                 return -1;      /* reload already in progress */
570         }
571         ast_lastreloadtime = ast_tvnow();
572
573         /* Call "predefined" reload here first */
574         for (i = 0; reload_classes[i].name; i++) {
575                 if (!name || !strcasecmp(name, reload_classes[i].name)) {
576                         reload_classes[i].reload_fn();  /* XXX should check error ? */
577                         res = 2;        /* found and reloaded */
578                 }
579         }
580
581         if (name && res) {
582                 ast_mutex_unlock(&reloadlock);
583                 return res;
584         }
585
586         AST_LIST_LOCK(&module_list);
587         AST_LIST_TRAVERSE(&module_list, cur, entry) {
588                 const struct ast_module_info *info = cur->info;
589
590                 if (name && resource_name_match(name, cur->resource))
591                         continue;
592
593                 if (!cur->flags.running || cur->flags.declined) {
594                         if (!name)
595                                 continue;
596                         ast_log(LOG_NOTICE, "The module '%s' was not properly initialized.  "
597                                 "Before reloading the module, you must run \"module load %s\" "
598                                 "and fix whatever is preventing the module from being initialized.\n",
599                                 name, name);
600                         res = 2; /* Don't report that the module was not found */
601                         break;
602                 }
603
604                 if (!info->reload) {    /* cannot be reloaded */
605                         if (res < 1)    /* store result if possible */
606                                 res = 1;        /* 1 = no reload() method */
607                         continue;
608                 }
609
610                 res = 2;
611                 ast_verb(3, "Reloading module '%s' (%s)\n", cur->resource, info->description);
612                 info->reload();
613         }
614         AST_LIST_UNLOCK(&module_list);
615
616         ast_mutex_unlock(&reloadlock);
617
618         return res;
619 }
620
621 static unsigned int inspect_module(const struct ast_module *mod)
622 {
623         if (!mod->info->description) {
624                 ast_log(LOG_WARNING, "Module '%s' does not provide a description.\n", mod->resource);
625                 return 1;
626         }
627
628         if (!mod->info->key) {
629                 ast_log(LOG_WARNING, "Module '%s' does not provide a license key.\n", mod->resource);
630                 return 1;
631         }
632
633         if (verify_key((unsigned char *) mod->info->key)) {
634                 ast_log(LOG_WARNING, "Module '%s' did not provide a valid license key.\n", mod->resource);
635                 return 1;
636         }
637
638         if (!ast_strlen_zero(mod->info->buildopt_sum) &&
639             strcmp(buildopt_sum, mod->info->buildopt_sum)) {
640                 ast_log(LOG_WARNING, "Module '%s' was not compiled with the same compile-time options as this version of Asterisk.\n", mod->resource);
641                 ast_log(LOG_WARNING, "Module '%s' will not be initialized as it may cause instability.\n", mod->resource);
642                 return 1;
643         }
644
645         return 0;
646 }
647
648 static enum ast_module_load_result load_resource(const char *resource_name, unsigned int global_symbols_only)
649 {
650         struct ast_module *mod;
651         enum ast_module_load_result res = AST_MODULE_LOAD_SUCCESS;
652         char tmp[256];
653
654         if ((mod = find_resource(resource_name, 0))) {
655                 if (mod->flags.running) {
656                         ast_log(LOG_WARNING, "Module '%s' already exists.\n", resource_name);
657                         return AST_MODULE_LOAD_DECLINE;
658                 }
659                 if (global_symbols_only && !ast_test_flag(mod->info, AST_MODFLAG_GLOBAL_SYMBOLS))
660                         return AST_MODULE_LOAD_SKIP;
661         } else {
662 #ifdef LOADABLE_MODULES
663                 if (!(mod = load_dynamic_module(resource_name, global_symbols_only))) {
664                         /* don't generate a warning message during load_modules() */
665                         if (!global_symbols_only) {
666                                 ast_log(LOG_WARNING, "Module '%s' could not be loaded.\n", resource_name);
667                                 return AST_MODULE_LOAD_DECLINE;
668                         } else {
669                                 return AST_MODULE_LOAD_SKIP;
670                         }
671                 }
672 #else
673                 ast_log(LOG_WARNING, "Module '%s' could not be loaded.\n", resource_name);
674                 return AST_MODULE_LOAD_DECLINE;
675 #endif
676         }
677
678         if (inspect_module(mod)) {
679                 ast_log(LOG_WARNING, "Module '%s' could not be loaded.\n", resource_name);
680 #ifdef LOADABLE_MODULES
681                 unload_dynamic_module(mod);
682 #endif
683                 return AST_MODULE_LOAD_DECLINE;
684         }
685
686         if (!mod->lib && mod->info->backup_globals()) {
687                 ast_log(LOG_WARNING, "Module '%s' was unable to backup its global data.\n", resource_name);
688                 return AST_MODULE_LOAD_DECLINE;
689         }
690
691         mod->flags.declined = 0;
692
693         if (mod->info->load)
694                 res = mod->info->load();
695
696         switch (res) {
697         case AST_MODULE_LOAD_SUCCESS:
698                 if (!ast_fully_booted) {
699                         ast_verb(1, "%s => (%s)\n", resource_name, term_color(tmp, mod->info->description, COLOR_BROWN, COLOR_BLACK, sizeof(tmp)));
700                         if (ast_opt_console && !option_verbose)
701                                 ast_verbose( ".");
702                 } else {
703                         ast_verb(1, "Loaded %s => (%s)\n", resource_name, mod->info->description);
704                 }
705
706                 mod->flags.running = 1;
707
708                 ast_update_use_count();
709                 break;
710         case AST_MODULE_LOAD_DECLINE:
711                 mod->flags.declined = 1;
712                 break;
713         case AST_MODULE_LOAD_FAILURE:
714                 break;
715         case AST_MODULE_LOAD_SKIP:
716                 /* modules should never return this value */
717                 break;
718         }
719
720         return res;
721 }
722
723 int ast_load_resource(const char *resource_name)
724 {
725         int res;
726         AST_LIST_LOCK(&module_list);
727         res = load_resource(resource_name, 0);
728         AST_LIST_UNLOCK(&module_list);
729
730         return res;
731 }
732
733 struct load_order_entry {
734         char *resource;
735         AST_LIST_ENTRY(load_order_entry) entry;
736 };
737
738 AST_LIST_HEAD_NOLOCK(load_order, load_order_entry);
739
740 static struct load_order_entry *add_to_load_order(const char *resource, struct load_order *load_order)
741 {
742         struct load_order_entry *order;
743
744         AST_LIST_TRAVERSE(load_order, order, entry) {
745                 if (!resource_name_match(order->resource, resource))
746                         return NULL;
747         }
748
749         if (!(order = ast_calloc(1, sizeof(*order))))
750                 return NULL;
751
752         order->resource = ast_strdup(resource);
753         AST_LIST_INSERT_TAIL(load_order, order, entry);
754
755         return order;
756 }
757
758 int load_modules(unsigned int preload_only)
759 {
760         struct ast_config *cfg;
761         struct ast_module *mod;
762         struct load_order_entry *order;
763         struct ast_variable *v;
764         unsigned int load_count;
765         struct load_order load_order;
766         int res = 0;
767         struct ast_flags config_flags = { 0 };
768         int modulecount = 0;
769
770 #ifdef LOADABLE_MODULES
771         struct dirent *dirent;
772         DIR *dir;
773 #endif
774
775         /* all embedded modules have registered themselves by now */
776         embedding = 0;
777
778         ast_verb(1, "Asterisk Dynamic Loader Starting:\n");
779
780         AST_LIST_HEAD_INIT_NOLOCK(&load_order);
781
782         AST_LIST_LOCK(&module_list);
783
784         if (embedded_module_list.first) {
785                 module_list.first = embedded_module_list.first;
786                 module_list.last = embedded_module_list.last;
787                 embedded_module_list.first = NULL;
788         }
789
790         if (!(cfg = ast_config_load2(AST_MODULE_CONFIG, "" /* core, can't reload */, config_flags))) {
791                 ast_log(LOG_WARNING, "No '%s' found, no modules will be loaded.\n", AST_MODULE_CONFIG);
792                 goto done;
793         }
794
795         /* first, find all the modules we have been explicitly requested to load */
796         for (v = ast_variable_browse(cfg, "modules"); v; v = v->next) {
797                 if (!strcasecmp(v->name, preload_only ? "preload" : "load")) {
798                         add_to_load_order(v->value, &load_order);
799                 }
800         }
801
802         /* check if 'autoload' is on */
803         if (!preload_only && ast_true(ast_variable_retrieve(cfg, "modules", "autoload"))) {
804                 /* if so, first add all the embedded modules that are not already running to the load order */
805                 AST_LIST_TRAVERSE(&module_list, mod, entry) {
806                         /* if it's not embedded, skip it */
807                         if (mod->lib)
808                                 continue;
809
810                         if (mod->flags.running)
811                                 continue;
812
813                         order = add_to_load_order(mod->resource, &load_order);
814                 }
815
816 #ifdef LOADABLE_MODULES
817                 /* if we are allowed to load dynamic modules, scan the directory for
818                    for all available modules and add them as well */
819                 if ((dir  = opendir(ast_config_AST_MODULE_DIR))) {
820                         while ((dirent = readdir(dir))) {
821                                 int ld = strlen(dirent->d_name);
822
823                                 /* Must end in .so to load it.  */
824
825                                 if (ld < 4)
826                                         continue;
827
828                                 if (strcasecmp(dirent->d_name + ld - 3, ".so"))
829                                         continue;
830
831                                 /* if there is already a module by this name in the module_list,
832                                    skip this file */
833                                 if (find_resource(dirent->d_name, 0))
834                                         continue;
835
836                                 add_to_load_order(dirent->d_name, &load_order);
837                         }
838
839                         closedir(dir);
840                 } else {
841                         if (!ast_opt_quiet)
842                                 ast_log(LOG_WARNING, "Unable to open modules directory '%s'.\n",
843                                         ast_config_AST_MODULE_DIR);
844                 }
845 #endif
846         }
847
848         /* now scan the config for any modules we are prohibited from loading and
849            remove them from the load order */
850         for (v = ast_variable_browse(cfg, "modules"); v; v = v->next) {
851                 if (strcasecmp(v->name, "noload"))
852                         continue;
853
854                 AST_LIST_TRAVERSE_SAFE_BEGIN(&load_order, order, entry) {
855                         if (!resource_name_match(order->resource, v->value)) {
856                                 AST_LIST_REMOVE_CURRENT(entry);
857                                 ast_free(order->resource);
858                                 ast_free(order);
859                         }
860                 }
861                 AST_LIST_TRAVERSE_SAFE_END;
862         }
863
864         /* we are done with the config now, all the information we need is in the
865            load_order list */
866         ast_config_destroy(cfg);
867
868         load_count = 0;
869         AST_LIST_TRAVERSE(&load_order, order, entry)
870                 load_count++;
871
872         if (load_count)
873                 ast_log(LOG_NOTICE, "%d modules will be loaded.\n", load_count);
874
875         /* first, load only modules that provide global symbols */
876         AST_LIST_TRAVERSE_SAFE_BEGIN(&load_order, order, entry) {
877                 switch (load_resource(order->resource, 1)) {
878                 case AST_MODULE_LOAD_SUCCESS:
879                         modulecount++;
880                 case AST_MODULE_LOAD_DECLINE:
881                         AST_LIST_REMOVE_CURRENT(entry);
882                         ast_free(order->resource);
883                         ast_free(order);
884                         break;
885                 case AST_MODULE_LOAD_FAILURE:
886                         res = -1;
887                         goto done;
888                 case AST_MODULE_LOAD_SKIP:
889                         /* try again later */
890                         break;
891                 }
892         }
893         AST_LIST_TRAVERSE_SAFE_END;
894
895         /* now load everything else */
896         AST_LIST_TRAVERSE_SAFE_BEGIN(&load_order, order, entry) {
897                 switch (load_resource(order->resource, 0)) {
898                 case AST_MODULE_LOAD_SUCCESS:
899                         modulecount++;
900                 case AST_MODULE_LOAD_DECLINE:
901                         AST_LIST_REMOVE_CURRENT(entry);
902                         ast_free(order->resource);
903                         ast_free(order);
904                         break;
905                 case AST_MODULE_LOAD_FAILURE:
906                         res = -1;
907                         goto done;
908                 case AST_MODULE_LOAD_SKIP:
909                         /* should not happen */
910                         break;
911                 }
912         }
913         AST_LIST_TRAVERSE_SAFE_END;
914
915 done:
916         while ((order = AST_LIST_REMOVE_HEAD(&load_order, entry))) {
917                 ast_free(order->resource);
918                 ast_free(order);
919         }
920
921         AST_LIST_UNLOCK(&module_list);
922         
923         /* Tell manager clients that are aggressive at logging in that we're done
924            loading modules. If there's a DNS problem in chan_sip, we might not
925            even reach this */
926         manager_event(EVENT_FLAG_SYSTEM, "ModuleLoadReport", "ModuleLoadStatus: Done\r\nModuleSelection: %s\r\nModuleCount: %d\r\n", preload_only ? "Preload" : "All", modulecount);
927         
928         return res;
929 }
930
931 void ast_update_use_count(void)
932 {
933         /* Notify any module monitors that the use count for a
934            resource has changed */
935         struct loadupdate *m;
936
937         AST_LIST_LOCK(&updaters);
938         AST_LIST_TRAVERSE(&updaters, m, entry)
939                 m->updater();
940         AST_LIST_UNLOCK(&updaters);
941 }
942
943 int ast_update_module_list(int (*modentry)(const char *module, const char *description, int usecnt, const char *like),
944                            const char *like)
945 {
946         struct ast_module *cur;
947         int unlock = -1;
948         int total_mod_loaded = 0;
949
950         if (AST_LIST_TRYLOCK(&module_list))
951                 unlock = 0;
952  
953         AST_LIST_TRAVERSE(&module_list, cur, entry) {
954                 total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
955         }
956
957         if (unlock)
958                 AST_LIST_UNLOCK(&module_list);
959
960         return total_mod_loaded;
961 }
962
963 /*! \brief Check if module exists */
964 int ast_module_check(const char *name)
965 {
966         struct ast_module *cur;
967
968         if (ast_strlen_zero(name))
969                 return 0;       /* FALSE */
970
971         cur = find_resource(name, 1);
972
973         return (cur != NULL);
974 }
975
976
977 int ast_loader_register(int (*v)(void))
978 {
979         struct loadupdate *tmp;
980
981         if (!(tmp = ast_malloc(sizeof(*tmp))))
982                 return -1;
983
984         tmp->updater = v;
985         AST_LIST_LOCK(&updaters);
986         AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
987         AST_LIST_UNLOCK(&updaters);
988
989         return 0;
990 }
991
992 int ast_loader_unregister(int (*v)(void))
993 {
994         struct loadupdate *cur;
995
996         AST_LIST_LOCK(&updaters);
997         AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
998                 if (cur->updater == v)  {
999                         AST_LIST_REMOVE_CURRENT(entry);
1000                         break;
1001                 }
1002         }
1003         AST_LIST_TRAVERSE_SAFE_END;
1004         AST_LIST_UNLOCK(&updaters);
1005
1006         return cur ? 0 : -1;
1007 }
1008
1009 struct ast_module *ast_module_ref(struct ast_module *mod)
1010 {
1011         ast_atomic_fetchadd_int(&mod->usecount, +1);
1012         ast_update_use_count();
1013
1014         return mod;
1015 }
1016
1017 void ast_module_unref(struct ast_module *mod)
1018 {
1019         ast_atomic_fetchadd_int(&mod->usecount, -1);
1020         ast_update_use_count();
1021 }