Parameters

The parameters are explained as follows:

name

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

,CPUSERVICE=cpuservice

An optional output parameter, which will contain the CPU service accumulated by the enclave on the local system.

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

,CPUTIME=cputime

An optional output parameter, which will contain the total CPU time accumulated by the enclave on the local system.

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

ETOKEN=etoken

A required input parameter, which contains the enclave token to be returned.

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

,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

,PLISTVER=1

,PLISTVER=2

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, which supports all parameters except those specifically referenced in higher versions.
• 1, which supports the following parameter and those from version 0:
  RESPTIME_RATIO
  
• 2, which supports the following parameters and those from version 0 and 1:

  ZAAPNFACTOR	ZAAPTIME	ZIIPTIME
  ZAAPSERVICE	ZIIPSERVICE

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, 1, or 2

,RESPTIME_RATIO=resptime_ratio

An optional output parameter, which contains the response time ratio times 100: act.resp.time / goal * 100 if the enclave has a response time goal (limited to: 1<=RESPTIME_RATIO<=1000) 0 otherwise

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

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

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

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

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

,SYSPLEXCPUSRV=sysplexcpusrv

An optional output parameter, which will contain the CPU service accumulated by the enclave on the local system and on other systems through the use of the IWMEXPT and IWMIMPT services. If the IWMEXPT and IWMIMPT services were not used, SYSPLEXCPUSRV returns the same value as CPUSERVICE.

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

,ZAAPNFACTOR=zaapnfactor

An optional output parameter, which contains the normalization factor for application assist processors (zAAPs). If zAAPs are running at a different speed, multiply zAAP service and times with this factor and divide the result by 256 to normalize the values to the speed of regular CPs. Note however, that if there has been a speed change of zAAP processors during the life time of the enclave, this calculation will return incorrect data.

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

,ZAAPSERVICE=zaapservice

An optional output parameter, which contains the application assist processor (zAAP) service accumulated by the enclave on the local system. The value is not normalized to the speed of regular CPs, but is expressed in zAAP speed which might be different. You may use ZAAPNFACTOR to normalize the value to the speed of regular CPs. Note however, that if the zAAP speed changed during the life time of the enclave, this value cannot be normalized correctly.

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

,ZAAPTIME=zaaptime

An optional output parameter, which contains the total application assist processor (zAAP) time accumulated by the enclave on the local system. The value is not normalized to the speed of regular CPs, but is expressed in zAAP speed which might be different. You may use ZAAPNFACTOR to normalize the value to the speed of regular CPs. Note however, that if the zAAP speed changed during the life time of the enclave, this value cannot be normalized correctly.

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

,ZIIPSERVICE=ziipservice

An optional output parameter, which contains the integrated information processor (zIIP) service accumulated by the enclave on the local system. The service is normalized to standard processor speed.

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

,ZIIPTIME=ziiptime

An optional output parameter, which contains the total integrated information processor (zIIP) time accumulated by the enclave on the local system. The time is normalized to standard processor speed.

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