Previous Topic: Viewing Dumps from TSO/ISPFNext Topic: Utilities


Advanced Techniques

Several easy-to-master techniques will make your dump viewing sessions more productive. It is recommended that you set your PF keys to some of the CA SymDump System commands to facilitate their use.

The Keep Window and the Electronic Notepad can help with your diagnostic procedure. Learn to use the KEEP command to copy any data line from any display into your Keep Window. The NOTES command enables you to maintain notes for each dump as you view.

Use the Auto-Mapping to view any storage location with labels retrieved from the appropriate OS or CICS control block. Learn how the EQUATE command can be used to create symbols and assign maps to storage locations, and how the HOME command can help you to control your movement through the display levels.

Details of these advanced techniques are described in this chapter.

This section contains the following topics:

Using PF Keys

Mapping Dump Storage Location

Using Symbols

Using the Keep Window

Using the Electronic Notepad

Display Levels

Using PF Keys

Using PF keys to execute some of the more common commands helps save time and reduce keystroke errors when entering commands.

To set your PF keys, type KEYS on any CA SymDump System command line and press ENTER. A standard PF keys dialog appears, enabling you to change your PF key settings for the product.

The KEYS dialog is shown here:

                  PF Key Definitions and Labels - Primary Keys  Command ===>                                                                     More:     +  Number of PF Keys . . . 24                          Terminal type  . . 3278  Enter "/" to select . .           (Enable EURO sign)    PF1 . . . HELP  PF2 . . . SPLIT  PF3 . . . END  PF4 . . . DUMP  PF5 . . . RFIND  PF6 . . . MAP  PF7 . . . UP  PF8 . . . DOWN  PF9 . . . SWAP  PF10  . . LEFT  PF11  . . RIGHT  PF12  . . RETRIEVE    PF1  Label  . .            PF2  Label  . .            PF3  Label  . .  PF4  Label  . .            PF5  Label  . .            PF6  Label  . .  PF7  Label  . .            PF8  Label  . .            PF9  Label  . .  PF10 Label  . .            PF11 Label  . .            PF12 Label  . .

Using the Keys dialog, you can assign any PF key to any dump viewer command. It is probably best to only reassign those keys whose functions are not used by the dump viewer.

For example, some of your PF keys may already be assigned to some of these functions, which are used by the dump viewer:

However, you can replace the following keys, which are not used by CA SymDump System, without interfering with other functions:

The TSO/ISPF dump viewer executes under its own unique application ID, so each user maintains separate key settings that affect only the use of dump viewer.

Using PF keys to execute cursor-sensitive commands also gives you point-and-shoot access to dump information. The CA SymDump System dump viewer for TSO/ISPF offers the following cursor-sensitive commands:

CMSG

Request CICS Message Help

DUMP

Display dump storage

DISASSEM

Disassemble program storage

KEEP

Copy data to the Keep Window

MAP

Map control blocks

For any of these commands, the cursor position can be used to select the command argument required to complete the command. Simply place the cursor on any token in the data portion of any display and press the PF key assigned to the command!

You can also enter any of these commands manually on the command line without operands. The data at the current cursor location is used as the command argument.

Example

Select any dump for viewing. Then select the Abend Summary report from the Favorites folder. Place your cursor on the current TCB address shown in the report and press the PF key that you have assigned to the DUMP command. The storage for the current TCB displays.

You get the same result by typing DUMP on the command line, placing your cursor on the current TCB address and pressing ENTER.

Because the current TCB address is also a known control block, try the same example using the MAP command instead of DUMP. The same storage is displayed, but this time it is mapped using the appropriate mapping DSECT for the TCB control block.

The ability to map control blocks without specifying a MAP name on the command is called Auto-Mapping and is available for all of the known OS and CICS control blocks listed in the dump tree.

Mapping Dump Storage Location

A map is a dummy section (or DSECT) that can be used with the MAP command to format an area of virtual storage within a dump. CA SymDump System provides built‑in maps for many of the OS and CICS control blocks. After loading any dump, use the LISTMAPS command to display the names of the loaded maps. Use the LOADMAPS command to load maps from a member in a map library. Use the MAP command to format the contents of virtual storage using one of the loaded maps.

The ability to map control blocks without specifying a MAP name on the command is called Auto-Mapping and is available for all of the known OS and CICS control blocks listed in the dump tree.

Use Auto-Mapping to map any storage location to the appropriate OS or CICS control block automatically. You do not need to know in advance the name of the mapping DSECT or even the type of control block being mapped. For all known control blocks in the dump, this is handled automatically for you.

You can use Auto-Mapping from any display that supports the MAP command. Here are some typical uses:

Note: If the storage address does not correspond to a known OS or CICS control block, it cannot be mapped automatically. Only those control blocks listed in the dump tree are known. However, you can always use the MAP command to map any storage location using a specified map name.

For more information about the commands related to mapping storage, see "Dump Viewer Commands".

Using Symbols

A symbol is simply a label used to identify a storage address within a dump. Some symbols are built-in for every dump, and others can be user-defined.

Once defined, a symbol may be used as part (or all) of the address argument for any DUMP, MAP, DISASSEM, or EQUATE command. The symbol is automatically replaced by its assigned value during address resolution.

Use the EQUATE command to define a symbol, assign it to a storage location, and optionally identify a map name for Auto-Mapping. Whenever a dump is loaded, built-in symbols are provided for the PSW, registers, and current TCB address. All of the built-in and user-defined symbols are stored in your profile and are preserved across viewing sessions.

Use the SYMBOLS command to list the currently defined symbols, and use the DROP command to remove a previously defined symbol.

Built-in Symbols

CA SymDump System provides the following built-in symbols for each dump:

PSW

The PSW at the time the dump was captured.

CURRTCB

The address of the TCB which requested the dump.

R0 thru R15

The general purpose registers at the time of the dump.

Examples

Symbols are used in the following examples:

To disassemble the instruction at the PSW address at the time of the dump:

DISASSEM PSW
or
DISASSEM PSW-2

To map the TCB at the time of the dump:

MAP CURRTCB

Note: Most OS control blocks can be mapped using Auto-Mapping and therefore do not require a map name.

To dump the register savearea at the time of the dump:

DUMP R13

To dump the previous register savearea:

DUMP R13+4?

To map the previous register savearea:

MAP R13+4?,SAVEAREA

Using the Keep Window

The Keep Window is a dynamic area located just above the highlighted header line on any display. You can copy any data line from any display into this area, causing that data line to remain in view even after you exit the display.

To add a data line to your Keep Window, first type KEEP on the command line, then place your cursor on the data line and press ENTER. Alternatively, if you have set a PF key for KEEP, place your cursor on any data line and press that key. The data line is added automatically to your Keep Window.

This is the Keep Window:

CA SymDump System V9.1 --------- Dump Tree ---------------------- Line 1 of 12 Command ===>                                                   Scroll ===> CSR  ------------------------------------------------------------------------------- System    XAE1            Asid      01FA            UserId    MIKED             JobName   MIKED530        Date      2009/07/11      Time      16.08.53          Program   DFHSIP          Offset    000AC970        Code      SM0103            --------------------------------- (Keep) -------------------------------------- PSW at time of error:        078D2000 95DEF5F0      DFHSIP  +AC970                 Reg 0  = 000000B8  PSA+B8             Reg 8  = 15EB67D8  E-PVT                  Reg 1  = 16A42680  E-PVT              Reg 9  = 16A4270C  E-PVT                  Reg 2  = 15EB67D8  E-PVT              Reg 10 = 16A4270C  E-PVT                  Reg 3  = 95DEDDA8  DFHSIP+EDDA8       Reg 11 = 16A41D67  E-PVT                  Reg 4  = 16A42580  E-PVT              Reg 12 = 0005C680  PVT                    Reg 5  = 15DEEDA7  DFHSIP+EEDA7       Reg 13 = 16A42580  E-PVT                  Reg 6  = 15DEFDA6  DFHSIP+EFDA6       Reg 14 = 007E1540  JSTCB-2F8              Reg 7  = 16A419E4  E-PVT              Reg 15 = 00000000  PSA                 ------------------------------------------------------------------------- Lvl 2 Cmd  Address     Description                                                     .             - Job=MIKED530                                                    .             - |-Favorites                                                     .               | |-Abend Summary                                               .               | |-CICS Message Help                                           F1=HELP      F2=SPLIT     F3=END       F4=DUMP      F5=RFIND     F6=MAP    F7=UP        F8=DOWN      F9=SWAP     F10=LEFT     F11=RIGHT    F12=RETRIEVE 

The size of the window is dynamic depending on the number of data lines added.

Note: When the window contains no data, it does not appear.

Each user has a separate Keep Window for each dump they view. The contents of each is saved in their user profile when a dump viewing session is ended, and is restored to the same state the next time they select the same dump for viewing. You can also use the KEEP command from the Dump Index display, which is maintained separately, it is not preserved across sessions, and cannot be viewed while a dump is loaded.

Removing a Data Line

To remove a data line from the keep window:

  1. Type KEEP on the command line.
  2. Place your cursor on the line being removed.
  3. Press ENTER.

Note: If you have a PF key set for KEEP, you can use that key instead of typing the command.

Use REMOVE as a synonym for KEEP to remove a line of data when the cursor is inside the window area.

Hiding the Keep Window

To prevent your Keep Window from displaying, type KEEP OFF on the command line and press ENTER.

To restore the display, type KEEP ON. The status of your window display (ON or OFF) is also saved in the user profile for each dump you view.

When KEEP OFF is specified, the data in your Keep Window is not lost; it is simply not displayed until the window display is reactivated. While KEEP OFF is in effect, data cannot be added or removed from the window.

Using the Electronic Notepad

The Electronic Notepad allows each user to maintain notes for each dump they view. The notepad is free-format and dynamically sized, allowing you to enter comments while viewing the dump.

Notepad records are 126 bytes wide to fill a 132-column screen format, and are horizontally scrollable for 80-column displays. You can enter any kind of data in the notepad because there is no syntax checking.

To open a notepad from the Dump Index display, place an N in the Cmd column next to the dump entry and press ENTER. You can also type NOTES on the command line and press ENTER. Then, when prompted enter the name of the reports data set for the dump.

To open a notepad for an open dump while viewing, type NOTES on the command line and press ENTER.

The first time you open the notepad for a new dump, the following message appears:

CA SymDump System V9.1 --------- Dump Index ---------------------- Line 1 of 9 Command ===>                                                   Scroll ===> CSR  ------------------------------------------------------------------------------- Index Dsna +------------------------------------------------------+             ---------- |                                                      | ----- Lvl 1 Cmd  Syste | No notes were found for the dump you selected.       |   Time       .   E100  |                                                      |   10.25.57   N   XAE1  | Press ENTER to start a new notepad for dump data set |   16.08.53   .   XAE1  |                                                      |   16.01.01   .   E100  | ===> PUBLIC.DUMPVIEW.CB7E95E2.A30A0CE3               |   11.15.05   .   E100  |                                                      |   14.20.19   .   TEST  | Press END to cancel the notes request.               |   07.32.55   .   XAE1  |                                                      |   13.27.11   .   XE44  +------------------------------------------------------+   12.18.16   .   XE44      009B  CARAC120  COBDEMO   0001B8C  AP0001  2009/03/31  16.40.52  -------------------------------------------------------------------------------

Press Enter to create a new notepad for the dump.

The Electronic Notepad is shown here:

CA SymDump System V9.1 --------- Notes -------------------------- Line 1 of 13 Command ===>                                                   Scroll ===> CSR  ------------------------------------------------------------------------------- Dump Dsname: PUBLIC.DUMPVIEW.CB7E95E2.A30A0CE3                                  Last Update: 2009/07/18 @ 16:09:15                                              ------------------------------------------------------------------------- Lvl 4 Cmd  ....+....1....+....2....+....3....+....4....+....5....+....6....+....7....  .                                                                               .   Active Task:      Task #0037  Tran STGV  Term G001  User CICSUSER           .                     Date 07/11/2009 at 16.08.53                               .                                                                               .   Storage Overlay:  UDSA at 001C0440 for 0000380 bytes.                       .                                                                               .   EXPLANATION:  A storage violation has been detected by the                  .   storage violation trap, which may be enabled via the CHKSTSK                .   or the CHKSTRM system initialization parameters or via the                  .   CSFE transaction.  The code X' code ' is the exception                      .   trace point ID which uniquely identifies the type of storage                .   violation detected.                                                         .                                                                              -------------------------------------------------------------------------------                                                                                  F1=HELP      F2=SPLIT     F3=END       F4=DUMP      F5=RFIND     F6=MAP   F7=UP        F8=DOWN      F9=SWAP     F10=LEFT     F11=RIGHT    F12=RETRIEVE

Use the Cmd column to insert or delete lines from notepad using the I or D line commands, respectively.

The content of the notepad is stored in your user profile when you close the notepad, and is restored from the profile whenever you open the notepad.

Display Levels

The level number shown in the upper right corner of the display indicates how many display levels are active. When you enter the END command, the display terminates and the active display at the previous level reappears.

A home state is a display that remains active (that is, it continues to occupy a display level) until you explicitly terminate the display with an END command. Therefore, entering a command or requesting a new display from a home state level always creates a new level, incrementing the level number by one. The same action from a non-home state results in a new report replacing the existing report without adding a new level.

A home state is automatically created for the Dump Index display, the Dump Tree display, and any display created by entering a command (or a line command) from either of those displays. The Dump Index display is always level one. When you select a dump from the index, the Dump Tree for the selected dump appears as the level two display. Selecting any item from the tree or entering any command on the command line from the tree results in a level three display. These are automatic home state levels.

Use the HOME command to create a home state level for any other display.

Examples

From the Dump Tree display (home state level two)

  1. Select the Abend Summary report from the Favorites folder.

    The report appears as level three, also a home state because it was selected from Dump Tree display.

  2. Type SYMBOLS to display the currently defined symbols. A new level (four) is created for this display because it was created from a home state.

    Level four is not a home state because it was not created from either the Dump Tree or the Dump Index display.

  3. Type STATUS to display the product status. Notice that the STATUS report replaces the SYMBOLS report in level four.

Note: Pressing the END key returns you to the previous level (three), which contains the Abend Summary report. The SYMBOLS report is no longer active, having been replaced in level four by the STATUS report.

In this example, to force the SYMBOLS report to be a home state:

  1. Type HOME while viewing the report.
  2. The STATUS report now occupies a new level (five).

Note: Pressing the END key from the STATUS report returns you to the SYMBOLS report.