xref: /freebsd/share/man/man9/getnewvnode.9 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.Dd November 1, 2023
28.Dt GETNEWVNODE 9
29.Os
30.Sh NAME
31.Nm getnewvnode
32.Nd "get a new vnode"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/vnode.h
36.In sys/mount.h
37.Ft int
38.Fn getnewvnode "const char *tag" "struct mount *mp" "struct vop_vector *vops" "struct vnode **vpp"
39.Sh DESCRIPTION
40The
41.Fn getnewvnode
42function initializes a new vnode, assigning it the vnode operations passed in
43.Fa vops .
44.Pp
45The arguments to
46.Fn getnewvnode
47are:
48.Bl -tag -width ".Fa vops"
49.It Fa tag
50The file system type string.
51This field should only be referenced for debugging or for userland utilities.
52.It Fa mp
53The mount point to add the new vnode to.
54.It Fa vops
55The vnode operations to assign to the new vnode.
56.It Fa vpp
57Points to the new vnode upon successful completion.
58.El
59.Sh RETURN VALUES
60.Fn getnewvnode
61returns 0 on success.
62.Sh BUGS
63It never returns an error, instead either succeeds or blocks indefinitely.
64.Sh AUTHORS
65This manual page was written by
66.An Chad David Aq Mt davidc@acns.ab.ca .
67