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

MRSYTCUP

Prolog
Control Block Contents
Cross Reference

MRSYTCUP Prolog

 DSECT NAME - SYTCUP
 FUNCTION - Map a Monitor record.
 LOCATED BY -
        Through the Monitor Control Area
 REFERENCED CONTROL BLOCKS -
        MRRECHDR    Monitor Record Header
 NAME - MRSYTCUP
 DESCRIPTIVE NAME - Monitor Sample Record
        Domain 0  - System Domain
        Record 16 - CPU Utilization Data in a Logical Partition
 DESCRIPTION - CPU utilization data for an individual logical
               partition.  Also included are data for each logical
               CPU in the partition.
 NOTES:
   -- This record is generated only when the system is running
      in the logical partition ("LPAR") environment.
   -- A separate record is generated for each logical partition in
      the system.
      However, if the HMC Global Performance Data setting
      is disabled, you will only receive a record for your
      partition.
   -- SYTCUP_CALCPUOF and SYTCUP_CALCPULN should always be used
      to locate the SYTCUP_CPUDATA entries.  Their values may be
      subject to change.


MRSYTCUP Control Block Contents

Offsets
Dec Hex  Type       Len  Name (Dim)             Description
 
  0   0  Structure   64  SYTCUP                 Start of monitor record
  0   0  Character    0  SYTCUP_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  Character    8  SYTCUP_LCUPNAME        Logical partition name
 28  1C  Unsigned     1  SYTCUP_LCUPPNUM        Logical partition number
 29  1D  Bitstring    1  SYTCUP_CALFLGS         Flag byte
          1... ....      SYTCUP_CALPTIS         When set to ON, this logical
                                                partition is the one that
                                                fetched the logical CPU
                                                utilization data
          .1.. ....      SYTCUP_LCXPUPVA        When set to ON, the user
                                                partition ID (SYTCUP_LCXPUPID)
                                                is valid.
          ..1. ....      SYTCUP_CALMORE         When set to ON, indicates
                                                an additional MRSYTCUP record
                                                is created for this LPAR.
                                                When OFF, indicates this is
                                                the only or last MRSYTCUP
                                                record for this LPAR.
          ...1 ....      *
          .... 1...      *
          .... .1..      *
          .... ..1.      *
          .... ...1      *
  30  1E  Unsigned    1  SYTCUP_CALNREC         The number of
                                                SYTCUP_CPUDATA entries in
                                                this record. A SYTCUP_CPUDATA
                                                entry is created for each
                                                logical CPU in the partition.
                                                For the total number of
                                                logical CPUs in the partition
                                                see SYTCUP_LCUPCPCT.
  31  1F  Unsigned    1  SYTCUP_LCUPCPCT        Total number of logical
                                                CPUs in this partition. If
                                                zero, this partition is not
                                                active. Includes secondary
                                                processors if SYTCUG_LCUT204E
                                                is on
 32  20  Signed       2  SYTCUP_CALCPUOF        Byte offset, relative from
                                                the start of this record, to
                                                the first SYTCUP_CPUDATA entry
                                                of the table
 34  22  Signed       2  SYTCUP_CALCPULN        length, in bytes, of a
                                                SYTCUP_CPUDATA entry
 36  24  Character    8  SYTCUP_LCUTCTOD        Time-of-day, in TOD clock
                                                value, that the logical CPU
                                                information was fetched
 44  2C  Character   16  SYTCUP_LCPTYPE         CPU TYPE as from EBCDIC NAME
                                                TABLE. This table is provided
                                                by the hardware, and describes
                                                the type of logical processor.
                                                This field does not contain a
                                                value when SYTCUG_LCUT204E is
                                                on; instead, the CPU type is
                                                available per logical processor
                                                in SYTCUP_LCXCPTYP.
 60  3C  Unsigned     1  SYTCUP_LCXPUPID        User partition ID UPID is
                                                valid if SYTCUP_LCXPUPVA is ON.
                                                Otherwise set to zero.
 61  3D  Character    3  *                      Reserved for IBM use
 64  40  Character    0  *                      Table of SYTCUP_CPUDATA
                                                entries, one for each logical
                                                CPU in the partition.
                                                SYTCUP_CALCPUOF,
                                                SYTCUP_CALCPULN and
                                                SYTCUP_LCBPCPCT should be used
                                                to locate this table.

CPU Utilization data for an individual logical CPU. There is a separate entry for each logical CPU in the partition.
Offsets Dec Hex Type Len Name (Dim) Description 0 0 Structure 40 SYTCUP_CPUDATA Logical CPU data entry 0 0 Unsigned 2 SYTCUP_LCUCPUID Logical CPU address 2 2 Unsigned 2 SYTCUP_LCUCWGHT Processing weight as assigned to this partition. Value is in range of 0 to 999 except that it is set to 65535 (x'FFFF') if this CPU is dedicated to this logical partition. 4 4 Bitstring 1 SYTCUP_LCUCFLGS CPU Information flag byte 1... .... SYTCUP_LCUCWCPL Wait completion flag. ON = 'YES' has been specified in the Wait Completion option of the logical partition controls. Logical CPU dispatching is to be done without regard to logical CPU wait states. OFF = CPU time not used by one logical CPU may be given to another logical CPU or logical partition. .1.. .... SYTCUP_LCUCCAPP Partition-Capping flag. ON if the operator has set capped=yes in the logical-partition controls. Not set if the logical partition uses dedicated CPUs. ..1. .... SYTCUP_LCXCCONL CPU-online flag. ON if logical CPU currently online. Valid only if enhanced LPAR support avail. (SYTCUG_LCUT204A is ON and SYTCUG_LCUT204S is OFF). ...1 .... * .... 1... * .... .1.. * .... ..1. * .... ...1 * 5 5 Unsigned 1 * Reserved for IBM use 6 6 Character 8 SYTCUP_LCUCACTM Accumulated number of microseconds during which a physical processor was assigned to this logical processor. Accumulation continues (i.e., is not reset) while the logical processor is defined. 14 E Character 8 SYTCUP_LCUCLPTM Accumulated number of microseconds, excluding LPAR-management time, during which a physical CPU was assigned to this logical CPU. This value is not reset while the logical CPU is defined. 22 16 Character 16 SYTCUP_LCXCPTYP CPU type as ECBDIC string. Contains a value only if enhanced LPAR monitor support with support for secondary processors is available as indicated by SYTCUG_LCUT204E. 38 26 Character 2 * Reserved for IBM use 40 28 Character 0 SYTCUP_END

MRSYTCUP 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
SYTCUP                     0     64
SYTCUP_CALCPULN           22      2
SYTCUP_CALCPUOF           20      2
SYTCUP_CALFLGS            1D      1
SYTCUP_CALMORE            1D           20
SYTCUP_CALNREC            1E      1
SYTCUP_CALPTIS            1D           80
SYTCUP_CPUDATA             0     40
SYTCUP_END                28      0
SYTCUP_LCPTYPE            2C     16
SYTCUP_LCUCACTM            6      8
SYTCUP_LCUCCAPP            4           40
SYTCUP_LCUCFLGS            4      1
SYTCUP_LCUCLPTM            E      8
SYTCUP_LCUCPUID            0      2
SYTCUP_LCUCWCPL            4           80
SYTCUP_LCUCWGHT            2      2
SYTCUP_LCUPCPCT           1F      1
SYTCUP_LCUPNAME           14      8
SYTCUP_LCUPPNUM           1C      1
SYTCUP_LCUTCTOD           24      8
SYTCUP_LCXCCONL            4           20
SYTCUP_LCXCPTYP           16     16
SYTCUP_LCXPUPID           3C      1
SYTCUP_LCXPUPVA           1D           40
SYTCUP_MRHDR               0      0

This information is based on z/VM V6R1.0.
Last updated on 9 Nov 2012 at 16:57:13.
Copyright IBM Corporation, 1990, 2012