XCTRC - DFHXCTRA parameter list definition

      CONTROL BLOCK NAME = DFHXCTRC
      DESCRIPTIVE NAME = CICS TS External CICS Interface, DFHXCTRA
                                  Parameter list definition.
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1992, 2010 
      FUNCTION = This file contains the XCTRA_PLIST definition. This
           DSECT defines the parameter list between DFHXCTRP (the
           EXCI trace module) and DFHXCTRA (the EXCI global trap
           module). Akin the CICS trap module DFHTRAP.
           If DFHXCTRA is active, (by having TRAP=ON defined in
           DFHXCOPTS), then DFHXCTRA will be invoked for every
           trace entry put out by the EXCI facility.
      LIFETIME = The storage mapped by this DSECT is GETMAINED
           by DFHXCTRI on the very first Init user request on every
           TCB, and kept until TCB termination.
      LOCATION = The XCTRA_PLIST dsect is actually part of a larger
           control block called TRAP_WA (also included in this copy
           book), which includes the areas pointed at by fields in
           XCTRA_PLIST. TRAP_WA is chained off the XCGLOBAL for the
           TCB.
      NOTES :
       DEPENDENCIES = S/390
       RESTRICTIONS = None.
       MODULE TYPE = Control block definition
     ------------------------------------------------------------------
        XCTRL - Mapping of LIFO storage required by DFHXCTRP, DFHXCTRI
                and DFHXCDMP.
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 580 XCTRL
(0) CHARACTER 72 RSA Save Area for external calls
(0) FULLWORD 4 * Reserved
(4) FULLWORD 4 RSACB Backward Pointer
(8) FULLWORD 4 RSACF Forward Pointer
(C) FULLWORD 4 * (4294967311:456248976) Regs 14 - 12
(48) ADDRESS 4 PLIST_PTR Pointer to base plist on
(4C) FULLWORD 4 AREA_LENGTH Used in table initialisation
(50) FULLWORD 4 BLOCK_COUNT Used in table initialisation
(54) FULLWORD 4 I Loop Index
(58) FULLWORD 4 J Loop Index
(5C) FULLWORD 4 * Reserved
(60) ADDRESS 8 SAVEGR14 area to save R14
(68) ADDRESS 8 SAVE2GR14 area to save R14
(70) ADDRESS 8 BACKPTR Used in table initialisation
(78) ADDRESS 8 TR_BLOCK_PTR Base for DFHTRBL structure
(80) ADDRESS 8 ENTRY_PTR Ptr to entry in table
(88) FULLWORD 4 ENTRY_LEN Entry length
(8C) BIT(8) 1 FOOTPRINTS Footprint flags
(8C) 1... ....   TRA_FREEMAIN_REQ Freemain of DFHTRA required
(8C) .1.. ....   TABLE_FREEMAIN_REQ Freemain of Trace table req.
(8C) ..1. ....   TRAP_WA_FREEMAIN_REQ Freemain of trap wa required
(8C) ...1 ....   GTF_BUF_FREEMAIN_REQ Freemain of GTF buffer req.
(8C) .... 1...   MOVING_DATA Moving Data into trace table
(8C) .... .1..   TRAP_IN_CONTROL Control passed to DFHXCTRA.
(8C) .... ..1.   OVERLENGTH_ENTRY overlength entry detected
(8C) .... ...1   * Reserved
(8D) BIT(8) 1 * (4294967299:456248976) Reserved
(90) CHARACTER 16 XCSVC_PLIST Parameter list to call XCSVC
(90) ADDRESS 4 XCSVC_CODEP Pointer to dump code
(94) ADDRESS 4 XCSVC_IDP Pointer to dump id
(98) ADDRESS 4 XCSVC_USERP Pointer to user name
(9C) ADDRESS 4 XCSVC_TCBP Pointer to TCB address
(A0) CHARACTER 8 WORK8 Work area for CVD and unpack
(A8) CHARACTER 8 TCBA_STR Char form of TCB address
(B0) CHARACTER 3 WORK3 work area
(B3) CHARACTER 4 SDUMP_RC Save area for SDUMP rc
(B7) CHARACTER 9 WORK9 Work area
(C0) CHARACTER 5 WORK5 Work area
(C5) CHARACTER 4 WORK4 work area
(C9) CHARACTER 3 * reserved
(CC) HALFWORD 2 INDEX Index into string
(CE) HALFWORD 2 RETRY_TIME_TO_GO SDUMP retry time left
(D0) ADDRESS 4 MSG_PLIST_PTR Pointer to mebm plist
(D4) BIT(8) 1 XCDMP_FOOTPRINTS footprints for XCDMP
(D4) 1... ....   STIMERM_FAILED remember STIMERM failed
(D4) .1.. ....   BUSY_MSG_ISSUED Only issue busy msg once
(D4) ..1. ....   SYSTEM_DUMP_TKN sdump has been taken
(D4) ...1 1111   * Reserved
(D5) BIT(8) 1 * (4294967299:456248976) Reserved
(D8) CHARACTER 184 MSG_PARM_AREA plist for MEBM
(190) ADDRESS 4 MEBM_TEMP_PTR temp ptr used for mebm
(194) CHARACTER 132 XCTRL_MSG Message buffer
(194) HALFWORD 2 XCTRL_MSG_LEN LL
(196) HALFWORD 2 XCTRL_MSG_0 BB
(198) CHARACTER 124 XCTRL_MSG_TEXT Maximum size msg output
(214) CHARACTER 4 XCTRL_MSG_WTO_PARMS Space for extra WTO parms
(218) UNSIGNED 4 * Reserved
(220) ADDRESS 8 GTF_PTR Address of data for GTRACE
(228) UNSIGNED 4 GTF_LEN Length of data for GTRACE *
(22C) UNSIGNED 4 GTF_LTG Length-to-go for GTRACE
(230) CHARACTER 8 GTRACE_AUTO Parameter area for GTRACE *
(238) CHARACTER 12 XCTRL_SYMP_STR symptom string
(238) CHARACTER 8 XCTRL_SYMP_STR_USER user name
(240) CHARACTER 2 XCTRL_SYMP_STR_TPT trace point id
(242) CHARACTER 2 * Reserved 
        XCTRA_PLIST - Parameter list passed to Global trap DFHXCTRA
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 72 XCTRA_PLIST 
     XCTRA_FLGSA Address of return actions flag word
     Return actions flag settings are in the byte addressed from
     field XCTRA_FLGSA in the parameter list to DFHXCTRA.
     The individual flag settings are as follows, and are declared
     as constants at the end of the structure.
     XCTRA_FTRE EQU X'80' .. Make further trace entry on
                                 behalf of trap exit
     XCTRA_DUMP EQU X'40' .. Take a system dump
     XCTRA_SKIP EQU X'20' .. Skip putting current trace entry
                                 out to GTF
     XCTRA_DISA EQU X'10' .. Disable trap so that it cannot
                                 be used again under this TCB.
     Any combination of these flags may be set and wherever possible
     all requested actions will be honoured upon return to DFHXCTRP.
(0) ADDRESS 4 XCTRA_FLGSA A(Return actions flag word)
(4) ADDRESS 4 * Reserved 
     XCTRA_CURTA Address of current entry in internal trace table
     This field points to the trace entry constructed by DFHXCTRP
     on the same invocation for which it is calling DFHXCTRA. This
     entry should not be modified by DFHXCTRA. Its structure is
     mapped by the DSECT DFHTREN.
(8) ADDRESS 8 XCTRA_CURTA A(Current entry) 
     XCTRA_WORKA Address of 80-byte work area for DFHXCTRA.
     This work area is acquired when DFHXCTRA is activated and is
     not changed by the EXCI until DFHXCTRA is de-activated, so it
     may be used for saving information between invocations of
     DFHXCTRA.
(10) ADDRESS 4 XCTRA_WORKA A(80-byte work area) 
     TRAD1A/L, TRAD2A/L and TRAD3A/L
     These six fields are used in conjunction with the setting of
     XCTRA_FTRE in the return actions flag byte. This flag indicates
     that DFHXCTRP should make a further trace entry. TRADnA/L are
     address and length pairs for the data fields to be included in
     this entry. If XCTRA_FTRE is set, DFHXCTRP examines the length
     fields in turn. All fields up to the first with a zero length
     will be included in the extra trace entry.
(14) CHARACTER 24 XCTRA_TRDAT Total length of data fields
(14) ADDRESS 4 XCTRA_TRAD1A Address of DATA1 information
(18) UNSIGNED 4 XCTRA_TRAD1L Length of DATA1 information
(1C) ADDRESS 4 XCTRA_TRAD2A Address of DATA2 information
(20) UNSIGNED 4 XCTRA_TRAD2L Length of DATA2 information
(24) ADDRESS 4 XCTRA_TRAD3A Address of DATA3 information
(28) UNSIGNED 4 XCTRA_TRAD3L Length of DATA3 information 
     XCTRA_XCGLOBALA - Address of the XCGLOBAL block for this TCB.
                       Address may be 0 if block not set up yet.
(2C) ADDRESS 4 XCTRA_XCGLOBALA A(XCGLOBAL block) 
     XCTRA_XCUSERA - Address of the XCUSER block representing the
                     particular user on whose behalf this request
                     is running.
                     Address may be 0 if block not set up yet.
(30) ADDRESS 4 XCTRA_XCUSERA A(XCUSER blcok) 
     XCTRA_XCPIPEA - Address of the XCPIPE block representing the
                     particular pipe being used for this request for
                     this user.
                     Address may be 0 if block not set up yet.
(34) ADDRESS 4 XCTRA_XCPIPEA A(XCPIPE) 
     XCTRA_XCPRH_WAA - Address of the working storage of the program
                       request handler.
                       Address may be 0 if block not set up yet.
(38) ADDRESS 4 XCTRA_XCPRH_WAA A(DFHXCPRH's working storage) 
     XCTRA_XCEIP_WAA - Address of the working storage of the EXEC
                       Interface program.
                       Address may be 0 if block not set up yet, or
                       the EXCI EXEC Interface is not being used.
(3C) ADDRESS 4 XCTRA_XCEIP_WAA A(DFHXCEIP's working storage) 
     XCTRA_RSAA - Address of the register save area to be used by
                  DFHXCTRA.
(40) ADDRESS 4 XCTRA_RSAA RSA address
(44) ADDRESS 4 * Reserved
(48) CHARACTER 0 XCTRA_PLIST_END Ending address 
        TRAP_WA - Work areas for Global trap DFHXCTRA
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 1024 TRAP_WA
(0) CHARACTER 72 TRAP_REGSAVE RSA for DFHXCTRA
(48) CHARACTER 72 TRAP_PLIST
(90) BIT(8) 1 TRAP_FLAGS Trap return action flags
(90) 1... ....   TRAP_TRACE Further trace entry required
(90) .1.. ....   TRAP_DUMP system dump required
(90) ..1. ....   TRAP_SKIP_GTF Skip outputting entry to GTF
(90) ...1 ....   TRAP_DISABLE Disable the trap
(90) .... 1111   * Reserved
(91) BIT(24) 3 * Reserved
(94) CHARACTER 128 TRAP_TR_DU_PLIST Area for plist for calling trace and dump
(114) CHARACTER 580 TRAP_TR_DU_WS Working stg required for recursive Trace call.
(358) CHARACTER 72 TRAP_TR_DU_RSA RSA for recursive trace call
(3A0) CHARACTER 96 TRAP_WORK Force D-word alignment for..
(3A0) CHARACTER 16 TRAP_WORK_EYEC '>DFHXCTRA_WKAREA' eyecatcher
(3B0) CHARACTER 80 TRAP_WORKAREA Work area for DFHXCTRA

Constants

Table 4.
Len Type Value Name Description 
     Constants for use with XCTRA_FLGSA
1 HEX 80 XCTRA_FTRE
1 HEX 40 XCTRA_DUMP
1 HEX 20 XCTRA_SKIP
1 HEX 10 XCTRA_DISA 
      External CICS Interface Trace Points
      Note: The exception trace point IDs correspond to the EXCI
            return code values for the particular error.
            Please consult DFHXCRCC if any changes are made.
2 HEX 0001 XCPRH_PIPE_ALREADY_ OPEN
2 HEX 0002 XCPRH_PIPE_ALREADY_ CLOSED
2 HEX 0003 XCPRH_VERIFY_BLOCK_FM_ ERROR
2 HEX 0005 XCPRH_XCP_FM_ERR
2 HEX 0006 XCPRH_IRP_IOAREA_FM_ ERR
2 HEX 0007 XCPRH_SERVER_ TERMINATED
2 HEX 0008 XCPRH_XFRASTG1_FM_ERR
2 HEX 0201 XCPRH_NO_CICS_IRC_ STARTED
2 HEX 0202 XCPRH_NO_PIPE
2 HEX 0203 XCPRH_NO_CICS_ON_OPEN
2 HEX 0204 XCPRH_NO_CICS_ON_DPL_1
2 HEX 0205 XCPRH_NO_CICS_ON_DPL_2
2 HEX 0206 XCPRH_NO_CICS_ON_DPL_3
2 HEX 0403 XCPRH_INVALID_APPL_ NAME
2 HEX 0405 XCPRH_PIPE_NOT_CLOSED
2 HEX 0406 XCPRH_PIPE_NOT_OPEN
2 HEX 0407 XCPRH_INVALID_USERID
2 HEX 0408 XCPRH_INVALID_UOWID
2 HEX 0409 XCPRH_INVALID_TRANSID
2 HEX 0414 XCPRH_ABORT_RECEIVED
2 HEX 0415 XCPRH_INVALID_ CONNECTION
2 HEX 0416 XCPRH_INVALID_CICS_ RELEASE
2 HEX 0417 XCPRH_PIPE_MUST_CLOSE
2 HEX 0418 XCPRH_INVALID_PIPE_ TOKEN
2 HEX 0422 XCPRH_SERVER_ABENDED
2 HEX 0423 XCPRH_SURROGATE_CHECK_ FAILED
2 HEX 0426 XCPRH_INVALID_TRANSID2
2 HEX 0427 XCPRH_INVALID_CCSID
2 HEX 0428 XCPRH_INVALID_ENDIAN
2 HEX 0603 XCPRH_XCUSER_GM_ERROR
2 HEX 0604 XCPRH_XCPIPE_GM_ERROR
2 HEX 0605 XCPRH_VERIFY_BLOCK_GM_ ERROR
2 HEX 0606 XCPRH_SSI_VERIFY_ FAILED
2 HEX 0607 XCPRH_SVC_CALL_FAILURE
2 HEX 0608 XCPRH_IRP_LOGON_ FAILURE
2 HEX 0609 XCPRH_IRP_CONNECT_FAIL
2 HEX 0610 XCPRH_IRP_DISC_FAIL
2 HEX 0611 XCPRH_IRP_LOGOFF_ FAILED
2 HEX 0612 XCPRH_TRANSFORM_1_ ERROR
2 HEX 0613 XCPRH_TRANSFORM_4_ERR
2 HEX 0614 XCPRH_IRP_NULL_DATA
2 HEX 0615 XCPRH_IRP_NEG_RESPONSE
2 HEX 0616 XCPRH_IRP_SWITCH_PULL_ ERR
2 HEX 0617 XCPRH_IRP_IOAREA_GM_ ERR
2 HEX 0619 XCPRH_IRP_BAD_IOAREA
2 HEX 0620 XCPRH_IRP_PROTOCOL_ERR
2 HEX 0621 XCPRH_PIPE_RECOVERY_ FAILURE
2 HEX 0622 XCPRH_ESTAE_SETUP_FAIL
2 HEX 0623 XCPRH_ESTAE_INVOKED
2 HEX 0624 XCPRH_TIMEDOUT
2 HEX 0625 XCPRH_STIMER_SETUP_ FAIL
2 HEX 0626 XCPRH_STIMER_CANCEL_ FAIL
2 HEX 0627 XCPRH_INCORRECT_SVC_ LVL
2 HEX 0628 XCPRH_INCORRECT_IRP_ LVL
2 HEX 0629 XCPRH_SERVER_PROTOCOL_ ERR
2 HEX 0800 XCPRH_LENGERR
2 HEX 0801 XCPRH_INVREQ
2 HEX 0802 XCPRH_PGMIDERR
2 HEX 0803 XCPRH_ROLDBACK
2 HEX 0804 XCPRH_NOTAUTH
2 HEX 0805 XCPRH_SYSIDER
2 HEX 0806 XCPRH_TERMERR
2 HEX 0807 XCPRH_RESUNAVAIL
2 HEX 1000 XCPRH_ENTRY
2 HEX 1001 XCPRH_EXIT
2 HEX 1010 XCEIP_ENTRY
2 HEX 1011 XCEIP_EXIT
2 HEX 2000 XCPRH_IRP_LOGON
2 HEX 2001 XCPRH_IRP_CONN
2 HEX 2002 XCPRH_IRP_DISC
2 HEX 2003 XCPRH_IRP_LOGOFF
2 HEX 2004 XCPRH_IRP_SWITCH
2 HEX 2005 XCPRH_IRP_SWITCH_DATA
2 HEX 2006 XCPRH_IRP_DATA
2 HEX 2007 XCPRH_PRE_URM
2 HEX 2008 XCPRH_POST_URM
2 HEX 2009 XCPRH_PRE_RACROUTE
2 HEX 200A XCPRH_POST_RACROUTE
2 HEX 0900 XCTRI_TRA_GM_ERROR
2 HEX 0901 XCTRI_TRACE_TABLE_GM_ ERROR
2 HEX 0902 XCTRI_TRAP_WA_GM_ERROR
2 HEX 0903 XCTRI_GTF_BUFFER_GM_ ERROR
2 HEX 0904 XCTRP_OVERLENGTH_ENTRY
2 HEX 0905 XCTRA_REQUESTED_ENTRY
2 HEX 0906 XCTRI_TIME_WA_GM_ERROR
2 HEX 3000 XCEIP_ESTAE_SETUP_ ERROR
2 HEX 3001 XCEIP_ESTAE_INVOKED
2 HEX 3002 XCEIP_INV_CTYPE_ON_ INIT
2 HEX 3003 XCEIP_INV_VNUM_ON_INIT
2 HEX 3004 XCEIP_INV_ANAME_ON_ INIT
2 HEX 3005 XCEIP_INV_CTYPE_ON_ ALLOC
2 HEX 3006 XCEIP_INV_VNUM_ON_ ALLOC
2 HEX 3007 XCEIP_INV_UTOKEN_ON_ ALLOC
2 HEX 3008 XCEIP_INV_CTYPE_ON_ OPEN
2 HEX 3009 XCEIP_INV_VNUM_ON_OPEN
2 HEX 3010 XCEIP_INV_UTOKEN_ON_ OPEN
2 HEX 3011 XCEIP_INV_PTOKEN_ON_ OPEN
2 HEX 3012 XCEIP_INV_CTYPE_ON_DPL
2 HEX 3013 XCEIP_INV_VNUM_ON_DPL
2 HEX 3014 XCEIP_INV_UTOKEN_ON_ DPL
2 HEX 3015 XCEIP_INV_PTOKEN_ON_ DPL
2 HEX 3017 XCEIP_INV_USERID
2 HEX 3018 XCEIP_PIPE_NOT_OPEN_ ON_DPL
2 HEX 3019 XCEIP_PIPE_MUST_CLOSE_ ON_DPL
2 HEX 3020 XCEIP_INV_CTYPE_ON_ CLOSE
2 HEX 3021 XCEIP_INV_VNUM_ON_ CLOSE
2 HEX 3022 XCEIP_INV_UTOKEN_ON_ CLOSE
2 HEX 3023 XCEIP_INV_PTOKEN_ON_ CLOSE
2 HEX 3024 XCEIP_INV_CTYPE_ON_ DEALL
2 HEX 3025 XCEIP_INV_VNUM_ON_ DEALL
2 HEX 3026 XCEIP_INV_UTOKEN_ON_ DEALL
2 HEX 3027 XCEIP_INV_PTOKEN_ON_ DEALL
2 HEX 3028 XCEIP_PIPE_NOT_CLOSED_ ON_DEALL
2 HEX 3029 XCEIP_RETRYING
2 HEX 3030 XCEIP_SURROGATE_CHK_ FAIL_ON_DPL
2 HEX 4000 XCGUR_ENTRY
2 HEX 4001 XCGUR_EXIT
2 HEX 4002 XCGUR_PRE_SVC
2 HEX 4003 XCGUR_POST_SVC
2 HEX 4004 XCGUR_RRS_NOT_ SUPPORTED
2 HEX 4005 XCGUR_RRS_ERROR
2 HEX 4006 XCGUR_SVC_EXCEPTION
2 HEX 4007 XCGUR_GETMAIN_ERR