[mirror_edk2.git] / PerformancePkg / Dp_App / DpInternal.h

/** @file\r
  Declarations of objects defined internally to the Dp Application.\r
\r
  Declarations of data and functions which are private to the Dp application.\r
  This file should never be referenced by anything other than components of the\r
  Dp application.  In addition to global data, function declarations for\r
  DpUtilities.c, DpTrace.c, and DpProfile.c are included here.\r
\r
  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
#ifndef _DP_INTELNAL_H_\r
#define _DP_INTELNAL_H_\r
\r
#define DP_GAUGE_STRING_LENGTH   36\r
\r
//\r
/// Module-Global Variables\r
///@{\r
extern EFI_HII_HANDLE     gHiiHandle;\r
extern CHAR16             *mPrintTokenBuffer;\r
extern CHAR16             mGaugeString[DP_GAUGE_STRING_LENGTH + 1];\r
extern CHAR16             mUnicodeToken[DXE_PERFORMANCE_STRING_SIZE];\r
extern UINT64             mInterestThreshold;\r
extern BOOLEAN            mShowId;\r
\r
extern PERF_SUMMARY_DATA  SummaryData;    ///< Create the SummaryData structure and init. to ZERO.\r
\r
/// Timer Specific Information.\r
extern TIMER_INFO         TimerInfo;\r
\r
/// Items for which to gather cumulative statistics.\r
extern PERF_CUM_DATA      CumData[];\r
\r
/// Number of items for which we are gathering cumulative statistics.\r
extern UINT32 const       NumCum;\r
\r
///@}\r
\r
/** \r
  Calculate an event's duration in timer ticks.\r
  \r
  Given the count direction and the event's start and end timer values,\r
  calculate the duration of the event in timer ticks.  Information for\r
  the current measurement is pointed to by the parameter.\r
  \r
  If the measurement's start time is 1, it indicates that the developer\r
  is indicating that the measurement began at the release of reset.\r
  The start time is adjusted to the timer's starting count before performing\r
  the elapsed time calculation.\r
  \r
  The calculated duration, in ticks, is the absolute difference between\r
  the measurement's ending and starting counts.\r
  \r
  @param Measurement   Pointer to a MEASUREMENT_RECORD structure containing\r
                       data for the current measurement.\r
  \r
  @return              The 64-bit duration of the event.\r
**/\r
UINT64\r
GetDuration (\r
  IN OUT MEASUREMENT_RECORD *Measurement\r
  );\r
\r
/** \r
  Determine whether the Measurement record is for an EFI Phase.\r
  \r
  The Token and Module members of the measurement record are checked.\r
  Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.\r
  \r
  @param[in]  Measurement A pointer to the Measurement record to test.\r
  \r
  @retval     TRUE        The measurement record is for an EFI Phase.\r
  @retval     FALSE       The measurement record is NOT for an EFI Phase.\r
**/\r
BOOLEAN\r
IsPhase(\r
  IN MEASUREMENT_RECORD *Measurement\r
  );\r
\r
/** \r
  Get the file name portion of the Pdb File Name.\r
  \r
  The portion of the Pdb File Name between the last backslash and\r
  either a following period or the end of the string is converted\r
  to Unicode and copied into UnicodeBuffer.  The name is truncated,\r
  if necessary, to ensure that UnicodeBuffer is not overrun.\r
  \r
  @param[in]  PdbFileName     Pdb file name.\r
  @param[out] UnicodeBuffer   The resultant Unicode File Name.\r
  \r
**/\r
VOID\r
GetShortPdbFileName (\r
  IN  CHAR8     *PdbFileName,\r
  OUT CHAR16    *UnicodeBuffer\r
  );\r
\r
/** \r
  Get a human readable name for an image handle.\r
  The following methods will be tried orderly:\r
    1. Image PDB\r
    2. ComponentName2 protocol\r
    3. FFS UI section\r
    4. Image GUID\r
    5. Image DevicePath\r
    6. Unknown Driver Name\r
  \r
  @param[in]    Handle\r
  \r
  @post   The resulting Unicode name string is stored in the\r
          mGaugeString global array.\r
  \r
**/\r
VOID\r
GetNameFromHandle (\r
  IN EFI_HANDLE Handle\r
  );\r
\r
/** \r
  Calculate the Duration in microseconds.\r
  \r
  Duration is multiplied by 1000, instead of Frequency being divided by 1000 or\r
  multiplying the result by 1000, in order to maintain precision.  Since Duration is\r
  a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.\r
  \r
  The time is calculated as (Duration * 1000) / Timer_Frequency.\r
  \r
  @param[in]  Duration   The event duration in timer ticks.\r
  \r
  @return     A 64-bit value which is the Elapsed time in microseconds.\r
**/\r
UINT64\r
DurationInMicroSeconds (\r
  IN UINT64 Duration\r
  );\r
\r
/** \r
  Formatted Print using a Hii Token to reference the localized format string.\r
  \r
  @param[in]  Token   A HII token associated with a localized Unicode string.\r
  @param[in]  ...     The variable argument list.\r
  \r
  @return             The number of characters converted by UnicodeVSPrint().\r
  \r
**/\r
UINTN\r
EFIAPI\r
PrintToken (\r
  IN UINT16 Token,\r
  ...\r
  );\r
\r
/** \r
  Get index of Measurement Record's match in the CumData array.\r
  \r
  If the Measurement's Token value matches a Token in one of the CumData\r
  records, the index of the matching record is returned.  The returned\r
  index is a signed value so that negative values can indicate that\r
  the Measurement didn't match any entry in the CumData array.\r
  \r
  @param[in]  Measurement A pointer to a Measurement Record to match against the CumData array.\r
  \r
  @retval     <0    Token is not in the CumData array.\r
  @retval     >=0   Return value is the index into CumData where Token is found.\r
**/\r
INTN\r
GetCumulativeItem(\r
  IN MEASUREMENT_RECORD *Measurement\r
  );\r
\r
/** \r
  Collect verbose statistics about the logged performance measurements.\r
  \r
  General Summary information for all Trace measurements is gathered and\r
  stored within the SummaryData structure.  This information is both\r
  used internally by subsequent reporting functions, and displayed\r
  at the end of verbose reports.\r
  \r
  @pre  The SummaryData and CumData structures must be initialized\r
        prior to calling this function.\r
  \r
  @post The SummaryData and CumData structures contain statistics for the\r
        current performance logs.\r
**/\r
VOID\r
GatherStatistics(\r
  VOID\r
  );\r
\r
/** \r
  Gather and print ALL Trace Records.\r
  \r
  Displays all "interesting" Trace measurements in order.<BR>\r
  The number of records displayed is controlled by:\r
     - records with a duration less than mInterestThreshold microseconds are not displayed.\r
     - No more than Limit records are displayed.  A Limit of zero will not limit the output.\r
     - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
       displayed.\r
  \r
  @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.\r
           The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.\r
           They must not be in use by a calling function.\r
  \r
  @param[in]    Limit       The number of records to print.  Zero is ALL.\r
  @param[in]    ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
  \r
**/\r
VOID\r
DumpAllTrace(\r
  IN UINTN             Limit,\r
  IN BOOLEAN           ExcludeFlag\r
  );\r
\r
/** \r
  Gather and print Raw Trace Records.\r
  \r
  All Trace measurements with a duration greater than or equal to\r
  mInterestThreshold are printed without interpretation.\r
  \r
  The number of records displayed is controlled by:\r
     - records with a duration less than mInterestThreshold microseconds are not displayed.\r
     - No more than Limit records are displayed.  A Limit of zero will not limit the output.\r
     - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
       displayed.\r
  \r
  @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.\r
  \r
  @param[in]    Limit       The number of records to print.  Zero is ALL.\r
  @param[in]    ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
  \r
**/\r
VOID\r
DumpRawTrace(\r
  IN UINTN          Limit,\r
  IN BOOLEAN        ExcludeFlag\r
  );\r
\r
/** \r
  Gather and print Major Phase metrics.\r
  \r
  @param[in]    Ticker      The timer value for the END of Shell phase\r
  \r
**/\r
VOID\r
ProcessPhases(\r
  IN UINT64 Ticker\r
  );\r
\r
\r
/** \r
  Gather and print Handle data.\r
  \r
  @param[in]    ExcludeFlag   TRUE to exclude individual Cumulative items from display.\r
  \r
  @return       Status from a call to gBS->LocateHandle().\r
**/\r
EFI_STATUS\r
ProcessHandles(\r
  IN BOOLEAN ExcludeFlag\r
  );\r
\r
\r
/** \r
  Gather and print PEIM data.\r
  \r
  Only prints complete PEIM records\r
  \r
**/\r
VOID\r
ProcessPeims(\r
  VOID\r
  );\r
\r
/** \r
  Gather and print global data.\r
  \r
  Strips out incomplete or "Execution Phase" records\r
  Only prints records where Handle is NULL\r
  Increment TIndex for every record, even skipped ones, so that we have an\r
  indication of every measurement record taken.\r
  \r
**/\r
VOID\r
ProcessGlobal(\r
  VOID\r
  );\r
\r
/** \r
  Gather and print cumulative data.\r
  \r
  Traverse the measurement records and:<BR>\r
  For each record with a Token listed in the CumData array:<BR>\r
     - Update the instance count and the total, minimum, and maximum durations.\r
  Finally, print the gathered cumulative statistics.\r
  \r
**/\r
VOID\r
ProcessCumulative(\r
  VOID\r
  );\r
\r
/** \r
  Gather and print ALL Profiling Records.\r
  \r
  Displays all "interesting" Profile measurements in order.\r
  The number of records displayed is controlled by:\r
     - records with a duration less than mInterestThreshold microseconds are not displayed.\r
     - No more than Limit records are displayed.  A Limit of zero will not limit the output.\r
     - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
       displayed.\r
  \r
  @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.\r
           The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.\r
           They must not be in use by a calling function.\r
  \r
  @param[in]    Limit         The number of records to print.  Zero is ALL.\r
  @param[in]    ExcludeFlag   TRUE to exclude individual Cumulative items from display.\r
  \r
**/\r
VOID\r
DumpAllProfile(\r
  IN UINTN          Limit,\r
  IN BOOLEAN        ExcludeFlag\r
  );\r
\r
/** \r
  Gather and print Raw Profile Records.\r
  \r
  All Profile measurements with a duration greater than or equal to\r
  mInterestThreshold are printed without interpretation.\r
  \r
  The number of records displayed is controlled by:\r
     - records with a duration less than mInterestThreshold microseconds are not displayed.\r
     - No more than Limit records are displayed.  A Limit of zero will not limit the output.\r
     - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
       displayed.\r
  \r
  @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.\r
  \r
  @param[in]    Limit         The number of records to print.  Zero is ALL.\r
  @param[in]    ExcludeFlag   TRUE to exclude individual Cumulative items from display.\r
  \r
**/\r
VOID\r
DumpRawProfile(\r
  IN UINTN          Limit,\r
  IN BOOLEAN        ExcludeFlag\r
  );\r
\r
/**\r
  Wrap original FreePool to check NULL pointer first.\r
\r
  @param[in]    Buffer      The pointer to the buffer to free.\r
\r
**/\r
VOID\r
SafeFreePool (\r
  IN VOID   *Buffer\r
  );\r
\r
#endif\r
Commit	Line	Data
c06ad33e	1	/** @file\r
86da563d ED	2	Declarations of objects defined internally to the Dp Application.\r
	3	\r
	4	Declarations of data and functions which are private to the Dp application.\r
	5	This file should never be referenced by anything other than components of the\r
	6	Dp application. In addition to global data, function declarations for\r
	7	DpUtilities.c, DpTrace.c, and DpProfile.c are included here.\r
	8	\r
f85acc22	9	Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
86da563d ED	10	This program and the accompanying materials\r
	11	are licensed and made available under the terms and conditions of the BSD License\r
	12	which accompanies this distribution. The full text of the license may be found at\r
	13	http://opensource.org/licenses/bsd-license.php\r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
c06ad33e	17	**/\r
9dd74618 ED	18	#ifndef _DP_INTELNAL_H_\r
9dd74618 ED	19	#define _DP_INTELNAL_H_\r
a2daf8db SZ	20	\r
	21	#define DP_GAUGE_STRING_LENGTH 36\r
	22	\r
c06ad33e	23	//\r
c06ad33e	24	/// Module-Global Variables\r
9dd74618	25	///@{\r
c06ad33e	26	extern EFI_HII_HANDLE gHiiHandle;\r
c06ad33e	27	extern CHAR16 *mPrintTokenBuffer;\r
a2daf8db SZ	28	extern CHAR16 mGaugeString[DP_GAUGE_STRING_LENGTH + 1];\r
a2daf8db SZ	29	extern CHAR16 mUnicodeToken[DXE_PERFORMANCE_STRING_SIZE];\r
c06ad33e	30	extern UINT64 mInterestThreshold;\r
0b84f444	31	extern BOOLEAN mShowId;\r
c06ad33e	32	\r
aec905b7	33	extern PERF_SUMMARY_DATA SummaryData; ///< Create the SummaryData structure and init. to ZERO.\r
c06ad33e	34	\r
	35	/// Timer Specific Information.\r
	36	extern TIMER_INFO TimerInfo;\r
	37	\r
	38	/// Items for which to gather cumulative statistics.\r
	39	extern PERF_CUM_DATA CumData[];\r
	40	\r
	41	/// Number of items for which we are gathering cumulative statistics.\r
	42	extern UINT32 const NumCum;\r
	43	\r
9dd74618	44	///@}\r
c06ad33e	45	\r
f97c2415 ED	46	/** \r
	47	Calculate an event's duration in timer ticks.\r
	48	\r
	49	Given the count direction and the event's start and end timer values,\r
	50	calculate the duration of the event in timer ticks. Information for\r
	51	the current measurement is pointed to by the parameter.\r
	52	\r
	53	If the measurement's start time is 1, it indicates that the developer\r
	54	is indicating that the measurement began at the release of reset.\r
	55	The start time is adjusted to the timer's starting count before performing\r
	56	the elapsed time calculation.\r
	57	\r
	58	The calculated duration, in ticks, is the absolute difference between\r
	59	the measurement's ending and starting counts.\r
	60	\r
	61	@param Measurement Pointer to a MEASUREMENT_RECORD structure containing\r
	62	data for the current measurement.\r
	63	\r
	64	@return The 64-bit duration of the event.\r
c06ad33e	65	**/\r
	66	UINT64\r
	67	GetDuration (\r
	68	IN OUT MEASUREMENT_RECORD *Measurement\r
cbdf19a5	69	);\r
c06ad33e	70	\r
f97c2415 ED	71	/** \r
	72	Determine whether the Measurement record is for an EFI Phase.\r
	73	\r
	74	The Token and Module members of the measurement record are checked.\r
	75	Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.\r
	76	\r
	77	@param[in] Measurement A pointer to the Measurement record to test.\r
	78	\r
	79	@retval TRUE The measurement record is for an EFI Phase.\r
	80	@retval FALSE The measurement record is NOT for an EFI Phase.\r
c06ad33e	81	**/\r
	82	BOOLEAN\r
	83	IsPhase(\r
	84	IN MEASUREMENT_RECORD *Measurement\r
cbdf19a5	85	);\r
c06ad33e	86	\r
f97c2415 ED	87	/** \r
	88	Get the file name portion of the Pdb File Name.\r
	89	\r
	90	The portion of the Pdb File Name between the last backslash and\r
	91	either a following period or the end of the string is converted\r
	92	to Unicode and copied into UnicodeBuffer. The name is truncated,\r
	93	if necessary, to ensure that UnicodeBuffer is not overrun.\r
	94	\r
	95	@param[in] PdbFileName Pdb file name.\r
	96	@param[out] UnicodeBuffer The resultant Unicode File Name.\r
	97	\r
c06ad33e	98	**/\r
	99	VOID\r
	100	GetShortPdbFileName (\r
	101	IN CHAR8 *PdbFileName,\r
	102	OUT CHAR16 *UnicodeBuffer\r
cbdf19a5	103	);\r
c06ad33e	104	\r
f97c2415 ED	105	/** \r
f97c2415 ED	106	Get a human readable name for an image handle.\r
a2daf8db SZ	107	The following methods will be tried orderly:\r
	108	1. Image PDB\r
	109	2. ComponentName2 protocol\r
	110	3. FFS UI section\r
	111	4. Image GUID\r
	112	5. Image DevicePath\r
	113	6. Unknown Driver Name\r
f97c2415 ED	114	\r
	115	@param[in] Handle\r
	116	\r
	117	@post The resulting Unicode name string is stored in the\r
	118	mGaugeString global array.\r
	119	\r
c06ad33e	120	**/\r
	121	VOID\r
	122	GetNameFromHandle (\r
	123	IN EFI_HANDLE Handle\r
cbdf19a5	124	);\r
c06ad33e	125	\r
f97c2415 ED	126	/** \r
	127	Calculate the Duration in microseconds.\r
	128	\r
	129	Duration is multiplied by 1000, instead of Frequency being divided by 1000 or\r
	130	multiplying the result by 1000, in order to maintain precision. Since Duration is\r
	131	a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.\r
	132	\r
	133	The time is calculated as (Duration * 1000) / Timer_Frequency.\r
	134	\r
	135	@param[in] Duration The event duration in timer ticks.\r
	136	\r
	137	@return A 64-bit value which is the Elapsed time in microseconds.\r
c06ad33e	138	**/\r
	139	UINT64\r
	140	DurationInMicroSeconds (\r
	141	IN UINT64 Duration\r
cbdf19a5	142	);\r
c06ad33e	143	\r
f97c2415 ED	144	/** \r
	145	Formatted Print using a Hii Token to reference the localized format string.\r
	146	\r
	147	@param[in] Token A HII token associated with a localized Unicode string.\r
	148	@param[in] ... The variable argument list.\r
	149	\r
	150	@return The number of characters converted by UnicodeVSPrint().\r
	151	\r
c06ad33e	152	**/\r
c06ad33e	153	UINTN\r
f85acc22	154	EFIAPI\r
c06ad33e	155	PrintToken (\r
	156	IN UINT16 Token,\r
	157	...\r
cbdf19a5	158	);\r
c06ad33e	159	\r
f97c2415 ED	160	/** \r
	161	Get index of Measurement Record's match in the CumData array.\r
	162	\r
	163	If the Measurement's Token value matches a Token in one of the CumData\r
	164	records, the index of the matching record is returned. The returned\r
	165	index is a signed value so that negative values can indicate that\r
	166	the Measurement didn't match any entry in the CumData array.\r
	167	\r
	168	@param[in] Measurement A pointer to a Measurement Record to match against the CumData array.\r
	169	\r
	170	@retval <0 Token is not in the CumData array.\r
	171	@retval >=0 Return value is the index into CumData where Token is found.\r
c06ad33e	172	**/\r
	173	INTN\r
	174	GetCumulativeItem(\r
	175	IN MEASUREMENT_RECORD *Measurement\r
cbdf19a5	176	);\r
c06ad33e	177	\r
f97c2415 ED	178	/** \r
	179	Collect verbose statistics about the logged performance measurements.\r
	180	\r
	181	General Summary information for all Trace measurements is gathered and\r
	182	stored within the SummaryData structure. This information is both\r
	183	used internally by subsequent reporting functions, and displayed\r
	184	at the end of verbose reports.\r
	185	\r
	186	@pre The SummaryData and CumData structures must be initialized\r
	187	prior to calling this function.\r
	188	\r
	189	@post The SummaryData and CumData structures contain statistics for the\r
	190	current performance logs.\r
c06ad33e	191	**/\r
	192	VOID\r
	193	GatherStatistics(\r
	194	VOID\r
cbdf19a5	195	);\r
c06ad33e	196	\r
f97c2415 ED	197	/** \r
	198	Gather and print ALL Trace Records.\r
	199	\r
	200	Displays all "interesting" Trace measurements in order.<BR>\r
	201	The number of records displayed is controlled by:\r
	202	- records with a duration less than mInterestThreshold microseconds are not displayed.\r
	203	- No more than Limit records are displayed. A Limit of zero will not limit the output.\r
	204	- If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
	205	displayed.\r
	206	\r
	207	@pre The mInterestThreshold global variable is set to the shortest duration to be printed.\r
	208	The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.\r
	209	They must not be in use by a calling function.\r
	210	\r
	211	@param[in] Limit The number of records to print. Zero is ALL.\r
	212	@param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
	213	\r
c06ad33e	214	**/\r
	215	VOID\r
	216	DumpAllTrace(\r
	217	IN UINTN Limit,\r
	218	IN BOOLEAN ExcludeFlag\r
cbdf19a5	219	);\r
c06ad33e	220	\r
f97c2415 ED	221	/** \r
	222	Gather and print Raw Trace Records.\r
	223	\r
	224	All Trace measurements with a duration greater than or equal to\r
	225	mInterestThreshold are printed without interpretation.\r
	226	\r
	227	The number of records displayed is controlled by:\r
	228	- records with a duration less than mInterestThreshold microseconds are not displayed.\r
	229	- No more than Limit records are displayed. A Limit of zero will not limit the output.\r
	230	- If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
	231	displayed.\r
	232	\r
	233	@pre The mInterestThreshold global variable is set to the shortest duration to be printed.\r
	234	\r
	235	@param[in] Limit The number of records to print. Zero is ALL.\r
	236	@param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
	237	\r
c06ad33e	238	**/\r
	239	VOID\r
	240	DumpRawTrace(\r
	241	IN UINTN Limit,\r
	242	IN BOOLEAN ExcludeFlag\r
cbdf19a5	243	);\r
c06ad33e	244	\r
f97c2415 ED	245	/** \r
	246	Gather and print Major Phase metrics.\r
	247	\r
	248	@param[in] Ticker The timer value for the END of Shell phase\r
	249	\r
c06ad33e	250	**/\r
	251	VOID\r
	252	ProcessPhases(\r
	253	IN UINT64 Ticker\r
cbdf19a5	254	);\r
c06ad33e	255	\r
c06ad33e	256	\r
f97c2415 ED	257	/** \r
	258	Gather and print Handle data.\r
	259	\r
	260	@param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
	261	\r
	262	@return Status from a call to gBS->LocateHandle().\r
c06ad33e	263	**/\r
	264	EFI_STATUS\r
	265	ProcessHandles(\r
	266	IN BOOLEAN ExcludeFlag\r
cbdf19a5	267	);\r
c06ad33e	268	\r
c06ad33e	269	\r
f97c2415 ED	270	/** \r
	271	Gather and print PEIM data.\r
	272	\r
	273	Only prints complete PEIM records\r
	274	\r
c06ad33e	275	**/\r
	276	VOID\r
	277	ProcessPeims(\r
	278	VOID\r
cbdf19a5	279	);\r
c06ad33e	280	\r
f97c2415 ED	281	/** \r
	282	Gather and print global data.\r
	283	\r
	284	Strips out incomplete or "Execution Phase" records\r
	285	Only prints records where Handle is NULL\r
	286	Increment TIndex for every record, even skipped ones, so that we have an\r
	287	indication of every measurement record taken.\r
	288	\r
c06ad33e	289	**/\r
	290	VOID\r
	291	ProcessGlobal(\r
	292	VOID\r
cbdf19a5	293	);\r
c06ad33e	294	\r
f97c2415 ED	295	/** \r
	296	Gather and print cumulative data.\r
	297	\r
	298	Traverse the measurement records and:<BR>\r
	299	For each record with a Token listed in the CumData array:<BR>\r
	300	- Update the instance count and the total, minimum, and maximum durations.\r
	301	Finally, print the gathered cumulative statistics.\r
	302	\r
c06ad33e	303	**/\r
	304	VOID\r
	305	ProcessCumulative(\r
	306	VOID\r
cbdf19a5	307	);\r
c06ad33e	308	\r
f97c2415 ED	309	/** \r
	310	Gather and print ALL Profiling Records.\r
	311	\r
	312	Displays all "interesting" Profile measurements in order.\r
	313	The number of records displayed is controlled by:\r
	314	- records with a duration less than mInterestThreshold microseconds are not displayed.\r
	315	- No more than Limit records are displayed. A Limit of zero will not limit the output.\r
	316	- If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
	317	displayed.\r
	318	\r
	319	@pre The mInterestThreshold global variable is set to the shortest duration to be printed.\r
	320	The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.\r
	321	They must not be in use by a calling function.\r
	322	\r
	323	@param[in] Limit The number of records to print. Zero is ALL.\r
	324	@param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
	325	\r
c06ad33e	326	**/\r
	327	VOID\r
	328	DumpAllProfile(\r
	329	IN UINTN Limit,\r
	330	IN BOOLEAN ExcludeFlag\r
cbdf19a5	331	);\r
c06ad33e	332	\r
f97c2415 ED	333	/** \r
	334	Gather and print Raw Profile Records.\r
	335	\r
	336	All Profile measurements with a duration greater than or equal to\r
	337	mInterestThreshold are printed without interpretation.\r
	338	\r
	339	The number of records displayed is controlled by:\r
	340	- records with a duration less than mInterestThreshold microseconds are not displayed.\r
	341	- No more than Limit records are displayed. A Limit of zero will not limit the output.\r
	342	- If the ExcludeFlag is TRUE, records matching entries in the CumData array are not\r
	343	displayed.\r
	344	\r
	345	@pre The mInterestThreshold global variable is set to the shortest duration to be printed.\r
	346	\r
	347	@param[in] Limit The number of records to print. Zero is ALL.\r
	348	@param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.\r
	349	\r
c06ad33e	350	**/\r
	351	VOID\r
	352	DumpRawProfile(\r
	353	IN UINTN Limit,\r
	354	IN BOOLEAN ExcludeFlag\r
cbdf19a5	355	);\r
a2daf8db SZ	356	\r
	357	/**\r
	358	Wrap original FreePool to check NULL pointer first.\r
	359	\r
	360	@param[in] Buffer The pointer to the buffer to free.\r
	361	\r
	362	**/\r
	363	VOID\r
	364	SafeFreePool (\r
	365	IN VOID *Buffer\r
	366	);\r
	367	\r
9dd74618	368	#endif\r