Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_cacheprime.8

raw
1 '\" t
2 .\" Title: vfs_cacheprime
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_CACHEPRIME" "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_cacheprime \- prime the kernel file data cache
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = cacheprime
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 vfs_cacheprime
43 VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients\&.
44 .PP
45 The size of the disk read operations performed by
46 vfs_cacheprime
47 is determined by the cacheprime:rsize option\&. All disk read operations are aligned on boundaries that are a multiple of this size\&. Each range of the file data is primed at most once during the time the client has the file open\&.
48 .PP
49 This module is stackable\&.
50 .SH "OPTIONS"
51 .PP
52 cacheprime:rsize = BYTES
53 .RS 4
54 The number of bytes with which to prime the kernel data cache\&.
55 .sp
56 The following suffixes may be applied to BYTES:
57 .RS
58 .sp
59 .RS 4
60 .ie n \{\
61 \h'-04'\(bu\h'+03'\c
62 .\}
63 .el \{\
64 .sp -1
65 .IP \(bu 2.3
66 .\}
67 K
68 \- BYTES is a number of kilobytes
69 .RE
70 .sp
71 .RS 4
72 .ie n \{\
73 \h'-04'\(bu\h'+03'\c
74 .\}
75 .el \{\
76 .sp -1
77 .IP \(bu 2.3
78 .\}
79 M
80 \- BYTES is a number of megabytes
81 .RE
82 .sp
83 .RS 4
84 .ie n \{\
85 \h'-04'\(bu\h'+03'\c
86 .\}
87 .el \{\
88 .sp -1
89 .IP \(bu 2.3
90 .\}
91 G
92 \- BYTES is a number of gigabytes
93 .RE
94 .sp
95 .RE
96 .RE
97 .SH "EXAMPLES"
98 .PP
99 For a hypothetical disk array, it is necessary to ensure that all read operations are of size 1 megabyte (1048576 bytes), and aligned on 1 megabyte boundaries:
100 .sp
101 .if n \{\
102 .RS 4
103 .\}
104 .nf
105 \fI[hypothetical]\fR
106 \m[blue]\fBvfs objects = cacheprime\fR\m[]
107 \m[blue]\fBcacheprime:rsize = 1M\fR\m[]
108 .fi
109 .if n \{\
110 .RE
111 .\}
112 .SH "CAVEATS"
113 .PP
114 cacheprime
115 is not a substitute for a general\-purpose readahead mechanism\&. It is intended for use only in very specific environments where disk operations must be aligned and sized to known values (as much as that is possible)\&.
116 .SH "VERSION"
117 .PP
118 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
119 .SH "AUTHOR"
120 .PP
121 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\&.