[asterisk-commits] branch oej/test-this-branch r15869 - in
/team/oej/test-this-branch: ./ includ...
asterisk-commits at lists.digium.com
asterisk-commits at lists.digium.com
Tue Mar 28 17:01:46 MST 2006
Author: oej
Date: Tue Mar 28 18:01:45 2006
New Revision: 15869
URL: http://svn.digium.com/view/asterisk?rev=15869&view=rev
Log:
Update to trunk
Modified:
team/oej/test-this-branch/ (props changed)
team/oej/test-this-branch/include/asterisk/module.h
team/oej/test-this-branch/loader.c
team/oej/test-this-branch/manager.c
Propchange: team/oej/test-this-branch/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Tue Mar 28 18:01:45 2006
@@ -1,1 +1,1 @@
-/trunk:1-15858
+/trunk:1-15867
Modified: team/oej/test-this-branch/include/asterisk/module.h
URL: http://svn.digium.com/view/asterisk/team/oej/test-this-branch/include/asterisk/module.h?rev=15869&r1=15868&r2=15869&view=diff
==============================================================================
--- team/oej/test-this-branch/include/asterisk/module.h (original)
+++ team/oej/test-this-branch/include/asterisk/module.h Tue Mar 28 18:01:45 2006
@@ -41,7 +41,7 @@
#define STATIC_MODULE static /* symbols are static */
#endif
-/* Every module should provide these functions */
+/*! \note Every module should provide these functions */
/*!
* \brief Initialize the module.
*
@@ -292,8 +292,8 @@
AST_LIST_ENTRY(localuser) next;
};
-/*! structure used for lock and refcount of module users.
- * The mutex protects the usecnt field and whatever needs to be
+/*! \brief structure used for lock and refcount of module users.
+ * \note The mutex protects the usecnt field and whatever needs to be
* protected (typically, a list of struct localuser).
* As a trick, if usecnt is initialized with -1,
* ast_format_register will init the mutex for you.
@@ -325,7 +325,7 @@
#define STANDARD_USECOUNT_DECL LOCAL_USER_DECL /* XXX lock remains unused */
-/*! run 'x' protected by lock, then call ast_update_use_count() */
+/*! \brief run 'x' protected by lock, then call ast_update_use_count() */
#define __MOD_PROTECT(x) do { \
ast_mutex_lock(&me.lock); \
x; \
@@ -388,8 +388,8 @@
*/
#define STANDARD_USECOUNT(res) do { res = me.usecnt; } while (0)
-/*
- * XXX The following macro is deprecated, and only used by modules
+/*! \brief Old usecount macro
+ * \note XXX The following macro is deprecated, and only used by modules
* in codecs/ and a few other places which do their own manipulation
* of the usecount variable.
* Its use is supposed to be gradually phased away as those modules
@@ -397,16 +397,18 @@
*/
#define OLD_STANDARD_USECOUNT(res) do { res = localusecnt; } while (0)
-/*!
- * \brief The following is part of the new module management code.
+/*! \page ModMngmnt The Asterisk Module management interface
+ * \par The following is part of the new module management code.
*
* All modules must implement the module API (load, unload...)
* whose functions are exported through fields of a "struct module_symbol";
*
* Modules exporting extra symbols (data or functions), should list
- * them into an array of struct symbol_entry:
+ * them into an array of struct symbol_entry: \r
* struct symbol_entry exported_symbols[]
+ * \r
* of symbols, with a NULL name on the last entry
+ *
* Functions should be added with MOD_FUNC(name),
* data structures with MOD_DATA(_name).
* The array in turn is referenced by struct module_symbol.
@@ -414,6 +416,7 @@
* to a record containing all the methods. This is the API of the module,
* and should be known to the module's clients as well.
*
+ * \par Connections to symbols in other modules
* Modules that require symbols supplied by other modules should
* provide an array
* struct symbol_entry required_symbols[]
@@ -445,7 +448,7 @@
* .buf = buf,
* }
*
- * NOTE: symbol names are 'global' in this module namespace, so it
+ * \note NOTE: symbol names are 'global' in this module namespace, so it
* will be wiser to name exported symbols with a prefix indicating the module
* supplying it, e.g. foo_f, foo_g, foo_buf. Internally to the module,
* symbols are still static so they can keep short and meaningful names.
@@ -458,6 +461,36 @@
*
* Note that the loader requires that no fields of exported_symbols
* are NULL, because that is used as an indication of the end of the array.
+ *
+ * \par Module states
+ * Modules can be in a number of different states, as below:
+ * - \b MS_FAILED attempt to load failed. This is final.
+ * - \b MS_NEW just added to the list, symbols unresolved.
+ * - \b MS_RESOLVED all symbols resolved, but supplier modules not active yet.
+ * - \b MS_CANLOAD all symbols resolved and suppliers are all active
+ * (or we are in a cyclic dependency and we are breaking a loop)
+ * - \b MS_ACTIVE load() returned successfully.
+ *
+ *
+ * \par Module Types
+ * For backward compatibility, we have 3 types of loadable modules:
+ *
+ * - \b MOD_0 these are the 'old style' modules, which export a number
+ * of callbacks, and their full interface, as globally visible
+ * symbols. The module needs to be loaded with RTLD_LAZY and
+ * RTLD_GLOBAL to make symbols visible to other modules, and
+ * to avoid load failures due to cross dependencies.
+ *
+ * - \b MOD_1 almost as above, but the generic callbacks are all into a
+ * a structure, mod_data. Same load requirements as above.
+ *
+ * - \b MOD_2 this is the 'new style' format for modules. The module must
+ * explictly declare which simbols are exported and which
+ * symbols from other modules are used, and the code in this
+ * loader will implement appropriate checks to load the modules
+ * in the correct order. Also this allows to load modules
+ * with RTLD_NOW and RTLD_LOCAL so there is no chance of run-time
+ * bugs due to unresolved symbols or name conflicts.
*/
struct symbol_entry {
Modified: team/oej/test-this-branch/loader.c
URL: http://svn.digium.com/view/asterisk/team/oej/test-this-branch/loader.c?rev=15869&r1=15868&r2=15869&view=diff
==============================================================================
--- team/oej/test-this-branch/loader.c (original)
+++ team/oej/test-this-branch/loader.c Tue Mar 28 18:01:45 2006
@@ -21,6 +21,7 @@
* \brief Module Loader
*
* \author Mark Spencer <markster at digium.com>
+ * - See ModMngMnt
*/
#include <stdio.h>
@@ -74,14 +75,14 @@
* MS_ACTIVE load() returned successfully.
*/
enum st_t { /* possible states of a module */
- MS_FAILED = 0, /* cannot load */
- MS_NEW = 1, /* nothing known */
- MS_RESOLVED = 2, /* all required resolved */
- MS_CANLOAD = 3, /* as above, plus cyclic depend.*/
- MS_ACTIVE = 4, /* all done */
+ MS_FAILED = 0, /*!< cannot load */
+ MS_NEW = 1, /*!< nothing known */
+ MS_RESOLVED = 2, /*!< all required resolved */
+ MS_CANLOAD = 3, /*!< as above, plus cyclic depend.*/
+ MS_ACTIVE = 4, /*!< all done */
};
-/*
+/*! \note
* All module symbols are in module_symbols.
* Modules are then linked in a list of struct module,
* whereas updaters are in a list of struct loadupdate.
@@ -115,7 +116,7 @@
static AST_LIST_HEAD_STATIC(updaters, loadupdate);
AST_MUTEX_DEFINE_STATIC(reloadlock);
-/*
+/*! \note
* helper localuser routines.
* All of these routines are extremely expensive, so the use of
* macros is totally unnecessary from the point of view of performance:
@@ -209,8 +210,8 @@
/*! \brief
* Fetch/release an exported symbol - modify export_refcount by delta
* \param delta 1 to fetch a symbol, -1 to release it.
- * on success, return symbol value.
- * Note, modules in MS_FAIL will never match in a 'get' request.
+ * \return on success, return symbol value.
+ * \note Note, modules in MS_FAIL will never match in a 'get' request.
* If src is non-NULL, on exit *src points to the source module.
*
* Must be called with the lock held.
@@ -297,8 +298,8 @@
/*!
* \brief Resolve symbols and change state accordingly.
- * Return 1 if state changed, 0 otherwise.
- * If MS_FAILED, MS_ACTIVE or MS_CANLOAD there is nothing to do.
+ * \return Return 1 if state changed, 0 otherwise.
+ * \note If MS_FAILED, MS_ACTIVE or MS_CANLOAD there is nothing to do.
* If a symbol cannot be resolved (no supplier or supplier in MS_FAIL),
* move to MS_FAIL and release all symbols;
* If all suppliers are MS_ACTIVE, move to MS_CANLOAD
@@ -333,8 +334,8 @@
return 1;
}
-/*
- * Fixup references and load modules according to their dependency order.
+/*!
+ * \brief Fixup references and load modules according to their dependency order.
* Called when new modules are added to the list.
* The algorithm is as follows:
* - all modules MS_FAILED are changed to MS_NEW, in case something
@@ -342,19 +343,19 @@
* - first try to resolve symbols. If successful, change the
* module's state to MS_RESOLVED otherwise to MS_FAILED
* - repeat on all modules until there is progress:
- * . if it is MS_ACTIVE or MS_FAILED, continue (no progress)
- * . if one has all required modules in MS_ACTIVE, try to load it.
+ * - if it is MS_ACTIVE or MS_FAILED, continue (no progress)
+ * - if one has all required modules in MS_ACTIVE, try to load it.
* If successful it becomes MS_ACTIVE itself, otherwise
* MS_FAILED and releases all symbols.
* In any case, we have progress.
- * . if one of the dependencies is MS_FAILED, release and set to
+ * - if one of the dependencies is MS_FAILED, release and set to
* MS_FAILED here too. We have progress.
* - if we have no progress there is a cyclic dependency.
* Take first and change to MS_CANLOAD, i.e. as if all required are
* MS_ACTIVE. we have progress, so repeat.
- * NOTE:
- * must be called with lock held
- * recursive calls simply return success.
+ * \par NOTE:
+ * - must be called with lock held
+ * - recursive calls simply return success.
*/
static int fixup(const char *caller)
{
@@ -449,7 +450,7 @@
}
/*--- end new-style routines ---*/
-/*
+/*! \note
* In addition to modules, the reload command handles some extra keywords
* which are listed here together with the corresponding handlers.
* This table is also used by the command completion code.
@@ -812,10 +813,10 @@
return cur;
}
-/*
- * load a single module (API call).
+/*!
+ * \brief load a single module (API call).
* (recursive calls from load_module() succeed.
- * Returns 0 on success, -1 on error.
+ * \return Returns 0 on success, -1 on error.
*/
int ast_load_resource(const char *resource_name)
{
@@ -851,7 +852,7 @@
+}
#endif
-/* if enabled, log and output on console the module's name, and try load it */
+/*! \brief if enabled, log and output on console the module's name, and try load it */
static int print_and_load(const char *s, struct ast_config *cfg)
{
char tmp[80];
Modified: team/oej/test-this-branch/manager.c
URL: http://svn.digium.com/view/asterisk/team/oej/test-this-branch/manager.c?rev=15869&r1=15868&r2=15869&view=diff
==============================================================================
--- team/oej/test-this-branch/manager.c (original)
+++ team/oej/test-this-branch/manager.c Tue Mar 28 18:01:45 2006
@@ -206,22 +206,19 @@
static char *complete_show_mancmd(const char *line, const char *word, int pos, int state)
{
- struct manager_action *cur = first_action;
+ struct manager_action *cur;
int which = 0;
+ char *ret = NULL;
ast_mutex_lock(&actionlock);
- while (cur) { /* Walk the list of actions */
- if (!strncasecmp(word, cur->action, strlen(word))) {
- if (++which > state) {
- char *ret = strdup(cur->action);
- ast_mutex_unlock(&actionlock);
- return ret;
- }
- }
- cur = cur->next;
+ for (cur = first_action; cur; cur = cur->next) { /* Walk the list of actions */
+ if (!strncasecmp(word, cur->action, strlen(word)) && ++which > state) {
+ ret = ast_strdup(cur->action);
+ break; /* make sure we exit even if ast_strdup() returns NULL */
+ }
}
ast_mutex_unlock(&actionlock);
- return NULL;
+ return ret;
}
void astman_append(struct mansession *s, const char *fmt, ...)
@@ -759,7 +756,7 @@
char *id = astman_get_header(m,"ActionID");
if (!ast_strlen_zero(id))
- snprintf(idText,256,"ActionID: %s\r\n",id);
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
astman_append(s, "Response: Success\r\n%s", idText);
ast_mutex_lock(&actionlock);
while (cur) { /* Walk the list of actions */
@@ -933,7 +930,7 @@
astman_send_ack(s, m, "Channel status will follow");
if (!ast_strlen_zero(id))
- snprintf(idText,256,"ActionID: %s\r\n",id);
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
if (all)
c = ast_channel_walk_locked(NULL);
else {
@@ -1038,6 +1035,7 @@
return 0;
}
}
+ /* XXX watch out, possible deadlock!!! */
chan = ast_get_channel_by_name_locked(name);
if (!chan) {
char buf[BUFSIZ];
@@ -1234,8 +1232,7 @@
astman_send_error(s, m, "Invalid channel\n");
return 0;
}
- *data = '\0';
- data++;
+ *data++ = '\0';
ast_copy_string(tmp2, callerid, sizeof(tmp2));
ast_callerid_parse(tmp2, &n, &l);
if (n) {
@@ -1318,7 +1315,7 @@
return 0;
}
if (!ast_strlen_zero(id))
- snprintf(idText,256,"ActionID: %s\r\n",id);
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
ret = ast_app_has_voicemail(mailbox, NULL);
astman_append(s, "Response: Success\r\n"
"%s"
@@ -1351,7 +1348,7 @@
}
ast_app_messagecount(mailbox, &newmsgs, &oldmsgs);
if (!ast_strlen_zero(id)) {
- snprintf(idText,256,"ActionID: %s\r\n",id);
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n",id);
}
astman_append(s, "Response: Success\r\n"
"%s"
@@ -1392,7 +1389,7 @@
status = ast_extension_state(NULL, context, exten);
ast_get_hint(hint, sizeof(hint) - 1, NULL, 0, NULL, context, exten);
if (!ast_strlen_zero(id)) {
- snprintf(idText,256,"ActionID: %s\r\n",id);
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
}
astman_append(s, "Response: Success\r\n"
"%s"
@@ -1451,9 +1448,9 @@
astman_send_error(s, m, "Missing action in request");
return 0;
}
- if (!ast_strlen_zero(id)) {
- snprintf(idText,256,"ActionID: %s\r\n",id);
- }
+ if (!ast_strlen_zero(id)) {
+ snprintf(idText, sizeof(idText), "ActionID: %s\r\n",id);
+ }
if (!s->authenticated) {
if (!strcasecmp(action, "Challenge")) {
char *authtype;
More information about the asterisk-commits
mailing list