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
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
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
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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>
32 #include <common/uri.h>
34 #include <arpa/inet.h>
35 #include <netinet/in.h>
42 /* Queue size of listen(2) */
43 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
45 /* Maximum number of FDs that can be sent over a Unix socket */
46 #define LTTCOMM_MAX_SEND_FDS 4
49 * Get the error code index from 0 since LTTCOMM_OK start at 1000
51 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
53 enum lttcomm_sessiond_command
{
57 LTTNG_DISABLE_CHANNEL
,
59 LTTNG_DISABLE_ALL_EVENT
,
62 LTTNG_ENABLE_ALL_EVENT
,
63 /* Session daemon command */
65 LTTNG_DESTROY_SESSION
,
70 LTTNG_LIST_TRACEPOINTS
,
71 LTTNG_REGISTER_CONSUMER
,
74 LTTNG_LIST_TRACEPOINT_FIELDS
,
77 LTTNG_DISABLE_CONSUMER
,
78 LTTNG_ENABLE_CONSUMER
,
79 LTTNG_SET_CONSUMER_URI
,
82 RELAYD_CREATE_SESSION
,
84 RELAYD_UPDATE_SYNC_INFO
,
96 enum lttcomm_return_code
{
97 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 1, /* Command socket ready */
98 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
99 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
100 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
101 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
102 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
103 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
104 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
105 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
106 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
107 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
108 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
109 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
110 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
112 /* MUST be last element */
113 LTTCOMM_NR
, /* Last element */
116 /* lttng socket protocol. */
117 enum lttcomm_sock_proto
{
123 * Index in the net_families array below. Please keep in sync!
125 enum lttcomm_sock_domain
{
130 struct lttcomm_sockaddr
{
131 enum lttcomm_sock_domain type
;
133 struct sockaddr_in sin
;
134 struct sockaddr_in6 sin6
;
138 struct lttcomm_sock
{
140 enum lttcomm_sock_proto proto
;
141 struct lttcomm_sockaddr sockaddr
;
142 const struct lttcomm_proto_ops
*ops
;
145 struct lttcomm_net_family
{
147 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
150 struct lttcomm_proto_ops
{
151 int (*bind
) (struct lttcomm_sock
*sock
);
152 int (*close
) (struct lttcomm_sock
*sock
);
153 int (*connect
) (struct lttcomm_sock
*sock
);
154 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
155 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
156 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
158 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
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
[LTTNG_SYMBOL_NAME_LEN
];
176 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
177 struct lttng_event event
;
181 struct lttng_channel chan
;
185 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
186 char event_name
[LTTNG_SYMBOL_NAME_LEN
];
187 struct lttng_event_context ctx
;
189 /* Use by register_consumer */
195 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
197 struct lttng_calibrate calibrate
;
198 /* Used by the set_consumer_url and used by create_session also call */
200 /* Number of lttng_uri following */
204 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
205 char event_name
[LTTNG_SYMBOL_NAME_LEN
];
206 /* Length of following bytecode */
207 uint32_t bytecode_len
;
212 #define LTTNG_FILTER_MAX_LEN 65536
215 * Filter bytecode data. The reloc table is located at the end of the
216 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
217 * starts at reloc_table_offset.
219 struct lttng_filter_bytecode
{
220 uint32_t len
; /* len of data */
221 uint32_t reloc_table_offset
;
226 * Data structure for the response from sessiond to the lttng client.
228 struct lttcomm_lttng_msg
{
229 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
230 uint32_t ret_code
; /* enum lttcomm_return_code */
231 uint32_t pid
; /* pid_t */
233 /* Contains: trace_name + data */
237 struct lttcomm_health_msg
{
242 struct lttcomm_health_data
{
247 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
248 * to either add a channel, add a stream, update a stream, or stop
251 struct lttcomm_consumer_msg
{
252 uint32_t cmd_type
; /* enum consumerd_command */
256 uint64_t max_sb_size
; /* the subbuffer size for this channel */
257 /* shm_fd and wait_fd are sent as ancillary data */
259 /* nb_init_streams is the number of streams open initially. */
260 unsigned int nb_init_streams
;
261 char name
[LTTNG_SYMBOL_NAME_LEN
];
266 /* shm_fd and wait_fd are sent as ancillary data */
267 uint32_t state
; /* enum lttcomm_consumer_fd_state */
268 enum lttng_event_output output
; /* use splice or mmap to consume this fd */
270 uid_t uid
; /* User ID owning the session */
271 gid_t gid
; /* Group ID owning the session */
272 char path_name
[PATH_MAX
];
274 unsigned int metadata_flag
;
275 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Name string of the stream */
276 uint64_t session_id
; /* Tracing session id of the stream */
280 enum lttng_stream_type type
;
281 /* Open socket to the relayd */
282 struct lttcomm_sock sock
;
285 uint64_t net_seq_idx
;
293 #ifdef HAVE_LIBLTTNG_UST_CTL
295 #include <lttng/ust-abi.h>
298 * Data structure for the commands sent from sessiond to UST.
300 struct lttcomm_ust_msg
{
304 struct lttng_ust_channel channel
;
305 struct lttng_ust_stream stream
;
306 struct lttng_ust_event event
;
307 struct lttng_ust_context context
;
308 struct lttng_ust_tracer_version version
;
313 * Data structure for the response from UST to the session daemon.
314 * cmd_type is sent back in the reply for validation.
316 struct lttcomm_ust_reply
{
319 uint32_t ret_code
; /* enum lttcomm_return_code */
320 uint32_t ret_val
; /* return value */
323 uint64_t memory_map_size
;
326 uint64_t memory_map_size
;
328 struct lttng_ust_tracer_version version
;
332 #endif /* HAVE_LIBLTTNG_UST_CTL */
334 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
336 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
337 const char *ip
, unsigned int port
);
338 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
339 const char *ip
, unsigned int port
);
341 extern struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
342 extern int lttcomm_create_sock(struct lttcomm_sock
*sock
);
343 extern struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
344 extern void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
345 extern struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
346 extern void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
347 struct lttcomm_sock
*src
);
349 #endif /* _LTTNG_SESSIOND_COMM_H */