484b35398bf76fc456f0223b2fd46d55e6fe39be
[samba.git] / docs-xml / smbdotconf / tuning / writecachesize.xml
1 <samba:parameter name="write cache size"
2                  context="S"
3                  type="bytes"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>If this integer parameter is set to non-zero value,
7     Samba will create an in-memory cache for each oplocked file 
8     (it does <emphasis>not</emphasis> do this for 
9     non-oplocked files). All writes that the client does not request 
10     to be flushed directly to disk will be stored in this cache if possible. 
11     The cache is flushed onto disk when a write comes in whose offset 
12     would not fit into the cache or when the file is closed by the client. 
13     Reads for the file are also served from this cache if the data is stored 
14     within it.</para>
15
16     <para>This cache allows Samba to batch client writes into a more 
17     efficient write size for RAID disks (i.e. writes may be tuned to 
18     be the RAID stripe size) and can improve performance on systems 
19     where the disk subsystem is a bottleneck but there is free 
20     memory for userspace programs.</para>
21
22     <para>The integer parameter specifies the size of this cache 
23                 (per oplocked file) in bytes.</para>
24
25     <para>Note that the write cache won't be used for file handles with a smb2 write lease.</para>
26 </description>
27
28 <related>aio read size</related>
29 <related>aio write size</related>
30 <related>smb2 leases</related>
31 <value type="default">0</value>
32 <value type="example">262144<comment> for a 256k cache size per file</comment></value>
33 </samba:parameter>