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