src/common/sessiond-comm/sessiond-comm.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *                      Julien Desfossez <julien.desfossez@polymtl.ca>
   4  *                      Mathieu Desnoyers <mathieu.desnoyers@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 /*
  21  * This header is meant for liblttng and libust internal use ONLY. These
  22  * declarations should NOT be considered stable API.
  23  */
  24
  25 #ifndef _LTTNG_SESSIOND_COMM_H
  26 #define _LTTNG_SESSIOND_COMM_H
  27
  28 #define _GNU_SOURCE
  29 #include <limits.h>
  30 #include <lttng/lttng.h>
  31 #include <common/compat/socket.h>
  32 #include <common/uri.h>
  33 #include <common/defaults.h>
  34
  35 #include <arpa/inet.h>
  36 #include <netinet/in.h>
  37 #include <sys/un.h>
  38
  39 #include "inet.h"
  40 #include "inet6.h"
  41 #include "unix.h"
  42
  43 /* Queue size of listen(2) */
  44 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  45
  46 /* Maximum number of FDs that can be sent over a Unix socket */
  47 #define LTTCOMM_MAX_SEND_FDS           4
  48
  49 /*
  50  * Get the error code index from 0 since LTTCOMM_OK start at 1000
  51  */
  52 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
  53
  54 enum lttcomm_sessiond_command {
  55         /* Tracer command */
  56         LTTNG_ADD_CONTEXT                                       = 1,
  57         LTTNG_CALIBRATE                                         = 2,
  58         LTTNG_DISABLE_CHANNEL                           = 3,
  59         LTTNG_DISABLE_EVENT                                     = 4,
  60         LTTNG_DISABLE_ALL_EVENT                         = 5,
  61         LTTNG_ENABLE_CHANNEL                            = 6,
  62         LTTNG_ENABLE_EVENT                                      = 7,
  63         LTTNG_ENABLE_ALL_EVENT                          = 8,
  64         /* Session daemon command */
  65         LTTNG_CREATE_SESSION                            = 9,
  66         LTTNG_DESTROY_SESSION                           = 10,
  67         LTTNG_LIST_CHANNELS                 = 11,
  68         LTTNG_LIST_DOMAINS                  = 12,
  69         LTTNG_LIST_EVENTS                   = 13,
  70         LTTNG_LIST_SESSIONS                 = 14,
  71         LTTNG_LIST_TRACEPOINTS              = 15,
  72         LTTNG_REGISTER_CONSUMER             = 16,
  73         LTTNG_START_TRACE                   = 17,
  74         LTTNG_STOP_TRACE                    = 18,
  75         LTTNG_LIST_TRACEPOINT_FIELDS        = 19,
  76
  77         /* Consumer */
  78         LTTNG_DISABLE_CONSUMER              = 20,
  79         LTTNG_ENABLE_CONSUMER               = 21,
  80         LTTNG_SET_CONSUMER_URI              = 22,
  81         /* Relay daemon */
  82         RELAYD_ADD_STREAM                   = 23,
  83         RELAYD_CREATE_SESSION               = 24,
  84         RELAYD_START_DATA                   = 25,
  85         RELAYD_UPDATE_SYNC_INFO             = 26,
  86         RELAYD_VERSION                      = 27,
  87         RELAYD_SEND_METADATA                = 28,
  88         RELAYD_CLOSE_STREAM                 = 29,
  89         RELAYD_DATA_PENDING                 = 30,
  90         RELAYD_QUIESCENT_CONTROL            = 31,
  91         LTTNG_ENABLE_EVENT_WITH_FILTER      = 32,
  92         LTTNG_HEALTH_CHECK                  = 33,
  93         LTTNG_DATA_PENDING                  = 34,
  94         RELAYD_BEGIN_DATA_PENDING           = 35,
  95         RELAYD_END_DATA_PENDING             = 36,
  96 };
  97
  98 /*
  99  * lttcomm error code.
 100  */
 101 enum lttcomm_return_code {
 102         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
 103         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 104         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 105         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 106         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 107         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 108         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 109         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 110         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 111         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 112         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 113         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 114         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 115         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 116
 117         /* MUST be last element */
 118         LTTCOMM_NR,                                             /* Last element */
 119 };
 120
 121 /* lttng socket protocol. */
 122 enum lttcomm_sock_proto {
 123         LTTCOMM_SOCK_UDP,
 124         LTTCOMM_SOCK_TCP,
 125 };
 126
 127 /*
 128  * Index in the net_families array below. Please keep in sync!
 129  */
 130 enum lttcomm_sock_domain {
 131         LTTCOMM_INET      = 0,
 132         LTTCOMM_INET6     = 1,
 133 };
 134
 135 struct lttcomm_sockaddr {
 136         enum lttcomm_sock_domain type;
 137         union {
 138                 struct sockaddr_in sin;
 139                 struct sockaddr_in6 sin6;
 140         } addr;
 141 };
 142
 143 struct lttcomm_sock {
 144         int fd;
 145         enum lttcomm_sock_proto proto;
 146         struct lttcomm_sockaddr sockaddr;
 147         const struct lttcomm_proto_ops *ops;
 148 };
 149
 150 struct lttcomm_net_family {
 151         int family;
 152         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 153 };
 154
 155 struct lttcomm_proto_ops {
 156         int (*bind) (struct lttcomm_sock *sock);
 157         int (*close) (struct lttcomm_sock *sock);
 158         int (*connect) (struct lttcomm_sock *sock);
 159         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 160         int (*listen) (struct lttcomm_sock *sock, int backlog);
 161         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 162                         int flags);
 163         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 164                         int flags);
 165 };
 166
 167 /*
 168  * Data structure received from lttng client to session daemon.
 169  */
 170 struct lttcomm_session_msg {
 171         uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
 172         struct lttng_session session;
 173         struct lttng_domain domain;
 174         union {
 175                 struct {
 176                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 177                         char name[NAME_MAX];
 178                 } disable;
 179                 /* Event data */
 180                 struct {
 181                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 182                         struct lttng_event event;
 183                         /* Length of following bytecode for filter. */
 184                         uint32_t bytecode_len;
 185                 } enable;
 186                 /* Create channel */
 187                 struct {
 188                         struct lttng_channel chan;
 189                 } channel;
 190                 /* Context */
 191                 struct {
 192                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 193                         struct lttng_event_context ctx;
 194                 } context;
 195                 /* Use by register_consumer */
 196                 struct {
 197                         char path[PATH_MAX];
 198                 } reg;
 199                 /* List */
 200                 struct {
 201                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 202                 } list;
 203                 struct lttng_calibrate calibrate;
 204                 /* Used by the set_consumer_url and used by create_session also call */
 205                 struct {
 206                         /* Number of lttng_uri following */
 207                         uint32_t size;
 208                 } uri;
 209         } u;
 210 };
 211
 212 #define LTTNG_FILTER_MAX_LEN    65536
 213
 214 /*
 215  * Filter bytecode data. The reloc table is located at the end of the
 216  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 217  * starts at reloc_table_offset.
 218  */
 219 #define LTTNG_FILTER_PADDING    32
 220 struct lttng_filter_bytecode {
 221         uint32_t len;   /* len of data */
 222         uint32_t reloc_table_offset;
 223         uint64_t seqnum;
 224         char padding[LTTNG_FILTER_PADDING];
 225         char data[0];
 226 };
 227
 228 /*
 229  * Data structure for the response from sessiond to the lttng client.
 230  */
 231 struct lttcomm_lttng_msg {
 232         uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
 233         uint32_t ret_code;   /* enum lttcomm_return_code */
 234         uint32_t pid;        /* pid_t */
 235         uint32_t data_size;
 236         /* Contains: trace_name + data */
 237         char payload[];
 238 };
 239
 240 struct lttcomm_health_msg {
 241         uint32_t component;
 242         uint32_t cmd;
 243 };
 244
 245 struct lttcomm_health_data {
 246         uint32_t ret_code;
 247 };
 248
 249 /*
 250  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 251  * to either add a channel, add a stream, update a stream, or stop
 252  * operation.
 253  */
 254 struct lttcomm_consumer_msg {
 255         uint32_t cmd_type;      /* enum consumerd_command */
 256         union {
 257                 struct {
 258                         int channel_key;
 259                         uint64_t max_sb_size; /* the subbuffer size for this channel */
 260                         /* shm_fd and wait_fd are sent as ancillary data */
 261                         uint64_t mmap_len;
 262                         /* nb_init_streams is the number of streams open initially. */
 263                         unsigned int nb_init_streams;
 264                         char name[LTTNG_SYMBOL_NAME_LEN];
 265                 } channel;
 266                 struct {
 267                         int channel_key;
 268                         int stream_key;
 269                         /* shm_fd and wait_fd are sent as ancillary data */
 270                         uint32_t state;    /* enum lttcomm_consumer_fd_state */
 271                         enum lttng_event_output output; /* use splice or mmap to consume this fd */
 272                         uint64_t mmap_len;
 273                         uid_t uid;         /* User ID owning the session */
 274                         gid_t gid;         /* Group ID owning the session */
 275                         char path_name[PATH_MAX];
 276                         int net_index;
 277                         unsigned int metadata_flag;
 278                         char name[DEFAULT_STREAM_NAME_LEN];  /* Name string of the stream */
 279                         uint64_t session_id;   /* Tracing session id of the stream */
 280                 } stream;
 281                 struct {
 282                         int net_index;
 283                         enum lttng_stream_type type;
 284                         /* Open socket to the relayd */
 285                         struct lttcomm_sock sock;
 286                         /* Tracing session id associated to the relayd. */
 287                         uint64_t session_id;
 288                 } relayd_sock;
 289                 struct {
 290                         uint64_t net_seq_idx;
 291                 } destroy_relayd;
 292                 struct {
 293                         uint64_t session_id;
 294                 } data_pending;
 295         } u;
 296 };
 297
 298 /*
 299  * Status message returned to the sessiond after a received command.
 300  */
 301 struct lttcomm_consumer_status_msg {
 302         enum lttng_error_code ret_code;
 303 };
 304
 305 #ifdef HAVE_LIBLTTNG_UST_CTL
 306
 307 #include <lttng/ust-abi.h>
 308
 309 /*
 310  * Data structure for the commands sent from sessiond to UST.
 311  */
 312 struct lttcomm_ust_msg {
 313         uint32_t handle;
 314         uint32_t cmd;
 315         union {
 316                 struct lttng_ust_channel channel;
 317                 struct lttng_ust_stream stream;
 318                 struct lttng_ust_event event;
 319                 struct lttng_ust_context context;
 320                 struct lttng_ust_tracer_version version;
 321         } u;
 322 };
 323
 324 /*
 325  * Data structure for the response from UST to the session daemon.
 326  * cmd_type is sent back in the reply for validation.
 327  */
 328 struct lttcomm_ust_reply {
 329         uint32_t handle;
 330         uint32_t cmd;
 331         uint32_t ret_code;      /* enum lttcomm_return_code */
 332         uint32_t ret_val;       /* return value */
 333         union {
 334                 struct {
 335                         uint64_t memory_map_size;
 336                 } channel;
 337                 struct {
 338                         uint64_t memory_map_size;
 339                 } stream;
 340                 struct lttng_ust_tracer_version version;
 341         } u;
 342 };
 343
 344 #endif /* HAVE_LIBLTTNG_UST_CTL */
 345
 346 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 347
 348 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 349                 const char *ip, unsigned int port);
 350 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 351                 const char *ip, unsigned int port);
 352
 353 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 354 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 355 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 356 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 357 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 358 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 359                 struct lttcomm_sock *src);
 360
 361 #endif  /* _LTTNG_SESSIOND_COMM_H */