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