xref: /original-bsd/lib/libc/sys/getfsstat.2 (revision 2bd07fe6)
Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)getfsstat.2 6.3 (Berkeley) 03/06/90

GETFSSTAT 2 ""
C 7
NAME
getfsstat - get list of all mounted filesystems
SYNOPSIS
#include <sys/types.h>
#include <sys/mount.h>

getfsstat(buf, bufsize, flags) struct statfs *buf[]; long bufsize; int flags;

DESCRIPTION
Getfsstat returns information about all mounted filesystems. Buf is a pointer to an array of statfs structures defined as follows:
typedef quad fsid_t;
#define MNAMELEN 32 /* length of buffer for returned name */
struct statfs {
 short f_type; /* type of filesystem (see below) */
 short f_flags; /* copy of mount flags */
 long f_fsize; /* fundamental filesystem block size */
 long f_bsize; /* optimal transfer block size */
 long f_blocks; /* total data blocks in filesystem */
 long f_bfree; /* free blocks in fs */
 long f_bavail; /* free blocks avail to non-superuser */
 long f_files; /* total file nodes in filesystem */
 long f_ffree; /* free file nodes in fs */
 fsid_t f_fsid; /* filesystem id */
 long f_spare[6]; /* spare for later */
 char f_mntonname[MNAMELEN]; /* directory on which mounted */
 char f_mntfromname[MNAMELEN]; /* mounted filesystem */
};
/*
 * File system types.
 */
#define MOUNT_UFS 1
#define MOUNT_NFS 2
#define MOUNT_PC 3

Fields that are undefined for a particular filesystem are set to -1. The buffer is filled with an array of fsstat structures, one for each mounted filesystem up to the size specified by bufsize .

If buf is given as zero, getfsstat returns just the number of mounted filesystems.

Normally flags should be specified as MNT_WAIT. If flags is set to MNT_NOWAIT, then getfsstat will return the information it has available without requesting an update from each filesystem. Thus, some of the information will be out of date, but getfsstat will not block waiting for information from a filesystem that is unable to respond.

RETURN VALUE
Upon successful completion, the number of fsstat structures is returned. Otherwise, -1 is returned and the global variable errno is set to indicate the error.
ERRORS
Getfsstat fails if one or more of the following are true:

15 EFAULT Buf points to an invalid address.

15 EIO An I/O error occurred while reading from or writing to the filesystem.

"SEE ALSO"
statfs(2), fstab(5), mount(8)