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