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

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