Debian Codegraph @

upstream/debian-unstable/man8/nfsdcld.8

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "NFSDCLD 8"
127 .TH NFSDCLD 8 "2011-12-21" "" ""
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 nfsdcld \- NFSv4 Client Tracking Daemon
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 nfsdcld [\-d] [\-F] [\-p path] [\-s stable storage dir]
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 nfsdcld is the NFSv4 client tracking daemon. It is not necessary to run
140 this daemon on machines that are not acting as NFSv4 servers.
141 .PP
142 When a network partition is combined with a server reboot, there are
143 edge conditions that can cause the server to grant lock reclaims when
144 other clients have taken conflicting locks in the interim. A more detailed
145 explanation of this issue is described in \s-1RFC\s0 3530, section 8.6.3.
146 .PP
147 In order to prevent these problems, the server must track a small amount
148 of per-client information on stable storage. This daemon provides the
149 userspace piece of that functionality.
150 .SH "OPTIONS"
151 .IX Header "OPTIONS"
152 .IP "\fB\-d\fR, \fB\-\-debug\fR" 4
153 .IX Item "-d, --debug"
154 Enable debug level logging.
155 .IP "\fB\-F\fR, \fB\-\-foreground\fR" 4
156 .IX Item "-F, --foreground"
157 Runs the daemon in the foreground and prints all output to stderr
158 .IP "\fB\-p\fR \fIpath\fR, \fB\-\-pipefsdir\fR=\fIpath\fR" 4
159 .IX Item "-p path, --pipefsdir=path"
160 Location of the rpc_pipefs filesystem. The default value is
161 \&\fI/var/lib/nfs/rpc_pipefs\fR.
162 .IP "\fB\-s\fR \fIstorage_dir\fR, \fB\-\-storagedir\fR=\fIstorage_dir\fR" 4
163 .IX Item "-s storagedir, --storagedir=storage_dir"
164 Directory where stable storage information should be kept. The default
165 value is \fI/var/lib/nfs/nfsdcld\fR.
166 .SH "CONFIGURATION FILE"
167 .IX Header "CONFIGURATION FILE"
168 The following values are recognized in the \fB[nfsdcld]\fR section
169 of the \fI/etc/nfs.conf\fR configuration file:
170 .IP "\fBstoragedir\fR" 4
171 .IX Item "storagedir"
172 Equivalent to \fB\-s\fR/\fB\-\-storagedir\fR.
173 .IP "\fBdebug\fR" 4
174 .IX Item "debug"
175 Setting "debug = 1" is equivalent to \fB\-d\fR/\fB\-\-debug\fR.
176 .LP
177 In addition, the following value is recognized from the \fB[general]\fR section:
178 .IP "\fBpipefs\-directory\fR" 4
179 .IX Item "pipefs-directory"
180 Equivalent to \fB\-p\fR/\fB\-\-pipefsdir\fR.
181 .SH "NOTES"
182 .IX Header "NOTES"
183 The Linux kernel NFSv4 server has historically tracked this information
184 on stable storage by manipulating information on the filesystem
185 directly, in the directory to which \fI/proc/fs/nfsd/nfsv4recoverydir\fR
186 points.
187 .PP
188 This changed with the original introduction of \fBnfsdcld\fR upcall in kernel version 3.4,
189 which was later deprecated in favor of the \fBnfsdcltrack\fR(8) usermodehelper
190 program, support for which was added in kernel version 3.8. However, since the
191 usermodehelper upcall does not work in containers, support for a new version of
192 the \fBnfsdcld\fR upcall was added in kernel version 5.2.
193 .PP
194 This daemon requires a kernel that supports the \fBnfsdcld\fR upcall. On older kernels, if
195 the legacy client name tracking code was in use, then the kernel would not create the
196 pipe that \fBnfsdcld\fR uses to talk to the kernel. On newer kernels, nfsd attempts to
197 initialize client tracking in the following order: First, the \fBnfsdcld\fR upcall. Second,
198 the \fBnfsdcltrack\fR usermodehelper upcall. Finally, the legacy client tracking.
199 .PP
200 This daemon should be run as root, as the pipe that it uses to communicate
201 with the kernel is only accessible by root. The daemon however does drop all
202 superuser capabilities after starting. Because of this, the \fIstoragedir\fR
203 should be owned by root, and be readable and writable by owner.
204 .PP
205 The daemon now supports different upcall versions to allow the kernel to pass additional
206 data to be stored in the on-disk database. The kernel will query the supported upcall
207 version from \fBnfsdcld\fR during client tracking initialization. A restart of \fBnfsd\fR is
208 not necessary after upgrading \fBnfsdcld\fR, however \fBnfsd\fR will not use a later upcall
209 version until restart. A restart of \fBnfsd is necessary\fR after downgrading \fBnfsdcld\fR,
210 to ensure that \fBnfsd\fR does not use an upcall version that \fBnfsdcld\fR does not support.
211 Additionally, a downgrade of \fBnfsdcld\fR requires the schema of the on-disk database to
212 be downgraded as well. That can be accomplished using the \fBnfsdclddb\fR(8) utility.
213 .SH FILES
214 .TP
215 .B /var/lib/nfs/nfsdcld/main.sqlite
216 .SH SEE ALSO
217 .BR nfsdcltrack "(8), " nfsdclddb (8)
218 .SH "AUTHORS"
219 .IX Header "AUTHORS"
220 The nfsdcld daemon was developed by Jeff Layton <[email protected]>
221 with modifications from Scott Mayhew <[email protected]>.