 |
The parameter descriptions are listed in alphabetical order. Default
values are underlined: - ,ADJUNCT=NO
- ,ADJUNCT=YES
- Use this input parameter to indicate whether adjunct data is associated
with each structure entry. Adjunct data is 64 bytes per entry.
- NO
- The structure entries do not have associated adjunct data.
- YES
- The structure entries have associated adjunct data.
 ,ALGORITHMVAL=algorithmval  - Use this input value to specify the value, as defined in IXLYCON,
of the SCMALGORITHM value that the CF will use to manage storage-class
memory. The following IXLYCON constants are valid values:
If you specify a value other than one of the valid IXLYCON constants,
the IXLCSP request fails with reason code IXLRSNCODEBADSCMALGORITHM.
See the appropriate SCMALGORITHM keyword values for specific algorithm
information.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of a one-byte input field that contains
a representation of the desired storage-class memory management algorithm.
- ,ANSAREA=ansarea
- Use this output area to contain information returned about the
request. The storage area is mapped by the IXLYCSPA macro.
Not
all fields in the answer area are applicable to all request types.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of an output area to contain information about the request.
- ,ANSLEN=anslen
- Use this input parameter to specify the length of the answer area.
The length should be long enough to accommodate the IXLYCSPA mapping
of the answer area.
To Code: Specify the RS-type name or
address (using a register from 2 to 12) of a fullword input field
that contains the length of the answer area.
- CFNAME=cfname
- Use this input parameter to specify the name of the coupling facility
for which computations are to be performed. The specified coupling
facility must be:
- Defined in the active CFRM policy
- Connected to the system from which the request is issued
- CFLEVEL=8 or higher.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of an 8-character input field that contains
the name of the coupling facility.
- ,DIRENTRYCOUNT=direntrycount
- Use this input parameter to specify the desired maximum number
of directory entries in the structure.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
input area to contain the maximum number of directory entries.
- ,DIRRATIO=1
- ,DIRRATIO=dirratio
- Use this input parameter to specify a value to express the directory
portion of the directory-to-element ratio of the coupling facility
structure. The value of DIRRATIO must be greater than zero.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the 2-byte input field that contains a value to express
the directory portion of the directory-to-element ratio of the coupling
facility structure.
- ,ELEMCHAR=0
- ,ELEMCHAR=elemchar
- Use this input parameter to specify the value of an element characteristic
used to determine the element size. The element size is calculated
with the formula 256*(2**ELEMCHAR), where ELEMCHAR is used as the
power of 2. For example, if ELEMCHAR=0, then the size of each element
is 256 bytes.
The valid values for ELEMCHAR range from zero to
a maximum determined by the coupling facility limitation on element
size.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the 1-byte input field that contains
the value of the element characteristic, used to determine the structure
element size. Note: The element size, in combination with the maximum
number of elements (MAXELEMNUM parameter), determines the size of
the data entry — the data written to and read from the structure.
With a coupling facility of CFLEVEL=0, a data entry can be up to 16
times the data element size, as indicated by the element characteristic.
With a coupling facility of CFLEVEL=1 or higher, a data entry can
be up to 255 times the data element size.
Use either
ELEMCHAR or ELEMINCRNUM to define the element size. You can specify
either an element characteristic or an element increment number for
element size determination.
- ,ELEMENTCOUNT=elementcount
- Use this input parameter to specify the desired maximum number
of data elements in the structure.
For a directory-only cache
structure, or a list structure without data elements, specify ELEMENTCOUNT=0. Zero cannot be specified when ELEMENT is specified for
LISTCNTLTYPE.
To Code: Specify the RS-type name
or address (using a register from 2 to 12) of a fullword input area
to contain the maximum number of data elements in the structure.
- ,ELEMENTRATIO=1
- ,ELEMENTRATIO=elementratio
- Use this input parameter to specify a value to express the element
portion of the directory-to-element ratio for a cache structure or
the entry-to-element ratio for a list structure. If ELEMENTRATIO is
zero, the calculation reflects a structure allocated without data
elements. Zero cannot be specified when ELEMENT
is specified for LISTCNTLTYPE.
To Code: Specify the
RS-type name or address (using a register from 2 to 12) of the 2-byte
input field that contains a value to express the element portion of
the directory-to-element ratio of the coupling facility structure.
- ,ELEMINCRNUM=elemincrnum
- Use this input parameter to specify the element increment number.
The element size is calculated with the formula 256*ELEMINCRNUM. For
example, if ELEMINCRNUM=1, then the size of each element is 256 bytes.
The valid values for ELEMINCRNUM range from 1 to a maximum determined
by the coupling facility limitation on element size. The value of
ELEMINCRNUM must be a power of 2.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
1-byte input field that contains the value of the element increment
number, used to determine the cache structure element size. Note: The
element size, in combination with the maximum number of elements (MAXELEMNUM
parameter), determines the size of the data entry — the data
written to and read from the structure. With a coupling facility of
CFLEVEL=0, a data entry can be up to 16 times the data element size,
as indicated by the element increment number. With a coupling facility
of CFLEVEL=1 or higher, a data entry can be up to 255 times the data
element size.
Use either ELEMCHAR or ELEMINCRNUM to
define the element size. You can specify either an element characteristic
or an element increment number for element size determination.
- ,EMCCOUNT=emccount
- Use this input parameter to specify the desired maximum number
of event monitor controls in the structure.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
input area to contain the maximum number of event monitor controls
in the structure.
- ,EMCSTGPCT=0
- ,EMCSTGPCT=emcstgpct
- Use this input parameter to specify the percentage of available
list structure storage that is to be set aside for event monitor controls
(EMCs). The amount of storage requested is that over and above the
storage amount included in the marginal structure size.
Specify
the percentage value in hundredths of a percent. For example, to
request a value of 20%, code EMCSTGPCT=2000.
The value of
EMCSTGPCT must be in the range of 0 to 10000. A non-zero value indicates
tha some connector intends to perform sublist monitoring. Note that
for sublist monitoring, the structure must be a keyed list structure
(REFOPTION=KEY).
To Code: Specify the RS-type name
or address (using a register from 2 to 12) of the halfword field that
contains a value to express the percentage of available structure
storage, over and above the storage amount included in the marginal
structure size, that is to be set aside for event monitor controls
(EMCs).
- ,ENTRYCOUNT=entrycount
- Use this input parameter to specify the desired maximum number
of list entries in the structure.
To Code: Specify the
RS-type name or address (using a register from 2 to 12) of a fullword
input area to contain the maximum number of directory or list entries
in the structure.
- ,ENTRYRATIO=1
- ,ENTRYRATIO=entryratio
- Use this input parameter to specify a value to express the list
entry portion of the entry-to-element ratio of the coupling facility
list structure.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the 2-byte field that contains
a value to express the list entry portion of the entry-to-element
ratio of the coupling facility list structure.
- ,KEYTYPE=ENTRY
- ,KEYTYPE=SECONDARY
- Use this input parameter to indicate whether keyed list entries
will use enty keys and secondary keys or only entry keys.
- ENTRY
- Specifies that only list entry keys will be used.
- SECONDARY
- Specifies that list entry keys and secondary list entry keys will
be used.
Secondary keys are stored in the first 32 bytes of the
64-byte list entry adjunct area. Therefore, when KEYTYPE=SECONDARY
is specified, adjunct data must also be requested by specifying ADJUNCT=YES.
KEYTYPE=SECONDARY requires a coupling facility of CFLEVEL=9 or higher.
- ,LISTCNTLTYPE=ENTRY
- ,LISTCNTLTYPE=ELEMENT
- Use this input parameter to specify whether the system maintains
and tracks list limits based on number of entries or number of elements.
- ENTRY
- Specifies that the list limits are specified and tracked as limits
on the number of entries that may reside on the list.
- ELEMENT
- Specifies that the list limits are specified and tracked as limits
on the total number of data elements that may be associated with entries
on the list.
Note: Neither ELEMENTRATIO nor ELEMENTCOUNT
can be specified as zero with this specification.
- ,LISTHEADERS=listheaders
- Use this input parameter to specify the number of lists (list
headers) for the coupling facility list structure. The number must
be greater than zero.
To Code: Specify the RS-type name
or address (using a register from 2 to 12) of the fullword input field
that contains the number of list headers to be allocated.
- ,LOCKENTRIES=0
- ,LOCKENTRIES=lockentries
- Use this input parameter to specify the number of lock entries
associated with the structure. If the value for the number of lock
entries is not a power of 2, it is rounded upward to the nearest power
of 2.
- When specified for a list structure, a LOCKENTRIES value of 0
indicates an unserialized list structure.
- When specified for a lock structure, a LOCKENTRIES value of 0
indicates that IXLCSP is to determine the maximum number of locks
that can be accomodated by a structure of the specified size. Specifying
LOCKENTRIES=0 is valid only when RECORD=NO is specified.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of the fullword field that contains the number
of lock entries for the coupling facility structure.
- ,MAXCONN=32
- ,MAXCONN=maxconn
- Use this input parameter to specify the maximum number of users
that can connect and use the list or lock structure. When the requested
MAXCONN keyword value is in the range 0 to 32, the value is 32.
To
perform computations for a structure that is to support more than
32 connectors, you must use the keyword MAXCONN, and ensure that the
target coupling facility is CFLEVEL=17 or higher. If you use MAXCONN
on a request on a request that is targeted for a coupling facility
with a CFLEVEL less than 17, the value for the computation is limited
by the user-id limit of the coupling facility.
For lock structures
use either NUMUSERS or MAXCONN to specify the maximum number of users
that can connect to the lock structure.
To Code: Specify the RS-type name or address (using a register
from 2 to 12) of the 1-byte field that contains the maximum number
of connectors to the coupling facility structure.
- ,MAXELEMNUM=16
- ,MAXELEMNUM=maxelemnum
- Use this input parameter to specify a value to determine the maximum
number of data elements for each data entry in the coupling facility
structure. MAXELEMNUM must be in the decimal range of 1 to 255.
The
maximum data entry size in bytes equals MAXELEMNUM multiplied by the
element size obtained from the value specified for ELEMCHAR or ELEMINCRNUM.
For
example, if ELEMCHAR=0 and MAXELEMNUM=1, the maximum data entry size
in bytes is 256. If ELEMCHAR=4 and MAXELEMNUM=16, the maximum data
entry size in bytes is 4096(16), or 65,536.
To ensure that
the system can assign all possible data elements allocated in a structure
to a directory or list entry, MAXELEMNUM must be greater than or equal
to: - ELEMENTRATIO divided by DIRRATIO (for cache structures)
- ELEMENTRATIO divided by ENTRYRATIO (for list structures)
when computing structure counts. MAXELEMNUM is ignored if ELEMENTRATIO
is zero. To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the 1-byte input field that contains
the maximum number of data elements for each data entry in the coupling
facility structure.
- ,MAXSIZE=COMPUTEDSTRSIZE
- ,MAXSIZE=maxsize
- Use this input parameter to specify the maximum size of the structure
in units of 4K blocks. The MAXSIZE parameter corresponds to the SIZE
parameter that would be used in defining the structure in the CFRM
policy.
If MAXSIZE is specified, and its value is greater than
the size computed from the other input parameters, then it is also
used as an input to the computation. If MAXSIZE is not specified,
the computation uses the computed structure size as the maximum size.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of a fullword input area to contain the maximum size of the
structure in units of 4K blocks.
- ,MF=S
- ,MF=(L,mfctrl)
- ,MF=(L,mfctrl,mfattr)
- ,MF=(L,mfctrl,0D)
- ,MF=(M,mfctrl)
- ,MF=(M,mfctrl,COMPLETE)
- ,MF=(M,mfctrl,NOCHECK)
- ,MF=(E,mfctrl)
- ,MF=(E,mfctrl,COMPLETE)
- ,MF=(E,mfctrl,NOCHECK)
- Use MF=S to specify the standard form of the macro, which builds
an in-line parameter list and generates the macro invocation to transfer
control to the service.
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 can be coded with the list form of the
macro.
Use MF=M to specify the modify form of the macro. Use
the modify form to generate code to put the parameters into the parameter
list.
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 stores the parameters
into the storage area defined by the list form, and generates the
macro invocation to transfer control to the service.
- ,mfctrl
- Use this output parameter to specify a storage area to contain
the parameters.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the parameter list.
- ,mfattr
- Use this input parameter to specify the name of a 1- to 60-character
string that can contain any value that is valid on an assembler DS
pseudo-op. You can use this parameter to force boundary alignment
of the parameter list. If you do not code mfattr, the system
provides a value of 0D, which forces the parameter list to a doubleword
boundary.
- ,COMPLETE
- ,NOCHECK
- Use this input parameter to specify the degree of macro parameter
syntax checking the system is to do.
- COMPLETE
- Use this parameter to require that the system check for required
parameters and supply defaults for omitted optional parameters.
- NOCHECK
- Use this parameter to specify that the system is not to check
for required parameters nor to supply defaults for omitted optional
parameters.
Note: In the macro expansion you might see some
defaults for optional parameters that are not documented here. The
ones that are not documented do not have any effect on the macro.
For example, if SMILE=var were an optional
parameter and the default is SMILE=NO_SMILE then it would not be documented.
However, if the default was SMILE=:-), then it would be documented
because a value would be the default.
- ,NAMECLASS=NO
- ,NAMECLASS=YES
- Use this input parameter to indicate whether the structure supports
name classes. Name classes are supported when the IXLCONN request
that results in allocation of the structure specifies a value of
NAMECLASSMASK other than X'0000' or X'FFFF'.
- NO
- The structure does not support name classes.
- YES
- The structure supports name classes.
- ,NUMCOCLASS=numcoclass
- Use this input parameter to specify the desired number of cast-out
classes to be used with the coupling facility cache structure.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the fullword input field that contains the number of cast-out
classes.
- ,NUMSTGCLASS=numstgclass
- Use this input parameter to specify the desired number of storage
classes used with the coupling facility cache structure.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the fullword input field that contains the number of storage
classes.
- ,NUMUSERS=numusers
- Use this input parameter to specify the maximum number of users
that can connect and use the lock structure.
When
you use the NUMUSERS keyword, the actual number of connections that
are used for computations does not exceed 32. If NUMUSERS specifies
a value over 32, the value for the computation is set to 32.
For XC to perform computations for a structure that supports
more than 32 connectors, you must use the keyword MAXCONN and ensure
that the target coupling facility is CFLEVEL=17 or higher. If you
use MAXCONN is on a request targeted for a coupling facility with
a CFLEVEL less than 17, the value of the computation is limited by
the user-id limit of the coupling facility.
For
lock structures, use either NUMUSERS or MAXCONN to specify the maximum
number of users that can connect to the lock structure.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of the 1-byte field that contains the maximum
number of connectors to the coupling facility lock structure.
- ,PLEIDS=YES
- ,PLEIDS=NO
- Use this input parameter to specify whether the list structure
is to be allocated with programmable list entry identifiers (PLEIDs).
For list structures that are to be used for XCF signalling, specify
PLEIDS=NO. For all other list structures, specify PLEIDS=YES.
- YES
- The calculation will reflect a list structure allocated with
PLEIDs.
- NO
- The calculation will reflect a list structure that is not allocated
with PLEIDs.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=plistver
- Use this input parameter to specify the version of the macro.
See Understanding IXLCSP Version Support for a description of the
options available with PLISTVER.
- ,RDATENTRYCOUNT=rdatentrycount
- Use this input parameter to specify the desired number of record
data entries in a lock structure.
RDATENTRYCOUNT is ignored when
RECORD=NO is specified.
To Code: Specify the RS-type
name or address (using a register from 2 to 12) of a fullword input
field that contains the maximum number of record data entries.
- ,RECORD=NO
- ,RECORD=YES
- Use this input parameter to specify whether the lock structure
has associated record data.
- NO
- The lock structure does not have record data.
- YES
- The lock structure does have record data.
- ,REFOPTION=NOKEYNAME
- ,REFOPTION=KEY
- ,REFOPTION=NAME
- Use this input parameter to specify how to reference list entries
in the coupling facility list structure. The list entry can always
be referenced by list entry identifier (LEID) or by unkeyed position.
Choose one of the following options to specify how the list entry
is to be referenced.
- NOKEYNAME
- The list entries have neither keys nor names.
- KEY
- The list entries have keys.
- NAME
- The list entries have names.
- ,REQUEST=COMPUTECOUNTS
- ,REQUEST=COMPUTESIZE
- ,REQUEST=COMPUTESCMSIZE
- Use this input parameter to specify the function requested.
- COMPUTECOUNTS
- Compute the number of structure objects that can be contained
within a structure of the specified size and attributes.
- COMPUTESIZE
- Compute the size of a structure having the specified attributes
and containing the specified number of objects.
- COMPUTESCMSIZE
- Compute the amount of storage-class memory that is required to
accommodate the specified number of objects.
REQUEST=COMPUTESCMSIZE
is valid when the target coupling facility is at a CFLEVEL greater
than or equal to 19.
- ,RETCODE=retcode
- Use this output parameter to specify the location in which the
system is to copy the return code from GPR 15.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
to contain the return code.
- ,RSNCODE=rsncode
- Use this output parameter to specify the location in which the
system is to copy the reason code from GPR 0.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
to contain the reason code.
- ,SCMALGORITHM=KEYPRIORITY1
- ,SCMALGORITHM=VALUE
- Use this input parameter to identify the algorithm that the coupling
facility uses to manage the storage-class memory that is associated
with this structure.
This parameter is ignored if SCMMAXSIZE is
specified as 0. - KEYPRIORITY1
- The first byte of the list entry key identifies the migration
priority. Data elements, REFOPTION=KEY, and LISTHEADERS=1023 are required.
- VALUE
- Indicates the use of the contents of ALGORITHMVAL to identify
the algorithm that is used to manage storage-class memory.
- ,SCMELEMENTCOUNT=scmelementcount
- Use this input parameter to specify the desired maximum number
of data elements that can overflow to storage-class memory.
The
minimum value of SCMELEMENTCOUNT with SCMALGORITHM=KEYPRIORITY1 is
1. The maximum value of SCMELEMENTCOUNT is 4294967295 (2**32-1).
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of an 8-byte input area to contain the maximum number of
data elements in storage-class memory for the structure.
- ,SCMENTRYCOUNT=scmentrycount
- Use this input parameter to specify the desired maximum number
of list entries that can overflow to storage-class memory.
The minimum
value of SCMENTRYCOUNT with SCMALGORITHM=KEYPRIORITY1 is 1. The maximum
value of SCMENTRYCOUNT is 4294967295 (2**32-1).
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of an 8-byte input area to contain the maximum number of
list entries in storage-class memory for the structure.
- ,SCMMAXSIZE=scmmaxsize
- Use this input parameter to specify, in units of 4K blocks, the
maximum amount of storage-class (flash) memory that the structure
is allowed to use. The SCMMAXSIZE keyword corresponds to the parameter
of the same name that is used in defining the structure in the CFRM
policy.
The maximum value of SCMMAXSIZE is 4294967295 (2**32-1).
SCMMAXSIZE
is valid when the target coupling facility is at a CFLEVEL greater
than or equal to 19.
To Code: Specify, in units of 4K
blocks, the RS-type name or address (using a register from 2 to 12)
of an 8-byte input area to contain the maximum amount of storage-class
memory for the structure.
- ,STRSIZE=strsize
- Use this input parameter to specify the structure size in units
of 4K blocks. The STRSIZE parameter corresponds to the INITSIZE parameter
that would be used in defining the structure in the CFRM policy.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of a fullword input field to contain the structure size in
units of 4K blocks.
- ,TYPE=CACHE
- ,TYPE=LIST
- ,TYPE=LOCK
- Use this input parameter to specify the type of structure for
which computations are to be made.
- ,UDFORDER=NO
- ,UDFORDER=YES
- Use this input parameter to indicate whether a user data field
(UDF) order queue should be maintained for each cast-out class for
the structure.
- NO
- The calculation is to reflect a cache structure that does not
maintain UDF order queues.
- YES
- The calculation is to reflect a cache structure that maintains
UDF order queues.
|
z/OS MVS Programming: Sysplex Services Reference
Copyright IBM Corporation 1990, 2014