PerformanceMeasurement.h File Reference

Data Structures
struct	_EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL

Macros
#define	PERFORMANCE_MEASUREMENT_PROTOCOL_GUID   { 0xc85d06be, 0x5f75, 0x48ce, {0xa8, 0x0f, 0x12, 0x36, 0xba, 0x3b, 0x87, 0xb1 } }
#define	SMM_PERFORMANCE_MEASUREMENT_PROTOCOL_GUID   { 0xd56b6d73, 0x1a7b, 0x4015, {0x9b, 0xb4, 0x7b, 0x07, 0x17, 0x29, 0xed, 0x24 } }

Typedefs
typedef struct _EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL	EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL
typedef EFI_STATUS(EFIAPI *	CREATE_PERFORMANCE_MEASUREMENT )(IN CONST VOID *CallerIdentifier, IN CONST VOID *Guid, IN CONST CHAR8 *String, IN UINT64 TimeStamp, IN UINT64 Address, IN UINT32 Identifier, IN PERF_MEASUREMENT_ATTRIBUTE Attribute)

Enumerations
enum	PERF_MEASUREMENT_ATTRIBUTE { PerfStartEntry, PerfEndEntry, PerfEntry }

Variables
EFI_GUID	gEdkiiPerformanceMeasurementProtocolGuid
EFI_GUID	gEdkiiSmmPerformanceMeasurementProtocolGuid

Detailed Description

Performance measurement protocol, allows logging performance data.

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

Macro Definition Documentation

#define PERFORMANCE_MEASUREMENT_PROTOCOL_GUID   { 0xc85d06be, 0x5f75, 0x48ce, {0xa8, 0x0f, 0x12, 0x36, 0xba, 0x3b, 0x87, 0xb1 } }

#define SMM_PERFORMANCE_MEASUREMENT_PROTOCOL_GUID   { 0xd56b6d73, 0x1a7b, 0x4015, {0x9b, 0xb4, 0x7b, 0x07, 0x17, 0x29, 0xed, 0x24 } }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * CREATE_PERFORMANCE_MEASUREMENT)(IN CONST VOID *CallerIdentifier, IN CONST VOID *Guid, IN CONST CHAR8 *String, IN UINT64 TimeStamp, IN UINT64 Address, IN UINT32 Identifier, IN PERF_MEASUREMENT_ATTRIBUTE Attribute)

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.
TimeStamp	- 64-bit time stamp.
Address	- Pointer to a location in memory relevant to the measurement.
Identifier	- 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.

typedef struct _EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL

Enumeration Type Documentation

enum PERF_MEASUREMENT_ATTRIBUTE

Enumerator
PerfStartEntry
PerfEndEntry
PerfEntry

Variable Documentation

EFI_GUID gEdkiiPerformanceMeasurementProtocolGuid

EFI_GUID gEdkiiSmmPerformanceMeasurementProtocolGuid