ITZXFILT — Transaction trace filter exit

Description

The ITZXFILT macro is used to invoke the Transaction Trace filter exit.

Environment

The requirements for the caller are:

Environmental factor Requirement
Minimum authorization: Problem state. PSW key 8 - 15
Dispatchable unit mode: Task or SRB
Cross memory mode: Any PASN, any HASN, any SASN
AMODE: 31-bit
ASC mode: Primary or access register (AR)

If in Access Register ASC mode, specify SYSSTATE ASCENV=AR before invoking this macro.
Interrupt status: Enabled for I/O and external interrupts
Locks: Unlocked or locked
Control parameters: Control parameters must be in the primary address space.

Programming requirements

None.

Restrictions

  1. Addressability to CVT and IHAECVT must be established prior to using this macro.
  2. FRRs are allowed.
  3. The version of the IWMCLSFY parameter list must be 4 or higher.

Input register information

Before issuing the ITZXFILT macro, the caller must insure that the following general purpose registers (GPRs) contain the specified information:
Register
Contents
13
The address of a 72-byte standard save area in the primary address space

Output register information

When control returns to the caller, the GPRs contain:
Register
Contents
0-1
Unpredictable (Used as a work register by the system)
2-13
Unchanged
14
Unpredictable (Used as a work register by the system)
15
Return code
When control returns to the caller, the ARs contain:
Register
Contents
0-1
Unpredictable (Used as a work register by the system)
2-13
Unchanged
14-15
Unpredictable (Used as a work register by the system)

Some callers depend on register contents remaining the same before and after issuing a macro. If the macro changes the contents of registers on which the caller depends, the caller must save them before issuing the macro and restore them after the macro returns control.

Performance implications

None.

Syntax

The ITZXFILT macro is written as follows:

Syntax Description
   
   name name: symbol. Begin name in column 1.
   
␢ One or more blanks must precede ITZXFILT.
   
ITZXFILT  
   
␢ One or more blanks must follow ITZXFILT.
   
FILTPARM=filtparm filtparm: RS-type address or address in register (2) - (12).
   
,WKAREA=wkarea wkarea: RS-type address or address in register (2) - (12).
   
  ,RETCODE=retcode retcode: RS-type address or address in register (2) - (12).
   

Parameters

The parameters are explained as follows:

name
This is an optional symbol, starting in column 1, that is the name on the ITZXFILT macro invocation. The name must conform to the rules for an ordinary assembler language symbol.
FILTPARM=filtparm
This is a required input parameter of the IWMCLSFY parameter list to be passed to the transaction trace filter exit.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,WKAREA=wkarea
This is a required input parameter of a 256-byte work area to be used by the transaction trace filter exit routine.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,RETCODE=retcode
This is an optional output parameter into which the return code is to be copied from GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

ABEND codes

None.

Return and reason codes

When the ITZXFILT macro returns control to your program, GPR 15 (and retcode, when you code RETCODE) contains a return code.

The following table identifies the hexadecimal return and reason codes.

Table 1. Return and Reason Codes for the ITZXFILT Macro
Return Code Meaning and Action
0 Meaning: The transaction trace token was created.

Action: None.
4 Meaning: The transaction trace token was not created.

Action: If the address of the 32-character transaction trace token field was not provided, provide it in the parameter list. Otherwise, the token was not created because of no match between the input parameter attributes and the transaction trace filter sets attributes.

Example

          IWMCLSFY MF=(L,TT_PARM),PLISTVER=MAX
          USING TT_PARM,R5
          LA    R1,TRANNAME
          ST    R1,TT_PARM_XTRXNAME_ADDR
          LA    R1,TRANTOKN
          ST    R1,TT_PARM_XTTRACETOKEN_ADDR
          ITZXFILT FILTPARM=TT_PARM,WKAREA=TT_WORK
          SPACE 1
          LTR   R15,R15
          BC    NZERO,NOTOKEN
          .
          .
 NOTOKEN  DS    0H
          .
          .
 TT_WORK  DS    CL256
 TRANNAME DC    CL8'MYWORKNM'
 TRANTOKN DC    CL32' '