External subsystem trace

You enable the external subsystem trace by using the /TRACE SET ON TABLE SUBS command. When you specify OPTION LOG, IMS writes the trace externally as type X'67FA' records.

The External Subsystem (ESS) trace entries help you analyze problems for either:

  • A connection problem between the IMS control region and the external subsystem (for example, Db2 for z/OS®)
  • Any problem between the IMS dependent region and the external subsystem

The following figure illustrates the external subsystem (ESS) trace record format. Each of the sixteen words is 4 bytes long. Words 0 and 1 hold the standard ESS trace record prefix. The Module ID and Sub function (WORD 1) determines what information appears in words 2 through 15.

Figure 1. External subsystem (ESS) trace record format
Graphic shows a trace record as a 16 column, 1 row table. Column 1 is labeled "WORD 0" and also shows a 1 byte field labeled "I," a 1 byte field labeled "R," and a 2 byte field labeled "SEQ NUM"; column 2 is labeled "WORD 1" and also shows a 2 byte field labeled "MOD ID" and a 2 byte field labeled "SUB FUNC"; columns 3 through 16 are labeled "WORD 2" through "WORD 15." WORD 0 and WORD 1 are labeled as the "STANDARD PREFIX" area. WORD 0 through WORD 15 are labeled as the "VARIABLE SECTION."
where
represents
I
This 1-byte field contains the hexadecimal trace record ID. Two possible ID values are X'57' and X'58'. The X'57' record ID is created by a module that executes in the IMS control region (for example, the ESS mother task DFSIESI0). The X'58' record ID is created by a module that executes in an IMS dependent region (for example, DFSESCT0).
R
This 1-byte field is reserved.
SEQ NUM
This 2-byte field contains the hexadecimal trace record sequence number assigned by the IMS trace component.
MOD ID
This 2-byte field contains a hexadecimal value that identifies the module that created the trace record. Each ESS module has an associated module ID. Macro DFSESFC contains the complete list of IDs.
SUB FUNC
This 2-byte field contains a hexadecimal value that identifies the subfunction that created the trace record within the module. For example, if a module creates a trace record in each of five internal subroutines, each subroutine has a unique SUB FUNC ID.

The following table shows:

  • The ID of the module that created the trace record
  • The ID of the subfunction (within the module) that created the record
  • The name of the module that created the record
  • A description of the event being traced

Table 1. Module ID and subfunction table
Module ID Subfunction Module Description
X'0015' X'0015' DFSESS40 ESS message service exit
X'0016' X'0014' DFSESS30 ESS logging exit
X'0017'

X'0011'
X'0012'
X'0040'
X'0041'

DFSESS10

IMS control region identify
Dependent region identify
Control region identify error
Identify error subsystem stopped

X'0018' X'0013' DFSESS20

ESS termination exit (if X'57')
Dependent region ESS term
(if X'58')

X'0285' X'0010' DFSESD80 Dependent region ESS initialization
X'0288' X'0001' DFSESSO0 Dependent region ESS sign on
X'0289' X'0003' DFSESD50 Dependent region ESS signoff
X'0290' X'0005' DFSESCT0 Dependent region ESS create thread
X'0291'

X'0002'
X'0003'
X'0004'

DFSESD50

Dependent region ESS term thread
Dependent region ESS term thread
region
ESS signoff Dependent region ESS
term identify

X'0292' X'0004' DFSESD50

Dependent region ESS term identify

X'0293' X'0007' DFSESAB0 Dependent region ESS ABORT
X'0294' X'0008' DFSESP10 Dependent region ESS commit prep
X'0295' X'0009' DFSESP20 Dependent region ESS commit cont
X'0307'

X'0016'
X'0017'
X'0018'

DFSFESP0

ESS commit processor entered
ESS commit processor exited
ESS commit processor R-I-D request

X'0402' X'0020' DFSESI30 IMS control region daughter identify
X'0021' IMS control region resolve-in-doubt
X'0022' IMS control region ESS CMD
X'0023' IMS control region ESS RRE
X'0024' IMS control region ESS ECHO
X'0025' IMS control region terminate identify
X'0026' IMS control region terminate subsystem
X'0027' IMS control region /STOP CMD
X'0028' IMS control region ESS term record
X'0029' IMS control region ESS shutdown
X'0030' IMS control region ESS termination
X'0031' IMS control region ESS AWE error
   
X'0403' X'0019' DFSESI50 Control region ESS initialization
X'0404' X'0042' DFSESI60 Control region ESS R-I-D exit
X'0405' X'0032' DFSESI70 Control region ESS /CHANGE
X'0409'

X'0001'
X'0002'

DFSIESI0

Mother ITASK request
Control region ESS attach

X'0506'

X'0006'
X'0019'
X'0020'

DFSESPR0

Dependent region ESS program
request handler
Dependent region ESS program
request recursive call
Dependent region ESS Subsystem
Not Operational (SNOX)