src/common/consumer.h

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