docs-xml/manpages/vfs_io_uring.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_io_uring.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_io_uring</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13 <refnamediv>
  14         <refname>vfs_io_uring</refname>
  15         <refpurpose>Implement async io in Samba vfs using io_uring of Linux (>= 5.1).</refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19         <cmdsynopsis>
  20                 <command>vfs objects = io_uring</command>
  21         </cmdsynopsis>
  22 </refsynopsisdiv>
  23
  24 <refsect1>
  25         <title>DESCRIPTION</title>
  26
  27         <para>This VFS module is part of the
  28         <citerefentry><refentrytitle>samba</refentrytitle>
  29         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  30
  31         <para>The <command>io_uring</command> VFS module enables asynchronous
  32         pread, pwrite and fsync using the io_uring infrastructure of Linux (>= 5.1).
  33         This provides much less overhead compared to the usage of the pthreadpool for
  34         async io.</para>
  35
  36         <para>This module SHOULD be listed last in any module stack as
  37         it requires real kernel file descriptors.</para>
  38
  39 </refsect1>
  40
  41
  42 <refsect1>
  43         <title>EXAMPLES</title>
  44
  45         <para>Straight forward use:</para>
  46
  47 <programlisting>
  48         <smbconfsection name="[cooldata]"/>
  49         <smbconfoption name="path">/data/ice</smbconfoption>
  50         <smbconfoption name="vfs objects">io_uring</smbconfoption>
  51 </programlisting>
  52
  53 </refsect1>
  54
  55 <refsect1>
  56         <title>OPTIONS</title>
  57
  58         <variablelist>
  59
  60                 <varlistentry>
  61                 <term>io_uring:num_entries = NUMBER_OF_QUEUE_ENTRIES</term>
  62                 <listitem>
  63                 <para>The number of entries in the submission queue.
  64                 The maximum allowed value depends on the kernel version
  65                 and the kernel will roundup the value to a power of 2.
  66                 </para>
  67                 <para>The default is '128'.</para>
  68                 </listitem>
  69                 </varlistentry>
  70
  71                 <varlistentry>
  72                 <term>io_uring:sqpoll = BOOL</term>
  73                 <listitem>
  74                 <para>Use the IORING_SETUP_SQPOLL feature.
  75                 </para>
  76                 <para>The default is 'no'.</para>
  77                 </listitem>
  78                 </varlistentry>
  79
  80         </variablelist>
  81 </refsect1>
  82
  83 <refsect1>
  84         <title>SEE ALSO</title>
  85         <para>
  86         <citerefentry><refentrytitle>io_uring_setup</refentrytitle><manvolnum>2</manvolnum></citerefentry>.
  87         </para>
  88 </refsect1>
  89
  90 <refsect1>
  91         <title>VERSION</title>
  92
  93         <para>This man page is part of version &doc.version; of the Samba suite.
  94         </para>
  95 </refsect1>
  96
  97 <refsect1>
  98         <title>AUTHOR</title>
  99
 100         <para>The original Samba software and related utilities
 101         were created by Andrew Tridgell. Samba is now developed
 102         by the Samba Team as an Open Source project similar
 103         to the way the Linux kernel is developed.</para>
 104
 105 </refsect1>
 106
 107 </refentry>