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