xref: /dflybsd-src/share/man/man9/VFS_FHTOVP.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
286d7f5d3SJohn Marino.\"
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" This program is free software.
686d7f5d3SJohn Marino.\"
786d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
886d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
986d7f5d3SJohn Marino.\" are met:
1086d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1286d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1386d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1486d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
1786d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1886d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1986d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
2086d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2186d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2286d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2386d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2486d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2586d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2686d7f5d3SJohn Marino.\"
2786d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VFS_FHTOVP.9,v 1.6.2.5 2001/12/17 11:30:18 ru Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd July 24, 1996
3086d7f5d3SJohn Marino.Dt VFS_FHTOVP 9
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm VFS_FHTOVP
3486d7f5d3SJohn Marino.Nd turn an NFS filehandle into a vnode
3586d7f5d3SJohn Marino.Sh SYNOPSIS
3686d7f5d3SJohn Marino.In sys/param.h
3786d7f5d3SJohn Marino.In sys/mount.h
3886d7f5d3SJohn Marino.In sys/vnode.h
3986d7f5d3SJohn Marino.Ft int
4086d7f5d3SJohn Marino.Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct vnode **vpp"
4186d7f5d3SJohn Marino.Sh DESCRIPTION
4286d7f5d3SJohn MarinoThis is used by the NFS server to turn an NFS filehandle into a vnode.
4386d7f5d3SJohn Marino.Pp
4486d7f5d3SJohn MarinoIts arguments are:
4586d7f5d3SJohn Marino.Bl -tag -width vpp
4686d7f5d3SJohn Marino.It Ar mp
4786d7f5d3SJohn MarinoThe filesystem.
4886d7f5d3SJohn Marino.It Ar fhp
4986d7f5d3SJohn MarinoThe filehandle to convert.
5086d7f5d3SJohn Marino.It Ar vpp
5186d7f5d3SJohn MarinoReturn parameter for the new locked vnode.
5286d7f5d3SJohn Marino.El
5386d7f5d3SJohn Marino.Pp
5486d7f5d3SJohn MarinoThe contents of the filehandle are defined by the filesystem and are
5586d7f5d3SJohn Marinonot examined by any other part of the system.  It should contain
5686d7f5d3SJohn Marinoenough information to uniquely identify a file within the filesystem
5786d7f5d3SJohn Marinoas well as noticing when a file has been removed and the filesystem
5886d7f5d3SJohn Marinoresources have been reused for a new file.  For instance, UFS
5986d7f5d3SJohn Marinofilesystem stores the inode number and inode generation counter in its
6086d7f5d3SJohn Marinofilehandle.
6186d7f5d3SJohn Marino.Pp
6286d7f5d3SJohn MarinoA call to this function should generally be preceded by a call to
6386d7f5d3SJohn Marino.Xr VFS_CHECKEXP 9
6486d7f5d3SJohn Marinoto check if the file is accessible to the client.
6586d7f5d3SJohn Marino.Sh RETURN VALUES
6686d7f5d3SJohn MarinoThe locked vnode for the file will be returned in
6786d7f5d3SJohn Marino.Fa *vpp .
6886d7f5d3SJohn Marino.Sh SEE ALSO
6986d7f5d3SJohn Marino.Xr VFS 9 ,
7086d7f5d3SJohn Marino.Xr VFS_CHECKEXP 9 ,
7186d7f5d3SJohn Marino.Xr VFS_VPTOFH 9 ,
7286d7f5d3SJohn Marino.Xr vnode 9
7386d7f5d3SJohn Marino.Sh AUTHORS
7486d7f5d3SJohn MarinoThis man page was written by
7586d7f5d3SJohn Marino.An Doug Rabson .
76