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

#### MRUSEINT

Prolog
Control Block Contents
Cross Reference

#### MRUSEINT Prolog

####

####

     DSECT NAME - USEINT
     FUNCTION - Map a Monitor record.
     LOCATED BY -
            Through the Monitor Control Area
     REFERENCED CONTROL BLOCKS -
            MRRECHDR    Monitor Record Header
     NAME - MRUSEINT
     DESCRIPTIVE NAME - Monitor Sample Record
                        Domain 4 - User Domain
                        Record 4 - User Interaction Data
     DESCRIPTION - Describes a VMDBK's use of the system.  Included
                   are such things as its use of IUCV, APPC and the
                   number of times it occupied various queues.  A
                   separate record is generated for each VMDBK defined
                   in the user's virtual complex.
     NOTES:
       - Fields labeled by the prefix, 'USEINT_HF', are high-frequency
         counters.
       - The following is the order of high-frequency counters in which
         the user is tested for its wait state.  If the user is in more
         than one state, it is counted only in the first of the list.
                     USEINT_HFIOWT
                     USEINT_HFCFWT
                     USEINT_HFSIMWT
                     USEINT_HFWTPAG
                     USEINT_HFLLIST
                     USEINT_HFCPUWT
                     USEINT_HFCPURN
                     USEINT_HFESVM
                     USEINT_HFLOAD
                     USEINT_HFDORM
                     USEINT_HFDSVM
                     USEINT_HFIOACT
                     USEINT_HFTIDL
                     USEINT_HFTSVM
                     USEINT_HFPGACT
                     USEINT_HFOTHR

    MRUSEINT Control Block Contents

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

      0   0  Structure  228  USEINT                 Start of monitor record
      0   0  Character    0  USEINT_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  USEINT_VMDUSER         User logon identification
     28  1C  Unsigned     2  USEINT_VMDCPUAD        Processor address
     30  1E  Bitstring    1  USEINT_CALFLAG         Flag byte
              1... ....      USEINT_CALBASE         If on, this is the base
                                                    VMDBK. VMDBASE
              .1.. ....      USEINT_CALTRQFL        If on, there is a TRQ block
                                                    set to either time the user in
                                                    a sleep state for a limited
                                                    period of time or to time 15
                                                    minutes before logging off a
                                                    disconnected user following an
                                                    attempted display I/O (time
                                                    bomb logoff).
              ..1. ....      *
              ...1 ....      *
              .... 1...      *
              .... .1..      *
              .... ..1.      *
              .... ...1      *
     31  1F  Unsigned     1  *                      Reserved for IBM use
     32  20  Character    4  USEINT_CALINTRN        'YES ' = this VMDBK is
                                                    currently contributing to a
                                                    transaction. 'NO ' = this VMDBK
                                                    is not currently contributing
                                                    to a transaction. 'UNDE' = this
                                                    VMDBK is currently idle and may
                                                    or may not contribute to a
                                                    transaction.
     36  24  Unsigned     4  USEINT_VMDSVMFX        Number of times the SVM-wait
                                                    flag was left on at the end of
                                                    a transaction and had to be
                                                    corrected by the scheduler by
                                                    resetting it.
     40  28  Character    8  USEINT_VMDSVMID        VMDBK name for the last
                                                    successful IUCV, VMCF, or
                                                    APPC/VM Send for this virtual
                                                    machine. Valid in base VMDBK
                                                    only.
     48  30  Bitstring    1  USEINT_VMDSVMWT        Service-virtual-machine (SVM)
                                                    wait flag byte - valid in base
                                                    VMDBK only.
              1... ....      USEINT_VMDSVMWF        VMDBK is waiting for a
                                                    response from IUCV, VMCF, or
                                                    APPC.
              .1.. ....      *
              ..1. ....      *
              ...1 ....      *
              .... 1...      *
              .... .1..      *
              .... ..1.      *
              .... ...1      *
     49  31  Character    0  USEINT_VMDSVMW2        Back-up byte to the VMDSVMWT
                                                    byte. Its contents will persist
                                                    longer than they would in
                                                    VMDSVMWT. Valid in base VMDBK
                                                    only.
     49  31  Bitstring    1  USEINT_VMDSVMWT        Service-virtual-machine (SVM)
                                                    wait flag byte - valid in base
                                                    VMDBK only.
              1... ....      USEINT_VMDSVMWF        VMDBK is waiting for a
                                                    response from IUCV, VMCF, or
                                                    APPC.
     50  32  Character    0  USEINT_VMDRDYCM        Flag byte set by IUCV, VMCF,
                                                    or APPC whenever IUCV/VMCF/APPC
                                                    makes an external interrupt. It
                                                    is sort of a "reference byte"
                                                    that tells the scheduler that
                                                    IUCV/VMCF/APPC had been active
                                                    recently. Valid in base VMDBK
                                                    only.
     50  32  Bitstring    1  USEINT_VMDSVMWT        Service-virtual-machine (SVM)
                                                    wait flag byte - valid in base
                                                    VMDBK only.
              1... ....      USEINT_VMDSVMWF        VMDBK is waiting for a
                                                    response from IUCV, VMCF, or
                                                    APPC.
     51  33  Unsigned     1  *                      Reserved for IBM use
     52  34  Unsigned     4  USEINT_HFQUCT          Number of times VMDBK was
                                                    high frequency sampled.
     56  38  Unsigned     4  USEINT_HFDISP0         Number of times the VMDBK was
                                                    in Q0. VMDSLIST = VMDDISPL and
                                                    VMDELIST = 0.
     60  3C  Unsigned     4  USEINT_HFDISP1         Number of times the VMDBK was
                                                    in Q1. VMDSLIST = VMDDISPL and
                                                    VMDELIST = 1.
     64  40  Unsigned     4  USEINT_HFDISP2         Number of times the VMDBK was
                                                    in Q2. VMDSLIST = VMDDISPL and
                                                    VMDELIST = 2.
     68  44  Unsigned     4  USEINT_HFDISP3         Number of times the VMDBK was
                                                    in Q3. VMDSLIST = VMDDISPL and
                                                    VMDELIST = 3.
     72  48  Unsigned     4  USEINT_HFELIG0         Number of times the VMDBK was
                                                    in E0. VMDSLIST = VMDELIG and
                                                    VMDELIST = 0.
     76  4C  Unsigned     4  USEINT_HFELIG1         Number of times the VMDBK was
                                                    in E1. VMDSLIST = VMDELIG and
                                                    VMDELIST = 1.
     80  50  Unsigned     4  USEINT_HFELIG2         Number of times the VMDBK was
                                                    in E2. VMDSLIST = VMDELIG and
                                                    VMDELIST = 2.
     84  54  Unsigned     4  USEINT_HFELIG3         Number of times the VMDBK was
                                                    in E3. VMDSLIST = VMDELIG and
                                                    VMDELIST = 3.
     88  58  Unsigned     4  USEINT_HFSTCT          Number of times VMDBK was
                                                    high frequency sampled. This
                                                    was once distinguishable from
                                                    USEINT_HFQUCT but is now the
                                                    same and is retained for
                                                    migration or compatibility
                                                    purposes.
     92  5C  Unsigned     4  USEINT_HFTIDL          Count of times user was found
                                                    in test idle and not in SVM
                                                    wait
     96  60  Unsigned     4  USEINT_HFTSVM          Count of times user was found
                                                    in test idle and in SVM wait
    100  64  Unsigned     4  USEINT_HFIOWT          Number of times this user was
                                                    in synchronous I/O wait. This
                                                    I/O wait indicates that a guest
                                                    is waiting for I/O completion
                                                    status and thus is prevented
                                                    from running. VMDIOWT
    104  68  Unsigned     4  USEINT_HFCFWT          Number of times this user was
                                                    found in console-function wait.
                                                    During such a wait, the virtual
                                                    cpu is not permitted to run.
                                                    VMDCFWT
    108  6C  Unsigned     4  USEINT_HFSIMWT         Number of times this user was
                                                    found in 'simulation wait' in
                                                    which the CPU is simulating
                                                    some hardware functions such as
                                                    instructions, interrupts, or
                                                    timer updates, and the virtual
                                                    machine is thus prevented from
                                                    running to avoid potential
                                                    conflicts with the simulations.
                                                    VMDSIMWT
    112  70  Unsigned     4  USEINT_HFWTPAG         Count of times this user was
                                                    found in page wait. Page wait
                                                    is when the current guest
                                                    instruction refers to a guest
                                                    page which is not present in
                                                    host storage and must be
                                                    brought in from auxiliary
                                                    storage. Page wait prevents the
                                                    virtual CPU from running,
                                                    however it is a "soft wait"
                                                    condition, and as such can be
                                                    cleared by a guest PSW swap.
                                                    VMDWTPAG
    116  74  Unsigned     4  USEINT_HFCPUWT         Count of times this user was
                                                    found waiting to run on the
                                                    real processor. VMDSTATE =
                                                    VMDREADY
    120  78  Unsigned     4  USEINT_HFCPURN         Count of times this user was
                                                    found running on the real
                                                    processor. VMDSTATE = VMDISPCH
    124  7C  Unsigned     4  USEINT_HFESVM          Count of times this user was
                                                    found in SVM wait and in the
                                                    eligible list
    128  80  Unsigned     4  USEINT_HFLOAD          Count of times this user was
                                                    considered a loading user.
                                                    VMDLOADU = on and VMDSLIST ^=
                                                    VMDDORM
    132  84  Unsigned     4  USEINT_HFDORM          Count of times this user was
                                                    found dormant. VMDSLIST =
                                                    VMDDORM
    136  88  Signed       4  USEINT_HFDSVM          Count of times this user was
                                                    found in SVM wait and in the
                                                    dormant list. Note: this count
                                                    is also included in
                                                    USEINT_HFDORM. VMDSVMWF of
                                                    VMDSVMWT = on and VMDSLIST =
                                                    VMDDORM
    140  8C  Unsigned     4  USEINT_HFOTHR          Count of times this user was
                                                    not found in any of the above
                                                    states
    144  90  Unsigned     2  USEINT_VMDCNTID        Number of times user was not
                                                    granted a test idle time when
                                                    it went idle in the dispatch
                                                    list
    146  92  Unsigned     2  USEINT_VMDCTIDL        Number of times this user was
                                                    granted a test idle time when
                                                    it went idle in the dispatch
                                                    list
    148  94  Unsigned     4  USEINT_VMDDFRWK        Count of 'deferred' work
                                                    items for the VMDBK. A
                                                    'deferred' work item is an
                                                    asynchronous task that has yet
                                                    to run. This VMDBK shall be
                                                    prevented from completing its
                                                    logoff until this count is
                                                    zero, i.e., when all such work
                                                    items have been run.
    152  98  Bitstring    1  USEINT_VMDSTATE        Scheduler/Dispatcher State.
                                                    X'63' = Review-suspended. VMDBK
                                                    is in transition to the
                                                    suspended state. X'58' =
                                                    Review-idle. VMDBK is in
                                                    transition to the idle state.
                                                    X'4D' = VMDBK has been selected
                                                    by dispatcher for processing.
                                                    X'42' = VMDBK is ready for
                                                    selection by dispatcher once it
                                                    goes to the dispatch list.
                                                    X'37' = Test-idle. VMDBK is
                                                    ready for selection by the
                                                    dispatcher but should be
                                                    dropped from the dispatch list
                                                    when selected the next time.
                                                    X'08' = VMDBK is suspended,
                                                    probably waiting for a
                                                    short-term event to occur.
                                                    X'00' = VMDBK is idle. No work
                                                    is available.
    153  99  Bitstring    1  USEINT_CALOSTAT        Virtual machine operating
                                                    status
              1... ....      USEINT_VMDSYSOP        User is primary system
                                                    operator
              .1.. ....      USEINT_VMDUSRCT        User is counted as being
                                                    logged on
              ..1. ....      *
              ...1 ....      USEINT_VMDFORCE        User is to be logged off.
                                                    This may be requested by CP, a
                                                    forced logoff, or user's logoff
                                                    command.
              .... 1...      USEINT_VMDUFORC        User is forced to logoff the
                                                    system
              .... .1..      USEINT_VMDDISC         User is running disconnected
              .... ..1.      USEINT_VMDAUTOL        AUTOLOG/XAUTOLOG in progress.
                                                    User has been automatically
                                                    logged on. This bit is set off
                                                    when the user's IPL statement
                                                    is processed, or (if there is
                                                    no IPL to process) when the
                                                    user enters a LOGON command
                                                    from a terminal to RECONNECT.
              .... ...1      USEINT_VMDXAUTO        The original command was
                                                    XAUTOLOG. Valid for the base
                                                    VMDBK only (see
                                                    USEINT_CALBASE).
    154  9A  Bitstring    1  USEINT_CALRSTAT        Reason(s) the dispatched
                                                    VMDBK is not being run
              1... ....      *
              .1.. ....      USEINT_VMDCFWT         VMDBK is in console function
                                                    wait. Either a console function
                                                    is active, or the virtual
                                                    machine is waiting for the
                                                    remaining VMDBKs in the
                                                    configuration to enter console
                                                    function mode.
              ..1. ....      USEINT_VMDSIMWT        CP is simulating some
                                                    hardware function for the guest
                                                    such as instructions,
                                                    interrupts, and timer updates.
                                                    Virtual machine is prevented
                                                    from running to avoid potential
                                                    conflicts with the simulations.
              ...1 ....      USEINT_VMDIOWT         Instruction waiting for I/O
                                                    status for completion. (May be
                                                    cancelled without loss of
                                                    system integrity.)
              .... 1...      *
              .... .1..      *
              .... ..1.      *
              .... ...1      *
    155  9B  Bitstring    1  USEINT_CALCWAIT        Console Function Wait control
                                                    flags.
              1... ....      USEINT_VMDSTOP         virtual machine in stop
                                                    state.
              .1.. ....      USEINT_VMDSLEEP        virtual machine is sleeping.
              ..1. ....      USEINT_VMDCKST         virtual cpu in check stop
                                                    state.
              ...1 ....      USEINT_VMDDSCWT        virtual machine is in
                                                    disconnected wait mode. I/O was
                                                    attempted to the display and
                                                    the user was disconnected, so a
                                                    timer is set to log the user
                                                    off if not reconnected within
                                                    15 minutes.
              .... 1...      *
              .... .1..      *
              .... ..1.      *
              .... ...1      *
    156  9C  Unsigned     2  USEINT_VMDCPRMD(4)     Number of times this user was
                                                    was pre-emptied from the
                                                    dispatch list (Q0, Q1, Q2, Q3)
                                                    due to a requirement for
                                                    storage for E1 users
    164  A4  Unsigned     2  USEINT_VMDCWSGD(4)     Number of times this user was
                                                    removed from the dispatch list
                                                    (Q0, Q1, Q2, Q3) because it
                                                    reached its working set size
                                                    growth limit, and its new
                                                    working set size would no
                                                    longer fit available storage.
    172  AC  Unsigned     2  USEINT_VMDCETSD(4)     Number of times this user was
                                                    removed from the dispatch list
                                                    (Q0, Q1, Q2, Q3) because it
                                                    reached elapsed time slice end.
    180  B4  Unsigned     2  USEINT_VMDCIDLD(4)     Number of times this user was
                                                    removed from the dispatch list
                                                    (Q0, Q1, Q2, Q3) because its
                                                    test idle time had expired or
                                                    because it was granted no test
                                                    idle time
    188  BC  Character    8  USEINT_VMDDQTOD        Time of day clock at the time
                                                    that the VMDBK was dropped from
                                                    the dispatch list
    196  C4  Character    8  USEINT_VMDSUSCK        Time of day clock at the time
                                                    the VMDBK was last marked
                                                    suspended
    204  CC  Character    8  USEINT_VMDMTTOD        Time of day clock when the
                                                    last transaction started. Valid
                                                    for the base VMDBK only (see
                                                    USEINT_CALBASE).
    212  D4  Unsigned     4  USEINT_HFIOACT         High Frequency Count.
                                                    Cardinal number of times the
                                                    user had an asynchronous I/O
                                                    outstanding, causing the user
                                                    to be left in the dispatch
                                                    list. VMDIOACT
    216  D8  Unsigned     4  USEINT_HFLLIST         High Frequency Count. Number
                                                    of times the user was in
                                                    dispatch list waiting for CPU
                                                    but was on the Limit List,
                                                    prevented from running by max
                                                    share.
    220  DC  Unsigned     4  USEINT_HFPGACT         High Frequency Count. Number
                                                    of times the virtual machine
                                                    had page fault requests active,
                                                    but was not in page wait
                                                    (VMDWTPAG was not set). This
                                                    would occur if asynchronous
                                                    page fault was being used and
                                                    there was an outstanding page
                                                    fault, but the virtual machine
                                                    loaded a wait state because it
                                                    had no other work to do. A
                                                    virtual machine can have page
                                                    faults handled asynchronously
                                                    if using the PAGEX feature or
                                                    the Page-Fault Handshaking CP
                                                    services via the CP PFAULT
                                                    MACRO.
    224  E0  Signed       2  USEINT_VMDSLCNT        Count of minor time slices
                                                    that have expired since the
                                                    start of current transaction.
    226  E2  Unsigned     2  *                      Reserved and available for
                                                    IBM use.
    228  E4  Character    0  USEINT_END

    MRUSEINT 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
    USEINT                     0    228
    USEINT_CALBASE            1E           80
    USEINT_CALCWAIT           9B      1
    USEINT_CALFLAG            1E      1
    USEINT_CALINTRN           20      4
    USEINT_CALOSTAT           99      1
    USEINT_CALRSTAT           9A      1
    USEINT_CALTRQFL           1E           40
    USEINT_END                E4      0
    USEINT_HFCFWT             68      4
    USEINT_HFCPURN            78      4
    USEINT_HFCPUWT            74      4
    USEINT_HFDISP0            38      4
    USEINT_HFDISP1            3C      4
    USEINT_HFDISP2            40      4
    USEINT_HFDISP3            44      4
    USEINT_HFDORM             84      4
    USEINT_HFDSVM             88      4
    USEINT_HFELIG0            48      4
    USEINT_HFELIG1            4C      4
    USEINT_HFELIG2            50      4
    USEINT_HFELIG3            54      4
    USEINT_HFESVM             7C      4
    USEINT_HFIOACT            D4      4
    USEINT_HFIOWT             64      4
    USEINT_HFLLIST            D8      4
    USEINT_HFLOAD             80      4
    USEINT_HFOTHR             8C      4
    USEINT_HFPGACT            DC      4
    USEINT_HFQUCT             34      4
    USEINT_HFSIMWT            6C      4
    USEINT_HFSTCT             58      4
    USEINT_HFTIDL             5C      4
    USEINT_HFTSVM             60      4
    USEINT_HFWTPAG            70      4
    USEINT_MRHDR               0      0
    USEINT_VMDAUTOL           99           02
    USEINT_VMDCETSD           AC      8
    USEINT_VMDCFWT            9A           40
    USEINT_VMDCIDLD           B4      8
    USEINT_VMDCKST            9B           20
    USEINT_VMDCNTID           90      2
    USEINT_VMDCPRMD           9C      8
    USEINT_VMDCPUAD           1C      2
    USEINT_VMDCTIDL           92      2
    USEINT_VMDCWSGD           A4      8
    USEINT_VMDDFRWK           94      4
    USEINT_VMDDISC            99           04
    USEINT_VMDDQTOD           BC      8
    USEINT_VMDDSCWT           9B           10
    USEINT_VMDFORCE           99           10
    USEINT_VMDIOWT            9A           10
    USEINT_VMDMTTOD           CC      8
    USEINT_VMDRDYCM           32      0
    USEINT_VMDSIMWT           9A           20
    USEINT_VMDSLCNT           E0      2
    USEINT_VMDSLEEP           9B           40
    USEINT_VMDSTATE           98      1
    USEINT_VMDSTOP            9B           80
    USEINT_VMDSUSCK           C4      8
    USEINT_VMDSVMFX           24      4
    USEINT_VMDSVMID           28      8
    USEINT_VMDSVMWF           30           80
    USEINT_VMDSVMWF           31           80
    USEINT_VMDSVMWF           32           80
    USEINT_VMDSVMWT           30      1
    USEINT_VMDSVMWT           31      1
    USEINT_VMDSVMWT           32      1
    USEINT_VMDSVMW2           31      0
    USEINT_VMDSYSOP           99           80
    USEINT_VMDUFORC           99           08
    USEINT_VMDUSER            14      8
    USEINT_VMDUSRCT           99           40
    USEINT_VMDXAUTO           99           01

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

    Last updated on 11 Dec 2005 at 18:48:12.

    Copyright IBM Corporation, 1990, 2005