Creating a detailed report using the load module scanner

You can request a detailed report from the scanner by editing and running the job DFHEILMS in SDFHSAMP. The detailed report gives a list for each module to show which of the specified commands it contains, at which offsets, including EDF information if available.

About this task

The job to request a detailed report includes statements identifying a filter to be used (DFHFLTR), and (optionally) a data set containing a list of relevant modules to be scanned (DFHLIST).

Procedure

  1. Ensure that the load library to be scanned does not contain concatenated data sets.
  2. Edit the JOB accounting parameters as appropriate.
  3. Ensure that your region size is appropriate for the number of load modules that you want to scan. Do not specify REGION=0M. See Points to bear in mind when using the load module scanner for more information.
  4. On the PARM statement, specify DETAIL. If you want to scan all modules in the load library, specify ALL as well. If you want to restrict the detailed scan by using a data set containing a list of modules identified during a summary scan of the load library, do not specify ALL.
    Read syntax diagramSkip visual syntax diagramPARM=DETAIL,ALL
    DETAIL
    Specifies that a detailed scan is required. The extent of the scan is defined by the ALL parameter.
    ALL
    Specifies that all modules in the load library are to be scanned for the requested EXEC CICS® commands. If ALL is omitted, only those modules listed in the data set specified on the DFHLIST DD statement are to be scanned.
  5. Edit the STEPLIB, DFHIN, SYSPRINT, DFHFLTR and DFHLIST statements as required.
    You can restrict the modules to be scanned during a detail scan, by using a data set containing a list of modules identified during a summary scan. If you want to do this, specify the name of the data set on the DFHLIST statement, and also ensure that the load library named in DFHIN is the same as the load library named when the summary scan was run.
    STEPLIB DD statement
    Specifies the name of the load library in which you have installed the scanner program, DFHEISUP.
    DFHIN DD statement
    Specifies the name of the load library to be scanned. This should not contain concatenated data sets. The DFHIN DD statement accepts both PDS and PDSEs. If you use the DFHLIST DD statement to name a data set created during a summary scan, ensure that DFHIN is set to the same location as when the summary scan was run. The scanner looks for the modules listed in DD DFHLIST in the location specified by DD DFHIN.
    SYSPRINT DD statement
    Specifies the destination for the detailed report.
    DFHFLTR DD statement
    Specifies the input file for the filter, containing details of the commands in which you are interested. CICS provides the following sample tables in the SDFHSAMP library:
    • DFHEIDBR contains the filter set for commands that are not supported by the 3270 bridge.
    • DFHEIDTH contains the filter set for commands that give access to shared storage. The use of these commands could make a program not threadsafe, unless it has the necessary synchronization logic in place to ensure serialization and prevent concurrent update.
    • DFHEIDAL contains the filter set for all possible commands.
    • DFHEIDNT contains the filter set for CICS commands that are not threadsafe and will cause a switch to the QR TCB. This could influence performance when trying to run in the Open Transaction Environment.
    See Creating a filter input file for the load module scanner for information on how to create your own filter input file.
    DFHLIST DD statement
    Specifies the name of an optional data set containing a list of the modules to be scanned. The modules in the list are those that potentially include the commands you specified in your filter. The data set can be created during a summary run of the scanner using the same filter, and can be edited — see Creating a summary report using the load module scanner for the procedure to create the data set. The file contains the fully qualified data set name and the member name of each module to be scanned. Each module name must appear on a separate line. All the modules must be within the load library that you are scanning (the PDS specified in the DFHIN DD statement).

    If you want to perform a detail scan on all the modules in the load library, specify ALL on the PARM statement, and change the DFHDTL DD statement to specify //DFHLIST DD DUMMY.

Example

Figure 1 shows an example of a job to run a detailed scan, using the sample command list DFHEIDBR as the filter input file.
Figure 1. Example of a job to run a detailed scan
 //DFHSCNR  JOB (accounting information)                       
 //DFHSCAN    EXEC PGM=DFHEISUP,PARM=('DETAIL'),REGION=512M
 //STEPLIB  DD DSN=HLQ.SDFHLOAD,DISP=SHR                   
 //SYSPRINT DD SYSOUT=*                                    
 //SYSERR   DD SYSOUT=*                                    
 //* Filter file, supplied by user, or from samples data set     
 //DFHFLTR  DD DSN=HLQ.ADFHSAMP(DFHEIDBR),DISP=SHR               
 //* Module list, supplied by user, used during detail runs.     
 //DFHLIST  DD DSN=HLQ.MODLIST,DISP=SHR  
 //* PDS containing loadmodules to be scanned                    
 //DFHIN    DD DSN=HLQ.SDFHLOAD,DISP=SHR
Figure 2 shows the contents of a detailed report.
Figure 2. Example of a detailed report produced by the scanner
  CICS LOAD MODULE SCANNER UTILITY                                   
SCAN PERFORMED ON Tue Jun  6 08:47:51 2000 USING TABLE RSTABLE1.3 

DETAILED LISTING OF UTL.CL717.LOAD             
                                                         
Module Name        DFHLMS00                                            
Module Language    Assembler                                           
Offset/EDF         Command                                             
-----------------  ------------------------------------------          
00000648/no-edf    ISSUE ERROR STATE CONVID                            
00000668/no-edf    LOAD PROGRAM                                        
00000677/no-edf    LOAD PROGRAM HOLD                                   
00000686/no-edf    LOAD PROGRAM LENGTH                                 
00000695/no-edf    LOAD PROGRAM FLENGTH                                
00000704/no-edf    LOAD PROGRAM LENGTH HOLD                            
00000713/no-edf    LOAD PROGRAM FLENGTH HOLD                           
00000722/no-edf    WRITEQ TS FROM LENGTH QUEUE AUXILIARY NUMITEMS      
00000731/no-edf    WRITEQ TS FROM LENGTH QUEUE AUXILIARY               
00000740/no-edf    WRITEQ TS FROM LENGTH QUEUE MAIN                    
00000749/no-edf    SEND TEXT FROM LENGTH TERMINAL                      
00000764/no-edf    SEND TEXT FROM LENGTH L40 TERMINAL                  
00000779/no-edf    SEND TEXT FROM LENGTH L64 TERMINAL                  
00000794/no-edf    SEND TEXT FROM LENGTH L80 TERMINAL                  
00000809/no-edf    RETURN                                              

Module Name        INTROC                                              
Module Language    COBOL                                               
Offset/EDF         Command                                             
-----------------  ------------------------------------------          
00000174/00085     ADDRESS COMMAREA                                    
00000204/00164     LINK PROGRAM COMMAREA LENGTH                        
00000221/00132     RETURN                                              
00000238/00127     RETURN                                              
00000255/00112     RETURN                                              
00000272/00106     RETURN                                              
00000289/00100     RETURN                                              
00000306/00080     RETURN                                        
      
Total possible commands located = 23                          
                                                                 
LOAD LIBRARY STATISTICS                  
                                          
Total modules in library                             =      2   
Total modules Scanned                                =      2    
Total CICS modules/tables not scanned                =      0    
Total modules possibly containing requested commands =      2

Each detailed report contains a section for each module, with the following details:

  • A header part for each module, giving its name and language.
    Note: For both detailed and summary reports, the identified language of the module is based on the language of the first identified command. If the module is a mixed language module, only the first located language will be reported. In addition, if the first identified command is a false hit, the language for that module will be reported incorrectly.
  • A line for each specified command located, giving:
    • The offset of the command's Arg0 declaration from the start of the load module. (This offset is in decimal format.) Typically, a command's Arg0 declaration is in a different part of the load module from the actual command, so the offset does not indicate where the command is located.
    • If available, the EDF line number at which the command was located, otherwise no-EDF is returned.
    • What the command appears to be, for example, DELETEQ TS QUEUE. This information includes identified specified parameters.
    In a program written in Assembler, identical commands using identical parameters share the same Arg0 in the literal pool. DFHEISUP only reports one of these identical commands.
  • The total count of the number of possible commands located.
  • Library totals, as with the summary report, but only for those modules selected for the detailed run.