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
00183
00184 const char *ast_module_name(const struct ast_module *mod);
00185
00186
00187
00188
00189
00190 struct ast_module_user;
00191 struct ast_module_user_list;
00192
00193
00194
00195
00196
00197
00198 enum ast_module_flags {
00199 AST_MODFLAG_DEFAULT = 0,
00200 AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00201 AST_MODFLAG_LOAD_ORDER = (1 << 1),
00202 };
00203
00204 enum ast_module_load_priority {
00205 AST_MODPRI_REALTIME_DEPEND = 10,
00206 AST_MODPRI_REALTIME_DEPEND2 = 20,
00207 AST_MODPRI_REALTIME_DRIVER = 30,
00208 AST_MODPRI_TIMING = 40,
00209 AST_MODPRI_CHANNEL_DEPEND = 50,
00210 AST_MODPRI_CHANNEL_DRIVER = 60,
00211 AST_MODPRI_APP_DEPEND = 70,
00212 AST_MODPRI_DEVSTATE_PROVIDER = 80,
00213 AST_MODPRI_DEVSTATE_PLUGIN = 90,
00214 AST_MODPRI_CDR_DRIVER = 100,
00215 AST_MODPRI_DEFAULT = 128,
00216 AST_MODPRI_DEVSTATE_CONSUMER = 150,
00217 };
00218
00219 struct ast_module_info {
00220
00221
00222
00223
00224
00225
00226
00227 struct ast_module *self;
00228 enum ast_module_load_result (*load)(void);
00229 int (*reload)(void);
00230 int (*unload)(void);
00231 int (*backup_globals)(void);
00232 void (*restore_globals)(void);
00233 const char *name;
00234 const char *description;
00235
00236
00237
00238
00239
00240
00241
00242 const char *key;
00243 unsigned int flags;
00244
00245
00246 const char buildopt_sum[33];
00247
00248
00249
00250
00251
00252
00253 unsigned char load_pri;
00254
00255
00256
00257
00258 const char *nonoptreq;
00259 };
00260
00261 void ast_module_register(const struct ast_module_info *);
00262 void ast_module_unregister(const struct ast_module_info *);
00263
00264 struct ast_module_user *__ast_module_user_add(struct ast_module *, struct ast_channel *);
00265 void __ast_module_user_remove(struct ast_module *, struct ast_module_user *);
00266 void __ast_module_user_hangup_all(struct ast_module *);
00267
00268 #define ast_module_user_add(chan) __ast_module_user_add(ast_module_info->self, chan)
00269 #define ast_module_user_remove(user) __ast_module_user_remove(ast_module_info->self, user)
00270 #define ast_module_user_hangup_all() __ast_module_user_hangup_all(ast_module_info->self)
00271
00272 struct ast_module *ast_module_ref(struct ast_module *);
00273 void ast_module_unref(struct ast_module *);
00274
00275 #if defined(__cplusplus) || defined(c_plusplus)
00276 #define AST_MODULE_INFO(keystr, flags_to_set, desc, load_func, unload_func, reload_func, load_pri) \
00277 static struct ast_module_info __mod_info = { \
00278 NULL, \
00279 load_func, \
00280 reload_func, \
00281 unload_func, \
00282 NULL, \
00283 NULL, \
00284 AST_MODULE, \
00285 desc, \
00286 keystr, \
00287 flags_to_set, \
00288 AST_BUILDOPT_SUM, \
00289 load_pri, \
00290 }; \
00291 static void __attribute__((constructor)) __reg_module(void) \
00292 { \
00293 ast_module_register(&__mod_info); \
00294 } \
00295 static void __attribute__((destructor)) __unreg_module(void) \
00296 { \
00297 ast_module_unregister(&__mod_info); \
00298 } \
00299 static const __attribute__((unused)) struct ast_module_info *ast_module_info = &__mod_info
00300
00301 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00302 AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc, \
00303 load_module, \
00304 unload_module, \
00305 NULL, \
00306 AST_MODPRI_DEFAULT \
00307 )
00308 #else
00309
00310
00311
00312
00313 static const __attribute__((unused)) struct ast_module_info *ast_module_info;
00314
00315 #if !defined(EMBEDDED_MODULE)
00316 #define __MODULE_INFO_SECTION
00317 #define __MODULE_INFO_GLOBALS
00318 #else
00319
00320
00321
00322
00323
00324
00325
00326 #define __MODULE_INFO_SECTION __attribute__((section(".embed_module")))
00327 #define __MODULE_INFO_GLOBALS .backup_globals = __backup_globals, .restore_globals = __restore_globals,
00328
00329 #define make_var_sub(mod, type) __ ## mod ## _ ## type
00330 #define make_var(mod, type) make_var_sub(mod, type)
00331
00332 extern void make_var(EMBEDDED_MODULE, bss_start);
00333 extern void make_var(EMBEDDED_MODULE, bss_end);
00334 extern void make_var(EMBEDDED_MODULE, data_start);
00335 extern void make_var(EMBEDDED_MODULE, data_end);
00336
00337 static void * __attribute__((section(".embed_module"))) __global_backup;
00338
00339 static int __backup_globals(void)
00340 {
00341 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00342
00343 if (__global_backup)
00344 return 0;
00345
00346 if (!data_size)
00347 return 0;
00348
00349 if (!(__global_backup = ast_malloc(data_size)))
00350 return -1;
00351
00352 memcpy(__global_backup, & make_var(EMBEDDED_MODULE, data_start), data_size);
00353
00354 return 0;
00355 }
00356
00357 static void __restore_globals(void)
00358 {
00359 size_t data_size = & make_var(EMBEDDED_MODULE, data_end) - & make_var(EMBEDDED_MODULE, data_start);
00360 size_t bss_size = & make_var(EMBEDDED_MODULE, bss_end) - & make_var(EMBEDDED_MODULE, bss_start);
00361
00362 if (bss_size)
00363 memset(& make_var(EMBEDDED_MODULE, bss_start), 0, bss_size);
00364
00365 if (!data_size || !__global_backup)
00366 return;
00367
00368 memcpy(& make_var(EMBEDDED_MODULE, data_start), __global_backup, data_size);
00369 }
00370 #undef make_var
00371 #undef make_var_sub
00372 #endif
00373
00374 #define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...) \
00375 static struct ast_module_info \
00376 __MODULE_INFO_SECTION \
00377 __mod_info = { \
00378 __MODULE_INFO_GLOBALS \
00379 .name = AST_MODULE, \
00380 .flags = flags_to_set, \
00381 .description = desc, \
00382 .key = keystr, \
00383 .buildopt_sum = AST_BUILDOPT_SUM, \
00384 fields \
00385 }; \
00386 static void __attribute__((constructor)) __reg_module(void) \
00387 { \
00388 ast_module_register(&__mod_info); \
00389 } \
00390 static void __attribute__((destructor)) __unreg_module(void) \
00391 { \
00392 ast_module_unregister(&__mod_info); \
00393 } \
00394 static const struct ast_module_info *ast_module_info = &__mod_info
00395
00396 #define AST_MODULE_INFO_STANDARD(keystr, desc) \
00397 AST_MODULE_INFO(keystr, AST_MODFLAG_LOAD_ORDER, desc, \
00398 .load = load_module, \
00399 .unload = unload_module, \
00400 .load_pri = AST_MODPRI_DEFAULT, \
00401 )
00402 #endif
00403
00404
00405
00406
00407
00408
00409
00410
00411
00412
00413
00414
00415
00416
00417
00418
00419
00420
00421 #define ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, ast_module_info->self)
00422
00423
00424
00425
00426
00427
00428
00429
00430
00431
00432
00433
00434
00435
00436
00437 #define ast_register_application_xml(app, execute) ast_register_application(app, execute, NULL, NULL)
00438
00439
00440
00441
00442
00443
00444
00445
00446
00447
00448
00449
00450
00451
00452
00453
00454
00455
00456
00457
00458 int ast_register_application2(const char *app, int (*execute)(struct ast_channel *, const char *),
00459 const char *synopsis, const char *description, void *mod);
00460
00461
00462
00463
00464
00465
00466
00467
00468
00469
00470
00471 int ast_unregister_application(const char *app);
00472
00473
00474 #if defined(__cplusplus) || defined(c_plusplus)
00475 }
00476 #endif
00477
00478 #endif