share/man/man2/ustat.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH USTAT 2 "Jul 23, 2001"
   7 .SH NAME
   8 ustat \- get file system statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <ustat.h>
  14
  15 \fBint\fR \fBustat\fR(\fBdev_t\fR \fIdev\fR, \fBstruct ustat *\fR\fIbuf\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBustat()\fR function returns information about a mounted file system.
  22 The \fIdev\fR argument is a device number identifying a device containing a
  23 mounted file system (see \fBmakedev\fR(3C)). The \fIbuf\fR argument is a
  24 pointer to a \fBustat\fR structure that includes the following members:
  25 .sp
  26 .in +2
  27 .nf
  28 daddr_t  f_tfree;      /* Total free blocks */
  29 ino_t    f_tinode;     /* Number of free inodes */
  30 char     f_fname[6];   /* Filsys name */
  31 char     f_fpack[6];   /* Filsys pack name */
  32 .fi
  33 .in -2
  34
  35 .sp
  36 .LP
  37 The \fBf_fname\fR and \fBf_fpack\fR members may not contain significant
  38 information on all systems; in this case, these members will contain the null
  39 character as the first character.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon successful completion, \fB0\fR is returned. Otherwise,  \fB\(mi1\fR is
  44 returned and \fBerrno\fR is set to indicate the error.
  45 .SH ERRORS
  46 .sp
  47 .LP
  48 The \fBustat()\fR function will fail if:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBECOMM\fR\fR
  53 .ad
  54 .RS 13n
  55 The \fIdev\fR argument is on a remote machine and the link to that machine is
  56 no longer active.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEFAULT\fR\fR
  63 .ad
  64 .RS 13n
  65 The \fIbuf\fR argument points to an illegal address.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBEINTR\fR\fR
  72 .ad
  73 .RS 13n
  74 A signal was caught during the execution of the \fBustat()\fR function.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBEINVAL\fR\fR
  81 .ad
  82 .RS 13n
  83 The \fIdev\fR argument is not the device number of a device containing a
  84 mounted file system.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBENOLINK\fR\fR
  91 .ad
  92 .RS 13n
  93 The \fIdev\fR argument refers to a device on a remote machine and the link  to
  94 that machine is no longer active.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBEOVERFLOW\fR\fR
 101 .ad
 102 .RS 13n
 103 One of the values returned cannot be represented in the structure pointed to by
 104 \fIbuf\fR.
 105 .RE
 106
 107 .SH USAGE
 108 .sp
 109 .LP
 110 The \fBstatvfs\fR(2) function should be used in favor of \fBustat()\fR.
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBstat\fR(2), \fBstatvfs\fR(2), \fBmakedev\fR(3C), \fBlfcompile\fR(5)
 115 .SH BUGS
 116 .sp
 117 .LP
 118 The \fBNFS\fR revision 2 protocol does not permit the number of free files to
 119 be provided to the client; therefore, when \fBustat()\fR has completed on an
 120 \fBNFS\fR file system, \fBf_tinode\fR is always \fB\(mi1\fR\&.