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