Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWM4MREG macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,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.
- ,OWNER_TKN=owner_tkn
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter, which contains any data associated with the resource that
may be useful later when the resource adjustment exit or the resource
data collection exit is called. The format is undefined to MVS™.
To code: Specify
the RS-type address, or address in register (2)-(12), of an 8-character
field.
- ,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
- ,RES_ADJ_EXIT@=res_adj_exit@
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter that contains the address of the resource adjustment exit
to be invoked when the system wishes to rebalance resource usage.
This exit is called with the same non cross-memory environment and
PSW key as when IWM4MREG is invoked.
To code: Specify
the RS-type address, or address in register (2)-(12), of a pointer
field.
- ,RES_ADJ_SIZE=res_adj_size
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter, which contains the minimum size (in 4K pages) by which
the specified resource can be adjusted. For a bufferpool, this corresponds
to a product external or the size of a cell.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a fullword field.
- ,RES_DATA_EXIT@=res_data_exit@
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter that contains the address of the resource data collection
exit to be invoked when the system checks how physical resources relate
to effectiveness of the given resource. This exit is called with the
same non cross-memory environment and PSW key as when IWM4MREG is
invoked.
To code: Specify the RS-type
address, or address in register (2)-(12), of a pointer field.
- ,RES_MAX_SIZE=res_max_size
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter, which contains the maximum size (in 4K pages) associated
with the specified resource.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field.
- ,RES_MIN_SIZE=res_min_size
- When RESOURCE_TYPE=BUFFER_POOL is specified, a required input
parameter, which contains the minimum size (in 4K pages) associated
with the specified resource.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field.
- RESOURCE_NAME=resource_name
- A required input parameter, which contains the resource name
associated with the resource to be registered. The value should be
padded on the right with blanks for any unused characters.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 16-character field.
- RESOURCE_TKN=resource_tkn
- A required input parameter, which contains the associated WLM
resource token which is used, for example, by the change state service
(IWMMCHST) and the deregister a resource service (IWM4MDRG).
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
- ,RESOURCE_TYPE=BUFFER_POOL
- A required parameter, which indicates the type of resource being
registered.
- ,RESOURCE_TYPE=BUFFER_POOL
- indicates that a bufferpool is being registered.
- ,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).
|