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