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