80d0b579391761e931bf9fa44c259428bc224efc
[asterisk/asterisk.git] / include / asterisk / module.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Asterisk module definitions.
21  *
22  * This file contains the definitons for functions Asterisk modules should
23  * provide and some other module related functions.
24  */
25
26 #ifndef _ASTERISK_MODULE_H
27 #define _ASTERISK_MODULE_H
28
29 #include "asterisk/linkedlists.h"       /* XXX needed here */
30
31 #include "asterisk/utils.h"
32
33 #if defined(__cplusplus) || defined(c_plusplus)
34 extern "C" {
35 #endif
36
37 #ifdef STATIC_MODULE    /* symbols are static */
38 #define _HAVE_STATIC_MODULE
39 #undef STATIC_MODULE
40 #define STATIC_MODULE   static /* symbols are static */
41 #else   /* !STATIC_MODULE, symbols are global */
42 #define STATIC_MODULE   /* empty - symbols are global */
43
44 /*! \note Every module should provide these functions */
45 /*! 
46  * \brief Initialize the module.
47  * 
48  * This function is called at module load time.  Put all code in here
49  * that needs to set up your module's hardware, software, registrations,
50  * etc.
51  *
52  * \return This function should return 0 on success and non-zero on failure.
53  * If the module is not loaded successfully, Asterisk will call its
54  * unload_module() function.
55  */
56 int load_module(void);
57
58 /*! 
59  * \brief Cleanup all module structures, sockets, etc.
60  *
61  * This is called at exit.  Any registrations and memory allocations need to be
62  * unregistered and free'd here.  Nothing else will do these for you (until
63  * exit).
64  *
65  * \return Zero on success, or non-zero on error.
66  */
67 int unload_module(void);
68
69 /*! 
70  * \brief Provides a usecount.
71  *
72  * This function will be called by various parts of asterisk.  Basically, all
73  * it has to do is to return a usecount when called.  You will need to maintain
74  * your usecount within the module somewhere.  The usecount should be how many
75  * channels provided by this module are in use.
76  *
77  * \return The module's usecount.
78  */
79 int usecount(void);             /* How many channels provided by this module are in use? */
80
81 /*! \brief Provides a description of the module.
82  *
83  * \return a short description of your module
84  */
85 const char *description(void);          /* Description of this module */
86
87 /*! 
88  * \brief Returns the ASTERISK_GPL_KEY
89  *
90  * This returns the ASTERISK_GPL_KEY, signifiying that you agree to the terms of
91  * the GPL stated in the ASTERISK_GPL_KEY.  Your module will not load if it does
92  * not return the EXACT message:
93  *
94  * \code
95  * char *key(void) {
96  *         return ASTERISK_GPL_KEY;
97  * }
98  * \endcode
99  *
100  * \return ASTERISK_GPL_KEY
101  */
102 const char *key(void);          /* Return the below mentioned key, unmodified */
103
104 /*! 
105  * \brief Reload stuff.
106  *
107  * This function is where any reload routines take place.  Re-read config files,
108  * change signalling, whatever is appropriate on a reload.
109  *
110  * \return The return value is not used.
111  */
112 int reload(void);               /* reload configs */
113 #endif  /* !STATIC_MODULE case */
114
115 /*! \brief The text the key() function should return. */
116 #define ASTERISK_GPL_KEY \
117 "This paragraph is copyright (c) 2006 by Digium, Inc. \
118 In order for your module to load, it must return this \
119 key via a function called \"key\".  Any code which \
120 includes this paragraph must be licensed under the GNU \
121 General Public License version 2 or later (at your \
122 option).  In addition to Digium's general reservations \
123 of rights, Digium expressly reserves the right to \
124 allow other parties to license this paragraph under \
125 different terms. Any use of Digium, Inc. trademarks or \
126 logos (including \"Asterisk\" or \"Digium\") without \
127 express written permission of Digium, Inc. is prohibited.\n"
128
129 #define AST_MODULE_CONFIG "modules.conf" /*!< \brief Module configuration file */
130
131 /*! 
132  * \brief Softly unload a module.
133  *
134  * This flag signals ast_unload_resource() to unload a module only if it is not
135  * in use, according to the module's usecount.
136  */
137 #define AST_FORCE_SOFT 0
138
139 /*! 
140  * \brief Firmly unload a module.
141  *
142  * This flag signals ast_unload_resource() to attempt to unload a module even
143  * if it is in use.  It will attempt to use the module's unload_module
144  * function.
145  */
146 #define AST_FORCE_FIRM 1
147
148 /*! 
149  * \brief Unconditionally unload a module.
150  *
151  * This flag signals ast_unload_resource() to first attempt to unload a module
152  * using the module's unload_module function, then if that fails to unload the
153  * module using dlclose.  The module will be unloaded even if it is still in
154  * use.  Use of this flag is not recommended.
155  */
156 #define AST_FORCE_HARD 2
157
158 /*! 
159  * \brief Load a module.
160  * \param resource_name The filename of the module to load.
161  *
162  * This function is run by the PBX to load the modules.  It performs
163  * all loading and initilization tasks.   Basically, to load a module, just
164  * give it the name of the module and it will do the rest.
165  *
166  * \return Zero on success, -1 on error.
167  */
168 int ast_load_resource(const char *resource_name);
169
170 /*! 
171  * \brief Unloads a module.
172  * \param resource_name The name of the module to unload.
173  * \param force The force flag.  This should be set using one of the AST_FORCE*
174  *        flags.
175  *
176  * This function unloads a module.  It will only unload modules that are not in
177  * use (usecount not zero), unless #AST_FORCE_FIRM or #AST_FORCE_HARD is 
178  * specified.  Setting #AST_FORCE_FIRM or #AST_FORCE_HARD will unload the
179  * module regardless of consequences (NOT_RECOMMENDED).
180  *
181  * \return Zero on success, -1 on error.
182  */
183 int ast_unload_resource(const char *resource_name, int force);
184
185 /*! 
186  * \brief Notify when usecount has been changed.
187  *
188  * This function calulates use counts and notifies anyone trying to keep track
189  * of them.  It should be called whenever your module's usecount changes.
190  *
191  * \note The LOCAL_USER macros take care of calling this function for you.
192  */
193 void ast_update_use_count(void);
194
195 /*! 
196  * \brief Ask for a list of modules, descriptions, and use counts.
197  * \param modentry A callback to an updater function.
198  * \param like
199  *
200  * For each of the modules loaded, modentry will be executed with the resource,
201  * description, and usecount values of each particular module.
202  * 
203  * \return the number of modules loaded
204  */
205 int ast_update_module_list(int (*modentry)(const char *module, const char *description, int usecnt, const char *like),
206                            const char *like);
207
208 /*! 
209  * \brief Add a procedure to be run when modules have been updated.
210  * \param updater The function to run when modules have been updated.
211  *
212  * This function adds the given function to a linked list of functions to be
213  * run when the modules are updated. 
214  *
215  * \return Zero on success and -1 on failure.
216  */
217 int ast_loader_register(int (*updater)(void));
218
219 /*! 
220  * \brief Remove a procedure to be run when modules are updated.
221  * \param updater The updater function to unregister.
222  *
223  * This removes the given function from the updater list.
224  * 
225  * \return Zero on success, -1 on failure.
226  */
227 int ast_loader_unregister(int (*updater)(void));
228
229 /*! 
230  * \brief Reload asterisk modules.
231  * \param name the name of the module to reload
232  *
233  * This function reloads the specified module, or if no modules are specified,
234  * it will reload all loaded modules.
235  *
236  * \note Modules are reloaded using their reload() functions, not unloading
237  * them and loading them again.
238  *
239  * \return Zero if the specified module was not found, 1 if the module was
240  * found but cannot be reloaded, -1 if a reload operation is already in
241  * progress, and 2 if the specfied module was found and reloaded.
242  */
243 int ast_module_reload(const char *name);
244
245 /*! 
246  * \brief Match modules names for the Asterisk cli.
247  * \param line Unused by this function, but this should be the line we are
248  *        matching.
249  * \param word The partial name to match. 
250  * \param pos The position the word we are completing is in.
251  * \param state The possible match to return.
252  * \param rpos The position we should be matching.  This should be the same as
253  *        pos.
254  * \param needsreload This should be 1 if we need to reload this module and 0
255  *        otherwise.  This function will only return modules that are reloadble
256  *        if this is 1.
257  *
258  * \return A possible completion of the partial match, or NULL if no matches
259  * were found.
260  */
261 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload);
262
263 /*!
264  * \brief Given a function address, find the corresponding module.
265  * This is required as a workaround to the fact that we do not
266  * have a module argument to the load_module() function.
267  * Hopefully the performance implications are small.
268  */
269 struct module *ast_find_module(int (*load_fn)(void));
270
271 /* Local user routines keep track of which channels are using a given module
272    resource.  They can help make removing modules safer, particularly if
273    they're in use at the time they have been requested to be removed */
274
275 struct localuser {
276         struct ast_channel *chan;
277         AST_LIST_ENTRY(localuser) next;
278 };
279
280 /*! \brief structure used for lock and refcount of module users.
281  * \note The mutex protects the usecnt field and whatever needs to be
282  * protected (typically, a list of struct localuser).
283  * As a trick, if usecnt is initialized with -1,
284  * ast_format_register will init the mutex for you.
285  */
286 struct ast_module_lock {
287         ast_mutex_t lock;
288         AST_LIST_HEAD_NOLOCK(localuser_head, localuser) u;
289         int usecnt;     /* number of active clients */
290 };
291
292 struct localuser *ast_localuser_add(struct ast_module_lock *m, struct ast_channel *chan);
293 void ast_localuser_remove(struct ast_module_lock *m, struct localuser *u);
294 void ast_hangup_localusers(struct ast_module_lock *m);
295
296 /*! 
297  * \brief create a localuser mutex and several other variables used for keeping the
298  * use count.
299  *
300  * <b>Sample Usage:</b>
301  * \code
302  * LOCAL_USER_DECL;
303  * \endcode
304  */
305 #define LOCAL_USER_DECL                                 \
306         static struct ast_module_lock me = {            \
307                 .u = AST_LIST_HEAD_NOLOCK_INIT_VALUE,   \
308                 .usecnt = 0,                            \
309                 .lock = AST_MUTEX_INIT_VALUE }
310
311 #define STANDARD_USECOUNT_DECL LOCAL_USER_DECL  /* XXX lock remains unused */
312
313 /*! \brief run 'x' protected by lock, then call ast_update_use_count() */
314 #define __MOD_PROTECT(x) do {                   \
315         ast_mutex_lock(&me.lock);               \
316         x;                                      \
317         ast_mutex_unlock(&me.lock);             \
318         ast_update_use_count();                 \
319         } while (0)
320
321 #define STANDARD_INCREMENT_USECOUNT __MOD_PROTECT(me.usecnt++)
322 #define STANDARD_DECREMENT_USECOUNT __MOD_PROTECT(me.usecnt--)
323
324 /*! 
325  * \brief Add a localuser.
326  * \param u a pointer to a localuser struct
327  *
328  * This macro adds a localuser to the list of users and increments the
329  * usecount.  It expects a variable named \p chan of type \p ast_channel in the
330  * current scope.
331  *
332  * \note This function dynamically allocates memory.  If this operation fails
333  * it will cause your function to return -1 to the caller.
334  */
335 #define LOCAL_USER_ADD(u) do {                  \
336         u = ast_localuser_add(&me, chan);       \
337         if (!u)                                 \
338                 return -1;                      \
339         } while (0)
340
341 /*! 
342  * \brief Remove a localuser.
343  * \param u the user to add, should be of type struct localuser
344  *
345  * This macro removes a localuser from the list of users and decrements the
346  * usecount.
347  */
348 #define LOCAL_USER_REMOVE(u) ast_localuser_remove(&me, u)
349
350 /*! 
351  * \brief Hangup all localusers.
352  *
353  * This macro hangs up on all current localusers and sets the usecount to zero
354  * when finished.
355  */
356 #define STANDARD_HANGUP_LOCALUSERS ast_hangup_localusers(&me)
357
358 /*!
359  * \brief Set the specfied integer to the current usecount.
360  * \param res the integer variable to set.
361  *
362  * This macro sets the specfied integer variable to the local usecount.
363  *
364  * <b>Sample Usage:</b>
365  * \code
366  * int usecount(void)
367  * {
368  *    int res;
369  *    STANDARD_USECOUNT(res);
370  *    return res;
371  * }
372  * \endcode
373  */
374 #define STANDARD_USECOUNT(res) do { res = me.usecnt; } while (0)
375
376 /*! \brief Old usecount macro
377  * \note XXX The following macro is deprecated, and only used by modules
378  * in codecs/ and a few other places which do their own manipulation
379  * of the usecount variable.
380  * Its use is supposed to be gradually phased away as those modules
381  * are updated to use the standard mechanism.
382  */
383 #define OLD_STANDARD_USECOUNT(res) do { res = localusecnt; } while (0)
384
385 /*! \page ModMngmnt The Asterisk Module management interface
386  * \par The following is part of the new module management code.
387  *
388  * All modules must implement the module API (load, unload...)
389  * whose functions are exported through fields of a "struct module_symbol";
390  *
391  * Modules exporting extra symbols (data or functions), should list
392  * them into an array of struct symbol_entry: \r
393  *     struct symbol_entry exported_symbols[]
394  * \r
395  * of symbols, with a NULL name on the last entry
396  *
397  * Functions should be added with MOD_FUNC(name),
398  * data structures with MOD_DATA(_name).
399  * The array in turn is referenced by struct module_symbol.
400  * (Typically, a module will export only a single symbol, which points
401  * to a record containing all the methods. This is the API of the module,
402  * and should be known to the module's clients as well.
403  *
404  * \par Connections to symbols in other modules
405  * Modules that require symbols supplied by other modules should
406  * provide an array
407  *     struct symbol_entry required_symbols[]
408  * of symbols, with a NULL name on the last entry, containing the
409  * name of the desired symbol.
410  * For good measure, we also provide the size in both caller and calle
411  * to figure out if there is a mismatch (not terribly useful because most
412  * objects are a single word, but still... )
413  * The symbol can be added to the array with MOD_WANT(symbol) macro.
414  * required_symbols is also pointed by through struct module_symbol.
415  *
416  * Typically, the whole interface exported by a module should be
417  * in a single structure named after the module, as follows.
418  * Say the module high level name is 'foo', then we should have
419  * - in include/asterisk/foo.h
420  *     struct foo_interface {
421  *              int (*f)(int, char *); -- first function exported 
422  *              const char (*g)(int); -- second function exported 
423  *              char *buf;
424  *              ...             -- other fields
425  *     }
426  * - in the module exporting the interface, e.g. res/res_foo.c
427  *      static int f(int, char *);
428  *      static const char *g(int);
429  *      const char buf[BUFSZ];
430  *     struct foo_interface foo = {
431  *      .f = f,
432  *      .g = g,
433  *      .buf = buf,
434  *     }
435  *
436  * \note NOTE: symbol names are 'global' in this module namespace, so it
437  * will be wiser to name exported symbols with a prefix indicating the module
438  * supplying it, e.g. foo_f, foo_g, foo_buf. Internally to the module,
439  * symbols are still static so they can keep short and meaningful names.
440  * The macros MOD_FIELD and METHOD_BASE() below help setting these entries.
441  *
442  *      MOD_FIELD(f1),          -- field and function name are the same
443  *      METHOD_BASE(foo_, f1),  -- field and function name differ by a prefix
444  *      .f1 = function_name,    -- generic case
445  *     }
446  *
447  * Note that the loader requires that no fields of exported_symbols
448  * are NULL, because that is used as an indication of the end of the array.
449  *
450  * \par Module states
451  * Modules can be in a number of different states, as below:
452  * - \b MS_FAILED    attempt to load failed. This is final.
453  * - \b MS_NEW       just added to the list, symbols unresolved.
454  * - \b MS_RESOLVED  all symbols resolved, but supplier modules not active yet.
455  * - \b MS_CANLOAD   all symbols resolved and suppliers are all active
456  *              (or we are in a cyclic dependency and we are breaking a loop)
457  * - \b MS_ACTIVE    load() returned successfully.
458  *
459  * 
460  * \par Module Types
461  * For backward compatibility, we have 3 types of loadable modules:
462  *
463  * - \b MOD_0 these are the 'old style' modules, which export a number
464  *       of callbacks, and their full interface, as globally visible
465  *       symbols. The module needs to be loaded with RTLD_LAZY and
466  *       RTLD_GLOBAL to make symbols visible to other modules, and
467  *       to avoid load failures due to cross dependencies.
468  *
469  * - \b MOD_1 almost as above, but the generic callbacks are all into a
470  *       a structure, mod_data. Same load requirements as above.
471  *
472  * - \b MOD_2 this is the 'new style' format for modules. The module must
473  *       explictly declare which simbols are exported and which
474  *       symbols from other modules are used, and the code in this
475  *       loader will implement appropriate checks to load the modules
476  *       in the correct order. Also this allows to load modules
477  *       with RTLD_NOW and RTLD_LOCAL so there is no chance of run-time
478  *       bugs due to unresolved symbols or name conflicts.
479  */
480
481 struct symbol_entry {
482         const char *name;
483         void *value;
484         int size;
485         struct module *src;     /* module sourcing it, filled by loader */
486 };
487
488 /*
489  * Constructors for symbol_entry values
490  */
491 #define MOD_FUNC(f)     { .name = #f, .value = f, .size = sizeof(f) }
492 #define MOD_DATA(d)     { .name = #d, .value = &d, .size = sizeof(_name) }
493 #define MOD_WANT(s)     { .name = #s, .value = &s, 0 }   /* required symbols */
494
495 /*
496  * Constructors for fields of foo_interface
497  */
498 #define MOD_FIELD(f)    . ## f = f
499 #define METHOD_BASE(_base, _name)       . ## _name = _base ## _name
500
501 /*
502  * Each 'registerable' entity has a pointer in the
503  * struct ast_registry, which points to an array of objects of
504  * the same type. The ast_*_register() function will be able to
505  * derive the size of these entries.
506  */
507 struct ast_registry {
508         struct ast_cli_entry *clis;
509 };
510
511 struct module_symbols {
512         int (*load_module)(void);
513         int (*unload_module)(void);
514         int (*usecount)(void);   
515         const char *(*description)(void);
516         const char *(*key)(void);
517         int (*reload)(void);
518         enum module_type {
519                 MOD_0,  /* old module style */
520                 MOD_1,  /* old style, but symbols here */
521                 MOD_2,  /* new style, exported symbols */
522         } type;
523         struct ast_registry *reg;
524         struct symbol_entry *exported_symbols;
525         struct symbol_entry *required_symbols;
526 };
527
528 #ifndef _HAVE_STATIC_MODULE
529 #define STD_MOD(t, reload_fn, exp, req)
530 #else
531 #define STD_MOD(t, reload_fn, exp, req)                 \
532 struct module_symbols mod_data = {                      \
533         .load_module = load_module,                     \
534         .unload_module = unload_module,                 \
535         .description = description,                     \
536         .key = key,                                     \
537         .reload = reload_fn,                            \
538         .usecount = usecount,                           \
539         .type = t,                                      \
540         .exported_symbols = exp,                        \
541         .required_symbols = req                         \
542 };
543 #endif /* _HAVE_STATIC_MODULE */
544
545 #if defined(__cplusplus) || defined(c_plusplus)
546 }
547 #endif
548
549 #endif /* _ASTERISK_MODULE_H */