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