CSL SCI Initialization/termination user exit

This exit is called during SCI address space initialization, IMSplex initialization, SCI address space normal termination, or IMSplex normal termination. This exit is not called during SCI address space abnormal termination or IMSplex abnormal termination. This exit is optional.

This exit is called for the following events:

  • After SCI has completed initialization
  • After each IMSplex has initialized
  • When SCI is terminating normally
  • When an IMSplex is terminating normally

This exit is defined as TYPE=INITTERM in the EXITDEF statement in the BPE user exit list PROCLIB member. You can specify one or more user exits of this type. When this exit is invoked, all user exits of this type are driven in the order specified by the EXITS= keyword. For more information on how to define user exit module names, see the SCI BPE user exit list PROCLIB member information in IMS Version 15.2 System Definition.

This exit is invoked amode 31 and should be reentrant.

Subsections:

Contents of registers on entry

Register Contents
1 Address of BPE user exit parameter list (mapped by macro BPEUXPL).
13 Address of the first of 2 prechained 72-byte save areas. These save areas are chained according to standard z/OS® save area linkage convention. The first save area can be used by the exit to save registers on entry. The second save area is for use by routines called from the user exit.
14 Return address.
15 Entry point of exit routine.

On entry to the Initialization/Termination exit, register 1 points to a standard BPE user exit parameter list. Field UXPL_EXITPLP in this list contains the address of the SCI Initialization/Termination user exit parameter list, which is mapped by macro CSLSITX. Field UXPL_COMPTYPEP in this list points to the character string SCI indicating an SCI address space.

SCI init/term user exit parameter list: SCI Initialization

The following table lists the user exit parameter list for SCI initialization. Included are the field name, the offset value and length (both in hexadecimal), how the field is used, and a brief description of the field.

Table 1. SCI init/term user exit parameter list: SCI Initialization
Field name Offset Length Field usage Description
SITX_PVER X'00' X'04' Input Parameter list version number (X'00000001').
SITX_FUNC X'04' X'04' Input Function code

1 SCI initialization.

SCI init/term user exit parameter list: SCI Termination

The following table lists the user exit parameter list for SCI termination. Included are the field name, the offset value and length (both in hexadecimal), how the field is used, and a brief description of the field.

Table 2. SCI init/term user exit parameter list: SCI Termination
Field name Offset Length Field usage Description
SITX_PVER X'00' X'04' Input Parameter list version number (X'00000001').
SITX_FUNC X'04' X'04' Input Function code

2 SCI normal termination.

SCI init/term user exit parameter list: IMSplex Initialization

The following table lists the user exit parameter list for IMSplex initialization. Included are the field name, the offset value and length (both in hexadecimal), how the field is used, and a brief description of the field.

Table 3. SCI init/term user exit parameter list: IMSplex Initialization
Field name Offset Length Field usage Description
SITX_PVER X'00' X'04' Input Parameter list version number (X'00000001').
SITX_FUNC X'04' X'04' Input Function code

3 IMSplex normal initialization.
SITX_IPLEXNM X'08' X'08' Input IMSplex name.

SCI init/term user exit parameter list: IMSplex Termination

The following table lists the user exit parameter list for IMSplex termination. Included are the field name, the offset value and length, both in hexadecimal, how the field is used, and a brief description of the field.

Table 4. SCI init/term user exit parameter list: IMSplex Termination
Field name Offset Length Field usage Description
SITX_PVER X'00' X'04' Input Parameter list version number (X'00000001').
SITX_FUNC X'04' X'04' Input Function code

4 IMSplex normal termination.
SITX_IPLEXNM X'08' X'08' Input IMSplex name.

Contents of registers on exit

Register Contents
15 Return code Meaning
  0 Always zero
  All other registers must be restored.