2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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
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.
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
25 #ifndef _LTTNG_SESSIOND_COMM_H
26 #define _LTTNG_SESSIOND_COMM_H
30 #include <lttng/lttng.h>
31 #include <common/compat/socket.h>
33 /* Queue size of listen(2) */
34 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
36 /* Maximum number of FDs that can be sent over a Unix socket */
37 #define LTTCOMM_MAX_SEND_FDS 4
40 * Get the error code index from 0 since LTTCOMM_OK start at 1000
42 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
44 enum lttcomm_sessiond_command
{
48 LTTNG_DISABLE_CHANNEL
,
50 LTTNG_DISABLE_ALL_EVENT
,
53 LTTNG_ENABLE_ALL_EVENT
,
54 /* Session daemon command */
56 LTTNG_DESTROY_SESSION
,
61 LTTNG_LIST_TRACEPOINTS
,
62 LTTNG_REGISTER_CONSUMER
,
70 enum lttcomm_return_code
{
71 LTTCOMM_OK
= 1000, /* Ok */
72 LTTCOMM_ERR
, /* Unknown Error */
73 LTTCOMM_UND
, /* Undefine command */
74 LTTCOMM_NOT_IMPLEMENTED
, /* Command not implemented */
75 LTTCOMM_UNKNOWN_DOMAIN
, /* Tracing domain not known */
76 LTTCOMM_ALLOC_FAIL
, /* Trace allocation fail */
77 LTTCOMM_NO_SESSION
, /* No session found */
78 LTTCOMM_CREATE_DIR_FAIL
, /* Create directory 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 */
84 LTTCOMM_SESS_NOT_FOUND
, /* Session name not found */
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 */
91 LTTCOMM_CONNECT_FAIL
, /* Unable to connect to unix socket */
92 LTTCOMM_APP_NOT_FOUND
, /* App not found in traceable app list */
93 LTTCOMM_EPERM
, /* Permission denied */
94 LTTCOMM_KERN_NA
, /* Kernel tracer unavalable */
95 LTTCOMM_KERN_VERSION
, /* Kernel tracer version is not compatible */
96 LTTCOMM_KERN_EVENT_EXIST
, /* Kernel event already exists */
97 LTTCOMM_KERN_SESS_FAIL
, /* Kernel create session failed */
98 LTTCOMM_KERN_CHAN_FAIL
, /* Kernel create channel failed */
99 LTTCOMM_KERN_CHAN_NOT_FOUND
, /* Kernel channel not found */
100 LTTCOMM_KERN_CHAN_DISABLE_FAIL
, /* Kernel disable channel failed */
101 LTTCOMM_KERN_CHAN_ENABLE_FAIL
, /* Kernel enable channel failed */
102 LTTCOMM_KERN_CONTEXT_FAIL
, /* Kernel add context failed */
103 LTTCOMM_KERN_ENABLE_FAIL
, /* Kernel enable event failed */
104 LTTCOMM_KERN_DISABLE_FAIL
, /* Kernel disable event failed */
105 LTTCOMM_KERN_META_FAIL
, /* Kernel open metadata failed */
106 LTTCOMM_KERN_START_FAIL
, /* Kernel start trace failed */
107 LTTCOMM_KERN_STOP_FAIL
, /* Kernel stop trace failed */
108 LTTCOMM_KERN_CONSUMER_FAIL
, /* Kernel consumer start failed */
109 LTTCOMM_KERN_STREAM_FAIL
, /* Kernel create stream failed */
110 LTTCOMM_KERN_DIR_FAIL
, /* Kernel trace directory creation failed */
111 LTTCOMM_KERN_DIR_EXIST
, /* Kernel trace directory exist */
112 LTTCOMM_KERN_NO_SESSION
, /* No kernel session found */
113 LTTCOMM_KERN_LIST_FAIL
, /* Kernel listing events failed */
114 LTTCOMM_UST_CALIBRATE_FAIL
, /* UST calibration failed */
115 LTTCOMM_UST_VERSION
, /* UST tracer version is not compatible */
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 LTTCOMM_UST_EVENT_EXIST
, /* UST event exist */
136 LTTCOMM_UST_EVENT_NOT_FOUND
, /* UST event not found */
137 LTTCOMM_UST_CONTEXT_EXIST
, /* UST context exist */
138 LTTCOMM_UST_CONTEXT_INVAL
, /* UST context invalid */
139 LTTCOMM_NEED_ROOT_SESSIOND
, /* root sessiond is needed */
140 LTTCOMM_TRACE_ALREADY_STARTED
, /* Tracing already started */
141 LTTCOMM_TRACE_ALREADY_STOPPED
, /* Tracing already stopped */
143 CONSUMERD_COMMAND_SOCK_READY
, /* when consumerd command socket ready */
144 CONSUMERD_SUCCESS_RECV_FD
, /* success on receiving fds */
145 CONSUMERD_ERROR_RECV_FD
, /* error on receiving fds */
146 CONSUMERD_ERROR_RECV_CMD
, /* error on receiving command */
147 CONSUMERD_POLL_ERROR
, /* Error in polling thread in kconsumerd */
148 CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
149 CONSUMERD_POLL_HUP
, /* All fds have hungup */
150 CONSUMERD_EXIT_SUCCESS
, /* kconsumerd exiting normally */
151 CONSUMERD_EXIT_FAILURE
, /* kconsumerd exiting on error */
152 CONSUMERD_OUTFD_ERROR
, /* error opening the tracefile */
153 CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
154 CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
155 CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
156 CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
158 /* MUST be last element */
159 LTTCOMM_NR
, /* Last element */
163 * Data structure received from lttng client to session daemon.
165 struct lttcomm_session_msg
{
166 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
167 struct lttng_session session
;
168 struct lttng_domain domain
;
171 char channel_name
[NAME_MAX
];
176 char channel_name
[NAME_MAX
];
177 struct lttng_event event
;
181 struct lttng_channel chan
;
185 char channel_name
[NAME_MAX
];
186 char event_name
[NAME_MAX
];
187 struct lttng_event_context ctx
;
189 /* Use by register_consumer */
195 char channel_name
[NAME_MAX
];
197 struct lttng_calibrate calibrate
;
202 * Data structure for the response from sessiond to the lttng client.
204 struct lttcomm_lttng_msg
{
205 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
206 uint32_t ret_code
; /* enum lttcomm_return_code */
207 uint32_t pid
; /* pid_t */
209 /* Contains: trace_name + data */
214 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
215 * to either add a channel, add a stream, update a stream, or stop
218 struct lttcomm_consumer_msg
{
219 uint32_t cmd_type
; /* enum consumerd_command */
223 uint64_t max_sb_size
; /* the subbuffer size for this channel */
224 /* shm_fd and wait_fd are sent as ancillary data */
230 /* shm_fd and wait_fd are sent as ancillary data */
231 uint32_t state
; /* enum lttcomm_consumer_fd_state */
232 enum lttng_event_output output
; /* use splice or mmap to consume this fd */
234 uid_t uid
; /* User ID owning the session */
235 gid_t gid
; /* Group ID owning the session */
236 char path_name
[PATH_MAX
];
241 #ifdef HAVE_LIBLTTNG_UST_CTL
243 #include <lttng/ust-abi.h>
246 * Data structure for the commands sent from sessiond to UST.
248 struct lttcomm_ust_msg
{
252 struct lttng_ust_channel channel
;
253 struct lttng_ust_stream stream
;
254 struct lttng_ust_event event
;
255 struct lttng_ust_context context
;
256 struct lttng_ust_tracer_version version
;
261 * Data structure for the response from UST to the session daemon.
262 * cmd_type is sent back in the reply for validation.
264 struct lttcomm_ust_reply
{
267 uint32_t ret_code
; /* enum lttcomm_return_code */
268 uint32_t ret_val
; /* return value */
271 uint64_t memory_map_size
;
274 uint64_t memory_map_size
;
276 struct lttng_ust_tracer_version version
;
280 #endif /* HAVE_LIBLTTNG_UST_CTL */
282 extern int lttcomm_create_unix_sock(const char *pathname
);
283 extern int lttcomm_connect_unix_sock(const char *pathname
);
284 extern int lttcomm_accept_unix_sock(int sock
);
285 extern int lttcomm_listen_unix_sock(int sock
);
286 extern int lttcomm_close_unix_sock(int sock
);
288 /* Send a message accompanied by fd(s) over a unix socket. */
289 extern ssize_t
lttcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
290 /* Recv a message accompanied by fd(s) from a unix socket */
291 extern ssize_t
lttcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
293 extern ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
294 extern ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
);
296 extern ssize_t
lttcomm_send_creds_unix_sock(int sock
, void *buf
, size_t len
);
297 extern ssize_t
lttcomm_recv_creds_unix_sock(int sock
, void *buf
, size_t len
,
298 lttng_sock_cred
*creds
);
300 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
301 extern int lttcomm_setsockopt_creds_unix_sock(int sock
);
303 #endif /* _LTTNG_SESSIOND_COMM_H */