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
;
210 char shm_path
[PATH_MAX
];
214 * Internal representation of the streams, sessiond_key is used to identify
217 struct lttng_consumer_stream
{
218 /* HT node used by the data_ht and metadata_ht */
219 struct lttng_ht_node_u64 node
;
220 /* stream indexed per channel key node */
221 struct lttng_ht_node_u64 node_channel_id
;
222 /* HT node used in consumer_data.stream_list_ht */
223 struct lttng_ht_node_u64 node_session_id
;
224 /* Pointer to associated channel. */
225 struct lttng_consumer_channel
*chan
;
227 /* Key by which the stream is indexed for 'node'. */
230 * File descriptor of the data output file. This can be either a file or a
231 * socket fd for relayd streaming.
233 int out_fd
; /* output file to write the data */
234 /* Write position in the output file descriptor */
236 /* Amount of bytes written to the output */
237 uint64_t output_written
;
238 enum lttng_consumer_stream_state state
;
241 int hangup_flush_done
;
242 enum lttng_event_output output
;
243 /* Maximum subbuffer size. */
244 unsigned long max_sb_size
;
247 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
248 * used for the mmap base and offset.
251 unsigned long mmap_len
;
256 /* UID/GID of the user owning the session to which stream belongs */
259 /* Network sequence number. Indicating on which relayd socket it goes. */
260 uint64_t net_seq_idx
;
262 * Indicate if this stream was successfully sent to a relayd. This is set
263 * after the refcount of the relayd is incremented and is checked when the
264 * stream is closed before decrementing the refcount in order to avoid an
267 unsigned int sent_to_relayd
;
269 /* Identify if the stream is the metadata */
270 unsigned int metadata_flag
;
271 /* Used when the stream is set for network streaming */
272 uint64_t relayd_stream_id
;
274 * When sending a stream packet to a relayd, this number is used to track
275 * the packet sent by the consumer and seen by the relayd. When sending the
276 * data header to the relayd, this number is sent and if the transmission
277 * was successful, it is incremented.
279 * Even if the full data is not fully transmitted it won't matter since
280 * only two possible error can happen after that where either the relayd
281 * died or a read error is detected on the stream making this value useless
284 * This value SHOULD be read/updated atomically or with the lock acquired.
286 uint64_t next_net_seq_num
;
288 * Lock to use the stream FDs since they are used between threads.
290 * This is nested INSIDE the consumer_data lock.
291 * This is nested INSIDE the metadata cache lock.
292 * This is nested INSIDE the channel lock.
293 * This is nested INSIDE the channel timer lock.
294 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
296 pthread_mutex_t lock
;
297 /* Tracing session id */
300 * Indicates if the stream end point is still active or not (network
301 * streaming or local file system). The thread "owning" the stream is
302 * handling this status and can be notified of a state change through the
303 * consumer data appropriate pipe.
305 enum consumer_endpoint_status endpoint_status
;
306 /* Stream name. Format is: <channel_name>_<cpu_number> */
307 char name
[LTTNG_SYMBOL_NAME_LEN
];
308 /* Internal state of libustctl. */
309 struct ustctl_consumer_stream
*ustream
;
310 struct cds_list_head send_node
;
311 /* On-disk circular buffer */
312 uint64_t tracefile_size_current
;
313 uint64_t tracefile_count_current
;
315 * Monitor or not the streams of this channel meaning this indicates if the
316 * streams should be sent to the data/metadata thread or added to the no
317 * monitor list of the channel.
319 unsigned int monitor
;
321 * Indicate if the stream is globally visible meaning that it has been
322 * added to the multiple hash tables. If *not* set, NO lock should be
323 * acquired in the destroy path.
325 unsigned int globally_visible
;
327 * Pipe to wake up the metadata poll thread when the UST metadata
330 int ust_metadata_poll_pipe
[2];
332 * How much metadata was read from the metadata cache and sent
335 uint64_t ust_metadata_pushed
;
337 * FD of the index file for this stream.
342 * Local pipe to extract data when using splice.
347 * Rendez-vous point between data and metadata stream in live mode.
349 pthread_cond_t metadata_rdv
;
350 pthread_mutex_t metadata_rdv_lock
;
352 /* Indicate if the stream still has some data to be read. */
353 unsigned int has_data
:1;
357 * Internal representation of a relayd socket pair.
359 struct consumer_relayd_sock_pair
{
360 /* Network sequence number. */
361 uint64_t net_seq_idx
;
362 /* Number of stream associated with this relayd */
363 unsigned int refcount
;
366 * This flag indicates whether or not we should destroy this object. The
367 * destruction should ONLY occurs when this flag is set and the refcount is
370 unsigned int destroy_flag
;
373 * Mutex protecting the control socket to avoid out of order packets
374 * between threads sending data to the relayd. Since metadata data is sent
375 * over that socket, at least two sendmsg() are needed (header + data)
376 * creating a race for packets to overlap between threads using it.
378 * This is nested INSIDE the consumer_data lock.
379 * This is nested INSIDE the stream lock.
381 pthread_mutex_t ctrl_sock_mutex
;
383 /* Control socket. Command and metadata are passed over it */
384 struct lttcomm_relayd_sock control_sock
;
387 * We don't need a mutex at this point since we only splice or write single
388 * large chunk of data with a header appended at the begining. Moreover,
389 * this socket is for now only used in a single thread.
391 struct lttcomm_relayd_sock data_sock
;
392 struct lttng_ht_node_u64 node
;
394 /* Session id on both sides for the sockets. */
395 uint64_t relayd_session_id
;
396 uint64_t sessiond_session_id
;
400 * UST consumer local data to the program. One or more instance per
403 struct lttng_consumer_local_data
{
405 * Function to call when data is available on a buffer.
406 * Returns the number of bytes read, or negative error value.
408 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
409 struct lttng_consumer_local_data
*ctx
);
411 * function to call when we receive a new channel, it receives a
412 * newly allocated channel, depending on the return code of this
413 * function, the new channel will be handled by the application
417 * > 0 (success, FD is kept by application)
418 * == 0 (success, FD is left to library)
421 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
423 * function to call when we receive a new stream, it receives a
424 * newly allocated stream, depending on the return code of this
425 * function, the new stream will be handled by the application
429 * > 0 (success, FD is kept by application)
430 * == 0 (success, FD is left to library)
433 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
435 * function to call when a stream is getting updated by the session
436 * daemon, this function receives the sessiond key and the new
437 * state, depending on the return code of this function the
438 * update of state for the stream is handled by the application
442 * > 0 (success, FD is kept by application)
443 * == 0 (success, FD is left to library)
446 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
447 enum lttng_consumer_type type
;
448 /* socket to communicate errors with sessiond */
449 int consumer_error_socket
;
450 /* socket to ask metadata to sessiond. */
451 int consumer_metadata_socket
;
453 * Protect consumer_metadata_socket.
455 * This is nested OUTSIDE the metadata cache lock.
457 pthread_mutex_t metadata_socket_lock
;
458 /* socket to exchange commands with sessiond */
459 char *consumer_command_sock_path
;
460 /* communication with splice */
461 int consumer_channel_pipe
[2];
462 /* Data stream poll thread pipe. To transfer data stream to the thread */
463 struct lttng_pipe
*consumer_data_pipe
;
466 * Data thread use that pipe to catch wakeup from read subbuffer that
467 * detects that there is still data to be read for the stream encountered.
468 * Before doing so, the stream is flagged to indicate that there is still
471 * Both pipes (read/write) are owned and used inside the data thread.
473 struct lttng_pipe
*consumer_wakeup_pipe
;
474 /* Indicate if the wakeup thread has been notified. */
475 unsigned int has_wakeup
:1;
477 /* to let the signal handler wake up the fd receiver thread */
478 int consumer_should_quit
[2];
479 /* Metadata poll thread pipe. Transfer metadata stream to it */
480 struct lttng_pipe
*consumer_metadata_pipe
;
484 * Library-level data. One instance per process.
486 struct lttng_consumer_global_data
{
488 * At this time, this lock is used to ensure coherence between the count
489 * and number of element in the hash table. It's also a protection for
490 * concurrent read/write between threads.
492 * This is nested OUTSIDE the stream lock.
493 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
495 pthread_mutex_t lock
;
498 * Number of streams in the data stream hash table declared outside.
499 * Protected by consumer_data.lock.
503 /* Channel hash table protected by consumer_data.lock. */
504 struct lttng_ht
*channel_ht
;
506 * Flag specifying if the local array of FDs needs update in the
507 * poll function. Protected by consumer_data.lock.
509 unsigned int need_update
;
510 enum lttng_consumer_type type
;
513 * Relayd socket(s) hashtable indexed by network sequence number. Each
514 * stream has an index which associate the right relayd socket to use.
516 struct lttng_ht
*relayd_ht
;
519 * This hash table contains all streams (metadata and data) indexed by
520 * session id. In other words, the ht is indexed by session id and each
521 * bucket contains the list of associated streams.
523 * This HT uses the "node_session_id" of the consumer stream.
525 struct lttng_ht
*stream_list_ht
;
528 * This HT uses the "node_channel_id" of the consumer stream.
530 struct lttng_ht
*stream_per_chan_id_ht
;
534 * Init consumer data structures.
536 int lttng_consumer_init(void);
539 * Set the error socket for communication with a session daemon.
541 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
545 * Set the command socket path for communication with a session daemon.
547 void lttng_consumer_set_command_sock_path(
548 struct lttng_consumer_local_data
*ctx
, char *sock
);
551 * Send return code to session daemon.
553 * Returns the return code of sendmsg : the number of bytes transmitted or -1
556 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
559 * Called from signal handler to ensure a clean exit.
561 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
564 * Cleanup the daemon's socket on exit.
566 void lttng_consumer_cleanup(void);
569 * Flush pending writes to trace output disk file.
571 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
575 * Poll on the should_quit pipe and the command socket return -1 on error and
576 * should exit, 0 if data is available on the command socket
578 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
580 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
582 enum lttng_consumer_stream_state state
,
583 const char *channel_name
,
590 enum consumer_channel_type type
,
591 unsigned int monitor
);
592 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
594 const char *pathname
,
599 enum lttng_event_output output
,
600 uint64_t tracefile_size
,
601 uint64_t tracefile_count
,
602 uint64_t session_id_per_pid
,
603 unsigned int monitor
,
604 unsigned int live_timer_interval
,
605 const char *shm_path
);
606 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
607 struct lttng_ht
*ht
);
608 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
609 struct lttng_ht
*ht
);
610 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
611 struct lttng_consumer_local_data
*ctx
);
612 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
614 /* lttng-relayd consumer command */
615 struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
616 uint64_t net_seq_idx
);
617 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
618 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
619 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
620 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
621 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
622 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
624 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
626 struct lttng_consumer_local_data
*lttng_consumer_create(
627 enum lttng_consumer_type type
,
628 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
629 struct lttng_consumer_local_data
*ctx
),
630 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
631 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
632 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
633 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
634 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
635 struct lttng_consumer_local_data
*ctx
,
636 struct lttng_consumer_stream
*stream
, unsigned long len
,
637 unsigned long padding
,
638 struct ctf_packet_index
*index
);
639 ssize_t
lttng_consumer_on_read_subbuffer_splice(
640 struct lttng_consumer_local_data
*ctx
,
641 struct lttng_consumer_stream
*stream
, unsigned long len
,
642 unsigned long padding
,
643 struct ctf_packet_index
*index
);
644 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
645 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
647 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
648 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
649 void *consumer_thread_metadata_poll(void *data
);
650 void *consumer_thread_data_poll(void *data
);
651 void *consumer_thread_sessiond_poll(void *data
);
652 void *consumer_thread_channel_poll(void *data
);
653 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
654 int sock
, struct pollfd
*consumer_sockpoll
);
656 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
657 struct lttng_consumer_local_data
*ctx
);
658 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
659 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
660 struct lttng_consumer_local_data
*ctx
, int sock
,
661 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
662 uint64_t sessiond_id
, uint64_t relayd_session_id
);
663 void consumer_flag_relayd_for_destroy(
664 struct consumer_relayd_sock_pair
*relayd
);
665 int consumer_data_pending(uint64_t id
);
666 int consumer_send_status_msg(int sock
, int ret_code
);
667 int consumer_send_status_channel(int sock
,
668 struct lttng_consumer_channel
*channel
);
669 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
671 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
672 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
673 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
674 uint64_t max_sb_size
);
675 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
676 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
677 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
678 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
679 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
681 #endif /* LIB_CONSUMER_H */