Add lttng-error.h containing every API err. code
[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 */
f73fabfd 51#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
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 {
f73fabfd
DG
96 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
97 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
98 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
99 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
100 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
101 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
102 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
103 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
104 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
105 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
106 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
107 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
108 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
109 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
80e327fa 110
20fe2104
DG
111 /* MUST be last element */
112 LTTCOMM_NR, /* Last element */
fac6795d
DG
113};
114
de5e9086
DG
115/* lttng socket protocol. */
116enum lttcomm_sock_proto {
117 LTTCOMM_SOCK_UDP,
118 LTTCOMM_SOCK_TCP,
119};
120
121/*
122 * Index in the net_families array below. Please keep in sync!
123 */
124enum lttcomm_sock_domain {
01d0a631
CB
125 LTTCOMM_INET = 0,
126 LTTCOMM_INET6 = 1,
de5e9086
DG
127};
128
129struct lttcomm_sockaddr {
130 enum lttcomm_sock_domain type;
131 union {
132 struct sockaddr_in sin;
133 struct sockaddr_in6 sin6;
134 } addr;
135};
136
137struct lttcomm_sock {
138 int fd;
139 enum lttcomm_sock_proto proto;
140 struct lttcomm_sockaddr sockaddr;
141 const struct lttcomm_proto_ops *ops;
142};
143
144struct lttcomm_net_family {
145 int family;
146 int (*create) (struct lttcomm_sock *sock, int type, int proto);
147};
148
149struct lttcomm_proto_ops {
150 int (*bind) (struct lttcomm_sock *sock);
151 int (*close) (struct lttcomm_sock *sock);
152 int (*connect) (struct lttcomm_sock *sock);
153 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
154 int (*listen) (struct lttcomm_sock *sock, int backlog);
155 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
156 int flags);
157 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
158 int flags);
159};
160
fac6795d 161/*
9bda164d 162 * Data structure received from lttng client to session daemon.
fac6795d
DG
163 */
164struct lttcomm_session_msg {
773168b7 165 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 166 struct lttng_session session;
9f19cc17 167 struct lttng_domain domain;
fac6795d
DG
168 union {
169 struct {
f3ed775e
DG
170 char channel_name[NAME_MAX];
171 char name[NAME_MAX];
172 } disable;
173 /* Event data */
fac6795d 174 struct {
f3ed775e
DG
175 char channel_name[NAME_MAX];
176 struct lttng_event event;
177 } enable;
178 /* Create channel */
179 struct {
180 struct lttng_channel chan;
181 } channel;
d65106b1
DG
182 /* Context */
183 struct {
184 char channel_name[NAME_MAX];
185 char event_name[NAME_MAX];
7d29a247 186 struct lttng_event_context ctx;
d65106b1 187 } context;
d9800920
DG
188 /* Use by register_consumer */
189 struct {
190 char path[PATH_MAX];
191 } reg;
9f19cc17
DG
192 /* List */
193 struct {
194 char channel_name[NAME_MAX];
195 } list;
d0254c7c 196 struct lttng_calibrate calibrate;
a4b92340 197 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 198 struct {
a4b92340
DG
199 /* Number of lttng_uri following */
200 uint32_t size;
201 } uri;
53a80697
MD
202 struct {
203 char channel_name[NAME_MAX];
204 char event_name[NAME_MAX];
205 /* Length of following bytecode */
206 uint32_t bytecode_len;
207 } filter;
fac6795d
DG
208 } u;
209};
210
53a80697
MD
211#define LTTNG_FILTER_MAX_LEN 65336
212
213/*
214 * Filter bytecode data. The reloc table is located at the end of the
215 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
216 * starts at reloc_table_offset.
217 */
218struct lttng_filter_bytecode {
219 uint16_t len; /* len of data */
220 uint16_t reloc_table_offset;
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;
de5e9086 258 char name[LTTNG_SYMBOL_NAME_LEN];
3bd1e081
MD
259 } channel;
260 struct {
261 int channel_key;
262 int stream_key;
263 /* shm_fd and wait_fd are sent as ancillary data */
264 uint32_t state; /* enum lttcomm_consumer_fd_state */
265 enum lttng_event_output output; /* use splice or mmap to consume this fd */
266 uint64_t mmap_len;
6df2e2c9
MD
267 uid_t uid; /* User ID owning the session */
268 gid_t gid; /* Group ID owning the session */
3bd1e081 269 char path_name[PATH_MAX];
de5e9086
DG
270 int net_index;
271 unsigned int metadata_flag;
272 char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */
3bd1e081 273 } stream;
de5e9086
DG
274 struct {
275 int net_index;
276 enum lttng_stream_type type;
277 /* Open socket to the relayd */
278 struct lttcomm_sock sock;
279 } relayd_sock;
173af62f
DG
280 struct {
281 uint64_t net_seq_idx;
282 } destroy_relayd;
3bd1e081 283 } u;
6e3805e2
DG
284};
285
74d0b642 286#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 287
9df8df5e 288#include <lttng/ust-abi.h>
6e3805e2 289
3817e7df
DG
290/*
291 * Data structure for the commands sent from sessiond to UST.
292 */
293struct lttcomm_ust_msg {
3817e7df
DG
294 uint32_t handle;
295 uint32_t cmd;
296 union {
3817e7df 297 struct lttng_ust_channel channel;
00a17c97 298 struct lttng_ust_stream stream;
3817e7df
DG
299 struct lttng_ust_event event;
300 struct lttng_ust_context context;
00a17c97 301 struct lttng_ust_tracer_version version;
3817e7df
DG
302 } u;
303};
304
305/*
306 * Data structure for the response from UST to the session daemon.
307 * cmd_type is sent back in the reply for validation.
308 */
309struct lttcomm_ust_reply {
310 uint32_t handle;
311 uint32_t cmd;
312 uint32_t ret_code; /* enum lttcomm_return_code */
313 uint32_t ret_val; /* return value */
314 union {
2b0bf864
DG
315 struct {
316 uint64_t memory_map_size;
317 } channel;
318 struct {
319 uint64_t memory_map_size;
320 } stream;
00a17c97 321 struct lttng_ust_tracer_version version;
3817e7df
DG
322 } u;
323};
324
74d0b642 325#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 326
fac6795d
DG
327extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
328
6364a07a
DG
329extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
330 const char *ip, unsigned int port);
331extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
332 const char *ip, unsigned int port);
333
de5e9086
DG
334extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
335extern int lttcomm_create_sock(struct lttcomm_sock *sock);
336extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
337extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
338extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
339extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
340 struct lttcomm_sock *src);
6364a07a 341
773168b7 342#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.072199 seconds and 4 git commands to generate.