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