share/man/man9/vfs_mountedon.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 November 21, 2001
  30 .Dt VFS_MOUNTEDON 9
  31 .Os
  32 .Sh NAME
  33 .Nm vfs_mountedon
  34 .Nd "check if the vnode belongs to a mounted file system"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/mount.h
  38 .Ft int
  39 .Fn vfs_mountedon "struct vnode *vp"
  40 .Sh DESCRIPTION
  41 .Fn vfs_mountedon
  42 inspects the
  43 .Vt mount
  44 structure in
  45 .Fa vp
  46 to determine if it points to a valid mount point.
  47 If the mount is valid, the vnode is considered to be busy.
  48 .Pp
  49 A common use of
  50 .Fn vfs_mountedon
  51 is to call it on device vnodes to determine if they are already associated with
  52 a file system.
  53 This is done to prevent multiple mounts on the same device.
  54 .Sh RETURN VALUES
  55 .Er EBUSY
  56 is returned if the vnode has a valid mount point; otherwise, 0 is returned.
  57 .Sh PSEUDOCODE
  58 .Bd -literal
  59 int
  60 ffs_mountfs(devvp, mp, td, malloctype)
  61         register struct vnode *devvp;
  62         struct mount *mp;
  63         struct thread *td;
  64         struct malloc_type *malloctype;
  65 {
  66         ...
  67
  68         error = vfs_mountedon(devvp);
  69         if (error)
  70                 return (error);
  71
  72         ...
  73 }
  74 .Ed
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Chad David Aq davidc@acns.ab.ca .