mirror of https://github.com/acidanthera/audk.git
Add new extension PerformanceLib APIs to store ID info.
Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13214 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lzeng14
parent
bff8c6f61d
commit
ba14539c90
|
|
@ -84,7 +84,9 @@ EndPerformanceMeasurement (
|
|||
|
||||
/**
|
||||
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,
|
||||
|
|
@ -130,6 +132,127 @@ GetPerformanceMeasurement (
|
|||
OUT UINT64 *EndTimeStamp
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@param Handle Pointer to environment specific context used
|
||||
to identify the component being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string
|
||||
that identifies the component being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string
|
||||
that identifies the module being measured.
|
||||
@param TimeStamp 64-bit time stamp.
|
||||
@param Identifier 32-bit identifier. If the value is 0, the created record
|
||||
is same as the one created by StartPerformanceMeasurement.
|
||||
|
||||
@retval RETURN_SUCCESS The start of the measurement was recorded.
|
||||
@retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
|
||||
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
|
||||
|
||||
**/
|
||||
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
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@param Handle Pointer to environment specific context used
|
||||
to identify the component being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string
|
||||
that identifies the component being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string
|
||||
that identifies the module being measured.
|
||||
@param TimeStamp 64-bit time stamp.
|
||||
@param Identifier 32-bit identifier. If the value is 0, the found record
|
||||
is same as the one found by EndPerformanceMeasurement.
|
||||
|
||||
@retval RETURN_SUCCESS The end of the measurement was recorded.
|
||||
@retval RETURN_NOT_FOUND The specified measurement record could not be found.
|
||||
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
|
||||
|
||||
**/
|
||||
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
|
||||
);
|
||||
|
||||
/**
|
||||
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().
|
||||
|
||||
@param 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.
|
||||
@param Handle Pointer to environment specific context used to identify the component
|
||||
being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string that identifies the component
|
||||
being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string that identifies the module
|
||||
being measured.
|
||||
@param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
|
||||
was started.
|
||||
@param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
|
||||
was ended.
|
||||
@param Identifier Pointer to the 32-bit identifier that was recorded.
|
||||
|
||||
@return 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
|
||||
);
|
||||
|
||||
/**
|
||||
Returns TRUE if the performance measurement macros are enabled.
|
||||
|
||||
|
|
@ -176,6 +299,34 @@ PerformanceMeasurementEnabled (
|
|||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Macro that calls EndPerformanceMeasurementEx().
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
then EndPerformanceMeasurementEx() is called.
|
||||
|
||||
**/
|
||||
#define PERF_END_EX(Handle, Token, Module, TimeStamp, Identifier) \
|
||||
do { \
|
||||
if (PerformanceMeasurementEnabled ()) { \
|
||||
EndPerformanceMeasurementEx (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 PERF_START_EX(Handle, Token, Module, TimeStamp, Identifier) \
|
||||
do { \
|
||||
if (PerformanceMeasurementEnabled ()) { \
|
||||
StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Macro that marks the beginning of performance measurement source code.
|
||||
|
||||
|
|
|
|||
|
|
@ -90,7 +90,9 @@ EndPerformanceMeasurement (
|
|||
|
||||
/**
|
||||
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,
|
||||
|
|
@ -145,6 +147,143 @@ GetPerformanceMeasurement (
|
|||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@param Handle Pointer to environment specific context used
|
||||
to identify the component being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string
|
||||
that identifies the component being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string
|
||||
that identifies the module being measured.
|
||||
@param TimeStamp 64-bit time stamp.
|
||||
@param Identifier 32-bit identifier. If the value is 0, the created record
|
||||
is same as the one created by StartPerformanceMeasurement.
|
||||
|
||||
@retval RETURN_SUCCESS The start of the measurement was recorded.
|
||||
@retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
|
||||
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
|
||||
|
||||
**/
|
||||
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 RETURN_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@param Handle Pointer to environment specific context used
|
||||
to identify the component being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string
|
||||
that identifies the component being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string
|
||||
that identifies the module being measured.
|
||||
@param TimeStamp 64-bit time stamp.
|
||||
@param Identifier 32-bit identifier. If the value is 0, the found record
|
||||
is same as the one found by EndPerformanceMeasurement.
|
||||
|
||||
@retval RETURN_SUCCESS The end of the measurement was recorded.
|
||||
@retval RETURN_NOT_FOUND The specified measurement record could not be found.
|
||||
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
|
||||
|
||||
**/
|
||||
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
|
||||
)
|
||||
{
|
||||
return RETURN_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
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().
|
||||
|
||||
@param 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.
|
||||
@param Handle Pointer to environment specific context used to identify the component
|
||||
being measured.
|
||||
@param Token Pointer to a Null-terminated ASCII string that identifies the component
|
||||
being measured.
|
||||
@param Module Pointer to a Null-terminated ASCII string that identifies the module
|
||||
being measured.
|
||||
@param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
|
||||
was started.
|
||||
@param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
|
||||
was ended.
|
||||
@param Identifier Pointer to the 32-bit identifier that was recorded.
|
||||
|
||||
@return 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
|
||||
)
|
||||
{
|
||||
ASSERT (Handle != NULL);
|
||||
ASSERT (Token != NULL);
|
||||
ASSERT (Module != NULL);
|
||||
ASSERT (StartTimeStamp != NULL);
|
||||
ASSERT (EndTimeStamp != NULL);
|
||||
ASSERT (Identifier != NULL);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
Returns TRUE if the performance measurement macros are enabled.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue