TEST option

z/OS MVS Programming: Assembler Services Reference ABE-HSP

TEST option

z/OS MVS Programming: Assembler Services Reference ABE-HSP
SA23-1369-00

The TEST option of the ESPIE macro determines the active SPIE/ESPIE environment and returns the information in a 4-word parameter list.

Input register information

Before issuing the TEST option of the ESPIE macro, the caller does not have to place any information into any register unless using it in register notation for a particular parameter, or using it as a base register.

Output register information

When control returns to the caller, the general purpose registers (GPRs) contain:

Register: Contents
0: Used as a work register by the system
1-13: Unchanged
14: Used as a work register by the system
15: Return code

When control returns to the caller, the access registers (ARs) contain:

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14-15: Used as work registers by the system

Some callers depend on register contents remaining the same before and after issuing a service. If the system changes the contents of registers on which the caller depends, the caller must save them before issuing the service, and restore them after the system returns control.

Syntax

The TEST option of the ESPIE macro is written as follows:

Syntax	Description

`name`	`name`: Symbol. Begin `name` in column 1.

␢	One or more blanks must precede ESPIE.

ESPIE

␢	One or more blanks must follow ESPIE.


TEST

,`parm addr`	`parm addr`: RX-type address, or register (1), (2) - (12).

Parameters

The parameters are explained as follows:

TEST

Indicates a request for information concerning the active or current SPIE/ESPIE environment. ESPIE processing returns this information to the caller in a 4-word parameter list located at parm addr.

,parm addr

Specifies the address of a 4-word parameter list aligned on a fullword boundary. The parameter list has the following form:

Word: Content
0: Address of the exit routine (31-bit address with the high-order bit set to 0 for 24-bit routines or 1 for 31-bit routines)
1: Address of the user-defined parameter list
2: Mask of program interruption types
3: Zero

Return and reason codes

ESPIE TEST returns status information about the current ESPIE environment in GPR 15. When control returns from ESPIE TEST, GPR 15 contains one of the following hexadecimal return codes.

Note: These return codes are informational; no actions are required.

Hexadecimal Return Code	Meaning
0	Meaning: An ESPIE exit is active and the 4-word parameter list contains the information specified in the description of the `parm addr` parameter.
4	Meaning: A SPIE exit is active. Word 1 of the parameter list described under `parm addr` contains the address of the current PICA. Words 0, 2, and 3 of the parameter list contain no relevant information.
8	Meaning: No SPIE or ESPIE is active. The contents of the 4-word parameter list contain no relevant information.

Example

Identify the active SPIE/ESPIE environment. Return the information about the exit routine in the 4-word parameter list, PARMLIST. Also return, in register 15, an indicator of whether a SPIE, ESPIE, or neither is active.

ESPIE TEST,PARMLIST