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