xref: /dflybsd-src/share/man/man9/VFS_FHTOVP.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
2*86d7f5d3SJohn Marino.\"
3*86d7f5d3SJohn Marino.\" All rights reserved.
4*86d7f5d3SJohn Marino.\"
5*86d7f5d3SJohn Marino.\" This program is free software.
6*86d7f5d3SJohn Marino.\"
7*86d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
8*86d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
9*86d7f5d3SJohn Marino.\" are met:
10*86d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
11*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
12*86d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
13*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
14*86d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
15*86d7f5d3SJohn Marino.\"
16*86d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17*86d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18*86d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19*86d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20*86d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21*86d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22*86d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23*86d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*86d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25*86d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*86d7f5d3SJohn Marino.\"
27*86d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VFS_FHTOVP.9,v 1.6.2.5 2001/12/17 11:30:18 ru Exp $
28*86d7f5d3SJohn Marino.\"
29*86d7f5d3SJohn Marino.Dd July 24, 1996
30*86d7f5d3SJohn Marino.Dt VFS_FHTOVP 9
31*86d7f5d3SJohn Marino.Os
32*86d7f5d3SJohn Marino.Sh NAME
33*86d7f5d3SJohn Marino.Nm VFS_FHTOVP
34*86d7f5d3SJohn Marino.Nd turn an NFS filehandle into a vnode
35*86d7f5d3SJohn Marino.Sh SYNOPSIS
36*86d7f5d3SJohn Marino.In sys/param.h
37*86d7f5d3SJohn Marino.In sys/mount.h
38*86d7f5d3SJohn Marino.In sys/vnode.h
39*86d7f5d3SJohn Marino.Ft int
40*86d7f5d3SJohn Marino.Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct vnode **vpp"
41*86d7f5d3SJohn Marino.Sh DESCRIPTION
42*86d7f5d3SJohn MarinoThis is used by the NFS server to turn an NFS filehandle into a vnode.
43*86d7f5d3SJohn Marino.Pp
44*86d7f5d3SJohn MarinoIts arguments are:
45*86d7f5d3SJohn Marino.Bl -tag -width vpp
46*86d7f5d3SJohn Marino.It Ar mp
47*86d7f5d3SJohn MarinoThe filesystem.
48*86d7f5d3SJohn Marino.It Ar fhp
49*86d7f5d3SJohn MarinoThe filehandle to convert.
50*86d7f5d3SJohn Marino.It Ar vpp
51*86d7f5d3SJohn MarinoReturn parameter for the new locked vnode.
52*86d7f5d3SJohn Marino.El
53*86d7f5d3SJohn Marino.Pp
54*86d7f5d3SJohn MarinoThe contents of the filehandle are defined by the filesystem and are
55*86d7f5d3SJohn Marinonot examined by any other part of the system.  It should contain
56*86d7f5d3SJohn Marinoenough information to uniquely identify a file within the filesystem
57*86d7f5d3SJohn Marinoas well as noticing when a file has been removed and the filesystem
58*86d7f5d3SJohn Marinoresources have been reused for a new file.  For instance, UFS
59*86d7f5d3SJohn Marinofilesystem stores the inode number and inode generation counter in its
60*86d7f5d3SJohn Marinofilehandle.
61*86d7f5d3SJohn Marino.Pp
62*86d7f5d3SJohn MarinoA call to this function should generally be preceded by a call to
63*86d7f5d3SJohn Marino.Xr VFS_CHECKEXP 9
64*86d7f5d3SJohn Marinoto check if the file is accessible to the client.
65*86d7f5d3SJohn Marino.Sh RETURN VALUES
66*86d7f5d3SJohn MarinoThe locked vnode for the file will be returned in
67*86d7f5d3SJohn Marino.Fa *vpp .
68*86d7f5d3SJohn Marino.Sh SEE ALSO
69*86d7f5d3SJohn Marino.Xr VFS 9 ,
70*86d7f5d3SJohn Marino.Xr VFS_CHECKEXP 9 ,
71*86d7f5d3SJohn Marino.Xr VFS_VPTOFH 9 ,
72*86d7f5d3SJohn Marino.Xr vnode 9
73*86d7f5d3SJohn Marino.Sh AUTHORS
74*86d7f5d3SJohn MarinoThis man page was written by
75*86d7f5d3SJohn Marino.An Doug Rabson .
76