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

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