UEPAR - Task related user exit plist

    CONTROL BLOCK NAME = DFHUERMD
    NAME OF MATCHING PLS CONTROL BLOCK = None
    DESCRIPTIVE NAME = CICS TS USER EXIT MACRO CALL, TYPE=RM
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1992 
    FUNCTION =
           Exercise the DFHUEXIT TYPE=RM option.
           This is part of the CICS User Exits support
           The DFHUEXIT TYPE=RM gives the programmer access to the
           parameter list for a task related user exit (TRUE).
           An instance of the control block represents one task
           related user exit.
    LIFETIME =
    STORAGE CLASS =
    LOCATION =
    INNER CONTROL BLOCKS = This copybook calls DFHUEXIT TYPE=RM
    NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS = None
       MODULE TYPE = Control block definition
   --------------------------------------------------------------------
    EXTERNAL REFERENCES = Not applicable
        DATA AREAS = This copybook generates an entry in Data Areas
            Manual for DFHUEXIT TYPE=RM.
        CONTROL BLOCKS = Not applicable
        GLOBAL VARIABLES (Macro pass) = Not applicable
   --------------------------------------------------------------------
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 DFHUEPAR
(0) ADDRESS 4 UEPEXN ADDRESS OF EXIT NUMBER
(4) ADDRESS 4 UEPGAA ADDRESS OF GLOBAL AREA ( (ZERO=NO WORK AREA)
(8) ADDRESS 4 UEPGAL ADDRESS OF GLOBAL AREA LENGTH
(C) ADDRESS 4 UEPCRCA ADDRESS OF CURRENT RETURN-CODE
(10) ADDRESS 4 UEPTCA (reserved)
(14) ADDRESS 4 UEPCSA (reserved)
(18) ADDRESS 4 UEPEPSA ADDRESS OF REGISTER SAVE AREA FOR USE BY EXIT PROGRAM
(1C) ADDRESS 4 UEPHMSA ADDRESS OF SAVE AREA USED FOR HOST MODULE'S REGISTERS 
     END OF RETURN CODE EQUATES
(1C) 1... ....   UERTPREP "X'80'" PREPARE
(1C) .1.. ....   UERTCOMM "X'40'" COMMIT UNCONDITIONALLY
(1C) ..1. ....   UERTBACK "X'20'" BACKOUT
(1C) ...1 ....   UERTDGCS "X'10'" LOST TO CICS INITIAL START
(1C) .... 1...   UERTDGNK "X'08'" RM SHOULD NOT BE IN-DOUBT
(1C) .... .1..   UERTWAIT "X'04'" RM WILL HAVE TO WAIT FOR OUTCOME
(1C) .... ..1.   UERTRSYN "X'02'" RESYNC
(1C) .... ...1   UERTLAST "X'01'" LAST COMMIT/ABORT IN THREAD
(1C) 1... ....   UERTONLY "X'80'" RM IS ONLY UPDATER - TRUE CAN PERFORM SINGLE PHASE COMMIT
(1C) .1.. ....   UERTELUW "X'40'" RM IS READ ONLY - TRUE CAN INVOKE RM WITH END LUW CALL.
(1C) .... .1..   UERFPREP "4" VOTE-YES
(1C) .... 1...   UERFBACK "8" VOTE-NO
(1C) .... 11..   UERFNLOG "12" VOTE-YES-BUT-DO-NOT-LOG
(1C) .... .1..   UERFDONE "4" COMMIT/ABORT COMPLETE
(1C) .... 1...   UERFHOLD "8" REMEMBER COMMIT/ABORT
(1C) .... .1..   UERFOK "4" SINGLE PHASE (UERTONLY): COMMITTED OK
(1C) .... 1...   UERFBOUT "8" SINGLE PHASE (UERTONLY): BACKED OUT
(1C) 1... ....   UERTEOTR "X'80'" END OF THREAD
(1C) .1.. ....   UERTSOTR "X'40'" START OF TASK
(1C) 1... ..1.   UERTRTTR "X'82'" no longer used
(1C) .1.. ..1.   UERTRTST "X'42'" no longer used
(1C) .... .1..   UERFEOTR "4" CALL UNDERSTOOD
(1C) 1... ....   UERTCONN "X'80'" EXTERNAL RESOURCE MANAGER IS
(1C) .1.. ....   UERTNCON "X'40'" EXTERNAL RESOURCE MANAGER IS NOT
(1C) 1... ....   UERTCORD "X'80'" CICS Orderly Termination
(1C) .1.. ....   UERTCIMM "X'40'" CICS Immediate Termination
(1C) ..1. ....   UERTCABY "X'20'" CICS ABEND (Retry possible - TCBs Dispatchable)
(1C) ...1 ....   UERTCABN "X'10'" CICS ABEND (Retry NOT possible - TCBs Dispatchable)
(1C) .... ...1   UERTOPCA "X'01'" Operator Cancel (Retry NOT possible - TCBs NOT dispatchable)
(20) ADDRESS 4 UEPURID ADDRESS OF LUW-ID
(24) ADDRESS 4 UEPTAA ADDRESS OF TASK AREA
(28) ADDRESS 4 UEPTAL ADDRESS OF TASK AREA LENGTH
(2C) ADDRESS 4 UEPEIB ADDRESS OF CURRENT EIB
(30) ADDRESS 4 UEPFLAGS ADDRESS OF FLAGWORD
(34) ADDRESS 4 UEPRMSTK ADDRESS OF KERNEL STACK ENTRY
(38) ADDRESS 4 UEPUOWDS ADDRESS OF LU6.2 UNIT OF WORK ID
(3C) ADDRESS 4 UEPSECFLG ADDRESS OF USER SECURITY BLOCK FLAG
(3C) 1... ....   UEPNOSEC "X'80'" SECURITY INACTIVE FOR THIS SYSTEM
(3C) ..1. ....   UEPSEC "X'20'" SECURITY ACTIVE FOR THIS SYSTEM
(40) ADDRESS 4 UEPSECBLK ADDRESS OF ADDRESS OF USER SECURITY BLOCK
(44) ADDRESS 4 UEPRMQUA ADDRESS OF RM QUALIFIER
(48) FULLWORD 4 UEPCALAM ADDRESS OF CALLER AMODE INDICATION BYTE
(48) 1... ....   UEPCAM31 "X'80'" INDICATES ORIGINAL CALLER WAS AMODE 31
(4C) ADDRESS 4 UEPSYNCA ADDRESS OF PARMS PASSED TO SYNC PT.
(4C) 1... ....   UEPSUPDR "X'80'" RM UNDERSTANDS SINGLE UPDATER PROTOCOL
(4C) .1.. ....   UEPREADO "X'40'" RM IS READ ONLY FOR THIS LUW
(50) ADDRESS 4 UEPTIND ADDRESS OF CALLER'S TASK INDICATORS
(50) 1... ....   UEPTANY "X'80'" DATA LOCATION ANY
(50) .1.. ....   UEPTCICS "X'40'" TASKDATAKEY = CICS 
  The following indicator is set after a failure to switch to
  the TCB expected by the TRUE. This is used only when the caller
  is Sync-Point or End_of_Task. All other callers are Abended.
(50) ..1. ....   UEPTUTCB "X'20'" UNEXPECTED TCB
(50) CHARACTER 0 UEPTQR "C'QR', 2" QUASI-REENTRANT (QR) TCB
(50) CHARACTER 0 UEPTCO "C'CO', 2" CONCURRENT (CO) TCB
(50) CHARACTER 0 UEPTRO "C'RO', 2" RESOURCE_OWNING (RO) TCB
(50) CHARACTER 0 UEPTFO "C'FO', 2" FILE_OWNING (FO) TCB
(50) CHARACTER 0 UEPTSZ "C'SZ', 2" FEPI (SZ) TCB
(50) CHARACTER 0 UEPTRP "C'RP', 2" RP MODE TCB
(50) CHARACTER 0 UEPTL8 "C'L8', 2" AN OPEN TCB, CICS KEY
(50) CHARACTER 0 UEPTL9 "C'L9', 2" AN OPEN TCB, USER KEY
(50) CHARACTER 0 UEPTSO "C'SO', 2" SOCKETS TCB
(50) CHARACTER 0 UEPTSL "C'SL', 2" SOCKETS LISTENER TCB
(50) CHARACTER 0 UEPTSP "C'SP', 2" SSL PTHREAD OWNING TCB
(50) CHARACTER 0 UEPTS8 "C'S8', 2" SSL TCB
(50) CHARACTER 0 UEPTTP "C'TP', 2" THREAD OWNING TCB
(50) CHARACTER 0 UEPTT8 "C'T8', 2" THREAD TCB, CICS KEY
(50) CHARACTER 0 UEPTJ8 "C'J8', 2" A JAVA TCB
(50) CHARACTER 0 UEPTJ9 "C'J9', 2" A JAVA TCB, USER KEY
(50) CHARACTER 0 UEPTJM "C'JM', 2" A MASTER JVM TCB
(50) CHARACTER 0 UEPTD2 "C'D2', 2" CICS-DB2 HOUSEKEEPING TCB
(50) CHARACTER 0 UEPTEP "C'EP', 2" EVENT PROCESSING TCB
(50) CHARACTER 0 UEPTJS "C'JS', 2" JOBSTEP TCB
(54) ADDRESS 4 UEPPBTOK ADDRESS OF CALLER'S PB TOKEN
(58) ADDRESS 4 UEPTRCE Address of trace flag byte
(58) 1... ....   UEPTRLV1 "X'80'" RMI Level 1 trace active
(58) .1.. ....   UEPTRLV2 "X'40'" RMI Level 2 trace active
(5C) FULLWORD 4 UEPRMEND (0) END of TYPE=RM Plist
(5C) .1.1 11..   UEPRMLEN "UEPRMEND-UEPEXN" Length of TYPE=RM Plist 
         THE FOLLOWING EQU DEFINITIONS RELATE TO THE OBJECT
            THAT IS ADDRESSED BY UEPFLAGS, NOT TO UEPFLAGS ITSELF.
(5C) .... ....   UEF0OFFS "0" FIRST BYTE ... 
         FIRST BYTE IS RESERVED FOR CICS/VS 1.5 COMPATIBILITY
(5C) .... ...1   UEF1OFFS "1" SECOND BYTE
(5C) .... ..1.   UEF2OFFS "2" THIRD BYTE
(5C) .... ..1.   UEFDTASK "UEF2OFFS" BYTE-DISPL = 2
(5C) .... .111   UEFPTASK "7" BIT-POSITN = 7
(5C) .... ...1   UEFMTASK "X'01'" BIT-MASK
(5C) .... ..1.   UEFDCTER "UEF2OFFS" BYTE-DISPL = 2
(5C) .... .1.1   UEFPCTER "5" BIT-POSITION = 5
(5C) .... .1..   UEFMCTER "X'04'" BIT-MASK
(5C) .... ..1.   UEFDFEDF "UEF2OFFS" BYTE-DISPL = 2
(5C) .... ..11   UEFPFEDF "3" BIT-POSITION = 3
(5C) ...1 ....   UEFMFEDF "X'10'" BIT-MASK
(5C) .... ..1.   UEFDSWAE "UEF2OFFS" BYTE-DISPL = 2
(5C) .... ..1.   UEFPSWAE "2" BIT-POSITION = 2
(5C) ..1. ....   UEFMSWAE "X'20'" BIT-MASK
(5C) .... ..1.   UEFDCON "UEF2OFFS" BYTE-DISPL = 2
(5C) .... ...1   UEFPCON "1" BIT-POSITION = 1
(5C) .1.. ....   UEFMCON "X'40'" BIT-MASK
(5C) .... ..11   UEF3OFFS "3" FOURTH BYTE
(5C) .... ..11   UEFDSPI "UEF3OFFS" BYTE-DISPL = 3
(5C) .... .11.   UEFPSPI "6" BIT-POSITN = 6
(5C) .... ..1.   UEFMSPI "X'02'" BIT-MASK
(5C) .... ..11   UEFDAPPL "UEF3OFFS" BYTE-DISPL = 3
(5C) .... .1.1   UEFPAPPL "5" BIT-POSITN = 5
(5C) .... .1..   UEFMAPPL "X'04'" BIT-MASK
(5C) .... ..11   UEFDSYNC "UEF3OFFS" BYTE-DISPL = 3
(5C) .... ..11   UEFPSYNC "3" BIT-POSITN = 3
(5C) ...1 ....   UEFMSYNC "X'10'" BIT-MASK 
     DUMMY SECTION FOR ROUTING FLAGS
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 DFHUEFLG
(0) BITSTRING 4 
     DUMMY SECTION FOR ROUTING ARGUMENT
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 DFHUERTR
(0) BITSTRING 1 UERTFGP FUNCTION GROUP
(1) BITSTRING 1 UERTFID ORIGIN-IDENTIFIER
(1) .... ..1.   UERTAPPL "31-(UEFDAPPL*8+ UEFPAPPL)" FROM API
(1) .... ..1.   UERTFAPI "UERTAPPL" FROM API
(1) .... ..1.   UERTAPI "UERTAPPL" FROM API
(1) .... ...1   UERTSPI "31-(UEFDSPI*8+ UEFPSPI)" FROM SPI
(1) .... .1..   UERTSYNC "31-(UEFDSYNC*8+ UEFPSYNC)" FROM SP-MGR
(1) .... 1...   UERTTASK "31-(UEFDTASK*8+ UEFPTASK)" FROM TASK-MGR
(1) .... 1.1.   UERTCTER "31-(UEFDCTER*8+ UEFPCTER)" FROM CICS-TERMINATION
(1) .... 11..   UERTFEDF "31-(UEFDFEDF*8+ UEFPFEDF)" FROM CEDF
(1) .... 111.   UERTFCON "31-(UEFDCON*8+ UEFPCON)" FROM context mgt (START)
(1) .... 11.1   UERTSWAE "31-(UEFDSWAE*8+ UEFPSWAE)" FROM Switch appl env
(1) ..1. ....   UERTRMSY "32" FROM RMSY (NOT FOR RM)
(2) BITSTRING 1 UERTOPT2 EIDOPT2.COPY
(3) BITSTRING 1   RESERVED
(4) ADDRESS 4 UERTREND (0) END OF RECURSIVE SECTION
(4) .... .1..   UERTRLEN "UERTREND-UERTFGP" Length of recursive section 
     DUMMY SECTION FOR workload manager call
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 DFHUECON ,
(0) ADDRESS 4 UECON_EXEC_PLIST_PTR Address of EXEC CICS START parameter list described by copy book DFHICUED
(4) ADDRESS 4 UECON_CORRELATOR_PTR Address of 512 byte area in which an 
               ARM correlator can be placed
(8) ADDRESS 4 UECON_ICRX_PTR Address of ICRX in task storage
(C) FULLWORD 4 UECON_ICRX_LEN Length of ICRX in task storage
(10) ADDRESS 4 UECON_ADAPTER_ID_PTR Address of a 64 byte area into which 
               an adapter identifier can be placed
(14) ADDRESS 4 UECON_ADAPTER_DATA1_ PTR Address of a 64 byte area into 
               which adapter data can be placed
(18) ADDRESS 4 UECON_ADAPTER_DATA2_ PTR Address of a 64 byte area into 
               which adapter data can be placed
(1C) ADDRESS 4 UECON_ADAPTER_DATA3_ PTR Address of a 64 byte area into 
               which adapter data can be placed
(20) ADDRESS 4 UECON_FLAGS Address of a 1-byte flag
(20) 1... ....   UECON_ADAPTER_DATA_ON "X'80'" Adapter data may be set 
      EXITID EQU-LIST - Global User Exit Number
(20) .... ...1   XTCIN "1"
(20) .... ..1.   XTCOUT "2"
(20) .... ..11   XTCATT "3"
(20) .... .1..   XTCTIN "4"
(20) .... .1.1   XTCTOUT "5"
(20) .... .11.   XDSBWT "6"
(20) .... .111   XDSAWT "7"
(20) .... 1...   XLGSTRM "8"
(20) .... 1..1   XDUREQ "9"
(20) .... 1.1.   XDUCLSE "10"
(20) .... 1.11   XDUOUT "11"
(20) .... 11..   XMEOUT "12"
(20) .... 11.1   XFCREQ "13"
(20) .... 111.   XFCREQC "14"
(20) .... 1111   XTSPTOUT "15"
(20) ...1 ....   XGMTEXT "16"
(20) ...1 ...1   XMNOUT "17"
(20) ...1 ..1.   XRCINIT "18"
(20) ...1 ..11   XRCINPT "19"
(20) ...1 .1..   XICREQ "20"
(20) ...1 .1.1   XICEXP "21"
(20) ...1 .11.   XISLCLQ "22"
(20) ...1 .111   XPCFTCH "23"
(20) ...1 1...   XPCHAIR "24"
(20) ...1 1..1   XPCTA "25"
(20) ...1 1.1.   XPCABND "26"
(20) ...1 1.11   XPCREQ "27"
(20) ...1 11..   XPCREQC "28"
(20) ...1 11.1   XTDREQ "29"
(20) ...1 111.   XTDIN "30"
(20) ...1 1111   XTDOUT "31"
(20) ..1. ....   XTSQRIN "32"
(20) ..1. ...1   XTSQROUT "33"
(20) ..1. ..1.   XTSPTIN "34"
(20) ..1. ..11   XZCIN "35"
(20) ..1. .1..   XZCOUT "36"
(20) ..1. .1.1   XZCATT "37"
(20) ..1. .11.   XZCOUT1 "38"
(20) ..1. .111   XXRSTAT "39"
(20) ..1. 1...   XXDFA "40"
(20) ..1. 1..1   XXDFB "41"
(20) ..1. 1.1.   XXDTO "42"
(20) ..1. 1.11   XSTOUT "43"
(20) ..1. 11..   XDLIPRE "44"
(20) ..1. 11.1   XDLIPOST "45"
(20) ..1. 111.   XFCSREQ "46"
(20) ..1. 1111   XEIIN "47"
(20) ..11 ....   XEIOUT "48"
(20) ..11 ...1   XALTENF "49"
(20) ..11 ..1.   XICTENF "50"
(20) ..11 ..11   XDTAD "51"
(20) ..11 .1..   XDTRD "52"
(20) ..11 .1.1   XDTLC "53"
(20) ..11 .11.   XSTERM "54"
(20) ..11 .111   XSRAB "55"
(20) ..11 1...   XFCSREQC "56"
(20) ..11 1..1   XSZBRQ "57"
(20) ..11 1.1.   XSZARQ "58"
(20) ..11 1.11   XISCONA "59"
(20) ..11 11..   XRSINDI "60"
(20) ..11 11.1   XXMATT "61"
(20) ..11 111.   XZIQUE "62"
(20) ..11 1111   XTSEREQ "63"
(20) .1.. ....   XTSEREQC "64"
(20) .1.. ...1   XTDEREQ "65"
(20) .1.. ..1.   XTDEREQC "66"
(20) .1.. ..11   XICEREQ "67"
(20) .1.. .1..   XICEREQC "68"
(20) .1.. .1.1   XALCAID "69"
(20) .1.. .11.   XSNON "70"
(20) .1.. .111   XSNOFF "71"
(20) .1.. 1...   XRMIIN "72"
(20) .1.. 1..1   XRMIOUT "73"
(20) .1.. 1.1.   XAKUSER "74"
(20) .1.. 1.11   XFCNREC "75"
(20) .1.. 11..   XFCBFAIL "76"
(20) .1.. 11.1   XFCLDEL "77"
(20) .1.. 111.   XFCBOVER "78"
(20) .1.. 1111   XFCBOUT "79"
(20) .1.1 ....   XFCVSDS "80"
(20) .1.1 ...1   XFCQUIS "81"
(20) .1.1 ..1.   XDUREQC "82"
(20) .1.1 ..11   XFCAREQ "83"
(20) .1.1 .1..   XFCAREQC "84"
(20) .1.1 .1.1   XEISPIN "85"
(20) .1.1 .11.   XEISPOUT "86"
(20) .1.1 .111   XNQEREQ "87"
(20) .1.1 1...   XNQEREQC "88"
(20) .1.1 1..1   XFAINTU "89"
(20) .1.1 1.1.   XBMIN "90"
(20) .1.1 1.11   XBMOUT "91"
(20) .1.1 11..   XBADEACT "92"
(20) .1.1 11.1   XLDLOAD "93"
(20) .1.1 111.   XLDELETE "94"
(20) .1.1 1111   XSNEX "95"
(20) .11. ....   XFCFRIN "96"
(20) .11. ...1   XFCFROUT "97"
(20) .11. ..1.   XICERES "98"
(20) .11. ..11   XPCERES "99"
(20) .11. .1..   XWBOPEN "100"
(20) .11. .1.1   XWBSNDO "101"
(20) .11. .11.   XWBAUTH "102"
(20) .11. .111   XAPADMGR "103"
(20) .11. 1...   XISQUE "104"
(20) .11. 1..1   XWSPRROO "105"
(20) .11. 1.1.   XWSPRRWI "106"
(20) .11. 1.11   XWSPRROI "107"
(20) .11. 11..   XWSPRRWO "108"
(20) .11. 11.1   XWSRQRWO "109"
(20) .11. 111.   XWSRQROO "110"
(20) .11. 1111   XWSRQROI "111"
(20) .111 ....   XWSRQRWI "112"
(20) .111 ...1   XWSSRRWO "113"
(20) .111 ..1.   XWSSRROO "114"
(20) .111 ..11   XWSSRROI "115"
(20) .111 .1..   XWSSRRWI "116"
(20) .111 .1.1   XISQLCL "117"
(20) .111 .11.   XFCRLSCO "118"
(20) .111 .111   XEPCAP "119"