LUC - Parameter list

      CONTROL BLOCK NAME = DFHLUCPS
      DESCRIPTIVE NAME = CICS TS DFHLUC Parameter List
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1986, 1994 
      FUNCTION =
           Contains the request and response for modules called by
           the DFHLUC macro.
           When the DFHLUC macro is used to invoke a LU6.2 request
           appropriate fields in the parameter list are set, and
           module DFHZARL is invoked. All information passed to
           and from DFHZARL is passed in this parameter list.
           It is also used to pass information from DFHZARL to
           DFHZERH and DFHZARR for certain requests, and to DFHZXR3
           for LU6.2 transaction routing.
      LIFETIME =
      STORAGE CLASS =
      LOCATION =
           The control block is located in the LIFO storage of the
           module which issues the DFHLUC macro; it may also
           be copied into the LIFO of the called module.
      INNER CONTROL BLOCKS = None
      NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS =
       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 20 DFHLUCDS 
    The first part of the parameter list is common to all requests
(0) CHARACTER 1 LUCOPN0 MAJOR REQUEST BYTE
(1) CHARACTER 1 LUCOPN1 MINOR REQUEST BYTE 1
(1) CHARACTER 0 * ALLOCATE / ALLOCATE PRIV
(1) 1... ....   LUCNOQ NOQUEUE specified
(1) .1.. ....   LUCASYSV LUCASYS is valid
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   LUCAPRFV APROFILE specified
(1) .... .1..   LUCNPRFV NPROFILE specified
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * INITIAL CALL, SEND, SEND-FMH
(1) 1... ....   LUCFROM Initial data provided or application data provided
(1) .1.. ....   LUCLISTV LLID data specified
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * ISSUE ABEND / ISSUE ERROR
(1) 1... ....   LUCABUSE User invocation
(1) .1.. ....   *
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * ISSUE ATTACH request
(1) 1... ....   LUCNOCHK TPN check not required
(1) .1.. ....   *
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * RECEIVE / RECEIVE FMH request
(1) 1... ....   LUCSET SET option specified
(1) .1.. ....   LUCBELOW DATALOC option
(1) ..1. ....   LUCNOLA Look Ahead option
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * SYNC-COMMITTED request
(1) 1... ....   LUCEXPF Explicit FORGET specified
(1) .1.. ....   LUCIMPF Implicit FORGET specified
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(1) CHARACTER 0 * FREE request
(1) 1... ....   LUCFRIMP IMPLICIT free
(1) .1.. ....   *
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   *
(2) CHARACTER 1 LUCOPN2 MINOR REQUEST BYTE 2
(2) CHARACTER 0 * ALLOCATE / ALLOCATE-PRIV
(2) 1... ....   LUCMODNV LUCMODNM is valid
(2) .1.. ....   LUCATI 'ATI' Allocate
(2) ..1. ....   LUCPRIV ALLOCATE PRIV request
(2) ...1 ....   LUCNETV NETNAME= specified
(2) .... 1...   LUCMNPRF Modename set to use profile modename
(2) .... .1..   *
(2) .... ..1.   *
(2) .... ...1   *
(2) CHARACTER 0 * ISSUE ERROR / ISSUE ABEND
(2) 1... ....   LUCAMSGV LUCAMSG, LUCLMSG valid
(2) .1.. ....   LUCSENSV LUCSENSE is valid
(2) ..1. ....   LUCMSGNV LUCMSGNO is valid
(2) ...1 ....   *
(2) .... 1...   LUCSSEND STATE=SEND was specified
(2) .... .1..   LUCSRECV STATE=RECEIVE specified
(2) .... ..1.   *
(2) .... ...1   *
(2) CHARACTER 0 * RECEIVE request
(2) 1... ....   LUCLLID receive LLID
(2) .1.. ....   LUCBUFR receive BUFFER
(2) ..1. ....   LUCIMMED SUBTYPE=IMMEDIATE specified
(2) ...1 ....   *
(2) .... 1...   *
(2) .... .1..   *
(2) .... ..1.   *
(2) .... ...1   *
(2) CHARACTER 0 * SEND / SEND-FMH request
(2) 1... ....   LUCNVIT INVITE option
(2) .1.. ....   LUCLAST LAST option (also used for SYNC- PREPARE and SYNC-REQ-COMMIT
(2) ..1. ....   LUCCONF CONFIRM option
(2) ...1 ....   LUCFLSH WAIT (or FLUSH!) option
(2) .... 1...   *
(2) .... .1..   *
(2) .... ..1.   *
(2) .... ...1   *
(3) CHARACTER 1 LUCOPN3 MINOR REQUEST BYTE 3
(3) CHARACTER 0 *
(3) 1... ....   LUCSYSCL System call
(3) .1.. ....   LUCNOSIG Do not return SIGNAL (Rec)
(3) ..1. ....   LUCNOSF Do not return sess fails
(3) ...1 ....   *
(3) .... 1...   *
(3) .... .1..   *
(3) .... ..1.   *
(3) .... ...1   *
(4) CHARACTER 6 LUCRCODE FEEDBACK FOR REQUEST RELATED ERRORS
(4) CHARACTER 1 LUCRCOD1 MAJOR ERROR BYTE
(5) CHARACTER 1 LUCRCOD2 MINOR ERROR BYTE
(6) CHARACTER 1 LUCRCOD3 MINOR ERROR BYTE
(7) CHARACTER 1 LUCRCOD4 Reserved
(8) CHARACTER 1 LUCRCOD5 Reserved
(9) CHARACTER 1 LUCRCOD6 Reserved
(A) CHARACTER 6 LUCSDBLK FEEDBACK FOR Conversation Related Errors
(A) CHARACTER 1 LUCFDBK1 STORAGE DEFINITION
(A) 1... ....   LUCCIDCM 1 - DATA COMPLETE
(A) .1.. ....   LUCCISYN 1 - SYNCPOINT REQ'D
(A) ..1. ....   LUCCIFRE 1 - FREE REQUESTED
(A) ...1 ....   LUCCIREC 1 - RECEIVE REQUIRED
(A) .... 1...   LUCCISIG 1 - SIGNAL RECEIVED
(A) .... .1..   LUCCICON 1 - CONFIRMATION REQ'D
(A) .... ..1.   LUCCIERR 1 - ERROR RECEIVED
(A) .... ...1   LUCCIRBK 1 - ROLLBACK REQUESTED
(B) CHARACTER 1 LUCFDBK2
(B) 1... ....   LUCCINEG Negative response received
(B) .1.. ....   LUCCINSU RECEIVE IMMEDIATE was unsuccesful
(B) ..1. ....   *
(B) ...1 ....   *
(B) .... 1...   *
(B) .... .1..   *
(B) .... ..1.   *
(B) .... ...1   *
(C) CHARACTER 4 LUCCDRCD ERROR CODE RECEIVED
(10) ADDRESS 4 LUCTTERQ ADDRESS OF TCTTE FOR THE CURRENT REQUEST 
    The second part of the parameter list is used by some requests
    only, and in different ways by each request:
(14) CHARACTER 0 LUCORG ADDITIONAL PARAMETERS ARE OVERLAID ON LUCORG 
      Overlay for ALLOCATE and ALLOCATE-PRIV requests
Table 2.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 52 * 
         inputs
(14) ADDRESS 4 LUCASYS SYSID (TCTSE) ADDRESS
(18) CHARACTER 4 LUCNSYS SYSID (TCTSE) NAME
(1C) CHARACTER 8 LUCMODNM MODENAME 
         outputs
(24) ADDRESS 4 LUCTTEAL ADDRESS OF ALLOCATED TCTTE 
         further inputs
(28) ADDRESS 4 LUCAPROF Address of PROFILE
(2C) CHARACTER 8 LUCNPROF Name of PROFILE
(34) FULLWORD 4 LUCNETNL Netname length
(38) CHARACTER 8 LUCNETNM Netname
(40) CHARACTER 8 LUCMGAL Mode group allocated 
      Overlay for EXTRACT PROCESS requests
Table 3.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 92 * 
         outputs
(14) CHARACTER 1 LUCEPCON CONVTYPE SPECIFIED IN LU6.2 ATTACH FMH RECEIVED
(15) CHARACTER 1 LUCEPSYN SYNCLEVEL SPECIFIED IN LU6.2 ATTACH FMH RECEIVED
(16) CHARACTER 1 LUCTTPNL ACTUAL LENGTH OF TPN IN LU6.2 ATTACH FMH RECEIVED
(17) CHARACTER 64 LUCTTPN TPN IN LU6.2 ATTACH FMH RECEIVED
(57) CHARACTER 1 * alignment
(58) ADDRESS 4 LUCPIPDA address of PIP list
(5C) HALFWORD 2 LUCPIPDL LENGTH OF PIPLIST
(5E) CHARACTER 8 LUCMODEN Mode name
(66) HALFWORD 2 LUCLUNML Length of fully qualified LU name
(68) CHARACTER 8 LUCLUNAM Qualified LU name 
      Overlay for FREE STORAGE request
Table 4.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 4 * 
         inputs
(14) ADDRESS 4 LUCASTG ADDR STORAGE TO BE FREED 
      Overlay for GET-MY-LUNAME request
Table 5.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 4 * 
         outputs
(14) ADDRESS 4 LUCALUNM ADDRESS OF QUALIFIED LUNAME - ONE BYTE LENGTH FOLLOWED BY QUALIFIED LUNAME 
      Overlay for ISSUE-ABEND and ISSUE-ERROR requests
Table 6.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 12 * 
         inputs
(14) ADDRESS 4 LUCAMSG MESSAGE TEXT ADDRESS
(18) HALFWORD 2 LUCLMSG MESSAGE TEXT LENGTH
(1A) CHARACTER 2 LUCMSGNO MESSAGE NUMBER
(1C) CHARACTER 4 LUCSENSE SENSE CODE 
      Overlay for ISSUE-ATTACH request
Table 7.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 68 * 
         inputs
(14) CHARACTER 1 LUCRQCON CONVTYPE REQUIRED IN LU6.2 ATTACH FMH SENT
(15) CHARACTER 1 LUCRQSYN SYNCLEVEL REQUIRED IN LU6.2 ATTACH FMH SENT
(16) CHARACTER 1 LUCFTPNL LENGTH OF TPN FOR LU6.2 ATTACH FMH SENT
(17) CHARACTER 64 LUCFTPN TPN FOR LU6.2 ATTACH FMH SENT
(57) CHARACTER 1 LUCPIP PIP DATA TO BE SENT
(57) 1... ....   *
(57) .1.. ....   *
(57) ..1. ....   *
(57) ...1 ....   *
(57) .... 1...   *
(57) .... .1..   *
(57) .... ..1.   *
(57) .... ...1   LUCPIPI 1 - PIP DATA PRESENT 
      Overlay for RECEIVE (R) and RECEIVE-FMH (RF) requests
Table 8.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 16 * 
         inputs
(14) ADDRESS 4 LUCTAREA INTO AREA ADDR (R, RF)
(18) FULLWORD 4 LUCTAREL MAX. APPL LENG (R, RF) 
         outputs
(1C) ADDRESS 4 LUCBFPTR SET DATA ADDR (R, RF)
(20) FULLWORD 4 LUCTDATL ACT. DATA LENG (R, RF) 
      Overlay for SEND (S), SEND-FMH (SF) and INITIAL-CALL requests
Table 9.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 16 * 
         inputs
(14) ADDRESS 4 LUCFDATA DATA ADDRESS (S, SF)
(18) FULLWORD 4 LUCFDATL DATA LENGTH (S, SF)
(1C) ADDRESS 4 LUCLISTA LIST address (Send)
(20) FULLWORD 4 LUCLISTS LIST size 
      Overlay for SYNC-PREPARE request
Table 10.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 1 * 
         outputs
(14) CHARACTER 1 LUCSPRET RESULT OF PREPARE
(14) 1... ....   LUCSPRQD RQD2 received
(14) .1.. ....   LUCSPFGT FORGET received
(14) ..1. ....   LUCSPHM HM Received
(14) ...1 ....   LUCSPVUR Vote unreliable received
(14) .... 1...   *
(14) .... .1..   *
(14) .... ..1.   *
(14) .... ...1   * 
      Overlay for SYNC-REQ-COMMIT request
Table 11.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 1 * 
         outputs
(14) CHARACTER 1 LUCSRRET RESULT OF REQUEST COMMIT
(14) 1... ....   LUCSRDR2 DR2 received
(14) .1.. ....   LUCSRNVL Invalid response received
(14) ..1. ....   LUCSRHM HM received
(14) ...1 ....   *
(14) .... 1...   *
(14) .... .1..   *
(14) .... ..1.   *
(14) .... ...1   * 
      Overlay for SYNC-COMMITTED request
Table 12.
Offset Hex Type Len Name (Dim) Description
(14) STRUCTURE 1 * 
         outputs
(14) CHARACTER 1 LUCSCRET RESULT OF COMMITTED
(14) 1... ....   LUCSCFGT FORGET received
(14) .1.. ....   LUCSCNVL Invalid response received
(14) ..1. ....   LUCSCHM HM Received
(14) ...1 ....   *
(14) .... 1...   *
(14) .... .1..   *
(14) .... ..1.   *
(14) .... ...1   *

Constants

Table 13.
Len Type Value Name Description 
    The following constants define the values of LUCOPN0, the Major
    Request byte, allocated as follows:
         X'01' - X'0F' - APPLICATION LEVEL CALLS TO DFHZARL
         X'10' - X'1F' - SYSTEM LEVEL CALLS TO DFHZARL
         X'20' - X'??' - FOR CALLS FROM DFHZARL
1 HEX 01 LUCALLOC ALLOCATE REQUEST
1 HEX 02 LUCTSIG TEST-SIGNAL request
1 HEX 03 LUCEXTP EXTRACT PROCESS REQUEST
1 HEX 05 LUCFREE FREE REQUEST
1 HEX 06 LUCIABN ISSUE ABEND REQUEST
1 HEX 07 LUCIATT ISSUE ATTACH REQUEST
1 HEX 08 LUCICON ISSUE CONFIRMATION REQ
1 HEX 09 LUCIERR ISSUE ERROR REQUEST
1 HEX 0A LUCISIG ISSUE SIGNAL REQUEST
1 HEX 0B LUCRECV RECEIVE REQUEST
1 HEX 0C LUCSEND SEND REQUEST
1 HEX 0D LUCWAIT WAIT REQUEST
1 HEX 10 LUCFRST FREE STORAGE REQUEST
1 HEX 11 LUCICAL INITIAL CALL REQUEST
1 HEX 12 LUCPRVAL ALLOCATE-PRIV REQUEST
1 HEX 13 LUCPREP SYNC PREPARE REQUEST
1 HEX 14 LUCRQCM SYNC REQUEST COMMIT REQ
1 HEX 15 LUCCMTD SYNC COMMITTED REQUEST
1 HEX 16 LUCFGET SYNC FORGET REQUEST
1 HEX 18 LUCGLUN Get LUNAME request
1 HEX 19 LUCRBCK SYNC ROLLBACK REQUEST
1 HEX 1A LUCSFMH SEND FMH request
1 HEX 1B LUCRFMH RECEIVE-FMH REQUEST
1 HEX 1C LUCUNBDC UNBIND-CLEANUP request
1 HEX 1D LUCISPRE ISSUE-PREPARE request
1 HEX 20 LUCRERP ERP FMH RECEIVED
1 HEX 21 LUCRNEG NEG RESP RECEIVED
1 HEX 22 LUCLSDST CLSDST call
1 HEX 23 LUCPRGSD PURGE-SEND call 
    The following constants define the values of the Major Error
    byte LUCRCOD1:
1 HEX 01 LUCESYSI SYSID error 
         The following values of LUCRCOD2 qualify this value of
         LUCRCOD1: '08'X SYSID is out of service This is further
         qualified by the following values of LUCRCOD3: '00'X Local
         queueing was not attempted '04'X Local queueing did not
         succeed '0C'X SYSID is not known in TCT This is further
         qualified by the following values of LUCRCOD3: '00'X SYSID
         name is not known '04'X SYSID name is not that of a TCTSE
         '08'X SYSID.MODENAME is not known '0C'X SYSID.PROFILE is not
         known
1 HEX 02 LUCESYSB SYSBUSY error
1 HEX 03 LUCEINVR INVREQ ERROR 
         The following values of LUCRCOD2 qualify this value of
         LUCRCOD1: '00'X Session is not defined as LU6.2 '04'X
         Converation level is wrong '08'X State error '0C'X Synclevel
         cannot be supported '0D'X Negative receive length (LUCTAREL)
         '10'X LL count error '11'X LL is invalid '12'X LL is
         incomplete '14'X Invalid request '18'X TPN send check failed
         '24'X Invalid request to ISSUE PREPARE

         Equates for LUCRCOD2 qualifiers documented above
1 HEX 00 LUCERC00
1 HEX 01 LUCERC01
1 HEX 02 LUCERC02
1 HEX 03 LUCERC03
1 HEX 04 LUCERC04
1 HEX 05 LUCERC05
1 HEX 06 LUCERC06
1 HEX 08 LUCERC08
1 HEX 0C LUCERC0C
1 HEX 0D LUCERC0D Negative receive length
1 HEX 10 LUCERC10
1 HEX 14 LUCERC14
1 HEX 18 LUCERC18
1 HEX 1C LUCERC1C
1 HEX 20 LUCERC20
1 HEX 24 LUCERC24
1 HEX 04 LUCENTAL NOTALLOC error
1 HEX 05 LUCELENG LENGERR ERROR
1 HEX 06 LUCEPROF PROFILE not found
1 HEX 11 LUCERLLE Invalid LL
1 HEX 12 LUCERLLI Incomplete LL 
    Constant values for LUCRQCON (also used for LUCEPCON)
1 HEX 00 LUCUNMP CONVTYPE IS UNMAPPED (GDS)
1 HEX 01 LUCMAPD CONVTYPE IS MAPPED (ELM) 
    Constant values for LUCRQSYN (also used for LUCEPSYN)
1 HEX 00 LUCSYNC0 SYNCLEVEL 0 (NOSYNC)
1 HEX 01 LUCSYNC1 SYNCLEVEL 1 (CONFIRM)
1 HEX 02 LUCSYNC2 SYNCLEVEL 2 (SYNCPT) 
    Define the length of the control block
4 DECIMAL 112 LUCLSTG