Skip to content
Snippets Groups Projects
  • David M. Lee's avatar
    9bed50db
    optional_api: Fix linking problems between modules that export global symbols · 9bed50db
    David M. Lee authored
    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
    
    
    git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397990 65c4cc65-6c06-0410-ace0-fbb531ad65f3
    9bed50db
    History
    optional_api: Fix linking problems between modules that export global symbols
    David M. Lee authored
    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
    
    
    git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397990 65c4cc65-6c06-0410-ace0-fbb531ad65f3