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/ctf-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 */
44 LTTNG_CONSUMER_STOP
, /* deprecated */
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
,
60 LTTNG_CONSUMER_STREAMS_SENT
,
63 /* State of each fd in consumer */
64 enum lttng_consumer_stream_state
{
65 LTTNG_CONSUMER_ACTIVE_STREAM
,
66 LTTNG_CONSUMER_PAUSE_STREAM
,
67 LTTNG_CONSUMER_DELETE_STREAM
,
70 enum lttng_consumer_type
{
71 LTTNG_CONSUMER_UNKNOWN
= 0,
72 LTTNG_CONSUMER_KERNEL
,
77 enum consumer_endpoint_status
{
78 CONSUMER_ENDPOINT_ACTIVE
,
79 CONSUMER_ENDPOINT_INACTIVE
,
82 enum consumer_channel_output
{
83 CONSUMER_CHANNEL_MMAP
= 0,
84 CONSUMER_CHANNEL_SPLICE
= 1,
87 enum consumer_channel_type
{
88 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
89 CONSUMER_CHANNEL_TYPE_DATA
= 1,
92 extern struct lttng_consumer_global_data consumer_data
;
95 struct cds_list_head head
;
100 struct consumer_metadata_cache
;
102 struct lttng_consumer_channel
{
103 /* HT node used for consumer_data.channel_ht */
104 struct lttng_ht_node_u64 node
;
105 /* Indexed key. Incremented value in the consumer. */
107 /* Number of streams referencing this channel */
109 /* Tracing session id on the session daemon side. */
112 * Session id when requesting metadata to the session daemon for
113 * a session with per-PID buffers.
115 uint64_t session_id_per_pid
;
116 /* Channel trace file path name. */
117 char pathname
[PATH_MAX
];
119 char name
[LTTNG_SYMBOL_NAME_LEN
];
120 /* UID and GID of the session owning this channel. */
123 /* Relayd id of the channel. -1ULL if it does not apply. */
126 * Number of streams NOT initialized yet. This is used in order to not
127 * delete this channel if streams are getting initialized.
129 unsigned int nb_init_stream_left
;
130 /* Output type (mmap or splice). */
131 enum consumer_channel_output output
;
132 /* Channel type for stream */
133 enum consumer_channel_type type
;
136 uid_t ust_app_uid
; /* Application UID. */
137 struct ustctl_consumer_channel
*uchan
;
138 unsigned char uuid
[UUID_STR_LEN
];
140 * Temporary stream list used to store the streams once created and waiting
141 * to be sent to the session daemon by receiving the
142 * LTTNG_CONSUMER_GET_CHANNEL.
144 struct stream_list streams
;
147 * Set if the channel is metadata. We keep a reference to the stream
148 * because we have to flush data once pushed by the session daemon. For a
149 * regular channel, this is always set to NULL.
151 struct lttng_consumer_stream
*metadata_stream
;
155 /* Node within channel thread ht */
156 struct lttng_ht_node_u64 wait_fd_node
;
158 /* Metadata cache is metadata channel */
159 struct consumer_metadata_cache
*metadata_cache
;
160 /* For UST metadata periodical flush */
161 int switch_timer_enabled
;
162 timer_t switch_timer
;
163 int switch_timer_error
;
165 /* For the live mode */
166 int live_timer_enabled
;
168 int live_timer_error
;
170 /* On-disk circular buffer */
171 uint64_t tracefile_size
;
172 uint64_t tracefile_count
;
174 * Monitor or not the streams of this channel meaning this indicates if the
175 * streams should be sent to the data/metadata thread or added to the no
176 * monitor list of the channel.
178 unsigned int monitor
;
183 * This lock protects against concurrent update of channel.
185 * This is nested INSIDE the consumer data lock.
186 * This is nested OUTSIDE the channel timer lock.
187 * This is nested OUTSIDE the metadata cache lock.
188 * This is nested OUTSIDE stream lock.
189 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
191 pthread_mutex_t lock
;
194 * Channel teardown lock.
196 * This lock protect against teardown of channel. It is _never_
197 * taken by the timer handler.
199 * This is nested INSIDE the consumer data lock.
200 * This is nested INSIDE the channel lock.
201 * This is nested OUTSIDE the metadata cache lock.
202 * This is nested OUTSIDE stream lock.
203 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
205 pthread_mutex_t timer_lock
;
207 /* Timer value in usec for live streaming. */
208 unsigned int live_timer_interval
;
212 char root_shm_path
[PATH_MAX
];
213 char shm_path
[PATH_MAX
];
217 * Internal representation of the streams, sessiond_key is used to identify
220 struct lttng_consumer_stream
{
221 /* HT node used by the data_ht and metadata_ht */
222 struct lttng_ht_node_u64 node
;
223 /* stream indexed per channel key node */
224 struct lttng_ht_node_u64 node_channel_id
;
225 /* HT node used in consumer_data.stream_list_ht */
226 struct lttng_ht_node_u64 node_session_id
;
227 /* Pointer to associated channel. */
228 struct lttng_consumer_channel
*chan
;
230 /* Key by which the stream is indexed for 'node'. */
233 * File descriptor of the data output file. This can be either a file or a
234 * socket fd for relayd streaming.
236 int out_fd
; /* output file to write the data */
237 /* Write position in the output file descriptor */
239 /* Amount of bytes written to the output */
240 uint64_t output_written
;
241 enum lttng_consumer_stream_state state
;
244 int hangup_flush_done
;
247 * metadata_timer_lock protects flags waiting_on_metadata and
248 * missed_metadata_flush.
250 pthread_mutex_t metadata_timer_lock
;
252 * Flag set when awaiting metadata to be pushed. Used in the
253 * timer thread to skip waiting on the stream (and stream lock) to
254 * ensure we can proceed to flushing metadata in live mode.
256 bool waiting_on_metadata
;
257 /* Raised when a timer misses a metadata flush. */
258 bool missed_metadata_flush
;
260 enum lttng_event_output output
;
261 /* Maximum subbuffer size. */
262 unsigned long max_sb_size
;
265 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
266 * used for the mmap base and offset.
269 unsigned long mmap_len
;
274 /* UID/GID of the user owning the session to which stream belongs */
277 /* Network sequence number. Indicating on which relayd socket it goes. */
278 uint64_t net_seq_idx
;
280 * Indicate if this stream was successfully sent to a relayd. This is set
281 * after the refcount of the relayd is incremented and is checked when the
282 * stream is closed before decrementing the refcount in order to avoid an
285 unsigned int sent_to_relayd
;
287 /* Identify if the stream is the metadata */
288 unsigned int metadata_flag
;
289 /* Used when the stream is set for network streaming */
290 uint64_t relayd_stream_id
;
292 * When sending a stream packet to a relayd, this number is used to track
293 * the packet sent by the consumer and seen by the relayd. When sending the
294 * data header to the relayd, this number is sent and if the transmission
295 * was successful, it is incremented.
297 * Even if the full data is not fully transmitted it won't matter since
298 * only two possible error can happen after that where either the relayd
299 * died or a read error is detected on the stream making this value useless
302 * This value SHOULD be read/updated atomically or with the lock acquired.
304 uint64_t next_net_seq_num
;
306 * Lock to use the stream FDs since they are used between threads.
308 * This is nested INSIDE the consumer_data lock.
309 * This is nested INSIDE the metadata cache lock.
310 * This is nested INSIDE the channel lock.
311 * This is nested INSIDE the channel timer lock.
312 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
314 pthread_mutex_t lock
;
315 /* Tracing session id */
318 * Indicates if the stream end point is still active or not (network
319 * streaming or local file system). The thread "owning" the stream is
320 * handling this status and can be notified of a state change through the
321 * consumer data appropriate pipe.
323 enum consumer_endpoint_status endpoint_status
;
324 /* Stream name. Format is: <channel_name>_<cpu_number> */
325 char name
[LTTNG_SYMBOL_NAME_LEN
];
326 /* Internal state of libustctl. */
327 struct ustctl_consumer_stream
*ustream
;
328 struct cds_list_head send_node
;
329 /* On-disk circular buffer */
330 uint64_t tracefile_size_current
;
331 uint64_t tracefile_count_current
;
333 * Monitor or not the streams of this channel meaning this indicates if the
334 * streams should be sent to the data/metadata thread or added to the no
335 * monitor list of the channel.
337 unsigned int monitor
;
339 * Indicate if the stream is globally visible meaning that it has been
340 * added to the multiple hash tables. If *not* set, NO lock should be
341 * acquired in the destroy path.
343 unsigned int globally_visible
;
345 * Pipe to wake up the metadata poll thread when the UST metadata
348 int ust_metadata_poll_pipe
[2];
350 * How much metadata was read from the metadata cache and sent
353 uint64_t ust_metadata_pushed
;
355 * FD of the index file for this stream.
360 * Local pipe to extract data when using splice.
365 * Rendez-vous point between data and metadata stream in live mode.
367 pthread_cond_t metadata_rdv
;
368 pthread_mutex_t metadata_rdv_lock
;
370 /* Indicate if the stream still has some data to be read. */
371 unsigned int has_data
:1;
375 * Internal representation of a relayd socket pair.
377 struct consumer_relayd_sock_pair
{
378 /* Network sequence number. */
379 uint64_t net_seq_idx
;
380 /* Number of stream associated with this relayd */
381 unsigned int refcount
;
384 * This flag indicates whether or not we should destroy this object. The
385 * destruction should ONLY occurs when this flag is set and the refcount is
388 unsigned int destroy_flag
;
391 * Mutex protecting the control socket to avoid out of order packets
392 * between threads sending data to the relayd. Since metadata data is sent
393 * over that socket, at least two sendmsg() are needed (header + data)
394 * creating a race for packets to overlap between threads using it.
396 * This is nested INSIDE the consumer_data lock.
397 * This is nested INSIDE the stream lock.
399 pthread_mutex_t ctrl_sock_mutex
;
401 /* Control socket. Command and metadata are passed over it */
402 struct lttcomm_relayd_sock control_sock
;
405 * We don't need a mutex at this point since we only splice or write single
406 * large chunk of data with a header appended at the begining. Moreover,
407 * this socket is for now only used in a single thread.
409 struct lttcomm_relayd_sock data_sock
;
410 struct lttng_ht_node_u64 node
;
412 /* Session id on both sides for the sockets. */
413 uint64_t relayd_session_id
;
414 uint64_t sessiond_session_id
;
418 * UST consumer local data to the program. One or more instance per
421 struct lttng_consumer_local_data
{
423 * Function to call when data is available on a buffer.
424 * Returns the number of bytes read, or negative error value.
426 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
427 struct lttng_consumer_local_data
*ctx
);
429 * function to call when we receive a new channel, it receives a
430 * newly allocated channel, depending on the return code of this
431 * function, the new channel will be handled by the application
435 * > 0 (success, FD is kept by application)
436 * == 0 (success, FD is left to library)
439 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
441 * function to call when we receive a new stream, it receives a
442 * newly allocated stream, depending on the return code of this
443 * function, the new stream will be handled by the application
447 * > 0 (success, FD is kept by application)
448 * == 0 (success, FD is left to library)
451 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
453 * function to call when a stream is getting updated by the session
454 * daemon, this function receives the sessiond key and the new
455 * state, depending on the return code of this function the
456 * update of state for the stream is handled by the application
460 * > 0 (success, FD is kept by application)
461 * == 0 (success, FD is left to library)
464 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
465 enum lttng_consumer_type type
;
466 /* socket to communicate errors with sessiond */
467 int consumer_error_socket
;
468 /* socket to ask metadata to sessiond. */
469 int consumer_metadata_socket
;
471 * Protect consumer_metadata_socket.
473 * This is nested OUTSIDE the metadata cache lock.
475 pthread_mutex_t metadata_socket_lock
;
476 /* socket to exchange commands with sessiond */
477 char *consumer_command_sock_path
;
478 /* communication with splice */
479 int consumer_channel_pipe
[2];
480 /* Data stream poll thread pipe. To transfer data stream to the thread */
481 struct lttng_pipe
*consumer_data_pipe
;
484 * Data thread use that pipe to catch wakeup from read subbuffer that
485 * detects that there is still data to be read for the stream encountered.
486 * Before doing so, the stream is flagged to indicate that there is still
489 * Both pipes (read/write) are owned and used inside the data thread.
491 struct lttng_pipe
*consumer_wakeup_pipe
;
492 /* Indicate if the wakeup thread has been notified. */
493 unsigned int has_wakeup
:1;
495 /* to let the signal handler wake up the fd receiver thread */
496 int consumer_should_quit
[2];
497 /* Metadata poll thread pipe. Transfer metadata stream to it */
498 struct lttng_pipe
*consumer_metadata_pipe
;
502 * Library-level data. One instance per process.
504 struct lttng_consumer_global_data
{
506 * At this time, this lock is used to ensure coherence between the count
507 * and number of element in the hash table. It's also a protection for
508 * concurrent read/write between threads.
510 * This is nested OUTSIDE the stream lock.
511 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
513 pthread_mutex_t lock
;
516 * Number of streams in the data stream hash table declared outside.
517 * Protected by consumer_data.lock.
521 /* Channel hash table protected by consumer_data.lock. */
522 struct lttng_ht
*channel_ht
;
524 * Flag specifying if the local array of FDs needs update in the
525 * poll function. Protected by consumer_data.lock.
527 unsigned int need_update
;
528 enum lttng_consumer_type type
;
531 * Relayd socket(s) hashtable indexed by network sequence number. Each
532 * stream has an index which associate the right relayd socket to use.
534 struct lttng_ht
*relayd_ht
;
537 * This hash table contains all streams (metadata and data) indexed by
538 * session id. In other words, the ht is indexed by session id and each
539 * bucket contains the list of associated streams.
541 * This HT uses the "node_session_id" of the consumer stream.
543 struct lttng_ht
*stream_list_ht
;
546 * This HT uses the "node_channel_id" of the consumer stream.
548 struct lttng_ht
*stream_per_chan_id_ht
;
552 * Init consumer data structures.
554 int lttng_consumer_init(void);
557 * Set the error socket for communication with a session daemon.
559 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
563 * Set the command socket path for communication with a session daemon.
565 void lttng_consumer_set_command_sock_path(
566 struct lttng_consumer_local_data
*ctx
, char *sock
);
569 * Send return code to session daemon.
571 * Returns the return code of sendmsg : the number of bytes transmitted or -1
574 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
577 * Called from signal handler to ensure a clean exit.
579 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
582 * Cleanup the daemon's socket on exit.
584 void lttng_consumer_cleanup(void);
587 * Flush pending writes to trace output disk file.
589 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
593 * Poll on the should_quit pipe and the command socket return -1 on error and
594 * should exit, 0 if data is available on the command socket
596 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
598 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
600 enum lttng_consumer_stream_state state
,
601 const char *channel_name
,
608 enum consumer_channel_type type
,
609 unsigned int monitor
);
610 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
612 const char *pathname
,
617 enum lttng_event_output output
,
618 uint64_t tracefile_size
,
619 uint64_t tracefile_count
,
620 uint64_t session_id_per_pid
,
621 unsigned int monitor
,
622 unsigned int live_timer_interval
,
623 const char *root_shm_path
,
624 const char *shm_path
);
625 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
626 struct lttng_ht
*ht
);
627 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
628 struct lttng_ht
*ht
);
629 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
630 struct lttng_consumer_local_data
*ctx
);
631 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
633 /* lttng-relayd consumer command */
634 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
635 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
636 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
637 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
638 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
639 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
641 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
643 struct lttng_consumer_local_data
*lttng_consumer_create(
644 enum lttng_consumer_type type
,
645 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
646 struct lttng_consumer_local_data
*ctx
),
647 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
648 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
649 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
650 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
651 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
652 struct lttng_consumer_local_data
*ctx
,
653 struct lttng_consumer_stream
*stream
, unsigned long len
,
654 unsigned long padding
,
655 struct ctf_packet_index
*index
);
656 ssize_t
lttng_consumer_on_read_subbuffer_splice(
657 struct lttng_consumer_local_data
*ctx
,
658 struct lttng_consumer_stream
*stream
, unsigned long len
,
659 unsigned long padding
,
660 struct ctf_packet_index
*index
);
661 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
662 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
664 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
665 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
666 void *consumer_thread_metadata_poll(void *data
);
667 void *consumer_thread_data_poll(void *data
);
668 void *consumer_thread_sessiond_poll(void *data
);
669 void *consumer_thread_channel_poll(void *data
);
670 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
671 int sock
, struct pollfd
*consumer_sockpoll
);
673 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
674 struct lttng_consumer_local_data
*ctx
);
675 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
676 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
677 struct lttng_consumer_local_data
*ctx
, int sock
,
678 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
679 uint64_t sessiond_id
, uint64_t relayd_session_id
);
680 void consumer_flag_relayd_for_destroy(
681 struct consumer_relayd_sock_pair
*relayd
);
682 int consumer_data_pending(uint64_t id
);
683 int consumer_send_status_msg(int sock
, int ret_code
);
684 int consumer_send_status_channel(int sock
,
685 struct lttng_consumer_channel
*channel
);
686 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
688 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
689 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
690 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
691 uint64_t max_sb_size
);
692 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
693 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
694 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
695 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
696 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
698 #endif /* LIB_CONSUMER_H */