d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
958e30b890
freebsd-skq/share/man/man9/VFS_CHECKEXP.9

89 lines
2.6 KiB
Groff
Raw Normal View History

Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.\"
vnode -> mountpoint reference vfs_check_export change license to my own, (ok'd by dfr) and remove advert clause. remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
.\" Copyright (c) 1999 Alfred Perlstein
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
vnode -> mountpoint reference vfs_check_export change license to my own, (ok'd by dfr) and remove advert clause. remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
.\" modification, are permitted provided that the following condition
.\" is met:
.\" Redistributions of source code must retain the above copyright
.\" notice, this condition and the following disclaimer.
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
.\"
.\" $FreeBSD$
.\"
Catch up with the VFS_VPTOFH(9) -> VOP_VPTOFH(9) repocopy that happened almost three years ago in r166794. PR: 140989 Submitted by: Lachlan Kang MFC after: 1 week
2010-01-04 22:22:00 +00:00
.Dd January 4, 2010
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Dt VFS_CHECKEXP 9
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Sh NAME
.Nm VFS_CHECKEXP
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
.Nd check if a file system is exported to a client
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/param.h
.In sys/mount.h
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Ft int
Fixed rotted-as-committed pseudo-prototype for VFS_CHECKXP(). It had not caught up with the changes to avoid storing socket addresses in mbufs, although the VFS_CHECKEXP() code had to since it was committed 2 years after those changes. Fixed formatting in this prototype.
2001-02-15 12:41:44 +00:00
.Fn VFS_CHECKEXP "struct mount *mp" "struct sockaddr *nam" "int *exflagsp" "struct ucred **credanonp"
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Sh DESCRIPTION
The .Fn macro.
2005-01-07 11:39:36 +00:00
The
.Fn VFS_CHECKEXP
macro is used by the NFS server to check if a mount point is exported
vnode -> mountpoint reference vfs_check_export change license to my own, (ok'd by dfr) and remove advert clause. remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
to a client.
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Pp
The .Fn macro.
2005-01-07 11:39:36 +00:00
The arguments it expects are:
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Bl -tag -width credanonp
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa mp
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
The mount point to be checked.
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa nam
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
An mbuf containing the network address of the client.
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa exflagsp
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
Return parameter for the export flags for this client.
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa credanonp
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
Return parameter for the anonymous credentials for this client.
.El
.Pp
The .Fn macro.
2005-01-07 11:39:36 +00:00
The
.Fn VFS_CHECKEXP
macro should be called on a file system's mount structure to determine if it
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
is exported to a client whose address is contained in
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Fa nam .
.Pp
It is generally called before
.Xr VFS_FHTOVP 9
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
to validate that a client has access to the file system.
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Pp
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
The file system should call
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Xr vfs_export_lookup 9
with the address of an appropriate
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.Vt netexport
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
structure and the address of the client,
.Fa nam ,
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
to verify that the client can access this file system.
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Sh RETURN VALUES
vnode -> mountpoint reference vfs_check_export change license to my own, (ok'd by dfr) and remove advert clause. remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
The export flags and anonymous credentials specific to the client (returned
by
.Xr vfs_export_lookup 9 )
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
will be returned in
.Fa *exflagsp
and
.Fa *credanonp .
.Sh SEE ALSO
.Xr VFS 9 ,
.Xr VFS_FHTOVP 9 ,
Catch up with the VFS_VPTOFH(9) -> VOP_VPTOFH(9) repocopy that happened almost three years ago in r166794. PR: 140989 Submitted by: Lachlan Kang MFC after: 1 week
2010-01-04 22:22:00 +00:00
.Xr VOP_VPTOFH 9 ,
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.Xr vnode 9
.Sh AUTHORS
Mdoc Janitor: * Use 'manual' instead of 'man' for consistency.
2003-10-23 06:24:55 +00:00
This manual page was written by
Document VFS changes: VFS_CHECKEXP.9, now used to check export credentials VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done. VFS.9, inform people of the vfs_std* functions available to avoid ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
.An Alfred Perlstein .
Reference in New Issue Copy Permalink