[asterisk-commits] dlee: trunk r397990 - in /trunk: ./ build_tools/ channels/ channels/sip/inclu...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Fri Aug 30 08:40:42 CDT 2013
Author: dlee
Date: Fri Aug 30 08:40:27 2013
New Revision: 397990
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=397990
Log:
optional_api: Fix linking problems between modules that export global symbols
With the new work in Asterisk 12, there are some uses of the
optional_api that are prone to failure. The details are rather involved,
and captured on [the wiki][1].
This patch addresses the issue by removing almost all of the magic from
the optional API implementation. Instead of relying on weak symbol
resolution, a new optional_api.c module was added to Asterisk core.
For modules providing an optional API, the pointer to the implementation
function is registered with the core. For modules that use an optional
API, a pointer to a stub function, along with a optional_ref function
pointer are registered with the core. The optional_ref function pointers
is set to the implementation function when it's provided, or the stub
function when it's now.
Since the implementation no longer relies on magic, it is now supported
on all platforms. In the spirit of choice, an OPTIONAL_API flag was
added, so we can disable the optional_api if needed (maybe it's buggy on
some bizarre platform I haven't tested on)
The AST_OPTIONAL_API*() macros themselves remained unchanged, so
existing code could remain unchanged. But to help with debugging the
optional_api, the patch limits the #include of optional API's to just
the modules using the API. This also reduces resource waste maintaining
optional_ref pointers that aren't used.
Other changes made as a part of this patch:
* The stubs for http_websocket that wrap system calls set errno to
ENOSYS.
* res_http_websocket now properly increments module use count.
* In loader.c, the while() wrappers around dlclose() were removed. The
while(!dlclose()) is actually an anti-pattern, which can lead to
infinite loops if the module you're attempting to unload exports a
symbol that was directly linked to.
* The special handling of nonoptreq on systems without weak symbol
support was removed, since we no longer rely on weak symbols for
optional_api.
[1]: https://wiki.asterisk.org/wiki/x/wACUAQ
(closes issue ASTERISK-22296)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2797/
........
Merged revisions 397989 from http://svn.asterisk.org/svn/asterisk/branches/12
Added:
trunk/main/optional_api.c
- copied unchanged from r397989, branches/12/main/optional_api.c
trunk/tests/test_optional_api.c
- copied unchanged from r397989, branches/12/tests/test_optional_api.c
Modified:
trunk/ (props changed)
trunk/CHANGES
trunk/build_tools/cflags.xml
trunk/channels/chan_sip.c
trunk/channels/sip/include/sip.h
trunk/configure
trunk/configure.ac
trunk/include/asterisk/ari.h
trunk/include/asterisk/autoconfig.h.in
trunk/include/asterisk/compiler.h
trunk/include/asterisk/http_websocket.h
trunk/include/asterisk/optional_api.h
trunk/main/asterisk.c
trunk/main/loader.c
trunk/res/ari/ari_websockets.c
trunk/res/ari/internal.h
trunk/res/res_ari.c
trunk/res/res_ari_events.c
trunk/res/res_http_websocket.c
trunk/rest-api-templates/res_ari_resource.c.mustache
trunk/rest-api-templates/swagger_model.py
Propchange: trunk/
------------------------------------------------------------------------------
--- branch-12-merged (original)
+++ branch-12-merged Fri Aug 30 08:40:27 2013
@@ -1,1 +1,1 @@
-/branches/12:1-397985
+/branches/12:1-397989
Modified: trunk/CHANGES
URL: http://svnview.digium.com/svn/asterisk/trunk/CHANGES?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/CHANGES (original)
+++ trunk/CHANGES Fri Aug 30 08:40:27 2013
@@ -63,6 +63,9 @@
Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
configuring and installing PJSIP for usage with Asterisk.
+ * Optional API was re-implemented to be more portable, and no longer requires
+ weak reference support from the compiler. The build option OPTIONAL_API may
+ be disabled to disable Optional API support.
Applications
------------------
Modified: trunk/build_tools/cflags.xml
URL: http://svnview.digium.com/svn/asterisk/trunk/build_tools/cflags.xml?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/build_tools/cflags.xml (original)
+++ trunk/build_tools/cflags.xml Fri Aug 30 08:40:27 2013
@@ -1,4 +1,4 @@
- <category name="MENUSELECT_CFLAGS" displayname="Compiler Flags" positive_output="yes" remove_on_change=".lastclean">
+<category name="MENUSELECT_CFLAGS" displayname="Compiler Flags" positive_output="yes" remove_on_change=".lastclean">
<member name="DONT_OPTIMIZE" displayname="Disable Optimizations by the Compiler">
<support_level>core</support_level>
</member>
@@ -28,6 +28,13 @@
<!-- Added to work around GCC bug
See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=47816
-->
+ <support_level>extended</support_level>
+ </member>
+ <member name="OPTIONAL_API" displayname="Enable the optional API">
+ <!-- Added to manually disable the optional API, since
+ it's now supported on all systems.
+ -->
+ <defaultenabled>yes</defaultenabled>
<support_level>extended</support_level>
</member>
<member name="BETTER_BACKTRACES" displayname="Use libbfd (GPL) to generate better inline backtraces">
Modified: trunk/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_sip.c?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Fri Aug 30 08:40:27 2013
@@ -298,6 +298,7 @@
#include "asterisk/stasis_system.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/features_config.h"
+#include "asterisk/http_websocket.h"
/*** DOCUMENTATION
<application name="SIPDtmfMode" language="en_US">
Modified: trunk/channels/sip/include/sip.h
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/include/sip.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/channels/sip/include/sip.h (original)
+++ trunk/channels/sip/include/sip.h Fri Aug 30 08:40:27 2013
@@ -35,7 +35,6 @@
#include "asterisk/indications.h"
#include "asterisk/security_events.h"
#include "asterisk/features.h"
-#include "asterisk/http_websocket.h"
#include "asterisk/rtp_engine.h"
#include "asterisk/netsock2.h"
#include "asterisk/features_config.h"
@@ -768,6 +767,8 @@
int tcp_enabled;
int default_max_forwards; /*!< Default max forwards (SIP Anti-loop) */
};
+
+struct ast_websocket;
/*! \brief The SIP socket definition */
struct sip_socket {
Modified: trunk/configure.ac
URL: http://svnview.digium.com/svn/asterisk/trunk/configure.ac?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/configure.ac (original)
+++ trunk/configure.ac Fri Aug 30 08:40:27 2013
@@ -957,37 +957,9 @@
AST_GCC_ATTRIBUTE(deprecated)
AST_GCC_ATTRIBUTE(sentinel)
AST_GCC_ATTRIBUTE(warn_unused_result)
-
-# Support weak symbols on a platform specific basis. The Mac OS X
-# (Darwin) support must be isolated from the other platforms because
-# it has caused other platforms to fail.
-#
-case "${OSARCH}" in
- darwin*)
- # Allow weak symbol support on Darwin platforms only because there
- # is active community support for it.
- # However, Darwin seems to break weak symbols for each new version.
- #
- AST_GCC_ATTRIBUTE(weak_import, [], [], PBX_WEAKREF)
-
- # Several other platforms including Linux have GCC versions that
- # define the weak attribute. However, this attribute is only
- # setup for use in the code by Darwin.
- AST_GCC_ATTRIBUTE(weak, [], [], PBX_WEAKREF)
- ;;
- linux-gnu)
- # Primarily support weak symbols on Linux platforms.
- #
- AST_GCC_ATTRIBUTE(weakref, [weakref("foo")], static, PBX_WEAKREF)
- ;;
- *)
- # Allow weak symbols on other platforms. However, any problems
- # with this feature on other platforms must be fixed by the
- # community.
- #
- AST_GCC_ATTRIBUTE(weakref, [weakref("foo")], static, PBX_WEAKREF)
- ;;
-esac
+AST_GCC_ATTRIBUTE(may_alias)
+AST_GCC_ATTRIBUTE(constructor)
+AST_GCC_ATTRIBUTE(destructor)
AC_MSG_CHECKING(for -ffunction-sections support)
saved_CFLAGS="${CFLAGS}"
@@ -1180,6 +1152,8 @@
AST_C_DEFINE_CHECK([GLOB_NOMAGIC], [GLOB_NOMAGIC], [glob.h])
AST_C_DEFINE_CHECK([GLOB_BRACE], [GLOB_BRACE], [glob.h])
+
+AST_C_DEFINE_CHECK([RTLD_NOLOAD], [RTLD_NOLOAD], [dlfcn.h])
AST_C_DEFINE_CHECK([IP_MTU_DISCOVER], [IP_MTU_DISCOVER], [netinet/in.h])
Modified: trunk/include/asterisk/ari.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/ari.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/include/asterisk/ari.h (original)
+++ trunk/include/asterisk/ari.h Fri Aug 30 08:40:27 2013
@@ -21,7 +21,7 @@
/*! \file
*
- * \brief Stasis RESTful API hooks.
+ * \brief Asterisk RESTful API hooks.
*
* This header file is used mostly as glue code between generated declarations
* and res_ari.c.
@@ -31,7 +31,14 @@
#include "asterisk/http.h"
#include "asterisk/json.h"
-#include "asterisk/http_websocket.h"
+
+/* Forward-declare websocket structs. This avoids including http_websocket.h,
+ * which causes optional_api stuff to happen, which makes optional_api more
+ * difficult to debug. */
+
+struct ast_websocket_server;
+
+struct ast_websocket;
/*!
* \brief Configured encoding format for JSON output.
Modified: trunk/include/asterisk/autoconfig.h.in
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/autoconfig.h.in?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/include/asterisk/autoconfig.h.in (original)
+++ trunk/include/asterisk/autoconfig.h.in Fri Aug 30 08:40:27 2013
@@ -82,11 +82,20 @@
/* Define to 1 if your GCC C compiler supports the 'const' attribute. */
#undef HAVE_ATTRIBUTE_const
+/* Define to 1 if your GCC C compiler supports the 'constructor' attribute. */
+#undef HAVE_ATTRIBUTE_constructor
+
/* Define to 1 if your GCC C compiler supports the 'deprecated' attribute. */
#undef HAVE_ATTRIBUTE_deprecated
+/* Define to 1 if your GCC C compiler supports the 'destructor' attribute. */
+#undef HAVE_ATTRIBUTE_destructor
+
/* Define to 1 if your GCC C compiler supports the 'malloc' attribute. */
#undef HAVE_ATTRIBUTE_malloc
+
+/* Define to 1 if your GCC C compiler supports the 'may_alias' attribute. */
+#undef HAVE_ATTRIBUTE_may_alias
/* Define to 1 if your GCC C compiler supports the 'pure' attribute. */
#undef HAVE_ATTRIBUTE_pure
@@ -101,15 +110,6 @@
attribute. */
#undef HAVE_ATTRIBUTE_warn_unused_result
-/* Define to 1 if your GCC C compiler supports the 'weak' attribute. */
-#undef HAVE_ATTRIBUTE_weak
-
-/* Define to 1 if your GCC C compiler supports the 'weak_import' attribute. */
-#undef HAVE_ATTRIBUTE_weak_import
-
-/* Define to 1 if your GCC C compiler supports the 'weakref' attribute. */
-#undef HAVE_ATTRIBUTE_weakref
-
/* Define to 1 if you have the Debug symbol decoding library. */
#undef HAVE_BFD
@@ -719,6 +719,9 @@
/* Define to 1 if you have the `roundl' function. */
#undef HAVE_ROUNDL
+
+/* Define if your system has the RTLD_NOLOAD headers. */
+#undef HAVE_RTLD_NOLOAD
/* Define to 1 if your system has /sbin/launchd. */
#undef HAVE_SBIN_LAUNCHD
Modified: trunk/include/asterisk/compiler.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/compiler.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/include/asterisk/compiler.h (original)
+++ trunk/include/asterisk/compiler.h Fri Aug 30 08:40:27 2013
@@ -71,6 +71,12 @@
#define attribute_warn_unused_result
#endif
+#ifdef HAVE_ATTRIBUTE_may_alias
+#define attribute_may_alias __attribute__((may_alias))
+#else
+#define attribute_may_alias
+#endif
+
/* Some older version of GNU gcc (3.3.5 on OpenBSD 4.3 for example) dont like 'NULL' as sentinel */
#define SENTINEL ((char *)NULL)
Modified: trunk/include/asterisk/http_websocket.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/http_websocket.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/include/asterisk/http_websocket.h (original)
+++ trunk/include/asterisk/http_websocket.h Fri Aug 30 08:40:27 2013
@@ -21,6 +21,8 @@
#include "asterisk/http.h"
#include "asterisk/optional_api.h"
+
+#include <errno.h>
/*!
* \file http_websocket.h
@@ -71,7 +73,7 @@
* \retval \c NULL on error
* \since 12
*/
-struct ast_websocket_server *ast_websocket_server_create(void);
+AST_OPTIONAL_API(struct ast_websocket_server *, ast_websocket_server_create, (void), { return NULL; });
/*!
* \brief Callback suitable for use with a \ref ast_http_uri.
@@ -79,7 +81,7 @@
* Set the data field of the ast_http_uri to \ref ast_websocket_server.
* \since 12
*/
-int ast_websocket_uri_cb(struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_vars, struct ast_variable *headers);
+AST_OPTIONAL_API(int, ast_websocket_uri_cb, (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_vars, struct ast_variable *headers), { return -1; });
/*!
* \brief Add a sub-protocol handler to the default /ws server
@@ -141,7 +143,7 @@
*
* \note Once an AST_WEBSOCKET_OPCODE_CLOSE opcode is received the socket will be closed
*/
-AST_OPTIONAL_API(int, ast_websocket_read, (struct ast_websocket *session, char **payload, uint64_t *payload_len, enum ast_websocket_opcode *opcode, int *fragmented), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_read, (struct ast_websocket *session, char **payload, uint64_t *payload_len, enum ast_websocket_opcode *opcode, int *fragmented), { errno = ENOSYS; return -1;});
/*!
* \brief Construct and transmit a WebSocket frame
@@ -154,7 +156,7 @@
* \retval 0 if successfully written
* \retval -1 if error occurred
*/
-AST_OPTIONAL_API(int, ast_websocket_write, (struct ast_websocket *session, enum ast_websocket_opcode opcode, char *payload, uint64_t actual_length), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_write, (struct ast_websocket *session, enum ast_websocket_opcode opcode, char *payload, uint64_t actual_length), { errno = ENOSYS; return -1;});
/*!
* \brief Close a WebSocket session by sending a message with the CLOSE opcode and an optional code
@@ -165,7 +167,7 @@
* \retval 0 if successfully written
* \retval -1 if error occurred
*/
-AST_OPTIONAL_API(int, ast_websocket_close, (struct ast_websocket *session, uint16_t reason), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_close, (struct ast_websocket *session, uint16_t reason), { errno = ENOSYS; return -1;});
/*!
* \brief Enable multi-frame reconstruction up to a certain number of bytes
@@ -207,7 +209,7 @@
*
* \note You must *not* directly read from or write to this file descriptor. It should only be used for polling.
*/
-AST_OPTIONAL_API(int, ast_websocket_fd, (struct ast_websocket *session), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_fd, (struct ast_websocket *session), { errno = ENOSYS; return -1;});
/*!
* \brief Get the remote address for a WebSocket connected session.
@@ -222,7 +224,7 @@
* \retval 0 if unsecure
* \retval 1 if secure
*/
-AST_OPTIONAL_API(int, ast_websocket_is_secure, (struct ast_websocket *session), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_is_secure, (struct ast_websocket *session), { errno = ENOSYS; return -1;});
/*!
* \brief Set the socket of a WebSocket session to be non-blocking.
@@ -230,6 +232,6 @@
* \retval 0 on success
* \retval -1 on failure
*/
-AST_OPTIONAL_API(int, ast_websocket_set_nonblock, (struct ast_websocket *session), {return -1;});
+AST_OPTIONAL_API(int, ast_websocket_set_nonblock, (struct ast_websocket *session), { errno = ENOSYS; return -1;});
#endif
Modified: trunk/include/asterisk/optional_api.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/optional_api.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/include/asterisk/optional_api.h (original)
+++ trunk/include/asterisk/optional_api.h Fri Aug 30 08:40:27 2013
@@ -1,7 +1,7 @@
/*
* Asterisk -- An open source telephony toolkit.
*
- * Copyright (C) 2008, Digium, Inc.
+ * Copyright (C) 2008-2013, Digium, Inc.
*
* Kevin P. Fleming <kpfleming at digium.com>
*
@@ -30,19 +30,6 @@
* have only a part of their functionality dependent on the APIs, and can
* provide the remainder even if the APIs are not available.
*
- * To accomodate this situation, the AST_OPTIONAL_API macro allows an API
- * function to be declared in a special way, if Asterisk being built on a
- * platform that supports special compiler and dynamic linker attributes.
- * If so the API function will actually be a weak symbol, which means if the
- * provider of the API is not loaded, the symbol can still be referenced (unlike a
- * strong symbol, which would cause an immediate fault if not defined when
- * referenced), but it will return NULL signifying the linker/loader was
- * not able to resolve the symbol. In addition, the macro defines a hidden
- * 'stub' version of the API call, using a provided function body, and uses
- * various methods to make the API function symbol actually resolve to
- * that hidden stub, but only when the *real* provider of the symbol has
- * not been found.
- *
* An example can be found in agi.h:
*
* \code
@@ -74,19 +61,6 @@
* apply special aliases to the function prototype; this can be done
* by defining AST_API_MODULE just before including the header file
* containing the AST_OPTIONAL_API macro calls.
- *
- * \note If the platform does not provide adequate resources,
- * then the AST_OPTIONAL_API macro will result in a non-optional function
- * definition; this means that any consumers of the API functions so
- * defined will require that the provider of the API functions be
- * loaded before they can reference the symbols.
- *
- * WARNING WARNING WARNING WARNING WARNING
- *
- * You MUST add the AST_MODFLAG_GLOBAL_SYMBOLS to the module for which you
- * are enabling optional_api functionality, or it will fail to work.
- *
- * WARNING WARNING WARNING WARNING WARNING
*/
/*!
@@ -99,122 +73,14 @@
*/
#define AST_OPTIONAL_API_UNAVAILABLE INT_MIN
-
-#if defined(HAVE_ATTRIBUTE_weak_import) || defined(HAVE_ATTRIBUTE_weak)
-
-/*
- * This is the Darwin (Mac OS/X) implementation, that only provides the 'weak'
- * or 'weak_import' compiler attribute for weak symbols. On this platform,
- *
- * - The module providing the API will only provide a '__' prefixed version
- * of the API function to other modules (this will be hidden from the other
- * modules by the macros), so any modules compiled against older versions
- * of the module that provided a non-prefixed version of the API function
- * will fail to link at runtime.
- * - In the API module itself, access to the API function without using a
- * prefixed name is provided by a static pointer variable that holds the
- * function address.
- * - 'Consumer' modules of the API will use a combination of a weak_import or
- * weak symbol, a local stub function, a pointer variable and a constructor
- * function (which initializes that pointer variable as the module is being
- * loaded) to provide safe, optional access to the API function without any
- * special code being required.
- */
-
-#if defined(HAVE_ATTRIBUTE_weak_import)
-#define __default_attribute weak_import /* pre-Lion */
-#else
-#define __default_attribute weak /* Lion-onwards */
-#endif
-
-#define AST_OPTIONAL_API_NAME(name) __##name
-
-#if defined(AST_API_MODULE)
-
-#define AST_OPTIONAL_API(result, name, proto, stub) \
- result AST_OPTIONAL_API_NAME(name) proto; \
- static attribute_unused typeof(AST_OPTIONAL_API_NAME(name)) * const name = AST_OPTIONAL_API_NAME(name);
-
-#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
- result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto; \
- static attribute_unused typeof(AST_OPTIONAL_API_NAME(name)) * const name = AST_OPTIONAL_API_NAME(name);
-
-#else
-
-#define AST_OPTIONAL_API(result, name, proto, stub) \
- static result __stub__##name proto stub; \
- __attribute__((__default_attribute)) typeof(__stub__##name) AST_OPTIONAL_API_NAME(name); \
- static attribute_unused typeof(__stub__##name) * name; \
- static void __attribute__((constructor)) __init__##name(void) { name = AST_OPTIONAL_API_NAME(name) ? : __stub__##name; }
-
-#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
- static __attribute__((attr)) result __stub__##name proto stub; \
- __attribute__((attr, __default_attribute)) typeof(__stub__##name) AST_OPTIONAL_API_NAME(name); \
- static attribute_unused __attribute__((attr)) typeof(__stub__##name) * name; \
- static void __attribute__((constructor)) __init__##name(void) { name = AST_OPTIONAL_API_NAME(name) ? : __stub__##name; }
-
-#endif
-
-/* End of Darwin (Mac OS/X) implementation */
-
-#elif defined(HAVE_ATTRIBUTE_weakref)
-
-/*
- * This is the generic GCC implementation, used when the 'weakref'
- * compiler attribute is available. On these platforms:
- *
- * - The module providing the API will provide a '__' prefixed version
- * of the API function to other modules (this will be hidden from the other
- * modules by the macros), and also a non-prefixed alias so that modules
- * compiled against older versions of the module that provided a non-prefixed
- * version of the API function will continue to link properly.
- * - In the API module itself, access to the API function without using a
- * prefixed name is provided by the non-prefixed alias described above.
- * - 'Consumer' modules of the API will use a combination of a weakref
- * symbol, a local stub function, a pointer variable and a constructor function
- * (which initializes that pointer variable as the module is being loaded)
- * to provide safe, optional access to the API function without any special
- * code being required.
- */
-
-#define AST_OPTIONAL_API_NAME(name) __##name
-
-#if defined(AST_API_MODULE)
-
-#define AST_OPTIONAL_API(result, name, proto, stub) \
- result AST_OPTIONAL_API_NAME(name) proto; \
- static __attribute__((alias(__stringify(AST_OPTIONAL_API_NAME(name))))) typeof(AST_OPTIONAL_API_NAME(name)) name;
-
-#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
- result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto; \
- static __attribute__((alias(__stringify(AST_OPTIONAL_API_NAME(name))))) typeof(AST_OPTIONAL_API_NAME(name)) name;
-
-#else
-
-#define AST_OPTIONAL_API(result, name, proto, stub) \
- static result __stub__##name proto stub; \
- static __attribute__((weakref(__stringify(AST_OPTIONAL_API_NAME(name))))) typeof(__stub__##name) __ref__##name; \
- static attribute_unused typeof(__stub__##name) * name; \
- static void __attribute__((constructor)) __init__##name(void) { name = __ref__##name ? : __stub__##name; }
-
-#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
- static __attribute__((attr)) result __stub__##name proto stub; \
- static __attribute__((attr, weakref(__stringify(AST_OPTIONAL_API_NAME(name))))) typeof(__stub__##name) __ref__##name; \
- static attribute_unused __attribute__((attr)) typeof(__stub__##name) * name; \
- static void __attribute__((constructor)) __init__##name(void) { name = __ref__##name ? : __stub__##name; }
-
-#endif
-
-/* End of GCC implementation */
-
-#else
-
-/* This is the non-optional implementation. */
-
-#define AST_OPTIONAL_API_NAME(name) name
-
-/*!
- * \brief Define an optional API function
+/*!
+ * \def AST_OPTIONAL_API_NAME(name)
+ * \brief Expands to the name of the implementation function.
+ */
+
+/*!
+ * \def AST_OPTIONAL_API(result, name, proto, stub)
+ * \brief Declare an optional API function
*
* \param result The type of result the function returns
* \param name The name of the function
@@ -225,12 +91,12 @@
* \code
* AST_OPTIONAL_API(int, ast_agi_register, (struct ast_module *mod, agi_command *cmd),
* { return AST_OPTIONAL_API_UNAVAILABLE; });
- * \endcode
- */
-#define AST_OPTIONAL_API(result, name, proto, stub) result AST_OPTIONAL_API_NAME(name) proto
-
-/*!
- * \brief Define an optional API function with compiler attributes
+ * \endcode
+ */
+
+/*!
+ * \def AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub)
+ * \brief Declare an optional API function with compiler attributes
*
* \param result The type of result the function returns
* \param attr Any compiler attributes to be applied to the function (without the __attribute__ wrapper)
@@ -238,12 +104,155 @@
* \param proto The prototype (arguments) of the function
* \param stub The code block that will be used by the hidden stub when needed
*/
-#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto
-
-/* End of non-optional implementation */
-
+
+#if defined(OPTIONAL_API)
+
+#if !defined(HAVE_ATTRIBUTE_constructor) || !defined(HAVE_ATTRIBUTE_constructor)
+#error OPTIONAL_API requires compiler constructor/destructor support
#endif
+/*!
+ * \internal
+ * \brief Function pointer to an optional API function.
+ *
+ * Functions that are declared as optional may have any signature they want;
+ * they are cast to this type as needed. We don't use a \c void pointer, because
+ * technically data and function pointers are incompatible.
+ *
+ * \note
+ * The may_alias attribute is to avoid type punning/strict aliasing warnings
+ * with older GCC's.
+ */
+typedef void (*ast_optional_fn)(void) attribute_may_alias;
+
+/*!
+ * \internal
+ * \brief Provide an implementation of an optional API.
+ *
+ * Any declared usages of this function are linked.
+ *
+ * \param symname Name of the provided function.
+ * \param impl Function pointer to the implementation function.
+ */
+void ast_optional_api_provide(const char *symname, ast_optional_fn impl);
+
+/*!
+ * \internal
+ * \brief Remove an implementation of an optional API.
+ *
+ * Any declared usages of this function are unlinked.
+ *
+ * \param symname Name of the provided function.
+ * \param impl Function pointer to the implementation function.
+ */
+void ast_optional_api_unprovide(const char *symname, ast_optional_fn impl);
+
+/*!
+ * \internal
+ * \brief Define a usage of an optional API.
+ *
+ * If the API has been provided, it will be linked into \a optional_ref.
+ * Otherwise, it will be linked to \a stub until an implementation is provided.
+ *
+ * \param symname Name of the function to use.
+ * \param optional_ref Pointer-to-function-pointer to link to impl/stub.
+ * \param stub Stub function to link to when impl is not available.
+ * \param module Name of the module requesting the API.
+ */
+void ast_optional_api_use(const char *symname, ast_optional_fn *optional_ref,
+ ast_optional_fn stub, const char *module);
+
+/*!
+ * \internal
+ * \brief Remove a usage of an optional API.
+ *
+ * The \a optional_ref will be linked to the \a stub provided at use time,
+ * will no longer be updated if the API is provided/removed.
+ *
+ * \param symname Name of the function to use.
+ * \param optional_ref Pointer-to-function-pointer to link to impl/stub.
+ * \param module Name of the module requesting the API.
+ */
+void ast_optional_api_unuse(const char *symname, ast_optional_fn *optional_ref,
+ const char *module);
+
+/*!
+ * \brief Call at exit to clean up optional_api internals.
+ *
+ * Since the optional_api code might run before main() starts, it can't safely
+ * register its own cleanup handlers. That has to be done within main().
+ */
+void optional_api_cleanup(void);
+
+#define AST_OPTIONAL_API_NAME(name) __##name
+
+#if defined(AST_API_MODULE)
+/* Module defining the API */
+
+#define AST_OPTIONAL_API_IMPL_INIT(name) \
+ static void __attribute__((constructor)) __init__##name##_impl(void) { \
+ ast_optional_api_provide(#name, \
+ (ast_optional_fn)AST_OPTIONAL_API_NAME(name)); \
+ } \
+ static void __attribute__((destructor)) __dtor__##name##_impl(void) { \
+ ast_optional_api_unprovide(#name, \
+ (ast_optional_fn)AST_OPTIONAL_API_NAME(name)); \
+ }
+
+#define AST_OPTIONAL_API(result, name, proto, stub) \
+ result AST_OPTIONAL_API_NAME(name) proto; \
+ static attribute_unused typeof(AST_OPTIONAL_API_NAME(name)) * const \
+ name = AST_OPTIONAL_API_NAME(name); \
+ AST_OPTIONAL_API_IMPL_INIT(name)
+
+#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
+ result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto; \
+ static attribute_unused typeof(AST_OPTIONAL_API_NAME(name)) * const \
+ name = AST_OPTIONAL_API_NAME(name); \
+ AST_OPTIONAL_API_IMPL_INIT(name)
+
+#else
+/* Module using the API */
+
+#define AST_OPTIONAL_API_INIT(name) \
+ static void __attribute__((constructor)) __init__##name(void) { \
+ ast_optional_api_use(#name, (ast_optional_fn *)&name, \
+ (ast_optional_fn)__stub__##name, \
+ AST_MODULE); \
+ } \
+ static void __attribute__((destructor)) __dtor__##name(void) { \
+ ast_optional_api_unuse(#name, (ast_optional_fn *)&name, \
+ AST_MODULE); \
+ }
+
+#define AST_OPTIONAL_API(result, name, proto, stub) \
+ static result __stub__##name proto stub; \
+ static attribute_unused \
+ typeof(__stub__##name) * name; \
+ AST_OPTIONAL_API_INIT(name)
+
+#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
+ static __attribute__((attr)) result __stub__##name proto stub; \
+ static attribute_unused __attribute__((attr)) \
+ typeof(__stub__##name) * name; \
+ AST_OPTIONAL_API_INIT(name)
+
+#endif /* defined(AST_API_MODULE) */
+
+#else /* defined(OPTIONAL_API) */
+
+/* Non-optional API */
+
+#define AST_OPTIONAL_API_NAME(name) name
+
+#define AST_OPTIONAL_API(result, name, proto, stub) \
+ result AST_OPTIONAL_API_NAME(name) proto
+
+#define AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) \
+ result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto
+
+#endif /* defined(OPTIONAL_API) */
+
#undef AST_API_MODULE
#endif /* __ASTERISK_OPTIONAL_API_H */
Modified: trunk/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/asterisk.c?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/main/asterisk.c (original)
+++ trunk/main/asterisk.c Fri Aug 30 08:40:27 2013
@@ -247,6 +247,7 @@
#include "asterisk/stasis_endpoints.h"
#include "asterisk/stasis_system.h"
#include "asterisk/security_events.h"
+#include "asterisk/optional_api.h"
#include "../defaults.h"
@@ -4165,6 +4166,10 @@
ast_el_read_history(filename);
}
+#if defined(OPTIONAL_API)
+ ast_register_cleanup(optional_api_cleanup);
+#endif
+
ast_json_init();
ast_ulaw_init();
ast_alaw_init();
Modified: trunk/main/loader.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/loader.c?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/main/loader.c (original)
+++ trunk/main/loader.c Fri Aug 30 08:40:27 2013
@@ -185,6 +185,8 @@
mod = resource_being_loaded;
}
+ ast_verb(5, "Registering module %s\n", info->name);
+
mod->info = info;
AST_LIST_HEAD_INIT(&mod->users);
@@ -230,6 +232,7 @@
AST_LIST_UNLOCK(&module_list);
if (mod) {
+ ast_verb(5, "Unregistering module %s\n", info->name);
AST_LIST_HEAD_DESTROY(&mod->users);
ast_free(mod);
}
@@ -403,16 +406,83 @@
}
#ifdef LOADABLE_MODULES
+
+/*!
+ * \brief dlclose(), with failure logging.
+ */
+static void logged_dlclose(const char *name, void *lib)
+{
+ if (dlclose(lib) != 0) {
+ ast_log(LOG_WARNING, "Failed to unload %s: %s\n",
+ name, dlerror());
+ }
+}
+
+#if defined(HAVE_RTLD_NOLOAD)
+/*!
+ * \brief Check to see if the given resource is loaded.
+ *
+ * \param resource_name Name of the resource, including .so suffix.
+ * \return False (0) if module is not loaded.
+ * \return True (non-zero) if module is loaded.
+ */
+static int is_module_loaded(const char *resource_name)
+{
+ char fn[PATH_MAX] = "";
+ void *lib;
+
+ ast_verb(10, "Checking if %s is loaded\n", resource_name);
+
+ snprintf(fn, sizeof(fn), "%s/%s", ast_config_AST_MODULE_DIR,
+ resource_name);
+
+ lib = dlopen(fn, RTLD_LAZY | RTLD_NOLOAD);
+
+ if (lib) {
+ ast_verb(10, " %s loaded\n", resource_name);
+ logged_dlclose(resource_name, lib);
+ return 1;
+ }
+
+ ast_verb(10, " %s not loaded\n", resource_name);
+ return 0;
+}
+#endif
+
static void unload_dynamic_module(struct ast_module *mod)
{
+ char *name = ast_strdupa(ast_module_name(mod));
void *lib = mod->lib;
/* WARNING: the structure pointed to by mod is going to
disappear when this operation succeeds, so we can't
dereference it */
- if (lib)
- while (!dlclose(lib));
+ if (!lib) {
+ return;
+ }
+
+ logged_dlclose(name, lib);
+
+ /* There are several situations where the module might still be resident
+ * in memory.
+ *
+ * If somehow there was another dlopen() on the same module (unlikely,
+ * since that all is supposed to happen in loader.c).
+ *
+ * Or the lazy resolution of a global symbol (very likely, since that is
+ * how we load all of our modules that export global symbols).
+ *
+ * Avoid the temptation of repeating the dlclose(). The other code that
+ * dlopened the module still has its module reference, and should close
+ * it itself. In other situations, dlclose() will happily return success
+ * for as many times as you wish to call it.
+ */
+#if defined(HAVE_RTLD_NOLOAD)
+ if (is_module_loaded(name)) {
+ ast_log(LOG_WARNING, "Module '%s' could not be completely unloaded\n", name);
+ }
+#endif
}
static enum ast_module_load_result load_resource(const char *resource_name, unsigned int global_symbols_only, struct ast_heap *resource_heap, int required);
@@ -461,7 +531,7 @@
if (resource_being_loaded != (mod = AST_LIST_LAST(&module_list))) {
ast_log(LOG_WARNING, "Module '%s' did not register itself during load\n", resource_in);
/* no, it did not, so close it and return */
- while (!dlclose(lib));
+ logged_dlclose(resource_in, lib);
/* note that the module's destructor will call ast_module_unregister(),
which will free the structure we allocated in resource_being_loaded */
return NULL;
@@ -472,32 +542,11 @@
/* if we are being asked only to load modules that provide global symbols,
and this one does not, then close it and return */
if (global_symbols_only && !wants_global) {
- while (!dlclose(lib));
+ logged_dlclose(resource_in, lib);
return NULL;
}
- /* This section is a workaround for a gcc 4.1 bug that has already been
- * fixed in later versions. Unfortunately, some distributions, such as
- * RHEL/CentOS 5, distribute gcc 4.1, so we're stuck with having to deal
- * with this issue. This basically ensures that optional_api modules are
- * loaded before any module which requires their functionality. */
-#if !defined(HAVE_ATTRIBUTE_weak_import) && !defined(HAVE_ATTRIBUTE_weakref)
- if (!ast_strlen_zero(mod->info->nonoptreq)) {
- /* Force any required dependencies to load */
- char *each, *required_resource = ast_strdupa(mod->info->nonoptreq);
- while ((each = strsep(&required_resource, ","))) {
- struct ast_module *dependency;
- each = ast_strip(each);
- dependency = find_resource(each, 0);
- /* Is it already loaded? */
- if (!dependency) {
- load_resource(each, global_symbols_only, resource_heap, 1);
- }
- }
- }
-#endif
-
- while (!dlclose(lib));
+ logged_dlclose(resource_in, lib);
resource_being_loaded = NULL;
/* start the load process again */
@@ -523,6 +572,7 @@
return AST_LIST_LAST(&module_list);
}
+
#endif
void ast_module_shutdown(void)
Modified: trunk/res/ari/ari_websockets.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/ari/ari_websockets.c?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/res/ari/ari_websockets.c (original)
+++ trunk/res/ari/ari_websockets.c Fri Aug 30 08:40:27 2013
@@ -20,8 +20,10 @@
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+#include "asterisk/ari.h"
#include "asterisk/astobj2.h"
-#include "asterisk/ari.h"
+#include "asterisk/http_websocket.h"
+#include "internal.h"
/*! \file
*
@@ -163,3 +165,15 @@
return ast_websocket_write(session->ws_session,
AST_WEBSOCKET_OPCODE_TEXT, str, strlen(str));
}
+
+void ari_handle_websocket(struct ast_websocket_server *ws_server,
+ struct ast_tcptls_session_instance *ser, const char *uri,
+ enum ast_http_method method, struct ast_variable *get_params,
+ struct ast_variable *headers)
+{
+ struct ast_http_uri fake_urih = {
+ .data = ws_server,
+ };
+ ast_websocket_uri_cb(ser, &fake_urih, uri, method, get_params,
+ headers);
+}
Modified: trunk/res/ari/internal.h
URL: http://svnview.digium.com/svn/asterisk/trunk/res/ari/internal.h?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/res/ari/internal.h (original)
+++ trunk/res/ari/internal.h Fri Aug 30 08:40:27 2013
@@ -25,7 +25,9 @@
* \author David M. Lee, II <dlee at digium.com>
*/
+#include "asterisk/http.h"
#include "asterisk/json.h"
+#include "asterisk/stringfields.h"
/*! @{ */
@@ -139,5 +141,25 @@
/*! @} */
+/* Forward-declare websocket structs. This avoids including http_websocket.h,
+ * which causes optional_api stuff to happen, which makes optional_api more
+ * difficult to debug. */
+
+struct ast_websocket_server;
+
+/*!
+ * \brief Wrapper for invoking the websocket code for an incoming connection.
+ *
+ * \param ws_server WebSocket server to invoke.
+ * \param ser HTTP session.
+ * \param uri Requested URI.
+ * \param method Requested HTTP method.
+ * \param get_params Parsed query parameters.
+ * \param headers Parsed HTTP headers.
+ */
+void ari_handle_websocket(struct ast_websocket_server *ws_server,
+ struct ast_tcptls_session_instance *ser, const char *uri,
+ enum ast_http_method method, struct ast_variable *get_params,
+ struct ast_variable *headers);
#endif /* ARI_INTERNAL_H_ */
Modified: trunk/res/res_ari.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_ari.c?view=diff&rev=397990&r1=397989&r2=397990
==============================================================================
--- trunk/res/res_ari.c (original)
+++ trunk/res/res_ari.c Fri Aug 30 08:40:27 2013
@@ -124,11 +124,11 @@
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+#include "ari/internal.h"
+#include "asterisk/ari.h"
#include "asterisk/astobj2.h"
#include "asterisk/module.h"
#include "asterisk/paths.h"
-#include "asterisk/ari.h"
-#include "ari/internal.h"
#include <string.h>
#include <sys/stat.h>
@@ -522,11 +522,8 @@
if (handler->ws_server && method == AST_HTTP_GET) {
/* WebSocket! */
- struct ast_http_uri fake_urih = {
- .data = handler->ws_server,
- };
- ast_websocket_uri_cb(ser, &fake_urih, uri, method, get_params,
- headers);
+ ari_handle_websocket(handler->ws_server, ser, uri, method,
+ get_params, headers);
/* Since the WebSocket code handles the connection, we shouldn't
[... 184 lines stripped ...]
More information about the asterisk-commits
mailing list