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