Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IWMESTRT macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,ARRIVALTIME=arrivaltime

,ARRIVALTIME=NO_ARRIVALTIME

An optional input parameter, which contains the time when the work request actually started. This time is used to calculate the response time of the work request. The format of the field is STCK. The default is NO_ARRIVALTIME. indicates that no arrival time is passed.

To code: Specify the RS-type address, or address in register (2)-(12), of a 64 bit field.

,CLSFY=clsfy

,CLSFY=NO_CLSFY

An optional input parameter, which contains the classification information in the format of the parameter list for IWMCLSFY or IWM4CLSY NOTE that this name is the data area name, not its pointer. IWM4CLSY or IWMCLSFY MF(M) should be used to initialize the area prior to invocation of IWMESTRT. If the EWLM_CORR field within that classification information is non-zero, a sub-work request is started.

Note that the variable length fields associated with the classify parameter list given by the CLSFY keyword have the following limitations in addition to those documented in IWMCLSFY or IWM4CLSY:

• SUBSYSPM is limited to 255 bytes
• COLLECTION is limited to 18 bytes
• CORRELATION is limited to 12 bytes

Note: If EWLMMODE=EXPLICIT_SINGLE is specified, all data in the optional classify parameter list (CLSFY=xxx) are ignored, including the EWLM_CORR. If the application wants to specify an EWLM parent correlator or classification attributes for an EWLM hop0 work request, these data have to be passed in the classification parameter list on the IWM4ECRE (IWMECREA) call and thus will be the same for all work requests on the enclave. The default is NO_CLSFY. indicates that no classify parameter list is passed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

ETOKEN=etoken

A required input parameter that contains the enclave token of the enclave under which the work request is processed.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,EWLMMODE=NORMAL

,EWLMMODE=EXPLICIT_SINGLE

An optional parameter that indicates, if the parameter EXPLICIT_SINGLE has been specified on the IWM4ECRE(or IWMECREA) call. The EWLMMODE parameter has to be omitted (or the default value NORMAL must be specified), if the enclave was not created with the ESTRT=EXPLICIT_SINGLE option and vice versa. Otherwise the results may be unpredictable. The default is EWLMMODE=NORMAL.

,EWLMMODE=NORMAL

indicates that the enclave was created with the ESTRT=EXPLICIT or ESTRT=IMPLIED option.

,EWLMMODE=EXPLICIT_SINGLE

indicates that the enclave was created with the ESTRT=EXPLICIT_SINGLE option which can only be used for a restricted environment. The caller must also provide a standard 72-Byte savearea (addressable in AMODE 31) pointed to by GPR13. Moreover the parameter list and the classification parameters must also be adressable in AMODE 31.

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form, when both are assembled with the same level of the system. In this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, if you use the currently available parameters.

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15. If you specify 15, GPR15, REG15, or R15 (within or without parentheses), the value will be left in GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or (R15).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0. If you specify 0, 00, GPR0, GPR00, REG0, REG00, or R0 (within or without parentheses), the value will be left in GPR 0.

To code: Specify the RS-type address of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00), REG0), (REG00), or (R0).

,WORKREQ_HDL=workreq_hdl

A required output parameter that will receive the handle which represents the work request. The application must pass this handle to the other work request services IWMESTOP, IWMEBLK, IWMEUBLK, and IWMEGCOR.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.