Dump utility program

The dump utility program (DFHDUnnn) runs offline (in batch mode) to produce a printout of CICS® transaction dumps from a CICS transaction dump data set (DFHDMPA or DFHDMPB). The dump utility program is renamed with a unique release identifier every CICS release. For example, its name is DFHDU760 in CICS TS beta.

Dump utilities (DFHDUnnn and DFHPDnnn) lists the name of the dump utility program by release.

Design overview

The dump utility program operates in batch mode while one of the dump data sets is closed. Each area, program, and table entry is identified, formatted, and printed separately, with both actual and relative addresses to facilitate analysis. You can select single or double spacing of dumps when the dump utility program is executed.

The CICS dump data set (DFHDMPA or DFHDMPB) contains a number of CICS transaction dumps. These are produced as the result of a transaction abend or a user-application EXEC CICS DUMP TRANSACTION request.

The dump utility program runs as a stand-alone program in batch mode to format and print the contents of a transaction dump data set. Parameters specified on the SYSIN data set can be used to print only selected dumps or an index of the dumps in the data set.

For further details about the dump utility program, see Dump utilities (DFHDUnnn and DFHPDnnn).

There are three sources of data for the dump utility program:
Parameters on JCL EXEC statement
A character string of keywords that can be specified to control the layout and format of the dumps.
SYSIN
Records specifying the criteria to be used in selecting which of the dumps on the data set are to be printed.
DFHDMPDS
The transaction dump data set.
There are two output files:
DFHPRINT
The print file for the formatted transaction dump.
DFHTINDX
The print file for the index of dumps on the data set.

Processing flow of the dump utility program

Figure 1 shows the dump utility program interfaces.
Figure 1. Dump utility program interfaces
This figure shows how the dump utility program works, as explained in the text.
The overall flow of the processing within the dump utility program is as follows. Unless otherwise indicated, all processing is performed by DFHDUPR, the main component of this utility program.
  1. Process the EXEC parameters if they are present.
  2. Call DFHDUPP to open the print data set DFHPRINT.
  3. Open the dump data set DFHDMPDS.
  4. Read the dumps from DFHDMPDS. For each dump, there are four categories of records:
    Dump header record
    Call DFHDUPS to see whether this dump is required for printing. On the first time through, DFHDUPS reads the selective print information from SYSIN. DFHDUPS also calls DFHDUPH to add the dump to the dump index data set DFHTINDX. DFHDUPH opens DFHTINDX on its first invocation.
    Module index records
    DFHDUPM is called to accumulate the module index information in a table in main storage.
    Other data records
    The data is formatted into print lines and DFHDUPP is invoked to write them to DFHPRINT.
    Dump trailer record
    DFHDUPM is invoked to sort and format the module index records. DFHDUPP is called to write them to DFHPRINT.
  5. When the end of the dump data set is encountered:
    1. DFHDUPP is called to close DFHPRINT.
    2. DFHDUPH is called to close DFHTINDX.
    3. DFHDUPR closes DFHDMPDS.
  6. The dump utility program terminates.

Modules

Module Function
DFHDUPR Controlling routine, responsible for reading information from the dump data set DFHDMPDS.
DFHDUPS Receives the address of a dump header record from the dump data set, and decides whether this dump fulfills the criteria for printing. On first entry, reads and stores the selective print parameters from SYSIN.
DFHDUPP Is responsible for all access to the print file DFHPRINT, namely for OPEN, CLOSE, and PUT requests.
DFHDUPH Writes line to dump index for each dump header record encountered. On first entry, opens the index file DFHTINDX.
DFHDUPM Invoked for each module index entry found to save information. Invoked when dump trailer record found to format and print the complete module index.

Copybooks

Copybook Function
DFHDUPSC Contains the definition of the parameter list passed to DFHDUPS.
DFHDUPMC Contains the definition of the parameter list passed to DFHDUPM.
DFHDUPPC Contains the definition of the parameter list passed to DFHDUPP.

Exits

Global user exit points are not applicable to offline utilities.

Trace

Trace points are not applicable to offline utilities.