Move UST registry into sessiond and implement notifiers
[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 4
46#define LTTNG_UST_ABI_MINOR_VERSION 0
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};
141
142#define LTTNG_UST_CONTEXT_PADDING1 16
143#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
144struct lttng_ust_context {
145 enum lttng_ust_context_type ctx;
146 char padding[LTTNG_UST_CONTEXT_PADDING1];
147
148 union {
149 char padding[LTTNG_UST_CONTEXT_PADDING2];
150 } u;
151} LTTNG_PACKED;
152
153/*
154 * Tracer channel attributes.
155 */
156#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
157struct lttng_ust_channel_attr {
158 uint64_t subbuf_size; /* bytes */
159 uint64_t num_subbuf; /* power of 2 */
160 int overwrite; /* 1: overwrite, 0: discard */
161 unsigned int switch_timer_interval; /* usec */
162 unsigned int read_timer_interval; /* usec */
163 enum lttng_ust_output output; /* splice, mmap */
164 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
165} LTTNG_PACKED;
166
167#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
168struct lttng_ust_tracepoint_iter {
169 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
170 int loglevel;
171 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
172} LTTNG_PACKED;
173
174enum lttng_ust_object_type {
175 LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
176 LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
177 LTTNG_UST_OBJECT_TYPE_STREAM = 1,
178 LTTNG_UST_OBJECT_TYPE_EVENT = 2,
179 LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
180};
181
182#define LTTNG_UST_OBJECT_DATA_PADDING1 32
183#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
184
185struct lttng_ust_object_data {
186 enum lttng_ust_object_type type;
187 int handle;
188 uint64_t size;
189 char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
190 union {
191 struct {
192 void *data;
193 enum lttng_ust_chan_type type;
194 } channel;
195 struct {
196 int shm_fd;
197 int wakeup_fd;
198 uint32_t stream_nr;
199 } stream;
200 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
201 } u;
202} LTTNG_PACKED;
203
204enum lttng_ust_calibrate_type {
205 LTTNG_UST_CALIBRATE_TRACEPOINT,
206};
207
208#define LTTNG_UST_CALIBRATE_PADDING1 16
209#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
210struct lttng_ust_calibrate {
211 enum lttng_ust_calibrate_type type; /* type (input) */
212 char padding[LTTNG_UST_CALIBRATE_PADDING1];
213
214 union {
215 char padding[LTTNG_UST_CALIBRATE_PADDING2];
216 } u;
217} LTTNG_PACKED;
218
219#define FILTER_BYTECODE_MAX_LEN 65536
220#define LTTNG_UST_FILTER_PADDING 32
221struct lttng_ust_filter_bytecode {
222 uint32_t len;
223 uint32_t reloc_offset;
224 uint64_t seqnum;
225 char padding[LTTNG_UST_FILTER_PADDING];
226 char data[0];
227} LTTNG_PACKED;
228
229#define _UST_CMD(minor) (minor)
230#define _UST_CMDR(minor, type) (minor)
231#define _UST_CMDW(minor, type) (minor)
232
233/* Handled by object descriptor */
234#define LTTNG_UST_RELEASE _UST_CMD(0x1)
235
236/* Handled by object cmd */
237
238/* LTTng-UST commands */
239#define LTTNG_UST_SESSION _UST_CMD(0x40)
240#define LTTNG_UST_TRACER_VERSION \
241 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
242#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
243#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
244#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
245#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
246
247/* Session FD commands */
248#define LTTNG_UST_CHANNEL \
249 _UST_CMDW(0x51, struct lttng_ust_channel)
250#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
251#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
252
253/* Channel FD commands */
254#define LTTNG_UST_STREAM _UST_CMD(0x60)
255#define LTTNG_UST_EVENT \
256 _UST_CMDW(0x61, struct lttng_ust_event)
257
258/* Event and Channel FD commands */
259#define LTTNG_UST_CONTEXT \
260 _UST_CMDW(0x70, struct lttng_ust_context)
261#define LTTNG_UST_FLUSH_BUFFER \
262 _UST_CMD(0x71)
263
264/* Event, Channel and Session commands */
265#define LTTNG_UST_ENABLE _UST_CMD(0x80)
266#define LTTNG_UST_DISABLE _UST_CMD(0x81)
267
268/* Tracepoint list commands */
269#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
270#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
271
272/* Event FD commands */
273#define LTTNG_UST_FILTER _UST_CMD(0xA0)
274
275#define LTTNG_UST_ROOT_HANDLE 0
276
277struct lttng_ust_obj;
278
279union ust_args {
280 struct {
281 void *chan_data;
282 } channel;
283 struct {
284 int shm_fd;
285 int wakeup_fd;
286 } stream;
287 struct {
288 struct lttng_ust_field_iter entry;
289 } field_list;
290};
291
292struct lttng_ust_objd_ops {
293 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
294 union ust_args *args, void *owner);
295 int (*release)(int objd);
296};
297
298/* Create root handle. Always ID 0. */
299int lttng_abi_create_root_handle(void);
300
301const struct lttng_ust_objd_ops *objd_ops(int id);
302int lttng_ust_objd_unref(int id);
303
304void lttng_ust_abi_exit(void);
305void lttng_ust_events_exit(void);
306void lttng_ust_objd_table_owner_cleanup(void *owner);
307
308#endif /* _LTTNG_UST_ABI_H */
This page took 0.023339 seconds and 4 git commands to generate.