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