utils/statd/statd.man

   1 .\"@(#)rpc.statd.8"
   2 .\"
   3 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
   4 .\" Modified by Jeffrey A. Uphoff, 1999, 2002, 2005.
   5 .\" Modified by Lon Hohberger, 2000.
   6 .\" Modified by Paul Clements, 2004.
   7 .\"
   8 .\" Rewritten by Chuck Lever <chuck.lever@oracle.com>, 2009.
   9 .\" Copyright 2009 Oracle.  All rights reserved.
  10 .\"
  11 .TH RPC.STATD 8 "1 November 2009
  12 .SH NAME
  13 rpc.statd \- NSM service daemon
  14 .SH SYNOPSIS
  15 .BI "rpc.statd [-dh?FLNvV] [-H " prog "] [-n " my-name "] [-o " outgoing-port "] [-p " listener-port "] [-P " path " ]
  16 .SH DESCRIPTION
  17 File locks are not part of persistent file system state.
  18 Lock state is thus lost when a host reboots.
  19 .PP
  20 Network file systems must also detect when lock state is lost
  21 because a remote host has rebooted.
  22 After an NFS client reboots, an NFS server must release all file locks
  23 held by applications that were running on that client.
  24 After a server reboots, a client must remind the
  25 server of file locks held by applications running on that client.
  26 .PP
  27 For NFS version 2 [RFC1094] and NFS version 3 [RFC1813], the
  28 .I Network Status Monitor
  29 protocol (or NSM for short)
  30 is used to notify NFS peers of reboots.
  31 On Linux, two separate user-space components constitute the NSM service:
  32 .TP
  33 .B rpc.statd
  34 A daemon that listens for reboot notifications from other hosts, and
  35 manages the list of hosts to be notified when the local system reboots
  36 .TP
  37 .B sm-notify
  38 A helper program that notifies NFS peers after the local system reboots
  39 .PP
  40 The local NFS lock manager alerts its local
  41 .B rpc.statd
  42 of each remote peer that should be monitored.
  43 When the local system reboots, the
  44 .B sm-notify
  45 command notifies the NSM service on monitored peers of the reboot.
  46 When a remote reboots, that peer notifies the local
  47 .BR rpc.statd ,
  48 which in turn passes the reboot notification
  49 back to the local NFS lock manager.
  50 .SH NSM OPERATION IN DETAIL
  51 The first file locking interaction between an NFS client and server causes
  52 the NFS lock managers on both peers to contact their local NSM service to
  53 store information about the opposite peer.
  54 On Linux, the local lock manager contacts
  55 .BR rpc.statd .
  56 .PP
  57 .B rpc.statd
  58 records information about each monitored NFS peer on persistent storage.
  59 This information describes how to contact a remote peer
  60 in case the local system reboots,
  61 how to recognize which monitored peer is reporting a reboot,
  62 and how to notify the local lock manager when a monitored peer
  63 indicates it has rebooted.
  64 .PP
  65 An NFS client sends a hostname, known as the client's
  66 .IR caller_name ,
  67 in each file lock request.
  68 An NFS server can use this hostname to send asynchronous GRANT
  69 calls to a client, or to notify the client it has rebooted.
  70 .PP
  71 The Linux NFS server can provide the client's
  72 .I caller_name
  73 or the client's network address to
  74 .BR rpc.statd .
  75 For the purposes of the NSM protocol,
  76 this name or address is known as the monitored peer's
  77 .IR mon_name .
  78 In addition, the local lock manager tells
  79 .B rpc.statd
  80 what it thinks its own hostname is.
  81 For the purposes of the NSM protocol,
  82 this hostname is known as
  83 .IR my_name .
  84 .PP
  85 There is no equivalent interaction between an NFS server and a client
  86 to inform the client of the server's
  87 .IR caller_name .
  88 Therefore NFS clients do not actually know what
  89 .I mon_name
  90 an NFS server might use in an SM_NOTIFY request.
  91 The Linux NFS client uses the server hostname from the mount command
  92 to identify rebooting NFS servers.
  93 .SS Reboot notification
  94 When the local system reboots, the
  95 .B sm-notify
  96 command reads the list of monitored peers from persistent storage and
  97 sends an SM_NOTIFY request to the NSM service on each listed remote peer.
  98 It uses the
  99 .I mon_name
 100 string as the destination.
 101 To identify which host has rebooted, the
 102 .B sm-notify
 103 command sends the
 104 .I my_name
 105 string recorded when that remote was monitored.
 106 The remote
 107 .B rpc.statd
 108 matches incoming SM_NOTIFY requests using this string,
 109 or the caller's network address,
 110 to one or more peers on its own monitor list.
 111 .PP
 112 If
 113 .B rpc.statd
 114 does not find a peer on its monitor list that matches
 115 an incoming SM_NOTIFY request,
 116 the notification is not forwarded to the local lock manager.
 117 In addition, each peer has its own
 118 .IR "NSM state number" ,
 119 a 32-bit integer that is bumped after each reboot by the
 120 .B sm-notify
 121 command.
 122 .B rpc.statd
 123 uses this number to distinguish between actual reboots
 124 and replayed notifications.
 125 .PP
 126 Part of NFS lock recovery is rediscovering
 127 which peers need to be monitored again.
 128 The
 129 .B sm-notify
 130 command clears the monitor list on persistent storage after each reboot.
 131 .SH OPTIONS
 132 .TP
 133 .BR -d , " --no-syslog
 134 Causes
 135 .B rpc.statd
 136 to write log messages on
 137 .I stderr
 138 instead of to the system log,
 139 if the
 140 .B -F
 141 option was also specified.
 142 .TP
 143 .BR -F , " --foreground
 144 Keeps
 145 .B rpc.statd
 146 attached to its controlling terminal so that NSM
 147 operation can be monitored directly or run under a debugger.
 148 If this option is not specified,
 149 .B rpc.statd
 150 backgrounds itself soon after it starts.
 151 .TP
 152 .BR -h , " -?" , " --help
 153 Causes
 154 .B rpc.statd
 155 to display usage information on
 156 .I stderr
 157 and then exit.
 158 .TP
 159 .BI "\-H," "" " \-\-ha-callout " prog
 160 Specifies a high availability callout program.
 161 If this option is not specified, no callouts are performed.
 162 See the
 163 .B High-availability callouts
 164 section below for details.
 165 .TP
 166 .BR -L , " --no-notify
 167 Prevents
 168 .B rpc.statd
 169 from running the
 170 .B sm-notify
 171 command when it starts up,
 172 preserving the existing NSM state number and monitor list.
 173 .IP
 174 Note: the
 175 .B sm-notify
 176 command contains a check to ensure it runs only once after each system reboot.
 177 This prevents spurious reboot notification if
 178 .B rpc.statd
 179 restarts without the
 180 .B -L
 181 option.
 182 .TP
 183 .BI "\-n, " "" "\-\-name " ipaddr " | " hostname
 184 Specifies the bind address used for RPC listener sockets.
 185 The
 186 .I ipaddr
 187 form can be expressed as either an IPv4 or an IPv6 presentation address.
 188 If this option is not specified,
 189 .B rpc.statd
 190 uses a wildcard address as the transport bind address.
 191 .IP
 192 This string is also passed to the
 193 .B sm-notify
 194 command to be used as the source address from which
 195 to send reboot notification requests.
 196 See
 197 .BR sm-notify (8)
 198 for details.
 199 .TP
 200 .BR -N
 201 Causes
 202 .B rpc.statd
 203 to run the
 204 .B sm-notify
 205 command, and then exit.
 206 Since the
 207 .B sm-notify
 208 command can also be run directly, this option is deprecated.
 209 .TP
 210 .BI "\-o," "" " \-\-outgoing\-port "  port
 211 Specifies the source port number the
 212 .B sm-notify
 213 command should use when sending reboot notifications.
 214 See
 215 .BR sm-notify (8)
 216 for details.
 217 .TP
 218 .BI "\-p," "" " \-\-port " port
 219 Specifies the port number used for RPC listener sockets.
 220 If this option is not specified,
 221 .B rpc.statd
 222 chooses a random ephemeral port for each listener socket.
 223 .IP
 224 This option can be used to fix the port value of its listeners when
 225 SM_NOTIFY requests must traverse a firewall between clients and servers.
 226 .TP
 227 .BI "\-P, " "" \-\-state\-directory\-path " pathname
 228 Specifies the pathname of the parent directory
 229 where NSM state information resides.
 230 If this option is not specified,
 231 .B rpc.statd
 232 uses
 233 .I /var/lib/nfs
 234 by default.
 235 .IP
 236 After starting,
 237 .B rpc.statd
 238 attempts to set its effective UID and GID to the owner
 239 and group of this directory.
 240 .TP
 241 .BR -v ", " -V ", " --version
 242 Causes
 243 .B rpc.statd
 244 to display version information on
 245 .I stderr
 246 and then exit.
 247 .SH SECURITY
 248 The
 249 .B rpc.statd
 250 daemon must be started as root to acquire privileges needed
 251 to create sockets with privileged source ports, and to access the
 252 state information database.
 253 Because
 254 .B rpc.statd
 255 maintains a long-running network service, however, it drops root privileges
 256 as soon as it starts up to reduce the risk of a privilege escalation attack.
 257 .PP
 258 During normal operation,
 259 the effective user ID it chooses is the owner of the state directory.
 260 This allows it to continue to access files in that directory after it
 261 has dropped its root privileges.
 262 To control which user ID
 263 .B rpc.statd
 264 chooses, simply use
 265 .BR chown (1)
 266 to set the owner of
 267 the state directory.
 268 .PP
 269 You can also protect your
 270 .B rpc.statd
 271 listeners using the
 272 .B tcp_wrapper
 273 library or
 274 .BR iptables (8).
 275 To use the
 276 .B tcp_wrapper
 277 library, add the hostnames of peers that should be allowed access to
 278 .IR /etc/hosts.allow .
 279 Use the daemon name
 280 .B statd
 281 even if the
 282 .B rpc.statd
 283 binary has a different filename.
 284 .P
 285 For further information see the
 286 .BR tcpd (8)
 287 and
 288 .BR hosts_access (5)
 289 man pages.
 290 .SH ADDITIONAL NOTES
 291 Lock recovery after a reboot is critical to maintaining data integrity
 292 and preventing unnecessary application hangs.
 293 To help
 294 .B rpc.statd
 295 match SM_NOTIFY requests to NLM requests, a number of best practices
 296 should be observed, including:
 297 .IP
 298 The UTS nodename of your systems should match the DNS names that NFS
 299 peers use to contact them
 300 .IP
 301 The UTS nodenames of your systems should always be fully qualified domain names
 302 .IP
 303 The forward and reverse DNS mapping of the UTS nodenames should be
 304 consistent
 305 .IP
 306 The hostname the client uses to mount the server should match the server's
 307 .I mon_name
 308 in SM_NOTIFY requests it sends
 309 .PP
 310 Unmounting an NFS file system does not necessarily stop
 311 either the NFS client or server from monitoring each other.
 312 Both may continue monitoring each other for a time in case subsequent
 313 NFS traffic between the two results in fresh mounts and additional
 314 file locking.
 315 .PP
 316 On Linux, if the
 317 .B lockd
 318 kernel module is unloaded during normal operation,
 319 all remote NFS peers are unmonitored.
 320 This can happen on an NFS client, for example,
 321 if an automounter removes all NFS mount
 322 points due to inactivity.
 323 .SS High-availability callouts
 324 .B rpc.statd
 325 can exec a special callout program during processing of
 326 successful SM_MON, SM_UNMON, and SM_UNMON_ALL requests.
 327 Such a program may be used in High Availability NFS (HA-NFS)
 328 environments to track lock state that may need to be migrated after
 329 a system reboot.
 330 .PP
 331 The name of the callout program is specified with the
 332 .B -H
 333 option.
 334 The program is run with 3 arguments:
 335 The first is either
 336 .B add-client
 337 or
 338 .B del-client
 339 depending on the reason for the callout.
 340 The second is the
 341 .I mon_name
 342 of the monitored peer.
 343 The third is the
 344 .I caller_name
 345 of the requesting lock manager.
 346 .SS IPv6 and TI-RPC support
 347 TI-RPC is a pre-requisite for supporting NFS on IPv6.
 348 If TI-RPC support is built into
 349 .BR rpc.statd ,
 350 it attempts to start listeners on network transports marked
 351 'visible' in
 352 .IR /etc/netconfig .
 353 As long as at least one network transport listener starts successfully,
 354 .B rpc.statd
 355 will operate.
 356 .SH FILES
 357 .TP 2.5i
 358 .I /var/lib/nfs/sm
 359 directory containing monitor list
 360 .TP 2.5i
 361 .I /var/lib/nfs/sm.bak
 362 directory containing notify list
 363 .TP 2.5i
 364 .I /var/lib/nfs/state
 365 NSM state number for this host
 366 .TP 2.5i
 367 .I /var/run/run.statd.pid
 368 pid file
 369 .TP 2.5i
 370 .I /etc/netconfig
 371 network transport capability database
 372 .SH SEE ALSO
 373 .BR sm-notify (8),
 374 .BR nfs (5),
 375 .BR rpc.nfsd (8),
 376 .BR rpcbind (8),
 377 .BR tcpd (8),
 378 .BR hosts_access (5),
 379 .BR iptables (8),
 380 .BR netconfig (5)
 381 .sp
 382 RFC 1094 - "NFS: Network File System Protocol Specification"
 383 .br
 384 RFC 1813 - "NFS Version 3 Protocol Specification"
 385 .br
 386 OpenGroup Protocols for Interworking: XNFS, Version 3W - Chapter 11
 387 .SH AUTHORS
 388 Jeff Uphoff <juphoff@users.sourceforge.net>
 389 .br
 390 Olaf Kirch <okir@monad.swb.de>
 391 .br
 392 H.J. Lu <hjl@gnu.org>
 393 .br
 394 Lon Hohberger <hohberger@missioncriticallinux.com>
 395 .br
 396 Paul Clements <paul.clements@steeleye.com>
 397 .br
 398 Chuck Lever <chuck.lever@oracle.com>