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