f8308505c712c915f3a2e17119ec2dea5c3c15c6
[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 #include <lttng-ust.h>
32
33 #define LTTNG_RUNDIR "/var/run/lttng"
34
35 /* Default unix socket path */
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"
40
41 /* Queue size of listen(2) */
42 #define MAX_LISTEN 64
43
44 /*
45 * Get the error code index from 0 since LTTCOMM_OK start at 1000
46 */
47 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
48
49 enum lttcomm_sessiond_command {
50 /* Tracer command */
51 LTTNG_ADD_CONTEXT,
52 LTTNG_CALIBRATE,
53 LTTNG_DISABLE_CHANNEL,
54 LTTNG_DISABLE_EVENT,
55 LTTNG_DISABLE_ALL_EVENT,
56 LTTNG_ENABLE_CHANNEL,
57 LTTNG_ENABLE_EVENT,
58 LTTNG_ENABLE_ALL_EVENT,
59 /* Session daemon command */
60 LTTNG_CREATE_SESSION,
61 LTTNG_DESTROY_SESSION,
62 LTTNG_LIST_CHANNELS,
63 LTTNG_LIST_DOMAINS,
64 LTTNG_LIST_EVENTS,
65 LTTNG_LIST_SESSIONS,
66 LTTNG_LIST_TRACEPOINTS,
67 LTTNG_REGISTER_CONSUMER,
68 LTTNG_START_TRACE,
69 LTTNG_STOP_TRACE,
70 };
71
72 /*
73 * lttcomm error code.
74 */
75 enum lttcomm_return_code {
76 LTTCOMM_OK = 1000, /* Ok */
77 LTTCOMM_ERR, /* Unknown Error */
78 LTTCOMM_UND, /* Undefine command */
79 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
80 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
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 */
89 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
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 */
96 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
97 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
98 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
99 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
100 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
101 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
102 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
103 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
104 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
105 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
106 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
107 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
108 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
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 */
114 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
115 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
116 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
117 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
118 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
119 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
120 KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
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 */
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) */
133 /* MUST be last element */
134 LTTCOMM_NR, /* Last element */
135 };
136
137 /*
138 * Data structure received from lttng client to session daemon.
139 */
140 struct lttcomm_session_msg {
141 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
142 struct lttng_session session;
143 struct lttng_domain domain;
144 union {
145 struct {
146 char channel_name[NAME_MAX];
147 char name[NAME_MAX];
148 } disable;
149 /* Event data */
150 struct {
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;
158 /* Context */
159 struct {
160 char channel_name[NAME_MAX];
161 char event_name[NAME_MAX];
162 struct lttng_event_context ctx;
163 } context;
164 /* Use by register_consumer */
165 struct {
166 char path[PATH_MAX];
167 } reg;
168 /* List */
169 struct {
170 char channel_name[NAME_MAX];
171 } list;
172 struct lttng_calibrate calibrate;
173 } u;
174 };
175
176 /*
177 * Data structure for the response from sessiond to the lttng client.
178 */
179 struct lttcomm_lttng_msg {
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;
184 /* Contains: trace_name + data */
185 char payload[];
186 };
187
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 */
194 struct lttcomm_kconsumerd_header {
195 uint32_t payload_size;
196 uint32_t cmd_type; /* enum kconsumerd_command */
197 };
198
199 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
200 * data and a path name to write it
201 */
202 struct lttcomm_kconsumerd_msg {
203 char path_name[PATH_MAX];
204 int fd;
205 uint32_t state; /* enum lttcomm_kconsumerd_fd_state */
206 unsigned long max_sb_size; /* the subbuffer size for this channel */
207 enum lttng_event_output output; /* use splice or mmap to consume this fd */
208 };
209
210 /*
211 * Data structure for the commands sent from sessiond to UST.
212 */
213 struct lttcomm_ust_msg {
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 */
228 struct 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 {
234 struct {
235 uint64_t memory_map_size;
236 } channel;
237 struct {
238 uint64_t memory_map_size;
239 } stream;
240 } u;
241 };
242
243 extern int lttcomm_create_unix_sock(const char *pathname);
244 extern int lttcomm_connect_unix_sock(const char *pathname);
245 extern int lttcomm_accept_unix_sock(int sock);
246 extern int lttcomm_listen_unix_sock(int sock);
247 extern int lttcomm_close_unix_sock(int sock);
248 /* Send fd(s) over a unix socket. */
249 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
250 size_t nb_fd, size_t len);
251 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
252 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
253 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
254
255 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.049368 seconds and 3 git commands to generate.