lib/libc/gen/getmntinfo.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  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, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getmntinfo.3        8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/gen/getmntinfo.3,v 1.8.2.4 2003/03/13 18:05:37 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/getmntinfo.3,v 1.5 2008/06/03 12:40:09 swildner Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt GETMNTINFO 3
  38 .Os
  39 .Sh NAME
  40 .Nm getmntinfo ,
  41 .Nm getmntvinfo
  42 .Nd get information about mounted file systems
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/param.h
  47 .In sys/ucred.h
  48 .In sys/mount.h
  49 .Ft int
  50 .Fn getmntinfo "struct statfs **mntbufp" "int flags"
  51 .Ft int
  52 .Fn getmntvinfo "struct statfs **mntbufp" "struct statvfs **mntvbufp" "int flags"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn getmntinfo
  56 function
  57 returns an array of
  58 .Fn statfs
  59 structures describing each currently mounted file system (see
  60 .Xr statfs 2 ) .
  61 .Pp
  62 The
  63 .Fn getmntinfo
  64 function
  65 passes its
  66 .Fa flags
  67 argument transparently to
  68 .Xr getfsstat 2 .
  69 .Sh RETURN VALUES
  70 On successful completion,
  71 .Fn getmntinfo
  72 returns a count of the number of elements in the array.
  73 The pointer to the array is stored into
  74 .Fa mntbufp .
  75 .Pp
  76 If an error occurs, zero is returned and the external variable
  77 .Va errno
  78 is set to indicate the error.
  79 Although the pointer
  80 .Fa mntbufp
  81 will be unmodified, any information previously returned by
  82 .Fn getmntinfo
  83 will be lost.
  84 .Pp
  85 The
  86 .Fn getmntvinfo
  87 function
  88 returns an array of
  89 .Fn statfs
  90 and
  91 .Fn statvfs
  92 structures describing each currently mounted file system (see
  93 .Xr statfs 2 ) ,
  94 and otherwise works like
  95 .Fn getmntinfo .
  96 .Sh ERRORS
  97 The
  98 .Fn getmntinfo
  99 function may fail and set
 100 .Va errno
 101 for any of the errors specified for the library routines
 102 .Xr getfsstat 2
 103 .Xr getvfsstat 2
 104 or
 105 .Xr malloc 3 .
 106 .Sh SEE ALSO
 107 .Xr getfsstat 2 ,
 108 .Xr mount 2 ,
 109 .Xr statfs 2 ,
 110 .Xr mount 8
 111 .Sh HISTORY
 112 The
 113 .Fn getmntinfo
 114 function first appeared in
 115 .Bx 4.4 .
 116 .Sh BUGS
 117 The
 118 .Fn getmntinfo
 119 function writes the array of structures to an internal static object
 120 and returns
 121 a pointer to that object.
 122 Subsequent calls to
 123 .Fn getmntinfo
 124 will modify the same object.
 125 .Pp
 126 The memory allocated by
 127 .Fn getmntinfo
 128 cannot be
 129 .Xr free 3 Ns 'd
 130 by the application.