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