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 const char *name;
47 /**
48 * Size of the CPU data associated with this tracepoint.
49 */
50 uint16_t payload_sz;
51 /**
52 * Size of the GPU data associated with this tracepoint.
53 */
54 uint16_t indirect_sz;
55 /**
56 * A bitfield of driver agnostic flags
57 */
58 uint16_t flags;
59 /**
60 * Index of this tracepoint in <basename>_tracepoint_names in the generated
61 * u_trace perfetto header. By associating these names with iids in setup,
62 * tracepoints can be presented with with their own names by passing that
63 * to event->set_stage_iid().
64 */
65 uint16_t tp_idx;
66 void (*print)(FILE *out, const void *payload, const void *indirect);
67 void (*print_json)(FILE *out, const void *payload, const void *indirect);
68 #ifdef HAVE_PERFETTO
69 /**
70 * Callback to emit a perfetto event, such as render-stage trace
71 */
72 void (*perfetto)(void *pctx,
73 uint64_t ts_ns,
74 uint16_t tp_idx,
75 const void *flush_data,
76 const void *payload,
77 const void *indirect);
78 #endif
79 };
80
81 /**
82 * Append a tracepoint followed by some amount of memory specified by
83 * variable_sz, returning pointer that can be filled with trace payload.
84 */
85 void *u_trace_appendv(struct u_trace *ut,
86 void *cs,
87 const struct u_tracepoint *tp,
88 unsigned variable_sz,
89 unsigned n_indirects,
90 const struct u_trace_address *addresses,
91 const uint8_t *indirect_sizes_B);
92
93 /**
94 * Append a trace event, returning pointer to buffer of tp->payload_sz
95 * to be filled in with trace payload. Called by generated tracepoint
96 * functions.
97 */
98 static inline void *
u_trace_append(struct u_trace * ut,void * cs,const struct u_tracepoint * tp)99 u_trace_append(struct u_trace *ut, void *cs, const struct u_tracepoint *tp)
100 {
101 return u_trace_appendv(ut, cs, tp, 0, 0, NULL, NULL);
102 }
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif /* _U_TRACE_PRIV_H */
109