__cpl (BPX1CPL) — CPL interface service

Function

The __cpl callable service calculates coupling facility structure sizes required by the CFRM (Coupling Facility Resource Manager) policy through a Web interface.

Requirements

Operation	Environment
Authorization:	Problem program or supervisor state, any PSW key
Dispatchable unit mode:	Task
Cross memory mode:	PASN = HASN
AMODE:	31-bit
ASC mode:	Primary address space control (ASC) 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 BPX1CPL,(FunctionCode,
              Bufferlen,
              Buffer,
              Return_value,
              Return_code,
              Reason_code)

Parameters

FunctionCode

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains a value indicating the type of CPL function requested. The following are the supported values:

1: Request data from available coupling facilities
2: Request a structure size
3: Request a structure size and CFLevel
4: Request a structure size and CFLevel with variable-length parameter list

Start of change These values are defined in __cpl.h. End of change

Bufferlen

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains the input length of the buffer.

Buffer

Supplied parameter

Type:: Structure
Length:: Length specified by Bufferlen

The name of a fullword that represents the buffer in which the __cpl service receives the input parameters from the Web and returns the results of the call.

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the __cpl 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 __cpl service stores the return code. The __cpl service stores a return code only if the return value is -1. See z/OS UNIX System Services Messages and Codes for a complete list of possible return code values. The __cpl service may return the following values in the Return_code parameter:

Return code	Explanation
EMVSCPLERROR	A __cpl service request failed. Consult reason_code, which will contain the reason code from the failing z/OS® service, to determine the reason the error occurred.
EFAULT	One of the parameters contained an address that was not accessible to the caller.
EINVAL	The FunctionCode parameter contains a value that is not correct, or the input parameter list is built incorrectly. The following reason codes can accompany the return code: JRCPLInvFcnCode, JRCPLInvBuffLen, JRCPLBuffTooSmall, JRCPLInvStrucType, JRCPLFcnReq, JRCPLParmVer.
EPERM	The calling thread's address space is not permitted to the BPX.CF resource in the FACILITY class. The caller's address space must be permitted to the BPX.CF resource profile in the FACILITY class. The following reason code can accompany the return code: JRCPLNotAuth.
ENOSYS	The __cpl service request failed because the system is not at the correct level. The following reason code can accompany the return code: JRCPLCFNotFound.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the __cpl service stores the reason code. The __cpl service stores a reason code only when the return value is -1. The reason code further qualifies the return code value. See z/OS MVS Programming: Sysplex Services Reference for the reason codes.

Usage notes

There is no 64-bit version of the __cpl callable service.

Characteristics and restrictions

The __cpl service is a privileged service; the caller must have read access to the BPX.CF resource profile in the FACILITY class.