xref: /dflybsd-src/share/man/man9/VFS_VGET.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
286d7f5d3SJohn Marino.\"
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" This program is free software.
686d7f5d3SJohn Marino.\"
786d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
886d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
986d7f5d3SJohn Marino.\" are met:
1086d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1286d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1386d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1486d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
1786d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1886d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1986d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
2086d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2186d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2286d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2386d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2486d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2586d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2686d7f5d3SJohn Marino.\"
2786d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VFS_VGET.9,v 1.5.2.2 2001/12/17 11:30:18 ru Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd July 24, 1996
3086d7f5d3SJohn Marino.Dt VFS_VGET 9
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm VFS_VGET
3486d7f5d3SJohn Marino.Nd convert an inode number to a vnode
3586d7f5d3SJohn Marino.Sh SYNOPSIS
3686d7f5d3SJohn Marino.In sys/param.h
3786d7f5d3SJohn Marino.In sys/mount.h
3886d7f5d3SJohn Marino.In sys/vnode.h
3986d7f5d3SJohn Marino.Ft int
4086d7f5d3SJohn Marino.Fn VFS_VGET "struct mount *mp" "ino_t ino" "struct vnode **vpp"
4186d7f5d3SJohn Marino.Sh DESCRIPTION
4286d7f5d3SJohn MarinoThis converts an inode number into a locked vnode.
4386d7f5d3SJohn Marino.Pp
4486d7f5d3SJohn MarinoIts arguments are:
4586d7f5d3SJohn Marino.Bl -tag -width ino
4686d7f5d3SJohn Marino.It Ar mp
4786d7f5d3SJohn MarinoThe filesystem.
4886d7f5d3SJohn Marino.It Ar ino
4986d7f5d3SJohn MarinoThe inode representing the file.
5086d7f5d3SJohn Marino.It Ar vpp
5186d7f5d3SJohn MarinoReturn parameter for the vnode.
5286d7f5d3SJohn Marino.El
5386d7f5d3SJohn Marino.Pp
5486d7f5d3SJohn MarinoThis is an optional filesystem entrypoint for filesystems which have a
5586d7f5d3SJohn Marinounique id number for every file in the filesystem.  It is used
5686d7f5d3SJohn Marinointernally by the UFS filesystem and also by the NFSv3 server to
5786d7f5d3SJohn Marinoimplement the
5886d7f5d3SJohn Marino.Dv READDIRPLUS
5986d7f5d3SJohn Marinonfs call.
6086d7f5d3SJohn Marino.Pp
6186d7f5d3SJohn MarinoIf the filesystem does not support this call, then it should return
6286d7f5d3SJohn Marino.Er EOPNOTSUPP .
6386d7f5d3SJohn Marino.Sh SEE ALSO
6486d7f5d3SJohn Marino.Xr VFS 9 ,
6586d7f5d3SJohn Marino.Xr vnode 9
6686d7f5d3SJohn Marino.Sh AUTHORS
6786d7f5d3SJohn MarinoThis man page was written by
6886d7f5d3SJohn Marino.An Doug Rabson .
69