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