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