xref: /dragonfly/share/man/man9/VFS_CHECKEXP.9 (revision 1d1731fa)
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: src/share/man/man9/VFS_CHECKEXP.9,v 1.2.2.4 2001/12/17 11:30:18 ru Exp $
26.\" $DragonFly: src/share/man/man9/VFS_CHECKEXP.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
27.\"
28.Dd September 10, 1999
29.Os
30.Dt VFS_CHECKEXP 9
31.Sh NAME
32.Nm VFS_CHECKEXP
33.Nd check if vnode is exported to a client
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/mount.h
37.Ft int
38.Fn VFS_CHECKEXP "struct mount *mp" "struct mbuf  *nam" "int *exflagsp" "struct ucred **credanonp"
39.Sh DESCRIPTION
40This is used by the NFS server to check if a mount point is exported
41to a client.
42.Pp
43Its arguments are:
44.Bl -tag -width credanonp
45.It Fa mp
46The mount point to be checked.
47.It Fa nam
48An mbuf containing the network address of the client.
49.It Fa exflagsp
50Return parameter for the export flags for this client.
51.It Fa credanonp
52Return parameter for the anonymous credentials for this client.
53.El
54.Pp
55This should be called on a file system's mount structure to determine if it
56is exported to a client whose address is contained in
57.Fa nam .
58.Pp
59It is generally called before
60.Xr VFS_FHTOVP 9
61to validate that a client has access to the filesystem.
62.Pp
63The filesystem should call
64.Xr vfs_export_lookup 9
65with the address of an appropriate
66.Vt netexport
67structure and the address of the client,
68.Fa nam ,
69to verify that the client can access this filesystem.
70.Sh RETURN VALUES
71The export flags and anonymous credentials specific to the client (returned
72by
73.Xr vfs_export_lookup 9 )
74will be returned in
75.Fa *exflagsp
76and
77.Fa *credanonp .
78.Sh SEE ALSO
79.Xr VFS 9 ,
80.Xr VFS_FHTOVP 9 ,
81.Xr VFS_VPTOFH 9 ,
82.Xr vnode 9
83.Sh AUTHORS
84This man page was written by
85.An Alfred Perlstein .
86