Kernel domain’s specific gates

Table 59 summarizes the kernel domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 59. Kernel domain’s specific gates
Gate Trace Function XPI
KEAR
KE 0701
KE 0702
DEREGISTER
READY
REGISTER
WAITPRED
NO
KEDD
KE 0201
KE 0202
ADD_DOMAIN
INQUIRE_DOMAIN_BY_TOKEN
INQUIRE_DOMAIN_BY_NAME
SET_ANCHOR
INQUIRE_ANCHOR
ADD_GATE
DELETE_GATE
INQUIRE_GLOBAL_TRACE
SET_GLOBAL_TRACE
INQUIRE_DOMAIN_TRACE
SET_DOMAIN_TRACE
INQUIRE_TASK_TRACE
SET_TASK_TRACE
PERFORM_SYSTEM_ACTION
SET_TRAP_OFF
SET_TRAP_ON
SET_DEFAULT_RECOVERY
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
KEDS
KE 0502
KE 05034
ABNORMALLY_TERMINATE_TASK
CREATE_TASK5
CREATE_TCB
DETACH_TERMINATED_OWN_TCBS
END_TASK
FREE_TCBS
PUSH_TASK
POP_TASK
READ_TIME
Start of changeRESET_RUNAWAY_TIMEREnd of change
RESET_TIME
START_RUNAWAY_TIMER
STOP_RUNAWAY_TIMER
RESTORE_STIMER
SEND_DEFERRED_ABEND
START_PURGE_PROTECTION
STOP_PURGE_PROTECTION
START_FORCEPURGE_PROTECTION
STOP_FORCEPURGE_PROTECTION
PROCESS_KETA_ERROR
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
NO
NO
NO
KEGD
KE 0401
KE 0402
INQUIRE_KERNEL
SET_KERNEL
NO
NO
KEIN
KE 0301
KE 0302
INITIALISE_KERNEL
SET_STATIC_TASKS
ADD_DYNAMIC_TASK
ADD_TEMPORARY_STATIC_TASK
DELETE_TASKS
NO
NO
NO
NO
NO
KETI
KE 0101
KE 0102
ADJUST_STCK_TO_LOCAL
CONVERT_TO_DECIMAL_TIME
CONVERT_TO_STCK_FORMAT
INQUIRE_DATE_FORMAT
INQ_LOCAL_DATETIME_DECIMAL
NOTIFY_RESET
REQUEST_NOTIFY_OF_A_RESET
RESET_LOCAL_TIME
SET_DATE_FORMAT
NO
NO
NO
NO
NO
NO
NO
NO
NO
KEXM
KE 0601
KE 0602
TRANSACTION_INITIALISATION
NO

KEAR gate, DEREGISTER function

The DEREGISTER function of the KEAR gate is used when performing a normal shutdown (and optionally at an immediate shutdown) to deregister CICS® from the MVS™ automatic restart manager.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED

KEAR gate, READY function

The READY function of the KEAR gate is used at the end of CICS initialization to indicate to the MVS automatic restart manager. that this CICS region is ready for work.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED

KEAR gate, REGISTER function

The REGISTER function of the KEAR gate is used very early in CICS initialization to register CICS with the MVS automatic restart manager.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEAR gate, WAITPRED function

The WAITPRED function of the KEAR gate is used to wait on predecessors in the restart policy for this CICS region, to ensure that prerequisite subsystems are available to CICS.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED

KEDD gate, ADD_DOMAIN function

The ADD_DOMAIN function of the KEDD gate is used to add a new domain to the domain table.

Input parameters

DOMAIN_NAME
is the 8-character domain name for the new domain to be added.
DOMAIN_TOKEN
is the 31-bit constant that uniquely identifies the domain, for example, DFHSM_DOMAIN for storage manager domain.
ENTRY_POINT
is the 31-bit address of the entry point for that domain, for example, A(X'80000000' + DFHSMDM) for storage manager domain.
[DOMAIN_AFFINITY]
is the TCB that the domain has affinity with for TERMINATE_DOMAIN. It can have any one of these values:
STEP|RO|QR|CO|SZ

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUPLICATE_DOMAIN_TOKEN
DUPLICATE_DOMAIN_NAME
INVALID
INVALID_DOMAIN_TOKEN
INVALID_ENTRY_POINT

KEDD gate, INQUIRE_DOMAIN_BY_TOKEN function

The INQUIRE_DOMAIN_BY_TOKEN function of the KEDD gate is used to return the domain name for a specified domain token.

Input parameters

DOMAIN_TOKEN
is the 31-bit constant that uniquely identifies the domain.

Output parameters

DOMAIN_NAME
is the 8-character domain name for the new domain to be added.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION DOMAIN_TOKEN_NOT_FOUND
INVALID INVALID_DOMAIN_TOKEN

KEDD gate, INQUIRE_DOMAIN_BY_NAME function

The INQUIRE_DOMAIN_BY_NAME function of the KEDD gate is used to return the domain token for a given domain name.

Input parameters

DOMAIN_NAME
is the 8-character domain name for the new domain to be added.

Output parameters

DOMAIN_TOKEN
is the 31-bit constant that uniquely identifies the domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
DOMAIN_NAME_NOT_FOUND

KEDD gate, SET_ANCHOR function

The SET_ANCHOR function of the KEDD gate is used to establish the calling domain’s global storage pointer.

Input parameters

ANCHOR
is the 31-bit address of the domain’s global storage.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_DOMAIN_TOKEN

KEDD gate, INQUIRE_ANCHOR function

The INQUIRE_ANCHOR function of the KEDD gate is used to return the specified domain’s global storage pointer to the caller. If the domain token is omitted, the calling domain is assumed.

Input parameters

[DOMAIN_TOKEN]
is the 31-bit constant that uniquely identifies the domain.

Output parameters

ANCHOR
is the 31-bit address of the domain’s global storage.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION DOMAIN_TOKEN_NOT_FOUND
INVALID INVALID_DOMAIN_TOKEN

KEDD gate, ADD_GATE function

The ADD_GATE function of the KEDD gate is used to update the domain table to add a new gate to the calling domain’s gate table.

Input parameters

GATE_INDEX
is the 31-bit constant that uniquely identifies the gate in the domain’s gate table.
ENTRY_POINT
is the 31-bit address of the entry point for the gate.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION DUPLICATE_GATE_INDEX
INVALID
INVALID_ENTRY_POINT
INVALID_GATE_INDEX
INVALID_DOMAIN_TOKEN

KEDD gate, DELETE_GATE function

The DELETE_GATE function of the KEDD gate is used to delete an existing gate from the calling domain’s gate table.

Input parameters

GATE_INDEX
is the 31-bit constant that uniquely identifies the gate in the domain’s gate table.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
When RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_GATE_INDEX
INVALID_DOMAIN_TOKEN

KEDD gate, INQUIRE_GLOBAL_TRACE function

The INQUIRE_GLOBAL_TRACE function of the KEDD gate is used to return the value of the global trace flags to the caller.

Input parameters

None.

Output parameters

[MASTER_TRACE_FLAG]
determines whether tracing, for any of the trace destinations, is active. It can have either of these values:
ON|OFF
[SYSTEM_TRACE_FLAG]
determines whether tracing is allowed for tasks for which standard tracing is in effect. It can have either of these values:
ON|OFF
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, SET_GLOBAL_TRACE function

The SET_GLOBAL_TRACE function of the KEDD gate is used to store the value of the global trace flags within the kernel.

Input parameters

[MASTER_TRACE_FLAG]
determines whether tracing, for any of the trace destinations, is active. It can have either of these values:
ON|OFF
[SYSTEM_TRACE_FLAG]
determines whether tracing is allowed for tasks for which standard tracing is in effect. It can have either of these values:
ON|OFF

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, INQUIRE_DOMAIN_TRACE function

The INQUIRE_DOMAIN_TRACE function of the KEDD gate is used to return the value of the specified domain’s trace flags to the caller. If the domain token is omitted, the calling domain is assumed.

Input parameters

[DOMAIN_TOKEN]
is the 31-bit constant that uniquely identifies the domain.

Output parameters

[STANDARD_TRACE_FLAGS]
is the set of 32 bits which determines selectivity of tracing within the domain for standard tasks.
[SPECIAL_TRACE_FLAGS]
is the set of 32 bits which determines selectivity of tracing within the domain for special tasks.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION DOMAIN_TOKEN_NOT_FOUND
INVALID INVALID_DOMAIN_TOKEN

KEDD gate, SET_DOMAIN_TRACE function

The SET_DOMAIN_TRACE function of the KEDD gate is used to store the value of the specified domain’s trace flags in the kernel. If the domain token is omitted, the calling domain is assumed.

The current task’s stack entries are updated to reflect the change. The trace count is incremented so that all other tasks have their stack entries refreshed when they are next dispatched.

Input parameters

[DOMAIN_TOKEN]
is the 31-bit constant that uniquely identifies the domain.
[STANDARD_TRACE_FLAGS]
is the set of 32 bits which determines selectivity of tracing within the domain for standard tasks.
[SPECIAL_TRACE_FLAGS]
is the set of 32 bits which determines selectivity of tracing within the domain for special tasks.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION DOMAIN_TOKEN_NOT_FOUND
INVALID INVALID_DOMAIN_TOKEN

KEDD gate, INQUIRE_TASK_TRACE function

The INQUIRE_TASK_TRACE function of the KEDD gate is used to return the value of the calling task’s trace flag to the caller.

Input parameters

None.

Output parameters

[TRACE_TYPE]
determines whether standard, special, or no tracing is required for this task. It can have any one of these values:
STANDARD|SPECIAL|SUPPRESSED
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, SET_TASK_TRACE function

The SET_TASK_TRACE function of the KEDD gate is used to store the value of the task trace flag in the current task’s task table6 entry.

The current task’s stack entries are updated to reflect the change.

Input parameters

TRACE_TYPE
determines whether standard, special, or no tracing is required for this task. It can have any one of these values:
STANDARD|SPECIAL|SUPPRESSED

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, PERFORM_SYSTEM_ACTION function

The PERFORM_SYSTEM_ACTION function of the KEDD gate is used in exceptional circumstances either to terminate CICS (with or without a dump) or to take an MVS SDUMP.

Normally, these services are invoked from domains during preinitialization before the dump domain is available.

Input parameters

[TERMINATE_SYSTEM ( YES, NO )]
specifies whether CICS is to be terminated or not. It can have either of these values:
YES|NO
[DUMP_SYSTEM ( YES, NO ) ]
specifies whether an MVS SDUMP is to be taken or not. It can have either of these values:
YES|NO
[NORMAL_TERMINATION( YES, NO )]
specifies whether CICS is being terminated normally. Normal termination includes controlled and immediate shutdowns. It can have either of these values:
YES|NO

The default value is NO.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, SET_TRAP_OFF function

The SET_TRAP_OFF function of the KEDD gate is used to reset the kernel global trap point.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDD gate, SET_TRAP_ON function

The SET_TRAP_ON function of the KEDD gate is used to set a kernel global trap point.

Input parameters

ENTRY_POINT
is the 31-bit address of the kernel global trap.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_ENTRY_POINT

KEDD gate, SET_DEFAULT_RECOVERY function

The SET_DEFAULT_RECOVERY function of the KEDD gate is used to establish the calling domain’s default recovery routine. Used by the Application domain to identify DFHSRP as its default recovery routine.

Input parameters

ENTRY_POINT
is the 31-bit address of the entry point for the recovery routine.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_DOMAIN_TOKEN

KEDS gate, ABNORMALLY_TERMINATE_TASK function

The ABNORMALLY_TERMINATE_TASK function of the KEDS gate identifies the task which is to be abnormally terminated.

Input parameters

TASK_TOKEN
identifies the task which is to be abnormally terminated.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION TERMINATE_FAILED

KEDS gate, CREATE_TASK function

The CREATE_TASK function of the KEDS gate is used to allocate a new executable task from the task table7.

When the task is first dispatched, the Kernel domain issues a KEDS_TASK_REPLY request, which passes control to the Dispatcher domain’s task reply gate. (See KEDS format, TASK_REPLY function.)

The attach token input on the CREATE_TASK request is passed back to the dispatcher domain on the TASK_REPLY, to identify the CREATE_TASK and TASK_REPLY pair.

Note:
The CREATE_TASK function is processed by the DFHKETA module.

Input parameters

ALLOCATION
indicates whether or not the returned task should be allocated from those tasks pre-allocated for MXT. It can either of these values:
STATIC | DYNAMIC
ATTACH_TOKEN
is the 31-bit token that uniquely identifies the request. This token is returned on the corresponding TASK_REPLY to identify the request.

Output parameters

TASK_TOKEN
is the 31-bit token that uniquely identifies the newly created task.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER INQUIRE_ERROR
EXCEPTION ADD_TASK_ERROR

KEDS gate, CREATE_TCB function

The CREATE_TCB function of the KEDS gate creates the default task for a new MVS TCB, and MVS posts the TCB to start execution. The default task is the task, associated with the TCB, that executes the dispatcher loop which chooses the next CICS task (system or non-system) to be dispatched, or if no CICS task is to be dispatched, issues an MVS WAIT.

The kernel invokes the dispatcher domain at its KEDS gate with a TCB_REPLY request, under the new TCB’s default task.

The attach token is used to identify the CREATE_TCB and TCB_REPLY pair.

Input parameters

ATTACH_TOKEN
is the 31-bit token that uniquely identifies the request. This token is returned on the corresponding TCB_REPLY to identify the request.
DEPENDENT_ON
specifies that the TCB is dependent on the named parent TCB mode. This parameter is used to ensure that in the case of an immediate shutdown, worker JVMs (which are built on J8 or J9 mode TCBs) are terminated before master JVMs (which are built on JM mode TCBs).
ESSENTIAL_TCB
indicates whether CICS is to be terminated if a TCB in this mode has its ESTAE exit driven for a non recoverable error.
EXEC_CAPABLE
indicates whether support should be provided under the new TCB for CICS API commands.
INHERIT_SUBSPACE
indicates whether TCBs in this mode are to inherit the subspace of the attaching TCB.
LE_ENVIRONMENT
indicates whether CICS should tell Language Environment® that it is running in a CICS environment under this TCB. If LE_CICS is specified, Language Environment will issue CICS API commands.
[MODE]
specifies the mode of the new TCB. It can have any one of these values:
RO|QR|CO|SZ|RP|FO
PARENT_MODENAME
identifies the mode of the TCB that is to ATTACH the new TCB.
PRTY_RELATIVE_TO_QR
gives the priority of this TCB relative to QR.
[SZERO]
gives the value (YES or NO) of the SZERO parameter for the ATTACH request. If TCB_KEY(USERKEY) is specified, SZERO(NO) is assumed.
TCB_KEY
specifies the key to be specified on the ATTACH of TCBs in this mode. The value ends up in TCBPKF. It can have either of these values:
CICSKEY|USERKEY

Output parameters

TASK_TOKEN
is the 31-bit token that uniquely identifies the new TCB’s task.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER INQUIRE_ERROR
EXCEPTION
ADD_TASK_ERROR
ADD_TCB_ERROR
ATTACH_KTCB_ERROR

KEDS gate, DETACH_TERMINATED_OWN_TCBS function

The DETACH_TERMINATED_OWN_TCBS function of the KEDS gate detaches any terminated TCBs which were attached by the TCB on which this function is invoked.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have this value:
OK

KEDS gate, END_TASK function

The END_TASK function of the KEDS gate is used to free any resources that have been acquired by the kernel domain during the lifetime of the current task and need freeing before the end of the task.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, FREE_TCBS function

The FREE_TCBS function of the KEDS gate conditionally frees control blocks, in collaboration with the Dispatcher for re-use, associated with any detached TCBs.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have this value:
OK

KEDS gate, PUSH_TASK function

Given a TCB executing its default task, the PUSH_TASK function of the KEDS gate is used to make it execute a CICS task instead.

Input parameters

TASK_TOKEN
is the 31-bit token that identifies the CICS task to be executed.

Output parameters

[INTERVAL]
is a doubleword containing the CPU time used by the task while it was pushed.
RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, POP_TASK function

Given a TCB executing the current CICS task, the POP_TASK function of the KEDS gate is used to make it execute its default task instead.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, READ_TIME function

The READ_TIME function of the KEDS gate is used to obtain the total CPU time that the current task has taken so far and the accumulated CPU time for the current TCB.

Input parameters

None.

Output parameters

[INTERVAL]
A doubleword containing the total CPU time used so far.
[ACCUM_TIME]
A doubleword containing the accumulated CPU time used so far by the current TCB.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
Start of change

KEDS gate, RESET_RUNAWAY_TIMER function

The RESET_RUNAWAY_TIMER function of the KEDS gate is used to reset runaway timing for the current task. This resets the count of outstanding STOP_RUNAWAY_TIMER requests.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER
End of change

KEDS gate, RESET_TIME function

The RESET_TIME function of the KEDS gate is used to reset the total CPU time that the current task has taken so far.

Input parameters

None.

Output parameters

[INTERVAL]
A doubleword containing the total CPU time used so far.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, STOP_RUNAWAY_TIMER function

The STOP_RUNAWAY_TIMER function of the KEDS gate is used to inhibit runaway detection for the current task. The remaining runaway interval is preserved until a START_RUNAWAY_TIMER request is issued. The stop runaway count is incremented by one; this allows STOP_RUNAWAY_TIMER requests to be nested.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, START_RUNAWAY_TIMER function

The START_RUNAWAY_TIMER function of the KEDS gate is used to resume runaway timing for the current task. This reduces the stop runaway count by one. The timer is resumed only when all outstanding STOP_RUNAWAY_TIMER requests have been canceled.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, RESTORE_STIMER function

The RESTORE_STIMER function of the KEDS gate is used to restore the kernel’s STIMER exit after MVS requests that use the MVS STIMER macro internally.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, SEND_DEFERRED_ABEND function

The SEND_DEFERRED_ABEND function of the KEDS gate is used by the transaction manager to implement the deferred purge function. If a purge request is made against a task that is not in a suitable state to be purged, this function defers the abend of that task until the task is no longer protected against purge.

This function is used by the transaction manager to implement the deferred purge function.

Input parameters

[DS_TASK_TOKEN]
is the 31-bit dispatcher token that identifies the CICS task to be abended. If not supplied, DS_TASK_TOKEN defaults to the current task.
ABEND_CODE
is the four-character abend code for the abend.
[FORCE]
indicates whether or not the deferred abend is to be forced. It can have either of these values:
YES|NO

The default is NO.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, START_PURGE_PROTECTION function

The START_PURGE_PROTECTION function of the KEDS gate is used to inhibit purge, but not force-purge, for the current task.

In general, each START_PURGE_PROTECTION call should have a corresponding STOP_PURGE_PROTECTION function call to end the purge protection period on completion of any program logic that needs such protection.

This function increments by one the purge protection count for the task. You can issue several START_PURGE_PROTECTION commands for the same task, to increase the count for the task. (To enable the task to purged, the count must be decremented to zero by issuing STOP_PURGE_PROTECTION commands.)

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, STOP_PURGE_PROTECTION function

The STOP_PURGE_PROTECTION function of the KEDS gate is used to enable again purge for the current task after purge has been suspended by a previous START_PURGE_PROTECTION function call.

This function decrements by one the purge protection count for the task. To enable the task to purged, the count must be decremented to zero by issuing the appropriate number of STOP_PURGE_PROTECTION commands.

You must design your exit programs to ensure that purge protection is correctly cancelled. For more information about using these functions to stop and start purge protection, see the CICS Customization Guide.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, START_FORCEPURGE_PROTECTION function

The START_FORCEPURGE_PROTECTION function of the KEDS gate is used by CICS to inhibit forcepurge for a task. The STOP_FORCEPURGE_PROTECTION function is used to end the forcepurge protection period.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, STOP_FORCEPURGE_PROTECTION function

The STOP_FORCEPURGE_PROTECTION function of the KEDS gate is used by CICS to enable again forcepurge for a task after forcepurge has been suspended by a previous START_FORCEPURGE_PROTECTION function call.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEDS gate, PROCESS_KETA_ERROR function

The PROCESS_KETA_ERROR function of the KEDS gate is used to handle any errors for the DFHKETA module. (The DFHKETA module handles the performance sensitive KEDS functions, and calls the DFHKEDS module when its recovery routine is invoked.)

Input parameters

ERROR_DATA
address of the error data that describes the error that has occurred in the DFHKETA module.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER

KEGD gate, INQUIRE_KERNEL function

The INQUIRE_KERNEL function of the KEGD gate is used to obtain the global data maintained by the kernel.

Input parameters

None.

Output parameters

[CICS_SVC_NUMBER]
is the 8-bit CICS service SVC number.
[SPECIFIC_APPLID]
is the 8-character specific applid that identifies the CICS system in the VTAM® network.
[GENERIC_APPLID]
is the 8-character generic applid that identifies the active and alternate CICS systems to VTAM in an XRF environment.
[XRF_COMMAND_LIST]
is the 8-character name of the command list table used by the XRF alternate CICS region.
[ALTERNATE_XRF_IDS]
is the 8-character name of the recoverable service table used if the CICS region is running with XRF and DBCTL.
[SYSID]
is the 4-character ZCP system entry name.
[SIT_NAME]
is the 8-character SIT name.
[OS_PARMS]
is the 8-byte block containing the 31-bit address and 31-bit length of the MVS parameters.
[OP_SYS]
is the 1-character operating system identifier, for example, ‘B’ = MVS.
[OP_REL]
is the 2-byte operating system release and modification level.
[HPO]
specifies whether CICS is to use the VTAM high performance option. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY_LIMIT]
the ICVR time to be used by all tasks that have been defined to have the default runaway limit in the system.
[CPU_MONITORING]
specifies whether the kernel is to perform CPU monitoring. It can have either of these values:
YES|NO
[USS_AVAILABLE]
specifies whether the kernel successfully issued a Unix System Services (USS) SET_DUB_DEFAULT DUBPROCESS command during CICS initialization. It can have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

KEGD gate, SET_KERNEL function

The SET_KERNEL function of the KEGD gate is used to change the global data maintained by the kernel.

Input parameters

[CICS_SVC_NUMBER]
is the 8-bit CICS service SVC number.
[SPECIFIC_APPLID]
is the 8-character specific applid that identifies the CICS system in the VTAM network.
[GENERIC_APPLID]
is the 8-character generic applid that identifies the active and alternate CICS systems to VTAM in an XRF environment.
[XRF_COMMAND_LIST]
is the 8-character name of the command list table used by the XRF alternate CICS region.
[ALTERNATE_XRF_IDS]
is the 8-character name of the recoverable service table used if the CICS region is running with XRF and DBCTL.
[SYSID]
is the 4-character ZCP system entry name.
[SIT_NAME]
is the 8-character name of the system initialization table.
[HPO]
specifies whether CICS is to use the VTAM high performance option. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY_LIMIT]
the ICVR time to be used by all tasks that have been defined to have the default runaway limit in the system.
[CPU_MONITORING]
specifies whether the kernel is to perform CPU monitoring. It can have either of these values:
YES|NO
[TERMINATE_FO]
specifies whether the FO TCB can be normally terminated on an immediate shutdown.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

KETI gate, RESET_LOCAL_TIME function

The RESET_LOCAL_TIME function of the KETI gate is used by the AP domain to inform KETI that a local time reset has occurred.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, REQUEST_NOTIFY_OF_A_RESET function

The REQUEST_NOTIFY_OF_A_RESET function of the KETI gate requests a shoulder tap from KETI whenever the local time is reset.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, SET_DATE_FORMAT function

The SET_DATE_FORMAT function of the KETI gate is used to set the date format for the timer domain.

Input parameters

DATE_FORMAT
is the format to be set as the default for the timer domain. It can have any one of these values:
YYMMDD|DDMMYY|MMDDYY

Output parameters

RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, INQUIRE_DATE_FORMAT function

The INQUIRE_DATE_FORMAT function of the KETI gate is used to return the current date format.

Input parameters

None.

Output parameters

DATE_FORMAT
is the current default date format for the timer domain. It can have any one of these values:
YYMMDD|DDMMYY|MMDDYY
RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, INQ_LOCAL_DATETIME_DECIMAL function

The INQ_LOCAL_DATETIME_DECIMAL function of the KETI gate is used to return the local date, and the local time in decimal format.

Input parameters

None.

Output parameters

DECIMAL_DATE
is an 8-character date in the format determined by FULL_DATE_FORMAT.
DECIMAL_TIME
is the current local decimal time in the format HHMMSS.
DECIMAL_MICROSECONDS
is the 6-character microseconds portion of DECIMAL_TIME.
FULL_DATE_FORMAT
is the current full date format determined by the default date format of the timer domain. It can have any one of these values:
YYYYMMDD|DDMMYYYY|MMDDYYYY
RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, CONVERT_TO_DECIMAL_TIME function

The CONVERT_TO_DECIMAL_TIME function of the KETI gate is used to convert dates and times in the internal store clock (STCK) format to decimal format.

Input parameters

STCK_TIME
is a doubleword containing a date and time in STCK format.

Output parameters

DECIMAL_DATE
is an 8-character date in the format determined by FULL_DATE_FORMAT
DECIMAL_TIME
is the current local decimal time in the format HHMMSS
DECIMAL_MICROSECONDS
is the 6-character microseconds portion of DECIMAL_TIME
FULL_DATE_FORMAT
is the current full date format determined by the default date format of the timer domain. It can have any one of these values:
YYYYMMDD|DDMMYYYY|MMDDYYYY
RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KETI gate, CONVERT_TO_STCK_FORMAT function

The CONVERT_TO_STCK_FORMAT function of the KETI gate is used to convert times and dates to STCK format.

Input parameters

DECIMAL_TIME
is the current local decimal time in the format HHMMSS.
[DECIMAL_DATE]
is an optional 8-character date in the format determined either by FULL_DATE_FORMAT or by the default for the timer domain if FULL_DATE_FORMAT is omitted.
[INSTANCE]
is required only if DECIMAL_DATE is omitted. It can have either of these values:
LAST|NEXT
[FULL_DATE_FORMAT]
is the current full date format. It can have any one of these values:
YYYYMMDD|DDMMYYYY|MMDDYYYY

Output parameters

STCK_TIME
is a doubleword containing the GMT STCK value corresponding to the input local time.
RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

KEXM gate, TRANSACTION_INITIALISATION function

The TRANSACTION_INITIALISATION function of the KEXM gate is used to perform kernel initialisation during XM task-reply.

Input parameters

TRANSACTION_TOKEN
is a token identifying the transaction for which kernel initialization is to be performed.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any one of these values:
OK|INVALID|KERNERROR|PURGED|DISASTER

4.
Only the following KEDS functions are traced:

SEND_DEFERRED_ABEND, START_PURGE_PROTECTION, STOP_PURGE_PROTECTION, and PROCESS_KETA_ERROR.

5.
The CREATE_TASK function is processed by the DFHKETA module; all other KEDS functions are processed by the DFHKEDS module.
6.
Task table: A task table is a logical block of tasks, allocated together by the Kernel domain, and used to simplify the process of dynamically adding new tasks. Task tables are chained together, and vary in number.
7.
Task table: A task table is a logical block of tasks, allocated together by the Kernel domain, and used to simplify the process of dynamically adding new tasks. Task tables are chained together, and vary in number.

[[ Contents Previous Page | Next Page Index ]]