share/man/man9/vcount.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2000 Andrew Stevenson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" If this manual page travels to places exotic (like projects other than
  30 .\" FreeBSD) I would love to hear about it.
  31 .\"     Andrew <andrew@ugh.net.au>
  32 .\"
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd January 19, 2012
  36 .Dt VCOUNT 9
  37 .Os
  38 .Sh NAME
  39 .Nm vcount ,
  40 .Nm count_dev
  41 .Nd "get total number of references to a device"
  42 .Sh SYNOPSIS
  43 .In sys/param.h
  44 .In sys/time.h
  45 .In sys/conf.h
  46 .In sys/vnode.h
  47 .Ft int
  48 .Fn vcount "struct vnode *vp"
  49 .Ft int
  50 .Fn count_dev "struct cdev *dev"
  51 .Sh DESCRIPTION
  52 .Fn vcount
  53 is used to get the number of references to a particular device.
  54 It allows for the fact that multiple vnodes may reference the same device.
  55 .Fn count_dev
  56 does the same thing as
  57 .Fn vcount ,
  58 but takes a
  59 .Vt "struct cdev"
  60 rather than a
  61 .Vt "struct vnode"
  62 pointer as an argument.
  63 .Sh RETURN VALUES
  64 .Fn vcount
  65 and
  66 .Fn count_dev
  67 both return the number of references to the device.
  68 .Sh SEE ALSO
  69 .Xr VFS 9 ,
  70 .Xr vnode 9
  71 .Sh AUTHORS
  72 This manual page was written by
  73 .An Andrew Stevenson .