1 /*
2 * Copyright © 2021 Google, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 */
23
24 #ifndef _UTIL_PERFETTO_H
25 #define _UTIL_PERFETTO_H
26
27 #include "util/u_atomic.h"
28 #include "util/detect_os.h"
29
30 // On Unix, pass a clockid_t to designate which clock was used to gather the timestamp
31 // On Windows, this paramter is ignored, and it's expected that `timestamp` comes from QueryPerformanceCounter
32 #if DETECT_OS_POSIX
33 #include <time.h>
34 typedef clockid_t perfetto_clock_id;
35 #else
36 typedef int32_t perfetto_clock_id;
37 #endif
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 #ifdef HAVE_PERFETTO
44
45 extern int util_perfetto_tracing_state;
46
47 void util_perfetto_init(void);
48
49 static inline bool
util_perfetto_is_tracing_enabled(void)50 util_perfetto_is_tracing_enabled(void)
51 {
52 return p_atomic_read_relaxed(&util_perfetto_tracing_state);
53 }
54
55 void util_perfetto_trace_begin(const char *name);
56
57 void util_perfetto_trace_end(void);
58
59 void util_perfetto_trace_begin_flow(const char *fname, uint64_t id);
60
61 void util_perfetto_counter_set(const char *name, double value);
62
63 void util_perfetto_trace_full_begin(const char *name, uint64_t track_id, uint64_t id, perfetto_clock_id clock, uint64_t timestamp);
64
65 void util_perfetto_trace_full_end(const char *name, uint64_t track_id, perfetto_clock_id clock, uint64_t timestamp);
66
67 uint64_t util_perfetto_next_id(void);
68
69 uint64_t util_perfetto_new_track(const char *name);
70
71 #else /* HAVE_PERFETTO */
72
73 static inline void
74 util_perfetto_init(void)
75 {
76 }
77
78 static inline bool
79 util_perfetto_is_tracing_enabled(void)
80 {
81 return false;
82 }
83
84 static inline void
85 util_perfetto_trace_begin(const char *name)
86 {
87 }
88
89 static inline void
90 util_perfetto_trace_end(void)
91 {
92 }
93
94 static inline void util_perfetto_trace_begin_flow(const char *fname, uint64_t id)
95 {
96 }
97
98 static inline void
99 util_perfetto_trace_full_begin(const char *name, uint64_t track_id, uint64_t id, perfetto_clock_id clock, uint64_t timestamp)
100 {
101 }
102
103 static inline void
104 util_perfetto_trace_full_end(const char *name, uint64_t track_id, perfetto_clock_id clock, uint64_t timestamp)
105 {
106 }
107
108 static inline void util_perfetto_counter_set(const char *name, double value)
109 {
110 }
111
112 static inline uint64_t util_perfetto_next_id(void)
113 {
114 return 0;
115 }
116
117 static inline uint64_t util_perfetto_new_track(const char *name)
118 {
119 return 0;
120 }
121
122 #endif /* HAVE_PERFETTO */
123
124 #ifdef __cplusplus
125 }
126 #endif
127
128 #endif /* _UTIL_PERFETTO_H */
129