IEAVDPE — Deallocate_Pause_Element

Description

Deallocate_Pause_Element frees a pause element that is no longer needed.

Environment

The requirements for the caller are:

Environmental factor Requirement
Minimum authorization: Problem state and any PSW key.
Dispatchable unit mode:
  • For auth_level=IEA_UNAUTHORIZED: Task
  • For auth_level=IEA_AUTHORIZED: Task or SRB
Cross memory mode:
  • For auth_level=IEA_UNAUTHORIZED: PASN=HASN=SASN
  • For auth_level=IEA_AUTHORIZED: Any PASN, any HASN, any SASN
AMODE: 31-bit addressing mode.
ASC mode: Primary mode.
Interrupt status: Enabled for I/O and external interrupts
Locks:
  • When supervisor state and PSW key 0: The local lock may be held.
  • When problem state, or not PSW key 0: No locks may be held.
Control parameters: Must be in the primary address space and addressable by the caller.

Programming requirements

Either link the calling program's object code with the linkable stub routine (IEACSS from SYS1.CSSLIB), or load the calling program and then call the service. The high-level language (HLL) definitions for the callable service are:

HLL Definition Description
IEAASM 390 Assembler declarations
IEAC C/390 and C++/390 declarations

Restrictions

When the calling program specifies auth_level=IEA_UNAUTHORIZED, the caller must be in task mode and can only release another task in its home address space. All pause element tokens (PETs) used when auth_level=IEA_UNAUTHORIZED must have been obtained using an authorization level of IEA_UNAUTHORIZED.

Input register information

Before calling Deallocate_Pause_Element, the caller must ensure that the following general purpose registers (GPRs) contain the specified information:
Register
Contents
1
Address of the parameter address list.
13
Address of a 72-byte register save area.

Output register information

When control returns to the caller, the GPRs contain:
Register
Contents
0-1
Used as work registers by the system
2-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 a work register 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.

Performance implications

None.

Syntax

Write the call as shown on the syntax diagram. You must code all parameters on the CALL statement in the order shown.

Syntax Description
CALL IEAVDPE

 
,(return_code
,auth_level
,pause_element_token)
 

Parameters

The parameters are explained as follows:

return_code
Returned parameter
  • Type: Integer
  • Character Set: N/A
  • Length: 4 bytes

Contains the return code from the Deallocate_Pause_Element service.

,auth_level
Supplied parameter
  • Type: Integer
  • Character Set: N/A
  • Length: 4 bytes

Indicates the maximum authorization level of the pause element being deallocated. IEAASM and IEAC define constants IEA_UNAUTHORIZED and IEA_AUTHORIZED, which the calling program can use. The following levels are supported:

Variable Value (HEX) Meaning
IEA_UNAUTHORIZED 0 This pause element being deallocated must have been allocated with auth_level=IEA_UNAUTHORIZED.
IEA_AUTHORIZED 1 This pause element being deallocated must have been allocated with auth_level=IEA_AUTHORIZED.
,pause_element_token
Supplied parameter
  • Type: Character string
  • Character Set: N/A
  • Length: 16 bytes

Contains the pause element token that identifies the pause element that is no longer needed.

ABEND codes

None.

Return codes

When the service returns control to the resource manager, GPR 15 and return_code contain a hexadecimal return code.

Return code in:
Decimal (Hex)
Equate symbol

 Meaning and Action
00 (00)

IEA_SUCCESS

 Meaning: Successful completion

Action: None.
04 (04) Meaning: Program error. The specified pause element token is not valid. The system rejects the service call.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
08 (08)

IEA_PE_TOKEN_STALE

 Meaning: The specified pause element token is stale; that is, it was valid but has been used on the Pause or Transfer service. This service requires the updated PET returned on Pause or Transfer.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
24 (18)

IEA_LOCK_HELD

 Meaning: Program error. The caller is holding one or more locks; no locks must be held. The system rejects the service call.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
32 (20)

IEA_PE_BAD_STATE

 Meaning: Program error. The pause element associated with the specified pause element token is not valid or has already been paused. A paused PE must be released before it is deallocated. This return code also can indicate that the address space associated with the pause element is ending or has ended and that the system freed the pause element.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
36 (24)

IEA_UNSUPPORTED_MVS_RELEASE

 Meaning: Environmental error. The system release does not support this service. The system rejects the service call.

Action: Run the program on a system that supports the service.
40 (28)

IEA_INVALID_AUTHCODE

 Meaning: Program error. The auth_level value specified in the call is not valid. The system rejects the service call.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
44 (2C)

IEA_INVALID_MODE

 Meaning: Program error. The calling program is not in primary ASC mode, which this service requires. The system rejects the service call.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
60 (3C)

IEA_AUTH_TOKEN

 Meaning: Program error. The caller specified auth_level=UNAUTHORIZED, but the pause element token was allocated with auth_level=AUTHORIZED. The system rejects the service call.

Action: Program error. The specified pause element token is not valid. The system rejects the service call.
64 (40)

IEA_PE_NOT_HOME

 Meaning: Program error. The caller specified auth_level=UNAUTHORIZED, but the pause element token was for a pause element allocated to another address.

Action: Check the calling program for a probable coding error. Correct the program and rerun it.
4095 (FFF)

IEA_UNEXPECTED_ERROR

 Meaning: This service routine encountered an unexpected error. The system rejects this service request.

Action: Contact IBM® support.