Update UST ABI and add UST some error message
[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>
3817e7df 31#include <lttng-ust.h>
5e16da05 32
f4688807 33#define LTTNG_RUNDIR "/var/run/lttng"
1526bda7 34
fac6795d 35/* Default unix socket path */
f4688807
DG
36#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
37#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
38#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
39#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
fac6795d
DG
40
41/* Queue size of listen(2) */
b959688f 42#define MAX_LISTEN 64
fac6795d 43
3817e7df
DG
44/*
45 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 46 */
686204ab 47#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d 48
6abb15de 49enum lttcomm_sessiond_command {
0d0c377a 50 /* Tracer command */
b579acd9 51 LTTNG_ADD_CONTEXT,
f4688807 52 LTTNG_CALIBRATE,
0b97ec54 53 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
54 LTTNG_DISABLE_EVENT,
55 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
56 LTTNG_ENABLE_CHANNEL,
57 LTTNG_ENABLE_EVENT,
58 LTTNG_ENABLE_ALL_EVENT,
59 /* Session daemon command */
fac6795d
DG
60 LTTNG_CREATE_SESSION,
61 LTTNG_DESTROY_SESSION,
9f19cc17
DG
62 LTTNG_LIST_CHANNELS,
63 LTTNG_LIST_DOMAINS,
f3ed775e 64 LTTNG_LIST_EVENTS,
9f19cc17 65 LTTNG_LIST_SESSIONS,
052da939 66 LTTNG_LIST_TRACEPOINTS,
d9800920 67 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
68 LTTNG_START_TRACE,
69 LTTNG_STOP_TRACE,
fac6795d
DG
70};
71
72/*
73 * lttcomm error code.
74 */
75enum lttcomm_return_code {
20fe2104
DG
76 LTTCOMM_OK = 1000, /* Ok */
77 LTTCOMM_ERR, /* Unknown Error */
78 LTTCOMM_UND, /* Undefine command */
7d29a247
DG
79 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
80 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104
DG
81 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
82 LTTCOMM_NO_SESSION, /* No session found */
83 LTTCOMM_CREATE_FAIL, /* Create trace fail */
84 LTTCOMM_SESSION_FAIL, /* Create session fail */
85 LTTCOMM_START_FAIL, /* Start tracing fail */
86 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
87 LTTCOMM_LIST_FAIL, /* Listing apps fail */
88 LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e 89 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104
DG
90 LTTCOMM_NO_TRACE, /* No trace exist */
91 LTTCOMM_FATAL, /* Session daemon had a fatal error */
92 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
93 LTTCOMM_SELECT_SESS, /* Must select a session */
94 LTTCOMM_EXIST_SESS, /* Session name already exist */
95 LTTCOMM_NO_EVENT, /* No event found */
d9800920 96 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864 97 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
20fe2104 98 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
7d29a247 99 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104
DG
100 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
101 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 102 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 103 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 104 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 105 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
106 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
107 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 108 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
109 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
110 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
111 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
112 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
113 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
114 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
115 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 116 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
0177d773 117 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
2b0bf864
DG
118 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
119 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
d4a1283e 120 KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
20fe2104
DG
121 KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
122 KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
123 KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
124 KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
125 KCONSUMERD_POLL_HUP, /* All fds have hungup */
126 KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
127 KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
128 KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
0632499a
JD
129 KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
130 KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
131 KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
132 KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104
DG
133 /* MUST be last element */
134 LTTCOMM_NR, /* Last element */
fac6795d
DG
135};
136
137/*
9bda164d 138 * Data structure received from lttng client to session daemon.
fac6795d
DG
139 */
140struct lttcomm_session_msg {
773168b7 141 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 142 struct lttng_session session;
9f19cc17 143 struct lttng_domain domain;
fac6795d
DG
144 union {
145 struct {
f3ed775e
DG
146 char channel_name[NAME_MAX];
147 char name[NAME_MAX];
148 } disable;
149 /* Event data */
fac6795d 150 struct {
f3ed775e
DG
151 char channel_name[NAME_MAX];
152 struct lttng_event event;
153 } enable;
154 /* Create channel */
155 struct {
156 struct lttng_channel chan;
157 } channel;
d65106b1
DG
158 /* Context */
159 struct {
160 char channel_name[NAME_MAX];
161 char event_name[NAME_MAX];
7d29a247 162 struct lttng_event_context ctx;
d65106b1 163 } context;
d9800920
DG
164 /* Use by register_consumer */
165 struct {
166 char path[PATH_MAX];
167 } reg;
9f19cc17
DG
168 /* List */
169 struct {
170 char channel_name[NAME_MAX];
171 } list;
d0254c7c 172 struct lttng_calibrate calibrate;
fac6795d
DG
173 } u;
174};
175
176/*
5e16da05 177 * Data structure for the response from sessiond to the lttng client.
fac6795d 178 */
5461b305 179struct lttcomm_lttng_msg {
773168b7
MD
180 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
181 uint32_t ret_code; /* enum lttcomm_return_code */
182 uint32_t pid; /* pid_t */
183 uint32_t data_size;
5461b305
DG
184 /* Contains: trace_name + data */
185 char payload[];
fac6795d
DG
186};
187
6e3805e2
DG
188/*
189 * Data structures for the kconsumerd communications
190 *
191 * The header structure is sent to the kconsumerd daemon to inform
192 * how many lttcomm_kconsumerd_msg it is about to receive
193 */
194struct lttcomm_kconsumerd_header {
773168b7
MD
195 uint32_t payload_size;
196 uint32_t cmd_type; /* enum kconsumerd_command */
6e3805e2
DG
197};
198
199/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
200 * data and a path name to write it
201 */
202struct lttcomm_kconsumerd_msg {
203 char path_name[PATH_MAX];
204 int fd;
773168b7 205 uint32_t state; /* enum lttcomm_kconsumerd_fd_state */
d4a1283e 206 unsigned long max_sb_size; /* the subbuffer size for this channel */
8b270bdb 207 enum lttng_event_output output; /* use splice or mmap to consume this fd */
6e3805e2
DG
208};
209
3817e7df
DG
210/*
211 * Data structure for the commands sent from sessiond to UST.
212 */
213struct lttcomm_ust_msg {
3817e7df
DG
214 uint32_t handle;
215 uint32_t cmd;
216 union {
217 struct lttng_ust_tracer_version version;
218 struct lttng_ust_channel channel;
219 struct lttng_ust_event event;
220 struct lttng_ust_context context;
221 } u;
222};
223
224/*
225 * Data structure for the response from UST to the session daemon.
226 * cmd_type is sent back in the reply for validation.
227 */
228struct lttcomm_ust_reply {
229 uint32_t handle;
230 uint32_t cmd;
231 uint32_t ret_code; /* enum lttcomm_return_code */
232 uint32_t ret_val; /* return value */
233 union {
2b0bf864
DG
234 struct {
235 uint64_t memory_map_size;
236 } channel;
237 struct {
238 uint64_t memory_map_size;
239 } stream;
3817e7df
DG
240 } u;
241};
242
fac6795d
DG
243extern int lttcomm_create_unix_sock(const char *pathname);
244extern int lttcomm_connect_unix_sock(const char *pathname);
245extern int lttcomm_accept_unix_sock(int sock);
246extern int lttcomm_listen_unix_sock(int sock);
87378cf5 247extern int lttcomm_close_unix_sock(int sock);
f4688807 248/* Send fd(s) over a unix socket. */
773168b7 249extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
f4688807 250 size_t nb_fd, size_t len);
fac6795d
DG
251extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
252extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
253extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
254
773168b7 255#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.055502 seconds and 4 git commands to generate.