UST 2.0 support
[lttng-tools.git] / include / lttng-sessiond-comm.h
CommitLineData
773168b7
MD
1#ifndef _LTTNG_SESSIOND_COMM_H
2#define _LTTNG_SESSIOND_COMM_H
3
6e3805e2
DG
4/*
5 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
6 * Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7 7 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d
DG
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
82a3637f
DG
11 * as published by the Free Software Foundation; only version 2
12 * of the License.
fac6795d
DG
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
fac6795d
DG
22 */
23
773168b7
MD
24/*
25 * This header is meant for liblttng and libust internal use ONLY.
26 * These declarations should NOT be considered stable API.
27 */
fac6795d
DG
28
29#include <limits.h>
f3ed775e 30#include <lttng/lttng.h>
5e16da05 31
f4688807 32#define LTTNG_RUNDIR "/var/run/lttng"
1526bda7 33
fac6795d 34/* Default unix socket path */
f4688807
DG
35#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
36#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
37#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
38#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
fac6795d
DG
39
40/* Queue size of listen(2) */
b959688f 41#define MAX_LISTEN 64
fac6795d 42
3817e7df
DG
43/*
44 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 45 */
686204ab 46#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d 47
6abb15de 48enum lttcomm_sessiond_command {
0d0c377a 49 /* Tracer command */
b579acd9 50 LTTNG_ADD_CONTEXT,
f4688807 51 LTTNG_CALIBRATE,
0b97ec54 52 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
53 LTTNG_DISABLE_EVENT,
54 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
55 LTTNG_ENABLE_CHANNEL,
56 LTTNG_ENABLE_EVENT,
57 LTTNG_ENABLE_ALL_EVENT,
58 /* Session daemon command */
fac6795d
DG
59 LTTNG_CREATE_SESSION,
60 LTTNG_DESTROY_SESSION,
9f19cc17
DG
61 LTTNG_LIST_CHANNELS,
62 LTTNG_LIST_DOMAINS,
f3ed775e 63 LTTNG_LIST_EVENTS,
9f19cc17 64 LTTNG_LIST_SESSIONS,
052da939 65 LTTNG_LIST_TRACEPOINTS,
d9800920 66 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
67 LTTNG_START_TRACE,
68 LTTNG_STOP_TRACE,
fac6795d
DG
69};
70
71/*
72 * lttcomm error code.
73 */
74enum lttcomm_return_code {
20fe2104
DG
75 LTTCOMM_OK = 1000, /* Ok */
76 LTTCOMM_ERR, /* Unknown Error */
77 LTTCOMM_UND, /* Undefine command */
7d29a247
DG
78 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
79 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104
DG
80 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
81 LTTCOMM_NO_SESSION, /* No session found */
82 LTTCOMM_CREATE_FAIL, /* Create trace fail */
83 LTTCOMM_SESSION_FAIL, /* Create session fail */
84 LTTCOMM_START_FAIL, /* Start tracing fail */
85 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
86 LTTCOMM_LIST_FAIL, /* Listing apps fail */
87 LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e 88 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104
DG
89 LTTCOMM_NO_TRACE, /* No trace exist */
90 LTTCOMM_FATAL, /* Session daemon had a fatal error */
91 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
92 LTTCOMM_SELECT_SESS, /* Must select a session */
93 LTTCOMM_EXIST_SESS, /* Session name already exist */
94 LTTCOMM_NO_EVENT, /* No event found */
d9800920 95 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864 96 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
20fe2104 97 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
7d29a247 98 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104
DG
99 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
100 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 101 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 102 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 103 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 104 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
105 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
106 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 107 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
108 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
109 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
110 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
111 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
112 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
113 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
114 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 115 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
0177d773 116 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
2b0bf864
DG
117 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
118 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
3bd1e081
MD
119 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
120 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
121 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
122 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
123 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
124 CONSUMERD_POLL_HUP, /* All fds have hungup */
125 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
126 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
127 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
128 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
129 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
130 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
131 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104
DG
132 /* MUST be last element */
133 LTTCOMM_NR, /* Last element */
fac6795d
DG
134};
135
136/*
9bda164d 137 * Data structure received from lttng client to session daemon.
fac6795d
DG
138 */
139struct lttcomm_session_msg {
773168b7 140 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 141 struct lttng_session session;
9f19cc17 142 struct lttng_domain domain;
fac6795d
DG
143 union {
144 struct {
f3ed775e
DG
145 char channel_name[NAME_MAX];
146 char name[NAME_MAX];
147 } disable;
148 /* Event data */
fac6795d 149 struct {
f3ed775e
DG
150 char channel_name[NAME_MAX];
151 struct lttng_event event;
152 } enable;
153 /* Create channel */
154 struct {
155 struct lttng_channel chan;
156 } channel;
d65106b1
DG
157 /* Context */
158 struct {
159 char channel_name[NAME_MAX];
160 char event_name[NAME_MAX];
7d29a247 161 struct lttng_event_context ctx;
d65106b1 162 } context;
d9800920
DG
163 /* Use by register_consumer */
164 struct {
165 char path[PATH_MAX];
166 } reg;
9f19cc17
DG
167 /* List */
168 struct {
169 char channel_name[NAME_MAX];
170 } list;
d0254c7c 171 struct lttng_calibrate calibrate;
fac6795d
DG
172 } u;
173};
174
175/*
5e16da05 176 * Data structure for the response from sessiond to the lttng client.
fac6795d 177 */
5461b305 178struct lttcomm_lttng_msg {
773168b7
MD
179 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
180 uint32_t ret_code; /* enum lttcomm_return_code */
181 uint32_t pid; /* pid_t */
182 uint32_t data_size;
5461b305
DG
183 /* Contains: trace_name + data */
184 char payload[];
fac6795d
DG
185};
186
6e3805e2 187/*
3bd1e081
MD
188 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
189 * to either add a channel, add a stream, update a stream, or stop
190 * operation.
6e3805e2 191 */
3bd1e081
MD
192struct lttcomm_consumer_msg {
193 uint32_t cmd_type; /* enum consumerd_command */
194 union {
195 struct {
196 int channel_key;
197 uint64_t max_sb_size; /* the subbuffer size for this channel */
198 /* shm_fd and wait_fd are sent as ancillary data */
199 uint64_t mmap_len;
200 } channel;
201 struct {
202 int channel_key;
203 int stream_key;
204 /* shm_fd and wait_fd are sent as ancillary data */
205 uint32_t state; /* enum lttcomm_consumer_fd_state */
206 enum lttng_event_output output; /* use splice or mmap to consume this fd */
207 uint64_t mmap_len;
208 char path_name[PATH_MAX];
209 } stream;
210 } u;
6e3805e2
DG
211};
212
3bd1e081
MD
213#ifdef CONFIG_LTTNG_TOOLS_HAVE_UST
214
215#include <ust/lttng-ust-abi.h>
6e3805e2 216
3817e7df
DG
217/*
218 * Data structure for the commands sent from sessiond to UST.
219 */
220struct lttcomm_ust_msg {
3817e7df
DG
221 uint32_t handle;
222 uint32_t cmd;
223 union {
224 struct lttng_ust_tracer_version version;
225 struct lttng_ust_channel channel;
226 struct lttng_ust_event event;
227 struct lttng_ust_context context;
228 } u;
229};
230
231/*
232 * Data structure for the response from UST to the session daemon.
233 * cmd_type is sent back in the reply for validation.
234 */
235struct lttcomm_ust_reply {
236 uint32_t handle;
237 uint32_t cmd;
238 uint32_t ret_code; /* enum lttcomm_return_code */
239 uint32_t ret_val; /* return value */
240 union {
2b0bf864
DG
241 struct {
242 uint64_t memory_map_size;
243 } channel;
244 struct {
245 uint64_t memory_map_size;
246 } stream;
3817e7df
DG
247 } u;
248};
249
3bd1e081
MD
250#endif /* CONFIG_LTTNG_TOOLS_HAVE_UST */
251
fac6795d
DG
252extern int lttcomm_create_unix_sock(const char *pathname);
253extern int lttcomm_connect_unix_sock(const char *pathname);
254extern int lttcomm_accept_unix_sock(int sock);
255extern int lttcomm_listen_unix_sock(int sock);
87378cf5 256extern int lttcomm_close_unix_sock(int sock);
3bd1e081
MD
257
258#define LTTCOMM_MAX_SEND_FDS 4
259/* Send a message accompanied by fd(s) over a unix socket. */
260extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
261/* Recv a message accompanied by fd(s) from a unix socket */
262extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
263
fac6795d
DG
264extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
265extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
266extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
267
773168b7 268#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.04018 seconds and 5 git commands to generate.