Design overview
The controlling program (DFHDU710, DFHTRDUF, DFHTRPRA, or DFHTRPRG) is responsible for acquiring the trace formatting control area (TRFCA), which is used for communication between the different routines.
As far as possible, the necessary code is constructed of routines that can run in all four environments. Subroutines required by the common code that cannot themselves be common (such as the line print subroutine) have their addresses placed in the TRFCA by the controlling program.
The controlling routines are:
- DFHDU710
- The dump utility program used to print transaction dumps. Invokes DFHTRFPB for each internal table block.
- DFHTRDUF
- The system dump formatting routine for the trace domain. Invokes DFHTRFPB for each internal table block.
- DFHTRPRA
- The main routine of the trace utility program DFHTU710 used to print an auxiliary trace data set. Invokes DFHTRFPP to encode selective print parameters. Invokes DFHTRFPB for each auxiliary trace block.
- DFHTRPRG
- The main routine of the GTF format appendage for CICS® entries (format ID X'EF') AMDUSREF (alias DFHTR710). Invokes DFHTRFPP to encode selective print parameters. Invokes DFHTRFFE for each trace entry.
A noncommon subroutine required in all four environments is:
- TRFPRL
- Print a specified character buffer. This is contained in the controlling program.
The common routines required in more than one environment are:
- DFHTRFPP
- Process parameters. Passed a character string, encodes the string as selective print parameters into the TRFCA (for DFHTRPRA and DFHTRPRG only). See Dump utilities (DFHDU700 and DFHPD700) for details of the selective print parameters.
- DFHTRFPB
- Process block. Processes a trace block from a dump or auxiliary trace data set, calling DFHTRFFE for each entry in the block.
- DFHTRFFE
- Format entry. Passed a trace entry, it calls DFHxxTRI, TRFPRL, and DFHTRFFD to produce the formatted entry.
- DFHTRFFD
- Format data. To format and print the trace data fields of a particular entry in hex and character form. Calls TRFPRL to print each line.
- DFHxxTRI
- The interpretation routine for the xx domain. Builds the interpretation string for a particular entry given the trace point ID and the data fields from the entry. The AP domain routine DFHAPTRI calls one of the interpretation routines DFHAPTRx. Each of these is responsible for a functional component of the AP domain.
- DFHTRIB
- The interpretation build program. Adds printable data to the interpretation buffer in the TRFCA as requested by the interpretation routine.
- DFHCDCON
- The interpretation of some trace entries requires analysis of domain call parameter lists. Converts a hexadecimal parameter list into a printable list of keywords. If the resulting interpretation string would have been more than 1024 bytes long if all keywords were included, the warning ‘<<INTERPRETATION OVERFLOWED>>’ is printed with the string.
- DFHxxyyT
- The data file for an xxyy format parameter list that is used by DFHCDCON to translate the hexadecimal parameter list into a printable list of keywords.
The components of the trace formatting function are shown in Figure 1.
Figure 1. Trace formatting components
