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