$HCIBK

Prolog  

Control Block Contents  
   $HCIBK DSECT

Storage Layout  

Cross Reference (Contains links to field and bit definitions)  

$HCIBK Prolog

 NAME       : LGRHCIBK
 DESCRIPTION: Relocation mapping for HCPHCIBK
 DSECT      : $HCIBK
 FUNCTION   : LGRHCIBK describes those fields of the HCIBK that
              will be migrated to the destination system during
              guest relocation.
 LOCATED BY : This is a mapping of the RDODATA area within the
              RDOBK during guest relocation.
 RELOCATION CONSIDERATIONS : This control block is used during live guest
              relocation.  It is used to relocate a control block
              defined in a corresponding HCP COPY file.  Any
              fields or bits defined in HCPHCIBK which are
              required on the destination system must be defined
              here, and code must be added to migrate the field
              or bit during a relocation.

$HCIBK Control Block Content

$HCIBK DSECT

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      $HCIBK         Relocation mapping for HCPHCIBK
          00000001       $HCI_VER       1 Mapping version number
0000    0 Signed       2 $HCI_HDRL      Header length (in bytes)
0002    2 Signed       2 $HCI_BITL      Length of mapped bits (in bytes)
0004    4 Signed       4 *              Reserved for future use
          00000008       $HCI_HDLN      *-$HCIBK Length of header (bytes)
      Bit map: Contains the HCIBK flags that are subject to
               relocation. These bits are defined sequentially,
               regardless of how they are defined in HCPHCIBK.
               This yields a consistent mapping that ensures
               compatibility when a guest is relocated between
               systems at differing service levels.
               Names in the comments column indicate the control
               block byte which contains the flag. This name is
               subject to change if the flag definition changes.
         ====> NEVER change bits which already exist here.
         ====> NEVER change the order of bits in this section.
         ====> ALWAYS add new bits at the end of this section,
               together with new flag bytes as required.
0008    8 Signed       2 $HCI_BITS (0)  Bit map area
0008    8 Bitstring    1 $HCI0
          1... ....      $HCISHOWN      X'80' $HCISHOWN HCIVFLAG
          00000001       $HCI_BLEN      *-$HCI_BITS Length of bit map
                                        area
      Data:    Contains all HCPHCIBK data that is subject to
               relocation, except for flag bits, which are
               handled separately.
               All fields are defined as XLnn to avoid alignment
               warnings and to pack the data efficiently.
         ====> NEVER change fields which already exist here.
         ====> NEVER change the order of fields in this section.
         ====> ALWAYS add new fields at the end of this section.
               together with new flag bytes as required.
0009    9 Bitstring    1 $HCI_DATA (0)  Start of data map
0009    9 Bitstring    4 $HCIFPNT       -> RDO offset to next $HCIBK
000D   13 Bitstring    2 $HCILEN        Total HCIBK message buffer length
000F   15 Bitstring    1 $HCIGFLG0      General object message flags
0010   16 Bitstring    1 $HCIGFLG1      Reserved for future IBM use
0011   17 Bitstring    2 $HCIMLFLG      Line type flags
0013   19 Bitstring    4 $HCIGFGPA      Foreground presentation
                                        attributes
0017   23 Bitstring    4 $HCIMFGPA      Presentation-attribute field
001B   27 Bitstring    4 $HCISEQ        General object sequence number
001F   31 Bitstring    2 $HCILINE       Binary line no. for Q VMSG/PVMSG
0021   33 Bitstring    4 $HCITEXT       -> RDO offset to message text
          00000025       $HCI_LEN       *-$HCIBK Total length, in bytes
          00000005       $HCI_SZ        ($HCI_LEN+7)/8 Size in
                                        doublewords

$HCIBK Storage Layout

          
*** $HCIBK - Relocation mapping for HCPHCIBK
*
*     +-------------+-------------+---------------------------+
*   0 | $HCI_HDRL   | $HCI_BITL   |///////////////////////////|
*     +------+------+-------------+------+-------------+------+
*   8 |$HCI0 |         $HCIFPNT          |  $HCILEN    |(00F) |
*     +------+-------------+-------------+-------------+------+
*  10 |(010) | $HCIMLFLG   |        $HCIGFGPA          |(017)-|
*     +------+-------------+---------------------------+------+
*  18 |    -$HCIMFGPA      |         $HCISEQ           |(01F)-|
*     +------+-------------+-------------+-------------+------+
*  20 |-(01F)|         $HCITEXT          | 25
*     +------+---------------------------+
*
*** $HCIBK - Relocation mapping for HCPHCIBK

$HCIBK Cross Reference

Symbol         Dspl Value
-------------- ---- -----
$HCI_BITL      0002
$HCI_BITS      0008
$HCI_BLEN      0008 00000001
$HCI_DATA      0009
$HCI_HDLN      0004 00000008
$HCI_HDRL      0000
$HCI_LEN       0021 00000025
$HCI_SZ        0021 00000005
$HCI_VER       0000 00000001
$HCIFPNT       0009
$HCIGFGPA      0013
$HCIGFLG0      000F
$HCIGFLG1      0010
$HCILEN        000D
$HCILINE       001F
$HCIMFGPA      0017
$HCIMLFLG      0011
$HCISEQ        001B
$HCISHOWN      0008 80
$HCITEXT       0021
$HCI0          0008