Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWM4MXFR 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.
- ,EWLM=NO
- An optional parameter, which indicates if this work manager
intents to participate in cross platform Enterprise Workload Management
(eWLM). The default is EWLM=NO.
- ,EWLM=NO
- The work manager interacts only with WLM and no interaction
with eWLM takes place.
- 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.
- ,MONTKN64=montkn64
- A required input parameter which contains the long delay monitoring
token for the dependent environment.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 64 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 "natural" 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.
- ,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).
- ,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
useable 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
useable 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:
* IwmEwlmArmStatusGood(0),
* IwmEwlmArmStatusAborted(1),
* IwmEwlmArmStatusFailed(2) or
* IwmEwlmArmStatusUnknown(3)
The codes above correspond to status codes in
the OpenGroup ARM 4.0 Standard (for the meaning of the status codes
see the ARM 4.0 Standard at http://www.opengroup.org/management/arm).
The default is IWMEWLMARMSTATUSNONE.
indicates that internal information in the Monitoring
Environment will be examined to determine the status of the work request:
if no abnormal event was recorded for the monitoring environment via
the IWM4MABN service, the completion status IwmEwlmArmStatusGood will
be reported to EWLM. If an abnormal event was reported via IWM4MABN,
the completion status IwmEwlmArmStatusFailed will be reported to EWLM.
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field, or specify a literal decimal
value.
|