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