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