Name

NFSPROC3_PATHCONF - Retrieve XPG4 Information

Call Arguments

 

struct PATHCONF3args {
    nfs_fh3 object;
};

Return Arguments

 

struct PATHCONF3resok {
    post_op_attr obj_attributes;
    uint32 linkmax;
    uint32 name_max;
    bool no_trunc;
    bool chown_restricted;
    bool case_insensitive;
    bool case_preserving;
};

struct PATHCONF3resfail {
    post_op_attr obj_attributes;
};

union PATHCONF3res switch (nfsstat3 status) {
    case NFS3_OK:
        PATHCONF3resok resok;
    default:
        PATHCONF3resfail resfail;
};

RPC Procedure Description

 

PATHCONF3res
NFSPROC3_PATHCONF(PATHCONF3args) = 20;

Description

Procedure PATHCONF retrieves the XPG4 pathconf() information for a file or directory. If the FSF_HOMOGENEOUS bit is set in FSFINFO3resok.properties, the pathconf() information will be the same for all files and directories in the exported file system in which this file or directory resides.

On entry, the arguments in PATHCONF3args are:

object

The file handle for the file system object.

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

obj_attributes

The attributes of the object specified by object.

linkmax

The maximum number of hard links to an object.

name_max

The maximum length in bytes of a filename (pathname component).

no_trunc

If TRUE, the server will reject any request that includes a name longer than name_max with the NFS3ERR_NAMETOOLONG error. If FALSE, any name over name_max bytes will be silently truncated to name_max bytes.

chown_restricted

If TRUE, the server will reject any request to change either the owner or the group associated with a file if the caller does not have the appropriate privileges.

case_insensitive

If TRUE, the server file system does not distinguish case when interpreting filenames.

case_preserving

If TRUE, the server file system will preserve the case of a name during a CREATE, MKDIR, MKNOD, SYMLINK, RENAME or LINK operation.

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

obj_attributes

The attributes of the object specified by object.

Implementation Guidance

In some implementations of the NFS Version 2 protocol, pathconf() information was obtained at mount time through the MOUNT protocol. The proper place to obtain it is as here, in the NFS Version 3 protocol itself.

Return Codes

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.