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>
33 #include <common/defaults.h>
34 #include <common/compat/uuid.h>
36 #include <arpa/inet.h>
37 #include <netinet/in.h>
44 /* Queue size of listen(2) */
45 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
47 /* Maximum number of FDs that can be sent over a Unix socket */
48 #define LTTCOMM_MAX_SEND_FDS 4
51 * Get the error code index from 0 since LTTCOMM_OK start at 1000
53 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
55 enum lttcomm_sessiond_command
{
57 LTTNG_ADD_CONTEXT
= 0,
59 LTTNG_DISABLE_CHANNEL
= 2,
60 LTTNG_DISABLE_EVENT
= 3,
61 LTTNG_DISABLE_ALL_EVENT
= 4,
62 LTTNG_ENABLE_CHANNEL
= 5,
63 LTTNG_ENABLE_EVENT
= 6,
64 LTTNG_ENABLE_ALL_EVENT
= 7,
65 /* Session daemon command */
66 LTTNG_CREATE_SESSION
= 8,
67 LTTNG_DESTROY_SESSION
= 9,
68 LTTNG_LIST_CHANNELS
= 10,
69 LTTNG_LIST_DOMAINS
= 11,
70 LTTNG_LIST_EVENTS
= 12,
71 LTTNG_LIST_SESSIONS
= 13,
72 LTTNG_LIST_TRACEPOINTS
= 14,
73 LTTNG_REGISTER_CONSUMER
= 15,
74 LTTNG_START_TRACE
= 16,
75 LTTNG_STOP_TRACE
= 17,
76 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
79 LTTNG_DISABLE_CONSUMER
= 19,
80 LTTNG_ENABLE_CONSUMER
= 20,
81 LTTNG_SET_CONSUMER_URI
= 21,
82 LTTNG_ENABLE_EVENT_WITH_FILTER
= 22,
83 LTTNG_HEALTH_CHECK
= 23,
84 LTTNG_DATA_PENDING
= 24,
87 enum lttcomm_relayd_command
{
88 RELAYD_ADD_STREAM
= 1,
89 RELAYD_CREATE_SESSION
= 2,
90 RELAYD_START_DATA
= 3,
91 RELAYD_UPDATE_SYNC_INFO
= 4,
93 RELAYD_SEND_METADATA
= 6,
94 RELAYD_CLOSE_STREAM
= 7,
95 RELAYD_DATA_PENDING
= 8,
96 RELAYD_QUIESCENT_CONTROL
= 9,
97 RELAYD_BEGIN_DATA_PENDING
= 10,
98 RELAYD_END_DATA_PENDING
= 11,
102 * lttcomm error code.
104 enum lttcomm_return_code
{
105 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 1, /* Command socket ready */
106 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
107 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
108 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
109 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
110 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
111 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
112 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
113 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
114 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
115 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
116 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
117 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
118 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
119 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
120 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
121 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
122 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
124 /* MUST be last element */
125 LTTCOMM_NR
, /* Last element */
128 /* lttng socket protocol. */
129 enum lttcomm_sock_proto
{
135 * Index in the net_families array below. Please keep in sync!
137 enum lttcomm_sock_domain
{
142 enum lttcomm_metadata_command
{
143 LTTCOMM_METADATA_REQUEST
= 1,
147 * Commands sent from the consumerd to the sessiond to request if new metadata
148 * is available. This message is used to find the per UID _or_ per PID registry
149 * for the channel key. For per UID lookup, the triplet
150 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
151 * per PID registry indexed by session id ignoring the other values.
153 struct lttcomm_metadata_request_msg
{
154 uint64_t session_id
; /* Tracing session id */
155 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
156 uint32_t bits_per_long
; /* Consumer ABI */
158 uint64_t key
; /* Metadata channel key. */
161 struct lttcomm_sockaddr
{
162 enum lttcomm_sock_domain type
;
164 struct sockaddr_in sin
;
165 struct sockaddr_in6 sin6
;
169 struct lttcomm_sock
{
171 enum lttcomm_sock_proto proto
;
172 struct lttcomm_sockaddr sockaddr
;
173 const struct lttcomm_proto_ops
*ops
;
177 * Relayd sock. Adds the protocol version to use for the communications with
180 struct lttcomm_relayd_sock
{
181 struct lttcomm_sock sock
;
186 struct lttcomm_net_family
{
188 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
191 struct lttcomm_proto_ops
{
192 int (*bind
) (struct lttcomm_sock
*sock
);
193 int (*close
) (struct lttcomm_sock
*sock
);
194 int (*connect
) (struct lttcomm_sock
*sock
);
195 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
196 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
197 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
199 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
204 * Data structure received from lttng client to session daemon.
206 struct lttcomm_session_msg
{
207 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
208 struct lttng_session session
;
209 struct lttng_domain domain
;
212 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
214 } LTTNG_PACKED disable
;
217 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
218 struct lttng_event event
;
219 /* Length of following bytecode for filter. */
220 uint32_t bytecode_len
;
221 } LTTNG_PACKED enable
;
224 struct lttng_channel chan
;
225 } LTTNG_PACKED channel
;
228 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
229 struct lttng_event_context ctx
;
230 } LTTNG_PACKED context
;
231 /* Use by register_consumer */
237 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
239 struct lttng_calibrate calibrate
;
240 /* Used by the set_consumer_url and used by create_session also call */
242 /* Number of lttng_uri following */
248 #define LTTNG_FILTER_MAX_LEN 65536
251 * Filter bytecode data. The reloc table is located at the end of the
252 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
253 * starts at reloc_table_offset.
255 #define LTTNG_FILTER_PADDING 32
256 struct lttng_filter_bytecode
{
257 uint32_t len
; /* len of data */
258 uint32_t reloc_table_offset
;
260 char padding
[LTTNG_FILTER_PADDING
];
265 * Data structure for the response from sessiond to the lttng client.
267 struct lttcomm_lttng_msg
{
268 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
269 uint32_t ret_code
; /* enum lttcomm_return_code */
270 uint32_t pid
; /* pid_t */
272 /* Contains: trace_name + data */
276 struct lttcomm_health_msg
{
281 struct lttcomm_health_data
{
286 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
287 * to either add a channel, add a stream, update a stream, or stop
290 struct lttcomm_consumer_msg
{
291 uint32_t cmd_type
; /* enum consumerd_command */
294 uint64_t channel_key
;
296 char pathname
[PATH_MAX
];
300 /* nb_init_streams is the number of streams open initially. */
301 uint32_t nb_init_streams
;
302 char name
[LTTNG_SYMBOL_NAME_LEN
];
303 /* Use splice or mmap to consume this fd */
304 enum lttng_event_output output
;
305 int type
; /* Per cpu or metadata. */
306 uint64_t tracefile_size
; /* bytes */
307 uint32_t tracefile_count
; /* number of tracefiles */
308 } LTTNG_PACKED channel
; /* Only used by Kernel. */
311 uint64_t channel_key
;
312 int32_t cpu
; /* On which CPU this stream is assigned. */
313 } LTTNG_PACKED stream
; /* Only used by Kernel. */
316 enum lttng_stream_type type
;
317 /* Open socket to the relayd */
318 struct lttcomm_relayd_sock sock
;
319 /* Tracing session id associated to the relayd. */
321 } LTTNG_PACKED relayd_sock
;
323 uint64_t net_seq_idx
;
324 } LTTNG_PACKED destroy_relayd
;
327 } LTTNG_PACKED data_pending
;
329 uint64_t subbuf_size
; /* bytes */
330 uint64_t num_subbuf
; /* power of 2 */
331 int32_t overwrite
; /* 1: overwrite, 0: discard */
332 uint32_t switch_timer_interval
; /* usec */
333 uint32_t read_timer_interval
; /* usec */
334 int32_t output
; /* splice, mmap */
335 int32_t type
; /* metadata or per_cpu */
336 uint64_t session_id
; /* Tracing session id */
337 char pathname
[PATH_MAX
]; /* Channel file path. */
338 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
339 uint32_t uid
; /* User ID of the session */
340 uint32_t gid
; /* Group ID ot the session */
341 uint64_t relayd_id
; /* Relayd id if apply. */
342 uint64_t key
; /* Unique channel key. */
343 unsigned char uuid
[UUID_LEN
]; /* uuid for ust tracer. */
344 uint32_t chan_id
; /* Channel ID on the tracer side. */
345 uint64_t tracefile_size
; /* bytes */
346 uint32_t tracefile_count
; /* number of tracefiles */
347 uint64_t session_id_per_pid
; /* Per-pid session ID. */
348 } LTTNG_PACKED ask_channel
;
351 } LTTNG_PACKED get_channel
;
354 } LTTNG_PACKED destroy_channel
;
356 uint64_t key
; /* Metadata channel key. */
357 uint64_t target_offset
; /* Offset in the consumer */
358 uint64_t len
; /* Length of metadata to be received. */
359 } LTTNG_PACKED push_metadata
;
361 uint64_t key
; /* Metadata channel key. */
362 } LTTNG_PACKED close_metadata
;
364 uint64_t key
; /* Metadata channel key. */
365 } LTTNG_PACKED setup_metadata
;
367 uint64_t key
; /* Channel key. */
368 } LTTNG_PACKED flush_channel
;
373 * Status message returned to the sessiond after a received command.
375 struct lttcomm_consumer_status_msg
{
376 enum lttng_error_code ret_code
;
379 struct lttcomm_consumer_status_channel
{
380 enum lttng_error_code ret_code
;
382 unsigned int stream_count
;
385 #ifdef HAVE_LIBLTTNG_UST_CTL
387 #include <lttng/ust-abi.h>
390 * Data structure for the commands sent from sessiond to UST.
392 struct lttcomm_ust_msg
{
396 struct lttng_ust_channel channel
;
397 struct lttng_ust_stream stream
;
398 struct lttng_ust_event event
;
399 struct lttng_ust_context context
;
400 struct lttng_ust_tracer_version version
;
405 * Data structure for the response from UST to the session daemon.
406 * cmd_type is sent back in the reply for validation.
408 struct lttcomm_ust_reply
{
411 uint32_t ret_code
; /* enum lttcomm_return_code */
412 uint32_t ret_val
; /* return value */
415 uint64_t memory_map_size
;
416 } LTTNG_PACKED channel
;
418 uint64_t memory_map_size
;
419 } LTTNG_PACKED stream
;
420 struct lttng_ust_tracer_version version
;
424 #endif /* HAVE_LIBLTTNG_UST_CTL */
426 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
428 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
429 const char *ip
, unsigned int port
);
430 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
431 const char *ip
, unsigned int port
);
433 extern struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
434 extern int lttcomm_create_sock(struct lttcomm_sock
*sock
);
435 extern struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
436 extern void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
437 extern struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
438 extern void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
439 struct lttcomm_sock
*src
);
441 /* Relayd socket object. */
442 extern struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
443 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
445 #endif /* _LTTNG_SESSIOND_COMM_H */