IEAINTKN — Build incident token

Description

Use the IEAINTKN macro to build an incident token. You can pass the token to other routines to identify related pieces of problem data.

Normally you will not need to use an IEAINTKN macro because the system generates an incident token when an SVC dump is requested and an incident token is not provided. For example, the system provides an incident token when it processes an SDUMPX macro without an INTOKEN parameter.

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
ASC mode: Primary or access register (AR)
Interrupt Status: Enabled or disabled for I/O and external interrupts
Locks: The caller may hold locks, but is not required to hold any.
   

Programming requirements

  • Place the TOKEN area in the primary address space or, for AR-mode callers, in an address space or data space that is addressable through an ALET that you provide.
  • Include the CVT mapping macro.

Restrictions

None.

Input register information

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

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-15
Used as work registers by the system
When control returns to the caller, the access registers (ARs) contain:
Register
Contents
0-1
Used as work registers by the system
2-13
Unchanged
14-15
Used as work registers 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.

Performance implications

None.

Syntax

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

Syntax Description
 
   name name: Symbol. Begin name in column 1.
   
␢ One or more blanks must precede IEAINTKN.
   
IEAINTKN  
   
␢ One or more blanks must follow IEAINTKN.
   
,TOKEN=inctoken addr inctoken addr: RX-type address or register (2) - (12).
   

Parameters

The parameters are explained as follows:

TOKEN=inctoken addr
Specifies the address of a 32-character area where the system builds the incident token. The area must begin on a doubleword boundary.

ABEND codes

None.

Return and reason codes

None.

Example

Provide an incident token in the area named MYTOKEN. 
          IEAINTKN TOKEN=MYTOKEN
          .
          .
          .
          DS  0D         Align parameter on double word boundary
 MYTOKEN  DS  CL32       Incident token
          CVT ,          CVT mapping