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