xref: /freebsd/share/man/man9/VFS_FHTOVP.9 (revision 09356c848473844673c36bb823b82effc73f1ea5)
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.\"
29.\" $FreeBSD$
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.In sys/param.h
39.In sys/mount.h
40.In sys/vnode.h
41.Ft int
42.Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct vnode **vpp"
43.Sh DESCRIPTION
44This is used by the NFS server to turn an NFS filehandle into a vnode.
45.Pp
46Its arguments are:
47.Bl -tag -width vpp
48.It Fa mp
49The file system.
50.It Fa fhp
51The filehandle to convert.
52.It Fa vpp
53Return parameter for the new locked vnode.
54.El
55.Pp
56The contents of the filehandle are defined by the file system and are
57not examined by any other part of the system.
58It should contain
59enough information to uniquely identify a file within the file system
60as well as noticing when a file has been removed and the file system
61resources have been reused for a new file.
62For instance, UFS
63file system stores the inode number and inode generation counter in its
64filehandle.
65.Pp
66A call to this function should generally be preceded by a call to
67.Xr VFS_CHECKEXP 9
68to check if the file is accessible to the client.
69.Sh RETURN VALUES
70The locked vnode for the file will be returned in
71.Fa *vpp .
72.Sh SEE ALSO
73.Xr VFS 9 ,
74.Xr VFS_CHECKEXP 9 ,
75.Xr VFS_VPTOFH 9 ,
76.Xr vnode 9
77.Sh AUTHORS
78This manual page was written by
79.An Doug Rabson .
80