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 <lttng/rotate-internal.h>
35 #include <common/compat/socket.h>
36 #include <common/uri.h>
37 #include <common/defaults.h>
38 #include <common/compat/uuid.h>
40 #include <arpa/inet.h>
41 #include <netinet/in.h>
46 #include <common/unix.h>
48 /* Queue size of listen(2) */
49 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
51 /* Maximum number of FDs that can be sent over a Unix socket */
52 #define LTTCOMM_MAX_SEND_FDS 4
55 * Get the error code index from 0 since LTTCOMM_OK start at 1000
57 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
59 enum lttcomm_sessiond_command
{
61 LTTNG_ADD_CONTEXT
= 0,
62 /* LTTNG_CALIBRATE used to be here */
63 LTTNG_DISABLE_CHANNEL
= 2,
64 LTTNG_DISABLE_EVENT
= 3,
65 LTTNG_LIST_SYSCALLS
= 4,
66 LTTNG_ENABLE_CHANNEL
= 5,
67 LTTNG_ENABLE_EVENT
= 6,
69 /* Session daemon command */
70 LTTNG_CREATE_SESSION
= 8,
71 LTTNG_DESTROY_SESSION
= 9,
72 LTTNG_LIST_CHANNELS
= 10,
73 LTTNG_LIST_DOMAINS
= 11,
74 LTTNG_LIST_EVENTS
= 12,
75 LTTNG_LIST_SESSIONS
= 13,
76 LTTNG_LIST_TRACEPOINTS
= 14,
77 LTTNG_REGISTER_CONSUMER
= 15,
78 LTTNG_START_TRACE
= 16,
79 LTTNG_STOP_TRACE
= 17,
80 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
83 LTTNG_DISABLE_CONSUMER
= 19,
84 LTTNG_ENABLE_CONSUMER
= 20,
85 LTTNG_SET_CONSUMER_URI
= 21,
88 LTTNG_DATA_PENDING
= 24,
89 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
90 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
91 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
92 LTTNG_SNAPSHOT_RECORD
= 28,
93 LTTNG_CREATE_SESSION_SNAPSHOT
= 29,
94 LTTNG_CREATE_SESSION_LIVE
= 30,
95 LTTNG_SAVE_SESSION
= 31,
97 LTTNG_UNTRACK_PID
= 33,
98 LTTNG_LIST_TRACKER_PIDS
= 34,
99 LTTNG_SET_SESSION_SHM_PATH
= 40,
100 LTTNG_REGENERATE_METADATA
= 41,
101 LTTNG_REGENERATE_STATEDUMP
= 42,
102 LTTNG_REGISTER_TRIGGER
= 43,
103 LTTNG_UNREGISTER_TRIGGER
= 44,
104 LTTNG_ROTATE_SESSION
= 45,
105 LTTNG_ROTATE_PENDING
= 46,
108 enum lttcomm_relayd_command
{
109 RELAYD_ADD_STREAM
= 1,
110 RELAYD_CREATE_SESSION
= 2,
111 RELAYD_START_DATA
= 3,
112 RELAYD_UPDATE_SYNC_INFO
= 4,
114 RELAYD_SEND_METADATA
= 6,
115 RELAYD_CLOSE_STREAM
= 7,
116 RELAYD_DATA_PENDING
= 8,
117 RELAYD_QUIESCENT_CONTROL
= 9,
118 RELAYD_BEGIN_DATA_PENDING
= 10,
119 RELAYD_END_DATA_PENDING
= 11,
120 RELAYD_ADD_INDEX
= 12,
121 RELAYD_SEND_INDEX
= 13,
122 RELAYD_CLOSE_INDEX
= 14,
123 /* Live-reading commands (2.4+). */
124 RELAYD_LIST_SESSIONS
= 15,
125 /* All streams of the channel have been sent to the relayd (2.4+). */
126 RELAYD_STREAMS_SENT
= 16,
127 /* Ask the relay to reset the metadata trace file (2.8+) */
128 RELAYD_RESET_METADATA
= 17,
129 /* Ask the relay to rotate a stream file (2.11+) */
130 RELAYD_ROTATE_STREAM
= 18,
131 /* Rename a chunk after the rotation is completed (2.11+) */
132 RELAYD_ROTATE_RENAME
= 19,
133 /* Check if a chunk has data pending (2.11+) */
134 RELAYD_ROTATE_PENDING
= 20,
135 /* Create a folder on the relayd FS (2.11+) */
140 * lttcomm error code.
142 enum lttcomm_return_code
{
143 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
144 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 1, /* Command socket ready */
145 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
146 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
147 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
148 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
149 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
150 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
151 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
152 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
153 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
154 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
155 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
156 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
157 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
158 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
159 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
160 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
161 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
162 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
163 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
164 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
166 /* MUST be last element */
167 LTTCOMM_NR
, /* Last element */
170 /* lttng socket protocol. */
171 enum lttcomm_sock_proto
{
177 * Index in the net_families array below. Please keep in sync!
179 enum lttcomm_sock_domain
{
184 enum lttcomm_metadata_command
{
185 LTTCOMM_METADATA_REQUEST
= 1,
189 * Commands sent from the consumerd to the sessiond to request if new metadata
190 * is available. This message is used to find the per UID _or_ per PID registry
191 * for the channel key. For per UID lookup, the triplet
192 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
193 * per PID registry indexed by session id ignoring the other values.
195 struct lttcomm_metadata_request_msg
{
196 uint64_t session_id
; /* Tracing session id */
197 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
198 uint32_t bits_per_long
; /* Consumer ABI */
200 uint64_t key
; /* Metadata channel key. */
203 struct lttcomm_sockaddr
{
204 enum lttcomm_sock_domain type
;
206 struct sockaddr_in sin
;
207 struct sockaddr_in6 sin6
;
211 struct lttcomm_sock
{
213 enum lttcomm_sock_proto proto
;
214 struct lttcomm_sockaddr sockaddr
;
215 const struct lttcomm_proto_ops
*ops
;
219 * Relayd sock. Adds the protocol version to use for the communications with
222 struct lttcomm_relayd_sock
{
223 struct lttcomm_sock sock
;
228 struct lttcomm_net_family
{
230 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
233 struct lttcomm_proto_ops
{
234 int (*bind
) (struct lttcomm_sock
*sock
);
235 int (*close
) (struct lttcomm_sock
*sock
);
236 int (*connect
) (struct lttcomm_sock
*sock
);
237 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
238 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
239 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
241 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
242 size_t len
, int flags
);
246 * Data structure received from lttng client to session daemon.
248 struct lttcomm_session_msg
{
249 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
250 struct lttng_session session
;
251 struct lttng_domain domain
;
255 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
256 struct lttng_event event LTTNG_PACKED
;
257 /* Length of following filter expression. */
258 uint32_t expression_len
;
259 /* Length of following bytecode for filter. */
260 uint32_t bytecode_len
;
262 uint32_t exclusion_count
;
264 * After this structure, the following variable-length
265 * items are transmitted:
266 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
267 * - unsigned char filter_expression[expression_len]
268 * - unsigned char filter_bytecode[bytecode_len]
270 } LTTNG_PACKED enable
;
272 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
273 struct lttng_event event LTTNG_PACKED
;
274 /* Length of following filter expression. */
275 uint32_t expression_len
;
276 /* Length of following bytecode for filter. */
277 uint32_t bytecode_len
;
279 * After this structure, the following variable-length
280 * items are transmitted:
281 * - unsigned char filter_expression[expression_len]
282 * - unsigned char filter_bytecode[bytecode_len]
284 } LTTNG_PACKED disable
;
287 struct lttng_channel chan LTTNG_PACKED
;
288 /* struct lttng_channel_extended is already packed. */
289 struct lttng_channel_extended extended
;
290 } LTTNG_PACKED channel
;
293 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
294 struct lttng_event_context ctx LTTNG_PACKED
;
295 uint32_t provider_name_len
;
296 uint32_t context_name_len
;
297 } LTTNG_PACKED context
;
298 /* Use by register_consumer */
304 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
306 struct lttng_calibrate calibrate
;
307 /* Used by the set_consumer_url and used by create_session also call */
309 /* Number of lttng_uri following */
313 struct lttng_snapshot_output output LTTNG_PACKED
;
314 } LTTNG_PACKED snapshot_output
;
317 struct lttng_snapshot_output output LTTNG_PACKED
;
318 } LTTNG_PACKED snapshot_record
;
321 unsigned int timer_interval
; /* usec */
322 } LTTNG_PACKED session_live
;
324 struct lttng_save_session_attr attr
; /* struct already packed */
325 } LTTNG_PACKED save_session
;
327 char shm_path
[PATH_MAX
];
328 } LTTNG_PACKED set_shm_path
;
331 } LTTNG_PACKED pid_tracker
;
334 } LTTNG_PACKED trigger
;
337 } LTTNG_PACKED rotate_pending
;
341 #define LTTNG_FILTER_MAX_LEN 65536
344 * Filter bytecode data. The reloc table is located at the end of the
345 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
346 * starts at reloc_table_offset.
348 #define LTTNG_FILTER_PADDING 32
349 struct lttng_filter_bytecode
{
350 uint32_t len
; /* len of data */
351 uint32_t reloc_table_offset
;
353 char padding
[LTTNG_FILTER_PADDING
];
358 * Event exclusion data. At the end of the structure, there will actually
359 * by zero or more names, where the actual number of names is given by
360 * the 'count' item of the structure.
362 #define LTTNG_EVENT_EXCLUSION_PADDING 32
363 struct lttng_event_exclusion
{
365 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
366 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
369 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
370 (&(_exclusion)->names[_i][0])
373 * Event command header.
375 struct lttcomm_event_command_header
{
376 /* Number of events */
381 * Event extended info header. This is the structure preceding each
382 * extended info data.
384 struct lttcomm_event_extended_header
{
386 * Size of filter string immediately following this header.
387 * This size includes the terminal null character.
392 * Number of exclusion names, immediately following the filter
393 * string. Each exclusion name has a fixed length of
394 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
397 uint32_t nb_exclusions
;
401 * Data structure for the response from sessiond to the lttng client.
403 struct lttcomm_lttng_msg
{
404 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
405 uint32_t ret_code
; /* enum lttcomm_return_code */
406 uint32_t pid
; /* pid_t */
407 uint32_t cmd_header_size
;
411 struct lttcomm_lttng_output_id
{
416 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
417 * to either add a channel, add a stream, update a stream, or stop
420 struct lttcomm_consumer_msg
{
421 uint32_t cmd_type
; /* enum consumerd_command */
424 uint64_t channel_key
;
426 char pathname
[PATH_MAX
];
430 /* nb_init_streams is the number of streams open initially. */
431 uint32_t nb_init_streams
;
432 char name
[LTTNG_SYMBOL_NAME_LEN
];
433 /* Use splice or mmap to consume this fd */
434 enum lttng_event_output output
;
435 int type
; /* Per cpu or metadata. */
436 uint64_t tracefile_size
; /* bytes */
437 uint32_t tracefile_count
; /* number of tracefiles */
438 /* If the channel's streams have to be monitored or not. */
440 /* timer to check the streams usage in live mode (usec). */
441 unsigned int live_timer_interval
;
442 /* timer to sample a channel's positions (usec). */
443 unsigned int monitor_timer_interval
;
444 } LTTNG_PACKED channel
; /* Only used by Kernel. */
447 uint64_t channel_key
;
448 int32_t cpu
; /* On which CPU this stream is assigned. */
449 /* Tells the consumer if the stream should be or not monitored. */
451 } LTTNG_PACKED stream
; /* Only used by Kernel. */
454 enum lttng_stream_type type
;
455 /* Open socket to the relayd */
456 struct lttcomm_relayd_sock sock
;
457 /* Tracing session id associated to the relayd. */
459 /* Relayd session id, only used with control socket. */
460 uint64_t relayd_session_id
;
461 } LTTNG_PACKED relayd_sock
;
463 uint64_t net_seq_idx
;
464 } LTTNG_PACKED destroy_relayd
;
467 } LTTNG_PACKED data_pending
;
469 uint64_t subbuf_size
; /* bytes */
470 uint64_t num_subbuf
; /* power of 2 */
471 int32_t overwrite
; /* 1: overwrite, 0: discard */
472 uint32_t switch_timer_interval
; /* usec */
473 uint32_t read_timer_interval
; /* usec */
474 unsigned int live_timer_interval
; /* usec */
475 uint32_t monitor_timer_interval
; /* usec */
476 int32_t output
; /* splice, mmap */
477 int32_t type
; /* metadata or per_cpu */
478 uint64_t session_id
; /* Tracing session id */
479 char pathname
[PATH_MAX
]; /* Channel file path. */
480 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
481 uint32_t uid
; /* User ID of the session */
482 uint32_t gid
; /* Group ID ot the session */
483 uint64_t relayd_id
; /* Relayd id if apply. */
484 uint64_t key
; /* Unique channel key. */
485 unsigned char uuid
[UUID_LEN
]; /* uuid for ust tracer. */
486 uint32_t chan_id
; /* Channel ID on the tracer side. */
487 uint64_t tracefile_size
; /* bytes */
488 uint32_t tracefile_count
; /* number of tracefiles */
489 uint64_t session_id_per_pid
; /* Per-pid session ID. */
490 /* Tells the consumer if the stream should be or not monitored. */
493 * For UST per UID buffers, this is the application UID of the
494 * channel. This can be different from the user UID requesting the
495 * channel creation and used for the rights on the stream file
496 * because the application can be in the tracing for instance.
498 uint32_t ust_app_uid
;
499 int64_t blocking_timeout
;
500 char root_shm_path
[PATH_MAX
];
501 char shm_path
[PATH_MAX
];
502 } LTTNG_PACKED ask_channel
;
505 } LTTNG_PACKED get_channel
;
508 } LTTNG_PACKED destroy_channel
;
510 uint64_t key
; /* Metadata channel key. */
511 uint64_t target_offset
; /* Offset in the consumer */
512 uint64_t len
; /* Length of metadata to be received. */
513 uint64_t version
; /* Version of the metadata. */
514 } LTTNG_PACKED push_metadata
;
516 uint64_t key
; /* Metadata channel key. */
517 } LTTNG_PACKED close_metadata
;
519 uint64_t key
; /* Metadata channel key. */
520 } LTTNG_PACKED setup_metadata
;
522 uint64_t key
; /* Channel key. */
523 } LTTNG_PACKED flush_channel
;
525 uint64_t key
; /* Channel key. */
526 } LTTNG_PACKED clear_quiescent_channel
;
528 char pathname
[PATH_MAX
];
529 /* Indicate if the snapshot goes on the relayd or locally. */
531 uint32_t metadata
; /* This a metadata snapshot. */
532 uint64_t relayd_id
; /* Relayd id if apply. */
534 uint64_t nb_packets_per_stream
;
535 } LTTNG_PACKED snapshot_channel
;
537 uint64_t channel_key
;
538 uint64_t net_seq_idx
;
539 } LTTNG_PACKED sent_streams
;
542 uint64_t channel_key
;
543 } LTTNG_PACKED discarded_events
;
546 uint64_t channel_key
;
547 } LTTNG_PACKED lost_packets
;
550 } LTTNG_PACKED regenerate_metadata
;
552 char pathname
[PATH_MAX
];
553 uint32_t metadata
; /* This is a metadata channel. */
554 uint64_t relayd_id
; /* Relayd id if apply. */
556 uint64_t new_chunk_id
;
557 } LTTNG_PACKED rotate_channel
;
559 char old_path
[LTTNG_PATH_MAX
];
560 char new_path
[LTTNG_PATH_MAX
];
561 uint64_t relayd_id
; /* Relayd id if apply. */
565 } LTTNG_PACKED rotate_rename
;
570 } LTTNG_PACKED rotate_pending_relay
;
572 char path
[LTTNG_PATH_MAX
];
573 uint64_t relayd_id
; /* Relayd id if apply. */
577 } LTTNG_PACKED mkdir
;
582 * Channel monitoring message returned to the session daemon on every
583 * monitor timer expiration.
585 struct lttcomm_consumer_channel_monitor_msg
{
586 /* Key of the sampled channel. */
589 * Lowest and highest usage (bytes) at the moment the sample was taken.
591 uint64_t lowest
, highest
;
595 * Status message returned to the sessiond after a received command.
597 struct lttcomm_consumer_status_msg
{
598 enum lttcomm_return_code ret_code
;
601 struct lttcomm_consumer_status_channel
{
602 enum lttcomm_return_code ret_code
;
604 unsigned int stream_count
;
607 #ifdef HAVE_LIBLTTNG_UST_CTL
609 #include <lttng/ust-abi.h>
612 * Data structure for the commands sent from sessiond to UST.
614 struct lttcomm_ust_msg
{
618 struct lttng_ust_channel channel
;
619 struct lttng_ust_stream stream
;
620 struct lttng_ust_event event
;
621 struct lttng_ust_context context
;
622 struct lttng_ust_tracer_version version
;
627 * Data structure for the response from UST to the session daemon.
628 * cmd_type is sent back in the reply for validation.
630 struct lttcomm_ust_reply
{
633 uint32_t ret_code
; /* enum lttcomm_return_code */
634 uint32_t ret_val
; /* return value */
637 uint64_t memory_map_size
;
638 } LTTNG_PACKED channel
;
640 uint64_t memory_map_size
;
641 } LTTNG_PACKED stream
;
642 struct lttng_ust_tracer_version version
;
646 #endif /* HAVE_LIBLTTNG_UST_CTL */
648 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
650 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
651 const char *ip
, unsigned int port
);
652 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
653 const char *ip
, unsigned int port
);
655 extern struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
656 extern int lttcomm_create_sock(struct lttcomm_sock
*sock
);
657 extern struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
658 extern void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
659 extern struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
660 extern void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
661 struct lttcomm_sock
*src
);
663 /* Relayd socket object. */
664 extern struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
665 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
667 extern int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
668 extern int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
670 extern void lttcomm_init(void);
671 /* Get network timeout, in milliseconds */
672 extern unsigned long lttcomm_get_network_timeout(void);
674 #endif /* _LTTNG_SESSIOND_COMM_H */