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