src/common/sessiond-comm/sessiond-comm.h

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