vfs_statfs(9) [debian man page]

VFS_STATFS(9)						   BSD Kernel Developer's Manual					     VFS_STATFS(9)

NAME

     VFS_STATFS -- return file system status

SYNOPSIS

     #include <sys/param.h>
     #include <sys/mount.h>
     #include <sys/vnode.h>

     int
     VFS_STATFS(struct mount *mp, struct statfs *sbp);

DESCRIPTION

     The VFS_STATFS() macro returns various pieces of information about the file system, including recommended I/O sizes, free space, free inodes,
     etc.

     The arguments it expects are:

     mp   The file system.

     sbp  A statfs structure, as defined by <sys/mount.h>, into which information is placed about the file system.

     The fields of struct statfs related to the file system are as follows:

     f_type	    Type of file system.

     f_flags	    A copy of mount exported flags.

     f_bsize	    Fragment size.

     f_iosize	    Optimal transfer block size.

     f_blocks	    The total number of data blocks in the file system.

     f_bfree	    The number of free blocks in the file system.

     f_bavail	    The number of free blocks available to non-superuser processes.

     f_files	    The total number of file nodes in the file system.

     f_ffree	    The number of free nodes available to non-superuser processes.

     f_syncwrites   The number of synchronous writes since the file system was mounted.

     f_asyncwrites  The number of asynchronous writes since the file system was mounted.

     f_syncreads    The number of synchronous reads since the file system was mounted.

     f_asyncreads   The number of asynchronous reads since the file system was mounted.

     f_namemax	    The maximum file name length for this file system.

     f_owner	    The user ID of the user that mounted the file system.

     f_fsid	    Unique file system ID.

     f_fstypename   The file system type name; a string of at most MFSNAMELEN bytes.

     f_mntfromname  The device name the file system was mounted from; a string of at most MNAMELEN bytes.

     f_mntonname    The name of the directory on which the file system is mounted; a string of at most MNAMELEN bytes.

SEE ALSO

     VFS(9), vnode(9)

AUTHORS

     This manual page was written by Doug Rabson.

BSD
								   May 23, 2009 							       BSD

STATFS(2)						      BSD System Calls Manual							 STATFS(2)

NAME

     statfs -- get file system statistics

SYNOPSIS

     #include <sys/param.h>
     #include <sys/mount.h>

     int
     statfs(const char *path, struct statfs *buf);

     int
     fstatfs(int fd, struct statfs *buf);

DESCRIPTION

     Statfs() returns information about a mounted file system.	Path is the path name of any file within the mounted file system.  Buf is a
     pointer to a statfs structure defined as follows:

     typedef struct { int32_t val[2]; } fsid_t;

     #define MFSNAMELEN   15 /* length of fs type name, not inc. nul */
     #define MNAMELEN	  90 /* length of buffer for returned name */

     struct statfs {
	 short	 f_otype;    /* type of file system (reserved: zero) */
	 short	 f_oflags;   /* copy of mount flags (reserved: zero) */
	 long	 f_bsize;    /* fundamental file system block size */
	 long	 f_iosize;   /* optimal transfer block size */
	 long	 f_blocks;   /* total data blocks in file system */
	 long	 f_bfree;    /* free blocks in fs */
	 long	 f_bavail;   /* free blocks avail to non-superuser */
	 long	 f_files;    /* total file nodes in file system */
	 long	 f_ffree;    /* free file nodes in fs */
	 fsid_t  f_fsid;     /* file system id (super-user only) */
	 uid_t	 f_owner;    /* user that mounted the file system */
	 short	 f_reserved1;	     /* reserved for future use */
	 short	 f_type;     /* type of file system (reserved) */
	 long	 f_flags;    /* copy of mount flags (reserved) */
	 long	 f_reserved2[2];     /* reserved for future use */
	 char	 f_fstypename[MFSNAMELEN]; /* fs type name */
	 char	 f_mntonname[MNAMELEN];    /* directory on which mounted */
	 char	 f_mntfromname[MNAMELEN];  /* mounted file system */
	 char	 f_reserved3;	     /* reserved for future use */
	 long	 f_reserved4[4];     /* reserved for future use */
     };

     Fields that are undefined for a particular file system are set to -1.  Fstatfs() returns the same information about an open file referenced
     by descriptor fd.

RETURN VALUES

     Upon successful completion, a value of 0 is returned.  Otherwise, -1 is returned and the global variable errno is set to indicate the error.

ERRORS

     Statfs() fails if one or more of the following are true:

     [ENOTDIR]		A component of the path prefix of Path is not a directory.

     [ENAMETOOLONG]	The length of a component of path exceeds {NAME_MAX} characters, or the length of path exceeds {PATH_MAX} characters.

     [ENOENT]		The file referred to by path does not exist.

     [EACCES]		Search permission is denied for a component of the path prefix of path.

     [ELOOP]		Too many symbolic links were encountered in translating path.

     [EFAULT]		Buf or path points to an invalid address.

     [EIO]		An I/O error occurred while reading from or writing to the file system.

     Fstatfs() fails if one or more of the following are true:

     [EBADF]		fd is not a valid open file descriptor.

     [EFAULT]		Buf points to an invalid address.

     [EIO]		An I/O error occurred while reading from or writing to the file system.

HISTORY

     The statfs() function first appeared in 4.4BSD.

BSD
								 February 11, 1994							       BSD