HISMTHDR Back to Index page
 
Prolog 
Control Block Contents 
   HisMTHdr DSECT
   HisMTDsc DSECT
   HisMTEnt DSECT
Storage Layout 
Cross Reference (Contains links to field and bit definitions)
Programming Interface Information:
This information is NOT intended to be
used as Programming Interfaces of z/VM.

 
  HISMTHDR Control Block Content Top of page
 

 HisMTHdr DSECT Top of page
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure HisMTHdr HISMT Service Interval Area *02* ACRONYM: N/A 0000 0 Character 8 HisMT_Hdr_EyeCatcher Will be 'HISMT ' after the first HISMT call. 0000 0 Character 1 HisMT_Hdr_EyeCatcherFirstChar On the first HISMT call for a new interval area, this field must contain binary zeroes. 0008 8 Signed 4 HisMT_Hdr_LengthRequired Length of storage required for the request to complete successfully. 000C 12 Bitstring 1 HisMTFlg Flags for config change reasons. One or more of these flags will be ON if reason code returned is HisMT_kRsnWarn_ConfigChange. For all other return and reason codes, these flags will be turned OFF. 1... .... HisMT_Hdr_SpeedChanged_CPEngine X'80' .1.. .... HisMT_Hdr_SpeedChanged_SpecialtyEngine X'40' ..1. .... HisMT_Hdr_MTModeChanged_CP X'20' ...1 .... HisMT_Hdr_MTModeChanged_zIIP X'10' .... 1... HisMT_Hdr_MTModeChanged_zAAP X'08' .... .1.. HisMT_Hdr_MTModeChanged_ICF X'04' .... ..1. HisMT_Hdr_MTModeChanged_IFL X'02' .... ...1 HisMT_Hdr_MTConfigChanged X'01' 000D 13 Character 3 HisMT_Hdr_Rsv00D Reserved 0010 16 Character 8 HisMT_Hdr_Timestamp Timestamp, the time (in STCK format) when the system captured the data. 0018 24 Character 16 HisMT_Hdr_ProdClass_Desc Locates array of productivity values for each processor class. This storage is mapped by DSECT HisMT_Desc. 0028 40 Character 16 HisMT_Hdr_ProdCore_Desc Locates array of productivity values for each core. This storage is mapped by DSECT HisMT_Desc. 0038 56 Character 16 HisMT_Hdr_CapClass_Desc Locates array of capacity factor values for each processor class. This storage is mapped by DSECT HisMT_Desc. 0048 72 Character 16 HisMT_Hdr_MaxCapClass_Desc Locates array of max capacity factor values for each processor class. This storage is mapped by DSECT HisMT_Desc. 0058 88 Character 16 HisMT_Hdr_CbfClass_Desc Locates array of CBF values for each processor class. This storage is mapped by DSECT HisMT_Desc. This field is for IBM use only. 0068 104 Character 16 HisMT_Hdr_CbfAN_Desc Locates array of charge back factor values for each AN. This storage is mapped by DSECT HisMT_Desc. This field is for IBM use only. 0078 120 Character 16 HisMT_Hdr_ClassBusyTime_Desc Locates array of busy time values per processor class. This storage is mapped by DSECT HisMT_Desc. 0088 136 Character 16 HisMT_Hdr_CoreBusyTime_Desc Locates array of core busy time values for each core. This storage is mapped by DSECT HisMT_Desc. 0098 152 Character 16 HisMT_Hdr_AvgTDClass_Desc Locates array of average thread density values for each processor class. This storage is mapped by DSECT HisMT_Desc. 00A8 168 Character 16 HisMT_Hdr_AvgTDCore_Desc Locates array of average thread density values per core. This storage is mapped by DSECT HisMT_Desc. 00B8 184 Character 16 HisMT_Hdr_CoreCountClass_Desc Locates array of counts of cores per processor class. This storage is mapped by DSECT HisMT_Desc. 00C8 200 Character 16 HisMT_Hdr_IntervalClass_Desc Locates array of interval times per processor class. This storage is mapped by DSECT HisMT_Desc. 00D8 216 Character 16 HisMT_Hdr_IntervalCore_Desc Locates array of interval times per core. This storage is mapped by DSECT HisMT_Desc. 00E8 232 Character 16 HisMT_Hdr_ThreadsClass_Desc Locates array of configured threads per core for each processor class. This storage is mapped by DSECT HisMT_Desc. 00F8 248 Signed 4 HisMT_Hdr_PreservableAreaOffset Offset to the preservable work area relative to the start of HisMT_Hdr. This field is for IBM use only, only in HCPHIS. 00FC 252 Signed 4 HisMT_Hdr_PreservableAreaLength The length of the preservable work area. This field is for IBM use only, only in HCPHIS. 0100 256 Signed 4 HisMT_Hdr_SystemAreaOffset Offset to the system work area relative to the start of HisMT_Hdr. This field is for IBM use only. Used only within HCPHIS. 0104 260 Signed 4 HisMT_Hdr_SystemAreaLength The length of the system work area. This field is for IBM use only. Used only within HCPHIS. 0108 264 Character 16 HisMT_Hdr_Rsv0A8 Reserved 0118 280 Character 1 HisMT_Hdr_End (0) 00000118 HisMT_Hdr_Len *-HisMTHdr ***The HISMT descriptor locates data associated with each HISMT ***metric requested via the HISMT service. ***The descriptor has an offset to the array containing HISMT data. ***Add HisMT_Desc_EntryLength to the current entry to get to the ***next entry in the array when iterating through the array entries.
 HisMTDsc DSECT Top of page
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure HisMTDsc HISMT Service Interval Area *02* ACRONYM: N/A 0000 0 Signed 4 HisMT_Desc_Offset Offset to the array relative to the start of the interval area. 0004 4 Signed 4 HisMT_Desc_Count The number of entries in the array. 0008 8 Signed 4 HisMT_Desc_EntryLength The length of a single entry in the array. Use this when iterating through the entries instead of compile time lengths. The offset to the nth entry from the start of the array is ((n-1)*HisMT_D esc_EntryLength). 000C 12 Character 4 HisMT_Desc_Rsv00C Reserved 0010 16 Character 1 HisMT_Desc_End (0) 00000010 HisMT_Desc_Len *-HisMTDsc
 HisMTEnt DSECT Top of page
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure HisMTEnt HISMT Service Interval Area *02* ACRONYM: N/A 0000 0 Signed 4 HisMT_Entry_Metric Metric value requested 0004 4 Character 1 HisMT_Entry_End (0) ***HISMT Constants 00C9E2D4 HisMT_Hdr_kEyeCatcher_0TO3 C'HISM' This is the first 4-byte segment of an 8-byte constant. 00404040 HisMT_Hdr_kEyeCatcher_4TO7 C'T ' This is the second 4-byte segment of an 8-byte constant. 00000118 HisMT_Hdr_kLength 280 Length of the header block for the interval area. ***HISMT Return/Reason Codes *** o It is guaranteed that no reason code will be reused (i.e. *** the same reason code will not be used for more than one *** return code). *** o Note carefully that bits 0-15 of the reason code may contain *** component-diagnostic data and must not be assumed to be *** 0. 0000FFFF HisMT_kRsnCodeMask 65535 Use this mask to isolate the non component-diagnostic portion of the reason code. HISMTReturn and Reason Code definitions .... .... HisMT_kRetOk X'00000000' Meaning: HISMT request completed successfully. Action: None required. .... .1.. HisMT_kRetWarn X'00000004' Meaning: Warning Action: HISMT request completed with a warning. 00000401 HisMT_kRsnWarn_IntvAreaSmall X'00000401' Meaning: The interval area provided was large enough to hold the minimum amount of data required for the request, but not large enough to hold all of the data requested. Action: Obtain a larger interval area using the HisMT_Hdr_LengthRequired field returned in the request's INTVAREA. Then call the service with the newly allocated interval area. (See Programming Requirements for the protocol for passing a new interval area that is at least HisMT_Hdr_LengthRequired bytes long) 00000402 HisMT_kRsnWarn_ConfigChanged X'00000402' Meaning: The system configuration was changed during the interval between the last HISMT call and the current HISMT call. The metric values returned in the interval area is questionable since the config was not consistent during the interval. See field HisMTFlg in the interval area header for what has changed. Action: The metric values returned from this call can be ignored. .... 1... HisMT_kRetUser X'00000008' Meaning: HISMT request failed due to a user error. Action: Refer to the action provided with the specific reason code. 00000801 HisMT_kRsnUser_InvVersion X'00000801' Meaning: The version for the parameter list specified is not valid. Action: Check for possible storage overlay. 00000802 HisMT_kRsnUser_InconsistentIntvArea X'00000802' Meaning: The HISMT call for this interval does not match the previous HISMT call for the provided interval area. Action: If this is the first invocation for this interval area, follow the protocol described in the HISMT service's Programming Requirements section to provide an interval area. If this is a subsequent call to HISMT for the interval area, make sure all subsequent calls to HISMT with that interval area request the same data. 00000803 HisMT_kRsnUser_IntvLenTooSmall X'00000803' Meaning: The interval area is less than HisMT_Hdr_kLength bytes. Action: Ensure the interval area length and the storage provided for the interval area is at least HisMT_Hdr_kLength bytes long. (See Programming Requirements for the protocol for obtaining big enough storage to contain the requested MT metrics) 00000804 HisMT_kRsnUser_UnknownDataInIntvArea X'00000804' Meaning: The interval area for this HISMT call contains some unexpected data. A storage overlay may have occured. Action: Issue HISMT request with a new interval area. 00000805 HisMT_kRsnUser_IntvAreaNotAligned X'00000805' Meaning: The interval area provided for this HISMT call is not on a doubleword boundary. Action: Make sure that the interval area is on a doubleword boundary. 00000806 HisMT_kRsnUser_IntvLenNot8ByteMultiple X'00000806' Meaning: The interval area length provided for this HISMT call is not a multiple of 8-bytes. Action: Provide an interval area whose length is an 8-byte multiple. 00000807 HisMT_kRsnUser_UnknownEyeCatcher X'00000807' Meaning: The eye catcher in the interval area for this HISMT call is unexpected. A storage overlay may have occured. Action: Issue a HISMT request with a new interval area. The first byte must contain binary zeroes. ...1 .... HisMT_kRetUnknown X'00000010' Meaning: Unexpected failure. Action: Refer to the action provided with the specific reason code. 00001001 HisMT_kRsnUnknown_Unknown X'00001001' Meaning: Unexpected failure. The state of the request is unpredictable. Action: Contact your system programmer. 00000004 HisMT_Entry_Len *-HisMTEnt
 
 
  HISMTHDR Storage Layout Top of page
 
          
*** HisMTHdr - HISMT Service Interval Area *02* ACRONYM: N/A
*
*     +-------------------------------------------------------+
*   0 |                 HISMT_HDR_EYECATCHER                  |
*     +-------------------------------------------------------+
*   8
*
*** HisMTHdr - HISMT Service Interval Area *02* ACRONYM: N/A
          
*** Overlay for HisMT_Hdr_EyeCatcher in HisMTHdr
*
*     +------+
*   0 |(000) | 1
*     +------+
*
*** Overlay for HisMT_Hdr_EyeCatcher in HisMTHdr
          
*** Overlay for HisMT_Hdr_EyeCatcher+8 in HisMTHdr
*
*     +---------------------------+------+--------------------+
*   8 | HISMT_HDR_LENGTHREQUIRED  |:MTFLG| HISMT_HDR_RSV00D   |
*     +---------------------------+------+--------------------+
*  10 |                 HISMT_HDR_TIMESTAMP                   |
*     +-------------------------------------------------------+
*  18 |               HISMT_HDR_PRODCLASS_DESC                |
*     |                                                       |
*     +-------------------------------------------------------+
*  28 |               HISMT_HDR_PRODCORE_DESC                 |
*     |                                                       |
*     +-------------------------------------------------------+
*  38 |               HISMT_HDR_CAPCLASS_DESC                 |
*     |                                                       |
*     +-------------------------------------------------------+
*  48 |              HISMT_HDR_MAXCAPCLASS_DESC               |
*     |                                                       |
*     +-------------------------------------------------------+
*  58 |               HISMT_HDR_CBFCLASS_DESC                 |
*     |                                                       |
*     +-------------------------------------------------------+
*  68 |                 HISMT_HDR_CBFAN_DESC                  |
*     |                                                       |
*     +-------------------------------------------------------+
*  78 |             HISMT_HDR_CLASSBUSYTIME_DESC              |
*     |                                                       |
*     +-------------------------------------------------------+
*  88 |             HISMT_HDR_COREBUSYTIME_DESC               |
*     |                                                       |
*     +-------------------------------------------------------+
*  98 |              HISMT_HDR_AVGTDCLASS_DESC                |
*     |                                                       |
*     +-------------------------------------------------------+
*  A8 |               HISMT_HDR_AVGTDCORE_DESC                |
*     |                                                       |
*     +-------------------------------------------------------+
*  B8 |            HISMT_HDR_CORECOUNTCLASS_DESC              |
*     |                                                       |
*     +-------------------------------------------------------+
*  C8 |             HISMT_HDR_INTERVALCLASS_DESC              |
*     |                                                       |
*     +-------------------------------------------------------+
*  D8 |             HISMT_HDR_INTERVALCORE_DESC               |
*     |                                                       |
*     +-------------------------------------------------------+
*  E8 |             HISMT_HDR_THREADSCLASS_DESC               |
*     |                                                       |
*     +---------------------------+---------------------------+
*  F8 |:MT_HDR_PRESERVABLEAREAOFF>|:MT_HDR_PRESERVABLEAREALEN>|
*     +---------------------------+---------------------------+
* 100 |HISMT_HDR_SYSTEMAREAOFFSET |HISMT_HDR_SYSTEMAREALENGTH |
*     +---------------------------+---------------------------+
* 108 |                   HISMT_HDR_RSV0A8                    |
*     |                                                       |
*     +-------------------------------------------------------+
*
*** Overlay for HisMT_Hdr_EyeCatcher+8 in HisMTHdr
          
*** HisMTDsc - HISMT Service Interval Area *02* ACRONYM: N/A
*
*     +---------------------------+---------------------------+
*   0 |    HISMT_DESC_OFFSET      |     HISMT_DESC_COUNT      |
*     +---------------------------+---------------------------+
*   8 |  HISMT_DESC_ENTRYLENGTH   |    HISMT_DESC_RSV00C      |
*     +---------------------------+---------------------------+
*
*** HisMTDsc - HISMT Service Interval Area *02* ACRONYM: N/A
          
*** HisMTEnt - HISMT Service Interval Area *02* ACRONYM: N/A
*
*     +---------------------------+
*   0 |    HISMT_ENTRY_METRIC     |
*     +---------------------------+
*
*** HisMTEnt - HISMT Service Interval Area *02* ACRONYM: N/A
 
 
  HISMTHDR Cross Reference Top of page
 
 
Symbol         Dspl Value
-------------- ---- -----
HisMT_kRetOk   0004 00
HisMT_kRetUnknown
               0004 10
HisMT_kRetUser
               0004 08
HisMT_kRetWarn
               0004 04
HisMT_kRsnCodeMask
               0004 0000FFFF
HisMT_kRsnUnknown_Unknown
               0004 00001001
HisMT_kRsnUser_InvVersion
               0004 00000801
HisMT_kRsnUser_InconsistentIntvArea
               0004 00000802
HisMT_kRsnUser_IntvLenTooSmall
               0004 00000803
HisMT_kRsnUser_UnknownDataInIntvArea
               0004 00000804
HisMT_kRsnUser_IntvAreaNotAligned
               0004 00000805
HisMT_kRsnUser_IntvLenNot8ByteMultiple
               0004 00000806
HisMT_kRsnUser_UnknownEyeCatcher
               0004 00000807
HisMT_kRsnWarn_IntvAreaSmall
               0004 00000401
HisMT_kRsnWarn_ConfigChanged
               0004 00000402
HisMT_Desc_Count
               0004
HisMT_Desc_End
               0010
HisMT_Desc_EntryLength
               0008
HisMT_Desc_Len
               0010 00000010
HisMT_Desc_Offset
               0000
HisMT_Desc_Rsv00C
               000C
HisMT_Entry_End
               0004
HisMT_Entry_Len
               0004 00000004
HisMT_Entry_Metric
               0000
HisMT_Hdr_kEyeCatcher_0TO3
               0004 00C9E2D4
HisMT_Hdr_kEyeCatcher_4TO7
               0004 00404040
HisMT_Hdr_kLength
               0004 00000118
HisMT_Hdr_AvgTDClass_Desc
               0098
HisMT_Hdr_AvgTDCore_Desc
               00A8
HisMT_Hdr_CapClass_Desc
               0038
HisMT_Hdr_CbfAN_Desc
               0068
HisMT_Hdr_CbfClass_Desc
               0058
HisMT_Hdr_ClassBusyTime_Desc
               0078
HisMT_Hdr_CoreBusyTime_Desc
               0088
HisMT_Hdr_CoreCountClass_Desc
               00B8
HisMT_Hdr_End  0118
HisMT_Hdr_EyeCatcher
               0000
HisMT_Hdr_EyeCatcherFirstChar
               0000
HisMT_Hdr_IntervalClass_Desc
               00C8
HisMT_Hdr_IntervalCore_Desc
               00D8
HisMT_Hdr_Len  0118 00000118
HisMT_Hdr_LengthRequired
               0008
HisMT_Hdr_MaxCapClass_Desc
               0048
HisMT_Hdr_MTConfigChanged
               000C 01
HisMT_Hdr_MTModeChanged_CP
               000C 20
HisMT_Hdr_MTModeChanged_zIIP
               000C 10
HisMT_Hdr_MTModeChanged_zAAP
               000C 08
HisMT_Hdr_MTModeChanged_ICF
               000C 04
HisMT_Hdr_MTModeChanged_IFL
               000C 02
HisMT_Hdr_PreservableAreaOffset
               00F8
HisMT_Hdr_PreservableAreaLength
               00FC
HisMT_Hdr_ProdClass_Desc
               0018
HisMT_Hdr_ProdCore_Desc
               0028
HisMT_Hdr_Rsv0A8
               0108
HisMT_Hdr_Rsv00D
               000D
HisMT_Hdr_SpeedChanged_CPEngine
               000C 80
HisMT_Hdr_SpeedChanged_SpecialtyEngine
               000C 40
HisMT_Hdr_SystemAreaOffset
               0100
HisMT_Hdr_SystemAreaLength
               0104
HisMT_Hdr_ThreadsClass_Desc
               00E8
HisMT_Hdr_Timestamp
               0010
HisMTFlg       000C
 
This information is based on z/VM 7.2.0 Last updated on 24 Jun 2020 at 09:32:00 EDT.
Copyright IBM Corporation, 1990, 2020