MdePkg/Include/Library/PerformanceLib.h File Reference


Defines

#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED   0x00000001
#define PERF_END(Handle, Token, Module, TimeStamp)
#define PERF_START(Handle, Token, Module, TimeStamp)
#define PERF_END_EX(Handle, Token, Module, TimeStamp, Identifier)
#define PERF_START_EX(Handle, Token, Module, TimeStamp, Identifier)
#define PERF_CODE_BEGIN()   do { if (PerformanceMeasurementEnabled ()) { UINT8 __PerformanceCodeLocal
#define PERF_CODE_END()   __PerformanceCodeLocal = 0; __PerformanceCodeLocal++; } } while (FALSE)
#define PERF_CODE(Expression)

Functions

RETURN_STATUS EFIAPI StartPerformanceMeasurement (IN CONST VOID *Handle, IN CONST CHAR8 *Token, IN CONST CHAR8 *Module, IN UINT64 TimeStamp)
RETURN_STATUS EFIAPI EndPerformanceMeasurement (IN CONST VOID *Handle, IN CONST CHAR8 *Token, IN CONST CHAR8 *Module, 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)
RETURN_STATUS EFIAPI StartPerformanceMeasurementEx (IN CONST VOID *Handle, IN CONST CHAR8 *Token, IN CONST CHAR8 *Module, IN UINT64 TimeStamp, IN UINT32 Identifier)
RETURN_STATUS EFIAPI EndPerformanceMeasurementEx (IN CONST VOID *Handle, IN CONST CHAR8 *Token, IN CONST CHAR8 *Module, 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)
BOOLEAN EFIAPI PerformanceMeasurementEnabled (VOID)

Detailed Description

Provides services to log the execution times and retrieve them later.

Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define PERF_CODE ( Expression   ) 

Value:

PERF_CODE_BEGIN ();          \
  Expression                   \
  PERF_CODE_END ()
Macro that declares a section of performance measurement source code.

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then the source code specified by Expression is included in a module. Otherwise, the source specified by Expression is not included in a module.

Parameters:
Expression Performance measurement source code to include in a module.

 
#define PERF_CODE_BEGIN (  )     do { if (PerformanceMeasurementEnabled ()) { UINT8 __PerformanceCodeLocal

Macro that marks the beginning of performance measurement source code.

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then this macro marks the beginning of source code that is included in a module. Otherwise, the source lines between PERF_CODE_BEGIN() and PERF_CODE_END() are not included in a module.

 
#define PERF_CODE_END (  )     __PerformanceCodeLocal = 0; __PerformanceCodeLocal++; } } while (FALSE)

Macro that marks the end of performance measurement source code.

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then this macro marks the end of source code that is included in a module. Otherwise, the source lines between PERF_CODE_BEGIN() and PERF_CODE_END() are not included in a module.

#define PERF_END ( Handle,
Token,
Module,
TimeStamp   ) 

Value:

do {                                                                \
    if (PerformanceMeasurementEnabled ()) {                           \
      EndPerformanceMeasurement (Handle, Token, Module, TimeStamp);   \
    }                                                                 \
  } while (FALSE)
Macro that calls EndPerformanceMeasurement().

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then EndPerformanceMeasurement() is called.

#define PERF_END_EX ( Handle,
Token,
Module,
TimeStamp,
Identifier   ) 

Value:

do {                                                                              \
    if (PerformanceMeasurementEnabled ()) {                                         \
      EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier);   \
    }                                                                               \
  } while (FALSE)
Macro that calls EndPerformanceMeasurementEx().

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then EndPerformanceMeasurementEx() is called.

#define PERF_START ( Handle,
Token,
Module,
TimeStamp   ) 

Value:

do {                                                                \
    if (PerformanceMeasurementEnabled ()) {                           \
      StartPerformanceMeasurement (Handle, Token, Module, TimeStamp); \
    }                                                                 \
  } while (FALSE)
Macro that calls StartPerformanceMeasurement().

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then StartPerformanceMeasurement() is called.

#define PERF_START_EX ( Handle,
Token,
Module,
TimeStamp,
Identifier   ) 

Value:

do {                                                                              \
    if (PerformanceMeasurementEnabled ()) {                                         \
      StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \
    }                                                                               \
  } while (FALSE)
Macro that calls StartPerformanceMeasurementEx().

If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set, then StartPerformanceMeasurementEx() is called.

#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED   0x00000001

Performance library propery mask bits


Function Documentation

RETURN_STATUS EFIAPI EndPerformanceMeasurement ( IN CONST VOID *  Handle,
IN CONST CHAR8 Token,
IN CONST CHAR8 Module,
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.
RETURN_DEVICE_ERROR A device error reading the time stamp.

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

Fills in the end time of a performance measurement.

Looks up the record that matches Handle, Token, Module and Identifier. 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.
RETURN_DEVICE_ERROR A device error reading the time stamp.

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 lof 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).

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 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).

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.

RETURN_STATUS EFIAPI StartPerformanceMeasurement ( IN CONST VOID *  Handle,
IN CONST CHAR8 Token,
IN CONST CHAR8 Module,
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.
RETURN_DEVICE_ERROR A device error reading the time stamp.

RETURN_STATUS EFIAPI StartPerformanceMeasurementEx ( IN CONST VOID *  Handle,
IN CONST CHAR8 Token,
IN CONST CHAR8 Module,
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.
RETURN_DEVICE_ERROR A device error reading the time stamp.


Generated on Wed Sep 23 16:24:21 2015 for MdePkg[ALL] by  doxygen 1.5.7.1