]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man9/VFS_VGET.9
The .Fn macro.
[FreeBSD/FreeBSD.git] / 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, 2004
32 .Os
33 .Dt VFS_VGET 9
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 macro converts an inode number into a locked vnode.
47 .Pp
48 Its arguments are:
49 .Bl -tag -width ".Fa flags"
50 .It Fa mp
51 The file system.
52 .It Fa ino
53 The inode representing the file.
54 .It Fa flags
55 Additional locking flags to pass through.
56 .It Fa vpp
57 Return parameter for the vnode.
58 .El
59 .Pp
60 This is an optional file system entry-point for file systems which have a
61 unique id number for every file in the file system.
62 It is used
63 internally by the UFS file system and also by the NFSv3 server to
64 implement the
65 .Dv READDIRPLUS
66 nfs call.
67 .Pp
68 If the file system does not support this call, then it should return
69 .Er EOPNOTSUPP .
70 .Sh SEE ALSO
71 .Xr VFS 9 ,
72 .Xr vget 9 ,
73 .Xr vnode 9
74 .Sh AUTHORS
75 This manual page was written by
76 .An Doug Rabson .