Bring in the new loader code as described in mantis #4377
[asterisk/asterisk.git] / include / asterisk / module.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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 #ifndef STATIC_MODULE
38 #define STATIC_MODULE   /* empty - symbols are global */
39 #else
40 #undef STATIC_MODULE
41 #define STATIC_MODULE   static /* symbols are static */
42 #endif
43
44 /* 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 STATIC_MODULE 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 STATIC_MODULE 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 STATIC_MODULE 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 STATIC_MODULE 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 STATIC_MODULE 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 STATIC_MODULE int reload(void);         /* reload configs */
113
114 /*! \brief The text the key() function should return. */
115 #define ASTERISK_GPL_KEY \
116         "This paragraph is Copyright (C) 2000, Linux Support Services, Inc.  \
117 In order for your module to load, it must return this key via a function \
118 called \"key\".  Any code which includes this paragraph must be licensed under \
119 the GNU General Public License version 2 or later (at your option).   Linux \
120 Support Services, Inc. reserves the right to allow other parties to license \
121 this paragraph under other terms as well."
122
123 #define AST_MODULE_CONFIG "modules.conf" /*!< \brief Module configuration file */
124
125 /*! 
126  * \brief Softly unload a module.
127  *
128  * This flag signals ast_unload_resource() to unload a module only if it is not
129  * in use, according to the module's usecount.
130  */
131 #define AST_FORCE_SOFT 0
132
133 /*! 
134  * \brief Firmly unload a module.
135  *
136  * This flag signals ast_unload_resource() to attempt to unload a module even
137  * if it is in use.  It will attempt to use the module's unload_module
138  * function.
139  */
140 #define AST_FORCE_FIRM 1
141
142 /*! 
143  * \brief Unconditionally unload a module.
144  *
145  * This flag signals ast_unload_resource() to first attempt to unload a module
146  * using the module's unload_module function, then if that fails to unload the
147  * module using dlclose.  The module will be unloaded even if it is still in
148  * use.  Use of this flag is not recommended.
149  */
150 #define AST_FORCE_HARD 2
151
152 /*! 
153  * \brief Load a module.
154  * \param resource_name The filename of the module to load.
155  *
156  * This function is run by the PBX to load the modules.  It performs
157  * all loading and initilization tasks.   Basically, to load a module, just
158  * give it the name of the module and it will do the rest.
159  *
160  * \return Zero on success, -1 on error.
161  */
162 int ast_load_resource(const char *resource_name);
163
164 /*! 
165  * \brief Unloads a module.
166  * \param resource_name The name of the module to unload.
167  * \param force The force flag.  This should be set using one of the AST_FORCE*
168  *        flags.
169  *
170  * This function unloads a module.  It will only unload modules that are not in
171  * use (usecount not zero), unless #AST_FORCE_FIRM or #AST_FORCE_HARD is 
172  * specified.  Setting #AST_FORCE_FIRM or #AST_FORCE_HARD will unload the
173  * module regardless of consequences (NOT_RECOMMENDED).
174  *
175  * \return Zero on success, -1 on error.
176  */
177 int ast_unload_resource(const char *resource_name, int force);
178
179 /*! 
180  * \brief Notify when usecount has been changed.
181  *
182  * This function calulates use counts and notifies anyone trying to keep track
183  * of them.  It should be called whenever your module's usecount changes.
184  *
185  * \note The LOCAL_USER macros take care of calling this function for you.
186  */
187 void ast_update_use_count(void);
188
189 /*! 
190  * \brief Ask for a list of modules, descriptions, and use counts.
191  * \param modentry A callback to an updater function.
192  * \param like
193  *
194  * For each of the modules loaded, modentry will be executed with the resource,
195  * description, and usecount values of each particular module.
196  * 
197  * \return the number of modules loaded
198  */
199 int ast_update_module_list(int (*modentry)(const char *module, const char *description, int usecnt, const char *like),
200                            const char *like);
201
202 /*! 
203  * \brief Add a procedure to be run when modules have been updated.
204  * \param updater The function to run when modules have been updated.
205  *
206  * This function adds the given function to a linked list of functions to be
207  * run when the modules are updated. 
208  *
209  * \return Zero on success and -1 on failure.
210  */
211 int ast_loader_register(int (*updater)(void));
212
213 /*! 
214  * \brief Remove a procedure to be run when modules are updated.
215  * \param updater The updater function to unregister.
216  *
217  * This removes the given function from the updater list.
218  * 
219  * \return Zero on success, -1 on failure.
220  */
221 int ast_loader_unregister(int (*updater)(void));
222
223 /*! 
224  * \brief Reload asterisk modules.
225  * \param name the name of the module to reload
226  *
227  * This function reloads the specified module, or if no modules are specified,
228  * it will reload all loaded modules.
229  *
230  * \note Modules are reloaded using their reload() functions, not unloading
231  * them and loading them again.
232  *
233  * \return Zero if the specified module was not found, 1 if the module was
234  * found but cannot be reloaded, -1 if a reload operation is already in
235  * progress, and 2 if the specfied module was found and reloaded.
236  */
237 int ast_module_reload(const char *name);
238
239 /*! 
240  * \brief Match modules names for the Asterisk cli.
241  * \param line Unused by this function, but this should be the line we are
242  *        matching.
243  * \param word The partial name to match. 
244  * \param pos The position the word we are completing is in.
245  * \param state The possible match to return.
246  * \param rpos The position we should be matching.  This should be the same as
247  *        pos.
248  * \param needsreload This should be 1 if we need to reload this module and 0
249  *        otherwise.  This function will only return modules that are reloadble
250  *        if this is 1.
251  *
252  * \return A possible completion of the partial match, or NULL if no matches
253  * were found.
254  */
255 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload);
256
257 /*! 
258  * \brief Register a function to be executed before Asterisk exits.
259  * \param func The callback function to use.
260  *
261  * \return Zero on success, -1 on error.
262  */
263 int ast_register_atexit(void (*func)(void));
264
265 /*! 
266  * \brief Unregister a function registered with ast_register_atexit().
267  * \param func The callback function to unregister.
268  */
269 void ast_unregister_atexit(void (*func)(void));
270
271 /*!
272  * \brief Given a function address, find the corresponding module.
273  * This is required as a workaround to the fact that we do not
274  * have a module argument to the load_module() function.
275  * Hopefully the performance implications are small.
276  */
277 struct module *ast_find_module(int (*load_fn)(void));
278
279 /* Local user routines keep track of which channels are using a given module
280    resource.  They can help make removing modules safer, particularly if
281    they're in use at the time they have been requested to be removed */
282
283 struct localuser {
284         struct ast_channel *chan;
285         AST_LIST_ENTRY(localuser) next;
286 };
287
288 /*! structure used for lock and refcount of module users.
289  * The mutex protects the usecnt field and whatever needs to be
290  * protected (typically, a list of struct localuser).
291  * As a trick, if usecnt is initialized with -1,
292  * ast_format_register will init the mutex for you.
293  */
294 struct ast_module_lock {
295         ast_mutex_t lock;
296         AST_LIST_HEAD_NOLOCK(localuser_head, localuser) u;
297         int usecnt;     /* number of active clients */
298 };
299
300 struct localuser *ast_localuser_add(struct ast_module_lock *m, struct ast_channel *chan);
301 void ast_localuser_remove(struct ast_module_lock *m, struct localuser *u);
302 void ast_hangup_localusers(struct ast_module_lock *m);
303
304 /*! 
305  * \brief create a localuser mutex and several other variables used for keeping the
306  * use count.
307  *
308  * <b>Sample Usage:</b>
309  * \code
310  * LOCAL_USER_DECL;
311  * \endcode
312  */
313 #define LOCAL_USER_DECL                                 \
314         static struct ast_module_lock me = {            \
315                 .u = AST_LIST_HEAD_NOLOCK_INIT_VALUE,   \
316                 .usecnt = 0,                            \
317                 .lock = AST_MUTEX_INIT_VALUE }
318
319 #define STANDARD_USECOUNT_DECL LOCAL_USER_DECL  /* XXX lock remains unused */
320
321 /*! run 'x' protected by lock, then call ast_update_use_count() */
322 #define __MOD_PROTECT(x) do {                   \
323         ast_mutex_lock(&me.lock);               \
324         x;                                      \
325         ast_mutex_unlock(&me.lock);             \
326         ast_update_use_count();                 \
327         } while (0)
328
329 #define STANDARD_INCREMENT_USECOUNT __MOD_PROTECT(me.usecnt++)
330 #define STANDARD_DECREMENT_USECOUNT __MOD_PROTECT(me.usecnt--)
331
332 /*! 
333  * \brief Add a localuser.
334  * \param u a pointer to a localuser struct
335  *
336  * This macro adds a localuser to the list of users and increments the
337  * usecount.  It expects a variable named \p chan of type \p ast_channel in the
338  * current scope.
339  *
340  * \note This function dynamically allocates memory.  If this operation fails
341  * it will cause your function to return -1 to the caller.
342  */
343 #define LOCAL_USER_ADD(u) do {                  \
344         u = ast_localuser_add(&me, chan);       \
345         if (!u)                                 \
346                 return -1;                      \
347         } while (0)
348
349 /*! 
350  * \brief Remove a localuser.
351  * \param u the user to add, should be of type struct localuser
352  *
353  * This macro removes a localuser from the list of users and decrements the
354  * usecount.
355  */
356 #define LOCAL_USER_REMOVE(u) ast_localuser_remove(&me, u)
357
358 /*! 
359  * \brief Hangup all localusers.
360  *
361  * This macro hangs up on all current localusers and sets the usecount to zero
362  * when finished.
363  */
364 #define STANDARD_HANGUP_LOCALUSERS ast_hangup_localusers(&me)
365
366 /*!
367  * \brief Set the specfied integer to the current usecount.
368  * \param res the integer variable to set.
369  *
370  * This macro sets the specfied integer variable to the local usecount.
371  *
372  * <b>Sample Usage:</b>
373  * \code
374  * int usecount(void)
375  * {
376  *    int res;
377  *    STANDARD_USECOUNT(res);
378  *    return res;
379  * }
380  * \endcode
381  */
382 #define STANDARD_USECOUNT(res) do { res = me.usecnt; } while (0)
383
384 /*
385  * XXX The following macro is deprecated, and only used by modules
386  * in codecs/ and a few other places which do their own manipulation
387  * of the usecount variable.
388  * Its use is supposed to be gradually phased away as those modules
389  * are updated to use the standard mechanism.
390  */
391 #define OLD_STANDARD_USECOUNT(res) do { res = localusecnt; } while (0)
392
393 /*!
394  * \brief The following is part of the new module management code.
395  *
396  * All modules must implement the module API (load, unload...)
397  * whose functions are exported through fields of a "struct module_symbol";
398  *
399  * Modules exporting extra symbols (data or functions), should list
400  * them into an array of struct symbol_entry:
401  *     struct symbol_entry exported_symbols[]
402  * of symbols, with a NULL name on the last entry
403  * Functions should be added with MOD_FUNC(name),
404  * data structures with MOD_DATA(_name).
405  * The array in turn is referenced by struct module_symbol.
406  * (Typically, a module will export only a single symbol, which points
407  * to a record containing all the methods. This is the API of the module,
408  * and should be known to the module's clients as well.
409  *
410  * Modules that require symbols supplied by other modules should
411  * provide an array
412  *     struct symbol_entry required_symbols[]
413  * of symbols, with a NULL name on the last entry, containing the
414  * name of the desired symbol.
415  * For good measure, we also provide the size in both caller and calle
416  * to figure out if there is a mismatch (not terribly useful because most
417  * objects are a single word, but still... )
418  * The symbol can be added to the array with MOD_WANT(symbol) macro.
419  * required_symbols is also pointed by through struct module_symbol.
420  *
421  * Typically, the whole interface exported by a module should be
422  * in a single structure named after the module, as follows.
423  * Say the module high level name is 'foo', then we should have
424  * - in include/asterisk/foo.h
425  *     struct foo_interface {
426  *              int (*f)(int, char *); -- first function exported 
427  *              const char (*g)(int); -- second function exported 
428  *              char *buf;
429  *              ...             -- other fields
430  *     }
431  * - in the module exporting the interface, e.g. res/res_foo.c
432  *      static int f(int, char *);
433  *      static const char *g(int);
434  *      const char buf[BUFSZ];
435  *     struct foo_interface foo = {
436  *      .f = f,
437  *      .g = g,
438  *      .buf = buf,
439  *     }
440  *
441  * NOTE: symbol names are 'global' in this module namespace, so it
442  * will be wiser to name exported symbols with a prefix indicating the module
443  * supplying it, e.g. foo_f, foo_g, foo_buf. Internally to the module,
444  * symbols are still static so they can keep short and meaningful names.
445  * The macros MOD_FIELD and METHOD_BASE() below help setting these entries.
446  *
447  *      MOD_FIELD(f1),          -- field and function name are the same
448  *      METHOD_BASE(foo_, f1),  -- field and function name differ by a prefix
449  *      .f1 = function_name,    -- generic case
450  *     }
451  *
452  * Note that the loader requires that no fields of exported_symbols
453  * are NULL, because that is used as an indication of the end of the array.
454  */
455
456 struct symbol_entry {
457         const char *name;
458         void *value;
459         int size;
460         struct module *src;     /* module sourcing it, filled by loader */
461 };
462
463 /*
464  * Constructors for symbol_entry values
465  */
466 #define MOD_FUNC(f)     { .name = #f, .value = f, .size = sizeof(f) }
467 #define MOD_DATA(d)     { .name = #d, .value = &d, .size = sizeof(_name) }
468 #define MOD_WANT(s)     { .name = #s, .value = &s, 0 }   /* required symbols */
469
470 /*
471  * Constructors for fields of foo_interface
472  */
473 #define MOD_FIELD(f)    . ## f = f
474 #define METHOD_BASE(_base, _name)       . ## _name = _base ## _name
475
476
477 struct module_symbols {
478         int (*load_module)(void);
479         int (*unload_module)(void);
480         int (*usecount)(void);   
481         char *(*description)(void);
482         char *(*key)(void);
483         int (*reload)(void);
484
485         enum module_type {
486                 MOD_0,  /* old module style */
487                 MOD_1,  /* old style, but symbols here */
488                 MOD_2,  /* new style, exported symbols */
489         } type;
490         struct symbol_entry *exported_symbols;
491         struct symbol_entry *required_symbols;
492 };
493
494 #define STD_MOD(t, exp, req)                            \
495 struct module_symbols mod_data = {                      \
496         .load_module = load_module,                     \
497         .unload_module = unload_module,                 \
498         .description = description,                     \
499         .key = key,                                     \
500         .reload = reload,                               \
501         .usecount = usecount,                           \
502         .type = t,                                      \
503         .exported_symbols = exp,                        \
504         .required_symbols = req                         \
505 };
506
507 #if defined(__cplusplus) || defined(c_plusplus)
508 }
509 #endif
510
511 #endif /* _ASTERISK_MODULE_H */