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

#### MRPRCAPM

Prolog
Control Block Contents
Cross Reference

#### MRPRCAPM Prolog

     DSECT NAME - PRCAPM
     FUNCTION - Map a Monitor record.
     LOCATED BY -
            Through the Monitor Control Area
     REFERENCED CONTROL BLOCKS -
            MRRECHDR    Monitor Record Header
     NAME - MRPRCAPM
     DESCRIPTIVE NAME - Monitor Sample Record
                        Domain 5  - Processor Domain
                        Record 10 - Crypto performance measurement data
     DESCRIPTION - Provides counters and timers for transactions on the
                   PCI crypto cards.  One or more records are
                   generated to include all of the information for
                   the processor configuration. Each record contains
                   a list of Crypto Measurement Blocks (CMBs) for
                   each AP in the processor configuration.

                   When the P bit is 1, one or more additional monitor
                   records are generated in the same interval with
                   the P bit = 1 in each interim record and the
                   P bit = 0 in the final record. Each record contains
                   a set of complete CMBs; CMBs are not split between
                   one record and the next.
     NOTES:
       - This record is generated only if PCI crypto cards are installed
         on the system.
       - This record is a mapping of data provided directly from the
         hardware.
       - This record is not generated if the HMC Global Performance
         Data setting is disabled.

#### MRPRCAPM Control Block Contents

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

      0   0  Structure   40+ PRCAPM                 Start of monitor record
      0   0  Character    0  PRCAPM_MRHDR           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    4  *                      Reserved for IBM use
    The store-crypto-measurement-data command-response block follows. The
    fixed-length data starts here.

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

     24  18  Unsigned     2  PRCAPM_L2              Unsigned integer specifying
                                                    the length in bytes of the
                                                    command response block
     26  1A  Unsigned     2  PRCAPM_RC              Unsigned integer specifying
                                                    the response code from the
                                                    store crypto-measurement-data
                                                    command
     28  1C  Character    4  *                      Reserved/zeroes
     32  20  Unsigned     4  *
              1... ....      PRCAPM_P               P bit: when P=0, the entire
                                                    response is returned, when P=1,
                                                    a partial response is returned
              .1.. ....      *
              ..1. ....      *
              ...1 ....      *
              .... 1...      *
              .... .1..      *
              .... ..1.      *
              .... ...1      *
     32  20  Character    3  *                      Reserved/zeroes
     36  24  Character    4  *                      Reserved/zeroes
    The variable data contains a crypto-measurement-block (CMB) list which
    contains one or more CMBs. The length of the command response block
    including both the fixed-length data and the variable length data is
    specified by the PRCAPM_L2 field. The length of the variable data
    depends on the type of AP (determined by the PRCAPM_CT field in the
    CMB header) and the number of APs installed.

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

     40  28  Character    0  PRCAPM_VAR_DATA        Start of variable length data
    CMB entry for type 9 APs (CEX3C).

    This AP type has just one crypto engine.

    This mapping is also used for crypto type (CT) 10,11,12,13
    and 14 when mapping type (MT) is 9.
    (PRCAPM_CT = 10,11,12,13 or 14 and PRCAPM_MT=9.)

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

      0   0  Structure   64  PRCAPM_CMB1
      0   0  Character   16  PRCAPM_CMB1HDR
      0   0  Bitstring    1  *                      Reserved/zeroes
      1   1  Bitstring    1  PRCAPM_CT              Crypto type
                                                       8  = CEX3A
                                                       9  = CEX3C
                                                       10 = CEX4S
                                                       11 = CEX5S
                                                       12 = CEX6S
                                                       13 = CEX7S
                                                       14 = CEX8S
      2   2  Bitstring    1  PRCAPM_FMT             Format - must be zero
      3   3  Bitstring    1  PRCAPM_APAX            AP index - Max value of
              1... ....      *                      63 unless hardware supports
              .1.. ....      *                      a larger max value of 255
              ..xx xxxx      PRCAPM_AX
      4   4  Unsigned     4  PRCAPM_S               32-bit binary floating point
                                                    value indicating the stepping
                                                    interval, in seconds, of the
                                                    timers
      8   8  Unsigned     4  PRCAPM_V               32-bit mask indicating the
                                                    validity of each timer-counter
                                                    pair
     12   C  Unsigned     1  *                      Reserved/zeroes
     13   D  Unsigned     1  PRCAPM_MT              Mapping Type
                                                    Zero for Crypto Types 8-9.
                                                    For Crypto Types 10-14:
                                                    MT = 8 for Accelerator Mode
                                                    MT = 9 for Co-processor Mode
                                                    MT = 10 for XCP Mode
                                                    When MT is not zero,
                                                    the MT determines the format of
                                                    the CMB starting with word 4.
                                                    The format of the CMB is
                                                    the same as the format of the
                                                    CMB for the Crypto Type which
                                                    is equivalent to the Mapping
                                                    Type.
     14   E  Unsigned     2  PRCAPM_L4              CMB Length in bytes
                                                    If zero, use the default lengths:
                                                    CT = 8              80 bytes
                                                    CT = 9              64 bytes
                                                    CT = 10-14 L4 will be non-zero
     16  10  Character    8  PRCAPM_CMB1_T0         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of all
                                                    operations on the AP
     24  18  Character    8  PRCAPM_CMB1_C0         64-bit unsigned integer
                                                    counter of the number of all
                                                    operations on the AP
     32  20  Character    8  PRCAPM_CMB1_T1         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of RSA-key-
                                                    generation operations on the AP
     40  28  Character    8  PRCAPM_CMB1_C1         64-bit unsigned integer
                                                    counter of the number of RSA-
                                                    key-generation operations on
                                                    the AP
     48  30  Character   16  *                      Reserved/zeroes
    CMB entry for 8 APs (CEX3A).

    This AP has just one crypto.

    This mapping is also used for cryto type (CT) 10,11,12,13
    and 14 when mapping type (MT) is 8.
    (PRCAPM_CT = 10,11,12,13 or 14 and PRCAPM_MT=8)

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

      0   0  Structure  112  PRCAPM_CMB3
      0   0  Character   16  PRCAPM_CMB3HDR
      0   0  Bitstring    1  *                      Reserved/zeroes
      1   1  Bitstring    1  PRCAPM_CT              Crypto type
                                                       8  = CEX3A
                                                       9  = CEX3C
                                                       10 = CEX4S
                                                       11 = CEX5S
                                                       12 = CEX6S
                                                       13 = CEX7S
                                                       14 = CEX8S
      2   2  Bitstring    1  PRCAPM_FMT             Format - must be zero
      3   3  Bitstring    1  PRCAPM_APAX            AP index - Max value of
              1... ....      *                      63 unless hardware supports
              .1.. ....      *                      a larger max value of 255
              ..xx xxxx      PRCAPM_AX
      4   4  Unsigned     4  PRCAPM_S               32-bit binary floating point
                                                    value indicating the stepping
                                                    interval, in seconds, of the
                                                    timers
      8   8  Unsigned     4  PRCAPM_V               32-bit mask indicating the
                                                    validity of each timer-counter
                                                    pair
     12   C  Unsigned     1  *                      Reserved/zeroes
     13   D  Unsigned     1  PRCAPM_MT              Mapping Type
                                                    Zero for Crypto Types 8-9.
                                                    For Crypto Types 10-14:
                                                    MT = 8 for Accelerator Mode
                                                    MT = 9 for Co-processor Mode
                                                    MT = 10 for XCP Mode
                                                    When MT is not zero,
                                                    the MT determines the format of
                                                    the CMB starting with word 4.
                                                    The format of the CMB is
                                                    the same as the format of the
                                                    CMB for the Crypto Type which
                                                    is equivalent to the Mapping
                                                    Type.
     14   E  Unsigned     2  PRCAPM_L4              CMB Length in bytes
                                                    If zero, use the default lengths:
                                                    CT = 8              80 bytes
                                                    CT = 9              64 bytes
                                                    CT = 10-14 L4 will be non-zero
    Timer-counter pairs for crypto engine-0

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

     16  10  Character    8  PRCAPM_CMB3_T0         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 1024-bit ME-format RSA
                                                    operations
     24  18  Character    8  PRCAPM_CMB3_C0         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0 for
                                                    1024-bit ME-format RSA
                                                    operations
     32  20  Character    8  PRCAPM_CMB3_T1         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 2048-bit ME-format RSA
                                                    operations
     40  28  Character    8  PRCAPM_CMB3_C1         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0 for
                                                    2048-bit ME-format RSA
                                                    operations
     48  30  Character    8  PRCAPM_CMB3_T2         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 1024-bit CRT-format RSA
                                                    operations
     56  38  Character    8  PRCAPM_CMB3_C2         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0 for
                                                    1024-bit CRT-format RSA
                                                    operations
     64  40  Character    8  PRCAPM_CMB3_T3         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 2048-bit CRT-format RSA
                                                    operations
     72  48  Character    8  PRCAPM_CMB3_C3         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0 for
                                                    2048-bit CRT-format RSA
                                                    operations
     80  50  Character    8  PRCAPM_CMB3_T4         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 4096-bit ME-format RSA
                                                    operations
                                                    (not available for type 6
                                                    APs)
     88  58  Character    8  PRCAPM_CMB3_C4         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0
                                                    for 4096-bit ME-format RSA
                                                    operations.
                                                    (not available for type 6
                                                    APs)
     96  60  Character    8  PRCAPM_CMB3_T5         64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time on AP engine-0
                                                    for 4096-bit CRT-format RSA
                                                    operations
                                                    (not available for type 6
                                                    APs)
    104  68  Character    8  PRCAPM_CMB3_C5         64-bit unsigned integer
                                                    counter of the number of
                                                    operations on AP engine-0
                                                    for 4096-bit CRT-format RSA
                                                    operations.
                                                    (not available for type 6
                                                    APs)
    CMB entry for crypto type (CT) 10, 11, 12, 13, and 14 APs,
    when mapping type(MT)=10
    (PRCAPM_CT = 10,11,12,13 or 14 and PRCAPM_MT=10)

    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

      0   0  Structure   96  PRCAPM_CMB10
      0   0  Character   16  PRCAPM_CMB10HDR
      0   0  Bitstring    1  *                      Reserved/zeroes
      1   1  Bitstring    1  PRCAPM_CT              Crypto type
                                                       8  = CEX3A
                                                       9  = CEX3C
                                                       10 = CEX4S
                                                       11 = CEX5S
                                                       12 = CEX6S
                                                       13 = CEX7S
                                                       14 = CEX8S
      2   2  Bitstring    1  PRCAPM_FMT             Format - must be zero
      3   3  Bitstring    1  PRCAPM_APAX            AP index - Max value of
              1... ....      *                      63 unless hardware supports
              .1.. ....      *                      a larger max value of 255
              ..xx xxxx      PRCAPM_AX
      4   4  Unsigned     4  PRCAPM_S               32-bit binary floating point
                                                    value indicating the stepping
                                                    interval, in seconds, of the
                                                    timers
      8   8  Unsigned     4  PRCAPM_V               32-bit mask indicating the
                                                    validity of each timer-counter
                                                    pair
     12   C  Unsigned     1  *                      Reserved/zeroes
     13   D  Unsigned     1  PRCAPM_MT              Mapping Type
                                                    Zero for Crypto Types 8-9.
                                                    For Crypto Types 10-14:
                                                    MT = 8 for Accelerator Mode
                                                    MT = 9 for Co-processor Mode
                                                    MT = 10 for XCP Mode
                                                    When MT is not zero,
                                                    the MT determines the format of
                                                    the CMB starting with word 4.
                                                    The format of the CMB is
                                                    the same as the format of the
                                                    CMB for the Crypto Type which
                                                    is equivalent to the Mapping
                                                    Type.
     14   E  Unsigned     2  PRCAPM_L4              CMB Length in bytes
                                                    If zero, use the default lengths:
                                                    CT = 8              80 bytes
                                                    CT = 9              64 bytes
                                                    CT = 10-14 L4 will be non-zero
    Offsets
    Dec Hex  Type       Len  Name (Dim)             Description

     16  10  Character    8  PRCAPM_CMB10_T0        64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of slow
                                                    asymmetric-key functions
     24  18  Character    8  PRCAPM_CMB10_C0        64-bit unsigned integer
                                                    counter of the number of
                                                    slow asymmetric-key functions
     32  20  Character    8  PRCAPM_CMB10_T1        64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of fast
                                                    asymmetric-key functions
     40  28  Character    8  PRCAPM_CMB10_C1        64-bit unsigned integer
                                                    counter of the number of
                                                    fast asymmetric-key functions
     48  30  Character    8  PRCAPM_CMB10_T2        64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of
                                                    symmetric-key functions
                                                    that return partial or
                                                    incremental results
     56  38  Character    8  PRCAPM_CMB10_C2        64-bit unsigned integer
                                                    counter of the number of
                                                    operations by symetric-key
                                                    funtions that return partial
                                                    or incremental results
     64  40  Character    8  PRCAPM_CMB10_T3        64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time of
                                                    symmetric-key functions
                                                    that return a complete or
                                                    final result.
     72  48  Character    8  PRCAPM_CMB10_C3        64-bit unsigned integer
                                                    counter of the number of
                                                    operations by symetric-key
                                                    funtions that return a
                                                    complete or final result.
     80  48  Character    8  PRCAPM_CMB10_T4        64-bit unsigned integer timer
                                                    value that measures the
                                                    execution time by an
                                                    asymmetric-key generation
                                                    function.
     88  58  Character    8  PRCAPM_CMB10_C4        64-bit unsigned integer
                                                    counter of the number of
                                                    operations by an
                                                    asymmetric-key generation
                                                    function.

#### MRPRCAPM 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
    PRCAPM                     0     40+
    PRCAPM_APAX                3      1
    PRCAPM_AX                  3      1
    PRCAPM_CMBHDR              0     16
    PRCAPM_CMB1                0     64
    PRCAPM_CMB1_C0            18      8
    PRCAPM_CMB1_C1            28      8
    PRCAPM_CMB1_T0            10      8
    PRCAPM_CMB1_T1            20      8
    PRCAPM_CMB1HDR             0     16
    PRCAPM_CMB2                0    336
    PRCAPM_CMB2_C0            18      8
    PRCAPM_CMB2_C1            28      8
    PRCAPM_CMB2_C10           B8      8
    PRCAPM_CMB2_C11           C8      8
    PRCAPM_CMB2_C12           D8      8
    PRCAPM_CMB2_C13           E8      8
    PRCAPM_CMB2_C14           F8      8
    PRCAPM_CMB2_C15          108      8
    PRCAPM_CMB2_C16          118      8
    PRCAPM_CMB2_C17          128      8
    PRCAPM_CMB2_C18          138      8
    PRCAPM_CMB2_C19          148      8
    PRCAPM_CMB2_C2            38      8
    PRCAPM_CMB2_C3            48      8
    PRCAPM_CMB2_C4            58      8
    PRCAPM_CMB2_C5            68      8
    PRCAPM_CMB2_C6            78      8
    PRCAPM_CMB2_C7            88      8
    PRCAPM_CMB2_C8            98      8
    PRCAPM_CMB2_C9            A8      8
    PRCAPM_CMB2_T0            10      8
    PRCAPM_CMB2_T1            20      8
    PRCAPM_CMB2_T10           B0      8
    PRCAPM_CMB2_T11           C0      8
    PRCAPM_CMB2_T12           D0      8
    PRCAPM_CMB2_T13           E0      8
    PRCAPM_CMB2_T14           F0      8
    PRCAPM_CMB2_T15          100      8
    PRCAPM_CMB2_T16          110      8
    PRCAPM_CMB2_T17          120      8
    PRCAPM_CMB2_T18          130      8
    PRCAPM_CMB2_T19          140      8
    PRCAPM_CMB2_T2            30      8
    PRCAPM_CMB2_T3            40      8
    PRCAPM_CMB2_T4            50      8
    PRCAPM_CMB2_T5            60      8
    PRCAPM_CMB2_T6            70      8
    PRCAPM_CMB2_T7            80      8
    PRCAPM_CMB2_T8            90      8
    PRCAPM_CMB2_T9            A0      8
    PRCAPM_CMB2HDR             0     16
    PRCAPM_CMB3                0    112
    PRCAPM_CMB3_C0            18      8
    PRCAPM_CMB3_C1            28      8
    PRCAPM_CMB3_C2            38      8
    PRCAPM_CMB3_C3            48      8
    PRCAPM_CMB3_C4            58      8
    PRCAPM_CMB3_C5            68      8
    PRCAPM_CMB3_T0            10      8
    PRCAPM_CMB3_T1            20      8
    PRCAPM_CMB3_T2            30      8
    PRCAPM_CMB3_T3            40      8
    PRCAPM_CMB3_T4            50      8
    PRCAPM_CMB3_T5            60      8
    PRCAPM_CMB3HDR             0     16
    PRCAPM_CMB10               0     96
    PRCAPM_CMB10_C0           18      8
    PRCAPM_CMB10_C1           28      8
    PRCAPM_CMB10_C2           38      8
    PRCAPM_CMB10_C3           48      8
    PRCAPM_CMB10_C4           58      8
    PRCAPM_CMB10_T0           10      8
    PRCAPM_CMB10_T1           20      8
    PRCAPM_CMB10_T2           30      8
    PRCAPM_CMB10_T3           40      8
    PRCAPM_CMB10_T4           50      8
    PRCAPM_CMB10HDR            0     16
    PRCAPM_CT                  1      1
    PRCAPM_FMT                 2      1
    PRCAPM_L2                 18      2
    PRCAPM_L4                  E      2
    PRCAPM_MRHDR               0      0
    PRCAPM_MT                  D      1
    PRCAPM_P                  1A           80
    PRCAPM_RC                 1A      2
    PRCAPM_S                   4      4
    PRCAPM_V                   8      4
    PRCAPM_VAR_DATA           28      0

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

    Last updated on 21 April 2022 at 13:57:52.

    Copyright IBM Corporation, 1990, 2022