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