4 Copyright (c) 2012 - 2015, 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 "PiSmmCpuDxeSmm.h"
16 #include "SmmProfileInternal.h"
18 UINT32 mSmmProfileCr3
;
20 SMM_PROFILE_HEADER
*mSmmProfileBase
;
21 MSR_DS_AREA_STRUCT
*mMsrDsAreaBase
;
23 // The buffer to store SMM profile data.
25 UINTN mSmmProfileSize
;
28 // The buffer to enable branch trace store.
30 UINTN mMsrDsAreaSize
= SMM_PROFILE_DTS_SIZE
;
33 // The flag indicates if execute-disable is supported by processor.
35 BOOLEAN mXdSupported
= FALSE
;
38 // The flag indicates if execute-disable is enabled on processor.
40 BOOLEAN mXdEnabled
= FALSE
;
43 // The flag indicates if BTS is supported by processor.
45 BOOLEAN mBtsSupported
= FALSE
;
48 // The flag indicates if SMM profile starts to record data.
50 BOOLEAN mSmmProfileStart
= FALSE
;
53 // Record the page fault exception count for one instruction execution.
57 UINT64 (*mLastPFEntryValue
)[MAX_PF_ENTRY_COUNT
];
58 UINT64
*(*mLastPFEntryPointer
)[MAX_PF_ENTRY_COUNT
];
60 MSR_DS_AREA_STRUCT
**mMsrDsArea
;
61 BRANCH_TRACE_RECORD
**mMsrBTSRecord
;
62 UINTN mBTSRecordNumber
;
63 PEBS_RECORD
**mMsrPEBSRecord
;
66 // These memory ranges are always present, they does not generate the access type of page fault exception,
67 // but they possibly generate instruction fetch type of page fault exception.
69 MEMORY_PROTECTION_RANGE
*mProtectionMemRange
= NULL
;
70 UINTN mProtectionMemRangeCount
= 0;
73 // Some predefined memory ranges.
75 MEMORY_PROTECTION_RANGE mProtectionMemRangeTemplate
[] = {
77 // SMRAM range (to be fixed in runtime).
78 // It is always present and instruction fetches are allowed.
80 {{0x00000000, 0x00000000},TRUE
,FALSE
},
83 // SMM profile data range( to be fixed in runtime).
84 // It is always present and instruction fetches are not allowed.
86 {{0x00000000, 0x00000000},TRUE
,TRUE
},
89 // Future extended range could be added here.
93 // PCI MMIO ranges (to be added in runtime).
94 // They are always present and instruction fetches are not allowed.
99 // These memory ranges are mapped by 4KB-page instead of 2MB-page.
101 MEMORY_RANGE
*mSplitMemRange
= NULL
;
102 UINTN mSplitMemRangeCount
= 0;
107 UINT32 mSmiCommandPort
;
110 Disable branch trace store.
118 AsmMsrAnd64 (MSR_DEBUG_CTL
, ~((UINT64
)(MSR_DEBUG_CTL_BTS
| MSR_DEBUG_CTL_TR
)));
122 Enable branch trace store.
130 AsmMsrOr64 (MSR_DEBUG_CTL
, (MSR_DEBUG_CTL_BTS
| MSR_DEBUG_CTL_TR
));
134 Get CPU Index from APIC ID.
145 ApicId
= GetApicId ();
147 for (Index
= 0; Index
< PcdGet32 (PcdCpuMaxLogicalProcessorNumber
); Index
++) {
148 if (gSmmCpuPrivate
->ProcessorInfo
[Index
].ProcessorId
== ApicId
) {
157 Get the source of IP after execute-disable exception is triggered.
159 @param CpuIndex The index of CPU.
160 @param DestinationIP The destination address.
164 GetSourceFromDestinationOnBts (
169 BRANCH_TRACE_RECORD
*CurrentBTSRecord
;
175 CurrentBTSRecord
= (BRANCH_TRACE_RECORD
*)mMsrDsArea
[CpuIndex
]->BTSIndex
;
176 for (Index
= 0; Index
< mBTSRecordNumber
; Index
++) {
177 if ((UINTN
)CurrentBTSRecord
< (UINTN
)mMsrBTSRecord
[CpuIndex
]) {
181 CurrentBTSRecord
= (BRANCH_TRACE_RECORD
*)((UINTN
)mMsrDsArea
[CpuIndex
]->BTSAbsoluteMaximum
- 1);
184 if (CurrentBTSRecord
->LastBranchTo
== DestinationIP
) {
186 // Good! find 1st one, then find 2nd one.
190 // The first one is DEBUG exception
195 // Good find proper one.
197 return CurrentBTSRecord
->LastBranchFrom
;
207 SMM profile specific INT 1 (single-step) exception handler.
209 @param InterruptType Defines the type of interrupt or exception that
210 occurred on the processor.This parameter is processor architecture specific.
211 @param SystemContext A pointer to the processor context when
212 the interrupt occurred on the processor.
216 DebugExceptionHandler (
217 IN EFI_EXCEPTION_TYPE InterruptType
,
218 IN EFI_SYSTEM_CONTEXT SystemContext
224 if (!mSmmProfileStart
) {
227 CpuIndex
= GetCpuIndex ();
230 // Clear last PF entries
232 for (PFEntry
= 0; PFEntry
< mPFEntryCount
[CpuIndex
]; PFEntry
++) {
233 *mLastPFEntryPointer
[CpuIndex
][PFEntry
] = mLastPFEntryValue
[CpuIndex
][PFEntry
];
237 // Reset page fault exception count for next page fault.
239 mPFEntryCount
[CpuIndex
] = 0;
247 // Clear TF in EFLAGS
249 ClearTrapFlag (SystemContext
);
253 Check if the memory address will be mapped by 4KB-page.
255 @param Address The address of Memory.
256 @param Nx The flag indicates if the memory is execute-disable.
261 IN EFI_PHYSICAL_ADDRESS Address
,
268 if (FeaturePcdGet (PcdCpuSmmProfileEnable
)) {
270 // Check configuration
272 for (Index
= 0; Index
< mProtectionMemRangeCount
; Index
++) {
273 if ((Address
>= mProtectionMemRange
[Index
].Range
.Base
) && (Address
< mProtectionMemRange
[Index
].Range
.Top
)) {
274 *Nx
= mProtectionMemRange
[Index
].Nx
;
275 return mProtectionMemRange
[Index
].Present
;
282 if ((Address
< mCpuHotPlugData
.SmrrBase
) ||
283 (Address
>= mCpuHotPlugData
.SmrrBase
+ mCpuHotPlugData
.SmrrSize
)) {
291 Check if the memory address will be mapped by 4KB-page.
293 @param Address The address of Memory.
298 IN EFI_PHYSICAL_ADDRESS Address
303 if (FeaturePcdGet (PcdCpuSmmProfileEnable
)) {
305 // Check configuration
307 for (Index
= 0; Index
< mSplitMemRangeCount
; Index
++) {
308 if ((Address
>= mSplitMemRange
[Index
].Base
) && (Address
< mSplitMemRange
[Index
].Top
)) {
313 if (Address
< mCpuHotPlugData
.SmrrBase
) {
314 if ((mCpuHotPlugData
.SmrrBase
- Address
) < BASE_2MB
) {
317 } else if (Address
> (mCpuHotPlugData
.SmrrBase
+ mCpuHotPlugData
.SmrrSize
- BASE_2MB
)) {
318 if ((Address
- (mCpuHotPlugData
.SmrrBase
+ mCpuHotPlugData
.SmrrSize
- BASE_2MB
)) < BASE_2MB
) {
330 Initialize the protected memory ranges and the 4KB-page mapped memory ranges.
334 InitProtectedMemRange (
339 UINTN NumberOfDescriptors
;
340 UINTN NumberOfMmioDescriptors
;
341 UINTN NumberOfProtectRange
;
342 UINTN NumberOfSpliteRange
;
343 EFI_GCD_MEMORY_SPACE_DESCRIPTOR
*MemorySpaceMap
;
346 EFI_PHYSICAL_ADDRESS ProtectBaseAddress
;
347 EFI_PHYSICAL_ADDRESS ProtectEndAddress
;
348 EFI_PHYSICAL_ADDRESS Top2MBAlignedAddress
;
349 EFI_PHYSICAL_ADDRESS Base2MBAlignedAddress
;
350 UINT64 High4KBPageSize
;
351 UINT64 Low4KBPageSize
;
353 NumberOfDescriptors
= 0;
354 NumberOfMmioDescriptors
= 0;
355 NumberOfSpliteRange
= 0;
356 MemorySpaceMap
= NULL
;
359 // Get MMIO ranges from GCD and add them into protected memory ranges.
361 Status
= gDS
->GetMemorySpaceMap (
362 &NumberOfDescriptors
,
365 for (Index
= 0; Index
< NumberOfDescriptors
; Index
++) {
366 if (MemorySpaceMap
[Index
].GcdMemoryType
== EfiGcdMemoryTypeMemoryMappedIo
) {
367 NumberOfMmioDescriptors
++;
371 if (NumberOfMmioDescriptors
!= 0) {
372 TotalSize
= NumberOfMmioDescriptors
* sizeof (MEMORY_PROTECTION_RANGE
) + sizeof (mProtectionMemRangeTemplate
);
373 mProtectionMemRange
= (MEMORY_PROTECTION_RANGE
*) AllocateZeroPool (TotalSize
);
374 ASSERT (mProtectionMemRange
!= NULL
);
375 mProtectionMemRangeCount
= TotalSize
/ sizeof (MEMORY_PROTECTION_RANGE
);
378 // Copy existing ranges.
380 CopyMem (mProtectionMemRange
, mProtectionMemRangeTemplate
, sizeof (mProtectionMemRangeTemplate
));
383 // Create split ranges which come from protected ranges.
385 TotalSize
= (TotalSize
/ sizeof (MEMORY_PROTECTION_RANGE
)) * sizeof (MEMORY_RANGE
);
386 mSplitMemRange
= (MEMORY_RANGE
*) AllocateZeroPool (TotalSize
);
387 ASSERT (mSplitMemRange
!= NULL
);
390 // Create MMIO ranges which are set to present and execution-disable.
392 NumberOfProtectRange
= sizeof (mProtectionMemRangeTemplate
) / sizeof (MEMORY_PROTECTION_RANGE
);
393 for (Index
= 0; Index
< NumberOfDescriptors
; Index
++) {
394 if (MemorySpaceMap
[Index
].GcdMemoryType
!= EfiGcdMemoryTypeMemoryMappedIo
) {
397 mProtectionMemRange
[NumberOfProtectRange
].Range
.Base
= MemorySpaceMap
[Index
].BaseAddress
;
398 mProtectionMemRange
[NumberOfProtectRange
].Range
.Top
= MemorySpaceMap
[Index
].BaseAddress
+ MemorySpaceMap
[Index
].Length
;
399 mProtectionMemRange
[NumberOfProtectRange
].Present
= TRUE
;
400 mProtectionMemRange
[NumberOfProtectRange
].Nx
= TRUE
;
401 NumberOfProtectRange
++;
406 // According to protected ranges, create the ranges which will be mapped by 2KB page.
408 NumberOfSpliteRange
= 0;
409 NumberOfProtectRange
= mProtectionMemRangeCount
;
410 for (Index
= 0; Index
< NumberOfProtectRange
; Index
++) {
412 // If MMIO base address is not 2MB alignment, make 2MB alignment for create 4KB page in page table.
414 ProtectBaseAddress
= mProtectionMemRange
[Index
].Range
.Base
;
415 ProtectEndAddress
= mProtectionMemRange
[Index
].Range
.Top
;
416 if (((ProtectBaseAddress
& (SIZE_2MB
- 1)) != 0) || ((ProtectEndAddress
& (SIZE_2MB
- 1)) != 0)) {
418 // Check if it is possible to create 4KB-page for not 2MB-aligned range and to create 2MB-page for 2MB-aligned range.
419 // A mix of 4KB and 2MB page could save SMRAM space.
421 Top2MBAlignedAddress
= ProtectEndAddress
& ~(SIZE_2MB
- 1);
422 Base2MBAlignedAddress
= (ProtectBaseAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1);
423 if ((Top2MBAlignedAddress
> Base2MBAlignedAddress
) &&
424 ((Top2MBAlignedAddress
- Base2MBAlignedAddress
) >= SIZE_2MB
)) {
426 // There is an range which could be mapped by 2MB-page.
428 High4KBPageSize
= ((ProtectEndAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1)) - (ProtectEndAddress
& ~(SIZE_2MB
- 1));
429 Low4KBPageSize
= ((ProtectBaseAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1)) - (ProtectBaseAddress
& ~(SIZE_2MB
- 1));
430 if (High4KBPageSize
!= 0) {
432 // Add not 2MB-aligned range to be mapped by 4KB-page.
434 mSplitMemRange
[NumberOfSpliteRange
].Base
= ProtectEndAddress
& ~(SIZE_2MB
- 1);
435 mSplitMemRange
[NumberOfSpliteRange
].Top
= (ProtectEndAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1);
436 NumberOfSpliteRange
++;
438 if (Low4KBPageSize
!= 0) {
440 // Add not 2MB-aligned range to be mapped by 4KB-page.
442 mSplitMemRange
[NumberOfSpliteRange
].Base
= ProtectBaseAddress
& ~(SIZE_2MB
- 1);
443 mSplitMemRange
[NumberOfSpliteRange
].Top
= (ProtectBaseAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1);
444 NumberOfSpliteRange
++;
448 // The range could only be mapped by 4KB-page.
450 mSplitMemRange
[NumberOfSpliteRange
].Base
= ProtectBaseAddress
& ~(SIZE_2MB
- 1);
451 mSplitMemRange
[NumberOfSpliteRange
].Top
= (ProtectEndAddress
+ SIZE_2MB
- 1) & ~(SIZE_2MB
- 1);
452 NumberOfSpliteRange
++;
457 mSplitMemRangeCount
= NumberOfSpliteRange
;
459 DEBUG ((EFI_D_INFO
, "SMM Profile Memory Ranges:\n"));
460 for (Index
= 0; Index
< mProtectionMemRangeCount
; Index
++) {
461 DEBUG ((EFI_D_INFO
, "mProtectionMemRange[%d].Base = %lx\n", Index
, mProtectionMemRange
[Index
].Range
.Base
));
462 DEBUG ((EFI_D_INFO
, "mProtectionMemRange[%d].Top = %lx\n", Index
, mProtectionMemRange
[Index
].Range
.Top
));
464 for (Index
= 0; Index
< mSplitMemRangeCount
; Index
++) {
465 DEBUG ((EFI_D_INFO
, "mSplitMemRange[%d].Base = %lx\n", Index
, mSplitMemRange
[Index
].Base
));
466 DEBUG ((EFI_D_INFO
, "mSplitMemRange[%d].Top = %lx\n", Index
, mSplitMemRange
[Index
].Top
));
471 Update page table according to protected memory ranges and the 4KB-page mapped memory ranges.
488 UINTN NumberOfPdpEntries
;
489 UINTN NumberOfPml4Entries
;
490 UINTN SizeOfMemorySpace
;
493 if (sizeof (UINTN
) == sizeof (UINT64
)) {
494 Pml4
= (UINT64
*)(UINTN
)mSmmProfileCr3
;
495 SizeOfMemorySpace
= HighBitSet64 (gPhyMask
) + 1;
497 // Calculate the table entries of PML4E and PDPTE.
499 if (SizeOfMemorySpace
<= 39 ) {
500 NumberOfPml4Entries
= 1;
501 NumberOfPdpEntries
= (UINT32
)LShiftU64 (1, (SizeOfMemorySpace
- 30));
503 NumberOfPml4Entries
= (UINT32
)LShiftU64 (1, (SizeOfMemorySpace
- 39));
504 NumberOfPdpEntries
= 512;
507 NumberOfPml4Entries
= 1;
508 NumberOfPdpEntries
= 4;
512 // Go through page table and change 2MB-page into 4KB-page.
514 for (Level1
= 0; Level1
< NumberOfPml4Entries
; Level1
++) {
515 if (sizeof (UINTN
) == sizeof (UINT64
)) {
516 if ((Pml4
[Level1
] & IA32_PG_P
) == 0) {
518 // If Pml4 entry does not exist, skip it
522 Pde
= (UINT64
*)(UINTN
)(Pml4
[Level1
] & PHYSICAL_ADDRESS_MASK
);
524 Pde
= (UINT64
*)(UINTN
)mSmmProfileCr3
;
526 for (Level2
= 0; Level2
< NumberOfPdpEntries
; Level2
++, Pde
++) {
527 if ((*Pde
& IA32_PG_P
) == 0) {
529 // If PDE entry does not exist, skip it
533 Pte
= (UINT64
*)(UINTN
)(*Pde
& PHYSICAL_ADDRESS_MASK
);
537 for (Level3
= 0; Level3
< SIZE_4KB
/ sizeof (*Pte
); Level3
++, Pte
++) {
538 if ((*Pte
& IA32_PG_P
) == 0) {
540 // If PTE entry does not exist, skip it
544 Address
= (((Level2
<< 9) + Level3
) << 21);
547 // If it is 2M page, check IsAddressSplit()
549 if (((*Pte
& IA32_PG_PS
) != 0) && IsAddressSplit (Address
)) {
551 // Based on current page table, create 4KB page table for split area.
553 ASSERT (Address
== (*Pte
& PHYSICAL_ADDRESS_MASK
));
555 Pt
= AllocatePages (1);
559 for (Level4
= 0; Level4
< SIZE_4KB
/ sizeof(*Pt
); Level4
++) {
560 Pt
[Level4
] = Address
+ ((Level4
<< 12) | IA32_PG_RW
| IA32_PG_P
);
562 *Pte
= (UINTN
)Pt
| IA32_PG_RW
| IA32_PG_P
;
563 } // end if IsAddressSplit
569 // Go through page table and set several page table entries to absent or execute-disable.
571 DEBUG ((EFI_D_INFO
, "Patch page table start ...\n"));
572 for (Level1
= 0; Level1
< NumberOfPml4Entries
; Level1
++) {
573 if (sizeof (UINTN
) == sizeof (UINT64
)) {
574 if ((Pml4
[Level1
] & IA32_PG_P
) == 0) {
576 // If Pml4 entry does not exist, skip it
580 Pde
= (UINT64
*)(UINTN
)(Pml4
[Level1
] & PHYSICAL_ADDRESS_MASK
);
582 Pde
= (UINT64
*)(UINTN
)mSmmProfileCr3
;
584 for (Level2
= 0; Level2
< NumberOfPdpEntries
; Level2
++, Pde
++) {
585 if ((*Pde
& IA32_PG_P
) == 0) {
587 // If PDE entry does not exist, skip it
591 Pte
= (UINT64
*)(UINTN
)(*Pde
& PHYSICAL_ADDRESS_MASK
);
595 for (Level3
= 0; Level3
< SIZE_4KB
/ sizeof (*Pte
); Level3
++, Pte
++) {
596 if ((*Pte
& IA32_PG_P
) == 0) {
598 // If PTE entry does not exist, skip it
602 Address
= (((Level2
<< 9) + Level3
) << 21);
604 if ((*Pte
& IA32_PG_PS
) != 0) {
607 if (!IsAddressValid (Address
, &Nx
)) {
609 // Patch to remove Present flag and RW flag
611 *Pte
= *Pte
& (INTN
)(INT32
)(~(IA32_PG_RW
| IA32_PG_P
));
613 if (Nx
&& mXdSupported
) {
614 *Pte
= *Pte
| IA32_PG_NX
;
618 Pt
= (UINT64
*)(UINTN
)(*Pte
& PHYSICAL_ADDRESS_MASK
);
622 for (Level4
= 0; Level4
< SIZE_4KB
/ sizeof(*Pt
); Level4
++, Pt
++) {
623 if (!IsAddressValid (Address
, &Nx
)) {
624 *Pt
= *Pt
& (INTN
)(INT32
)(~(IA32_PG_RW
| IA32_PG_P
));
626 if (Nx
&& mXdSupported
) {
627 *Pt
= *Pt
| IA32_PG_NX
;
640 DEBUG ((EFI_D_INFO
, "Patch page table done!\n"));
642 // Set execute-disable flag
650 To find FADT in ACPI tables.
652 @param AcpiTableGuid The GUID used to find ACPI table in UEFI ConfigurationTable.
654 @return FADT table pointer.
656 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*
657 FindAcpiFadtTableByAcpiGuid (
658 IN EFI_GUID
*AcpiTableGuid
661 EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*Rsdp
;
662 EFI_ACPI_DESCRIPTION_HEADER
*Rsdt
;
663 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt
;
670 // found ACPI table RSD_PTR from system table
672 for (Index
= 0; Index
< gST
->NumberOfTableEntries
; Index
++) {
673 if (CompareGuid (&(gST
->ConfigurationTable
[Index
].VendorGuid
), AcpiTableGuid
)) {
675 // A match was found.
677 Rsdp
= gST
->ConfigurationTable
[Index
].VendorTable
;
686 Rsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*)(UINTN
) Rsdp
->RsdtAddress
;
687 if (Rsdt
== NULL
|| Rsdt
->Signature
!= EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
) {
691 for (Index
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
); Index
< Rsdt
->Length
; Index
= Index
+ sizeof (UINT32
)) {
693 Data32
= *(UINT32
*) ((UINT8
*) Rsdt
+ Index
);
694 Fadt
= (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*) (UINT32
*) (UINTN
) Data32
;
695 if (Fadt
->Header
.Signature
== EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
700 if (Fadt
== NULL
|| Fadt
->Header
.Signature
!= EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
708 To find FADT in ACPI tables.
710 @return FADT table pointer.
712 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*
717 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt
;
719 Fadt
= FindAcpiFadtTableByAcpiGuid (&gEfiAcpi20TableGuid
);
724 return FindAcpiFadtTableByAcpiGuid (&gEfiAcpi10TableGuid
);
728 To get system port address of the SMI Command Port in FADT table.
736 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt
;
738 Fadt
= FindAcpiFadtTable ();
739 ASSERT (Fadt
!= NULL
);
741 mSmiCommandPort
= Fadt
->SmiCmd
;
742 DEBUG ((EFI_D_INFO
, "mSmiCommandPort = %x\n", mSmiCommandPort
));
746 Updates page table to make some memory ranges (like system memory) absent
747 and make some memory ranges (like MMIO) present and execute disable. It also
748 update 2MB-page to 4KB-page for some memory ranges.
757 // The flag indicates SMM profile starts to work.
759 mSmmProfileStart
= TRUE
;
763 Initialize SMM profile in SmmReadyToLock protocol callback function.
765 @param Protocol Points to the protocol's unique identifier.
766 @param Interface Points to the interface instance.
767 @param Handle The handle on which the interface was installed.
769 @retval EFI_SUCCESS SmmReadyToLock protocol callback runs successfully.
773 InitSmmProfileCallBack (
774 IN CONST EFI_GUID
*Protocol
,
782 // Save to variable so that SMM profile data can be found.
784 Status
= gRT
->SetVariable (
787 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
788 sizeof(mSmmProfileBase
),
793 // Get Software SMI from FADT
795 GetSmiCommandPort ();
798 // Initialize protected memory range for patching page table later.
800 InitProtectedMemRange ();
806 Initialize SMM profile data structures.
810 InitSmmProfileInternal (
815 EFI_PHYSICAL_ADDRESS Base
;
818 UINTN MsrDsAreaSizePerCpu
;
821 mPFEntryCount
= (UINTN
*)AllocateZeroPool (sizeof (UINTN
) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
822 ASSERT (mPFEntryCount
!= NULL
);
823 mLastPFEntryValue
= (UINT64 (*)[MAX_PF_ENTRY_COUNT
])AllocateZeroPool (
824 sizeof (mLastPFEntryValue
[0]) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
825 ASSERT (mLastPFEntryValue
!= NULL
);
826 mLastPFEntryPointer
= (UINT64
*(*)[MAX_PF_ENTRY_COUNT
])AllocateZeroPool (
827 sizeof (mLastPFEntryPointer
[0]) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
828 ASSERT (mLastPFEntryPointer
!= NULL
);
831 // Allocate memory for SmmProfile below 4GB.
834 mSmmProfileSize
= PcdGet32 (PcdCpuSmmProfileSize
);
835 ASSERT ((mSmmProfileSize
& 0xFFF) == 0);
838 TotalSize
= mSmmProfileSize
+ mMsrDsAreaSize
;
840 TotalSize
= mSmmProfileSize
;
844 Status
= gBS
->AllocatePages (
846 EfiReservedMemoryType
,
847 EFI_SIZE_TO_PAGES (TotalSize
),
850 ASSERT_EFI_ERROR (Status
);
851 ZeroMem ((VOID
*)(UINTN
)Base
, TotalSize
);
852 mSmmProfileBase
= (SMM_PROFILE_HEADER
*)(UINTN
)Base
;
855 // Initialize SMM profile data header.
857 mSmmProfileBase
->HeaderSize
= sizeof (SMM_PROFILE_HEADER
);
858 mSmmProfileBase
->MaxDataEntries
= (UINT64
)((mSmmProfileSize
- sizeof(SMM_PROFILE_HEADER
)) / sizeof (SMM_PROFILE_ENTRY
));
859 mSmmProfileBase
->MaxDataSize
= MultU64x64 (mSmmProfileBase
->MaxDataEntries
, sizeof(SMM_PROFILE_ENTRY
));
860 mSmmProfileBase
->CurDataEntries
= 0;
861 mSmmProfileBase
->CurDataSize
= 0;
862 mSmmProfileBase
->TsegStart
= mCpuHotPlugData
.SmrrBase
;
863 mSmmProfileBase
->TsegSize
= mCpuHotPlugData
.SmrrSize
;
864 mSmmProfileBase
->NumSmis
= 0;
865 mSmmProfileBase
->NumCpus
= gSmmCpuPrivate
->SmmCoreEntryContext
.NumberOfCpus
;
868 mMsrDsArea
= (MSR_DS_AREA_STRUCT
**)AllocateZeroPool (sizeof (MSR_DS_AREA_STRUCT
*) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
869 ASSERT (mMsrDsArea
!= NULL
);
870 mMsrBTSRecord
= (BRANCH_TRACE_RECORD
**)AllocateZeroPool (sizeof (BRANCH_TRACE_RECORD
*) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
871 ASSERT (mMsrBTSRecord
!= NULL
);
872 mMsrPEBSRecord
= (PEBS_RECORD
**)AllocateZeroPool (sizeof (PEBS_RECORD
*) * PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
873 ASSERT (mMsrPEBSRecord
!= NULL
);
875 mMsrDsAreaBase
= (MSR_DS_AREA_STRUCT
*)((UINTN
)Base
+ mSmmProfileSize
);
876 MsrDsAreaSizePerCpu
= mMsrDsAreaSize
/ PcdGet32 (PcdCpuMaxLogicalProcessorNumber
);
877 mBTSRecordNumber
= (MsrDsAreaSizePerCpu
- sizeof(PEBS_RECORD
) * PEBS_RECORD_NUMBER
- sizeof(MSR_DS_AREA_STRUCT
)) / sizeof(BRANCH_TRACE_RECORD
);
878 for (Index
= 0; Index
< PcdGet32 (PcdCpuMaxLogicalProcessorNumber
); Index
++) {
879 mMsrDsArea
[Index
] = (MSR_DS_AREA_STRUCT
*)((UINTN
)mMsrDsAreaBase
+ MsrDsAreaSizePerCpu
* Index
);
880 mMsrBTSRecord
[Index
] = (BRANCH_TRACE_RECORD
*)((UINTN
)mMsrDsArea
[Index
] + sizeof(MSR_DS_AREA_STRUCT
));
881 mMsrPEBSRecord
[Index
] = (PEBS_RECORD
*)((UINTN
)mMsrDsArea
[Index
] + MsrDsAreaSizePerCpu
- sizeof(PEBS_RECORD
) * PEBS_RECORD_NUMBER
);
883 mMsrDsArea
[Index
]->BTSBufferBase
= (UINTN
)mMsrBTSRecord
[Index
];
884 mMsrDsArea
[Index
]->BTSIndex
= mMsrDsArea
[Index
]->BTSBufferBase
;
885 mMsrDsArea
[Index
]->BTSAbsoluteMaximum
= mMsrDsArea
[Index
]->BTSBufferBase
+ mBTSRecordNumber
* sizeof(BRANCH_TRACE_RECORD
) + 1;
886 mMsrDsArea
[Index
]->BTSInterruptThreshold
= mMsrDsArea
[Index
]->BTSAbsoluteMaximum
+ 1;
888 mMsrDsArea
[Index
]->PEBSBufferBase
= (UINTN
)mMsrPEBSRecord
[Index
];
889 mMsrDsArea
[Index
]->PEBSIndex
= mMsrDsArea
[Index
]->PEBSBufferBase
;
890 mMsrDsArea
[Index
]->PEBSAbsoluteMaximum
= mMsrDsArea
[Index
]->PEBSBufferBase
+ PEBS_RECORD_NUMBER
* sizeof(PEBS_RECORD
) + 1;
891 mMsrDsArea
[Index
]->PEBSInterruptThreshold
= mMsrDsArea
[Index
]->PEBSAbsoluteMaximum
+ 1;
895 mProtectionMemRange
= mProtectionMemRangeTemplate
;
896 mProtectionMemRangeCount
= sizeof (mProtectionMemRangeTemplate
) / sizeof (MEMORY_PROTECTION_RANGE
);
899 // Update TSeg entry.
901 mProtectionMemRange
[0].Range
.Base
= mCpuHotPlugData
.SmrrBase
;
902 mProtectionMemRange
[0].Range
.Top
= mCpuHotPlugData
.SmrrBase
+ mCpuHotPlugData
.SmrrSize
;
905 // Update SMM profile entry.
907 mProtectionMemRange
[1].Range
.Base
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)mSmmProfileBase
;
908 mProtectionMemRange
[1].Range
.Top
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)mSmmProfileBase
+ TotalSize
;
911 // Allocate memory reserved for creating 4KB pages.
913 InitPagesForPFHandler ();
916 // Start SMM profile when SmmReadyToLock protocol is installed.
918 Status
= gSmst
->SmmRegisterProtocolNotify (
919 &gEfiSmmReadyToLockProtocolGuid
,
920 InitSmmProfileCallBack
,
923 ASSERT_EFI_ERROR (Status
);
929 Check if XD feature is supported by a processor.
933 CheckFeatureSupported (
941 AsmCpuid (CPUID_EXTENDED_FUNCTION
, &RegEax
, NULL
, NULL
, NULL
);
942 if (RegEax
<= CPUID_EXTENDED_FUNCTION
) {
944 // Extended CPUID functions are not supported on this processor.
946 mXdSupported
= FALSE
;
949 AsmCpuid (CPUID_EXTENDED_CPU_SIG
, NULL
, NULL
, NULL
, &RegEdx
);
950 if ((RegEdx
& CPUID1_EDX_XD_SUPPORT
) == 0) {
952 // Execute Disable Bit feature is not supported on this processor.
954 mXdSupported
= FALSE
;
959 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &RegEdx
);
960 if ((RegEdx
& CPUID1_EDX_BTS_AVAILABLE
) != 0) {
963 // When CPUID.1:EDX[21] is set, the following BTS facilities are available:
964 // 1. The BTS_UNAVAILABLE flag in the IA32_MISC_ENABLE MSR indicates the
965 // availability of the BTS facilities, including the ability to set the BTS and
966 // BTINT bits in the MSR_DEBUGCTLA MSR.
967 // 2. The IA32_DS_AREA MSR can be programmed to point to the DS save area.
969 if ((AsmMsrBitFieldRead64 (MSR_IA32_MISC_ENABLE
, 11, 11) == 0) &&
970 (AsmMsrBitFieldRead64 (MSR_IA32_MISC_ENABLE
, 12, 12) == 0)) {
972 // BTS facilities is supported.
974 mBtsSupported
= FALSE
;
981 Check if XD and BTS features are supported by all processors.
985 CheckProcessorFeature (
990 EFI_MP_SERVICES_PROTOCOL
*MpServices
;
992 Status
= gBS
->LocateProtocol (&gEfiMpServiceProtocolGuid
, NULL
, (VOID
**)&MpServices
);
993 ASSERT_EFI_ERROR (Status
);
996 // First detect if XD and BTS are supported
999 mBtsSupported
= TRUE
;
1002 // Check if XD and BTS are supported on all processors.
1004 CheckFeatureSupported ();
1007 //Check on other processors if BSP supports this
1009 if (mXdSupported
|| mBtsSupported
) {
1010 MpServices
->StartupAllAPs (
1012 (EFI_AP_PROCEDURE
) CheckFeatureSupported
,
1031 UINT64 MsrRegisters
;
1033 MsrRegisters
= AsmReadMsr64 (MSR_EFER
);
1034 if ((MsrRegisters
& MSR_EFER_XD
) != 0) {
1037 MsrRegisters
|= MSR_EFER_XD
;
1038 AsmWriteMsr64 (MSR_EFER
, MsrRegisters
);
1046 ActivateSingleStepDB (
1052 Dr6
= AsmReadDr6 ();
1053 if ((Dr6
& DR6_SINGLE_STEP
) != 0) {
1056 Dr6
|= DR6_SINGLE_STEP
;
1071 DebugCtl
= AsmReadMsr64 (MSR_DEBUG_CTL
);
1072 if ((DebugCtl
& MSR_DEBUG_CTL_LBR
) != 0) {
1075 AsmWriteMsr64 (MSR_LER_FROM_LIP
, 0);
1076 AsmWriteMsr64 (MSR_LER_TO_LIP
, 0);
1077 DebugCtl
|= MSR_DEBUG_CTL_LBR
;
1078 AsmWriteMsr64 (MSR_DEBUG_CTL
, DebugCtl
);
1082 Enable branch trace store.
1084 @param CpuIndex The index of the processor.
1094 DebugCtl
= AsmReadMsr64 (MSR_DEBUG_CTL
);
1095 if ((DebugCtl
& MSR_DEBUG_CTL_BTS
) != 0) {
1099 AsmWriteMsr64 (MSR_DS_AREA
, (UINT64
)(UINTN
)mMsrDsArea
[CpuIndex
]);
1100 DebugCtl
|= (UINT64
)(MSR_DEBUG_CTL_BTS
| MSR_DEBUG_CTL_TR
);
1101 DebugCtl
&= ~((UINT64
)MSR_DEBUG_CTL_BTINT
);
1102 AsmWriteMsr64 (MSR_DEBUG_CTL
, DebugCtl
);
1106 Increase SMI number in each SMI entry.
1110 SmmProfileRecordSmiNum (
1114 if (mSmmProfileStart
) {
1115 mSmmProfileBase
->NumSmis
++;
1120 Initialize processor environment for SMM profile.
1122 @param CpuIndex The index of the processor.
1126 ActivateSmmProfile (
1131 // Enable Single Step DB#
1133 ActivateSingleStepDB ();
1135 if (mBtsSupported
) {
1137 // We can not get useful information from LER, so we have to use BTS.
1144 ActivateBTS (CpuIndex
);
1149 Initialize SMM profile in SMM CPU entry point.
1151 @param[in] Cr3 The base address of the page tables to use in SMM.
1162 mSmmProfileCr3
= Cr3
;
1165 // Skip SMM profile initialization if feature is disabled
1167 if (!FeaturePcdGet (PcdCpuSmmProfileEnable
)) {
1172 // Initialize SmmProfile here
1174 InitSmmProfileInternal ();
1177 // Initialize profile IDT.
1183 Update page table to map the memory correctly in order to make the instruction
1184 which caused page fault execute successfully. And it also save the original page
1185 table to be restored in single-step exception.
1187 @param PageTable PageTable Address.
1188 @param PFAddress The memory address which caused page fault exception.
1189 @param CpuIndex The index of the processor.
1190 @param ErrorCode The Error code of exception.
1194 RestorePageTableBelow4G (
1207 if (sizeof(UINT64
) == sizeof(UINTN
)) {
1208 PTIndex
= (UINTN
)BitFieldRead64 (PFAddress
, 39, 47);
1209 ASSERT (PageTable
[PTIndex
] != 0);
1210 PageTable
= (UINT64
*)(UINTN
)(PageTable
[PTIndex
] & PHYSICAL_ADDRESS_MASK
);
1216 PTIndex
= (UINTN
)BitFieldRead64 (PFAddress
, 30, 38);
1217 ASSERT (PageTable
[PTIndex
] != 0);
1218 PageTable
= (UINT64
*)(UINTN
)(PageTable
[PTIndex
] & PHYSICAL_ADDRESS_MASK
);
1223 PTIndex
= (UINTN
)BitFieldRead64 (PFAddress
, 21, 29);
1224 if ((PageTable
[PTIndex
] & IA32_PG_PS
) != 0) {
1230 // Record old entries with non-present status
1231 // Old entries include the memory which instruction is at and the memory which instruction access.
1234 ASSERT (mPFEntryCount
[CpuIndex
] < MAX_PF_ENTRY_COUNT
);
1235 if (mPFEntryCount
[CpuIndex
] < MAX_PF_ENTRY_COUNT
) {
1236 PFIndex
= mPFEntryCount
[CpuIndex
];
1237 mLastPFEntryValue
[CpuIndex
][PFIndex
] = PageTable
[PTIndex
];
1238 mLastPFEntryPointer
[CpuIndex
][PFIndex
] = &PageTable
[PTIndex
];
1239 mPFEntryCount
[CpuIndex
]++;
1245 PageTable
[PTIndex
] = (PFAddress
& ~((1ull << 21) - 1));
1246 PageTable
[PTIndex
] |= (UINT64
)IA32_PG_PS
;
1247 PageTable
[PTIndex
] |= (UINT64
)(IA32_PG_RW
| IA32_PG_P
);
1248 if ((ErrorCode
& IA32_PF_EC_ID
) != 0) {
1249 PageTable
[PTIndex
] &= ~IA32_PG_NX
;
1255 ASSERT (PageTable
[PTIndex
] != 0);
1256 PageTable
= (UINT64
*)(UINTN
)(PageTable
[PTIndex
] & PHYSICAL_ADDRESS_MASK
);
1261 PTIndex
= (UINTN
)BitFieldRead64 (PFAddress
, 12, 20);
1264 // Record old entries with non-present status
1265 // Old entries include the memory which instruction is at and the memory which instruction access.
1268 ASSERT (mPFEntryCount
[CpuIndex
] < MAX_PF_ENTRY_COUNT
);
1269 if (mPFEntryCount
[CpuIndex
] < MAX_PF_ENTRY_COUNT
) {
1270 PFIndex
= mPFEntryCount
[CpuIndex
];
1271 mLastPFEntryValue
[CpuIndex
][PFIndex
] = PageTable
[PTIndex
];
1272 mLastPFEntryPointer
[CpuIndex
][PFIndex
] = &PageTable
[PTIndex
];
1273 mPFEntryCount
[CpuIndex
]++;
1279 PageTable
[PTIndex
] = (PFAddress
& ~((1ull << 12) - 1));
1280 PageTable
[PTIndex
] |= (UINT64
)(IA32_PG_RW
| IA32_PG_P
);
1281 if ((ErrorCode
& IA32_PF_EC_ID
) != 0) {
1282 PageTable
[PTIndex
] &= ~IA32_PG_NX
;
1288 The Page fault handler to save SMM profile data.
1290 @param Rip The RIP when exception happens.
1291 @param ErrorCode The Error code of exception.
1295 SmmProfilePFHandler (
1304 UINT64 InstructionAddress
;
1305 UINTN MaxEntryNumber
;
1306 UINTN CurrentEntryNumber
;
1307 BOOLEAN IsValidPFAddress
;
1308 SMM_PROFILE_ENTRY
*SmmProfileEntry
;
1311 UINTN SwSmiCpuIndex
;
1313 EFI_SMM_SAVE_STATE_IO_INFO IoInfo
;
1315 if (!mSmmProfileStart
) {
1317 // If SMM profile does not start, call original page fault handler.
1319 SmiDefaultPFHandler ();
1323 if (mBtsSupported
) {
1327 IsValidPFAddress
= FALSE
;
1328 PageTable
= (UINT64
*)AsmReadCr3 ();
1329 PFAddress
= AsmReadCr2 ();
1330 CpuIndex
= GetCpuIndex ();
1332 if (PFAddress
<= 0xFFFFFFFF) {
1333 RestorePageTableBelow4G (PageTable
, PFAddress
, CpuIndex
, ErrorCode
);
1335 RestorePageTableAbove4G (PageTable
, PFAddress
, CpuIndex
, ErrorCode
, &IsValidPFAddress
);
1338 if (!IsValidPFAddress
) {
1339 InstructionAddress
= Rip
;
1340 if ((ErrorCode
& IA32_PF_EC_ID
) != 0 && (mBtsSupported
)) {
1342 // If it is instruction fetch failure, get the correct IP from BTS.
1344 InstructionAddress
= GetSourceFromDestinationOnBts (CpuIndex
, Rip
);
1345 if (InstructionAddress
== 0) {
1347 // It indicates the instruction which caused page fault is not a jump instruction,
1348 // set instruction address same as the page fault address.
1350 InstructionAddress
= PFAddress
;
1355 // Try to find which CPU trigger SWSMI
1359 // Indicate it is not software SMI
1361 SmiCommand
= 0xFFFFFFFFFFFFFFFFULL
;
1362 for (Index
= 0; Index
< gSmst
->NumberOfCpus
; Index
++) {
1363 Status
= SmmReadSaveState(&mSmmCpu
, sizeof(IoInfo
), EFI_SMM_SAVE_STATE_REGISTER_IO
, Index
, &IoInfo
);
1364 if (EFI_ERROR (Status
)) {
1367 if (IoInfo
.IoPort
== mSmiCommandPort
) {
1371 SwSmiCpuIndex
= Index
;
1373 // A software SMI triggered by SMI command port has been found, get SmiCommand from SMI command port.
1375 SoftSmiValue
= IoRead8 (mSmiCommandPort
);
1376 SmiCommand
= (UINT64
)SoftSmiValue
;
1381 SmmProfileEntry
= (SMM_PROFILE_ENTRY
*)(UINTN
)(mSmmProfileBase
+ 1);
1383 // Check if there is already a same entry in profile data.
1385 for (Index
= 0; Index
< (UINTN
) mSmmProfileBase
->CurDataEntries
; Index
++) {
1386 if ((SmmProfileEntry
[Index
].ErrorCode
== (UINT64
)ErrorCode
) &&
1387 (SmmProfileEntry
[Index
].Address
== PFAddress
) &&
1388 (SmmProfileEntry
[Index
].CpuNum
== (UINT64
)CpuIndex
) &&
1389 (SmmProfileEntry
[Index
].Instruction
== InstructionAddress
) &&
1390 (SmmProfileEntry
[Index
].SmiCmd
== SmiCommand
)) {
1392 // Same record exist, need not save again.
1397 if (Index
== mSmmProfileBase
->CurDataEntries
) {
1398 CurrentEntryNumber
= (UINTN
) mSmmProfileBase
->CurDataEntries
;
1399 MaxEntryNumber
= (UINTN
) mSmmProfileBase
->MaxDataEntries
;
1400 if (FeaturePcdGet (PcdCpuSmmProfileRingBuffer
)) {
1401 CurrentEntryNumber
= CurrentEntryNumber
% MaxEntryNumber
;
1403 if (CurrentEntryNumber
< MaxEntryNumber
) {
1405 // Log the new entry
1407 SmmProfileEntry
[CurrentEntryNumber
].SmiNum
= mSmmProfileBase
->NumSmis
;
1408 SmmProfileEntry
[CurrentEntryNumber
].ErrorCode
= (UINT64
)ErrorCode
;
1409 SmmProfileEntry
[CurrentEntryNumber
].ApicId
= (UINT64
)GetApicId ();
1410 SmmProfileEntry
[CurrentEntryNumber
].CpuNum
= (UINT64
)CpuIndex
;
1411 SmmProfileEntry
[CurrentEntryNumber
].Address
= PFAddress
;
1412 SmmProfileEntry
[CurrentEntryNumber
].Instruction
= InstructionAddress
;
1413 SmmProfileEntry
[CurrentEntryNumber
].SmiCmd
= SmiCommand
;
1415 // Update current entry index and data size in the header.
1417 mSmmProfileBase
->CurDataEntries
++;
1418 mSmmProfileBase
->CurDataSize
= MultU64x64 (mSmmProfileBase
->CurDataEntries
, sizeof (SMM_PROFILE_ENTRY
));
1427 if (mBtsSupported
) {
1433 Replace INT1 exception handler to restore page table to absent/execute-disable state
1434 in order to trigger page fault again to save SMM profile data..
1442 SmmRegisterExceptionHandler (&mSmmCpuService
, EXCEPT_IA32_DEBUG
, DebugExceptionHandler
);