TianoCore EDK2 master
Loading...
Searching...
No Matches
DpUtilities.c File Reference

Go to the source code of this file.

Functions

UINT64 GetDuration (IN OUT MEASUREMENT_RECORD *Measurement)
 
BOOLEAN IsPhase (IN MEASUREMENT_RECORD *Measurement)
 
BOOLEAN IsCorePerf (IN MEASUREMENT_RECORD *Measurement)
 
VOID DpGetShortPdbFileName (IN CHAR8 *PdbFileName, OUT CHAR16 *UnicodeBuffer)
 
VOID DpGetNameFromHandle (IN EFI_HANDLE Handle)
 
UINT64 DurationInMicroSeconds (IN UINT64 Duration)
 
INTN GetCumulativeItem (IN MEASUREMENT_RECORD *Measurement)
 

Detailed Description

Utility functions used by the Dp application.

Copyright (c) 2009 - 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 DpUtilities.c.

Function Documentation

◆ DpGetNameFromHandle()

VOID DpGetNameFromHandle ( IN EFI_HANDLE  Handle)

Get a human readable name for an image handle. The following methods will be tried orderly:

  1. Image PDB
  2. ComponentName2 protocol
  3. FFS UI section
  4. Image GUID
  5. Image DevicePath
  6. Unknown Driver Name
Parameters
[in]Handle
Postcondition
The resulting Unicode name string is stored in the mGaugeString global array.

Definition at line 208 of file DpUtilities.c.

◆ DpGetShortPdbFileName()

VOID DpGetShortPdbFileName ( IN CHAR8 *  PdbFileName,
OUT CHAR16 *  UnicodeBuffer 
)

Get the file name portion of the Pdb File Name.

The portion of the Pdb File Name between the last backslash and either a following period or the end of the string is converted to Unicode and copied into UnicodeBuffer. The name is truncated, if necessary, to ensure that UnicodeBuffer is not overrun.

Parameters
[in]PdbFileNamePdb file name.
[out]UnicodeBufferThe resultant Unicode File Name.

Definition at line 150 of file DpUtilities.c.

◆ DurationInMicroSeconds()

UINT64 DurationInMicroSeconds ( IN UINT64  Duration)

Calculate the Duration in microseconds.

Duration is multiplied by 1000, instead of Frequency being divided by 1000 or multiplying the result by 1000, in order to maintain precision. Since Duration is a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.

The time is calculated as (Duration * 1000) / Timer_Frequency.

Parameters
[in]DurationThe event duration in timer ticks.
Returns
A 64-bit value which is the Elapsed time in microseconds.

Definition at line 392 of file DpUtilities.c.

◆ GetCumulativeItem()

INTN GetCumulativeItem ( IN MEASUREMENT_RECORD Measurement)

Get index of Measurement Record's match in the CumData array.

If the Measurement's Token value matches a Token in one of the CumData records, the index of the matching record is returned. The returned index is a signed value so that negative values can indicate that the Measurement didn't match any entry in the CumData array.

Parameters
[in]MeasurementA pointer to a Measurement Record to match against the CumData array.
Return values
<0Token is not in the CumData array.
>=0Return value is the index into CumData where Token is found.

Definition at line 413 of file DpUtilities.c.

◆ GetDuration()

UINT64 GetDuration ( IN OUT MEASUREMENT_RECORD Measurement)

Calculate an event's duration in timer ticks.

Given the count direction and the event's start and end timer values, calculate the duration of the event in timer ticks. Information for the current measurement is pointed to by the parameter.

If the measurement's start time is 1, it indicates that the developer is indicating that the measurement began at the release of reset. The start time is adjusted to the timer's starting count before performing the elapsed time calculation.

The calculated duration, in ticks, is the absolute difference between the measurement's ending and starting counts.

Parameters
MeasurementPointer to a MEASUREMENT_RECORD structure containing data for the current measurement.
Returns
The 64-bit duration of the event.

Definition at line 57 of file DpUtilities.c.

◆ IsCorePerf()

BOOLEAN IsCorePerf ( IN MEASUREMENT_RECORD Measurement)

Determine whether the Measurement record is for core code.

Parameters
[in]MeasurementA pointer to the Measurement record to test.
Return values
TRUEThe measurement record is used for core.
FALSEThe measurement record is NOT used for core.

Definition at line 116 of file DpUtilities.c.

◆ IsPhase()

BOOLEAN IsPhase ( IN MEASUREMENT_RECORD Measurement)

Determine whether the Measurement record is for an EFI Phase.

The Token and Module members of the measurement record are checked. Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.

Parameters
[in]MeasurementA pointer to the Measurement record to test.
Return values
TRUEThe measurement record is for an EFI Phase.
FALSEThe measurement record is NOT for an EFI Phase.

Definition at line 91 of file DpUtilities.c.