Fix: Conditionally disable test requiring shared libs
[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 */
7c9534d6
JD
56 LTTNG_ADD_CONTEXT = 0,
57 LTTNG_CALIBRATE = 1,
58 LTTNG_DISABLE_CHANNEL = 2,
59 LTTNG_DISABLE_EVENT = 3,
60 LTTNG_DISABLE_ALL_EVENT = 4,
61 LTTNG_ENABLE_CHANNEL = 5,
62 LTTNG_ENABLE_EVENT = 6,
63 LTTNG_ENABLE_ALL_EVENT = 7,
0d0c377a 64 /* Session daemon command */
7c9534d6
JD
65 LTTNG_CREATE_SESSION = 8,
66 LTTNG_DESTROY_SESSION = 9,
67 LTTNG_LIST_CHANNELS = 10,
68 LTTNG_LIST_DOMAINS = 11,
69 LTTNG_LIST_EVENTS = 12,
70 LTTNG_LIST_SESSIONS = 13,
71 LTTNG_LIST_TRACEPOINTS = 14,
72 LTTNG_REGISTER_CONSUMER = 15,
73 LTTNG_START_TRACE = 16,
74 LTTNG_STOP_TRACE = 17,
75 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
53a80697 76
de5e9086 77 /* Consumer */
7c9534d6
JD
78 LTTNG_DISABLE_CONSUMER = 19,
79 LTTNG_ENABLE_CONSUMER = 20,
80 LTTNG_SET_CONSUMER_URI = 21,
81 LTTNG_ENABLE_EVENT_WITH_FILTER = 22,
82 LTTNG_HEALTH_CHECK = 23,
83 LTTNG_DATA_PENDING = 24,
84};
85
86enum lttcomm_relayd_command {
87 RELAYD_ADD_STREAM = 1,
88 RELAYD_CREATE_SESSION = 2,
89 RELAYD_START_DATA = 3,
90 RELAYD_UPDATE_SYNC_INFO = 4,
91 RELAYD_VERSION = 5,
92 RELAYD_SEND_METADATA = 6,
93 RELAYD_CLOSE_STREAM = 7,
94 RELAYD_DATA_PENDING = 8,
95 RELAYD_QUIESCENT_CONTROL = 9,
96 RELAYD_BEGIN_DATA_PENDING = 10,
97 RELAYD_END_DATA_PENDING = 11,
fac6795d
DG
98};
99
100/*
101 * lttcomm error code.
102 */
103enum lttcomm_return_code {
f73fabfd
DG
104 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
105 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
106 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
107 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
108 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
109 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
110 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
111 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
112 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
113 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
114 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
115 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
116 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
117 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
80e327fa 118
20fe2104
DG
119 /* MUST be last element */
120 LTTCOMM_NR, /* Last element */
fac6795d
DG
121};
122
de5e9086
DG
123/* lttng socket protocol. */
124enum lttcomm_sock_proto {
125 LTTCOMM_SOCK_UDP,
126 LTTCOMM_SOCK_TCP,
127};
128
129/*
130 * Index in the net_families array below. Please keep in sync!
131 */
132enum lttcomm_sock_domain {
01d0a631
CB
133 LTTCOMM_INET = 0,
134 LTTCOMM_INET6 = 1,
de5e9086
DG
135};
136
137struct lttcomm_sockaddr {
138 enum lttcomm_sock_domain type;
139 union {
140 struct sockaddr_in sin;
141 struct sockaddr_in6 sin6;
142 } addr;
fc5e05b7 143} LTTNG_PACKED;
de5e9086
DG
144
145struct lttcomm_sock {
146 int fd;
147 enum lttcomm_sock_proto proto;
148 struct lttcomm_sockaddr sockaddr;
149 const struct lttcomm_proto_ops *ops;
fc5e05b7 150} LTTNG_PACKED;
de5e9086
DG
151
152struct lttcomm_net_family {
153 int family;
154 int (*create) (struct lttcomm_sock *sock, int type, int proto);
155};
156
157struct lttcomm_proto_ops {
158 int (*bind) (struct lttcomm_sock *sock);
159 int (*close) (struct lttcomm_sock *sock);
160 int (*connect) (struct lttcomm_sock *sock);
161 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
162 int (*listen) (struct lttcomm_sock *sock, int backlog);
163 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
164 int flags);
165 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
166 int flags);
167};
168
fac6795d 169/*
9bda164d 170 * Data structure received from lttng client to session daemon.
fac6795d
DG
171 */
172struct lttcomm_session_msg {
773168b7 173 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 174 struct lttng_session session;
9f19cc17 175 struct lttng_domain domain;
fac6795d
DG
176 union {
177 struct {
db8870ed 178 char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e 179 char name[NAME_MAX];
fc5e05b7 180 } LTTNG_PACKED disable;
f3ed775e 181 /* Event data */
fac6795d 182 struct {
db8870ed 183 char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e 184 struct lttng_event event;
025faf73
DG
185 /* Length of following bytecode for filter. */
186 uint32_t bytecode_len;
fc5e05b7 187 } LTTNG_PACKED enable;
f3ed775e
DG
188 /* Create channel */
189 struct {
190 struct lttng_channel chan;
fc5e05b7 191 } LTTNG_PACKED channel;
d65106b1
DG
192 /* Context */
193 struct {
db8870ed 194 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7d29a247 195 struct lttng_event_context ctx;
fc5e05b7 196 } LTTNG_PACKED context;
d9800920
DG
197 /* Use by register_consumer */
198 struct {
199 char path[PATH_MAX];
fc5e05b7 200 } LTTNG_PACKED reg;
9f19cc17
DG
201 /* List */
202 struct {
db8870ed 203 char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 204 } LTTNG_PACKED list;
d0254c7c 205 struct lttng_calibrate calibrate;
a4b92340 206 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 207 struct {
a4b92340
DG
208 /* Number of lttng_uri following */
209 uint32_t size;
fc5e05b7 210 } LTTNG_PACKED uri;
fac6795d 211 } u;
fc5e05b7 212} LTTNG_PACKED;
fac6795d 213
d93c4f1f 214#define LTTNG_FILTER_MAX_LEN 65536
53a80697
MD
215
216/*
217 * Filter bytecode data. The reloc table is located at the end of the
218 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
219 * starts at reloc_table_offset.
220 */
b6bbed5f 221#define LTTNG_FILTER_PADDING 32
53a80697 222struct lttng_filter_bytecode {
d93c4f1f
CB
223 uint32_t len; /* len of data */
224 uint32_t reloc_table_offset;
f3f0db50 225 uint64_t seqnum;
b6bbed5f 226 char padding[LTTNG_FILTER_PADDING];
53a80697 227 char data[0];
fc5e05b7 228} LTTNG_PACKED;
53a80697 229
fac6795d 230/*
5e16da05 231 * Data structure for the response from sessiond to the lttng client.
fac6795d 232 */
5461b305 233struct lttcomm_lttng_msg {
773168b7
MD
234 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
235 uint32_t ret_code; /* enum lttcomm_return_code */
236 uint32_t pid; /* pid_t */
237 uint32_t data_size;
5461b305
DG
238 /* Contains: trace_name + data */
239 char payload[];
fc5e05b7 240} LTTNG_PACKED;
fac6795d 241
44a5e5eb
DG
242struct lttcomm_health_msg {
243 uint32_t component;
244 uint32_t cmd;
fc5e05b7 245} LTTNG_PACKED;
44a5e5eb
DG
246
247struct lttcomm_health_data {
248 uint32_t ret_code;
fc5e05b7 249} LTTNG_PACKED;
44a5e5eb 250
6e3805e2 251/*
3bd1e081
MD
252 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
253 * to either add a channel, add a stream, update a stream, or stop
254 * operation.
6e3805e2 255 */
3bd1e081
MD
256struct lttcomm_consumer_msg {
257 uint32_t cmd_type; /* enum consumerd_command */
258 union {
259 struct {
260 int channel_key;
261 uint64_t max_sb_size; /* the subbuffer size for this channel */
262 /* shm_fd and wait_fd are sent as ancillary data */
263 uint64_t mmap_len;
c30aaa51
MD
264 /* nb_init_streams is the number of streams open initially. */
265 unsigned int nb_init_streams;
de5e9086 266 char name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 267 } LTTNG_PACKED channel;
3bd1e081
MD
268 struct {
269 int channel_key;
270 int stream_key;
271 /* shm_fd and wait_fd are sent as ancillary data */
272 uint32_t state; /* enum lttcomm_consumer_fd_state */
273 enum lttng_event_output output; /* use splice or mmap to consume this fd */
274 uint64_t mmap_len;
6df2e2c9
MD
275 uid_t uid; /* User ID owning the session */
276 gid_t gid; /* Group ID owning the session */
3bd1e081 277 char path_name[PATH_MAX];
de5e9086
DG
278 int net_index;
279 unsigned int metadata_flag;
ce2a9e76 280 char name[DEFAULT_STREAM_NAME_LEN]; /* Name string of the stream */
53632229 281 uint64_t session_id; /* Tracing session id of the stream */
fc5e05b7 282 } LTTNG_PACKED stream;
de5e9086
DG
283 struct {
284 int net_index;
285 enum lttng_stream_type type;
286 /* Open socket to the relayd */
287 struct lttcomm_sock sock;
46e6455f
DG
288 /* Tracing session id associated to the relayd. */
289 uint64_t session_id;
fc5e05b7 290 } LTTNG_PACKED relayd_sock;
173af62f
DG
291 struct {
292 uint64_t net_seq_idx;
fc5e05b7 293 } LTTNG_PACKED destroy_relayd;
53632229
DG
294 struct {
295 uint64_t session_id;
fc5e05b7 296 } LTTNG_PACKED data_pending;
3bd1e081 297 } u;
fc5e05b7 298} LTTNG_PACKED;
6e3805e2 299
f50f23d9
DG
300/*
301 * Status message returned to the sessiond after a received command.
302 */
303struct lttcomm_consumer_status_msg {
304 enum lttng_error_code ret_code;
fc5e05b7 305} LTTNG_PACKED;
f50f23d9 306
74d0b642 307#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 308
9df8df5e 309#include <lttng/ust-abi.h>
6e3805e2 310
3817e7df
DG
311/*
312 * Data structure for the commands sent from sessiond to UST.
313 */
314struct lttcomm_ust_msg {
3817e7df
DG
315 uint32_t handle;
316 uint32_t cmd;
317 union {
3817e7df 318 struct lttng_ust_channel channel;
00a17c97 319 struct lttng_ust_stream stream;
3817e7df
DG
320 struct lttng_ust_event event;
321 struct lttng_ust_context context;
00a17c97 322 struct lttng_ust_tracer_version version;
3817e7df 323 } u;
fc5e05b7 324} LTTNG_PACKED;
3817e7df
DG
325
326/*
327 * Data structure for the response from UST to the session daemon.
328 * cmd_type is sent back in the reply for validation.
329 */
330struct lttcomm_ust_reply {
331 uint32_t handle;
332 uint32_t cmd;
333 uint32_t ret_code; /* enum lttcomm_return_code */
334 uint32_t ret_val; /* return value */
335 union {
2b0bf864
DG
336 struct {
337 uint64_t memory_map_size;
fc5e05b7 338 } LTTNG_PACKED channel;
2b0bf864
DG
339 struct {
340 uint64_t memory_map_size;
fc5e05b7 341 } LTTNG_PACKED stream;
00a17c97 342 struct lttng_ust_tracer_version version;
3817e7df 343 } u;
fc5e05b7 344} LTTNG_PACKED;
3817e7df 345
74d0b642 346#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 347
fac6795d
DG
348extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
349
6364a07a
DG
350extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
351 const char *ip, unsigned int port);
352extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
353 const char *ip, unsigned int port);
354
de5e9086
DG
355extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
356extern int lttcomm_create_sock(struct lttcomm_sock *sock);
357extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
358extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
359extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
360extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
361 struct lttcomm_sock *src);
6364a07a 362
773168b7 363#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.057116 seconds and 5 git commands to generate.