Fix: post-clear trace chunk has a late beginning packet
[lttng-tools.git] / src / common / consumer / consumer.h
1 /*
2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
5 * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * SPDX-License-Identifier: GPL-2.0-only
8 *
9 */
10
11 #ifndef LIB_CONSUMER_H
12 #define LIB_CONSUMER_H
13
14 #include <limits.h>
15 #include <poll.h>
16 #include <unistd.h>
17 #include <urcu/list.h>
18
19 #include <lttng/lttng.h>
20
21 #include <common/hashtable/hashtable.h>
22 #include <common/compat/fcntl.h>
23 #include <common/uuid.h>
24 #include <common/sessiond-comm/sessiond-comm.h>
25 #include <common/pipe.h>
26 #include <common/index/ctf-index.h>
27 #include <common/trace-chunk-registry.h>
28 #include <common/credentials.h>
29 #include <common/buffer-view.h>
30
31 struct lttng_consumer_local_data;
32
33 /* Commands for consumer */
34 enum lttng_consumer_command {
35 LTTNG_CONSUMER_ADD_CHANNEL,
36 LTTNG_CONSUMER_ADD_STREAM,
37 /* pause, delete, active depending on fd state */
38 LTTNG_CONSUMER_UPDATE_STREAM,
39 /* inform the consumer to quit when all fd has hang up */
40 LTTNG_CONSUMER_STOP, /* deprecated */
41 LTTNG_CONSUMER_ADD_RELAYD_SOCKET,
42 /* Inform the consumer to kill a specific relayd connection */
43 LTTNG_CONSUMER_DESTROY_RELAYD,
44 /* Return to the sessiond if there is data pending for a session */
45 LTTNG_CONSUMER_DATA_PENDING,
46 /* Consumer creates a channel and returns it to sessiond. */
47 LTTNG_CONSUMER_ASK_CHANNEL_CREATION,
48 LTTNG_CONSUMER_GET_CHANNEL,
49 LTTNG_CONSUMER_DESTROY_CHANNEL,
50 LTTNG_CONSUMER_PUSH_METADATA,
51 LTTNG_CONSUMER_CLOSE_METADATA,
52 LTTNG_CONSUMER_SETUP_METADATA,
53 LTTNG_CONSUMER_FLUSH_CHANNEL,
54 LTTNG_CONSUMER_SNAPSHOT_CHANNEL,
55 LTTNG_CONSUMER_SNAPSHOT_METADATA,
56 LTTNG_CONSUMER_STREAMS_SENT,
57 LTTNG_CONSUMER_DISCARDED_EVENTS,
58 LTTNG_CONSUMER_LOST_PACKETS,
59 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL,
60 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE,
61 LTTNG_CONSUMER_ROTATE_CHANNEL,
62 LTTNG_CONSUMER_INIT,
63 LTTNG_CONSUMER_CREATE_TRACE_CHUNK,
64 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK,
65 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS,
66 LTTNG_CONSUMER_CLEAR_CHANNEL,
67 };
68
69 enum lttng_consumer_type {
70 LTTNG_CONSUMER_UNKNOWN = 0,
71 LTTNG_CONSUMER_KERNEL,
72 LTTNG_CONSUMER64_UST,
73 LTTNG_CONSUMER32_UST,
74 };
75
76 enum consumer_endpoint_status {
77 CONSUMER_ENDPOINT_ACTIVE,
78 CONSUMER_ENDPOINT_INACTIVE,
79 };
80
81 enum consumer_channel_output {
82 CONSUMER_CHANNEL_MMAP = 0,
83 CONSUMER_CHANNEL_SPLICE = 1,
84 };
85
86 enum consumer_channel_type {
87 CONSUMER_CHANNEL_TYPE_METADATA = 0,
88 CONSUMER_CHANNEL_TYPE_DATA = 1,
89 };
90
91 enum sync_metadata_status {
92 SYNC_METADATA_STATUS_NEW_DATA,
93 SYNC_METADATA_STATUS_NO_DATA,
94 SYNC_METADATA_STATUS_ERROR,
95 };
96
97 extern struct lttng_consumer_global_data consumer_data;
98
99 struct stream_list {
100 struct cds_list_head head;
101 unsigned int count;
102 };
103
104 /* Stub. */
105 struct consumer_metadata_cache;
106
107 struct lttng_consumer_channel {
108 /* Is the channel published in the channel hash tables? */
109 bool is_published;
110 /*
111 * Was the channel deleted (logically) and waiting to be reclaimed?
112 * If this flag is set, no modification that is not cleaned-up by the
113 * RCU reclamation callback should be made
114 */
115 bool is_deleted;
116 /* HT node used for consumer_data.channel_ht */
117 struct lttng_ht_node_u64 node;
118 /* HT node used for consumer_data.channels_by_session_id_ht */
119 struct lttng_ht_node_u64 channels_by_session_id_ht_node;
120 /* Indexed key. Incremented value in the consumer. */
121 uint64_t key;
122 /* Number of streams referencing this channel */
123 int refcount;
124 /* Tracing session id on the session daemon side. */
125 uint64_t session_id;
126 /* Current trace chunk of the session in which this channel exists. */
127 struct lttng_trace_chunk *trace_chunk;
128 /*
129 * Session id when requesting metadata to the session daemon for
130 * a session with per-PID buffers.
131 */
132 uint64_t session_id_per_pid;
133 /*
134 * In the case of local streams, this field contains the channel's
135 * output path; a path relative to the session's output path.
136 * e.g. ust/uid/1000/64-bit
137 *
138 * In the case of remote streams, the contents of this field depends
139 * on the version of the relay daemon peer. For 2.11+ peers, the
140 * contents are the same as in the local case. However, for legacy
141 * peers, this contains a path of the form:
142 * /hostname/session_path/ust/uid/1000/64-bit
143 */
144 char pathname[PATH_MAX];
145 /* Channel name. */
146 char name[LTTNG_SYMBOL_NAME_LEN];
147 /* Relayd id of the channel. -1ULL if it does not apply. */
148 uint64_t relayd_id;
149 /*
150 * Number of streams NOT initialized yet. This is used in order to not
151 * delete this channel if streams are getting initialized.
152 */
153 unsigned int nb_init_stream_left;
154 /* Output type (mmap or splice). */
155 enum consumer_channel_output output;
156 /* Channel type for stream */
157 enum consumer_channel_type type;
158
159 /* For UST */
160 uid_t ust_app_uid; /* Application UID. */
161 struct ustctl_consumer_channel *uchan;
162 unsigned char uuid[LTTNG_UUID_STR_LEN];
163 /*
164 * Temporary stream list used to store the streams once created and waiting
165 * to be sent to the session daemon by receiving the
166 * LTTNG_CONSUMER_GET_CHANNEL.
167 */
168 struct stream_list streams;
169
170 /*
171 * Set if the channel is metadata. We keep a reference to the stream
172 * because we have to flush data once pushed by the session daemon. For a
173 * regular channel, this is always set to NULL.
174 */
175 struct lttng_consumer_stream *metadata_stream;
176
177 /* for UST */
178 int wait_fd;
179 /* Node within channel thread ht */
180 struct lttng_ht_node_u64 wait_fd_node;
181
182 /* Metadata cache is metadata channel */
183 struct consumer_metadata_cache *metadata_cache;
184
185 /* For UST metadata periodical flush */
186 int switch_timer_enabled;
187 timer_t switch_timer;
188 int switch_timer_error;
189
190 /* For the live mode */
191 int live_timer_enabled;
192 timer_t live_timer;
193 int live_timer_error;
194 /* Channel is part of a live session ? */
195 bool is_live;
196
197 /* For channel monitoring timer. */
198 int monitor_timer_enabled;
199 timer_t monitor_timer;
200
201 /* On-disk circular buffer */
202 uint64_t tracefile_size;
203 uint64_t tracefile_count;
204 /*
205 * Monitor or not the streams of this channel meaning this indicates if the
206 * streams should be sent to the data/metadata thread or added to the no
207 * monitor list of the channel.
208 */
209 unsigned int monitor;
210
211 /*
212 * Channel lock.
213 *
214 * This lock protects against concurrent update of channel.
215 *
216 * This is nested INSIDE the consumer data lock.
217 * This is nested OUTSIDE the channel timer lock.
218 * This is nested OUTSIDE the metadata cache lock.
219 * This is nested OUTSIDE stream lock.
220 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
221 */
222 pthread_mutex_t lock;
223
224 /*
225 * Channel teardown lock.
226 *
227 * This lock protect against teardown of channel. It is _never_
228 * taken by the timer handler.
229 *
230 * This is nested INSIDE the consumer data lock.
231 * This is nested INSIDE the channel lock.
232 * This is nested OUTSIDE the metadata cache lock.
233 * This is nested OUTSIDE stream lock.
234 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
235 */
236 pthread_mutex_t timer_lock;
237
238 /* Timer value in usec for live streaming. */
239 unsigned int live_timer_interval;
240
241 int *stream_fds;
242 int nr_stream_fds;
243 char root_shm_path[PATH_MAX];
244 char shm_path[PATH_MAX];
245 /* Only set for UST channels. */
246 LTTNG_OPTIONAL(struct lttng_credentials) buffer_credentials;
247 /* Total number of discarded events for that channel. */
248 uint64_t discarded_events;
249 /* Total number of missed packets due to overwriting (overwrite). */
250 uint64_t lost_packets;
251
252 bool streams_sent_to_relayd;
253 };
254
255 struct stream_subbuffer {
256 union {
257 /*
258 * CONSUMER_CHANNEL_SPLICE
259 * No ownership assumed.
260 */
261 int fd;
262 /* CONSUMER_CHANNEL_MMAP */
263 struct lttng_buffer_view buffer;
264 } buffer;
265 union {
266 /*
267 * Common members are fine to access through either
268 * union entries (as per C11, Common Initial Sequence).
269 */
270 struct {
271 unsigned long subbuf_size;
272 unsigned long padded_subbuf_size;
273 uint64_t version;
274 /*
275 * Left unset when unsupported.
276 *
277 * Indicates that this is the last sub-buffer of
278 * a series of sub-buffer that makes-up a coherent
279 * (parseable) unit of metadata.
280 */
281 LTTNG_OPTIONAL(bool) coherent;
282 } metadata;
283 struct {
284 unsigned long subbuf_size;
285 unsigned long padded_subbuf_size;
286 uint64_t packet_size;
287 uint64_t content_size;
288 uint64_t timestamp_begin;
289 uint64_t timestamp_end;
290 uint64_t events_discarded;
291 /* Left unset when unsupported. */
292 LTTNG_OPTIONAL(uint64_t) sequence_number;
293 uint64_t stream_id;
294 /* Left unset when unsupported. */
295 LTTNG_OPTIONAL(uint64_t) stream_instance_id;
296 } data;
297 } info;
298 };
299
300 /*
301 * Perform any operation required to acknowledge
302 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
303 *
304 * Stream and channel locks are acquired during this call.
305 */
306 typedef int (*on_wake_up_cb)(struct lttng_consumer_stream *);
307
308 /*
309 * Perform any operation required before a consumer stream is put
310 * to sleep before awaiting a data availability notification.
311 *
312 * Stream and channel locks are acquired during this call.
313 */
314 typedef int (*on_sleep_cb)(struct lttng_consumer_stream *,
315 struct lttng_consumer_local_data *);
316
317 /*
318 * Acquire the subbuffer at the current 'consumed' position.
319 *
320 * Stream and channel locks are acquired during this call.
321 */
322 typedef int (*get_next_subbuffer_cb)(struct lttng_consumer_stream *,
323 struct stream_subbuffer *);
324
325 /*
326 * Populate the stream_subbuffer's info member. The info to populate
327 * depends on the type (metadata/data) of the stream.
328 *
329 * Stream and channel locks are acquired during this call.
330 */
331 typedef int (*extract_subbuffer_info_cb)(
332 struct lttng_consumer_stream *, struct stream_subbuffer *);
333
334 /*
335 * Invoked after a subbuffer's info has been filled.
336 *
337 * Stream and channel locks are acquired during this call.
338 */
339 typedef int (*pre_consume_subbuffer_cb)(struct lttng_consumer_stream *,
340 const struct stream_subbuffer *);
341
342 /*
343 * Consume subbuffer contents.
344 *
345 * Stream and channel locks are acquired during this call.
346 */
347 typedef ssize_t (*consume_subbuffer_cb)(struct lttng_consumer_local_data *,
348 struct lttng_consumer_stream *,
349 const struct stream_subbuffer *);
350
351 /*
352 * Release the current subbuffer and advance the 'consumed' position by
353 * one subbuffer.
354 *
355 * Stream and channel locks are acquired during this call.
356 */
357 typedef int (*put_next_subbuffer_cb)(struct lttng_consumer_stream *,
358 struct stream_subbuffer *);
359
360 /*
361 * Invoked after consuming a subbuffer.
362 *
363 * Stream and channel locks are acquired during this call.
364 */
365 typedef int (*post_consume_cb)(struct lttng_consumer_stream *,
366 const struct stream_subbuffer *,
367 struct lttng_consumer_local_data *);
368
369 /*
370 * Send a live beacon if no data is available.
371 *
372 * Stream and channel locks are acquired during this call.
373 */
374 typedef int (*send_live_beacon_cb)(struct lttng_consumer_stream *);
375
376 /*
377 * Lock the stream and channel locks and any other stream-type specific
378 * lock that need to be acquired during the processing of an
379 * availability notification.
380 */
381 typedef void (*lock_cb)(struct lttng_consumer_stream *);
382
383 /*
384 * Unlock the stream and channel locks and any other stream-type specific
385 * lock before sleeping until the next availability notification.
386 *
387 * Stream and channel locks are acquired during this call.
388 */
389 typedef void (*unlock_cb)(struct lttng_consumer_stream *);
390
391 /*
392 * Invoked when a subbuffer's metadata version does not match the last
393 * known metadata version.
394 *
395 * Stream and channel locks are acquired during this call.
396 */
397 typedef void (*reset_metadata_cb)(struct lttng_consumer_stream *);
398
399 /*
400 * Internal representation of the streams, sessiond_key is used to identify
401 * uniquely a stream.
402 */
403 struct lttng_consumer_stream {
404 /* HT node used by the data_ht and metadata_ht */
405 struct lttng_ht_node_u64 node;
406 /* stream indexed per channel key node */
407 struct lttng_ht_node_u64 node_channel_id;
408 /* HT node used in consumer_data.stream_list_ht */
409 struct lttng_ht_node_u64 node_session_id;
410 /* Pointer to associated channel. */
411 struct lttng_consumer_channel *chan;
412 /*
413 * Current trace chunk. Holds a reference to the trace chunk.
414 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
415 * when it was created in the context of a no-output session.
416 */
417 struct lttng_trace_chunk *trace_chunk;
418
419 /* Key by which the stream is indexed for 'node'. */
420 uint64_t key;
421 /*
422 * File descriptor of the data output file. This can be either a file or a
423 * socket fd for relayd streaming.
424 */
425 int out_fd; /* output file to write the data */
426 /* Write position in the output file descriptor */
427 off_t out_fd_offset;
428 /* Amount of bytes written to the output */
429 uint64_t output_written;
430 int shm_fd_is_copy;
431 int data_read;
432 int hangup_flush_done;
433
434 /*
435 * Whether the stream is in a "complete" state (e.g. it does not have a
436 * partially written sub-buffer.
437 *
438 * Initialized to "false" on stream creation (first packet is empty).
439 *
440 * The various transitions of the quiescent state are:
441 * - On "start" tracing: set to false, since the stream is not
442 * "complete".
443 * - On "stop" tracing: if !quiescent -> flush FINAL (update
444 * timestamp_end), and set to true; the stream has entered a
445 * complete/quiescent state.
446 * - On "destroy" or stream/application hang-up: if !quiescent ->
447 * flush FINAL, and set to true.
448 *
449 * NOTE: Update and read are protected by the stream lock.
450 */
451 bool quiescent;
452
453 /*
454 * True if the sequence number is not available (lttng-modules < 2.8).
455 */
456 bool sequence_number_unavailable;
457
458 /*
459 * metadata_timer_lock protects flags waiting_on_metadata and
460 * missed_metadata_flush.
461 */
462 pthread_mutex_t metadata_timer_lock;
463 /*
464 * Flag set when awaiting metadata to be pushed. Used in the
465 * timer thread to skip waiting on the stream (and stream lock) to
466 * ensure we can proceed to flushing metadata in live mode.
467 */
468 bool waiting_on_metadata;
469 /* Raised when a timer misses a metadata flush. */
470 bool missed_metadata_flush;
471
472 enum lttng_event_output output;
473 /* Maximum subbuffer size (in bytes). */
474 unsigned long max_sb_size;
475
476 /*
477 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
478 * used for the mmap base and offset.
479 */
480 void *mmap_base;
481 unsigned long mmap_len;
482
483 /* For UST */
484
485 int wait_fd;
486 /* Network sequence number. Indicating on which relayd socket it goes. */
487 uint64_t net_seq_idx;
488 /*
489 * Indicate if this stream was successfully sent to a relayd. This is set
490 * after the refcount of the relayd is incremented and is checked when the
491 * stream is closed before decrementing the refcount in order to avoid an
492 * unbalanced state.
493 */
494 unsigned int sent_to_relayd;
495
496 /* Identify if the stream is the metadata */
497 unsigned int metadata_flag;
498 /*
499 * Last known metadata version, reset the metadata file in case
500 * of change.
501 */
502 uint64_t metadata_version;
503 /* Used when the stream is set for network streaming */
504 uint64_t relayd_stream_id;
505 /*
506 * When sending a stream packet to a relayd, this number is used to track
507 * the packet sent by the consumer and seen by the relayd. When sending the
508 * data header to the relayd, this number is sent and if the transmission
509 * was successful, it is incremented.
510 *
511 * Even if the full data is not fully transmitted it won't matter since
512 * only two possible error can happen after that where either the relayd
513 * died or a read error is detected on the stream making this value useless
514 * after that.
515 *
516 * This value SHOULD be read/updated atomically or with the lock acquired.
517 */
518 uint64_t next_net_seq_num;
519 /*
520 * Lock to use the stream FDs since they are used between threads.
521 *
522 * This is nested INSIDE the consumer_data lock.
523 * This is nested INSIDE the channel lock.
524 * This is nested INSIDE the channel timer lock.
525 * This is nested OUTSIDE the metadata cache lock.
526 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
527 */
528 pthread_mutex_t lock;
529 /* Tracing session id */
530 uint64_t session_id;
531 /*
532 * Indicates if the stream end point is still active or not (network
533 * streaming or local file system). The thread "owning" the stream is
534 * handling this status and can be notified of a state change through the
535 * consumer data appropriate pipe.
536 */
537 enum consumer_endpoint_status endpoint_status;
538 /* Stream name. Format is: <channel_name>_<cpu_number> */
539 char name[LTTNG_SYMBOL_NAME_LEN];
540 /* Internal state of libustctl. */
541 struct ustctl_consumer_stream *ustream;
542 struct cds_list_head send_node;
543 /* On-disk circular buffer */
544 uint64_t tracefile_size_current;
545 uint64_t tracefile_count_current;
546 /*
547 * Monitor or not the streams of this channel meaning this indicates if the
548 * streams should be sent to the data/metadata thread or added to the no
549 * monitor list of the channel.
550 */
551 unsigned int monitor;
552 /*
553 * Indicate if the stream is globally visible meaning that it has been
554 * added to the multiple hash tables. If *not* set, NO lock should be
555 * acquired in the destroy path.
556 */
557 unsigned int globally_visible;
558 /*
559 * Pipe to wake up the metadata poll thread when the UST metadata
560 * cache is updated.
561 */
562 int ust_metadata_poll_pipe[2];
563 /*
564 * How much metadata was read from the metadata cache and sent
565 * to the channel.
566 */
567 uint64_t ust_metadata_pushed;
568 /*
569 * Copy of the last discarded event value to detect the overflow of
570 * the counter.
571 */
572 uint64_t last_discarded_events;
573 /* Copy of the sequence number of the last packet extracted. */
574 uint64_t last_sequence_number;
575 /*
576 * Index file object of the index file for this stream.
577 */
578 struct lttng_index_file *index_file;
579
580 /*
581 * Local pipe to extract data when using splice.
582 */
583 int splice_pipe[2];
584
585 /*
586 * Rendez-vous point between data and metadata stream in live mode.
587 */
588 pthread_cond_t metadata_rdv;
589 pthread_mutex_t metadata_rdv_lock;
590
591 /*
592 * rotate_position represents the packet sequence number of the last
593 * packet which belongs to the current trace chunk prior to the rotation.
594 * When that position is reached, this tracefile can be closed and a
595 * new one is created in channel_read_only_attributes.path.
596 */
597 uint64_t rotate_position;
598
599 /* Whether or not a packet was opened during the current trace chunk. */
600 bool opened_packet_in_current_trace_chunk;
601
602 /*
603 * Read-only copies of channel values. We cannot safely access the
604 * channel from a stream, so we need to have a local copy of these
605 * fields in the stream object. These fields should be removed from
606 * the stream objects when we introduce refcounting.
607 */
608 struct {
609 uint64_t tracefile_size;
610 } channel_read_only_attributes;
611
612 /*
613 * Flag to inform the data or metadata thread that a stream is
614 * ready to be rotated.
615 */
616 bool rotate_ready;
617
618 /* Indicate if the stream still has some data to be read. */
619 unsigned int has_data:1;
620 /*
621 * Inform the consumer or relay to reset the metadata
622 * file before writing in it (regeneration).
623 */
624 unsigned int reset_metadata_flag:1;
625 struct {
626 /*
627 * Invoked in the order of declaration.
628 * See callback type definitions.
629 */
630 lock_cb lock;
631 on_wake_up_cb on_wake_up;
632 get_next_subbuffer_cb get_next_subbuffer;
633 extract_subbuffer_info_cb extract_subbuffer_info;
634 pre_consume_subbuffer_cb pre_consume_subbuffer;
635 reset_metadata_cb reset_metadata;
636 consume_subbuffer_cb consume_subbuffer;
637 put_next_subbuffer_cb put_next_subbuffer;
638 post_consume_cb post_consume;
639 send_live_beacon_cb send_live_beacon;
640 on_sleep_cb on_sleep;
641 unlock_cb unlock;
642 } read_subbuffer_ops;
643 struct metadata_bucket *metadata_bucket;
644 };
645
646 /*
647 * Internal representation of a relayd socket pair.
648 */
649 struct consumer_relayd_sock_pair {
650 /* Network sequence number. */
651 uint64_t net_seq_idx;
652 /* Number of stream associated with this relayd */
653 int refcount;
654
655 /*
656 * This flag indicates whether or not we should destroy this object. The
657 * destruction should ONLY occurs when this flag is set and the refcount is
658 * set to zero.
659 */
660 unsigned int destroy_flag;
661
662 /*
663 * Mutex protecting the control socket to avoid out of order packets
664 * between threads sending data to the relayd. Since metadata data is sent
665 * over that socket, at least two sendmsg() are needed (header + data)
666 * creating a race for packets to overlap between threads using it.
667 *
668 * This is nested INSIDE the consumer_data lock.
669 * This is nested INSIDE the stream lock.
670 */
671 pthread_mutex_t ctrl_sock_mutex;
672
673 /* Control socket. Command and metadata are passed over it */
674 struct lttcomm_relayd_sock control_sock;
675
676 /*
677 * We don't need a mutex at this point since we only splice or write single
678 * large chunk of data with a header appended at the begining. Moreover,
679 * this socket is for now only used in a single thread.
680 */
681 struct lttcomm_relayd_sock data_sock;
682 struct lttng_ht_node_u64 node;
683
684 /* Session id on both sides for the sockets. */
685 uint64_t relayd_session_id;
686 uint64_t sessiond_session_id;
687 struct lttng_consumer_local_data *ctx;
688 };
689
690 /*
691 * UST consumer local data to the program. One or more instance per
692 * process.
693 */
694 struct lttng_consumer_local_data {
695 /*
696 * Function to call when data is available on a buffer.
697 * Returns the number of bytes read, or negative error value.
698 */
699 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
700 struct lttng_consumer_local_data *ctx,
701 bool locked_by_caller);
702 /*
703 * function to call when we receive a new channel, it receives a
704 * newly allocated channel, depending on the return code of this
705 * function, the new channel will be handled by the application
706 * or the library.
707 *
708 * Returns:
709 * > 0 (success, FD is kept by application)
710 * == 0 (success, FD is left to library)
711 * < 0 (error)
712 */
713 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
714 /*
715 * function to call when we receive a new stream, it receives a
716 * newly allocated stream, depending on the return code of this
717 * function, the new stream will be handled by the application
718 * or the library.
719 *
720 * Returns:
721 * > 0 (success, FD is kept by application)
722 * == 0 (success, FD is left to library)
723 * < 0 (error)
724 */
725 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
726 /*
727 * function to call when a stream is getting updated by the session
728 * daemon, this function receives the sessiond key and the new
729 * state, depending on the return code of this function the
730 * update of state for the stream is handled by the application
731 * or the library.
732 *
733 * Returns:
734 * > 0 (success, FD is kept by application)
735 * == 0 (success, FD is left to library)
736 * < 0 (error)
737 */
738 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
739 enum lttng_consumer_type type;
740 /* socket to communicate errors with sessiond */
741 int consumer_error_socket;
742 /* socket to ask metadata to sessiond. */
743 int consumer_metadata_socket;
744 /*
745 * Protect consumer_metadata_socket.
746 *
747 * This is nested OUTSIDE the metadata cache lock.
748 */
749 pthread_mutex_t metadata_socket_lock;
750 /* socket to exchange commands with sessiond */
751 char *consumer_command_sock_path;
752 /* communication with splice */
753 int consumer_channel_pipe[2];
754 /* Data stream poll thread pipe. To transfer data stream to the thread */
755 struct lttng_pipe *consumer_data_pipe;
756
757 /*
758 * Data thread use that pipe to catch wakeup from read subbuffer that
759 * detects that there is still data to be read for the stream encountered.
760 * Before doing so, the stream is flagged to indicate that there is still
761 * data to be read.
762 *
763 * Both pipes (read/write) are owned and used inside the data thread.
764 */
765 struct lttng_pipe *consumer_wakeup_pipe;
766 /* Indicate if the wakeup thread has been notified. */
767 unsigned int has_wakeup:1;
768
769 /* to let the signal handler wake up the fd receiver thread */
770 int consumer_should_quit[2];
771 /* Metadata poll thread pipe. Transfer metadata stream to it */
772 struct lttng_pipe *consumer_metadata_pipe;
773 /*
774 * Pipe used by the channel monitoring timers to provide state samples
775 * to the session daemon (write-only).
776 */
777 int channel_monitor_pipe;
778 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
779 };
780
781 /*
782 * Library-level data. One instance per process.
783 */
784 struct lttng_consumer_global_data {
785 /*
786 * At this time, this lock is used to ensure coherence between the count
787 * and number of element in the hash table. It's also a protection for
788 * concurrent read/write between threads.
789 *
790 * This is nested OUTSIDE the stream lock.
791 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
792 */
793 pthread_mutex_t lock;
794
795 /*
796 * Number of streams in the data stream hash table declared outside.
797 * Protected by consumer_data.lock.
798 */
799 int stream_count;
800
801 /* Channel hash table protected by consumer_data.lock. */
802 struct lttng_ht *channel_ht;
803 /* Channel hash table indexed by session id. */
804 struct lttng_ht *channels_by_session_id_ht;
805 /*
806 * Flag specifying if the local array of FDs needs update in the
807 * poll function. Protected by consumer_data.lock.
808 */
809 unsigned int need_update;
810 enum lttng_consumer_type type;
811
812 /*
813 * Relayd socket(s) hashtable indexed by network sequence number. Each
814 * stream has an index which associate the right relayd socket to use.
815 */
816 struct lttng_ht *relayd_ht;
817
818 /*
819 * This hash table contains all streams (metadata and data) indexed by
820 * session id. In other words, the ht is indexed by session id and each
821 * bucket contains the list of associated streams.
822 *
823 * This HT uses the "node_session_id" of the consumer stream.
824 */
825 struct lttng_ht *stream_list_ht;
826
827 /*
828 * This HT uses the "node_channel_id" of the consumer stream.
829 */
830 struct lttng_ht *stream_per_chan_id_ht;
831
832 /*
833 * Trace chunk registry indexed by (session_id, chunk_id).
834 */
835 struct lttng_trace_chunk_registry *chunk_registry;
836 };
837
838 /*
839 * Set to nonzero when the consumer is exiting. Updated by signal
840 * handler and thread exit, read by threads.
841 */
842 extern int consumer_quit;
843
844 /*
845 * Set to nonzero when the consumer is exiting. Updated by signal
846 * handler and thread exit, read by threads.
847 */
848 extern int consumer_quit;
849
850 /* Flag used to temporarily pause data consumption from testpoints. */
851 extern int data_consumption_paused;
852
853 /* Return a human-readable consumer type string that is suitable for logging. */
854 static inline
855 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
856 {
857 switch (type) {
858 case LTTNG_CONSUMER_UNKNOWN:
859 return "unknown";
860 case LTTNG_CONSUMER_KERNEL:
861 return "kernel";
862 case LTTNG_CONSUMER32_UST:
863 return "32-bit user space";
864 case LTTNG_CONSUMER64_UST:
865 return "64-bit user space";
866 default:
867 abort();
868 }
869 }
870
871 /*
872 * Init consumer data structures.
873 */
874 int lttng_consumer_init(void);
875
876 /*
877 * Set the error socket for communication with a session daemon.
878 */
879 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
880 int sock);
881
882 /*
883 * Set the command socket path for communication with a session daemon.
884 */
885 void lttng_consumer_set_command_sock_path(
886 struct lttng_consumer_local_data *ctx, char *sock);
887
888 /*
889 * Send return code to session daemon.
890 *
891 * Returns the return code of sendmsg : the number of bytes transmitted or -1
892 * on error.
893 */
894 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
895
896 /*
897 * Called from signal handler to ensure a clean exit.
898 */
899 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
900
901 /*
902 * Cleanup the daemon's socket on exit.
903 */
904 void lttng_consumer_cleanup(void);
905
906 /*
907 * Poll on the should_quit pipe and the command socket return -1 on error and
908 * should exit, 0 if data is available on the command socket
909 */
910 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
911
912 /*
913 * Copy the fields from the channel that need to be accessed (read-only)
914 * directly from the stream.
915 */
916 void consumer_stream_update_channel_attributes(
917 struct lttng_consumer_stream *stream,
918 struct lttng_consumer_channel *channel);
919
920 struct lttng_consumer_stream *consumer_allocate_stream(
921 struct lttng_consumer_channel *channel,
922 uint64_t channel_key,
923 uint64_t stream_key,
924 const char *channel_name,
925 uint64_t relayd_id,
926 uint64_t session_id,
927 struct lttng_trace_chunk *trace_chunk,
928 int cpu,
929 int *alloc_ret,
930 enum consumer_channel_type type,
931 unsigned int monitor);
932 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
933 uint64_t session_id,
934 const uint64_t *chunk_id,
935 const char *pathname,
936 const char *name,
937 uint64_t relayd_id,
938 enum lttng_event_output output,
939 uint64_t tracefile_size,
940 uint64_t tracefile_count,
941 uint64_t session_id_per_pid,
942 unsigned int monitor,
943 unsigned int live_timer_interval,
944 bool is_in_live_session,
945 const char *root_shm_path,
946 const char *shm_path);
947 void consumer_del_stream(struct lttng_consumer_stream *stream,
948 struct lttng_ht *ht);
949 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
950 struct lttng_ht *ht);
951 int consumer_add_channel(struct lttng_consumer_channel *channel,
952 struct lttng_consumer_local_data *ctx);
953 void consumer_del_channel(struct lttng_consumer_channel *channel);
954
955 /* lttng-relayd consumer command */
956 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
957 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
958 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
959 void close_relayd_stream(struct lttng_consumer_stream *stream);
960 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
961 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
962 size_t data_size);
963 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
964
965 struct lttng_consumer_local_data *lttng_consumer_create(
966 enum lttng_consumer_type type,
967 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
968 struct lttng_consumer_local_data *ctx,
969 bool locked_by_caller),
970 int (*recv_channel)(struct lttng_consumer_channel *channel),
971 int (*recv_stream)(struct lttng_consumer_stream *stream),
972 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
973 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
974 ssize_t lttng_consumer_on_read_subbuffer_mmap(
975 struct lttng_consumer_stream *stream,
976 const struct lttng_buffer_view *buffer,
977 unsigned long padding);
978 ssize_t lttng_consumer_on_read_subbuffer_splice(
979 struct lttng_consumer_local_data *ctx,
980 struct lttng_consumer_stream *stream, unsigned long len,
981 unsigned long padding);
982 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
983 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
984 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
985 unsigned long *pos);
986 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
987 unsigned long *pos);
988 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
989 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
990 void *consumer_thread_metadata_poll(void *data);
991 void *consumer_thread_data_poll(void *data);
992 void *consumer_thread_sessiond_poll(void *data);
993 void *consumer_thread_channel_poll(void *data);
994 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
995 int sock, struct pollfd *consumer_sockpoll);
996
997 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
998 struct lttng_consumer_local_data *ctx,
999 bool locked_by_caller);
1000 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1001 void consumer_add_relayd_socket(uint64_t net_seq_idx, int sock_type,
1002 struct lttng_consumer_local_data *ctx, int sock,
1003 struct pollfd *consumer_sockpoll, struct lttcomm_relayd_sock *relayd_sock,
1004 uint64_t sessiond_id, uint64_t relayd_session_id);
1005 void consumer_flag_relayd_for_destroy(
1006 struct consumer_relayd_sock_pair *relayd);
1007 int consumer_data_pending(uint64_t id);
1008 int consumer_send_status_msg(int sock, int ret_code);
1009 int consumer_send_status_channel(int sock,
1010 struct lttng_consumer_channel *channel);
1011 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1012 uint64_t key);
1013 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1014 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1015 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1016 uint64_t max_sb_size);
1017 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1018 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1019 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1020 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1021 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1022 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1023 uint64_t key, uint64_t relayd_id, uint32_t metadata,
1024 struct lttng_consumer_local_data *ctx);
1025 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1026 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data *ctx,
1027 struct lttng_consumer_stream *stream);
1028 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1029 uint64_t key, struct lttng_consumer_local_data *ctx);
1030 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1031 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1032 const uint64_t *relayd_id, uint64_t session_id,
1033 uint64_t chunk_id,
1034 time_t chunk_creation_timestamp,
1035 const char *chunk_override_name,
1036 const struct lttng_credentials *credentials,
1037 struct lttng_directory_handle *chunk_directory_handle);
1038 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1039 const uint64_t *relayd_id, uint64_t session_id,
1040 uint64_t chunk_id, time_t chunk_close_timestamp,
1041 const enum lttng_trace_chunk_command_type *close_command,
1042 char *path);
1043 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1044 const uint64_t *relayd_id, uint64_t session_id,
1045 uint64_t chunk_id);
1046 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1047 enum lttcomm_return_code lttng_consumer_init_command(
1048 struct lttng_consumer_local_data *ctx,
1049 const lttng_uuid sessiond_uuid);
1050 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1051
1052 #endif /* LIB_CONSUMER_H */
This page took 0.081888 seconds and 4 git commands to generate.