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.h>
  22 #include <common/hashtable/hashtable.h>
  23 #include <lttng/lttng.h>
  24
  25 #include "snapshot.h"
  26
  27 struct snapshot;
  28 struct snapshot_output;
  29
  30 enum consumer_dst_type {
  31         CONSUMER_DST_LOCAL,
  32         CONSUMER_DST_NET,
  33 };
  34
  35 struct consumer_socket {
  36         /*
  37          * File descriptor. This is just a reference to the consumer data meaning
  38          * that every access must be locked and checked for a possible invalid
  39          * value.
  40          */
  41         int *fd_ptr;
  42
  43         /*
  44          * To use this socket (send/recv), this lock MUST be acquired.
  45          */
  46         pthread_mutex_t *lock;
  47
  48         /*
  49          * Indicates if the socket was registered by a third part
  50          * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
  51          * During the destroy phase of a consumer output, we close the socket if
  52          * this flag is set to 1 since we don't need the fd anymore.
  53          */
  54         unsigned int registered;
  55
  56         /* Flag if network sockets were sent to the consumer. */
  57         unsigned int control_sock_sent;
  58         unsigned int data_sock_sent;
  59
  60         struct lttng_ht_node_ulong node;
  61
  62         enum lttng_consumer_type type;
  63 };
  64
  65 struct consumer_data {
  66         enum lttng_consumer_type type;
  67
  68         pthread_t thread;       /* Worker thread interacting with the consumer */
  69
  70         /* Conditions used by the consumer thread to indicate readiness. */
  71         pthread_cond_t cond;
  72         pthread_condattr_t condattr;
  73         pthread_mutex_t cond_mutex;
  74
  75         /*
  76          * This is a flag condition indicating that the consumer thread is ready
  77          * and connected to the lttng-consumerd daemon. This flag MUST only be
  78          * updated by locking the condition mutex above or before spawning a
  79          * consumer thread.
  80          *
  81          * A value of 0 means that the thread is NOT ready. A value of 1 means that
  82          * the thread consumer did connect successfully to the lttng-consumerd
  83          * daemon. A negative value indicates that there is been an error and the
  84          * thread has likely quit.
  85          */
  86         int consumer_thread_is_ready;
  87
  88         /* Mutex to control consumerd pid assignation */
  89         pthread_mutex_t pid_mutex;
  90         pid_t pid;
  91
  92         int err_sock;
  93         /* These two sockets uses the cmd_unix_sock_path. */
  94         int cmd_sock;
  95         /*
  96          * The metadata socket object is handled differently and only created
  97          * locally in this object thus it's the only reference available in the
  98          * session daemon. For that reason, a variable for the fd is required and
  99          * the metadata socket fd points to it.
 100          */
 101         int metadata_fd;
 102         struct consumer_socket metadata_sock;
 103
 104         /* consumer error and command Unix socket path */
 105         char err_unix_sock_path[PATH_MAX];
 106         char cmd_unix_sock_path[PATH_MAX];
 107
 108         /*
 109          * This lock has two purposes. It protects any change to the consumer
 110          * socket and make sure only one thread uses this object for read/write
 111          * operations.
 112          */
 113         pthread_mutex_t lock;
 114 };
 115
 116 /*
 117  * Network URIs
 118  */
 119 struct consumer_net {
 120         /*
 121          * Indicate if URI type is set. Those flags should only be set when the
 122          * created URI is done AND valid.
 123          */
 124         int control_isset;
 125         int data_isset;
 126
 127         /*
 128          * The following two URIs MUST have the same destination address for
 129          * network streaming to work. Network hop are not yet supported.
 130          */
 131
 132         /* Control path for network streaming. */
 133         struct lttng_uri control;
 134
 135         /* Data path for network streaming. */
 136         struct lttng_uri data;
 137 };
 138
 139 /*
 140  * Consumer output object describing where and how to send data.
 141  */
 142 struct consumer_output {
 143         /* If the consumer is enabled meaning that should be used */
 144         unsigned int enabled;
 145         enum consumer_dst_type type;
 146
 147         /*
 148          * The net_seq_index is the index of the network stream on the consumer
 149          * side. It tells the consumer which streams goes to which relayd with this
 150          * index. The relayd sockets are index with it on the consumer side.
 151          */
 152         uint64_t net_seq_index;
 153
 154         /*
 155          * Subdirectory path name used for both local and network consumer.
 156          */
 157         char subdir[PATH_MAX];
 158
 159         /*
 160          * Hashtable of consumer_socket index by the file descriptor value. For
 161          * multiarch consumer support, we can have more than one consumer (ex: 32
 162          * and 64 bit).
 163          */
 164         struct lttng_ht *socks;
 165
 166         /* Tell if this output is used for snapshot. */
 167         unsigned int snapshot:1;
 168
 169         union {
 170                 char trace_path[PATH_MAX];
 171                 struct consumer_net net;
 172         } dst;
 173 };
 174
 175 struct consumer_socket *consumer_find_socket(int key,
 176                 struct consumer_output *consumer);
 177 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
 178                 struct consumer_output *consumer);
 179 struct consumer_socket *consumer_allocate_socket(int *fd);
 180 void consumer_add_socket(struct consumer_socket *sock,
 181                 struct consumer_output *consumer);
 182 void consumer_del_socket(struct consumer_socket *sock,
 183                 struct consumer_output *consumer);
 184 void consumer_destroy_socket(struct consumer_socket *sock);
 185 int consumer_copy_sockets(struct consumer_output *dst,
 186                 struct consumer_output *src);
 187 void consumer_destroy_output_sockets(struct consumer_output *obj);
 188 int consumer_socket_send(struct consumer_socket *socket, void *msg,
 189                 size_t len);
 190 int consumer_socket_recv(struct consumer_socket *socket, void *msg,
 191                 size_t len);
 192
 193 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
 194 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
 195 void consumer_destroy_output(struct consumer_output *obj);
 196 int consumer_set_network_uri(struct consumer_output *obj,
 197                 struct lttng_uri *uri);
 198 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
 199 int consumer_send_msg(struct consumer_socket *sock,
 200                 struct lttcomm_consumer_msg *msg);
 201 int consumer_send_stream(struct consumer_socket *sock,
 202                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 203                 int *fds, size_t nb_fd);
 204 int consumer_send_channel(struct consumer_socket *sock,
 205                 struct lttcomm_consumer_msg *msg);
 206 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
 207                 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
 208                 enum lttng_stream_type type, uint64_t session_id,
 209                 char *session_name, char *hostname, int session_live_timer);
 210 int consumer_send_destroy_relayd(struct consumer_socket *sock,
 211                 struct consumer_output *consumer);
 212 int consumer_recv_status_reply(struct consumer_socket *sock);
 213 int consumer_recv_status_channel(struct consumer_socket *sock,
 214                 uint64_t *key, unsigned int *stream_count);
 215 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
 216 int consumer_create_socket(struct consumer_data *data,
 217                 struct consumer_output *output);
 218 int consumer_set_subdir(struct consumer_output *consumer,
 219                 const char *session_name);
 220
 221 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 222                 uint64_t subbuf_size,
 223                 uint64_t num_subbuf,
 224                 int overwrite,
 225                 unsigned int switch_timer_interval,
 226                 unsigned int read_timer_interval,
 227                 unsigned int live_timer_interval,
 228                 int output,
 229                 int type,
 230                 uint64_t session_id,
 231                 const char *pathname,
 232                 const char *name,
 233                 uid_t uid,
 234                 gid_t gid,
 235                 uint64_t relayd_id,
 236                 uint64_t key,
 237                 unsigned char *uuid,
 238                 uint32_t chan_id,
 239                 uint64_t tracefile_size,
 240                 uint64_t tracefile_count,
 241                 uint64_t session_id_per_pid,
 242                 unsigned int monitor,
 243                 uint32_t ust_app_uid,
 244                 const char *root_shm_path,
 245                 const char *shm_path);
 246 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 247                 enum lttng_consumer_command cmd,
 248                 uint64_t channel_key,
 249                 uint64_t stream_key,
 250                 int cpu);
 251 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
 252                 enum lttng_consumer_command cmd,
 253                 uint64_t channel_key, uint64_t net_seq_idx);
 254 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 255                 enum lttng_consumer_command cmd,
 256                 uint64_t channel_key,
 257                 uint64_t session_id,
 258                 const char *pathname,
 259                 uid_t uid,
 260                 gid_t gid,
 261                 uint64_t relayd_id,
 262                 const char *name,
 263                 unsigned int nb_init_streams,
 264                 enum lttng_event_output output,
 265                 int type,
 266                 uint64_t tracefile_size,
 267                 uint64_t tracefile_count,
 268                 unsigned int monitor,
 269                 unsigned int live_timer_interval);
 270 int consumer_is_data_pending(uint64_t session_id,
 271                 struct consumer_output *consumer);
 272 int consumer_close_metadata(struct consumer_socket *socket,
 273                 uint64_t metadata_key);
 274 int consumer_setup_metadata(struct consumer_socket *socket,
 275                 uint64_t metadata_key);
 276 int consumer_push_metadata(struct consumer_socket *socket,
 277                 uint64_t metadata_key, char *metadata_str, size_t len,
 278                 size_t target_offset);
 279 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
 280
 281 /* Snapshot command. */
 282 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
 283                 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
 284                 const char *session_path, int wait, uint64_t nb_packets_per_stream);
 285
 286 #endif /* _CONSUMER_H */