share/man/man9/VFS_FHTOVP.9

   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 .\" $DragonFly: src/share/man/man9/VFS_FHTOVP.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd July 24, 1996
  31 .Os
  32 .Dt VFS_FHTOVP 9
  33 .Sh NAME
  34 .Nm VFS_FHTOVP
  35 .Nd turn an NFS filehandle into a vnode
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/mount.h
  39 .In sys/vnode.h
  40 .Ft int
  41 .Fn VFS_FHTOVP "struct mount *mp" "struct fid *fhp" "struct vnode **vpp"
  42 .Sh DESCRIPTION
  43 This is used by the NFS server to turn an NFS filehandle into a vnode.
  44 .Pp
  45 Its arguments are:
  46 .Bl -tag -width vpp
  47 .It Ar mp
  48 The filesystem.
  49 .It Ar fhp
  50 The filehandle to convert.
  51 .It Ar vpp
  52 Return parameter for the new locked vnode.
  53 .El
  54 .Pp
  55 The contents of the filehandle are defined by the filesystem and are
  56 not examined by any other part of the system.  It should contain
  57 enough information to uniquely identify a file within the filesystem
  58 as well as noticing when a file has been removed and the filesystem
  59 resources have been reused for a new file.  For instance, UFS
  60 filesystem stores the inode number and inode generation counter in its
  61 filehandle.
  62 .Pp
  63 A call to this function should generally be preceded by a call to
  64 .Xr VFS_CHECKEXP 9
  65 to check if the file is accessible to the client.
  66 .Sh RETURN VALUES
  67 The locked vnode for the file will be returned in
  68 .Fa *vpp .
  69 .Sh SEE ALSO
  70 .Xr VFS 9 ,
  71 .Xr VFS_CHECKEXP 9 ,
  72 .Xr VFS_VPTOFH 9 ,
  73 .Xr vnode 9
  74 .Sh AUTHORS
  75 This man page was written by
  76 .An Doug Rabson .