DSB - DBCTL Scheduling block

      CONTROL BLOCK NAME = DFHDSB
         (In DFHDBCOP, invoked via DFHDBMAC)
         (Invoked by DFHDLP DSB=DSECT)
      DESCRIPTIVE NAME = CICS TS DBCTL Scheduling Block
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1986, 2012 
      FUNCTION =
      Used to store task-related information
      regarding the CICS-DBCTL interface.
      LIFETIME =
      The DBCTL Scheduling Block (DSB) is acquired when a task issues
      its first schedule request to DBCTL. It is cleared just before
      each subsequent schedule request from the same task is processed.
      It is released at task termination.
      LOCATION = PAPL token -> DSB
      NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS = None
       MODULE TYPE = Control Block definition
     ------------------------------------------------------------------
      EXTERNAL REFERENCES =
            TCA, DGB, PCB list.
       CONTROL BLOCKS =
           DBCTL exit addresses
       GLOBAL VARIABLES (Macro pass) = None
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 656 DFHDSB 
     Fields common to all DSBs
(0) CHARACTER 8 DSBDESC Set to DFHDSB
(8) ADDRESS 4 DSBTCA Address of the TCA
(C) ADDRESS 4 DSBDGB Address of the DGB
(10) ADDRESS 4 DSBTTOK Task Token 
         Contains address of DSB
(14) ADDRESS 4 DSBTECB Task ECB used by Suspend and 
         Resume exits
(18) ADDRESS 4 DSBRESPW Pointer to the response word - 
         This field is set by DFHDBAT
(1C) ADDRESS 4 DSBSSX pointer to the status exit extn
(20) CHARACTER 1 DSBRTYP Request Type 
         I: Connection Request T: Disconnection Request P: PSB
         Schedule Request D: DL/I Request R: Resync S: CICS Shutdown

     Fields relating to Schedule Requests
     These fields are relevant for the duration of a schedule
     Term cycle.
(21) BIT(8) 1 DSBFLAGS
(21) 1... ....   DSBSCHED Indicator for schedule 1 : DBCTL PSB scheduled successfully during task 0 : DBCTL PSB never schedule
(21) .1.. ....   DSBIOREQ Indicator for IOPCB 1 : IOPCB required 0 : IOPCB not required
(21) ..1. ....   DSBINRMC This task in DFHRMCAL This bit is set and reset in a single request
(21) ...1 ....   DSB_WAIT Wait in IMS request ind.
(21) .... 1...   DSBTRLV2 Trace Flag used by DBREX 1 : RMI lvl 2 trace active 0 : RMI lvl 2 trace inactive
(21) .... .1..   DSBPREP We have seen prepare
(21) .... ..1.   DSBDPL Was this DPL'd to
(21) .... ...1   DSBPSK DRA supports PSK
(22) CHARACTER 8 DSBPSBNM PSB name
(2A) UNSIGNED 1 DSBWRTH Deadlock worth
(2B) CHARACTER 1 DSBLSFL Long-Short flag
(2C) ADDRESS 4 DSBPCBL Address of PCB List
(2C) FULLWORD 4 DSBTIMEO Shutdown timeout value
(30) ADDRESS 4 DSBDBPCB Address of first DBPCB
(34) FULLWORD 4 DSBMAXIO Maximum IO size
(38) FULLWORD 4 DSBMAXKE Maximum key length
(3C) ADDRESS 4 DSBADGMA Addr getmn'd area
(40) FULLWORD 4 DSBLATFM Lgth area to free
(44) CHARACTER 1 DSBPLTY PSB language type 
     Fields relating to DL/I requests
(45) CHARACTER 1 DSBALTY Application language type
(46) CHARACTER 1 * Reserved
(47) CHARACTER 1 DSBCTLCT DBCTL Inv'n count
(48) FULLWORD 4 DSBSEGL Segment length
(4C) ADDRESS 4 DSBSEGA Segment address 
     Area to contain R1 parameter list to the Adapter
(50) CHARACTER 64 DSBPARMS Parameters to interface with the Adapter 
     Monitoring and trace areas are placed at the end of the DSB so
     that the rest of the DSB can be traced by DFHDBREX without the
     need for multiple GTRACE requests ( 255 byte limit ).
     Monitoring area used on schedule and term requests.
(90) CHARACTER 256 DSBMONI Monitoring info from DBCTL 
     Trace area used to build GTF trace entry output by DFHDBREX.
(190) CHARACTER 256 DSBGTRACE Trace area used by GTRACE 
       R1 Parameter List for a Connection Request to the Adapter
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 64 DSBINIP
(0) ADDRESS 4 DSBINRTYPA Address of the Request Type
(4) ADDRESS 4 DSBINTTOKA Address of the Task Token
(8) ADDRESS 4 DSBINRESPA Address of Adapter Response word
(C) ADDRESS 4 DSBINDBID Address of input DBCTL id(if any)
(10) ADDRESS 4 DSBINAGNA Address of CICS AGN - not used
(14) ADDRESS 4 DSBINSTSUA Address of Startup Table Suffix
(18) ADDRESS 4 DSBINAPLID Address of CICS APPLID
(1C) ADDRESS 4 DSBINSUSXA Address of Suspend Exit
(20) ADDRESS 4 DSBINRESXA Address of Resume Exit
(24) ADDRESS 4 DSBINCTLXA Address of Control Exit
(28) ADDRESS 4 DSBININTKA Address of Connect Token
(2C) ADDRESS 4 DSBINMONXA Address of Monitoring Exit
(30) ADDRESS 4 DSBINTOKXA Address of Token Exit
(34) ADDRESS 4 DSBINSTAXA Address of Statistics Exit
(38) ADDRESS 4 DSBINSTSXA Address of status exit
(3C) ADDRESS 4 DSBINPCTOKN Address of Call Token-Prev Session 
       Response From a Connection Request to the Adapter
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 16 DSBINIR
(0) HALFWORD 2 DSBINRESPL Length of the response
(2) CHARACTER 1 * Reserved
(3) CHARACTER 1 * Reserved
(4) UNSIGNED 4 DSBINPRETC Return code from the PAPL
(8) CHARACTER 4 DSBINDBCID DBCTL ID
(C) ADDRESS 4 DSBINCTOKN Call Token 
       R1 Parameter list for a Disconnection Request to the Adapter
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 20 DSBTERP
(0) ADDRESS 4 DSBTERTYPA Address of the Request Type
(4) ADDRESS 4 DSBTETTOKA Address of the Task Token
(8) ADDRESS 4 DSBTERESPA Address of Adapter response word
(C) ADDRESS 4 * Reserved
(10) ADDRESS 4 DSBTETTYPA Address of Disconnection Type Flag 
       Response from a Disconnection Request to the Adapter
Table 5.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 24 DSBTERR
(0) HALFWORD 2 DSBTERESPL Length of the response
(2) CHARACTER 1 * Reserved
(3) CHARACTER 1 * Reserved
(4) UNSIGNED 4 DSBTEPRETC Return code from the PAPL
(8) FULLWORD 4 DSBTEMATHD Max thread hits
(C) FULLWORD 4 DSBTEMITHD Min thread hits
(10) CHARACTER 4 DSBTEELMAX Elapsed time at max threads
(14) FULLWORD 4 DSBTEHIWAT Hi-Water for No. of threads 
      R1 parameter list for PSB Schedule request to the Adapter
Table 6.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 36 DSBPSBP
(0) ADDRESS 4 DSBPSRTYPA Address of the Request Type
(4) ADDRESS 4 DSBPSTTOKA Address of the Task Token
(8) ADDRESS 4 DSBPSRESPA Address of Adapter Response Word
(C) ADDRESS 4 DSBPSUSERA Address of Userid field
(10) ADDRESS 4 DSBPSMONIA Address of Monitoring Area
(14) ADDRESS 4 DSBPSALTYA Address of Language Type
(18) ADDRESS 4 DSBPSDEADA Address of Deadlock Worth
(1C) ADDRESS 4 DSBPSLSFLA Address of LONG-SHORT Flag
(20) ADDRESS 4 DSBPSPSBNA Address of PSBNAME 
      Response from a PSB Schedule request to the Adapter
Table 7.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 24 DSBPSBR
(0) HALFWORD 2 DSBPSRESPL Length of the Response
(2) CHARACTER 1 DSBPSPLTY PSB Language Type
(3) BIT(8) 1 DSBPSFLAGS
(3) 1111 1...   * Reserved
(3) .... .1..   DSBPSP31 PCB Loc 31
(3) .... ..1.   * Reserved
(3) .... ...1   DSBPSPSK DRA supports PSK
(4) UNSIGNED 4 DSBPSPRETC Return Code from the PAPL
(8) ADDRESS 4 DSBPSPCBL Address of PCB list
(C) ADDRESS 4 DSBPSDBPCB Address of first DBPCB
(10) FULLWORD 4 DSBPSMAXIO Maximum IO size
(14) FULLWORD 4 DSBPSMAXKE Maximum key length 
      R1 Parameter list for DL/I request to Adapter
Table 8.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 24 DSBDLIP
(0) ADDRESS 4 DSBDLRTYPA Address of the Request Type
(4) ADDRESS 4 DSBDLTTOKA Address of the Task Token
(8) ADDRESS 4 DSBDLRESPA Address of Adapter Response Word
(C) ADDRESS 4 * Reserved
(10) ADDRESS 4 DSBDLAPR1A Address of Application Parameter List
(14) ADDRESS 4 DSBDLALTYA Address of Language Type 
      Response from a DL/I request to the ADAPTER
Table 9.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 DSBDLIR
(0) HALFWORD 2 DSBDLRESPL Length of the Response
(2) CHARACTER 1 * Reserved
(3) CHARACTER 1 * Reserved
(4) UNSIGNED 4 DSBDLPRETC Return Code from the PAPL
(8) FULLWORD 4 DSBDLSEGL Segment length 
      Format of PAPLRETC response code from the DRA
Table 10.
Offset Hex Type Len Name (Dim) Description
(4) STRUCTURE 4 DSBPRETC
(4) BIT(8) 1 DSBPRETC_FLAGS Flag values
(5) BIT(12) 2 DSBPRETC_SYSTEM System abend code
(6) BIT(12) POS(5) 2 DSBPRETC_USER User abend code

Constants

Table 11.
Len Type Value Name Description 
    Possible values of DSBTERT
1 CHARACTER O DSBTERT_ORD
1 CHARACTER I DSBTERT_IMM
1 CHARACTER A DSBTERT_ABND 
    Possible values of DSBRTP
1 CHARACTER I DSBINIT_REQ initialization DSB
1 CHARACTER T DSBTERM_REQ termination DSB
1 CHARACTER P DSBPSB_REQ schedule DSB
1 CHARACTER D DSBDLI_REQ DLI req DSB
1 CHARACTER R DSBRES_REQ resync DSB
1 CHARACTER S DSBSHU_REQ shutdown DSB 
    Possible values of DSBALTY and DSBPLTY
1 HEX 01 DSBLPLI PL/I
1 HEX 02 DSBLCOB COBOL
1 HEX 03 DSBLFOR Fortran
1 HEX 04 DSBLASM assembler
1 HEX 08 DSBLAIB AIB 
    Value of DSBWRTH
1 DECIMAL 87 DSBWRTH_CICS 
    Value of DSBLSFL
1 HEX 80 DSBLSFL_CICS CICS tasks classed as short 
    Possible values of DSBTETTYP, i.e. the field that DSBTETTYPA
    points to.
1 CHARACTER C DSBTETTYP_CHKPT
1 CHARACTER F DSBTETTYP_FAST
1 CHARACTER S DSBTETTYP_SLOW 
    Values of bit flags
0 BIT 1 DSB_ON
0 BIT 0 DSB_OFF 
    Values of DFHDBAT'S Return codes in R15
4 DECIMAL 4 DSBUNSUP Call not understood
4 DECIMAL 8 DSBIFDUP Redundant interface Call
4 DECIMAL 12 DSBINNLD Connect load failure
4 DECIMAL 16 DSBTRPRE Disconnect Preempted
4 DECIMAL 24 DSBADNRY Adapter not ready
4 DECIMAL 28 DSBADDIS Adapter is disabled
4 DECIMAL 32 DSBCANCD Thread is cancelled
4 DECIMAL 36 DSBCADUP Redundant Cancel Call
1 HEX 80 DSBPRETC_ABEND_SNAP abend + snap
1 HEX 88 DSBPRETC_ABEND abend
1 HEX 84 DSBPRETC_ABEND_DRASNAP
        abend + DRA snap
1 HEX 40 DSBPRETC_STATUS status code
1 HEX 00 DSBPRETC_RETURN return code