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