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