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