home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 November / PCWorld_2003-11_cd.bin / Komunik / apache / apache_2.0.47-win32-x86-no_ssl.msi / Data.Cab / F250828_perftuning.xml < prev    next >
Extensible Markup Language  |  2003-05-09  |  48KB  |  1,101 lines

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <manualpage metafile="perf-tuning.xml.meta">
  6.   <parentdocument href="./">Miscellaneous Documentation</parentdocument>
  7.  
  8.   <title>Apache Performance Tuning</title>
  9.  
  10.   <summary>
  11.  
  12.     <note type="warning"><title>Warning:</title>
  13.       <p>This document has not been fully updated
  14.       to take into account changes made in the 2.0 version of the
  15.       Apache HTTP Server. Some of the information may still be
  16.       relevant, but please use it with care.</p>
  17.     </note>
  18.  
  19.     <p>Orignally written by Dean Gaudet.</p>
  20.  
  21.     <p>Apache 2.0 is a general-purpose webserver, designed to
  22.     provide a balance of flexibility, portability, and performance.
  23.     Although it has not been designed specifically to set benchmark
  24.     records, Apache 2.0 is capable of high performance in many
  25.     real-world situations.</p>
  26.  
  27.     <p>Compared to Apache 1.3, release 2.0 contains many additional
  28.     optimizations to increase throughput and scalability. Most of
  29.     these improvements are enabled by default. However, there are
  30.     compile-time and run-time configuration choices that can
  31.     significantly affect performance. This document describes the
  32.     options that a server administrator can configure to tune the
  33.     performance of an Apache 2.0 installation. Some of these
  34.     configuration options enable the httpd to better take advantage
  35.     of the capabilities of the hardware and OS, while others allow
  36.     the administrator to trade functionality for speed.</p>
  37.  
  38.   </summary>
  39.  
  40.   <section id="hardware">
  41.  
  42.     <title>Hardware and Operating System Issues</title>
  43.  
  44.     <p>The single biggest hardware issue affecting webserver
  45.     performance is RAM. A webserver should never ever have to swap,
  46.     as swapping increases the latency of each request beyond a point
  47.     that users consider "fast enough". This causes users to hit
  48.     stop and reload, further increasing the load. You can, and
  49.     should, control the <directive module="mpm_common"
  50.     >MaxClients</directive> setting so that your server
  51.     does not spawn so many children it starts swapping. This procedure
  52.     for doing this is simple: determine the size of your average Apache
  53.     process, by looking at your process list via a tool such as
  54.     <code>top</code>, and divide this into your total available memory,
  55.     leaving some room for other processes.</p>
  56.  
  57.     <p>Beyond that the rest is mundane: get a fast enough CPU, a
  58.     fast enough network card, and fast enough disks, where "fast
  59.     enough" is something that needs to be determined by
  60.     experimentation.</p>
  61.  
  62.     <p>Operating system choice is largely a matter of local
  63.     concerns. But some guidelines that have proven generally
  64.     useful are:</p>
  65.  
  66.     <ul>
  67.       <li>
  68.         <p>Run the latest stable release and patchlevel of the
  69.         operating system that you choose. Many OS suppliers have
  70.         introduced significant performance improvements to their
  71.         TCP stacks and thread libraries in recent years.</p>
  72.       </li>
  73.  
  74.       <li>
  75.         <p>If your OS supports a <code>sendfile(2)</code> system
  76.         call, make sure you install the release and/or patches
  77.         needed to enable it. (With Linux, for example, this means
  78.         using Linux 2.4 or later. For early releases of Solaris 8,
  79.         you may need to apply a patch.) On systems where it is
  80.         available, <code>sendfile</code> enables Apache 2 to deliver
  81.         static content faster and with lower CPU utilization.</p>
  82.       </li>
  83.     </ul>
  84.  
  85.   </section>
  86.  
  87.   <section id="runtime">
  88.  
  89.     <title>Run-Time Configuration Issues</title>
  90.  
  91.     <related>
  92.       <modulelist>
  93.         <module>mod_dir</module>
  94.         <module>mpm_common</module>
  95.         <module>mod_status</module>
  96.       </modulelist>
  97.       <directivelist>
  98.         <directive module="core">AllowOverride</directive>
  99.         <directive module="mod_dir">DirectoryIndex</directive>
  100.         <directive module="core">HostnameLookups</directive>
  101.         <directive module="core">EnableMMAP</directive>
  102.         <directive module="core">EnableSendfile</directive>
  103.         <directive module="core">KeepAliveTimeout</directive>
  104.         <directive module="prefork">MaxSpareServers</directive>
  105.         <directive module="prefork">MinSpareServers</directive>
  106.         <directive module="core">Options</directive>
  107.         <directive module="mpm_common">StartServers</directive>
  108.       </directivelist>
  109.     </related>
  110.  
  111.     <section id="dns">
  112.  
  113.       <title>HostnameLookups and other DNS considerations</title>
  114.  
  115.       <p>Prior to Apache 1.3, <directive module="core"
  116.       >HostnameLookups</directive> defaulted to <code>On</code>.
  117.       This adds latency to every request because it requires a
  118.       DNS lookup to complete before the request is finished. In
  119.       Apache 1.3 this setting defaults to <code>Off</code>. If you need
  120.       to have addresses in your log files resolved to hostnames, use the
  121.       <a href="../programs/logresolve.html"><code>logresolve</code></a>
  122.       program that comes with Apache, on one of the numerous log
  123.       reporting packages which are available.</p>
  124.  
  125.       <p>It is recommended that you do this sort of postprocessing of
  126.       your log files on some machine other than the production web
  127.       server machine, in order that this activity not adversely affect
  128.       server performance.</p>
  129.  
  130.       <p>If you use any <code><directive module="mod_access">Allow</directive> 
  131.       from domain</code> or <code><directive 
  132.       module="mod_access">Deny</directive> from domain</code> 
  133.       directives (i.e., using a hostname, or a domain name, rather than
  134.       an IP address) then you will pay for
  135.       a double reverse DNS lookup (a reverse, followed by a forward
  136.       to make sure that the reverse is not being spoofed). For best
  137.       performence, therefore, use IP addresses, rather than names, when
  138.       using these directives, if possible.</p>
  139.  
  140.       <p>Note that it's possible to scope the directives, such as
  141.       within a <code><Location /server-status></code> section.
  142.       In this case the DNS lookups are only performed on requests
  143.       matching the criteria. Here's an example which disables lookups
  144.       except for <code>.html</code> and <code>.cgi</code> files:</p>
  145.  
  146.       <example>
  147.         HostnameLookups off<br />
  148.         <Files ~ "\.(html|cgi)$"><br />
  149.         <indent>
  150.           HostnameLookups on<br />
  151.         </indent>
  152.         </Files>
  153.       </example>
  154.  
  155.       <p>But even still, if you just need DNS names in some CGIs you
  156.       could consider doing the <code>gethostbyname</code> call in the
  157.       specific CGIs that need it.</p>
  158.  
  159.     </section>
  160.  
  161.     <section id="symlinks">
  162.  
  163.       <title>FollowSymLinks and SymLinksIfOwnerMatch</title>
  164.  
  165.       <p>Wherever in your URL-space you do not have an <code>Options
  166.       FollowSymLinks</code>, or you do have an <code>Options
  167.       SymLinksIfOwnerMatch</code> Apache will have to issue extra
  168.       system calls to check up on symlinks. One extra call per
  169.       filename component. For example, if you had:</p>
  170.  
  171.       <example>
  172.         DocumentRoot /www/htdocs<br />
  173.         <Directory /><br />
  174.         <indent>
  175.           Options SymLinksIfOwnerMatch<br />
  176.         </indent>
  177.         </Directory>
  178.       </example>
  179.  
  180.       <p>and a request is made for the URI <code>/index.html</code>.
  181.       Then Apache will perform <code>lstat(2)</code> on
  182.       <code>/www</code>, <code>/www/htdocs</code>, and
  183.       <code>/www/htdocs/index.html</code>. The results of these
  184.       <code>lstats</code> are never cached, so they will occur on
  185.       every single request. If you really desire the symlinks
  186.       security checking you can do something like this:</p>
  187.  
  188.       <example>
  189.         DocumentRoot /www/htdocs<br />
  190.         <Directory /><br />
  191.         <indent>
  192.           Options FollowSymLinks<br />
  193.         </indent>
  194.         </Directory><br />
  195.         <br />
  196.         <Directory /www/htdocs><br />
  197.         <indent>
  198.           Options -FollowSymLinks +SymLinksIfOwnerMatch<br />
  199.         </indent>
  200.         </Directory>
  201.       </example>
  202.  
  203.       <p>This at least avoids the extra checks for the
  204.       <directive module="core">DocumentRoot</directive> path.
  205.       Note that you'll need to add similar sections if you
  206.       have any <directive module="mod_alias">Alias</directive> or
  207.       <directive module="mod_rewrite">RewriteRule</directive> paths
  208.       outside of your document root. For highest performance,
  209.       and no symlink protection, set <code>FollowSymLinks</code>
  210.       everywhere, and never set <code>SymLinksIfOwnerMatch</code>.</p>
  211.  
  212.     </section>
  213.  
  214.     <section id="htacess">
  215.  
  216.       <title>AllowOverride</title>
  217.  
  218.       <p>Wherever in your URL-space you allow overrides (typically
  219.       <code>.htaccess</code> files) Apache will attempt to open
  220.       <code>.htaccess</code> for each filename component. For
  221.       example,</p>
  222.  
  223.       <example>
  224.         DocumentRoot /www/htdocs<br />
  225.         <Directory /><br />
  226.         <indent>
  227.           AllowOverride all<br />
  228.         </indent>
  229.         </Directory>
  230.       </example>
  231.  
  232.       <p>and a request is made for the URI <code>/index.html</code>.
  233.       Then Apache will attempt to open <code>/.htaccess</code>,
  234.       <code>/www/.htaccess</code>, and
  235.       <code>/www/htdocs/.htaccess</code>. The solutions are similar
  236.       to the previous case of <code>Options FollowSymLinks</code>.
  237.       For highest performance use <code>AllowOverride None</code>
  238.       everywhere in your filesystem.</p>
  239.  
  240.     </section>
  241.  
  242.     <section id="negotiation">
  243.  
  244.       <title>Negotiation</title>
  245.  
  246.       <p>If at all possible, avoid content-negotiation if you're
  247.       really interested in every last ounce of performance. In
  248.       practice the benefits of negotiation outweigh the performance
  249.       penalties. There's one case where you can speed up the server.
  250.       Instead of using a wildcard such as:</p>
  251.  
  252.       <example>
  253.         DirectoryIndex index
  254.       </example>
  255.  
  256.       <p>Use a complete list of options:</p>
  257.  
  258.       <example>
  259.         DirectoryIndex index.cgi index.pl index.shtml index.html
  260.       </example>
  261.  
  262.       <p>where you list the most common choice first.</p>
  263.  
  264.       <p>Also note that explicitly creating a <code>type-map</code>
  265.       file provides better performance than using
  266.       <code>MultiViews</code>, as the necessary information can be
  267.       determined by reading this single file, rather than having to
  268.       scan the directory for files.</p>
  269.  
  270.     <p>If your site needs content negotiation consider using
  271.     <code>type-map</code> files, rather than the <code>Options
  272.     MultiViews</code> directive to accomplish the negotiation. See the
  273.     <a href="../content-negotiation.html">Content Negotiation</a>
  274.     documentation for a full discussion of the methods of negotiation,
  275.     and instructions for creating <code>type-map</code> files.</p>
  276.  
  277.     </section>
  278.  
  279.     <section>
  280.  
  281.       <title>Memory-mapping</title>
  282.  
  283.       <p>In situations where Apache 2.0 needs to look at the contents
  284.       of a file being delivered--for example, when doing server-side-include
  285.       processing--it normally memory-maps the file if the OS supports
  286.       some form of <code>mmap(2)</code>.</p>
  287.  
  288.       <p>On some platforms, this memory-mapping improves performance.
  289.       However, there are cases where memory-mapping can hurt the performance
  290.       or even the stability of the httpd:</p>
  291.  
  292.       <ul>
  293.         <li>
  294.           <p>On some operating systems, <code>mmap</code> does not scale
  295.           as well as <code>read(2)</code> when the number of CPUs increases.
  296.           On multiprocessor Solaris servers, for example, Apache 2.0 sometimes
  297.           delivers server-parsed files faster when <code>mmap</code> is disabled.</p>
  298.         </li>
  299.  
  300.         <li>
  301.           <p>If you memory-map a file located on an NFS-mounted filesystem
  302.           and a process on another NFS client machine deletes or truncates
  303.           the file, your process may get a bus error the next time it tries
  304.           to access the mapped file content.</p>
  305.         </li>
  306.       </ul>
  307.  
  308.       <p>For installations where either of these factors applies, you
  309.       should use <code>EnableMMAP off</code> to disable the memory-mapping
  310.       of delivered files. (Note: This directive can be overridden on
  311.       a per-directory basis.)</p>
  312.  
  313.     </section>
  314.  
  315.     <section>
  316.  
  317.       <title>Sendfile</title>
  318.  
  319.       <p>In situations where Apache 2.0 can ignore the contents of the file
  320.       to be delivered -- for example, when serving static file content -- 
  321.       it normally uses the kernel sendfile support the file if the OS 
  322.       supports the <code>sendfile(2)</code> operation.</p>
  323.  
  324.       <p>On most platforms, using sendfile improves performance by eliminating
  325.       separate read and send mechanics.  However, there are cases where using
  326.       sendfile can harm the stability of the httpd:</p>
  327.  
  328.       <ul>
  329.         <li>
  330.           <p>Some platforms may have broken sendfile support that the build
  331.           system did not detect, especially if the binaries were built on
  332.           another box and moved to such a machine with broken sendfile support.</p>
  333.         </li>
  334.         <li>
  335.           <p>With an NFS-mounted files, the kernel may be unable 
  336.           to reliably serve the network file through it's own cache.</p>
  337.         </li>
  338.       </ul>
  339.  
  340.       <p>For installations where either of these factors applies, you
  341.       should use <code>EnableSendfile off</code> to disable sendfile
  342.       delivery of file contents. (Note: This directive can be overridden 
  343.       on a per-directory basis.)</p>
  344.  
  345.     </section>
  346.  
  347.     <section id="process">
  348.  
  349.       <title>Process Creation</title>
  350.  
  351.       <p>Prior to Apache 1.3 the <directive module="prefork"
  352.       >MinSpareServers</directive>, <directive module="prefork"
  353.       >MaxSpareServers</directive>, and <directive module="mpm_common"
  354.       >StartServers</directive> settings all had drastic effects on
  355.       benchmark results. In particular, Apache required a "ramp-up"
  356.       period in order to reach a number of children sufficient to serve
  357.       the load being applied. After the initial spawning of
  358.       <directive module="mpm_common">StartServers</directive> children,
  359.       only one child per second would be created to satisfy the
  360.       <directive module="prefork">MinSpareServers</directive>
  361.       setting. So a server being accessed by 100 simultaneous
  362.       clients, using the default <directive module="mpm_common"
  363.       >StartServers</directive> of <code>5</code> would take on
  364.       the order 95 seconds to spawn enough children to handle
  365.       the load. This works fine in practice on real-life servers,
  366.       because they aren't restarted frequently. But does really
  367.       poorly on benchmarks which might only run for ten minutes.</p>
  368.  
  369.       <p>The one-per-second rule was implemented in an effort to
  370.       avoid swamping the machine with the startup of new children. If
  371.       the machine is busy spawning children it can't service
  372.       requests. But it has such a drastic effect on the perceived
  373.       performance of Apache that it had to be replaced. As of Apache
  374.       1.3, the code will relax the one-per-second rule. It will spawn
  375.       one, wait a second, then spawn two, wait a second, then spawn
  376.       four, and it will continue exponentially until it is spawning
  377.       32 children per second. It will stop whenever it satisfies the
  378.       <directive module="prefork">MinSpareServers</directive>
  379.       setting.</p>
  380.  
  381.       <p>This appears to be responsive enough that it's almost
  382.       unnecessary to twiddle the <directive module="prefork"
  383.       >MinSpareServers</directive>, <directive module="prefork"
  384.       >MaxSpareServers</directive> and <directive module="mpm_common"
  385.       >StartServers</directive> knobs. When more than 4 children are
  386.       spawned per second, a message will be emitted to the
  387.       <directive module="core">ErrorLog</directive>. If you
  388.       see a lot of these errors then consider tuning these settings.
  389.       Use the <module>mod_status</module> output as a guide.</p>
  390.  
  391.     <p>Related to process creation is process death induced by the
  392.     <directive module="mpm_common">MaxRequestsPerChild</directive>
  393.     setting. By default this is <code>0</code>,
  394.     which means that there is no limit to the number of requests
  395.     handled per child. If your configuration currently has this set
  396.     to some very low number, such as <code>30</code>, you may want to bump this
  397.     up significantly. If you are running SunOS or an old version of
  398.     Solaris, limit this to <code>10000</code> or so because of memory leaks.</p>
  399.  
  400.     <p>When keep-alives are in use, children will be kept busy
  401.     doing nothing waiting for more requests on the already open
  402.     connection. The default <directive module="core"
  403.     >KeepAliveTimeout</directive> of <code>15</code>
  404.     seconds attempts to minimize this effect. The tradeoff here is
  405.     between network bandwidth and server resources. In no event
  406.     should you raise this above about <code>60</code> seconds, as <a
  407.     href="http://www.research.digital.com/wrl/techreports/abstracts/95.4.html">
  408.     most of the benefits are lost</a>.</p>
  409.  
  410.     </section>
  411.  
  412.   </section>
  413.  
  414.   <section id="compiletime">
  415.  
  416.     <title>Compile-Time Configuration Issues</title>
  417.  
  418.     <section>
  419.  
  420.       <title>Choosing an MPM</title>
  421.  
  422.       <p>Apache 2.x supports pluggable concurrency models, called
  423.       <a href="../mpm.html">Multi-Processing Modules</a> (MPMs).
  424.       When building Apache, you must choose an MPM to use.  There
  425.       are platform-specific MPMs for some platforms:
  426.       <module>beos</module>, <module>mpm_netware</module>,
  427.       <module>mpmt_os2</module>, and <module>mpm_winnt</module>.  For
  428.       general Unix-type systems, there are several MPMs from which
  429.       to choose.  The choice of MPM can affect the speed and scalability
  430.       of the httpd:</p>
  431.  
  432.       <ul>
  433.  
  434.         <li>The <module>worker</module> MPM uses multiple child
  435.         processes with many threads each.  Each thread handles
  436.         one connection at a time.  Worker generally is a good
  437.         choice for high-traffic servers because it has a smaller
  438.         memory footprint than the prefork MPM.</li>
  439.  
  440.         <li>The <module>prefork</module> MPM uses multiple child
  441.         processes with one thread each.  Each process handles
  442.         one connection at a time.  On many systems, prefork is
  443.         comparable in speed to worker, but it uses more memory.
  444.         Prefork's threadless design has advantages over worker
  445.         in some situations: it can be used with non-thread-safe
  446.         third-party modules, and it is easier to debug on platforms
  447.         with poor thread debugging support.</li>
  448.  
  449.       </ul>
  450.  
  451.       <p>For more information on these and other MPMs, please
  452.       see the MPM <a href="../mpm.html">documentation</a>.</p>
  453.  
  454.     </section>
  455.  
  456.     <section id="modules">
  457.  
  458.         <title>Modules</title>
  459.  
  460.         <p>Since memory usage is such an important consideration in
  461.         performance, you should attempt to eliminate modules that youare
  462.         not actually using. If you have built the modules as <a
  463.         href="../dso.html">DSOs</a>, eliminating modules is a simple
  464.         matter of commenting out the associated <directive
  465.         module="mod_so">LoadModule</directive> directive for that module.
  466.         This allows you to experiment with removing modules, and seeing
  467.         if your site still functions in their absense.</p>
  468.  
  469.         <p>If, on the other hand, you have modules statically linked
  470.         into your Apache binary, you will need to recompile Apache in
  471.         order to remove unwanted modules.</p>
  472.  
  473.         <p>An associated question that arises here is, of course, what
  474.         modules you need, and which ones you don't. The answer here
  475.         will, of course, vary from one web site to another. However, the
  476.         <em>minimal</em> list of modules which you can get by with tends
  477.         to include <module>mod_mime</module>, <module>mod_dir</module>,
  478.         and <module>mod_log_config</module>. <code>mod_log_config</code> is,
  479.         of course, optional, as you can run a web site without log
  480.         files. This is, however, not recommended.</p>
  481.  
  482.     </section>
  483.  
  484.     <section>
  485.  
  486.       <title>Atomic Operations</title>
  487.  
  488.       <p>Some modules, such as <module>mod_cache</module> and
  489.       recent development builds of the worker MPM, use APR's
  490.       atomic API.  This API provides atomic operations that can
  491.       be used for lightweight thread synchronization.</p>
  492.  
  493.       <p>By default, APR implements these operations using the
  494.       most efficient mechanism available on each target
  495.       OS/CPU platform.  Many modern CPUs, for example, have
  496.       an instruction that does an atomic compare-and-swap (CAS)
  497.       operation in hardware.  On some platforms, however, APR
  498.       defaults to a slower, mutex-based implementation of the
  499.       atomic API in order to ensure compatibility with older
  500.       CPU models that lack such instructions.  If you are
  501.       building Apache for one of these platforms, and you plan
  502.       to run only on newer CPUs, you can select a faster atomic
  503.       implementation at build time by configuring Apache with
  504.       the <code>--enable-nonportable-atomics</code> option:</p>
  505.  
  506.       <example>
  507.         ./buildconf<br />
  508.         ./configure --with-mpm=worker --enable-nonportable-atomics=yes
  509.       </example>
  510.  
  511.       <p>The <code>--enable-nonportable-atomics</code> option is
  512.       relevant for the following platforms:</p>
  513.  
  514.       <ul>
  515.  
  516.         <li>Solaris on SPARC<br />
  517.             By default, APR uses mutex-based atomics on Solaris/SPARC.
  518.             If you configure with <code>--enable-nonportable-atomics</code>,
  519.             however, APR generates code that uses a SPARC v8plus opcode for
  520.             fast hardware compare-and-swap.  If you configure Apache with
  521.             this option, the atomic operations will be more efficient
  522.             (allowing for lower CPU utilization and higher concurrency),
  523.             but the resulting executable will run only on UltraSPARC
  524.             chips.
  525.         </li>
  526.  
  527.         <li>Linux on x86<br />
  528.             By default, APR uses mutex-based atomics on Linux.  If you
  529.             configure with <code>--enable-nonportable-atomics</code>,
  530.             however, APR generates code that uses a 486 opcode for fast
  531.             hardware compare-and-swap.  This will result in more efficient
  532.             atomic operations, but the resulting executable will run only
  533.             on 486 and later chips (and not on 386).
  534.         </li>
  535.  
  536.       </ul>
  537.  
  538.     </section>
  539.  
  540.     <section>
  541.  
  542.       <title>mod_status and ExtendedStatus On</title>
  543.  
  544.       <p>If you include <module>mod_status</module> and you also set
  545.       <code>ExtendedStatus On</code> when building and running
  546.       Apache, then on every request Apache will perform two calls to
  547.       <code>gettimeofday(2)</code> (or <code>times(2)</code>
  548.       depending on your operating system), and (pre-1.3) several
  549.       extra calls to <code>time(2)</code>. This is all done so that
  550.       the status report contains timing indications. For highest
  551.       performance, set <code>ExtendedStatus off</code> (which is the
  552.       default).</p>
  553.  
  554.     </section>
  555.  
  556.     <section>
  557.  
  558.       <title>accept Serialization - multiple sockets</title>
  559.  
  560.       <p>This discusses a shortcoming in the Unix socket API. Suppose
  561.       your web server uses multiple <directive module="mpm_common"
  562.       >Listen</directive> statements to listen on either multiple
  563.       ports or multiple addresses. In order to test each socket
  564.       to see if a connection is ready Apache uses
  565.       <code>select(2)</code>. <code>select(2)</code> indicates that a
  566.       socket has <em>zero</em> or <em>at least one</em> connection
  567.       waiting on it. Apache's model includes multiple children, and
  568.       all the idle ones test for new connections at the same time. A
  569.       naive implementation looks something like this (these examples
  570.       do not match the code, they're contrived for pedagogical
  571.       purposes):</p>
  572.  
  573.       <example>
  574.         for (;;) {<br />
  575.         <indent>
  576.           for (;;) {<br />
  577.           <indent>
  578.             fd_set accept_fds;<br />
  579.             <br />
  580.             FD_ZERO (&accept_fds);<br />
  581.             for (i = first_socket; i <= last_socket; ++i) {<br />
  582.             <indent>
  583.               FD_SET (i, &accept_fds);<br />
  584.             </indent>
  585.             }<br />
  586.             rc = select (last_socket+1, &accept_fds, NULL, NULL, NULL);<br />
  587.             if (rc < 1) continue;<br />
  588.             new_connection = -1;<br />
  589.             for (i = first_socket; i <= last_socket; ++i) {<br />
  590.             <indent>
  591.               if (FD_ISSET (i, &accept_fds)) {<br />
  592.               <indent>
  593.                 new_connection = accept (i, NULL, NULL);<br />
  594.                 if (new_connection != -1) break;<br />
  595.               </indent>
  596.               }<br />
  597.             </indent>
  598.             }<br />
  599.             if (new_connection != -1) break;<br />
  600.           </indent>
  601.           }<br />
  602.           process the new_connection;<br />
  603.         </indent>
  604.         }
  605.       </example>
  606.  
  607.       <p>But this naive implementation has a serious starvation problem.
  608.       Recall that multiple children execute this loop at the same
  609.       time, and so multiple children will block at
  610.       <code>select</code> when they are in between requests. All
  611.       those blocked children will awaken and return from
  612.       <code>select</code> when a single request appears on any socket
  613.       (the number of children which awaken varies depending on the
  614.       operating system and timing issues). They will all then fall
  615.       down into the loop and try to <code>accept</code> the
  616.       connection. But only one will succeed (assuming there's still
  617.       only one connection ready), the rest will be <em>blocked</em>
  618.       in <code>accept</code>. This effectively locks those children
  619.       into serving requests from that one socket and no other
  620.       sockets, and they'll be stuck there until enough new requests
  621.       appear on that socket to wake them all up. This starvation
  622.       problem was first documented in <a
  623.       href="http://bugs.apache.org/index/full/467">PR#467</a>. There
  624.       are at least two solutions.</p>
  625.  
  626.       <p>One solution is to make the sockets non-blocking. In this
  627.       case the <code>accept</code> won't block the children, and they
  628.       will be allowed to continue immediately. But this wastes CPU
  629.       time. Suppose you have ten idle children in
  630.       <code>select</code>, and one connection arrives. Then nine of
  631.       those children will wake up, try to <code>accept</code> the
  632.       connection, fail, and loop back into <code>select</code>,
  633.       accomplishing nothing. Meanwhile none of those children are
  634.       servicing requests that occurred on other sockets until they
  635.       get back up to the <code>select</code> again. Overall this
  636.       solution does not seem very fruitful unless you have as many
  637.       idle CPUs (in a multiprocessor box) as you have idle children,
  638.       not a very likely situation.</p>
  639.  
  640.       <p>Another solution, the one used by Apache, is to serialize
  641.       entry into the inner loop. The loop looks like this
  642.       (differences highlighted):</p>
  643.  
  644.       <example>
  645.         for (;;) {<br />
  646.         <indent>
  647.           <strong>accept_mutex_on ();</strong><br />
  648.           for (;;) {<br />
  649.           <indent>
  650.             fd_set accept_fds;<br />
  651.             <br />
  652.             FD_ZERO (&accept_fds);<br />
  653.             for (i = first_socket; i <= last_socket; ++i) {<br />
  654.             <indent>
  655.               FD_SET (i, &accept_fds);<br />
  656.             </indent>
  657.             }<br />
  658.             rc = select (last_socket+1, &accept_fds, NULL, NULL, NULL);<br />
  659.             if (rc < 1) continue;<br />
  660.             new_connection = -1;<br />
  661.             for (i = first_socket; i <= last_socket; ++i) {<br />
  662.             <indent>
  663.               if (FD_ISSET (i, &accept_fds)) {<br />
  664.               <indent>
  665.                 new_connection = accept (i, NULL, NULL);<br />
  666.                 if (new_connection != -1) break;<br />
  667.               </indent>
  668.               }<br />
  669.             </indent>
  670.             }<br />
  671.             if (new_connection != -1) break;<br />
  672.           </indent>
  673.           }<br />
  674.           <strong>accept_mutex_off ();</strong><br />
  675.           process the new_connection;<br />
  676.         </indent>
  677.         }
  678.       </example>
  679.  
  680.       <p><a id="serialize" name="serialize">The functions</a>
  681.       <code>accept_mutex_on</code> and <code>accept_mutex_off</code>
  682.       implement a mutual exclusion semaphore. Only one child can have
  683.       the mutex at any time. There are several choices for
  684.       implementing these mutexes. The choice is defined in
  685.       <code>src/conf.h</code> (pre-1.3) or
  686.       <code>src/include/ap_config.h</code> (1.3 or later). Some
  687.       architectures do not have any locking choice made, on these
  688.       architectures it is unsafe to use multiple
  689.       <directive module="mpm_common">Listen</directive>
  690.       directives.</p>
  691.  
  692.       <dl>
  693.         <dt><code>USE_FLOCK_SERIALIZED_ACCEPT</code></dt>
  694.  
  695.         <dd>
  696.           <p>This method uses the <code>flock(2)</code> system call to
  697.           lock a lock file (located by the <directive module="mpm_common"
  698.           >LockFile</directive> directive).</p>
  699.         </dd>
  700.  
  701.         <dt><code>USE_FCNTL_SERIALIZED_ACCEPT</code></dt>
  702.  
  703.         <dd>
  704.           <p>This method uses the <code>fcntl(2)</code> system call to
  705.           lock a lock file (located by the <directive module="mpm_common"
  706.           >LockFile</directive> directive).</p>
  707.         </dd>
  708.  
  709.         <dt><code>USE_SYSVSEM_SERIALIZED_ACCEPT</code></dt>
  710.  
  711.         <dd>
  712.           <p>(1.3 or later) This method uses SysV-style semaphores to
  713.           implement the mutex. Unfortunately SysV-style semaphores have
  714.           some bad side-effects. One is that it's possible Apache will
  715.           die without cleaning up the semaphore (see the
  716.           <code>ipcs(8)</code> man page). The other is that the
  717.           semaphore API allows for a denial of service attack by any
  718.           CGIs running under the same uid as the webserver
  719.           (<em>i.e.</em>, all CGIs, unless you use something like
  720.           <code>suexec</code> or <code>cgiwrapper</code>). For these
  721.           reasons this method is not used on any architecture except
  722.           IRIX (where the previous two are prohibitively expensive
  723.           on most IRIX boxes).</p>
  724.         </dd>
  725.  
  726.         <dt><code>USE_USLOCK_SERIALIZED_ACCEPT</code></dt>
  727.  
  728.         <dd>
  729.           <p>(1.3 or later) This method is only available on IRIX, and
  730.           uses <code>usconfig(2)</code> to create a mutex. While this
  731.           method avoids the hassles of SysV-style semaphores, it is not
  732.           the default for IRIX. This is because on single processor
  733.           IRIX boxes (5.3 or 6.2) the uslock code is two orders of
  734.           magnitude slower than the SysV-semaphore code. On
  735.           multi-processor IRIX boxes the uslock code is an order of
  736.           magnitude faster than the SysV-semaphore code. Kind of a
  737.           messed up situation. So if you're using a multiprocessor IRIX
  738.           box then you should rebuild your webserver with
  739.           <code>-DUSE_USLOCK_SERIALIZED_ACCEPT</code> on the
  740.           <code>EXTRA_CFLAGS</code>.</p>
  741.         </dd>
  742.  
  743.         <dt><code>USE_PTHREAD_SERIALIZED_ACCEPT</code></dt>
  744.  
  745.         <dd>
  746.           <p>(1.3 or later) This method uses POSIX mutexes and should
  747.           work on any architecture implementing the full POSIX threads
  748.           specification, however appears to only work on Solaris (2.5
  749.           or later), and even then only in certain configurations. If
  750.           you experiment with this you should watch out for your server
  751.           hanging and not responding. Static content only servers may
  752.           work just fine.</p>
  753.         </dd>
  754.       </dl>
  755.  
  756.       <p>If your system has another method of serialization which
  757.       isn't in the above list then it may be worthwhile adding code
  758.       for it (and submitting a patch back to Apache).</p>
  759.  
  760.       <p>Another solution that has been considered but never
  761.       implemented is to partially serialize the loop -- that is, let
  762.       in a certain number of processes. This would only be of
  763.       interest on multiprocessor boxes where it's possible multiple
  764.       children could run simultaneously, and the serialization
  765.       actually doesn't take advantage of the full bandwidth. This is
  766.       a possible area of future investigation, but priority remains
  767.       low because highly parallel web servers are not the norm.</p>
  768.  
  769.       <p>Ideally you should run servers without multiple
  770.       <directive module="mpm_common">Listen</directive>
  771.       statements if you want the highest performance.
  772.       But read on.</p>
  773.  
  774.     </section>
  775.  
  776.     <section>
  777.  
  778.       <title>accept Serialization - single socket</title>
  779.  
  780.       <p>The above is fine and dandy for multiple socket servers, but
  781.       what about single socket servers? In theory they shouldn't
  782.       experience any of these same problems because all children can
  783.       just block in <code>accept(2)</code> until a connection
  784.       arrives, and no starvation results. In practice this hides
  785.       almost the same "spinning" behaviour discussed above in the
  786.       non-blocking solution. The way that most TCP stacks are
  787.       implemented, the kernel actually wakes up all processes blocked
  788.       in <code>accept</code> when a single connection arrives. One of
  789.       those processes gets the connection and returns to user-space,
  790.       the rest spin in the kernel and go back to sleep when they
  791.       discover there's no connection for them. This spinning is
  792.       hidden from the user-land code, but it's there nonetheless.
  793.       This can result in the same load-spiking wasteful behaviour
  794.       that a non-blocking solution to the multiple sockets case
  795.       can.</p>
  796.  
  797.       <p>For this reason we have found that many architectures behave
  798.       more "nicely" if we serialize even the single socket case. So
  799.       this is actually the default in almost all cases. Crude
  800.       experiments under Linux (2.0.30 on a dual Pentium pro 166
  801.       w/128Mb RAM) have shown that the serialization of the single
  802.       socket case causes less than a 3% decrease in requests per
  803.       second over unserialized single-socket. But unserialized
  804.       single-socket showed an extra 100ms latency on each request.
  805.       This latency is probably a wash on long haul lines, and only an
  806.       issue on LANs. If you want to override the single socket
  807.       serialization you can define
  808.       <code>SINGLE_LISTEN_UNSERIALIZED_ACCEPT</code> and then
  809.       single-socket servers will not serialize at all.</p>
  810.  
  811.     </section>
  812.  
  813.     <section>
  814.  
  815.       <title>Lingering Close</title>
  816.  
  817.       <p>As discussed in <a
  818.       href="http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt">
  819.       draft-ietf-http-connection-00.txt</a> section 8, in order for
  820.       an HTTP server to <strong>reliably</strong> implement the
  821.       protocol it needs to shutdown each direction of the
  822.       communication independently (recall that a TCP connection is
  823.       bi-directional, each half is independent of the other). This
  824.       fact is often overlooked by other servers, but is correctly
  825.       implemented in Apache as of 1.2.</p>
  826.  
  827.       <p>When this feature was added to Apache it caused a flurry of
  828.       problems on various versions of Unix because of a
  829.       shortsightedness. The TCP specification does not state that the
  830.       <code>FIN_WAIT_2</code> state has a timeout, but it doesn't prohibit it.
  831.       On systems without the timeout, Apache 1.2 induces many sockets
  832.       stuck forever in the <code>FIN_WAIT_2</code> state. In many cases this
  833.       can be avoided by simply upgrading to the latest TCP/IP patches
  834.       supplied by the vendor. In cases where the vendor has never
  835.       released patches (<em>i.e.</em>, SunOS4 -- although folks with
  836.       a source license can patch it themselves) we have decided to
  837.       disable this feature.</p>
  838.  
  839.       <p>There are two ways of accomplishing this. One is the socket
  840.       option <code>SO_LINGER</code>. But as fate would have it, this
  841.       has never been implemented properly in most TCP/IP stacks. Even
  842.       on those stacks with a proper implementation (<em>i.e.</em>,
  843.       Linux 2.0.31) this method proves to be more expensive (cputime)
  844.       than the next solution.</p>
  845.  
  846.       <p>For the most part, Apache implements this in a function
  847.       called <code>lingering_close</code> (in
  848.       <code>http_main.c</code>). The function looks roughly like
  849.       this:</p>
  850.  
  851.       <example>
  852.         void lingering_close (int s)<br />
  853.         {<br />
  854.         <indent>
  855.           char junk_buffer[2048];<br />
  856.           <br />
  857.           /* shutdown the sending side */<br />
  858.           shutdown (s, 1);<br />
  859.           <br />
  860.           signal (SIGALRM, lingering_death);<br />
  861.           alarm (30);<br />
  862.           <br />
  863.           for (;;) {<br />
  864.           <indent>
  865.             select (s for reading, 2 second timeout);<br />
  866.             if (error) break;<br />
  867.             if (s is ready for reading) {<br />
  868.             <indent>
  869.               if (read (s, junk_buffer, sizeof (junk_buffer)) <= 0) {<br />
  870.               <indent>
  871.                 break;<br />
  872.               </indent>
  873.               }<br />
  874.               /* just toss away whatever is here */<br />
  875.             </indent>
  876.             }<br />
  877.           </indent>
  878.           }<br />
  879.           <br />
  880.           close (s);<br />
  881.         </indent>
  882.         }
  883.       </example>
  884.  
  885.       <p>This naturally adds some expense at the end of a connection,
  886.       but it is required for a reliable implementation. As HTTP/1.1
  887.       becomes more prevalent, and all connections are persistent,
  888.       this expense will be amortized over more requests. If you want
  889.       to play with fire and disable this feature you can define
  890.       <code>NO_LINGCLOSE</code>, but this is not recommended at all.
  891.       In particular, as HTTP/1.1 pipelined persistent connections
  892.       come into use <code>lingering_close</code> is an absolute
  893.       necessity (and <a
  894.       href="http://www.w3.org/Protocols/HTTP/Performance/Pipeline.html">
  895.       pipelined connections are faster</a>, so you want to support
  896.       them).</p>
  897.  
  898.     </section>
  899.  
  900.     <section>
  901.  
  902.       <title>Scoreboard File</title>
  903.  
  904.       <p>Apache's parent and children communicate with each other
  905.       through something called the scoreboard. Ideally this should be
  906.       implemented in shared memory. For those operating systems that
  907.       we either have access to, or have been given detailed ports
  908.       for, it typically is implemented using shared memory. The rest
  909.       default to using an on-disk file. The on-disk file is not only
  910.       slow, but it is unreliable (and less featured). Peruse the
  911.       <code>src/main/conf.h</code> file for your architecture and
  912.       look for either <code>USE_MMAP_SCOREBOARD</code> or
  913.       <code>USE_SHMGET_SCOREBOARD</code>. Defining one of those two
  914.       (as well as their companions <code>HAVE_MMAP</code> and
  915.       <code>HAVE_SHMGET</code> respectively) enables the supplied
  916.       shared memory code. If your system has another type of shared
  917.       memory, edit the file <code>src/main/http_main.c</code> and add
  918.       the hooks necessary to use it in Apache. (Send us back a patch
  919.       too please.)</p>
  920.  
  921.       <note>Historical note: The Linux port of Apache didn't start to
  922.       use shared memory until version 1.2 of Apache. This oversight
  923.       resulted in really poor and unreliable behaviour of earlier
  924.       versions of Apache on Linux.</note>
  925.  
  926.     </section>
  927.  
  928.     <section>
  929.  
  930.       <title>DYNAMIC_MODULE_LIMIT</title>
  931.  
  932.       <p>If you have no intention of using dynamically loaded modules
  933.       (you probably don't if you're reading this and tuning your
  934.       server for every last ounce of performance) then you should add
  935.       <code>-DDYNAMIC_MODULE_LIMIT=0</code> when building your
  936.       server. This will save RAM that's allocated only for supporting
  937.       dynamically loaded modules.</p>
  938.  
  939.     </section>
  940.  
  941.   </section>
  942.  
  943.   <section id="trace">
  944.  
  945.     <title>Appendix: Detailed Analysis of a Trace</title>
  946.  
  947.     <p>Here is a system call trace of Apache 2.0.38 with the worker MPM
  948.     on Solaris 8. This trace was collected using:</p>
  949.  
  950.     <example>
  951.       truss -l -p <var>httpd_child_pid</var>.
  952.     </example>
  953.  
  954.     <p>The <code>-l</code> option tells truss to log the ID of the
  955.     LWP (lightweight process--Solaris's form of kernel-level thread)
  956.     that invokes each system call.</p>
  957.  
  958.     <p>Other systems may have different system call tracing utilities
  959.     such as <code>strace</code>, <code>ktrace</code>, or <code>par</code>.
  960.     They all produce similar output.</p>
  961.  
  962.     <p>In this trace, a client has requested a 10KB static file
  963.     from the httpd. Traces of non-static requests or requests
  964.     with content negotiation look wildly different (and quite ugly
  965.     in some cases).</p>
  966.  
  967.     <example>
  968. <pre>/67:    accept(3, 0x00200BEC, 0x00200C0C, 1) (sleeping...)
  969. /67:    accept(3, 0x00200BEC, 0x00200C0C, 1)            = 9</pre>
  970.     </example>
  971.  
  972.     <p>In this trace, the listener thread is running within LWP #67.</p>
  973.  
  974.     <note>Note the lack of <code>accept(2)</code> serialization. On this
  975.     particular platform, the worker MPM uses an unserialized accept by
  976.     default unless it is listening on multiple ports.</note>
  977.  
  978.     <example>
  979. <pre>/65:    lwp_park(0x00000000, 0)                         = 0
  980. /67:    lwp_unpark(65, 1)                               = 0</pre>
  981.     </example>
  982.  
  983.     <p>Upon accepting the connection, the listener thread wakes up
  984.     a worker thread to do the request processing. In this trace,
  985.     the worker thread that handles the request is mapped to LWP #65.</p>
  986.  
  987.     <example>
  988. <pre>/65:    getsockname(9, 0x00200BA4, 0x00200BC4, 1)       = 0</pre>
  989.     </example>
  990.  
  991.     <p>In order to implement virtual hosts, Apache needs to know
  992.     the local socket address used to accept the connection. It
  993.     is possible to eliminate this call in many situations (such
  994.     as when there are no virtual hosts, or when
  995.     <directive module="mpm_common">Listen</directive> directives
  996.     are used which do not have wildcard addresses). But
  997.     no effort has yet been made to do these optimizations. </p>
  998.  
  999.     <example>
  1000. <pre>/65:    brk(0x002170E8)                                 = 0
  1001. /65:    brk(0x002190E8)                                 = 0</pre>
  1002.     </example>
  1003.  
  1004.     <p>The <code>brk(2)</code> calls allocate memory from the heap.
  1005.     It is rare to see these in a system call trace, because the httpd
  1006.     uses custom memory allocators (<code>apr_pool</code> and
  1007.     <code>apr_bucket_alloc</code>) for most request processing.
  1008.     In this trace, the httpd has just been started, so it must
  1009.     call <code>malloc(3)</code> to get the blocks of raw memory
  1010.     with which to create the custom memory allocators.</p>
  1011.  
  1012.     <example>
  1013. <pre>/65:    fcntl(9, F_GETFL, 0x00000000)                   = 2
  1014. /65:    fstat64(9, 0xFAF7B818)                          = 0
  1015. /65:    getsockopt(9, 65535, 8192, 0xFAF7B918, 0xFAF7B910, 2190656) = 0
  1016. /65:    fstat64(9, 0xFAF7B818)                          = 0
  1017. /65:    getsockopt(9, 65535, 8192, 0xFAF7B918, 0xFAF7B914, 2190656) = 0
  1018. /65:    setsockopt(9, 65535, 8192, 0xFAF7B918, 4, 2190656) = 0
  1019. /65:    fcntl(9, F_SETFL, 0x00000082)                   = 0</pre>
  1020.     </example>
  1021.  
  1022.     <p>Next, the worker thread puts the connection to the client (file
  1023.     descriptor 9) in non-blocking mode. The <code>setsockopt(2)</code>
  1024.     and <code>getsockopt(2)</code> calls are a side-effect of how
  1025.     Solaris's libc handles <code>fcntl(2)</code> on sockets.</p>
  1026.  
  1027.     <example>
  1028. <pre>/65:    read(9, " G E T   / 1 0 k . h t m".., 8000)     = 97</pre>
  1029.     </example>
  1030.  
  1031.     <p>The worker thread reads the request from the client.</p>
  1032.  
  1033.     <example>
  1034. <pre>/65:    stat("/var/httpd/apache/httpd-8999/htdocs/10k.html", 0xFAF7B978) = 0
  1035. /65:    open("/var/httpd/apache/httpd-8999/htdocs/10k.html", O_RDONLY) = 10</pre>
  1036.     </example>
  1037.  
  1038.     <p>This httpd has been configured with <code>Options FollowSymLinks</code>
  1039.     and <code>AllowOverride None</code>.  Thus it doesn't need to
  1040.     <code>lstat(2)</code> each directory in the path leading up to the
  1041.     requested file, nor check for <code>.htaccess</code> files.
  1042.     It simply calls <code>stat(2)</code> to verify that the file:
  1043.     1) exists, and 2) is a regular file, not a directory.</p>
  1044.  
  1045.     <example>
  1046. <pre>/65:    sendfilev(0, 9, 0x00200F90, 2, 0xFAF7B53C)      = 10269</pre>
  1047.     </example>
  1048.  
  1049.     <p>In this example, the httpd is able to send the HTTP response
  1050.     header and the requested file with a single <code>sendfilev(2)</code>
  1051.     system call. Sendfile semantics vary among operating systems. On some other
  1052.     systems, it is necessary to do a <code>write(2)</code> or
  1053.     <code>writev(2)</code> call to send the headers before calling
  1054.     <code>sendfile(2)</code>.</p>
  1055.  
  1056.     <example>
  1057. <pre>/65:    write(4, " 1 2 7 . 0 . 0 . 1   -  ".., 78)      = 78</pre>
  1058.     </example>
  1059.  
  1060.     <p>This <code>write(2)</code> call records the request in the
  1061.     access log. Note that one thing missing from this trace is a
  1062.     <code>time(2)</code> call. Unlike Apache 1.3, Apache 2.0 uses
  1063.     <code>gettimeofday(3)</code> to look up the time. On some operating
  1064.     systems, like Linux or Solaris, <code>gettimeofday</code> has an
  1065.     optimized implementation that doesn't require as much overhead
  1066.     as a typical system call.</p>
  1067.  
  1068.     <example>
  1069. <pre>/65:    shutdown(9, 1, 1)                               = 0
  1070. /65:    poll(0xFAF7B980, 1, 2000)                       = 1
  1071. /65:    read(9, 0xFAF7BC20, 512)                        = 0
  1072. /65:    close(9)                                        = 0</pre>
  1073.     </example>
  1074.  
  1075.     <p>The worker thread does a lingering close of the connection.</p>
  1076.  
  1077.     <example>
  1078. <pre>/65:    close(10)                                       = 0
  1079. /65:    lwp_park(0x00000000, 0)         (sleeping...)</pre>
  1080.     </example>
  1081.  
  1082.     <p>Finally the worker thread closes the file that it has just delivered
  1083.     and blocks until the listener assigns it another connection.</p>
  1084.  
  1085.     <example>
  1086. <pre>/67:    accept(3, 0x001FEB74, 0x001FEB94, 1) (sleeping...)</pre>
  1087.     </example>
  1088.  
  1089.     <p>Meanwhile, the listener thread is able to accept another connection
  1090.     as soon as it has dispatched this connection to a worker thread (subject
  1091.     to some flow-control logic in the worker MPM that throttles the listener
  1092.     if all the available workers are busy).  Though it isn't apparent from
  1093.     this trace, the next <code>accept(2)</code> can (and usually does, under
  1094.     high load conditions) occur in parallel with the worker thread's handling
  1095.     of the just-accepted connection.</p>
  1096.  
  1097.   </section>
  1098.  
  1099. </manualpage>
  1100.  
  1101.