AXEXT — Extract authorization index

Description

The AXEXT macro returns the authorization index value, AX, of the address space.

Related macros

ATSET, AXFRE, AXRES, and AXSET

Environment

These are the requirements for the caller:

Environmental factor	Requirement
Minimum authorization:	Supervisor state or PKM 0-7
Dispatchable unit mode:	Task or SRB
Cross memory mode:	PASN=HASN or PASN¬=HASN
AMODE:	Any
ASC mode:	Primary
Interrupt status:	Enabled for I/O and external interrupts
Locks:	No locks held
Control parameters:	Must be in the primary address space

Programming requirements

None.

Restrictions

None.

Input register information

The AXEXT macro is sensitive to the SYSSTATE macro with the OSREL=ZOSV1R6 parameter

If the caller has issued the SYSSTATE macro with the OSREL=ZOSV1R6 parameter (Version 1 Release 6 of z/OS® or later) before issuing the AXEXT macro, the caller does not have to place any information into any general purpose register (GPR) unless using it in register notation for a particular parameter, or using it as a base register.
Otherwise, the caller must ensure that the following general purpose register contains the specified information:
Register

Contents

13

The address of an 18-word save area

Output register information

After the caller issues the macro, the macro might use some registers as work registers or might change the contents of some registers. When the macro returns control to the caller, the contents of these registers are not the same as they were before the macro was issued. Therefore, if the caller depends on these registers containing the same value before and after issuing the macro, the caller must save these registers before issuing the macro and restore them after the system returns control.

When control returns to the caller, the general purpose registers (GPRs) contain:

Register: Contents
0: Bits 16-31 contain the extracted AX; bits 0-15 are set to zero
1: Used as a work register by the macro
2-13: Unchanged
14: Used as a work register by the macro
15: Return code

Performance implications

None.

Syntax

This is the standard form of the AXEXT macro:

Syntax	Description

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

␢	One or more blanks must precede AXEXT.

AXEXT

␢	One or more blanks must follow AXEXT.

ASID=`asid value`	`asid value`: RX-type address or register (0) - (12).
	Default: Current PASID.

,RELATED=`value`	`value`: Any valid macro keyword specification.

Parameters

These are the parameters:

ASID=asid value: Specifies the ASID of the address space from where the AX is to be extracted. When the RX-type address is used, it points to a halfword containing the ASID. When the register form is used, bits 16-31 contain the ASID and bits 0-15 are set to zero. When ASID is not specified, the current PASID is assumed.
,RELATED=value: Specifies information used to self-document macros by “relating” functions or services to corresponding functions or services. The format and content of the information are set at the discretion of the user. They can be any valid coding values.

ABEND codes

See z/OS MVS System Codes for an explanation and programmer responses for these codes.

Return codes

When AXEXT macro returns control to your program, GPR 15 contains a return code.

Table 1. Return Codes for the AXEXT Macro
Hexadecimal Return Code	Meaning
00	The AX value of the specified address space was successfully obtained.

Examples

For examples of the use of this and other cross memory macros, refer to the chapter on cross memory communication in z/OS MVS Programming: Extended Addressability Guide.