e614a726f20880d72fcb1601af9130a36aae77a3
[asterisk/asterisk.git] / include / asterisk / module.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, 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  * \brief Asterisk module definitions.
23  *
24  * This file contains the definitons for functions Asterisk modules should
25  * provide and some other module related functions.
26  */
27
28 /*! \li \ref module.h uses the configuration file \ref modules.conf
29  * \addtogroup configuration_file
30  */
31
32 /*! \page modules.conf modules.conf
33  * \verbinclude modules.conf.sample
34  */
35
36 #ifndef _ASTERISK_MODULE_H
37 #define _ASTERISK_MODULE_H
38
39 #include "asterisk/utils.h"
40
41 #if defined(__cplusplus) || defined(c_plusplus)
42 extern "C" {
43 #endif
44
45 /*! \brief The text the key() function should return. */
46 #define ASTERISK_GPL_KEY \
47 "This paragraph is copyright (c) 2006 by Digium, Inc. \
48 In order for your module to load, it must return this \
49 key via a function called \"key\".  Any code which \
50 includes this paragraph must be licensed under the GNU \
51 General Public License version 2 or later (at your \
52 option).  In addition to Digium's general reservations \
53 of rights, Digium expressly reserves the right to \
54 allow other parties to license this paragraph under \
55 different terms. Any use of Digium, Inc. trademarks or \
56 logos (including \"Asterisk\" or \"Digium\") without \
57 express written permission of Digium, Inc. is prohibited.\n"
58
59 #define AST_MODULE_CONFIG "modules.conf" /*!< \brief Module configuration file */
60
61 enum ast_module_unload_mode {
62         AST_FORCE_SOFT = 0, /*!< Softly unload a module, only if not in use */
63         AST_FORCE_FIRM = 1, /*!< Firmly unload a module, even if in use */
64         AST_FORCE_HARD = 2, /*!< as FIRM, plus dlclose() on the module. Not recommended
65                                 as it may cause crashes */
66 };
67
68 enum ast_module_load_result {
69         AST_MODULE_LOAD_SUCCESS = 0,    /*!< Module loaded and configured */
70         AST_MODULE_LOAD_DECLINE = 1,    /*!< Module is not configured */
71         AST_MODULE_LOAD_SKIP = 2,       /*!< Module was skipped for some reason (For loader.c use only. Should never be returned by modules)*/
72         AST_MODULE_LOAD_PRIORITY = 3,   /*!< Module is not loaded yet, but is added to prioity heap */
73         AST_MODULE_LOAD_FAILURE = -1,   /*!< Module could not be loaded properly */
74 };
75
76 /*!
77  * \since 12
78  * \brief Possible return types for \ref ast_module_reload
79  */
80 enum ast_module_reload_result {
81         AST_MODULE_RELOAD_SUCCESS = 0,      /*!< The module was reloaded succesfully */
82         AST_MODULE_RELOAD_QUEUED,           /*!< The module reload request was queued */
83         AST_MODULE_RELOAD_NOT_FOUND,        /*!< The requested module was not found */
84         AST_MODULE_RELOAD_ERROR,            /*!< An error occurred while reloading the module */
85         AST_MODULE_RELOAD_IN_PROGRESS,      /*!< A module reload request is already in progress */
86         AST_MODULE_RELOAD_UNINITIALIZED,    /*!< The module has not been initialized */
87         AST_MODULE_RELOAD_NOT_IMPLEMENTED,  /*!< This module doesn't support reloading */
88 };
89
90 enum ast_module_support_level {
91         AST_MODULE_SUPPORT_UNKNOWN,
92         AST_MODULE_SUPPORT_CORE,
93         AST_MODULE_SUPPORT_EXTENDED,
94         AST_MODULE_SUPPORT_DEPRECATED,
95 };
96
97 /*! 
98  * \brief Load a module.
99  * \param resource_name The name of the module to load.
100  *
101  * This function is run by the PBX to load the modules.  It performs
102  * all loading and initialization tasks.   Basically, to load a module, just
103  * give it the name of the module and it will do the rest.
104  *
105  * \return See possible enum values for ast_module_load_result.
106  */
107 enum ast_module_load_result ast_load_resource(const char *resource_name);
108
109 /*! 
110  * \brief Unload a module.
111  * \param resource_name The name of the module to unload.
112  * \param ast_module_unload_mode The force flag. This should be set using one of the AST_FORCE flags.
113  *
114  * This function unloads a module.  It will only unload modules that are not in
115  * use (usecount not zero), unless #AST_FORCE_FIRM or #AST_FORCE_HARD is 
116  * specified.  Setting #AST_FORCE_FIRM or #AST_FORCE_HARD will unload the
117  * module regardless of consequences (NOT RECOMMENDED).
118  *
119  * \retval 0 on success.
120  * \retval -1 on error.
121  */
122 int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode);
123
124 /*!
125  * \brief Reload asterisk modules.
126  * \param name the name of the module to reload
127  *
128  * This function reloads the specified module, or if no modules are specified,
129  * it will reload all loaded modules.
130  *
131  * \note Modules are reloaded using their reload() functions, not unloading
132  * them and loading them again.
133  *
134  * \retval The \ref ast_module_reload_result status of the module load request
135  */
136 enum ast_module_reload_result ast_module_reload(const char *name);
137
138 /*! 
139  * \brief Notify when usecount has been changed.
140  *
141  * This function calulates use counts and notifies anyone trying to keep track
142  * of them.  It should be called whenever your module's usecount changes.
143  *
144  * \note The ast_module_user_* functions take care of calling this function for you.
145  */
146 void ast_update_use_count(void);
147
148 /*!
149  * \brief Ask for a list of modules, descriptions, use counts and status.
150  * \param modentry A callback to an updater function.
151  * \param like
152  *
153  * For each of the modules loaded, modentry will be executed with the resource,
154  * description, and usecount values of each particular module.
155  *
156  * \return the number of modules loaded
157  */
158 int ast_update_module_list(int (*modentry)(const char *module, const char *description,
159                                            int usecnt, const char *status, const char *like,
160                                            enum ast_module_support_level support_level),
161                            const char *like);
162
163 /*!
164  * \brief Ask for a list of modules, descriptions, use counts and status.
165  * \param modentry A callback to an updater function
166  * \param like
167  * \param data Data passed into the callback for manipulation
168  *
169  * For each of the modules loaded, modentry will be executed with the resource,
170  * description, and usecount values of each particular module.
171  *
172  * \return the number of modules loaded
173  * \since 13.5.0
174  */
175 int ast_update_module_list_data(int (*modentry)(const char *module, const char *description,
176                                                 int usecnt, const char *status, const char *like,
177                                                 enum ast_module_support_level support_level,
178                                                 void *data),
179                                 const char *like, void *data);
180
181 /*!
182  * \brief Ask for a list of modules, descriptions, use counts and status.
183  * \param modentry A callback to an updater function
184  * \param like
185  * \param data Data passed into the callback for manipulation
186  * \param condition The condition to meet
187  *
188  * For each of the modules loaded, modentry will be executed with the resource,
189  * description, and usecount values of each particular module.
190  *
191  * \return the number of conditions met
192  * \since 13.5.0
193  */
194 int ast_update_module_list_condition(int (*modentry)(const char *module, const char *description,
195                                                      int usecnt, const char *status, const char *like,
196                                                      enum ast_module_support_level support_level,
197                                                      void *data, const char *condition),
198                                      const char *like, void *data, const char *condition);
199
200 /*!
201  * \brief Check if module with the name given is loaded
202  * \param name Module name, like "chan_sip.so"
203  * \retval 1 if true 
204  * \retval 0 if false
205  */
206 int ast_module_check(const char *name);
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  * \retval 0 on success 
216  * \retval -1 on failure.
217  */
218 int ast_loader_register(int (*updater)(void));
219
220 /*! 
221  * \brief Remove a procedure to be run when modules are updated.
222  * \param updater The updater function to unregister.
223  *
224  * This removes the given function from the updater list.
225  * 
226  * \retval 0 on success
227  * \retval -1 on failure.
228  */
229 int ast_loader_unregister(int (*updater)(void));
230
231 /*! 
232  * \brief Match modules names for the Asterisk cli.
233  * \param line Unused by this function, but this should be the line we are
234  *        matching.
235  * \param word The partial name to match. 
236  * \param pos The position the word we are completing is in.
237  * \param state The possible match to return.
238  * \param rpos The position we should be matching.  This should be the same as
239  *        pos.
240  * \param needsreload This should be 1 if we need to reload this module and 0
241  *        otherwise.  This function will only return modules that are reloadble
242  *        if this is 1.
243  *
244  * \retval A possible completion of the partial match.
245  * \retval NULL if no matches were found.
246  */
247 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload);
248
249 /* Opaque type for module handles generated by the loader */
250
251 struct ast_module;
252
253 /*!
254  * \brief Get the name of a module.
255  * \param mod A pointer to the module.
256  * \return the name of the module
257  * \retval NULL if mod or mod->info is NULL
258  */
259 const char *ast_module_name(const struct ast_module *mod);
260
261 /* User count routines keep track of which channels are using a given module
262    resource.  They can help make removing modules safer, particularly if
263    they're in use at the time they have been requested to be removed */
264
265 struct ast_module_user;
266 struct ast_module_user_list;
267
268 /*! \page ModMngmnt The Asterisk Module management interface
269  *
270  * All modules must implement the module API (load, unload...)
271  */
272
273 enum ast_module_flags {
274         AST_MODFLAG_DEFAULT = 0,
275         AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
276         AST_MODFLAG_LOAD_ORDER = (1 << 1),
277 };
278
279 enum ast_module_load_priority {
280         AST_MODPRI_REALTIME_DEPEND =    10,  /*!< Dependency for a realtime driver */
281         AST_MODPRI_REALTIME_DEPEND2 =   20,  /*!< Second level dependency for a realtime driver (func_curl needs res_curl, but is needed by res_config_curl) */
282         AST_MODPRI_REALTIME_DRIVER =    30,  /*!< A realtime driver, which provides configuration services for other modules */
283         AST_MODPRI_TIMING =             40,  /*!< Dependency for a channel (MOH needs timing interfaces to be fully loaded) */
284         AST_MODPRI_CHANNEL_DEPEND =     50,  /*!< Channel driver dependency (may depend upon realtime, e.g. MOH) */
285         AST_MODPRI_CHANNEL_DRIVER =     60,  /*!< Channel drivers (provide devicestate) */
286         AST_MODPRI_APP_DEPEND =         70,  /*!< Dependency for an application */
287         AST_MODPRI_DEVSTATE_PROVIDER =  80,  /*!< Applications and other modules that _provide_ devicestate (e.g. meetme) */
288         AST_MODPRI_DEVSTATE_PLUGIN =    90,  /*!< Plugin for a module that provides devstate (e.g. res_calendar_*) */
289         AST_MODPRI_CDR_DRIVER =        100,  /*!< CDR or CEL backend */
290         AST_MODPRI_DEFAULT =           128,  /*!< Modules not otherwise defined (such as most apps) will load here */
291         AST_MODPRI_DEVSTATE_CONSUMER = 150,  /*!< Certain modules, which consume devstate, need to load after all others (e.g. app_queue) */
292 };
293
294 struct ast_module_info {
295
296         /*!
297          * The 'self' pointer for a module; it will be set by the loader before
298          * it calls the module's load_module() entrypoint, and used by various
299          * other macros that need to identify the module.
300          */
301
302         struct ast_module *self;
303         enum ast_module_load_result (*load)(void);      /*!< register stuff etc. Optional. */
304         int (*reload)(void);                    /*!< config etc. Optional. */
305         int (*unload)(void);                    /*!< unload. called with the module locked */
306         const char *name;                       /*!< name of the module for loader reference and CLI commands */
307         const char *description;                /*!< user friendly description of the module. */
308
309         /*! 
310          * This holds the ASTERISK_GPL_KEY, signifiying that you agree to the terms of
311          * the Asterisk license as stated in the ASTERISK_GPL_KEY.  Your module will not
312          * load if it does not return the EXACT key string.
313          */
314
315         const char *key;
316         unsigned int flags;
317
318         /*! The value of AST_BUILDOPT_SUM when this module was compiled */
319         const char buildopt_sum[33];
320
321         /*! This value represents the order in which a module's load() function is initialized.
322          *  The lower this value, the higher the priority.  The value is only checked if the
323          *  AST_MODFLAG_LOAD_ORDER flag is set.  If the AST_MODFLAG_LOAD_ORDER flag is not set,
324          *  this value will never be read and the module will be given the lowest possible priority
325          *  on load. */
326         unsigned char load_pri;
327
328         /*! Modules which should be loaded first, in comma-separated string format.
329          * These are only required for loading, when the optional_api header file
330          * detects that the compiler does not support the optional API featureset. */
331         const char *nonoptreq;
332         /*! The support level for the given module */
333         enum ast_module_support_level support_level;
334 };
335
336 void ast_module_register(const struct ast_module_info *);
337 void ast_module_unregister(const struct ast_module_info *);
338
339 struct ast_module_user *__ast_module_user_add(struct ast_module *, struct ast_channel *);
340 void __ast_module_user_remove(struct ast_module *, struct ast_module_user *);
341 void __ast_module_user_hangup_all(struct ast_module *);
342
343 #define ast_module_user_add(chan) __ast_module_user_add(AST_MODULE_SELF, chan)
344 #define ast_module_user_remove(user) __ast_module_user_remove(AST_MODULE_SELF, user)
345 #define ast_module_user_hangup_all() __ast_module_user_hangup_all(AST_MODULE_SELF)
346
347 struct ast_module *__ast_module_ref(struct ast_module *mod, const char *file, int line, const char *func);
348 void __ast_module_shutdown_ref(struct ast_module *mod, const char *file, int line, const char *func);
349 void __ast_module_unref(struct ast_module *mod, const char *file, int line, const char *func);
350
351 /*!
352  * \brief Hold a reference to the module
353  * \param mod Module to reference
354  * \return mod
355  *
356  * \note A module reference will prevent the module
357  * from being unloaded.
358  */
359 #define ast_module_ref(mod)           __ast_module_ref(mod, __FILE__, __LINE__, __PRETTY_FUNCTION__)
360 /*!
361  * \brief Prevent unload of the module before shutdown
362  * \param mod Module to hold
363  *
364  * \note This should not be balanced by a call to ast_module_unref.
365  */
366 #define ast_module_shutdown_ref(mod)  __ast_module_shutdown_ref(mod, __FILE__, __LINE__, __PRETTY_FUNCTION__)
367 /*!
368  * \brief Release a reference to the module
369  * \param mod Module to release
370  */
371 #define ast_module_unref(mod)         __ast_module_unref(mod, __FILE__, __LINE__, __PRETTY_FUNCTION__)
372
373 #if defined(__cplusplus) || defined(c_plusplus)
374 #define AST_MODULE_INFO(keystr, flags_to_set, desc, load_func, unload_func, reload_func, load_pri, support_level)       \
375         static struct ast_module_info __mod_info = {    \
376                 NULL,                                                          \
377                 load_func,                                                     \
378                 reload_func,                                                   \
379                 unload_func,                                                   \
380                 AST_MODULE,                                                    \
381                 desc,                                                          \
382                 keystr,                                                        \
383                 flags_to_set,                                                  \
384                 AST_BUILDOPT_SUM,                                              \
385                 load_pri,                                                      \
386                 NULL,                                                          \
387                 support_level,                                                 \
388         };                                                                 \
389         static void  __attribute__((constructor)) __reg_module(void)       \
390         {                                                                  \
391                 ast_module_register(&__mod_info);                              \
392         }                                                                  \
393         static void  __attribute__((destructor)) __unreg_module(void)      \
394         {                                                                  \
395                 ast_module_unregister(&__mod_info);                            \
396         }                                                                  \
397         struct ast_module *AST_MODULE_SELF_SYM(void)                       \
398         {                                                                  \
399                 return __mod_info.self;                                        \
400         }                                                                  \
401         static const __attribute__((unused)) struct ast_module_info *ast_module_info = &__mod_info
402
403
404 #define AST_MODULE_INFO_STANDARD(keystr, desc)              \
405         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
406                         load_module,                                    \
407                         unload_module,                                  \
408                         NULL,                                           \
409                         AST_MODPRI_DEFAULT,                             \
410                         AST_MODULE_SUPPORT_CORE                         \
411                        )
412
413 #define AST_MODULE_INFO_STANDARD_EXTENDED(keystr, desc)     \
414         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
415                         load_module,                                    \
416                         unload_module,                                  \
417                         NULL,                                           \
418                         AST_MODPRI_DEFAULT,                             \
419                         AST_MODULE_SUPPORT_EXTENDED                     \
420                        )
421 #define AST_MODULE_INFO_STANDARD_DEPRECATED(keystr, desc)   \
422         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
423                         load_module,                                    \
424                         unload_module,                                  \
425                         NULL,                                           \
426                         AST_MODPRI_DEFAULT,                             \
427                         AST_MODULE_SUPPORT_DEPRECATED                   \
428                        )
429
430 #else /* plain C */
431
432 /* forward declare this pointer in modules, so that macro/function
433    calls that need it can get it, since it will actually be declared
434    and populated at the end of the module's source file... */
435 #if !defined(AST_IN_CORE)
436 static const __attribute__((unused)) struct ast_module_info *ast_module_info;
437 #endif
438
439 #define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)  \
440         static struct ast_module_info                           \
441                 __mod_info = {                                  \
442                 .name = AST_MODULE,                             \
443                 .flags = flags_to_set,                          \
444                 .description = desc,                            \
445                 .key = keystr,                                  \
446                 .buildopt_sum = AST_BUILDOPT_SUM,               \
447                 fields                                          \
448         };                                                      \
449         static void  __attribute__((constructor)) __reg_module(void) \
450         { \
451                 ast_module_register(&__mod_info); \
452         } \
453         static void  __attribute__((destructor)) __unreg_module(void) \
454         { \
455                 ast_module_unregister(&__mod_info); \
456         } \
457         struct ast_module *AST_MODULE_SELF_SYM(void)                       \
458         {                                                                  \
459                 return __mod_info.self;                                        \
460         }                                                                  \
461         static const struct ast_module_info *ast_module_info = &__mod_info
462
463 #define AST_MODULE_INFO_STANDARD(keystr, desc)              \
464         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
465                         .load = load_module,                            \
466                         .unload = unload_module,                        \
467                         .load_pri = AST_MODPRI_DEFAULT,                 \
468                         .support_level = AST_MODULE_SUPPORT_CORE,       \
469                        )
470
471 #define AST_MODULE_INFO_STANDARD_EXTENDED(keystr, desc)     \
472         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
473                         .load = load_module,                            \
474                         .unload = unload_module,                        \
475                         .load_pri = AST_MODPRI_DEFAULT,                 \
476                         .support_level = AST_MODULE_SUPPORT_EXTENDED,   \
477                        )
478
479 #define AST_MODULE_INFO_STANDARD_DEPRECATED(keystr, desc)   \
480         AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc,   \
481                         .load = load_module,                            \
482                         .unload = unload_module,                        \
483                         .load_pri = AST_MODPRI_DEFAULT,                 \
484                         .support_level = AST_MODULE_SUPPORT_DEPRECATED, \
485                        )
486
487 #endif  /* plain C */
488
489 /*! 
490  * \brief Register an application.
491  *
492  * \param app Short name of the application
493  * \param execute a function callback to execute the application. It should return
494  *                non-zero if the channel needs to be hung up.
495  * \param synopsis a short description (one line synopsis) of the application
496  * \param description long description with all of the details about the use of 
497  *                    the application
498  * 
499  * This registers an application with Asterisk's internal application list. 
500  * \note The individual applications themselves are responsible for registering and unregistering
501  *       and unregistering their own CLI commands.
502  * 
503  * \retval 0 success 
504  * \retval -1 failure.
505  */
506 #define ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, AST_MODULE_SELF)
507
508 /*! 
509  * \brief Register an application using XML documentation.
510  *
511  * \param app Short name of the application
512  * \param execute a function callback to execute the application. It should return
513  *                non-zero if the channel needs to be hung up.
514  * 
515  * This registers an application with Asterisk's internal application list. 
516  * \note The individual applications themselves are responsible for registering and unregistering
517  *       and unregistering their own CLI commands.
518  * 
519  * \retval 0 success 
520  * \retval -1 failure.
521  */
522 #define ast_register_application_xml(app, execute) ast_register_application(app, execute, NULL, NULL)
523
524
525 /*!
526  * \brief Register an application.
527  *
528  * \param app Short name of the application
529  * \param execute a function callback to execute the application. It should return
530  *                non-zero if the channel needs to be hung up.
531  * \param synopsis a short description (one line synopsis) of the application
532  * \param description long description with all of the details about the use of
533  *                    the application
534  * \param mod module this application belongs to
535  *
536  * This registers an application with Asterisk's internal application list.
537  * \note The individual applications themselves are responsible for registering and unregistering
538  *       and unregistering their own CLI commands.
539  *
540  * \retval 0 success
541  * \retval -1 failure.
542  */
543 int ast_register_application2(const char *app, int (*execute)(struct ast_channel *, const char *),
544                                      const char *synopsis, const char *description, void *mod);
545
546 /*! 
547  * \brief Unregister an application
548  * 
549  * \param app name of the application (does not have to be the same string as the one that was registered)
550  * 
551  * This unregisters an application from Asterisk's internal application list.
552  * 
553  * \retval 0 success 
554  * \retval -1 failure
555  */
556 int ast_unregister_application(const char *app);
557
558 const char *ast_module_support_level_to_string(enum ast_module_support_level support_level);
559
560 /*! Macro to safely ref and unref the self module for the current scope */
561 #define SCOPED_MODULE_USE(module) \
562         RAII_VAR(struct ast_module *, __self__ ## __LINE__, ast_module_ref(module), ast_module_unref)
563
564 #if defined(__cplusplus) || defined(c_plusplus)
565 }
566 #endif
567
568 #endif /* _ASTERISK_MODULE_H */