lttng.h API update: set filter becomes enable event with filter
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
CommitLineData
6e3805e2
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7 4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d 5 *
d14d33bf
AM
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
fac6795d 9 *
990570ed
DG
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d14d33bf 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
990570ed 13 * more details.
fac6795d 14 *
d14d33bf
AM
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fac6795d
DG
18 */
19
773168b7 20/*
990570ed
DG
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
773168b7 23 */
fac6795d 24
990570ed
DG
25#ifndef _LTTNG_SESSIOND_COMM_H
26#define _LTTNG_SESSIOND_COMM_H
27
d19d9ada 28#define _GNU_SOURCE
fac6795d 29#include <limits.h>
f3ed775e 30#include <lttng/lttng.h>
b17231c6 31#include <common/compat/socket.h>
a4b92340 32#include <common/uri.h>
ce2a9e76 33#include <common/defaults.h>
5e16da05 34
6364a07a
DG
35#include <arpa/inet.h>
36#include <netinet/in.h>
37#include <sys/un.h>
38
39#include "inet.h"
40#include "inet6.h"
0d37f2bc
DG
41#include "unix.h"
42
fac6795d 43/* Queue size of listen(2) */
f158a754 44#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 45
990570ed
DG
46/* Maximum number of FDs that can be sent over a Unix socket */
47#define LTTCOMM_MAX_SEND_FDS 4
48
3817e7df
DG
49/*
50 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 51 */
f73fabfd 52#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d 53
6abb15de 54enum lttcomm_sessiond_command {
0d0c377a 55 /* Tracer command */
b579acd9 56 LTTNG_ADD_CONTEXT,
f4688807 57 LTTNG_CALIBRATE,
0b97ec54 58 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
59 LTTNG_DISABLE_EVENT,
60 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
61 LTTNG_ENABLE_CHANNEL,
62 LTTNG_ENABLE_EVENT,
63 LTTNG_ENABLE_ALL_EVENT,
64 /* Session daemon command */
fac6795d
DG
65 LTTNG_CREATE_SESSION,
66 LTTNG_DESTROY_SESSION,
9f19cc17
DG
67 LTTNG_LIST_CHANNELS,
68 LTTNG_LIST_DOMAINS,
f3ed775e 69 LTTNG_LIST_EVENTS,
9f19cc17 70 LTTNG_LIST_SESSIONS,
052da939 71 LTTNG_LIST_TRACEPOINTS,
d9800920 72 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
73 LTTNG_START_TRACE,
74 LTTNG_STOP_TRACE,
f37d259d 75 LTTNG_LIST_TRACEPOINT_FIELDS,
53a80697 76
de5e9086
DG
77 /* Consumer */
78 LTTNG_DISABLE_CONSUMER,
79 LTTNG_ENABLE_CONSUMER,
80 LTTNG_SET_CONSUMER_URI,
81 /* Relay daemon */
82 RELAYD_ADD_STREAM,
83 RELAYD_CREATE_SESSION,
84 RELAYD_START_DATA,
85 RELAYD_UPDATE_SYNC_INFO,
86 RELAYD_VERSION,
87 RELAYD_SEND_METADATA,
173af62f 88 RELAYD_CLOSE_STREAM,
6d805429 89 RELAYD_DATA_PENDING,
c8f59ee5 90 RELAYD_QUIESCENT_CONTROL,
025faf73 91 LTTNG_ENABLE_EVENT_WITH_FILTER,
44a5e5eb 92 LTTNG_HEALTH_CHECK,
6d805429 93 LTTNG_DATA_PENDING,
fac6795d
DG
94};
95
96/*
97 * lttcomm error code.
98 */
99enum lttcomm_return_code {
f73fabfd
DG
100 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
101 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
102 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
103 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
104 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
105 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
106 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
107 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
108 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
109 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
110 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
111 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
112 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
113 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
80e327fa 114
20fe2104
DG
115 /* MUST be last element */
116 LTTCOMM_NR, /* Last element */
fac6795d
DG
117};
118
de5e9086
DG
119/* lttng socket protocol. */
120enum lttcomm_sock_proto {
121 LTTCOMM_SOCK_UDP,
122 LTTCOMM_SOCK_TCP,
123};
124
125/*
126 * Index in the net_families array below. Please keep in sync!
127 */
128enum lttcomm_sock_domain {
01d0a631
CB
129 LTTCOMM_INET = 0,
130 LTTCOMM_INET6 = 1,
de5e9086
DG
131};
132
133struct lttcomm_sockaddr {
134 enum lttcomm_sock_domain type;
135 union {
136 struct sockaddr_in sin;
137 struct sockaddr_in6 sin6;
138 } addr;
139};
140
141struct lttcomm_sock {
142 int fd;
143 enum lttcomm_sock_proto proto;
144 struct lttcomm_sockaddr sockaddr;
145 const struct lttcomm_proto_ops *ops;
146};
147
148struct lttcomm_net_family {
149 int family;
150 int (*create) (struct lttcomm_sock *sock, int type, int proto);
151};
152
153struct lttcomm_proto_ops {
154 int (*bind) (struct lttcomm_sock *sock);
155 int (*close) (struct lttcomm_sock *sock);
156 int (*connect) (struct lttcomm_sock *sock);
157 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
158 int (*listen) (struct lttcomm_sock *sock, int backlog);
159 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
160 int flags);
161 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
162 int flags);
163};
164
fac6795d 165/*
9bda164d 166 * Data structure received from lttng client to session daemon.
fac6795d
DG
167 */
168struct lttcomm_session_msg {
773168b7 169 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 170 struct lttng_session session;
9f19cc17 171 struct lttng_domain domain;
fac6795d
DG
172 union {
173 struct {
db8870ed 174 char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e
DG
175 char name[NAME_MAX];
176 } disable;
177 /* Event data */
fac6795d 178 struct {
db8870ed 179 char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e 180 struct lttng_event event;
025faf73
DG
181 /* Length of following bytecode for filter. */
182 uint32_t bytecode_len;
f3ed775e
DG
183 } enable;
184 /* Create channel */
185 struct {
186 struct lttng_channel chan;
187 } channel;
d65106b1
DG
188 /* Context */
189 struct {
db8870ed 190 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7d29a247 191 struct lttng_event_context ctx;
d65106b1 192 } context;
d9800920
DG
193 /* Use by register_consumer */
194 struct {
195 char path[PATH_MAX];
196 } reg;
9f19cc17
DG
197 /* List */
198 struct {
db8870ed 199 char channel_name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 200 } list;
d0254c7c 201 struct lttng_calibrate calibrate;
a4b92340 202 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 203 struct {
a4b92340
DG
204 /* Number of lttng_uri following */
205 uint32_t size;
206 } uri;
fac6795d
DG
207 } u;
208};
209
d93c4f1f 210#define LTTNG_FILTER_MAX_LEN 65536
53a80697
MD
211
212/*
213 * Filter bytecode data. The reloc table is located at the end of the
214 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
215 * starts at reloc_table_offset.
216 */
217struct lttng_filter_bytecode {
d93c4f1f
CB
218 uint32_t len; /* len of data */
219 uint32_t reloc_table_offset;
f3f0db50 220 uint64_t seqnum;
53a80697
MD
221 char data[0];
222};
223
fac6795d 224/*
5e16da05 225 * Data structure for the response from sessiond to the lttng client.
fac6795d 226 */
5461b305 227struct lttcomm_lttng_msg {
773168b7
MD
228 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
229 uint32_t ret_code; /* enum lttcomm_return_code */
230 uint32_t pid; /* pid_t */
231 uint32_t data_size;
5461b305
DG
232 /* Contains: trace_name + data */
233 char payload[];
fac6795d
DG
234};
235
44a5e5eb
DG
236struct lttcomm_health_msg {
237 uint32_t component;
238 uint32_t cmd;
239};
240
241struct lttcomm_health_data {
242 uint32_t ret_code;
243};
244
6e3805e2 245/*
3bd1e081
MD
246 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
247 * to either add a channel, add a stream, update a stream, or stop
248 * operation.
6e3805e2 249 */
3bd1e081
MD
250struct lttcomm_consumer_msg {
251 uint32_t cmd_type; /* enum consumerd_command */
252 union {
253 struct {
254 int channel_key;
255 uint64_t max_sb_size; /* the subbuffer size for this channel */
256 /* shm_fd and wait_fd are sent as ancillary data */
257 uint64_t mmap_len;
c30aaa51
MD
258 /* nb_init_streams is the number of streams open initially. */
259 unsigned int nb_init_streams;
de5e9086 260 char name[LTTNG_SYMBOL_NAME_LEN];
3bd1e081
MD
261 } channel;
262 struct {
263 int channel_key;
264 int stream_key;
265 /* shm_fd and wait_fd are sent as ancillary data */
266 uint32_t state; /* enum lttcomm_consumer_fd_state */
267 enum lttng_event_output output; /* use splice or mmap to consume this fd */
268 uint64_t mmap_len;
6df2e2c9
MD
269 uid_t uid; /* User ID owning the session */
270 gid_t gid; /* Group ID owning the session */
3bd1e081 271 char path_name[PATH_MAX];
de5e9086
DG
272 int net_index;
273 unsigned int metadata_flag;
ce2a9e76 274 char name[DEFAULT_STREAM_NAME_LEN]; /* Name string of the stream */
53632229 275 uint64_t session_id; /* Tracing session id of the stream */
3bd1e081 276 } stream;
de5e9086
DG
277 struct {
278 int net_index;
279 enum lttng_stream_type type;
280 /* Open socket to the relayd */
281 struct lttcomm_sock sock;
282 } relayd_sock;
173af62f
DG
283 struct {
284 uint64_t net_seq_idx;
285 } destroy_relayd;
53632229
DG
286 struct {
287 uint64_t session_id;
6d805429 288 } data_pending;
3bd1e081 289 } u;
6e3805e2
DG
290};
291
74d0b642 292#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 293
9df8df5e 294#include <lttng/ust-abi.h>
6e3805e2 295
3817e7df
DG
296/*
297 * Data structure for the commands sent from sessiond to UST.
298 */
299struct lttcomm_ust_msg {
3817e7df
DG
300 uint32_t handle;
301 uint32_t cmd;
302 union {
3817e7df 303 struct lttng_ust_channel channel;
00a17c97 304 struct lttng_ust_stream stream;
3817e7df
DG
305 struct lttng_ust_event event;
306 struct lttng_ust_context context;
00a17c97 307 struct lttng_ust_tracer_version version;
3817e7df
DG
308 } u;
309};
310
311/*
312 * Data structure for the response from UST to the session daemon.
313 * cmd_type is sent back in the reply for validation.
314 */
315struct lttcomm_ust_reply {
316 uint32_t handle;
317 uint32_t cmd;
318 uint32_t ret_code; /* enum lttcomm_return_code */
319 uint32_t ret_val; /* return value */
320 union {
2b0bf864
DG
321 struct {
322 uint64_t memory_map_size;
323 } channel;
324 struct {
325 uint64_t memory_map_size;
326 } stream;
00a17c97 327 struct lttng_ust_tracer_version version;
3817e7df
DG
328 } u;
329};
330
74d0b642 331#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 332
fac6795d
DG
333extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
334
6364a07a
DG
335extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
336 const char *ip, unsigned int port);
337extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
338 const char *ip, unsigned int port);
339
de5e9086
DG
340extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
341extern int lttcomm_create_sock(struct lttcomm_sock *sock);
342extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
343extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
344extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
345extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
346 struct lttcomm_sock *src);
6364a07a 347
773168b7 348#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.075717 seconds and 4 git commands to generate.