Fix wrong return value on consumer socket creation
[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 *
990570ed
DG
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; only version 2 of the License.
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
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
fac6795d 14 *
990570ed
DG
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17 * Place - Suite 330, Boston, MA 02111-1307, 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
fac6795d 33/* Queue size of listen(2) */
f158a754 34#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 35
990570ed
DG
36/* Maximum number of FDs that can be sent over a Unix socket */
37#define LTTCOMM_MAX_SEND_FDS 4
38
3817e7df
DG
39/*
40 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 41 */
686204ab 42#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d 43
6abb15de 44enum lttcomm_sessiond_command {
0d0c377a 45 /* Tracer command */
b579acd9 46 LTTNG_ADD_CONTEXT,
f4688807 47 LTTNG_CALIBRATE,
0b97ec54 48 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
49 LTTNG_DISABLE_EVENT,
50 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
51 LTTNG_ENABLE_CHANNEL,
52 LTTNG_ENABLE_EVENT,
53 LTTNG_ENABLE_ALL_EVENT,
54 /* Session daemon command */
fac6795d
DG
55 LTTNG_CREATE_SESSION,
56 LTTNG_DESTROY_SESSION,
9f19cc17
DG
57 LTTNG_LIST_CHANNELS,
58 LTTNG_LIST_DOMAINS,
f3ed775e 59 LTTNG_LIST_EVENTS,
9f19cc17 60 LTTNG_LIST_SESSIONS,
052da939 61 LTTNG_LIST_TRACEPOINTS,
d9800920 62 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
63 LTTNG_START_TRACE,
64 LTTNG_STOP_TRACE,
fac6795d
DG
65};
66
67/*
68 * lttcomm error code.
69 */
70enum lttcomm_return_code {
20fe2104
DG
71 LTTCOMM_OK = 1000, /* Ok */
72 LTTCOMM_ERR, /* Unknown Error */
73 LTTCOMM_UND, /* Undefine command */
7d29a247
DG
74 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
75 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104
DG
76 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
77 LTTCOMM_NO_SESSION, /* No session found */
ae856491 78 LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
20fe2104
DG
79 LTTCOMM_SESSION_FAIL, /* Create session fail */
80 LTTCOMM_START_FAIL, /* Start tracing fail */
81 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
82 LTTCOMM_LIST_FAIL, /* Listing apps fail */
83 LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e 84 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104
DG
85 LTTCOMM_NO_TRACE, /* No trace exist */
86 LTTCOMM_FATAL, /* Session daemon had a fatal error */
87 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
88 LTTCOMM_SELECT_SESS, /* Must select a session */
89 LTTCOMM_EXIST_SESS, /* Session name already exist */
90 LTTCOMM_NO_EVENT, /* No event found */
d9800920 91 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864 92 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
8e0af1b4 93 LTTCOMM_EPERM, /* Permission denied */
20fe2104 94 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
394016d1 95 LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
7d29a247 96 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104
DG
97 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
98 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 99 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 100 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 101 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 102 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
103 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
104 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 105 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
106 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
107 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
108 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
109 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
110 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
111 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
112 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 113 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
4466912f 114 LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
e0c7ec2b 115 LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
0177d773 116 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa 117 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4 118 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864 119 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4
MD
120 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
121 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
122 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
123 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
124 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
125 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
126 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
127 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8
MD
128 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
129 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4
MD
130 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
131 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
132 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
133 LTTCOMM_UST_NO_SESSION, /* No UST session found */
134 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d 135 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921 136 LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384 137 LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
ae856491 138 LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
80e327fa
DG
139 LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */
140 LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */
141 LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */
2bdd86d4 142
3bd1e081
MD
143 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
144 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
145 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720 146 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081
MD
147 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
148 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
149 CONSUMERD_POLL_HUP, /* All fds have hungup */
150 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
151 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
152 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
153 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
154 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
155 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
156 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
b024d072 157 LTTCOMM_INVALID, /* Invalid parameter */
80e327fa 158
20fe2104
DG
159 /* MUST be last element */
160 LTTCOMM_NR, /* Last element */
fac6795d
DG
161};
162
163/*
9bda164d 164 * Data structure received from lttng client to session daemon.
fac6795d
DG
165 */
166struct lttcomm_session_msg {
773168b7 167 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 168 struct lttng_session session;
9f19cc17 169 struct lttng_domain domain;
fac6795d
DG
170 union {
171 struct {
f3ed775e
DG
172 char channel_name[NAME_MAX];
173 char name[NAME_MAX];
174 } disable;
175 /* Event data */
fac6795d 176 struct {
f3ed775e
DG
177 char channel_name[NAME_MAX];
178 struct lttng_event event;
179 } enable;
180 /* Create channel */
181 struct {
182 struct lttng_channel chan;
183 } channel;
d65106b1
DG
184 /* Context */
185 struct {
186 char channel_name[NAME_MAX];
187 char event_name[NAME_MAX];
7d29a247 188 struct lttng_event_context ctx;
d65106b1 189 } context;
d9800920
DG
190 /* Use by register_consumer */
191 struct {
192 char path[PATH_MAX];
193 } reg;
9f19cc17
DG
194 /* List */
195 struct {
196 char channel_name[NAME_MAX];
197 } list;
d0254c7c 198 struct lttng_calibrate calibrate;
fac6795d
DG
199 } u;
200};
201
202/*
5e16da05 203 * Data structure for the response from sessiond to the lttng client.
fac6795d 204 */
5461b305 205struct lttcomm_lttng_msg {
773168b7
MD
206 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
207 uint32_t ret_code; /* enum lttcomm_return_code */
208 uint32_t pid; /* pid_t */
209 uint32_t data_size;
5461b305
DG
210 /* Contains: trace_name + data */
211 char payload[];
fac6795d
DG
212};
213
6e3805e2 214/*
3bd1e081
MD
215 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
216 * to either add a channel, add a stream, update a stream, or stop
217 * operation.
6e3805e2 218 */
3bd1e081
MD
219struct lttcomm_consumer_msg {
220 uint32_t cmd_type; /* enum consumerd_command */
221 union {
222 struct {
223 int channel_key;
224 uint64_t max_sb_size; /* the subbuffer size for this channel */
225 /* shm_fd and wait_fd are sent as ancillary data */
226 uint64_t mmap_len;
227 } channel;
228 struct {
229 int channel_key;
230 int stream_key;
231 /* shm_fd and wait_fd are sent as ancillary data */
232 uint32_t state; /* enum lttcomm_consumer_fd_state */
233 enum lttng_event_output output; /* use splice or mmap to consume this fd */
234 uint64_t mmap_len;
6df2e2c9
MD
235 uid_t uid; /* User ID owning the session */
236 gid_t gid; /* Group ID owning the session */
3bd1e081
MD
237 char path_name[PATH_MAX];
238 } stream;
239 } u;
6e3805e2
DG
240};
241
74d0b642 242#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 243
9df8df5e 244#include <lttng/ust-abi.h>
6e3805e2 245
3817e7df
DG
246/*
247 * Data structure for the commands sent from sessiond to UST.
248 */
249struct lttcomm_ust_msg {
3817e7df
DG
250 uint32_t handle;
251 uint32_t cmd;
252 union {
3817e7df 253 struct lttng_ust_channel channel;
00a17c97 254 struct lttng_ust_stream stream;
3817e7df
DG
255 struct lttng_ust_event event;
256 struct lttng_ust_context context;
00a17c97 257 struct lttng_ust_tracer_version version;
3817e7df
DG
258 } u;
259};
260
261/*
262 * Data structure for the response from UST to the session daemon.
263 * cmd_type is sent back in the reply for validation.
264 */
265struct lttcomm_ust_reply {
266 uint32_t handle;
267 uint32_t cmd;
268 uint32_t ret_code; /* enum lttcomm_return_code */
269 uint32_t ret_val; /* return value */
270 union {
2b0bf864
DG
271 struct {
272 uint64_t memory_map_size;
273 } channel;
274 struct {
275 uint64_t memory_map_size;
276 } stream;
00a17c97 277 struct lttng_ust_tracer_version version;
3817e7df
DG
278 } u;
279};
280
74d0b642 281#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 282
fac6795d
DG
283extern int lttcomm_create_unix_sock(const char *pathname);
284extern int lttcomm_connect_unix_sock(const char *pathname);
285extern int lttcomm_accept_unix_sock(int sock);
286extern int lttcomm_listen_unix_sock(int sock);
87378cf5 287extern int lttcomm_close_unix_sock(int sock);
3bd1e081 288
3bd1e081
MD
289/* Send a message accompanied by fd(s) over a unix socket. */
290extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
291/* Recv a message accompanied by fd(s) from a unix socket */
292extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
293
fac6795d
DG
294extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
295extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
d19d9ada
DG
296
297extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
298extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
b17231c6 299 lttng_sock_cred *creds);
d19d9ada 300
fac6795d 301extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
d19d9ada 302extern int lttcomm_setsockopt_creds_unix_sock(int sock);
fac6795d 303
773168b7 304#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.066928 seconds and 4 git commands to generate.