Using the AR/CTL common call


The function code of the common call determines whether 

AR/CTL

 performs restart or checkpoint processing. The restart call should specify user areas identical to those specified in the checkpoint calls. If the areas are different, the areas in the checkpoint calls will be used; however, the lengths must be identical for 

AR/CTL

 to accomplish restart.

Error
Warning

If an application program uses checkpoint/restart support or any AR/CTL data services, it must issue the restart call once as the first call and before any data set open processing.

Call format

The following shows the format of the common call in COBOL. All parameters are positional.

CALL 'CBLTARC' USING function,statuscd,forceopt,
     ioarealn,ioarea,beginarea-1,endarea-1,
     beginarea-2,endarea-2,...beginarea-n,endarea-n

Call parameters

The following parameters are valid on the AR/CTL restart call:

langTARC

Required. The literal that identifies the call as the AR/CTL common call, where lang is one of the following programming languages:

Language

Description

CBL

COBOL

ASM

Assembler

PLI

PL/I

function

Required. The name of the 4-byte field that identifies the function of the call. The following functions are valid:

Function

Description

XRST

restart request

CHKP

checkpoint request

statuscd

Required. The name of the 2-byte field that receives the status code from AR/CTL.

forceopt

Required; ignored for the XRST function code. The name of the 3-byte field that contains the checkpoint force option. The following values are valid:

Value

Description

YES

Forces checkpoint processing to complete.

NO

Accepts the checkpoint pacing recommendation. To pad the field the value must be followed by a blank (X'40').

ioarealn

Required. The name of the 4-byte binary field, PICTURE S9(8) COMP, that contains the length of the I/O area. The minimum length is 12 bytes for the XRST function code and 8 bytes for the CHKP function code. For more information, see Coding-an-I-O-area.

ioarea

Required. The name of the field that receives the restart identifier from AR/CTL and that the program can use to communicate a checkpoint identifier to AR/CTL. The program can leave this area blank. For more information, see Coding-an-I-O-area.

It is not necessary for any of the following user areas to begin or end on a fullword boundary.

beginarea-1

Required. The name of a field that contains the beginning address of the first program data area to save in the checkpoint record or to restore at restart.

endarea-1

Required. The name of a field that marks the ending address of the first program data area to save in the checkpoint record or to restore at restart. This field is not included in the save area.

beginarea-n

Optional. The name of a field that contains the beginning address of the next program data area to save in the checkpoint record or to restore at restart. You can specify a maximum of seven areas.

endarea-n

Optional. The name of a field that marks the ending address of the next program data area to save in the checkpoint record or to restore at restart. This field is not included in the save area.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Application Restart Control for Db2, IMS and VSAM 4.2