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 <lttng/snapshot-internal.h>
  32 #include <common/compat/socket.h>
  33 #include <common/uri.h>
  34 #include <common/defaults.h>
  35 #include <common/compat/uuid.h>
  36
  37 #include <arpa/inet.h>
  38 #include <netinet/in.h>
  39 #include <sys/un.h>
  40
  41 #include "inet.h"
  42 #include "inet6.h"
  43 #include "unix.h"
  44
  45 /* Queue size of listen(2) */
  46 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  47
  48 /* Maximum number of FDs that can be sent over a Unix socket */
  49 #define LTTCOMM_MAX_SEND_FDS           4
  50
  51 /*
  52  * Get the error code index from 0 since LTTCOMM_OK start at 1000
  53  */
  54 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
  55
  56 enum lttcomm_sessiond_command {
  57         /* Tracer command */
  58         LTTNG_ADD_CONTEXT                   = 0,
  59         LTTNG_CALIBRATE                     = 1,
  60         LTTNG_DISABLE_CHANNEL               = 2,
  61         LTTNG_DISABLE_EVENT                 = 3,
  62         LTTNG_DISABLE_ALL_EVENT             = 4,
  63         LTTNG_ENABLE_CHANNEL                = 5,
  64         LTTNG_ENABLE_EVENT                  = 6,
  65         LTTNG_ENABLE_ALL_EVENT              = 7,
  66         /* Session daemon command */
  67         LTTNG_CREATE_SESSION                = 8,
  68         LTTNG_DESTROY_SESSION               = 9,
  69         LTTNG_LIST_CHANNELS                 = 10,
  70         LTTNG_LIST_DOMAINS                  = 11,
  71         LTTNG_LIST_EVENTS                   = 12,
  72         LTTNG_LIST_SESSIONS                 = 13,
  73         LTTNG_LIST_TRACEPOINTS              = 14,
  74         LTTNG_REGISTER_CONSUMER             = 15,
  75         LTTNG_START_TRACE                   = 16,
  76         LTTNG_STOP_TRACE                    = 17,
  77         LTTNG_LIST_TRACEPOINT_FIELDS        = 18,
  78
  79         /* Consumer */
  80         LTTNG_DISABLE_CONSUMER              = 19,
  81         LTTNG_ENABLE_CONSUMER               = 20,
  82         LTTNG_SET_CONSUMER_URI              = 21,
  83         LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
  84         LTTNG_HEALTH_CHECK                  = 23,
  85         LTTNG_DATA_PENDING                  = 24,
  86         LTTNG_SNAPSHOT_ADD_OUTPUT           = 25,
  87         LTTNG_SNAPSHOT_DEL_OUTPUT           = 26,
  88         LTTNG_SNAPSHOT_LIST_OUTPUT          = 27,
  89         LTTNG_SNAPSHOT_RECORD               = 28,
  90 };
  91
  92 enum lttcomm_relayd_command {
  93         RELAYD_ADD_STREAM                   = 1,
  94         RELAYD_CREATE_SESSION               = 2,
  95         RELAYD_START_DATA                   = 3,
  96         RELAYD_UPDATE_SYNC_INFO             = 4,
  97         RELAYD_VERSION                      = 5,
  98         RELAYD_SEND_METADATA                = 6,
  99         RELAYD_CLOSE_STREAM                 = 7,
 100         RELAYD_DATA_PENDING                 = 8,
 101         RELAYD_QUIESCENT_CONTROL            = 9,
 102         RELAYD_BEGIN_DATA_PENDING           = 10,
 103         RELAYD_END_DATA_PENDING             = 11,
 104 };
 105
 106 /*
 107  * lttcomm error code.
 108  */
 109 enum lttcomm_return_code {
 110         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
 111         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 112         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 113         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 114         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 115         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 116         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 117         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 118         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 119         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 120         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 121         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 122         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 123         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 124         LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
 125         LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
 126         LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
 127
 128         /* MUST be last element */
 129         LTTCOMM_NR,                                             /* Last element */
 130 };
 131
 132 /* lttng socket protocol. */
 133 enum lttcomm_sock_proto {
 134         LTTCOMM_SOCK_UDP,
 135         LTTCOMM_SOCK_TCP,
 136 };
 137
 138 /*
 139  * Index in the net_families array below. Please keep in sync!
 140  */
 141 enum lttcomm_sock_domain {
 142         LTTCOMM_INET      = 0,
 143         LTTCOMM_INET6     = 1,
 144 };
 145
 146 enum lttcomm_metadata_command {
 147         LTTCOMM_METADATA_REQUEST = 1,
 148 };
 149
 150 /*
 151  * Commands sent from the consumerd to the sessiond to request if new metadata
 152  * is available. This message is used to find the per UID _or_ per PID registry
 153  * for the channel key. For per UID lookup, the triplet
 154  * bits_per_long/uid/session_id is used. On lookup failure, we search for the
 155  * per PID registry indexed by session id ignoring the other values.
 156  */
 157 struct lttcomm_metadata_request_msg {
 158         uint64_t session_id; /* Tracing session id */
 159         uint64_t session_id_per_pid; /* Tracing session id for per-pid */
 160         uint32_t bits_per_long; /* Consumer ABI */
 161         uint32_t uid;
 162         uint64_t key; /* Metadata channel key. */
 163 } LTTNG_PACKED;
 164
 165 struct lttcomm_sockaddr {
 166         enum lttcomm_sock_domain type;
 167         union {
 168                 struct sockaddr_in sin;
 169                 struct sockaddr_in6 sin6;
 170         } addr;
 171 } LTTNG_PACKED;
 172
 173 struct lttcomm_sock {
 174         int32_t fd;
 175         enum lttcomm_sock_proto proto;
 176         struct lttcomm_sockaddr sockaddr;
 177         const struct lttcomm_proto_ops *ops;
 178 } LTTNG_PACKED;
 179
 180 /*
 181  * Relayd sock. Adds the protocol version to use for the communications with
 182  * the relayd.
 183  */
 184 struct lttcomm_relayd_sock {
 185         struct lttcomm_sock sock;
 186         uint32_t major;
 187         uint32_t minor;
 188 } LTTNG_PACKED;
 189
 190 struct lttcomm_net_family {
 191         int family;
 192         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 193 };
 194
 195 struct lttcomm_proto_ops {
 196         int (*bind) (struct lttcomm_sock *sock);
 197         int (*close) (struct lttcomm_sock *sock);
 198         int (*connect) (struct lttcomm_sock *sock);
 199         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 200         int (*listen) (struct lttcomm_sock *sock, int backlog);
 201         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 202                         int flags);
 203         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 204                         int flags);
 205 };
 206
 207 /*
 208  * Data structure received from lttng client to session daemon.
 209  */
 210 struct lttcomm_session_msg {
 211         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 212         struct lttng_session session;
 213         struct lttng_domain domain;
 214         union {
 215                 struct {
 216                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 217                         char name[NAME_MAX];
 218                 } LTTNG_PACKED disable;
 219                 /* Event data */
 220                 struct {
 221                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 222                         struct lttng_event event;
 223                         /* Length of following bytecode for filter. */
 224                         uint32_t bytecode_len;
 225                 } LTTNG_PACKED enable;
 226                 /* Create channel */
 227                 struct {
 228                         struct lttng_channel chan;
 229                 } LTTNG_PACKED channel;
 230                 /* Context */
 231                 struct {
 232                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 233                         struct lttng_event_context ctx;
 234                 } LTTNG_PACKED context;
 235                 /* Use by register_consumer */
 236                 struct {
 237                         char path[PATH_MAX];
 238                 } LTTNG_PACKED reg;
 239                 /* List */
 240                 struct {
 241                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 242                 } LTTNG_PACKED list;
 243                 struct lttng_calibrate calibrate;
 244                 /* Used by the set_consumer_url and used by create_session also call */
 245                 struct {
 246                         /* Number of lttng_uri following */
 247                         uint32_t size;
 248                 } LTTNG_PACKED uri;
 249                 struct {
 250                         struct lttng_snapshot_output output;
 251                 } LTTNG_PACKED snapshot_output;
 252                 struct {
 253                         uint32_t wait;
 254                         struct lttng_snapshot_output output;
 255                 } LTTNG_PACKED snapshot_record;
 256         } u;
 257 } LTTNG_PACKED;
 258
 259 #define LTTNG_FILTER_MAX_LEN    65536
 260
 261 /*
 262  * Filter bytecode data. The reloc table is located at the end of the
 263  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 264  * starts at reloc_table_offset.
 265  */
 266 #define LTTNG_FILTER_PADDING    32
 267 struct lttng_filter_bytecode {
 268         uint32_t len;   /* len of data */
 269         uint32_t reloc_table_offset;
 270         uint64_t seqnum;
 271         char padding[LTTNG_FILTER_PADDING];
 272         char data[0];
 273 } LTTNG_PACKED;
 274
 275 /*
 276  * Data structure for the response from sessiond to the lttng client.
 277  */
 278 struct lttcomm_lttng_msg {
 279         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 280         uint32_t ret_code;      /* enum lttcomm_return_code */
 281         uint32_t pid;           /* pid_t */
 282         uint32_t data_size;
 283         /* Contains: trace_name + data */
 284         char payload[];
 285 } LTTNG_PACKED;
 286
 287 struct lttcomm_lttng_output_id {
 288         uint32_t id;
 289 } LTTNG_PACKED;
 290
 291 struct lttcomm_health_msg {
 292         uint32_t component;
 293         uint32_t cmd;
 294 } LTTNG_PACKED;
 295
 296 struct lttcomm_health_data {
 297         uint32_t ret_code;
 298 } LTTNG_PACKED;
 299
 300 /*
 301  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 302  * to either add a channel, add a stream, update a stream, or stop
 303  * operation.
 304  */
 305 struct lttcomm_consumer_msg {
 306         uint32_t cmd_type;      /* enum consumerd_command */
 307         union {
 308                 struct {
 309                         uint64_t channel_key;
 310                         uint64_t session_id;
 311                         char pathname[PATH_MAX];
 312                         uint32_t uid;
 313                         uint32_t gid;
 314                         uint64_t relayd_id;
 315                         /* nb_init_streams is the number of streams open initially. */
 316                         uint32_t nb_init_streams;
 317                         char name[LTTNG_SYMBOL_NAME_LEN];
 318                         /* Use splice or mmap to consume this fd */
 319                         enum lttng_event_output output;
 320                         int type; /* Per cpu or metadata. */
 321                         uint64_t tracefile_size; /* bytes */
 322                         uint32_t tracefile_count; /* number of tracefiles */
 323                         /* If the channel's streams have to be monitored or not. */
 324                         uint32_t monitor;
 325                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 326                 struct {
 327                         uint64_t stream_key;
 328                         uint64_t channel_key;
 329                         int32_t cpu;    /* On which CPU this stream is assigned. */
 330                         /* Tells the consumer if the stream should be or not monitored. */
 331                         uint32_t no_monitor;
 332                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 333                 struct {
 334                         uint64_t net_index;
 335                         enum lttng_stream_type type;
 336                         /* Open socket to the relayd */
 337                         struct lttcomm_relayd_sock sock;
 338                         /* Tracing session id associated to the relayd. */
 339                         uint64_t session_id;
 340                 } LTTNG_PACKED relayd_sock;
 341                 struct {
 342                         uint64_t net_seq_idx;
 343                 } LTTNG_PACKED destroy_relayd;
 344                 struct {
 345                         uint64_t session_id;
 346                 } LTTNG_PACKED data_pending;
 347                 struct {
 348                         uint64_t subbuf_size;                   /* bytes */
 349                         uint64_t num_subbuf;                    /* power of 2 */
 350                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 351                         uint32_t switch_timer_interval;         /* usec */
 352                         uint32_t read_timer_interval;           /* usec */
 353                         int32_t output;                         /* splice, mmap */
 354                         int32_t type;                           /* metadata or per_cpu */
 355                         uint64_t session_id;                    /* Tracing session id */
 356                         char pathname[PATH_MAX];                /* Channel file path. */
 357                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 358                         uint32_t uid;                           /* User ID of the session */
 359                         uint32_t gid;                           /* Group ID ot the session */
 360                         uint64_t relayd_id;                     /* Relayd id if apply. */
 361                         uint64_t key;                           /* Unique channel key. */
 362                         unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
 363                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 364                         uint64_t tracefile_size;        /* bytes */
 365                         uint32_t tracefile_count;       /* number of tracefiles */
 366                         uint64_t session_id_per_pid;    /* Per-pid session ID. */
 367                         /* Tells the consumer if the stream should be or not monitored. */
 368                         uint32_t monitor;
 369                 } LTTNG_PACKED ask_channel;
 370                 struct {
 371                         uint64_t key;
 372                 } LTTNG_PACKED get_channel;
 373                 struct {
 374                         uint64_t key;
 375                 } LTTNG_PACKED destroy_channel;
 376                 struct {
 377                         uint64_t key;   /* Metadata channel key. */
 378                         uint64_t target_offset; /* Offset in the consumer */
 379                         uint64_t len;   /* Length of metadata to be received. */
 380                 } LTTNG_PACKED push_metadata;
 381                 struct {
 382                         uint64_t key;   /* Metadata channel key. */
 383                 } LTTNG_PACKED close_metadata;
 384                 struct {
 385                         uint64_t key;   /* Metadata channel key. */
 386                 } LTTNG_PACKED setup_metadata;
 387                 struct {
 388                         uint64_t key;   /* Channel key. */
 389                 } LTTNG_PACKED flush_channel;
 390                 struct {
 391                         char pathname[PATH_MAX];
 392                         /* Indicate if the snapshot goes on the relayd or locally. */
 393                         uint32_t use_relayd;
 394                         uint32_t metadata;              /* This a metadata snapshot. */
 395                         uint64_t relayd_id;             /* Relayd id if apply. */
 396                         uint64_t key;
 397                         uint64_t max_size;
 398                 } LTTNG_PACKED snapshot_channel;
 399         } u;
 400 } LTTNG_PACKED;
 401
 402 /*
 403  * Status message returned to the sessiond after a received command.
 404  */
 405 struct lttcomm_consumer_status_msg {
 406         enum lttng_error_code ret_code;
 407 } LTTNG_PACKED;
 408
 409 struct lttcomm_consumer_status_channel {
 410         enum lttng_error_code ret_code;
 411         uint64_t key;
 412         unsigned int stream_count;
 413 } LTTNG_PACKED;
 414
 415 #ifdef HAVE_LIBLTTNG_UST_CTL
 416
 417 #include <lttng/ust-abi.h>
 418
 419 /*
 420  * Data structure for the commands sent from sessiond to UST.
 421  */
 422 struct lttcomm_ust_msg {
 423         uint32_t handle;
 424         uint32_t cmd;
 425         union {
 426                 struct lttng_ust_channel channel;
 427                 struct lttng_ust_stream stream;
 428                 struct lttng_ust_event event;
 429                 struct lttng_ust_context context;
 430                 struct lttng_ust_tracer_version version;
 431         } u;
 432 } LTTNG_PACKED;
 433
 434 /*
 435  * Data structure for the response from UST to the session daemon.
 436  * cmd_type is sent back in the reply for validation.
 437  */
 438 struct lttcomm_ust_reply {
 439         uint32_t handle;
 440         uint32_t cmd;
 441         uint32_t ret_code;      /* enum lttcomm_return_code */
 442         uint32_t ret_val;       /* return value */
 443         union {
 444                 struct {
 445                         uint64_t memory_map_size;
 446                 } LTTNG_PACKED channel;
 447                 struct {
 448                         uint64_t memory_map_size;
 449                 } LTTNG_PACKED stream;
 450                 struct lttng_ust_tracer_version version;
 451         } u;
 452 } LTTNG_PACKED;
 453
 454 #endif /* HAVE_LIBLTTNG_UST_CTL */
 455
 456 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 457
 458 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 459                 const char *ip, unsigned int port);
 460 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 461                 const char *ip, unsigned int port);
 462
 463 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 464 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 465 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 466 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 467 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 468 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 469                 struct lttcomm_sock *src);
 470
 471 /* Relayd socket object. */
 472 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
 473                 struct lttng_uri *uri, uint32_t major, uint32_t minor);
 474
 475 #endif  /* _LTTNG_SESSIOND_COMM_H */