Parameters

The parameters are explained as follows:

name

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

,COMPCODE=YES

,COMPCODE=NO

An optional parameter, which indicates whether completion status for this service is needed. The default is COMPCODE=YES.

,COMPCODE=YES

indicates that completion status is needed.

,COMPCODE=NO

indicates that completion status is not needed. Registers 0, 15 cannot be used as reason code and return code registers upon completion of the macro expansion. For this reason neither RETCODE NOR RSNCODE may be specified when COMPCODE(NO) is specified.

FUNCTION=CONTINUE

FUNCTION=RETURN

A required parameter, which indicates whether the dependent environment is continuing from or returning to the parent environment.

FUNCTION=CONTINUE

indicates that this is a unique continuation of the work request which is reflected in the dependent monitoring environment.

Note that the parent environment may continue to be active on behalf of the work request.

Note that specification of FUNCTION(CONTINUE) produces an inline expansion rather than an out-of-line service. Registers 0, 1, 14, and 15 are not preserved across the expansion.

FUNCTION=RETURN

indicates that the work request is returning to a previously established parent monitoring environment.

Use of this option indicates that the dependent environment no longer represents the work request.

Note that specification of FUNCTION(RETURN) produces an inline expansion rather than an out-of-line service. Registers 0, 1, 14, and 15 are not preserved across the expansion.

,MONTKN=montkn

A required input parameter, which contains the delay monitoring token for the dependent environment.

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

,PARENTENV=NOSWITCH

,PARENTENV=SECONDARY

A required parameter, which describes whether a space switch is needed to access the parent monitoring environment.

,PARENTENV=NOSWITCH

indicates that NO space switch is needed to access the parent monitoring environment. This would be appropriate if the parent monitoring environment was established (by IWM4MCRE) to be used by routines in a specific system key or if it was established to be used in a specific user key in the current primary.

,PARENTENV=SECONDARY

indicates that the parent monitoring environment was established in current secondary (for use by a specific user key).

,PARENTKEY=parentkey

When PARENTKEYP=VALUE is specified, a required input parameter, which contains the key in which the parent monitoring environment must be accessed. Use of this keyword value requires that the invoker be in supervisor state or that the caller have PKM authority to the key specified. The high-order 4 bits (i.e. bits 0-3) contain the key value.

Note that this is different from the "normal" way of declaring the key, and uses the machine orientation for keeping the storage key in the high-order bits.

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

,PARENTKEYP=VALUE

,PARENTKEYP=PSWKEY

,PARENTKEYP=UNKNOWN

A required parameter, which describes whether a key switch is needed to access the parent monitoring environment.

,PARENTKEYP=VALUE

indicates that the key is being passed explicitly via PARENTKEY.

,PARENTKEYP=PSWKEY

indicates that the current PSW key should be used. Use of this keyword value requires that the parent monitoring environment was established with the same key as the current PSW.

,PARENTKEYP=UNKNOWN

indicates that the key associated with the parent monitoring environment is unknown. Use of this keyword value requires that the invoker be in supervisor state or that the caller have PKM authority to key 0.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

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; 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 parameters and those from version 0:
  WORKREQ_STA
  

To code: Specify one of the following:

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

,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).

,RUNTIME_VER=SHORT_FORM

,RUNTIME_VER=MINIMAL

When FUNCTION=CONTINUE is specified, an optional parameter, which indicates what level of runtime verification will be performed. The default is RUNTIME_VER=SHORT_FORM.

,RUNTIME_VER=SHORT_FORM

indicates that checking should verify that a monitoring environment is established and passes a short form of verification prior to being used.

,RUNTIME_VER=MINIMAL

indicates that checking will only be done to verify that a monitoring environment may be established, assuming that it would be valid and usable if established.

,RUNTIME_VER=SHORT_FORM

,RUNTIME_VER=MINIMAL

When FUNCTION=RETURN is specified, an optional parameter, which indicates what level of runtime verification will be performed. The default is RUNTIME_VER=SHORT_FORM.

,RUNTIME_VER=SHORT_FORM

indicates that checking should verify that a monitoring environment is established and passes a short form of verification prior to being used.

,RUNTIME_VER=MINIMAL

indicates that checking will only be done to verify that a monitoring environment may be established, assuming that it would be valid and usable if established.

,WORKREQ_STA=workreq_sta

,WORKREQ_STA=IWMEWLMARMSTATUSNONE

When FUNCTION=RETURN is specified, an optional input parameter, which contains the completion status code of the work request. Available completion status codes (defined in macro IWMYCON) are the following:

• IwmEwlmArmStatusGood(0)
• IwmEwlmArmStatusAborted(1)
• IwmEwlmArmStatusFailed(2)
• IwmEwlmArmStatusUnknown(3)

These codes correspond to status codes in the OpenGroup ARM 4.0 Standard. For further information about the meaning of the status codes, refer to the ARM 4.0 Standard at http://www.opengroup.org/management/arm. The default is IWMEWLMARMSTATUSNONE. This indicates that internal information in the monitoring environment are examined to determine the status of the work request. If no abnormal event was recorded for the monitoring environment with the IWMMABNL service, the completion status IwmEwlmArmStatusGood is reported to EWLM. If an abnormal event was reported with IWMMABNL, the completion status IwmEwlmArmStatusFailed is reported to EWLM.

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