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

#### PTHBK

Prolog

Control Block Contents
PTHBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### PTHBK Prolog

     NAME       : HCPPTHBK
     DESCRIPTION: ISFC Path description block
     COPYRIGHT -
                  THIS MODULE IS "RESTRICTED MATERIALS OF IBM"
                  5654-030 (C) COPYRIGHT IBM CORP. - 1991, 1995
                  LICENSED MATERIALS - PROPERTY OF IBM
                  SEE COPYRIGHT INSTRUCTIONS, G120-2083
     DSECT      : PTHBK
     FUNCTION   : Maintain information about an ISFC path
                  from a remote system.
     LOCATED BY : HCPBTBPA  anchor for PTHBKS located by path ID
                  HCPBTBSA  anchor for PTHBKS located by session ID
                  TRGBK points to PTHBK.
     CREATED BY : HCPBUVAP  whenever called to create a path.
     DELETED BY : HCPBUVRP  whenever a path is complete and released.
     SERIALIZED : The ISFC global lock (HCPBDSGL).

#### PTHBK Control Block Content

#### PTHBK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      PTHBK          ISFC Path description block
         PTHBK management.
    0000    0 Signed       4 PTHLSESS       LOCAL SESSION ID
    0004    4 Signed       4 PTHRSESS       REMOTE SESSION ID
    0008    8 Signed       2 PTHMSGIS       LAST MESSAGE ID SENT
    000A   10 Signed       2 PTHMSGIR       LAST MESSAGE ID RECEIVED
    000C   12 Signed       4 PTHMSGQ        QUEUE OF INCOMPLETE MESSAGES
                                            RECVD
    0010   16 Signed       4 PTHBYTES       NUMBER OF BYTES SENT
    0014   20 Signed       4 PTHBYTER       NUMBER OF BYTES RECEIVED
    0018   24 Signed       4 PTHPIPFR       PIP DATA MDEBK FOR CONNECT
    001C   28 Character    4 PTHMAIL        MAILBOX NAME
    0020   32 Signed       4 PTHTRGQ        QUEUE OF WORK WAITING AT TARGET
    0024   36 Signed       4 PTHTRGTL       TARGET QUEUE TAIL POINTER
    0028   40 Signed       2 *              RESERVED
    002A   42 Bitstring    1 PTHFLAGS       FLAGS
              1... ....      PTHACCST       X'80' ACCOUNTING STARTED FOR PATH
              ...1 ....      PTHPACRQ       X'10' REQUESTED PACING RESPONSE
              .... 1...      PTHCOMP        X'08' SESSION IS COMPLETE
              .... .1..      PTHBIGS        X'04' Big send in progress, queue
              .... ..1.      PTHBUSY        X'02' PATH IS BUSY
              .... ...1      PTHPACAN       X'01' OWE A PACING ANSWER ON THIS
                                            PATH
    002B   43 Bitstring    1 PTHFLAG2       FLAGS
              1... ....      PTHOCLOS       X'80' We sent close to source
                                            (passthru) or partner
                                            (non-passthru)
              .1.. ....      PTHICLOS       X'40' We received close from
                                            source (passthru) or partner
                                            (non-passthru)
              ..1. ....      PTHMCLOS       X'20' Mailbox is done with PTHBK
              ...1 ....      PTHLCLOS       X'10' Line driver sent close to
                                            source (passthru) or partner
                                            (non-passthru)
              .... 1...      PTHOCLOT       X'08' We sent close to target
                                            (passthru only)
              .... .1..      PTHICLOT       X'04' We received close from
                                            target (passthru only)
              .... ..1.      PTHMCLOT       X'02' For completeness only (see
                                            above)
              .... ...1      PTHLCLOT       X'01' Line driver sent close to
                                            target (passthru only)
    002C   44 Signed       4 PTHMBAD        DISPLACEMENT TO MAILBOX
                                            INFORMATION
    0030   48 Signed       2 PTHPNDSN       COUNT OF OUTSTANDING SENDS
    0032   50 Bitstring    1 PTHFLAG3       USED FOR MBEFLAG
              1... ....      PTHACCT        X'80' CUT ACCOUTING RECORDS
    0033   51 Bitstring    1 PTHPFLAG       Flags for passthru session
              1... ....      PTHPASS        X'80' Indicates a passthru conv
              .1.. ....      PTHTARG        X'40' From target side of session
                                            (can only be set if PTHPASS set)
              .... ...1      PTHGOING       X'01' ISFC Close started
         The following are the APPC and IUCV extensions.
    0034   52 Signed       2 PTHLPATH       LOCAL PATHID
    0036   54 Bitstring    1 PTHFLGAP       APPC FLAG BYTE
              1... ....      PTHPURGE       X'80' PURGE THINGS ON THIS PATH
              .1.. ....      PTHSEVER       X'40' PATH WAS SEVERED
              ..1. ....      PTHGONE        X'20' PTHBK NOT IN ISFC PATH
                                            TABLE NOTES : PTHSEVER and
                                            PTHGONE are also set in HCPAAT on
                                            a delayed connect and turned off
                                            when the connect completes.
              ...1 ....      PTHGATWY       X'10' GATEWAY IS IN PTHTPN
              .... 1...      PTHPRIV        X'08' USERID IS IN PTHTPN
              .... .1..      PTHVALID       X'04' PATH IS A VALID IUCV PATH
              .... ..1.      PTHSVFCI       X'02' FCI received on a SEVER
              .... ...1      PTHCSTRP       X'01' CS data length stripped
    0037   55 Bitstring    1 PTHSTATE       PATH CURRENT STATE
              00000001       PTHRESET       X'01' PATH IS IN RESET STATE
              00000002       PTHCONN        X'02' PATH IS IN CONNECT STATE
              00000003       PTHSEND        X'03' PATH IS IN SEND STATE
              00000004       PTHRECV        X'04' PATH IS IN RECEIVE STATE
              00000005       PTHCONF        X'05' PATH IS IN CONFIRM STATE
              00000006       PTHSEVST       X'06' PATH IS IN SEVER STATE
    0038   56 Signed       4 PTHPEND        POINTER TO PENDING FRAME
    003C   60 Signed       4 *              RESERVED
    0040   64 Bitstring    8 PTHSRCQ        QUEUE OF WORK AT THE SOURCE
    0048   72 Signed       4 PTHNODAD       ADDRESS OF NODBK
    004C   76 Signed       4 PTHRCVCT       Count of received 4K frames
    0050   80 Signed       4 PTHSNTCT       COUNT OF FRAMES SINCE LAST PACE
    0054   84 Signed       4 PTHPACCT       RESERVED
    0058   88 Character    8 PTHAUSER       ACCESS USERID
    0060   96 Character    8 PTHTPN         TPN OR GATEWAY NAME
    0068  104 Character    8 PTHFMHTP       TPN given in FMH5
    0070  112 Dbl-Word     8 *              Reserved space
    0078  120 Address      4 PTHENTSN       Address of the send routine
    007C  124 Signed       4 * (3)          Reserved
    0088  136 Signed       2 PTHCMHLN       CM header length
    008A  138 Signed       2 PTHMHLEN       Mailbox header length
    008C  140 Signed       4 * (3)          Reserved
              00000013       PTHSIZE        (*-PTHBK+7)/8 Size of PTHBK in
                                            doublewords
    0050   80 Signed       4 PTHNODEP       Target NODBK for passthru
    0054   84 Signed       4 PTHPSESS       Source session for passthru
         The following fields are defined for IUCV needs. These overlay the
         APPC/VM specific fields in the PTHBK.
    0058   88 Character    8 PTHUSER        IUCV userid for path
    0060   96 Character    8 PTHTRGU        Target userid
    0068  104 Signed       4 PTHRPLY        IUCV Reply pending queue
    006C  108 Signed       4 PTHRPLYT       IUCV Reply queue tail
    0070  112 Dbl-Word     8 *              Reserved space
         The following fields are defined for CP application mailbox needs.
         These overlay some of the APPC/VM specific fields in the PTHBK.
    0036   54 Bitstring    1 PTHFLGCP       Flag
              ..1. ....      PTHGONNE       X'20' Inbound CLOSE received and
                                            TRGBK for path removed from CP
                                            application TRGBK chain.
    0058   88 Character    8 PTHAPPLS       Source CP application
    0060   96 Character    8 PTHAPPLT       Target CP application
    0068  104 Character    8 PTHNODET       Target node
    0070  112 Signed       4 PTHACTBK       Addr of application's ACTBK
    0074  116 Signed       4 PTHTRGBK       Path's TRGBK address
         The following are the flags defined in PTHFLAGS.
         The following are the flags defined in PTHFLAG2.
         Notes : On a passthru conversation, the PTH*CLOS bits repre- sent
         closes sent to/from the source and the PTH*CLOT bits represent closes
         sent to/from the target. Also note that the PTHMCLO* bits are
         automatically set on a passthru conversation, since the data is never
         presen- ted to the mailbox(es) on the intermediate node(s) of a
         passthru conversation.
         On a normal (non-passthru) conversation, the PTH*CLOT bits are not
         necessary. They are immediately set. A conversation is non-passthru on
         the nodes where the source and target reside (whether there are zero or
         more nodes in between). The PTH*CLOS bits represent closes sent to/from
         the 'partner' (could be the source, target, or an intermediate node).
         Note that PTHMCLOT does not supply any significant information about
         the target. It is always set. We keep it defined for completeness and
         to make it easier to determine when we have received all closes
         (PTHFLAG2 = X'FF') so we can release the PTHBK.
         The following are the flags defined in PTHFLAG3.
         The following are the flags defined in PTHPFLAG.
         The following are the flags defined in PTHFLGAP.
         The following are the flags defined in PTHFLGCP.
         The following are the flags defined in PTHSTATE. NOTES : These values
         correspond to the values defined for IPSTATE IN IPARML.

#### PTHBK Storage Layout

    *** PTHBK - ISFC Path description block
    *
    *     +---------------------------+---------------------------+
    *   0 |         PTHLSESS          |         PTHRSESS          |
    *     +-------------+-------------+---------------------------+
    *   8 |  PTHMSGIS   |  PTHMSGIR   |         PTHMSGQ           |
    *     +-------------+-------------+---------------------------+
    *  10 |         PTHBYTES          |         PTHBYTER          |
    *     +---------------------------+---------------------------+
    *  18 |         PTHPIPFR          |         PTHMAIL           |
    *     +---------------------------+---------------------------+
    *  20 |         PTHTRGQ           |         PTHTRGTL          |
    *     +-------------+------+------+---------------------------+
    *  28 |/////////////|:FLAGS|:FLAG2|         PTHMBAD           |
    *     +-------------+------+------+-------------+------+------+
    *  30 |  PTHPNDSN   |:FLAG3|:PFLAG|  PTHLPATH   |:FLGAP|:STATE|
    *     +-------------+------+------+-------------+------+------+
    *  38 |         PTHPEND           |///////////////////////////|
    *     +---------------------------+---------------------------+
    *  40 |                       PTHSRCQ                         |
    *     +---------------------------+---------------------------+
    *  48 |         PTHNODAD          |         PTHRCVCT          |
    *     +---------------------------+---------------------------+
    *  50 |         PTHSNTCT          |         PTHPACCT          |
    *     +---------------------------+---------------------------+
    *  58 |                       PTHAUSER                        |
    *     +-------------------------------------------------------+
    *  60 |                        PTHTPN                         |
    *     +-------------------------------------------------------+
    *  68 |                       PTHFMHTP                        |
    *     +-------------------------------------------------------+
    *  70 |///////////////////////////////////////////////////////|
    *     +---------------------------+---------------------------+
    *  78 |         PTHENTSN          |///////////////////////////|
    *     +---------------------------+///////////////////////////|
    *     |///////////////////////////////////////////////////////|
    *     +-------------+-------------+---------------------------+
    *  88 |  PTHCMHLN   |  PTHMHLEN   |///////////////////////////|
    *     +-------------+-------------+///////////////////////////|
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *  98
    *
    *** PTHBK - ISFC Path description block

    *** Overlay for PTHSNTCT in PTHBK
    *
    *     +---------------------------+---------------------------+
    *  50 |         PTHNODEP          |         PTHPSESS          |
    *     +---------------------------+---------------------------+
    *  58
    *
    *** Overlay for PTHSNTCT in PTHBK

    *** Overlay for PTHAUSER in PTHBK
    *
    *     +-------------------------------------------------------+
    *  58 |                       PTHUSER                         |
    *     +-------------------------------------------------------+
    *  60 |                       PTHTRGU                         |
    *     +---------------------------+---------------------------+
    *  68 |         PTHRPLY           |         PTHRPLYT          |
    *     +---------------------------+---------------------------+
    *  70 |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *  78
    *
    *** Overlay for PTHAUSER in PTHBK

    *** Overlay for PTHFLGAP in PTHBK
    *
    *                                               +------+
    *  30 ...                                    36 |:FLGCP| 37
    *                                               +------+
    *
    *** Overlay for PTHFLGAP in PTHBK

    *** Overlay for PTHAUSER in PTHBK
    *
    *     +-------------------------------------------------------+
    *  58 |                       PTHAPPLS                        |
    *     +-------------------------------------------------------+
    *  60 |                       PTHAPPLT                        |
    *     +-------------------------------------------------------+
    *  68 |                       PTHNODET                        |
    *     +---------------------------+---------------------------+
    *  70 |         PTHACTBK          |         PTHTRGBK          |
    *     +---------------------------+---------------------------+
    *  78
    *
    *** Overlay for PTHAUSER in PTHBK

#### PTHBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    PTHACCST       002A 80
    PTHACCT        0032 80
    PTHACTBK       0070
    PTHAPPLS       0058
    PTHAPPLT       0060
    PTHAUSER       0058
    PTHBIGS        002A 04
    PTHBUSY        002A 02
    PTHBYTER       0014
    PTHBYTES       0010
    PTHCMHLN       0088
    PTHCOMP        002A 08
    PTHCONF        0037 00000005
    PTHCONN        0037 00000002
    PTHCSTRP       0036 01
    PTHENTSN       0078
    PTHFLAGS       002A
    PTHFLAG2       002B
    PTHFLAG3       0032
    PTHFLGAP       0036
    PTHFLGCP       0036
    PTHFMHTP       0068
    PTHGATWY       0036 10
    PTHGOING       0033 01
    PTHGONE        0036 20
    PTHGONNE       0036 20
    PTHICLOS       002B 40
    PTHICLOT       002B 04
    PTHLCLOS       002B 10
    PTHLCLOT       002B 01
    PTHLPATH       0034
    PTHLSESS       0000
    PTHMAIL        001C
    PTHMBAD        002C
    PTHMCLOS       002B 20
    PTHMCLOT       002B 02
    PTHMHLEN       008A
    PTHMSGIR       000A
    PTHMSGIS       0008
    PTHMSGQ        000C
    PTHNODAD       0048
    PTHNODEP       0050
    PTHNODET       0068
    PTHOCLOS       002B 80
    PTHOCLOT       002B 08
    PTHPACAN       002A 01
    PTHPACCT       0054
    PTHPACRQ       002A 10
    PTHPASS        0033 80
    PTHPEND        0038
    PTHPFLAG       0033
    PTHPIPFR       0018
    PTHPNDSN       0030
    PTHPRIV        0036 08
    PTHPSESS       0054
    PTHPURGE       0036 80
    PTHRCVCT       004C
    PTHRECV        0037 00000004
    PTHRESET       0037 00000001
    PTHRPLY        0068
    PTHRPLYT       006C
    PTHRSESS       0004
    PTHSEND        0037 00000003
    PTHSEVER       0036 40
    PTHSEVST       0037 00000006
    PTHSIZE        008C 00000013
    PTHSNTCT       0050
    PTHSRCQ        0040
    PTHSTATE       0037
    PTHSVFCI       0036 02
    PTHTARG        0033 40
    PTHTPN         0060
    PTHTRGBK       0074
    PTHTRGQ        0020
    PTHTRGTL       0024
    PTHTRGU        0060
    PTHUSER        0058
    PTHVALID       0036 04

This information is based on z/VM V4R3.0. Last updated on 1 May 2002 at 09:48:57 EDT.
Copyright IBM Corporation, 1990, 2002