Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_io_uring.8

raw
1 '\" t
2 .\" Title: vfs_io_uring
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_IO_URING" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_io_uring \- Implement async io in Samba vfs using io_uring of Linux (>= 5\&.1)\&.
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = io_uring
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 io_uring
43 VFS module enables asynchronous pread, pwrite and fsync using the io_uring infrastructure of Linux (>= 5\&.1)\&. This provides much less overhead compared to the usage of the pthreadpool for async io\&.
44 .PP
45 This module SHOULD be listed last in any module stack as it requires real kernel file descriptors\&.
46 .SH "EXAMPLES"
47 .PP
48 Straight forward use:
49 .sp
50 .if n \{\
51 .RS 4
52 .\}
53 .nf
54 \fI[cooldata]\fR
55 \m[blue]\fBpath = /data/ice\fR\m[]
56 \m[blue]\fBvfs objects = io_uring\fR\m[]
57 .fi
58 .if n \{\
59 .RE
60 .\}
61 .SH "OPTIONS"
62 .PP
63 io_uring:num_entries = NUMBER_OF_QUEUE_ENTRIES
64 .RS 4
65 The number of entries in the submission queue\&. The maximum allowed value depends on the kernel version and the kernel will roundup the value to a power of 2\&.
66 .sp
67 The default is \*(Aq128\*(Aq\&.
68 .RE
69 .PP
70 io_uring:sqpoll = BOOL
71 .RS 4
72 Use the IORING_SETUP_SQPOLL feature\&.
73 .sp
74 The default is \*(Aqno\*(Aq\&.
75 .RE
76 .SH "SEE ALSO"
77 .PP
78 \fBio_uring_setup\fR(2)\&.
79 .SH "VERSION"
80 .PP
81 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
82 .SH "AUTHOR"
83 .PP
84 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.