d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document the changes done to nfsuserd by r320757.

Browse Source 
This is a content change.
This commit is contained in:
rmacklem 2017-07-06 22:34:34 +00:00
parent dca15b18f0
commit a03b61f552
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
usr.sbin/nfsuserd/nfsuserd.8
View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 4, 2017
.Dd July 6, 2017
.Dt NFSUSERD 8
.Os
.Sh NAME
@ -40,21 +40,34 @@ services plus support manage-gids for all NFS versions
.Op Fl verbose
.Op Fl force
.Op Fl manage-gids
.Op Fl use-udpsock
.Op Ar num_servers
.Sh DESCRIPTION
.Nm
loads user and group information into the kernel for NFSv4.
It must be running for NFSv4 to function correctly, either client or server.
It also provides support for manage-gids and must be running on the server if
this is being used for any version of NFS.
.Pp
Upon startup, it loads the machines DNS domain name, plus timeout and
cache size limit into the kernel. It then preloads the cache with group
and user information, up to the cache size limit and forks off N children
(default 4), that service requests from the kernel for cache misses. The
master server is there for the sole purpose of killing off the slaves.
(only 1 child for AF_LOCAL sockets), that service requests from the kernel for cache misses.
The master server is there for the sole purpose of killing off the slave(s).
To stop the nfsuserd, send a SIGUSR1 to the master server.
.Pp
By default, upcalls from the kernel use an AF_LOCAL socket.
For this case, only one server daemon will be running.
The
.Fl use-udpsock
option may be used to make the
.Nm
daemon use a UDP socket, with upcalls done via 127.0.0.1, which was the
old behaviour for
.Nm .
Use of the UDP socket can only be done if
.Xr jail 8
are not being used.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl domain Ar domain_name
@ -91,14 +104,12 @@ and uses the group list for that uid provided by
.Xr getgrouplist 3
on the server instead of the list of groups provided in the RPC authenticator.
This can be used to avoid the 16 group limit for AUTH_SYS.
.It Fl use-udpsock
This flag forces use of the old behaviour of a UDP socket with upcalls done via 127.0.0.1.
.It Ar num_servers
Specifies how many servers to create (max 20).
The default of 4 may be sufficient. You should run enough servers, so that
.Xr ps 1
shows almost no running time for one or two of the slaves after the system
has been running for a long period. Running too few will have a major
performance impact, whereas running too many will only tie up some resources,
such as a process table entry and swap space.
This option has been deprecated and is ignored for AF_LOCAL upcall sockets,
which always use a single server.
.El
.Sh SEE ALSO
.Xr getgrent 3 ,
@ -127,8 +138,11 @@ and
.Xr passwd 5
for more information on how the databases are accessed.
.Pp
Since the kernel communicates with the
For the
.Fl use-udpsock
option, since the kernel communicates with the
.Nm
daemon via an upcall that uses the IP address 127.0.0.1, it does not work correctly when
.Xr jail 8
are used and can crash the system.
This is not a problem when a AF_LOCAL socket is used.