1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
|
/** @file
Provides services to log the execution times and retrieve them later.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __PERFORMANCE_LIB_H__
#define __PERFORMANCE_LIB_H__
///
/// Performance library property mask bits
///
#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001
//
// Public Progress Identifiers for Event Records.
//
#define PERF_EVENT_ID 0x00
#define MODULE_START_ID 0x01
#define MODULE_END_ID 0x02
#define MODULE_LOADIMAGE_START_ID 0x03
#define MODULE_LOADIMAGE_END_ID 0x04
#define MODULE_DB_START_ID 0x05
#define MODULE_DB_END_ID 0x06
#define MODULE_DB_SUPPORT_START_ID 0x07
#define MODULE_DB_SUPPORT_END_ID 0x08
#define MODULE_DB_STOP_START_ID 0x09
#define MODULE_DB_STOP_END_ID 0x0A
#define PERF_EVENTSIGNAL_START_ID 0x10
#define PERF_EVENTSIGNAL_END_ID 0x11
#define PERF_CALLBACK_START_ID 0x20
#define PERF_CALLBACK_END_ID 0x21
#define PERF_FUNCTION_START_ID 0x30
#define PERF_FUNCTION_END_ID 0x31
#define PERF_INMODULE_START_ID 0x40
#define PERF_INMODULE_END_ID 0x41
#define PERF_CROSSMODULE_START_ID 0x50
#define PERF_CROSSMODULE_END_ID 0x51
//
// Declare bits for PcdPerformanceLibraryPropertyMask and
// also used as the Type parameter of LogPerformanceMeasurementEnabled().
//
#define PERF_CORE_START_IMAGE 0x0002
#define PERF_CORE_LOAD_IMAGE 0x0004
#define PERF_CORE_DB_SUPPORT 0x0008
#define PERF_CORE_DB_START 0x0010
#define PERF_CORE_DB_STOP 0x0020
#define PERF_GENERAL_TYPE 0x0040
/**
Creates a record for the beginning of a performance measurement.
Creates a record that contains the Handle, Token, and Module.
If TimeStamp is not zero, then TimeStamp is added to the record as the start time.
If TimeStamp is zero, then this function reads the current time stamp
and adds that time stamp value to the record as the start time.
@param Handle Pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@retval RETURN_SUCCESS The start of the measurement was recorded.
@retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
**/
RETURN_STATUS
EFIAPI
StartPerformanceMeasurement (
IN CONST VOID *Handle OPTIONAL,
IN CONST CHAR8 *Token OPTIONAL,
IN CONST CHAR8 *Module OPTIONAL,
IN UINT64 TimeStamp
);
/**
Fills in the end time of a performance measurement.
Looks up the record that matches Handle, Token, and Module.
If the record can not be found then return RETURN_NOT_FOUND.
If the record is found and TimeStamp is not zero,
then TimeStamp is added to the record as the end time.
If the record is found and TimeStamp is zero, then this function reads
the current time stamp and adds that time stamp value to the record as the end time.
@param Handle Pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@retval RETURN_SUCCESS The end of the measurement was recorded.
@retval RETURN_NOT_FOUND The specified measurement record could not be found.
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
**/
RETURN_STATUS
EFIAPI
EndPerformanceMeasurement (
IN CONST VOID *Handle OPTIONAL,
IN CONST CHAR8 *Token OPTIONAL,
IN CONST CHAR8 *Module OPTIONAL,
IN UINT64 TimeStamp
);
/**
Attempts to retrieve a performance measurement log entry from the performance measurement log.
It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,
and then eliminate the Identifier.
Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is
zero on entry, then an attempt is made to retrieve the first entry from the performance log,
and the key for the second entry in the log is returned. If the performance log is empty,
then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance
log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is
returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is
retrieved and an implementation specific non-zero key value that specifies the end of the performance
log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry
is retrieved and zero is returned. In the cases where a performance log entry can be returned,
the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.
If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().
If Handle is NULL, then ASSERT().
If Token is NULL, then ASSERT().
If Module is NULL, then ASSERT().
If StartTimeStamp is NULL, then ASSERT().
If EndTimeStamp is NULL, then ASSERT().
@param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.
0, then the first performance measurement log entry is retrieved.
On exit, the key of the next performance log entry.
@param Handle Pointer to environment specific context used to identify the component
being measured.
@param Token Pointer to a Null-terminated ASCII string that identifies the component
being measured.
@param Module Pointer to a Null-terminated ASCII string that identifies the module
being measured.
@param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
was started.
@param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
was ended.
@return The key for the next performance log entry (in general case).
**/
UINTN
EFIAPI
GetPerformanceMeasurement (
IN UINTN LogEntryKey,
OUT CONST VOID **Handle,
OUT CONST CHAR8 **Token,
OUT CONST CHAR8 **Module,
OUT UINT64 *StartTimeStamp,
OUT UINT64 *EndTimeStamp
);
/**
Creates a record for the beginning of a performance measurement.
Creates a record that contains the Handle, Token, Module and Identifier.
If TimeStamp is not zero, then TimeStamp is added to the record as the start time.
If TimeStamp is zero, then this function reads the current time stamp
and adds that time stamp value to the record as the start time.
@param Handle Pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@param Identifier 32-bit identifier. If the value is 0, the created record
is same as the one created by StartPerformanceMeasurement.
@retval RETURN_SUCCESS The start of the measurement was recorded.
@retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
**/
RETURN_STATUS
EFIAPI
StartPerformanceMeasurementEx (
IN CONST VOID *Handle OPTIONAL,
IN CONST CHAR8 *Token OPTIONAL,
IN CONST CHAR8 *Module OPTIONAL,
IN UINT64 TimeStamp,
IN UINT32 Identifier
);
/**
Fills in the end time of a performance measurement.
Looks up the record that matches Handle, Token and Module.
If the record can not be found then return RETURN_NOT_FOUND.
If the record is found and TimeStamp is not zero,
then TimeStamp is added to the record as the end time.
If the record is found and TimeStamp is zero, then this function reads
the current time stamp and adds that time stamp value to the record as the end time.
@param Handle Pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@param Identifier 32-bit identifier. If the value is 0, the found record
is same as the one found by EndPerformanceMeasurement.
@retval RETURN_SUCCESS The end of the measurement was recorded.
@retval RETURN_NOT_FOUND The specified measurement record could not be found.
@retval RETURN_DEVICE_ERROR A device error reading the time stamp.
**/
RETURN_STATUS
EFIAPI
EndPerformanceMeasurementEx (
IN CONST VOID *Handle OPTIONAL,
IN CONST CHAR8 *Token OPTIONAL,
IN CONST CHAR8 *Module OPTIONAL,
IN UINT64 TimeStamp,
IN UINT32 Identifier
);
/**
Attempts to retrieve a performance measurement log entry from the performance measurement log.
It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,
and then assign the Identifier with 0.
Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is
zero on entry, then an attempt is made to retrieve the first entry from the performance log,
and the key for the second entry in the log is returned. If the performance log is empty,
then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance
log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is
returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is
retrieved and an implementation specific non-zero key value that specifies the end of the performance
log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry
is retrieved and zero is returned. In the cases where a performance log entry can be returned,
the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.
If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().
If Handle is NULL, then ASSERT().
If Token is NULL, then ASSERT().
If Module is NULL, then ASSERT().
If StartTimeStamp is NULL, then ASSERT().
If EndTimeStamp is NULL, then ASSERT().
If Identifier is NULL, then ASSERT().
@param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.
0, then the first performance measurement log entry is retrieved.
On exit, the key of the next performance of entry entry.
@param Handle Pointer to environment specific context used to identify the component
being measured.
@param Token Pointer to a Null-terminated ASCII string that identifies the component
being measured.
@param Module Pointer to a Null-terminated ASCII string that identifies the module
being measured.
@param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
was started.
@param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement
was ended.
@param Identifier Pointer to the 32-bit identifier that was recorded.
@return The key for the next performance log entry (in general case).
**/
UINTN
EFIAPI
GetPerformanceMeasurementEx (
IN UINTN LogEntryKey,
OUT CONST VOID **Handle,
OUT CONST CHAR8 **Token,
OUT CONST CHAR8 **Module,
OUT UINT64 *StartTimeStamp,
OUT UINT64 *EndTimeStamp,
OUT UINT32 *Identifier
);
/**
Returns TRUE if the performance measurement macros are enabled.
This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.
@retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
PcdPerformanceLibraryPropertyMask is set.
@retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of
PcdPerformanceLibraryPropertyMask is clear.
**/
BOOLEAN
EFIAPI
PerformanceMeasurementEnabled (
VOID
);
/**
Check whether the specified performance measurement can be logged.
This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set
and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.
@param Type - Type of the performance measurement entry.
@retval TRUE The performance measurement can be logged.
@retval FALSE The performance measurement can NOT be logged.
**/
BOOLEAN
EFIAPI
LogPerformanceMeasurementEnabled (
IN CONST UINTN Type
);
/**
Create performance record with event description.
@param CallerIdentifier - Image handle or pointer to caller ID GUID
@param Guid - Pointer to a GUID.
Used for event signal perf and callback perf to cache the event guid.
@param String - Pointer to a string describing the measurement
@param Address - Pointer to a location in memory relevant to the measurement.
@param Identifier - Performance identifier describing the type of measurement.
@retval RETURN_SUCCESS - Successfully created performance record
@retval RETURN_OUT_OF_RESOURCES - Ran out of space to store the records
@retval RETURN_INVALID_PARAMETER - Invalid parameter passed to function - NULL
pointer or invalid Identifier.
**/
RETURN_STATUS
EFIAPI
LogPerformanceMeasurement (
IN CONST VOID *CallerIdentifier OPTIONAL,
IN CONST VOID *Guid OPTIONAL,
IN CONST CHAR8 *String OPTIONAL,
IN UINT64 Address OPTIONAL,
IN UINT32 Identifier
);
/**
Begin Macro to measure the performance of StartImage in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT1 (disable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_START_IMAGE_BEGIN(ModuleHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_START_IMAGE)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of StartImage in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT1 (disable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_START_IMAGE_END(ModuleHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_START_IMAGE)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of LoadImage in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT2 (disable PERF_CORE_LOAD_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_LOAD_IMAGE_BEGIN(ModuleHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_LOAD_IMAGE)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_LOADIMAGE_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of LoadImage in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT2 (disable PERF_CORE_LOAD_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_LOAD_IMAGE_END(ModuleHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_LOAD_IMAGE)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_LOADIMAGE_END_ID); \
} \
} while (FALSE)
/**
Start Macro to measure the performance of DriverBinding Support in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT3 (disable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_SUPPORT_BEGIN(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_SUPPORT)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_SUPPORT_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of DriverBinding Support in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT3 (disable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_SUPPORT_END(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_SUPPORT)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_SUPPORT_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of DriverBinding Start in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT4 (disable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_START_BEGIN(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_START)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of DriverBinding Start in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT4 (disable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_START_END(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_START)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_END_ID); \
} \
} while (FALSE)
/**
Start Macro to measure the performance of DriverBinding Stop in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT5 (disable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_STOP_BEGIN(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_STOP)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_STOP_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of DriverBinding Stop in core.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT5 (disable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_DRIVER_BINDING_STOP_END(ModuleHandle, ControllerHandle) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_STOP)) { \
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_STOP_END_ID); \
} \
} while (FALSE)
/**
Macro to measure the time from power-on to this macro execution.
It can be used to log a meaningful thing which happens at a time point.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_EVENT(EventString) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, EventString , 0, PERF_EVENT_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of event signal behavior in any module.
The event guid will be passed with this macro.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_EVENT_SIGNAL_BEGIN(EventGuid) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, EventGuid, __func__ , 0, PERF_EVENTSIGNAL_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of event signal behavior in any module.
The event guid will be passed with this macro.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_EVENT_SIGNAL_END(EventGuid) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, EventGuid, __func__ , 0, PERF_EVENTSIGNAL_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of a callback function in any module.
The event guid which trigger the callback function will be passed with this macro.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_CALLBACK_BEGIN(TriggerGuid) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, TriggerGuid, __func__ , 0, PERF_CALLBACK_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of a callback function in any module.
The event guid which trigger the callback function will be passed with this macro.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_CALLBACK_END(TriggerGuid) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, TriggerGuid, __func__ , 0, PERF_CALLBACK_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of a general function in any module.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_FUNCTION_BEGIN() \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, __func__ , 0, PERF_FUNCTION_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of a general function in any module.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_FUNCTION_END() \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, __func__ , 0, PERF_FUNCTION_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of a behavior within one module.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_INMODULE_BEGIN(MeasurementString) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_INMODULE_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of a behavior within one module.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_INMODULE_END(MeasurementString) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_INMODULE_END_ID); \
} \
} while (FALSE)
/**
Begin Macro to measure the performance of a behavior in different modules.
Such as the performance of PEI phase, DXE phase, BDS phase.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_CROSSMODULE_BEGIN(MeasurementString) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_CROSSMODULE_START_ID); \
} \
} while (FALSE)
/**
End Macro to measure the performance of a behavior in different modules.
Such as the performance of PEI phase, DXE phase, BDS phase.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,
then LogPerformanceMeasurement() is called.
**/
#define PERF_CROSSMODULE_END(MeasurementString) \
do { \
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_CROSSMODULE_END_ID); \
} \
} while (FALSE)
/**
Macro that calls EndPerformanceMeasurement().
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then EndPerformanceMeasurement() is called.
**/
#define PERF_END(Handle, Token, Module, TimeStamp) \
do { \
if (PerformanceMeasurementEnabled ()) { \
EndPerformanceMeasurement (Handle, Token, Module, TimeStamp); \
} \
} while (FALSE)
/**
Macro that calls StartPerformanceMeasurement().
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then StartPerformanceMeasurement() is called.
**/
#define PERF_START(Handle, Token, Module, TimeStamp) \
do { \
if (PerformanceMeasurementEnabled ()) { \
StartPerformanceMeasurement (Handle, Token, Module, TimeStamp); \
} \
} while (FALSE)
/**
Macro that calls EndPerformanceMeasurementEx().
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then EndPerformanceMeasurementEx() is called.
**/
#define PERF_END_EX(Handle, Token, Module, TimeStamp, Identifier) \
do { \
if (PerformanceMeasurementEnabled ()) { \
EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \
} \
} while (FALSE)
/**
Macro that calls StartPerformanceMeasurementEx().
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then StartPerformanceMeasurementEx() is called.
**/
#define PERF_START_EX(Handle, Token, Module, TimeStamp, Identifier) \
do { \
if (PerformanceMeasurementEnabled ()) { \
StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \
} \
} while (FALSE)
/**
Macro that marks the beginning of performance measurement source code.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then this macro marks the beginning of source code that is included in a module.
Otherwise, the source lines between PERF_CODE_BEGIN() and PERF_CODE_END() are not included in a module.
**/
#define PERF_CODE_BEGIN() \
do { \
if (PerformanceMeasurementEnabled ()) { \
do { } while (FALSE)
/**
Macro that marks the end of performance measurement source code.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then this macro marks the end of source code that is included in a module.
Otherwise, the source lines between PERF_CODE_BEGIN() and PERF_CODE_END() are not included in a module.
**/
#define PERF_CODE_END() \
} \
} while (FALSE)
/**
Macro that declares a section of performance measurement source code.
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
then the source code specified by Expression is included in a module.
Otherwise, the source specified by Expression is not included in a module.
@param Expression Performance measurement source code to include in a module.
**/
#define PERF_CODE(Expression) \
PERF_CODE_BEGIN (); \
Expression \
PERF_CODE_END ()
#endif
|
