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

#### MRSYTCUM

Prolog
Control Block Contents
Cross Reference

#### MRSYTCUM Prolog

     DSECT NAME - SYTCUM
     FUNCTION - Map a Monitor record.
     LOCATED BY -
            Through the Monitor Control Area
     REFERENCED CONTROL BLOCKS -
            MRRECHDR    Monitor Record Header
     NAME - MRSYTCUM
     DESCRIPTIVE NAME - Monitor Sample Record
            Domain 0  - System Domain
            Record 17 - Physical CPU Utilization Data for LPAR Management
     DESCRIPTION - Physical CPU/core utilization data for LPAR
                   management, including data for each CPU/core.
     NOTES:
       -- This record is generated only when the logical
          partition (LPAR) management time facility is
          available from the underlying hypervisor.

       -- SYTCUM_CALMIBOF and SYTCUM_CALMIBLN should always be used
          to locate the SYTCUM_MIBDATA entries.  Their values may be
          subject to change.

       -- For additional information about the format and
          meaning of the SYTCUM_SSI1MTIF field, refer to
           - Principles of Operation for the layout of the
             STSI output (SYSIB 1.2.2), which is documented
             in Chapter 10 under "STORE SYSTEM INFORMATION".

       -- For additional information about the format of
          the SYTCUM_LCXPCTOP field, refer to
           - Principles of Operation for the layout of the
             STSI output (SYSIB 15.1.x), which is documented
             in Chapter 10 under "STORE SYSTEM INFORMATION".

       -- This record is not generated if the HMC Global
          Performance Data setting is disabled.

       -- When a field in this record uses the term "CPU/core",
          the meaning of the field changes based on whether
          Multithreading (MT) Facility is installed on the
          central processing complex (CPC). Refer to
          SYTCUM_SSI1MTFI bit in this record to determine
          whether MT is installed on this CPC.
          When MT is not installed on this CPC, a physical core
          contains only one CPU:
            - CPU   : central processing unit.
            - CORE  : physical unit containing one CPU.
                      In this environment the core has
                      1 thread, the term "thread" is not used,
                      and the term "CPU" is generally favored
                      over the term "core".
           When MT is installed on this CPC, a physical core
           contains one or more CPUs (aka "threads"):
             - CPU   : central processing unit. Identified by
                       CPU address which consists of core ID
                       and thread ID.
             - CORE  : physical unit containing one or more
                       CPUs (aka "threads"). All CPUs of a core
                       have the same CPU type.
             - THREAD: synonym for a CPU that is a member of a
                       core. Each thread on a core has a
                       distinct thread ID (TID), numbered from
                       0 up to the maximum thread ID available
                       on the core.

#### MRSYTCUM Control Block Contents

    Offsets
    Dec  Hex  Type        Len  Name (Dim)             Description

       0   0  Structure    48+ SYTCUM                 Start of monitor record
       0   0  Character     0  SYTCUM_MRHDR           Record header. See MRRECHDR
                                                      for details.
       0   0  Character    20  MRHDR
       0   0  Unsigned      2  MRHDRLEN               record length in bytes
       2   2  Unsigned      2  MRHDRZER               field of zeros
       4   4  Unsigned      1  MRHDRDM                domain identifier
       5   5  Unsigned      1  *
       6   6  Unsigned      2  MRHDRRC                record identifier
       8   8  Character     8  MRHDRTOD               Time at which this record
                                                      was built. In time-of-day
                                                      (TOD) clock format. See IBM
                                                      System 370 XA Principle of
                                                      Operation for explanation of
                                                      format.
      16  10  Character     4  *
      20  14  Character     0  MRHDR_END              End of header
      20  14  Unsigned      1  SYTCUM_CALNREC         Number of SYTCUM_MIBDATA
                                                      entries found in this record.
                                                      One SYTCUM_MIBDATA entry is
                                                      created for each physical
                                                      CPU/core. For the total
                                                      number of physical CPUs/cores
                                                      see SYTCUM_LCUPCPCT.
      21  15  Bitstring     1  SYTCUM_CALFLGS         Flag byte
              1... ....        SYTCUM_CALMORE          When set to ON, indicates
                                                      an additional MRSYTCUM record
                                                      is created for this CPC. When
                                                      OFF, indicates this is the
                                                      only or last MRSYTCUM record
                                                      for this CPC.
              .1.. ....        *
              ..1. ....        SYTCUM_CALBUSY          When set to ON, indicates that
                                                      a busy condition was encountered
                                                      when attempting to acquire
                                                      current processor utilization
                                                      data. To avoid delays, reported
                                                      data uses cached values that
                                                      were obtained at the time
                                                      indicated in SYTCUM_LCUTCTOD.
              ...1 ....        *
              .... 1...        *
              .... .1..        *
              .... ..1.        *
              .... ...1        *
      22  16  Unsigned      1  SYTCUM_LCUPCPCT        Total number of physical
                                                      CPUs/cores.
      23  17  Character     1  *                      Reserved for IBM use
      24  18  Signed        2  SYTCUM_CALMIBOF        Byte offset, relative to
                                                      the start of this record, to
                                                      the first SYTCUM_MIBDATA
                                                      entry of the table
      26  1A  Signed        2  SYTCUM_CALMIBLN        Length in bytes of a
                                                      SYTCUM_MIBDATA entry
      28  1C  Character     8  SYTCUM_LCUTCTOD        Time-of-day, in TOD clock
                                                      format, that the physical
                                                      CPU/core information was
                                                      fetched.
      36  24  Bitstring     1  SYTCUM_SSI1MTIF        Multithreading
                                                      configuration
              1... ....        SYTCUM_SSI1MTFI         Bit 0 = 0 MT facility not
                                                      installed on the CPC.
                                                      Remainder of this field,
                                                      SYTCUM_SSI1HTSC is not
                                                      meaningful (stored as zeros).
                                                      Bit 0 = 1 MT facility
                                                      installed on the CPC.
              .1.. ....        *
              ..1. ....        *
              ...1 1111        SYTCUM_SSI1HTSC         Bits 3-7 = Maximum
                                                      supported TID on any core
                                                      (range 1-31, indicating 2-32
                                                      threads/core). Valid only if
                                                      SYTCUM_SSI1MTFI=1
      37  25  Character     3  *                      Reserved for IBM use
      40  28  Character     8  *                      Reserved for IBM use
      48  30  Character     0  *                      Table of SYTCUM_MIBDATA
                                                      entries, one for each
                                                      physical CPU/core.
                                                      SYTCUM_CALMIBOF,
                                                      SYTCUM_CALMIBLN and
                                                      SYTCUM_CALNREC should be used
                                                      to locate this table.
    CPU/core utilization data for LPAR management. There is a separate entry
    for each CPU/core.

    LCXPCTOP expresses the topological location of the
    physical CPU/core:

        MNest = number of topology levels
        MagX = location identifier for level X
        0-------8------16------24------31
        | Mag6  | Mag5  | Mag4  | Mag3  |
        +-------+-------+-------+-------+
        | Mag2  | Mag1  | rsvd  | MNest |
        +-------+-------+-------+-------+

    MNest states the number of topology levels in the machine.
    MagX fields where X>MNest will always be zero.
    The MagX field where X=MNest is the topmost topology level.
    Valid values for the MagX fields are >= 1.
    If X<=MNest and the value in MagX=0, the machine was
    unable to report a location identifier for level X.

    Offsets
    Dec  Hex  Type        Len  Name (Dim)             Description

       0   0  Structure    44  SYTCUM_MIBDATA         Physical CPU/core data
                                                      entry
       0   0  Unsigned      2  SYTCUM_LCUMCPU         Physical CPU address / core
                                                      ID
       2   2  Character     8  SYTCUM_LCUMGTM         Accumulated number of
                                                      microseconds during which a
                                                      physical CPU/core was
                                                      assigned LPAR management
                                                      time. This value is reset
                                                      only when the Processor
                                                      Resource/Systems Manager
                                                      (PR/SM) is initialized.
      10   A  Character    16  SYTCUM_LCUPTYPE        Physical CPU/core type as
                                                      an EBCDIC string. Contains a
                                                      value only if enhanced LPAR
                                                      monitor support with support
                                                      for specialty processors is
                                                      available as indicated by
                                                      SYTCUG_LCUT204E.
      26  1A  Character     2  *                      Reserved and available for
                                                      IBM use.
      28  1C  Character     8  SYTCUM_LCUSMTM         If non-zero, accumulated
                                                      number of microseconds during
                                                      which a physical CPU/core was
                                                      assigned system management
                                                      time. This value is reset
                                                      only by a power on reset.
      36  24  Character     8  SYTCUM_LCXPCTOP        Location of the physical
                                                      CPU/core in the topology.
                                                      Organized the same as words 1-2
                                                      of the SYSIB 15.1.x response.
                                                      If the model does not provide
                                                      this data, this field will
                                                      be zero.
      44  2C  Character     0  SYTCUM_END

#### MRSYTCUM 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
    SYTCUM                     0     48
    SYTCUM_CALBUSY            15           20
    SYTCUM_CALFLGS            15      1
    SYTCUM_CALMIBLN           1A      2
    SYTCUM_CALMIBOF           18      2
    SYTCUM_CALMORE            15           80
    SYTCUM_CALNREC            14      1
    SYTCUM_END                2C      0
    SYTCUM_LCUMCPU             0      2
    SYTCUM_LCUMGTM             2      8
    SYTCUM_LCUPCPCT           16      1
    SYTCUM_LCUPTYPE            A     16
    SYTCUM_LCUSMTM            1C      8
    SYTCUM_LCUTCTOD           1C      8
    SYTCUM_LCXPCTOP           24      8
    SYTCUM_MIBDATA             0     44
    SYTCUM_MRHDR               0      0
    SYTCUM_SSI1HTSC           24
    SYTCUM_SSI1MTFI           24           80
    SYTCUM_SSI1MTIF           24      1

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

    Last updated on 21 April 2022 at 14:52:11.

    Copyright IBM Corporation, 1990, 2022