home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F232597_dso.html.en < prev    next >
Extensible Markup Language  |  2003-03-30  |  16KB  |  302 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>Dynamic Shared Object (DSO) Support - Apache HTTP Server</title>
  9. <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="./images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page"><div id="page-header">
  14. <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="./images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="./">Version 2.0</a></div><div id="page-content"><div id="preamble"><h1>Dynamic Shared Object (DSO) Support</h1>
  20.     <p>The Apache HTTP Server is a modular program where the
  21.     administrator can choose the functionality to include in the
  22.     server by selecting a set of modules. The modules can be
  23.     statically compiled into the <code>httpd</code> binary when the
  24.     server is built. Alternatively, modules can be compiled as
  25.     Dynamic Shared Objects (DSOs) that exist separately from the
  26.     main <code>httpd</code> binary file. DSO modules may be
  27.     compiled at the time the server is built, or they may be
  28.     compiled and added at a later time using the Apache Extension
  29.     Tool (<a href="programs/apxs.html">apxs</a>).</p>
  30.  
  31.     <p>This document describes how to use DSO modules as well as
  32.     the theory behind their use.</p>
  33.   </div>
  34. <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#implementation">Implementation</a></li>
  35. <li><img alt="" src="./images/down.gif" /> <a href="#usage">Usage Summary</a></li>
  36. <li><img alt="" src="./images/down.gif" /> <a href="#background">Background</a></li>
  37. <li><img alt="" src="./images/down.gif" /> <a href="#advantages">Advantages and Disadvantages</a></li>
  38. </ul></div>
  39. <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  40. <div class="section">
  41. <h2><a name="implementation" id="implementation">Implementation</a></h2>
  42.  
  43. <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_so.html">mod_so</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code></li></ul></td></tr></table>
  44.  
  45.     <p>The DSO support for loading individual Apache modules is based
  46.     on a module named <code class="module"><a href="./mod/mod_so.html">mod_so</a></code> which must be statically
  47.     compiled into the Apache core. It is the only module besides
  48.     <code class="module"><a href="./mod/core.html">core</a></code> which cannot be put into a DSO
  49.     itself. Practically all other distributed Apache modules can then
  50.     be placed into a DSO by individually enabling the DSO build for
  51.     them via <code>configure</code>'s
  52.     <code>--enable-<em>module</em>=shared</code> option as discussed
  53.     in the <a href="install.html">install documentation</a>. After a
  54.     module is compiled into a DSO named <code>mod_foo.so</code> you
  55.     can use <code class="module"><a href="./mod/mod_so.html">mod_so</a></code>'s <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code> command in your
  56.     <code>httpd.conf</code> file to load this module at server startup
  57.     or restart.</p>
  58.  
  59.     <p>To simplify this creation of DSO files for Apache modules
  60.     (especially for third-party modules) a new support program
  61.     named <a href="programs/apxs.html">apxs</a> (<em>APache
  62.     eXtenSion</em>) is available. It can be used to build DSO based
  63.     modules <em>outside of</em> the Apache source tree. The idea is
  64.     simple: When installing Apache the <code>configure</code>'s
  65.     <code>make install</code> procedure installs the Apache C
  66.     header files and puts the platform-dependent compiler and
  67.     linker flags for building DSO files into the <code>apxs</code>
  68.     program. This way the user can use <code>apxs</code> to compile
  69.     his Apache module sources without the Apache distribution
  70.     source tree and without having to fiddle with the
  71.     platform-dependent compiler and linker flags for DSO
  72.     support.</p>
  73. </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  74. <div class="section">
  75. <h2><a name="usage" id="usage">Usage Summary</a></h2>
  76.  
  77.     <p>To give you an overview of the DSO features of Apache 2.0,
  78.     here is a short and concise summary:</p>
  79.  
  80.     <ol>
  81.       <li>
  82.         Build and install a <em>distributed</em> Apache module, say
  83.         <code>mod_foo.c</code>, into its own DSO
  84.         <code>mod_foo.so</code>: 
  85.  
  86. <div class="example"><p><code>
  87. $ ./configure --prefix=/path/to/install --enable-foo=shared<br />
  88. $ make install
  89. </code></p></div>
  90.       </li>
  91.  
  92.       <li>
  93.         Build and install a <em>third-party</em> Apache module, say
  94.         <code>mod_foo.c</code>, into its own DSO
  95.         <code>mod_foo.so</code>: 
  96.  
  97. <div class="example"><p><code>
  98. $ ./configure --add-module=module_type:/path/to/3rdparty/mod_foo.c --enable-foo=shared<br />
  99. $ make install
  100. </code></p></div>
  101.       </li>
  102.  
  103.       <li>
  104.         Configure Apache for <em>later installation</em> of shared
  105.         modules: 
  106.  
  107. <div class="example"><p><code>
  108. $ ./configure --enable-so<br />
  109. $ make install
  110. </code></p></div>
  111.       </li>
  112.  
  113.       <li>
  114.         Build and install a <em>third-party</em> Apache module, say
  115.         <code>mod_foo.c</code>, into its own DSO
  116.         <code>mod_foo.so</code> <em>outside of</em> the Apache
  117.         source tree using <a href="programs/apxs.html">apxs</a>: 
  118.  
  119. <div class="example"><p><code>
  120. $ cd /path/to/3rdparty<br />
  121. $ apxs -c mod_foo.c<br />
  122. $ apxs -i -a -n foo mod_foo.la
  123. </code></p></div>
  124.       </li>
  125.     </ol>
  126.  
  127.     <p>In all cases, once the shared module is compiled, you must
  128.     use a <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
  129.     directive in <code>httpd.conf</code> to tell Apache to activate
  130.     the module.</p>
  131. </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  132. <div class="section">
  133. <h2><a name="background" id="background">Background</a></h2>
  134.  
  135.     <p>On modern Unix derivatives there exists a nifty mechanism
  136.     usually called dynamic linking/loading of <em>Dynamic Shared
  137.     Objects</em> (DSO) which provides a way to build a piece of
  138.     program code in a special format for loading it at run-time
  139.     into the address space of an executable program.</p>
  140.  
  141.     <p>This loading can usually be done in two ways: Automatically
  142.     by a system program called <code>ld.so</code> when an
  143.     executable program is started or manually from within the
  144.     executing program via a programmatic system interface to the
  145.     Unix loader through the system calls
  146.     <code>dlopen()/dlsym()</code>.</p>
  147.  
  148.     <p>In the first way the DSO's are usually called <em>shared
  149.     libraries</em> or <em>DSO libraries</em> and named
  150.     <code>libfoo.so</code> or <code>libfoo.so.1.2</code>. They
  151.     reside in a system directory (usually <code>/usr/lib</code>)
  152.     and the link to the executable program is established at
  153.     build-time by specifying <code>-lfoo</code> to the linker
  154.     command. This hard-codes library references into the executable
  155.     program file so that at start-time the Unix loader is able to
  156.     locate <code>libfoo.so</code> in <code>/usr/lib</code>, in
  157.     paths hard-coded via linker-options like <code>-R</code> or in
  158.     paths configured via the environment variable
  159.     <code>LD_LIBRARY_PATH</code>. It then resolves any (yet
  160.     unresolved) symbols in the executable program which are
  161.     available in the DSO.</p>
  162.  
  163.     <p>Symbols in the executable program are usually not referenced
  164.     by the DSO (because it's a reusable library of general code)
  165.     and hence no further resolving has to be done. The executable
  166.     program has no need to do anything on its own to use the
  167.     symbols from the DSO because the complete resolving is done by
  168.     the Unix loader. (In fact, the code to invoke
  169.     <code>ld.so</code> is part of the run-time startup code which
  170.     is linked into every executable program which has been bound
  171.     non-static). The advantage of dynamic loading of common library
  172.     code is obvious: the library code needs to be stored only once,
  173.     in a system library like <code>libc.so</code>, saving disk
  174.     space for every program.</p>
  175.  
  176.     <p>In the second way the DSO's are usually called <em>shared
  177.     objects</em> or <em>DSO files</em> and can be named with an
  178.     arbitrary extension (although the canonical name is
  179.     <code>foo.so</code>). These files usually stay inside a
  180.     program-specific directory and there is no automatically
  181.     established link to the executable program where they are used.
  182.     Instead the executable program manually loads the DSO at
  183.     run-time into its address space via <code>dlopen()</code>. At
  184.     this time no resolving of symbols from the DSO for the
  185.     executable program is done. But instead the Unix loader
  186.     automatically resolves any (yet unresolved) symbols in the DSO
  187.     from the set of symbols exported by the executable program and
  188.     its already loaded DSO libraries (especially all symbols from
  189.     the ubiquitous <code>libc.so</code>). This way the DSO gets
  190.     knowledge of the executable program's symbol set as if it had
  191.     been statically linked with it in the first place.</p>
  192.  
  193.     <p>Finally, to take advantage of the DSO's API the executable
  194.     program has to resolve particular symbols from the DSO via
  195.     <code>dlsym()</code> for later use inside dispatch tables
  196.     <em>etc.</em> In other words: The executable program has to
  197.     manually resolve every symbol it needs to be able to use it.
  198.     The advantage of such a mechanism is that optional program
  199.     parts need not be loaded (and thus do not spend memory) until
  200.     they are needed by the program in question. When required,
  201.     these program parts can be loaded dynamically to extend the
  202.     base program's functionality.</p>
  203.  
  204.     <p>Although this DSO mechanism sounds straightforward there is
  205.     at least one difficult step here: The resolving of symbols from
  206.     the executable program for the DSO when using a DSO to extend a
  207.     program (the second way). Why? Because "reverse resolving" DSO
  208.     symbols from the executable program's symbol set is against the
  209.     library design (where the library has no knowledge about the
  210.     programs it is used by) and is neither available under all
  211.     platforms nor standardized. In practice the executable
  212.     program's global symbols are often not re-exported and thus not
  213.     available for use in a DSO. Finding a way to force the linker
  214.     to export all global symbols is the main problem one has to
  215.     solve when using DSO for extending a program at run-time.</p>
  216.  
  217.     <p>The shared library approach is the typical one, because it
  218.     is what the DSO mechanism was designed for, hence it is used
  219.     for nearly all types of libraries the operating system
  220.     provides. On the other hand using shared objects for extending
  221.     a program is not used by a lot of programs.</p>
  222.  
  223.     <p>As of 1998 there are only a few software packages available
  224.     which use the DSO mechanism to actually extend their
  225.     functionality at run-time: Perl 5 (via its XS mechanism and the
  226.     DynaLoader module), Netscape Server, <em>etc.</em> Starting
  227.     with version 1.3, Apache joined the crew, because Apache
  228.     already uses a module concept to extend its functionality and
  229.     internally uses a dispatch-list-based approach to link external
  230.     modules into the Apache core functionality. So, Apache is
  231.     really predestined for using DSO to load its modules at
  232.     run-time.</p>
  233. </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  234. <div class="section">
  235. <h2><a name="advantages" id="advantages">Advantages and Disadvantages</a></h2>
  236.  
  237.     <p>The above DSO based features have the following
  238.     advantages:</p>
  239.  
  240.     <ul>
  241.       <li>The server package is more flexible at run-time because
  242.       the actual server process can be assembled at run-time via
  243.       <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
  244.       <code>httpd.conf</code> configuration commands instead of
  245.       <code>configure</code> options at build-time. For instance
  246.       this way one is able to run different server instances
  247.       (standard & SSL version, minimalistic & powered up
  248.       version [mod_perl, PHP3], <em>etc.</em>) with only one Apache
  249.       installation.</li>
  250.  
  251.       <li>The server package can be easily extended with
  252.       third-party modules even after installation. This is at least
  253.       a great benefit for vendor package maintainers who can create
  254.       a Apache core package and additional packages containing
  255.       extensions like PHP3, mod_perl, mod_fastcgi,
  256.       <em>etc.</em></li>
  257.  
  258.       <li>Easier Apache module prototyping because with the
  259.       DSO/<code>apxs</code> pair you can both work outside the
  260.       Apache source tree and only need an <code>apxs -i</code>
  261.       command followed by an <code>apachectl restart</code> to
  262.       bring a new version of your currently developed module into
  263.       the running Apache server.</li>
  264.     </ul>
  265.  
  266.     <p>DSO has the following disadvantages:</p>
  267.  
  268.     <ul>
  269.       <li>The DSO mechanism cannot be used on every platform
  270.       because not all operating systems support dynamic loading of
  271.       code into the address space of a program.</li>
  272.  
  273.       <li>The server is approximately 20% slower at startup time
  274.       because of the symbol resolving overhead the Unix loader now
  275.       has to do.</li>
  276.  
  277.       <li>The server is approximately 5% slower at execution time
  278.       under some platforms because position independent code (PIC)
  279.       sometimes needs complicated assembler tricks for relative
  280.       addressing which are not necessarily as fast as absolute
  281.       addressing.</li>
  282.  
  283.       <li>Because DSO modules cannot be linked against other
  284.       DSO-based libraries (<code>ld -lfoo</code>) on all platforms
  285.       (for instance a.out-based platforms usually don't provide
  286.       this functionality while ELF-based platforms do) you cannot
  287.       use the DSO mechanism for all types of modules. Or in other
  288.       words, modules compiled as DSO files are restricted to only
  289.       use symbols from the Apache core, from the C library
  290.       (<code>libc</code>) and all other dynamic or static libraries
  291.       used by the Apache core, or from static library archives
  292.       (<code>libfoo.a</code>) containing position independent code.
  293.       The only chances to use other code is to either make sure the
  294.       Apache core itself already contains a reference to it or
  295.       loading the code yourself via <code>dlopen()</code>.</li>
  296.     </ul>
  297.  
  298. </div></div>
  299. <div id="footer">
  300. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  301. <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div>
  302. </body></html>