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 bool end_of_pipe;
49 void (*print)(FILE *out, const void *payload);
50 void (*print_json)(FILE *out, const void *payload);
51 #ifdef HAVE_PERFETTO
52 /**
53 * Callback to emit a perfetto event, such as render-stage trace
54 */
55 void (*perfetto)(void *pctx,
56 uint64_t ts_ns,
57 const void *flush_data,
58 const void *payload);
59 #endif
60 };
61
62 /**
63 * Append a tracepoint followed by some amount of memory specified by
64 * variable_sz, returning pointer that can be filled with trace payload.
65 */
66 void *u_trace_appendv(struct u_trace *ut,
67 void *cs,
68 const struct u_tracepoint *tp,
69 unsigned variable_sz);
70
71 /**
72 * Append a trace event, returning pointer to buffer of tp->payload_sz
73 * to be filled in with trace payload. Called by generated tracepoint
74 * functions.
75 */
76 static inline void *
u_trace_append(struct u_trace * ut,void * cs,const struct u_tracepoint * tp)77 u_trace_append(struct u_trace *ut, void *cs, const struct u_tracepoint *tp)
78 {
79 return u_trace_appendv(ut, cs, tp, 0);
80 }
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* _U_TRACE_PRIV_H */
87