$AMSG | Back to Index page

| Prolog Control Block Contents $AMSG DSECT Storage Layout Cross Reference (Contains links to field and bit definitions) |
Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM.

$AMSG Prolog | Top of page

     NAME       : LGRAMSG
     DESCRIPTION: Relocation mapping for HCPAMSG
     DSECT      : $AMSG
     FUNCTION   : LGRAMSG describes those fields of the AMSG block
                  that will be relocated 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 : HCPRLFAF - AMSG/IOCM 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 HCPAMSG 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.

$AMSG Control Block Content | Top of page

     $AMSG DSECT
    Top of page

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      $AMSG          Relocation mapping for HCPAMSG
              00000001       $AMSG_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 $AMSG_HDRL     Header length (in bytes)
    0002    2 Signed       2 $AMSG_BITL     Length of mapped bits (in bytes)
    0004    4 Signed       4 *              Reserved for future use
              00000008       $AMSG_HDLN     *-$AMSG Length of header (bytes)
          Bit map: Contains the AMSG flags that are subject to
                   relocation. These bits are defined sequentially,
                   regardless of how they are defined in HCPAMSG.
                   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 $AMSG_BITS (0) Bit map area
              00000000       $AMSG_BLEN     *-$AMSG_BITS Length of bit map
                                            area
          Data:    Contains all HCPAMSG 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 $AMSG_DATA (0) Start of data map
    0008    8 Bitstring    4 $AMSGNEXT      Pointer to next AMSG block
    000C   12 Bitstring    4 $AMSGBKID      IDs storage area as an AMSG block
    0010   16 Bitstring    4 $AMSGTLG       Length of entire message HDR+MSG
    0014   20 Bitstring    4 $AMSGMGID      Message ID
    0018   24 Bitstring    2 $AMSGLGH       Length of the message
    001A   26 Bitstring    1 $AMSGEVST      Asynchronous Event status
    001B   27 Bitstring    1 $AMSGSESS      Session ID
    001C   28 Bitstring    1 $AMSGBUF (0)   Message buffer contents
              0000001C       $AMSG_LEN      *-$AMSG Total length, in bytes
              00000004       $AMSG_SZ       ($AMSG_LEN+7)/8 Size in
                                            doublewords

$AMSG Storage Layout | Top of page

    *** $AMSG - Relocation mapping for HCPAMSG
    *
    *     +-------------+-------------+---------------------------+
    *   0 | $AMSG_HDRL  | $AMSG_BITL  |///////////////////////////|
    *     +-------------+-------------+---------------------------+
    *   8 |        $AMSGNEXT          |        $AMSGBKID          |
    *     +---------------------------+---------------------------+
    *  10 |         $AMSGTLG          |        $AMSGMGID          |
    *     +-------------+------+------+---------------------------+
    *  18 |  $AMSGLGH   |(01A) |(01B) |
    *     +-------------+------+------+
    *
    *** $AMSG - Relocation mapping for HCPAMSG

$AMSG Cross Reference | Top of page

    Symbol         Dspl Value
    -------------- ---- -----
    $AMSG_BITL     0002
    $AMSG_BITS     0008
    $AMSG_BLEN     0008 00000000
    $AMSG_DATA     0008
    $AMSG_HDLN     0004 00000008
    $AMSG_HDRL     0000
    $AMSG_LEN      001C 0000001C
    $AMSG_SZ       001C 00000004
    $AMSG_VER      0000 00000001
    $AMSGBKID      000C
    $AMSGBUF       001C
    $AMSGEVST      001A
    $AMSGLGH       0018
    $AMSGMGID      0014
    $AMSGNEXT      0008
    $AMSGSESS      001B
    $AMSGTLG       0010

This information is based on z/VM 7.2.0 Last updated on 24 Jun 2020 at 09:32:01 EDT.
Copyright IBM Corporation, 1990, 2020