Document async I/O options
authorAlexander Bokovoy <ab@samba.org>
Thu, 17 May 2007 12:19:46 +0000 (12:19 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 14:01:49 +0000 (09:01 -0500)
docs/smbdotconf/tuning/aioreadsize.xml [new file with mode: 0644]
docs/smbdotconf/tuning/aiowritesize.xml [new file with mode: 0644]

diff --git a/docs/smbdotconf/tuning/aioreadsize.xml b/docs/smbdotconf/tuning/aioreadsize.xml
new file mode 100644 (file)
index 0000000..082cf5d
--- /dev/null
@@ -0,0 +1,22 @@
+<samba:parameter name="aio read size"
+                 context="S"
+                type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+  <para>If Samba has been built with asynchronous I/O support and this
+    integer parameter is set to non-zero value,
+    Samba will read from file asynchronously when size of request is bigger
+    than this value. Note that it happens only for non-chained and non-chaining
+    reads and when not using write cache.</para>
+
+  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
+    only up to 10 outstanding asynchronous requests, read and write combined.</para>
+
+  <related>write cache size</related>
+  <related>aio write size</related>
+</description>
+
+<value type="default">0</value>
+<value type="example">16384<comment> Use asynchronous I/O for reads bigger than 16KB
+    request size</comment></value>
+</samba:parameter>
diff --git a/docs/smbdotconf/tuning/aiowritesize.xml b/docs/smbdotconf/tuning/aiowritesize.xml
new file mode 100644 (file)
index 0000000..e33a60e
--- /dev/null
@@ -0,0 +1,22 @@
+<samba:parameter name="aio write size"
+                 context="S"
+                type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+  <para>If Samba has been built with asynchronous I/O support and this
+    integer parameter is set to non-zero value,
+    Samba will write to file asynchronously when size of request is bigger
+    than this value. Note that it happens only for non-chained and non-chaining
+    reads and when not using write cache.</para>
+
+  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
+    only up to 10 outstanding asynchronous requests, read and write combined.</para>
+  
+  <related>write cache size</related>
+  <related>aio read size</related>
+</description>
+
+<value type="default">0</value>
+<value type="example">16384<comment> Use asynchronous I/O for writes bigger than 16KB
+    request size</comment></value>
+</samba:parameter>