Libraries and utilities for instrumenting regions of code and measuring their perform...
[mirror_edk2.git] / PerformancePkg / Dp_App / Dp.h
1 /** @file
2 * Common declarations for the Dp Performance Reporting Utility.
3 *
4 * Copyright (c) 2009-2010, Intel Corporation. All rights reserved.<BR>
5 * This program and the accompanying materials
6 * are licensed and made available under the terms and conditions of the BSD License
7 * which accompanies this distribution. The full text of the license may be found at
8 * http://opensource.org/licenses/bsd-license.php
9 *
10 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 **/
13
14 #ifndef _EFI_APP_DP_H_
15 #define _EFI_APP_DP_H_
16
17 #define DP_MAJOR_VERSION 2
18 #define DP_MINOR_VERSION 3
19
20 /**
21 * The value assigned to DP_DEBUG controls which debug output
22 * is generated. Set it to ZERO to disable.
23 **/
24 #define DP_DEBUG 0
25
26 /**
27 * Set to 1 once Profiling has been implemented in order to enable
28 * profiling related options and report output.
29 **/
30 #define PROFILING_IMPLEMENTED 0
31
32 #define DEFAULT_THRESHOLD 1000 ///< One millisecond.
33 #define DEFAULT_DISPLAYCOUNT 50
34 #define MAXIMUM_DISPLAYCOUNT 999999 ///< Arbitrary maximum reasonable number.
35
36 #define PERF_MAXDUR 0xFFFFFFFFFFFFFFFFULL
37
38 /// Determine whether 0 <= C < L. If L == 0, return true regardless of C.
39 #define WITHIN_LIMIT( C, L) ( ((L) == 0) || ((C) < (L)) )
40
41 /// Structure for storing Timer specific information.
42 typedef struct {
43 UINT64 StartCount; ///< Value timer is initialized with.
44 UINT64 EndCount; ///< Value timer has just before it wraps.
45 UINT32 Frequency; ///< Timer count frequency in KHz.
46 BOOLEAN CountUp; ///< TRUE if the counter counts up.
47 } TIMER_INFO;
48
49 /** Initialize one PERF_CUM_DATA structure instance for token t.
50 *
51 * This parameterized macro takes a single argument, t, which is expected
52 * to resolve to a pointer to an ASCII string literal. This parameter may
53 * take any one of the following forms:
54 * - PERF_INIT_CUM_DATA("Token") A string literal
55 * - PERF_INIT_CUM_DATA(pointer) A pointer -- CHAR8 *pointer;
56 * - PERF_INIT_CUM_DATA(array) Address of an array -- CHAR8 array[N];
57 **/
58 #define PERF_INIT_CUM_DATA(t) { 0ULL, PERF_MAXDUR, 0ULL, (t), 0U }
59
60 typedef struct {
61 UINT64 Duration; ///< Cumulative duration for this item.
62 UINT64 MinDur; ///< Smallest duration encountered.
63 UINT64 MaxDur; ///< Largest duration encountered.
64 CHAR8 *Name; ///< ASCII name of this item.
65 UINT32 Count; ///< Total number of measurements accumulated.
66 } PERF_CUM_DATA;
67
68 typedef struct {
69 UINT32 NumTrace; ///< Number of recorded TRACE performance measurements.
70 UINT32 NumProfile; ///< Number of recorded PROFILE performance measurements.
71 UINT32 NumIncomplete; ///< Number of measurements with no END value.
72 UINT32 NumSummary; ///< Number of summary section measurements.
73 UINT32 NumHandles; ///< Number of measurements with handles.
74 UINT32 NumPEIMs; ///< Number of measurements of PEIMs.
75 UINT32 NumGlobal; ///< Number of measurements with END value and NULL handle.
76 } PERF_SUMMARY_DATA;
77
78 typedef struct {
79 VOID *Handle;
80 CHAR8 *Token; ///< Measured token string name.
81 CHAR8 *Module; ///< Module string name.
82 UINT64 StartTimeStamp; ///< Start time point.
83 UINT64 EndTimeStamp; ///< End time point.
84 } MEASUREMENT_RECORD;
85
86 typedef struct {
87 CHAR8 *Name; ///< Measured token string name.
88 UINT64 CumulativeTime; ///< Accumulated Elapsed Time.
89 UINT64 MinTime; ///< Minimum Elapsed Time.
90 UINT64 MaxTime; ///< Maximum Elapsed Time.
91 UINT32 Count; ///< Number of measurements accumulated.
92 } PROFILE_RECORD;
93
94 #endif // _EFI_APP_DP_H_