Skip to content

Commit 06638d8

Browse files
Merge pull request #358 from edwarddavidbaker/update-readme-umaskext
readme: Add core UMaskExt documentation
2 parents 9828091 + b4b35f4 commit 06638d8

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,19 @@ is defined architecturally. Each value corresponds to an event logic unit and sh
199199
mask value to obtain an architectural performance event.
200200
201201
### UMask
202-
This field maps to the Unit Mask filed in the `IA32_PERFEVTSELx[15:8]` MSRs. It further qualifies the event logic
202+
This field maps to the Unit Mask field in the `IA32_PERFEVTSELx[15:8]` MSRs. It further qualifies the event logic
203203
unit selected in the event select field to detect a specific micro-architectural condition.
204204
205+
### UMaskExt (Core events)
206+
This field maps to the Unit Mask 2 field in the `IA32_PERFEVTSELx[47:40]` MSRs. First introduced with architectural
207+
performance monitoring version 6.
208+
209+
> These bits qualify the condition that the selected event logic unit detects. Valid UMASK2 values for each
210+
event logic unit are specific to the unit. The new UMASK2 field may also be used in conjunction with UMASK.
211+
212+
:warning: `UMaskExt` will be renamed to `UMask2` to align with the Intel® SDM. Please refer to
213+
https://github.com/intel/perfmon/issues/357 for additional information.
214+
205215
### EventName
206216
It is a string of characters to identify the programming of an event.
207217
@@ -237,7 +247,7 @@ This is useful in event-based sampling. This field gives a recommended default o
237247
workload or tool preference.
238248
239249
### MSRIndex
240-
Additional MSRs may be required for programming certain events. This field gives the address of such MSRS.
250+
Additional MSRs may be required for programming certain events. This field gives the address of such MSRs.
241251
Examples include:
242252
* 0x3F6: MSR_PEBS_LD_LAT - used to configure the Load Latency Performance Monitoring Facility
243253
* 0x1A6/0x1A7: MSR_OFFCORE_RSP_X - used to configure the offcore response events
@@ -253,7 +263,7 @@ Applies to processors that support both precise and non-precise events in **Proc
253263
0. The event cannot be programmed to collect a PEBS record.
254264
1. The event may be programmed to collect a PEBS record, but caution is advised. For instance, PEBS collection of this event may consume limited PEBS resources whereas interrupt-based sampling may be sufficient for the usage model.
255265
2. The event may be programmed to collect a PEBS record, and due to the nature of the event, PEBS collection may be preferred. For instance,
256-
PEBS collection of Goldmont's `HW_INTERUPTS.RECIEVED` event is recommended because the hardware interrupt being counted may lead to the masking of
266+
PEBS collection of Goldmont's `HW_INTERRUPTS.RECEIVED` event is recommended because the hardware interrupt being counted may lead to the masking of
257267
interrupts which would interfere with interrupt-based sampling.
258268
3. The event must be programmed to collect a PEBS record.
259269

0 commit comments

Comments
 (0)