NAME       : LGRRTVBK
 DESCRIPTION: Relocation mapping for HCPRTVBK
 DSECT      : $RTVBK
 FUNCTION   : LGRRTVBK describes those fields of the RTVBK 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 HCPRTVBK 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.

 $RTVBK DSECT
Top of page

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      $RTVBK         Relocation mapping for HCPRTVBK
          00000001       $RTV_VER       1 Mapping version number
0000    0 Signed       2 $RTV_HDRL      Header length (in bytes)
0002    2 Signed       2 $RTV_BITL      Length of mapped bits (in bytes)
0004    4 Signed       4 *              Reserved for future use
          00000008       $RTV_HDLN      *-$RTVBK Length of header (bytes)
      Bit map: Contains the RTVBK flags that are subject to
               relocation. These bits are defined sequentially,
               regardless of how they are defined in HCPRTVBK.
               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 $RTV_BITS (0)  Bit map area
          00000000       $RTV_BLEN      *-$RTV_BITS Length of bit map
                                        area
      Data:    Contains all HCPRTVBK 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.
0008    8 Bitstring    1 $RTV_DATA (0)  Start of data map
0008    8 Bitstring    2 $RTVALLOC      Number of RETRIEVE buffers
                                        alloc'd
000A   10 Bitstring    2 $RTVBFREQ      Number of RETRIEVE buffers
                                        requested
000C   12 Bitstring    2 $RTVDFCNT      Number of RETRIEVE PF keys
                                        defined
000E   14 Bitstring    2 $RTVBFCNT      Number of RETRIEVE buffers so far
0010   16 Bitstring    2 $RTVLSRTV      Last retrieved entry
          00000012       $RTV_LEN       *-$RTVBK Total fixed length, in
                                        bytes
          00000003       $RTV_SZ        ($RTV_LEN+7)/8 Size in
                                        doublewords
      The $RTVGSDBK field is repeated (RTVBFCNT) times
0012   18 Bitstring    4 $RTVGSDBK (0)  -> RDO offsets to GSDBKs

          
*** $RTVBK - Relocation mapping for HCPRTVBK
*
*     +-------------+-------------+---------------------------+
*   0 | $RTV_HDRL   | $RTV_BITL   |///////////////////////////|
*     +-------------+-------------+-------------+-------------+
*   8 | $RTVALLOC   | $RTVBFREQ   | $RTVDFCNT   | $RTVBFCNT   |
*     +-------------+-------------+-------------+-------------+
*  10 | $RTVLSRTV   |
*     +-------------+
*
*** $RTVBK - Relocation mapping for HCPRTVBK

 
Symbol         Dspl Value
-------------- ---- -----
$RTV_BITL      0002
$RTV_BITS      0008
$RTV_BLEN      0008 00000000
$RTV_DATA      0008
$RTV_HDLN      0004 00000008
$RTV_HDRL      0000
$RTV_LEN       0010 00000012
$RTV_SZ        0010 00000003
$RTV_VER       0000 00000001
$RTVALLOC      0008
$RTVBFCNT      000E
$RTVBFREQ      000A
$RTVDFCNT      000C
$RTVGSDBK      0012
$RTVLSRTV      0010