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