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