FCRR gate, RESTART_RLS function

This function performs a restart of the record-level sharing (RLS) component of file control. The exact processing depends on the type of restart being performed: cold, initial, warm, emergency, or dynamic.

COLD and INITIAL

The RLS control ACB is registered and a cold start of RLS is performed; both processes are initiated through calls to DFHFCCA.

WARM and EMERGENCY

The RLS control ACB is registered and recovery information is inquired upon from SMSVSAM; both processes are initiated through calls to DFHFCCA. If the recovery information indicates that some data sets are in lost locks status, the corresponding DSNBs are marked as being in lost locks state and preparation for lost locks recovery is carried out. Any orphan locks are eliminated.

DYNAMIC

This type of restart occurs when a new instance of the SMSVSAM server becomes available following a previous server failure.

Having waited for file control restart to complete, if it was still in progress, and for any in-progress dynamic RLS restarts to complete, RLS access is drained if necessary, the control ACB is registered, and recovery information is inquired upon from SMSVSAM. All three of these processes are initiated through calls to DFHFCCA.

If the recovery information indicates that some data sets are in lost locks status, the corresponding DSNBs are marked as being lost locks, and preparation for lost locks recovery is carried out. Any orphan locks are eliminated.

The CICS® recovery manager is called to recover any shunted units of work that are backout-failed because of the SMSVSAM server failure or a general file backout failure and any units of work that are commit-failed because of the SMSVSAM server failure.

Input Parameters

TYPE_OF_RESTART
Indicates the type of RLS restart being performed. Values for the parameter are:
  • COLD
  • WARM
  • EMERGENCY
  • DYNAMIC

Output Parameters

REASON
The following values are returned when RESPONSE is INVALID:
  • INVALID_FUNCTION
  • INVALID_RESTART_TYPE
The following values are returned when RESPONSE is EXCEPTION:
  • REGISTER_CTL_ACB_FAILED
  • COLD_START_RLS_FAILED
  • DRAIN_RLS_FAILED
  • LOST_LOCKS_INFO_LOST
  • INQUIRE_RECOVERY_FAILED
  • LOST_LOCKS_COMPLETE_FAILED
  • ORPHAN_RELEASE_FAILED
The following values are returned when RESPONSE is DISASTER:
  • DSSR_FAILED
  • TM_LOCATE_FAILED
  • TM_UNLOCK_FAILED
  • ABEND
  • DISASTER_PERCOLATION
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