IEA4RLS2 — Release

Description

Call IEA4RLS2 service to remove a task or SRB that has been paused, or to keep a task or SRB from being paused.

Although a pause element can be used multiple times to pause a task or SRB, a pause element token can be used to successfully pause and release a task or SRB only once. Each time a pause element is used, the system generates a new PET to identify the pause element. The system returns the new updated PET on calls to the pause and transfer services.

Environment

The requirements for the caller are:

Environmental factor Requirement
Minimum authorization:
  • For LINKAGE=BRANCH, supervisor state and PSW key 0.
  • For LINKAGE=SVC:
    • Working with an IEA_AUTHORIZED pause element, supervisor state and PSW key 0-7.
    • Working with an IEA_UNAUTHORIZED pause element, problem state and any PSW key.
Dispatchable unit mode:
  • For LINKAGE=BRANCH: Task or SRB
  • For LINKAGE=SVC: Task
Cross memory mode:
  • For LINKAGE=BRANCH: Any PASN, any HASN, any SASN
  • For LINKAGE=SVC: PASN=HASN=SASN
AMODE: 64-bit
ASC mode: Primary mode.
Interrupt status: Enabled or disabled for I/O and external interrupts.
Locks:
  • For LINKAGE=BRANCH: The CPU, CMS, or local locks may be held.
  • For LINKAGE=SVC: No locks may be held.
Control parameters: Must be in the primary address space and addressable by the caller.

Programming requirements

Either link the object code of the calling program with the linkable stub routine (IEA4CSS 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

Pause elements that are created with pause_element_auth_level=IEA_UNAUTHORIZED may only be used by callers in task mode and can only be released from a task in their home address space.

Release cannot be used by tasks that are higher in the task tree than the cross memory resource owning task (the top, or first, job step task in the address space).

Input register information

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

Output register information

When control returns to the caller, the general purpose registers (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

Syntax Description
SYSSTATE AMODE64=YES  

CALL IEA4RLS2

 
,(return_code
,target_du_pause_element_token
,target_du_release_code
,linkage)
 

Parameters

The parameters are explained as follows:

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

Contains the return from the Release service.

,target_du_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 used to pause a task or SRB. If the PET identifies a pause element that has not been paused, the task is paused. However, the value specified in target_du_release_code is returned to the caller of pause.

,target_du_release_code
Supplied parameter
  • Type: Character string
  • Character Set: N/A
  • Length: 3 bytes

Contains the release code returned to the caller of pause or transfer service that used or will use the same PET to pause a task or SRB. If the program is not using this code for communication, set this field to zero.

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

Specifies how the Release service routine is to be invoked. The following options are supported:

Variable Value (hexadecimal) Meaning
IEA_LINKAGE_SVC 0 The Release service routine will be invoked by an SVC linkage. This option can be used when in non-cross memory task mode, in any key, and either problem state or supervisor state.
IEA_LINKAGE_BRANCH 1 The Release service routine will be invoked by a branch instruction. The caller must be in both key 0 and supervisor state. This option must be selected when in SRB mode.

ABEND codes

None.

Return codes

When the service returns control to the resource manager, GPR 15 and the return_code parameter 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) IEA_PE_TOKEN_BAD Meaning: 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.
16 (10) IEA_SLEEP_DISRUPTED Meaning: RTM has terminated the task or SRB; no release is necessary.

Action: None
20 (14) IEA_SPACE_TERMINATING Meaning: The address space that contains the task or SRB is terminating; no release is necessary.

Action: None
24 (18) IEA_LOCK_HELD Meaning: Program error. The caller is holding one or more locks; other than the local lock, CMS, or CPU lock, no locks may 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 pause element token specified is invalid or has already been prereleased.

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.
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 was in Problem state or key 8, but the pause element token was allocated with pause_element_auth_level=IEA_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 pause element token was for a pause element allocated with pause_element_auth_level=IEA_UNAUTHORIZED to another address space.

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: Search problem reporting databases for a fix for the problem. If no fix exists, contact the IBM® Support Center.