2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@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.
20 #ifndef LIB_CONSUMER_H
21 #define LIB_CONSUMER_H
26 #include <urcu/list.h>
28 #include <lttng/lttng.h>
30 #include <common/hashtable/hashtable.h>
31 #include <common/compat/fcntl.h>
32 #include <common/compat/uuid.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
34 #include <common/pipe.h>
35 #include <common/index/lttng-index.h>
37 /* Commands for consumer */
38 enum lttng_consumer_command
{
39 LTTNG_CONSUMER_ADD_CHANNEL
,
40 LTTNG_CONSUMER_ADD_STREAM
,
41 /* pause, delete, active depending on fd state */
42 LTTNG_CONSUMER_UPDATE_STREAM
,
43 /* inform the consumer to quit when all fd has hang up */
45 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
46 /* Inform the consumer to kill a specific relayd connection */
47 LTTNG_CONSUMER_DESTROY_RELAYD
,
48 /* Return to the sessiond if there is data pending for a session */
49 LTTNG_CONSUMER_DATA_PENDING
,
50 /* Consumer creates a channel and returns it to sessiond. */
51 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
52 LTTNG_CONSUMER_GET_CHANNEL
,
53 LTTNG_CONSUMER_DESTROY_CHANNEL
,
54 LTTNG_CONSUMER_PUSH_METADATA
,
55 LTTNG_CONSUMER_CLOSE_METADATA
,
56 LTTNG_CONSUMER_SETUP_METADATA
,
57 LTTNG_CONSUMER_FLUSH_CHANNEL
,
58 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
59 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
62 /* State of each fd in consumer */
63 enum lttng_consumer_stream_state
{
64 LTTNG_CONSUMER_ACTIVE_STREAM
,
65 LTTNG_CONSUMER_PAUSE_STREAM
,
66 LTTNG_CONSUMER_DELETE_STREAM
,
69 enum lttng_consumer_type
{
70 LTTNG_CONSUMER_UNKNOWN
= 0,
71 LTTNG_CONSUMER_KERNEL
,
76 enum consumer_endpoint_status
{
77 CONSUMER_ENDPOINT_ACTIVE
,
78 CONSUMER_ENDPOINT_INACTIVE
,
81 enum consumer_channel_output
{
82 CONSUMER_CHANNEL_MMAP
= 0,
83 CONSUMER_CHANNEL_SPLICE
= 1,
86 enum consumer_channel_type
{
87 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
88 CONSUMER_CHANNEL_TYPE_DATA
= 1,
91 extern struct lttng_consumer_global_data consumer_data
;
94 struct cds_list_head head
;
99 struct consumer_metadata_cache
;
101 struct lttng_consumer_channel
{
102 /* HT node used for consumer_data.channel_ht */
103 struct lttng_ht_node_u64 node
;
104 /* Indexed key. Incremented value in the consumer. */
106 /* Number of streams referencing this channel */
108 /* Tracing session id on the session daemon side. */
111 * Session id when requesting metadata to the session daemon for
112 * a session with per-PID buffers.
114 uint64_t session_id_per_pid
;
115 /* Channel trace file path name. */
116 char pathname
[PATH_MAX
];
118 char name
[LTTNG_SYMBOL_NAME_LEN
];
119 /* UID and GID of the session owning this channel. */
122 /* Relayd id of the channel. -1ULL if it does not apply. */
125 * Number of streams NOT initialized yet. This is used in order to not
126 * delete this channel if streams are getting initialized.
128 unsigned int nb_init_stream_left
;
129 /* Output type (mmap or splice). */
130 enum consumer_channel_output output
;
131 /* Channel type for stream */
132 enum consumer_channel_type type
;
135 uid_t ust_app_uid
; /* Application UID. */
136 struct ustctl_consumer_channel
*uchan
;
137 unsigned char uuid
[UUID_STR_LEN
];
139 * Temporary stream list used to store the streams once created and waiting
140 * to be sent to the session daemon by receiving the
141 * LTTNG_CONSUMER_GET_CHANNEL.
143 struct stream_list streams
;
146 * Set if the channel is metadata. We keep a reference to the stream
147 * because we have to flush data once pushed by the session daemon. For a
148 * regular channel, this is always set to NULL.
150 struct lttng_consumer_stream
*metadata_stream
;
154 /* Node within channel thread ht */
155 struct lttng_ht_node_u64 wait_fd_node
;
157 /* Metadata cache is metadata channel */
158 struct consumer_metadata_cache
*metadata_cache
;
159 /* For UST metadata periodical flush */
160 int switch_timer_enabled
;
161 timer_t switch_timer
;
162 int switch_timer_error
;
164 /* For the live mode */
165 int live_timer_enabled
;
167 int live_timer_error
;
169 /* On-disk circular buffer */
170 uint64_t tracefile_size
;
171 uint64_t tracefile_count
;
173 * Monitor or not the streams of this channel meaning this indicates if the
174 * streams should be sent to the data/metadata thread or added to the no
175 * monitor list of the channel.
177 unsigned int monitor
;
182 * This lock protects against concurrent update of channel.
184 * This is nested INSIDE the consumer data lock.
185 * This is nested OUTSIDE the channel timer lock.
186 * This is nested OUTSIDE the metadata cache lock.
187 * This is nested OUTSIDE stream lock.
188 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
190 pthread_mutex_t lock
;
193 * Channel teardown lock.
195 * This lock protect against teardown of channel. It is _never_
196 * taken by the timer handler.
198 * This is nested INSIDE the consumer data lock.
199 * This is nested INSIDE the channel lock.
200 * This is nested OUTSIDE the metadata cache lock.
201 * This is nested OUTSIDE stream lock.
202 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
204 pthread_mutex_t timer_lock
;
206 /* Timer value in usec for live streaming. */
207 unsigned int live_timer_interval
;
211 * Internal representation of the streams, sessiond_key is used to identify
214 struct lttng_consumer_stream
{
215 /* HT node used by the data_ht and metadata_ht */
216 struct lttng_ht_node_u64 node
;
217 /* stream indexed per channel key node */
218 struct lttng_ht_node_u64 node_channel_id
;
219 /* HT node used in consumer_data.stream_list_ht */
220 struct lttng_ht_node_u64 node_session_id
;
221 /* Pointer to associated channel. */
222 struct lttng_consumer_channel
*chan
;
224 /* Key by which the stream is indexed for 'node'. */
227 * File descriptor of the data output file. This can be either a file or a
228 * socket fd for relayd streaming.
230 int out_fd
; /* output file to write the data */
231 /* Write position in the output file descriptor */
233 /* Amount of bytes written to the output */
234 uint64_t output_written
;
235 enum lttng_consumer_stream_state state
;
238 int hangup_flush_done
;
239 enum lttng_event_output output
;
240 /* Maximum subbuffer size. */
241 unsigned long max_sb_size
;
244 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
245 * used for the mmap base and offset.
248 unsigned long mmap_len
;
253 /* UID/GID of the user owning the session to which stream belongs */
256 /* Network sequence number. Indicating on which relayd socket it goes. */
257 uint64_t net_seq_idx
;
259 * Indicate if this stream was successfully sent to a relayd. This is set
260 * after the refcount of the relayd is incremented and is checked when the
261 * stream is closed before decrementing the refcount in order to avoid an
264 unsigned int sent_to_relayd
;
266 /* Identify if the stream is the metadata */
267 unsigned int metadata_flag
;
268 /* Used when the stream is set for network streaming */
269 uint64_t relayd_stream_id
;
271 * When sending a stream packet to a relayd, this number is used to track
272 * the packet sent by the consumer and seen by the relayd. When sending the
273 * data header to the relayd, this number is sent and if the transmission
274 * was successful, it is incremented.
276 * Even if the full data is not fully transmitted it won't matter since
277 * only two possible error can happen after that where either the relayd
278 * died or a read error is detected on the stream making this value useless
281 * This value SHOULD be read/updated atomically or with the lock acquired.
283 uint64_t next_net_seq_num
;
285 * Lock to use the stream FDs since they are used between threads.
287 * This is nested INSIDE the consumer_data lock.
288 * This is nested INSIDE the metadata cache lock.
289 * This is nested INSIDE the channel lock.
290 * This is nested INSIDE the channel timer lock.
291 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
293 pthread_mutex_t lock
;
294 /* Tracing session id */
297 * Indicates if the stream end point is still active or not (network
298 * streaming or local file system). The thread "owning" the stream is
299 * handling this status and can be notified of a state change through the
300 * consumer data appropriate pipe.
302 enum consumer_endpoint_status endpoint_status
;
303 /* Stream name. Format is: <channel_name>_<cpu_number> */
304 char name
[LTTNG_SYMBOL_NAME_LEN
];
305 /* Internal state of libustctl. */
306 struct ustctl_consumer_stream
*ustream
;
307 struct cds_list_head send_node
;
308 /* On-disk circular buffer */
309 uint64_t tracefile_size_current
;
310 uint64_t tracefile_count_current
;
312 * Monitor or not the streams of this channel meaning this indicates if the
313 * streams should be sent to the data/metadata thread or added to the no
314 * monitor list of the channel.
316 unsigned int monitor
;
318 * Indicate if the stream is globally visible meaning that it has been
319 * added to the multiple hash tables. If *not* set, NO lock should be
320 * acquired in the destroy path.
322 unsigned int globally_visible
;
324 * Pipe to wake up the metadata poll thread when the UST metadata
327 int ust_metadata_poll_pipe
[2];
329 * How much metadata was read from the metadata cache and sent
332 uint64_t ust_metadata_pushed
;
334 * FD of the index file for this stream.
340 * Internal representation of a relayd socket pair.
342 struct consumer_relayd_sock_pair
{
343 /* Network sequence number. */
344 uint64_t net_seq_idx
;
345 /* Number of stream associated with this relayd */
346 unsigned int refcount
;
349 * This flag indicates whether or not we should destroy this object. The
350 * destruction should ONLY occurs when this flag is set and the refcount is
353 unsigned int destroy_flag
;
356 * Mutex protecting the control socket to avoid out of order packets
357 * between threads sending data to the relayd. Since metadata data is sent
358 * over that socket, at least two sendmsg() are needed (header + data)
359 * creating a race for packets to overlap between threads using it.
361 * This is nested INSIDE the consumer_data lock.
362 * This is nested INSIDE the stream lock.
364 pthread_mutex_t ctrl_sock_mutex
;
366 /* Control socket. Command and metadata are passed over it */
367 struct lttcomm_relayd_sock control_sock
;
370 * We don't need a mutex at this point since we only splice or write single
371 * large chunk of data with a header appended at the begining. Moreover,
372 * this socket is for now only used in a single thread.
374 struct lttcomm_relayd_sock data_sock
;
375 struct lttng_ht_node_u64 node
;
377 /* Session id on both sides for the sockets. */
378 uint64_t relayd_session_id
;
379 uint64_t sessiond_session_id
;
383 * UST consumer local data to the program. One or more instance per
386 struct lttng_consumer_local_data
{
388 * Function to call when data is available on a buffer.
389 * Returns the number of bytes read, or negative error value.
391 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
392 struct lttng_consumer_local_data
*ctx
);
394 * function to call when we receive a new channel, it receives a
395 * newly allocated channel, depending on the return code of this
396 * function, the new channel will be handled by the application
400 * > 0 (success, FD is kept by application)
401 * == 0 (success, FD is left to library)
404 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
406 * function to call when we receive a new stream, it receives a
407 * newly allocated stream, depending on the return code of this
408 * function, the new stream will be handled by the application
412 * > 0 (success, FD is kept by application)
413 * == 0 (success, FD is left to library)
416 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
418 * function to call when a stream is getting updated by the session
419 * daemon, this function receives the sessiond key and the new
420 * state, depending on the return code of this function the
421 * update of state for the stream is handled by the application
425 * > 0 (success, FD is kept by application)
426 * == 0 (success, FD is left to library)
429 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
430 enum lttng_consumer_type type
;
431 /* socket to communicate errors with sessiond */
432 int consumer_error_socket
;
433 /* socket to ask metadata to sessiond. */
434 int consumer_metadata_socket
;
436 * Protect consumer_metadata_socket.
438 * This is nested OUTSIDE the metadata cache lock.
440 pthread_mutex_t metadata_socket_lock
;
441 /* socket to exchange commands with sessiond */
442 char *consumer_command_sock_path
;
443 /* communication with splice */
444 int consumer_thread_pipe
[2];
445 int consumer_channel_pipe
[2];
446 int consumer_splice_metadata_pipe
[2];
447 /* Data stream poll thread pipe. To transfer data stream to the thread */
448 struct lttng_pipe
*consumer_data_pipe
;
449 /* to let the signal handler wake up the fd receiver thread */
450 int consumer_should_quit
[2];
451 /* Metadata poll thread pipe. Transfer metadata stream to it */
452 struct lttng_pipe
*consumer_metadata_pipe
;
456 * Library-level data. One instance per process.
458 struct lttng_consumer_global_data
{
460 * At this time, this lock is used to ensure coherence between the count
461 * and number of element in the hash table. It's also a protection for
462 * concurrent read/write between threads.
464 * This is nested OUTSIDE the stream lock.
465 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
467 pthread_mutex_t lock
;
470 * Number of streams in the data stream hash table declared outside.
471 * Protected by consumer_data.lock.
475 /* Channel hash table protected by consumer_data.lock. */
476 struct lttng_ht
*channel_ht
;
478 * Flag specifying if the local array of FDs needs update in the
479 * poll function. Protected by consumer_data.lock.
481 unsigned int need_update
;
482 enum lttng_consumer_type type
;
485 * Relayd socket(s) hashtable indexed by network sequence number. Each
486 * stream has an index which associate the right relayd socket to use.
488 struct lttng_ht
*relayd_ht
;
491 * This hash table contains all streams (metadata and data) indexed by
492 * session id. In other words, the ht is indexed by session id and each
493 * bucket contains the list of associated streams.
495 * This HT uses the "node_session_id" of the consumer stream.
497 struct lttng_ht
*stream_list_ht
;
500 * This HT uses the "node_channel_id" of the consumer stream.
502 struct lttng_ht
*stream_per_chan_id_ht
;
506 * Init consumer data structures.
508 void lttng_consumer_init(void);
511 * Set the error socket for communication with a session daemon.
513 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
517 * Set the command socket path for communication with a session daemon.
519 void lttng_consumer_set_command_sock_path(
520 struct lttng_consumer_local_data
*ctx
, char *sock
);
523 * Send return code to session daemon.
525 * Returns the return code of sendmsg : the number of bytes transmitted or -1
528 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
531 * Called from signal handler to ensure a clean exit.
533 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
536 * Cleanup the daemon's socket on exit.
538 void lttng_consumer_cleanup(void);
541 * Flush pending writes to trace output disk file.
543 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
547 * Poll on the should_quit pipe and the command socket return -1 on error and
548 * should exit, 0 if data is available on the command socket
550 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
552 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
554 enum lttng_consumer_stream_state state
,
555 const char *channel_name
,
562 enum consumer_channel_type type
,
563 unsigned int monitor
);
564 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
566 const char *pathname
,
571 enum lttng_event_output output
,
572 uint64_t tracefile_size
,
573 uint64_t tracefile_count
,
574 uint64_t session_id_per_pid
,
575 unsigned int monitor
,
576 unsigned int live_timer_interval
);
577 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
578 struct lttng_ht
*ht
);
579 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
580 struct lttng_ht
*ht
);
581 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
582 struct lttng_consumer_local_data
*ctx
);
583 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
585 /* lttng-relayd consumer command */
586 struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
587 uint64_t net_seq_idx
);
588 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
589 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
590 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
591 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
592 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
594 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
596 struct lttng_consumer_local_data
*lttng_consumer_create(
597 enum lttng_consumer_type type
,
598 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
599 struct lttng_consumer_local_data
*ctx
),
600 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
601 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
602 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
603 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
604 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
605 struct lttng_consumer_local_data
*ctx
,
606 struct lttng_consumer_stream
*stream
, unsigned long len
,
607 unsigned long padding
,
608 struct lttng_packet_index
*index
);
609 ssize_t
lttng_consumer_on_read_subbuffer_splice(
610 struct lttng_consumer_local_data
*ctx
,
611 struct lttng_consumer_stream
*stream
, unsigned long len
,
612 unsigned long padding
,
613 struct lttng_packet_index
*index
);
614 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
615 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
617 void *consumer_thread_metadata_poll(void *data
);
618 void *consumer_thread_data_poll(void *data
);
619 void *consumer_thread_sessiond_poll(void *data
);
620 void *consumer_thread_channel_poll(void *data
);
621 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
622 int sock
, struct pollfd
*consumer_sockpoll
);
624 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
625 struct lttng_consumer_local_data
*ctx
);
626 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
627 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
628 struct lttng_consumer_local_data
*ctx
, int sock
,
629 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
630 uint64_t sessiond_id
, uint64_t relayd_session_id
);
631 void consumer_flag_relayd_for_destroy(
632 struct consumer_relayd_sock_pair
*relayd
);
633 int consumer_data_pending(uint64_t id
);
634 int consumer_send_status_msg(int sock
, int ret_code
);
635 int consumer_send_status_channel(int sock
,
636 struct lttng_consumer_channel
*channel
);
637 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
639 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
640 unsigned long consumer_get_consumed_maxsize(unsigned long consumed_pos
,
641 unsigned long produced_pos
, uint64_t max_stream_size
);
642 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
643 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
644 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
645 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
646 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
648 #endif /* LIB_CONSUMER_H */