#include <Guid/PerformanceMeasurement.h>
#include <Library/PerformanceLib.h>
#include <Library/DebugLib.h>
#include <Library/SmmServicesTableLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseMemoryLib.h>

Functions
EFI_STATUS EFIAPI	SmmPerformanceLibExitBootServicesCallback (IN CONST EFI_GUID Protocol, IN VOID Interface, IN EFI_HANDLE Handle)

EFI_STATUS EFIAPI	SmmPerformanceLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS EFIAPI	SmmPerformanceLibDestructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS	GetPerformanceMeasurementProtocol (VOID)

RETURN_STATUS EFIAPI	StartPerformanceMeasurementEx (IN CONST VOID Handle OPTIONAL, IN CONST CHAR8 Token OPTIONAL, IN CONST CHAR8 *Module OPTIONAL, IN UINT64 TimeStamp, IN UINT32 Identifier)

RETURN_STATUS EFIAPI	EndPerformanceMeasurementEx (IN CONST VOID Handle OPTIONAL, IN CONST CHAR8 Token OPTIONAL, IN CONST CHAR8 *Module OPTIONAL, IN UINT64 TimeStamp, IN UINT32 Identifier)

UINTN EFIAPI	GetPerformanceMeasurementEx (IN UINTN LogEntryKey, OUT CONST VOID Handle, OUT CONST CHAR8 Token, OUT CONST CHAR8 *Module, OUT UINT64 StartTimeStamp, OUT UINT64 EndTimeStamp, OUT UINT32 Identifier)

RETURN_STATUS EFIAPI	StartPerformanceMeasurement (IN CONST VOID Handle OPTIONAL, IN CONST CHAR8 Token OPTIONAL, IN CONST CHAR8 *Module OPTIONAL, IN UINT64 TimeStamp)

RETURN_STATUS EFIAPI	EndPerformanceMeasurement (IN CONST VOID Handle OPTIONAL, IN CONST CHAR8 Token OPTIONAL, IN CONST CHAR8 *Module OPTIONAL, IN UINT64 TimeStamp)

UINTN EFIAPI	GetPerformanceMeasurement (IN UINTN LogEntryKey, OUT CONST VOID Handle, OUT CONST CHAR8 Token, OUT CONST CHAR8 *Module, OUT UINT64 StartTimeStamp, OUT UINT64 *EndTimeStamp)

BOOLEAN EFIAPI	PerformanceMeasurementEnabled (VOID)

RETURN_STATUS EFIAPI	LogPerformanceMeasurement (IN CONST VOID CallerIdentifier, IN CONST VOID Guid OPTIONAL, IN CONST CHAR8 *String OPTIONAL, IN UINT64 Address OPTIONAL, IN UINT32 Identifier)

BOOLEAN EFIAPI	LogPerformanceMeasurementEnabled (IN CONST UINTN Type)

Variables
EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL *	mPerformanceMeasurement = NULL

BOOLEAN	mPerformanceMeasurementEnabled

VOID *	mPerformanceLibExitBootServicesRegistration

Detailed Description

Performance Library used in SMM phase.

This library instance provides infrastructure for SMM drivers to log performance data. It consumes SMM PerformanceEx or Performance Protocol published by SmmCorePerformanceLib to log performance data. If both SMM PerformanceEx and Performance Protocol are not available, it does not log any performance information.

Copyright (c) 2011 - 2023, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SmmPerformanceLib.c.

Function Documentation

◆ EndPerformanceMeasurement()

RETURN_STATUS EFIAPI EndPerformanceMeasurement	(	IN CONST VOID *Handle	OPTIONAL,
		IN CONST CHAR8 *Token	OPTIONAL,
		IN CONST CHAR8 *Module	OPTIONAL,
		IN UINT64	TimeStamp
	)

Fills in the end time of a performance measurement.

Looks up the record that matches Handle, Token, and Module. If the record can not be found then return RETURN_NOT_FOUND. If the record is found and TimeStamp is not zero, then TimeStamp is added to the record as the end time. If the record is found and TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the end time.

Parameters

Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
TimeStamp	64-bit time stamp.

Return values

RETURN_SUCCESS	The end of the measurement was recorded.
RETURN_NOT_FOUND	The specified measurement record could not be found.

Definition at line 379 of file SmmPerformanceLib.c.

◆ EndPerformanceMeasurementEx()

RETURN_STATUS EFIAPI EndPerformanceMeasurementEx	(	IN CONST VOID *Handle	OPTIONAL,
		IN CONST CHAR8 *Token	OPTIONAL,
		IN CONST CHAR8 *Module	OPTIONAL,
		IN UINT64	TimeStamp,
		IN UINT32	Identifier
	)

Fills in the end time of a performance measurement.

Looks up the record that matches Handle, Token and Module. If the record can not be found then return RETURN_NOT_FOUND. If the record is found and TimeStamp is not zero, then TimeStamp is added to the record as the end time. If the record is found and TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the end time.

Parameters

Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
TimeStamp	64-bit time stamp.
Identifier	32-bit identifier. If the value is 0, the found record is same as the one found by EndPerformanceMeasurement.

Return values

RETURN_SUCCESS	The end of the measurement was recorded.
RETURN_NOT_FOUND	The specified measurement record could not be found.

Definition at line 234 of file SmmPerformanceLib.c.

◆ GetPerformanceMeasurement()

UINTN EFIAPI GetPerformanceMeasurement	(	IN UINTN	LogEntryKey,
		OUT CONST VOID **	Handle,
		OUT CONST CHAR8 **	Token,
		OUT CONST CHAR8 **	Module,
		OUT UINT64 *	StartTimeStamp,
		OUT UINT64 *	EndTimeStamp
	)

Attempts to retrieve a performance measurement log entry from the performance measurement log. It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx, and then eliminate the Identifier.

Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is zero on entry, then an attempt is made to retrieve the first entry from the performance log, and the key for the second entry in the log is returned. If the performance log is empty, then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is retrieved and an implementation specific non-zero key value that specifies the end of the performance log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry is retrieved and zero is returned. In the cases where a performance log entry can be returned, the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp. If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT(). If Handle is NULL, then ASSERT(). If Token is NULL, then ASSERT(). If Module is NULL, then ASSERT(). If StartTimeStamp is NULL, then ASSERT(). If EndTimeStamp is NULL, then ASSERT().

Parameters

LogEntryKey	On entry, the key of the performance measurement log entry to retrieve. 0, then the first performance measurement log entry is retrieved. On exit, the key of the next performance log entry.
Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
StartTimeStamp	Pointer to the 64-bit time stamp that was recorded when the measurement was started.
EndTimeStamp	Pointer to the 64-bit time stamp that was recorded when the measurement was ended.

Returns: The key for the next performance log entry (in general case).

Definition at line 430 of file SmmPerformanceLib.c.

◆ GetPerformanceMeasurementEx()

UINTN EFIAPI GetPerformanceMeasurementEx	(	IN UINTN	LogEntryKey,
		OUT CONST VOID **	Handle,
		OUT CONST CHAR8 **	Token,
		OUT CONST CHAR8 **	Module,
		OUT UINT64 *	StartTimeStamp,
		OUT UINT64 *	EndTimeStamp,
		OUT UINT32 *	Identifier
	)

Attempts to retrieve a performance measurement log entry from the performance measurement log. It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement, and then assign the Identifier with 0.

Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is zero on entry, then an attempt is made to retrieve the first entry from the performance log, and the key for the second entry in the log is returned. If the performance log is empty, then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is retrieved and an implementation specific non-zero key value that specifies the end of the performance log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry is retrieved and zero is returned. In the cases where a performance log entry can be returned, the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier. If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT(). If Handle is NULL, then ASSERT(). If Token is NULL, then ASSERT(). If Module is NULL, then ASSERT(). If StartTimeStamp is NULL, then ASSERT(). If EndTimeStamp is NULL, then ASSERT(). If Identifier is NULL, then ASSERT().

Parameters

LogEntryKey	On entry, the key of the performance measurement log entry to retrieve. 0, then the first performance measurement log entry is retrieved. On exit, the key of the next performance log entry.
Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
StartTimeStamp	Pointer to the 64-bit time stamp that was recorded when the measurement was started.
EndTimeStamp	Pointer to the 64-bit time stamp that was recorded when the measurement was ended.
Identifier	Pointer to the 32-bit identifier that was recorded.

Returns: The key for the next performance log entry (in general case).

Definition at line 310 of file SmmPerformanceLib.c.

◆ GetPerformanceMeasurementProtocol()

EFI_STATUS GetPerformanceMeasurementProtocol ( VOID )

The function caches the pointers to SMM PerformanceEx protocol and Performance Protocol.

The function locates SMM PerformanceEx protocol and Performance Protocol from protocol database.

Return values

EFI_SUCCESS	SMM PerformanceEx protocol or Performance Protocol is successfully located.
EFI_NOT_FOUND	Both SMM PerformanceEx protocol and Performance Protocol are not located to log performance.

Definition at line 127 of file SmmPerformanceLib.c.

◆ LogPerformanceMeasurement()

RETURN_STATUS EFIAPI LogPerformanceMeasurement	(	IN CONST VOID *	CallerIdentifier,
		IN CONST VOID *Guid	OPTIONAL,
		IN CONST CHAR8 *String	OPTIONAL,
		IN UINT64 Address	OPTIONAL,
		IN UINT32	Identifier
	)

Create performance record with event description and a timestamp.

Parameters

CallerIdentifier	- Image handle or pointer to caller ID GUID
Guid	- Pointer to a GUID
String	- Pointer to a string describing the measurement
Address	- Pointer to a location in memory relevant to the measurement
Identifier	- Performance identifier describing the type of measurement

Return values

RETURN_SUCCESS	- Successfully created performance record
RETURN_OUT_OF_RESOURCES	- Ran out of space to store the records
RETURN_INVALID_PARAMETER	- Invalid parameter passed to function - NULL pointer or invalid PerfId

Definition at line 480 of file SmmPerformanceLib.c.

◆ LogPerformanceMeasurementEnabled()

BOOLEAN EFIAPI LogPerformanceMeasurementEnabled ( IN CONST UINTN Type )

Check whether the specified performance measurement can be logged.

This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.

Parameters

Type	- Type of the performance measurement entry.

Return values

TRUE	The performance measurement can be logged.
FALSE	The performance measurement can NOT be logged.

Definition at line 518 of file SmmPerformanceLib.c.

◆ PerformanceMeasurementEnabled()

BOOLEAN EFIAPI PerformanceMeasurementEnabled ( VOID )

Returns TRUE if the performance measurement macros are enabled.

This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.

Return values

TRUE	The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set.
FALSE	The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is clear.

Definition at line 456 of file SmmPerformanceLib.c.

◆ SmmPerformanceLibConstructor()

EFI_STATUS EFIAPI SmmPerformanceLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function initializes the Performance Measurement Enable flag

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 68 of file SmmPerformanceLib.c.

◆ SmmPerformanceLibDestructor()

EFI_STATUS EFIAPI SmmPerformanceLibDestructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The destructor function frees resources allocated by constructor.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The destructor always returns EFI_SUCCESS.

Definition at line 97 of file SmmPerformanceLib.c.

◆ SmmPerformanceLibExitBootServicesCallback()

EFI_STATUS EFIAPI SmmPerformanceLibExitBootServicesCallback	(	IN CONST EFI_GUID *	Protocol,
		IN VOID *	Interface,
		IN EFI_HANDLE	Handle
	)

This is the Event call back function is triggered in SMM to notify the Library the system is entering runtime phase.

Parameters

[in]	Protocol	Points to the protocol's unique identifier
[in]	Interface	Points to the interface instance
[in]	Handle	The handle on which the interface was installed

Return values

EFI_SUCCESS SmmAtRuntimeCallBack runs successfully

Definition at line 40 of file SmmPerformanceLib.c.

◆ StartPerformanceMeasurement()

RETURN_STATUS EFIAPI StartPerformanceMeasurement	(	IN CONST VOID *Handle	OPTIONAL,
		IN CONST CHAR8 *Token	OPTIONAL,
		IN CONST CHAR8 *Module	OPTIONAL,
		IN UINT64	TimeStamp
	)

Creates a record for the beginning of a performance measurement.

Creates a record that contains the Handle, Token, and Module. If TimeStamp is not zero, then TimeStamp is added to the record as the start time. If TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the start time.

Parameters

Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
TimeStamp	64-bit time stamp.

Return values

RETURN_SUCCESS	The start of the measurement was recorded.
RETURN_OUT_OF_RESOURCES	There are not enough resources to record the measurement.

Definition at line 345 of file SmmPerformanceLib.c.

◆ StartPerformanceMeasurementEx()

RETURN_STATUS EFIAPI StartPerformanceMeasurementEx	(	IN CONST VOID *Handle	OPTIONAL,
		IN CONST CHAR8 *Token	OPTIONAL,
		IN CONST CHAR8 *Module	OPTIONAL,
		IN UINT64	TimeStamp,
		IN UINT32	Identifier
	)

Creates a record for the beginning of a performance measurement.

Creates a record that contains the Handle, Token, Module and Identifier. If TimeStamp is not zero, then TimeStamp is added to the record as the start time. If TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the start time.

Parameters

Handle	Pointer to environment specific context used to identify the component being measured.
Token	Pointer to a Null-terminated ASCII string that identifies the component being measured.
Module	Pointer to a Null-terminated ASCII string that identifies the module being measured.
TimeStamp	64-bit time stamp.
Identifier	32-bit identifier. If the value is 0, the created record is same as the one created by StartPerformanceMeasurement.

Return values

RETURN_SUCCESS	The start of the measurement was recorded.
RETURN_OUT_OF_RESOURCES	There are not enough resources to record the measurement.

Definition at line 175 of file SmmPerformanceLib.c.

Variable Documentation

◆ mPerformanceLibExitBootServicesRegistration

VOID* mPerformanceLibExitBootServicesRegistration

Definition at line 26 of file SmmPerformanceLib.c.

◆ mPerformanceMeasurement

EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL* mPerformanceMeasurement = NULL

Definition at line 24 of file SmmPerformanceLib.c.

◆ mPerformanceMeasurementEnabled

BOOLEAN mPerformanceMeasurementEnabled

Definition at line 25 of file SmmPerformanceLib.c.

Functions

Variables

Detailed Description

Function Documentation

◆ EndPerformanceMeasurement()

◆ EndPerformanceMeasurementEx()

◆ GetPerformanceMeasurement()

◆ GetPerformanceMeasurementEx()

◆ GetPerformanceMeasurementProtocol()

◆ LogPerformanceMeasurement()

◆ LogPerformanceMeasurementEnabled()

◆ PerformanceMeasurementEnabled()

◆ SmmPerformanceLibConstructor()

◆ SmmPerformanceLibDestructor()

◆ SmmPerformanceLibExitBootServicesCallback()

◆ StartPerformanceMeasurement()

◆ StartPerformanceMeasurementEx()

Variable Documentation

◆ mPerformanceLibExitBootServicesRegistration

◆ mPerformanceMeasurement

◆ mPerformanceMeasurementEnabled