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