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