| | 1 | /** @file\r |
| | 2 | Performance library instance mainly used by DxeCore.\r |
| | 3 | \r |
| | 4 | This library provides the performance measurement interfaces and initializes performance\r |
| | 5 | logging for DXE phase. It first initializes its private global data structure for\r |
| | 6 | performance logging and saves the performance GUIDed HOB passed from PEI phase. \r |
| | 7 | It initializes DXE phase performance logging by publishing the Performance and PerformanceEx Protocol,\r |
| | 8 | which are consumed by DxePerformanceLib to logging performance data in DXE phase.\r |
| | 9 | \r |
| | 10 | This library is mainly used by DxeCore to start performance logging to ensure that\r |
| | 11 | Performance Protocol is installed at the very beginning of DXE phase.\r |
| | 12 | \r |
| | 13 | Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r |
| | 14 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r |
| | 15 | This program and the accompanying materials\r |
| | 16 | are licensed and made available under the terms and conditions of the BSD License\r |
| | 17 | which accompanies this distribution. The full text of the license may be found at\r |
| | 18 | http://opensource.org/licenses/bsd-license.php\r |
| | 19 | \r |
| | 20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| | 21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| | 22 | \r |
| | 23 | **/\r |
| | 24 | \r |
| | 25 | \r |
| | 26 | #include "DxeCorePerformanceLibInternal.h"\r |
| | 27 | \r |
| | 28 | \r |
| | 29 | //\r |
| | 30 | // The data structure to hold global performance data.\r |
| | 31 | //\r |
| | 32 | GAUGE_DATA_HEADER *mGaugeData;\r |
| | 33 | \r |
| | 34 | //\r |
| | 35 | // The current maximum number of logging entries. If current number of \r |
| | 36 | // entries exceeds this value, it will re-allocate a larger array and\r |
| | 37 | // migration the old data to the larger array.\r |
| | 38 | //\r |
| | 39 | UINT32 mMaxGaugeRecords;\r |
| | 40 | \r |
| | 41 | //\r |
| | 42 | // The handle to install Performance Protocol instance.\r |
| | 43 | //\r |
| | 44 | EFI_HANDLE mHandle = NULL;\r |
| | 45 | \r |
| | 46 | //\r |
| | 47 | // Interfaces for Performance Protocol.\r |
| | 48 | //\r |
| | 49 | PERFORMANCE_PROTOCOL mPerformanceInterface = {\r |
| | 50 | StartGauge,\r |
| | 51 | EndGauge,\r |
| | 52 | GetGauge\r |
| | 53 | };\r |
| | 54 | \r |
| | 55 | //\r |
| | 56 | // Interfaces for PerformanceEx Protocol.\r |
| | 57 | //\r |
| | 58 | PERFORMANCE_EX_PROTOCOL mPerformanceExInterface = {\r |
| | 59 | StartGaugeEx,\r |
| | 60 | EndGaugeEx,\r |
| | 61 | GetGaugeEx\r |
| | 62 | };\r |
| | 63 | \r |
| | 64 | PERFORMANCE_PROPERTY mPerformanceProperty;\r |
| | 65 | \r |
| | 66 | //\r |
| | 67 | // Gauge record lock to avoid data corruption or even memory overflow\r |
| | 68 | //\r |
| | 69 | STATIC EFI_LOCK mPerfRecordLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);\r |
| | 70 | \r |
| | 71 | /**\r |
| | 72 | Searches in the gauge array with keyword Handle, Token, Module and Identifier.\r |
| | 73 | \r |
| | 74 | This internal function searches for the gauge entry in the gauge array.\r |
| | 75 | If there is an entry that exactly matches the given keywords\r |
| | 76 | and its end time stamp is zero, then the index of that gauge entry is returned;\r |
| | 77 | otherwise, the the number of gauge entries in the array is returned.\r |
| | 78 | \r |
| | 79 | @param Handle Pointer to environment specific context used\r |
| | 80 | to identify the component being measured.\r |
| | 81 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 82 | that identifies the component being measured.\r |
| | 83 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 84 | that identifies the module being measured.\r |
| | 85 | @param Identifier 32-bit identifier.\r |
| | 86 | \r |
| | 87 | @retval The index of gauge entry in the array.\r |
| | 88 | \r |
| | 89 | **/\r |
| | 90 | UINT32\r |
| | 91 | InternalSearchForGaugeEntry (\r |
| | 92 | IN CONST VOID *Handle, OPTIONAL\r |
| | 93 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 94 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 95 | IN UINT32 Identifier\r |
| | 96 | )\r |
| | 97 | {\r |
| | 98 | UINT32 Index;\r |
| | 99 | UINT32 Index2;\r |
| | 100 | UINT32 NumberOfEntries;\r |
| | 101 | GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r |
| | 102 | \r |
| | 103 | if (Token == NULL) {\r |
| | 104 | Token = "";\r |
| | 105 | }\r |
| | 106 | if (Module == NULL) {\r |
| | 107 | Module = "";\r |
| | 108 | }\r |
| | 109 | \r |
| | 110 | NumberOfEntries = mGaugeData->NumberOfEntries;\r |
| | 111 | GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r |
| | 112 | \r |
| | 113 | Index2 = 0;\r |
| | 114 | \r |
| | 115 | for (Index = 0; Index < NumberOfEntries; Index++) {\r |
| | 116 | Index2 = NumberOfEntries - 1 - Index;\r |
| | 117 | if (GaugeEntryExArray[Index2].EndTimeStamp == 0 &&\r |
| | 118 | (GaugeEntryExArray[Index2].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&\r |
| | 119 | AsciiStrnCmp (GaugeEntryExArray[Index2].Token, Token, DXE_PERFORMANCE_STRING_LENGTH) == 0 &&\r |
| | 120 | AsciiStrnCmp (GaugeEntryExArray[Index2].Module, Module, DXE_PERFORMANCE_STRING_LENGTH) == 0) {\r |
| | 121 | Index = Index2;\r |
| | 122 | break;\r |
| | 123 | }\r |
| | 124 | }\r |
| | 125 | \r |
| | 126 | return Index;\r |
| | 127 | }\r |
| | 128 | \r |
| | 129 | /**\r |
| | 130 | Adds a record at the end of the performance measurement log\r |
| | 131 | that records the start time of a performance measurement.\r |
| | 132 | \r |
| | 133 | Adds a record to the end of the performance measurement log\r |
| | 134 | that contains the Handle, Token, Module and Identifier.\r |
| | 135 | The end time of the new record must be set to zero.\r |
| | 136 | If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r |
| | 137 | If TimeStamp is zero, the start time in the record is filled in with the value\r |
| | 138 | read from the current time stamp.\r |
| | 139 | \r |
| | 140 | @param Handle Pointer to environment specific context used\r |
| | 141 | to identify the component being measured.\r |
| | 142 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 143 | that identifies the component being measured.\r |
| | 144 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 145 | that identifies the module being measured.\r |
| | 146 | @param TimeStamp 64-bit time stamp.\r |
| | 147 | @param Identifier 32-bit identifier. If the value is 0, the created record\r |
| | 148 | is same as the one created by StartGauge of PERFORMANCE_PROTOCOL.\r |
| | 149 | \r |
| | 150 | @retval EFI_SUCCESS The data was read correctly from the device.\r |
| | 151 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r |
| | 152 | \r |
| | 153 | **/\r |
| | 154 | EFI_STATUS\r |
| | 155 | EFIAPI\r |
| | 156 | StartGaugeEx (\r |
| | 157 | IN CONST VOID *Handle, OPTIONAL\r |
| | 158 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 159 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 160 | IN UINT64 TimeStamp,\r |
| | 161 | IN UINT32 Identifier\r |
| | 162 | )\r |
| | 163 | {\r |
| | 164 | GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r |
| | 165 | UINTN GaugeDataSize;\r |
| | 166 | GAUGE_DATA_HEADER *NewGaugeData;\r |
| | 167 | UINTN OldGaugeDataSize;\r |
| | 168 | GAUGE_DATA_HEADER *OldGaugeData;\r |
| | 169 | UINT32 Index;\r |
| | 170 | EFI_STATUS Status;\r |
| | 171 | \r |
| | 172 | Status = EfiAcquireLockOrFail (&mPerfRecordLock);\r |
| | 173 | if (EFI_ERROR (Status)) {\r |
| | 174 | return Status;\r |
| | 175 | }\r |
| | 176 | \r |
| | 177 | Index = mGaugeData->NumberOfEntries;\r |
| | 178 | if (Index >= mMaxGaugeRecords) {\r |
| | 179 | //\r |
| | 180 | // Try to enlarge the scale of gauge array.\r |
| | 181 | //\r |
| | 182 | OldGaugeData = mGaugeData;\r |
| | 183 | OldGaugeDataSize = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords;\r |
| | 184 | \r |
| | 185 | GaugeDataSize = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords * 2;\r |
| | 186 | \r |
| | 187 | NewGaugeData = AllocateZeroPool (GaugeDataSize);\r |
| | 188 | if (NewGaugeData == NULL) {\r |
| | 189 | EfiReleaseLock (&mPerfRecordLock);\r |
| | 190 | return EFI_OUT_OF_RESOURCES;\r |
| | 191 | }\r |
| | 192 | \r |
| | 193 | mGaugeData = NewGaugeData;\r |
| | 194 | mMaxGaugeRecords *= 2;\r |
| | 195 | \r |
| | 196 | //\r |
| | 197 | // Initialize new data array and migrate old data one.\r |
| | 198 | //\r |
| | 199 | mGaugeData = CopyMem (mGaugeData, OldGaugeData, OldGaugeDataSize);\r |
| | 200 | \r |
| | 201 | FreePool (OldGaugeData);\r |
| | 202 | }\r |
| | 203 | \r |
| | 204 | GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r |
| | 205 | GaugeEntryExArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;\r |
| | 206 | \r |
| | 207 | if (Token != NULL) {\r |
| | 208 | AsciiStrnCpyS (GaugeEntryExArray[Index].Token, DXE_PERFORMANCE_STRING_SIZE, Token, DXE_PERFORMANCE_STRING_LENGTH);\r |
| | 209 | }\r |
| | 210 | if (Module != NULL) {\r |
| | 211 | AsciiStrnCpyS (GaugeEntryExArray[Index].Module, DXE_PERFORMANCE_STRING_SIZE, Module, DXE_PERFORMANCE_STRING_LENGTH);\r |
| | 212 | }\r |
| | 213 | \r |
| | 214 | GaugeEntryExArray[Index].EndTimeStamp = 0;\r |
| | 215 | GaugeEntryExArray[Index].Identifier = Identifier;\r |
| | 216 | \r |
| | 217 | if (TimeStamp == 0) {\r |
| | 218 | TimeStamp = GetPerformanceCounter ();\r |
| | 219 | }\r |
| | 220 | GaugeEntryExArray[Index].StartTimeStamp = TimeStamp;\r |
| | 221 | \r |
| | 222 | mGaugeData->NumberOfEntries++;\r |
| | 223 | \r |
| | 224 | EfiReleaseLock (&mPerfRecordLock);\r |
| | 225 | \r |
| | 226 | return EFI_SUCCESS;\r |
| | 227 | }\r |
| | 228 | \r |
| | 229 | /**\r |
| | 230 | Searches the performance measurement log from the beginning of the log\r |
| | 231 | for the first matching record that contains a zero end time and fills in a valid end time.\r |
| | 232 | \r |
| | 233 | Searches the performance measurement log from the beginning of the log\r |
| | 234 | for the first record that matches Handle, Token and Module and has an end time value of zero.\r |
| | 235 | If the record can not be found then return EFI_NOT_FOUND.\r |
| | 236 | If the record is found and TimeStamp is not zero,\r |
| | 237 | then the end time in the record is filled in with the value specified by TimeStamp.\r |
| | 238 | If the record is found and TimeStamp is zero, then the end time in the matching record\r |
| | 239 | is filled in with the current time stamp value.\r |
| | 240 | \r |
| | 241 | @param Handle Pointer to environment specific context used\r |
| | 242 | to identify the component being measured.\r |
| | 243 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 244 | that identifies the component being measured.\r |
| | 245 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 246 | that identifies the module being measured.\r |
| | 247 | @param TimeStamp 64-bit time stamp.\r |
| | 248 | @param Identifier 32-bit identifier. If the value is 0, the found record\r |
| | 249 | is same as the one found by EndGauge of PERFORMANCE_PROTOCOL.\r |
| | 250 | \r |
| | 251 | @retval EFI_SUCCESS The end of the measurement was recorded.\r |
| | 252 | @retval EFI_NOT_FOUND The specified measurement record could not be found.\r |
| | 253 | \r |
| | 254 | **/\r |
| | 255 | EFI_STATUS\r |
| | 256 | EFIAPI\r |
| | 257 | EndGaugeEx (\r |
| | 258 | IN CONST VOID *Handle, OPTIONAL\r |
| | 259 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 260 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 261 | IN UINT64 TimeStamp,\r |
| | 262 | IN UINT32 Identifier\r |
| | 263 | )\r |
| | 264 | {\r |
| | 265 | GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r |
| | 266 | UINT32 Index;\r |
| | 267 | EFI_STATUS Status;\r |
| | 268 | \r |
| | 269 | Status = EfiAcquireLockOrFail (&mPerfRecordLock);\r |
| | 270 | if (EFI_ERROR (Status)) {\r |
| | 271 | return Status;\r |
| | 272 | }\r |
| | 273 | \r |
| | 274 | if (TimeStamp == 0) {\r |
| | 275 | TimeStamp = GetPerformanceCounter ();\r |
| | 276 | }\r |
| | 277 | \r |
| | 278 | Index = InternalSearchForGaugeEntry (Handle, Token, Module, Identifier);\r |
| | 279 | if (Index >= mGaugeData->NumberOfEntries) {\r |
| | 280 | EfiReleaseLock (&mPerfRecordLock);\r |
| | 281 | return EFI_NOT_FOUND;\r |
| | 282 | }\r |
| | 283 | GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r |
| | 284 | GaugeEntryExArray[Index].EndTimeStamp = TimeStamp;\r |
| | 285 | \r |
| | 286 | EfiReleaseLock (&mPerfRecordLock);\r |
| | 287 | return EFI_SUCCESS;\r |
| | 288 | }\r |
| | 289 | \r |
| | 290 | /**\r |
| | 291 | Retrieves a previously logged performance measurement.\r |
| | 292 | It can also retrieve the log created by StartGauge and EndGauge of PERFORMANCE_PROTOCOL,\r |
| | 293 | and then assign the Identifier with 0.\r |
| | 294 | \r |
| | 295 | Retrieves the performance log entry from the performance log specified by LogEntryKey.\r |
| | 296 | If it stands for a valid entry, then EFI_SUCCESS is returned and\r |
| | 297 | GaugeDataEntryEx stores the pointer to that entry.\r |
| | 298 | \r |
| | 299 | This internal function is added to avoid releasing lock before each return statement.\r |
| | 300 | \r |
| | 301 | @param LogEntryKey The key for the previous performance measurement log entry.\r |
| | 302 | If 0, then the first performance measurement log entry is retrieved.\r |
| | 303 | @param GaugeDataEntryEx The indirect pointer to the extended gauge data entry specified by LogEntryKey\r |
| | 304 | if the retrieval is successful.\r |
| | 305 | \r |
| | 306 | @retval EFI_SUCCESS The GuageDataEntryEx is successfully found based on LogEntryKey.\r |
| | 307 | @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).\r |
| | 308 | @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).\r |
| | 309 | @retval EFI_INVALIDE_PARAMETER GaugeDataEntryEx is NULL.\r |
| | 310 | \r |
| | 311 | **/\r |
| | 312 | EFI_STATUS\r |
| | 313 | EFIAPI\r |
| | 314 | InternalGetGaugeEx (\r |
| | 315 | IN UINTN LogEntryKey,\r |
| | 316 | OUT GAUGE_DATA_ENTRY_EX **GaugeDataEntryEx\r |
| | 317 | )\r |
| | 318 | {\r |
| | 319 | UINTN NumberOfEntries;\r |
| | 320 | GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r |
| | 321 | \r |
| | 322 | NumberOfEntries = (UINTN) (mGaugeData->NumberOfEntries);\r |
| | 323 | if (LogEntryKey > NumberOfEntries) {\r |
| | 324 | return EFI_INVALID_PARAMETER;\r |
| | 325 | }\r |
| | 326 | if (LogEntryKey == NumberOfEntries) {\r |
| | 327 | return EFI_NOT_FOUND;\r |
| | 328 | }\r |
| | 329 | \r |
| | 330 | GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r |
| | 331 | \r |
| | 332 | if (GaugeDataEntryEx == NULL) {\r |
| | 333 | return EFI_INVALID_PARAMETER;\r |
| | 334 | }\r |
| | 335 | *GaugeDataEntryEx = &GaugeEntryExArray[LogEntryKey];\r |
| | 336 | \r |
| | 337 | return EFI_SUCCESS;\r |
| | 338 | }\r |
| | 339 | \r |
| | 340 | /**\r |
| | 341 | Retrieves a previously logged performance measurement.\r |
| | 342 | It can also retrieve the log created by StartGauge and EndGauge of PERFORMANCE_PROTOCOL,\r |
| | 343 | and then assign the Identifier with 0.\r |
| | 344 | \r |
| | 345 | Retrieves the performance log entry from the performance log specified by LogEntryKey.\r |
| | 346 | If it stands for a valid entry, then EFI_SUCCESS is returned and\r |
| | 347 | GaugeDataEntryEx stores the pointer to that entry.\r |
| | 348 | \r |
| | 349 | @param LogEntryKey The key for the previous performance measurement log entry.\r |
| | 350 | If 0, then the first performance measurement log entry is retrieved.\r |
| | 351 | @param GaugeDataEntryEx The indirect pointer to the extended gauge data entry specified by LogEntryKey\r |
| | 352 | if the retrieval is successful.\r |
| | 353 | \r |
| | 354 | @retval EFI_SUCCESS The GuageDataEntryEx is successfully found based on LogEntryKey.\r |
| | 355 | @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).\r |
| | 356 | @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).\r |
| | 357 | @retval EFI_INVALIDE_PARAMETER GaugeDataEntryEx is NULL.\r |
| | 358 | \r |
| | 359 | **/\r |
| | 360 | EFI_STATUS\r |
| | 361 | EFIAPI\r |
| | 362 | GetGaugeEx (\r |
| | 363 | IN UINTN LogEntryKey,\r |
| | 364 | OUT GAUGE_DATA_ENTRY_EX **GaugeDataEntryEx\r |
| | 365 | )\r |
| | 366 | {\r |
| | 367 | EFI_STATUS Status;\r |
| | 368 | \r |
| | 369 | Status = EfiAcquireLockOrFail (&mPerfRecordLock);\r |
| | 370 | if (EFI_ERROR (Status)) {\r |
| | 371 | return Status;\r |
| | 372 | }\r |
| | 373 | \r |
| | 374 | Status = InternalGetGaugeEx (LogEntryKey, GaugeDataEntryEx);\r |
| | 375 | \r |
| | 376 | EfiReleaseLock (&mPerfRecordLock);\r |
| | 377 | \r |
| | 378 | return Status;\r |
| | 379 | }\r |
| | 380 | \r |
| | 381 | /**\r |
| | 382 | Adds a record at the end of the performance measurement log\r |
| | 383 | that records the start time of a performance measurement.\r |
| | 384 | \r |
| | 385 | Adds a record to the end of the performance measurement log\r |
| | 386 | that contains the Handle, Token, and Module.\r |
| | 387 | The end time of the new record must be set to zero.\r |
| | 388 | If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r |
| | 389 | If TimeStamp is zero, the start time in the record is filled in with the value\r |
| | 390 | read from the current time stamp.\r |
| | 391 | \r |
| | 392 | @param Handle Pointer to environment specific context used\r |
| | 393 | to identify the component being measured.\r |
| | 394 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 395 | that identifies the component being measured.\r |
| | 396 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 397 | that identifies the module being measured.\r |
| | 398 | @param TimeStamp 64-bit time stamp.\r |
| | 399 | \r |
| | 400 | @retval EFI_SUCCESS The data was read correctly from the device.\r |
| | 401 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r |
| | 402 | \r |
| | 403 | **/\r |
| | 404 | EFI_STATUS\r |
| | 405 | EFIAPI\r |
| | 406 | StartGauge (\r |
| | 407 | IN CONST VOID *Handle, OPTIONAL\r |
| | 408 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 409 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 410 | IN UINT64 TimeStamp\r |
| | 411 | )\r |
| | 412 | {\r |
| | 413 | return StartGaugeEx (Handle, Token, Module, TimeStamp, 0);\r |
| | 414 | }\r |
| | 415 | \r |
| | 416 | /**\r |
| | 417 | Searches the performance measurement log from the beginning of the log\r |
| | 418 | for the first matching record that contains a zero end time and fills in a valid end time.\r |
| | 419 | \r |
| | 420 | Searches the performance measurement log from the beginning of the log\r |
| | 421 | for the first record that matches Handle, Token, and Module and has an end time value of zero.\r |
| | 422 | If the record can not be found then return EFI_NOT_FOUND.\r |
| | 423 | If the record is found and TimeStamp is not zero,\r |
| | 424 | then the end time in the record is filled in with the value specified by TimeStamp.\r |
| | 425 | If the record is found and TimeStamp is zero, then the end time in the matching record\r |
| | 426 | is filled in with the current time stamp value.\r |
| | 427 | \r |
| | 428 | @param Handle Pointer to environment specific context used\r |
| | 429 | to identify the component being measured.\r |
| | 430 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 431 | that identifies the component being measured.\r |
| | 432 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 433 | that identifies the module being measured.\r |
| | 434 | @param TimeStamp 64-bit time stamp.\r |
| | 435 | \r |
| | 436 | @retval EFI_SUCCESS The end of the measurement was recorded.\r |
| | 437 | @retval EFI_NOT_FOUND The specified measurement record could not be found.\r |
| | 438 | \r |
| | 439 | **/\r |
| | 440 | EFI_STATUS\r |
| | 441 | EFIAPI\r |
| | 442 | EndGauge (\r |
| | 443 | IN CONST VOID *Handle, OPTIONAL\r |
| | 444 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 445 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 446 | IN UINT64 TimeStamp\r |
| | 447 | )\r |
| | 448 | {\r |
| | 449 | return EndGaugeEx (Handle, Token, Module, TimeStamp, 0);\r |
| | 450 | }\r |
| | 451 | \r |
| | 452 | /**\r |
| | 453 | Retrieves a previously logged performance measurement.\r |
| | 454 | It can also retrieve the log created by StartGaugeEx and EndGaugeEx of PERFORMANCE_EX_PROTOCOL,\r |
| | 455 | and then eliminate the Identifier.\r |
| | 456 | \r |
| | 457 | Retrieves the performance log entry from the performance log specified by LogEntryKey.\r |
| | 458 | If it stands for a valid entry, then EFI_SUCCESS is returned and\r |
| | 459 | GaugeDataEntry stores the pointer to that entry.\r |
| | 460 | \r |
| | 461 | @param LogEntryKey The key for the previous performance measurement log entry.\r |
| | 462 | If 0, then the first performance measurement log entry is retrieved.\r |
| | 463 | @param GaugeDataEntry The indirect pointer to the gauge data entry specified by LogEntryKey\r |
| | 464 | if the retrieval is successful.\r |
| | 465 | \r |
| | 466 | @retval EFI_SUCCESS The GuageDataEntry is successfully found based on LogEntryKey.\r |
| | 467 | @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).\r |
| | 468 | @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).\r |
| | 469 | @retval EFI_INVALIDE_PARAMETER GaugeDataEntry is NULL.\r |
| | 470 | \r |
| | 471 | **/\r |
| | 472 | EFI_STATUS\r |
| | 473 | EFIAPI\r |
| | 474 | GetGauge (\r |
| | 475 | IN UINTN LogEntryKey,\r |
| | 476 | OUT GAUGE_DATA_ENTRY **GaugeDataEntry\r |
| | 477 | )\r |
| | 478 | {\r |
| | 479 | EFI_STATUS Status;\r |
| | 480 | GAUGE_DATA_ENTRY_EX *GaugeEntryEx;\r |
| | 481 | \r |
| | 482 | GaugeEntryEx = NULL;\r |
| | 483 | \r |
| | 484 | Status = GetGaugeEx (LogEntryKey, &GaugeEntryEx);\r |
| | 485 | if (EFI_ERROR (Status)) {\r |
| | 486 | return Status;\r |
| | 487 | }\r |
| | 488 | \r |
| | 489 | if (GaugeDataEntry == NULL) {\r |
| | 490 | return EFI_INVALID_PARAMETER;\r |
| | 491 | }\r |
| | 492 | \r |
| | 493 | *GaugeDataEntry = (GAUGE_DATA_ENTRY *) GaugeEntryEx;\r |
| | 494 | \r |
| | 495 | return EFI_SUCCESS;\r |
| | 496 | }\r |
| | 497 | \r |
| | 498 | /**\r |
| | 499 | Dumps all the PEI performance log to DXE performance gauge array.\r |
| | 500 | \r |
| | 501 | This internal function dumps all the PEI performance log to the DXE performance gauge array.\r |
| | 502 | It retrieves the optional GUID HOB for PEI performance and then saves the performance data\r |
| | 503 | to DXE performance data structures.\r |
| | 504 | \r |
| | 505 | **/\r |
| | 506 | VOID\r |
| | 507 | InternalGetPeiPerformance (\r |
| | 508 | VOID\r |
| | 509 | )\r |
| | 510 | {\r |
| | 511 | EFI_HOB_GUID_TYPE *GuidHob;\r |
| | 512 | PEI_PERFORMANCE_LOG_HEADER *LogHob;\r |
| | 513 | PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r |
| | 514 | UINT32 *LogIdArray;\r |
| | 515 | GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r |
| | 516 | UINT32 Index;\r |
| | 517 | UINT32 NumberOfEntries;\r |
| | 518 | \r |
| | 519 | NumberOfEntries = 0;\r |
| | 520 | GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r |
| | 521 | \r |
| | 522 | //\r |
| | 523 | // Dump PEI Log Entries to DXE Guage Data structure.\r |
| | 524 | //\r |
| | 525 | GuidHob = GetFirstGuidHob (&gPerformanceProtocolGuid);\r |
| | 526 | if (GuidHob != NULL) {\r |
| | 527 | LogHob = GET_GUID_HOB_DATA (GuidHob);\r |
| | 528 | LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (LogHob + 1);\r |
| | 529 | \r |
| | 530 | NumberOfEntries = LogHob->NumberOfEntries;\r |
| | 531 | for (Index = 0; Index < NumberOfEntries; Index++) {\r |
| | 532 | GaugeEntryExArray[Index].Handle = LogEntryArray[Index].Handle;\r |
| | 533 | AsciiStrCpyS (GaugeEntryExArray[Index].Token, DXE_PERFORMANCE_STRING_SIZE, LogEntryArray[Index].Token);\r |
| | 534 | AsciiStrCpyS (GaugeEntryExArray[Index].Module, DXE_PERFORMANCE_STRING_SIZE, LogEntryArray[Index].Module);\r |
| | 535 | GaugeEntryExArray[Index].StartTimeStamp = LogEntryArray[Index].StartTimeStamp;\r |
| | 536 | GaugeEntryExArray[Index].EndTimeStamp = LogEntryArray[Index].EndTimeStamp;\r |
| | 537 | GaugeEntryExArray[Index].Identifier = 0;\r |
| | 538 | }\r |
| | 539 | \r |
| | 540 | GuidHob = GetFirstGuidHob (&gPerformanceExProtocolGuid);\r |
| | 541 | if (GuidHob != NULL) {\r |
| | 542 | LogIdArray = GET_GUID_HOB_DATA (GuidHob);\r |
| | 543 | for (Index = 0; Index < NumberOfEntries; Index++) {\r |
| | 544 | GaugeEntryExArray[Index].Identifier = LogIdArray[Index];\r |
| | 545 | }\r |
| | 546 | }\r |
| | 547 | }\r |
| | 548 | mGaugeData->NumberOfEntries = NumberOfEntries;\r |
| | 549 | }\r |
| | 550 | \r |
| | 551 | /**\r |
| | 552 | The constructor function initializes Performance infrastructure for DXE phase.\r |
| | 553 | \r |
| | 554 | The constructor function publishes Performance and PerformanceEx protocol, allocates memory to log DXE performance\r |
| | 555 | and merges PEI performance data to DXE performance log.\r |
| | 556 | It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.\r |
| | 557 | \r |
| | 558 | @param ImageHandle The firmware allocated handle for the EFI image.\r |
| | 559 | @param SystemTable A pointer to the EFI System Table.\r |
| | 560 | \r |
| | 561 | @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r |
| | 562 | \r |
| | 563 | **/\r |
| | 564 | EFI_STATUS\r |
| | 565 | EFIAPI\r |
| | 566 | DxeCorePerformanceLibConstructor (\r |
| | 567 | IN EFI_HANDLE ImageHandle,\r |
| | 568 | IN EFI_SYSTEM_TABLE *SystemTable\r |
| | 569 | )\r |
| | 570 | {\r |
| | 571 | EFI_STATUS Status;\r |
| | 572 | PERFORMANCE_PROPERTY *PerformanceProperty;\r |
| | 573 | \r |
| | 574 | \r |
| | 575 | if (!PerformanceMeasurementEnabled ()) {\r |
| | 576 | //\r |
| | 577 | // Do not initialize performance infrastructure if not required.\r |
| | 578 | //\r |
| | 579 | return EFI_SUCCESS;\r |
| | 580 | }\r |
| | 581 | //\r |
| | 582 | // Install the protocol interfaces.\r |
| | 583 | //\r |
| | 584 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
| | 585 | &mHandle,\r |
| | 586 | &gPerformanceProtocolGuid,\r |
| | 587 | &mPerformanceInterface,\r |
| | 588 | &gPerformanceExProtocolGuid,\r |
| | 589 | &mPerformanceExInterface,\r |
| | 590 | NULL\r |
| | 591 | );\r |
| | 592 | ASSERT_EFI_ERROR (Status);\r |
| | 593 | \r |
| | 594 | mMaxGaugeRecords = INIT_DXE_GAUGE_DATA_ENTRIES + (UINT16) (PcdGet16 (PcdMaxPeiPerformanceLogEntries16) != 0 ?\r |
| | 595 | PcdGet16 (PcdMaxPeiPerformanceLogEntries16) :\r |
| | 596 | PcdGet8 (PcdMaxPeiPerformanceLogEntries));\r |
| | 597 | \r |
| | 598 | mGaugeData = AllocateZeroPool (sizeof (GAUGE_DATA_HEADER) + (sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords));\r |
| | 599 | ASSERT (mGaugeData != NULL);\r |
| | 600 | \r |
| | 601 | InternalGetPeiPerformance ();\r |
| | 602 | \r |
| | 603 | Status = EfiGetSystemConfigurationTable (&gPerformanceProtocolGuid, (VOID **) &PerformanceProperty);\r |
| | 604 | if (EFI_ERROR (Status)) {\r |
| | 605 | //\r |
| | 606 | // Install configuration table for performance property.\r |
| | 607 | //\r |
| | 608 | mPerformanceProperty.Revision = PERFORMANCE_PROPERTY_REVISION;\r |
| | 609 | mPerformanceProperty.Reserved = 0;\r |
| | 610 | mPerformanceProperty.Frequency = GetPerformanceCounterProperties (\r |
| | 611 | &mPerformanceProperty.TimerStartValue,\r |
| | 612 | &mPerformanceProperty.TimerEndValue\r |
| | 613 | );\r |
| | 614 | Status = gBS->InstallConfigurationTable (&gPerformanceProtocolGuid, &mPerformanceProperty);\r |
| | 615 | ASSERT_EFI_ERROR (Status);\r |
| | 616 | }\r |
| | 617 | \r |
| | 618 | return EFI_SUCCESS;\r |
| | 619 | }\r |
| | 620 | \r |
| | 621 | /**\r |
| | 622 | Adds a record at the end of the performance measurement log\r |
| | 623 | that records the start time of a performance measurement.\r |
| | 624 | \r |
| | 625 | Adds a record to the end of the performance measurement log\r |
| | 626 | that contains the Handle, Token, Module and Identifier.\r |
| | 627 | The end time of the new record must be set to zero.\r |
| | 628 | If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r |
| | 629 | If TimeStamp is zero, the start time in the record is filled in with the value\r |
| | 630 | read from the current time stamp.\r |
| | 631 | \r |
| | 632 | @param Handle Pointer to environment specific context used\r |
| | 633 | to identify the component being measured.\r |
| | 634 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 635 | that identifies the component being measured.\r |
| | 636 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 637 | that identifies the module being measured.\r |
| | 638 | @param TimeStamp 64-bit time stamp.\r |
| | 639 | @param Identifier 32-bit identifier. If the value is 0, the created record\r |
| | 640 | is same as the one created by StartPerformanceMeasurement.\r |
| | 641 | \r |
| | 642 | @retval RETURN_SUCCESS The start of the measurement was recorded.\r |
| | 643 | @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r |
| | 644 | \r |
| | 645 | **/\r |
| | 646 | RETURN_STATUS\r |
| | 647 | EFIAPI\r |
| | 648 | StartPerformanceMeasurementEx (\r |
| | 649 | IN CONST VOID *Handle, OPTIONAL\r |
| | 650 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 651 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 652 | IN UINT64 TimeStamp,\r |
| | 653 | IN UINT32 Identifier\r |
| | 654 | )\r |
| | 655 | {\r |
| | 656 | return (RETURN_STATUS) StartGaugeEx (Handle, Token, Module, TimeStamp, Identifier);\r |
| | 657 | }\r |
| | 658 | \r |
| | 659 | /**\r |
| | 660 | Searches the performance measurement log from the beginning of the log\r |
| | 661 | for the first matching record that contains a zero end time and fills in a valid end time.\r |
| | 662 | \r |
| | 663 | Searches the performance measurement log from the beginning of the log\r |
| | 664 | for the first record that matches Handle, Token and Module and has an end time value of zero.\r |
| | 665 | If the record can not be found then return RETURN_NOT_FOUND.\r |
| | 666 | If the record is found and TimeStamp is not zero,\r |
| | 667 | then the end time in the record is filled in with the value specified by TimeStamp.\r |
| | 668 | If the record is found and TimeStamp is zero, then the end time in the matching record\r |
| | 669 | is filled in with the current time stamp value.\r |
| | 670 | \r |
| | 671 | @param Handle Pointer to environment specific context used\r |
| | 672 | to identify the component being measured.\r |
| | 673 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 674 | that identifies the component being measured.\r |
| | 675 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 676 | that identifies the module being measured.\r |
| | 677 | @param TimeStamp 64-bit time stamp.\r |
| | 678 | @param Identifier 32-bit identifier. If the value is 0, the found record\r |
| | 679 | is same as the one found by EndPerformanceMeasurement.\r |
| | 680 | \r |
| | 681 | @retval RETURN_SUCCESS The end of the measurement was recorded.\r |
| | 682 | @retval RETURN_NOT_FOUND The specified measurement record could not be found.\r |
| | 683 | \r |
| | 684 | **/\r |
| | 685 | RETURN_STATUS\r |
| | 686 | EFIAPI\r |
| | 687 | EndPerformanceMeasurementEx (\r |
| | 688 | IN CONST VOID *Handle, OPTIONAL\r |
| | 689 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 690 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 691 | IN UINT64 TimeStamp,\r |
| | 692 | IN UINT32 Identifier\r |
| | 693 | )\r |
| | 694 | {\r |
| | 695 | return (RETURN_STATUS) EndGaugeEx (Handle, Token, Module, TimeStamp, Identifier);\r |
| | 696 | }\r |
| | 697 | \r |
| | 698 | /**\r |
| | 699 | Attempts to retrieve a performance measurement log entry from the performance measurement log.\r |
| | 700 | It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,\r |
| | 701 | and then assign the Identifier with 0.\r |
| | 702 | \r |
| | 703 | Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is\r |
| | 704 | zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r |
| | 705 | and the key for the second entry in the log is returned. If the performance log is empty,\r |
| | 706 | then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance\r |
| | 707 | log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r |
| | 708 | returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is\r |
| | 709 | retrieved and an implementation specific non-zero key value that specifies the end of the performance\r |
| | 710 | log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r |
| | 711 | is retrieved and zero is returned. In the cases where a performance log entry can be returned,\r |
| | 712 | the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.\r |
| | 713 | If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r |
| | 714 | If Handle is NULL, then ASSERT().\r |
| | 715 | If Token is NULL, then ASSERT().\r |
| | 716 | If Module is NULL, then ASSERT().\r |
| | 717 | If StartTimeStamp is NULL, then ASSERT().\r |
| | 718 | If EndTimeStamp is NULL, then ASSERT().\r |
| | 719 | If Identifier is NULL, then ASSERT().\r |
| | 720 | \r |
| | 721 | @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.\r |
| | 722 | 0, then the first performance measurement log entry is retrieved.\r |
| | 723 | On exit, the key of the next performance log entry.\r |
| | 724 | @param Handle Pointer to environment specific context used to identify the component\r |
| | 725 | being measured.\r |
| | 726 | @param Token Pointer to a Null-terminated ASCII string that identifies the component\r |
| | 727 | being measured.\r |
| | 728 | @param Module Pointer to a Null-terminated ASCII string that identifies the module\r |
| | 729 | being measured.\r |
| | 730 | @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r |
| | 731 | was started.\r |
| | 732 | @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r |
| | 733 | was ended.\r |
| | 734 | @param Identifier Pointer to the 32-bit identifier that was recorded.\r |
| | 735 | \r |
| | 736 | @return The key for the next performance log entry (in general case).\r |
| | 737 | \r |
| | 738 | **/\r |
| | 739 | UINTN\r |
| | 740 | EFIAPI\r |
| | 741 | GetPerformanceMeasurementEx (\r |
| | 742 | IN UINTN LogEntryKey, \r |
| | 743 | OUT CONST VOID **Handle,\r |
| | 744 | OUT CONST CHAR8 **Token,\r |
| | 745 | OUT CONST CHAR8 **Module,\r |
| | 746 | OUT UINT64 *StartTimeStamp,\r |
| | 747 | OUT UINT64 *EndTimeStamp,\r |
| | 748 | OUT UINT32 *Identifier\r |
| | 749 | )\r |
| | 750 | {\r |
| | 751 | EFI_STATUS Status;\r |
| | 752 | GAUGE_DATA_ENTRY_EX *GaugeData;\r |
| | 753 | \r |
| | 754 | GaugeData = NULL;\r |
| | 755 | \r |
| | 756 | ASSERT (Handle != NULL);\r |
| | 757 | ASSERT (Token != NULL);\r |
| | 758 | ASSERT (Module != NULL);\r |
| | 759 | ASSERT (StartTimeStamp != NULL);\r |
| | 760 | ASSERT (EndTimeStamp != NULL);\r |
| | 761 | ASSERT (Identifier != NULL);\r |
| | 762 | \r |
| | 763 | Status = GetGaugeEx (LogEntryKey++, &GaugeData);\r |
| | 764 | \r |
| | 765 | //\r |
| | 766 | // Make sure that LogEntryKey is a valid log entry key,\r |
| | 767 | //\r |
| | 768 | ASSERT (Status != EFI_INVALID_PARAMETER);\r |
| | 769 | \r |
| | 770 | if (EFI_ERROR (Status)) {\r |
| | 771 | //\r |
| | 772 | // The LogEntryKey is the last entry (equals to the total entry number).\r |
| | 773 | //\r |
| | 774 | return 0;\r |
| | 775 | }\r |
| | 776 | \r |
| | 777 | ASSERT (GaugeData != NULL);\r |
| | 778 | \r |
| | 779 | *Handle = (VOID *) (UINTN) GaugeData->Handle;\r |
| | 780 | *Token = GaugeData->Token;\r |
| | 781 | *Module = GaugeData->Module;\r |
| | 782 | *StartTimeStamp = GaugeData->StartTimeStamp;\r |
| | 783 | *EndTimeStamp = GaugeData->EndTimeStamp;\r |
| | 784 | *Identifier = GaugeData->Identifier;\r |
| | 785 | \r |
| | 786 | return LogEntryKey;\r |
| | 787 | }\r |
| | 788 | \r |
| | 789 | /**\r |
| | 790 | Adds a record at the end of the performance measurement log\r |
| | 791 | that records the start time of a performance measurement.\r |
| | 792 | \r |
| | 793 | Adds a record to the end of the performance measurement log\r |
| | 794 | that contains the Handle, Token, and Module.\r |
| | 795 | The end time of the new record must be set to zero.\r |
| | 796 | If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r |
| | 797 | If TimeStamp is zero, the start time in the record is filled in with the value\r |
| | 798 | read from the current time stamp.\r |
| | 799 | \r |
| | 800 | @param Handle Pointer to environment specific context used\r |
| | 801 | to identify the component being measured.\r |
| | 802 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 803 | that identifies the component being measured.\r |
| | 804 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 805 | that identifies the module being measured.\r |
| | 806 | @param TimeStamp 64-bit time stamp.\r |
| | 807 | \r |
| | 808 | @retval RETURN_SUCCESS The start of the measurement was recorded.\r |
| | 809 | @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r |
| | 810 | \r |
| | 811 | **/\r |
| | 812 | RETURN_STATUS\r |
| | 813 | EFIAPI\r |
| | 814 | StartPerformanceMeasurement (\r |
| | 815 | IN CONST VOID *Handle, OPTIONAL\r |
| | 816 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 817 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 818 | IN UINT64 TimeStamp\r |
| | 819 | )\r |
| | 820 | {\r |
| | 821 | return StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);\r |
| | 822 | }\r |
| | 823 | \r |
| | 824 | /**\r |
| | 825 | Searches the performance measurement log from the beginning of the log\r |
| | 826 | for the first matching record that contains a zero end time and fills in a valid end time.\r |
| | 827 | \r |
| | 828 | Searches the performance measurement log from the beginning of the log\r |
| | 829 | for the first record that matches Handle, Token, and Module and has an end time value of zero.\r |
| | 830 | If the record can not be found then return RETURN_NOT_FOUND.\r |
| | 831 | If the record is found and TimeStamp is not zero,\r |
| | 832 | then the end time in the record is filled in with the value specified by TimeStamp.\r |
| | 833 | If the record is found and TimeStamp is zero, then the end time in the matching record\r |
| | 834 | is filled in with the current time stamp value.\r |
| | 835 | \r |
| | 836 | @param Handle Pointer to environment specific context used\r |
| | 837 | to identify the component being measured.\r |
| | 838 | @param Token Pointer to a Null-terminated ASCII string\r |
| | 839 | that identifies the component being measured.\r |
| | 840 | @param Module Pointer to a Null-terminated ASCII string\r |
| | 841 | that identifies the module being measured.\r |
| | 842 | @param TimeStamp 64-bit time stamp.\r |
| | 843 | \r |
| | 844 | @retval RETURN_SUCCESS The end of the measurement was recorded.\r |
| | 845 | @retval RETURN_NOT_FOUND The specified measurement record could not be found.\r |
| | 846 | \r |
| | 847 | **/\r |
| | 848 | RETURN_STATUS\r |
| | 849 | EFIAPI\r |
| | 850 | EndPerformanceMeasurement (\r |
| | 851 | IN CONST VOID *Handle, OPTIONAL\r |
| | 852 | IN CONST CHAR8 *Token, OPTIONAL\r |
| | 853 | IN CONST CHAR8 *Module, OPTIONAL\r |
| | 854 | IN UINT64 TimeStamp\r |
| | 855 | )\r |
| | 856 | {\r |
| | 857 | return EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);\r |
| | 858 | }\r |
| | 859 | \r |
| | 860 | /**\r |
| | 861 | Attempts to retrieve a performance measurement log entry from the performance measurement log.\r |
| | 862 | It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,\r |
| | 863 | and then eliminate the Identifier.\r |
| | 864 | \r |
| | 865 | Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is\r |
| | 866 | zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r |
| | 867 | and the key for the second entry in the log is returned. If the performance log is empty,\r |
| | 868 | then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance\r |
| | 869 | log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r |
| | 870 | returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is\r |
| | 871 | retrieved and an implementation specific non-zero key value that specifies the end of the performance\r |
| | 872 | log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r |
| | 873 | is retrieved and zero is returned. In the cases where a performance log entry can be returned,\r |
| | 874 | the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.\r |
| | 875 | If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r |
| | 876 | If Handle is NULL, then ASSERT().\r |
| | 877 | If Token is NULL, then ASSERT().\r |
| | 878 | If Module is NULL, then ASSERT().\r |
| | 879 | If StartTimeStamp is NULL, then ASSERT().\r |
| | 880 | If EndTimeStamp is NULL, then ASSERT().\r |
| | 881 | \r |
| | 882 | @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.\r |
| | 883 | 0, then the first performance measurement log entry is retrieved.\r |
| | 884 | On exit, the key of the next performance log entry.\r |
| | 885 | @param Handle Pointer to environment specific context used to identify the component\r |
| | 886 | being measured.\r |
| | 887 | @param Token Pointer to a Null-terminated ASCII string that identifies the component\r |
| | 888 | being measured.\r |
| | 889 | @param Module Pointer to a Null-terminated ASCII string that identifies the module\r |
| | 890 | being measured.\r |
| | 891 | @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r |
| | 892 | was started.\r |
| | 893 | @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r |
| | 894 | was ended.\r |
| | 895 | \r |
| | 896 | @return The key for the next performance log entry (in general case).\r |
| | 897 | \r |
| | 898 | **/\r |
| | 899 | UINTN\r |
| | 900 | EFIAPI\r |
| | 901 | GetPerformanceMeasurement (\r |
| | 902 | IN UINTN LogEntryKey,\r |
| | 903 | OUT CONST VOID **Handle,\r |
| | 904 | OUT CONST CHAR8 **Token,\r |
| | 905 | OUT CONST CHAR8 **Module,\r |
| | 906 | OUT UINT64 *StartTimeStamp,\r |
| | 907 | OUT UINT64 *EndTimeStamp\r |
| | 908 | )\r |
| | 909 | {\r |
| | 910 | UINT32 Identifier;\r |
| | 911 | return GetPerformanceMeasurementEx (LogEntryKey, Handle, Token, Module, StartTimeStamp, EndTimeStamp, &Identifier);\r |
| | 912 | }\r |
| | 913 | \r |
| | 914 | /**\r |
| | 915 | Returns TRUE if the performance measurement macros are enabled.\r |
| | 916 | \r |
| | 917 | This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r |
| | 918 | PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.\r |
| | 919 | \r |
| | 920 | @retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r |
| | 921 | PcdPerformanceLibraryPropertyMask is set.\r |
| | 922 | @retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r |
| | 923 | PcdPerformanceLibraryPropertyMask is clear.\r |
| | 924 | \r |
| | 925 | **/\r |
| | 926 | BOOLEAN\r |
| | 927 | EFIAPI\r |
| | 928 | PerformanceMeasurementEnabled (\r |
| | 929 | VOID\r |
| | 930 | )\r |
| | 931 | {\r |
| | 932 | return (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r |
| | 933 | }\r |
projects / mirror_edk2.git / blame_incremental