DFHFCAT (file control catalog manager)

Call mechanism

Kernel subroutine call. Automatic stack storage acquired as part of the call.

Entry address

DFHFCAT. The entry point address is held in FC static storage in a field named FC_FCAT_ADDRESS, which is set by DFHFCRP when it loads DFHFCAT.

Purpose

The file control catalog manager is part of the file control component. This program processes inquire and update requests on the state of the backup while open (BWO) attributes in the ICF catalog for VSAM data sets and inquire on the quiesce state in the ICF catalog. The DFSMS Callable Services interface is used for these operations.

Called by

DFHFCDN
Get the base data set name for a DSNB that has not yet been validated, update the recovery point, or to set the BWO attributes to a ‘forward recovered’ state
DFHFCN
Inquire on the current state of, and to update, BWO attributes during file open processing; and to reset these attributes during file close processing.
DFHFCQI
Inquire on the quiesce state of a data set.

Inputs

The FCAT parameter list, as defined by the DFHFCATA DSECT, is created as part of the subroutine call.

The input parameters are:
  • Data set name
  • Recovery point

Outputs

Returned in the FCAT parameter list:
  • Quiesce state
  • Base data set name
  • State (fuzzy, sharp)
  • Response
  • Reason

Operation

DFHFCAT provides the following functions:
INQ_BASEDSNAME
Gets the base data set name for a specified data set name from the ICF catalog. This function is used when there is not a validated DSN block for the data set.
INQ_CATALOG_QUIESCESTATE
If the level of DFSMS is 1.3 or higher, issues an IGWARLS call to determine the quiesce state of the data set (quiesced or unquiesced).
INQ_DATASET_STATE
Determines the current state of a VSAM data set’s BWO attributes in the ICF catalog. If the BWO attributes indicate that the data set is “back level”, that is, a backup copy has been restored but not forward recovered, an exception response is returned; otherwise, a state of ‘fuzzy’ or ‘sharp’ is returned, indicating whether or not the data set is defined in the ICF catalog as eligible for BWO.
SET_CATALOG_RECOVERED
Updates a VSAM data set’s BWO attributes in the ICF catalog to a ‘forward recovered’ state to indicate that the data set has been forward recovered.
SET_CATALOG_RECOV_POINT
Updates a VSAM data set’s BWO attributes in the ICF catalog with the new recovery point.
SET_BWO_BITS_DISABLED
Updates a VSAM data set’s BWO attributes in the ICF catalog to show that the data set is no longer eligible for BWO support, and updates the recovery point.
SET_BWO_BITS_ENABLED
Updates a VSAM data set’s BWO attributes in the ICF catalog to show that the data set is eligible for BWO support, and updates the recovery point.

How loaded

By DFHFCRP as part of file control initialization.



dfhs3f3.html | Timestamp icon Last updated: Monday, 5 June 2017