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         /* Ask the relay to create a trace chunk (2.11+) */
 137         RELAYD_CREATE_TRACE_CHUNK           = 19,
 138         /* Ask the relay to close a trace chunk (2.11+) */
 139         RELAYD_CLOSE_TRACE_CHUNK            = 20,
 140 };
 141
 142 /*
 143  * lttcomm error code.
 144  */
 145 enum lttcomm_return_code {
 146         LTTCOMM_CONSUMERD_SUCCESS            = 0,   /* Everything went fine. */
 147         /*
 148          * Some code paths use -1 to express an error, others
 149          * negate this consumer return code. Starting codes at
 150          * 100 ensures there is no mix-up between this error value
 151          * and legitimate status codes.
 152          */
 153         LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
 154         LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
 155         LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
 156         LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
 157         LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
 158         LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
 159         LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
 160         LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
 161         LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
 162         LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
 163         LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
 164         LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
 165         LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
 166         LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
 167         LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
 168         LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
 169         LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
 170         LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
 171         LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */
 172         LTTCOMM_CONSUMERD_CHAN_NOT_FOUND,           /* Channel not found. */
 173         LTTCOMM_CONSUMERD_ALREADY_SET,              /* Resource already set. */
 174         LTTCOMM_CONSUMERD_ROTATION_FAIL,            /* Rotation has failed. */
 175         LTTCOMM_CONSUMERD_SNAPSHOT_FAILED,          /* snapshot has failed. */
 176         LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
 177         LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
 178         LTTCOMM_CONSUMERD_INVALID_PARAMETERS,       /* Invalid parameters. */
 179         LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
 180         LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
 181         LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK,      /* Unknown trace chunk. */
 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 /*
 263  * Data structure received from lttng client to session daemon.
 264  */
 265 struct lttcomm_session_msg {
 266         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 267         struct lttng_session session;
 268         struct lttng_domain domain;
 269         union {
 270                 /* Event data */
 271                 struct {
 272                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 273                         struct lttng_event event LTTNG_PACKED;
 274                         /* Length of following filter expression. */
 275                         uint32_t expression_len;
 276                         /* Length of following bytecode for filter. */
 277                         uint32_t bytecode_len;
 278                         /* Exclusion count (fixed-size strings). */
 279                         uint32_t exclusion_count;
 280                         /* Userspace probe location size. */
 281                         uint32_t userspace_probe_location_len;
 282                         /*
 283                          * After this structure, the following variable-length
 284                          * items are transmitted:
 285                          * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
 286                          * - char filter_expression[expression_len]
 287                          * - unsigned char filter_bytecode[bytecode_len]
 288                          */
 289                 } LTTNG_PACKED enable;
 290                 struct {
 291                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 292                         struct lttng_event event LTTNG_PACKED;
 293                         /* Length of following filter expression. */
 294                         uint32_t expression_len;
 295                         /* Length of following bytecode for filter. */
 296                         uint32_t bytecode_len;
 297                         /*
 298                          * After this structure, the following variable-length
 299                          * items are transmitted:
 300                          * - unsigned char filter_expression[expression_len]
 301                          * - unsigned char filter_bytecode[bytecode_len]
 302                          */
 303                 } LTTNG_PACKED disable;
 304                 /* Create channel */
 305                 struct {
 306                         struct lttng_channel chan LTTNG_PACKED;
 307                         /* struct lttng_channel_extended is already packed. */
 308                         struct lttng_channel_extended extended;
 309                 } LTTNG_PACKED channel;
 310                 /* Context */
 311                 struct {
 312                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 313                         struct lttng_event_context ctx LTTNG_PACKED;
 314                         uint32_t provider_name_len;
 315                         uint32_t context_name_len;
 316                 } LTTNG_PACKED context;
 317                 /* Use by register_consumer */
 318                 struct {
 319                         char path[PATH_MAX];
 320                 } LTTNG_PACKED reg;
 321                 /* List */
 322                 struct {
 323                         char channel_name[LTTNG_SYMBOL_NAME_LEN];
 324                 } LTTNG_PACKED list;
 325                 struct lttng_calibrate calibrate;
 326                 /* Used by the set_consumer_url and used by create_session also call */
 327                 struct {
 328                         /* Number of lttng_uri following */
 329                         uint32_t size;
 330                 } LTTNG_PACKED uri;
 331                 struct {
 332                         struct lttng_snapshot_output output LTTNG_PACKED;
 333                 } LTTNG_PACKED snapshot_output;
 334                 struct {
 335                         uint32_t wait;
 336                         struct lttng_snapshot_output output LTTNG_PACKED;
 337                 } LTTNG_PACKED snapshot_record;
 338                 struct {
 339                         uint32_t nb_uri;
 340                         unsigned int timer_interval;    /* usec */
 341                 } LTTNG_PACKED session_live;
 342                 struct {
 343                         struct lttng_save_session_attr attr; /* struct already packed */
 344                 } LTTNG_PACKED save_session;
 345                 struct {
 346                         char shm_path[PATH_MAX];
 347                 } LTTNG_PACKED set_shm_path;
 348                 struct {
 349                         uint32_t pid;
 350                 } LTTNG_PACKED pid_tracker;
 351                 struct {
 352                         uint32_t length;
 353                 } LTTNG_PACKED trigger;
 354                 struct {
 355                         uint64_t rotation_id;
 356                 } LTTNG_PACKED get_rotation_info;
 357                 struct {
 358                         /* enum lttng_rotation_schedule_type */
 359                         uint8_t type;
 360                         /*
 361                          * If set == 1, set schedule to value, if set == 0,
 362                          * clear this schedule type.
 363                          */
 364                         uint8_t set;
 365                         uint64_t value;
 366                 } LTTNG_PACKED rotation_set_schedule;
 367                 struct {
 368                         /*
 369                          * Includes the null-terminator.
 370                          * Must be an absolute path.
 371                          *
 372                          * Size bounded by LTTNG_PATH_MAX.
 373                          */
 374                         uint16_t home_dir_size;
 375                         uint64_t session_descriptor_size;
 376                         /* An lttng_session_descriptor follows. */
 377                 } LTTNG_PACKED create_session;
 378         } u;
 379 } LTTNG_PACKED;
 380
 381 #define LTTNG_FILTER_MAX_LEN    65536
 382 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN        65536
 383
 384 /*
 385  * Filter bytecode data. The reloc table is located at the end of the
 386  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 387  * starts at reloc_table_offset.
 388  */
 389 #define LTTNG_FILTER_PADDING    32
 390 struct lttng_filter_bytecode {
 391         uint32_t len;   /* len of data */
 392         uint32_t reloc_table_offset;
 393         uint64_t seqnum;
 394         char padding[LTTNG_FILTER_PADDING];
 395         char data[0];
 396 } LTTNG_PACKED;
 397
 398 /*
 399  * Event exclusion data. At the end of the structure, there will actually
 400  * by zero or more names, where the actual number of names is given by
 401  * the 'count' item of the structure.
 402  */
 403 #define LTTNG_EVENT_EXCLUSION_PADDING   32
 404 struct lttng_event_exclusion {
 405         uint32_t count;
 406         char padding[LTTNG_EVENT_EXCLUSION_PADDING];
 407         char names[0][LTTNG_SYMBOL_NAME_LEN];
 408 } LTTNG_PACKED;
 409
 410 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
 411         (&(_exclusion)->names[_i][0])
 412
 413 /*
 414  * Event command header.
 415  */
 416 struct lttcomm_event_command_header {
 417         /* Number of events */
 418         uint32_t nb_events;
 419 } LTTNG_PACKED;
 420
 421 /*
 422  * Event extended info header. This is the structure preceding each
 423  * extended info data.
 424  */
 425 struct lttcomm_event_extended_header {
 426         /*
 427          * Size of filter string immediately following this header.
 428          * This size includes the terminal null character.
 429          */
 430         uint32_t filter_len;
 431
 432         /*
 433          * Number of exclusion names, immediately following the filter
 434          * string. Each exclusion name has a fixed length of
 435          * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
 436          * character.
 437          */
 438         uint32_t nb_exclusions;
 439
 440         /*
 441          * Size of the event's userspace probe location (if applicable).
 442          */
 443         uint32_t userspace_probe_location_len;
 444 } LTTNG_PACKED;
 445
 446 /*
 447  * Command header of the reply to an LTTNG_DESTROY_SESSION command.
 448  */
 449 struct lttcomm_session_destroy_command_header {
 450         /* enum lttng_session */
 451         int32_t rotation_state;
 452 };
 453
 454 /*
 455  * Data structure for the response from sessiond to the lttng client.
 456  */
 457 struct lttcomm_lttng_msg {
 458         uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
 459         uint32_t ret_code;      /* enum lttcomm_return_code */
 460         uint32_t pid;           /* pid_t */
 461         uint32_t cmd_header_size;
 462         uint32_t data_size;
 463 } LTTNG_PACKED;
 464
 465 struct lttcomm_lttng_output_id {
 466         uint32_t id;
 467 } LTTNG_PACKED;
 468
 469 /*
 470  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 471  * to either add a channel, add a stream, update a stream, or stop
 472  * operation.
 473  */
 474 struct lttcomm_consumer_msg {
 475         uint32_t cmd_type;      /* enum lttng_consumer_command */
 476         union {
 477                 struct {
 478                         uint64_t channel_key;
 479                         uint64_t session_id;
 480                         /* ID of the session's current trace chunk. */
 481                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
 482                         char pathname[PATH_MAX];
 483                         uint64_t relayd_id;
 484                         /* nb_init_streams is the number of streams open initially. */
 485                         uint32_t nb_init_streams;
 486                         char name[LTTNG_SYMBOL_NAME_LEN];
 487                         /* Use splice or mmap to consume this fd */
 488                         enum lttng_event_output output;
 489                         int type; /* Per cpu or metadata. */
 490                         uint64_t tracefile_size; /* bytes */
 491                         uint32_t tracefile_count; /* number of tracefiles */
 492                         /* If the channel's streams have to be monitored or not. */
 493                         uint32_t monitor;
 494                         /* timer to check the streams usage in live mode (usec). */
 495                         unsigned int live_timer_interval;
 496                         /* timer to sample a channel's positions (usec). */
 497                         unsigned int monitor_timer_interval;
 498                 } LTTNG_PACKED channel; /* Only used by Kernel. */
 499                 struct {
 500                         uint64_t stream_key;
 501                         uint64_t channel_key;
 502                         int32_t cpu;    /* On which CPU this stream is assigned. */
 503                         /* Tells the consumer if the stream should be or not monitored. */
 504                         uint32_t no_monitor;
 505                 } LTTNG_PACKED stream;  /* Only used by Kernel. */
 506                 struct {
 507                         uint64_t net_index;
 508                         enum lttng_stream_type type;
 509                         /* Open socket to the relayd */
 510                         struct lttcomm_relayd_sock sock;
 511                         /* Tracing session id associated to the relayd. */
 512                         uint64_t session_id;
 513                         /* Relayd session id, only used with control socket. */
 514                         uint64_t relayd_session_id;
 515                 } LTTNG_PACKED relayd_sock;
 516                 struct {
 517                         uint64_t net_seq_idx;
 518                 } LTTNG_PACKED destroy_relayd;
 519                 struct {
 520                         uint64_t session_id;
 521                 } LTTNG_PACKED data_pending;
 522                 struct {
 523                         uint64_t subbuf_size;                   /* bytes */
 524                         uint64_t num_subbuf;                    /* power of 2 */
 525                         int32_t overwrite;                      /* 1: overwrite, 0: discard */
 526                         uint32_t switch_timer_interval;         /* usec */
 527                         uint32_t read_timer_interval;           /* usec */
 528                         unsigned int live_timer_interval;       /* usec */
 529                         uint32_t monitor_timer_interval;        /* usec */
 530                         int32_t output;                         /* splice, mmap */
 531                         int32_t type;                           /* metadata or per_cpu */
 532                         uint64_t session_id;                    /* Tracing session id */
 533                         char pathname[PATH_MAX];                /* Channel file path. */
 534                         char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
 535                         /* Credentials used to open the UST buffer shared mappings. */
 536                         struct {
 537                                 uint32_t uid;
 538                                 uint32_t gid;
 539                         } LTTNG_PACKED buffer_credentials;
 540                         uint64_t relayd_id;                     /* Relayd id if apply. */
 541                         uint64_t key;                           /* Unique channel key. */
 542                         /* ID of the session's current trace chunk. */
 543                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
 544                         unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
 545                         uint32_t chan_id;                       /* Channel ID on the tracer side. */
 546                         uint64_t tracefile_size;        /* bytes */
 547                         uint32_t tracefile_count;       /* number of tracefiles */
 548                         uint64_t session_id_per_pid;    /* Per-pid session ID. */
 549                         /* Tells the consumer if the stream should be or not monitored. */
 550                         uint32_t monitor;
 551                         /*
 552                          * For UST per UID buffers, this is the application UID of the
 553                          * channel.  This can be different from the user UID requesting the
 554                          * channel creation and used for the rights on the stream file
 555                          * because the application can be in the tracing for instance.
 556                          */
 557                         uint32_t ust_app_uid;
 558                         int64_t blocking_timeout;
 559                         char root_shm_path[PATH_MAX];
 560                         char shm_path[PATH_MAX];
 561                 } LTTNG_PACKED ask_channel;
 562                 struct {
 563                         uint64_t key;
 564                 } LTTNG_PACKED get_channel;
 565                 struct {
 566                         uint64_t key;
 567                 } LTTNG_PACKED destroy_channel;
 568                 struct {
 569                         uint64_t key;   /* Metadata channel key. */
 570                         uint64_t target_offset; /* Offset in the consumer */
 571                         uint64_t len;   /* Length of metadata to be received. */
 572                         uint64_t version; /* Version of the metadata. */
 573                 } LTTNG_PACKED push_metadata;
 574                 struct {
 575                         uint64_t key;   /* Metadata channel key. */
 576                 } LTTNG_PACKED close_metadata;
 577                 struct {
 578                         uint64_t key;   /* Metadata channel key. */
 579                 } LTTNG_PACKED setup_metadata;
 580                 struct {
 581                         uint64_t key;   /* Channel key. */
 582                 } LTTNG_PACKED flush_channel;
 583                 struct {
 584                         uint64_t key;   /* Channel key. */
 585                 } LTTNG_PACKED clear_quiescent_channel;
 586                 struct {
 587                         char pathname[PATH_MAX];
 588                         /* Indicate if the snapshot goes on the relayd or locally. */
 589                         uint32_t use_relayd;
 590                         uint32_t metadata;              /* This a metadata snapshot. */
 591                         uint64_t relayd_id;             /* Relayd id if apply. */
 592                         uint64_t key;
 593                         uint64_t nb_packets_per_stream;
 594                 } LTTNG_PACKED snapshot_channel;
 595                 struct {
 596                         uint64_t channel_key;
 597                         uint64_t net_seq_idx;
 598                 } LTTNG_PACKED sent_streams;
 599                 struct {
 600                         uint64_t session_id;
 601                         uint64_t channel_key;
 602                 } LTTNG_PACKED discarded_events;
 603                 struct {
 604                         uint64_t session_id;
 605                         uint64_t channel_key;
 606                 } LTTNG_PACKED lost_packets;
 607                 struct {
 608                         uint64_t session_id;
 609                 } LTTNG_PACKED regenerate_metadata;
 610                 struct {
 611                         uint32_t metadata; /* This is a metadata channel. */
 612                         uint64_t relayd_id; /* Relayd id if apply. */
 613                         uint64_t key;
 614                 } LTTNG_PACKED rotate_channel;
 615                 struct {
 616                         uint64_t session_id;
 617                         uint64_t chunk_id;
 618                 } LTTNG_PACKED check_rotation_pending_local;
 619                 struct {
 620                         uint64_t relayd_id;
 621                         uint64_t session_id;
 622                         uint64_t chunk_id;
 623                 } LTTNG_PACKED check_rotation_pending_relay;
 624                 struct {
 625                         /*
 626                          * Relayd id, if applicable (remote).
 627                          *
 628                          * A directory file descriptor referring to the chunk's
 629                          * output folder is transmitted if the chunk is local
 630                          * (relayd_id unset).
 631                          *
 632                          * `override_name` is left NULL (all-zeroes) if the
 633                          * chunk's name is not overriden.
 634                          */
 635                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
 636                         char override_name[LTTNG_NAME_MAX];
 637                         uint64_t session_id;
 638                         uint64_t chunk_id;
 639                         uint64_t creation_timestamp;
 640                         LTTNG_OPTIONAL_COMM(struct {
 641                                 uint32_t uid;
 642                                 uint32_t gid;
 643                         } LTTNG_PACKED ) LTTNG_PACKED credentials;
 644                 } LTTNG_PACKED create_trace_chunk;
 645                 struct {
 646                         LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
 647                         uint64_t session_id;
 648                         uint64_t chunk_id;
 649                         uint64_t close_timestamp;
 650                         /* enum lttng_trace_chunk_command_type */
 651                         LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
 652                 } LTTNG_PACKED close_trace_chunk;
 653                 struct {
 654                         LTTNG_OPTIONAL_COMM(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 */