share/man/man9/vfs_busy.9

   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 .\" $FreeBSD$
  28 .\"
  29 .Dd February 11, 2013
  30 .Dt VFS_BUSY 9
  31 .Os
  32 .Sh NAME
  33 .Nm vfs_busy
  34 .Nd "marks a mount point as busy"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/mount.h
  38 .Ft int
  39 .Fn vfs_busy "struct mount *mp" "int flags"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vfs_busy
  43 function marks a mount point as busy by incrementing
  44 the reference count of a mount point.
  45 It also delays unmounting by sleeping on
  46 .Fa mp
  47 if the
  48 .Dv MNTK_UNMOUNT
  49 flag is set in
  50 .Fa mp->mnt_kern_flag
  51 and the
  52 .Dv MBF_NOWAIT
  53 flag is
  54 .Em not
  55 set.
  56 .Pp
  57 Its arguments are:
  58 .Bl -tag -width ".Fa flags"
  59 .It Fa mp
  60 The mount point to busy.
  61 .It Fa flags
  62 Flags controlling how
  63 .Fn vfs_busy
  64 should act.
  65 .Bl -tag -width ".Dv MBF_MNTLSTLOCK"
  66 .It Dv MBF_NOWAIT
  67 do not sleep if
  68 .Dv MNTK_UNMOUNT
  69 is set.
  70 .It Dv MBF_MNTLSTLOCK
  71 drop the mountlist_mtx in the critical path.
  72 .El
  73 .El
  74 .Sh RETURN VALUES
  75 A 0 value is returned on success.
  76 If the mount point is being
  77 unmounted and MBF_NOWAIT flag is specified
  78 .Er ENOENT
  79 will be returned.
  80 .Sh ERRORS
  81 .Bl -tag -width Er
  82 .It Bq Er ENOENT
  83 The mount point is being unmounted
  84 .Dv ( MNTK_UNMOUNT
  85 is set).
  86 .El
  87 .Sh SEE ALSO
  88 .Xr vfs_unbusy 9
  89 .Sh AUTHORS
  90 This manual page was written by
  91 .An Chad David Aq davidc@acns.ab.ca .