~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs/htmldocs/manpages/vfs_cacheprime.8.html

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_cacheprime</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_cacheprime.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_cacheprime &#8212; prime the kernel file data cache</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = cacheprime</code></p></div></div><div class="refsect1" lang="en"><a name="id2522914"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the
 
2
        <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_cacheprime</code> VFS module reads chunks
 
3
        of file data near the range requested by clients in order to
 
4
        make sure the data is present in the kernel file data cache at
 
5
        the time when it is actually requested by clients. </p><p>The size of the disk read operations performed
 
6
        by <code class="literal">vfs_cacheprime</code> is determined by the
 
7
        cacheprime:rsize option. All disk read operations are aligned
 
8
        on boundaries that are a multiple of this size. Each range of
 
9
        the file data is primed at most once during the time the client
 
10
        has the file open. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id2483334"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">cacheprime:rsize = BYTES</span></dt><dd><p>The number of bytes with which to prime
 
11
                the kernel data cache.</p><p>The following suffixes may be applied to BYTES:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">K</code> - BYTES is a number of kilobytes</p></li><li><p><code class="literal">M</code> - BYTES is a number of megabytes</p></li><li><p><code class="literal">G</code> - BYTES is a number of gigabytes</p></li></ul></div></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2483392"></a><h2>EXAMPLES</h2><p>For a hypothetical disk array, it is necessary to ensure
 
12
        that all read operations are of size 1 megabyte (1048576 bytes),
 
13
        and aligned on 1 megabyte boundaries:
 
14
        </p><pre class="programlisting">
 
15
        <em class="parameter"><code>[hypothetical]</code></em>
 
16
        <a class="link" href="smb.conf.5.html#VFSOBJECTS" target="_top">vfs objects = cacheprime</a>
 
17
        <a class="link" href="smb.conf.5.html#CACHEPRIME:RSIZE" target="_top">cacheprime:rsize = 1M</a>
 
18
</pre></div><div class="refsect1" lang="en"><a name="id2483662"></a><h2>CAVEATS</h2><p><code class="literal">cacheprime</code> is not a a substitute for
 
19
        a general-purpose readahead mechanism. It is intended for use
 
20
        only in very specific environments where disk operations must
 
21
        be aligned and sized to known values (as much as that is possible).
 
22
        </p></div><div class="refsect1" lang="en"><a name="id2483679"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite.
 
23
        </p></div><div class="refsect1" lang="en"><a name="id2483690"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
 
24
        were created by Andrew Tridgell. Samba is now developed
 
25
        by the Samba Team as an Open Source project similar
 
26
        to the way the Linux kernel is developed.</p></div></div></body></html>