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