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