vn_getname — Get the peer or socket name

Function

The vn_getname operation gets the peer name or the socket name.

Environment on entry and exit

Input parameter format

vn_getname  (Token_structure,
             OSI_structure,
             Audit_structure,
             Name_type,
             Sockaddr_length,
             Sockaddr,
             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 (vnode) that is being operated on. It contains the PFS's initialization token, mount token, and the file 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.

Name_type

Supplied parameter

Type:: Integer
Length:: Fullword

A fullword that specifies whether to get the peer name or the socket name. The values for this field are defined in the BPXYPFSI header file (see Interface structures for C language servers and clients).

Sockaddr_length

Supplied and returned parameter

Type:: Integer
Length:: Fullword

A fullword that supplies the length of the Sockaddr buffer, and returns the length of the Sockaddr structure that is returned.

Sockaddr

Supplied and returned parameter

Type:: SOCK
Length:: Specified by Sockaddr_length

A structure that varies depending on the address family type. On return, it contains the address that was used for this operation. For an example of this mapping for AF_INET, see in.h.

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

A fullword in which the vn_getname 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 vn_getname operation stores the return code. The vn_getname 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 vn_getname operation should support at least the following error values:

Return_code	Explanation
EINVAL	The length of the name that was specified is too short.
ENOTCONN	The socket is not connected for a getpeername request.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

A fullword in which the vn_getname operation stores the reason code. The vn_getname 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 vn_getname processing: For more information about the semantics of this operation for a POSIX-conforming PFS, refer to the publications that are mentioned in Finding more information about sockets for the getpeername and getsockname functions.
Serialization provided by the LFS: The vn_getname operation is invoked with an exclusive latch held on the vnode of the socket.
Security calls to be made by the PFS: None