Commit | Line | Data |
---|---|---|
9f3fdbc6 MD |
1 | #ifndef _LTTNG_UST_ABI_H |
2 | #define _LTTNG_UST_ABI_H | |
3 | ||
4 | /* | |
4318ae1b | 5 | * lttng/ust-abi.h |
9f3fdbc6 | 6 | * |
9f3fdbc6 MD |
7 | * LTTng-UST ABI header |
8 | * | |
e92f3e28 MD |
9 | * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
a60d70e6 | 17 | * |
e92f3e28 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
9f3fdbc6 MD |
20 | */ |
21 | ||
0a42beb6 MD |
22 | #include <stdint.h> |
23 | ||
f56cd1d5 | 24 | #define LTTNG_UST_SYM_NAME_LEN 256 |
9f3fdbc6 | 25 | |
1332bb04 MD |
26 | #define LTTNG_UST_COMM_VERSION_MAJOR 2 |
27 | #define LTTNG_UST_COMM_VERSION_MINOR 0 | |
b35d179d | 28 | |
9f3fdbc6 | 29 | enum lttng_ust_instrumentation { |
df854e41 MD |
30 | LTTNG_UST_TRACEPOINT = 0, |
31 | LTTNG_UST_PROBE = 1, | |
32 | LTTNG_UST_FUNCTION = 2, | |
6b0e60f1 MD |
33 | }; |
34 | ||
35 | enum lttng_ust_loglevel_type { | |
882a56d7 MD |
36 | LTTNG_UST_LOGLEVEL_ALL = 0, |
37 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
38 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
9f3fdbc6 MD |
39 | }; |
40 | ||
9f3fdbc6 | 41 | enum lttng_ust_output { |
b35d179d | 42 | LTTNG_UST_MMAP = 0, |
9f3fdbc6 MD |
43 | }; |
44 | ||
b35d179d | 45 | struct lttng_ust_tracer_version { |
b728d87e MD |
46 | uint32_t major; |
47 | uint32_t minor; | |
b35d179d | 48 | uint32_t patchlevel; |
b35d179d | 49 | }; |
9f3fdbc6 | 50 | |
1332bb04 | 51 | #define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32 |
9f3fdbc6 MD |
52 | struct lttng_ust_channel { |
53 | int overwrite; /* 1: overwrite, 0: discard */ | |
54 | uint64_t subbuf_size; /* in bytes */ | |
55 | uint64_t num_subbuf; | |
56 | unsigned int switch_timer_interval; /* usecs */ | |
57 | unsigned int read_timer_interval; /* usecs */ | |
b35d179d | 58 | enum lttng_ust_output output; /* output mode */ |
1332bb04 | 59 | char padding[LTTNG_UST_CHANNEL_PADDING]; |
9f3fdbc6 MD |
60 | }; |
61 | ||
1332bb04 MD |
62 | #define LTTNG_UST_STREAM_PADDING1 16 |
63 | #define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
381c0f1e | 64 | struct lttng_ust_stream { |
1332bb04 MD |
65 | char padding[LTTNG_UST_STREAM_PADDING1]; |
66 | ||
67 | union { | |
68 | char padding[LTTNG_UST_STREAM_PADDING2]; | |
69 | } u; | |
381c0f1e MD |
70 | }; |
71 | ||
1332bb04 MD |
72 | #define LTTNG_UST_EVENT_PADDING1 16 |
73 | #define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
9f3fdbc6 | 74 | struct lttng_ust_event { |
9f3fdbc6 | 75 | enum lttng_ust_instrumentation instrumentation; |
6b0e60f1 MD |
76 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
77 | ||
78 | enum lttng_ust_loglevel_type loglevel_type; | |
882a56d7 | 79 | int loglevel; /* value, -1: all */ |
1332bb04 | 80 | char padding[LTTNG_UST_EVENT_PADDING1]; |
6b0e60f1 | 81 | |
9f3fdbc6 MD |
82 | /* Per instrumentation type configuration */ |
83 | union { | |
1332bb04 | 84 | char padding[LTTNG_UST_EVENT_PADDING2]; |
9f3fdbc6 MD |
85 | } u; |
86 | }; | |
87 | ||
9f3fdbc6 | 88 | enum lttng_ust_context_type { |
3b402b40 | 89 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
90 | LTTNG_UST_CONTEXT_VPID = 1, |
91 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 92 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
9f3fdbc6 MD |
93 | }; |
94 | ||
1332bb04 MD |
95 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
96 | #define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
9f3fdbc6 MD |
97 | struct lttng_ust_context { |
98 | enum lttng_ust_context_type ctx; | |
1332bb04 MD |
99 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
100 | ||
9f3fdbc6 | 101 | union { |
1332bb04 | 102 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
9f3fdbc6 MD |
103 | } u; |
104 | }; | |
105 | ||
92462b01 MD |
106 | /* |
107 | * Tracer channel attributes. | |
108 | */ | |
1332bb04 | 109 | #define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32 |
92462b01 MD |
110 | struct lttng_ust_channel_attr { |
111 | int overwrite; /* 1: overwrite, 0: discard */ | |
112 | uint64_t subbuf_size; /* bytes */ | |
113 | uint64_t num_subbuf; /* power of 2 */ | |
114 | unsigned int switch_timer_interval; /* usec */ | |
115 | unsigned int read_timer_interval; /* usec */ | |
116 | enum lttng_ust_output output; /* splice, mmap */ | |
1332bb04 | 117 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; |
92462b01 MD |
118 | }; |
119 | ||
1332bb04 | 120 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
cbef6901 MD |
121 | struct lttng_ust_tracepoint_iter { |
122 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
882a56d7 | 123 | int loglevel; |
1332bb04 | 124 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
cbef6901 MD |
125 | }; |
126 | ||
1332bb04 | 127 | #define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32 |
92462b01 MD |
128 | struct lttng_ust_object_data { |
129 | int handle; | |
130 | int shm_fd; | |
131 | int wait_fd; | |
132 | uint64_t memory_map_size; | |
1332bb04 | 133 | char padding[LTTNG_UST_OBJECT_DATA_PADDING]; |
92462b01 MD |
134 | }; |
135 | ||
d9a9a33b MD |
136 | enum lttng_ust_calibrate_type { |
137 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
138 | }; | |
139 | ||
1332bb04 MD |
140 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
141 | #define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
d9a9a33b MD |
142 | struct lttng_ust_calibrate { |
143 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
1332bb04 MD |
144 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; |
145 | ||
146 | union { | |
147 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
148 | } u; | |
d9a9a33b MD |
149 | }; |
150 | ||
9f3fdbc6 MD |
151 | #define _UST_CMD(minor) (minor) |
152 | #define _UST_CMDR(minor, type) (minor) | |
153 | #define _UST_CMDW(minor, type) (minor) | |
154 | ||
46050b1a MD |
155 | /* Handled by object descriptor */ |
156 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
157 | ||
158 | /* Handled by object cmd */ | |
159 | ||
9f3fdbc6 MD |
160 | /* LTTng-UST commands */ |
161 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
162 | #define LTTNG_UST_TRACER_VERSION \ | |
163 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
164 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
165 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 166 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
9f3fdbc6 | 167 | |
46050b1a | 168 | /* Session FD commands */ |
9f3fdbc6 MD |
169 | #define LTTNG_UST_METADATA \ |
170 | _UST_CMDW(0x50, struct lttng_ust_channel) | |
171 | #define LTTNG_UST_CHANNEL \ | |
172 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
173 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
174 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
175 | ||
46050b1a | 176 | /* Channel FD commands */ |
9f3fdbc6 MD |
177 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
178 | #define LTTNG_UST_EVENT \ | |
179 | _UST_CMDW(0x61, struct lttng_ust_event) | |
180 | ||
46050b1a | 181 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
182 | #define LTTNG_UST_CONTEXT \ |
183 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 184 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 185 | _UST_CMD(0x71) |
9f3fdbc6 | 186 | |
46050b1a | 187 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
188 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
189 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
190 | ||
51489cad MD |
191 | /* Tracepoint list commands */ |
192 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
193 | ||
46050b1a MD |
194 | #define LTTNG_UST_ROOT_HANDLE 0 |
195 | ||
b61ce3b2 | 196 | struct lttng_ust_obj; |
46050b1a | 197 | |
ef9ff354 MD |
198 | union ust_args { |
199 | struct { | |
200 | int *shm_fd; | |
201 | int *wait_fd; | |
202 | uint64_t *memory_map_size; | |
203 | } channel; | |
204 | struct { | |
205 | int *shm_fd; | |
206 | int *wait_fd; | |
207 | uint64_t *memory_map_size; | |
208 | } stream; | |
209 | }; | |
210 | ||
b61ce3b2 | 211 | struct lttng_ust_objd_ops { |
ef9ff354 MD |
212 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
213 | union ust_args *args); | |
46050b1a MD |
214 | int (*release)(int objd); |
215 | }; | |
216 | ||
217 | /* Create root handle. Always ID 0. */ | |
218 | int lttng_abi_create_root_handle(void); | |
219 | ||
b61ce3b2 | 220 | const struct lttng_ust_objd_ops *objd_ops(int id); |
d4419b81 | 221 | int lttng_ust_objd_unref(int id); |
46050b1a MD |
222 | |
223 | void lttng_ust_abi_exit(void); | |
003fedf4 | 224 | void lttng_ust_events_exit(void); |
b35d179d | 225 | |
9f3fdbc6 | 226 | #endif /* _LTTNG_UST_ABI_H */ |