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
29 #include <lttng/lttng.h>
30 #include <lttng/snapshot-internal.h>
31 #include <lttng/save-internal.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/trigger/trigger-internal.h>
34 #include <common/compat/socket.h>
35 #include <common/uri.h>
36 #include <common/defaults.h>
37 #include <common/compat/uuid.h>
39 #include <arpa/inet.h>
40 #include <netinet/in.h>
45 #include <common/unix.h>
47 /* Queue size of listen(2) */
48 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
50 /* Maximum number of FDs that can be sent over a Unix socket */
51 #define LTTCOMM_MAX_SEND_FDS 4
54 * Get the error code index from 0 since LTTCOMM_OK start at 1000
56 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
58 enum lttcomm_sessiond_command
{
60 LTTNG_ADD_CONTEXT
= 0,
61 /* LTTNG_CALIBRATE used to be here */
62 LTTNG_DISABLE_CHANNEL
= 2,
63 LTTNG_DISABLE_EVENT
= 3,
64 LTTNG_LIST_SYSCALLS
= 4,
65 LTTNG_ENABLE_CHANNEL
= 5,
66 LTTNG_ENABLE_EVENT
= 6,
68 /* Session daemon command */
69 LTTNG_CREATE_SESSION
= 8,
70 LTTNG_DESTROY_SESSION
= 9,
71 LTTNG_LIST_CHANNELS
= 10,
72 LTTNG_LIST_DOMAINS
= 11,
73 LTTNG_LIST_EVENTS
= 12,
74 LTTNG_LIST_SESSIONS
= 13,
75 LTTNG_LIST_TRACEPOINTS
= 14,
76 LTTNG_REGISTER_CONSUMER
= 15,
77 LTTNG_START_TRACE
= 16,
78 LTTNG_STOP_TRACE
= 17,
79 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
82 LTTNG_DISABLE_CONSUMER
= 19,
83 LTTNG_ENABLE_CONSUMER
= 20,
84 LTTNG_SET_CONSUMER_URI
= 21,
87 LTTNG_DATA_PENDING
= 24,
88 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
89 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
90 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
91 LTTNG_SNAPSHOT_RECORD
= 28,
92 LTTNG_CREATE_SESSION_SNAPSHOT
= 29,
93 LTTNG_CREATE_SESSION_LIVE
= 30,
94 LTTNG_SAVE_SESSION
= 31,
96 LTTNG_UNTRACK_PID
= 33,
97 LTTNG_LIST_TRACKER_PIDS
= 34,
98 LTTNG_SET_SESSION_SHM_PATH
= 40,
99 LTTNG_REGENERATE_METADATA
= 41,
100 LTTNG_REGENERATE_STATEDUMP
= 42,
101 LTTNG_REGISTER_TRIGGER
= 43,
102 LTTNG_UNREGISTER_TRIGGER
= 44,
103 LTTNG_CLEAR_SESSION
= 49,
106 enum lttcomm_relayd_command
{
107 RELAYD_ADD_STREAM
= 1,
108 RELAYD_CREATE_SESSION
= 2,
109 RELAYD_START_DATA
= 3,
110 RELAYD_UPDATE_SYNC_INFO
= 4,
112 RELAYD_SEND_METADATA
= 6,
113 RELAYD_CLOSE_STREAM
= 7,
114 RELAYD_DATA_PENDING
= 8,
115 RELAYD_QUIESCENT_CONTROL
= 9,
116 RELAYD_BEGIN_DATA_PENDING
= 10,
117 RELAYD_END_DATA_PENDING
= 11,
118 RELAYD_ADD_INDEX
= 12,
119 RELAYD_SEND_INDEX
= 13,
120 RELAYD_CLOSE_INDEX
= 14,
121 /* Live-reading commands (2.4+). */
122 RELAYD_LIST_SESSIONS
= 15,
123 /* All streams of the channel have been sent to the relayd (2.4+). */
124 RELAYD_STREAMS_SENT
= 16,
125 /* Ask the relay to reset the metadata trace file (2.8+) */
126 RELAYD_RESET_METADATA
= 17,
128 /* Feature branch specific commands start at 10000. */
130 /* Ask the relay to clear files belonging to a session (feature branch). */
131 RELAYD_CLEAR_SESSION_CUSTOM_EFFICIOS
= 10000,
135 * lttcomm error code.
137 enum lttcomm_return_code
{
138 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
139 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 1, /* Command socket ready */
140 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
141 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
142 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
143 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
144 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
145 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
146 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
147 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
148 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
149 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
150 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
151 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
152 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
153 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
154 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
155 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
156 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
157 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
158 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
159 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
160 LTTCOMM_CONSUMERD_RELAYD_DISALLOW_CLEAR
, /* Relayd does not accept clear command. */
162 /* MUST be last element */
163 LTTCOMM_NR
, /* Last element */
166 /* lttng socket protocol. */
167 enum lttcomm_sock_proto
{
173 * Index in the net_families array below. Please keep in sync!
175 enum lttcomm_sock_domain
{
180 enum lttcomm_metadata_command
{
181 LTTCOMM_METADATA_REQUEST
= 1,
185 * Commands sent from the consumerd to the sessiond to request if new metadata
186 * is available. This message is used to find the per UID _or_ per PID registry
187 * for the channel key. For per UID lookup, the triplet
188 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
189 * per PID registry indexed by session id ignoring the other values.
191 struct lttcomm_metadata_request_msg
{
192 uint64_t session_id
; /* Tracing session id */
193 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
194 uint32_t bits_per_long
; /* Consumer ABI */
196 uint64_t key
; /* Metadata channel key. */
199 struct lttcomm_sockaddr
{
200 enum lttcomm_sock_domain type
;
202 struct sockaddr_in sin
;
203 struct sockaddr_in6 sin6
;
207 struct lttcomm_sock
{
209 enum lttcomm_sock_proto proto
;
210 struct lttcomm_sockaddr sockaddr
;
211 const struct lttcomm_proto_ops
*ops
;
215 * Relayd sock. Adds the protocol version to use for the communications with
218 struct lttcomm_relayd_sock
{
219 struct lttcomm_sock sock
;
224 struct lttcomm_net_family
{
226 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
229 struct lttcomm_proto_ops
{
230 int (*bind
) (struct lttcomm_sock
*sock
);
231 int (*close
) (struct lttcomm_sock
*sock
);
232 int (*connect
) (struct lttcomm_sock
*sock
);
233 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
234 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
235 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
237 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
238 size_t len
, int flags
);
242 * Data structure received from lttng client to session daemon.
244 struct lttcomm_session_msg
{
245 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
246 struct lttng_session session
;
247 struct lttng_domain domain
;
251 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
252 struct lttng_event event LTTNG_PACKED
;
253 /* Length of following filter expression. */
254 uint32_t expression_len
;
255 /* Length of following bytecode for filter. */
256 uint32_t bytecode_len
;
258 uint32_t exclusion_count
;
260 * After this structure, the following variable-length
261 * items are transmitted:
262 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
263 * - unsigned char filter_expression[expression_len]
264 * - unsigned char filter_bytecode[bytecode_len]
266 } LTTNG_PACKED enable
;
268 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
269 struct lttng_event event LTTNG_PACKED
;
270 /* Length of following filter expression. */
271 uint32_t expression_len
;
272 /* Length of following bytecode for filter. */
273 uint32_t bytecode_len
;
275 * After this structure, the following variable-length
276 * items are transmitted:
277 * - unsigned char filter_expression[expression_len]
278 * - unsigned char filter_bytecode[bytecode_len]
280 } LTTNG_PACKED disable
;
283 struct lttng_channel chan LTTNG_PACKED
;
284 /* struct lttng_channel_extended is already packed. */
285 struct lttng_channel_extended extended
;
286 } LTTNG_PACKED channel
;
289 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
290 struct lttng_event_context ctx LTTNG_PACKED
;
291 uint32_t provider_name_len
;
292 uint32_t context_name_len
;
293 } LTTNG_PACKED context
;
294 /* Use by register_consumer */
300 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
302 struct lttng_calibrate calibrate
;
303 /* Used by the set_consumer_url and used by create_session also call */
305 /* Number of lttng_uri following */
309 struct lttng_snapshot_output output LTTNG_PACKED
;
310 } LTTNG_PACKED snapshot_output
;
313 struct lttng_snapshot_output output LTTNG_PACKED
;
314 } LTTNG_PACKED snapshot_record
;
317 unsigned int timer_interval
; /* usec */
318 } LTTNG_PACKED session_live
;
320 struct lttng_save_session_attr attr
; /* struct already packed */
321 } LTTNG_PACKED save_session
;
323 char shm_path
[PATH_MAX
];
324 } LTTNG_PACKED set_shm_path
;
327 } LTTNG_PACKED pid_tracker
;
330 } LTTNG_PACKED trigger
;
334 #define LTTNG_FILTER_MAX_LEN 65536
337 * Filter bytecode data. The reloc table is located at the end of the
338 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
339 * starts at reloc_table_offset.
341 #define LTTNG_FILTER_PADDING 32
342 struct lttng_filter_bytecode
{
343 uint32_t len
; /* len of data */
344 uint32_t reloc_table_offset
;
346 char padding
[LTTNG_FILTER_PADDING
];
351 * Event exclusion data. At the end of the structure, there will actually
352 * by zero or more names, where the actual number of names is given by
353 * the 'count' item of the structure.
355 #define LTTNG_EVENT_EXCLUSION_PADDING 32
356 struct lttng_event_exclusion
{
358 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
359 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
362 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
363 (&(_exclusion)->names[_i][0])
366 * Event command header.
368 struct lttcomm_event_command_header
{
369 /* Number of events */
374 * Event extended info header. This is the structure preceding each
375 * extended info data.
377 struct lttcomm_event_extended_header
{
379 * Size of filter string immediately following this header.
380 * This size includes the terminal null character.
385 * Number of exclusion names, immediately following the filter
386 * string. Each exclusion name has a fixed length of
387 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
390 uint32_t nb_exclusions
;
394 * Data structure for the response from sessiond to the lttng client.
396 struct lttcomm_lttng_msg
{
397 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
398 uint32_t ret_code
; /* enum lttcomm_return_code */
399 uint32_t pid
; /* pid_t */
400 uint32_t cmd_header_size
;
404 struct lttcomm_lttng_output_id
{
409 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
410 * to either add a channel, add a stream, update a stream, or stop
413 struct lttcomm_consumer_msg
{
414 uint32_t cmd_type
; /* enum consumerd_command */
417 uint64_t channel_key
;
419 char pathname
[PATH_MAX
];
423 /* nb_init_streams is the number of streams open initially. */
424 uint32_t nb_init_streams
;
425 char name
[LTTNG_SYMBOL_NAME_LEN
];
426 /* Use splice or mmap to consume this fd */
427 enum lttng_event_output output
;
428 int type
; /* Per cpu or metadata. */
429 uint64_t tracefile_size
; /* bytes */
430 uint32_t tracefile_count
; /* number of tracefiles */
431 /* If the channel's streams have to be monitored or not. */
433 /* timer to check the streams usage in live mode (usec). */
434 unsigned int live_timer_interval
;
435 /* timer to sample a channel's positions (usec). */
436 unsigned int monitor_timer_interval
;
437 } LTTNG_PACKED channel
; /* Only used by Kernel. */
440 uint64_t channel_key
;
441 int32_t cpu
; /* On which CPU this stream is assigned. */
442 /* Tells the consumer if the stream should be or not monitored. */
444 } LTTNG_PACKED stream
; /* Only used by Kernel. */
447 enum lttng_stream_type type
;
448 /* Open socket to the relayd */
449 struct lttcomm_relayd_sock sock
;
450 /* Tracing session id associated to the relayd. */
452 /* Relayd session id, only used with control socket. */
453 uint64_t relayd_session_id
;
454 } LTTNG_PACKED relayd_sock
;
456 uint64_t net_seq_idx
;
457 } LTTNG_PACKED destroy_relayd
;
460 } LTTNG_PACKED data_pending
;
462 uint64_t subbuf_size
; /* bytes */
463 uint64_t num_subbuf
; /* power of 2 */
464 int32_t overwrite
; /* 1: overwrite, 0: discard */
465 uint32_t switch_timer_interval
; /* usec */
466 uint32_t read_timer_interval
; /* usec */
467 unsigned int live_timer_interval
; /* usec */
468 uint32_t monitor_timer_interval
; /* usec */
469 int32_t output
; /* splice, mmap */
470 int32_t type
; /* metadata or per_cpu */
471 uint64_t session_id
; /* Tracing session id */
472 char pathname
[PATH_MAX
]; /* Channel file path. */
473 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
474 uint32_t uid
; /* User ID of the session */
475 uint32_t gid
; /* Group ID ot the session */
476 uint64_t relayd_id
; /* Relayd id if apply. */
477 uint64_t key
; /* Unique channel key. */
478 unsigned char uuid
[UUID_LEN
]; /* uuid for ust tracer. */
479 uint32_t chan_id
; /* Channel ID on the tracer side. */
480 uint64_t tracefile_size
; /* bytes */
481 uint32_t tracefile_count
; /* number of tracefiles */
482 uint64_t session_id_per_pid
; /* Per-pid session ID. */
483 /* Tells the consumer if the stream should be or not monitored. */
486 * For UST per UID buffers, this is the application UID of the
487 * channel. This can be different from the user UID requesting the
488 * channel creation and used for the rights on the stream file
489 * because the application can be in the tracing for instance.
491 uint32_t ust_app_uid
;
492 int64_t blocking_timeout
;
493 char root_shm_path
[PATH_MAX
];
494 char shm_path
[PATH_MAX
];
495 } LTTNG_PACKED ask_channel
;
498 } LTTNG_PACKED get_channel
;
501 } LTTNG_PACKED destroy_channel
;
503 uint64_t key
; /* Metadata channel key. */
504 uint64_t target_offset
; /* Offset in the consumer */
505 uint64_t len
; /* Length of metadata to be received. */
506 uint64_t version
; /* Version of the metadata. */
507 } LTTNG_PACKED push_metadata
;
509 uint64_t key
; /* Metadata channel key. */
510 } LTTNG_PACKED close_metadata
;
512 uint64_t key
; /* Metadata channel key. */
513 } LTTNG_PACKED setup_metadata
;
515 uint64_t key
; /* Channel key. */
516 } LTTNG_PACKED flush_channel
;
518 uint64_t key
; /* Channel key. */
519 } LTTNG_PACKED clear_quiescent_channel
;
521 char pathname
[PATH_MAX
];
522 /* Indicate if the snapshot goes on the relayd or locally. */
524 uint32_t metadata
; /* This a metadata snapshot. */
525 uint64_t relayd_id
; /* Relayd id if apply. */
527 uint64_t nb_packets_per_stream
;
528 } LTTNG_PACKED snapshot_channel
;
530 uint64_t channel_key
;
531 uint64_t net_seq_idx
;
532 } LTTNG_PACKED sent_streams
;
535 uint64_t channel_key
;
536 } LTTNG_PACKED discarded_events
;
539 uint64_t channel_key
;
540 } LTTNG_PACKED lost_packets
;
543 } LTTNG_PACKED regenerate_metadata
;
546 } LTTNG_PACKED clear_channel
;
551 * Channel monitoring message returned to the session daemon on every
552 * monitor timer expiration.
554 struct lttcomm_consumer_channel_monitor_msg
{
555 /* Key of the sampled channel. */
558 * Lowest and highest usage (bytes) at the moment the sample was taken.
560 uint64_t lowest
, highest
;
564 * Status message returned to the sessiond after a received command.
566 struct lttcomm_consumer_status_msg
{
567 enum lttcomm_return_code ret_code
;
570 struct lttcomm_consumer_status_channel
{
571 enum lttcomm_return_code ret_code
;
573 unsigned int stream_count
;
576 #ifdef HAVE_LIBLTTNG_UST_CTL
578 #include <lttng/ust-abi.h>
581 * Data structure for the commands sent from sessiond to UST.
583 struct lttcomm_ust_msg
{
587 struct lttng_ust_channel channel
;
588 struct lttng_ust_stream stream
;
589 struct lttng_ust_event event
;
590 struct lttng_ust_context context
;
591 struct lttng_ust_tracer_version version
;
596 * Data structure for the response from UST to the session daemon.
597 * cmd_type is sent back in the reply for validation.
599 struct lttcomm_ust_reply
{
602 uint32_t ret_code
; /* enum lttcomm_return_code */
603 uint32_t ret_val
; /* return value */
606 uint64_t memory_map_size
;
607 } LTTNG_PACKED channel
;
609 uint64_t memory_map_size
;
610 } LTTNG_PACKED stream
;
611 struct lttng_ust_tracer_version version
;
615 #endif /* HAVE_LIBLTTNG_UST_CTL */
617 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
619 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
620 const char *ip
, unsigned int port
);
621 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
622 const char *ip
, unsigned int port
);
624 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
625 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
626 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
627 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
628 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
629 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
630 struct lttcomm_sock
*src
);
632 /* Relayd socket object. */
633 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
634 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
636 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
637 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
639 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
642 * Set a port to an lttcomm_sock. This will have no effect is the socket is
645 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
647 LTTNG_HIDDEN
void lttcomm_init(void);
648 /* Get network timeout, in milliseconds */
649 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
651 #endif /* _LTTNG_SESSIOND_COMM_H */