src/common/sessiond-comm/sessiond-comm.h

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