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_FAILURE = -1,
00065 };
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077 enum ast_module_load_result ast_load_resource(const char *resource_name);
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092 int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode);
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102 void ast_update_use_count(void);
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114 int ast_update_module_list(int (*modentry)(const char *module, const char *description, int usecnt, const char *like),
00115 const char *like);
00116
00117
00118
00119
00120
00121
00122
00123 int ast_module_check(const char *name);
00124
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135 int ast_loader_register(int (*updater)(void));
00136
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146 int ast_loader_unregister(int (*updater)(void));
00147
00148
00149
00150
00151
00152
00153 void ast_module_shutdown(void);
00154
00155
00156
00157
00158
00159
00160
00161
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171 char *ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, int needsreload);
00172
00173
00174
00175 struct ast_module;
00176
00177
00178
00179
00180
00181 struct ast_module_user;
00182 struct ast_module_user_list;
00183
00184
00185
00186
00187
00188
00189 enum ast_module_flags {
00190 AST_MODFLAG_DEFAULT = 0,
00191 AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00192 };
00193
00194 struct ast_module_info {
00195
00196
00197
00198
00199
00200
00201
00202 struct ast_module *self;
00203 enum ast_module_load_result (*load)(void);
00204 int (*reload)(void);
00205 int (*unload)(void);
00206 int (*backup_globals)(void);
00207 void (*restore_globals)(void);
00208 const char *name;
00209 const char *description;
00210
00211
00212
00213
00214
00215
00216
00217 const char *key;
00218 unsigned int flags;
00219
00220
00221 const char buildopt_sum[33];
00222 };
00223
00224 void ast_module_register(const struct ast_module_info *);
00225 void ast_module_unregister(const struct ast_module_info *);
00226
00227 struct ast_module_user *__ast_module_user_add(struct ast_module *, struct ast_channel *);
00228 void __ast_module_user_remove(struct ast_module *, struct ast_module_user *);
00229 void __ast_module_user_hangup_all(struct ast_module *);
00230
00231 #define ast_module_user_add(chan) __ast_module_user_add(ast_module_info->self, chan)
00232 #define ast_module_user_remove(user) __ast_module_user_remove(ast_module_info->self, user)
00233 #define ast_module_user_hangup_all() __ast_module_user_hangup_all(ast_module_info->self)
00234
00235 struct ast_module *ast_module_ref(struct ast_module *);
00236 void ast_module_unref(struct ast_module *);
00237
00238 #if defined(__cplusplus) || defined(c_plusplus)
00239 #define AST_MODULE_INFO(keystr, flags_to_set, desc, load_func, unload_func, reload_func) \
00240 static struct ast_module_info __mod_info = { \
00241 NULL, \
00242 load_func, \
00243 reload_func, \
00244 unload_func, \
00245 NULL, \
00246 NULL, \
00247 AST_MODULE, \
00248 desc, \
00249 keystr, \
00250 flags_to_set, \
00251 AST_BUILDOPT_SUM, \
00252 }; \
00253 static void __attribute__((constructor)) __reg_module(void) \
00254 { \
00255 ast_module_register(&__mod_info); \
00256 } \
00257 static void __attribute__((destructor)) __unreg_module(void) \
00258 { \
00259 ast_module_unregister(&__mod_info); \
00260 } \
00261 static const __attribute__((unused)) struct ast_module_info *ast_module_info = &__mod_info
00262
00263 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00264 AST_MODULE_INFO(keystr, AST_MODFLAG_DEFAULT, desc, \
00265 load_module, \
00266 unload_module, \
00267 NULL \
00268 )
00269 #else
00270
00271
00272
00273
00274 static const __attribute__((unused)) struct ast_module_info *ast_module_info;
00275
00276 #if !defined(EMBEDDED_MODULE)
00277 #define __MODULE_INFO_SECTION
00278 #define __MODULE_INFO_GLOBALS
00279 #else
00280
00281
00282
00283
00284
00285
00286
00287 #define __MODULE_INFO_SECTION __attribute__((section(".embed_module")))
00288 #define __MODULE_INFO_GLOBALS .backup_globals = __backup_globals, .restore_globals = __restore_globals,
00289
00290 #define make_var_sub(mod, type) __ ## mod ## _ ## type
00291 #define make_var(mod, type) make_var_sub(mod, type)
00292
00293 extern void make_var(EMBEDDED_MODULE, bss_start);
00294 extern void make_var(EMBEDDED_MODULE, bss_end);
00295 extern void make_var(EMBEDDED_MODULE, data_start);
00296 extern void make_var(EMBEDDED_MODULE, data_end);
00297
00298 static void * __attribute__((section(".embed_module"))) __global_backup;
00299
00300 static int __backup_globals(void)
00301 {
00302 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00303
00304 if (__global_backup)
00305 return 0;
00306
00307 if (!data_size)
00308 return 0;
00309
00310 if (!(__global_backup = ast_malloc(data_size)))
00311 return -1;
00312
00313 memcpy(__global_backup, & make_var(EMBEDDED_MODULE, data_start), data_size);
00314
00315 return 0;
00316 }
00317
00318 static void __restore_globals(void)
00319 {
00320 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00321 size_t bss_size = & make_var(EMBEDDED_MODULE, bss_end) - & make_var(EMBEDDED_MODULE, bss_start);
00322
00323 if (bss_size)
00324 memset(& make_var(EMBEDDED_MODULE, bss_start), 0, bss_size);
00325
00326 if (!data_size || !__global_backup)
00327 return;
00328
00329 memcpy(& make_var(EMBEDDED_MODULE, data_start), __global_backup, data_size);
00330 }
00331 #undef make_var
00332 #undef make_var_sub
00333 #endif
00334
00335 #define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...) \
00336 static struct ast_module_info \
00337 __MODULE_INFO_SECTION \
00338 __mod_info = { \
00339 __MODULE_INFO_GLOBALS \
00340 .name = AST_MODULE, \
00341 .flags = flags_to_set, \
00342 .description = desc, \
00343 .key = keystr, \
00344 .buildopt_sum = AST_BUILDOPT_SUM, \
00345 fields \
00346 }; \
00347 static void __attribute__((constructor)) __reg_module(void) \
00348 { \
00349 ast_module_register(&__mod_info); \
00350 } \
00351 static void __attribute__((destructor)) __unreg_module(void) \
00352 { \
00353 ast_module_unregister(&__mod_info); \
00354 } \
00355 static const struct ast_module_info *ast_module_info = &__mod_info
00356
00357 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00358 AST_MODULE_INFO(keystr, AST_MODFLAG_DEFAULT, desc, \
00359 .load = load_module, \
00360 .unload = unload_module, \
00361 )
00362 #endif
00363
00364
00365
00366
00367
00368
00369
00370
00371
00372
00373
00374
00375
00376
00377
00378
00379
00380
00381 #define ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, ast_module_info->self)
00382
00383
00384
00385
00386
00387
00388
00389
00390
00391
00392
00393
00394
00395
00396
00397
00398
00399
00400
00401 int ast_register_application2(const char *app, int (*execute)(struct ast_channel *, void *),
00402 const char *synopsis, const char *description, void *mod);
00403
00404
00405
00406
00407
00408
00409
00410
00411
00412
00413
00414 int ast_unregister_application(const char *app);
00415
00416
00417 #if defined(__cplusplus) || defined(c_plusplus)
00418 }
00419 #endif
00420
00421 #endif