v_fstatfs (BPX1VSF, BPX4VSF) — Return file system status

Function

The v_fstatfs service returns file system status for the file system that contains the file or directory that is represented by the supplied Vnode_token parameter.

Requirements

Operation	Environment
Authorization:	Supervisor state or problem state, any PSW key
Dispatchable unit mode:	Task
Cross memory mode:	PASN = HASN
AMODE (BPX1VSF):	31-bit
AMODE (BPX4VSF):	64-bit
ASC mode:	Primary mode
Interrupt status:	Enabled for interrupts
Locks:	Unlocked
Control parameters:	All parameters must be addressable by the caller and in the primary address space.

Format

CALL BPX1VSF,(Vnode_token,
              OSS,
              FsAttr_length,
              FsAttr,
              Return_value,
              Return_code,
              Reason_code)

AMODE 64 callers use BPX4VSF with the same parameters.

Parameters

Vnode_token

Supplied parameter

Type:: Token
Length:: 8 bytes

The name of an 8-byte area that contains a vnode token that represents a file or directory that is contained in the file system for which status is being requested.

OSS

Supplied and returned parameter

Type:: Structure
Length:: OSS#LENGTH (from the BPXYOSS macro)

The name of an area that contains operating-system-specific parameters. This area is mapped by the BPXYOSS macro (see BPXYOSS — Map operating system specific information).

FsAttr_length

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains the length of the area that is passed in the FsAttr parameter. To determine the value of FsAttr_length, use the BPXYSSTF macro (see Mapping macros in z/OS UNIX System Services Programming: Assembler Callable Services Reference).

FsAttr

Returned parameter

Type:: Structure
Length:: Specified by the FsAttr_length parameter

The name of an area, of length FsAttr_length, in which the v_fstatfs service returns file system status information. This area is mapped by the BPXYSSTF macro (see Mapping macros in z/OS UNIX System Services Programming: Assembler Callable Services Reference).

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_fstatfs service returns 0 if the request is successful, or -1 if it is not successful.

Return_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_fstatfs service stores the return code. The v_fstatfs service returns Return_code only if Return_value is -1. See z/OS UNIX System Services Messages and Codes for a complete list of possible return code values. The v_fstatfs service can return one of the following values in the Return_code parameter:

Return_code	Explanation
EINVAL	Parameter error; for example, a supplied area was too small. The following reason codes can accompany the return code: JRSmallFsAttr , JRVTokenFreed, JRWrongPID, JRStaleVnodeTok, JRInvalidVnodeTok, JRInvalidOSS.
EPERM	The operation is not permitted. The caller of the service is not registered as a server.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_fstatfs service stores the reason code. The v_fstatfs service returns a Reason_code only if Return_value is -1. Reason_code further qualifies the Return_code value. See z/OS UNIX System Services Messages and Codes for the reason codes.

Usage notes

The supplied FsAttr structure must be at least SSTF#MINLEN (from the BPXYSSTF macro) bytes in length. The length of the structure is SSTF#LENGTH.
The input FsAttr structure length might not match the length that is supported by the file system. The file system returns the size that represents the amount of valid data in SSTFLEN.

Related services

v_reg (BPX1VRG, BPX4VRG) — Register a process as a server

Characteristics and restrictions

A process must be registered as a server before the v_fstatfs service is permitted; see v_reg (BPX1VRG, BPX4VRG) — Register a process as a server.

Examples

For an example using this callable service, see BPX1VSF, BPX4VSF (v_fstatfs).