src/common/sessiond-comm/sessiond-comm.hpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-only
   6  *
   7  */
   8
   9 /*
  10  * This header is meant for liblttng and libust internal use ONLY. These
  11  * declarations should NOT be considered stable API.
  12  */
  13
  14 #ifndef _LTTNG_SESSIOND_COMM_H
  15 #define _LTTNG_SESSIOND_COMM_H
  16
  17 #include <limits.h>
  18 #include <lttng/lttng.h>
  19 #include <lttng/snapshot-internal.hpp>
  20 #include <lttng/save-internal.hpp>
  21 #include <lttng/channel-internal.hpp>
  22 #include <lttng/trigger/trigger-internal.hpp>
  23 #include <lttng/rotate-internal.hpp>
  24 #include <common/compat/socket.hpp>
  25 #include <common/uri.hpp>
  26 #include <common/defaults.hpp>
  27 #include <common/uuid.hpp>
  28 #include <common/macros.hpp>
  29 #include <common/optional.hpp>
  30
  31 #include <arpa/inet.h>
  32 #include <netinet/in.h>
  33 #include <stdint.h>
  34 #include <sys/un.h>
  35
  36 #include "inet.hpp"
  37 #include "inet6.hpp"
  38 #include <common/unix.hpp>
  39
  40 /* Queue size of listen(2) */
  41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  42
  43 /* Maximum number of FDs that can be sent over a Unix socket */
  44 #if defined(__linux__)
  45 /* Based on the kernel's SCM_MAX_FD which is 253 since 2.6.38 (255 before) */
  46 #define LTTCOMM_MAX_SEND_FDS           253
  47 #else
  48 #define LTTCOMM_MAX_SEND_FDS           16
  49 #endif
  50
  51 enum lttcomm_sessiond_command {
  52         /* Tracer command */
  53         LTTNG_ADD_CONTEXT                               = 0,
  54         /* LTTNG_CALIBRATE used to be here */
  55         LTTNG_DISABLE_CHANNEL                           = 2,
  56         LTTNG_DISABLE_EVENT                             = 3,
  57         LTTNG_LIST_SYSCALLS                             = 4,
  58         LTTNG_ENABLE_CHANNEL                            = 5,
  59         LTTNG_ENABLE_EVENT                              = 6,
  60         /* 7 */
  61         /* Session daemon command */
  62         /* 8 */
  63         LTTNG_DESTROY_SESSION                           = 9,
  64         LTTNG_LIST_CHANNELS                             = 10,
  65         LTTNG_LIST_DOMAINS                              = 11,
  66         LTTNG_LIST_EVENTS                               = 12,
  67         LTTNG_LIST_SESSIONS                             = 13,
  68         LTTNG_LIST_TRACEPOINTS                          = 14,
  69         LTTNG_REGISTER_CONSUMER                         = 15,
  70         LTTNG_START_TRACE                               = 16,
  71         LTTNG_STOP_TRACE                                = 17,
  72         LTTNG_LIST_TRACEPOINT_FIELDS                    = 18,
  73
  74         /* Consumer */
  75         LTTNG_DISABLE_CONSUMER                          = 19,
  76         LTTNG_ENABLE_CONSUMER                           = 20,
  77         LTTNG_SET_CONSUMER_URI                          = 21,
  78         /* 22 */
  79         /* 23 */
  80         LTTNG_DATA_PENDING                              = 24,
  81         LTTNG_SNAPSHOT_ADD_OUTPUT                       = 25,
  82         LTTNG_SNAPSHOT_DEL_OUTPUT                       = 26,
  83         LTTNG_SNAPSHOT_LIST_OUTPUT                      = 27,
  84         LTTNG_SNAPSHOT_RECORD                           = 28,
  85         /* 29 */
  86         /* 30 */
  87         LTTNG_SAVE_SESSION                              = 31,
  88         LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE    = 32,
  89         LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE = 33,
  90         LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY           = 34,
  91         LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY           = 35,
  92         LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET     = 36,
  93         LTTNG_SET_SESSION_SHM_PATH                      = 40,
  94         LTTNG_REGENERATE_METADATA                       = 41,
  95         LTTNG_REGENERATE_STATEDUMP                      = 42,
  96         LTTNG_REGISTER_TRIGGER                          = 43,
  97         LTTNG_UNREGISTER_TRIGGER                        = 44,
  98         LTTNG_ROTATE_SESSION                            = 45,
  99         LTTNG_ROTATION_GET_INFO                         = 46,
 100         LTTNG_ROTATION_SET_SCHEDULE                     = 47,
 101         LTTNG_SESSION_LIST_ROTATION_SCHEDULES           = 48,
 102         LTTNG_CREATE_SESSION_EXT                        = 49,
 103         LTTNG_CLEAR_SESSION                             = 50,
 104         LTTNG_LIST_TRIGGERS                             = 51,
 105         LTTNG_EXECUTE_ERROR_QUERY                       = 52,
 106 };
 107
 108 static inline
 109 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd)
 110 {
 111         switch (cmd) {
 112         case LTTNG_ADD_CONTEXT:
 113                 return "LTTNG_ADD_CONTEXT";
 114         case LTTNG_DISABLE_CHANNEL:
 115                 return "LTTNG_DISABLE_CHANNEL";
 116         case LTTNG_DISABLE_EVENT:
 117                 return "LTTNG_DISABLE_EVENT";
 118         case LTTNG_LIST_SYSCALLS:
 119                 return "LTTNG_LIST_SYSCALLS";
 120         case LTTNG_ENABLE_CHANNEL:
 121                 return "LTTNG_ENABLE_CHANNEL";
 122         case LTTNG_ENABLE_EVENT:
 123                 return "LTTNG_ENABLE_EVENT";
 124         case LTTNG_DESTROY_SESSION:
 125                 return "LTTNG_DESTROY_SESSION";
 126         case LTTNG_LIST_CHANNELS:
 127                 return "LTTNG_LIST_CHANNELS";
 128         case LTTNG_LIST_DOMAINS:
 129                 return "LTTNG_LIST_DOMAINS";
 130         case LTTNG_LIST_EVENTS:
 131                 return "LTTNG_LIST_EVENTS";
 132         case LTTNG_LIST_SESSIONS:
 133                 return "LTTNG_LIST_SESSIONS";
 134         case LTTNG_LIST_TRACEPOINTS:
 135                 return "LTTNG_LIST_TRACEPOINTS";
 136         case LTTNG_REGISTER_CONSUMER:
 137                 return "LTTNG_REGISTER_CONSUMER";
 138         case LTTNG_START_TRACE:
 139                 return "LTTNG_START_TRACE";
 140         case LTTNG_STOP_TRACE:
 141                 return "LTTNG_STOP_TRACE";
 142         case LTTNG_LIST_TRACEPOINT_FIELDS:
 143                 return "LTTNG_LIST_TRACEPOINT_FIELDS";
 144         case LTTNG_DISABLE_CONSUMER:
 145                 return "LTTNG_DISABLE_CONSUMER";
 146         case LTTNG_ENABLE_CONSUMER:
 147                 return "LTTNG_ENABLE_CONSUMER";
 148         case LTTNG_SET_CONSUMER_URI:
 149                 return "LTTNG_SET_CONSUMER_URI";
 150         case LTTNG_DATA_PENDING:
 151                 return "LTTNG_DATA_PENDING";
 152         case LTTNG_SNAPSHOT_ADD_OUTPUT:
 153                 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
 154         case LTTNG_SNAPSHOT_DEL_OUTPUT:
 155                 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
 156         case LTTNG_SNAPSHOT_LIST_OUTPUT:
 157                 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
 158         case LTTNG_SNAPSHOT_RECORD:
 159                 return "LTTNG_SNAPSHOT_RECORD";
 160         case LTTNG_SAVE_SESSION:
 161                 return "LTTNG_SAVE_SESSION";
 162         case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE:
 163                 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
 164         case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE:
 165                 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
 166         case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY:
 167                 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
 168         case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY:
 169                 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
 170         case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET:
 171                 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
 172         case LTTNG_SET_SESSION_SHM_PATH:
 173                 return "LTTNG_SET_SESSION_SHM_PATH";
 174         case LTTNG_REGENERATE_METADATA:
 175                 return "LTTNG_REGENERATE_METADATA";
 176         case LTTNG_REGENERATE_STATEDUMP:
 177                 return "LTTNG_REGENERATE_STATEDUMP";
 178         case LTTNG_REGISTER_TRIGGER:
 179                 return "LTTNG_REGISTER_TRIGGER";
 180         case LTTNG_UNREGISTER_TRIGGER:
 181                 return "LTTNG_UNREGISTER_TRIGGER";
 182         case LTTNG_ROTATE_SESSION:
 183                 return "LTTNG_ROTATE_SESSION";
 184         case LTTNG_ROTATION_GET_INFO:
 185                 return "LTTNG_ROTATION_GET_INFO";
 186         case LTTNG_ROTATION_SET_SCHEDULE:
 187                 return "LTTNG_ROTATION_SET_SCHEDULE";
 188         case LTTNG_SESSION_LIST_ROTATION_SCHEDULES:
 189                 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
 190         case LTTNG_CREATE_SESSION_EXT:
 191                 return "LTTNG_CREATE_SESSION_EXT";
 192         case LTTNG_CLEAR_SESSION:
 193                 return "LTTNG_CLEAR_SESSION";
 194         case LTTNG_LIST_TRIGGERS:
 195                 return "LTTNG_LIST_TRIGGERS";
 196         case LTTNG_EXECUTE_ERROR_QUERY:
 197                 return "LTTNG_EXECUTE_ERROR_QUERY";
 198         default:
 199                 abort();
 200         }
 201 }
 202
 203 enum lttcomm_relayd_command {
 204         RELAYD_ADD_STREAM                   = 1,
 205         RELAYD_CREATE_SESSION               = 2,
 206         RELAYD_START_DATA                   = 3,
 207         RELAYD_UPDATE_SYNC_INFO             = 4,
 208         RELAYD_VERSION                      = 5,
 209         RELAYD_SEND_METADATA                = 6,
 210         RELAYD_CLOSE_STREAM                 = 7,
 211         RELAYD_DATA_PENDING                 = 8,
 212         RELAYD_QUIESCENT_CONTROL            = 9,
 213         RELAYD_BEGIN_DATA_PENDING           = 10,
 214         RELAYD_END_DATA_PENDING             = 11,
 215         RELAYD_ADD_INDEX                    = 12,
 216         RELAYD_SEND_INDEX                   = 13,
 217         RELAYD_CLOSE_INDEX                  = 14,
 218         /* Live-reading commands (2.4+). */
 219         RELAYD_LIST_SESSIONS                = 15,
 220         /* All streams of the channel have been sent to the relayd (2.4+). */
 221         RELAYD_STREAMS_SENT                 = 16,
 222         /* Ask the relay to reset the metadata trace file (2.8+) */
 223         RELAYD_RESET_METADATA               = 17,
 224         /* Ask the relay to rotate a set of stream files (2.11+) */
 225         RELAYD_ROTATE_STREAMS                = 18,
 226         /* Ask the relay to create a trace chunk (2.11+) */
 227         RELAYD_CREATE_TRACE_CHUNK           = 19,
 228         /* Ask the relay to close a trace chunk (2.11+) */
 229         RELAYD_CLOSE_TRACE_CHUNK            = 20,
 230         /* Ask the relay whether a trace chunk exists (2.11+) */
 231         RELAYD_TRACE_CHUNK_EXISTS           = 21,
 232         /* Get the current configuration of a relayd peer (2.12+) */
 233         RELAYD_GET_CONFIGURATION            = 22,
 234
 235         /* Feature branch specific commands start at 10000. */
 236 };
 237
 238 static inline
 239 const char *lttcomm_relayd_command_str(lttcomm_relayd_command cmd)
 240 {
 241         switch (cmd) {
 242         case RELAYD_ADD_STREAM:
 243                 return "RELAYD_ADD_STREAM";
 244         case RELAYD_CREATE_SESSION:
 245                 return "RELAYD_CREATE_SESSION";
 246         case RELAYD_START_DATA:
 247                 return "RELAYD_START_DATA";
 248         case RELAYD_UPDATE_SYNC_INFO:
 249                 return "RELAYD_UPDATE_SYNC_INFO";
 250         case RELAYD_VERSION:
 251                 return "RELAYD_VERSION";
 252         case RELAYD_SEND_METADATA:
 253                 return "RELAYD_SEND_METADATA";
 254         case RELAYD_CLOSE_STREAM:
 255                 return "RELAYD_CLOSE_STREAM";
 256         case RELAYD_DATA_PENDING:
 257                 return "RELAYD_DATA_PENDING";
 258         case RELAYD_QUIESCENT_CONTROL:
 259                 return "RELAYD_QUIESCENT_CONTROL";
 260         case RELAYD_BEGIN_DATA_PENDING:
 261                 return "RELAYD_BEGIN_DATA_PENDING";
 262         case RELAYD_END_DATA_PENDING:
 263                 return "RELAYD_END_DATA_PENDING";
 264         case RELAYD_ADD_INDEX:
 265                 return "RELAYD_ADD_INDEX";
 266         case RELAYD_SEND_INDEX:
 267                 return "RELAYD_SEND_INDEX";
 268         case RELAYD_CLOSE_INDEX:
 269                 return "RELAYD_CLOSE_INDEX";
 270         case RELAYD_LIST_SESSIONS:
 271                 return "RELAYD_LIST_SESSIONS";
 272         case RELAYD_STREAMS_SENT:
 273                 return "RELAYD_STREAMS_SENT";
 274         case RELAYD_RESET_METADATA:
 275                 return "RELAYD_RESET_METADATA";
 276         case RELAYD_ROTATE_STREAMS:
 277                 return "RELAYD_ROTATE_STREAMS";
 278         case RELAYD_CREATE_TRACE_CHUNK:
 279                 return "RELAYD_CREATE_TRACE_CHUNK";
 280         case RELAYD_CLOSE_TRACE_CHUNK:
 281                 return "RELAYD_CLOSE_TRACE_CHUNK";
 282         case RELAYD_TRACE_CHUNK_EXISTS:
 283                 return "RELAYD_TRACE_CHUNK_EXISTS";
 284         case RELAYD_GET_CONFIGURATION:
 285                 return "RELAYD_GET_CONFIGURATION";
 286         default:
 287                 abort();
 288         }
 289 }
 290
 291 /*
 292  * lttcomm error code.
 293  */
 294 enum lttcomm_return_code {
 295         LTTCOMM_CONSUMERD_SUCCESS            = 0,   /* Everything went fine. */
 296         /*
 297          * Some code paths use -1 to express an error, others
 298          * negate this consumer return code. Starting codes at
 299          * 100 ensures there is no mix-up between this error value
 300          * and legitimate status codes.
 301          */
 302         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
 303         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 304         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 305         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 306         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 307         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 308         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 309         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 310         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 311         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 312         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 313         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 314         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 315         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 316         LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
 317         LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
 318         LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
 319         LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
 320         LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */
 321         LTTCOMM_CONSUMERD_CHAN_NOT_FOUND,           /* Channel not found. */
 322         LTTCOMM_CONSUMERD_ALREADY_SET,              /* Resource already set. */
 323         LTTCOMM_CONSUMERD_ROTATION_FAIL,            /* Rotation has failed. */
 324         LTTCOMM_CONSUMERD_SNAPSHOT_FAILED,          /* snapshot has failed. */
 325         LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
 326         LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk close failed. */
 327         LTTCOMM_CONSUMERD_INVALID_PARAMETERS,       /* Invalid parameters. */
 328         LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
 329         LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
 330         LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK,      /* Unknown trace chunk. */
 331         LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED,  /* Relayd does not accept clear command. */
 332         LTTCOMM_CONSUMERD_UNKNOWN_ERROR,            /* Unknown error. */
 333
 334         /* MUST be last element */
 335         LTTCOMM_NR,                                             /* Last element */
 336 };
 337
 338 /* lttng socket protocol. */
 339 enum lttcomm_sock_proto {
 340         LTTCOMM_SOCK_UDP,
 341         LTTCOMM_SOCK_TCP,
 342 };
 343
 344 /*
 345  * Index in the net_families array below. Please keep in sync!
 346  */
 347 enum lttcomm_sock_domain {
 348         LTTCOMM_INET      = 0,
 349         LTTCOMM_INET6     = 1,
 350 };
 351
 352 enum lttcomm_metadata_command {
 353         LTTCOMM_METADATA_REQUEST = 1,
 354 };
 355
 356 /*
 357  * Commands sent from the consumerd to the sessiond to request if new metadata
 358  * is available. This message is used to find the per UID _or_ per PID registry
 359  * for the channel key. For per UID lookup, the triplet
 360  * bits_per_long/uid/session_id is used. On lookup failure, we search for the
 361  * per PID registry indexed by session id ignoring the other values.
 362  */
 363 struct lttcomm_metadata_request_msg {
 364         uint64_t session_id; /* Tracing session id */
 365         uint64_t session_id_per_pid; /* Tracing session id for per-pid */
 366         uint32_t bits_per_long; /* Consumer ABI */
 367         uint32_t uid;
 368         uint64_t key; /* Metadata channel key. */
 369 } LTTNG_PACKED;
 370
 371 struct lttcomm_sockaddr {
 372         enum lttcomm_sock_domain type;
 373         union {
 374                 struct sockaddr_in sin;
 375                 struct sockaddr_in6 sin6;
 376         } addr;
 377 };
 378
 379 struct lttcomm_sock {
 380         int32_t fd;
 381         enum lttcomm_sock_proto proto;
 382         struct lttcomm_sockaddr sockaddr;
 383         const struct lttcomm_proto_ops *ops;
 384 };
 385
 386 /*
 387  * Relayd sock. Adds the protocol version to use for the communications with
 388  * the relayd.
 389  */
 390 struct lttcomm_relayd_sock {
 391         struct lttcomm_sock sock;
 392         uint32_t major;
 393         uint32_t minor;
 394 };
 395
 396 struct lttcomm_net_family {
 397         int family;
 398         int (*create) (struct lttcomm_sock *sock, int type, int proto);
 399 };
 400
 401 struct lttcomm_proto_ops {
 402         int (*bind) (struct lttcomm_sock *sock);
 403         int (*close) (struct lttcomm_sock *sock);
 404         int (*connect) (struct lttcomm_sock *sock);
 405         struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
 406         int (*listen) (struct lttcomm_sock *sock, int backlog);
 407         ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
 408                         int flags);
 409         ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
 410                         size_t len, int flags);
 411 };
 412
 413 struct process_attr_integral_value_comm {
 414         union {
 415                 int64_t _signed;
 416                 uint64_t _unsigned;
 417         } u;
 418 } LTTNG_PACKED;
 419
 420 /*
 421  * Data structure received from lttng client to session daemon.
 422  */
 423 struct lttcomm_session_msg {
 424         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 425         struct lttng_session session;
 426         struct lttng_domain domain;
 427         union {
 428                 /* Event data */
 429                 struct {
 430                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 431                         uint32_t length;
 432                 } LTTNG_PACKED enable;
 433                 struct {
 434                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 435                         uint32_t length;
 436                 } LTTNG_PACKED disable;
 437                 /* Create channel */
 438                 struct {
 439                         uint32_t length;
 440                 } LTTNG_PACKED channel;
 441                 /* Context */
 442                 struct {
 443                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 444                         uint32_t length;
 445                 } LTTNG_PACKED context;
 446                 /* Use by register_consumer */
 447                 struct {
 448                         char path[PATH_MAX];
 449                 } LTTNG_PACKED reg;
 450                 /* List */
 451                 struct {
 452                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 453                 } LTTNG_PACKED list;
 454                 struct lttng_calibrate calibrate;
 455                 /* Used by the set_consumer_url and used by create_session also call */
 456                 struct {
 457                         /* Number of lttng_uri following */
 458                         uint32_t size;
 459                 } LTTNG_PACKED uri;
 460                 struct {
 461                         struct lttng_snapshot_output output;
 462                 } LTTNG_PACKED snapshot_output;
 463                 struct {
 464                         uint32_t wait;
 465                         struct lttng_snapshot_output output;
 466                 } LTTNG_PACKED snapshot_record;
 467                 struct {
 468                         uint32_t nb_uri;
 469                         unsigned int timer_interval;    /* usec */
 470                 } LTTNG_PACKED session_live;
 471                 struct {
 472                         struct lttng_save_session_attr attr;
 473                 } LTTNG_PACKED save_session;
 474                 struct {
 475                         char shm_path[PATH_MAX];
 476                 } LTTNG_PACKED set_shm_path;
 477                 struct {
 478                         /* enum lttng_process_attr */
 479                         int32_t process_attr;
 480                         /* enum lttng_process_attr_value_type */
 481                         int32_t value_type;
 482
 483                         struct process_attr_integral_value_comm integral_value;
 484                         /*
 485                          * For user/group names, a variable length,
 486                          * zero-terminated, string of length 'name_len'
 487                          * (including the terminator) follows.
 488                          *
 489                          * integral_value should not be used in those cases.
 490                          */
 491                         uint32_t name_len;
 492                 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
 493                 struct {
 494                         /* enum lttng_process_attr */
 495                         int32_t process_attr;
 496                 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
 497                 struct {
 498                         /* enum lttng_process_attr */
 499                         int32_t process_attr;
 500                 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
 501                 struct {
 502                         /* enum lttng_process_attr */
 503                         int32_t process_attr;
 504                         /* enum lttng_tracking_policy */
 505                         int32_t tracking_policy;
 506                 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
 507                 struct {
 508                         uint32_t length;
 509                         uint8_t is_trigger_anonymous;
 510                 } LTTNG_PACKED trigger;
 511                 struct {
 512                         uint32_t length;
 513                 } LTTNG_PACKED error_query;
 514                 struct {
 515                         uint64_t rotation_id;
 516                 } LTTNG_PACKED get_rotation_info;
 517                 struct {
 518                         /* enum lttng_rotation_schedule_type */
 519                         uint8_t type;
 520                         /*
 521                          * If set == 1, set schedule to value, if set == 0,
 522                          * clear this schedule type.
 523                          */
 524                         uint8_t set;
 525                         uint64_t value;
 526                 } LTTNG_PACKED rotation_set_schedule;
 527                 struct {
 528                         /*
 529                          * Includes the null-terminator.
 530                          * Must be an absolute path.
 531                          *
 532                          * Size bounded by LTTNG_PATH_MAX.
 533                          */
 534                         uint16_t home_dir_size;
 535                         uint64_t session_descriptor_size;
 536                         /* An lttng_session_descriptor follows. */
 537                 } LTTNG_PACKED create_session;
 538         } u;
 539         /* Count of fds sent. */
 540         uint32_t fd_count;
 541 } LTTNG_PACKED;
 542
 543 #define LTTNG_FILTER_MAX_LEN    65536
 544 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN        65536
 545
 546 /*
 547  * Filter bytecode data. The reloc table is located at the end of the
 548  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 549  * starts at reloc_table_offset.
 550  */
 551 #define LTTNG_FILTER_PADDING    32
 552 struct lttng_bytecode {
 553         uint32_t len;   /* len of data */
 554         uint32_t reloc_table_offset;
 555         uint64_t seqnum;
 556         char padding[LTTNG_FILTER_PADDING];
 557         char data[0];
 558 } LTTNG_PACKED;
 559
 560 /*
 561  * Event exclusion data. At the end of the structure, there will actually
 562  * by zero or more names, where the actual number of names is given by
 563  * the 'count' item of the structure.
 564  */
 565 #define LTTNG_EVENT_EXCLUSION_PADDING   32
 566 struct lttng_event_exclusion {
 567         uint32_t count;
 568         char padding[LTTNG_EVENT_EXCLUSION_PADDING];
 569         char names[][LTTNG_SYMBOL_NAME_LEN];
 570 } LTTNG_PACKED;
 571
 572 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
 573         ((_exclusion)->names[_i])
 574
 575 /*
 576  * Listing command header.
 577  */
 578 struct lttcomm_list_command_header {
 579         /* Number of elements */
 580         uint32_t count;
 581 } LTTNG_PACKED;
 582
 583 /*
 584  * Event extended info header. This is the structure preceding each
 585  * extended info data.
 586  */
 587 struct lttcomm_event_extended_header {
 588         /*
 589          * Size of filter string immediately following this header.
 590          * This size includes the terminal null character.
 591          */
 592         uint32_t filter_len;
 593
 594         /*
 595          * Number of exclusion names, immediately following the filter
 596          * string. Each exclusion name has a fixed length of
 597          * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
 598          * character.
 599          */
 600         uint32_t nb_exclusions;
 601
 602         /*
 603          * Size of the event's userspace probe location (if applicable).
 604          */
 605         uint32_t userspace_probe_location_len;
 606 } LTTNG_PACKED;
 607
 608 /*
 609  * Command header of the reply to an LTTNG_DESTROY_SESSION command.
 610  */
 611 struct lttcomm_session_destroy_command_header {
 612         /* enum lttng_session */
 613         int32_t rotation_state;
 614 };
 615
 616 /*
 617  * tracker command header.
 618  */
 619 struct lttcomm_tracker_command_header {
 620         uint32_t nb_tracker_id;
 621 } LTTNG_PACKED;
 622
 623 /*
 624  * Data structure for the response from sessiond to the lttng client.
 625  */
 626 struct lttcomm_lttng_msg {
 627         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 628         uint32_t ret_code;      /* enum lttcomm_return_code */
 629         uint32_t pid;           /* pid_t */
 630         uint32_t cmd_header_size;
 631         uint32_t data_size;
 632         uint32_t fd_count;
 633 } LTTNG_PACKED;
 634
 635 struct lttcomm_lttng_output_id {
 636         uint32_t id;
 637 } LTTNG_PACKED;
 638
 639 /*
 640  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 641  * to either add a channel, add a stream, update a stream, or stop
 642  * operation.
 643  */
 644 struct lttcomm_consumer_msg {
 645         uint32_t cmd_type;      /* enum lttng_consumer_command */
 646         union {
 647                 struct {
 648                         uint64_t channel_key;
 649                         uint64_t session_id;
 650                         /* ID of the session's current trace chunk. */
 651                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
 652                         char pathname[PATH_MAX];
 653                         uint64_t relayd_id;
 654                         /* nb_init_streams is the number of streams open initially. */
 655                         uint32_t nb_init_streams;
 656                         char name[LTTNG_SYMBOL_NAME_LEN];
 657                         /* Use splice or mmap to consume this fd */
 658                         enum lttng_event_output output;
 659                         int type; /* Per cpu or metadata. */
 660                         uint64_t tracefile_size; /* bytes */
 661                         uint32_t tracefile_count; /* number of tracefiles */
 662                         /* If the channel's streams have to be monitored or not. */
 663                         uint32_t monitor;
 664                         /* timer to check the streams usage in live mode (usec). */
 665                         unsigned int live_timer_interval;
 666                         /* is part of a live session */
 667                         uint8_t is_live;
 668                         /* timer to sample a channel's positions (usec). */
 669                         unsigned int monitor_timer_interval;
 670                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 671                 struct {
 672                         uint64_t stream_key;
 673                         uint64_t channel_key;
 674                         int32_t cpu;    /* On which CPU this stream is assigned. */
 675                         /* Tells the consumer if the stream should be or not monitored. */
 676                         uint32_t no_monitor;
 677                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 678                 struct {
 679                         uint64_t net_index;
 680                         enum lttng_stream_type type;
 681                         uint32_t major;
 682                         uint32_t minor;
 683                         uint8_t relayd_socket_protocol;
 684                         /* Tracing session id associated to the relayd. */
 685                         uint64_t session_id;
 686                         /* Relayd session id, only used with control socket. */
 687                         uint64_t relayd_session_id;
 688                 } LTTNG_PACKED relayd_sock;
 689                 struct {
 690                         uint64_t net_seq_idx;
 691                 } LTTNG_PACKED destroy_relayd;
 692                 struct {
 693                         uint64_t session_id;
 694                 } LTTNG_PACKED data_pending;
 695                 struct {
 696                         uint64_t subbuf_size;                   /* bytes */
 697                         uint64_t num_subbuf;                    /* power of 2 */
 698                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 699                         uint32_t switch_timer_interval;         /* usec */
 700                         uint32_t read_timer_interval;           /* usec */
 701                         unsigned int live_timer_interval;       /* usec */
 702                         uint8_t is_live;                        /* is part of a live session */
 703                         uint32_t monitor_timer_interval;        /* usec */
 704                         int32_t output;                         /* splice, mmap */
 705                         int32_t type;                           /* metadata or per_cpu */
 706                         uint64_t session_id;                    /* Tracing session id */
 707                         char pathname[PATH_MAX];                /* Channel file path. */
 708                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 709                         /* Credentials used to open the UST buffer shared mappings. */
 710                         struct {
 711                                 uint32_t uid;
 712                                 uint32_t gid;
 713                         } LTTNG_PACKED buffer_credentials;
 714                         uint64_t relayd_id;                     /* Relayd id if apply. */
 715                         uint64_t key;                           /* Unique channel key. */
 716                         /* ID of the session's current trace chunk. */
 717                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
 718                         unsigned char uuid[LTTNG_UUID_LEN];     /* uuid for ust tracer. */
 719                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 720                         uint64_t tracefile_size;        /* bytes */
 721                         uint32_t tracefile_count;       /* number of tracefiles */
 722                         uint64_t session_id_per_pid;    /* Per-pid session ID. */
 723                         /* Tells the consumer if the stream should be or not monitored. */
 724                         uint32_t monitor;
 725                         /*
 726                          * For UST per UID buffers, this is the application UID of the
 727                          * channel.  This can be different from the user UID requesting the
 728                          * channel creation and used for the rights on the stream file
 729                          * because the application can be in the tracing for instance.
 730                          */
 731                         uint32_t ust_app_uid;
 732                         int64_t blocking_timeout;
 733                         char root_shm_path[PATH_MAX];
 734                         char shm_path[PATH_MAX];
 735                 } LTTNG_PACKED ask_channel;
 736                 struct {
 737                         uint64_t key;
 738                 } LTTNG_PACKED get_channel;
 739                 struct {
 740                         uint64_t key;
 741                 } LTTNG_PACKED destroy_channel;
 742                 struct {
 743                         uint64_t key;   /* Metadata channel key. */
 744                         uint64_t target_offset; /* Offset in the consumer */
 745                         uint64_t len;   /* Length of metadata to be received. */
 746                         uint64_t version; /* Version of the metadata. */
 747                 } LTTNG_PACKED push_metadata;
 748                 struct {
 749                         uint64_t key;   /* Metadata channel key. */
 750                 } LTTNG_PACKED close_metadata;
 751                 struct {
 752                         uint64_t key;   /* Metadata channel key. */
 753                 } LTTNG_PACKED setup_metadata;
 754                 struct {
 755                         uint64_t key;   /* Channel key. */
 756                 } LTTNG_PACKED flush_channel;
 757                 struct {
 758                         uint64_t key;   /* Channel key. */
 759                 } LTTNG_PACKED clear_quiescent_channel;
 760                 struct {
 761                         char pathname[PATH_MAX];
 762                         /* Indicate if the snapshot goes on the relayd or locally. */
 763                         uint32_t use_relayd;
 764                         uint32_t metadata;              /* This a metadata snapshot. */
 765                         uint64_t relayd_id;             /* Relayd id if apply. */
 766                         uint64_t key;
 767                         uint64_t nb_packets_per_stream;
 768                 } LTTNG_PACKED snapshot_channel;
 769                 struct {
 770                         uint64_t channel_key;
 771                         uint64_t net_seq_idx;
 772                 } LTTNG_PACKED sent_streams;
 773                 struct {
 774                         uint64_t session_id;
 775                         uint64_t channel_key;
 776                 } LTTNG_PACKED discarded_events;
 777                 struct {
 778                         uint64_t session_id;
 779                         uint64_t channel_key;
 780                 } LTTNG_PACKED lost_packets;
 781                 struct {
 782                         uint64_t session_id;
 783                 } LTTNG_PACKED regenerate_metadata;
 784                 struct {
 785                         uint32_t metadata; /* This is a metadata channel. */
 786                         uint64_t relayd_id; /* Relayd id if apply. */
 787                         uint64_t key;
 788                 } LTTNG_PACKED rotate_channel;
 789                 struct {
 790                         uint64_t session_id;
 791                         uint64_t chunk_id;
 792                 } LTTNG_PACKED check_rotation_pending_local;
 793                 struct {
 794                         uint64_t relayd_id;
 795                         uint64_t session_id;
 796                         uint64_t chunk_id;
 797                 } LTTNG_PACKED check_rotation_pending_relay;
 798                 struct {
 799                         /*
 800                          * Relayd id, if applicable (remote).
 801                          *
 802                          * A directory file descriptor referring to the chunk's
 803                          * output folder is transmitted if the chunk is local
 804                          * (relayd_id unset).
 805                          *
 806                          * `override_name` is left NULL (all-zeroes) if the
 807                          * chunk's name is not overridden.
 808                          */
 809                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
 810                         char override_name[LTTNG_NAME_MAX];
 811                         uint64_t session_id;
 812                         uint64_t chunk_id;
 813                         uint64_t creation_timestamp;
 814                         LTTNG_OPTIONAL_COMM(struct {
 815                                 uint32_t uid;
 816                                 uint32_t gid;
 817                         } LTTNG_PACKED ) LTTNG_PACKED credentials;
 818                 } LTTNG_PACKED create_trace_chunk;
 819                 struct {
 820                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
 821                         uint64_t session_id;
 822                         uint64_t chunk_id;
 823                         uint64_t close_timestamp;
 824                         /* enum lttng_trace_chunk_command_type */
 825                         LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
 826                 } LTTNG_PACKED close_trace_chunk;
 827                 struct {
 828                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
 829                         uint64_t session_id;
 830                         uint64_t chunk_id;
 831                 } LTTNG_PACKED trace_chunk_exists;
 832                 struct {
 833                         lttng_uuid sessiond_uuid;
 834                 } LTTNG_PACKED init;
 835                 struct {
 836                         uint64_t key;
 837                 } LTTNG_PACKED clear_channel;
 838                 struct {
 839                         uint64_t key;
 840                 } LTTNG_PACKED open_channel_packets;
 841         } u;
 842 } LTTNG_PACKED;
 843
 844 /*
 845  * Channel monitoring message returned to the session daemon on every
 846  * monitor timer expiration.
 847  */
 848 struct lttcomm_consumer_channel_monitor_msg {
 849         /* Key of the sampled channel. */
 850         uint64_t key;
 851         /*
 852          * Lowest and highest usage (bytes) at the moment the sample was taken.
 853          */
 854         uint64_t lowest, highest;
 855         /*
 856          * Sum of all the consumed positions for a channel.
 857          */
 858         uint64_t total_consumed;
 859 } LTTNG_PACKED;
 860
 861 /*
 862  * Status message returned to the sessiond after a received command.
 863  */
 864 struct lttcomm_consumer_status_msg {
 865         enum lttcomm_return_code ret_code;
 866 } LTTNG_PACKED;
 867
 868 struct lttcomm_consumer_status_channel {
 869         enum lttcomm_return_code ret_code;
 870         uint64_t key;
 871         unsigned int stream_count;
 872 } LTTNG_PACKED;
 873
 874 struct lttcomm_consumer_close_trace_chunk_reply {
 875         enum lttcomm_return_code ret_code;
 876         uint32_t path_length;
 877         char path[];
 878 };
 879
 880 #ifdef HAVE_LIBLTTNG_UST_CTL
 881
 882 #include <lttng/ust-abi.h>
 883
 884 /*
 885  * Data structure for the commands sent from sessiond to UST.
 886  */
 887 struct lttcomm_ust_msg {
 888         uint32_t handle;
 889         uint32_t cmd;
 890         union {
 891                 struct lttng_ust_abi_channel channel;
 892                 struct lttng_ust_abi_stream stream;
 893                 struct lttng_ust_abi_event event;
 894                 struct lttng_ust_abi_context context;
 895                 struct lttng_ust_abi_tracer_version version;
 896         } u;
 897 } LTTNG_PACKED;
 898
 899 /*
 900  * Data structure for the response from UST to the session daemon.
 901  * cmd_type is sent back in the reply for validation.
 902  */
 903 struct lttcomm_ust_reply {
 904         uint32_t handle;
 905         uint32_t cmd;
 906         uint32_t ret_code;      /* enum lttcomm_return_code */
 907         uint32_t ret_val;       /* return value */
 908         union {
 909                 struct {
 910                         uint64_t memory_map_size;
 911                 } LTTNG_PACKED channel;
 912                 struct {
 913                         uint64_t memory_map_size;
 914                 } LTTNG_PACKED stream;
 915                 struct lttng_ust_abi_tracer_version version;
 916         } u;
 917 } LTTNG_PACKED;
 918
 919 #endif /* HAVE_LIBLTTNG_UST_CTL */
 920
 921 const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 922
 923 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 924                 const char *ip, unsigned int port);
 925 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 926                 const char *ip, unsigned int port);
 927
 928 struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
 929 int lttcomm_populate_sock_from_open_socket(struct lttcomm_sock *sock,
 930                 int fd,
 931                 enum lttcomm_sock_proto protocol);
 932 int lttcomm_create_sock(struct lttcomm_sock *sock);
 933 struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
 934 void lttcomm_destroy_sock(struct lttcomm_sock *sock);
 935 struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 936 void lttcomm_copy_sock(struct lttcomm_sock *dst,
 937                 struct lttcomm_sock *src);
 938
 939 /* Relayd socket object. */
 940 struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
 941                 struct lttng_uri *uri, uint32_t major, uint32_t minor);
 942
 943 int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
 944 int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
 945
 946 int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
 947                 uint16_t *port);
 948 /*
 949  * Set a port to an lttcomm_sock. This will have no effect is the socket is
 950  * already bound.
 951  */
 952 int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
 953
 954 void lttcomm_init(void);
 955 /* Get network timeout, in milliseconds */
 956 unsigned long lttcomm_get_network_timeout(void);
 957
 958 #endif  /* _LTTNG_SESSIOND_COMM_H */