#include <PiPei.h>
#include <Guid/ExtendedFirmwarePerformance.h>
#include <Guid/PerformanceMeasurement.h>
#include <Library/PerformanceLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/BaseLib.h>
#include <Library/TimerLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseMemoryLib.h>

Macros
#define	STRING_SIZE (FPDT_STRING_EVENT_RECORD_NAME_LENGTH * sizeof (CHAR8))

#define	PEI_MAX_RECORD_SIZE (sizeof (FPDT_DUAL_GUID_STRING_EVENT_RECORD) + STRING_SIZE)

Functions
EFI_STATUS	GetFpdtRecordPtr (IN UINT8 RecordSize, IN OUT FPDT_RECORD_PTR FpdtRecordPtr, IN OUT FPDT_PEI_EXT_PERF_HEADER *PeiPerformanceLogHeader)

BOOLEAN	IsKnownTokens (IN CONST CHAR8 *Token)

BOOLEAN	IsKnownID (IN UINT32 Identifier)

EFI_STATUS	GetFpdtRecordId (IN BOOLEAN Attribute, IN CONST VOID Handle, IN CONST CHAR8 String, OUT UINT16 *ProgressID)

VOID	CopyStringIntoPerfRecordAndUpdateLength (IN OUT CHAR8 Destination, IN CONST CHAR8 Source, IN OUT UINT8 *Length)

EFI_STATUS	InsertFpdtRecord (IN CONST VOID CallerIdentifier OPTIONAL, IN CONST VOID Guid OPTIONAL, IN CONST CHAR8 *String OPTIONAL, IN UINT64 Ticker, IN UINT64 Address OPTIONAL, IN UINT16 PerfId, IN PERF_MEASUREMENT_ATTRIBUTE Attribute)

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)

Detailed Description

Performance library instance used in PEI phase.

This file implements all APIs in Performance Library class in MdePkg. It creates performance logging GUIDed HOB on the first performance logging and then logs the performance data to the GUIDed HOB. Due to the limitation of temporary RAM, the maximum number of performance logging entry is specified by PcdMaxPeiPerformanceLogEntries or PcdMaxPeiPerformanceLogEntries16.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PeiPerformanceLib.c.

Macro Definition Documentation

◆ PEI_MAX_RECORD_SIZE

#define PEI_MAX_RECORD_SIZE (sizeof (FPDT_DUAL_GUID_STRING_EVENT_RECORD) + STRING_SIZE)

Definition at line 30 of file PeiPerformanceLib.c.

◆ STRING_SIZE

#define STRING_SIZE (FPDT_STRING_EVENT_RECORD_NAME_LENGTH * sizeof (CHAR8))

Definition at line 29 of file PeiPerformanceLib.c.

Function Documentation

◆ CopyStringIntoPerfRecordAndUpdateLength()

VOID CopyStringIntoPerfRecordAndUpdateLength	(	IN OUT CHAR8 *	Destination,
		IN CONST CHAR8 *	Source,
		IN OUT UINT8 *	Length
	)

Copies the string from Source into Destination and updates Length with the size of the string.

Parameters

Destination	- destination of the string copy
Source	- pointer to the source string which will get copied
Length	- pointer to a length variable to be updated

Definition at line 258 of file PeiPerformanceLib.c.

◆ EndPerformanceMeasurement()

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

Creates a record for the end of a performance measurement.

If the TimeStamp is not zero or one, then TimeStamp is added to the record as the end time. If the TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the end time. If the TimeStamp is one, then this function reads 0 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 737 of file PeiPerformanceLib.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
	)

Creates a record for the end of a performance measurement.

If the TimeStamp is not zero or one, then TimeStamp is added to the record as the end time. If the TimeStamp is zero, then this function reads the current time stamp and adds that time stamp value to the record as the end time. If the TimeStamp is one, then this function reads 0 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 601 of file PeiPerformanceLib.c.

◆ GetFpdtRecordId()

EFI_STATUS GetFpdtRecordId	(	IN BOOLEAN	Attribute,
		IN CONST VOID *	Handle,
		IN CONST CHAR8 *	String,
		OUT UINT16 *	ProgressID
	)

Get the FPDT record identifier.

Parameters

Attribute	The attribute of the Record. PerfStartEntry: Start Record. PerfEndEntry: End Record.
Handle	Pointer to environment specific context used to identify the component being measured.
String	Pointer to a Null-terminated ASCII string that identifies the component being measured.
ProgressID	On return, pointer to the ProgressID.

Return values

EFI_SUCCESS	Get record info successfully.
EFI_INVALID_PARAMETER	No matched FPDT record.

Definition at line 192 of file PeiPerformanceLib.c.

◆ GetFpdtRecordPtr()

EFI_STATUS GetFpdtRecordPtr	(	IN UINT8	RecordSize,
		IN OUT FPDT_RECORD_PTR *	FpdtRecordPtr,
		IN OUT FPDT_PEI_EXT_PERF_HEADER **	PeiPerformanceLogHeader
	)

Return the pointer to the FPDT record in the allocated memory.

Parameters

RecordSize	The size of FPDT record.
FpdtRecordPtr	Pointer the FPDT record in the allocated memory.
PeiPerformanceLogHeader	Pointer to the header of the PEI Performance records in the GUID Hob.

Return values

EFI_SUCCESS	Successfully get the pointer to the FPDT record.
EFI_OUT_OF_RESOURCES	Ran out of space to store the records.

Definition at line 43 of file PeiPerformanceLib.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().

NOT Support yet.

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 of entry 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 790 of file PeiPerformanceLib.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().

!!!NOT Support yet!!!

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 of entry 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 667 of file PeiPerformanceLib.c.

◆ InsertFpdtRecord()

EFI_STATUS InsertFpdtRecord	(	IN CONST VOID *CallerIdentifier	OPTIONAL,
		IN CONST VOID *Guid	OPTIONAL,
		IN CONST CHAR8 *String	OPTIONAL,
		IN UINT64	Ticker,
		IN UINT64 Address	OPTIONAL,
		IN UINT16	PerfId,
		IN PERF_MEASUREMENT_ATTRIBUTE	Attribute
	)

Convert PEI performance log to FPDT String boot record.

Parameters

CallerIdentifier	- Image handle or pointer to caller ID GUID.
Guid	- Pointer to a GUID.
String	- Pointer to a string describing the measurement.
Ticker	- 64-bit time stamp.
Address	- Pointer to a location in memory relevant to the measurement.
PerfId	- Performance identifier describing the type of measurement.
Attribute	- The attribute of the measurement. According to attribute can create a start record for PERF_START/PERF_START_EX, or a end record for PERF_END/PERF_END_EX, or a general record for other Perf macros.

Return values

EFI_SUCCESS	- Successfully created performance record.
EFI_OUT_OF_RESOURCES	- Ran out of space to store the records.
EFI_INVALID_PARAMETER	- Invalid parameter passed to function - NULL pointer or invalid PerfId.

Definition at line 309 of file PeiPerformanceLib.c.

◆ IsKnownID()

BOOLEAN IsKnownID ( IN UINT32 Identifier )

Check whether the ID is a known one which map to the known Token.

Parameters

Identifier 32-bit identifier.

Return values

TRUE	Is a known one used by core.
FALSE	Not a known one.

Definition at line 156 of file PeiPerformanceLib.c.

◆ IsKnownTokens()

BOOLEAN IsKnownTokens ( IN CONST CHAR8 * Token )

Check whether the Token is a known one which is uesed by core.

Parameters

Token Pointer to a Null-terminated ASCII string

Return values

TRUE	Is a known one used by core.
FALSE	Not a known one.

Definition at line 121 of file PeiPerformanceLib.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 840 of file PeiPerformanceLib.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 865 of file PeiPerformanceLib.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 816 of file PeiPerformanceLib.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.

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.

If TimeStamp is one, then this function reads 0 as the start time.

If TimeStamp is other value, then TimeStamp is added 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 705 of file PeiPerformanceLib.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.

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.

If TimeStamp is one, then this function reads 0 as the start time.

If TimeStamp is other value, then TimeStamp is added 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 556 of file PeiPerformanceLib.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ PEI_MAX_RECORD_SIZE

◆ STRING_SIZE

Function Documentation

◆ CopyStringIntoPerfRecordAndUpdateLength()

◆ EndPerformanceMeasurement()

◆ EndPerformanceMeasurementEx()

◆ GetFpdtRecordId()

◆ GetFpdtRecordPtr()

◆ GetPerformanceMeasurement()

◆ GetPerformanceMeasurementEx()

◆ InsertFpdtRecord()

◆ IsKnownID()

◆ IsKnownTokens()

◆ LogPerformanceMeasurement()

◆ LogPerformanceMeasurementEnabled()

◆ PerformanceMeasurementEnabled()

◆ StartPerformanceMeasurement()

◆ StartPerformanceMeasurementEx()