xref: /freebsd/share/man/man9/VFS_VGET.9 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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.\" $Id: VFS_VGET.9,v 1.1 1997/03/03 17:59:58 dfr Exp $
30.\"
31.Dd July 24, 1996
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.Fd #include <sys/mount.h>
39.Fd #include <sys/vnode.h>
40.Ft int
41.Fn VFS_VGET "struct mount *mp" "ino_t ino" "struct vnode **vpp"
42.Sh DESCRIPTION
43This converts an inode number into a locked vnode.
44.Pp
45Its arguments are:
46.Bl -tag -width ino
47.It Ar mp
48The filesystem.
49.It Ar ino
50The inode representing the file.
51.It Ar vpp
52Return parameter for the vnode.
53.El
54.Pp
55This is an optional filesystem entrypoint for filesystems which have a
56unique id number for every file in the filesystem.  It is used
57internally by the UFS filesystem and also by the NFSv3 server to
58implement the
59.Dv READDIRPLUS
60nfs call.
61.Pp
62If the filesystem does not support this call, then it should return
63.Dv EOPNOTSUPP .
64.Sh SEE ALSO
65.Xr VFS 9 ,
66.Xr vnode 9
67.Sh AUTHORS
68This man page was written by Doug Rabson.
69
70