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