Split and remove lttng-share header file
[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>
d19d9ada 31#include <sys/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 */
78 LTTCOMM_CREATE_FAIL, /* Create trace fail */
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 */
7d29a247 95 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104
DG
96 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
97 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 98 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 99 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 100 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 101 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
102 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
103 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 104 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
105 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
106 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
107 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
108 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
109 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
110 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
111 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 112 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
0177d773 113 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa 114 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4 115 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864 116 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4
MD
117 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
118 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
119 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
120 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
121 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
122 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
123 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
124 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8
MD
125 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
126 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4
MD
127 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
128 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
129 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
130 LTTCOMM_UST_NO_SESSION, /* No UST session found */
131 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d 132 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921 133 LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384 134 LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
2bdd86d4 135
3bd1e081
MD
136 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
137 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
138 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720 139 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081
MD
140 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
141 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
142 CONSUMERD_POLL_HUP, /* All fds have hungup */
143 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
144 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
145 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
146 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
147 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
148 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
149 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104
DG
150 /* MUST be last element */
151 LTTCOMM_NR, /* Last element */
fac6795d
DG
152};
153
154/*
9bda164d 155 * Data structure received from lttng client to session daemon.
fac6795d
DG
156 */
157struct lttcomm_session_msg {
773168b7 158 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 159 struct lttng_session session;
9f19cc17 160 struct lttng_domain domain;
fac6795d
DG
161 union {
162 struct {
f3ed775e
DG
163 char channel_name[NAME_MAX];
164 char name[NAME_MAX];
165 } disable;
166 /* Event data */
fac6795d 167 struct {
f3ed775e
DG
168 char channel_name[NAME_MAX];
169 struct lttng_event event;
170 } enable;
171 /* Create channel */
172 struct {
173 struct lttng_channel chan;
174 } channel;
d65106b1
DG
175 /* Context */
176 struct {
177 char channel_name[NAME_MAX];
178 char event_name[NAME_MAX];
7d29a247 179 struct lttng_event_context ctx;
d65106b1 180 } context;
d9800920
DG
181 /* Use by register_consumer */
182 struct {
183 char path[PATH_MAX];
184 } reg;
9f19cc17
DG
185 /* List */
186 struct {
187 char channel_name[NAME_MAX];
188 } list;
d0254c7c 189 struct lttng_calibrate calibrate;
fac6795d
DG
190 } u;
191};
192
193/*
5e16da05 194 * Data structure for the response from sessiond to the lttng client.
fac6795d 195 */
5461b305 196struct lttcomm_lttng_msg {
773168b7
MD
197 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
198 uint32_t ret_code; /* enum lttcomm_return_code */
199 uint32_t pid; /* pid_t */
200 uint32_t data_size;
5461b305
DG
201 /* Contains: trace_name + data */
202 char payload[];
fac6795d
DG
203};
204
6e3805e2 205/*
3bd1e081
MD
206 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
207 * to either add a channel, add a stream, update a stream, or stop
208 * operation.
6e3805e2 209 */
3bd1e081
MD
210struct lttcomm_consumer_msg {
211 uint32_t cmd_type; /* enum consumerd_command */
212 union {
213 struct {
214 int channel_key;
215 uint64_t max_sb_size; /* the subbuffer size for this channel */
216 /* shm_fd and wait_fd are sent as ancillary data */
217 uint64_t mmap_len;
218 } channel;
219 struct {
220 int channel_key;
221 int stream_key;
222 /* shm_fd and wait_fd are sent as ancillary data */
223 uint32_t state; /* enum lttcomm_consumer_fd_state */
224 enum lttng_event_output output; /* use splice or mmap to consume this fd */
225 uint64_t mmap_len;
6df2e2c9
MD
226 uid_t uid; /* User ID owning the session */
227 gid_t gid; /* Group ID owning the session */
3bd1e081
MD
228 char path_name[PATH_MAX];
229 } stream;
230 } u;
6e3805e2
DG
231};
232
74d0b642 233#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 234
9df8df5e 235#include <lttng/ust-abi.h>
6e3805e2 236
3817e7df
DG
237/*
238 * Data structure for the commands sent from sessiond to UST.
239 */
240struct lttcomm_ust_msg {
3817e7df
DG
241 uint32_t handle;
242 uint32_t cmd;
243 union {
3817e7df 244 struct lttng_ust_channel channel;
00a17c97 245 struct lttng_ust_stream stream;
3817e7df
DG
246 struct lttng_ust_event event;
247 struct lttng_ust_context context;
00a17c97 248 struct lttng_ust_tracer_version version;
3817e7df
DG
249 } u;
250};
251
252/*
253 * Data structure for the response from UST to the session daemon.
254 * cmd_type is sent back in the reply for validation.
255 */
256struct lttcomm_ust_reply {
257 uint32_t handle;
258 uint32_t cmd;
259 uint32_t ret_code; /* enum lttcomm_return_code */
260 uint32_t ret_val; /* return value */
261 union {
2b0bf864
DG
262 struct {
263 uint64_t memory_map_size;
264 } channel;
265 struct {
266 uint64_t memory_map_size;
267 } stream;
00a17c97 268 struct lttng_ust_tracer_version version;
3817e7df
DG
269 } u;
270};
271
74d0b642 272#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 273
fac6795d
DG
274extern int lttcomm_create_unix_sock(const char *pathname);
275extern int lttcomm_connect_unix_sock(const char *pathname);
276extern int lttcomm_accept_unix_sock(int sock);
277extern int lttcomm_listen_unix_sock(int sock);
87378cf5 278extern int lttcomm_close_unix_sock(int sock);
3bd1e081 279
3bd1e081
MD
280/* Send a message accompanied by fd(s) over a unix socket. */
281extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
282/* Recv a message accompanied by fd(s) from a unix socket */
283extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
284
fac6795d
DG
285extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
286extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
d19d9ada
DG
287
288extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
289extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
290 struct ucred *creds);
291
fac6795d 292extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
d19d9ada 293extern int lttcomm_setsockopt_creds_unix_sock(int sock);
fac6795d 294
773168b7 295#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.041069 seconds and 4 git commands to generate.