1 /*
2 * Copyright © 2020 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 __NEEDS_TRACE_PRIV
25 #error "Do not use this header!"
26 #endif
27
28 #ifndef _U_TRACE_PRIV_H
29 #define _U_TRACE_PRIV_H
30
31 #include "u_trace.h"
32 #include <stdio.h>
33
34 /*
35 * Internal interface used by generated tracepoints
36 */
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /**
43 * Tracepoint descriptor.
44 */
45 struct u_tracepoint {
46 unsigned payload_sz;
47 const char *name;
48 /**
49 * Whether this tracepoint's timestamp must be recorded with as an
50 * end-of-pipe timestamp (for some GPUs the recording timestamp instruction
51 * might be different for top/end of pipe).
52 */
53 bool end_of_pipe:1;
54 /**
55 * Index of this tracepoint in <basename>_tracepoint_names in the generated
56 * u_trace perfetto header. By associating these names with iids in setup,
57 * tracepoints can be presented with with their own names by passing that
58 * to event->set_stage_iid().
59 */
60 uint16_t tp_idx;
61 void (*print)(FILE *out, const void *payload);
62 void (*print_json)(FILE *out, const void *payload);
63 #ifdef HAVE_PERFETTO
64 /**
65 * Callback to emit a perfetto event, such as render-stage trace
66 */
67 void (*perfetto)(void *pctx,
68 uint64_t ts_ns,
69 uint16_t tp_idx,
70 const void *flush_data,
71 const void *payload);
72 #endif
73 };
74
75 /**
76 * Append a tracepoint followed by some amount of memory specified by
77 * variable_sz, returning pointer that can be filled with trace payload.
78 */
79 void *u_trace_appendv(struct u_trace *ut,
80 void *cs,
81 const struct u_tracepoint *tp,
82 unsigned variable_sz);
83
84 /**
85 * Append a trace event, returning pointer to buffer of tp->payload_sz
86 * to be filled in with trace payload. Called by generated tracepoint
87 * functions.
88 */
89 static inline void *
u_trace_append(struct u_trace * ut,void * cs,const struct u_tracepoint * tp)90 u_trace_append(struct u_trace *ut, void *cs, const struct u_tracepoint *tp)
91 {
92 return u_trace_appendv(ut, cs, tp, 0);
93 }
94
95 #ifdef __cplusplus
96 }
97 #endif
98
99 #endif /* _U_TRACE_PRIV_H */
100