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