[mirror_edk2.git] / EdkModulePkg / Library / PeiPerformanceLib / PeiPerformanceLib.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. 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
Module Name:\r
\r
  PeiPerformanceLib.c\r
\r
Abstract:\r
\r
  Performance Library\r
\r
--*/\r
\r
/**\r
  Gets PEI the GUID HOB for PEI performance.\r
\r
  This internal function searches for the GUID HOB for PEI performance.\r
  If that GUID HOB is not found, it will build a new one.\r
  It returns the data area of that GUID HOB to record performance log.    \r
\r
  @param  Handle                  Pointer to environment specific context used\r
                                  to identify the component being measured.\r
  @param  Token                   Pointer to a Null-terminated ASCII string\r
                                  that identifies the component being measured.\r
  @param  Module                  Pointer to a Null-terminated ASCII string\r
                                  that identifies the module being measured.\r
\r
  @retval The index of log entry in the array.\r
\r
**/\r
PEI_PERFORMANCE_LOG_HEADER *\r
InternalGetPerformanceHobLog (\r
  VOID\r
  )\r
{\r
  EFI_HOB_GUID_TYPE           *GuidHob;\r
  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;\r
  UINTN                       PeiPerformanceLogSize;\r
\r
  GuidHob = GetFirstGuidHob (&gPeiPerformanceHobGuid);\r
  \r
  if (GuidHob != NULL) {\r
    //\r
    // PEI Performance HOB was found, then return the existing one.\r
    //\r
    PeiPerformanceLog = GET_GUID_HOB_DATA (GuidHob);\r
  } else {\r
    //\r
    // PEI Performance HOB was not found, then build one.\r
    //\r
    PeiPerformanceLogSize = sizeof (PEI_PERFORMANCE_LOG_HEADER) + \r
                            sizeof (PEI_PERFORMANCE_LOG_ENTRY) * PcdGet8 (PcdMaxPeiPerformanceLogEntries);\r
    PeiPerformanceLog     = BuildGuidHob (&gPeiPerformanceHobGuid, PeiPerformanceLogSize);\r
    PeiPerformanceLog     = ZeroMem (PeiPerformanceLog, PeiPerformanceLogSize);\r
  }\r
\r
  return PeiPerformanceLog;\r
}\r
\r
/**\r
  Searches in the log array with keyword Handle, Token and Module.\r
\r
  This internal function searches for the log entry in the log array.\r
  If there is an entry that exactly matches the given key word triple\r
  and its end time stamp is zero, then the index of that log entry is returned;\r
  otherwise, the the number of log entries in the array is returned.  \r
\r
  @param  Handle                  Pointer to environment specific context used\r
                                  to identify the component being measured.\r
  @param  Token                   Pointer to a Null-terminated ASCII string\r
                                  that identifies the component being measured.\r
  @param  Module                  Pointer to a Null-terminated ASCII string\r
                                  that identifies the module being measured.\r
\r
  @retval The index of log entry in the array.\r
\r
**/\r
UINT32\r
InternalSearchForLogEntry (\r
  IN PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog,\r
  IN CONST VOID                 *Handle,  OPTIONAL\r
  IN CONST CHAR8                *Token,   OPTIONAL\r
  IN CONST CHAR8                *Module   OPTIONAL\r
  )\r
{\r
  UINT32                    Index;\r
  UINT32                    NumberOfEntries;\r
  PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
  \r
\r
  if (Token == NULL) {\r
    Token = "";\r
  }\r
  if (Module == NULL) {\r
    Module = "";\r
  }\r
  NumberOfEntries = PeiPerformanceLog->NumberOfEntries;\r
  LogEntryArray   = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
  \r
  for (Index = 0; Index < NumberOfEntries; Index++) {\r
    if ((LogEntryArray[Index].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&\r
         AsciiStrnCmp (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
         AsciiStrnCmp (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
         LogEntryArray[Index].EndTimeStamp == 0\r
       ) {\r
      break;\r
    }\r
  }\r
  return Index;\r
} \r
\r
/**\r
  Creates a record for the beginning of a performance measurement. \r
  \r
  Creates a record that contains the Handle, Token, and Module.\r
  If TimeStamp is not zero, then TimeStamp is added to the record as the start time.\r
  If TimeStamp is zero, then this function reads the current time stamp\r
  and adds that time stamp value to the record as the start time.\r
\r
  @param  Handle                  Pointer to environment specific context used\r
                                  to identify the component being measured.\r
  @param  Token                   Pointer to a Null-terminated ASCII string\r
                                  that identifies the component being measured.\r
  @param  Module                  Pointer to a Null-terminated ASCII string\r
                                  that identifies the module being measured.\r
  @param  TimeStamp               64-bit time stamp.\r
\r
  @retval RETURN_SUCCESS          The start of the measurement was recorded.\r
  @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
StartPerformanceMeasurement (\r
  IN CONST VOID   *Handle,  OPTIONAL\r
  IN CONST CHAR8  *Token,   OPTIONAL\r
  IN CONST CHAR8  *Module,  OPTIONAL\r
  IN UINT64       TimeStamp\r
  )\r
{\r
  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;\r
  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;\r
  UINT32                      Index;\r
\r
  PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
  \r
  if (PeiPerformanceLog->NumberOfEntries >= PcdGet8 (PcdMaxPeiPerformanceLogEntries)) {\r
    return RETURN_OUT_OF_RESOURCES;\r
  }\r
  Index                       = PeiPerformanceLog->NumberOfEntries++;\r
  LogEntryArray               = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);        \r
  LogEntryArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;\r
\r
  if (Token != NULL) {\r
    AsciiStrnCpy (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH);\r
  }\r
  if (Module != NULL) {\r
    AsciiStrnCpy (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH);\r
  }\r
\r
  if (TimeStamp == 0) {\r
    TimeStamp = GetPerformanceCounter ();\r
  }\r
  LogEntryArray[Index].StartTimeStamp = TimeStamp;\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Fills in the end time of a performance measurement. \r
  \r
  Looks up the record that matches Handle, Token, and Module.\r
  If the record can not be found then return RETURN_NOT_FOUND.\r
  If the record is found and TimeStamp is not zero,\r
  then TimeStamp is added to the record as the end time.\r
  If the record is found and TimeStamp is zero, then this function reads\r
  the current time stamp and adds that time stamp value to the record as the end time.\r
  If this function is called multiple times for the same record, then the end time is overwritten.\r
\r
  @param  Handle                  Pointer to environment specific context used\r
                                  to identify the component being measured.\r
  @param  Token                   Pointer to a Null-terminated ASCII string\r
                                  that identifies the component being measured.\r
  @param  Module                  Pointer to a Null-terminated ASCII string\r
                                  that identifies the module being measured.\r
  @param  TimeStamp               64-bit time stamp.\r
\r
  @retval RETURN_SUCCESS          The end of  the measurement was recorded.\r
  @retval RETURN_NOT_FOUND        The specified measurement record could not be found.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
EndPerformanceMeasurement (\r
  IN CONST VOID   *Handle,  OPTIONAL\r
  IN CONST CHAR8  *Token,   OPTIONAL\r
  IN CONST CHAR8  *Module,  OPTIONAL\r
  IN UINT64       TimeStamp\r
  )\r
{\r
  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;\r
  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;\r
  UINT32                      Index;\r
\r
  if (TimeStamp == 0) {\r
    TimeStamp = GetPerformanceCounter ();\r
  }\r
  \r
  PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
  Index             = InternalSearchForLogEntry (PeiPerformanceLog, Handle, Token, Module);\r
  if (Index >= PeiPerformanceLog->NumberOfEntries) {\r
    return RETURN_NOT_FOUND;\r
  }\r
  LogEntryArray     = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
  LogEntryArray[Index].EndTimeStamp = TimeStamp;\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Attempts to retrieve a performance measurement log entry from the performance measurement log. \r
  \r
  Attempts to retrieve the performance log entry specified by LogEntryKey.  If LogEntryKey is\r
  zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r
  and the key for the second entry in the log is returned.  If the performance log is empty,\r
  then no entry is retrieved and zero is returned.  If LogEntryKey is not zero, then the performance\r
  log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r
  returned.  If LogEntryKey is the key for the last entry in the log, then the last log entry is\r
  retrieved and an implementation specific non-zero key value that specifies the end of the performance\r
  log is returned.  If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r
  is retrieved and zero is returned.  In the cases where a performance log entry can be returned,\r
  the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.\r
  If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r
  If Handle is NULL, then ASSERT().\r
  If Token is NULL, then ASSERT().\r
  If Module is NULL, then ASSERT().\r
  If StartTimeStamp is NULL, then ASSERT().\r
  If EndTimeStamp is NULL, then ASSERT().\r
\r
  @param  LogEntryKey             On entry, the key of the performance measurement log entry to retrieve.\r
                                  0, then the first performance measurement log entry is retrieved.\r
                                  On exit, the key of the next performance lof entry entry.\r
  @param  Handle                  Pointer to environment specific context used to identify the component\r
                                  being measured.  \r
  @param  Token                   Pointer to a Null-terminated ASCII string that identifies the component\r
                                  being measured. \r
  @param  Module                  Pointer to a Null-terminated ASCII string that identifies the module\r
                                  being measured.\r
  @param  StartTimeStamp          Pointer to the 64-bit time stamp that was recorded when the measurement\r
                                  was started.\r
  @param  EndTimeStamp            Pointer to the 64-bit time stamp that was recorded when the measurement\r
                                  was ended.\r
\r
  @return The key for the next performance log entry (in general case).\r
\r
**/\r
UINTN\r
EFIAPI\r
GetPerformanceMeasurement (\r
  IN  UINTN       LogEntryKey, \r
  OUT CONST VOID  **Handle,\r
  OUT CONST CHAR8 **Token,\r
  OUT CONST CHAR8 **Module,\r
  OUT UINT64      *StartTimeStamp,\r
  OUT UINT64      *EndTimeStamp\r
  )\r
{\r
  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;\r
  PEI_PERFORMANCE_LOG_ENTRY   *CurrentLogEntry;\r
  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;\r
  UINTN                       NumberOfEntries;\r
\r
  ASSERT (Handle != NULL);\r
  ASSERT (Token != NULL);\r
  ASSERT (Module != NULL);\r
  ASSERT (StartTimeStamp != NULL);\r
  ASSERT (EndTimeStamp != NULL);\r
  \r
  PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
 \r
  NumberOfEntries   = (UINTN) (PeiPerformanceLog->NumberOfEntries);\r
  LogEntryArray     = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
  //\r
  // Make sure that LogEntryKey is a valid log entry key.\r
  //\r
  ASSERT (LogEntryKey <= NumberOfEntries);\r
  \r
  if (LogEntryKey == NumberOfEntries) {\r
    return 0;\r
  }\r
\r
  CurrentLogEntry = &(LogEntryArray[LogEntryKey++]);\r
\r
  *Handle         = (VOID *) (UINTN) (CurrentLogEntry->Handle);\r
  *Token          = CurrentLogEntry->Token;\r
  *Module         = CurrentLogEntry->Module;\r
  *StartTimeStamp = CurrentLogEntry->StartTimeStamp;\r
  *EndTimeStamp   = CurrentLogEntry->EndTimeStamp;\r
\r
  return LogEntryKey;  \r
}\r
\r
/**\r
  Returns TRUE if the performance measurement macros are enabled. \r
  \r
  This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
  PcdPerformanceLibraryPropertyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval TRUE                    The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
                                  PcdPerformanceLibraryPropertyMask is set.\r
  @retval FALSE                   The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
                                  PcdPerformanceLibraryPropertyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
PerformanceMeasurementEnabled (\r
  VOID\r
  )\r
{\r
  return ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r
}\r
Commit	Line	Data
4ba61e5e	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	PeiPerformanceLib.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Performance Library\r
	19	\r
	20	--*/\r
	21	\r
	22	/**\r
	23	Gets PEI the GUID HOB for PEI performance.\r
	24	\r
	25	This internal function searches for the GUID HOB for PEI performance.\r
	26	If that GUID HOB is not found, it will build a new one.\r
	27	It returns the data area of that GUID HOB to record performance log. \r
	28	\r
	29	@param Handle Pointer to environment specific context used\r
	30	to identify the component being measured.\r
	31	@param Token Pointer to a Null-terminated ASCII string\r
	32	that identifies the component being measured.\r
	33	@param Module Pointer to a Null-terminated ASCII string\r
	34	that identifies the module being measured.\r
	35	\r
	36	@retval The index of log entry in the array.\r
	37	\r
	38	**/\r
	39	PEI_PERFORMANCE_LOG_HEADER *\r
	40	InternalGetPerformanceHobLog (\r
	41	VOID\r
	42	)\r
	43	{\r
	44	EFI_HOB_GUID_TYPE *GuidHob;\r
	45	PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
	46	UINTN PeiPerformanceLogSize;\r
	47	\r
	48	GuidHob = GetFirstGuidHob (&gPeiPerformanceHobGuid);\r
	49	\r
	50	if (GuidHob != NULL) {\r
	51	//\r
	52	// PEI Performance HOB was found, then return the existing one.\r
	53	//\r
	54	PeiPerformanceLog = GET_GUID_HOB_DATA (GuidHob);\r
	55	} else {\r
	56	//\r
	57	// PEI Performance HOB was not found, then build one.\r
	58	//\r
	59	PeiPerformanceLogSize = sizeof (PEI_PERFORMANCE_LOG_HEADER) + \r
6ffd3b0c	60	sizeof (PEI_PERFORMANCE_LOG_ENTRY) * PcdGet8 (PcdMaxPeiPerformanceLogEntries);\r
4ba61e5e	61	PeiPerformanceLog = BuildGuidHob (&gPeiPerformanceHobGuid, PeiPerformanceLogSize);\r
	62	PeiPerformanceLog = ZeroMem (PeiPerformanceLog, PeiPerformanceLogSize);\r
	63	}\r
	64	\r
	65	return PeiPerformanceLog;\r
	66	}\r
	67	\r
	68	/**\r
	69	Searches in the log array with keyword Handle, Token and Module.\r
	70	\r
	71	This internal function searches for the log entry in the log array.\r
	72	If there is an entry that exactly matches the given key word triple\r
	73	and its end time stamp is zero, then the index of that log entry is returned;\r
	74	otherwise, the the number of log entries in the array is returned. \r
	75	\r
	76	@param Handle Pointer to environment specific context used\r
	77	to identify the component being measured.\r
	78	@param Token Pointer to a Null-terminated ASCII string\r
	79	that identifies the component being measured.\r
	80	@param Module Pointer to a Null-terminated ASCII string\r
	81	that identifies the module being measured.\r
	82	\r
	83	@retval The index of log entry in the array.\r
	84	\r
	85	**/\r
	86	UINT32\r
	87	InternalSearchForLogEntry (\r
	88	IN PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog,\r
	89	IN CONST VOID *Handle, OPTIONAL\r
	90	IN CONST CHAR8 *Token, OPTIONAL\r
	91	IN CONST CHAR8 *Module OPTIONAL\r
	92	)\r
	93	{\r
	94	UINT32 Index;\r
	95	UINT32 NumberOfEntries;\r
	96	PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
	97	\r
	98	\r
	99	if (Token == NULL) {\r
	100	Token = "";\r
	101	}\r
	102	if (Module == NULL) {\r
	103	Module = "";\r
	104	}\r
	105	NumberOfEntries = PeiPerformanceLog->NumberOfEntries;\r
	106	LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
	107	\r
	108	for (Index = 0; Index < NumberOfEntries; Index++) {\r
	109	if ((LogEntryArray[Index].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&\r
	110	AsciiStrnCmp (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
	111	AsciiStrnCmp (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
	112	LogEntryArray[Index].EndTimeStamp == 0\r
	113	) {\r
	114	break;\r
	115	}\r
	116	}\r
	117	return Index;\r
	118	} \r
	119	\r
	120	/**\r
	121	Creates a record for the beginning of a performance measurement. \r
	122	\r
	123	Creates a record that contains the Handle, Token, and Module.\r
	124	If TimeStamp is not zero, then TimeStamp is added to the record as the start time.\r
125	If TimeStamp is zero, then this function reads the current time stamp\r
126	and adds that time stamp value to the record as the start time.\r
127	\r
128	@param Handle Pointer to environment specific context used\r
129	to identify the component being measured.\r
130	@param Token Pointer to a Null-terminated ASCII string\r
131	that identifies the component being measured.\r
132	@param Module Pointer to a Null-terminated ASCII string\r
133	that identifies the module being measured.\r
134	@param TimeStamp 64-bit time stamp.\r
135	\r
136	@retval RETURN_SUCCESS The start of the measurement was recorded.\r
137	@retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r
138	\r
139	**/\r
140	RETURN_STATUS\r
141	EFIAPI\r
142	StartPerformanceMeasurement (\r
143	IN CONST VOID *Handle, OPTIONAL\r
144	IN CONST CHAR8 *Token, OPTIONAL\r
145	IN CONST CHAR8 *Module, OPTIONAL\r
146	IN UINT64 TimeStamp\r
147	)\r
148	{\r
149	PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
150	PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
151	UINT32 Index;\r
152	\r
153	PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
154	\r
6ffd3b0c	155	if (PeiPerformanceLog->NumberOfEntries >= PcdGet8 (PcdMaxPeiPerformanceLogEntries)) {\r
4ba61e5e	156	return RETURN_OUT_OF_RESOURCES;\r
	157	}\r
	158	Index = PeiPerformanceLog->NumberOfEntries++;\r
	159	LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1); \r
	160	LogEntryArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;\r
	161	\r
	162	if (Token != NULL) {\r
	163	AsciiStrnCpy (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH);\r
	164	}\r
	165	if (Module != NULL) {\r
	166	AsciiStrnCpy (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH);\r
	167	}\r
	168	\r
	169	if (TimeStamp == 0) {\r
	170	TimeStamp = GetPerformanceCounter ();\r
	171	}\r
	172	LogEntryArray[Index].StartTimeStamp = TimeStamp;\r
	173	\r
	174	return RETURN_SUCCESS;\r
	175	}\r
	176	\r
	177	/**\r
	178	Fills in the end time of a performance measurement. \r
	179	\r
	180	Looks up the record that matches Handle, Token, and Module.\r
	181	If the record can not be found then return RETURN_NOT_FOUND.\r
	182	If the record is found and TimeStamp is not zero,\r
	183	then TimeStamp is added to the record as the end time.\r
	184	If the record is found and TimeStamp is zero, then this function reads\r
	185	the current time stamp and adds that time stamp value to the record as the end time.\r
	186	If this function is called multiple times for the same record, then the end time is overwritten.\r
	187	\r
	188	@param Handle Pointer to environment specific context used\r
	189	to identify the component being measured.\r
	190	@param Token Pointer to a Null-terminated ASCII string\r
	191	that identifies the component being measured.\r
	192	@param Module Pointer to a Null-terminated ASCII string\r
	193	that identifies the module being measured.\r
	194	@param TimeStamp 64-bit time stamp.\r
	195	\r
	196	@retval RETURN_SUCCESS The end of the measurement was recorded.\r
	197	@retval RETURN_NOT_FOUND The specified measurement record could not be found.\r
	198	\r
	199	**/\r
	200	RETURN_STATUS\r
	201	EFIAPI\r
	202	EndPerformanceMeasurement (\r
	203	IN CONST VOID *Handle, OPTIONAL\r
	204	IN CONST CHAR8 *Token, OPTIONAL\r
	205	IN CONST CHAR8 *Module, OPTIONAL\r
	206	IN UINT64 TimeStamp\r
	207	)\r
	208	{\r
	209	PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
	210	PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
	211	UINT32 Index;\r
	212	\r
	213	if (TimeStamp == 0) {\r
	214	TimeStamp = GetPerformanceCounter ();\r
	215	}\r
	216	\r
	217	PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
	218	Index = InternalSearchForLogEntry (PeiPerformanceLog, Handle, Token, Module);\r
	219	if (Index >= PeiPerformanceLog->NumberOfEntries) {\r
220	return RETURN_NOT_FOUND;\r
221	}\r
222	LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
223	LogEntryArray[Index].EndTimeStamp = TimeStamp;\r
224	\r
225	return RETURN_SUCCESS;\r
226	}\r
227	\r
228	/**\r
229	Attempts to retrieve a performance measurement log entry from the performance measurement log. \r
230	\r
231	Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is\r
232	zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r
233	and the key for the second entry in the log is returned. If the performance log is empty,\r
234	then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance\r
235	log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r
236	returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is\r
237	retrieved and an implementation specific non-zero key value that specifies the end of the performance\r
238	log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r
239	is retrieved and zero is returned. In the cases where a performance log entry can be returned,\r
240	the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.\r
241	If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r
242	If Handle is NULL, then ASSERT().\r
243	If Token is NULL, then ASSERT().\r
244	If Module is NULL, then ASSERT().\r
245	If StartTimeStamp is NULL, then ASSERT().\r
246	If EndTimeStamp is NULL, then ASSERT().\r
247	\r
248	@param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.\r
249	0, then the first performance measurement log entry is retrieved.\r
250	On exit, the key of the next performance lof entry entry.\r
251	@param Handle Pointer to environment specific context used to identify the component\r
252	being measured. \r
253	@param Token Pointer to a Null-terminated ASCII string that identifies the component\r
254	being measured. \r
255	@param Module Pointer to a Null-terminated ASCII string that identifies the module\r
256	being measured.\r
257	@param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r
258	was started.\r
259	@param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r
260	was ended.\r
261	\r
262	@return The key for the next performance log entry (in general case).\r
263	\r
264	**/\r
265	UINTN\r
266	EFIAPI\r
267	GetPerformanceMeasurement (\r
268	IN UINTN LogEntryKey, \r
269	OUT CONST VOID **Handle,\r
270	OUT CONST CHAR8 **Token,\r
271	OUT CONST CHAR8 **Module,\r
272	OUT UINT64 *StartTimeStamp,\r
273	OUT UINT64 *EndTimeStamp\r
274	)\r
275	{\r
276	PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
277	PEI_PERFORMANCE_LOG_ENTRY *CurrentLogEntry;\r
278	PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
279	UINTN NumberOfEntries;\r
280	\r
281	ASSERT (Handle != NULL);\r
282	ASSERT (Token != NULL);\r
283	ASSERT (Module != NULL);\r
284	ASSERT (StartTimeStamp != NULL);\r
285	ASSERT (EndTimeStamp != NULL);\r
286	\r
287	PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
288	\r
289	NumberOfEntries = (UINTN) (PeiPerformanceLog->NumberOfEntries);\r
290	LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
291	//\r
292	// Make sure that LogEntryKey is a valid log entry key.\r
293	//\r
294	ASSERT (LogEntryKey <= NumberOfEntries);\r
295	\r
296	if (LogEntryKey == NumberOfEntries) {\r
297	return 0;\r
298	}\r
299	\r
300	CurrentLogEntry = &(LogEntryArray[LogEntryKey++]);\r
301	\r
302	Handle = (VOID ) (UINTN) (CurrentLogEntry->Handle);\r
303	*Token = CurrentLogEntry->Token;\r
304	*Module = CurrentLogEntry->Module;\r
305	*StartTimeStamp = CurrentLogEntry->StartTimeStamp;\r
306	*EndTimeStamp = CurrentLogEntry->EndTimeStamp;\r
307	\r
308	return LogEntryKey; \r
309	}\r
310	\r
311	/**\r
312	Returns TRUE if the performance measurement macros are enabled. \r
313	\r
314	This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
315	PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.\r
316	\r
317	@retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
318	PcdPerformanceLibraryPropertyMask is set.\r
319	@retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
320	PcdPerformanceLibraryPropertyMask is clear.\r
321	\r
322	**/\r
323	BOOLEAN\r
324	EFIAPI\r
325	PerformanceMeasurementEnabled (\r
326	VOID\r
327	)\r
328	{\r
329	return ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r
330	}\r