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