Fix: leak of consumer_output when using an explicit snapshot output
[lttng-tools.git] / src / common / consumer / consumer.h
1 /*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@efficios.com>
5 * 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 2 only,
9 * as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #ifndef LIB_CONSUMER_H
22 #define LIB_CONSUMER_H
23
24 #include <limits.h>
25 #include <poll.h>
26 #include <unistd.h>
27 #include <urcu/list.h>
28
29 #include <lttng/lttng.h>
30
31 #include <common/hashtable/hashtable.h>
32 #include <common/compat/fcntl.h>
33 #include <common/compat/uuid.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/pipe.h>
36 #include <common/index/ctf-index.h>
37 #include <common/trace-chunk-registry.h>
38 #include <common/credentials.h>
39
40 /* Commands for consumer */
41 enum lttng_consumer_command {
42 LTTNG_CONSUMER_ADD_CHANNEL,
43 LTTNG_CONSUMER_ADD_STREAM,
44 /* pause, delete, active depending on fd state */
45 LTTNG_CONSUMER_UPDATE_STREAM,
46 /* inform the consumer to quit when all fd has hang up */
47 LTTNG_CONSUMER_STOP, /* deprecated */
48 LTTNG_CONSUMER_ADD_RELAYD_SOCKET,
49 /* Inform the consumer to kill a specific relayd connection */
50 LTTNG_CONSUMER_DESTROY_RELAYD,
51 /* Return to the sessiond if there is data pending for a session */
52 LTTNG_CONSUMER_DATA_PENDING,
53 /* Consumer creates a channel and returns it to sessiond. */
54 LTTNG_CONSUMER_ASK_CHANNEL_CREATION,
55 LTTNG_CONSUMER_GET_CHANNEL,
56 LTTNG_CONSUMER_DESTROY_CHANNEL,
57 LTTNG_CONSUMER_PUSH_METADATA,
58 LTTNG_CONSUMER_CLOSE_METADATA,
59 LTTNG_CONSUMER_SETUP_METADATA,
60 LTTNG_CONSUMER_FLUSH_CHANNEL,
61 LTTNG_CONSUMER_SNAPSHOT_CHANNEL,
62 LTTNG_CONSUMER_SNAPSHOT_METADATA,
63 LTTNG_CONSUMER_STREAMS_SENT,
64 LTTNG_CONSUMER_DISCARDED_EVENTS,
65 LTTNG_CONSUMER_LOST_PACKETS,
66 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL,
67 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE,
68 LTTNG_CONSUMER_ROTATE_CHANNEL,
69 LTTNG_CONSUMER_INIT,
70 LTTNG_CONSUMER_CREATE_TRACE_CHUNK,
71 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK,
72 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS,
73 };
74
75 enum lttng_consumer_type {
76 LTTNG_CONSUMER_UNKNOWN = 0,
77 LTTNG_CONSUMER_KERNEL,
78 LTTNG_CONSUMER64_UST,
79 LTTNG_CONSUMER32_UST,
80 };
81
82 enum consumer_endpoint_status {
83 CONSUMER_ENDPOINT_ACTIVE,
84 CONSUMER_ENDPOINT_INACTIVE,
85 };
86
87 enum consumer_channel_output {
88 CONSUMER_CHANNEL_MMAP = 0,
89 CONSUMER_CHANNEL_SPLICE = 1,
90 };
91
92 enum consumer_channel_type {
93 CONSUMER_CHANNEL_TYPE_METADATA = 0,
94 CONSUMER_CHANNEL_TYPE_DATA = 1,
95 };
96
97 extern struct lttng_consumer_global_data consumer_data;
98
99 struct stream_list {
100 struct cds_list_head head;
101 unsigned int count;
102 };
103
104 /* Stub. */
105 struct consumer_metadata_cache;
106
107 struct lttng_consumer_channel {
108 /* Is the channel published in the channel hash tables? */
109 bool is_published;
110 /* HT node used for consumer_data.channel_ht */
111 struct lttng_ht_node_u64 node;
112 /* HT node used for consumer_data.channels_by_session_id_ht */
113 struct lttng_ht_node_u64 channels_by_session_id_ht_node;
114 /* Indexed key. Incremented value in the consumer. */
115 uint64_t key;
116 /* Number of streams referencing this channel */
117 int refcount;
118 /* Tracing session id on the session daemon side. */
119 uint64_t session_id;
120 /* Current trace chunk of the session in which this channel exists. */
121 struct lttng_trace_chunk *trace_chunk;
122 /*
123 * Session id when requesting metadata to the session daemon for
124 * a session with per-PID buffers.
125 */
126 uint64_t session_id_per_pid;
127 /* Channel trace file path name. */
128 char pathname[PATH_MAX];
129 /* Channel name. */
130 char name[LTTNG_SYMBOL_NAME_LEN];
131 /* Relayd id of the channel. -1ULL if it does not apply. */
132 uint64_t relayd_id;
133 /*
134 * Number of streams NOT initialized yet. This is used in order to not
135 * delete this channel if streams are getting initialized.
136 */
137 unsigned int nb_init_stream_left;
138 /* Output type (mmap or splice). */
139 enum consumer_channel_output output;
140 /* Channel type for stream */
141 enum consumer_channel_type type;
142
143 /* For UST */
144 uid_t ust_app_uid; /* Application UID. */
145 struct ustctl_consumer_channel *uchan;
146 unsigned char uuid[UUID_STR_LEN];
147 /*
148 * Temporary stream list used to store the streams once created and waiting
149 * to be sent to the session daemon by receiving the
150 * LTTNG_CONSUMER_GET_CHANNEL.
151 */
152 struct stream_list streams;
153
154 /*
155 * Set if the channel is metadata. We keep a reference to the stream
156 * because we have to flush data once pushed by the session daemon. For a
157 * regular channel, this is always set to NULL.
158 */
159 struct lttng_consumer_stream *metadata_stream;
160
161 /* for UST */
162 int wait_fd;
163 /* Node within channel thread ht */
164 struct lttng_ht_node_u64 wait_fd_node;
165
166 /* Metadata cache is metadata channel */
167 struct consumer_metadata_cache *metadata_cache;
168
169 /* For UST metadata periodical flush */
170 int switch_timer_enabled;
171 timer_t switch_timer;
172 int switch_timer_error;
173
174 /* For the live mode */
175 int live_timer_enabled;
176 timer_t live_timer;
177 int live_timer_error;
178
179 /* For channel monitoring timer. */
180 int monitor_timer_enabled;
181 timer_t monitor_timer;
182
183 /* On-disk circular buffer */
184 uint64_t tracefile_size;
185 uint64_t tracefile_count;
186 /*
187 * Monitor or not the streams of this channel meaning this indicates if the
188 * streams should be sent to the data/metadata thread or added to the no
189 * monitor list of the channel.
190 */
191 unsigned int monitor;
192
193 /*
194 * Channel lock.
195 *
196 * This lock protects against concurrent update of channel.
197 *
198 * This is nested INSIDE the consumer data lock.
199 * This is nested OUTSIDE the channel timer lock.
200 * This is nested OUTSIDE the metadata cache lock.
201 * This is nested OUTSIDE stream lock.
202 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
203 */
204 pthread_mutex_t lock;
205
206 /*
207 * Channel teardown lock.
208 *
209 * This lock protect against teardown of channel. It is _never_
210 * taken by the timer handler.
211 *
212 * This is nested INSIDE the consumer data lock.
213 * This is nested INSIDE the channel lock.
214 * This is nested OUTSIDE the metadata cache lock.
215 * This is nested OUTSIDE stream lock.
216 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
217 */
218 pthread_mutex_t timer_lock;
219
220 /* Timer value in usec for live streaming. */
221 unsigned int live_timer_interval;
222
223 int *stream_fds;
224 int nr_stream_fds;
225 char root_shm_path[PATH_MAX];
226 char shm_path[PATH_MAX];
227 /* Only set for UST channels. */
228 LTTNG_OPTIONAL(struct lttng_credentials) buffer_credentials;
229 /* Total number of discarded events for that channel. */
230 uint64_t discarded_events;
231 /* Total number of missed packets due to overwriting (overwrite). */
232 uint64_t lost_packets;
233
234 bool streams_sent_to_relayd;
235 };
236
237 /*
238 * Internal representation of the streams, sessiond_key is used to identify
239 * uniquely a stream.
240 */
241 struct lttng_consumer_stream {
242 /* HT node used by the data_ht and metadata_ht */
243 struct lttng_ht_node_u64 node;
244 /* stream indexed per channel key node */
245 struct lttng_ht_node_u64 node_channel_id;
246 /* HT node used in consumer_data.stream_list_ht */
247 struct lttng_ht_node_u64 node_session_id;
248 /* Pointer to associated channel. */
249 struct lttng_consumer_channel *chan;
250 /*
251 * Current trace chunk. Holds a reference to the trace chunk.
252 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
253 * when it was created in the context of a no-output session.
254 */
255 struct lttng_trace_chunk *trace_chunk;
256
257 /* Key by which the stream is indexed for 'node'. */
258 uint64_t key;
259 /*
260 * File descriptor of the data output file. This can be either a file or a
261 * socket fd for relayd streaming.
262 */
263 int out_fd; /* output file to write the data */
264 /* Write position in the output file descriptor */
265 off_t out_fd_offset;
266 /* Amount of bytes written to the output */
267 uint64_t output_written;
268 int shm_fd_is_copy;
269 int data_read;
270 int hangup_flush_done;
271
272 /*
273 * Whether the stream is in a "complete" state (e.g. it does not have a
274 * partially written sub-buffer.
275 *
276 * Initialized to "false" on stream creation (first packet is empty).
277 *
278 * The various transitions of the quiescent state are:
279 * - On "start" tracing: set to false, since the stream is not
280 * "complete".
281 * - On "stop" tracing: if !quiescent -> flush FINAL (update
282 * timestamp_end), and set to true; the stream has entered a
283 * complete/quiescent state.
284 * - On "destroy" or stream/application hang-up: if !quiescent ->
285 * flush FINAL, and set to true.
286 *
287 * NOTE: Update and read are protected by the stream lock.
288 */
289 bool quiescent;
290
291 /*
292 * metadata_timer_lock protects flags waiting_on_metadata and
293 * missed_metadata_flush.
294 */
295 pthread_mutex_t metadata_timer_lock;
296 /*
297 * Flag set when awaiting metadata to be pushed. Used in the
298 * timer thread to skip waiting on the stream (and stream lock) to
299 * ensure we can proceed to flushing metadata in live mode.
300 */
301 bool waiting_on_metadata;
302 /* Raised when a timer misses a metadata flush. */
303 bool missed_metadata_flush;
304
305 enum lttng_event_output output;
306 /* Maximum subbuffer size. */
307 unsigned long max_sb_size;
308
309 /*
310 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
311 * used for the mmap base and offset.
312 */
313 void *mmap_base;
314 unsigned long mmap_len;
315
316 /* For UST */
317
318 int wait_fd;
319 /* Network sequence number. Indicating on which relayd socket it goes. */
320 uint64_t net_seq_idx;
321 /*
322 * Indicate if this stream was successfully sent to a relayd. This is set
323 * after the refcount of the relayd is incremented and is checked when the
324 * stream is closed before decrementing the refcount in order to avoid an
325 * unbalanced state.
326 */
327 unsigned int sent_to_relayd;
328
329 /* Identify if the stream is the metadata */
330 unsigned int metadata_flag;
331 /*
332 * Last known metadata version, reset the metadata file in case
333 * of change.
334 */
335 uint64_t metadata_version;
336 /* Used when the stream is set for network streaming */
337 uint64_t relayd_stream_id;
338 /*
339 * When sending a stream packet to a relayd, this number is used to track
340 * the packet sent by the consumer and seen by the relayd. When sending the
341 * data header to the relayd, this number is sent and if the transmission
342 * was successful, it is incremented.
343 *
344 * Even if the full data is not fully transmitted it won't matter since
345 * only two possible error can happen after that where either the relayd
346 * died or a read error is detected on the stream making this value useless
347 * after that.
348 *
349 * This value SHOULD be read/updated atomically or with the lock acquired.
350 */
351 uint64_t next_net_seq_num;
352 /*
353 * Lock to use the stream FDs since they are used between threads.
354 *
355 * This is nested INSIDE the consumer_data lock.
356 * This is nested INSIDE the channel lock.
357 * This is nested INSIDE the channel timer lock.
358 * This is nested OUTSIDE the metadata cache lock.
359 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
360 */
361 pthread_mutex_t lock;
362 /* Tracing session id */
363 uint64_t session_id;
364 /*
365 * Indicates if the stream end point is still active or not (network
366 * streaming or local file system). The thread "owning" the stream is
367 * handling this status and can be notified of a state change through the
368 * consumer data appropriate pipe.
369 */
370 enum consumer_endpoint_status endpoint_status;
371 /* Stream name. Format is: <channel_name>_<cpu_number> */
372 char name[LTTNG_SYMBOL_NAME_LEN];
373 /* Internal state of libustctl. */
374 struct ustctl_consumer_stream *ustream;
375 struct cds_list_head send_node;
376 /* On-disk circular buffer */
377 uint64_t tracefile_size_current;
378 uint64_t tracefile_count_current;
379 /*
380 * Monitor or not the streams of this channel meaning this indicates if the
381 * streams should be sent to the data/metadata thread or added to the no
382 * monitor list of the channel.
383 */
384 unsigned int monitor;
385 /*
386 * Indicate if the stream is globally visible meaning that it has been
387 * added to the multiple hash tables. If *not* set, NO lock should be
388 * acquired in the destroy path.
389 */
390 unsigned int globally_visible;
391 /*
392 * Pipe to wake up the metadata poll thread when the UST metadata
393 * cache is updated.
394 */
395 int ust_metadata_poll_pipe[2];
396 /*
397 * How much metadata was read from the metadata cache and sent
398 * to the channel.
399 */
400 uint64_t ust_metadata_pushed;
401 /*
402 * Copy of the last discarded event value to detect the overflow of
403 * the counter.
404 */
405 uint64_t last_discarded_events;
406 /* Copy of the sequence number of the last packet extracted. */
407 uint64_t last_sequence_number;
408 /*
409 * Index file object of the index file for this stream.
410 */
411 struct lttng_index_file *index_file;
412
413 /*
414 * Local pipe to extract data when using splice.
415 */
416 int splice_pipe[2];
417
418 /*
419 * Rendez-vous point between data and metadata stream in live mode.
420 */
421 pthread_cond_t metadata_rdv;
422 pthread_mutex_t metadata_rdv_lock;
423
424 /*
425 * rotate_position represents the position in the ring-buffer that has to
426 * be flushed to disk to complete the ongoing rotation. When that position
427 * is reached, this tracefile can be closed and a new one is created in
428 * channel_read_only_attributes.path.
429 */
430 unsigned long rotate_position;
431
432 /*
433 * Read-only copies of channel values. We cannot safely access the
434 * channel from a stream, so we need to have a local copy of these
435 * fields in the stream object. These fields should be removed from
436 * the stream objects when we introduce refcounting.
437 */
438 struct {
439 uint64_t tracefile_size;
440 } channel_read_only_attributes;
441
442 /*
443 * Flag to inform the data or metadata thread that a stream is
444 * ready to be rotated.
445 */
446 bool rotate_ready;
447
448 /* Indicate if the stream still has some data to be read. */
449 unsigned int has_data:1;
450 /*
451 * Inform the consumer or relay to reset the metadata
452 * file before writing in it (regeneration).
453 */
454 unsigned int reset_metadata_flag:1;
455 };
456
457 /*
458 * Internal representation of a relayd socket pair.
459 */
460 struct consumer_relayd_sock_pair {
461 /* Network sequence number. */
462 uint64_t net_seq_idx;
463 /* Number of stream associated with this relayd */
464 int refcount;
465
466 /*
467 * This flag indicates whether or not we should destroy this object. The
468 * destruction should ONLY occurs when this flag is set and the refcount is
469 * set to zero.
470 */
471 unsigned int destroy_flag;
472
473 /*
474 * Mutex protecting the control socket to avoid out of order packets
475 * between threads sending data to the relayd. Since metadata data is sent
476 * over that socket, at least two sendmsg() are needed (header + data)
477 * creating a race for packets to overlap between threads using it.
478 *
479 * This is nested INSIDE the consumer_data lock.
480 * This is nested INSIDE the stream lock.
481 */
482 pthread_mutex_t ctrl_sock_mutex;
483
484 /* Control socket. Command and metadata are passed over it */
485 struct lttcomm_relayd_sock control_sock;
486
487 /*
488 * We don't need a mutex at this point since we only splice or write single
489 * large chunk of data with a header appended at the begining. Moreover,
490 * this socket is for now only used in a single thread.
491 */
492 struct lttcomm_relayd_sock data_sock;
493 struct lttng_ht_node_u64 node;
494
495 /* Session id on both sides for the sockets. */
496 uint64_t relayd_session_id;
497 uint64_t sessiond_session_id;
498 struct lttng_consumer_local_data *ctx;
499 };
500
501 /*
502 * UST consumer local data to the program. One or more instance per
503 * process.
504 */
505 struct lttng_consumer_local_data {
506 /*
507 * Function to call when data is available on a buffer.
508 * Returns the number of bytes read, or negative error value.
509 */
510 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
511 struct lttng_consumer_local_data *ctx);
512 /*
513 * function to call when we receive a new channel, it receives a
514 * newly allocated channel, depending on the return code of this
515 * function, the new channel will be handled by the application
516 * or the library.
517 *
518 * Returns:
519 * > 0 (success, FD is kept by application)
520 * == 0 (success, FD is left to library)
521 * < 0 (error)
522 */
523 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
524 /*
525 * function to call when we receive a new stream, it receives a
526 * newly allocated stream, depending on the return code of this
527 * function, the new stream will be handled by the application
528 * or the library.
529 *
530 * Returns:
531 * > 0 (success, FD is kept by application)
532 * == 0 (success, FD is left to library)
533 * < 0 (error)
534 */
535 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
536 /*
537 * function to call when a stream is getting updated by the session
538 * daemon, this function receives the sessiond key and the new
539 * state, depending on the return code of this function the
540 * update of state for the stream is handled by the application
541 * or the library.
542 *
543 * Returns:
544 * > 0 (success, FD is kept by application)
545 * == 0 (success, FD is left to library)
546 * < 0 (error)
547 */
548 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
549 enum lttng_consumer_type type;
550 /* socket to communicate errors with sessiond */
551 int consumer_error_socket;
552 /* socket to ask metadata to sessiond. */
553 int consumer_metadata_socket;
554 /*
555 * Protect consumer_metadata_socket.
556 *
557 * This is nested OUTSIDE the metadata cache lock.
558 */
559 pthread_mutex_t metadata_socket_lock;
560 /* socket to exchange commands with sessiond */
561 char *consumer_command_sock_path;
562 /* communication with splice */
563 int consumer_channel_pipe[2];
564 /* Data stream poll thread pipe. To transfer data stream to the thread */
565 struct lttng_pipe *consumer_data_pipe;
566
567 /*
568 * Data thread use that pipe to catch wakeup from read subbuffer that
569 * detects that there is still data to be read for the stream encountered.
570 * Before doing so, the stream is flagged to indicate that there is still
571 * data to be read.
572 *
573 * Both pipes (read/write) are owned and used inside the data thread.
574 */
575 struct lttng_pipe *consumer_wakeup_pipe;
576 /* Indicate if the wakeup thread has been notified. */
577 unsigned int has_wakeup:1;
578
579 /* to let the signal handler wake up the fd receiver thread */
580 int consumer_should_quit[2];
581 /* Metadata poll thread pipe. Transfer metadata stream to it */
582 struct lttng_pipe *consumer_metadata_pipe;
583 /*
584 * Pipe used by the channel monitoring timers to provide state samples
585 * to the session daemon (write-only).
586 */
587 int channel_monitor_pipe;
588 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
589 };
590
591 /*
592 * Library-level data. One instance per process.
593 */
594 struct lttng_consumer_global_data {
595 /*
596 * At this time, this lock is used to ensure coherence between the count
597 * and number of element in the hash table. It's also a protection for
598 * concurrent read/write between threads.
599 *
600 * This is nested OUTSIDE the stream lock.
601 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
602 */
603 pthread_mutex_t lock;
604
605 /*
606 * Number of streams in the data stream hash table declared outside.
607 * Protected by consumer_data.lock.
608 */
609 int stream_count;
610
611 /* Channel hash table protected by consumer_data.lock. */
612 struct lttng_ht *channel_ht;
613 /* Channel hash table indexed by session id. */
614 struct lttng_ht *channels_by_session_id_ht;
615 /*
616 * Flag specifying if the local array of FDs needs update in the
617 * poll function. Protected by consumer_data.lock.
618 */
619 unsigned int need_update;
620 enum lttng_consumer_type type;
621
622 /*
623 * Relayd socket(s) hashtable indexed by network sequence number. Each
624 * stream has an index which associate the right relayd socket to use.
625 */
626 struct lttng_ht *relayd_ht;
627
628 /*
629 * This hash table contains all streams (metadata and data) indexed by
630 * session id. In other words, the ht is indexed by session id and each
631 * bucket contains the list of associated streams.
632 *
633 * This HT uses the "node_session_id" of the consumer stream.
634 */
635 struct lttng_ht *stream_list_ht;
636
637 /*
638 * This HT uses the "node_channel_id" of the consumer stream.
639 */
640 struct lttng_ht *stream_per_chan_id_ht;
641
642 /*
643 * Trace chunk registry indexed by (session_id, chunk_id).
644 */
645 struct lttng_trace_chunk_registry *chunk_registry;
646 };
647
648 /*
649 * Set to nonzero when the consumer is exiting. Updated by signal
650 * handler and thread exit, read by threads.
651 */
652 extern int consumer_quit;
653
654 /*
655 * Set to nonzero when the consumer is exiting. Updated by signal
656 * handler and thread exit, read by threads.
657 */
658 extern int consumer_quit;
659
660 /* Flag used to temporarily pause data consumption from testpoints. */
661 extern int data_consumption_paused;
662
663 /* Return a human-readable consumer type string that is suitable for logging. */
664 static inline
665 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
666 {
667 switch (type) {
668 case LTTNG_CONSUMER_UNKNOWN:
669 return "unknown";
670 case LTTNG_CONSUMER_KERNEL:
671 return "kernel";
672 case LTTNG_CONSUMER32_UST:
673 return "32-bit user space";
674 case LTTNG_CONSUMER64_UST:
675 return "64-bit user space";
676 default:
677 abort();
678 }
679 }
680
681 /*
682 * Init consumer data structures.
683 */
684 int lttng_consumer_init(void);
685
686 /*
687 * Set the error socket for communication with a session daemon.
688 */
689 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
690 int sock);
691
692 /*
693 * Set the command socket path for communication with a session daemon.
694 */
695 void lttng_consumer_set_command_sock_path(
696 struct lttng_consumer_local_data *ctx, char *sock);
697
698 /*
699 * Send return code to session daemon.
700 *
701 * Returns the return code of sendmsg : the number of bytes transmitted or -1
702 * on error.
703 */
704 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
705
706 /*
707 * Called from signal handler to ensure a clean exit.
708 */
709 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
710
711 /*
712 * Cleanup the daemon's socket on exit.
713 */
714 void lttng_consumer_cleanup(void);
715
716 /*
717 * Poll on the should_quit pipe and the command socket return -1 on error and
718 * should exit, 0 if data is available on the command socket
719 */
720 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
721
722 /*
723 * Copy the fields from the channel that need to be accessed (read-only)
724 * directly from the stream.
725 */
726 void consumer_stream_update_channel_attributes(
727 struct lttng_consumer_stream *stream,
728 struct lttng_consumer_channel *channel);
729
730 struct lttng_consumer_stream *consumer_allocate_stream(uint64_t channel_key,
731 uint64_t stream_key,
732 const char *channel_name,
733 uint64_t relayd_id,
734 uint64_t session_id,
735 struct lttng_trace_chunk *trace_chunk,
736 int cpu,
737 int *alloc_ret,
738 enum consumer_channel_type type,
739 unsigned int monitor);
740 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
741 uint64_t session_id,
742 const uint64_t *chunk_id,
743 const char *pathname,
744 const char *name,
745 uint64_t relayd_id,
746 enum lttng_event_output output,
747 uint64_t tracefile_size,
748 uint64_t tracefile_count,
749 uint64_t session_id_per_pid,
750 unsigned int monitor,
751 unsigned int live_timer_interval,
752 const char *root_shm_path,
753 const char *shm_path);
754 void consumer_del_stream(struct lttng_consumer_stream *stream,
755 struct lttng_ht *ht);
756 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
757 struct lttng_ht *ht);
758 int consumer_add_channel(struct lttng_consumer_channel *channel,
759 struct lttng_consumer_local_data *ctx);
760 void consumer_del_channel(struct lttng_consumer_channel *channel);
761
762 /* lttng-relayd consumer command */
763 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
764 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
765 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
766 void close_relayd_stream(struct lttng_consumer_stream *stream);
767 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
768 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
769 size_t data_size);
770 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
771
772 struct lttng_consumer_local_data *lttng_consumer_create(
773 enum lttng_consumer_type type,
774 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
775 struct lttng_consumer_local_data *ctx),
776 int (*recv_channel)(struct lttng_consumer_channel *channel),
777 int (*recv_stream)(struct lttng_consumer_stream *stream),
778 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
779 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
780 ssize_t lttng_consumer_on_read_subbuffer_mmap(
781 struct lttng_consumer_local_data *ctx,
782 struct lttng_consumer_stream *stream, unsigned long len,
783 unsigned long padding,
784 struct ctf_packet_index *index);
785 ssize_t lttng_consumer_on_read_subbuffer_splice(
786 struct lttng_consumer_local_data *ctx,
787 struct lttng_consumer_stream *stream, unsigned long len,
788 unsigned long padding,
789 struct ctf_packet_index *index);
790 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
791 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
792 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
793 unsigned long *pos);
794 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
795 unsigned long *pos);
796 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
797 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
798 void *consumer_thread_metadata_poll(void *data);
799 void *consumer_thread_data_poll(void *data);
800 void *consumer_thread_sessiond_poll(void *data);
801 void *consumer_thread_channel_poll(void *data);
802 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
803 int sock, struct pollfd *consumer_sockpoll);
804
805 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
806 struct lttng_consumer_local_data *ctx);
807 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
808 void consumer_add_relayd_socket(uint64_t net_seq_idx, int sock_type,
809 struct lttng_consumer_local_data *ctx, int sock,
810 struct pollfd *consumer_sockpoll, struct lttcomm_relayd_sock *relayd_sock,
811 uint64_t sessiond_id, uint64_t relayd_session_id);
812 void consumer_flag_relayd_for_destroy(
813 struct consumer_relayd_sock_pair *relayd);
814 int consumer_data_pending(uint64_t id);
815 int consumer_send_status_msg(int sock, int ret_code);
816 int consumer_send_status_channel(int sock,
817 struct lttng_consumer_channel *channel);
818 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
819 uint64_t key);
820 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
821 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
822 unsigned long produced_pos, uint64_t nb_packets_per_stream,
823 uint64_t max_sb_size);
824 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
825 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
826 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
827 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
828 int consumer_create_index_file(struct lttng_consumer_stream *stream);
829 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
830 uint64_t key, uint64_t relayd_id, uint32_t metadata,
831 struct lttng_consumer_local_data *ctx);
832 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
833 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data *ctx,
834 struct lttng_consumer_stream *stream);
835 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
836 uint64_t key, struct lttng_consumer_local_data *ctx);
837 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
838 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
839 const uint64_t *relayd_id, uint64_t session_id,
840 uint64_t chunk_id,
841 time_t chunk_creation_timestamp,
842 const char *chunk_override_name,
843 const struct lttng_credentials *credentials,
844 struct lttng_directory_handle *chunk_directory_handle);
845 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
846 const uint64_t *relayd_id, uint64_t session_id,
847 uint64_t chunk_id, time_t chunk_close_timestamp,
848 const enum lttng_trace_chunk_command_type *close_command);
849 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
850 const uint64_t *relayd_id, uint64_t session_id,
851 uint64_t chunk_id);
852 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
853 enum lttcomm_return_code lttng_consumer_init_command(
854 struct lttng_consumer_local_data *ctx,
855 const lttng_uuid sessiond_uuid);
856
857 #endif /* LIB_CONSUMER_H */
This page took 0.058261 seconds and 5 git commands to generate.