DGB - DBCTL-CICS Global Block

      CONTROL BLOCK NAME = DFHDGB
         (In DFHDBCOP, invoked via DFHDBMAC)
         (Invoked by DFHDLP DGB=DSECT)
      DESCRIPTIVE NAME = CICS TS DBCTL-CICS Global Block
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1986, 2016 
      FUNCTION =
      Used to store connection/disconnection information
      regarding the CICS-DBCTL interface.
      LIFETIME =
      The DBCTL Global Block (DGB) is acquired when initialisation
      of the CICS-DBCTL interface is first attempted.
      It is used to store connection/disconnection information
      regarding the CICS-DBCTL interface.
      It is released at the end of the CICS session.
      LOCATION = CSA->OPFL->DLP->DGB
      NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS = None
       MODULE TYPE = Control Block definition
     ------------------------------------------------------------------
      EXTERNAL REFERENCES =
       CSA, DLP, Control Transaction Area, DBCTL-XRF area
       DATA AREAS =
           Values from MVS and JES control blocks concerning DBCTL
       CONTROL BLOCKS =
           DBCTL exit addresses
       GLOBAL VARIABLES (Macro pass) = None
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 252 DFHDGB Based DGB
(0) CHARACTER 8 DGBDESC Set to DFHDGB
(8) ADDRESS 4 DGBCSA Address of the CSA
(C) ADDRESS 4 DGBDLP Address of the DLP
(10) ADDRESS 4 DGBCTA Address of the Control Txn Area
(14) ADDRESS 4 DGBDXBA Address of the DBCTL-XRF area
(18) ADDRESS 4 DGBSMTOK Storage Manager Token
(1C) ADDRESS 4 DGBCTOKN Call Token - Returned on response to INIT from the Adapter
(20) FULLWORD 4 DGBDSENO Session Number of CICS-DBCTL
(24) CHARACTER 4 DGBDSTATCS Status Fields
(24) CHARACTER 1 DGBDSTAT Status of the CICS-DBCTL interface
(25) UNSIGNED 3 DGBDSTCT Count incremented by 1 when DGBDSTAT is updated or when the control exit is notified by DBCTL of a change in DBCTL's state
(28) CHARACTER 4 DGBCFLAGCS Added for CS logic
(28) CHARACTER 1 DGBCFLAG Cleanup flag
(28) 1... ....   DGBDFAIL DBCTL or DRA has failed
(28) .1.. ....   DGBATEN Indicator for adapter enable 1 0 : Not enabled yet
(28) ..1. ....   DGBDXERR Indicator for XRF proc's 0 : Enabled 1 : Disabled due to error
(28) ...1 ....   DGBCABORT CICS aborted the connection..
(28) .... 1...   DGBMNPND1 MN call 1 got back POINT_NOT_DEFINED
(28) .... .1..   DGBMNPND2 MN call 2 got back POINT_NOT_DEFINED
(28) .... ..11   * Reserved
(29) UNSIGNED 3 DGBDRMCT Count of number of DFHRMCAL requests active in the ADAPTER/DRA
(2C) FULLWORD 4 DGBPSBSU Total number of successful PSB schedule requests 
             Connection information
(30) CHARACTER 2 DGBSTSU Startup Table Suffix
(32) CHARACTER 4 DGBIDBID DBCTL id Override (if any)
(36) CHARACTER 8 DGBCAPLD CICS APPLID
(3E) CHARACTER 2 * Reserved
(40) CHARACTER 4 DGBABORTCS Added for CS logic
(40) CHARACTER 1 DGBABORTRC Reason for connection abort
(40) 1... ....   DGBNOPSK Storage protect active but DRA does not support storage protection
(40) .111 1111   * Reserved
(41) CHARACTER 3 * Reserved
(44) ADDRESS 4 DGBINITT The INIT Token contains the address of the DGB
(48) CHARACTER 4 DGBIECB the Initialisation ECB 
         Exit details Exit details - if the order of the exit fields
         is altered then DFHDBCON and DFHDBDI will require alteration
(4C) CHARACTER 8 DGBSPXE Exit name
(54) ADDRESS 4 DGBSPXA Address of the Suspend exit
(58) CHARACTER 8 DGBREXE Exit name
(60) ADDRESS 4 DGBREXA Address of the Resume exit
(64) CHARACTER 8 DGBCTXE Exit name
(6C) ADDRESS 4 DGBCTXA Address of the Control exit
(70) CHARACTER 8 DGBMOXE Exit name
(78) ADDRESS 4 DGBMOXA Address of the Monitoring exit
(7C) CHARACTER 8 DGBTOXE Exit name
(84) ADDRESS 4 DGBTOXA Address of the Token exit
(88) CHARACTER 8 DGBSTXE Exit name
(90) ADDRESS 4 DGBSTXA Address of the Statistics exit
(94) CHARACTER 8 DGBSSXE Exit name
(9C) ADDRESS 4 DGBSSXA Address of the Status exit
(A0) CHARACTER 8 DGBATE Exit name
(A8) ADDRESS 4 DGBATA Address of the ADAPTER-Transformer 
         End of exit details
(AC) CHARACTER 8 DGBCTIME Connect time 
             Connection information returned from DBCTL
(B4) CHARACTER 4 DGBDBCID DBCTL ID
(B8) CHARACTER 8 DGBJOBN DBCTL job name
(C0) UNSIGNED 2 DGBASID DBCTL ASID
(C2) CHARACTER 8 DGBJOBI DBCTL JES Job Id
(CA) CHARACTER 1 DGBCRC DBCTL command recognition character
(CB) CHARACTER 1 DGBRGTY DBCTL region type
(CC) HALFWORD 2 DGBMITHD Minimum number of threads
(CE) HALFWORD 2 DGBMATHD Maximum number of threads
(D0) CHARACTER 8 DGBRSEN DBCTL RSE Name
(D8) CHARACTER 4 DGBSDBID Saved DBCTL ID for CPSM RTA 
         evaluation @R126793A IMS Support information
(DC) CHARACTER 1 DGBDLEV Support flags(from PAPLDLEV)
(DC) 1111 ....   * Reserved
(DC) .... 1...   DGBOTCB IMS supports OTE environment
(DC) .... .1..   DGBLPL31 PCB in 31 bit storage
(DC) .... ..1.   DGBSUPD DRA supports single updater
(DC) .... ...1   DGBPSK DRA supports PSK 
             Disconnection information
(DD) CHARACTER 1 DGBDISTY Disconnection type
(DE) CHARACTER 8 DGBDTIME Disconnect time 
             Disconnection information returned from DBCTL These
         fields relate to the previous CICS-DBCTL session
(E6) CHARACTER 2 * Reserved
(E8) FULLWORD 4 DGBNOMATHD Max thread hits
(EC) FULLWORD 4 DGBNOMITHD Min thread hits
(F0) CHARACTER 4 DGBELMAX Elapsed time at Max Threads
(F4) FULLWORD 4 DGBHIWAT Hi-Water for no. of Threads
(F8) ADDRESS 4 DGBALOAD Load addr ADAPTER-XFORMER
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 52 DFHDGBCTA 
             Control transaction information
(0) ADDRESS 4 DGBCWEHD Control trans. work elements header
(4) CHARACTER 1 DGBCTL Control transaction flag
(4) 1... ....   DGBCTLATT Control transaction attached
(4) .111 1111   * Reserved
(5) CHARACTER 3 * Reserved
(8) ADDRESS 4 DGBCECB Control transaction ECB
(C) CHARACTER 8 DGBDTIM Time DRA last abnormally terminated
(14) CHARACTER 16 DGBCWEERR storage for control exit error CWE
(14) ADDRESS 4 DGBCWEERRA work ptr used in Building CWEERR
(18) CHARACTER 12 * Reserved
(24) CHARACTER 16 DGBCWETERM storage for control exit term CWE
(24) ADDRESS 4 DGBCWETERMA
(28) CHARACTER 12 * Reserved

Constants

Table 3.
Len Type Value Name Description 
    Possible values of DGBDSTAT
1 HEX 00 DGBDSHUT Interface shut
1 HEX 01 DGBDPHS1 Connection phase 1
1 HEX 02 DGBDPHS2 Connection phase 2
1 HEX 04 DGBDREDY Interface ready
1 HEX 08 DGBDORDT Orderly termination , i.e. phase 1 of termination
1 HEX 10 DGBDIMMT Immediate termination, i.e. phase 2 of termination
1 HEX 20 DGBDDEAD Interface dead, i.e. interface is unusable 
      Possible values of DGBRGTY - DBCTL region types
1 HEX 01 DGBDBCX DB/DC with XRF
1 HEX 02 DGBDBCO DB/DC only
1 HEX 04 DGBDBCT DBCTL 
    Possible values of DGBDISTY
1 HEX 01 DGBORDDI Orderly termination request input
1 HEX 02 DGBIMMDI Immediate termination request input