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