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