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