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