share/man/man9/VFS_FHTOVP.9

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