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 };
  95
  96 /*
  97  * lttcomm error code.
  98  */
  99 enum lttcomm_return_code {
 100         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
 101         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 102         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 103         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 104         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 105         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 106         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 107         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 108         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 109         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 110         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 111         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 112         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 113         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 114
 115         /* MUST be last element */
 116         LTTCOMM_NR,                                             /* Last element */
 117 };
 118
 119 /* lttng socket protocol. */
 120 enum lttcomm_sock_proto {
 121         LTTCOMM_SOCK_UDP,
 122         LTTCOMM_SOCK_TCP,
 123 };
 124
 125 /*
 126  * Index in the net_families array below. Please keep in sync!
 127  */
 128 enum lttcomm_sock_domain {
 129         LTTCOMM_INET      = 0,
 130         LTTCOMM_INET6     = 1,
 131 };
 132
 133 struct lttcomm_sockaddr {
 134         enum lttcomm_sock_domain type;
 135         union {
 136                 struct sockaddr_in sin;
 137                 struct sockaddr_in6 sin6;
 138         } addr;
 139 };
 140
 141 struct lttcomm_sock {
 142         int fd;
 143         enum lttcomm_sock_proto proto;
 144         struct lttcomm_sockaddr sockaddr;
 145         const struct lttcomm_proto_ops *ops;
 146 };
 147
 148 struct lttcomm_net_family {
 149         int family;
 150         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 151 };
 152
 153 struct lttcomm_proto_ops {
 154         int (*bind) (struct lttcomm_sock *sock);
 155         int (*close) (struct lttcomm_sock *sock);
 156         int (*connect) (struct lttcomm_sock *sock);
 157         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 158         int (*listen) (struct lttcomm_sock *sock, int backlog);
 159         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 160                         int flags);
 161         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 162                         int flags);
 163 };
 164
 165 /*
 166  * Data structure received from lttng client to session daemon.
 167  */
 168 struct lttcomm_session_msg {
 169         uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
 170         struct lttng_session session;
 171         struct lttng_domain domain;
 172         union {
 173                 struct {
 174                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 175                         char name[NAME_MAX];
 176                 } disable;
 177                 /* Event data */
 178                 struct {
 179                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 180                         struct lttng_event event;
 181                         /* Length of following bytecode for filter. */
 182                         uint32_t bytecode_len;
 183                 } enable;
 184                 /* Create channel */
 185                 struct {
 186                         struct lttng_channel chan;
 187                 } channel;
 188                 /* Context */
 189                 struct {
 190                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 191                         struct lttng_event_context ctx;
 192                 } context;
 193                 /* Use by register_consumer */
 194                 struct {
 195                         char path[PATH_MAX];
 196                 } reg;
 197                 /* List */
 198                 struct {
 199                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 200                 } list;
 201                 struct lttng_calibrate calibrate;
 202                 /* Used by the set_consumer_url and used by create_session also call */
 203                 struct {
 204                         /* Number of lttng_uri following */
 205                         uint32_t size;
 206                 } uri;
 207         } u;
 208 };
 209
 210 #define LTTNG_FILTER_MAX_LEN    65536
 211
 212 /*
 213  * Filter bytecode data. The reloc table is located at the end of the
 214  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 215  * starts at reloc_table_offset.
 216  */
 217 #define LTTNG_FILTER_PADDING    32
 218 struct lttng_filter_bytecode {
 219         uint32_t len;   /* len of data */
 220         uint32_t reloc_table_offset;
 221         uint64_t seqnum;
 222         char padding[LTTNG_FILTER_PADDING];
 223         char data[0];
 224 };
 225
 226 /*
 227  * Data structure for the response from sessiond to the lttng client.
 228  */
 229 struct lttcomm_lttng_msg {
 230         uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
 231         uint32_t ret_code;   /* enum lttcomm_return_code */
 232         uint32_t pid;        /* pid_t */
 233         uint32_t data_size;
 234         /* Contains: trace_name + data */
 235         char payload[];
 236 };
 237
 238 struct lttcomm_health_msg {
 239         uint32_t component;
 240         uint32_t cmd;
 241 };
 242
 243 struct lttcomm_health_data {
 244         uint32_t ret_code;
 245 };
 246
 247 /*
 248  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 249  * to either add a channel, add a stream, update a stream, or stop
 250  * operation.
 251  */
 252 struct lttcomm_consumer_msg {
 253         uint32_t cmd_type;      /* enum consumerd_command */
 254         union {
 255                 struct {
 256                         int channel_key;
 257                         uint64_t max_sb_size; /* the subbuffer size for this channel */
 258                         /* shm_fd and wait_fd are sent as ancillary data */
 259                         uint64_t mmap_len;
 260                         /* nb_init_streams is the number of streams open initially. */
 261                         unsigned int nb_init_streams;
 262                         char name[LTTNG_SYMBOL_NAME_LEN];
 263                 } channel;
 264                 struct {
 265                         int channel_key;
 266                         int stream_key;
 267                         /* shm_fd and wait_fd are sent as ancillary data */
 268                         uint32_t state;    /* enum lttcomm_consumer_fd_state */
 269                         enum lttng_event_output output; /* use splice or mmap to consume this fd */
 270                         uint64_t mmap_len;
 271                         uid_t uid;         /* User ID owning the session */
 272                         gid_t gid;         /* Group ID owning the session */
 273                         char path_name[PATH_MAX];
 274                         int net_index;
 275                         unsigned int metadata_flag;
 276                         char name[DEFAULT_STREAM_NAME_LEN];  /* Name string of the stream */
 277                         uint64_t session_id;   /* Tracing session id of the stream */
 278                 } stream;
 279                 struct {
 280                         int net_index;
 281                         enum lttng_stream_type type;
 282                         /* Open socket to the relayd */
 283                         struct lttcomm_sock sock;
 284                 } relayd_sock;
 285                 struct {
 286                         uint64_t net_seq_idx;
 287                 } destroy_relayd;
 288                 struct {
 289                         uint64_t session_id;
 290                 } data_pending;
 291         } u;
 292 };
 293
 294 #ifdef HAVE_LIBLTTNG_UST_CTL
 295
 296 #include <lttng/ust-abi.h>
 297
 298 /*
 299  * Data structure for the commands sent from sessiond to UST.
 300  */
 301 struct lttcomm_ust_msg {
 302         uint32_t handle;
 303         uint32_t cmd;
 304         union {
 305                 struct lttng_ust_channel channel;
 306                 struct lttng_ust_stream stream;
 307                 struct lttng_ust_event event;
 308                 struct lttng_ust_context context;
 309                 struct lttng_ust_tracer_version version;
 310         } u;
 311 };
 312
 313 /*
 314  * Data structure for the response from UST to the session daemon.
 315  * cmd_type is sent back in the reply for validation.
 316  */
 317 struct lttcomm_ust_reply {
 318         uint32_t handle;
 319         uint32_t cmd;
 320         uint32_t ret_code;      /* enum lttcomm_return_code */
 321         uint32_t ret_val;       /* return value */
 322         union {
 323                 struct {
 324                         uint64_t memory_map_size;
 325                 } channel;
 326                 struct {
 327                         uint64_t memory_map_size;
 328                 } stream;
 329                 struct lttng_ust_tracer_version version;
 330         } u;
 331 };
 332
 333 #endif /* HAVE_LIBLTTNG_UST_CTL */
 334
 335 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 336
 337 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 338                 const char *ip, unsigned int port);
 339 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 340                 const char *ip, unsigned int port);
 341
 342 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 343 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 344 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 345 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 346 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 347 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 348                 struct lttcomm_sock *src);
 349
 350 #endif  /* _LTTNG_SESSIOND_COMM_H */