STATVFS(3) Library Functions Manual STATVFS(3)

fstatvfs statvfs — get file system information


#include <sys/statvfs.h>

int fstatvfs(int fildes, struct statvfs *buf);
int statvfs(const char *restrict path, struct statvfs *restrict buf);

The fstatvfs () function shall obtain information about the file system containing the file referenced by .

The statvfs () function shall obtain information about the file system containing the file named by .

For both functions, the argument is a pointer to a statvfs structure that shall be filled. Read, write, or execute permission of the named file is not required.

The following flags can be returned in the member:

Read-only file system.
Setuid/setgid bits ignored by exec(3) .

It is unspecified whether all members of the statvfs structure have meaningful values on all file systems.

Upon successful completion, statvfs () shall return 0. Otherwise, it shall return -1 and set to indicate the error.

The fstatvfs () and statvfs () functions shall fail if:

An I/O error occurred while reading the file system.
A signal was caught during execution of the function.
One of the values to be returned cannot be represented correctly in the structure pointed to by buf .

The fstatvfs () function shall fail if:

The fildes argument is not an open file descriptor.

The statvfs () function shall fail if:

Search permission is denied on a component of the path prefix.
A loop exists in symbolic links encountered during resolution of the path argument.
The length of a pathname exceeds {PATH_MAX} or a pathname component is longer than {NAME_MAX}.
A component of path does not name an existing file or path is an empty string.
A component of the path prefix of path is not a directory.

The statvfs () function may fail if:

More than {SYMLOOP_MAX} symbolic links were encountered during resolution of the path argument.
Pathname resolution of a symbolic link produced an intermediate result whose length exceeds {PATH_MAX}.

The following example shows how to obtain file system information for the file system upon which the file named /home/cnd/mod1 resides, using the fstatvfs () function. The /home/cnd/mod1 file is opened with read/write privileges and the open file descriptor is passed to the fstatvfs () function.

#include <statvfs.h>
#include <fcntl.h>


struct statvfs buffer;
int            status;
...
fildes = open("/home/cnd/mod1", O_RDWR);
status  = fstatvfs(fildes, &buffer);

The following example shows how to obtain file system information for the file system upon which the file named /home/cnd/mod1 resides, using the statvfs () function.

#include <statvfs.h>


struct statvfs buffer;
int            status;
...
status = statvfs("/home/cnd/mod1", &buffer);

None.

None.

None.

chmod(3), chown(3), creat(3), dup(3), exec(3), fcntl(3), link(3), mknod(3), open(3), pipe(3), read(3), time(3), unlink(3), utime(3), write(3), the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <sys/statvfs.h>

First released in Issue 4, Version 2.

Moved from X/OPEN UNIX extension to BASE.

Large File Summit extensions are added.

The DESCRIPTION is updated to avoid use of the term "must" for application requirements.

The keyword is added to the statvfs () prototype for alignment with the ISO/IEC 9899:1999 (“ISO C99”) standard.

The wording of the mandatory [ELOOP] error condition is updated, and a second optional [ELOOP] error condition is added.

footer end

December 6, 2001 posix.fail