Implement dynamic types, and application context provider support
[lttng-ust.git] / include / lttng / ust-abi.h
... / ...
CommitLineData
1#ifndef _LTTNG_UST_ABI_H
2#define _LTTNG_UST_ABI_H
3
4/*
5 * lttng/ust-abi.h
6 *
7 * LTTng-UST ABI header
8 *
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:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
30#include <stdint.h>
31#include <lttng/ust-compiler.h>
32
33#ifndef __ust_stringify
34#define __ust_stringify1(x) #x
35#define __ust_stringify(x) __ust_stringify1(x)
36#endif /* __ust_stringify */
37
38#define LTTNG_UST_SYM_NAME_LEN 256
39#define LTTNG_UST_ABI_PROCNAME_LEN 16
40
41/* UST comm magic number, used to validate protocol and endianness. */
42#define LTTNG_UST_COMM_MAGIC 0xC57C57C5
43
44/* Version for ABI between liblttng-ust, sessiond, consumerd */
45#define LTTNG_UST_ABI_MAJOR_VERSION 6
46#define LTTNG_UST_ABI_MINOR_VERSION 1
47
48enum lttng_ust_instrumentation {
49 LTTNG_UST_TRACEPOINT = 0,
50 LTTNG_UST_PROBE = 1,
51 LTTNG_UST_FUNCTION = 2,
52};
53
54enum lttng_ust_loglevel_type {
55 LTTNG_UST_LOGLEVEL_ALL = 0,
56 LTTNG_UST_LOGLEVEL_RANGE = 1,
57 LTTNG_UST_LOGLEVEL_SINGLE = 2,
58};
59
60enum lttng_ust_output {
61 LTTNG_UST_MMAP = 0,
62};
63
64enum lttng_ust_chan_type {
65 LTTNG_UST_CHAN_PER_CPU = 0,
66 LTTNG_UST_CHAN_METADATA = 1,
67};
68
69struct lttng_ust_tracer_version {
70 uint32_t major;
71 uint32_t minor;
72 uint32_t patchlevel;
73} LTTNG_PACKED;
74
75#define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
76/*
77 * Given that the consumerd is limited to 64k file descriptors, we
78 * cannot expect much more than 1MB channel structure size. This size is
79 * depends on the number of streams within a channel, which depends on
80 * the number of possible CPUs on the system.
81 */
82#define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
83struct lttng_ust_channel {
84 uint64_t len;
85 enum lttng_ust_chan_type type;
86 char padding[LTTNG_UST_CHANNEL_PADDING];
87 char data[]; /* variable sized data */
88} LTTNG_PACKED;
89
90#define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
91struct lttng_ust_stream {
92 uint64_t len; /* shm len */
93 uint32_t stream_nr; /* stream number */
94 char padding[LTTNG_UST_STREAM_PADDING1];
95 /*
96 * shm_fd and wakeup_fd are send over unix socket as file
97 * descriptors after this structure.
98 */
99} LTTNG_PACKED;
100
101#define LTTNG_UST_EVENT_PADDING1 16
102#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
103struct lttng_ust_event {
104 enum lttng_ust_instrumentation instrumentation;
105 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
106
107 enum lttng_ust_loglevel_type loglevel_type;
108 int loglevel; /* value, -1: all */
109 char padding[LTTNG_UST_EVENT_PADDING1];
110
111 /* Per instrumentation type configuration */
112 union {
113 char padding[LTTNG_UST_EVENT_PADDING2];
114 } u;
115} LTTNG_PACKED;
116
117enum lttng_ust_field_type {
118 LTTNG_UST_FIELD_OTHER = 0,
119 LTTNG_UST_FIELD_INTEGER = 1,
120 LTTNG_UST_FIELD_ENUM = 2,
121 LTTNG_UST_FIELD_FLOAT = 3,
122 LTTNG_UST_FIELD_STRING = 4,
123};
124
125#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
126struct lttng_ust_field_iter {
127 char event_name[LTTNG_UST_SYM_NAME_LEN];
128 char field_name[LTTNG_UST_SYM_NAME_LEN];
129 enum lttng_ust_field_type type;
130 int loglevel; /* event loglevel */
131 int nowrite;
132 char padding[LTTNG_UST_FIELD_ITER_PADDING];
133} LTTNG_PACKED;
134
135enum lttng_ust_context_type {
136 LTTNG_UST_CONTEXT_VTID = 0,
137 LTTNG_UST_CONTEXT_VPID = 1,
138 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
139 LTTNG_UST_CONTEXT_PROCNAME = 3,
140 LTTNG_UST_CONTEXT_IP = 4,
141 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
142 LTTNG_UST_CONTEXT_CPU_ID = 6,
143};
144
145struct lttng_ust_perf_counter_ctx {
146 uint32_t type;
147 uint64_t config;
148 char name[LTTNG_UST_SYM_NAME_LEN];
149} LTTNG_PACKED;
150
151#define LTTNG_UST_CONTEXT_PADDING1 16
152#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
153struct lttng_ust_context {
154 enum lttng_ust_context_type ctx;
155 char padding[LTTNG_UST_CONTEXT_PADDING1];
156
157 union {
158 struct lttng_ust_perf_counter_ctx perf_counter;
159 char padding[LTTNG_UST_CONTEXT_PADDING2];
160 } u;
161} LTTNG_PACKED;
162
163/*
164 * Tracer channel attributes.
165 */
166#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
167struct lttng_ust_channel_attr {
168 uint64_t subbuf_size; /* bytes */
169 uint64_t num_subbuf; /* power of 2 */
170 int overwrite; /* 1: overwrite, 0: discard */
171 unsigned int switch_timer_interval; /* usec */
172 unsigned int read_timer_interval; /* usec */
173 enum lttng_ust_output output; /* splice, mmap */
174 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
175} LTTNG_PACKED;
176
177#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
178struct lttng_ust_tracepoint_iter {
179 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
180 int loglevel;
181 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
182} LTTNG_PACKED;
183
184enum lttng_ust_object_type {
185 LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
186 LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
187 LTTNG_UST_OBJECT_TYPE_STREAM = 1,
188 LTTNG_UST_OBJECT_TYPE_EVENT = 2,
189 LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
190};
191
192#define LTTNG_UST_OBJECT_DATA_PADDING1 32
193#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
194
195struct lttng_ust_object_data {
196 enum lttng_ust_object_type type;
197 int handle;
198 uint64_t size;
199 char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
200 union {
201 struct {
202 void *data;
203 enum lttng_ust_chan_type type;
204 int wakeup_fd;
205 } channel;
206 struct {
207 int shm_fd;
208 int wakeup_fd;
209 uint32_t stream_nr;
210 } stream;
211 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
212 } u;
213} LTTNG_PACKED;
214
215enum lttng_ust_calibrate_type {
216 LTTNG_UST_CALIBRATE_TRACEPOINT,
217};
218
219#define LTTNG_UST_CALIBRATE_PADDING1 16
220#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
221struct lttng_ust_calibrate {
222 enum lttng_ust_calibrate_type type; /* type (input) */
223 char padding[LTTNG_UST_CALIBRATE_PADDING1];
224
225 union {
226 char padding[LTTNG_UST_CALIBRATE_PADDING2];
227 } u;
228} LTTNG_PACKED;
229
230#define FILTER_BYTECODE_MAX_LEN 65536
231#define LTTNG_UST_FILTER_PADDING 32
232struct lttng_ust_filter_bytecode {
233 uint32_t len;
234 uint32_t reloc_offset;
235 uint64_t seqnum;
236 char padding[LTTNG_UST_FILTER_PADDING];
237 char data[0];
238} LTTNG_PACKED;
239
240#define LTTNG_UST_EXCLUSION_PADDING 32
241struct lttng_ust_event_exclusion {
242 uint32_t count;
243 char padding[LTTNG_UST_EXCLUSION_PADDING];
244 char names[LTTNG_UST_SYM_NAME_LEN][0];
245} LTTNG_PACKED;
246
247#define _UST_CMD(minor) (minor)
248#define _UST_CMDR(minor, type) (minor)
249#define _UST_CMDW(minor, type) (minor)
250
251/* Handled by object descriptor */
252#define LTTNG_UST_RELEASE _UST_CMD(0x1)
253
254/* Handled by object cmd */
255
256/* LTTng-UST commands */
257#define LTTNG_UST_SESSION _UST_CMD(0x40)
258#define LTTNG_UST_TRACER_VERSION \
259 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
260#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
261#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
262#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
263#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
264
265/* Session FD commands */
266#define LTTNG_UST_CHANNEL \
267 _UST_CMDW(0x51, struct lttng_ust_channel)
268#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
269#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
270
271/* Channel FD commands */
272#define LTTNG_UST_STREAM _UST_CMD(0x60)
273#define LTTNG_UST_EVENT \
274 _UST_CMDW(0x61, struct lttng_ust_event)
275
276/* Event and Channel FD commands */
277#define LTTNG_UST_CONTEXT \
278 _UST_CMDW(0x70, struct lttng_ust_context)
279#define LTTNG_UST_FLUSH_BUFFER \
280 _UST_CMD(0x71)
281
282/* Event, Channel and Session commands */
283#define LTTNG_UST_ENABLE _UST_CMD(0x80)
284#define LTTNG_UST_DISABLE _UST_CMD(0x81)
285
286/* Tracepoint list commands */
287#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
288#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
289
290/* Event FD commands */
291#define LTTNG_UST_FILTER _UST_CMD(0xA0)
292#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
293
294#define LTTNG_UST_ROOT_HANDLE 0
295
296struct lttng_ust_obj;
297
298union ust_args {
299 struct {
300 void *chan_data;
301 int wakeup_fd;
302 } channel;
303 struct {
304 int shm_fd;
305 int wakeup_fd;
306 } stream;
307 struct {
308 struct lttng_ust_field_iter entry;
309 } field_list;
310};
311
312struct lttng_ust_objd_ops {
313 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
314 union ust_args *args, void *owner);
315 int (*release)(int objd);
316};
317
318/* Create root handle. Always ID 0. */
319int lttng_abi_create_root_handle(void);
320
321const struct lttng_ust_objd_ops *objd_ops(int id);
322int lttng_ust_objd_unref(int id, int is_owner);
323
324void lttng_ust_abi_exit(void);
325void lttng_ust_events_exit(void);
326void lttng_ust_objd_table_owner_cleanup(void *owner);
327
328#endif /* _LTTNG_UST_ABI_H */
This page took 0.023139 seconds and 4 git commands to generate.