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