Fix package: don't distribute generated headers
[lttng-ust.git] / include / lttng / ust-abi.h
CommitLineData
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.
d2428e87
MD
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.
9f3fdbc6
MD
28 */
29
0a42beb6 30#include <stdint.h>
b3f60bbf 31#include <lttng/ust-compiler.h>
0a42beb6 32
f56cd1d5 33#define LTTNG_UST_SYM_NAME_LEN 256
9f3fdbc6 34
0f4eaec3 35/* Version for comm protocol between sessiond and ust */
1332bb04 36#define LTTNG_UST_COMM_VERSION_MAJOR 2
3adfa155 37#define LTTNG_UST_COMM_VERSION_MINOR 1
b35d179d 38
0f4eaec3
MD
39/* Version for ABI between liblttng-ust, sessiond, consumerd */
40#define LTTNG_UST_INTERNAL_MAJOR_VERSION 3
41#define LTTNG_UST_INTERNAL_MINOR_VERSION 0
42#define LTTNG_UST_INTERNAL_PATCHLEVEL_VERSION 0
43
9f3fdbc6 44enum lttng_ust_instrumentation {
df854e41
MD
45 LTTNG_UST_TRACEPOINT = 0,
46 LTTNG_UST_PROBE = 1,
47 LTTNG_UST_FUNCTION = 2,
6b0e60f1
MD
48};
49
50enum lttng_ust_loglevel_type {
882a56d7
MD
51 LTTNG_UST_LOGLEVEL_ALL = 0,
52 LTTNG_UST_LOGLEVEL_RANGE = 1,
53 LTTNG_UST_LOGLEVEL_SINGLE = 2,
9f3fdbc6
MD
54};
55
9f3fdbc6 56enum lttng_ust_output {
b35d179d 57 LTTNG_UST_MMAP = 0,
9f3fdbc6
MD
58};
59
b35d179d 60struct lttng_ust_tracer_version {
b728d87e
MD
61 uint32_t major;
62 uint32_t minor;
b35d179d 63 uint32_t patchlevel;
b3f60bbf 64} LTTNG_PACKED;
9f3fdbc6 65
1332bb04 66#define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32
9f3fdbc6 67struct lttng_ust_channel {
9f3fdbc6
MD
68 uint64_t subbuf_size; /* in bytes */
69 uint64_t num_subbuf;
b3f60bbf 70 int overwrite; /* 1: overwrite, 0: discard */
9f3fdbc6
MD
71 unsigned int switch_timer_interval; /* usecs */
72 unsigned int read_timer_interval; /* usecs */
b35d179d 73 enum lttng_ust_output output; /* output mode */
1332bb04 74 char padding[LTTNG_UST_CHANNEL_PADDING];
b3f60bbf 75} LTTNG_PACKED;
9f3fdbc6 76
1332bb04
MD
77#define LTTNG_UST_STREAM_PADDING1 16
78#define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
381c0f1e 79struct lttng_ust_stream {
1332bb04
MD
80 char padding[LTTNG_UST_STREAM_PADDING1];
81
82 union {
83 char padding[LTTNG_UST_STREAM_PADDING2];
84 } u;
b3f60bbf 85} LTTNG_PACKED;
381c0f1e 86
1332bb04
MD
87#define LTTNG_UST_EVENT_PADDING1 16
88#define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
9f3fdbc6 89struct lttng_ust_event {
9f3fdbc6 90 enum lttng_ust_instrumentation instrumentation;
6b0e60f1
MD
91 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
92
93 enum lttng_ust_loglevel_type loglevel_type;
882a56d7 94 int loglevel; /* value, -1: all */
1332bb04 95 char padding[LTTNG_UST_EVENT_PADDING1];
6b0e60f1 96
9f3fdbc6
MD
97 /* Per instrumentation type configuration */
98 union {
1332bb04 99 char padding[LTTNG_UST_EVENT_PADDING2];
9f3fdbc6 100 } u;
b3f60bbf 101} LTTNG_PACKED;
9f3fdbc6 102
06d4f27e
MD
103enum lttng_ust_field_type {
104 LTTNG_UST_FIELD_OTHER = 0,
105 LTTNG_UST_FIELD_INTEGER = 1,
106 LTTNG_UST_FIELD_ENUM = 2,
107 LTTNG_UST_FIELD_FLOAT = 3,
108 LTTNG_UST_FIELD_STRING = 4,
109};
110
38cb8991 111#define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 28
06d4f27e
MD
112struct lttng_ust_field_iter {
113 char event_name[LTTNG_UST_SYM_NAME_LEN];
114 char field_name[LTTNG_UST_SYM_NAME_LEN];
115 enum lttng_ust_field_type type;
116 int loglevel; /* event loglevel */
180901e6 117 int nowrite;
06d4f27e 118 char padding[LTTNG_UST_FIELD_ITER_PADDING];
b3f60bbf 119} LTTNG_PACKED;
06d4f27e 120
9f3fdbc6 121enum lttng_ust_context_type {
3b402b40 122 LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0
MD
123 LTTNG_UST_CONTEXT_VPID = 1,
124 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb 125 LTTNG_UST_CONTEXT_PROCNAME = 3,
9f3fdbc6
MD
126};
127
1332bb04
MD
128#define LTTNG_UST_CONTEXT_PADDING1 16
129#define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
9f3fdbc6
MD
130struct lttng_ust_context {
131 enum lttng_ust_context_type ctx;
1332bb04
MD
132 char padding[LTTNG_UST_CONTEXT_PADDING1];
133
9f3fdbc6 134 union {
1332bb04 135 char padding[LTTNG_UST_CONTEXT_PADDING2];
9f3fdbc6 136 } u;
b3f60bbf 137} LTTNG_PACKED;
9f3fdbc6 138
92462b01
MD
139/*
140 * Tracer channel attributes.
141 */
1332bb04 142#define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
92462b01 143struct lttng_ust_channel_attr {
92462b01
MD
144 uint64_t subbuf_size; /* bytes */
145 uint64_t num_subbuf; /* power of 2 */
b3f60bbf 146 int overwrite; /* 1: overwrite, 0: discard */
92462b01
MD
147 unsigned int switch_timer_interval; /* usec */
148 unsigned int read_timer_interval; /* usec */
149 enum lttng_ust_output output; /* splice, mmap */
1332bb04 150 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
b3f60bbf 151} LTTNG_PACKED;
92462b01 152
1332bb04 153#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
cbef6901
MD
154struct lttng_ust_tracepoint_iter {
155 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
882a56d7 156 int loglevel;
1332bb04 157 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
b3f60bbf 158} LTTNG_PACKED;
cbef6901 159
1332bb04 160#define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32
92462b01 161struct lttng_ust_object_data {
b3f60bbf 162 uint64_t memory_map_size;
92462b01
MD
163 int handle;
164 int shm_fd;
165 int wait_fd;
1332bb04 166 char padding[LTTNG_UST_OBJECT_DATA_PADDING];
b3f60bbf 167} LTTNG_PACKED;
92462b01 168
d9a9a33b
MD
169enum lttng_ust_calibrate_type {
170 LTTNG_UST_CALIBRATE_TRACEPOINT,
171};
172
1332bb04
MD
173#define LTTNG_UST_CALIBRATE_PADDING1 16
174#define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
d9a9a33b
MD
175struct lttng_ust_calibrate {
176 enum lttng_ust_calibrate_type type; /* type (input) */
1332bb04
MD
177 char padding[LTTNG_UST_CALIBRATE_PADDING1];
178
179 union {
180 char padding[LTTNG_UST_CALIBRATE_PADDING2];
181 } u;
b3f60bbf 182} LTTNG_PACKED;
d9a9a33b 183
5b4839a8 184#define FILTER_BYTECODE_MAX_LEN 65536
a5930599 185#define LTTNG_UST_FILTER_PADDING 32
2d78951a 186struct lttng_ust_filter_bytecode {
2734ca65
CB
187 uint32_t len;
188 uint32_t reloc_offset;
3f6fd224 189 uint64_t seqnum;
a5930599 190 char padding[LTTNG_UST_FILTER_PADDING];
2d78951a 191 char data[0];
b3f60bbf 192} LTTNG_PACKED;
2d78951a 193
9f3fdbc6
MD
194#define _UST_CMD(minor) (minor)
195#define _UST_CMDR(minor, type) (minor)
196#define _UST_CMDW(minor, type) (minor)
197
46050b1a
MD
198/* Handled by object descriptor */
199#define LTTNG_UST_RELEASE _UST_CMD(0x1)
200
201/* Handled by object cmd */
202
9f3fdbc6
MD
203/* LTTng-UST commands */
204#define LTTNG_UST_SESSION _UST_CMD(0x40)
205#define LTTNG_UST_TRACER_VERSION \
206 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
207#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
208#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d 209#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
06d4f27e 210#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
9f3fdbc6 211
46050b1a 212/* Session FD commands */
9f3fdbc6
MD
213#define LTTNG_UST_METADATA \
214 _UST_CMDW(0x50, struct lttng_ust_channel)
215#define LTTNG_UST_CHANNEL \
216 _UST_CMDW(0x51, struct lttng_ust_channel)
217#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
218#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
219
46050b1a 220/* Channel FD commands */
9f3fdbc6
MD
221#define LTTNG_UST_STREAM _UST_CMD(0x60)
222#define LTTNG_UST_EVENT \
223 _UST_CMDW(0x61, struct lttng_ust_event)
224
46050b1a 225/* Event and Channel FD commands */
9f3fdbc6
MD
226#define LTTNG_UST_CONTEXT \
227 _UST_CMDW(0x70, struct lttng_ust_context)
43d330a4 228#define LTTNG_UST_FLUSH_BUFFER \
43861eab 229 _UST_CMD(0x71)
9f3fdbc6 230
46050b1a 231/* Event, Channel and Session commands */
9f3fdbc6
MD
232#define LTTNG_UST_ENABLE _UST_CMD(0x80)
233#define LTTNG_UST_DISABLE _UST_CMD(0x81)
234
51489cad
MD
235/* Tracepoint list commands */
236#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
06d4f27e 237#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
51489cad 238
2d78951a
MD
239/* Event FD commands */
240#define LTTNG_UST_FILTER _UST_CMD(0xA0)
241
46050b1a
MD
242#define LTTNG_UST_ROOT_HANDLE 0
243
b61ce3b2 244struct lttng_ust_obj;
46050b1a 245
ef9ff354
MD
246union ust_args {
247 struct {
248 int *shm_fd;
249 int *wait_fd;
250 uint64_t *memory_map_size;
251 } channel;
252 struct {
253 int *shm_fd;
254 int *wait_fd;
255 uint64_t *memory_map_size;
256 } stream;
40003310
MD
257 struct {
258 struct lttng_ust_field_iter entry;
259 } field_list;
ef9ff354
MD
260};
261
b61ce3b2 262struct lttng_ust_objd_ops {
ef9ff354 263 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
f59ed768 264 union ust_args *args, void *owner);
46050b1a
MD
265 int (*release)(int objd);
266};
267
268/* Create root handle. Always ID 0. */
269int lttng_abi_create_root_handle(void);
270
b61ce3b2 271const struct lttng_ust_objd_ops *objd_ops(int id);
d4419b81 272int lttng_ust_objd_unref(int id);
46050b1a
MD
273
274void lttng_ust_abi_exit(void);
003fedf4 275void lttng_ust_events_exit(void);
f59ed768 276void lttng_ust_objd_table_owner_cleanup(void *owner);
b35d179d 277
9f3fdbc6 278#endif /* _LTTNG_UST_ABI_H */
This page took 0.041809 seconds and 4 git commands to generate.