The requirements for the caller are:

To add a subspace entry to a DU-AL, the caller must be running under the task that created the subspace.

None.

Before issuing the ALESERV 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.

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.

None.

The standard form of the ALESERV macro is written as follows:

The parameters are explained as follows:

ADD

Requests that the system add an entry to the access list and return the ALET. You are required to use two parameters:

• STOKEN specifies the space for which the entry is to be added
• ALET specifies the address of the location where the system returns the ALET.

You can also specify whether the access list is DU-AL or PASN-AL (AL parameter) and, for address spaces, whether the entry is PUBLIC or PRIVATE (ACCESS parameter). The defaults are DU-AL and PUBLIC.

A subspace access list entry must be added to the DU-AL as a public entry.

To add an entry for a SCOPE=COMMON data space to all PASN-ALs in the system, use the AL=PASN parameter on ALESERV ADD.

To add an entry for an address space, the problem state, PSW key 8 - F caller must have EAX-authority to the target address space. The supervisor state or PSW key 0 - 7 caller can use the CHKEAX=NO parameter, which adds an entry for the address space without requiring the caller to have EAX-authority.

To ensure the integrity of data spaces and hiperspaces, the system has certain rules for adding entries for data spaces and hiperspaces to access lists. The following two tables summarize the rules for problem state programs with PSW key 8 - F and supervisor state or PSW key 0 - 7 programs.

Table 1. Rules for Adding Entries for Data Spaces to Access Lists

Function	Type of data space	A problem state program with PSW key 8 - F:	A supervisor state or key 0-7 program:
Add entries to the DU-AL	SCOPE=SINGLE	Can add entries for the data spaces it owns or created.	Can add entries if the caller's home and owner's home address space is the same.
Add entries to the DU-AL	SCOPE=ALL and SCOPE=COMMON	Cannot add entries.	Can add entries.
Add entries to the PASN-AL	SCOPE=SINGLE	Can add entries if the caller owns or creates the data space and the data space is not already on the PASN-AL through the actions of a problem state program with PSW key 8 - F.	Can add entries if its PASN-AL is the same as the PASN-AL of the owner's home address space.
Add entries to the PASN-AL	SCOPE=ALL and SCOPE=COMMON	Cannot add entries.	Can add entries for SCOPE=COMMON data spaces. Can add entries for SCOPE=ALL data spaces if no unauthorized program can run in the primary address space.

Table 2. Rules for Adding Entries for Hiperspaces to Access Lists

Function	Type of hiperspace	A problem state program with PSW key 8 - F:	A supervisor state or key 0-7 program:
Add entries to the DU-AL	Nonshared standard	Can add entries for the hiperspaces it owns.	Can add entries if the caller's home and owner's home address space is the same.
Add entries to the DU-AL	Shared standard and ESO	Cannot add entries.	Can add entries.
Add entries to the PASN-AL	Nonshared standard	Cannot add entries.	Can add entries if its PASN-AL is the same as the PASN-AL of the owner's home address space.
Add entries to the PASN-AL	Shared standard and ESO	Cannot add entries.	Can add entries for shared standard hiperspaces. Can add entries for ESO hiperspaces if no unauthorized program can run in the primary address space.

An access list entry for an ESO hiperspace should never be available to an unauthorized program.

The following notes are for users of data-in-virtual and hiperspaces.

• Once you add an entry for a standard hiperspace, you cannot use that hiperspace as a data-in-virtual object
• If a DIV ACCESS is in effect for a standard hiperspace, you cannot add an entry for that hiperspace.

ADDPASN

Requests that the system add the primary address space to the DU-AL without requiring a user to have EAX-authority to the address space. The entry is a public entry. ALET, required with ADDPASN, receives the ALET that identifies the entry.

DELETE

Requests that the system delete an entry from the DU-AL or the PASN-AL. ALET, required with DELETE, identifies the entry to be deleted.

To delete an entry for an address space, the problem state program with PSW key 8 - F must have EAX-authority to the target address space. The supervisor state or PSW key 0 - 7 caller can use the CHKEAX=NO parameter, which deletes an entry for the address space without requiring the caller to have EAX-authority.

When the request is for a SCOPE=COMMON data space, ALESERV deletes the entry from all PASN-ALs in the system.

EXTRACT

Requests that the system find the STOKEN associated with the specified ALET. The caller can obtain the STOKEN for any space that is represented by a valid entry on the current access list. STOKEN is a required parameter.

SEARCH

Requests that the system search through the DU-AL or PASN-AL for an ALET that corresponds to a specified STOKEN. Specify whether the search is to be through the DU-AL or the PASN-AL. (AL=WORKUNIT is the default.) ALET and STOKEN are required parameters.

EXTRACTH

Requests that the system find the STOKEN of the home address space. STOKEN is a required parameter.

,ACCESS=PUBLIC

,ACCESS=PRIVATE

Specifies whether the access list entry you are adding is PUBLIC or PRIVATE. You cannot add a PRIVATE entry for a data space, subspace, or hiperspace. The default is ACCESS=PUBLIC.

,AL=WORKUNIT

,AL=PASN

Specifies whether the access list is a DU-AL (WORKUNIT) or a PASN-AL (PASN). The default is AL=WORKUNIT.

For the ADD request, AL identifies the type of access list. To add entries for data spaces and hiperspaces to the DU-AL and PASN-AL, see the rules described in Table 1 and Table 2.

For the SEARCH request, AL specifies whether the system is to search through the DU-AL or the PASN-AL.

When adding or searching for a subspace access list entry, you must specify AL=WORKUNIT.

,ALET=alet-addr

Specifies the 4-byte ALET that either you provide or the system returns, depending on the other parameters you specify on ALESERV. When you use RX-type notation, alet-addr specifies the address of the 4-byte field that contains the ALET. When you use register notation, alet-addr specifies a register that contains the ALET itself, rather than the address of the ALET.

For the ADD and ADDPASN requests, the system returns the ALET of the added entry.

For the DELETE request, you provide the ALET for the access list entry to be deleted. Do not specify an ALET of 0, 1, or 2.

For the EXTRACT request, you provide the ALET whose STOKEN you require. The system returns the STOKEN in stoken-addr. When you specify ALET 0, the system returns the caller's primary address space STOKEN. Do not specify ALET 1 on an EXTRACT request.

For the SEARCH request, you specify where in the access list the system is to begin the search:

• If you specify minus one (-1), the system starts searching at the beginning of the DU-AL or PASN-AL.
• If you specify a valid ALET, the system starts searching with the next ALET in the access list.

The system then returns the searched-for ALET, if present. Otherwise, alet-addr is unchanged and register 15 contains a return code that specifies that an ALET for the STOKEN is not on the access list.

,STOKEN=stoken-addr

Specifies an 8-byte identifier of an address space, data space, subspace, or hiperspace. For ADD processing, STOKEN identifies the space that the program wants to access.

For the EXTRACT request, the system returns the STOKEN that corresponds to the specified ALET.

For the SEARCH request, STOKEN identifies the STOKEN for which the system is to return the corresponding ALET.

For the EXTRACTH request, the system returns the STOKEN of the home address space.

,CHKEAX=YES

,CHKEAX=NO

Specifies that ALESERV does (CHKEAX=YES) or does not (CHKEAX=NO) check the EAX authority of the caller to the address space to be added to or deleted from the access list. The default is CHKEAX=YES.

,CHKPT=FAIL

,CHKPT=IGNORE

Specifies how the system is to process a checkpoint request made through the CHKPT macro, relevant to the access list entry being added. If you specify CHKPT=IGNORE, the system ignores the access list entry added (DU-AL or PASN-AL) and processes the checkpoint operation. If you specify CHKPT=FAIL, the system rejects the checkpoint operation. The default is CHKPT=FAIL. Note that this keyword does not apply to an access list entry being added for a SCOPE=COMMON data space. Access list entries for SCOPE=COMMON data spaces are always ignored by the system on a checkpoint request.

If you specify CHKPT=IGNORE, you assume full responsibility of managing the data space, subspace, or hiperspace storage. See z/OS MVS Programming: Extended Addressability Guide for more information.

,RELATED=any-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 may be any valid coding values.

None.

When control is returned from ALESERV ADD, register 15 contains one of the following hexadecimal return codes. A return code of 8 or more means the system rejects the request.

When control is returned from ALESERV ADDPASN, register 15 contains one of the following hexadecimal return codes.

When control is returned from ALESERV DELETE, register 15 contains one of the following hexadecimal return codes.

When control is returned from ALESERV EXTRACT, register 15 contains one of the following hexadecimal return codes.

When control is returned from ALESERV SEARCH, register 15 contains one of the following hexadecimal return codes.

When control is returned from ALESERV EXTRACTH, register 15 contains one of the following hexadecimal return codes.