2 Performance library instance used by SMM Core.
4 This library provides the performance measurement interfaces and initializes performance
5 logging for the SMM phase.
6 It initializes SMM phase performance logging by publishing the SMM Performance and PerformanceEx Protocol,
7 which is consumed by SmmPerformanceLib to logging performance data in SMM phase.
9 This library is mainly used by SMM Core to start performance logging to ensure that
10 SMM Performance and PerformanceEx Protocol are installed at the very beginning of SMM phase.
12 Caution: This module requires additional review when modified.
13 This driver will have external input - performance data and communicate buffer in SMM mode.
14 This external input must be validated carefully to avoid security issue like
15 buffer overflow, integer overflow.
17 SmmPerformanceHandlerEx(), SmmPerformanceHandler() will receive untrusted input and do basic validation.
19 Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
20 This program and the accompanying materials
21 are licensed and made available under the terms and conditions of the BSD License
22 which accompanies this distribution. The full text of the license may be found at
23 http://opensource.org/licenses/bsd-license.php
25 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
26 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
31 #include "SmmCorePerformanceLibInternal.h"
34 // The data structure to hold global performance data.
36 GAUGE_DATA_HEADER
*mGaugeData
;
39 // The current maximum number of logging entries. If current number of
40 // entries exceeds this value, it will re-allocate a larger array and
41 // migration the old data to the larger array.
43 UINT32 mMaxGaugeRecords
;
46 // The handle to install Performance Protocol instance.
48 EFI_HANDLE mHandle
= NULL
;
50 BOOLEAN mPerformanceMeasurementEnabled
;
52 SPIN_LOCK mSmmPerfLock
;
54 EFI_SMRAM_DESCRIPTOR
*mSmramRanges
;
55 UINTN mSmramRangeCount
;
58 // Interfaces for SMM Performance Protocol.
60 PERFORMANCE_PROTOCOL mPerformanceInterface
= {
67 // Interfaces for SMM PerformanceEx Protocol.
69 PERFORMANCE_EX_PROTOCOL mPerformanceExInterface
= {
76 Searches in the gauge array with keyword Handle, Token, Module and Identfier.
78 This internal function searches for the gauge entry in the gauge array.
79 If there is an entry that exactly matches the given keywords
80 and its end time stamp is zero, then the index of that gauge entry is returned;
81 otherwise, the the number of gauge entries in the array is returned.
83 @param Handle Pointer to environment specific context used
84 to identify the component being measured.
85 @param Token Pointer to a Null-terminated ASCII string
86 that identifies the component being measured.
87 @param Module Pointer to a Null-terminated ASCII string
88 that identifies the module being measured.
89 @param Identifier 32-bit identifier.
91 @retval The index of gauge entry in the array.
95 SmmSearchForGaugeEntry (
96 IN CONST VOID
*Handle
, OPTIONAL
97 IN CONST CHAR8
*Token
, OPTIONAL
98 IN CONST CHAR8
*Module
, OPTIONAL
99 IN CONST UINT32 Identifier
104 UINT32 NumberOfEntries
;
105 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
110 if (Module
== NULL
) {
114 NumberOfEntries
= mGaugeData
->NumberOfEntries
;
115 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
119 for (Index
= 0; Index
< NumberOfEntries
; Index
++) {
120 Index2
= NumberOfEntries
- 1 - Index
;
121 if (GaugeEntryExArray
[Index2
].EndTimeStamp
== 0 &&
122 (GaugeEntryExArray
[Index2
].Handle
== (EFI_PHYSICAL_ADDRESS
) (UINTN
) Handle
) &&
123 AsciiStrnCmp (GaugeEntryExArray
[Index2
].Token
, Token
, SMM_PERFORMANCE_STRING_LENGTH
) == 0 &&
124 AsciiStrnCmp (GaugeEntryExArray
[Index2
].Module
, Module
, SMM_PERFORMANCE_STRING_LENGTH
) == 0 &&
125 (GaugeEntryExArray
[Index2
].Identifier
== Identifier
)) {
135 Adds a record at the end of the performance measurement log
136 that records the start time of a performance measurement.
138 Adds a record to the end of the performance measurement log
139 that contains the Handle, Token, Module and Identifier.
140 The end time of the new record must be set to zero.
141 If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.
142 If TimeStamp is zero, the start time in the record is filled in with the value
143 read from the current time stamp.
145 @param Handle Pointer to environment specific context used
146 to identify the component being measured.
147 @param Token Pointer to a Null-terminated ASCII string
148 that identifies the component being measured.
149 @param Module Pointer to a Null-terminated ASCII string
150 that identifies the module being measured.
151 @param TimeStamp 64-bit time stamp.
152 @param Identifier 32-bit identifier. If the value is 0, the created record
153 is same as the one created by StartGauge of PERFORMANCE_PROTOCOL.
155 @retval EFI_SUCCESS The data was read correctly from the device.
156 @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.
162 IN CONST VOID
*Handle
, OPTIONAL
163 IN CONST CHAR8
*Token
, OPTIONAL
164 IN CONST CHAR8
*Module
, OPTIONAL
169 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
171 GAUGE_DATA_HEADER
*NewGaugeData
;
172 UINTN OldGaugeDataSize
;
173 GAUGE_DATA_HEADER
*OldGaugeData
;
176 AcquireSpinLock (&mSmmPerfLock
);
178 Index
= mGaugeData
->NumberOfEntries
;
179 if (Index
>= mMaxGaugeRecords
) {
181 // Try to enlarge the scale of gauge array.
183 OldGaugeData
= mGaugeData
;
184 OldGaugeDataSize
= sizeof (GAUGE_DATA_HEADER
) + sizeof (GAUGE_DATA_ENTRY_EX
) * mMaxGaugeRecords
;
186 GaugeDataSize
= sizeof (GAUGE_DATA_HEADER
) + sizeof (GAUGE_DATA_ENTRY_EX
) * mMaxGaugeRecords
* 2;
188 NewGaugeData
= AllocateZeroPool (GaugeDataSize
);
189 if (NewGaugeData
== NULL
) {
190 ReleaseSpinLock (&mSmmPerfLock
);
191 return EFI_OUT_OF_RESOURCES
;
194 mGaugeData
= NewGaugeData
;
195 mMaxGaugeRecords
*= 2;
198 // Initialize new data array and migrate old data one.
200 mGaugeData
= CopyMem (mGaugeData
, OldGaugeData
, OldGaugeDataSize
);
202 FreePool (OldGaugeData
);
205 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
206 GaugeEntryExArray
[Index
].Handle
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) Handle
;
209 AsciiStrnCpy (GaugeEntryExArray
[Index
].Token
, Token
, SMM_PERFORMANCE_STRING_LENGTH
);
211 if (Module
!= NULL
) {
212 AsciiStrnCpy (GaugeEntryExArray
[Index
].Module
, Module
, SMM_PERFORMANCE_STRING_LENGTH
);
215 GaugeEntryExArray
[Index
].EndTimeStamp
= 0;
216 GaugeEntryExArray
[Index
].Identifier
= Identifier
;
218 if (TimeStamp
== 0) {
219 TimeStamp
= GetPerformanceCounter ();
221 GaugeEntryExArray
[Index
].StartTimeStamp
= TimeStamp
;
223 mGaugeData
->NumberOfEntries
++;
225 ReleaseSpinLock (&mSmmPerfLock
);
231 Searches the performance measurement log from the beginning of the log
232 for the first matching record that contains a zero end time and fills in a valid end time.
234 Searches the performance measurement log from the beginning of the log
235 for the first record that matches Handle, Token, Module and Identifier and has an end time value of zero.
236 If the record can not be found then return EFI_NOT_FOUND.
237 If the record is found and TimeStamp is not zero,
238 then the end time in the record is filled in with the value specified by TimeStamp.
239 If the record is found and TimeStamp is zero, then the end time in the matching record
240 is filled in with the current time stamp value.
242 @param Handle Pointer to environment specific context used
243 to identify the component being measured.
244 @param Token Pointer to a Null-terminated ASCII string
245 that identifies the component being measured.
246 @param Module Pointer to a Null-terminated ASCII string
247 that identifies the module being measured.
248 @param TimeStamp 64-bit time stamp.
249 @param Identifier 32-bit identifier. If the value is 0, the found record
250 is same as the one found by EndGauge of PERFORMANCE_PROTOCOL.
252 @retval EFI_SUCCESS The end of the measurement was recorded.
253 @retval EFI_NOT_FOUND The specified measurement record could not be found.
259 IN CONST VOID
*Handle
, OPTIONAL
260 IN CONST CHAR8
*Token
, OPTIONAL
261 IN CONST CHAR8
*Module
, OPTIONAL
266 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
269 AcquireSpinLock (&mSmmPerfLock
);
271 if (TimeStamp
== 0) {
272 TimeStamp
= GetPerformanceCounter ();
275 Index
= SmmSearchForGaugeEntry (Handle
, Token
, Module
, Identifier
);
276 if (Index
>= mGaugeData
->NumberOfEntries
) {
277 ReleaseSpinLock (&mSmmPerfLock
);
278 return EFI_NOT_FOUND
;
280 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
281 GaugeEntryExArray
[Index
].EndTimeStamp
= TimeStamp
;
283 ReleaseSpinLock (&mSmmPerfLock
);
289 Retrieves a previously logged performance measurement.
290 It can also retrieve the log created by StartGauge and EndGauge of PERFORMANCE_PROTOCOL,
291 and then assign the Identifier with 0.
293 Retrieves the performance log entry from the performance log specified by LogEntryKey.
294 If it stands for a valid entry, then EFI_SUCCESS is returned and
295 GaugeDataEntryEx stores the pointer to that entry.
297 @param LogEntryKey The key for the previous performance measurement log entry.
298 If 0, then the first performance measurement log entry is retrieved.
299 @param GaugeDataEntryEx The indirect pointer to the extended gauge data entry specified by LogEntryKey
300 if the retrieval is successful.
302 @retval EFI_SUCCESS The GuageDataEntryEx is successfully found based on LogEntryKey.
303 @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).
304 @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).
305 @retval EFI_INVALIDE_PARAMETER GaugeDataEntryEx is NULL.
311 IN UINTN LogEntryKey
,
312 OUT GAUGE_DATA_ENTRY_EX
**GaugeDataEntryEx
315 UINTN NumberOfEntries
;
316 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
318 NumberOfEntries
= (UINTN
) (mGaugeData
->NumberOfEntries
);
319 if (LogEntryKey
> NumberOfEntries
) {
320 return EFI_INVALID_PARAMETER
;
322 if (LogEntryKey
== NumberOfEntries
) {
323 return EFI_NOT_FOUND
;
326 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
328 if (GaugeDataEntryEx
== NULL
) {
329 return EFI_INVALID_PARAMETER
;
331 *GaugeDataEntryEx
= &GaugeEntryExArray
[LogEntryKey
];
337 Adds a record at the end of the performance measurement log
338 that records the start time of a performance measurement.
340 Adds a record to the end of the performance measurement log
341 that contains the Handle, Token, and Module.
342 The end time of the new record must be set to zero.
343 If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.
344 If TimeStamp is zero, the start time in the record is filled in with the value
345 read from the current time stamp.
347 @param Handle Pointer to environment specific context used
348 to identify the component being measured.
349 @param Token Pointer to a Null-terminated ASCII string
350 that identifies the component being measured.
351 @param Module Pointer to a Null-terminated ASCII string
352 that identifies the module being measured.
353 @param TimeStamp 64-bit time stamp.
355 @retval EFI_SUCCESS The data was read correctly from the device.
356 @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.
362 IN CONST VOID
*Handle
, OPTIONAL
363 IN CONST CHAR8
*Token
, OPTIONAL
364 IN CONST CHAR8
*Module
, OPTIONAL
368 return StartGaugeEx (Handle
, Token
, Module
, TimeStamp
, 0);
372 Searches the performance measurement log from the beginning of the log
373 for the first matching record that contains a zero end time and fills in a valid end time.
375 Searches the performance measurement log from the beginning of the log
376 for the first record that matches Handle, Token, and Module and has an end time value of zero.
377 If the record can not be found then return EFI_NOT_FOUND.
378 If the record is found and TimeStamp is not zero,
379 then the end time in the record is filled in with the value specified by TimeStamp.
380 If the record is found and TimeStamp is zero, then the end time in the matching record
381 is filled in with the current time stamp value.
383 @param Handle Pointer to environment specific context used
384 to identify the component being measured.
385 @param Token Pointer to a Null-terminated ASCII string
386 that identifies the component being measured.
387 @param Module Pointer to a Null-terminated ASCII string
388 that identifies the module being measured.
389 @param TimeStamp 64-bit time stamp.
391 @retval EFI_SUCCESS The end of the measurement was recorded.
392 @retval EFI_NOT_FOUND The specified measurement record could not be found.
398 IN CONST VOID
*Handle
, OPTIONAL
399 IN CONST CHAR8
*Token
, OPTIONAL
400 IN CONST CHAR8
*Module
, OPTIONAL
404 return EndGaugeEx (Handle
, Token
, Module
, TimeStamp
, 0);
408 Retrieves a previously logged performance measurement.
409 It can also retrieve the log created by StartGaugeEx and EndGaugeEx of PERFORMANCE_EX_PROTOCOL,
410 and then eliminate the Identifier.
412 Retrieves the performance log entry from the performance log specified by LogEntryKey.
413 If it stands for a valid entry, then EFI_SUCCESS is returned and
414 GaugeDataEntry stores the pointer to that entry.
416 @param LogEntryKey The key for the previous performance measurement log entry.
417 If 0, then the first performance measurement log entry is retrieved.
418 @param GaugeDataEntry The indirect pointer to the gauge data entry specified by LogEntryKey
419 if the retrieval is successful.
421 @retval EFI_SUCCESS The GuageDataEntry is successfully found based on LogEntryKey.
422 @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).
423 @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).
424 @retval EFI_INVALIDE_PARAMETER GaugeDataEntry is NULL.
430 IN UINTN LogEntryKey
,
431 OUT GAUGE_DATA_ENTRY
**GaugeDataEntry
435 GAUGE_DATA_ENTRY_EX
*GaugeEntryEx
;
439 Status
= GetGaugeEx (LogEntryKey
, &GaugeEntryEx
);
440 if (EFI_ERROR (Status
)) {
444 if (GaugeDataEntry
== NULL
) {
445 return EFI_INVALID_PARAMETER
;
448 *GaugeDataEntry
= (GAUGE_DATA_ENTRY
*) GaugeEntryEx
;
454 This function check if the address is in SMRAM.
456 @param Buffer the buffer address to be checked.
457 @param Length the buffer length to be checked.
459 @retval TRUE this address is in SMRAM.
460 @retval FALSE this address is NOT in SMRAM.
464 IN EFI_PHYSICAL_ADDRESS Buffer
,
470 for (Index
= 0; Index
< mSmramRangeCount
; Index
++) {
471 if (((Buffer
>= mSmramRanges
[Index
].CpuStart
) && (Buffer
< mSmramRanges
[Index
].CpuStart
+ mSmramRanges
[Index
].PhysicalSize
)) ||
472 ((mSmramRanges
[Index
].CpuStart
>= Buffer
) && (mSmramRanges
[Index
].CpuStart
< Buffer
+ Length
))) {
481 This function check if the address refered by Buffer and Length is valid.
483 @param Buffer the buffer address to be checked.
484 @param Length the buffer length to be checked.
486 @retval TRUE this address is valid.
487 @retval FALSE this address is NOT valid.
495 if (Buffer
> (MAX_ADDRESS
- Length
)) {
501 if (IsAddressInSmram ((EFI_PHYSICAL_ADDRESS
)Buffer
, (UINT64
)Length
)) {
508 Communication service SMI Handler entry.
510 This SMI handler provides services for the performance wrapper driver.
512 Caution: This function may receive untrusted input.
513 Communicate buffer and buffer size are external input, so this function will do basic validation.
515 @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
516 @param[in] RegisterContext Points to an optional handler context which was specified when the
517 handler was registered.
518 @param[in, out] CommBuffer A pointer to a collection of data in memory that will
519 be conveyed from a non-SMM environment into an SMM environment.
520 @param[in, out] CommBufferSize The size of the CommBuffer.
522 @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers
523 should still be called.
524 @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should
526 @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still
528 @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.
532 SmmPerformanceHandlerEx (
533 IN EFI_HANDLE DispatchHandle
,
534 IN CONST VOID
*RegisterContext
,
535 IN OUT VOID
*CommBuffer
,
536 IN OUT UINTN
*CommBufferSize
540 SMM_PERF_COMMUNICATE_EX
*SmmPerfCommData
;
541 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
544 GaugeEntryExArray
= NULL
;
547 // If input is invalid, stop processing this SMI
549 if (CommBuffer
== NULL
|| CommBufferSize
== NULL
) {
553 if(*CommBufferSize
< sizeof (SMM_PERF_COMMUNICATE_EX
)) {
557 if (!IsAddressValid ((UINTN
)CommBuffer
, *CommBufferSize
)) {
558 DEBUG ((EFI_D_ERROR
, "SMM communcation data buffer in SMRAM or overflow!\n"));
562 SmmPerfCommData
= (SMM_PERF_COMMUNICATE_EX
*)CommBuffer
;
564 switch (SmmPerfCommData
->Function
) {
565 case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER
:
566 SmmPerfCommData
->NumberOfEntries
= mGaugeData
->NumberOfEntries
;
567 Status
= EFI_SUCCESS
;
570 case SMM_PERF_FUNCTION_GET_GAUGE_DATA
:
571 if ( SmmPerfCommData
->GaugeDataEx
== NULL
|| SmmPerfCommData
->NumberOfEntries
== 0 ||
572 (SmmPerfCommData
->LogEntryKey
+ SmmPerfCommData
->NumberOfEntries
) > mGaugeData
->NumberOfEntries
) {
573 Status
= EFI_INVALID_PARAMETER
;
580 DataSize
= SmmPerfCommData
->NumberOfEntries
* sizeof(GAUGE_DATA_ENTRY_EX
);
581 if (!IsAddressValid ((UINTN
)SmmPerfCommData
->GaugeDataEx
, DataSize
)) {
582 DEBUG ((EFI_D_ERROR
, "SMM Performance Data buffer in SMRAM or overflow!\n"));
583 Status
= EFI_ACCESS_DENIED
;
587 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
589 (UINT8
*) (SmmPerfCommData
->GaugeDataEx
),
590 (UINT8
*) &GaugeEntryExArray
[SmmPerfCommData
->LogEntryKey
],
593 Status
= EFI_SUCCESS
;
597 Status
= EFI_UNSUPPORTED
;
601 SmmPerfCommData
->ReturnStatus
= Status
;
607 Communication service SMI Handler entry.
609 This SMI handler provides services for the performance wrapper driver.
611 Caution: This function may receive untrusted input.
612 Communicate buffer and buffer size are external input, so this function will do basic validation.
614 @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
615 @param[in] RegisterContext Points to an optional handler context which was specified when the
616 handler was registered.
617 @param[in, out] CommBuffer A pointer to a collection of data in memory that will
618 be conveyed from a non-SMM environment into an SMM environment.
619 @param[in, out] CommBufferSize The size of the CommBuffer.
621 @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers
622 should still be called.
623 @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should
625 @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still
627 @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.
631 SmmPerformanceHandler (
632 IN EFI_HANDLE DispatchHandle
,
633 IN CONST VOID
*RegisterContext
,
634 IN OUT VOID
*CommBuffer
,
635 IN OUT UINTN
*CommBufferSize
639 SMM_PERF_COMMUNICATE
*SmmPerfCommData
;
640 GAUGE_DATA_ENTRY_EX
*GaugeEntryExArray
;
645 GaugeEntryExArray
= NULL
;
648 // If input is invalid, stop processing this SMI
650 if (CommBuffer
== NULL
|| CommBufferSize
== NULL
) {
654 if(*CommBufferSize
< sizeof (SMM_PERF_COMMUNICATE
)) {
658 if (!IsAddressValid ((UINTN
)CommBuffer
, *CommBufferSize
)) {
659 DEBUG ((EFI_D_ERROR
, "SMM communcation data buffer in SMRAM or overflow!\n"));
663 SmmPerfCommData
= (SMM_PERF_COMMUNICATE
*)CommBuffer
;
665 switch (SmmPerfCommData
->Function
) {
666 case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER
:
667 SmmPerfCommData
->NumberOfEntries
= mGaugeData
->NumberOfEntries
;
668 Status
= EFI_SUCCESS
;
671 case SMM_PERF_FUNCTION_GET_GAUGE_DATA
:
672 if ( SmmPerfCommData
->GaugeData
== NULL
|| SmmPerfCommData
->NumberOfEntries
== 0 ||
673 (SmmPerfCommData
->LogEntryKey
+ SmmPerfCommData
->NumberOfEntries
) > mGaugeData
->NumberOfEntries
) {
674 Status
= EFI_INVALID_PARAMETER
;
681 DataSize
= SmmPerfCommData
->NumberOfEntries
* sizeof(GAUGE_DATA_ENTRY
);
682 if (!IsAddressValid ((UINTN
)SmmPerfCommData
->GaugeData
, DataSize
)) {
683 DEBUG ((EFI_D_ERROR
, "SMM Performance Data buffer in SMRAM or overflow!\n"));
684 Status
= EFI_ACCESS_DENIED
;
688 GaugeEntryExArray
= (GAUGE_DATA_ENTRY_EX
*) (mGaugeData
+ 1);
690 LogEntryKey
= SmmPerfCommData
->LogEntryKey
;
691 for (Index
= 0; Index
< SmmPerfCommData
->NumberOfEntries
; Index
++) {
693 (UINT8
*) &(SmmPerfCommData
->GaugeData
[Index
]),
694 (UINT8
*) &GaugeEntryExArray
[LogEntryKey
++],
695 sizeof (GAUGE_DATA_ENTRY
)
698 Status
= EFI_SUCCESS
;
702 Status
= EFI_UNSUPPORTED
;
706 SmmPerfCommData
->ReturnStatus
= Status
;
712 SmmBase2 protocol notify callback function, when SMST and SMM memory service get initialized
713 this function is callbacked to initialize the Smm Performance Lib
715 @param Event The event of notify protocol.
716 @param Context Notify event context.
721 InitializeSmmCorePerformanceLib (
728 EFI_SMM_ACCESS2_PROTOCOL
*SmmAccess
;
733 // Initialize spin lock
735 InitializeSpinLock (&mSmmPerfLock
);
737 mMaxGaugeRecords
= INIT_SMM_GAUGE_DATA_ENTRIES
;
739 mGaugeData
= AllocateZeroPool (sizeof (GAUGE_DATA_HEADER
) + (sizeof (GAUGE_DATA_ENTRY_EX
) * mMaxGaugeRecords
));
740 ASSERT (mGaugeData
!= NULL
);
743 // Get SMRAM information
745 Status
= gBS
->LocateProtocol (&gEfiSmmAccess2ProtocolGuid
, NULL
, (VOID
**)&SmmAccess
);
746 ASSERT_EFI_ERROR (Status
);
749 Status
= SmmAccess
->GetCapabilities (SmmAccess
, &Size
, NULL
);
750 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
752 Status
= gSmst
->SmmAllocatePool (
753 EfiRuntimeServicesData
,
755 (VOID
**)&mSmramRanges
757 ASSERT_EFI_ERROR (Status
);
759 Status
= SmmAccess
->GetCapabilities (SmmAccess
, &Size
, mSmramRanges
);
760 ASSERT_EFI_ERROR (Status
);
762 mSmramRangeCount
= Size
/ sizeof (EFI_SMRAM_DESCRIPTOR
);
765 // Install the protocol interfaces.
767 Status
= gSmst
->SmmInstallProtocolInterface (
769 &gSmmPerformanceProtocolGuid
,
770 EFI_NATIVE_INTERFACE
,
771 &mPerformanceInterface
773 ASSERT_EFI_ERROR (Status
);
775 Status
= gSmst
->SmmInstallProtocolInterface (
777 &gSmmPerformanceExProtocolGuid
,
778 EFI_NATIVE_INTERFACE
,
779 &mPerformanceExInterface
781 ASSERT_EFI_ERROR (Status
);
784 /// Register SMM Performance SMI handler
787 Status
= gSmst
->SmiHandlerRegister (SmmPerformanceHandler
, &gSmmPerformanceProtocolGuid
, &Handle
);
788 ASSERT_EFI_ERROR (Status
);
789 Status
= gSmst
->SmiHandlerRegister (SmmPerformanceHandlerEx
, &gSmmPerformanceExProtocolGuid
, &Handle
);
790 ASSERT_EFI_ERROR (Status
);
794 The constructor function initializes the Performance Measurement Enable flag and
795 registers SmmBase2 protocol notify callback.
796 It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.
798 @param ImageHandle The firmware allocated handle for the EFI image.
799 @param SystemTable A pointer to the EFI System Table.
801 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
806 SmmCorePerformanceLibConstructor (
807 IN EFI_HANDLE ImageHandle
,
808 IN EFI_SYSTEM_TABLE
*SystemTable
815 mPerformanceMeasurementEnabled
= (BOOLEAN
) ((PcdGet8(PcdPerformanceLibraryPropertyMask
) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED
) != 0);
816 if (!mPerformanceMeasurementEnabled
) {
818 // Do not initialize performance infrastructure if not required.
824 // Create the events to do the library init.
826 Status
= gBS
->CreateEvent (
829 InitializeSmmCorePerformanceLib
,
833 ASSERT_EFI_ERROR (Status
);
836 // Register for protocol notifications on this event
838 Status
= gBS
->RegisterProtocolNotify (
839 &gEfiSmmBase2ProtocolGuid
,
844 ASSERT_EFI_ERROR (Status
);
850 Adds a record at the end of the performance measurement log
851 that records the start time of a performance measurement.
853 Adds a record to the end of the performance measurement log
854 that contains the Handle, Token, Module and Identifier.
855 The end time of the new record must be set to zero.
856 If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.
857 If TimeStamp is zero, the start time in the record is filled in with the value
858 read from the current time stamp.
860 @param Handle Pointer to environment specific context used
861 to identify the component being measured.
862 @param Token Pointer to a Null-terminated ASCII string
863 that identifies the component being measured.
864 @param Module Pointer to a Null-terminated ASCII string
865 that identifies the module being measured.
866 @param TimeStamp 64-bit time stamp.
867 @param Identifier 32-bit identifier. If the value is 0, the created record
868 is same as the one created by StartPerformanceMeasurement.
870 @retval RETURN_SUCCESS The start of the measurement was recorded.
871 @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
876 StartPerformanceMeasurementEx (
877 IN CONST VOID
*Handle
, OPTIONAL
878 IN CONST CHAR8
*Token
, OPTIONAL
879 IN CONST CHAR8
*Module
, OPTIONAL
884 return (RETURN_STATUS
) StartGaugeEx (Handle
, Token
, Module
, TimeStamp
, Identifier
);
888 Searches the performance measurement log from the beginning of the log
889 for the first matching record that contains a zero end time and fills in a valid end time.
891 Searches the performance measurement log from the beginning of the log
892 for the first record that matches Handle, Token, Module and Identifier and has an end time value of zero.
893 If the record can not be found then return RETURN_NOT_FOUND.
894 If the record is found and TimeStamp is not zero,
895 then the end time in the record is filled in with the value specified by TimeStamp.
896 If the record is found and TimeStamp is zero, then the end time in the matching record
897 is filled in with the current time stamp value.
899 @param Handle Pointer to environment specific context used
900 to identify the component being measured.
901 @param Token Pointer to a Null-terminated ASCII string
902 that identifies the component being measured.
903 @param Module Pointer to a Null-terminated ASCII string
904 that identifies the module being measured.
905 @param TimeStamp 64-bit time stamp.
906 @param Identifier 32-bit identifier. If the value is 0, the found record
907 is same as the one found by EndPerformanceMeasurement.
909 @retval RETURN_SUCCESS The end of the measurement was recorded.
910 @retval RETURN_NOT_FOUND The specified measurement record could not be found.
915 EndPerformanceMeasurementEx (
916 IN CONST VOID
*Handle
, OPTIONAL
917 IN CONST CHAR8
*Token
, OPTIONAL
918 IN CONST CHAR8
*Module
, OPTIONAL
923 return (RETURN_STATUS
) EndGaugeEx (Handle
, Token
, Module
, TimeStamp
, Identifier
);
927 Attempts to retrieve a performance measurement log entry from the performance measurement log.
928 It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,
929 and then assign the Identifier with 0.
931 Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is
932 zero on entry, then an attempt is made to retrieve the first entry from the performance log,
933 and the key for the second entry in the log is returned. If the performance log is empty,
934 then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance
935 log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is
936 returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is
937 retrieved and an implementation specific non-zero key value that specifies the end of the performance
938 log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry
939 is retrieved and zero is returned. In the cases where a performance log entry can be returned,
940 the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.
941 If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().
942 If Handle is NULL, then ASSERT().
943 If Token is NULL, then ASSERT().
944 If Module is NULL, then ASSERT().
945 If StartTimeStamp is NULL, then ASSERT().
946 If EndTimeStamp is NULL, then ASSERT().
947 If Identifier is NULL, then ASSERT().
949 @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.
950 0, then the first performance measurement log entry is retrieved.
951 On exit, the key of the next performance log entry.
952 @param Handle Pointer to environment specific context used to identify the component
954 @param Token Pointer to a Null-terminated ASCII string that identifies the component
956 @param Module Pointer to a Null-terminated ASCII string that identifies the module
958 @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
960 @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
962 @param Identifier Pointer to the 32-bit identifier that was recorded.
964 @return The key for the next performance log entry (in general case).
969 GetPerformanceMeasurementEx (
970 IN UINTN LogEntryKey
,
971 OUT CONST VOID
**Handle
,
972 OUT CONST CHAR8
**Token
,
973 OUT CONST CHAR8
**Module
,
974 OUT UINT64
*StartTimeStamp
,
975 OUT UINT64
*EndTimeStamp
,
976 OUT UINT32
*Identifier
980 GAUGE_DATA_ENTRY_EX
*GaugeData
;
984 ASSERT (Handle
!= NULL
);
985 ASSERT (Token
!= NULL
);
986 ASSERT (Module
!= NULL
);
987 ASSERT (StartTimeStamp
!= NULL
);
988 ASSERT (EndTimeStamp
!= NULL
);
989 ASSERT (Identifier
!= NULL
);
991 Status
= GetGaugeEx (LogEntryKey
++, &GaugeData
);
994 // Make sure that LogEntryKey is a valid log entry key,
996 ASSERT (Status
!= EFI_INVALID_PARAMETER
);
998 if (EFI_ERROR (Status
)) {
1000 // The LogEntryKey is the last entry (equals to the total entry number).
1005 ASSERT (GaugeData
!= NULL
);
1007 *Handle
= (VOID
*) (UINTN
) GaugeData
->Handle
;
1008 *Token
= GaugeData
->Token
;
1009 *Module
= GaugeData
->Module
;
1010 *StartTimeStamp
= GaugeData
->StartTimeStamp
;
1011 *EndTimeStamp
= GaugeData
->EndTimeStamp
;
1012 *Identifier
= GaugeData
->Identifier
;
1018 Adds a record at the end of the performance measurement log
1019 that records the start time of a performance measurement.
1021 Adds a record to the end of the performance measurement log
1022 that contains the Handle, Token, and Module.
1023 The end time of the new record must be set to zero.
1024 If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.
1025 If TimeStamp is zero, the start time in the record is filled in with the value
1026 read from the current time stamp.
1028 @param Handle Pointer to environment specific context used
1029 to identify the component being measured.
1030 @param Token Pointer to a Null-terminated ASCII string
1031 that identifies the component being measured.
1032 @param Module Pointer to a Null-terminated ASCII string
1033 that identifies the module being measured.
1034 @param TimeStamp 64-bit time stamp.
1036 @retval RETURN_SUCCESS The start of the measurement was recorded.
1037 @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
1042 StartPerformanceMeasurement (
1043 IN CONST VOID
*Handle
, OPTIONAL
1044 IN CONST CHAR8
*Token
, OPTIONAL
1045 IN CONST CHAR8
*Module
, OPTIONAL
1049 return StartPerformanceMeasurementEx (Handle
, Token
, Module
, TimeStamp
, 0);
1053 Searches the performance measurement log from the beginning of the log
1054 for the first matching record that contains a zero end time and fills in a valid end time.
1056 Searches the performance measurement log from the beginning of the log
1057 for the first record that matches Handle, Token, and Module and has an end time value of zero.
1058 If the record can not be found then return RETURN_NOT_FOUND.
1059 If the record is found and TimeStamp is not zero,
1060 then the end time in the record is filled in with the value specified by TimeStamp.
1061 If the record is found and TimeStamp is zero, then the end time in the matching record
1062 is filled in with the current time stamp value.
1064 @param Handle Pointer to environment specific context used
1065 to identify the component being measured.
1066 @param Token Pointer to a Null-terminated ASCII string
1067 that identifies the component being measured.
1068 @param Module Pointer to a Null-terminated ASCII string
1069 that identifies the module being measured.
1070 @param TimeStamp 64-bit time stamp.
1072 @retval RETURN_SUCCESS The end of the measurement was recorded.
1073 @retval RETURN_NOT_FOUND The specified measurement record could not be found.
1078 EndPerformanceMeasurement (
1079 IN CONST VOID
*Handle
, OPTIONAL
1080 IN CONST CHAR8
*Token
, OPTIONAL
1081 IN CONST CHAR8
*Module
, OPTIONAL
1085 return EndPerformanceMeasurementEx (Handle
, Token
, Module
, TimeStamp
, 0);
1089 Attempts to retrieve a performance measurement log entry from the performance measurement log.
1090 It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,
1091 and then eliminate the Identifier.
1093 Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is
1094 zero on entry, then an attempt is made to retrieve the first entry from the performance log,
1095 and the key for the second entry in the log is returned. If the performance log is empty,
1096 then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance
1097 log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is
1098 returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is
1099 retrieved and an implementation specific non-zero key value that specifies the end of the performance
1100 log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry
1101 is retrieved and zero is returned. In the cases where a performance log entry can be returned,
1102 the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.
1103 If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().
1104 If Handle is NULL, then ASSERT().
1105 If Token is NULL, then ASSERT().
1106 If Module is NULL, then ASSERT().
1107 If StartTimeStamp is NULL, then ASSERT().
1108 If EndTimeStamp is NULL, then ASSERT().
1110 @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.
1111 0, then the first performance measurement log entry is retrieved.
1112 On exit, the key of the next performance log entry.
1113 @param Handle Pointer to environment specific context used to identify the component
1115 @param Token Pointer to a Null-terminated ASCII string that identifies the component
1117 @param Module Pointer to a Null-terminated ASCII string that identifies the module
1119 @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
1121 @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
1124 @return The key for the next performance log entry (in general case).
1129 GetPerformanceMeasurement (
1130 IN UINTN LogEntryKey
,
1131 OUT CONST VOID
**Handle
,
1132 OUT CONST CHAR8
**Token
,
1133 OUT CONST CHAR8
**Module
,
1134 OUT UINT64
*StartTimeStamp
,
1135 OUT UINT64
*EndTimeStamp
1139 return GetPerformanceMeasurementEx (LogEntryKey
, Handle
, Token
, Module
, StartTimeStamp
, EndTimeStamp
, &Identifier
);
1143 Returns TRUE if the performance measurement macros are enabled.
1145 This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
1146 PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.
1148 @retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
1149 PcdPerformanceLibraryPropertyMask is set.
1150 @retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
1151 PcdPerformanceLibraryPropertyMask is clear.
1156 PerformanceMeasurementEnabled (
1160 return mPerformanceMeasurementEnabled
;