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