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