vfs_network — Define a socket domain to the PFS

Function

The vfs_network operation is called as a result of the NETWORK statement in the BPXBPRMxx parmlib member that is used to start z/OS UNIX. It defines information about a socket domain to the PFS that is supporting it.

Environment on entry and exit

See Environment for PFS operations.

Input parameter format

vfs_network (Token_structure,
             OSI_structure,
             Audit_structure,
             Network_structure,
             Return_value,
             Return_code,
             Reason_code)

Parameters

Token_structure

Supplied parameter

Type:: TOKSTR
Length:: Specified by TOKSTR.ts_hdr.cblen.

The Token_structure represents the file system (VFS) that is being operated on. It contains the PFS's initialization token and mount token. Refer to LFS/PFS control block structure for a discussion of this structure, and to the TOKSTR typedef in BPXYPFSI in Interface structures for C language servers and clients for its mapping.

OSI_structure

Supplied and returned parameter

Type:: OSI
Length:: Specified by OSI.osi_hdr.cblen.

The OSI_structure contains information that is used by the OSI operations that may be called by the PFS. See OSI services for more information.

It also contains MVS-specific information that needs to be passed to the PFS, including SMF accounting fields, a work area, a recovery area, and an optional pointer to an output ATTR structure. For more details on the OSI structure, see The OSI structure.

This area is mapped by the OSI typedef in BPXYPFSI in Interface structures for C language servers and clients.

Audit_structure

Supplied parameter

Type:: CRED
Length:: Specified by CRED.cred_hdr.cblen.

The Audit_structure contains information that is used by the security product for access checks and auditing. It is passed to most SAF routines that are invoked by the PFS.

Refer to Security responsibilities and considerations for a discussion of security processing, and to the CRED typedef in BPXYPFSI in Interface structures for C language servers and clients for the mapping of this structure.

Network_structure

Supplied parameter

Type:: NETW
Length:: Specified by netw.netw_hdr.cblen

The Network_structure is an area, built during initialization, that contains the information that is included on the NETWORK statement—the socket domain name and number and the maximum number of sockets. This area is mapped by the NETW typedef in the BPXYPFSI header file (see Interface structures for C language servers and clients).

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

A fullword in which the vfs_network operation returns the results of the operation as one of the following:

Return_value: Meaning
-1: The operation was not successful. The Return_code and Reason_Code values must be filled in by the PFS when Return_value is -1.
0: The operation was successful.

Return_code

Returned parameter

Type:: Integer
Length:: Fullword

A fullword in which the vfs_network operations stores the return code. The vfs_network operation returns Return_code only if Return_value is -1. For a complete list of supported return code values, see z/OS UNIX System Services Messages and Codes.

The vfs_network operation should support at least the following error values:

Return_code	Explanation
EAFNOSUPPORT	The address family that was specified in the Network_structure is not supported by this PFS.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

A fullword in which the vfs_network operation stores the reason code. The vfs_network operation returns Reason_code only if Return_value is -1. Reason_code further qualifies the Return_code value. These reason codes are documented by the PFS.

Implementation notes

Overview of vfs_network processing

For information about the vfs_network call, refer to Activating a domain.

Specific processing notes

The PFS should ensure that it does not do any blocking waits during its processing.

The PFS is responsible for returning two fields set so that they can be used for subsequent processing. These fields are:

NETW.nt_localremote: An indication of whether the communication done by this PFS is local or remote. Turn the bit on to indicate remote communication.
TOKSTR.ts_mount: The 8-byte token that is returned by the PFS and used on all subsequent calls to this PFS. This token is used by the PFS to locate the PFS structures that are associated with this network.

Serialization provided by the LFS

The logical file system ensures that only one vfs_network statement is processed at a time. Further, the PFS does not receive any socket requests specifying this domain until the vfs_network operation completes.

Security calls to be made by the PFS

None.