xref: /freebsd/share/man/man9/VFS_CHECKEXP.9 (revision 70d51341bf6ad3be0ea5b02ef489691d80719249)
1.\"
2.\" Copyright (c) 1999 Alfred Perlstein
3.\"
4.\" All rights reserved.
5.\"
6.\" This program is free software.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following condition
10.\" is met:
11.\"    Redistributions of source code must retain the above copyright
12.\"    notice, this condition and the following disclaimer.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd September 10, 1999
28.Os
29.Dt VFS_CHECKEXP 9
30.Sh NAME
31.Nm VFS_CHECKEXP
32.Nd check if a filesystem is exported to a client
33.Sh SYNOPSIS
34.Fd #include <sys/param.h>
35.Fd #include <sys/mount.h>
36.Ft int
37.Fn VFS_CHECKEXP "struct mount *mp" "struct sockaddr *nam" "int *exflagsp" "struct ucred **credanonp"
38.Sh DESCRIPTION
39This is used by the NFS server to check if a mount point is exported
40to a client.
41.Pp
42Its arguments are:
43.Bl -tag -width credanonp
44.It Ar mp
45The mount point to be checked.
46.It Ar nam
47An mbuf containing the network address of the client.
48.It Ar exflagsp
49Return parameter for the export flags for this client.
50.It Ar credanonp
51Return parameter for the anonymous credentials for this client.
52.El
53.Pp
54This should be called on a file system's mount structure to determine if it
55is exported to a client whose address is contained in
56.Fa nam .
57.Pp
58It is generally called before
59.Xr VFS_FHTOVP 9
60to validate that a client has access to the filesystem.
61.Pp
62The filesystem should call
63.Xr vfs_export_lookup 9
64with the address of an appropriate
65.Dv netexport
66structure and the address of the client,
67.Fa nam ,
68to verify that the client can access this filesystem.
69.Sh RETURN VALUES
70The export flags and anonymous credentials specific to the client (returned
71by
72.Xr vfs_export_lookup 9 )
73will be returned in
74.Fa *exflagsp
75and
76.Fa *credanonp .
77.Sh SEE ALSO
78.Xr VFS 9 ,
79.Xr VFS_FHTOVP 9 ,
80.Xr VFS_VPTOFH 9 ,
81.Xr vnode 9
82.Sh AUTHORS
83This man page was written by
84.An Alfred Perlstein .
85