src/bin/lttng-sessiond/consumer.h

   1 /*
   2  * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License, version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 51
  15  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _CONSUMER_H
  19 #define _CONSUMER_H
  20
  21 #include <common/consumer/consumer.h>
  22 #include <common/hashtable/hashtable.h>
  23 #include <lttng/lttng.h>
  24 #include <urcu/ref.h>
  25
  26 #include "snapshot.h"
  27
  28 struct snapshot;
  29 struct snapshot_output;
  30 struct ltt_session;
  31
  32 enum consumer_dst_type {
  33         CONSUMER_DST_LOCAL,
  34         CONSUMER_DST_NET,
  35 };
  36
  37 enum consumer_trace_chunk_exists_status {
  38         CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL,
  39         CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE,
  40         CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK,
  41 };
  42
  43 struct consumer_socket {
  44         /*
  45          * File descriptor. This is just a reference to the consumer data meaning
  46          * that every access must be locked and checked for a possible invalid
  47          * value.
  48          */
  49         int *fd_ptr;
  50
  51         /*
  52          * To use this socket (send/recv), this lock MUST be acquired.
  53          */
  54         pthread_mutex_t *lock;
  55
  56         /*
  57          * Indicates if the socket was registered by a third part
  58          * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
  59          * During the destroy phase of a consumer output, we close the socket if
  60          * this flag is set to 1 since we don't need the fd anymore.
  61          */
  62         unsigned int registered;
  63
  64         /* Flag if network sockets were sent to the consumer. */
  65         unsigned int control_sock_sent;
  66         unsigned int data_sock_sent;
  67
  68         struct lttng_ht_node_ulong node;
  69
  70         enum lttng_consumer_type type;
  71 };
  72
  73 struct consumer_data {
  74         enum lttng_consumer_type type;
  75
  76         /* Mutex to control consumerd pid assignation */
  77         pthread_mutex_t pid_mutex;
  78         pid_t pid;
  79
  80         int err_sock;
  81         /* These two sockets uses the cmd_unix_sock_path. */
  82         int cmd_sock;
  83         /*
  84          * Write-end of the channel monitoring pipe to be passed to the
  85          * consumer.
  86          */
  87         int channel_monitor_pipe;
  88         /*
  89          * The metadata socket object is handled differently and only created
  90          * locally in this object thus it's the only reference available in the
  91          * session daemon. For that reason, a variable for the fd is required and
  92          * the metadata socket fd points to it.
  93          */
  94         int metadata_fd;
  95         struct consumer_socket metadata_sock;
  96
  97         /* consumer error and command Unix socket path */
  98         const char *err_unix_sock_path;
  99         const char *cmd_unix_sock_path;
 100
 101         /*
 102          * This lock has two purposes. It protects any change to the consumer
 103          * socket and make sure only one thread uses this object for read/write
 104          * operations.
 105          */
 106         pthread_mutex_t lock;
 107 };
 108
 109 /*
 110  * Network URIs
 111  */
 112 struct consumer_net {
 113         /*
 114          * Indicate if URI type is set. Those flags should only be set when the
 115          * created URI is done AND valid.
 116          */
 117         int control_isset;
 118         int data_isset;
 119
 120         /*
 121          * The following two URIs MUST have the same destination address for
 122          * network streaming to work. Network hop are not yet supported.
 123          */
 124
 125         /* Control path for network streaming. */
 126         struct lttng_uri control;
 127
 128         /* Data path for network streaming. */
 129         struct lttng_uri data;
 130
 131         /* <hostname>/<session-name> */
 132         char base_dir[PATH_MAX];
 133 };
 134
 135 /*
 136  * Consumer output object describing where and how to send data.
 137  */
 138 struct consumer_output {
 139         struct urcu_ref ref;    /* Refcount */
 140
 141         /* If the consumer is enabled meaning that should be used */
 142         unsigned int enabled;
 143         enum consumer_dst_type type;
 144
 145         /*
 146          * The net_seq_index is the index of the network stream on the consumer
 147          * side. It tells the consumer which streams goes to which relayd with this
 148          * index. The relayd sockets are index with it on the consumer side.
 149          */
 150         uint64_t net_seq_index;
 151         /* Store the relay protocol in use if the session is remote. */
 152         uint32_t relay_major_version;
 153         uint32_t relay_minor_version;
 154
 155         /* True if relayd supports the clear feature. */
 156         bool relay_allows_clear;
 157
 158         /*
 159          * Subdirectory path name used for both local and network
 160          * consumer ("kernel", "ust", or empty).
 161          */
 162         char domain_subdir[max(sizeof(DEFAULT_KERNEL_TRACE_DIR),
 163                         sizeof(DEFAULT_UST_TRACE_DIR))];
 164
 165         /*
 166          * Hashtable of consumer_socket index by the file descriptor value. For
 167          * multiarch consumer support, we can have more than one consumer (ex:
 168          * 32 and 64 bit).
 169          */
 170         struct lttng_ht *socks;
 171
 172         /* Tell if this output is used for snapshot. */
 173         unsigned int snapshot:1;
 174
 175         union {
 176                 char session_root_path[LTTNG_PATH_MAX];
 177                 struct consumer_net net;
 178         } dst;
 179
 180         /*
 181          * Sub-directory below the session_root_path where the next chunk of
 182          * trace will be stored (\0 before the first session rotation).
 183          */
 184         char chunk_path[LTTNG_PATH_MAX];
 185 };
 186
 187 struct consumer_socket *consumer_find_socket(int key,
 188                 const struct consumer_output *consumer);
 189 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
 190                 const struct consumer_output *consumer);
 191 struct consumer_socket *consumer_allocate_socket(int *fd);
 192 void consumer_add_socket(struct consumer_socket *sock,
 193                 struct consumer_output *consumer);
 194 void consumer_del_socket(struct consumer_socket *sock,
 195                 struct consumer_output *consumer);
 196 void consumer_destroy_socket(struct consumer_socket *sock);
 197 int consumer_copy_sockets(struct consumer_output *dst,
 198                 struct consumer_output *src);
 199 void consumer_destroy_output_sockets(struct consumer_output *obj);
 200 int consumer_socket_send(struct consumer_socket *socket, void *msg,
 201                 size_t len);
 202 int consumer_socket_recv(struct consumer_socket *socket, void *msg,
 203                 size_t len);
 204
 205 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
 206 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
 207 void consumer_output_get(struct consumer_output *obj);
 208 void consumer_output_put(struct consumer_output *obj);
 209 int consumer_set_network_uri(const struct ltt_session *session,
 210                 struct consumer_output *obj,
 211                 struct lttng_uri *uri);
 212 int consumer_send_fds(struct consumer_socket *sock, const int *fds,
 213                 size_t nb_fd);
 214 int consumer_send_msg(struct consumer_socket *sock,
 215                 struct lttcomm_consumer_msg *msg);
 216 int consumer_send_stream(struct consumer_socket *sock,
 217                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 218                 const int *fds, size_t nb_fd);
 219 int consumer_send_channel(struct consumer_socket *sock,
 220                 struct lttcomm_consumer_msg *msg);
 221 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
 222                 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
 223                 enum lttng_stream_type type, uint64_t session_id,
 224                 const char *session_name, const char *hostname,
 225                 const char *base_path, int session_live_timer,
 226                 const uint64_t *current_chunk_id, time_t session_creation_time,
 227                 bool session_name_contains_creation_time);
 228 int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock,
 229                 int pipe);
 230 int consumer_send_destroy_relayd(struct consumer_socket *sock,
 231                 struct consumer_output *consumer);
 232 int consumer_recv_status_reply(struct consumer_socket *sock);
 233 int consumer_recv_status_channel(struct consumer_socket *sock,
 234                 uint64_t *key, unsigned int *stream_count);
 235 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
 236 int consumer_create_socket(struct consumer_data *data,
 237                 struct consumer_output *output);
 238
 239 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 240                 uint64_t subbuf_size,
 241                 uint64_t num_subbuf,
 242                 int overwrite,
 243                 unsigned int switch_timer_interval,
 244                 unsigned int read_timer_interval,
 245                 unsigned int live_timer_interval,
 246                 unsigned int monitor_timer_interval,
 247                 int output,
 248                 int type,
 249                 uint64_t session_id,
 250                 const char *pathname,
 251                 const char *name,
 252                 uint64_t relayd_id,
 253                 uint64_t key,
 254                 unsigned char *uuid,
 255                 uint32_t chan_id,
 256                 uint64_t tracefile_size,
 257                 uint64_t tracefile_count,
 258                 uint64_t session_id_per_pid,
 259                 unsigned int monitor,
 260                 uint32_t ust_app_uid,
 261                 int64_t blocking_timeout,
 262                 const char *root_shm_path,
 263                 const char *shm_path,
 264                 struct lttng_trace_chunk *trace_chunk,
 265                 const struct lttng_credentials *buffer_credentials);
 266 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 267                 uint64_t channel_key,
 268                 uint64_t stream_key,
 269                 int32_t cpu);
 270 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
 271                 enum lttng_consumer_command cmd,
 272                 uint64_t channel_key, uint64_t net_seq_idx);
 273 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 274                 uint64_t channel_key,
 275                 uint64_t session_id,
 276                 const char *pathname,
 277                 uid_t uid,
 278                 gid_t gid,
 279                 uint64_t relayd_id,
 280                 const char *name,
 281                 unsigned int nb_init_streams,
 282                 enum lttng_event_output output,
 283                 int type,
 284                 uint64_t tracefile_size,
 285                 uint64_t tracefile_count,
 286                 unsigned int monitor,
 287                 unsigned int live_timer_interval,
 288                 unsigned int monitor_timer_interval,
 289                 struct lttng_trace_chunk *trace_chunk);
 290 int consumer_is_data_pending(uint64_t session_id,
 291                 struct consumer_output *consumer);
 292 int consumer_close_metadata(struct consumer_socket *socket,
 293                 uint64_t metadata_key);
 294 int consumer_setup_metadata(struct consumer_socket *socket,
 295                 uint64_t metadata_key);
 296 int consumer_push_metadata(struct consumer_socket *socket,
 297                 uint64_t metadata_key, char *metadata_str, size_t len,
 298                 size_t target_offset, uint64_t version);
 299 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
 300 int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key);
 301 int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
 302                 struct consumer_output *consumer, uint64_t *discarded);
 303 int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
 304                 struct consumer_output *consumer, uint64_t *lost);
 305
 306 /* Snapshot command. */
 307 enum lttng_error_code consumer_snapshot_channel(struct consumer_socket *socket,
 308                 uint64_t key, const struct consumer_output *output, int metadata,
 309                 uid_t uid, gid_t gid, const char *channel_path, int wait,
 310                 uint64_t nb_packets_per_stream);
 311
 312 /* Rotation commands. */
 313 int consumer_rotate_channel(struct consumer_socket *socket, uint64_t key,
 314                 uid_t uid, gid_t gid, struct consumer_output *output,
 315                 bool is_metadata_channel);
 316 int consumer_init(struct consumer_socket *socket,
 317                 const lttng_uuid sessiond_uuid);
 318
 319 int consumer_create_trace_chunk(struct consumer_socket *socket,
 320                 uint64_t relayd_id, uint64_t session_id,
 321                 struct lttng_trace_chunk *chunk,
 322                 const char *domain_subdir);
 323 int consumer_close_trace_chunk(struct consumer_socket *socket,
 324                 uint64_t relayd_id, uint64_t session_id,
 325                 struct lttng_trace_chunk *chunk,
 326                 char *closed_trace_chunk_path);
 327 int consumer_trace_chunk_exists(struct consumer_socket *socket,
 328                 uint64_t relayd_id, uint64_t session_id,
 329                 struct lttng_trace_chunk *chunk,
 330                 enum consumer_trace_chunk_exists_status *result);
 331
 332 char *setup_channel_trace_path(struct consumer_output *consumer,
 333                 const char *session_path, size_t *consumer_path_offset);
 334
 335 #endif /* _CONSUMER_H */