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