freebsd-dev/sbin/nfsiod/nfsiod.8

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     From: @(#)nfsiod.8	8.2 (Berkeley) 2/22/94
.\" $FreeBSD$
.\"
.Dd December 26, 2009
.Dt NFSIOD 8
.Os
.Sh NAME
.Nm nfsiod
.Nd local
.Tn NFS
asynchronous I/O server
.Sh SYNOPSIS
.Nm
.Op Fl n Ar num_servers
.Sh DESCRIPTION
The
.Nm
utility controls the maximum number of
.Nm
kernel processes which run on an
.Tn NFS
client machine to service asynchronous I/O requests to its server.
Having
.Nm
kernel processes
improves performance but is not required for correct operation.
.Pp
The option is as follows:
.Bl -tag -width indent
.It Fl n
Specify how many processes are permitted to be started.
.El
.Pp
Without an option,
.Nm
displays the current settings.
A client should allow enough number of processes to handle its maximum
level of concurrency, typically four to six.
.Pp
If
.Nm
detects that the running kernel does not include
.Tn NFS
support, it will attempt to load a kernel module containing
.Tn NFS
code, using
.Xr kldload 2 .
If this fails, or no
.Tn NFS
module was available,
.Nm
exits with an error.
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr nfsstat 1 ,
.Xr kldload 2 ,
.Xr nfssvc 2 ,
.Xr mountd 8 ,
.Xr nfsd 8 ,
.Xr rpcbind 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
.Pp
Starting with
.Fx 5.0 ,
the utility no longer starts daemons, but only serves as a vfs
loader and
.Xr sysctl 3
wrapper.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1989, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`.\" From: @(#)nfsiod.8 8.2 (Berkeley) 2/22/94`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`.Dd December 26, 2009`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Dt NFSIOD 8`
			`.Os`
			`.Sh NAME`
			`.Nm nfsiod`
			`.Nd local`
			`.Tn NFS`
			`asynchronous I/O server`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Op Fl n Ar num_servers`
			`.Sh DESCRIPTION`
The .Nm utility 2002-07-06 19:34:18 +00:00			`The`
			`.Nm`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`utility controls the maximum number of`
			`.Nm`
			`kernel processes which run on an`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Tn NFS`
			`client machine to service asynchronous I/O requests to its server.`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`Having`
			`.Nm`
			`kernel processes`
			`improves performance but is not required for correct operation.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Pp`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`The option is as follows:`
Correct use of .Nm. Do not dot terminate syslog() strings. Remove unused #includes. Add rcsid. -Wall. 1998-07-15 06:35:20 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl n`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`Specify how many processes are permitted to be started.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Pp`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`Without an option,`
			`.Nm`
			`displays the current settings.`
			`A client should allow enough number of processes to handle its maximum`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`level of concurrency, typically four to six.`
			`.Pp`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`If`
Correct use of .Nm. Do not dot terminate syslog() strings. Remove unused #includes. Add rcsid. -Wall. 1998-07-15 06:35:20 +00:00			`.Nm`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`detects that the running kernel does not include`
			`.Tn NFS`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`support, it will attempt to load a kernel module containing`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`.Tn NFS`
			`code, using`
- Introduce a new struct xvfsconf, the userland version of struct vfsconf. - Make getvfsbyname() take a struct xvfsconf *. - Convert several consumers of getvfsbyname() to use struct xvfsconf. - Correct the getvfsbyname.3 manpage. - Create a new vfs.conflist sysctl to dump all the struct xvfsconf in the kernel, and rewrite getvfsbyname() to use this instead of the weird existing API. - Convert some {set,get,end}vfsent() consumers to use the new vfs.conflist sysctl. - Convert a vfsload() call in nfsiod.c to kldload() and remove the useless vfsisloadable() and endvfsent() calls. - Add a warning printf() in vfs_sysctl() to tell people they are using an old userland. After these changes, it's possible to modify struct vfsconf without breaking the binary compatibility. Please note that these changes don't break this compatibility either. When bp will have updated mount_smbfs(8) with the patch I sent him, there will be no more consumers of the {set,get,end}vfsent(), vfsisloadable() and vfsload() API, and I will promptly delete it. 2002-08-10 20:19:04 +00:00			`.Xr kldload 2 .`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`If this fails, or no`
			`.Tn NFS`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`module was available,`
Correct use of .Nm. Do not dot terminate syslog() strings. Remove unused #includes. Add rcsid. -Wall. 1998-07-15 06:35:20 +00:00			`.Nm`
Automatically load NFS and a bevy of other filesystems. 1994-09-22 22:17:02 +00:00			`exits with an error.`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh SEE ALSO`
			`.Xr nfsstat 1 ,`
- Introduce a new struct xvfsconf, the userland version of struct vfsconf. - Make getvfsbyname() take a struct xvfsconf *. - Convert several consumers of getvfsbyname() to use struct xvfsconf. - Correct the getvfsbyname.3 manpage. - Create a new vfs.conflist sysctl to dump all the struct xvfsconf in the kernel, and rewrite getvfsbyname() to use this instead of the weird existing API. - Convert some {set,get,end}vfsent() consumers to use the new vfs.conflist sysctl. - Convert a vfsload() call in nfsiod.c to kldload() and remove the useless vfsisloadable() and endvfsent() calls. - Add a warning printf() in vfs_sysctl() to tell people they are using an old userland. After these changes, it's possible to modify struct vfsconf without breaking the binary compatibility. Please note that these changes don't break this compatibility either. When bp will have updated mount_smbfs(8) with the patch I sent him, there will be no more consumers of the {set,get,end}vfsent(), vfsisloadable() and vfsload() API, and I will promptly delete it. 2002-08-10 20:19:04 +00:00			`.Xr kldload 2 ,`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Xr nfssvc 2 ,`
			`.Xr mountd 8 ,`
Thresh-out the nfs manual page references a bit Reviewed by: Julian Elischer <julian@elischer.org> 2000-01-13 21:47:21 +00:00			`.Xr nfsd 8 ,`
Correct cross-reference: portmap.8 --> rpcbind.8 Submitted by: .Xr testing script 2001-06-07 16:59:19 +00:00			`.Xr rpcbind 8`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh HISTORY`
			`The`
Correct use of .Nm. Do not dot terminate syslog() strings. Remove unused #includes. Add rcsid. -Wall. 1998-07-15 06:35:20 +00:00			`.Nm`
Use the .Bx macro where appropriate. 1996-08-23 20:36:11 +00:00			`utility first appeared in`
			`.Bx 4.4 .`
- Display current settings when run without options. - Revise a manpage to NOT sound confusing. [1] In collaboration with: sat [1] 2009-12-26 08:36:02 +00:00			`.Pp`
			`Starting with`
			`.Fx 5.0 ,`
			`the utility no longer starts daemons, but only serves as a vfs`
			`loader and`
			`.Xr sysctl 3`
			`wrapper.`