src/common/consumer/consumer.h

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