FABADA1 SYSIN DD data set

The SYSIN DD data set contains the FPB user's description of the processing to be done by module FABADA1. It describes the database and area to be analyzed, and it contains optional user's requests that further define the operating mode.

This topic contains product sensitive programming interface information.

Syntax of the control statement

FABADA1 requires a control statement.

Keywords and the associated values can be coded in free format (columns 1 - 72), provided certain syntactical coding rules are followed:

  1. If specification of a keyword value is required, the keyword must be separated from its associated value by an equal sign. The equal sign must not be preceded by blanks, but can be followed by one or more blanks. The value must be separated from the next keyword by a blank, a comma, or a comma followed by one or more blanks.
  2. For keywords that do not have associated values, the keyword must be separated from the next keyword by a blank, a comma, or a comma followed by one or more blanks.
  3. In case of duplicate keywords, the last one coded is used.

Format

This control-statement data set usually resides in the input stream. However, it can also be defined as a sequential data set or as a member of a partitioned data set. It must contain 80-byte fixed-length records. Block size, if coded, must be a multiple of 80.

Control records can be coded as shown in the following figure.

Figure 1. FABADA1 SYSIN DD data set
  //SYSIN DD *
    DBDNAME=VRSDSRF,AREA=VRSTSS1,VSAM,STATS,TYPRUN=RPT
    SDEP,TBLENTRY=70000,SPTFALL
  /*

Record format

There is only one statement type in the SYSIN file. It contains the following keywords:

DBDNAME=dbdname
[AREA=areaname]
[TYPRUN={RPT|PTRSCAN|PTRALL|FS|MODEL|DATA|DATACMP}]
[VSAM]
[SDEP]
[OVRD]

[STATS]
[STATS=YES|NO]
[TBLENTRY={10000|nnnnnnnn}]
[SPTFALL] 

VSAM={YES|NO}
SDEP={YES|NO}
OVRD={YES|NO}
SPTFALL={YES|NO}
IMSCATHLQ={*NO|bsdshlq}
IMSCATACB_INPUT={CURRENT|PENDING}
DBDNAME=
This statement specifies the DBD name of the database to be analyzed. This operand must be the name of a DBD with a DEDB organization. DBDNAME is a required keyword.
AREA=
This statement specifies the area name that is to be analyzed.

The DEDB Pointer Checker determines an input data set by analyzing the combination of the VSAM keyword and AREA statement. This is done as follows:

  • If the VSAM keyword is not specified and the AREA= statement is specified, then image copy input is processed and the specified area name is used to verify that the correct image copy data set has been provided. When concatenated image copy data sets for multiple areas are used as input, this operand must be omitted.
  • If both the VSAM keyword and the AREA= statement are specified, then VSAM data set input is processed and the specified area name is used to verify that the correct area data set has been provided. When DBRC=Y is specified, then the area status in DBRC is verified.
  • If the VSAM keyword is specified but the AREA= statement is not provided, then an area name is obtained from the second CI of the VSAM data set.
  • If neither the VSAM keyword nor the AREA= statement is specified, then VSAM data set input (DARVSAM DD) is processed. If DARVSAM DD is not provided or DD DUMMY is specified, then image copy input (DFSDUMP DD) is processed.

To make DBRC=Y or area data set dynamic allocation effective, both the VSAM keyword and the AREA= statement must be specified.

TYPRUN=
This statement specifies the operating mode. The following describes the various modes supported. When the operating mode is not specified, DEDB Pointer Checker assumes the default operating mode of RPT.

The following table summarizes the functions performed for each TYPRUN= value.

Table 1. TYPRUN= values and associated functions
TYPRUN= Integrity verification Analysis and report
PTRSCAN
  • Fast scan of database integrity.
  • Optional CI Map/CI Dump report.
PTRALL
  • Fast scan of database integrity.
  • In-depth pointer analysis and resolution.
  • Optional CI Map/CI Dump report.
  • Optional Pointer Chain Reconstruction report.
FS
  • Fast scan of database integrity.
  • Optional CI Map/CI Dump report.
  • Freespace Analysis reports only.
  • Optional Reorg control statement generation.
  • Optional History file update.
  • Optional History2 file update.
  • Optional threshold analysis (free-space variables only).
RPT
  • Fast scan of database integrity.
  • In-depth pointer analysis and resolution.
  • Optional CI Map/CI Dump report.
  • Optional Pointer Chain Reconstruction report.
  • Complete analysis report generated.
  • Optional Reorg control statement generation.
  • Optional History file update.
  • Optional History2 file update.
  • Optional threshold analysis (free-space variables only).
MODEL
  • Fast scan of database integrity.
  • In-depth pointer analysis and resolution.
  • Optional CI Map/CI Dump report.
  • Optional Pointer Chain Reconstruction report.
  • Complete analysis report generated.
  • Root key value appended to data records for tuning.
  • Optional Largest Database Records report.
  • Optional Reorg control statement generation.
  • Optional History file update.
  • Optional History2 file update.
  • Optional threshold analysis (free-space variables only).
DATA
  • Fast scan of database integrity.
  • In-depth pointer analysis and resolution.
  • Segment data appended to segment information records.
    • Expanded segment data is appended if the segment edit/compression routine defined for the segment.
  • Optional CI Map/CI Dump report.
  • Optional Pointer Chain Reconstruction report.
DATACMP
  • Fast scan of database integrity.
  • In-depth pointer analysis and resolution.
  • Segment data appended to segment information records.
    • Segment data as is in CI is appended regardless of the definition of the segment edit/compression routine for the segment.
  • Optional CI Map/CI Dump report.
  • Optional Pointer Chain Reconstruction report.
PTRSCAN
When this mode is specified, DEDB Pointer Checker scans the database for pointer integrity errors without creating any output records for further analysis and reporting. Messages are generated if any pointer integrity errors are detected. The exact RBA of some errors cannot be reported in this mode.

PTRSCAN provides a very fast method of integrity verification, using minimal computer resources. Although unlikely, it is possible that some pointer errors are undetected in this mode. Use PTRALL or RPT when complete integrity verification is needed.

PTRALL
When this mode is specified, DEDB Pointer Checker scans the database and generates the segment records and the pointer information records for detecting and reporting pointer integrity errors in the database. The exact RBA of the error is reported in this mode. Any output records associated with further analysis of the database are not generated in this mode.
FS
When this mode is specified, DEDB Pointer Checker scans the database and generates only the output records required to analyze and report free space information for the database.
RPT
When this mode is specified, FABADA1 generates output records required for a complete analysis and reporting of the database. FABADA1 also performs all functions of the PTRALL mode.
MODEL
When this mode is specified, FABADA1 appends the root key value to the segment information records for tuning the database using DEDB Tuning Aid. FABADA1 also performs all functions of the RPT mode.
DATA
When this mode is specified, DEDB Pointer Checker appends the segment data to the segment information records. If the segment edit/compression routine is defined for the segment, the routine is called to expand the segment and the expanded segment data is appended. This option allows you to access the segment data from an image copy data set in physical hierarchical data sequence. Also, DEDB Pointer Checker performs all functions of PTRALL mode.

Begin product-sensitive programming interface information.

The formats of the records produced when TYPRUN=DATA are given by the mapping macro FABAMDAR. The file contains one type 1,1 record, one or more type 1,0 records, and many type 3 records.

End product-sensitive programming interface information.

DATACMP
When this mode is specified, DEDB Pointer Checker appends the segment data to the segment information records. Regardless of the definition of the segment edit/compression routine for the segment, the segment data as is in CI is appended. This option allows you to access the segment data from a physical image copy data set in physical hierarchical data sequence. Also, DEDB Pointer Checker performs all functions of PTRALL mode.

Begin product-sensitive programming interface information.

The formats of the records produced when TYPRUN=DATACMP are given by the mapping macro FABAMDAR. The file contains one type 1,1 record, one or more type 1,0 records, and many type 3 records.

End product-sensitive programming interface information.

VSAM
The VSAM keyword instructs the DEDB Pointer Checker to process the VSAM data set. This parameter must be omitted when image copy data sets are used as input.

DEDB Pointer Checker determines an input data set by analyzing the combination of the VSAM keyword and AREA statement. This is done as follows:

  • If the VSAM keyword is not specified and the AREA= statement is specified, then image copy input is processed and the specified area name is used to verify that the correct image copy data set has been provided. When concatenated image copy data sets for multiple areas are used as input, this operand must be omitted.
  • If both the VSAM keyword and the AREA= statement are specified, then VSAM data set input is processed and the specified area name is used to verify that the correct area data set has been provided. When DBRC=Y is specified, then the area status in DBRC is verified.
  • If the VSAM keyword is specified but the AREA= statement is not provided, then an area name is obtained from the second CI of the VSAM data set.
  • If neither the VSAM keyword nor the AREA= statement is specified, then VSAM data set input (DARVSAM DD) is processed. If DARVSAM DD is not provided or DD DUMMY is specified, then image copy input (DFSDUMP DD) is processed.

To make DBRC=Y or area data set dynamic allocation effective, both the VSAM keyword and the AREA= statement must be specified.

SDEP
This keyword requests DEDB Pointer Checker to verify and report any SDEP pointer integrity errors in the database. This keyword is ignored for a database that does not specify SDEP segments.

For how to process SDEP segments, see the topic "Determining how to process SDEP segments" in the IMS Fast Path Solution Pack: IMS High Performance Fast Path Utilities User's Guide.

OVRD
This keyword requests DEDB Pointer Checker to override a DBD member date (that is, the date of an ACBGEN for the DBD) and image copy date discrepancy.

FABADA1 normally terminates with an abend code of 3527 if the DBD member date is after the date of the image copy. Processing can be forced to continue by specifying OVRD keyword.

CAUTION:
If structural or physical changes have been made to the DBD, specifying OVRD keyword causes unpredictable results.
STATS
This keyword specifies that statistics and run totals are to be generated. The default is none. It is always preferable to generate run totals and statistics.
STATS=
This optional keyword parameter specifies whether DEDB Pointer Checker is to report the run totals and statistics.

'YES' specifies that DEDB Pointer Checker is to report the run totals and statistics. STATS=YES is the same as the STATS keyword.

'NO' specifies that DEDB Pointer Checker is not to report the run totals and statistics. 'NO' is the default value.

TBLENTRY=
This keyword parameter specifies the entry number of the SDEP table (SDEPTBL). The table contains the data of the parent root segment and the RBA data of the deleted SDEP segment. When the TBLENTRY= keyword is specified with the SPTFALL keyword, information about all SDEP RBAs between Logical Begin and Logical End of the SDEP part are also kept in the table. This keyword is ignored when the SDEP keyword is not specified.

The maximum value that can be specified for TBLENTRY is 99999999; the minimum is 0. When the specified value is greater than 63161283, FPB internally replaces the specified value to 63161283. When the specified value is 0, FPB bypasses the SDEP validation process by using the SDEP table. FABADA1 generates, in the DAR3CSO data set, all pointer information records and the segment information records for all logically deleted SDEP segments as it does for the valid SDEP segments so that the information of the deleted segment can be resolved in program FABADA3.

The default value is 10000. The length of an entry in the SDEP table is 34 bytes. The table resides above 16M by using GETMAIN. So if you need to define many entries for a deleted SDEP check, increase your region size as well.

How to estimate the entry number

Estimate the following numbers first:

  • Number of root segments that have an SDEP pointer
  • Number of valid SDEP segments
  • Number of deleted SDEP segments between the logical begin and the logical end

Then estimate the number of entries as follows:

number of entries = number of root segments with SDEP pointer
  + number of valid SDEP segments
                    + (number of deleted SDEP segments/8)

One entry saves one root segment's information. The RBA of the deleted SDEP segment (which existed between the Logical Begin and the Logical End) is kept in the table. A maximum of 8 RBAs is kept in one entry. When SPTFALL is specified, all non-deleted SDEP segment information is kept in the table. One entry saves the information for one non-deleted SDEP segment.

SPTFALL
When this keyword is specified, DEDB Pointer Checker validates whether the SPTF in a valid SDEP segment points to a deleted RBA that is located at a physically higher RBA number. If you specify this keyword, pointer information for all valid SDEP segment RBAs is kept in the SDEP table. You should specify large enough entry numbers in TBLENTRY=. When this keyword is omitted, the SPTF RBA will be checked only to determine whether it points to a deleted segment whose RBA is physically smaller than the SPTF RBA.
VSAM=
This optional keyword parameter specifies whether DEDB Pointer Checker is to process a VSAM data set or image copy data sets.

'YES' specifies that DEDB Pointer Checker is to process a VSAM data set.

VSAM=YES has the same meaning as the VSAM keyword.

'NO' specifies that DEDB Pointer Checker is to process image copy data sets. 'NO' is the default value.

SDEP=
This optional keyword parameter specifies whether DEDB Pointer Checker is to verify and report any SDEP pointer integrity errors in the database.

'YES' specifies that DEDB Pointer Checker is to verify and report any SDEP pointer integrity errors. SDEP=YES has the same meaning as the SDEP keyword.

'NO' specifies that DEDB Pointer Checker is not to verify and report any SDEP pointer integrity errors. 'NO' is the default value.

OVRD=
This optional keyword parameter specifies whether DEDB Pointer Checker is to override a DBD member date (that is, the date of an ACBGEN for the DBD) and image copy date discrepancy.

'YES' specifies that DEDB Pointer Checker is to override the date discrepancy. OVRD=YES has the same meaning as the OVRD keyword.

'NO' specifies that DEDB Pointer Checker is not to override the date discrepancy. 'NO' is the default value.

SPTFALL=
This optional keyword parameter specifies whether DEDB Pointer Checker is to validate the SPTF in a valid SDEP segment points to a deleted RBA that is located at a physically higher RBA number.

'YES' specifies that pointer information for all valid SDEP segment RBAs is kept in the SDEP table. SPTFALL=YES has the same meaning as the SPTFALL keyword.

'NO' specifies that SPTF RBA will be checked only to determine whether it points to a deleted segment whose RBA is physically smaller than the SPTF RBA. 'NO' is the default value.

IMSCATHLQ=
This optional keyword specifies to retrieve ACBs from the IMS directory (an extension of the IMS catalog) instead of from the ACB library.

'bsdshlq' specifies to read ACBs from the IMS directory by using the IMS Tools Catalog Interface. bsdshlq specifies the high-level qualifier of the bootstrap data set of the IMS directory. IMSCATHLQ=bsdshlq is effective when the IMS catalog and the IMS management of ACBs are enabled.

If a TYPE=CATDSHLQ statement was used to create a DFSMDA member in your MDA library, you must specify the SYSDSHLQ parameter used in that DFSMDA member for the IMSCATHLQ keyword parameter.

'*NO' specifies to read ACBs from the ACB library. *NO is the default value.

IMSCATACB_INPUT=
This optional keyword specifies whether to retrieve currently active ACB definitions or pending ACB definitions from the IMS directory. IMSCATACB_INPUT keyword is effective only when the IMSCATHLQ=bsdshlq option is specified.

'CURRENT' specifies that currently active ACB members are retrieved from the IMS directory data sets. CURRENT is the default value.

'PENDING' specifies that pending ACB members are retrieved from the staging data set.