AXSET — Set authorization index

Description

The AXSET macro sets the authorization index (AX) of the home address space to the value specified by the caller. The AX must be reserved. The address space in which the AX is being changed cannot own SASN=OLD connected space switch entry tables. All routines that subsequently execute, with a PASID of the address space for the AX being changed, execute with the new AX.

Related macros

ATSET, AXFRE, AXRES, and AXEXT

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:	Primary

Programming requirements

None.

Restrictions

None.

Input register information

The AXSET 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 AXSET 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 0-15 contain zeros; bits 16-31 contain the replaced Authority Index (AX)
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 AXSET macro:

Syntax	Description

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

␢	One or more blanks must precede AXSET.

AXSET

␢	One or more blanks must follow AXSET.

AX=`AX value`	`AX value`: RX-type address or register (0) - (12).

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

Parameters

These are the parameters:

AX=AX value: Specifies the new AX value. The RX-type address specifies a halfword containing the new AX. When the register form is used, the register must contain the new AX in bits 16-31, and bits 0-15 must be zero.
,RELATED=value: Specifies information used to self-document macros by “relating” functions or services to corresponding functions or services. The format and contents of the information specified are at the discretion of the user and 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 AXSET macro returns control to your program, GPR 15 contains a return code.

Table 1. Return Code for the AXSET Macro
Hexadecimal Return Code	Meaning
00	The AX of the home address space is set to the value specified by the caller.

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.