share/man/man9/VFS_VGET.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_VGET.9,v 1.5.2.2 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/VFS_VGET.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  31 .\"
  32 .Dd July 24, 1996
  33 .Os
  34 .Dt VFS_VGET 9
  35 .Sh NAME
  36 .Nm VFS_VGET
  37 .Nd convert an inode number to 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_VGET "struct mount *mp" "ino_t ino" "struct vnode **vpp"
  44 .Sh DESCRIPTION
  45 This converts an inode number into a locked vnode.
  46 .Pp
  47 Its arguments are:
  48 .Bl -tag -width ino
  49 .It Ar mp
  50 The filesystem.
  51 .It Ar ino
  52 The inode representing the file.
  53 .It Ar vpp
  54 Return parameter for the vnode.
  55 .El
  56 .Pp
  57 This is an optional filesystem entrypoint for filesystems which have a
  58 unique id number for every file in the filesystem.  It is used
  59 internally by the UFS filesystem and also by the NFSv3 server to
  60 implement the
  61 .Dv READDIRPLUS
  62 nfs call.
  63 .Pp
  64 If the filesystem does not support this call, then it should return
  65 .Er EOPNOTSUPP .
  66 .Sh SEE ALSO
  67 .Xr VFS 9 ,
  68 .Xr vnode 9
  69 .Sh AUTHORS
  70 This man page was written by
  71 .An Doug Rabson .