ATSET — Set authorization table

Description

The ATSET macro sets up an entry in the authorization table or in the authorization table bits. ATSET sets the PT and SSAR authority in the authorization table entry of the home address space. The authorization index value (AX) determines what entry is set.

The extended authorization index (EAX) determines what authorization table bits are set. To an address space, the EAX authority and SSAR authority are the same.

Related macros

ATEXT, 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 addressable in the caller's primary address space

Programming requirements

None.

Restrictions

None.

Input register information

The ATSET 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 ATSET 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-1: Used as work registers 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 ATSET macro:

Syntax	Description

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

␢	One or more blanks must precede ATSET.

ATSET

␢	One or more blanks must follow ATSET.

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

,PT=NO	Default: PT=NO
,PT=YES

,SSAR=NO	Default: SSAR=NO
,SSAR=YES

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

Parameters

These are the parameters:

AX=ax value: Specifies the AX value for which the PT and SSAR authority are to be set. The RX-type address points to the address of a half word containing the AX value. It is addressable in primary mode. When the register form is used, the AX value must be in bits 16-31. Bits 0-15 are ignored.
,PT=NO
,PT=YES: Specifies, YES or NO, whether program transfer (PT) is allowed into the home address space by routines executing with the specified AX.
,SSAR=NO
,SSAR=YES: Specifies, YES or NO, whether routines, executing with the specified AX, are allowed to establish secondary addressability to the home address space. It also specifies, YES or NO, whether routines with the specified EAX are allowed to access the address space through access registers.
,RELATED=value: Specifies information used to self-document macros. It “relates” functions or services to corresponding functions or services. The user can use any valid coding value. The format and contents are at the user's discretion.
Note: Every time you invoke the ATSET macro, you must set PT and SSAR authority. Specify: PT=YES.

ABEND codes

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

Return codes

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

Table 1. Return Code for the ATSET Macro.
Hexadecimal Return Code	Meaning
00	The selected authorization table entry has been set.

Examples

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