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