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