1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in the
16.\" documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
| 1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in the
16.\" documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
|
30.\"
31.Dd July 24, 1996
32.Os
33.Dt VFS_FHTOVP 9
34.Sh NAME
35.Nm VFS_FHTOVP
36.Nd turn an NFS filehandle into a vnode
37.Sh SYNOPSIS
38.Fd #include <sys/mount.h>
39.Fd #include <sys/vnode.h>
40.Ft int
41.Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct mbuf *nam" "struct vnode **vpp" "int *exflagsp" "struct ucred **credanonp"
42.Sh DESCRIPTION
43This is used by the NFS server to turn an NFS filehandle into a vnode.
44.Pp
45Its arguments are:
46.Bl -tag -width credanonp
47.It Ar mp
48The filesystem.
49.It Ar fhp
50The filehandle to convert.
51.It Ar nam
52An mbuf containing the network address of the client.
53.It Ar vpp
54Return parameter for the new locked vnode.
55.It Ar exflagsp
56Return parameter for the export flags for this client.
57.It Ar credanonp
58Return parameter for the anonymous credentials for this client.
59.El
60.Pp
61The contents of the filehandle are defined by the filesystem and are
62not examined by any other part of the system. It should contain
63enough information to uniquely identify a file within the filesystem
64as well as noticing when a file has been removed and the filesystem
65resources have been reused for a new file. For instance, UFS
66filesystem stores the inode number and inode generation counter in its
67filehandle.
68.Pp
69The filesystem should call
70.Xr vfs_export_lookup 9
71with the address of an appropriate
72.Dv netexport
73structure and the address of the client,
74.Fa nam ,
75to verify that the client can access this filesystem.
76.Sh RETURN VALUES
77The locked vnode for the file will be returned in
78.Fa *vpp .
79The export flags and anonymous credentials specific to the client
80(returned by
81.Xr vfs_export_lookup 9 )
82will be returned in
83.Fa *exflagsp
84and
85.Fa *credanonp .
86.Sh SEE ALSO
87.Xr VFS 9 ,
88.Xr VFS_VPTOFH 9 ,
89.Xr vnode 9
90.Sh AUTHORS
| 30.\"
31.Dd July 24, 1996
32.Os
33.Dt VFS_FHTOVP 9
34.Sh NAME
35.Nm VFS_FHTOVP
36.Nd turn an NFS filehandle into a vnode
37.Sh SYNOPSIS
38.Fd #include <sys/mount.h>
39.Fd #include <sys/vnode.h>
40.Ft int
41.Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct mbuf *nam" "struct vnode **vpp" "int *exflagsp" "struct ucred **credanonp"
42.Sh DESCRIPTION
43This is used by the NFS server to turn an NFS filehandle into a vnode.
44.Pp
45Its arguments are:
46.Bl -tag -width credanonp
47.It Ar mp
48The filesystem.
49.It Ar fhp
50The filehandle to convert.
51.It Ar nam
52An mbuf containing the network address of the client.
53.It Ar vpp
54Return parameter for the new locked vnode.
55.It Ar exflagsp
56Return parameter for the export flags for this client.
57.It Ar credanonp
58Return parameter for the anonymous credentials for this client.
59.El
60.Pp
61The contents of the filehandle are defined by the filesystem and are
62not examined by any other part of the system. It should contain
63enough information to uniquely identify a file within the filesystem
64as well as noticing when a file has been removed and the filesystem
65resources have been reused for a new file. For instance, UFS
66filesystem stores the inode number and inode generation counter in its
67filehandle.
68.Pp
69The filesystem should call
70.Xr vfs_export_lookup 9
71with the address of an appropriate
72.Dv netexport
73structure and the address of the client,
74.Fa nam ,
75to verify that the client can access this filesystem.
76.Sh RETURN VALUES
77The locked vnode for the file will be returned in
78.Fa *vpp .
79The export flags and anonymous credentials specific to the client
80(returned by
81.Xr vfs_export_lookup 9 )
82will be returned in
83.Fa *exflagsp
84and
85.Fa *credanonp .
86.Sh SEE ALSO
87.Xr VFS 9 ,
88.Xr VFS_VPTOFH 9 ,
89.Xr vnode 9
90.Sh AUTHORS
|