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