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