Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM.

#### CONBK

Prolog

Control Block Contents
CONBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### CONBK Prolog

     NAME       : HCPCONBK
     DESCRIPTION: APPCVM CONNECT BLOCK
     DSECT      : CONBK
     FUNCTION   : CONTAINS INFORMATION RELATED TO AN APPCVM CONNECT
     LOCATED BY : PDESADDR FIELD OF PDEBK (WHEN PDEALLAV IS SET)
                  DCRSCEXT FIELD OF DCRBK
     CREATED BY : HCPIUP
     DELETED BY : HCPIUB (ACCEPT  PROCESSING)
                  HCPIUL (SEVER   PROCESSING)
                  HCPIUN (RECEIVE PROCESSING)
                  HCPIUP (CONNECT PROCESSING)
                  HCPIUQ (DELAYED CONNECT PROCESSING)
     NOTES      : THIS COPY FILE REQUIRES THE FOLLOWING IN ORDER
                  TO GENERATE PROPERLY:
                  - IPARMLX
                  - HCPMSGBK
                  - HCPCNUBK

#### CONBK Control Block Content

#### CONBK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      CONBK          APPCVM CONNECT BLOCK
          NOTES      :
                 WHEN THE INVOKER OF APPCVM CONNECT SPECIFIES FMH5=NO,
                 ANY DATA PROVIDED BY THE INVOKER IN THE CONNECTION
                 PARAMETER LIST EXTENSION (CPLE) IS PLACED IN THE CONIDATA
                 AREA OF CONBK. THE ADDRESS AND LENGTH OF THE CPLE IS
                 PROVIDED BY THE INVOKER IN IPBFADR2 AND IPBFLN2F.
                 CP WILL USE THIS INFORMATION WHEN BUILDING THE ALLOCATE
                 DATA PORTION OF THIS CONTROL BLOCK.
                 THE CONIDATA AREA IS MAPPED BY THE IPARMLX DSECT IN
                 IPARMLX COPY.
         **** THE VALUE OF IPXDWSIZ FOR DATAMAP IS 20
    0000    0 Dbl-Word     8 CONIDATA (20)  CON EXT PLIST INPUT AREA
    00A0  160 Signed       4 CONLENTH       EXTENSION LENGTH IN DOUBLEWORDS
    00A4  164 Signed       4 CONADLEN       ACTUAL ALLOCATE DATA LENGTH ****
                                            THE VALUE OF MSGSIZE FOR DATAMAP
                                            IS 7
    00A8  168 Dbl-Word     8 CONMSGBK (7)   ALLOCATE DATA MSGBLOK
                                           *** Start of CNUBK map
         **** The value of CNUSIZE for datamap is 7
    00E0  224 Bitstring   56 CONRWORK (0)   INPUT TO HCPIDRFN
    00E0  224 Character    8 CONRNAME       RESOURCE/GATEWAY NAME
    00E8  232 Bitstring    1 *              RESERVED
    00E9  233 Bitstring    1 CONRSLVL       RESOURCE'S SECURITY LEVEL
              .1.. ....      CONRNONE       X'40' CONRNONE SECURTY(NONE) ON
                                            CONNECT OK
              ...1 ....      CONRINDR       X'10' CONRINDR This is an
                                            indirect connect
    00EA  234 Bitstring    1 *              RESERVED
    00EB  235 Bitstring    1 CONRTYPE       TYPE OF RESOURCE PROVIDED
              00000001       CONRGATE       X'01' CONRGATE CONRNAME CONTAINS
                                            A GATEWAY
    00EC  236 Bitstring    4 *              RESERVED
    00F0  240 Character    8 CONRUSER       USERID OF RESOURCE OWNER
    00F8  248 Bitstring   32 *              Reserved *** End of CNUBK map
    0118  280 Bitstring    1 CONPSWDL       LENGTH OF PSWD TO ENCRYPT
    0119  281 Bitstring    3 *              RESERVED
    011C  284 Signed       4 CONPSWDA       ADDR OF PSWD TO ENCRYPT
    0120  288 Character    8 CONALTID       SOURCE'S VMDALTID VALUE
          NOTES      :
                 THE NODE PORTION OF THE ALLOCATE DATA FOLLOWS.
                 THIS IS NEVER PROVIDED BY THE SOURCE OF THE CONNECT.
                 IT IS FILLED IN BY CP AFTER A BROADCAST REQUEST TO
                 LOCATE A PRIVATE SERVER IN THE COLLECTION. THIS IS
                 ONLY PART OF THE ALLOCATE DATA WHEN WE ARE ROUTING
                 A PRIVATE SERVER CONNECT THROUGH TSAF TO ANOTHER NODE
                 IN THE COLLECTION.  TSAF NEEDS THIS INFORMATION IN
                 ORDER TO ROUTE THE CONNECT TO THE NODE WHERE THE PRIVATE
                 SERVER IS LOCATED.
    0128  296 Character    8 CONNODE        USERS NODE IN COLLECTION
              00000130       CONFIXED       *-CONBK FIXED LENGTH OF CONBK
          NOTES      :
                 THE VM AREA AND FMH5 PORTION OF THE ALLOCATE DATA FOLLOWS.
                 WHEN FMH5=YES, THE INVOKER OF CONNECT PROVIDES THIS DATA.
                 HENCE THE SIZE OF THIS AREA WILL VARY AND ONLY CONVMARE,
                 CONVTOTL, CONVFIXL AND CONVCOML CAN BE REFERENCED DIRECTLY.
                 WHEN FMH5=NO, CP BUILDS THE ALLOCATE DATA.  HENCE THE SIZE
                 OF THIS AREA IS FIXED AND REPRESENTS THE LARGEST POSSIBLE
                 VM AREA/FMH5 CP CAN BUILD.
    0130  304 Character  164 CONVMARE (0)   VM AREA OF ALLOCATE DATA
    0130  304 Signed       2 CONVTOTL       TOTAL LENGTH
    0132  306 Signed       2 CONVFIXL       FIXED LENGTH FIELDS LENGTH
    0134  308 Signed       2 *              RESERVED
    0136  310 Signed       2 CONVCOML       VM COM SERVER AREA LENGTH
    0138  312 Bitstring    1 CONVSIIL       SESSION INSTANCE ID LENGTH
    0139  313 Bitstring    1 CONVLFQL       LOCAL FULLY QUAL LU LENGTH
    013A  314 Bitstring    1 CONVRFQL       REMOTE FULLY QUAL LU LENGTH
    013B  315 Character    5 *              RESERVED
    0140  320 Character    8 CONVMODE       MODE NAME SPECIFIED
    0148  328 Character    8 CONVSII        SESSION INSTANCE IDENTIFIER
    0150  336 Character   16 CONVLKL (0)    LOCALLY KNOWN LUNAME
    0150  336 Character    8 CONVLUQ        LUNAME QUALIFIER
    0158  344 Character    8 CONVTLU        TARGET LUNAME
    0160  352 Character   16 CONVPLKL (0)   PARTNER LOCAL KNOWN LUNAME
    0160  352 Character    8 CONVPLUQ       PARTNER LUNAME QUALIFIER
    0168  360 Character    8 CONVPTLU       PARTNER TARGET LUNAME
    0170  368 Character   17 CONVLFQ        LOCAL FULLY QUALIFIED LU
    0181  385 Character   17 CONVRFQ        REMOTE FULLY QUALIFIED LU
    0192  402 Character    6 *              RESERVED
    0198  408 Character    8 CONVALT        "CURRENT" ALTID FOR TARGET
    01A0  416 Character    8 CONVVCIT       VIRT CONFIGURATION ID TOKEN
          The next set of information, along with the variable-length
          supplementary group ID (SGID) information, is passed on
          each connect so that the server at the other end can have
          access to POSIX access control information.
    01A8  424 Bitstring    1 CONVIDFL       Access control flags
              1... ....      CONVIDVL       X'80' CONVIDVL The UID/GID
                                            information has been filled in.
    01A9  425 Bitstring    3 *              Reserved for IBM use.
    01AC  428 Signed       4 CONVEUID       Effective UID of the process
                                            issuing the CONNECT.
    01B0  432 Signed       4 CONVEGID       Effective GID of the process
                                            issuing the CONNECT.
    01B4  436 Signed       4 CONVRUID       Real UID of the process issuing
                                            the CONNECT.
    01B8  440 Signed       4 CONVRGID       Real GID of the process issuing
                                            the CONNECT.
    01BC  444 Signed       4 CONVIDLN       Length of the supplementary GID
                                            information (may be in the range
                                            zero to NGMAXMAX*4).
    01C0  448 Signed       4 CONVVARL       Total length of the VM-defined
                                            variable length section of this
                                            block. This section begins after
                                            the FMH5 and is followed by the
                                            communication server area.
              00000094       CONVVRSL       *-CONVMARE VMA area length
                                            including the variable-length
                                            section length field. This field
                                            must be distinct from CPEVMLEN to
                                            allow future expansion.
    01C4  452 Character   16 CONVCBPL (0)   Partner LUNAME to use in
                                            connecting back to the partner.
    01C4  452 Character    8 CONVCBLQ       LUNAME qualifier to use in
                                            connecting back to the partner.
                                            Contains one of the following:
                                            *USERID if the connection
                                            originated on the same system as
                                            the target. (The value is equal
                                            to that in CONVPLUQ.)
                                            <gatelu> if the connection
                                            is through AVS or an unknown
                                            comserv. (The value is equal to
                                            that in CONVPLUQ.) <system
                                            gateway name of originating
                                            system> if the connection is
                                            through ISFC or TSAF. <system
                                            gateway name of the gateway
                                            system> if the connection is
                                            passing from a CS collection to a
                                            TSAF collection or vice versa.
    01CC  460 Character    8 CONVCBTL       Target luname to use in
                                            connecting back to the partner.
                                            This should always be equal to
                                            CONVPTLU; it's added here for
                                            ease of use.
              0000009C       CONVFIX        *-CONVSIIL VM AREA FIXED FIELDS
                                            LENGTH
              000000A4       CONVMLEN       *-CONVMARE LENGTH OF VM AREA
          NOTES      :
                 HCPIUP CONTAINS THE TEMPLATE FOR INITIALIZING THE FIRST
                 10 BYTES OF THE FMH5 THAT CP BUILDS.  SOME OF THESE
                 VALUES WILL BE OVERRIDEN IN HCPIUP BASED ON INFORMATION
                 PROVIDED BY THE SOURCE OF THE CONNECT.
    01D4  468 Bitstring  131 CONFMH5 (0)    FMH5 ATTACH
    01D4  468 Bitstring    1 *              FMH5 TOTAL LENGTH
    01D5  469 Bitstring    1 *              TYPE IS FMH5 (X'12')
    01D6  470 Bitstring    2 *              ATTACH CMD CODE (X'02FF')
    01D8  472 Bitstring    1 CONFFLAG       FLAG FIELD
              1... ....      CONFAV         X'80' CONFAV ALREADY-VERIFIED
                                            INDICATOR
              .... 1...      CONFPIP        X'08' CONFPIP PIP PRESENT
              00000005       CONFFIXL       *-CONFMH5 1ST 5 BYTES ARE FIXED
    01D9  473 Bitstring    1 *              FIXED LENGTH FIELDS LENGTH
    01DA  474 Bitstring    1 CONFTYPE       CONVERSATION TYPE
              000000D0       CONFBASC       X'D0' CONFBASC BASIC CONVERSATION
              000000D1       CONFMAPC       X'D1' CONFMAPC MAPPED
                                            CONVERSATION
    01DB  475 Bitstring    1 *              RESERVED
    01DC  476 Bitstring    1 CONFSYNC       SYNCHRONIZATION LEVEL
              00000080       CONFSYPT       X'80' CONFSYPT SYNCLVL=SYNCPT,
                                            CNF, BKOUT
              00000040       CONFCONF       X'40' CONFCONF SYNCLVL=CONFIRM
    01DD  477 Bitstring    1 CONFTPNL       TRANSACTION PRG NAME LENGTH
          NOTES      :
                 THE TPN, SECURITY AREA, LUWID THAT CP BUILDS CAN VARY IN
                 SIZE UP TO THE MAXIMUM SIZE DEFINED HERE.  YOU MUST
                 CALCULATE ADDRESSABILITY TO THE FOLLOWING LABELS WHEN
                 BUILDING THE FMH5.
    01DE  478 Character   64 CONFTPN        TRANSACTION PROGRAM NAME
              0000004A       CONFLEN        *-CONFMH5 MAXIMUM FMH5 LENGTH
    021E  542 Bitstring   21 *              SECURITY AREA OF FMH5
    0233  563 Character   27 CONFLUW (0)    LUWID FIELDS
    0233  563 Bitstring    1 CONFLUWL       LUWID FIELD LENGTH
    0234  564 Character   26 CONFLUWI       LUWID
    024E  590 Character    9 CONFCCF (0)    CONVERSAT CORRELATOR FIELDS
    024E  590 Bitstring    1 CONFCCL        CONVERSATION CORRELATOR LEN
    024F  591 Character    8 CONFCC         CONVERSATION CORRELATOR
          Beginning of the VM-defined variable-length section.
          This section directly follows the FMH5 and precedes the
          communication server area. It consists of zero or more
          variable-length areas. The sum of the lengths of
          all of the information in this section is defined in
          CONVVARL.
          Supplementary GID information area
          This section comes immediately after the FMH5 and contains
          the supplementary group IDs (part of the set of POSIX
          access control values). The length of this section is
          in CONVIDLN in the VMA area; if the length is zero, there
          are no supplementary group IDs. The valid range for the
          length is zero to NGMAXMAX*4; APPC/VM connect
          processing checks to ensure that this area does not grow
          too big for APPC/VM connect processing to handle.
          Each SGID is four bytes long. The first starts at
          displacement zero in this area, the second at displacement
          four, and so on.
    0257  599 Bitstring  500 CONSGIDV (0)   Beginning of SGID information
    0257  599 Bitstring  500 CONSGIDS       Supplementary GIDs
          End of the VM-defined variable-length section.
          NOTES      :
                 THE VM COMMUNICATIONS SERVER AREA PORTION OF THE ALLOCATE
                 DATA FOLLOWS.
                 WHEN FMH5=YES, A COMMUNICATION SERVER CAN PROVIDE THIS
                 AREA ON CONNECT.  THIS INFORMATION IS NOT PASSED ON TO
                 THE TARGET OF THE CONNECT.
    044B 1099 Bitstring    8 CONCOMSV (0)
    044B 1099 Bitstring    1 CONCFLAG       FLAG BYTE
              .1.. ....      CONCPBFL       X'40' CONCPBFL PIP ADDRESS IS
                                            BUFFER LIST NOTES : CONCPBFL MUST
                                            MATCH IPXPBUFL'S VALUE IN IPARMLX
                                            COPY
    044C 1100 Bitstring    2 CONCPLEN       LENGTH OF PIP DATA
    044E 1102 Bitstring    1 *              RESERVED
    044F 1103 Bitstring    4 CONCPADR       ADDRESS OF PIP DATA
              00000001       CONCSIZE       (*-CONCOMSV+7)/8 CONCOMSV SIZE IN
                                            DOUBLEWORDS
          Block size - to be used only by the creator of the block.
              0000008B       CONBKSZ        (*-CONBK+7)/8 SIZE OF CONBK IN
                                            DOUBLEWORDS

#### CONBK Storage Layout

    *** CONBK - APPCVM CONNECT BLOCK
    *
    *     +-------------------------------------------------------+
    *   0 |                                                       |
    *     =                       CONIDATA                        =
    *     |                                                       |
    *     +---------------------------+---------------------------+
    *  A0 |         CONLENTH          |         CONADLEN          |
    *     +---------------------------+---------------------------+
    *  A8 |                                                       |
    *     =                       CONMSGBK                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  E0 |                       CONRNAME                        |
    *     +------+------+------+------+---------------------------+
    *  E8 |//////|:RSLVL|//////|:RTYPE|///////////////////////////|
    *     +------+------+------+------+---------------------------+
    *  F0 |                       CONRUSER                        |
    *     +-------------------------------------------------------+
    *  F8 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +------+--------------------+---------------------------+
    * 118 |:PSWDL|////////////////////|         CONPSWDA          |
    *     +------+--------------------+---------------------------+
    * 120 |                       CONALTID                        |
    *     +-------------------------------------------------------+
    * 128 |                       CONNODE                         |
    *     +-------------+-------------+-------------+-------------+
    * 130 |  CONVTOTL   |  CONVFIXL   |/////////////|  CONVCOML   |
    *     +------+------+------+------+-------------+-------------+
    * 138 |:VSIIL|:VLFQL|:VRFQL|//////////////////////////////////|
    *     +------+------+------+----------------------------------+
    * 140 |                       CONVMODE                        |
    *     +-------------------------------------------------------+
    * 148 |                       CONVSII                         |
    *     +-------------------------------------------------------+
    * 150 |                       CONVLUQ                         |
    *     +-------------------------------------------------------+
    * 158 |                       CONVTLU                         |
    *     +-------------------------------------------------------+
    * 160 |                       CONVPLUQ                        |
    *     +-------------------------------------------------------+
    * 168 |                       CONVPTLU                        |
    *     +-------------------------------------------------------+
    * 170 |                                                       |
    *     =                       CONVLFQ                         =
    *     |      +------------------------------------------------+
    * 180 |      |                                                |
    *     +------+                                                |
    *     |                       CONVRFQ                         |
    *     |             +-----------------------------------------+
    * 190 |             |/////////////////////////////////////////|
    *     +-------------+-----------------------------------------+
    * 198 |                       CONVALT                         |
    *     +-------------------------------------------------------+
    * 1A0 |                       CONVVCIT                        |
    *     +------+--------------------+---------------------------+
    * 1A8 |:VIDFL|////////////////////|         CONVEUID          |
    *     +------+--------------------+---------------------------+
    * 1B0 |         CONVEGID          |         CONVRUID          |
    *     +---------------------------+---------------------------+
    * 1B8 |         CONVRGID          |         CONVIDLN          |
    *     +---------------------------+---------------------------+
    * 1C0 |         CONVVARL          |        CONVCBLQ-          |
    *     +---------------------------+---------------------------+
    * 1C8 |          -(1C4)           |        CONVCBTL-          |
    *     +---------------------------+------+------+-------------+
    * 1D0 |          -(1CC)           |//////|//////|/////////////|
    *     +------+------+------+------+------+------+-------------+
    * 1D8 |:FFLAG|//////|:FTYPE|//////|:FSYNC|:FTPNL|             |
    *     +------+------+------+------+------+------+             |
    * 1E0 |                                                       |
    *     =                       CONFTPN                         =
    *     |                                         +-------------+
    *     |                                         |/////////////|
    *     +-----------------------------------------+/////////////|
    * 220 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |////////////////////+------+---------------------------+
    * 230 |////////////////////|:FLUWL|                           |
    *     +--------------------+------+                           |
    * 238 |                                                       |
    *     =                       CONFLUWI                        =
    *     |                                         +------+------+
    * 248 |                                         |:FCCL |(24F)-|
    *     +-----------------------------------------+------+------+
    * 250 |                    -CONFCC                     |      |
    *     +------------------------------------------------+      |
    * 258 |                                                       |
    *     =                       CONSGIDS                        =
    *     |                    +------+-------------+------+------+
    * 448 |                    |:CFLAG|  CONCPLEN   |//////|(44F)-|
    *     +--------------------+------+-------------+------+------+
    * 450 |     -CONCPADR      | 453
    *     +--------------------+
    *
    *** CONBK - APPCVM CONNECT BLOCK

#### CONBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    CONADLEN       00A4
    CONALTID       0120
    CONBKSZ        044F 0000008B
    CONCFLAG       044B
    CONCOMSV       044B
    CONCPADR       044F
    CONCPBFL       044B 40
    CONCPLEN       044C
    CONCSIZE       044F 00000001
    CONFAV         01D8 80
    CONFBASC       01DA 000000D0
    CONFCC         024F
    CONFCCF        024E
    CONFCCL        024E
    CONFCONF       01DC 00000040
    CONFFIXL       01D8 00000005
    CONFFLAG       01D8
    CONFIXED       0128 00000130
    CONFLEN        01DE 0000004A
    CONFLUW        0233
    CONFLUWI       0234
    CONFLUWL       0233
    CONFMAPC       01DA 000000D1
    CONFMH5        01D4
    CONFPIP        01D8 08
    CONFSYNC       01DC
    CONFSYPT       01DC 00000080
    CONFTPN        01DE
    CONFTPNL       01DD
    CONFTYPE       01DA
    CONIDATA       0000
    CONLENTH       00A0
    CONMSGBK       00A8
    CONNODE        0128
    CONPSWDA       011C
    CONPSWDL       0118
    CONRGATE       00EB 00000001
    CONRINDR       00E9 10
    CONRNAME       00E0
    CONRNONE       00E9 40
    CONRSLVL       00E9
    CONRTYPE       00EB
    CONRUSER       00F0
    CONRWORK       00E0
    CONSGIDS       0257
    CONSGIDV       0257
    CONVALT        0198
    CONVCBLQ       01C4
    CONVCBPL       01C4
    CONVCBTL       01CC
    CONVCOML       0136
    CONVEGID       01B0
    CONVEUID       01AC
    CONVFIX        01CC 0000009C
    CONVFIXL       0132
    CONVIDFL       01A8
    CONVIDLN       01BC
    CONVIDVL       01A8 80
    CONVLFQ        0170
    CONVLFQL       0139
    CONVLKL        0150
    CONVLUQ        0150
    CONVMARE       0130
    CONVMLEN       01CC 000000A4
    CONVMODE       0140
    CONVPLKL       0160
    CONVPLUQ       0160
    CONVPTLU       0168
    CONVRFQ        0181
    CONVRFQL       013A
    CONVRGID       01B8
    CONVRUID       01B4
    CONVSII        0148
    CONVSIIL       0138
    CONVTLU        0158
    CONVTOTL       0130
    CONVVARL       01C0
    CONVVCIT       01A0
    CONVVRSL       01C0 00000094

This information is based on z/VM V6R1.0. Last updated on 18 Feb 2010 at 08:29:51 EDT.
Copyright IBM Corporation, 1990, 2008