docs: Bump version up to 4.6.
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_aio_linux.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_aio_linux.8">
4
5 <refmeta>
6         <refentrytitle>vfs_aio_linux</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_aio_linux</refname>
16         <refpurpose>implement async I/O in Samba vfs using Linux kernel aio calls</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = aio_linux</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>aio_linux</command> VFS module enables asynchronous
33         I/O for Samba on Linux kernels that have the kernel AIO calls available
34         without using the Posix AIO interface. Posix AIO can suffer from severe
35         limitations.  For example, on some Linux versions the
36         real-time signals that it uses are broken under heavy load.
37         Other systems only allow AIO when special kernel modules are
38         loaded or only allow a certain system-wide amount of async
39         requests being scheduled. Systems based on glibc (most Linux
40         systems) only allow a single outstanding request per file
41         descriptor which essentially makes Posix AIO useless on systems
42         using the glibc implementation.</para>
43
44         <para>To work around all these limitations, the aio_linux module
45         was written. It uses the Linux kernel AIO interface instead of the
46         internal Posix AIO interface to allow read and write calls
47         to be processed asynchronously. A queue size of 128 events
48         is used by default. To change this limit set the "aio num events"
49         parameter below.
50         </para>
51
52         <para>
53         Note that the smb.conf parameters <command>aio read size</command>
54         and <command>aio write size</command> must also be set appropriately
55         for this module to be active.
56         </para>
57
58         <para>This module MUST be listed last in any module stack as
59         the Samba VFS pread/pwrite interface is not thread-safe. This
60         module makes direct pread and pwrite system calls and does
61         NOT call the Samba VFS pread and pwrite interfaces.</para>
62
63 </refsect1>
64
65
66 <refsect1>
67         <title>EXAMPLES</title>
68
69         <para>Straight forward use:</para>
70
71 <programlisting>
72         <smbconfsection name="[cooldata]"/>
73         <smbconfoption name="path">/data/ice</smbconfoption>
74         <smbconfoption name="aio read size">1024</smbconfoption>
75         <smbconfoption name="aio write size">1024</smbconfoption>
76         <smbconfoption name="vfs objects">aio_linux</smbconfoption>
77 </programlisting>
78
79 </refsect1>
80
81 <refsect1>
82         <title>OPTIONS</title>
83
84         <variablelist>
85
86                 <varlistentry>
87                 <term>aio_linux:aio num events = INTEGER</term>
88                 <listitem>
89                 <para>Set the maximum size of the event queue
90                 that is used to limit outstanding IO requests.
91                 </para>
92                 <para>By default this is set to 128.</para>
93                 </listitem>
94                 </varlistentry>
95
96         </variablelist>
97 </refsect1>
98 <refsect1>
99         <title>VERSION</title>
100
101         <para>This man page is correct for version 4.0 of the Samba suite.
102         </para>
103 </refsect1>
104
105 <refsect1>
106         <title>AUTHOR</title>
107
108         <para>The original Samba software and related utilities
109         were created by Andrew Tridgell. Samba is now developed
110         by the Samba Team as an Open Source project similar
111         to the way the Linux kernel is developed.</para>
112
113 </refsect1>
114
115 </refentry>