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

SHPBK

Prolog  

Control Block Contents  
   SHPBK DSECT

Storage Layout  

Cross Reference (Contains links to field and bit definitions)  


SHPBK Prolog

Name       :  SHPBK
DSECT      :  SHPBK
Description:  Map/Generate CSE Sys Definition Table

 

SHPBK Control Block Content


SHPBK DSECT

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      SHPBK          Map/Generate CSE Sys Definition Table
0000    0 Character    8 SHPSYSNM       Logical system name
0008    8 Character    8 SHPCVM         CSE Communication VM name
0010   16 Character    8 SHPALIAS       System name alias
0018   24 Signed       4 SHPNQ1         Number of entries in Q1
001C   28 Signed       4 SHPNQ2         Number of entries in Q2
0020   32 Signed       4 SHPNQ1T        Number of times Q1 serviced
0024   36 Signed       4 SHPNQ2T        Number of times Q2 serviced
0028   40 Address      4 SHPQ1          Q1 chain
002C   44 Address      4 SHPQ2          Q2 chain
0030   48 Address      4 SHPADT1        Address of Q1 timer element
0034   52 Address      2 SHPLN          Table length in bytes
0036   54 Signed       2 SHPQ1DEL       Number of seconds to wait in Q1
0038   56 Bitstring    1 SHPTYPE        S*1 System type (Main or Shared)
          1... ....      SHPTYPEM       X'80' SHPTYPEM Main system
          .1.. ....      SHPTYPES       X'40' SHPTYPES Associated system
0039   57 Bitstring    1 SHPSTAT        S*2 System status field
          1... ....      SHPMSG         X'80' SHPMSG Msg 972W was already
                                        sent
          .1.. ....      SHPSYNTK       X'40' SHPSYNTK Synchronization
                                        task running
          ...1 ....      SHPLKDR        X'10' SHPLKDR CVM has lost
                                        communication with System-B
          .... 1...      Q1TIMPOP       X'08' Q1TIMPOP Q1 is not being
                                        serviced
          .... .1..      SHPSYNCR       X'04' SHPSYNCR Request
                                        synchronization
          .... ..1.      SHPINIT        X'02' SHPINIT CVM was initialized
                                        at least once
          .... ...1      SHPCVMA        X'01' SHPCVMA The CVM is active
                                        In an SSI environment CP is the
                                        CVM so it is always active, thus
                                        in the main SHPBK this bit is
                                        always set. In an associated
                                        SHPBK this bit is set if we have
                                        a socket open with that member.
003A   58 Bitstring    1 SHPFLG1        S*3 First flag field
          .1.. ....      SHPDBACT       X'40' SHPDBACT Deferred buffer
                                        task is active
          ..1. ....      SHPWKQ2        X'20' SHPWKQ2 Processing Q2
          ...1 ....      SHPTRFIN       X'10' SHPTRFIN Incoming traffic
                                        received
          .... 1...      SHPTIMDA       X'08' SHPTIMDA Disable timer pops
          .... .1..      SHPPOSTR       X'04' SHPPOSTR Post the CVM for
                                        this system
          .... ..1.      SHPQ1TST       X'02' SHPQ1TST Q1 timer is set
          .... ...1      SHPPOST        X'01' SHPPOST The CVM has been
                                        posted (CSE) Transport thread
                                        running (SSI)
003B   59 Bitstring    1 SHPINDEX       S*4 System Index in bit map form
003C   60 Signed       1 SHPLNSNM       S*5 Length of system name
003D   61 Signed       1 SHPLNUNM       S*6 Length of the CVM name
003E   62 Signed       1 SHPLNANM       S*7 Length of system name alias
003F   63 Signed       1 SHPBNDX        S*8 System Index in binary
0040   64 Bitstring    1 SHPISFRI       S*9 CSE level code, if known
                                        defined for the other. In an SSI
                                        environment SHPISFRI is intended
                                        to be a counter not a bitmap and
                                        it should be tested with CLI not
                                        TM.
          .... ....      SHPISFR0       X'00' SHPISFR0 CSE Release not
                                        known
          .... ...1      SHPISFR1       X'01' SHPISFR1 CSE level 1
          .... ..1.      SHPISFR2       X'02' SHPISFR2 CSE level 2
          .... ..11      SHPISFR3       X'03' SHPISFR3 CSE level 3
          .... .111      SHPISFR4       X'07' SHPISFR4 CSE level 4
          .... ...1      SHPSSIR1       X'01' SHPSSIR1 SSI level 1 Notes
                                        : SHPISFRI is combined with
                                        SHPSSTAT (below) so the
0041   65 Bitstring    1 SHPSSTAT       S*10 Spool sharing status byte
                                        defined for the other.
          1... ....      SHPNSHRS       X'80' SHPNSHRS Cross system
                                        spooling with this system was
                                        disabled by SYSGEN.
          .1.. ....      SHPNSHRQ       X'40' SHPNSHRQ Cross system
                                        spooling with this system was
                                        disabled by QITEM.
          ..1. ....      SHPTROFF       X'20' SHPTROFF Stop CSE tracing.
          ...1 ....      SHPTRFRZ       X'10' SHPTRFRZ CSE tracing freeze
                                        bit. Stop tracing if we are going
                                        to sync. Notes : SHPSSTAT is
                                        combined with SHPISFRI (above) so
                                        the
0042   66 Bitstring    1 SHPGSDLK       S*11 CSE command lock used by XCC
0043   67 Bitstring    1 SHPHPOOL       RDR *SPL system index
0044   68 Address      4 *              Reserved for IBM use
0048   72 Address      4 SHPDBANC       Anchor of deferred buffer chain
004C   76 Address      4 SHPDBLAS       Pointer to last deferred buffer
0050   80 Signed       4 SHPUSRS        Count of logged on users
0054   84 Signed       4 SHPDIALD       Count of dialed users
0058   88 Signed       4 SHPLUCNT       Count of SNA users
005C   92 Signed       4 SHPSOCK        Socket identifier In the main
                                        system's SHPBK this socket handle
                                        is used for USRBK broadcasts. In
                                        an associate system's SHPBK this
                                        socket handle is used for CSE
                                        QITEMs.
0060   96 Dbl-Word     8 SHPRETRY (0)   ** START of RETRY USRBK Fields **
                                        SHPRETRY updated with compare and
                                        swap double rather than via a
                                        lock
0060   96 Dbl-Word     8 SHPLCSYS (0)   for LoCal SYStem:
0060   96 Bitstring    4 SHPJFAL        Join FAiLed mask of systems
0064  100 Bitstring    4 SHPJSUC        Join SUCcess mask of systems
0060   96 Dbl-Word     8 SHPRMSYS (0)   for ReMote SYStems:
0060   96 Address      4 SHPLPTR        List PoinTeR to retry userids
0064  100 Bitstring    1 SHPRBY1        Retry BYte 1:
          1... ....      SHPRS          X'80' SHPRS Retry Scheduled DS X
                                        Reserved for IBM use
0066  102 Signed       2 SHPLCNT        List CouNTer of users to retry
                                        **** END of RETRY USRBK Fields
0068  104 Address      4 *              Reserved for IBM use
006C  108 Address      4 *              Reserved for IBM use
0070  112 Dbl-Word     8 SHPLOCK (6)    Used by spin lock logic Unless
                                        otherwise noted: Fields above
                                        this line are protected by the
                                        spin lock Fields below this line
                                        are protected by the defer lock
                                        If both are required the defer
                                        lock must be obtained first
00A0  160 Dbl-Word     8 SHPDLOCK (3)   Used by defer lock logic
00B8  184 Address      4 SHPRPG         A(RPAGES DSECT)
00BC  188 Address      4 SHPCPEX        Sync CPEBK to stack, plus the
                                        SYNC1/2/3 byte. This byte must be
                                        cleared before the contents of
                                        SHPCPEX can be used to address
                                        the CPEBK. SHPCPEX updated with
                                        compare and swap rather than via
                                        a lock
00C0  192 Address      8 *              Reserved for IBM use
00C8  200 Address      4 *              Reserved for IBM use
00CC  204 Address      4 *              Reserved for IBM use
00D0  208 Dbl-Word     8 SHPEND (0)
          000000D0       SHPSZ          (*-SHPSYSNM)
          0000001A       SHPSZD         (*-SHPSYSNM)/8 Size in d-words

 

SHPBK Storage Layout

          
*** SHPBK - Control Block in SHPBK
*
*     +-------------------------------------------------------+
*   0 |                       SHPSYSNM                        |
*     +-------------------------------------------------------+
*   8 |                        SHPCVM                         |
*     +-------------------------------------------------------+
*  10 |                       SHPALIAS                        |
*     +---------------------------+---------------------------+
*  18 |          SHPNQ1           |          SHPNQ2           |
*     +---------------------------+---------------------------+
*  20 |         SHPNQ1T           |         SHPNQ2T           |
*     +---------------------------+---------------------------+
*  28 |          SHPQ1            |          SHPQ2            |
*     +---------------------------+-------------+-------------+
*  30 |         SHPADT1           |   SHPLN     |  SHPQ1DEL   |
*     +------+------+------+------+------+------+------+------+
*  38 |:TYPE |:STAT |:FLG1 |:INDEX|:LNSNM|:LNUNM|:LNANM|:BNDX |
*     +------+------+------+------+------+------+------+------+
*  40 |:ISFRI|:SSTAT|:GSDLK|:HPOOL|///////////////////////////|
*     +------+------+------+------+---------------------------+
*  48 |         SHPDBANC          |         SHPDBLAS          |
*     +---------------------------+---------------------------+
*  50 |         SHPUSRS           |         SHPDIALD          |
*     +---------------------------+---------------------------+
*  58 |         SHPLUCNT          |         SHPSOCK           |
*     +---------------------------+---------------------------+
*  60 |         SHPJFAL           |         SHPJSUC           |
*     +---------------------------+---------------------------+
*  68
*
*** SHPBK - Control Block in SHPBK
          
*** Overlay for SHPRETRY in SHPBK
*
*     +---------------------------+------+------+-------------+
*  60 |         SHPLPTR           |:RBY1 |//////|  SHPLCNT    |
*     +---------------------------+------+------+-------------+
*  68 |///////////////////////////|///////////////////////////|
*     +---------------------------+---------------------------+
*  70 |                                                       |
*     =                       SHPLOCK                         =
*     |                                                       |
*     +-------------------------------------------------------+
*  A0 |                                                       |
*     =                       SHPDLOCK                        =
*     |                                                       |
*     +---------------------------+---------------------------+
*  B8 |          SHPRPG           |         SHPCPEX           |
*     +---------------------------+---------------------------+
*  C0 |///////////////////////////////////////////////////////|
*     +---------------------------+---------------------------+
*  C8 |///////////////////////////|///////////////////////////|
*     +---------------------------+---------------------------+
*
*** Overlay for SHPRETRY in SHPBK

 

SHPBK Cross Reference

Symbol         Dspl Value
-------------- ---- -----
Q1TIMPOP       0039 08
SHPADT1        0030
SHPALIAS       0010
SHPBNDX        003F
SHPCPEX        00BC
SHPCVM         0008
SHPCVMA        0039 01
SHPDBACT       003A 40
SHPDBANC       0048
SHPDBLAS       004C
SHPDIALD       0054
SHPDLOCK       00A0
SHPEND         00D0
SHPFLG1        003A
SHPGSDLK       0042
SHPHPOOL       0043
SHPINDEX       003B
SHPINIT        0039 02
SHPISFRI       0040
SHPISFR0       0040 00
SHPISFR1       0040 01
SHPISFR2       0040 02
SHPISFR3       0040 03
SHPISFR4       0040 07
SHPJFAL        0060
SHPJSUC        0064
SHPLCNT        0066
SHPLCSYS       0060
SHPLKDR        0039 10
SHPLN          0034
SHPLNANM       003E
SHPLNSNM       003C
SHPLNUNM       003D
SHPLOCK        0070
SHPLPTR        0060
SHPLUCNT       0058
SHPMSG         0039 80
SHPNQ1         0018
SHPNQ1T        0020
SHPNQ2         001C
SHPNQ2T        0024
SHPNSHRQ       0041 40
SHPNSHRS       0041 80
SHPPOST        003A 01
SHPPOSTR       003A 04
SHPQ1          0028
SHPQ1DEL       0036
SHPQ1TST       003A 02
SHPQ2          002C
SHPRBY1        0064
SHPRETRY       0060
SHPRMSYS       0060
SHPRPG         00B8
SHPRS          0064 80
SHPSOCK        005C
SHPSSIR1       0040 01
SHPSSTAT       0041
SHPSTAT        0039
SHPSYNCR       0039 04
SHPSYNTK       0039 40
SHPSYSNM       0000
SHPSZ          00D0 000000D0
SHPSZD         00D0 0000001A
SHPTIMDA       003A 08
SHPTRFIN       003A 10
SHPTRFRZ       0041 10
SHPTROFF       0041 20
SHPTYPE        0038
SHPTYPEM       0038 80
SHPTYPES       0038 40
SHPUSRS        0050
SHPWKQ2        003A 20

This information is based on z/VM V6R2.0. Last updated on 21 Nov 2011 at 11:20:50 EDT.
Copyright IBM Corporation, 1990, 2011