Programming Interface Information: The Monitor Records are intended Programming Interfaces that allow the customer to write programs to obtain services of z/VM.

#### MRUSERLE

Prolog
Control Block Contents
Cross Reference

#### MRUSERLE Prolog

     DSECT NAME - USERLE
     FUNCTION - Map a Monitor record.
     LOCATED BY -
            Through the Monitor Control Area
     REFERENCED CONTROL BLOCKS -
            MRRECHDR    Monitor Record Header
     COMMENTS -
       If new fields are added to this record, it is possible that
       the relocation code that sends this data to the destination
       system may need to be updated.  This could be in either the
       HCPRLOSR/HCPRLORR and/or the HCPRLURS/HCPRLURD pairs of
       entry points.
     NAME - MRUSERLE
     DESCRIPTIVE NAME - Monitor Event Record
            Domain 4  - User domain
            Record 12 - Guest relocation ended
     DESCRIPTION - Indicates the end (completion or termination)
                   of a guest relocation.  The record contains
                   command operands and options, and performance
                   data associated with the relocation.
     NOTES:
      Codes defined for USERLE_RLOFINCD
        00     Completed successfully
        01     Canceled by VMRELOCATE CANCEL command
        02     Canceled by CPHX command
        03     Canceled due to lost ISFC connection
        04     Canceled due to MAXTOTAL time limit exceeded
        05     Canceled due to MAXQUIESCE time limit exceeded
        06     Canceled due to eligibility violation
        07     Canceled due to virtual machine reset or logoff
        08     Canceled due to internal processing error
        09     Canceled because CP exit rejected this relocation
        11     Canceled because CP exit gave a return code
               that is not valid

#### MRUSERLE Control Block Contents

    Offsets
    Dec  Hex  Type        Len  Name (Dim)             Description

       0   0  Structure   268  USERLE                 Start of monitor record
       0   0  Character     0  USERLE_CALMRHDR        Record header. See MRRECHDR
                                                      for details.
       0   0  Character    20  MRHDR
       0   0  Unsigned      2  MRHDRLEN
       2   2  Unsigned      2  MRHDRZER
       4   4  Unsigned      1  MRHDRDM
       5   5  Unsigned      1  *
       6   6  Unsigned      2  MRHDRRC
       8   8  Character     8  MRHDRTOD
      16  10  Character     4  *
      20  14  Character     0  MRHDR_END
      20  14  Character     8  USERLE_RLOISSUER       VMRELOCATE cmd issuer
      28  1C  Character     8  USERLE_RLOUSER         Userid of relocation target
      36  24  Character     8  USERLE_RLOSRCSYS       Name of source system
      44  2C  Character     8  USERLE_RLODSTSYS       Name of destination system
      52  34  Character     8  USERLE_RLOSTARTM       Time of start of relocation
                                                      in TOD units
      60  3C  Signed        4  USERLE_RLOMAXT         MAXTOTAL time (seconds)
      64  40  Signed        4  USERLE_RLOMAXQ         MAXQUIESCE time (seconds)
      68  44  Bitstring     1  USERLE_LCLFLAGS        Local relocation info flags
              1... ....        USERLE_RLOMOVSRC        This record was cut on the
                                                      source system
              .1.. ....        USERLE_VMDAFSUP         CPU affinity suppression
                                                      bit after the relocation
              ..1. ....        USERLE_CALAFSPC         Flag indicating if CPU
                                                      affinity suppression was
                                                      changed from its setting on
                                                      the source system. This flag
                                                      is on if it was changed
              ...1 ....        *
              .... 1...        *
              .... .1..        *
              .... ..1.        *
              .... ...1        *
      69  45  Bitstring     1  USERLE_RLOMVOPT        Flag byte for cmd options
              1... ....        USERLE_RLOMVFA          FORCE ARCH specified
              .1.. ....        USERLE_RLOMVFD          FORCE DOMAIN specified
              ..1. ....        USERLE_RLOMVFS          FORCE STORAGE specified
              ...1 ....        USERLE_RLOMVASN         ASYNCH was requested
              .... 1...        USERLE_RLONLIMT         NOLIMIT requested for
                                                      MAXTOTAL
              .... .1..        USERLE_RLONLIMQ         NOLIMIT requested for
                                                      MAXQUIESCE
              .... ..1.        USERLE_RLOIMMED         IMMEDIATE was specified
              .... ...1        *
      70  46  Bitstring     1  USERLE_VMDSTRLO        SET VMRELOCATE flags (valid
                                                      only in the base VMDBK
              1... ....        USERLE_VMDRLONA         This virtual machine has
                                                      VMRELOCATION set off. If
                                                      USERLE_RLOMOVSRC=OFF, this
                                                      value is unreliable if the
                                                      relocation ended
                                                      unsuccessfully.
              .1.. ....        *
              ..1. ....        *
              ...1 ....        *
              .... 1...        *
              .... .1..        *
              .... ..1.        *
              .... ...1        *
      71  47  Unsigned      1  USERLE_RLOFINCD        Code indicating reason why
                                                      the relocation ended. See the
                                                      prologue for explanation of
                                                      possible the codes
      72  48  Unsigned      4  USERLE_RLOVDXCT        Count of virtual devices
                                                      transferred
      76  4C  Unsigned      4  USERLE_RLOAIOCT        Count of active I/Os
                                                      encountered
      80  50  Unsigned      4  USERLE_RLONQDCT        Count of non-QDIO type I/Os
                                                      cleared
      84  54  Unsigned      4  USERLE_RLOQDCT         Count of QDIO type I/Os
                                                      cleared
      88  58  Unsigned      4  USERLE_RLOMEMPS        Number of memory passes
                                                      made during the relocation
      92  5C  Character     8  USERLE_RLOPASSA        Number of guest pages
                                                      transferred in first pass.
     100  64  Character     8  USERLE_RLOPSAVG        Average number of guest
                                                      pages transferred during pass
                                                      2 through pass n-2. This
                                                      field is zero when the
                                                      relocation is IMMEDIATE.
     108  6C  Character     8  USERLE_RLOPASSY        Number of guest pages
                                                      transferred in the next to
                                                      last (penultimate) pass
     116  74  Character     8  USERLE_RLOCPCNT        Number of guest pages
                                                      transferred on the final pass
     124  7C  Character     8  USERLE_RLOCONTM        Timestamp (TOD) of
                                                      completion of initial ISFC
                                                      connection
     132  84  Character     8  USERLE_RLOELGTM        Timestamp (TOD) of
                                                      completion of initial
                                                      eligibility checks
     140  8C  Character     8  USERLE_RLOCRETM        Timestamp (TOD) of
                                                      completion of creation of
                                                      skeleton VMDBK
     148  94  Character     8  USERLE_RLOSETTM        Timestamp (TOD) of
                                                      completion of STMGT set up
     156  9C  Character     8  USERLE_RLOMEMTM        Timestamp (TOD) of
                                                      completion of memory transfer
                                                      except for the last two
                                                      passes. This field is only
                                                      valid in the record cut on
                                                      the source. This field is not
                                                      valid for the record
                                                      generated on the destination
                                                      system.
     164  A4  Character     8  USERLE_RLOFCPTM        Timestamp (TOD) of
                                                      completion of FCP I/O delay.
                                                      This field is only valid in
                                                      the record cut on the source.
                                                      This field is not valid for
                                                      the record generated on the
                                                      destination system.
     172  AC  Character     8  USERLE_RLOQUITM        Timestamp (TOD) of
                                                      completion of guest quiesce.
     180  B4  Character     8  USERLE_RLOIOCTM        Timestamp (TOD) of
                                                      completion of I/O config
                                                      relocation
     188  BC  Character     8  USERLE_RLOSTATM        Timestamp (TOD) of
                                                      completion of virtual machine
                                                      state relocation
     196  C4  Character     8  USERLE_RLOCRYTM        Timestamp (TOD) of
                                                      completion of all really
                                                      enqueued crypto messages
     204  CC  Character     8  USERLE_RLOVSETM        Timestamp (TOD) of
                                                      completion of final VSIM elig
                                                      checks
     212  D4  Character     8  USERLE_RLOSMETM        Timestamp (TOD) of
                                                      completion of final STMGT
                                                      elig checks. This field is
                                                      only valid in the record cut
                                                      on the source. This field is
                                                      not valid for the record
                                                      generated on the destination
                                                      system.
     220  DC  Character     8  USERLE_RLOPENTM        Timestamp (TOD) of
                                                      completion of penultimate
                                                      memory pass. This field is
                                                      only valid in the record cut
                                                      on the source. This field is
                                                      not valid for the record
                                                      generated on the destination
                                                      system.
     228  E4  Character     8  USERLE_RLOLSTTM        Timestamp (TOD) of
                                                      completion of last memory
                                                      pass
     236  EC  Character     8  USERLE_RLOIOETM        Timestamp (TOD) of
                                                      completion of final I/O
                                                      eligibility checks
     244  F4  Character     8  USERLE_RLORESTM        Timestamp (TOD) of
                                                      completion of resumption of
                                                      guest execution
                                                      (approximate). The guest is
                                                      actually resumed in
                                                      destination side clean-up
                                                      which occurs after relocation
                                                      sockets have been closed. On
                                                      the source, this field
                                                      represents the time when the
                                                      socket is closed. In the
                                                      destination record, this
                                                      field is the time just prior
                                                      to guest resumption.
     252  FC  Character     8  USERLE_RLOCLNTM        Timestamp (TOD) of
                                                      completion of final clean up,
                                                      including logoff of the guest
                                                      on the source system
     260 104  Unsigned      4  USERLE_RLOSRCRSV       Reserved frame count on the
                                                      source system
     264 108  Unsigned      4  USERLE_RLODSTRSV       Reserved frame count on the
                                                      destination system
     268 10C  Character     0  USERLE_END

#### MRUSERLE Cross Reference

                          Hex           Hex
    Name                  Offset Length Value

    MRHDR                      0     20
    MRHDR_END                 14      0
    MRHDRDM                    4      1
    MRHDRLEN                   0      2
    MRHDRRC                    6      2
    MRHDRTOD                   8      8
    MRHDRZER                   2      2
    USERLE                     0    268
    USERLE_CALAFSPC           44           20
    USERLE_CALMRHDR            0      0
    USERLE_END               10C      0
    USERLE_LCLFLAGS           44      1
    USERLE_RLOAIOCT           4C      4
    USERLE_RLOCLNTM           FC      8
    USERLE_RLOCONTM           7C      8
    USERLE_RLOCPCNT           74      8
    USERLE_RLOCRETM           8C      8
    USERLE_RLOCRYTM           C4      8
    USERLE_RLODSTRSV         108      4
    USERLE_RLODSTSYS          2C      8
    USERLE_RLOELGTM           84      8
    USERLE_RLOFCPTM           A4      8
    USERLE_RLOFINCD           47      1
    USERLE_RLOIMMED           45           02
    USERLE_RLOIOCTM           B4      8
    USERLE_RLOIOETM           EC      8
    USERLE_RLOISSUER          14      8
    USERLE_RLOLSTTM           E4      8
    USERLE_RLOMAXQ            40      4
    USERLE_RLOMAXT            3C      4
    USERLE_RLOMEMPS           58      4
    USERLE_RLOMEMTM           9C      8
    USERLE_RLOMOVSRC          44           80
    USERLE_RLOMVASN           45           10
    USERLE_RLOMVFA            45           80
    USERLE_RLOMVFD            45           40
    USERLE_RLOMVFS            45           20
    USERLE_RLOMVOPT           45      1
    USERLE_RLONLIMQ           45           04
    USERLE_RLONLIMT           45           08
    USERLE_RLONQDCT           50      4
    USERLE_RLOPASSA           5C      8
    USERLE_RLOPASSY           6C      8
    USERLE_RLOPENTM           DC      8
    USERLE_RLOPSAVG           64      8
    USERLE_RLOQDCT            54      4
    USERLE_RLOQUITM           AC      8
    USERLE_RLORESTM           F4      8
    USERLE_RLOSETTM           94      8
    USERLE_RLOSMETM           D4      8
    USERLE_RLOSRCRSV         104      4
    USERLE_RLOSRCSYS          24      8
    USERLE_RLOSTARTM          34      8
    USERLE_RLOSTATM           BC      8
    USERLE_RLOUSER            1C      8
    USERLE_RLOVDXCT           48      4
    USERLE_RLOVSETM           CC      8
    USERLE_VMDAFSUP           44           40
    USERLE_VMDRLONA           46           80
    USERLE_VMDSTRLO           46      1

    This information is
    based on z/VM V7R2.0.

    Last updated on 05 August 2020 at 20:48:16.

    Copyright IBM Corporation, 1990, 2020