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.Dd May 19, 2019 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" "int flags" "struct vnode **vpp" 41.Sh DESCRIPTION 42The 43.Fn VFS_FHTOVP 44macro is used by the NFS server to turn an NFS filehandle into a vnode. 45.Pp 46The arguments it expects are: 47.Bl -tag -width flags 48.It Fa mp 49The file system. 50.It Fa fhp 51The filehandle to convert. 52.It Fa flags 53Additional locking flags to pass through to 54.Xr vget 9 . 55File systems are allowed to ignore 56.Ar flags 57and use 58.Dv LK_EXCLUSIVE 59instead. 60.It Fa vpp 61Return parameter for the new locked vnode. 62.El 63.Pp 64The contents of the filehandle are defined by the file system and are 65not examined by any other part of the system. 66It should contain 67enough information to uniquely identify a file within the file system 68as well as noticing when a file has been removed and the file system 69resources have been reused for a new file. 70For instance, UFS 71file system stores the inode number and inode generation counter in its 72filehandle. 73.Pp 74A call to 75.Fn VFS_FHTOVP 76should generally be preceded by a call to 77.Xr VFS_CHECKEXP 9 78to check if the file is accessible to the client. 79.Sh RETURN VALUES 80The locked vnode for the file will be returned in 81.Fa *vpp . 82.Sh SEE ALSO 83.Xr VFS 9 , 84.Xr VFS_CHECKEXP 9 , 85.Xr vnode 9 , 86.Xr VOP_VPTOFH 9 87.Sh AUTHORS 88This manual page was written by 89.An Doug Rabson . 90