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 "health.h"
  26
  27 enum consumer_dst_type {
  28         CONSUMER_DST_LOCAL,
  29         CONSUMER_DST_NET,
  30 };
  31
  32 struct consumer_socket {
  33         /* File descriptor */
  34         int fd;
  35         /*
  36          * To use this socket (send/recv), this lock MUST be acquired.
  37          */
  38         pthread_mutex_t *lock;
  39
  40         /*
  41          * Indicates if the socket was registered by a third part
  42          * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
  43          * During the destroy phase of a consumer output, we close the socket if
  44          * this flag is set to 1 since we don't need the fd anymore.
  45          */
  46         unsigned int registered;
  47
  48         struct lttng_ht_node_ulong node;
  49 };
  50
  51 struct consumer_data {
  52         enum lttng_consumer_type type;
  53
  54         pthread_t thread;       /* Worker thread interacting with the consumer */
  55
  56         /* Conditions used by the consumer thread to indicate readiness. */
  57         pthread_cond_t cond;
  58         pthread_condattr_t condattr;
  59         pthread_mutex_t cond_mutex;
  60
  61         /*
  62          * This is a flag condition indicating that the consumer thread is ready
  63          * and connected to the lttng-consumerd daemon. This flag MUST only be
  64          * updated by locking the condition mutex above or before spawning a
  65          * consumer thread.
  66          *
  67          * A value of 0 means that the thread is NOT ready. A value of 1 means that
  68          * the thread consumer did connect successfully to the lttng-consumerd
  69          * daemon. A negative value indicates that there is been an error and the
  70          * thread has likely quit.
  71          */
  72         int consumer_thread_is_ready;
  73
  74         /* Mutex to control consumerd pid assignation */
  75         pthread_mutex_t pid_mutex;
  76         pid_t pid;
  77
  78         int err_sock;
  79         int cmd_sock;
  80
  81         /* consumer error and command Unix socket path */
  82         char err_unix_sock_path[PATH_MAX];
  83         char cmd_unix_sock_path[PATH_MAX];
  84
  85         /* Health check of the thread */
  86         struct health_state health;
  87
  88         /* communication lock */
  89         pthread_mutex_t lock;
  90 };
  91
  92 /*
  93  * Network URIs
  94  */
  95 struct consumer_net {
  96         /*
  97          * Indicate if URI type is set. Those flags should only be set when the
  98          * created URI is done AND valid.
  99          */
 100         int control_isset;
 101         int data_isset;
 102
 103         /*
 104          * The following two URIs MUST have the same destination address for
 105          * network streaming to work. Network hop are not yet supported.
 106          */
 107
 108         /* Control path for network streaming. */
 109         struct lttng_uri control;
 110
 111         /* Data path for network streaming. */
 112         struct lttng_uri data;
 113
 114         /* Flag if network sockets were sent to the consumer. */
 115         unsigned int control_sock_sent;
 116         unsigned int data_sock_sent;
 117 };
 118
 119 /*
 120  * Consumer output object describing where and how to send data.
 121  */
 122 struct consumer_output {
 123         /* If the consumer is enabled meaning that should be used */
 124         unsigned int enabled;
 125         enum consumer_dst_type type;
 126
 127         /*
 128          * The net_seq_index is the index of the network stream on the consumer
 129          * side. It tells the consumer which streams goes to which relayd with this
 130          * index. The relayd sockets are index with it on the consumer side.
 131          */
 132         int net_seq_index;
 133
 134         /*
 135          * Subdirectory path name used for both local and network consumer.
 136          */
 137         char subdir[PATH_MAX];
 138
 139         /*
 140          * Hashtable of consumer_socket index by the file descriptor value. For
 141          * multiarch consumer support, we can have more than one consumer (ex: 32
 142          * and 64 bit).
 143          */
 144         struct lttng_ht *socks;
 145
 146         union {
 147                 char trace_path[PATH_MAX];
 148                 struct consumer_net net;
 149         } dst;
 150 };
 151
 152 struct consumer_socket *consumer_find_socket(int key,
 153                 struct consumer_output *consumer);
 154 struct consumer_socket *consumer_allocate_socket(int fd);
 155 void consumer_add_socket(struct consumer_socket *sock,
 156                 struct consumer_output *consumer);
 157 void consumer_del_socket(struct consumer_socket *sock,
 158                 struct consumer_output *consumer);
 159 void consumer_destroy_socket(struct consumer_socket *sock);
 160
 161 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
 162 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
 163 void consumer_destroy_output(struct consumer_output *obj);
 164 int consumer_set_network_uri(struct consumer_output *obj,
 165                 struct lttng_uri *uri);
 166 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
 167 int consumer_send_stream(struct consumer_socket *sock,
 168                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 169                 int *fds, size_t nb_fd);
 170 int consumer_send_channel(struct consumer_socket *sock,
 171                 struct lttcomm_consumer_msg *msg);
 172 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
 173                 struct lttcomm_sock *sock, struct consumer_output *consumer,
 174                 enum lttng_stream_type type);
 175 int consumer_send_destroy_relayd(struct consumer_socket *sock,
 176                 struct consumer_output *consumer);
 177 int consumer_recv_status_reply(struct consumer_socket *sock);
 178 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
 179 int consumer_create_socket(struct consumer_data *data,
 180                 struct consumer_output *output);
 181 int consumer_set_subdir(struct consumer_output *consumer,
 182                 const char *session_name);
 183
 184 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 185                 enum lttng_consumer_command cmd,
 186                 int channel_key,
 187                 int stream_key,
 188                 uint32_t state,
 189                 enum lttng_event_output output,
 190                 uint64_t mmap_len,
 191                 uid_t uid,
 192                 gid_t gid,
 193                 int net_index,
 194                 unsigned int metadata_flag,
 195                 const char *name,
 196                 const char *pathname,
 197                 unsigned int session_id);
 198 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 199                 enum lttng_consumer_command cmd,
 200                 int channel_key,
 201                 uint64_t max_sb_size,
 202                 uint64_t mmap_len,
 203                 const char *name,
 204                 unsigned int nb_init_streams);
 205 int consumer_is_data_pending(unsigned int id,
 206                 struct consumer_output *consumer);
 207
 208 #endif /* _CONSUMER_H */