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