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