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         /* 22 */
  84         /* 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         LTTNG_CREATE_SESSION_SNAPSHOT       = 29,
  91         LTTNG_CREATE_SESSION_LIVE           = 30,
  92 };
  93
  94 enum lttcomm_relayd_command {
  95         RELAYD_ADD_STREAM                   = 1,
  96         RELAYD_CREATE_SESSION               = 2,
  97         RELAYD_START_DATA                   = 3,
  98         RELAYD_UPDATE_SYNC_INFO             = 4,
  99         RELAYD_VERSION                      = 5,
 100         RELAYD_SEND_METADATA                = 6,
 101         RELAYD_CLOSE_STREAM                 = 7,
 102         RELAYD_DATA_PENDING                 = 8,
 103         RELAYD_QUIESCENT_CONTROL            = 9,
 104         RELAYD_BEGIN_DATA_PENDING           = 10,
 105         RELAYD_END_DATA_PENDING             = 11,
 106         RELAYD_ADD_INDEX                    = 12,
 107         RELAYD_SEND_INDEX                   = 13,
 108         RELAYD_CLOSE_INDEX                  = 14,
 109         /* Live-reading commands (2.4+). */
 110         RELAYD_LIST_SESSIONS                = 15,
 111         /* All streams of the channel have been sent to the relayd (2.4+). */
 112         RELAYD_STREAMS_SENT                 = 16,
 113 };
 114
 115 /*
 116  * lttcomm error code.
 117  */
 118 enum lttcomm_return_code {
 119         LTTCOMM_CONSUMERD_SUCCESS            = 0,   /* Everything went fine. */
 120         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
 121         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 122         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 123         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 124         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 125         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 126         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 127         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 128         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 129         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 130         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 131         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 132         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 133         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 134         LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
 135         LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
 136         LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
 137         LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
 138         LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */
 139
 140         /* MUST be last element */
 141         LTTCOMM_NR,                                             /* Last element */
 142 };
 143
 144 /* lttng socket protocol. */
 145 enum lttcomm_sock_proto {
 146         LTTCOMM_SOCK_UDP,
 147         LTTCOMM_SOCK_TCP,
 148 };
 149
 150 /*
 151  * Index in the net_families array below. Please keep in sync!
 152  */
 153 enum lttcomm_sock_domain {
 154         LTTCOMM_INET      = 0,
 155         LTTCOMM_INET6     = 1,
 156 };
 157
 158 enum lttcomm_metadata_command {
 159         LTTCOMM_METADATA_REQUEST = 1,
 160 };
 161
 162 /*
 163  * Commands sent from the consumerd to the sessiond to request if new metadata
 164  * is available. This message is used to find the per UID _or_ per PID registry
 165  * for the channel key. For per UID lookup, the triplet
 166  * bits_per_long/uid/session_id is used. On lookup failure, we search for the
 167  * per PID registry indexed by session id ignoring the other values.
 168  */
 169 struct lttcomm_metadata_request_msg {
 170         uint64_t session_id; /* Tracing session id */
 171         uint64_t session_id_per_pid; /* Tracing session id for per-pid */
 172         uint32_t bits_per_long; /* Consumer ABI */
 173         uint32_t uid;
 174         uint64_t key; /* Metadata channel key. */
 175 } LTTNG_PACKED;
 176
 177 struct lttcomm_sockaddr {
 178         enum lttcomm_sock_domain type;
 179         union {
 180                 struct sockaddr_in sin;
 181                 struct sockaddr_in6 sin6;
 182         } addr;
 183 } LTTNG_PACKED;
 184
 185 struct lttcomm_sock {
 186         int32_t fd;
 187         enum lttcomm_sock_proto proto;
 188         struct lttcomm_sockaddr sockaddr;
 189         const struct lttcomm_proto_ops *ops;
 190 } LTTNG_PACKED;
 191
 192 /*
 193  * Relayd sock. Adds the protocol version to use for the communications with
 194  * the relayd.
 195  */
 196 struct lttcomm_relayd_sock {
 197         struct lttcomm_sock sock;
 198         uint32_t major;
 199         uint32_t minor;
 200 } LTTNG_PACKED;
 201
 202 struct lttcomm_net_family {
 203         int family;
 204         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 205 };
 206
 207 struct lttcomm_proto_ops {
 208         int (*bind) (struct lttcomm_sock *sock);
 209         int (*close) (struct lttcomm_sock *sock);
 210         int (*connect) (struct lttcomm_sock *sock);
 211         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 212         int (*listen) (struct lttcomm_sock *sock, int backlog);
 213         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 214                         int flags);
 215         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 216                         int flags);
 217 };
 218
 219 /*
 220  * Data structure received from lttng client to session daemon.
 221  */
 222 struct lttcomm_session_msg {
 223         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 224         struct lttng_session session;
 225         struct lttng_domain domain;
 226         union {
 227                 struct {
 228                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 229                         char name[NAME_MAX];
 230                 } LTTNG_PACKED disable;
 231                 /* Event data */
 232                 struct {
 233                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 234                         struct lttng_event event;
 235                         /* Length of following bytecode for filter. */
 236                         uint32_t bytecode_len;
 237                         /* exclusion data */
 238                         uint32_t exclusion_count;
 239                         /*
 240                          * After this structure, the following variable-length
 241                          * items are transmitted:
 242                          * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
 243                          * - unsigned char filter_bytecode[bytecode_len]
 244                          */
 245                 } LTTNG_PACKED enable;
 246                 /* Create channel */
 247                 struct {
 248                         struct lttng_channel chan;
 249                 } LTTNG_PACKED channel;
 250                 /* Context */
 251                 struct {
 252                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 253                         struct lttng_event_context ctx;
 254                 } LTTNG_PACKED context;
 255                 /* Use by register_consumer */
 256                 struct {
 257                         char path[PATH_MAX];
 258                 } LTTNG_PACKED reg;
 259                 /* List */
 260                 struct {
 261                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 262                 } LTTNG_PACKED list;
 263                 struct lttng_calibrate calibrate;
 264                 /* Used by the set_consumer_url and used by create_session also call */
 265                 struct {
 266                         /* Number of lttng_uri following */
 267                         uint32_t size;
 268                 } LTTNG_PACKED uri;
 269                 struct {
 270                         struct lttng_snapshot_output output;
 271                 } LTTNG_PACKED snapshot_output;
 272                 struct {
 273                         uint32_t wait;
 274                         struct lttng_snapshot_output output;
 275                 } LTTNG_PACKED snapshot_record;
 276                 struct {
 277                         uint32_t nb_uri;
 278                         unsigned int timer_interval;    /* usec */
 279                 } LTTNG_PACKED session_live;
 280         } u;
 281 } LTTNG_PACKED;
 282
 283 #define LTTNG_FILTER_MAX_LEN    65536
 284
 285 /*
 286  * Filter bytecode data. The reloc table is located at the end of the
 287  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 288  * starts at reloc_table_offset.
 289  */
 290 #define LTTNG_FILTER_PADDING    32
 291 struct lttng_filter_bytecode {
 292         uint32_t len;   /* len of data */
 293         uint32_t reloc_table_offset;
 294         uint64_t seqnum;
 295         char padding[LTTNG_FILTER_PADDING];
 296         char data[0];
 297 } LTTNG_PACKED;
 298
 299 /*
 300  * Event exclusion data. At the end of the structure, there will actually
 301  * by zero or more names, where the actual number of names is given by
 302  * the 'count' item of the structure.
 303  */
 304 #define LTTNG_EVENT_EXCLUSION_PADDING   32
 305 struct lttng_event_exclusion {
 306         uint32_t count;
 307         char padding[LTTNG_EVENT_EXCLUSION_PADDING];
 308         char names[LTTNG_SYMBOL_NAME_LEN][0];
 309 } LTTNG_PACKED;
 310
 311 /*
 312  * Data structure for the response from sessiond to the lttng client.
 313  */
 314 struct lttcomm_lttng_msg {
 315         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 316         uint32_t ret_code;      /* enum lttcomm_return_code */
 317         uint32_t pid;           /* pid_t */
 318         uint32_t data_size;
 319         /* Contains: trace_name + data */
 320         char payload[];
 321 } LTTNG_PACKED;
 322
 323 struct lttcomm_lttng_output_id {
 324         uint32_t id;
 325 } LTTNG_PACKED;
 326
 327 /*
 328  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 329  * to either add a channel, add a stream, update a stream, or stop
 330  * operation.
 331  */
 332 struct lttcomm_consumer_msg {
 333         uint32_t cmd_type;      /* enum consumerd_command */
 334         union {
 335                 struct {
 336                         uint64_t channel_key;
 337                         uint64_t session_id;
 338                         char pathname[PATH_MAX];
 339                         uint32_t uid;
 340                         uint32_t gid;
 341                         uint64_t relayd_id;
 342                         /* nb_init_streams is the number of streams open initially. */
 343                         uint32_t nb_init_streams;
 344                         char name[LTTNG_SYMBOL_NAME_LEN];
 345                         /* Use splice or mmap to consume this fd */
 346                         enum lttng_event_output output;
 347                         int type; /* Per cpu or metadata. */
 348                         uint64_t tracefile_size; /* bytes */
 349                         uint32_t tracefile_count; /* number of tracefiles */
 350                         /* If the channel's streams have to be monitored or not. */
 351                         uint32_t monitor;
 352                         /* timer to check the streams usage in live mode (usec). */
 353                         unsigned int live_timer_interval;
 354                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 355                 struct {
 356                         uint64_t stream_key;
 357                         uint64_t channel_key;
 358                         int32_t cpu;    /* On which CPU this stream is assigned. */
 359                         /* Tells the consumer if the stream should be or not monitored. */
 360                         uint32_t no_monitor;
 361                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 362                 struct {
 363                         uint64_t net_index;
 364                         enum lttng_stream_type type;
 365                         /* Open socket to the relayd */
 366                         struct lttcomm_relayd_sock sock;
 367                         /* Tracing session id associated to the relayd. */
 368                         uint64_t session_id;
 369                         /* Relayd session id, only used with control socket. */
 370                         uint64_t relayd_session_id;
 371                 } LTTNG_PACKED relayd_sock;
 372                 struct {
 373                         uint64_t net_seq_idx;
 374                 } LTTNG_PACKED destroy_relayd;
 375                 struct {
 376                         uint64_t session_id;
 377                 } LTTNG_PACKED data_pending;
 378                 struct {
 379                         uint64_t subbuf_size;                   /* bytes */
 380                         uint64_t num_subbuf;                    /* power of 2 */
 381                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 382                         uint32_t switch_timer_interval;         /* usec */
 383                         uint32_t read_timer_interval;           /* usec */
 384                         unsigned int live_timer_interval;               /* usec */
 385                         int32_t output;                         /* splice, mmap */
 386                         int32_t type;                           /* metadata or per_cpu */
 387                         uint64_t session_id;                    /* Tracing session id */
 388                         char pathname[PATH_MAX];                /* Channel file path. */
 389                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 390                         uint32_t uid;                           /* User ID of the session */
 391                         uint32_t gid;                           /* Group ID ot the session */
 392                         uint64_t relayd_id;                     /* Relayd id if apply. */
 393                         uint64_t key;                           /* Unique channel key. */
 394                         unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
 395                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 396                         uint64_t tracefile_size;        /* bytes */
 397                         uint32_t tracefile_count;       /* number of tracefiles */
 398                         uint64_t session_id_per_pid;    /* Per-pid session ID. */
 399                         /* Tells the consumer if the stream should be or not monitored. */
 400                         uint32_t monitor;
 401                         /*
 402                          * For UST per UID buffers, this is the application UID of the
 403                          * channel.  This can be different from the user UID requesting the
 404                          * channel creation and used for the rights on the stream file
 405                          * because the application can be in the tracing for instance.
 406                          */
 407                         uint32_t ust_app_uid;
 408                 } LTTNG_PACKED ask_channel;
 409                 struct {
 410                         uint64_t key;
 411                 } LTTNG_PACKED get_channel;
 412                 struct {
 413                         uint64_t key;
 414                 } LTTNG_PACKED destroy_channel;
 415                 struct {
 416                         uint64_t key;   /* Metadata channel key. */
 417                         uint64_t target_offset; /* Offset in the consumer */
 418                         uint64_t len;   /* Length of metadata to be received. */
 419                 } LTTNG_PACKED push_metadata;
 420                 struct {
 421                         uint64_t key;   /* Metadata channel key. */
 422                 } LTTNG_PACKED close_metadata;
 423                 struct {
 424                         uint64_t key;   /* Metadata channel key. */
 425                 } LTTNG_PACKED setup_metadata;
 426                 struct {
 427                         uint64_t key;   /* Channel key. */
 428                 } LTTNG_PACKED flush_channel;
 429                 struct {
 430                         char pathname[PATH_MAX];
 431                         /* Indicate if the snapshot goes on the relayd or locally. */
 432                         uint32_t use_relayd;
 433                         uint32_t metadata;              /* This a metadata snapshot. */
 434                         uint64_t relayd_id;             /* Relayd id if apply. */
 435                         uint64_t key;
 436                         uint64_t max_stream_size;
 437                 } LTTNG_PACKED snapshot_channel;
 438                 struct {
 439                         uint64_t channel_key;
 440                         uint64_t net_seq_idx;
 441                 } LTTNG_PACKED sent_streams;
 442         } u;
 443 } LTTNG_PACKED;
 444
 445 /*
 446  * Status message returned to the sessiond after a received command.
 447  */
 448 struct lttcomm_consumer_status_msg {
 449         enum lttcomm_return_code ret_code;
 450 } LTTNG_PACKED;
 451
 452 struct lttcomm_consumer_status_channel {
 453         enum lttcomm_return_code ret_code;
 454         uint64_t key;
 455         unsigned int stream_count;
 456 } LTTNG_PACKED;
 457
 458 #ifdef HAVE_LIBLTTNG_UST_CTL
 459
 460 #include <lttng/ust-abi.h>
 461
 462 /*
 463  * Data structure for the commands sent from sessiond to UST.
 464  */
 465 struct lttcomm_ust_msg {
 466         uint32_t handle;
 467         uint32_t cmd;
 468         union {
 469                 struct lttng_ust_channel channel;
 470                 struct lttng_ust_stream stream;
 471                 struct lttng_ust_event event;
 472                 struct lttng_ust_context context;
 473                 struct lttng_ust_tracer_version version;
 474         } u;
 475 } LTTNG_PACKED;
 476
 477 /*
 478  * Data structure for the response from UST to the session daemon.
 479  * cmd_type is sent back in the reply for validation.
 480  */
 481 struct lttcomm_ust_reply {
 482         uint32_t handle;
 483         uint32_t cmd;
 484         uint32_t ret_code;      /* enum lttcomm_return_code */
 485         uint32_t ret_val;       /* return value */
 486         union {
 487                 struct {
 488                         uint64_t memory_map_size;
 489                 } LTTNG_PACKED channel;
 490                 struct {
 491                         uint64_t memory_map_size;
 492                 } LTTNG_PACKED stream;
 493                 struct lttng_ust_tracer_version version;
 494         } u;
 495 } LTTNG_PACKED;
 496
 497 #endif /* HAVE_LIBLTTNG_UST_CTL */
 498
 499 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 500
 501 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 502                 const char *ip, unsigned int port);
 503 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 504                 const char *ip, unsigned int port);
 505
 506 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 507 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 508 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 509 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 510 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 511 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 512                 struct lttcomm_sock *src);
 513
 514 /* Relayd socket object. */
 515 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
 516                 struct lttng_uri *uri, uint32_t major, uint32_t minor);
 517
 518 extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
 519 extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
 520
 521 extern void lttcomm_init(void);
 522 /* Get network timeout, in milliseconds */
 523 extern unsigned long lttcomm_get_network_timeout(void);
 524
 525 #endif  /* _LTTNG_SESSIOND_COMM_H */