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