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