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/trigger/trigger-internal.h>
33 #include <common/compat/socket.h>
34 #include <common/uri.h>
35 #include <common/defaults.h>
36 #include <common/compat/uuid.h>
38 #include <arpa/inet.h>
39 #include <netinet/in.h>
44 #include <common/unix.h>
46 /* Queue size of listen(2) */
47 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
49 /* Maximum number of FDs that can be sent over a Unix socket */
50 #define LTTCOMM_MAX_SEND_FDS 4
53 * Get the error code index from 0 since LTTCOMM_OK start at 1000
55 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
57 enum lttcomm_sessiond_command
{
59 LTTNG_ADD_CONTEXT
= 0,
60 /* LTTNG_CALIBRATE used to be here */
61 LTTNG_DISABLE_CHANNEL
= 2,
62 LTTNG_DISABLE_EVENT
= 3,
63 LTTNG_LIST_SYSCALLS
= 4,
64 LTTNG_ENABLE_CHANNEL
= 5,
65 LTTNG_ENABLE_EVENT
= 6,
67 /* Session daemon command */
68 LTTNG_CREATE_SESSION
= 8,
69 LTTNG_DESTROY_SESSION
= 9,
70 LTTNG_LIST_CHANNELS
= 10,
71 LTTNG_LIST_DOMAINS
= 11,
72 LTTNG_LIST_EVENTS
= 12,
73 LTTNG_LIST_SESSIONS
= 13,
74 LTTNG_LIST_TRACEPOINTS
= 14,
75 LTTNG_REGISTER_CONSUMER
= 15,
76 LTTNG_START_TRACE
= 16,
77 LTTNG_STOP_TRACE
= 17,
78 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
81 LTTNG_DISABLE_CONSUMER
= 19,
82 LTTNG_ENABLE_CONSUMER
= 20,
83 LTTNG_SET_CONSUMER_URI
= 21,
86 LTTNG_DATA_PENDING
= 24,
87 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
88 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
89 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
90 LTTNG_SNAPSHOT_RECORD
= 28,
91 LTTNG_CREATE_SESSION_SNAPSHOT
= 29,
92 LTTNG_CREATE_SESSION_LIVE
= 30,
93 LTTNG_SAVE_SESSION
= 31,
95 LTTNG_UNTRACK_PID
= 33,
96 LTTNG_LIST_TRACKER_PIDS
= 34,
97 LTTNG_SET_SESSION_SHM_PATH
= 40,
98 LTTNG_REGENERATE_METADATA
= 41,
99 LTTNG_REGENERATE_STATEDUMP
= 42,
100 LTTNG_REGISTER_TRIGGER
= 43,
101 LTTNG_UNREGISTER_TRIGGER
= 44,
104 enum lttcomm_relayd_command
{
105 RELAYD_ADD_STREAM
= 1,
106 RELAYD_CREATE_SESSION
= 2,
107 RELAYD_START_DATA
= 3,
108 RELAYD_UPDATE_SYNC_INFO
= 4,
110 RELAYD_SEND_METADATA
= 6,
111 RELAYD_CLOSE_STREAM
= 7,
112 RELAYD_DATA_PENDING
= 8,
113 RELAYD_QUIESCENT_CONTROL
= 9,
114 RELAYD_BEGIN_DATA_PENDING
= 10,
115 RELAYD_END_DATA_PENDING
= 11,
116 RELAYD_ADD_INDEX
= 12,
117 RELAYD_SEND_INDEX
= 13,
118 RELAYD_CLOSE_INDEX
= 14,
119 /* Live-reading commands (2.4+). */
120 RELAYD_LIST_SESSIONS
= 15,
121 /* All streams of the channel have been sent to the relayd (2.4+). */
122 RELAYD_STREAMS_SENT
= 16,
123 /* Ask the relay to reset the metadata trace file (2.8+) */
124 RELAYD_RESET_METADATA
= 17,
128 * lttcomm error code.
130 enum lttcomm_return_code
{
131 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
132 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 1, /* Command socket ready */
133 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
134 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
135 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
136 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
137 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
138 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
139 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
140 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
141 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
142 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
143 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
144 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
145 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
146 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
147 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
148 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
149 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
150 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
151 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
152 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
154 /* MUST be last element */
155 LTTCOMM_NR
, /* Last element */
158 /* lttng socket protocol. */
159 enum lttcomm_sock_proto
{
165 * Index in the net_families array below. Please keep in sync!
167 enum lttcomm_sock_domain
{
172 enum lttcomm_metadata_command
{
173 LTTCOMM_METADATA_REQUEST
= 1,
177 * Commands sent from the consumerd to the sessiond to request if new metadata
178 * is available. This message is used to find the per UID _or_ per PID registry
179 * for the channel key. For per UID lookup, the triplet
180 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
181 * per PID registry indexed by session id ignoring the other values.
183 struct lttcomm_metadata_request_msg
{
184 uint64_t session_id
; /* Tracing session id */
185 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
186 uint32_t bits_per_long
; /* Consumer ABI */
188 uint64_t key
; /* Metadata channel key. */
191 struct lttcomm_sockaddr
{
192 enum lttcomm_sock_domain type
;
194 struct sockaddr_in sin
;
195 struct sockaddr_in6 sin6
;
199 struct lttcomm_sock
{
201 enum lttcomm_sock_proto proto
;
202 struct lttcomm_sockaddr sockaddr
;
203 const struct lttcomm_proto_ops
*ops
;
207 * Relayd sock. Adds the protocol version to use for the communications with
210 struct lttcomm_relayd_sock
{
211 struct lttcomm_sock sock
;
216 struct lttcomm_net_family
{
218 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
221 struct lttcomm_proto_ops
{
222 int (*bind
) (struct lttcomm_sock
*sock
);
223 int (*close
) (struct lttcomm_sock
*sock
);
224 int (*connect
) (struct lttcomm_sock
*sock
);
225 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
226 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
227 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
229 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
230 size_t len
, int flags
);
234 * Data structure received from lttng client to session daemon.
236 struct lttcomm_session_msg
{
237 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
238 struct lttng_session session
;
239 struct lttng_domain domain
;
243 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
244 struct lttng_event event LTTNG_PACKED
;
245 /* Length of following filter expression. */
246 uint32_t expression_len
;
247 /* Length of following bytecode for filter. */
248 uint32_t bytecode_len
;
250 uint32_t exclusion_count
;
252 * After this structure, the following variable-length
253 * items are transmitted:
254 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
255 * - unsigned char filter_expression[expression_len]
256 * - unsigned char filter_bytecode[bytecode_len]
258 } LTTNG_PACKED enable
;
260 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
261 struct lttng_event event LTTNG_PACKED
;
262 /* Length of following filter expression. */
263 uint32_t expression_len
;
264 /* Length of following bytecode for filter. */
265 uint32_t bytecode_len
;
267 * After this structure, the following variable-length
268 * items are transmitted:
269 * - unsigned char filter_expression[expression_len]
270 * - unsigned char filter_bytecode[bytecode_len]
272 } LTTNG_PACKED disable
;
275 struct lttng_channel chan LTTNG_PACKED
;
276 } LTTNG_PACKED channel
;
279 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
280 struct lttng_event_context ctx LTTNG_PACKED
;
281 uint32_t provider_name_len
;
282 uint32_t context_name_len
;
283 } LTTNG_PACKED context
;
284 /* Use by register_consumer */
290 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
292 struct lttng_calibrate calibrate
;
293 /* Used by the set_consumer_url and used by create_session also call */
295 /* Number of lttng_uri following */
299 struct lttng_snapshot_output output LTTNG_PACKED
;
300 } LTTNG_PACKED snapshot_output
;
303 struct lttng_snapshot_output output LTTNG_PACKED
;
304 } LTTNG_PACKED snapshot_record
;
307 unsigned int timer_interval
; /* usec */
308 } LTTNG_PACKED session_live
;
310 struct lttng_save_session_attr attr
; /* struct already packed */
311 } LTTNG_PACKED save_session
;
313 char shm_path
[PATH_MAX
];
314 } LTTNG_PACKED set_shm_path
;
317 } LTTNG_PACKED pid_tracker
;
320 } LTTNG_PACKED trigger
;
324 #define LTTNG_FILTER_MAX_LEN 65536
327 * Filter bytecode data. The reloc table is located at the end of the
328 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
329 * starts at reloc_table_offset.
331 #define LTTNG_FILTER_PADDING 32
332 struct lttng_filter_bytecode
{
333 uint32_t len
; /* len of data */
334 uint32_t reloc_table_offset
;
336 char padding
[LTTNG_FILTER_PADDING
];
341 * Event exclusion data. At the end of the structure, there will actually
342 * by zero or more names, where the actual number of names is given by
343 * the 'count' item of the structure.
345 #define LTTNG_EVENT_EXCLUSION_PADDING 32
346 struct lttng_event_exclusion
{
348 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
349 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
352 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
353 (&(_exclusion)->names[_i][0])
356 * Event command header.
358 struct lttcomm_event_command_header
{
359 /* Number of events */
364 * Event extended info header. This is the structure preceding each
365 * extended info data.
367 struct lttcomm_event_extended_header
{
369 * Size of filter string immediately following this header.
370 * This size includes the terminal null character.
375 * Number of exclusion names, immediately following the filter
376 * string. Each exclusion name has a fixed length of
377 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
380 uint32_t nb_exclusions
;
384 * Channel extended info.
386 struct lttcomm_channel_extended
{
387 uint64_t discarded_events
;
388 uint64_t lost_packets
;
392 * Data structure for the response from sessiond to the lttng client.
394 struct lttcomm_lttng_msg
{
395 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
396 uint32_t ret_code
; /* enum lttcomm_return_code */
397 uint32_t pid
; /* pid_t */
398 uint32_t cmd_header_size
;
402 struct lttcomm_lttng_output_id
{
407 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
408 * to either add a channel, add a stream, update a stream, or stop
411 struct lttcomm_consumer_msg
{
412 uint32_t cmd_type
; /* enum consumerd_command */
415 uint64_t channel_key
;
417 char pathname
[PATH_MAX
];
421 /* nb_init_streams is the number of streams open initially. */
422 uint32_t nb_init_streams
;
423 char name
[LTTNG_SYMBOL_NAME_LEN
];
424 /* Use splice or mmap to consume this fd */
425 enum lttng_event_output output
;
426 int type
; /* Per cpu or metadata. */
427 uint64_t tracefile_size
; /* bytes */
428 uint32_t tracefile_count
; /* number of tracefiles */
429 /* If the channel's streams have to be monitored or not. */
431 /* timer to check the streams usage in live mode (usec). */
432 unsigned int live_timer_interval
;
433 } LTTNG_PACKED channel
; /* Only used by Kernel. */
436 uint64_t channel_key
;
437 int32_t cpu
; /* On which CPU this stream is assigned. */
438 /* Tells the consumer if the stream should be or not monitored. */
440 } LTTNG_PACKED stream
; /* Only used by Kernel. */
443 enum lttng_stream_type type
;
444 /* Open socket to the relayd */
445 struct lttcomm_relayd_sock sock
;
446 /* Tracing session id associated to the relayd. */
448 /* Relayd session id, only used with control socket. */
449 uint64_t relayd_session_id
;
450 } LTTNG_PACKED relayd_sock
;
452 uint64_t net_seq_idx
;
453 } LTTNG_PACKED destroy_relayd
;
456 } LTTNG_PACKED data_pending
;
458 uint64_t subbuf_size
; /* bytes */
459 uint64_t num_subbuf
; /* power of 2 */
460 int32_t overwrite
; /* 1: overwrite, 0: discard */
461 uint32_t switch_timer_interval
; /* usec */
462 uint32_t read_timer_interval
; /* usec */
463 unsigned int live_timer_interval
; /* usec */
464 uint32_t monitor_timer_interval
; /* usec */
465 int32_t output
; /* splice, mmap */
466 int32_t type
; /* metadata or per_cpu */
467 uint64_t session_id
; /* Tracing session id */
468 char pathname
[PATH_MAX
]; /* Channel file path. */
469 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
470 uint32_t uid
; /* User ID of the session */
471 uint32_t gid
; /* Group ID ot the session */
472 uint64_t relayd_id
; /* Relayd id if apply. */
473 uint64_t key
; /* Unique channel key. */
474 unsigned char uuid
[UUID_LEN
]; /* uuid for ust tracer. */
475 uint32_t chan_id
; /* Channel ID on the tracer side. */
476 uint64_t tracefile_size
; /* bytes */
477 uint32_t tracefile_count
; /* number of tracefiles */
478 uint64_t session_id_per_pid
; /* Per-pid session ID. */
479 /* Tells the consumer if the stream should be or not monitored. */
482 * For UST per UID buffers, this is the application UID of the
483 * channel. This can be different from the user UID requesting the
484 * channel creation and used for the rights on the stream file
485 * because the application can be in the tracing for instance.
487 uint32_t ust_app_uid
;
488 char root_shm_path
[PATH_MAX
];
489 char shm_path
[PATH_MAX
];
490 } LTTNG_PACKED ask_channel
;
493 } LTTNG_PACKED get_channel
;
496 } LTTNG_PACKED destroy_channel
;
498 uint64_t key
; /* Metadata channel key. */
499 uint64_t target_offset
; /* Offset in the consumer */
500 uint64_t len
; /* Length of metadata to be received. */
501 uint64_t version
; /* Version of the metadata. */
502 } LTTNG_PACKED push_metadata
;
504 uint64_t key
; /* Metadata channel key. */
505 } LTTNG_PACKED close_metadata
;
507 uint64_t key
; /* Metadata channel key. */
508 } LTTNG_PACKED setup_metadata
;
510 uint64_t key
; /* Channel key. */
511 } LTTNG_PACKED flush_channel
;
513 uint64_t key
; /* Channel key. */
514 } LTTNG_PACKED clear_quiescent_channel
;
516 char pathname
[PATH_MAX
];
517 /* Indicate if the snapshot goes on the relayd or locally. */
519 uint32_t metadata
; /* This a metadata snapshot. */
520 uint64_t relayd_id
; /* Relayd id if apply. */
522 uint64_t nb_packets_per_stream
;
523 } LTTNG_PACKED snapshot_channel
;
525 uint64_t channel_key
;
526 uint64_t net_seq_idx
;
527 } LTTNG_PACKED sent_streams
;
530 uint64_t channel_key
;
531 } LTTNG_PACKED discarded_events
;
534 uint64_t channel_key
;
535 } LTTNG_PACKED lost_packets
;
538 } LTTNG_PACKED regenerate_metadata
;
543 * Channel monitoring message returned to the session daemon on every
544 * monitor timer expiration.
546 struct lttcomm_consumer_channel_monitor_msg
{
547 /* Key of the sampled channel. */
550 * Lowest and highest usage (bytes) at the moment the sample was taken.
552 uint64_t lowest
, highest
;
556 * Status message returned to the sessiond after a received command.
558 struct lttcomm_consumer_status_msg
{
559 enum lttcomm_return_code ret_code
;
562 struct lttcomm_consumer_status_channel
{
563 enum lttcomm_return_code ret_code
;
565 unsigned int stream_count
;
568 #ifdef HAVE_LIBLTTNG_UST_CTL
570 #include <lttng/ust-abi.h>
573 * Data structure for the commands sent from sessiond to UST.
575 struct lttcomm_ust_msg
{
579 struct lttng_ust_channel channel
;
580 struct lttng_ust_stream stream
;
581 struct lttng_ust_event event
;
582 struct lttng_ust_context context
;
583 struct lttng_ust_tracer_version version
;
588 * Data structure for the response from UST to the session daemon.
589 * cmd_type is sent back in the reply for validation.
591 struct lttcomm_ust_reply
{
594 uint32_t ret_code
; /* enum lttcomm_return_code */
595 uint32_t ret_val
; /* return value */
598 uint64_t memory_map_size
;
599 } LTTNG_PACKED channel
;
601 uint64_t memory_map_size
;
602 } LTTNG_PACKED stream
;
603 struct lttng_ust_tracer_version version
;
607 #endif /* HAVE_LIBLTTNG_UST_CTL */
609 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
611 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
612 const char *ip
, unsigned int port
);
613 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
614 const char *ip
, unsigned int port
);
616 extern struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
617 extern int lttcomm_create_sock(struct lttcomm_sock
*sock
);
618 extern struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
619 extern void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
620 extern struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
621 extern void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
622 struct lttcomm_sock
*src
);
624 /* Relayd socket object. */
625 extern struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
626 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
628 extern int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
629 extern int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
631 extern void lttcomm_init(void);
632 /* Get network timeout, in milliseconds */
633 extern unsigned long lttcomm_get_network_timeout(void);
635 #endif /* _LTTNG_SESSIOND_COMM_H */