Fix: missing hostname context
[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>
5e16da05 33
6364a07a
DG
34#include <arpa/inet.h>
35#include <netinet/in.h>
36#include <sys/un.h>
37
38#include "inet.h"
39#include "inet6.h"
0d37f2bc
DG
40#include "unix.h"
41
fac6795d 42/* Queue size of listen(2) */
f158a754 43#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 44
990570ed
DG
45/* Maximum number of FDs that can be sent over a Unix socket */
46#define LTTCOMM_MAX_SEND_FDS 4
47
3817e7df
DG
48/*
49 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 50 */
686204ab 51#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d 52
6abb15de 53enum lttcomm_sessiond_command {
0d0c377a 54 /* Tracer command */
b579acd9 55 LTTNG_ADD_CONTEXT,
f4688807 56 LTTNG_CALIBRATE,
0b97ec54 57 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
58 LTTNG_DISABLE_EVENT,
59 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
60 LTTNG_ENABLE_CHANNEL,
61 LTTNG_ENABLE_EVENT,
62 LTTNG_ENABLE_ALL_EVENT,
63 /* Session daemon command */
fac6795d
DG
64 LTTNG_CREATE_SESSION,
65 LTTNG_DESTROY_SESSION,
9f19cc17
DG
66 LTTNG_LIST_CHANNELS,
67 LTTNG_LIST_DOMAINS,
f3ed775e 68 LTTNG_LIST_EVENTS,
9f19cc17 69 LTTNG_LIST_SESSIONS,
052da939 70 LTTNG_LIST_TRACEPOINTS,
d9800920 71 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
72 LTTNG_START_TRACE,
73 LTTNG_STOP_TRACE,
f37d259d 74 LTTNG_LIST_TRACEPOINT_FIELDS,
53a80697 75
de5e9086
DG
76 /* Consumer */
77 LTTNG_DISABLE_CONSUMER,
78 LTTNG_ENABLE_CONSUMER,
79 LTTNG_SET_CONSUMER_URI,
80 /* Relay daemon */
81 RELAYD_ADD_STREAM,
82 RELAYD_CREATE_SESSION,
83 RELAYD_START_DATA,
84 RELAYD_UPDATE_SYNC_INFO,
85 RELAYD_VERSION,
86 RELAYD_SEND_METADATA,
173af62f 87 RELAYD_CLOSE_STREAM,
53a80697 88 LTTNG_SET_FILTER,
44a5e5eb 89 LTTNG_HEALTH_CHECK,
fac6795d
DG
90};
91
92/*
93 * lttcomm error code.
94 */
95enum lttcomm_return_code {
42224349 96 LTTCOMM_OK = 10, /* Ok */
20fe2104
DG
97 LTTCOMM_ERR, /* Unknown Error */
98 LTTCOMM_UND, /* Undefine command */
7d29a247
DG
99 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
100 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104
DG
101 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
102 LTTCOMM_NO_SESSION, /* No session found */
ae856491 103 LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
20fe2104
DG
104 LTTCOMM_SESSION_FAIL, /* Create session fail */
105 LTTCOMM_START_FAIL, /* Start tracing fail */
106 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
107 LTTCOMM_LIST_FAIL, /* Listing apps fail */
108 LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e 109 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104
DG
110 LTTCOMM_NO_TRACE, /* No trace exist */
111 LTTCOMM_FATAL, /* Session daemon had a fatal error */
112 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
113 LTTCOMM_SELECT_SESS, /* Must select a session */
114 LTTCOMM_EXIST_SESS, /* Session name already exist */
115 LTTCOMM_NO_EVENT, /* No event found */
d9800920 116 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864 117 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
8e0af1b4 118 LTTCOMM_EPERM, /* Permission denied */
20fe2104 119 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
394016d1 120 LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
7d29a247 121 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104 122 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
42224349 123 LTTCOMM_KERN_CHAN_EXIST, /* Kernel channel already exists */
20fe2104 124 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 125 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 126 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 127 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 128 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
129 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
130 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 131 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
132 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
133 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
134 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
135 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
136 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
137 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
138 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 139 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
4466912f 140 LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
e0c7ec2b 141 LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
0177d773 142 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa 143 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4 144 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864 145 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4
MD
146 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
147 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
148 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
149 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
150 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
151 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
152 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
153 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8
MD
154 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
155 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4
MD
156 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
157 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
158 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
159 LTTCOMM_UST_NO_SESSION, /* No UST session found */
160 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d 161 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921 162 LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384 163 LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
ae856491 164 LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
80e327fa
DG
165 LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */
166 LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */
167 LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */
bd29c13d 168 LTTCOMM_KERN_EVENT_ENOSYS, /* Kernel event type not supported */
2bdd86d4 169
3bd1e081
MD
170 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
171 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
172 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720 173 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081
MD
174 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
175 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
176 CONSUMERD_POLL_HUP, /* All fds have hungup */
177 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
178 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
179 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
180 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
181 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
182 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
183 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
b024d072 184 LTTCOMM_INVALID, /* Invalid parameter */
5c827ce0
DG
185 LTTCOMM_NO_USTCONSUMERD, /* No UST consumer detected */
186 LTTCOMM_NO_KERNCONSUMERD, /* No Kernel consumer detected */
a027b2d2 187 LTTCOMM_EVENT_EXIST_LOGLEVEL, /* Event already enabled with different loglevel */
a4b92340
DG
188 LTTCOMM_URL_DATA_MISS, /* Missing network data URL */
189 LTTCOMM_URL_CTRL_MISS, /* Missing network control URL */
de5e9086
DG
190 LTTCOMM_ENABLE_CONSUMER_FAIL, /* Enabling consumer failed */
191 LTTCOMM_RELAYD_SESSION_FAIL, /* lttng-relayd create session failed */
192 LTTCOMM_RELAYD_VERSION_FAIL, /* lttng-relayd not compatible */
53a80697
MD
193 LTTCOMM_FILTER_INVAL, /* Invalid filter bytecode */
194 LTTCOMM_FILTER_NOMEM, /* Lack of memory for filter bytecode */
195 LTTCOMM_FILTER_EXIST, /* Filter already exist */
a4b92340 196 LTTCOMM_NO_CONSUMER, /* No consumer exist for the tracing session */
80e327fa 197
20fe2104
DG
198 /* MUST be last element */
199 LTTCOMM_NR, /* Last element */
fac6795d
DG
200};
201
de5e9086
DG
202/* lttng socket protocol. */
203enum lttcomm_sock_proto {
204 LTTCOMM_SOCK_UDP,
205 LTTCOMM_SOCK_TCP,
206};
207
208/*
209 * Index in the net_families array below. Please keep in sync!
210 */
211enum lttcomm_sock_domain {
01d0a631
CB
212 LTTCOMM_INET = 0,
213 LTTCOMM_INET6 = 1,
de5e9086
DG
214};
215
216struct lttcomm_sockaddr {
217 enum lttcomm_sock_domain type;
218 union {
219 struct sockaddr_in sin;
220 struct sockaddr_in6 sin6;
221 } addr;
222};
223
224struct lttcomm_sock {
225 int fd;
226 enum lttcomm_sock_proto proto;
227 struct lttcomm_sockaddr sockaddr;
228 const struct lttcomm_proto_ops *ops;
229};
230
231struct lttcomm_net_family {
232 int family;
233 int (*create) (struct lttcomm_sock *sock, int type, int proto);
234};
235
236struct lttcomm_proto_ops {
237 int (*bind) (struct lttcomm_sock *sock);
238 int (*close) (struct lttcomm_sock *sock);
239 int (*connect) (struct lttcomm_sock *sock);
240 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
241 int (*listen) (struct lttcomm_sock *sock, int backlog);
242 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
243 int flags);
244 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
245 int flags);
246};
247
fac6795d 248/*
9bda164d 249 * Data structure received from lttng client to session daemon.
fac6795d
DG
250 */
251struct lttcomm_session_msg {
773168b7 252 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 253 struct lttng_session session;
9f19cc17 254 struct lttng_domain domain;
fac6795d
DG
255 union {
256 struct {
f3ed775e
DG
257 char channel_name[NAME_MAX];
258 char name[NAME_MAX];
259 } disable;
260 /* Event data */
fac6795d 261 struct {
f3ed775e
DG
262 char channel_name[NAME_MAX];
263 struct lttng_event event;
264 } enable;
265 /* Create channel */
266 struct {
267 struct lttng_channel chan;
268 } channel;
d65106b1
DG
269 /* Context */
270 struct {
271 char channel_name[NAME_MAX];
272 char event_name[NAME_MAX];
7d29a247 273 struct lttng_event_context ctx;
d65106b1 274 } context;
d9800920
DG
275 /* Use by register_consumer */
276 struct {
277 char path[PATH_MAX];
278 } reg;
9f19cc17
DG
279 /* List */
280 struct {
281 char channel_name[NAME_MAX];
282 } list;
d0254c7c 283 struct lttng_calibrate calibrate;
a4b92340 284 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 285 struct {
a4b92340
DG
286 /* Number of lttng_uri following */
287 uint32_t size;
288 } uri;
53a80697
MD
289 struct {
290 char channel_name[NAME_MAX];
291 char event_name[NAME_MAX];
292 /* Length of following bytecode */
293 uint32_t bytecode_len;
294 } filter;
fac6795d
DG
295 } u;
296};
297
53a80697
MD
298#define LTTNG_FILTER_MAX_LEN 65336
299
300/*
301 * Filter bytecode data. The reloc table is located at the end of the
302 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
303 * starts at reloc_table_offset.
304 */
305struct lttng_filter_bytecode {
306 uint16_t len; /* len of data */
307 uint16_t reloc_table_offset;
308 char data[0];
309};
310
fac6795d 311/*
5e16da05 312 * Data structure for the response from sessiond to the lttng client.
fac6795d 313 */
5461b305 314struct lttcomm_lttng_msg {
773168b7
MD
315 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
316 uint32_t ret_code; /* enum lttcomm_return_code */
317 uint32_t pid; /* pid_t */
318 uint32_t data_size;
5461b305
DG
319 /* Contains: trace_name + data */
320 char payload[];
fac6795d
DG
321};
322
44a5e5eb
DG
323struct lttcomm_health_msg {
324 uint32_t component;
325 uint32_t cmd;
326};
327
328struct lttcomm_health_data {
329 uint32_t ret_code;
330};
331
6e3805e2 332/*
3bd1e081
MD
333 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
334 * to either add a channel, add a stream, update a stream, or stop
335 * operation.
6e3805e2 336 */
3bd1e081
MD
337struct lttcomm_consumer_msg {
338 uint32_t cmd_type; /* enum consumerd_command */
339 union {
340 struct {
341 int channel_key;
342 uint64_t max_sb_size; /* the subbuffer size for this channel */
343 /* shm_fd and wait_fd are sent as ancillary data */
344 uint64_t mmap_len;
de5e9086 345 char name[LTTNG_SYMBOL_NAME_LEN];
3bd1e081
MD
346 } channel;
347 struct {
348 int channel_key;
349 int stream_key;
350 /* shm_fd and wait_fd are sent as ancillary data */
351 uint32_t state; /* enum lttcomm_consumer_fd_state */
352 enum lttng_event_output output; /* use splice or mmap to consume this fd */
353 uint64_t mmap_len;
6df2e2c9
MD
354 uid_t uid; /* User ID owning the session */
355 gid_t gid; /* Group ID owning the session */
3bd1e081 356 char path_name[PATH_MAX];
de5e9086
DG
357 int net_index;
358 unsigned int metadata_flag;
359 char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */
3bd1e081 360 } stream;
de5e9086
DG
361 struct {
362 int net_index;
363 enum lttng_stream_type type;
364 /* Open socket to the relayd */
365 struct lttcomm_sock sock;
366 } relayd_sock;
173af62f
DG
367 struct {
368 uint64_t net_seq_idx;
369 } destroy_relayd;
3bd1e081 370 } u;
6e3805e2
DG
371};
372
74d0b642 373#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 374
9df8df5e 375#include <lttng/ust-abi.h>
6e3805e2 376
3817e7df
DG
377/*
378 * Data structure for the commands sent from sessiond to UST.
379 */
380struct lttcomm_ust_msg {
3817e7df
DG
381 uint32_t handle;
382 uint32_t cmd;
383 union {
3817e7df 384 struct lttng_ust_channel channel;
00a17c97 385 struct lttng_ust_stream stream;
3817e7df
DG
386 struct lttng_ust_event event;
387 struct lttng_ust_context context;
00a17c97 388 struct lttng_ust_tracer_version version;
3817e7df
DG
389 } u;
390};
391
392/*
393 * Data structure for the response from UST to the session daemon.
394 * cmd_type is sent back in the reply for validation.
395 */
396struct lttcomm_ust_reply {
397 uint32_t handle;
398 uint32_t cmd;
399 uint32_t ret_code; /* enum lttcomm_return_code */
400 uint32_t ret_val; /* return value */
401 union {
2b0bf864
DG
402 struct {
403 uint64_t memory_map_size;
404 } channel;
405 struct {
406 uint64_t memory_map_size;
407 } stream;
00a17c97 408 struct lttng_ust_tracer_version version;
3817e7df
DG
409 } u;
410};
411
74d0b642 412#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 413
fac6795d
DG
414extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
415
6364a07a
DG
416extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
417 const char *ip, unsigned int port);
418extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
419 const char *ip, unsigned int port);
420
de5e9086
DG
421extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
422extern int lttcomm_create_sock(struct lttcomm_sock *sock);
423extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
424extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
425extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
426extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
427 struct lttcomm_sock *src);
6364a07a 428
773168b7 429#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.079813 seconds and 4 git commands to generate.