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.Fd #include <sys/param.h> 39.Fd #include <sys/mount.h> 40.Fd #include <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 Ar mp 49The filesystem. 50.It Ar fhp 51The filehandle to convert. 52.It Ar vpp 53Return parameter for the new locked vnode. 54.El 55.Pp 56The contents of the filehandle are defined by the filesystem and are 57not examined by any other part of the system. It should contain 58enough information to uniquely identify a file within the filesystem 59as well as noticing when a file has been removed and the filesystem 60resources have been reused for a new file. For instance, UFS 61filesystem stores the inode number and inode generation counter in its 62filehandle. 63.Pp 64A call to this function should generally be preceded by a call to 65.Xr VFS_CHECKEXP 9 66to check if the file is accessible to the client. 67.Sh RETURN VALUES 68The locked vnode for the file will be returned in 69.Fa *vpp . 70.Sh SEE ALSO 71.Xr VFS 9 , 72.Xr VFS_CHECKEXP 9 , 73.Xr VFS_VPTOFH 9 , 74.Xr vnode 9 75.Sh AUTHORS 76This man page was written by 77.An Doug Rabson . 78