Name

NFSPROC3_FSSTAT - Get Dynamic File System Information

Call Arguments

 

struct FSSTAT3args {
    nfs_fh3 fsroot;
};

Return Arguments

 

struct FSSTAT3resok {
    post_op_attr obj_attributes;
    size3 tbytes;
    size3 fbytes;
    size3 abytes;
    size3 tfiles;
    size3 ffiles;
    size3 afiles;
    uint32 invarsec;
};

struct FSSTAT3resfail {
    post_op_attr obj_attributes;
};

union FSSTAT3res switch (nfsstat3 status) {
    case NFS3_OK:
        FSSTAT3resok resok;
    default:
        FSSTAT3resfail resfail;
};

RPC Procedure Description

 

FSSTAT3res
NFSPROC3_FSSTAT(FSSTAT3args) = 18;

Description

Procedure FSSTAT retrieves volatile file system state information.

On entry, the arguments in FSSTAT3args are:

fsroot

A file handle identifying a object in the file system. This is normally a file handle for a mount point for a file system, as originally obtained from the MOUNT service on the server.

Upon successful return, FSSTAT3res.status is NFS3_OK and FSSTAT3res.resok contains:

obj_attributes

The attributes of the file system object specified in fsroot.

tbytes

The total size, in bytes, of the file system.

fbytes

The amount of free space, in bytes, in the file system.

abytes

The amount of free space, in bytes, available to the user identified by the authentication information in the RPC. (This reflects space that is reserved by the file system; it does not reflect any quota system implemented by the server.)

tfiles

The total number of file slots in the file system. (On a UNIX server, this often corresponds to the number of i-nodes configured.)

ffiles

The number of free file slots in the file system.

afiles

The number of free file slots that are available to the user corresponding to the authentication information in the RPC. (This reflects slots that are reserved by the file system; it does not reflect any quota system implemented by the server.)

invarsec

A measure of file system volatility[??]the number of seconds for which the file system is not expected to change. For a volatile, frequently updated file system, this will be zero. For an immutable file system, such as a CD-ROM, this would be the largest unsigned integer. For file systems that are infrequently modified (for example, one containing local executable programs and on-line documentation), a value corresponding to a few hours or days might be used. The client may use this as a hint in tuning its cache management. Note, however, that this measure is assumed to be dynamic and may change at any time.

Otherwise, FSSTAT3res.status contains the error on failure and FSSTAT3res.resfail contains the following:

obj_attributes

The attributes of the file system object specified in fsroot.

Implementation Guidance

Not all implementations can support the entire list of attributes. It is expected that servers will make a best effort at supporting all the attributes.

Return Codes

NFS3ERR_IO

I/O error. Some sort of hard error occurred when the operation was in progress. This could be a disk error, for example.

NFS3ERR_STALE

Invalid file handle. The file handle given in the arguments was invalid. The file referred to by that file handle no longer exists or access to it has been revoked.

NFS3ERR_BADHANDLE

Invalid NFS file handle. The file handle failed internal consistency checks.

NFS3ERR_SERVERFAULT

An error occurred on the server, which does not map to any of the valid NFS Version 3 protocol error values. The client should translate this into an appropriate error. Clients based on an XPG system may choose to translate this to EIO.

[??] Some characters or strings that appear in the printed document are not easily representable using HTML.