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$
  30 .\"
  31 .Dd January 7, 2005
  32 .Dt VFS_VGET 9
  33 .Os
  34 .Sh NAME
  35 .Nm VFS_VGET
  36 .Nd convert an inode number to a vnode
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/mount.h
  40 .In sys/vnode.h
  41 .Ft int
  42 .Fn VFS_VGET "struct mount *mp" "ino_t ino" "int flags" "struct vnode **vpp"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn VFS_VGET
  46 looks up or creates a vnode from a (mount, inode#) tuple.
  47 .Pp
  48 Its arguments are:
  49 .Bl -tag -width ".Fa flags"
  50 .It Fa mp
  51 The mount point.
  52 .It Fa ino
  53 The inode representing the file.
  54 This is a unique number assigned by the file system when vnodes are first
  55 created.
  56 .It Fa flags
  57 Additional locking flags to pass through to
  58 .Xr vget 9 .
  59 .It Fa vpp
  60 Return parameter for the vnode.
  61 .El
  62 .Pp
  63 This is an optional file system entry-point for file systems mainly
  64 intended for NFS server use, but many file systems
  65 use it internally in
  66 .Xr VOP_LOOKUP 9
  67 and similar.
  68 .Pp
  69 If the file system does not support this call, then it should return
  70 .Er EOPNOTSUPP .
  71 .Pp
  72 Please see
  73 .Fn ffs_vget
  74 in
  75 .Pa sys/ufs/ffs/ffs_vfsops.c
  76 for the canonical example.
  77 .Sh SEE ALSO
  78 .Xr VFS 9 ,
  79 .Xr vget 9 ,
  80 .Xr vnode 9
  81 .Sh AUTHORS
  82 This manual page was written by
  83 .An Doug Rabson .