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

$BITMP

Prolog  

Control Block Contents  
   $BITMP DSECT

Storage Layout  

Cross Reference (Contains links to field and bit definitions)  


$BITMP Prolog

 NAME       : LGRBITMP
 DESCRIPTION: Relocation mapping for HCPBITMP
 DSECT      : $BITMP
 FUNCTION   : LGRBITMP describes those fields of the BITMP 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.
 CREATED BY : HCPRLFLF - BITMP Formatter for LGR
 DELETED BY : HCPRLDRL - Release storage associated with an RDP
 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 HCPBITMP 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.

 

$BITMP Control Block Content


$BITMP DSECT

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      $BITMP         Relocation mapping for HCPBITMP
          00000001       $BIT_VER       1 Mapping version number for this
                                        DSECT. Version is independent of
                                        the CP level and need only be
                                        changed when this DSECT is
                                        changed. The convention is to
                                        increment by 1.
0000    0 Signed       2 $BIT_HDRL      Header length (in bytes)
0002    2 Signed       2 $BIT_BITL      Length of mapped bits (in bytes)
0004    4 Signed       4 *              Reserved for future use
          00000008       $BIT_HDLN      *-$BITMP Length of header (bytes)
      Bit map: Contains the BITMP flags that are subject to
               relocation. These bits are defined sequentially,
               regardless of how they are defined in HCPBITMP.
               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 $BIT_BITS (0)  Bit map area
0008    8 Bitstring    1 $BIT0
          1... ....      $BITHDR        X'80' $BITHDR 1=This is a BIT
                                        Header record 0=This is a BIT
                                        Range record space 1
          00000001       $BIT_BLEN      *-$BIT_BITS Length of bit map
                                        area
      Data:    Contains all HCPBITMP 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 $BIT_DATA (0)  Start of data map
0009    9 Bitstring    4 $BITMPMAX      The max bit number allowed
000D   13 Bitstring    4 $BITMPPGS      How many pointers at BITMPPTR
0011   17 Bitstring    4 $BITMPP1L      Low half-page of bitmap frame
0015   21 Bitstring    4 $BITMPP1H      High half-page of bitmap frame
          00000019       $BITBYSZ       *-$BITMP Byte length of $BITMP
          00000004       $BITSIZE       ((*-$BITMP)+7)/8 DWord length of
                                        $BITMP

 

$BITMP Storage Layout

          
*** $BITMP - Relocation mapping for HCPBITMP
*
*     +-------------+-------------+---------------------------+
*   0 | $BIT_HDRL   | $BIT_BITL   |///////////////////////////|
*     +------+------+-------------+------+--------------------+
*   8 |$BIT0 |        $BITMPMAX          |    $BITMPPGS-      |
*     +------+---------------------------+--------------------+
*  10 |-(00D)|        $BITMPP1L          |    $BITMPP1H-      |
*     +------+---------------------------+--------------------+
*  18 |-(015)| 19
*     +------+
*
*** $BITMP - Relocation mapping for HCPBITMP

 

$BITMP Cross Reference

Symbol         Dspl Value
-------------- ---- -----
$BIT_BITL      0002
$BIT_BITS      0008
$BIT_BLEN      0008 00000001
$BIT_DATA      0009
$BIT_HDLN      0004 00000008
$BIT_HDRL      0000
$BIT_VER       0000 00000001
$BITBYSZ       0015 00000019
$BITHDR        0008 80
$BITMPMAX      0009
$BITMPPGS      000D
$BITMPP1H      0015
$BITMPP1L      0011
$BITSIZE       0015 00000004
$BIT0          0008

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