xref: /freebsd/share/man/man9/insmntque.9 (revision 531c890b8aecbf157fe3491503b5ca62c0b01093)
1.\" Copyright (C) 2008 Chad David <davidc@acns.ab.ca>.
2.\" 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.\" $FreeBSD$
28.\"
29.Dd February 25, 2008
30.Dt insmntque 9
31.Os
32.Sh NAME
33.Nm insmntque
34.Nd "associate a vnode with a mount"
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft int
39.Fn insmntque "struct vnode *vp" "struct mount *mp"
40.Sh DESCRIPTION
41The
42.Fn insmntque
43function associates a vnode with a mount.
44This includes updating
45.Va v_mount
46for the vnode, and inserting the vnode into the mounts vnode list.
47.Pp
48The mount reference count is incremented for each vnode added to the
49mount, and that reference is decremented by
50.Fn vgone 9 .
51.Pp
52The mount's interlock is held while the vnode is inserted.
53.Sh RETURN VALUES
54.Fn insmntque
55will always return 0, unless the file system is currently being unmounted
56in which case it will return
57.Dv EBUSY .
58.Sh SEE ALSO
59.Xr vgone 9
60.Sh AUTHORS
61This manual page was written by
62.An Chad David Aq davidc@acns.ab.ca .
63