xref: /openbsd/share/man/man9/getnewvnode.9 (revision 905646f0)
1.\"     $OpenBSD: getnewvnode.9,v 1.10 2020/01/20 23:23:04 claudio Exp $
2.\"
3.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice(s), this list of conditions and the following disclaimer as
10.\"    the first lines of this file unmodified other than the possible
11.\"    addition of one or more copyright notices.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice(s), 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 COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
20.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
26.\" DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man9/getnewvnode.9,v 1.1 2001/12/02 02:13:35 alfred Exp $
29.\"
30.Dd $Mdocdate: January 20 2020 $
31.Dt GETNEWVNODE 9
32.Os
33.Sh NAME
34.Nm getnewvnode
35.Nd get a new vnode
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/vnode.h
39.In sys/mount.h
40.Ft int
41.Fo getnewvnode
42.Fa "enum vtagtype tag"
43.Fa "struct mount *mp"
44.Fa "const struct vops *vops"
45.Fa "struct vnode **vpp"
46.Fc
47.Sh DESCRIPTION
48The
49.Fn getnewvnode
50function initializes a new vnode, assigning it the vnode operations passed in
51.Fa vops .
52It will have its v_tag field set to
53.Fa tag
54and be placed in the mount queue for the mount point represented by
55.Fa mp .
56.Pp
57The vnode is either freshly allocated, taken from the free list or taken from
58the hold list.
59If there are no vnodes on the free list, half the time a vnode
60referencing buffers will be taken from the hold list, otherwise it will be
61freshly allocated.
62.Pp
63The arguments to
64.Fn getnewvnode
65are:
66.Bl -tag -width ".Fa vops"
67.It Fa tag
68The file system type.
69.It Fa mp
70The mount point to add the new vnode to.
71.It Fa vops
72The vnode operations to assign to the new vnode.
73.It Fa vpp
74Points to the new vnode upon successful completion.
75.El
76.Sh RETURN VALUES
77.Fn getnewvnode
78returns 0 on success, or ENFILE if the vnode table is full.
79.Sh AUTHORS
80This man page was originally written by
81.An Chad David Aq Mt davidc@acns.ab.ca
82for
83.Fx .
84