00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028 #ifndef _ASTERISK_MODULE_H
00029 #define _ASTERISK_MODULE_H
00030
00031 #include "asterisk/utils.h"
00032
00033 #if defined(__cplusplus) || defined(c_plusplus)
00034 extern "C" {
00035 #endif
00036
00037
00038 #define ASTERISK_GPL_KEY \
00039 "This paragraph is copyright (c) 2006 by Digium, Inc. \
00040 In order for your module to load, it must return this \
00041 key via a function called \"key\". Any code which \
00042 includes this paragraph must be licensed under the GNU \
00043 General Public License version 2 or later (at your \
00044 option). In addition to Digium's general reservations \
00045 of rights, Digium expressly reserves the right to \
00046 allow other parties to license this paragraph under \
00047 different terms. Any use of Digium, Inc. trademarks or \
00048 logos (including \"Asterisk\" or \"Digium\") without \
00049 express written permission of Digium, Inc. is prohibited.\n"
00050
00051 #define AST_MODULE_CONFIG "modules.conf"
00052
00053 enum ast_module_unload_mode {
00054 AST_FORCE_SOFT = 0,
00055 AST_FORCE_FIRM = 1,
00056 AST_FORCE_HARD = 2,
00057
00058 };
00059
00060 enum ast_module_load_result {
00061 AST_MODULE_LOAD_SUCCESS = 0,
00062 AST_MODULE_LOAD_DECLINE = 1,
00063 AST_MODULE_LOAD_SKIP = 2,
00064 AST_MODULE_LOAD_PRIORITY = 3,
00065 AST_MODULE_LOAD_FAILURE = -1,
00066 };
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078 enum ast_module_load_result ast_load_resource(const char *resource_name);
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093 int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode);
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103 void ast_update_use_count(void);
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115 int ast_update_module_list(int (*modentry)(const char *module, const char *description, int usecnt, const char *like),
00116 const char *like);
00117
00118
00119
00120
00121
00122
00123
00124 int ast_module_check(const char *name);
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136 int ast_loader_register(int (*updater)(void));
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146
00147 int ast_loader_unregister(int (*updater)(void));
00148
00149
00150
00151
00152
00153
00154 void ast_module_shutdown(void);
00155
00156
00157
00158
00159
00160
00161
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171
00172 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload);
00173
00174
00175
00176 struct ast_module;
00177
00178
00179
00180
00181
00182 struct ast_module_user;
00183 struct ast_module_user_list;
00184
00185
00186
00187
00188
00189
00190 enum ast_module_flags {
00191 AST_MODFLAG_DEFAULT = 0,
00192 AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00193 AST_MODFLAG_LOAD_ORDER = (1 << 1),
00194 };
00195
00196 struct ast_module_info {
00197
00198
00199
00200
00201
00202
00203
00204 struct ast_module *self;
00205 enum ast_module_load_result (*load)(void);
00206 int (*reload)(void);
00207 int (*unload)(void);
00208 int (*backup_globals)(void);
00209 void (*restore_globals)(void);
00210 const char *name;
00211 const char *description;
00212
00213
00214
00215
00216
00217
00218
00219 const char *key;
00220 unsigned int flags;
00221
00222
00223 const char buildopt_sum[33];
00224
00225
00226
00227
00228
00229
00230 unsigned char load_pri;
00231 };
00232
00233 void ast_module_register(const struct ast_module_info *);
00234 void ast_module_unregister(const struct ast_module_info *);
00235
00236 struct ast_module_user *__ast_module_user_add(struct ast_module *, struct ast_channel *);
00237 void __ast_module_user_remove(struct ast_module *, struct ast_module_user *);
00238 void __ast_module_user_hangup_all(struct ast_module *);
00239
00240 #define ast_module_user_add(chan) __ast_module_user_add(ast_module_info->self, chan)
00241 #define ast_module_user_remove(user) __ast_module_user_remove(ast_module_info->self, user)
00242 #define ast_module_user_hangup_all() __ast_module_user_hangup_all(ast_module_info->self)
00243
00244 struct ast_module *ast_module_ref(struct ast_module *);
00245 void ast_module_unref(struct ast_module *);
00246
00247 #if defined(__cplusplus) || defined(c_plusplus)
00248 #define AST_MODULE_INFO(keystr, flags_to_set, desc, load_func, unload_func, reload_func) \
00249 static struct ast_module_info __mod_info = { \
00250 NULL, \
00251 load_func, \
00252 reload_func, \
00253 unload_func, \
00254 NULL, \
00255 NULL, \
00256 AST_MODULE, \
00257 desc, \
00258 keystr, \
00259 flags_to_set, \
00260 AST_BUILDOPT_SUM, \
00261 }; \
00262 static void __attribute__((constructor)) __reg_module(void) \
00263 { \
00264 ast_module_register(&__mod_info); \
00265 } \
00266 static void __attribute__((destructor)) __unreg_module(void) \
00267 { \
00268 ast_module_unregister(&__mod_info); \
00269 } \
00270 static const __attribute__((unused)) struct ast_module_info *ast_module_info = &__mod_info
00271
00272 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00273 AST_MODULE_INFO(keystr, AST_MODFLAG_DEFAULT, desc, \
00274 load_module, \
00275 unload_module, \
00276 NULL \
00277 )
00278 #else
00279
00280
00281
00282
00283 static const __attribute__((unused)) struct ast_module_info *ast_module_info;
00284
00285 #if !defined(EMBEDDED_MODULE)
00286 #define __MODULE_INFO_SECTION
00287 #define __MODULE_INFO_GLOBALS
00288 #else
00289
00290
00291
00292
00293
00294
00295
00296 #define __MODULE_INFO_SECTION __attribute__((section(".embed_module")))
00297 #define __MODULE_INFO_GLOBALS .backup_globals = __backup_globals, .restore_globals = __restore_globals,
00298
00299 #define make_var_sub(mod, type) __ ## mod ## _ ## type
00300 #define make_var(mod, type) make_var_sub(mod, type)
00301
00302 extern void make_var(EMBEDDED_MODULE, bss_start);
00303 extern void make_var(EMBEDDED_MODULE, bss_end);
00304 extern void make_var(EMBEDDED_MODULE, data_start);
00305 extern void make_var(EMBEDDED_MODULE, data_end);
00306
00307 static void * __attribute__((section(".embed_module"))) __global_backup;
00308
00309 static int __backup_globals(void)
00310 {
00311 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00312
00313 if (__global_backup)
00314 return 0;
00315
00316 if (!data_size)
00317 return 0;
00318
00319 if (!(__global_backup = ast_malloc(data_size)))
00320 return -1;
00321
00322 memcpy(__global_backup, & make_var(EMBEDDED_MODULE, data_start), data_size);
00323
00324 return 0;
00325 }
00326
00327 static void __restore_globals(void)
00328 {
00329 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00330 size_t bss_size = & make_var(EMBEDDED_MODULE, bss_end) - & make_var(EMBEDDED_MODULE, bss_start);
00331
00332 if (bss_size)
00333 memset(& make_var(EMBEDDED_MODULE, bss_start), 0, bss_size);
00334
00335 if (!data_size || !__global_backup)
00336 return;
00337
00338 memcpy(& make_var(EMBEDDED_MODULE, data_start), __global_backup, data_size);
00339 }
00340 #undef make_var
00341 #undef make_var_sub
00342 #endif
00343
00344 #define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...) \
00345 static struct ast_module_info \
00346 __MODULE_INFO_SECTION \
00347 __mod_info = { \
00348 __MODULE_INFO_GLOBALS \
00349 .name = AST_MODULE, \
00350 .flags = flags_to_set, \
00351 .description = desc, \
00352 .key = keystr, \
00353 .buildopt_sum = AST_BUILDOPT_SUM, \
00354 fields \
00355 }; \
00356 static void __attribute__((constructor)) __reg_module(void) \
00357 { \
00358 ast_module_register(&__mod_info); \
00359 } \
00360 static void __attribute__((destructor)) __unreg_module(void) \
00361 { \
00362 ast_module_unregister(&__mod_info); \
00363 } \
00364 static const struct ast_module_info *ast_module_info = &__mod_info
00365
00366 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00367 AST_MODULE_INFO(keystr, AST_MODFLAG_DEFAULT, desc, \
00368 .load = load_module, \
00369 .unload = unload_module, \
00370 )
00371 #endif
00372
00373
00374
00375
00376
00377
00378
00379
00380
00381
00382
00383
00384
00385
00386
00387
00388
00389
00390 #define ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, ast_module_info->self)
00391
00392
00393
00394
00395
00396
00397
00398
00399
00400
00401
00402
00403
00404
00405
00406
00407
00408
00409
00410 int ast_register_application2(const char *app, int (*execute)(struct ast_channel *, void *),
00411 const char *synopsis, const char *description, void *mod);
00412
00413
00414
00415
00416
00417
00418
00419
00420
00421
00422
00423 int ast_unregister_application(const char *app);
00424
00425
00426 #if defined(__cplusplus) || defined(c_plusplus)
00427 }
00428 #endif
00429
00430 #endif