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