PDEBK | Back to Index page

| Prolog Control Block Contents PDEBK DSECT Storage Layout Cross Reference (Contains links to field and bit definitions) |
Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM.

PDEBK Prolog | Top of page

     NAME       : HCPPDEBK
     DESCRIPTION: PATH DESCRIPTOR ENTRY
     DSECT      : PDEBK
     FUNCTION   : HOLDS INFORMATION ABOUT AN IUCV OR APPC/VM PATH.
     LOCATED BY : CCTPDSEG FIELD IN HCPCCTBK
     CREATED BY : HCPIUFGP FOR IUCV CONNECT AND APPCVM CONNECT
     DELETED BY : HCPIULSV FOR SEVER
     RELOCATION CONSIDERATIONS : This control block is relocated as part of a live
                  guest relocation (LGR).  The bits and fields that
                  need to be relocated are defined in the
                  corresponding LGRPDEBK COPY file.  Whenever changes
                  are made to this control block, consideration must
                  be given to any effects these changes will have on
                  a relocation.  If any new fields or bits are
                  defined, they may need to be relocated.  If
                  existing bits or fields are changed, corresponding
                  modifications may be required in the LGR version of
                  this control block.  Consider also the effects of
                  these changes on a relocation involving a back-level
                  release of CP.

PDEBK Control Block Content | Top of page

     PDEBK DSECT
    Top of page

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      PDEBK          PATH DESCRIPTOR ENTRY
    0000    0 Signed       2 PDEMSGCT       CNT OF OUTSTANDING MSGS ON PATH
    0002    2 Signed       2 PDETGPID       TARGET PATH ID
    0004    4 Address      4 PDETGCCT       TARGET CCT ADDRESS
    0008    8 Signed       4 PDETGLKA       TARGET IUCV LOCKWORD POINTER
          PDEVALID, PDEPEND1, PDEPEND2, and PDESERVD ( PEND1 + PDEND2)
          are the main flags used to indicate the status of one half
          of a path. The main combination's that will occur are
          PDEPEND1 on - The side of the path that has issued a CONNECT
          PDEPEND2 on - The side of the path that will issue an ACCEPT
          PDEVALID on - This side of the path is fully established.
          PDEVALID + PDESEVRD on - Partner has severed their side.
          If see PDEPHELD + PDESEVRD on, indicates that a SEVER has
          occurred on a path where the original function that set
          PDEPHELD had to release the IUCV lock for a brief time
          PDEPHELD is set for two different reasons.
          First, when the IUCV or APPCVM code is making a a call to
             an ESM and has given up the Invoker's IUCV lock from
               IUCV CONNECT
               APPCVM CONNECT
               IUCV SEVER
               APPCVM SEVER
          Second, when IUCV ACCEPT is going for the partner's lock,
             PDEPHELD on protects the Acceptor's PDEBK.
          The purpose of PDEPHELD is to give the calling function
          control over the disposition of a PDEBK when PDEPHELD is ON.
    000C   12 Bitstring    1 PDEFLAGS       STATUS
              1... ....      PDEVALID       X'80' PDEVALID VALID PATH
              .1.. ....      PDESEND        X'40' PDESEND SEND ALLOWED ON
                                            THIS PATH
              ..1. ....      PDEPRTY        X'20' PDEPRTY MAY INITIATE
                                            PRIORITY MESSAGES
              ...1 ....      PDEPRMD        X'10' PDEPRMD MAY PUT DATA IN
                                            PARMLIST
              .... 1...      PDEPHELD       X'08' PDEPHELD Path held by first
                                            invoker
              .... .1..      PDECNTRL       X'04' PDECNTRL CONTROL PATH
              .... ..1.      PDEPEND1       X'02' PDEPEND1 INITIATED
                                            CONNECTION
              .... ...1      PDEPEND2       X'01' PDEPEND2 INCOMING
                                            CONNECTION
              .... ....      PDEZERO        X'00' PDEZERO PDEBK INVALID AND
                                            AVAILABLE
              .... ..11      PDESEVRD       PDEPEND1+PDEPEND2 PDESEVRD ENTRY
                                            HAS BEEN SEVERED
    000D   13 Bitstring    1 PDEAPPFL       APPC/VM FLAGS
              1... ....      PDEAPPC        X'80' PDEAPPC APPC/VM PATH
              .1.. ....      PDEAPSCF       X'40' PDEAPSCF SENDCNF/SENDCNFD
                                            PERMITTED
              ..1. ....      PDEAPRCQ       X'20' PDEAPRCQ MSGBLOK QUEUED ON
                                            RECEIVE QUEUE
              ...1 ....      PDEAPSNQ       X'10' PDEAPSNQ MSGBLOK QUEUED ON
                                            SEND QUEUE
              .... 1...      PDEAPPND       X'08' PDEAPPND FUNCTION PENDING
                                            ON THIS PATH
              .... .1..      PDEAPSRQ       X'04' PDEAPSRQ SENDREQ PENDING ON
                                            THIS PATH
              .... ..1.      PDEAPMPD       X'02' PDEAPMPD MESSAGE PENDING
                                            BUT NOT IN RECEIVE STATE
              .... ...1      PDEPURGE       X'01' PDEPURGE IUCV PURGE allowed
                                            on this path
          NOTES      :
                 PDESTATE IS AN EXTERNAL VALUE.
                 IF A NEW STATE IS ADDED THERE ARE TABLES IN THE MODULES
                 WHICH HANDLE SEND, RECEIVE AND SEVER PROCESSING WHICH
                 HAVE CORRESPONDING ENTRIES ADDED.
    000E   14 Bitstring    1 PDESTATE       APPC/VM STATE CODES
              .... ...1      PDESRSET       X'01' PDESRSET PATH IN RESET
                                            STATE
              .... ..1.      PDESTCON       X'02' PDESTCON PATH IN CONNECT
                                            STATE
              .... ..11      PDESTSND       X'03' PDESTSND PATH IN SEND STATE
              .... .1..      PDESTRCV       X'04' PDESTRCV PATH IN RECEIVE
                                            STATE
              .... .1.1      PDESTCFM       X'05' PDESTCFM PATH IN CONFIRM
                                            STATE
              .... .11.      PDESTSVR       X'06' PDESTSVR PATH IN SEVER
                                            STATE
              .... .111      PDESDEFR       X'07' PDESDEFR PATH IN
                                            DEFER_RECEIVE STATE
              .... 1...      PDESDEFS       X'08' PDESDEFS PATH IN
                                            DEFER_SEVER STATE
              .... 1..1      PDESPREP       X'09' PDESPREP PATH IN
                                            PREPARE_RECEIVED STATE
              .... 1.1.      PDESSRCM       X'0A' PDESSRCM PATH IN STATE ...
                                            SOLICITED_REQUEST_COMMIT_RECEIVED
              .... 1.11      PDESURCM       X'0B' PDESURCM PATH IN STATE ...
                                            UNSOLICITED_REQUEST_COMMIT_RECEIV
                                            ED
              .... 11..      PDESCMTD       X'0C' PDESCMTD PATH IN
                                            COMMITED_RECEIVED STATE
              .... 11.1      PDESBOUT       X'0D' PDESBOUT PATH IN
                                            BACKOUT_RECEIVED STATE
              .... 111.      PDESBKRQ       X'0E' PDESBKRQ PATH IN
                                            BACKOUT_REQUIRED STATE
    000F   15 Bitstring    1 PDEAPPF2       SECOND APPC/VM FLAG BYTE
              1... ....      PDECMSRV       X'80' PDECMSRV COMMUNICATION
                                            SERVER PATH
              .1.. ....      PDELGDOK       X'40' PDELGDOK WILLING TO RECEIVE
                                            LOG_DATA
              ..1. ....      PDELGDAT       X'20' PDELGDAT LOG_DATA PENDING
                                            ON PATH
              ...1 ....      PDELDSVR       X'10' PDELDSVR PATH SEVERED WITH
                                            LOG_DATA
              .... 1...      PDETGOK        X'08' PDETGOK TARGET PATH IS
                                            STILL VALID
              .... .1..      PDESNCPT       X'04' PDESNCPT SYNCPT FLOWS
                                            ALLOWED ON PATH
              .... ..1.      PDECHGDR       X'02' PDECHGDR CHANGE DIRECTION
                                            IS OK
              .... ...1      PDEPDSPF       X'01' PDEPDSPF SETSTATE INV-
                                            SYNCPT FLOW PENDING
    0010   16 Bitstring    1 PDEAPPF3       THIRD APPC/VM FLAG BYTE
              1... ....      PDELRCNV       X'80' PDELRCNV ONLY FIRST BYTE OF
                                            LOGICAL RECORD LENGTH AVAILABLE
                                            IN CURRENT BUFFER
              .1.. ....      PDEACIMM       X'40' PDEACIMM ALLOCATE STATE AND
                                            RECEIVE STATE
              ..1. ....      PDESTBKR       X'20' PDESTBKR BACKOUT_REQUIRED
                                            SET VIA SETSTATE
              ...1 ....      PDEMDRCV       X'10' PDEMDRCV REQUEST RECEIVE
                                            STATE MODIFIER
              .... 1...      PDEMDSVR       X'08' PDEMDSVR REQUEST SEVER
                                            STATE MODIFIER
              .... .1..      PDEGOTPR       X'04' PDEGOTPR PREPARE RECEIVED
                                            ON PATH
              .... ..1.      PDESNTPR       X'02' PDESNTPR PREPARE SENT ON
                                            PATH
              .... ...1      PDESNCIP       X'01' PDESNCIP SYNCPOINT IN
                                            PROGRESS
    0011   17 Bitstring    1 PDEAPPF4       STATE RELATED FIELDS CONTROL
              1... ....      PDENEWLU       X'80' PDENEWLU PARTNER SUPPORTS
                                            RECEIVING LUWID
              .1.. ....      PDEPHAS2       X'40' PDEPHAS2 IN 2ND PHASE OF
                                            2-PHASE SYNCPT
              ..1. ....      PDEAPPCW       X'20' PDEAPPCW PATH IN APPCVM
                                            WAIT
              ...1 ....      PDESUSPC       X'10' PDESUSPC PATH IN SUSPENDED
                                            CONNECT
              .... 1...      PDEALLAV       X'08' PDEALLAV PDESADDR IS VALID
                                            CONBK ADDRESS CONBK IS ALLOCATION
                                            DATA
              .... .1..      PDECCED        X'04' PDECCED PDESADDR IS VALID
                                            CCED ADDRESS
              .... ..1.      PDEALTID       X'02' PDEALTID THIS PATH SET
                                            VMDALTID, SEVERING THIS PATH WILL
                                            CLEAR IT
              .... ...1      PDELUWID       X'01' PDELUWID STOP SENDBACK,
                                            SENDERR FOR NOW
    0012   18 Signed       2 PDELRECL       LENGTH REMAINING IN LOGICAL
                                            RECORD
    0014   20 Signed       4 PDESADDR       STATE RELATED ADDRESS IUSBK OR
                                            CONBK ADDRESS
    0018   24 Signed       2 PDEMSGLM       MESSAGE LIMIT
    001A   26 Bitstring    1 PDESAVST       PREVIOUS STATE OF PATH
    001B   27 Bitstring    1 PDEAPPF5       FIFTH FLAG BYTE
              1... ....      PDECANCL       X'80' PDECANCL Suspended CONNECT
                                            has been can- celled, blocks will
                                            be released
              .... 1...      PDESVSIP       X'08' PDESVSIP SEVER ISSUED
                                            DURING SYNCPT
              .... .1..      PDEPBRIP       X'04' PDEPBRIP PARTNER SPECIFIED
                                            RIP ON BACKOUT
              .... ..1.      PDELGPRT       X'02' PDELGPRT LOG DATA PARTIALLY
                                            RECEIVED
              .... ...1      PDELGSNC       X'01' PDELGSNC LOG DATA SENT
                                            DURING SYNCPT
    001C   28 Address      4 PDEPPA         Address of the PPA block for this
                                            connection.
              00000004       PDESIZE        (*-PDEBK+7)/8 PDEBK SIZE IN
                                            DOUBLEWORDS
           NOTES      : IN ORDER FOR THE PDEBK MANAGEMENT CODE TO WORK PROPERLY
                 THE FOLLOWING TWO VALUES MUST ALWAYS BE ROUNDED TO THE
                 NEAREST DOUBLE WORD VALUE.
              00000008       PDENTMIN       8 MIN NUMBER OF PDEBKS TO BE
                                            BUILT
              00000080       PDENTMAX       128 MAXIMUM PDEBKS IN A PDSEG

PDEBK Storage Layout | Top of page

    *** PDEBK - PATH DESCRIPTOR ENTRY
    *
    *     +-------------+-------------+---------------------------+
    *   0 |  PDEMSGCT   |  PDETGPID   |         PDETGCCT          |
    *     +-------------+-------------+------+------+------+------+
    *   8 |         PDETGLKA          |:FLAGS|:APPFL|:STATE|:APPF2|
    *     +------+------+-------------+------+------+------+------+
    *  10 |:APPF3|:APPF4|  PDELRECL   |         PDESADDR          |
    *     +------+------+------+------+---------------------------+
    *  18 |  PDEMSGLM   |:SAVST|:APPF5|          PDEPPA           |
    *     +-------------+------+------+---------------------------+
    *  20
    *
    *** PDEBK - PATH DESCRIPTOR ENTRY

PDEBK Cross Reference | Top of page

    Symbol         Dspl Value
    -------------- ---- -----
    PDEACIMM       0010 40
    PDEALLAV       0011 08
    PDEALTID       0011 02
    PDEAPMPD       000D 02
    PDEAPPC        000D 80
    PDEAPPCW       0011 20
    PDEAPPFL       000D
    PDEAPPF2       000F
    PDEAPPF3       0010
    PDEAPPF4       0011
    PDEAPPF5       001B
    PDEAPPND       000D 08
    PDEAPRCQ       000D 20
    PDEAPSCF       000D 40
    PDEAPSNQ       000D 10
    PDEAPSRQ       000D 04
    PDECANCL       001B 80
    PDECCED        0011 04
    PDECHGDR       000F 02
    PDECMSRV       000F 80
    PDECNTRL       000C 04
    PDEFLAGS       000C
    PDEGOTPR       0010 04
    PDELDSVR       000F 10
    PDELGDAT       000F 20
    PDELGDOK       000F 40
    PDELGPRT       001B 02
    PDELGSNC       001B 01
    PDELRCNV       0010 80
    PDELRECL       0012
    PDELUWID       0011 01
    PDEMDRCV       0010 10
    PDEMDSVR       0010 08
    PDEMSGCT       0000
    PDEMSGLM       0018
    PDENEWLU       0011 80
    PDENTMAX       001C 00000080
    PDENTMIN       001C 00000008
    PDEPBRIP       001B 04
    PDEPDSPF       000F 01
    PDEPEND1       000C 02
    PDEPEND2       000C 01
    PDEPHAS2       0011 40
    PDEPHELD       000C 08
    PDEPPA         001C
    PDEPRMD        000C 10
    PDEPRTY        000C 20
    PDEPURGE       000D 01
    PDESADDR       0014
    PDESAVST       001A
    PDESBKRQ       000E 0E
    PDESBOUT       000E 0D
    PDESCMTD       000E 0C
    PDESDEFR       000E 07
    PDESDEFS       000E 08
    PDESEND        000C 40
    PDESEVRD       000C 03
    PDESIZE        001C 00000004
    PDESNCIP       0010 01
    PDESNCPT       000F 04
    PDESNTPR       0010 02
    PDESPREP       000E 09
    PDESRSET       000E 01
    PDESSRCM       000E 0A
    PDESTATE       000E
    PDESTBKR       0010 20
    PDESTCFM       000E 05
    PDESTCON       000E 02
    PDESTRCV       000E 04
    PDESTSND       000E 03
    PDESTSVR       000E 06
    PDESURCM       000E 0B
    PDESUSPC       0011 10
    PDESVSIP       001B 08
    PDETGCCT       0004
    PDETGLKA       0008
    PDETGOK        000F 08
    PDETGPID       0002
    PDEVALID       000C 80
    PDEZERO        000C 00

This information is based on z/VM 7.2.0 Last updated on 24 Jun 2020 at 09:29:33 EDT.
Copyright IBM Corporation, 1990, 2020