summaryrefslogtreecommitdiff
path: root/static/freebsd/man9/insmntque.9
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man9/insmntque.9')
-rw-r--r--static/freebsd/man9/insmntque.997
1 files changed, 97 insertions, 0 deletions
diff --git a/static/freebsd/man9/insmntque.9 b/static/freebsd/man9/insmntque.9
new file mode 100644
index 00000000..33ba697b
--- /dev/null
+++ b/static/freebsd/man9/insmntque.9
@@ -0,0 +1,97 @@
+.\" Copyright (C) 2008 Chad David <davidc@acns.ab.ca>.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice(s), this list of conditions and the following disclaimer as
+.\" the first lines of this file unmodified other than the possible
+.\" addition of one or more copyright notices.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice(s), this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
+.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
+.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+.\" DAMAGE.
+.\"
+.Dd October 24, 2025
+.Dt INSMNTQUE 9
+.Os
+.Sh NAME
+.Nm insmntque ,
+.Nm insmntque1
+.Nd "associate a vnode with a mount"
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/vnode.h
+.Ft int
+.Fn insmntque "struct vnode *vp" "struct mount *mp"
+.Ft int
+.Fn insmntque1 "struct vnode *vp" "struct mount *mp"
+.Sh DESCRIPTION
+The
+.Fn insmntque
+function associates a vnode with a mount.
+This includes updating
+.Va v_mount
+for the vnode, and inserting the vnode into the mount's vnode list.
+.Pp
+The indirect mount reference count, maintained as the count of the
+vnodes owned by it, is incremented for each vnode added to the
+mount, and that reference is decremented by
+.Xr vgone 9 .
+.Pp
+The mount's interlock is held while the vnode is inserted.
+The vnode must be exclusively locked.
+.Pp
+On failure,
+.Fn insmntque
+resets vnode's operations vector to the vector of
+.Xr deadfs 9 ,
+clears
+.Va v_data ,
+and then calls
+.Xr vgone 9
+and
+.Xr vput 9 .
+If more elaborated cleanup after
+.Fn insmntque
+failure is needed, the
+.Fn insmntque1
+function may be used instead.
+It does not do any cleanup following a failure, leaving all
+the work to the caller.
+In particular, the operations vector
+.Va v_op
+and
+.Va v_data
+fields of the vnode are kept intact.
+.Sh RETURN VALUES
+The
+.Fn insmntque
+function will always return 0, unless the file system is currently being unmounted
+in which case it may return
+.Dv EBUSY .
+Also,
+.Fn insmntque
+may be forced to insert the vnode into the mount's vnode list
+by setting the
+.Va VV_FORCEINSMQ
+flag in the vnode
+.Va v_flag ,
+even if the file system is being unmounted.
+.Sh SEE ALSO
+.Xr vgone 9
+.Sh AUTHORS
+This manual page was written by
+.An Chad David Aq Mt davidc@acns.ab.ca .