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