src/common/sessiond-comm/sessiond-comm.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *                      Julien Desfossez <julien.desfossez@polymtl.ca>
   4  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /*
  21  * This header is meant for liblttng and libust internal use ONLY. These
  22  * declarations should NOT be considered stable API.
  23  */
  24
  25 #ifndef _LTTNG_SESSIOND_COMM_H
  26 #define _LTTNG_SESSIOND_COMM_H
  27
  28 #define _GNU_SOURCE
  29 #include <limits.h>
  30 #include <lttng/lttng.h>
  31 #include <lttng/snapshot-internal.h>
  32 #include <common/compat/socket.h>
  33 #include <common/uri.h>
  34 #include <common/defaults.h>
  35 #include <common/compat/uuid.h>
  36
  37 #include <arpa/inet.h>
  38 #include <netinet/in.h>
  39 #include <sys/un.h>
  40
  41 #include "inet.h"
  42 #include "inet6.h"
  43 #include "unix.h"
  44
  45 /* Queue size of listen(2) */
  46 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  47
  48 /* Maximum number of FDs that can be sent over a Unix socket */
  49 #define LTTCOMM_MAX_SEND_FDS           4
  50
  51 /*
  52  * Get the error code index from 0 since LTTCOMM_OK start at 1000
  53  */
  54 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
  55
  56 enum lttcomm_sessiond_command {
  57         /* Tracer command */
  58         LTTNG_ADD_CONTEXT                   = 0,
  59         LTTNG_CALIBRATE                     = 1,
  60         LTTNG_DISABLE_CHANNEL               = 2,
  61         LTTNG_DISABLE_EVENT                 = 3,
  62         LTTNG_DISABLE_ALL_EVENT             = 4,
  63         LTTNG_ENABLE_CHANNEL                = 5,
  64         LTTNG_ENABLE_EVENT                  = 6,
  65         LTTNG_ENABLE_ALL_EVENT              = 7,
  66         /* Session daemon command */
  67         LTTNG_CREATE_SESSION                = 8,
  68         LTTNG_DESTROY_SESSION               = 9,
  69         LTTNG_LIST_CHANNELS                 = 10,
  70         LTTNG_LIST_DOMAINS                  = 11,
  71         LTTNG_LIST_EVENTS                   = 12,
  72         LTTNG_LIST_SESSIONS                 = 13,
  73         LTTNG_LIST_TRACEPOINTS              = 14,
  74         LTTNG_REGISTER_CONSUMER             = 15,
  75         LTTNG_START_TRACE                   = 16,
  76         LTTNG_STOP_TRACE                    = 17,
  77         LTTNG_LIST_TRACEPOINT_FIELDS        = 18,
  78
  79         /* Consumer */
  80         LTTNG_DISABLE_CONSUMER              = 19,
  81         LTTNG_ENABLE_CONSUMER               = 20,
  82         LTTNG_SET_CONSUMER_URI              = 21,
  83         LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
  84         LTTNG_HEALTH_CHECK                  = 23,
  85         LTTNG_DATA_PENDING                  = 24,
  86         LTTNG_SNAPSHOT_ADD_OUTPUT           = 25,
  87         LTTNG_SNAPSHOT_DEL_OUTPUT           = 26,
  88         LTTNG_SNAPSHOT_LIST_OUTPUT          = 27,
  89         LTTNG_SNAPSHOT_RECORD               = 28,
  90         LTTNG_CREATE_SESSION_SNAPSHOT       = 29,
  91 };
  92
  93 enum lttcomm_relayd_command {
  94         RELAYD_ADD_STREAM                   = 1,
  95         RELAYD_CREATE_SESSION               = 2,
  96         RELAYD_START_DATA                   = 3,
  97         RELAYD_UPDATE_SYNC_INFO             = 4,
  98         RELAYD_VERSION                      = 5,
  99         RELAYD_SEND_METADATA                = 6,
 100         RELAYD_CLOSE_STREAM                 = 7,
 101         RELAYD_DATA_PENDING                 = 8,
 102         RELAYD_QUIESCENT_CONTROL            = 9,
 103         RELAYD_BEGIN_DATA_PENDING           = 10,
 104         RELAYD_END_DATA_PENDING             = 11,
 105 };
 106
 107 /*
 108  * lttcomm error code.
 109  */
 110 enum lttcomm_return_code {
 111         LTTCOMM_CONSUMERD_SUCCESS            = 0,   /* Everything went fine. */
 112         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
 113         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 114         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 115         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 116         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 117         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 118         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 119         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 120         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 121         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 122         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 123         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 124         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 125         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 126         LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
 127         LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
 128         LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
 129         LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
 130         LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */
 131
 132         /* MUST be last element */
 133         LTTCOMM_NR,                                             /* Last element */
 134 };
 135
 136 /* lttng socket protocol. */
 137 enum lttcomm_sock_proto {
 138         LTTCOMM_SOCK_UDP,
 139         LTTCOMM_SOCK_TCP,
 140 };
 141
 142 /*
 143  * Index in the net_families array below. Please keep in sync!
 144  */
 145 enum lttcomm_sock_domain {
 146         LTTCOMM_INET      = 0,
 147         LTTCOMM_INET6     = 1,
 148 };
 149
 150 enum lttcomm_metadata_command {
 151         LTTCOMM_METADATA_REQUEST = 1,
 152 };
 153
 154 /*
 155  * Commands sent from the consumerd to the sessiond to request if new metadata
 156  * is available. This message is used to find the per UID _or_ per PID registry
 157  * for the channel key. For per UID lookup, the triplet
 158  * bits_per_long/uid/session_id is used. On lookup failure, we search for the
 159  * per PID registry indexed by session id ignoring the other values.
 160  */
 161 struct lttcomm_metadata_request_msg {
 162         uint64_t session_id; /* Tracing session id */
 163         uint64_t session_id_per_pid; /* Tracing session id for per-pid */
 164         uint32_t bits_per_long; /* Consumer ABI */
 165         uint32_t uid;
 166         uint64_t key; /* Metadata channel key. */
 167 } LTTNG_PACKED;
 168
 169 struct lttcomm_sockaddr {
 170         enum lttcomm_sock_domain type;
 171         union {
 172                 struct sockaddr_in sin;
 173                 struct sockaddr_in6 sin6;
 174         } addr;
 175 } LTTNG_PACKED;
 176
 177 struct lttcomm_sock {
 178         int32_t fd;
 179         enum lttcomm_sock_proto proto;
 180         struct lttcomm_sockaddr sockaddr;
 181         const struct lttcomm_proto_ops *ops;
 182 } LTTNG_PACKED;
 183
 184 /*
 185  * Relayd sock. Adds the protocol version to use for the communications with
 186  * the relayd.
 187  */
 188 struct lttcomm_relayd_sock {
 189         struct lttcomm_sock sock;
 190         uint32_t major;
 191         uint32_t minor;
 192 } LTTNG_PACKED;
 193
 194 struct lttcomm_net_family {
 195         int family;
 196         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 197 };
 198
 199 struct lttcomm_proto_ops {
 200         int (*bind) (struct lttcomm_sock *sock);
 201         int (*close) (struct lttcomm_sock *sock);
 202         int (*connect) (struct lttcomm_sock *sock);
 203         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 204         int (*listen) (struct lttcomm_sock *sock, int backlog);
 205         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 206                         int flags);
 207         ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 208                         int flags);
 209 };
 210
 211 /*
 212  * Data structure received from lttng client to session daemon.
 213  */
 214 struct lttcomm_session_msg {
 215         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 216         struct lttng_session session;
 217         struct lttng_domain domain;
 218         union {
 219                 struct {
 220                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 221                         char name[NAME_MAX];
 222                 } LTTNG_PACKED disable;
 223                 /* Event data */
 224                 struct {
 225                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 226                         struct lttng_event event;
 227                         /* Length of following bytecode for filter. */
 228                         uint32_t bytecode_len;
 229                 } LTTNG_PACKED enable;
 230                 /* Create channel */
 231                 struct {
 232                         struct lttng_channel chan;
 233                 } LTTNG_PACKED channel;
 234                 /* Context */
 235                 struct {
 236                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 237                         struct lttng_event_context ctx;
 238                 } LTTNG_PACKED context;
 239                 /* Use by register_consumer */
 240                 struct {
 241                         char path[PATH_MAX];
 242                 } LTTNG_PACKED reg;
 243                 /* List */
 244                 struct {
 245                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 246                 } LTTNG_PACKED list;
 247                 struct lttng_calibrate calibrate;
 248                 /* Used by the set_consumer_url and used by create_session also call */
 249                 struct {
 250                         /* Number of lttng_uri following */
 251                         uint32_t size;
 252                 } LTTNG_PACKED uri;
 253                 struct {
 254                         struct lttng_snapshot_output output;
 255                 } LTTNG_PACKED snapshot_output;
 256                 struct {
 257                         uint32_t wait;
 258                         struct lttng_snapshot_output output;
 259                 } LTTNG_PACKED snapshot_record;
 260         } u;
 261 } LTTNG_PACKED;
 262
 263 #define LTTNG_FILTER_MAX_LEN    65536
 264
 265 /*
 266  * Filter bytecode data. The reloc table is located at the end of the
 267  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 268  * starts at reloc_table_offset.
 269  */
 270 #define LTTNG_FILTER_PADDING    32
 271 struct lttng_filter_bytecode {
 272         uint32_t len;   /* len of data */
 273         uint32_t reloc_table_offset;
 274         uint64_t seqnum;
 275         char padding[LTTNG_FILTER_PADDING];
 276         char data[0];
 277 } LTTNG_PACKED;
 278
 279 /*
 280  * Data structure for the response from sessiond to the lttng client.
 281  */
 282 struct lttcomm_lttng_msg {
 283         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 284         uint32_t ret_code;      /* enum lttcomm_return_code */
 285         uint32_t pid;           /* pid_t */
 286         uint32_t data_size;
 287         /* Contains: trace_name + data */
 288         char payload[];
 289 } LTTNG_PACKED;
 290
 291 struct lttcomm_lttng_output_id {
 292         uint32_t id;
 293 } LTTNG_PACKED;
 294
 295 struct lttcomm_health_msg {
 296         uint32_t component;
 297         uint32_t cmd;
 298 } LTTNG_PACKED;
 299
 300 struct lttcomm_health_data {
 301         uint32_t ret_code;
 302 } LTTNG_PACKED;
 303
 304 /*
 305  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 306  * to either add a channel, add a stream, update a stream, or stop
 307  * operation.
 308  */
 309 struct lttcomm_consumer_msg {
 310         uint32_t cmd_type;      /* enum consumerd_command */
 311         union {
 312                 struct {
 313                         uint64_t channel_key;
 314                         uint64_t session_id;
 315                         char pathname[PATH_MAX];
 316                         uint32_t uid;
 317                         uint32_t gid;
 318                         uint64_t relayd_id;
 319                         /* nb_init_streams is the number of streams open initially. */
 320                         uint32_t nb_init_streams;
 321                         char name[LTTNG_SYMBOL_NAME_LEN];
 322                         /* Use splice or mmap to consume this fd */
 323                         enum lttng_event_output output;
 324                         int type; /* Per cpu or metadata. */
 325                         uint64_t tracefile_size; /* bytes */
 326                         uint32_t tracefile_count; /* number of tracefiles */
 327                         /* If the channel's streams have to be monitored or not. */
 328                         uint32_t monitor;
 329                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 330                 struct {
 331                         uint64_t stream_key;
 332                         uint64_t channel_key;
 333                         int32_t cpu;    /* On which CPU this stream is assigned. */
 334                         /* Tells the consumer if the stream should be or not monitored. */
 335                         uint32_t no_monitor;
 336                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 337                 struct {
 338                         uint64_t net_index;
 339                         enum lttng_stream_type type;
 340                         /* Open socket to the relayd */
 341                         struct lttcomm_relayd_sock sock;
 342                         /* Tracing session id associated to the relayd. */
 343                         uint64_t session_id;
 344                 } LTTNG_PACKED relayd_sock;
 345                 struct {
 346                         uint64_t net_seq_idx;
 347                 } LTTNG_PACKED destroy_relayd;
 348                 struct {
 349                         uint64_t session_id;
 350                 } LTTNG_PACKED data_pending;
 351                 struct {
 352                         uint64_t subbuf_size;                   /* bytes */
 353                         uint64_t num_subbuf;                    /* power of 2 */
 354                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 355                         uint32_t switch_timer_interval;         /* usec */
 356                         uint32_t read_timer_interval;           /* usec */
 357                         int32_t output;                         /* splice, mmap */
 358                         int32_t type;                           /* metadata or per_cpu */
 359                         uint64_t session_id;                    /* Tracing session id */
 360                         char pathname[PATH_MAX];                /* Channel file path. */
 361                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 362                         uint32_t uid;                           /* User ID of the session */
 363                         uint32_t gid;                           /* Group ID ot the session */
 364                         uint64_t relayd_id;                     /* Relayd id if apply. */
 365                         uint64_t key;                           /* Unique channel key. */
 366                         unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
 367                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 368                         uint64_t tracefile_size;        /* bytes */
 369                         uint32_t tracefile_count;       /* number of tracefiles */
 370                         uint64_t session_id_per_pid;    /* Per-pid session ID. */
 371                         /* Tells the consumer if the stream should be or not monitored. */
 372                         uint32_t monitor;
 373                         /*
 374                          * For UST per UID buffers, this is the application UID of the
 375                          * channel.  This can be different from the user UID requesting the
 376                          * channel creation and used for the rights on the stream file
 377                          * because the application can be in the tracing for instance.
 378                          */
 379                         uint32_t ust_app_uid;
 380                 } LTTNG_PACKED ask_channel;
 381                 struct {
 382                         uint64_t key;
 383                 } LTTNG_PACKED get_channel;
 384                 struct {
 385                         uint64_t key;
 386                 } LTTNG_PACKED destroy_channel;
 387                 struct {
 388                         uint64_t key;   /* Metadata channel key. */
 389                         uint64_t target_offset; /* Offset in the consumer */
 390                         uint64_t len;   /* Length of metadata to be received. */
 391                 } LTTNG_PACKED push_metadata;
 392                 struct {
 393                         uint64_t key;   /* Metadata channel key. */
 394                 } LTTNG_PACKED close_metadata;
 395                 struct {
 396                         uint64_t key;   /* Metadata channel key. */
 397                 } LTTNG_PACKED setup_metadata;
 398                 struct {
 399                         uint64_t key;   /* Channel key. */
 400                 } LTTNG_PACKED flush_channel;
 401                 struct {
 402                         char pathname[PATH_MAX];
 403                         /* Indicate if the snapshot goes on the relayd or locally. */
 404                         uint32_t use_relayd;
 405                         uint32_t metadata;              /* This a metadata snapshot. */
 406                         uint64_t relayd_id;             /* Relayd id if apply. */
 407                         uint64_t key;
 408                         uint64_t max_stream_size;
 409                 } LTTNG_PACKED snapshot_channel;
 410         } u;
 411 } LTTNG_PACKED;
 412
 413 /*
 414  * Status message returned to the sessiond after a received command.
 415  */
 416 struct lttcomm_consumer_status_msg {
 417         enum lttcomm_return_code ret_code;
 418 } LTTNG_PACKED;
 419
 420 struct lttcomm_consumer_status_channel {
 421         enum lttcomm_return_code ret_code;
 422         uint64_t key;
 423         unsigned int stream_count;
 424 } LTTNG_PACKED;
 425
 426 #ifdef HAVE_LIBLTTNG_UST_CTL
 427
 428 #include <lttng/ust-abi.h>
 429
 430 /*
 431  * Data structure for the commands sent from sessiond to UST.
 432  */
 433 struct lttcomm_ust_msg {
 434         uint32_t handle;
 435         uint32_t cmd;
 436         union {
 437                 struct lttng_ust_channel channel;
 438                 struct lttng_ust_stream stream;
 439                 struct lttng_ust_event event;
 440                 struct lttng_ust_context context;
 441                 struct lttng_ust_tracer_version version;
 442         } u;
 443 } LTTNG_PACKED;
 444
 445 /*
 446  * Data structure for the response from UST to the session daemon.
 447  * cmd_type is sent back in the reply for validation.
 448  */
 449 struct lttcomm_ust_reply {
 450         uint32_t handle;
 451         uint32_t cmd;
 452         uint32_t ret_code;      /* enum lttcomm_return_code */
 453         uint32_t ret_val;       /* return value */
 454         union {
 455                 struct {
 456                         uint64_t memory_map_size;
 457                 } LTTNG_PACKED channel;
 458                 struct {
 459                         uint64_t memory_map_size;
 460                 } LTTNG_PACKED stream;
 461                 struct lttng_ust_tracer_version version;
 462         } u;
 463 } LTTNG_PACKED;
 464
 465 #endif /* HAVE_LIBLTTNG_UST_CTL */
 466
 467 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 468
 469 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 470                 const char *ip, unsigned int port);
 471 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 472                 const char *ip, unsigned int port);
 473
 474 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 475 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
 476 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 477 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 478 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 479 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
 480                 struct lttcomm_sock *src);
 481
 482 /* Relayd socket object. */
 483 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
 484                 struct lttng_uri *uri, uint32_t major, uint32_t minor);
 485
 486 extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
 487 extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
 488
 489 extern void lttcomm_init(void);
 490 /* Get network timeout, in milliseconds */
 491 extern unsigned long lttcomm_get_network_timeout(void);
 492
 493 #endif  /* _LTTNG_SESSIOND_COMM_H */