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