d282f77dea2cb485f964b56740a1822998339aa9
[lttng-tools.git] / include / lttng-sessiond-comm.h
1 #ifndef _LTTNG_SESSIOND_COMM_H
2 #define _LTTNG_SESSIOND_COMM_H
3
4 /*
5 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
6 * Julien Desfossez <julien.desfossez@polymtl.ca>
7 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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
11 * as published by the Free Software Foundation; only version 2
12 * of the License.
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.
22 */
23
24 /*
25 * This header is meant for liblttng and libust internal use ONLY.
26 * These declarations should NOT be considered stable API.
27 */
28
29 #include <limits.h>
30 #include <lttng/lttng.h>
31
32 #define LTTNG_RUNDIR "/var/run/lttng"
33
34 /* Default unix socket path */
35 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond"
36 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond"
37 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-lttng-sessiond"
38 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-lttng-sessiond"
39
40 /* Queue size of listen(2) */
41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
42
43 /*
44 * Get the error code index from 0 since LTTCOMM_OK start at 1000
45 */
46 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
47
48 enum lttcomm_sessiond_command {
49 /* Tracer command */
50 LTTNG_ADD_CONTEXT,
51 LTTNG_CALIBRATE,
52 LTTNG_DISABLE_CHANNEL,
53 LTTNG_DISABLE_EVENT,
54 LTTNG_DISABLE_ALL_EVENT,
55 LTTNG_ENABLE_CHANNEL,
56 LTTNG_ENABLE_EVENT,
57 LTTNG_ENABLE_ALL_EVENT,
58 /* Session daemon command */
59 LTTNG_CREATE_SESSION,
60 LTTNG_DESTROY_SESSION,
61 LTTNG_LIST_CHANNELS,
62 LTTNG_LIST_DOMAINS,
63 LTTNG_LIST_EVENTS,
64 LTTNG_LIST_SESSIONS,
65 LTTNG_LIST_TRACEPOINTS,
66 LTTNG_REGISTER_CONSUMER,
67 LTTNG_START_TRACE,
68 LTTNG_STOP_TRACE,
69 };
70
71 /*
72 * lttcomm error code.
73 */
74 enum lttcomm_return_code {
75 LTTCOMM_OK = 1000, /* Ok */
76 LTTCOMM_ERR, /* Unknown Error */
77 LTTCOMM_UND, /* Undefine command */
78 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
79 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
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 */
88 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
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 */
95 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
96 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
97 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
98 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
99 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
100 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
101 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
102 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
103 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
104 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
105 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
106 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
107 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
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 */
113 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
114 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
115 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
116 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
117 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
118 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
119 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
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 */
128 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
129 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
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 */
135
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 */
139 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
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) */
150 /* MUST be last element */
151 LTTCOMM_NR, /* Last element */
152 };
153
154 /*
155 * Data structure received from lttng client to session daemon.
156 */
157 struct lttcomm_session_msg {
158 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
159 struct lttng_session session;
160 struct lttng_domain domain;
161 union {
162 struct {
163 char channel_name[NAME_MAX];
164 char name[NAME_MAX];
165 } disable;
166 /* Event data */
167 struct {
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;
175 /* Context */
176 struct {
177 char channel_name[NAME_MAX];
178 char event_name[NAME_MAX];
179 struct lttng_event_context ctx;
180 } context;
181 /* Use by register_consumer */
182 struct {
183 char path[PATH_MAX];
184 } reg;
185 /* List */
186 struct {
187 char channel_name[NAME_MAX];
188 } list;
189 struct lttng_calibrate calibrate;
190 } u;
191 };
192
193 /*
194 * Data structure for the response from sessiond to the lttng client.
195 */
196 struct lttcomm_lttng_msg {
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;
201 /* Contains: trace_name + data */
202 char payload[];
203 };
204
205 /*
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.
209 */
210 struct 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;
226 char path_name[PATH_MAX];
227 } stream;
228 } u;
229 };
230
231 #ifdef HAVE_LIBLTTNG_UST_CTL
232
233 #include <lttng/ust-abi.h>
234
235 /*
236 * Data structure for the commands sent from sessiond to UST.
237 */
238 struct lttcomm_ust_msg {
239 uint32_t handle;
240 uint32_t cmd;
241 union {
242 struct lttng_ust_channel channel;
243 struct lttng_ust_stream stream;
244 struct lttng_ust_event event;
245 struct lttng_ust_context context;
246 struct lttng_ust_tracer_version version;
247 } u;
248 };
249
250 /*
251 * Data structure for the response from UST to the session daemon.
252 * cmd_type is sent back in the reply for validation.
253 */
254 struct lttcomm_ust_reply {
255 uint32_t handle;
256 uint32_t cmd;
257 uint32_t ret_code; /* enum lttcomm_return_code */
258 uint32_t ret_val; /* return value */
259 union {
260 struct {
261 uint64_t memory_map_size;
262 } channel;
263 struct {
264 uint64_t memory_map_size;
265 } stream;
266 struct lttng_ust_tracer_version version;
267 } u;
268 };
269
270 #endif /* HAVE_LIBLTTNG_UST_CTL */
271
272 extern int lttcomm_create_unix_sock(const char *pathname);
273 extern int lttcomm_connect_unix_sock(const char *pathname);
274 extern int lttcomm_accept_unix_sock(int sock);
275 extern int lttcomm_listen_unix_sock(int sock);
276 extern int lttcomm_close_unix_sock(int sock);
277
278 #define LTTCOMM_MAX_SEND_FDS 4
279 /* Send a message accompanied by fd(s) over a unix socket. */
280 extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
281 /* Recv a message accompanied by fd(s) from a unix socket */
282 extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
283
284 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
285 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
286 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
287
288 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.04918 seconds and 3 git commands to generate.