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

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