2 Intel Processor Trace feature.
4 Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "CpuCommonFeatures.h"
18 /// This macro define the max entries in the Topa table.
19 /// Each entry in the table contains some attribute bits, a pointer to an output region, and the size of the region.
20 /// The last entry in the table may hold a pointer to the next table. This pointer can either point to the top of the
21 /// current table (for circular array) or to the base of another table.
22 /// At least 2 entries are needed because the list of entries must
23 /// be terminated by an entry with the END bit set to 1, so 2
24 /// entries are required to use a single valid entry.
26 #define MAX_TOPA_ENTRY_COUNT 2
30 /// Processor trace output scheme selection.
33 RtitOutputSchemeSingleRange
= 0,
38 BOOLEAN ProcTraceSupported
;
39 BOOLEAN TopaSupported
;
40 BOOLEAN SingleRangeSupported
;
41 } PROC_TRACE_PROCESSOR_DATA
;
44 UINT32 NumberOfProcessors
;
46 UINT8 ProcTraceOutputScheme
;
47 UINT32 ProcTraceMemSize
;
49 UINTN
*ThreadMemRegionTable
;
50 UINTN AllocatedThreads
;
53 UINTN TopaMemArrayCount
;
55 PROC_TRACE_PROCESSOR_DATA
*ProcessorData
;
59 RTIT_TOPA_TABLE_ENTRY TopaEntry
[MAX_TOPA_ENTRY_COUNT
];
60 } PROC_TRACE_TOPA_TABLE
;
63 Prepares for the data used by CPU feature detection and initialization.
65 @param[in] NumberOfProcessors The number of CPUs in the platform.
67 @return Pointer to a buffer of CPU related configuration data.
69 @note This service could be called by BSP only.
73 ProcTraceGetConfigData (
74 IN UINTN NumberOfProcessors
77 PROC_TRACE_DATA
*ConfigData
;
79 ConfigData
= AllocateZeroPool (sizeof (PROC_TRACE_DATA
) + sizeof (PROC_TRACE_PROCESSOR_DATA
) * NumberOfProcessors
);
80 ASSERT (ConfigData
!= NULL
);
81 ConfigData
->ProcessorData
= (PROC_TRACE_PROCESSOR_DATA
*) ((UINT8
*) ConfigData
+ sizeof (PROC_TRACE_DATA
));
83 ConfigData
->NumberOfProcessors
= (UINT32
) NumberOfProcessors
;
84 ConfigData
->ProcTraceMemSize
= PcdGet32 (PcdCpuProcTraceMemSize
);
85 ConfigData
->ProcTraceOutputScheme
= PcdGet8 (PcdCpuProcTraceOutputScheme
);
91 Detects if Intel Processor Trace feature supported on current
94 @param[in] ProcessorNumber The index of the CPU executing this function.
95 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
96 structure for the CPU executing this function.
97 @param[in] ConfigData A pointer to the configuration buffer returned
98 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
99 CPU_FEATURE_GET_CONFIG_DATA was not provided in
100 RegisterCpuFeature().
102 @retval TRUE Processor Trace feature is supported.
103 @retval FALSE Processor Trace feature is not supported.
105 @note This service could be called by BSP/APs.
110 IN UINTN ProcessorNumber
,
111 IN REGISTER_CPU_FEATURE_INFORMATION
*CpuInfo
,
112 IN VOID
*ConfigData OPTIONAL
115 PROC_TRACE_DATA
*ProcTraceData
;
116 CPUID_STRUCTURED_EXTENDED_FEATURE_FLAGS_EBX Ebx
;
117 CPUID_INTEL_PROCESSOR_TRACE_MAIN_LEAF_ECX Ecx
;
120 // Check if ProcTraceMemorySize option is enabled (0xFF means disable by user)
122 ProcTraceData
= (PROC_TRACE_DATA
*) ConfigData
;
123 ASSERT (ProcTraceData
!= NULL
);
124 if ((ProcTraceData
->ProcTraceMemSize
> RtitTopaMemorySize128M
) ||
125 (ProcTraceData
->ProcTraceOutputScheme
> RtitOutputSchemeToPA
)) {
130 // Check if Processor Trace is supported
132 AsmCpuidEx (CPUID_STRUCTURED_EXTENDED_FEATURE_FLAGS
, 0, NULL
, &Ebx
.Uint32
, NULL
, NULL
);
133 ProcTraceData
->ProcessorData
[ProcessorNumber
].ProcTraceSupported
= (BOOLEAN
) (Ebx
.Bits
.IntelProcessorTrace
== 1);
134 if (!ProcTraceData
->ProcessorData
[ProcessorNumber
].ProcTraceSupported
) {
138 AsmCpuidEx (CPUID_INTEL_PROCESSOR_TRACE
, CPUID_INTEL_PROCESSOR_TRACE_MAIN_LEAF
, NULL
, NULL
, &Ecx
.Uint32
, NULL
);
139 ProcTraceData
->ProcessorData
[ProcessorNumber
].TopaSupported
= (BOOLEAN
) (Ecx
.Bits
.RTIT
== 1);
140 ProcTraceData
->ProcessorData
[ProcessorNumber
].SingleRangeSupported
= (BOOLEAN
) (Ecx
.Bits
.SingleRangeOutput
== 1);
141 if ((ProcTraceData
->ProcessorData
[ProcessorNumber
].TopaSupported
&& (ProcTraceData
->ProcTraceOutputScheme
== RtitOutputSchemeToPA
)) ||
142 (ProcTraceData
->ProcessorData
[ProcessorNumber
].SingleRangeSupported
&& (ProcTraceData
->ProcTraceOutputScheme
== RtitOutputSchemeSingleRange
))) {
150 Initializes Intel Processor Trace feature to specific state.
152 @param[in] ProcessorNumber The index of the CPU executing this function.
153 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
154 structure for the CPU executing this function.
155 @param[in] ConfigData A pointer to the configuration buffer returned
156 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
157 CPU_FEATURE_GET_CONFIG_DATA was not provided in
158 RegisterCpuFeature().
159 @param[in] State If TRUE, then the Processor Trace feature must be
161 If FALSE, then the Processor Trace feature must be
164 @retval RETURN_SUCCESS Intel Processor Trace feature is initialized.
169 ProcTraceInitialize (
170 IN UINTN ProcessorNumber
,
171 IN REGISTER_CPU_FEATURE_INFORMATION
*CpuInfo
,
172 IN VOID
*ConfigData
, OPTIONAL
176 UINT32 MemRegionSize
;
179 UINTN MemRegionBaseAddr
;
180 UINTN
*ThreadMemRegionTable
;
182 UINTN TopaTableBaseAddr
;
183 UINTN AlignedAddress
;
185 PROC_TRACE_TOPA_TABLE
*TopaTable
;
186 PROC_TRACE_DATA
*ProcTraceData
;
188 MSR_IA32_RTIT_CTL_REGISTER CtrlReg
;
189 MSR_IA32_RTIT_STATUS_REGISTER StatusReg
;
190 MSR_IA32_RTIT_OUTPUT_BASE_REGISTER OutputBaseReg
;
191 MSR_IA32_RTIT_OUTPUT_MASK_PTRS_REGISTER OutputMaskPtrsReg
;
192 RTIT_TOPA_TABLE_ENTRY
*TopaEntryPtr
;
194 ProcTraceData
= (PROC_TRACE_DATA
*) ConfigData
;
195 ASSERT (ProcTraceData
!= NULL
);
197 MemRegionBaseAddr
= 0;
200 if (ProcTraceData
->ThreadMemRegionTable
== NULL
) {
202 DEBUG ((DEBUG_INFO
, "Initialize Processor Trace\n"));
206 /// Refer to PROC_TRACE_MEM_SIZE Table for Size Encoding
208 MemRegionSize
= (UINT32
) (1 << (ProcTraceData
->ProcTraceMemSize
+ 12));
210 DEBUG ((DEBUG_INFO
, "ProcTrace: MemSize requested: 0x%X \n", MemRegionSize
));
214 // Clear MSR_IA32_RTIT_CTL[0] and IA32_RTIT_STS only if MSR_IA32_RTIT_CTL[0]==1b
216 CtrlReg
.Uint64
= AsmReadMsr64 (MSR_IA32_RTIT_CTL
);
217 if (CtrlReg
.Bits
.TraceEn
!= 0) {
219 /// Clear bit 0 in MSR IA32_RTIT_CTL (570)
221 CtrlReg
.Bits
.TraceEn
= 0;
222 CPU_REGISTER_TABLE_WRITE64 (
230 /// Clear MSR IA32_RTIT_STS (571h) to all zeros
232 StatusReg
.Uint64
= 0x0;
233 CPU_REGISTER_TABLE_WRITE64 (
236 MSR_IA32_RTIT_STATUS
,
243 // Let BSP allocate and create the necessary memory region (Aligned to the size of
244 // the memory region from setup option(ProcTraceMemSize) which is an integral multiple of 4kB)
245 // for the all the enabled threads for storing Processor Trace debug data. Then Configure the trace
246 // address base in MSR, IA32_RTIT_OUTPUT_BASE (560h) bits 47:12. Note that all regions must be
247 // aligned based on their size, not just 4K. Thus a 2M region must have bits 20:12 clear.
249 ThreadMemRegionTable
= (UINTN
*) AllocatePool (ProcTraceData
->NumberOfProcessors
* sizeof (UINTN
*));
250 if (ThreadMemRegionTable
== NULL
) {
251 DEBUG ((DEBUG_ERROR
, "Allocate ProcTrace ThreadMemRegionTable Failed\n"));
252 return RETURN_OUT_OF_RESOURCES
;
254 ProcTraceData
->ThreadMemRegionTable
= ThreadMemRegionTable
;
256 for (Index
= 0; Index
< ProcTraceData
->NumberOfProcessors
; Index
++, ProcTraceData
->AllocatedThreads
++) {
257 Pages
= EFI_SIZE_TO_PAGES (MemRegionSize
);
258 Alignment
= MemRegionSize
;
259 AlignedAddress
= (UINTN
) AllocateAlignedReservedPages (Pages
, Alignment
);
260 if (AlignedAddress
== 0) {
261 DEBUG ((DEBUG_ERROR
, "ProcTrace: Out of mem, allocated only for %d threads\n", ProcTraceData
->AllocatedThreads
));
264 // Could not allocate for BSP even
266 FreePool ((VOID
*) ThreadMemRegionTable
);
267 ThreadMemRegionTable
= NULL
;
268 return RETURN_OUT_OF_RESOURCES
;
273 ThreadMemRegionTable
[Index
] = AlignedAddress
;
274 DEBUG ((DEBUG_INFO
, "ProcTrace: PT MemRegionBaseAddr(aligned) for thread %d: 0x%llX \n", Index
, (UINT64
) ThreadMemRegionTable
[Index
]));
277 DEBUG ((DEBUG_INFO
, "ProcTrace: Allocated PT mem for %d thread \n", ProcTraceData
->AllocatedThreads
));
278 MemRegionBaseAddr
= ThreadMemRegionTable
[0];
280 if (ProcessorNumber
< ProcTraceData
->AllocatedThreads
) {
281 MemRegionBaseAddr
= ProcTraceData
->ThreadMemRegionTable
[ProcessorNumber
];
283 return RETURN_SUCCESS
;
288 /// Check Processor Trace output scheme: Single Range output or ToPA table
292 // Single Range output scheme
294 if (ProcTraceData
->ProcessorData
[ProcessorNumber
].SingleRangeSupported
&&
295 (ProcTraceData
->ProcTraceOutputScheme
== RtitOutputSchemeSingleRange
)) {
297 DEBUG ((DEBUG_INFO
, "ProcTrace: Enabling Single Range Output scheme \n"));
301 // Clear MSR IA32_RTIT_CTL (0x570) ToPA (Bit 8)
303 CtrlReg
.Uint64
= AsmReadMsr64 (MSR_IA32_RTIT_CTL
);
304 CtrlReg
.Bits
.ToPA
= 0;
305 CPU_REGISTER_TABLE_WRITE64 (
313 // Program MSR IA32_RTIT_OUTPUT_BASE (0x560) bits[63:7] with the allocated Memory Region
315 OutputBaseReg
.Bits
.Base
= (MemRegionBaseAddr
>> 7) & 0x01FFFFFF;
316 OutputBaseReg
.Bits
.BaseHi
= RShiftU64 ((UINT64
) MemRegionBaseAddr
, 32) & 0xFFFFFFFF;
317 CPU_REGISTER_TABLE_WRITE64 (
320 MSR_IA32_RTIT_OUTPUT_BASE
,
325 // Program the Mask bits for the Memory Region to MSR IA32_RTIT_OUTPUT_MASK_PTRS (561h)
327 OutputMaskPtrsReg
.Bits
.MaskOrTableOffset
= ((MemRegionSize
- 1) >> 7) & 0x01FFFFFF;
328 OutputMaskPtrsReg
.Bits
.OutputOffset
= RShiftU64 (MemRegionSize
- 1, 32) & 0xFFFFFFFF;
329 CPU_REGISTER_TABLE_WRITE64 (
332 MSR_IA32_RTIT_OUTPUT_MASK_PTRS
,
333 OutputMaskPtrsReg
.Uint64
338 // ToPA(Table of physical address) scheme
340 if (ProcTraceData
->ProcessorData
[ProcessorNumber
].TopaSupported
&&
341 (ProcTraceData
->ProcTraceOutputScheme
== RtitOutputSchemeToPA
)) {
343 // Create ToPA structure aligned at 4KB for each logical thread
344 // with at least 2 entries by 8 bytes size each. The first entry
345 // should have the trace output base address in bits 47:12, 6:9
346 // for Size, bits 4,2 and 0 must be cleared. The second entry
347 // should have the base address of the table location in bits
348 // 47:12, bits 4 and 2 must be cleared and bit 0 must be set.
351 DEBUG ((DEBUG_INFO
, "ProcTrace: Enabling ToPA scheme \n"));
353 // Let BSP allocate ToPA table mem for all threads
355 TopaMemArray
= (UINTN
*) AllocatePool (ProcTraceData
->AllocatedThreads
* sizeof (UINTN
*));
356 if (TopaMemArray
== NULL
) {
357 DEBUG ((DEBUG_ERROR
, "ProcTrace: Allocate mem for ToPA Failed\n"));
358 return RETURN_OUT_OF_RESOURCES
;
360 ProcTraceData
->TopaMemArray
= TopaMemArray
;
362 for (Index
= 0; Index
< ProcTraceData
->AllocatedThreads
; Index
++) {
363 Pages
= EFI_SIZE_TO_PAGES (sizeof (PROC_TRACE_TOPA_TABLE
));
365 AlignedAddress
= (UINTN
) AllocateAlignedReservedPages (Pages
, Alignment
);
366 if (AlignedAddress
== 0) {
367 if (Index
< ProcTraceData
->AllocatedThreads
) {
368 ProcTraceData
->AllocatedThreads
= Index
;
370 DEBUG ((DEBUG_ERROR
, "ProcTrace: Out of mem, allocating ToPA mem only for %d threads\n", ProcTraceData
->AllocatedThreads
));
373 // Could not allocate for BSP
375 FreePool ((VOID
*) TopaMemArray
);
377 return RETURN_OUT_OF_RESOURCES
;
382 TopaMemArray
[Index
] = AlignedAddress
;
383 DEBUG ((DEBUG_INFO
, "ProcTrace: Topa table address(aligned) for thread %d is 0x%llX \n", Index
, (UINT64
) TopaMemArray
[Index
]));
386 DEBUG ((DEBUG_INFO
, "ProcTrace: Allocated ToPA mem for %d thread \n", ProcTraceData
->AllocatedThreads
));
388 // BSP gets the first block
390 TopaTableBaseAddr
= TopaMemArray
[0];
393 // Count for currently executing AP.
395 if (ProcessorNumber
< ProcTraceData
->AllocatedThreads
) {
396 TopaTableBaseAddr
= ProcTraceData
->TopaMemArray
[ProcessorNumber
];
398 return RETURN_SUCCESS
;
402 TopaTable
= (PROC_TRACE_TOPA_TABLE
*) TopaTableBaseAddr
;
403 TopaEntryPtr
= &TopaTable
->TopaEntry
[0];
404 TopaEntryPtr
->Bits
.Base
= (MemRegionBaseAddr
>> 12) & 0x000FFFFF;
405 TopaEntryPtr
->Bits
.BaseHi
= RShiftU64 ((UINT64
) MemRegionBaseAddr
, 32) & 0xFFFFFFFF;
406 TopaEntryPtr
->Bits
.Size
= ProcTraceData
->ProcTraceMemSize
;
407 TopaEntryPtr
->Bits
.END
= 0;
409 TopaEntryPtr
= &TopaTable
->TopaEntry
[1];
410 TopaEntryPtr
->Bits
.Base
= (TopaTableBaseAddr
>> 12) & 0x000FFFFF;
411 TopaEntryPtr
->Bits
.BaseHi
= RShiftU64 ((UINT64
) TopaTableBaseAddr
, 32) & 0xFFFFFFFF;
412 TopaEntryPtr
->Bits
.END
= 1;
415 // Program the MSR IA32_RTIT_OUTPUT_BASE (0x560) bits[63:7] with ToPA base
417 OutputBaseReg
.Bits
.Base
= (TopaTableBaseAddr
>> 7) & 0x01FFFFFF;
418 OutputBaseReg
.Bits
.BaseHi
= RShiftU64 ((UINT64
) TopaTableBaseAddr
, 32) & 0xFFFFFFFF;
419 CPU_REGISTER_TABLE_WRITE64 (
422 MSR_IA32_RTIT_OUTPUT_BASE
,
427 // Set the MSR IA32_RTIT_OUTPUT_MASK (0x561) bits[63:7] to 0
429 OutputMaskPtrsReg
.Bits
.MaskOrTableOffset
= 0;
430 OutputMaskPtrsReg
.Bits
.OutputOffset
= 0;
431 CPU_REGISTER_TABLE_WRITE64 (
434 MSR_IA32_RTIT_OUTPUT_MASK_PTRS
,
435 OutputMaskPtrsReg
.Uint64
438 // Enable ToPA output scheme by enabling MSR IA32_RTIT_CTL (0x570) ToPA (Bit 8)
440 CtrlReg
.Uint64
= AsmReadMsr64 (MSR_IA32_RTIT_CTL
);
441 CtrlReg
.Bits
.ToPA
= 1;
442 CPU_REGISTER_TABLE_WRITE64 (
451 /// Enable the Processor Trace feature from MSR IA32_RTIT_CTL (570h)
453 CtrlReg
.Uint64
= AsmReadMsr64 (MSR_IA32_RTIT_CTL
);
455 CtrlReg
.Bits
.User
= 1;
456 CtrlReg
.Bits
.BranchEn
= 1;
458 CtrlReg
.Bits
.TraceEn
= 0;
460 CtrlReg
.Bits
.TraceEn
= 1;
462 CPU_REGISTER_TABLE_WRITE64 (
469 return RETURN_SUCCESS
;