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         unsigned int session_id; /* Tracing session id */
 159         uint32_t bits_per_long; /* Consumer ABI */
 160         uint32_t uid;
 161         uint64_t key; /* Metadata channel key. */
 162 } LTTNG_PACKED;
 163
 164 struct lttcomm_sockaddr {
 165         enum lttcomm_sock_domain type;
 166         union {
 167                 struct sockaddr_in sin;
 168                 struct sockaddr_in6 sin6;
 169         } addr;
 170 } LTTNG_PACKED;
 171
 172 struct lttcomm_sock {
 173         int32_t fd;
 174         enum lttcomm_sock_proto proto;
 175         struct lttcomm_sockaddr sockaddr;
 176         const struct lttcomm_proto_ops *ops;
 177 } LTTNG_PACKED;
 178
 179 /*
 180  * Relayd sock. Adds the protocol version to use for the communications with
 181  * the relayd.
 182  */
 183 struct lttcomm_relayd_sock {
 184         struct lttcomm_sock sock;
 185         uint32_t major;
 186         uint32_t minor;
 187 } LTTNG_PACKED;
 188
 189 struct lttcomm_net_family {
 190         int family;
 191         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 192 };
 193
 194 struct lttcomm_proto_ops {
 195         int (*bind) (struct lttcomm_sock *sock);
 196         int (*close) (struct lttcomm_sock *sock);
 197         int (*connect) (struct lttcomm_sock *sock);
 198         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 199         int (*listen) (struct lttcomm_sock *sock, int backlog);
 200         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 201                         int flags);
 202         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 203                         int flags);
 204 };
 205
 206 /*
 207  * Data structure received from lttng client to session daemon.
 208  */
 209 struct lttcomm_session_msg {
 210         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 211         struct lttng_session session;
 212         struct lttng_domain domain;
 213         union {
 214                 struct {
 215                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 216                         char name[NAME_MAX];
 217                 } LTTNG_PACKED disable;
 218                 /* Event data */
 219                 struct {
 220                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 221                         struct lttng_event event;
 222                         /* Length of following bytecode for filter. */
 223                         uint32_t bytecode_len;
 224                 } LTTNG_PACKED enable;
 225                 /* Create channel */
 226                 struct {
 227                         struct lttng_channel chan;
 228                 } LTTNG_PACKED channel;
 229                 /* Context */
 230                 struct {
 231                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 232                         struct lttng_event_context ctx;
 233                 } LTTNG_PACKED context;
 234                 /* Use by register_consumer */
 235                 struct {
 236                         char path[PATH_MAX];
 237                 } LTTNG_PACKED reg;
 238                 /* List */
 239                 struct {
 240                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 241                 } LTTNG_PACKED list;
 242                 struct lttng_calibrate calibrate;
 243                 /* Used by the set_consumer_url and used by create_session also call */
 244                 struct {
 245                         /* Number of lttng_uri following */
 246                         uint32_t size;
 247                 } LTTNG_PACKED uri;
 248                 struct {
 249                         struct lttng_snapshot_output output;
 250                 } LTTNG_PACKED snapshot_output;
 251                 struct {
 252                         uint32_t wait;
 253                         struct lttng_snapshot_output output;
 254                 } LTTNG_PACKED snapshot_record;
 255         } u;
 256 } LTTNG_PACKED;
 257
 258 #define LTTNG_FILTER_MAX_LEN    65536
 259
 260 /*
 261  * Filter bytecode data. The reloc table is located at the end of the
 262  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 263  * starts at reloc_table_offset.
 264  */
 265 #define LTTNG_FILTER_PADDING    32
 266 struct lttng_filter_bytecode {
 267         uint32_t len;   /* len of data */
 268         uint32_t reloc_table_offset;
 269         uint64_t seqnum;
 270         char padding[LTTNG_FILTER_PADDING];
 271         char data[0];
 272 } LTTNG_PACKED;
 273
 274 /*
 275  * Data structure for the response from sessiond to the lttng client.
 276  */
 277 struct lttcomm_lttng_msg {
 278         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 279         uint32_t ret_code;      /* enum lttcomm_return_code */
 280         uint32_t pid;           /* pid_t */
 281         uint32_t data_size;
 282         /* Contains: trace_name + data */
 283         char payload[];
 284 } LTTNG_PACKED;
 285
 286 struct lttcomm_lttng_output_id {
 287         uint32_t id;
 288 } LTTNG_PACKED;
 289
 290 struct lttcomm_health_msg {
 291         uint32_t component;
 292         uint32_t cmd;
 293 } LTTNG_PACKED;
 294
 295 struct lttcomm_health_data {
 296         uint32_t ret_code;
 297 } LTTNG_PACKED;
 298
 299 /*
 300  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 301  * to either add a channel, add a stream, update a stream, or stop
 302  * operation.
 303  */
 304 struct lttcomm_consumer_msg {
 305         uint32_t cmd_type;      /* enum consumerd_command */
 306         union {
 307                 struct {
 308                         uint64_t channel_key;
 309                         uint64_t session_id;
 310                         char pathname[PATH_MAX];
 311                         uint32_t uid;
 312                         uint32_t gid;
 313                         uint64_t relayd_id;
 314                         /* nb_init_streams is the number of streams open initially. */
 315                         uint32_t nb_init_streams;
 316                         char name[LTTNG_SYMBOL_NAME_LEN];
 317                         /* Use splice or mmap to consume this fd */
 318                         enum lttng_event_output output;
 319                         int type; /* Per cpu or metadata. */
 320                         uint64_t tracefile_size; /* bytes */
 321                         uint32_t tracefile_count; /* number of tracefiles */
 322                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 323                 struct {
 324                         uint64_t stream_key;
 325                         uint64_t channel_key;
 326                         int32_t cpu;    /* On which CPU this stream is assigned. */
 327                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 328                 struct {
 329                         uint64_t net_index;
 330                         enum lttng_stream_type type;
 331                         /* Open socket to the relayd */
 332                         struct lttcomm_relayd_sock sock;
 333                         /* Tracing session id associated to the relayd. */
 334                         uint64_t session_id;
 335                 } LTTNG_PACKED relayd_sock;
 336                 struct {
 337                         uint64_t net_seq_idx;
 338                 } LTTNG_PACKED destroy_relayd;
 339                 struct {
 340                         uint64_t session_id;
 341                 } LTTNG_PACKED data_pending;
 342                 struct {
 343                         uint64_t subbuf_size;                   /* bytes */
 344                         uint64_t num_subbuf;                    /* power of 2 */
 345                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 346                         uint32_t switch_timer_interval;         /* usec */
 347                         uint32_t read_timer_interval;           /* usec */
 348                         int32_t output;                         /* splice, mmap */
 349                         int32_t type;                           /* metadata or per_cpu */
 350                         uint64_t session_id;                    /* Tracing session id */
 351                         char pathname[PATH_MAX];                /* Channel file path. */
 352                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 353                         uint32_t uid;                           /* User ID of the session */
 354                         uint32_t gid;                           /* Group ID ot the session */
 355                         uint64_t relayd_id;                     /* Relayd id if apply. */
 356                         uint64_t key;                           /* Unique channel key. */
 357                         unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
 358                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 359                         uint64_t tracefile_size;        /* bytes */
 360                         uint32_t tracefile_count;       /* number of tracefiles */
 361                 } LTTNG_PACKED ask_channel;
 362                 struct {
 363                         uint64_t key;
 364                 } LTTNG_PACKED get_channel;
 365                 struct {
 366                         uint64_t key;
 367                 } LTTNG_PACKED destroy_channel;
 368                 struct {
 369                         uint64_t key;   /* Metadata channel key. */
 370                         uint64_t target_offset; /* Offset in the consumer */
 371                         uint64_t len;   /* Length of metadata to be received. */
 372                 } LTTNG_PACKED push_metadata;
 373                 struct {
 374                         uint64_t key;   /* Metadata channel key. */
 375                 } LTTNG_PACKED close_metadata;
 376                 struct {
 377                         uint64_t key;   /* Metadata channel key. */
 378                 } LTTNG_PACKED setup_metadata;
 379                 struct {
 380                         uint64_t key;   /* Channel key. */
 381                 } LTTNG_PACKED flush_channel;
 382         } u;
 383 } LTTNG_PACKED;
 384
 385 /*
 386  * Status message returned to the sessiond after a received command.
 387  */
 388 struct lttcomm_consumer_status_msg {
 389         enum lttng_error_code ret_code;
 390 } LTTNG_PACKED;
 391
 392 struct lttcomm_consumer_status_channel {
 393         enum lttng_error_code ret_code;
 394         uint64_t key;
 395         unsigned int stream_count;
 396 } LTTNG_PACKED;
 397
 398 #ifdef HAVE_LIBLTTNG_UST_CTL
 399
 400 #include <lttng/ust-abi.h>
 401
 402 /*
 403  * Data structure for the commands sent from sessiond to UST.
 404  */
 405 struct lttcomm_ust_msg {
 406         uint32_t handle;
 407         uint32_t cmd;
 408         union {
 409                 struct lttng_ust_channel channel;
 410                 struct lttng_ust_stream stream;
 411                 struct lttng_ust_event event;
 412                 struct lttng_ust_context context;
 413                 struct lttng_ust_tracer_version version;
 414         } u;
 415 } LTTNG_PACKED;
 416
 417 /*
 418  * Data structure for the response from UST to the session daemon.
 419  * cmd_type is sent back in the reply for validation.
 420  */
 421 struct lttcomm_ust_reply {
 422         uint32_t handle;
 423         uint32_t cmd;
 424         uint32_t ret_code;      /* enum lttcomm_return_code */
 425         uint32_t ret_val;       /* return value */
 426         union {
 427                 struct {
 428                         uint64_t memory_map_size;
 429                 } LTTNG_PACKED channel;
 430                 struct {
 431                         uint64_t memory_map_size;
 432                 } LTTNG_PACKED stream;
 433                 struct lttng_ust_tracer_version version;
 434         } u;
 435 } LTTNG_PACKED;
 436
 437 #endif /* HAVE_LIBLTTNG_UST_CTL */
 438
 439 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 440
 441 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 442                 const char *ip, unsigned int port);
 443 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 444                 const char *ip, unsigned int port);
 445
 446 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 447 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 448 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 449 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 450 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 451 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 452                 struct lttcomm_sock *src);
 453
 454 /* Relayd socket object. */
 455 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
 456                 struct lttng_uri *uri, uint32_t major, uint32_t minor);
 457
 458 #endif  /* _LTTNG_SESSIOND_COMM_H */