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.\" $Id: VFS_FHTOVP.9,v 1.3 1998/03/12 07:31:04 charnier Exp $ 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 mbuf *nam" "struct vnode **vpp" "int *exflagsp" "struct ucred **credanonp" 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 credanonp 48.It Ar mp 49The filesystem. 50.It Ar fhp 51The filehandle to convert. 52.It Ar nam 53An mbuf containing the network address of the client. 54.It Ar vpp 55Return parameter for the new locked vnode. 56.It Ar exflagsp 57Return parameter for the export flags for this client. 58.It Ar credanonp 59Return parameter for the anonymous credentials for this client. 60.El 61.Pp 62The contents of the filehandle are defined by the filesystem and are 63not examined by any other part of the system. It should contain 64enough information to uniquely identify a file within the filesystem 65as well as noticing when a file has been removed and the filesystem 66resources have been reused for a new file. For instance, UFS 67filesystem stores the inode number and inode generation counter in its 68filehandle. 69.Pp 70The filesystem should call 71.Xr vfs_export_lookup 9 72with the address of an appropriate 73.Dv netexport 74structure and the address of the client, 75.Fa nam , 76to verify that the client can access this filesystem. 77.Sh RETURN VALUES 78The locked vnode for the file will be returned in 79.Fa *vpp . 80The export flags and anonymous credentials specific to the client 81(returned by 82.Xr vfs_export_lookup 9 ) 83will be returned in 84.Fa *exflagsp 85and 86.Fa *credanonp . 87.Sh SEE ALSO 88.Xr VFS 9 , 89.Xr VFS_VPTOFH 9 , 90.Xr vnode 9 91.Sh AUTHORS 92This man page was written by 93.An Doug Rabson . 94