TIE - Task interface element

      CONTROL BLOCK NAME = DFHTIEPS
      DESCRIPTIVE NAME = CICS TS Task Interface Element
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1994, 2010 
      FUNCTION =
           PLX Structure of the TIE, which represents the intersection
           of a CICS task (TCA) with a named External Resource Manager
           represented by a Task Related User Exit (TRUE). An enabled
           TRUE is represented by an User Exit Program Block (EPB).
           The TIE holds all the task lifetime information which is
           passed betweena CICS task and a named External Resource
           Manager.
           The TIE belongs to the external resource manager module
           DFHERM. There can be many TIEs per CICS task. TIEs are
           chained off the TCA.
      LIFETIME =
           A TIE is acuired the first time a TRUE is invoked by a
           CICS task. There is one TIE for each TRUE a task invokes.
           All TIEs for a task are freemained by DFHERM at end of task.
      STORAGE CLASS =
           TIEs are getmained from a dedicated subpool for each TRUE.
           Appended to the end of the TIE, is the Task Local Work Area
           for the TRUE, whose size is specified when the TRUE is
           enabled. Hence TIEs for different TRUEs are different sizes.
           A TIE subpool is located above the line only if the TRUE
           TRUE is ENABLED specifying LINKEDITMODE, and the TRUE has
           been linkedited amode(31), meaning that the TRUE is always
           invoked in amode(31).
      LOCATION =
           The head of the TIE chain is TCATIEBA in the system TCA.
           Within a TIE is TIECHNA which points to the next TIE on
           the chain for the task.
      INNER CONTROL BLOCKS = None
      NOTES :
       DEPENDENCIES = S/390
       RESTRICTIONS = None
       MODULE TYPE = Control block definition
     ------------------------------------------------------------------
      EXTERNAL REFERENCES = None
      DATA AREAS = None
      CONTROL BLOCKS = None
      GLOBAL VARIABLES (Macro pass) = None
     ------------------------------------------------------------------
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 128 DFHTIEDS
(0) CHARACTER 16 TIE_PREFIX Standard Prefix
(0) HALFWORD 2 TIE_LEN Length (inc. work area)
(2) CHARACTER 14 TIE_EYE Eyecatcher
(2) CHARACTER 6 TIE_EYE1 '>TIE--'
(8) CHARACTER 8 TIE_EYE2 Resource Manager name
(10) ADDRESS 4 TIECHNA Addr next TIE on TCA chain
(14) ADDRESS 4 TIEUTCA Addr of our TCA (user TCA)
(18) ADDRESS 4 TIETRUEP Addr of current UEPAR plist for TRUE - for dump's use
(1C) ADDRESS 4 TIESECBLK Addr user security block
(20) BIT(8) 1 TIESECFLG Security flags
(20) 1... ....   TIENOSEC Security inactive
(20) .1.. ....   * Reserved
(20) ..1. ....   TIESEC Security active for system
(20) ...1 1111   * Reserved
(21) BIT(8) 1 TIEEISFG EIS settings for the TRUE
(21) 1... ....   TIEVALID TIEEISFG settings are valid
(21) .1.. ....   TIEDAT31 True has DATALOCATION(ANY)
(21) ..1. ....   TIECEDFY True has CEDF(YES)
(21) ...1 ....   TIECICS True has tdatakey(CICS)
(21) .... 1111   * Reserved
(22) BIT(8) 1 TIETRACE Trace flags for TRUE
(22) 1... ....   TIETRLV1 RMI level 1 trace active
(22) .1.. ....   TIETRLV2 RMI level 2 trace active
(22) ..11 1111   * Reserved
(23) BIT(8) 1 * Reserved
(24) UNSIGNED 4 TIEPBTOK WLM PB token
(28) FULLWORD 4 TIERCNT TRUE recursion count
(2C) ADDRESS 4 TIEEPAD Addr of EIP transfer vector 
         Recovery Section of TIE. These fields are shared between
         DFHERM and DFHERMSP which is the RMI syncpoint processor
         called by Recovery Manager Domain
(30) CHARACTER 68 TIERECOV Recovery section of TIE
(30) CHARACTER 8 TIERTKN Current UOW id
(38) CHARACTER 27 TIE62UOW Network wide (LU 6.2) UOWID
(53) CHARACTER 1 * filler to word align
(54) CHARACTER 8 TIEEPN Resource Manager name
(5C) CHARACTER 8 TIERMQUA Reource manager qualifier
(64) BIT(32) 4 TIELTOK Link token returned by RM
(68) ADDRESS 4 TIEEPBA Addr of EPB for this TRUE
(6C) BIT(8) 1 TIEFOOTP Footprints for RM Dom calls
(6C) 1... ....   TIEADDLK RMLN ADD_LINK issued
(6C) .1.. ....   TIERNEC Recovery(necessary) set
(6C) ..1. ....   TIESINGU Single_updater(yes) set
(6C) ...1 ....   TIESETTK Set work token issued
(6C) .... 1...   TIESETHR Set heurism(yes) issued
(6C) .... .1..   TIESETLI SET_LINK LINK_ID issued
(6C) .... ..1.   TIETRABD True has abended
(6C) .... ...1   TIENOLNK Add_link too late
(6D) BIT(8) 1 TIESYNCP TRUE's syncpoint parms
(6D) 1... ....   TIESUPDR TRUE understands single.. updater protocol
(6D) .1.. ....   TIEREADO TRUE understands read-only protocol
(6D) ..11 1111   * Reserved
(6E) BIT(16) 2 * Reserved 
         TIEFLAGS is the target of UEPFLAGS during RMI execution. It
         is initialised from the TRUE's interest profile in the EPB
         (EPBFLAGS). The first byte of TIEFLAGS is reserved for
         CICS/VS 1.5 compatibility.
(70) BIT(32) 4 TIEFLAGS TRUE interest profile
(70) BIT(8) 1 TIEFLAG0 Byte 0
(71) BIT(8) 1 TIEFLAG1 Byte 1
(72) BIT(8) 1 TIEFLAG2 Byte 2
(72) 111. ....   *
(72) ...1 ....   TIEMFEDF Interest in EDF
(72) .... 1...   *
(72) .... .1..   TIEMCTER Interest in shutdown
(72) .... ..1.   *
(72) .... ...1   TIEMTASK Interest in task start/end
(73) BIT(8) 1 TIEFLAG3 Byte 3
(73) 111. ....   *
(73) ...1 ....   TIEMSYNC Interest in Syncpoint
(73) .... 1...   TIEMRORM Avoid unshunting
(73) .... .1..   TIEMAPPL Interest in API calls
(73) .... ..1.   TIEMSPI Interest in SPI calls
(73) .... ...1   * 
         End of Recovery Section
(74) HALFWORD 2 TIEGAL Global work area length
(76) HALFWORD 2 TIETAL Task Local work area length
(78) ADDRESS 4 TIEFREE Free TIE forward chain 
         NOTE: The offset of TIELWAA must not be changed.
(7C) ADDRESS 4 TIELWAA Address of LWA 
         End of the task Interface Element
(80) CHARACTER 0 TIEENDA End of TIE 
         Start of TRUE's Task Local Work Area (if one exists)
(80) CHARACTER 0 TIELWA Start of TRUE's work area - must be doubleword aligned.

Constants

Table 2.
Len Type Value Name Description 
     RMI Trace points
      DFHERMSP
2 HEX 2500 ERMSP_ENTRY ERMSP entry
2 HEX 2501 ERMSP_EXIT ERMSP exit
2 HEX 2502 ERMSP_INV_FORMAT Invalid format
2 HEX 2503 ERMSP_INV_RMRO_ FUNCTION
        Invalid rmro function
2 HEX 2504 ERMSP_INV_RMLK_ FUNCTION
        Invalid rmlk function
2 HEX 2505 ERMSP_RECOVERY Recovery routine entered
2 HEX 2506 ERMSP_RMWTI_SET_FAIL SET WORK_TOKEN from ERMSP has failed
2 HEX 2507 ERMSP_RMUWM_INQ_UOW_ FAIL
        INQ UOW from ERMSP has failed
2 HEX 2508 ERMSP_XMAT_ATTACH_FAIL
        attach from ERMSP has failed
2 HEX 2509 ERMSP_RMI_BEFORE ERMSP is about to call the RMI
2 HEX 2510 ERMSP_RMI_AFTER Control has returned to ERMSP from the RMI 
      DFHERM
2 HEX 2520 ERM_ENTRY entry trace
2 HEX 2521 ERM_EXIT exit trace
2 HEX 2522 ERM_ABOUT_TO_CALL_TRUE
        Passing control to the true
2 HEX 2523 ERM_RETURN_FROM_TRUE Receiving control back from the TRUE
2 HEX 2524 ERM_RM_NOT_AVAILABLE TRUE disabled
2 HEX 2525 ERM_ADD_LINK_FAIL ADD LINK from ERM has failed
2 HEX 2526 ERM_SET_LINK_FAIL SET LINK from ERM has failed
2 HEX 2527 ERM_RMWTI_SET_FAIL SET WORK_TOKEN from ERM has failed
2 HEX 2528 ERM_RMUWI_INQ_FAIL INQ UOW ID from ERM has failed
2 HEX 2529 ERM_SET_UOW_FAIL SET UOW from from ERM has failed
2 HEX 2530 ERM_PGEX_ERROR_BEFORE
        PGEX error before calling TRUE
2 HEX 2531 ERM_PGEX_ERROR_AFTER PGEX error after calling TRUE
2 HEX 2532 ERM_PGEX_ERROR_RECOV PGEX error during recovery processing
2 HEX 2533 ERM_RECOVERY_ENTERED ERM's recovery routine invoked
2 HEX 2534 ERM_CHAIR_MODIFIED XPCHAIR exit in DFHERM modified handle address
2 HEX 2535 ERM_CHANGE_MODE_FAILED 
      DFHRMSY
2 HEX 2540 RMSY_ENTRY RMSY entry
2 HEX 2541 RMSY_EXIT RMSY exit
2 HEX 2542 RMSY_XMIQM_INQ_TRAN_ FAIL
        XMIQM from RMSY failed
2 HEX 2543 RMSY_RMUWM_INQ_UOW_ FAIL
        RMUWM inq uow from RMSY has failed
2 HEX 2544 RMSY_RMDMM_INQ_ STARTUP_FAIL
        RMDM call from RMSY has failed
2 HEX 2545 RMSY_UNEXPECTED_RMLN_ REASON
        RMSY received an unexprected reason for an exception response from rmln initiate_rec.
2 HEX 2546 RMSY_BAD_RMLN_RESPONSE
        RMSY received serious error from rmln call
2 HEX 2547 RMSY_RMLN_TERMINATE_ FAIL
        Terminate recovery issued by RMSY has failed
2 HEX 2548 RMSY_RMI_BEFORE RMSY is about to call the RMI
2 HEX 2549 RMSY_RMI_AFTER Control has returned to RMSY from the RMI 
      DFHERMRS
2 HEX 2560 ERMRS_ENTRY ERMRS entry
2 HEX 2561 ERMRS_EXIT ERMRS exit
2 HEX 2562 ERMRS_INV_EIP_FUNCTION
        ERMRS called for wrong EIP function
2 HEX 2563 ERMRS_INV_FUNCTION Invalid eiei function
2 HEX 2564 ERMRS_RMLN_START_LINK_ FAIL
        RMLN start link browse from ERMRS failed
2 HEX 2565 ERMRS_RMLN_GET_NEXT_ LINK_FAIL
        RMLN getnext_link from ERMRS failed
2 HEX 2566 ERMRS_RMLN_END_LINK_ BROWSE_FAIL
        RMLN end link browse from ERMRS failed
2 HEX 2567 ERMRS_RECOVERY Recovery routine entered
2 HEX 2568 ERMRS_RMUWM_INQ_UOW_ FAIL
        INQ UOW from ERMRS has failed
2 HEX 2569 ERMRS_UNEXPECTED_RMLN_ REASON
        ERMRS received an unexprected reason for an exception response from rmln initiate_rec.
2 HEX 2570 ERMRS_BAD_RMLN_ RESPONSE
        ERMRS received serious error from rmln initiate rec.
2 HEX 2571 ERMRS_RMLN_TERMINATE_ FAIL
        RMLN terminate recovery from ERMRS failed
2 HEX 2572 ERMRS_RMLN_SET_MARK_ FAIL
        RMLN set mark from ERMRS failed
2 HEX 2573 ERMRS_XMAT_ATTACH_FAIL
        attach from ERMRS has failed