FCQU gate, PROCESS_QUIESCE function
This function is called when a quiesce request is received from VSAM RLS. The quiesce exit, DFHFCQX, queues requests to the CFQR system transaction, DFHFCQR, which calls DFHFCQU to process each one in turn. The PROCESS_QUIESCE function is also called to implement a non-RLS variant of QUIESCE called NON_RLS_CLOSE.
Input Parameters
- QUIESCE_TYPE
- The type of quiesce being requested. Values for the parameter
are:
- QUIESCE
- Corresponds to an SMSVSAM QUICLOSE. All files open against the data set are closed, the file state of each file is set to unenabled with a flag that says reenable on QUIOPEN, and a QUICMP is issued for the QUICLOSE back to VSAM RLS to indicate that QUICLOSE processing is complete. The IMMEDIATE parameter governs how file closes are to be performed. If the IMMEDIATE parameter is set to NO, or omitted, files will be closed when all UOWs using the data set have completed normally. If the IMMEDIATE parameter is set to YES, all such UOWs will be force purged to speed up file closure.
- UNQUIESCE
- Corresponds to an SMSVSAM QUIOPEN. All files associated with the data set are checked to see if their file state requires resetting back to enabled because it had been set unenabled by a QUICLOSE.
- NONBWO_START
- Corresponds to an SMSVSAM QUICOPY. CICS prepares for a non-BWO backup of the data set by preventing new units of work from updating the data set, allowing existing UOWs to finish updating the data set, and issuing a QUICMP for the QUICOPY back to SMSVSAM to indicate that QUICOPY processing is complete. The files involved are not closed.
- NONBWO_END
- Corresponds to an SMSVSAM QUICEND. All files associated with the data set are checked to see if their file state requires resetting to enabled because it had been set unenabled by an OPEN failure, and a set of ’tie up records’ is written for the data set.
- BWO_START
- Corresponds to an SMSVSAM QUIBWO. CICS prepares for a BWO backup of the data set by writing a set of ’tie up records’ allowing existing units of work to finish updating the data set and issuing a QUICMP for the QUIBWO back to SMSVSAM to indicate that QUIBWO processing is complete. The files involved are not closed, and updates are not prevented.
- BWO_END
- Corresponds to an SMSVSAM QUIBEND. The only processing involved is to stop an existing BWO quiesce if one is in progress.
- LOCKS_RECOVERY_COMPLETE
- Corresponds to an SMSVSAM QUILLRC. CICS is notified that lost locks recovery has been completed for the data set throughout the sysplex. DFHFCRR is called with the LOST_LOCKS_RECOVERED function to process the availability of the data set.
- FORWARD_RECOVERY_COMPLETE
- Corresponds to an SMSVSAM QUIFRC. CICS is notified that forward recovery has been completed for the data set. DFHFCRR is called with the RESOURCE_AVAILABLE function to process the availability of the data set.
- CACHE_AVAILABLE
- Corresponds to an SMSVSAM QUICA. CICS is notified that a previously failed cache structure is now available. DFHFCRR is called with the RESOURCE_AVAILABLE function to process the availability of the cache.
- NON_RLS_CLOSE
- Processes a non-RLS variant of type CLOSE called NON_RLS_CLOSE. All ACBs open against the specified non-RLS data set are closed. NON_RLS_CLOSE is used internally by CICS and does not run under the CFQR system transaction. Each quiesce request type is processed in a different way by DFHFCQU.
- DSNAME|CACHE_NAME
- Specifies either the 44-character name of the data set to which the quiesce request applies, or when the value of the QUIESCE_TYPE parameter is CACHE_AVAILABLE, the 16-character name of the cache structure that has become available.
- IMMEDIATE
- This parameter applies only when the value of the QUIESCE_TYPE parameter
is QUIESCE or NON_RLS_CLOSE, and indicates whether units of work that
have updated the data set will be forced to complete immediately,
or whether the request will wait for those units of work to complete
naturally. Values for the parameter are:
- YES
- NO
- CONCURRENT
- This parameter applies only when the value of the QUIESCE_TYPE parameter
is NONBWO_START or BWO_START, This parameter indicates whether the
concurrent copy technique is being used and has no effect on the processing.
Values for the parameter are:
- YES
- NO
- QUIESCE_TOKEN
- This token is supplied by SMSVSAM when certain quiesce requests are initiated and must be passed back when the quiesce complete is issued.
Output Parameters
- REASON
- The following value is returned when RESPONSE is INVALID:
- INVALID_QUIESCE_TYPE
- The following value is returned when RESPONSE is EXCEPTION:
- DSNB_NOT_FOUND
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- DISASTER_PERCOLATION
- DFHFCRR_ERROR
- DFHFCQI_ERROR
- DFHFCFS_ERROR
- DFHTM_FAILURE
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED