REQUEST=COUNTPAGES option of IARV64

REQUEST=COUNTPAGES requests the count of the number of 4K pages currently in use in real storage, on auxiliary storage, and in both real storage and on auxiliary storage to back the input high virtual storage ranges.

Environment

The requirements for the caller are:

Environmental factor	Requirement
Minimum authorization:	Supervisor state or with PSW key 0-7. The caller must be running in supervisor state or with PSW key 0-7.
Dispatchable unit mode:	Task or SRB
Cross memory mode:	Any PASN, any HASN, any SASN
AMODE:	31- or 64-bit
ASC mode:	Primary or access register (AR)
Interrupt status:	Enabled for I/O and external interrupts.
Locks:	A local lock may be held.
Control parameters:	Control parameters must be in the primary address space and can reside both below and above the bar.

Programming requirements

None

Restrictions

This macro supports multiple versions. Some keywords are unique to certain versions. See PLISTVER parameter description.

Input register information

Before issuing the IARV64 macro, the caller does not have to place any information into any register unless using it in register notation for a particular parameter, or using it as a base register.

Output register information

When control returns to the caller, the GPRs contain:

Register: Contents
0: Reason code, if GPR 15 is non-zero
1: Used as a work register by the system
2-13: Unchanged
14: Used as a work register by the system
15: Return code

When control returns to the caller, the ARs contain:

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14-15: Used as work registers by the system

Some callers depend on register contents remaining the same before and after issuing a service. If the system changes the contents of registers on which the caller depends, the caller must save them before issuing the service, and restore them after the system returns control.

Performance implications

None

Syntax

The REQUEST=COUNTPAGES option of the IARV64 macro is written as follows:

Syntax	Description

`name`	`name:` symbol. Begin `name` in column 1.

␢	One or more blanks must precede IARV64.

IARV64

␢	One or more blanks must follow IARV64.

REQUEST=COUNTPAGES

,COND=NO	Default: COND=NO
,COND=YES

,V64LISTPTR=`v64listptr`	`v64listptr:` RS-type address or address in register (2) - (12).

,V64LISTLENGTH=`v64listlength`	`v64listlength:` RS-type address or address in register (2) - (12).

,RANGLIST=`ranglist`	`ranglist:` RS-type address or address in register (2) - (12).

,NUMRANGE=`numrange`	`numrange:` RS-type address or address in register (2) - (12). Default: NUMRANGE=1

,ALETVALUE=`aletvalue`	`aletvalue:` RS-type address or address in register (2) - (12). Default: ALETVALUE=0

,UNLOCKED=NO	Default: NO
,UNLOCKED=YES

,RETCODE=`retcode`	`retcode:` RS-type address or register (2) - (12) or (15), (GPR15).

,RSNCODE=`rsncode`	`rsncode:` RS-type address or register (0) or (2) - (12).

,PLISTVER=IMPLIED_VERSION	Default: PLISTVER=IMPLIED_VERSION
,PLISTVER=MAX
,PLISTVER=0, 1, 2, 3

,MF=S	Default: MF=S
,MF=(L,`list addr`)	`list addr:` RS-type address or register (1) - (12).
,MF=(L,`list addr,attr`)
,MF=(L,`list addr`,0D)
,MF=(E,`list addr`)
,MF=(E,`list addr`,COMPLETE)

Parameters

The parameters are explained as follows:

name

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

REQUEST=COUNTPAGES

A required parameter. REQUEST=COUNTPAGES requests the count of the number of 4K pages currently in use in real storage, on auxiliary storage, and in both real storage and on auxiliary storage to back the input high virtual storage ranges. The counts are returned as grand totals for all pages within the ranges requested. If a page is in real storage and on auxiliary storage, it will be counted in real storage, on auxiliary storage, and in both real storage and on auxiliary storage. See IAXV64WA for a description of the output area.

,COND=NO

,COND=YES

An optional parameter that specifies whether the request is unconditional or conditional. In all cases, the request will be abnormally ended for invalid requests, including violation of environmental restrictions. The default is COND=NO.

,COND=NO: The request is unconditional. The request is abnormally ended when the request cannot be satisfied.
,COND=YES: The request is conditional. The request is not abnormally ended for resource unavailability.

,V64LISTPTR=v64listptr

A required input parameter that contains the address of the work area that will contain the results of the COUNTPAGES request. The work area must be in fixed storage addressable from the address space for which the request is made and must be initialized to zero by the caller.

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

,V64LISTLENGTH=v64listlength

A required input parameter that specifies the length of the work area that contains the results of the COUNTPAGES request. The work area must be at least 64 bytes long.

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

,RANGLIST=ranglist

A required input parameter that contains the address of a range list. The range list consists of a number of entries (as specified by NUMRANGE) where each entry is 16 bytes long. A description of the fields in each entry is as follows:

VSA: Denotes the starting virtual address of the data to be acted on. The virtual address must be on a page boundary and within a memory object returned by GETSHARED, GETSTOR or GETCOMMON.
The length of this field is 8 bytes.
NUMPAGES: Contains the number of 4K pages to be acted on. The number of pages specified, starting with the specified VSA, must lie within a single memory object.
The length of this field is 8 bytes.

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

,NUMRANGE=numrange

,NUMRANGE=1

An optional input parameter that specifies the number of entries in the supplied range list up to 16. The default is NUMRANGE=1.

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

,ALETVALUE=aletvalue

,ALETVALUE=0

An optional input parameter that indicates the ALET of the address space that will access the memory object.

The only supported values are 0 (primary) and 2 (home).

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

,UNLOCKED=NO

,UNLOCKED=YES

An optional parameter that specifies whether the request is to be performed without RSM serialization. This should only be used when the memory objects to be counted will not be modified or detached and an exact count is not needed. These counts will not be accurate because RSM processing can be modifying frame allocations. The default is UNLOCKED=NO.

UNLOCKED=NO: The request will use RSM serialization. This is the recommended option.
UNLOCKED=YES: The request will not hold RSM locks during processing.

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0, 1, 2, 3

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, supports all parameters except those specifically referenced in higher versions.
1, supports both the following parameters and parameters from version 0:
- CONVERTSIZE64
- CONVERTSTART
- GUARDSIZE64
- V64SHARED
2, supports both the following parameters and parameters from version 0 and 1:
- AMOUNTSIZE
- DETACHFIXED
- DUMP
- DUMPPRIORITY
- DUMPPROTOCOL
- LOCALSYSAREA
- MEMLIMIT
- OPTIONVALUE
- ORDER
- OWNERASID
- OWNERCOM
- TYPE
- USERTOKEN
- V64COMMON
3, supports both the following parameters and parameters from version 0, 1 and 2:
- ATTRIBUTE
- OWNERJOBNAME
- TRACKINFO

To code: Specify one of the following:

IMPLIED_VERSION
MAX
A decimal value of 0, 1, 2 or 3.

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