|
Description
Call the CSRPQEX cell pool service to receive status information
about a specified extent.
CSRPQEX does not prevent other programs from changing the pool
during or after a query. CSRPQEX returns the status as it was at
the time you issued the CALL.
Environment
The requirements for the caller are:
Environmental factor |
Requirement |
---|
Minimum authorization: |
Problem state with PSW key 8-15 |
Dispatchable unit mode: |
Task or SRB |
Cross memory mode: |
Any PASN, any HASN, any SASN |
AMODE: |
24- or 31-bit addressing mode. Nucleus-resident
code must be in 31-bit addressing mode when calling the service.
All input addresses must be valid 31-bit addresses. |
ASC mode: |
Primary or AR mode. (If the anchor and the extents
are located in a data space, the caller must be in AR mode.) |
Interrupt status: |
Enabled or disabled for I/O and external interrupts |
Locks: |
The caller may hold locks, but is not required
to hold any. |
Control parameters: |
Must reside in a single address or data space.
Control parameters must be in the primary address space or in an address/data
space that is addressable through a public entry on the caller's dispatchable
unit access list (DU-AL). |
Programming requirements
If your program is in AR mode, issue the SYSSTATE macro with ASCENV=AR
before you call CSRPQEX so the CALL macro can generate the correct
code for AR mode.
Before you use cell pool services, you can optionally include the
CSRCPASM macro to generate cell pool services equate (EQU) statements.
CSRCPASM provides the following constants for use in your program: * Length of the cell pool anchor data area:
*
CSR_ANCHOR_LENGTH EQU 64
*
*
* Base length of the cell pool extent data area:
*
CSR_EXTENT_BASE EQU 128
*
*
* Length of the user-supplied pool name:
*
CSR_POOL_NAME_LEN EQU 8
*
*
Input register information
Before calling the CSRPQEX service, 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 general purpose registers
(GPRs) contain: - Register
- Contents
- 0-1
- Used as work registers 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 access registers (ARs)
contain: - Register
- Contents
- 0-1
- Used as work registers by the system
- 2-14
- Unchanged
- 15
- Used as a work register 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.
Syntax
Write the call as shown on the syntax diagram. You must code all
parameters on the CALL statement in the order shown.
Syntax |
Description |
---|
CALL CSRPQEX |
,(cntl_alet
,anchor_addr
,extent_num
,status
,extent_addr
,extent_len
,area_addr
,area_size
,total_cells
,avail_cells
,return_code)
|
Parameters
All input to callable services is in the form of RX-type addresses.
The parameters are explained as follows:
- ,(cntl_alet
- Specifies the variable containing the ALET that identifies the
location of the anchor and extents. Initialize the ALET to 0 if your
program is running in AR mode and the anchor and extents are in the
primary address space. If your program is running in primary ASC mode,
the value is ignored, but you must code the parameter anyway.
- ,anchor_addr
- Specifies the variable containing the address of the 64-byte
anchor.
- ,extent_num
- Specifies the variable containing the number of the extent the
service will query.
- ,status
- When CSRPQEX completes, the variable specified for status contains
one of the following decimal numbers. These indicate the status of
the extent at the time of the CALL.
- 1
- Disconnected and inactive
- 2
- Connect in progress
- 3
- Connected and inactive
- 4
- Connected and active
- 5
- Disconnect in progress
- ,extent_addr
- When CSRPQEX completes, the variable specified for extent_addr contains
the address of the extent.
- ,extent_len
- When CSRPQEX completes, the variable specified for extent_len contains
the length of the extent, in bytes.
- ,area_addr
- When CSRPQEX completes, the variable specified for area_addr contains
the address of cell storage.
- ,area_size
- When CSRPQEX completes, the variable specified for area_size contains
the size of cell storage for the extent.
- ,total_cells
- When CSRPQEX completes, the variable specified for total_cells contains
the total number of cells associated with the extents.
- ,avail_cells
- When CSRPQEX completes, the variable specified for avail_cells contains
the total number of cells associated with the specified extent that
are available for allocation.
- ,return_code)
- When CSRPQEX completes, the variable specified for return_code contains
the return code.
Return and reason codes
When the CSRPQEX service returns control to your program , GPR
15 (and return_code) contains one of the following return
codes.
Hexadecimal Return Code |
Decimal Return Code |
Meaning and Action |
---|
00 |
00 |
Meaning: The operation was
successful. Action: None.
|
1C |
28 |
Meaning: Program error.
The anchor address is not valid. Action:
Check to see if your program passed the wrong anchor address or inadvertently
overlaid the anchor area.
|
30 |
48 |
Meaning: Program error.
The extent number is not valid. Action:
Make sure the extent number is within the range of 0 through 65536.
|
64 |
100 |
Meaning: Program error
or system error. An extent chain was broken. Action:
Check to see if your program inadvertently overlaid an extent area.
Make sure that no extent belongs to more than one cell pool.
|
68 |
104 |
Meaning: Program error
or system error. An extent chain is circular. Action:
Check to see if your program inadvertently overlaid an extent area.
Make sure that no extent belongs to more than one cell pool.
|
6C |
108 |
Meaning: Program error
or system error. An extent could not be found. Action:
Check to see if your program inadvertently overlaid an extent area.
Make sure that the anchor address for the right cell pool is being
passed.
|
74 |
116 |
Meaning: Program error
or system error. An extent has been overlaid. Action:
Check to see if your program inadvertently overlaid an extent area.
Make sure that no extent belongs to more than one cell pool.
|
|