| 
Programming Interface Information:
 This information is NOT intended to be used as Programming Interfaces of z/VM.  | 
$APMBK
Control Block Contents  
   $APMBK DSECT
Cross Reference (Contains links to field and bit definitions)
$APMBK Prolog
 NAME       : LGRAPMBK
 DESCRIPTION: Relocation mapping for HCPAPMBK
 DSECT      : $APMBK
 FUNCTION   : LGRAPMBK describes those fields of the APMBK 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 HCPVMDBK 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.
$APMBK Control Block Content
$APMBK DSECT
Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      $APMBK         Relocation mapping for HCPAPMBK
          00000001       $APM_VER       1 Mapping version number
0000    0 Signed       2 $APM_HDRL      Header length (in bytes)
0002    2 Signed       2 $APM_BITL      Length of mapped bits (in bytes)
0004    4 Signed       4 *              Reserved for future use
          00000008       $APM_HDLN      *-$APMBK Length of header (bytes)
      Bit map: Contains the APMBK flags that are subject to
               relocation. These bits are defined sequentially,
               regardless of how they are defined in HCPAPMBK.
               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 $APM_BITS (0)  Bit map area
0008    8 Bitstring    1 $APM0
          1... ....      $APM0VNQS      X'80' $APM0VNQS APMFL0
          .1.. ....      $APM0VNQD      X'40' $APM0VNQD APMFL0
          ..1. ....      $APM0VDQS      X'20' $APM0VDQS APMFL0
          ...1 ....      $APM0VDQD      X'10' $APM0VDQD APMFL0
          .... 1...      $APM0RNQS      X'08' $APM0RNQS APMFL0
          .... .1..      $APM0RNQD      X'04' $APM0RNQD APMFL0
          .... ..1.      $APM0RDQS      X'02' $APM0RDQS APMFL0
          .... ...1      $APM0RDQD      X'01' $APM0RDQD APMFL0
0009    9 Bitstring    1 $APM1
          .... .1..      $APM1INDQ      X'04' $APM1INDQ APMFL1
          .... ..1.      $APM1INNQ      X'02' $APM1INNQ APMFL1
          .... ...1      $APM1TOSS      X'01' $APM1TOSS APMFL1
          00000002       $APM_BLEN      *-$APM_BITS Length of bit map
                                        area
      Data:    Contains all HCPAPMBK 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.
000A   10 Bitstring    1 $APM_DATA (0)  Start of data map
000A   10 Bitstring    4 $APM_ITEM      Slot number in APVARRAY
                                        (1-origin)
000E   14 Bitstring    4 $APM_NEXT      ->RDO offset to next $APMBK
     APMAPVBK - copy from VMDAPVBK on destination
0012   18 Bitstring    8 $APMPSMID      Guest PSMID
001A   26 Bitstring    8 $APMNVT        Host TOD of virtual NQAP
0022   34 Bitstring    8 $APMNRT        Host TOD of real NQAP
002A   42 Bitstring    4 $APMNQCRS      Relative message cursor
002E   46 Bitstring    4 $APMNQDL       Total data length of message
0032   50 Bitstring    4 $APMNADLN      ->RDO offset to first NQ
                                        APMADLN
0036   54 Bitstring    8 $APMDVT        Host TOD of virtual DQAP
003E   62 Bitstring    8 $APMDRT        Host TOD of real DQAP
0046   70 Bitstring    4 $APMDQCRS      Relative message cursor
004A   74 Bitstring    4 $APMDQRL       Residual length for DQAP
004E   78 Bitstring    4 $APMDQDL       Total data length of message
0052   82 Bitstring    4 $APMDADLN      ->RDO offset to first DQ
                                        APMADLN
          00000056       $APM_LEN       *-$APMBK Total length, in bytes
          0000000B       $APM_SZ        ($APM_LEN+7)/8 Size in
                                        doublewords
$APMBK Storage Layout
          
*** $APMBK - Relocation mapping for HCPAPMBK
*
*     +-------------+-------------+---------------------------+
*   0 | $APM_HDRL   | $APM_BITL   |///////////////////////////|
*     +------+------+-------------+-------------+-------------+
*   8 |$APM0 |$APM1 |        $APM_ITEM          | $APM_NEXT-  |
*     +------+------+---------------------------+-------------+
*  10 |   -(00E)    |               $APMPSMID-                |
*     +-------------+-----------------------------------------+
*  18 |   -(012)    |                $APMNVT-                 |
*     +-------------+-----------------------------------------+
*  20 |   -(01A)    |                $APMNRT-                 |
*     +-------------+---------------------------+-------------+
*  28 |   -(022)    |        $APMNQCRS          | $APMNQDL-   |
*     +-------------+---------------------------+-------------+
*  30 |   -(02E)    |        $APMNADLN          |   (036)-    |
*     +-------------+---------------------------+-------------+
*  38 |                -$APMDVT                 |   (03E)-    |
*     +-----------------------------------------+-------------+
*  40 |                -$APMDRT                 | $APMDQCRS-  |
*     +-------------+---------------------------+-------------+
*  48 |   -(046)    |         $APMDQRL          | $APMDQDL-   |
*     +-------------+---------------------------+-------------+
*  50 |   -(04E)    |        $APMDADLN          | 56
*     +-------------+---------------------------+
*
*** $APMBK - Relocation mapping for HCPAPMBK
$APMBK Cross Reference
Symbol Dspl Value -------------- ---- ----- $APM_BITL 0002 $APM_BITS 0008 $APM_BLEN 0009 00000002 $APM_DATA 000A $APM_HDLN 0004 00000008 $APM_HDRL 0000 $APM_ITEM 000A $APM_LEN 0052 00000056 $APM_NEXT 000E $APM_SZ 0052 0000000B $APM_VER 0000 00000001 $APMDADLN 0052 $APMDQCRS 0046 $APMDQDL 004E $APMDQRL 004A $APMDRT 003E $APMDVT 0036 $APMNADLN 0032 $APMNQCRS 002A $APMNQDL 002E $APMNRT 0022 $APMNVT 001A $APMPSMID 0012 $APM0 0008 $APM0RDQD 0008 01 $APM0RDQS 0008 02 $APM0RNQD 0008 04 $APM0RNQS 0008 08 $APM0VDQD 0008 10 $APM0VDQS 0008 20 $APM0VNQD 0008 40 $APM0VNQS 0008 80 $APM1 0009 $APM1INDQ 0009 04 $APM1INNQ 0009 02 $APM1TOSS 0009 01
Copyright IBM Corporation, 1990, 2011