granicus.if.org Git - apache/blob - docs/manual/mod/mod_file_cache.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_file_cache - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.gif" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_file_cache</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_file_cache.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_file_cache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ko/mod/mod_file_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  32 </div>
  33 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Caches a static list of files in memory</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>file_cache_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_file_cache.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39
  40     <div class="warning">
  41       This module should be used with care. You can easily create a broken
  42       site using <code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code>, so read this document
  43       carefully.
  44     </div>
  45
  46     <p><em>Caching</em> frequently requested files that change very
  47     infrequently is a technique for reducing server load.
  48     <code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code> provides two techniques for caching
  49     frequently requested <em>static</em> files. Through configuration
  50     directives, you can direct <code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code> to either
  51     open then <code>mmap()</code> a file, or to pre-open a file and save
  52     the file's open <em>file handle</em>. Both techniques reduce server
  53     load when processing requests for these files by doing part of the work
  54     (specifically, the file I/O) for serving the file when the
  55     server is started rather than during each request.</p>
  56
  57     <p>Notice: You cannot use this for speeding up CGI programs or
  58     other files which are served by special content handlers. It
  59     can only be used for regular files which are usually served by
  60     the Apache core content handler.</p>
  61
  62     <p>This module is an extension of and borrows heavily from the
  63     <code>mod_mmap_static</code> module in Apache 1.3.</p>
  64 </div>
  65 <div id="quickview"><h3>Topics</h3>
  66 <ul id="topics">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#using">Using mod_file_cache</a></li>
  68 </ul><h3 class="directives">Directives</h3>
  69 <ul id="toc">
  70 <li><img alt="" src="../images/down.gif" /> <a href="#cachefile">CacheFile</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#mmapfile">MMapFile</a></li>
  72 </ul>
  73 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  74 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  75 <div class="section">
  76 <h2><a name="using" id="using">Using mod_file_cache</a></h2>
  77
  78     <p><code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code> caches a list of statically
  79     configured files via <code class="directive"><a href="#mmapfile">MMapFile</a></code> or <code class="directive"><a href="#cachefile">CacheFile</a></code> directives in the main server configuration.</p>
  80
  81     <p>Not all platforms support both directives. You will receive an error
  82     message in the server error log if you attempt to use an
  83     unsupported directive. If given an unsupported directive, the
  84     server will start but the file will not be cached. On platforms
  85     that support both directives, you should experiment with both to
  86     see which works best for you.</p>
  87
  88     <h3>MMapFile Directive</h3>
  89
  90       <p>The <code class="directive"><a href="#mmapfile">MMapFile</a></code>
  91       directive of <code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code> maps a list of
  92       statically configured files into memory through the system call
  93       <code>mmap()</code>. This system call is available on most modern
  94       Unix derivatives, but not on all. There are sometimes system-specific
  95       limits on the size and number of files that can be
  96       <code>mmap()</code>ed, experimentation is probably the easiest way
  97       to find out.</p>
  98
  99       <p>This <code>mmap()</code>ing is done once at server start or
 100       restart, only. So whenever one of the mapped files changes on the
 101       filesystem you <em>have</em> to restart the server (see the <a href="../stopping.html">Stopping and Restarting</a> documentation).
 102       To reiterate that point: if the files are modified <em>in place</em>
 103       without restarting the server you may end up serving requests that
 104       are completely bogus. You should update files by unlinking the old
 105       copy and putting a new copy in place. Most tools such as
 106       <code>rdist</code> and <code>mv</code> do this. The reason why this
 107       modules doesn't take care of changes to the files is that this check
 108       would need an extra <code>stat()</code> every time which is a waste
 109       and against the intent of I/O reduction.</p>
 110
 111
 112     <h3>CacheFile Directive</h3>
 113
 114       <p>The <code class="directive"><a href="#cachefile">CacheFile</a></code>
 115       directive of <code class="module"><a href="../mod/mod_file_cache.html">mod_file_cache</a></code> opens an active
 116       <em>handle</em> or <em>file descriptor</em> to the file (or files)
 117       listed in the configuration directive and places these open file
 118       handles in the cache. When the file is requested, the server
 119       retrieves the handle from the cache and passes it to the
 120       <code>sendfile()</code> (or <code>TransmitFile()</code> on Windows),
 121       socket API.</p>
 122
 123
 124
 125       <p>This file handle caching is done once at server start or
 126       restart, only. So whenever one of the cached files changes on
 127       the filesystem you <em>have</em> to restart the server (see the
 128       <a href="../stopping.html">Stopping and Restarting</a>
 129       documentation). To reiterate that point: if the files are
 130       modified <em>in place</em> without restarting the server you
 131       may end up serving requests that are completely bogus. You
 132       should update files by unlinking the old copy and putting a new
 133       copy in place. Most tools such as <code>rdist</code> and
 134       <code>mv</code> do this.</p>
 135
 136
 137     <div class="note"><h3>Note</h3>
 138       <p>Don't bother asking for a directive which recursively
 139       caches all the files in a directory. Try this instead... See the
 140       <code class="directive"><a href="../mod/core.html#include">Include</a></code> directive, and consider
 141       this command:</p>
 142
 143       <div class="example"><p><code>
 144         find /www/htdocs -type f -print \<br />
 145         | sed -e 's/.*/mmapfile &amp;/' &gt; /www/conf/mmap.conf
 146       </code></p></div>
 147     </div>
 148 </div>
 149 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 150 <div class="directive-section"><h2><a name="CacheFile" id="CacheFile">CacheFile</a> <a name="cachefile" id="cachefile">Directive</a></h2>
 151 <table class="directive">
 152 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cache a list of file handles at startup time</td></tr>
 153 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheFile <var>file-path</var> [<var>file-path</var>] ...</code></td></tr>
 154 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 155 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 156 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_file_cache</td></tr>
 157 </table>
 158     <p>The <code class="directive">CacheFile</code> directive opens handles to
 159     one or more files (given as whitespace separated arguments) and
 160     places these handles into the cache at server startup
 161     time. Handles to cached files are automatically closed on a server
 162     shutdown.  When the files have changed on the filesystem, the
 163     server should be restarted to re-cache them.</p>
 164
 165     <p>Be careful with the <var>file-path</var> arguments: They have
 166     to literally match the filesystem path Apache's URL-to-filename
 167     translation handlers create. We cannot compare inodes or other
 168     stuff to match paths through symbolic links <em>etc.</em>
 169     because that again would cost extra <code>stat()</code> system
 170     calls which is not acceptable. This module may or may not work
 171     with filenames rewritten by <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> or
 172     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.</p>
 173
 174     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CacheFile /usr/local/apache/htdocs/index.html</pre>
 175 </div>
 176
 177 </div>
 178 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 179 <div class="directive-section"><h2><a name="MMapFile" id="MMapFile">MMapFile</a> <a name="mmapfile" id="mmapfile">Directive</a></h2>
 180 <table class="directive">
 181 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Map a list of files into memory at startup time</td></tr>
 182 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MMapFile <var>file-path</var> [<var>file-path</var>] ...</code></td></tr>
 183 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 184 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 185 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_file_cache</td></tr>
 186 </table>
 187     <p>The <code class="directive">MMapFile</code> directive maps one or more files
 188     (given as whitespace separated arguments) into memory at server
 189     startup time. They are automatically unmapped on a server
 190     shutdown. When the files have changed on the filesystem at
 191     least a <code>HUP</code> or <code>USR1</code> signal should be send to
 192     the server to re-<code>mmap()</code> them.</p>
 193
 194     <p>Be careful with the <var>file-path</var> arguments: They have
 195     to literally match the filesystem path Apache's URL-to-filename
 196     translation handlers create. We cannot compare inodes or other
 197     stuff to match paths through symbolic links <em>etc.</em>
 198     because that again would cost extra <code>stat()</code> system
 199     calls which is not acceptable. This module may or may not work
 200     with filenames rewritten by <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> or
 201     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.</p>
 202
 203     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">MMapFile /usr/local/apache/htdocs/index.html</pre>
 204 </div>
 205
 206 </div>
 207 </div>
 208 <div class="bottomlang">
 209 <p><span>Available Languages: </span><a href="../en/mod/mod_file_cache.html" title="English">&nbsp;en&nbsp;</a> |
 210 <a href="../fr/mod/mod_file_cache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 211 <a href="../ko/mod/mod_file_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 212 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 213 <script type="text/javascript"><!--//--><![CDATA[//><!--
 214 var comments_shortname = 'httpd';
 215 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_file_cache.html';
 216 (function(w, d) {
 217     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 218         d.write('<div id="comments_thread"><\/div>');
 219         var s = d.createElement('script');
 220         s.type = 'text/javascript';
 221         s.async = true;
 222         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 223         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 224     }
 225     else {
 226         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 227     }
 228 })(window, document);
 229 //--><!]]></script></div><div id="footer">
 230 <p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 231 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 232 if (typeof(prettyPrint) !== 'undefined') {
 233     prettyPrint();
 234 }
 235 //--><!]]></script>
 236 </body></html>