Fix: Handle SIGBUS in sessiond and consumerd
[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 enum get_next_subbuffer_status {
303 GET_NEXT_SUBBUFFER_STATUS_OK,
304 GET_NEXT_SUBBUFFER_STATUS_NO_DATA,
305 GET_NEXT_SUBBUFFER_STATUS_ERROR,
306 };
307
308 /*
309 * Perform any operation required to acknowledge
310 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
311 *
312 * Stream and channel locks are acquired during this call.
313 */
314 typedef int (*on_wake_up_cb)(struct lttng_consumer_stream *);
315
316 /*
317 * Perform any operation required before a consumer stream is put
318 * to sleep before awaiting a data availability notification.
319 *
320 * Stream and channel locks are acquired during this call.
321 */
322 typedef int (*on_sleep_cb)(struct lttng_consumer_stream *,
323 struct lttng_consumer_local_data *);
324
325 /*
326 * Acquire the subbuffer at the current 'consumed' position.
327 *
328 * Stream and channel locks are acquired during this call.
329 */
330 typedef enum get_next_subbuffer_status (*get_next_subbuffer_cb)(
331 struct lttng_consumer_stream *, struct stream_subbuffer *);
332
333 /*
334 * Populate the stream_subbuffer's info member. The info to populate
335 * depends on the type (metadata/data) of the stream.
336 *
337 * Stream and channel locks are acquired during this call.
338 */
339 typedef int (*extract_subbuffer_info_cb)(
340 struct lttng_consumer_stream *, struct stream_subbuffer *);
341
342 /*
343 * Invoked after a subbuffer's info has been filled.
344 *
345 * Stream and channel locks are acquired during this call.
346 */
347 typedef int (*pre_consume_subbuffer_cb)(struct lttng_consumer_stream *,
348 const struct stream_subbuffer *);
349
350 /*
351 * Consume subbuffer contents.
352 *
353 * Stream and channel locks are acquired during this call.
354 */
355 typedef ssize_t (*consume_subbuffer_cb)(struct lttng_consumer_local_data *,
356 struct lttng_consumer_stream *,
357 const struct stream_subbuffer *);
358
359 /*
360 * Release the current subbuffer and advance the 'consumed' position by
361 * one subbuffer.
362 *
363 * Stream and channel locks are acquired during this call.
364 */
365 typedef int (*put_next_subbuffer_cb)(struct lttng_consumer_stream *,
366 struct stream_subbuffer *);
367
368 /*
369 * Invoked after consuming a subbuffer.
370 *
371 * Stream and channel locks are acquired during this call.
372 */
373 typedef int (*post_consume_cb)(struct lttng_consumer_stream *,
374 const struct stream_subbuffer *,
375 struct lttng_consumer_local_data *);
376
377 /*
378 * Send a live beacon if no data is available.
379 *
380 * Stream and channel locks are acquired during this call.
381 */
382 typedef int (*send_live_beacon_cb)(struct lttng_consumer_stream *);
383
384 /*
385 * Lock the stream and channel locks and any other stream-type specific
386 * lock that need to be acquired during the processing of an
387 * availability notification.
388 */
389 typedef void (*lock_cb)(struct lttng_consumer_stream *);
390
391 /*
392 * Unlock the stream and channel locks and any other stream-type specific
393 * lock before sleeping until the next availability notification.
394 *
395 * Stream and channel locks are acquired during this call.
396 */
397 typedef void (*unlock_cb)(struct lttng_consumer_stream *);
398
399 /*
400 * Invoked when a subbuffer's metadata version does not match the last
401 * known metadata version.
402 *
403 * Stream and channel locks are acquired during this call.
404 */
405 typedef void (*reset_metadata_cb)(struct lttng_consumer_stream *);
406
407 /*
408 * Internal representation of the streams, sessiond_key is used to identify
409 * uniquely a stream.
410 */
411 struct lttng_consumer_stream {
412 /* HT node used by the data_ht and metadata_ht */
413 struct lttng_ht_node_u64 node;
414 /* stream indexed per channel key node */
415 struct lttng_ht_node_u64 node_channel_id;
416 /* HT node used in consumer_data.stream_list_ht */
417 struct lttng_ht_node_u64 node_session_id;
418 /* Pointer to associated channel. */
419 struct lttng_consumer_channel *chan;
420 /*
421 * Current trace chunk. Holds a reference to the trace chunk.
422 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
423 * when it was created in the context of a no-output session.
424 */
425 struct lttng_trace_chunk *trace_chunk;
426
427 /* Key by which the stream is indexed for 'node'. */
428 uint64_t key;
429 /*
430 * File descriptor of the data output file. This can be either a file or a
431 * socket fd for relayd streaming.
432 */
433 int out_fd; /* output file to write the data */
434 /* Write position in the output file descriptor */
435 off_t out_fd_offset;
436 /* Amount of bytes written to the output */
437 uint64_t output_written;
438 int shm_fd_is_copy;
439 int data_read;
440 int hangup_flush_done;
441
442 /*
443 * Whether the stream is in a "complete" state (e.g. it does not have a
444 * partially written sub-buffer.
445 *
446 * Initialized to "false" on stream creation (first packet is empty).
447 *
448 * The various transitions of the quiescent state are:
449 * - On "start" tracing: set to false, since the stream is not
450 * "complete".
451 * - On "stop" tracing: if !quiescent -> flush FINAL (update
452 * timestamp_end), and set to true; the stream has entered a
453 * complete/quiescent state.
454 * - On "destroy" or stream/application hang-up: if !quiescent ->
455 * flush FINAL, and set to true.
456 *
457 * NOTE: Update and read are protected by the stream lock.
458 */
459 bool quiescent;
460
461 /*
462 * True if the sequence number is not available (lttng-modules < 2.8).
463 */
464 bool sequence_number_unavailable;
465
466 /*
467 * metadata_timer_lock protects flags waiting_on_metadata and
468 * missed_metadata_flush.
469 */
470 pthread_mutex_t metadata_timer_lock;
471 /*
472 * Flag set when awaiting metadata to be pushed. Used in the
473 * timer thread to skip waiting on the stream (and stream lock) to
474 * ensure we can proceed to flushing metadata in live mode.
475 */
476 bool waiting_on_metadata;
477 /* Raised when a timer misses a metadata flush. */
478 bool missed_metadata_flush;
479
480 enum lttng_event_output output;
481 /* Maximum subbuffer size (in bytes). */
482 unsigned long max_sb_size;
483
484 /*
485 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
486 * used for the mmap base and offset.
487 */
488 void *mmap_base;
489 unsigned long mmap_len;
490
491 /* For UST */
492
493 int wait_fd;
494 /* Network sequence number. Indicating on which relayd socket it goes. */
495 uint64_t net_seq_idx;
496 /*
497 * Indicate if this stream was successfully sent to a relayd. This is set
498 * after the refcount of the relayd is incremented and is checked when the
499 * stream is closed before decrementing the refcount in order to avoid an
500 * unbalanced state.
501 */
502 unsigned int sent_to_relayd;
503
504 /* Identify if the stream is the metadata */
505 unsigned int metadata_flag;
506 /*
507 * Last known metadata version, reset the metadata file in case
508 * of change.
509 */
510 uint64_t metadata_version;
511 /* Used when the stream is set for network streaming */
512 uint64_t relayd_stream_id;
513 /*
514 * When sending a stream packet to a relayd, this number is used to track
515 * the packet sent by the consumer and seen by the relayd. When sending the
516 * data header to the relayd, this number is sent and if the transmission
517 * was successful, it is incremented.
518 *
519 * Even if the full data is not fully transmitted it won't matter since
520 * only two possible error can happen after that where either the relayd
521 * died or a read error is detected on the stream making this value useless
522 * after that.
523 *
524 * This value SHOULD be read/updated atomically or with the lock acquired.
525 */
526 uint64_t next_net_seq_num;
527 /*
528 * Lock to use the stream FDs since they are used between threads.
529 *
530 * This is nested INSIDE the consumer_data lock.
531 * This is nested INSIDE the channel lock.
532 * This is nested INSIDE the channel timer lock.
533 * This is nested OUTSIDE the metadata cache lock.
534 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
535 */
536 pthread_mutex_t lock;
537 /* Tracing session id */
538 uint64_t session_id;
539 /*
540 * Indicates if the stream end point is still active or not (network
541 * streaming or local file system). The thread "owning" the stream is
542 * handling this status and can be notified of a state change through the
543 * consumer data appropriate pipe.
544 */
545 enum consumer_endpoint_status endpoint_status;
546 /* Stream name. Format is: <channel_name>_<cpu_number> */
547 char name[LTTNG_SYMBOL_NAME_LEN];
548 /* Internal state of libustctl. */
549 struct lttng_ust_ctl_consumer_stream *ustream;
550 struct cds_list_head send_node;
551 /* On-disk circular buffer */
552 uint64_t tracefile_size_current;
553 uint64_t tracefile_count_current;
554 /*
555 * Monitor or not the streams of this channel meaning this indicates if the
556 * streams should be sent to the data/metadata thread or added to the no
557 * monitor list of the channel.
558 */
559 unsigned int monitor;
560 /*
561 * Indicate if the stream is globally visible meaning that it has been
562 * added to the multiple hash tables. If *not* set, NO lock should be
563 * acquired in the destroy path.
564 */
565 unsigned int globally_visible;
566 /*
567 * Pipe to wake up the metadata poll thread when the UST metadata
568 * cache is updated.
569 */
570 int ust_metadata_poll_pipe[2];
571 /*
572 * How much metadata was read from the metadata cache and sent
573 * to the channel.
574 */
575 uint64_t ust_metadata_pushed;
576 /*
577 * Copy of the last discarded event value to detect the overflow of
578 * the counter.
579 */
580 uint64_t last_discarded_events;
581 /* Copy of the sequence number of the last packet extracted. */
582 uint64_t last_sequence_number;
583 /*
584 * Index file object of the index file for this stream.
585 */
586 struct lttng_index_file *index_file;
587
588 /*
589 * Local pipe to extract data when using splice.
590 */
591 int splice_pipe[2];
592
593 /*
594 * Rendez-vous point between data and metadata stream in live mode.
595 */
596 pthread_cond_t metadata_rdv;
597 pthread_mutex_t metadata_rdv_lock;
598
599 /*
600 * rotate_position represents the packet sequence number of the last
601 * packet which belongs to the current trace chunk prior to the rotation.
602 * When that position is reached, this tracefile can be closed and a
603 * new one is created in channel_read_only_attributes.path.
604 */
605 uint64_t rotate_position;
606
607 /* Whether or not a packet was opened during the current trace chunk. */
608 bool opened_packet_in_current_trace_chunk;
609
610 /*
611 * Read-only copies of channel values. We cannot safely access the
612 * channel from a stream, so we need to have a local copy of these
613 * fields in the stream object. These fields should be removed from
614 * the stream objects when we introduce refcounting.
615 */
616 struct {
617 uint64_t tracefile_size;
618 } channel_read_only_attributes;
619
620 /*
621 * Flag to inform the data or metadata thread that a stream is
622 * ready to be rotated.
623 */
624 bool rotate_ready;
625
626 /* Indicate if the stream still has some data to be read. */
627 unsigned int has_data:1;
628 /*
629 * Inform the consumer or relay to reset the metadata
630 * file before writing in it (regeneration).
631 */
632 unsigned int reset_metadata_flag:1;
633 struct {
634 /*
635 * Invoked in the order of declaration.
636 * See callback type definitions.
637 */
638 lock_cb lock;
639 on_wake_up_cb on_wake_up;
640 get_next_subbuffer_cb get_next_subbuffer;
641 extract_subbuffer_info_cb extract_subbuffer_info;
642 pre_consume_subbuffer_cb pre_consume_subbuffer;
643 reset_metadata_cb reset_metadata;
644 consume_subbuffer_cb consume_subbuffer;
645 put_next_subbuffer_cb put_next_subbuffer;
646 struct lttng_dynamic_array post_consume_cbs;
647 send_live_beacon_cb send_live_beacon;
648 on_sleep_cb on_sleep;
649 unlock_cb unlock;
650 } read_subbuffer_ops;
651 struct metadata_bucket *metadata_bucket;
652 };
653
654 /*
655 * Internal representation of a relayd socket pair.
656 */
657 struct consumer_relayd_sock_pair {
658 /* Network sequence number. */
659 uint64_t net_seq_idx;
660 /* Number of stream associated with this relayd */
661 int refcount;
662
663 /*
664 * This flag indicates whether or not we should destroy this object. The
665 * destruction should ONLY occurs when this flag is set and the refcount is
666 * set to zero.
667 */
668 unsigned int destroy_flag;
669
670 /*
671 * Mutex protecting the control socket to avoid out of order packets
672 * between threads sending data to the relayd. Since metadata data is sent
673 * over that socket, at least two sendmsg() are needed (header + data)
674 * creating a race for packets to overlap between threads using it.
675 *
676 * This is nested INSIDE the consumer_data lock.
677 * This is nested INSIDE the stream lock.
678 */
679 pthread_mutex_t ctrl_sock_mutex;
680
681 /* Control socket. Command and metadata are passed over it */
682 struct lttcomm_relayd_sock control_sock;
683
684 /*
685 * We don't need a mutex at this point since we only splice or write single
686 * large chunk of data with a header appended at the begining. Moreover,
687 * this socket is for now only used in a single thread.
688 */
689 struct lttcomm_relayd_sock data_sock;
690 struct lttng_ht_node_u64 node;
691
692 /* Session id on both sides for the sockets. */
693 uint64_t relayd_session_id;
694 uint64_t sessiond_session_id;
695 struct lttng_consumer_local_data *ctx;
696 };
697
698 /*
699 * UST consumer local data to the program. One or more instance per
700 * process.
701 */
702 struct lttng_consumer_local_data {
703 /*
704 * Function to call when data is available on a buffer.
705 * Returns the number of bytes read, or negative error value.
706 */
707 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
708 struct lttng_consumer_local_data *ctx,
709 bool locked_by_caller);
710 /*
711 * function to call when we receive a new channel, it receives a
712 * newly allocated channel, depending on the return code of this
713 * function, the new channel will be handled by the application
714 * or the library.
715 *
716 * Returns:
717 * > 0 (success, FD is kept by application)
718 * == 0 (success, FD is left to library)
719 * < 0 (error)
720 */
721 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
722 /*
723 * function to call when we receive a new stream, it receives a
724 * newly allocated stream, depending on the return code of this
725 * function, the new stream will be handled by the application
726 * or the library.
727 *
728 * Returns:
729 * > 0 (success, FD is kept by application)
730 * == 0 (success, FD is left to library)
731 * < 0 (error)
732 */
733 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
734 /*
735 * function to call when a stream is getting updated by the session
736 * daemon, this function receives the sessiond key and the new
737 * state, depending on the return code of this function the
738 * update of state for the stream is handled by the application
739 * or the library.
740 *
741 * Returns:
742 * > 0 (success, FD is kept by application)
743 * == 0 (success, FD is left to library)
744 * < 0 (error)
745 */
746 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
747 enum lttng_consumer_type type;
748 /* socket to communicate errors with sessiond */
749 int consumer_error_socket;
750 /* socket to ask metadata to sessiond. */
751 int consumer_metadata_socket;
752 /*
753 * Protect consumer_metadata_socket.
754 *
755 * This is nested OUTSIDE the metadata cache lock.
756 */
757 pthread_mutex_t metadata_socket_lock;
758 /* socket to exchange commands with sessiond */
759 char *consumer_command_sock_path;
760 /* communication with splice */
761 int consumer_channel_pipe[2];
762 /* Data stream poll thread pipe. To transfer data stream to the thread */
763 struct lttng_pipe *consumer_data_pipe;
764
765 /*
766 * Data thread use that pipe to catch wakeup from read subbuffer that
767 * detects that there is still data to be read for the stream encountered.
768 * Before doing so, the stream is flagged to indicate that there is still
769 * data to be read.
770 *
771 * Both pipes (read/write) are owned and used inside the data thread.
772 */
773 struct lttng_pipe *consumer_wakeup_pipe;
774 /* Indicate if the wakeup thread has been notified. */
775 unsigned int has_wakeup:1;
776
777 /* to let the signal handler wake up the fd receiver thread */
778 int consumer_should_quit[2];
779 /* Metadata poll thread pipe. Transfer metadata stream to it */
780 struct lttng_pipe *consumer_metadata_pipe;
781 /*
782 * Pipe used by the channel monitoring timers to provide state samples
783 * to the session daemon (write-only).
784 */
785 int channel_monitor_pipe;
786 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
787 };
788
789 /*
790 * Library-level data. One instance per process.
791 */
792 struct lttng_consumer_global_data {
793 /*
794 * At this time, this lock is used to ensure coherence between the count
795 * and number of element in the hash table. It's also a protection for
796 * concurrent read/write between threads.
797 *
798 * This is nested OUTSIDE the stream lock.
799 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
800 */
801 pthread_mutex_t lock;
802
803 /*
804 * Number of streams in the data stream hash table declared outside.
805 * Protected by consumer_data.lock.
806 */
807 int stream_count;
808
809 /* Channel hash table protected by consumer_data.lock. */
810 struct lttng_ht *channel_ht;
811 /* Channel hash table indexed by session id. */
812 struct lttng_ht *channels_by_session_id_ht;
813 /*
814 * Flag specifying if the local array of FDs needs update in the
815 * poll function. Protected by consumer_data.lock.
816 */
817 unsigned int need_update;
818 enum lttng_consumer_type type;
819
820 /*
821 * Relayd socket(s) hashtable indexed by network sequence number. Each
822 * stream has an index which associate the right relayd socket to use.
823 */
824 struct lttng_ht *relayd_ht;
825
826 /*
827 * This hash table contains all streams (metadata and data) indexed by
828 * session id. In other words, the ht is indexed by session id and each
829 * bucket contains the list of associated streams.
830 *
831 * This HT uses the "node_session_id" of the consumer stream.
832 */
833 struct lttng_ht *stream_list_ht;
834
835 /*
836 * This HT uses the "node_channel_id" of the consumer stream.
837 */
838 struct lttng_ht *stream_per_chan_id_ht;
839
840 /*
841 * Trace chunk registry indexed by (session_id, chunk_id).
842 */
843 struct lttng_trace_chunk_registry *chunk_registry;
844 };
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 /*
853 * Set to nonzero when the consumer is exiting. Updated by signal
854 * handler and thread exit, read by threads.
855 */
856 extern int consumer_quit;
857
858 /* Flag used to temporarily pause data consumption from testpoints. */
859 extern int data_consumption_paused;
860
861 /* Return a human-readable consumer type string that is suitable for logging. */
862 static inline
863 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
864 {
865 switch (type) {
866 case LTTNG_CONSUMER_UNKNOWN:
867 return "unknown";
868 case LTTNG_CONSUMER_KERNEL:
869 return "kernel";
870 case LTTNG_CONSUMER32_UST:
871 return "32-bit user space";
872 case LTTNG_CONSUMER64_UST:
873 return "64-bit user space";
874 default:
875 abort();
876 }
877 }
878
879 /*
880 * Init consumer data structures.
881 */
882 int lttng_consumer_init(void);
883
884 /*
885 * Set the error socket for communication with a session daemon.
886 */
887 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
888 int sock);
889
890 /*
891 * Set the command socket path for communication with a session daemon.
892 */
893 void lttng_consumer_set_command_sock_path(
894 struct lttng_consumer_local_data *ctx, char *sock);
895
896 /*
897 * Send return code to session daemon.
898 *
899 * Returns the return code of sendmsg : the number of bytes transmitted or -1
900 * on error.
901 */
902 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
903
904 /*
905 * Called from signal handler to ensure a clean exit.
906 */
907 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
908
909 /*
910 * Cleanup the daemon's socket on exit.
911 */
912 void lttng_consumer_cleanup(void);
913
914 /*
915 * Poll on the should_quit pipe and the command socket return -1 on error and
916 * should exit, 0 if data is available on the command socket
917 */
918 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
919
920 /*
921 * Copy the fields from the channel that need to be accessed (read-only)
922 * directly from the stream.
923 */
924 void consumer_stream_update_channel_attributes(
925 struct lttng_consumer_stream *stream,
926 struct lttng_consumer_channel *channel);
927
928 struct lttng_consumer_stream *consumer_allocate_stream(
929 struct lttng_consumer_channel *channel,
930 uint64_t channel_key,
931 uint64_t stream_key,
932 const char *channel_name,
933 uint64_t relayd_id,
934 uint64_t session_id,
935 struct lttng_trace_chunk *trace_chunk,
936 int cpu,
937 int *alloc_ret,
938 enum consumer_channel_type type,
939 unsigned int monitor);
940 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
941 uint64_t session_id,
942 const uint64_t *chunk_id,
943 const char *pathname,
944 const char *name,
945 uint64_t relayd_id,
946 enum lttng_event_output output,
947 uint64_t tracefile_size,
948 uint64_t tracefile_count,
949 uint64_t session_id_per_pid,
950 unsigned int monitor,
951 unsigned int live_timer_interval,
952 bool is_in_live_session,
953 const char *root_shm_path,
954 const char *shm_path);
955 void consumer_del_stream(struct lttng_consumer_stream *stream,
956 struct lttng_ht *ht);
957 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
958 struct lttng_ht *ht);
959 int consumer_add_channel(struct lttng_consumer_channel *channel,
960 struct lttng_consumer_local_data *ctx);
961 void consumer_del_channel(struct lttng_consumer_channel *channel);
962
963 /* lttng-relayd consumer command */
964 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
965 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
966 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
967 void close_relayd_stream(struct lttng_consumer_stream *stream);
968 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
969 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
970 size_t data_size);
971 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
972
973 struct lttng_consumer_local_data *lttng_consumer_create(
974 enum lttng_consumer_type type,
975 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
976 struct lttng_consumer_local_data *ctx,
977 bool locked_by_caller),
978 int (*recv_channel)(struct lttng_consumer_channel *channel),
979 int (*recv_stream)(struct lttng_consumer_stream *stream),
980 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
981 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
982 ssize_t lttng_consumer_on_read_subbuffer_mmap(
983 struct lttng_consumer_stream *stream,
984 const struct lttng_buffer_view *buffer,
985 unsigned long padding);
986 ssize_t lttng_consumer_on_read_subbuffer_splice(
987 struct lttng_consumer_local_data *ctx,
988 struct lttng_consumer_stream *stream, unsigned long len,
989 unsigned long padding);
990 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
991 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
992 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
993 unsigned long *pos);
994 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
995 unsigned long *pos);
996 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
997 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
998 void *consumer_thread_metadata_poll(void *data);
999 void *consumer_thread_data_poll(void *data);
1000 void *consumer_thread_sessiond_poll(void *data);
1001 void *consumer_thread_channel_poll(void *data);
1002 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1003 int sock, struct pollfd *consumer_sockpoll);
1004
1005 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1006 struct lttng_consumer_local_data *ctx,
1007 bool locked_by_caller);
1008 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1009 void consumer_add_relayd_socket(uint64_t net_seq_idx, int sock_type,
1010 struct lttng_consumer_local_data *ctx, int sock,
1011 struct pollfd *consumer_sockpoll, struct lttcomm_relayd_sock *relayd_sock,
1012 uint64_t sessiond_id, uint64_t relayd_session_id);
1013 void consumer_flag_relayd_for_destroy(
1014 struct consumer_relayd_sock_pair *relayd);
1015 int consumer_data_pending(uint64_t id);
1016 int consumer_send_status_msg(int sock, int ret_code);
1017 int consumer_send_status_channel(int sock,
1018 struct lttng_consumer_channel *channel);
1019 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1020 uint64_t key);
1021 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1022 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1023 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1024 uint64_t max_sb_size);
1025 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1026 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1027 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1028 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1029 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1030 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1031 uint64_t key, uint64_t relayd_id, uint32_t metadata,
1032 struct lttng_consumer_local_data *ctx);
1033 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1034 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data *ctx,
1035 struct lttng_consumer_stream *stream);
1036 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1037 uint64_t key, struct lttng_consumer_local_data *ctx);
1038 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1039 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1040 const uint64_t *relayd_id, uint64_t session_id,
1041 uint64_t chunk_id,
1042 time_t chunk_creation_timestamp,
1043 const char *chunk_override_name,
1044 const struct lttng_credentials *credentials,
1045 struct lttng_directory_handle *chunk_directory_handle);
1046 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1047 const uint64_t *relayd_id, uint64_t session_id,
1048 uint64_t chunk_id, time_t chunk_close_timestamp,
1049 const enum lttng_trace_chunk_command_type *close_command,
1050 char *path);
1051 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1052 const uint64_t *relayd_id, uint64_t session_id,
1053 uint64_t chunk_id);
1054 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1055 enum lttcomm_return_code lttng_consumer_init_command(
1056 struct lttng_consumer_local_data *ctx,
1057 const lttng_uuid sessiond_uuid);
1058 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1059 enum lttcomm_return_code lttng_consumer_open_channel_packets(
1060 struct lttng_consumer_channel *channel);
1061 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1062 void lttng_consumer_sigbus_handle(void *addr);
1063
1064 #endif /* LIB_CONSUMER_H */
This page took 0.051353 seconds and 5 git commands to generate.