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. */
123 /* MUST be last element */
124 LTTCOMM_NR
, /* Last element */
127 /* lttng socket protocol. */
128 enum lttcomm_sock_proto
{
134 * Index in the net_families array below. Please keep in sync!
136 enum lttcomm_sock_domain
{
141 enum lttcomm_metadata_command
{
142 LTTCOMM_METADATA_REQUEST
= 1,
146 * Commands sent from the consumerd to the sessiond to request if new metadata
147 * is available. This message is used to find the per UID _or_ per PID registry
148 * for the channel key. For per UID lookup, the triplet
149 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
150 * per PID registry indexed by session id ignoring the other values.
152 struct lttcomm_metadata_request_msg
{
153 unsigned int session_id
; /* Tracing session id */
154 uint32_t bits_per_long
; /* Consumer ABI */
156 uint64_t key
; /* Metadata channel key. */
159 struct lttcomm_sockaddr
{
160 enum lttcomm_sock_domain type
;
162 struct sockaddr_in sin
;
163 struct sockaddr_in6 sin6
;
167 struct lttcomm_sock
{
169 enum lttcomm_sock_proto proto
;
170 struct lttcomm_sockaddr sockaddr
;
171 const struct lttcomm_proto_ops
*ops
;
175 * Relayd sock. Adds the protocol version to use for the communications with
178 struct lttcomm_relayd_sock
{
179 struct lttcomm_sock sock
;
184 struct lttcomm_net_family
{
186 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
189 struct lttcomm_proto_ops
{
190 int (*bind
) (struct lttcomm_sock
*sock
);
191 int (*close
) (struct lttcomm_sock
*sock
);
192 int (*connect
) (struct lttcomm_sock
*sock
);
193 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
194 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
195 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
197 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
202 * Data structure received from lttng client to session daemon.
204 struct lttcomm_session_msg
{
205 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
206 struct lttng_session session
;
207 struct lttng_domain domain
;
210 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
212 } LTTNG_PACKED disable
;
215 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
216 struct lttng_event event
;
217 /* Length of following bytecode for filter. */
218 uint32_t bytecode_len
;
219 } LTTNG_PACKED enable
;
222 struct lttng_channel chan
;
223 } LTTNG_PACKED channel
;
226 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
227 struct lttng_event_context ctx
;
228 } LTTNG_PACKED context
;
229 /* Use by register_consumer */
235 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
237 struct lttng_calibrate calibrate
;
238 /* Used by the set_consumer_url and used by create_session also call */
240 /* Number of lttng_uri following */
246 #define LTTNG_FILTER_MAX_LEN 65536
249 * Filter bytecode data. The reloc table is located at the end of the
250 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
251 * starts at reloc_table_offset.
253 #define LTTNG_FILTER_PADDING 32
254 struct lttng_filter_bytecode
{
255 uint32_t len
; /* len of data */
256 uint32_t reloc_table_offset
;
258 char padding
[LTTNG_FILTER_PADDING
];
263 * Data structure for the response from sessiond to the lttng client.
265 struct lttcomm_lttng_msg
{
266 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
267 uint32_t ret_code
; /* enum lttcomm_return_code */
268 uint32_t pid
; /* pid_t */
270 /* Contains: trace_name + data */
274 struct lttcomm_health_msg
{
279 struct lttcomm_health_data
{
284 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
285 * to either add a channel, add a stream, update a stream, or stop
288 struct lttcomm_consumer_msg
{
289 uint32_t cmd_type
; /* enum consumerd_command */
292 uint64_t channel_key
;
294 char pathname
[PATH_MAX
];
298 /* nb_init_streams is the number of streams open initially. */
299 uint32_t nb_init_streams
;
300 char name
[LTTNG_SYMBOL_NAME_LEN
];
301 /* Use splice or mmap to consume this fd */
302 enum lttng_event_output output
;
303 int type
; /* Per cpu or metadata. */
304 uint64_t tracefile_size
; /* bytes */
305 uint32_t tracefile_count
; /* number of tracefiles */
306 } LTTNG_PACKED channel
; /* Only used by Kernel. */
309 uint64_t channel_key
;
310 int32_t cpu
; /* On which CPU this stream is assigned. */
311 } LTTNG_PACKED stream
; /* Only used by Kernel. */
314 enum lttng_stream_type type
;
315 /* Open socket to the relayd */
316 struct lttcomm_relayd_sock sock
;
317 /* Tracing session id associated to the relayd. */
319 } LTTNG_PACKED relayd_sock
;
321 uint64_t net_seq_idx
;
322 } LTTNG_PACKED destroy_relayd
;
325 } LTTNG_PACKED data_pending
;
327 uint64_t subbuf_size
; /* bytes */
328 uint64_t num_subbuf
; /* power of 2 */
329 int32_t overwrite
; /* 1: overwrite, 0: discard */
330 uint32_t switch_timer_interval
; /* usec */
331 uint32_t read_timer_interval
; /* usec */
332 int32_t output
; /* splice, mmap */
333 int32_t type
; /* metadata or per_cpu */
334 uint64_t session_id
; /* Tracing session id */
335 char pathname
[PATH_MAX
]; /* Channel file path. */
336 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
337 uint32_t uid
; /* User ID of the session */
338 uint32_t gid
; /* Group ID ot the session */
339 uint64_t relayd_id
; /* Relayd id if apply. */
340 uint64_t key
; /* Unique channel key. */
341 unsigned char uuid
[UUID_LEN
]; /* uuid for ust tracer. */
342 uint32_t chan_id
; /* Channel ID on the tracer side. */
343 uint64_t tracefile_size
; /* bytes */
344 uint32_t tracefile_count
; /* number of tracefiles */
345 } LTTNG_PACKED ask_channel
;
348 } LTTNG_PACKED get_channel
;
351 } LTTNG_PACKED destroy_channel
;
353 uint64_t key
; /* Metadata channel key. */
354 uint64_t target_offset
; /* Offset in the consumer */
355 uint64_t len
; /* Length of metadata to be received. */
356 } LTTNG_PACKED push_metadata
;
358 uint64_t key
; /* Metadata channel key. */
359 } LTTNG_PACKED close_metadata
;
361 uint64_t key
; /* Metadata channel key. */
362 } LTTNG_PACKED setup_metadata
;
364 uint64_t key
; /* Channel key. */
365 } LTTNG_PACKED flush_channel
;
370 * Status message returned to the sessiond after a received command.
372 struct lttcomm_consumer_status_msg
{
373 enum lttng_error_code ret_code
;
376 struct lttcomm_consumer_status_channel
{
377 enum lttng_error_code ret_code
;
379 unsigned int stream_count
;
382 #ifdef HAVE_LIBLTTNG_UST_CTL
384 #include <lttng/ust-abi.h>
387 * Data structure for the commands sent from sessiond to UST.
389 struct lttcomm_ust_msg
{
393 struct lttng_ust_channel channel
;
394 struct lttng_ust_stream stream
;
395 struct lttng_ust_event event
;
396 struct lttng_ust_context context
;
397 struct lttng_ust_tracer_version version
;
402 * Data structure for the response from UST to the session daemon.
403 * cmd_type is sent back in the reply for validation.
405 struct lttcomm_ust_reply
{
408 uint32_t ret_code
; /* enum lttcomm_return_code */
409 uint32_t ret_val
; /* return value */
412 uint64_t memory_map_size
;
413 } LTTNG_PACKED channel
;
415 uint64_t memory_map_size
;
416 } LTTNG_PACKED stream
;
417 struct lttng_ust_tracer_version version
;
421 #endif /* HAVE_LIBLTTNG_UST_CTL */
423 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
425 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
426 const char *ip
, unsigned int port
);
427 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
428 const char *ip
, unsigned int port
);
430 extern struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
431 extern int lttcomm_create_sock(struct lttcomm_sock
*sock
);
432 extern struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
433 extern void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
434 extern struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
435 extern void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
436 struct lttcomm_sock
*src
);
438 /* Relayd socket object. */
439 extern struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
440 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
442 #endif /* _LTTNG_SESSIOND_COMM_H */