src/bin/lttng-sessiond/ust-ctl-internal.h

   1 /*
   2  * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
   3  * Copyright (C) 2011-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-only
   6  *
   7  */
   8
   9 #ifndef LTTNG_UST_CTL_INTERNAL_H
  10 #define LTTNG_UST_CTL_INTERNAL_H
  11
  12 #include <sys/types.h>
  13 #include <limits.h>
  14
  15 #include "lttng-ust-abi.h"
  16
  17 #ifndef LTTNG_UST_UUID_LEN
  18 #define LTTNG_UST_UUID_LEN      16
  19 #endif
  20
  21 /* Default unix socket path */
  22 #define LTTNG_UST_SOCK_FILENAME                                 \
  23         "lttng-ust-sock-"                                       \
  24         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  25
  26 /*
  27  * Shared memory files path are automatically related to shm root, e.g.
  28  * /dev/shm under linux.
  29  */
  30 #define LTTNG_UST_WAIT_FILENAME                                 \
  31         "lttng-ust-wait-"                                       \
  32         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  33
  34 struct lttng_ust_shm_handle;
  35 struct lttng_ust_lib_ring_buffer;
  36
  37 struct ustctl_consumer_channel_attr {
  38         enum lttng_ust_chan_type type;
  39         uint64_t subbuf_size;                   /* bytes */
  40         uint64_t num_subbuf;                    /* power of 2 */
  41         int overwrite;                          /* 1: overwrite, 0: discard */
  42         unsigned int switch_timer_interval;     /* usec */
  43         unsigned int read_timer_interval;       /* usec */
  44         enum lttng_ust_output output;           /* splice, mmap */
  45         uint32_t chan_id;                       /* channel ID */
  46         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
  47         int64_t blocking_timeout;                       /* Blocking timeout (usec) */
  48 } LTTNG_PACKED;
  49
  50 /*
  51  * API used by sessiond.
  52  */
  53
  54 struct lttng_ust_context_attr {
  55         enum lttng_ust_context_type ctx;
  56         union {
  57                 struct lttng_ust_perf_counter_ctx perf_counter;
  58                 struct {
  59                         char *provider_name;
  60                         char *ctx_name;
  61                 } app_ctx;
  62         } u;
  63 };
  64
  65 /*
  66  * Error values: all the following functions return:
  67  * >= 0: Success (LTTNG_UST_OK)
  68  * < 0: error code.
  69  */
  70 int ustctl_register_done(int sock);
  71 int ustctl_create_session(int sock);
  72 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  73                 struct lttng_ust_object_data *channel_data,
  74                 struct lttng_ust_object_data **event_data);
  75 int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
  76                 struct lttng_ust_object_data *obj_data,
  77                 struct lttng_ust_object_data **context_data);
  78 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
  79                 struct lttng_ust_object_data *obj_data);
  80 int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
  81                 struct lttng_ust_object_data *obj_data);
  82
  83 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
  84 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
  85 int ustctl_start_session(int sock, int handle);
  86 int ustctl_stop_session(int sock, int handle);
  87
  88 /*
  89  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
  90  * error value.
  91  */
  92 int ustctl_tracepoint_list(int sock);
  93
  94 /*
  95  * ustctl_tracepoint_list_get is used to iterate on the tp list
  96  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
  97  * returned.
  98  */
  99 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
 100                 struct lttng_ust_tracepoint_iter *iter);
 101
 102 /*
 103  * ustctl_tracepoint_field_list returns a tracepoint field list handle,
 104  * or negative error value.
 105  */
 106 int ustctl_tracepoint_field_list(int sock);
 107
 108 /*
 109  * ustctl_tracepoint_field_list_get is used to iterate on the tp field
 110  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 111  * returned.
 112  */
 113 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 114                 struct lttng_ust_field_iter *iter);
 115
 116 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
 117 int ustctl_wait_quiescent(int sock);
 118
 119 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
 120
 121 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
 122
 123 /* Release object created by members of this API. */
 124 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 125 /* Release handle returned by create session. */
 126 int ustctl_release_handle(int sock, int handle);
 127
 128 int ustctl_recv_channel_from_consumer(int sock,
 129                 struct lttng_ust_object_data **channel_data);
 130 int ustctl_recv_stream_from_consumer(int sock,
 131                 struct lttng_ust_object_data **stream_data);
 132 int ustctl_send_channel_to_ust(int sock, int session_handle,
 133                 struct lttng_ust_object_data *channel_data);
 134 int ustctl_send_stream_to_ust(int sock,
 135                 struct lttng_ust_object_data *channel_data,
 136                 struct lttng_ust_object_data *stream_data);
 137
 138 /*
 139  * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
 140  * it succeeds (returns 0). It must be released using
 141  * ustctl_release_object() and then freed with free().
 142  */
 143 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
 144                 struct lttng_ust_object_data *src);
 145
 146 /*
 147  * API used by consumer.
 148  */
 149
 150 struct ustctl_consumer_channel;
 151 struct ustctl_consumer_stream;
 152 struct ustctl_consumer_channel_attr;
 153
 154 int ustctl_get_nr_stream_per_channel(void);
 155
 156 struct ustctl_consumer_channel *
 157         ustctl_create_channel(struct ustctl_consumer_channel_attr *attr,
 158                 const int *stream_fds, int nr_stream_fds);
 159 /*
 160  * Each stream created needs to be destroyed before calling
 161  * ustctl_destroy_channel().
 162  */
 163 void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
 164
 165 int ustctl_send_channel_to_sessiond(int sock,
 166                 struct ustctl_consumer_channel *channel);
 167 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 168 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 169 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 170 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 171
 172 int ustctl_write_metadata_to_channel(
 173                 struct ustctl_consumer_channel *channel,
 174                 const char *metadata_str,       /* NOT null-terminated */
 175                 size_t len);                    /* metadata length */
 176 ssize_t ustctl_write_one_packet_to_channel(
 177                 struct ustctl_consumer_channel *channel,
 178                 const char *metadata_str,       /* NOT null-terminated */
 179                 size_t len);                    /* metadata length */
 180
 181 /*
 182  * Send a NULL stream to finish iteration over all streams of a given
 183  * channel.
 184  */
 185 int ustctl_send_stream_to_sessiond(int sock,
 186                 struct ustctl_consumer_stream *stream);
 187 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
 188 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
 189 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
 190 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
 191
 192 /* Create/destroy stream buffers for read */
 193 struct ustctl_consumer_stream *
 194         ustctl_create_stream(struct ustctl_consumer_channel *channel,
 195                         int cpu);
 196 void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
 197
 198 /* For mmap mode, readable without "get" operation */
 199 int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
 200                 unsigned long *len);
 201 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
 202                 unsigned long *len);
 203
 204 /*
 205  * For mmap mode, operate on the current packet (between get/put or
 206  * get_next/put_next).
 207  */
 208 void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream);
 209 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
 210                 unsigned long *off);
 211 int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
 212                 unsigned long *len);
 213 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
 214                 unsigned long *len);
 215 int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
 216 int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
 217
 218 /* snapshot */
 219
 220 int ustctl_snapshot(struct ustctl_consumer_stream *stream);
 221 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream);
 222 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
 223                 unsigned long *pos);
 224 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
 225                 unsigned long *pos);
 226 int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
 227                 unsigned long *pos);
 228 int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
 229
 230 void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
 231                 int producer_active);
 232
 233 /* index */
 234 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
 235                 uint64_t *timestamp_begin);
 236 int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
 237         uint64_t *timestamp_end);
 238 int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
 239         uint64_t *events_discarded);
 240 int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
 241         uint64_t *content_size);
 242 int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
 243         uint64_t *packet_size);
 244 int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
 245                 uint64_t *stream_id);
 246 int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
 247                 uint64_t *ts);
 248 int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
 249                 uint64_t *seq);
 250 int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
 251                 uint64_t *id);
 252
 253 /* returns whether UST has perf counters support. */
 254 int ustctl_has_perf_counters(void);
 255
 256 /* Regenerate the statedump. */
 257 int ustctl_regenerate_statedump(int sock, int handle);
 258
 259 /* event registry management */
 260
 261 enum ustctl_socket_type {
 262         USTCTL_SOCKET_CMD = 0,
 263         USTCTL_SOCKET_NOTIFY = 1,
 264 };
 265
 266 enum ustctl_notify_cmd {
 267         USTCTL_NOTIFY_CMD_EVENT = 0,
 268         USTCTL_NOTIFY_CMD_CHANNEL = 1,
 269         USTCTL_NOTIFY_CMD_ENUM = 2,
 270 };
 271
 272 enum ustctl_channel_header {
 273         USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
 274         USTCTL_CHANNEL_HEADER_COMPACT = 1,
 275         USTCTL_CHANNEL_HEADER_LARGE = 2,
 276 };
 277
 278 /* event type structures */
 279
 280 enum ustctl_abstract_types {
 281         ustctl_atype_integer,
 282         ustctl_atype_enum,      /* legacy */
 283         ustctl_atype_array,     /* legacy */
 284         ustctl_atype_sequence,  /* legacy */
 285         ustctl_atype_string,
 286         ustctl_atype_float,
 287         ustctl_atype_variant,   /* legacy */
 288         ustctl_atype_struct,    /* legacy */
 289         ustctl_atype_enum_nestable,
 290         ustctl_atype_array_nestable,
 291         ustctl_atype_sequence_nestable,
 292         ustctl_atype_struct_nestable,
 293         ustctl_atype_variant_nestable,
 294         NR_USTCTL_ABSTRACT_TYPES,
 295 };
 296
 297 enum ustctl_string_encodings {
 298         ustctl_encode_none = 0,
 299         ustctl_encode_UTF8 = 1,
 300         ustctl_encode_ASCII = 2,
 301         NR_USTCTL_STRING_ENCODINGS,
 302 };
 303
 304 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
 305 struct ustctl_integer_type {
 306         uint32_t size;          /* in bits */
 307         uint32_t signedness;
 308         uint32_t reverse_byte_order;
 309         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 310         int32_t encoding;       /* enum ustctl_string_encodings */
 311         uint16_t alignment;     /* in bits */
 312         char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
 313 } LTTNG_PACKED;
 314
 315 #define USTCTL_UST_FLOAT_TYPE_PADDING   24
 316 struct ustctl_float_type {
 317         uint32_t exp_dig;               /* exponent digits, in bits */
 318         uint32_t mant_dig;              /* mantissa digits, in bits */
 319         uint32_t reverse_byte_order;
 320         uint16_t alignment;     /* in bits */
 321         char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
 322 } LTTNG_PACKED;
 323
 324 #define USTCTL_UST_ENUM_VALUE_PADDING   15
 325 struct ustctl_enum_value {
 326         uint64_t value;
 327         uint8_t signedness;
 328         char padding[USTCTL_UST_ENUM_VALUE_PADDING];
 329 } LTTNG_PACKED;
 330
 331 enum ustctl_ust_enum_entry_options {
 332         USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 333 };
 334
 335 #define USTCTL_UST_ENUM_ENTRY_PADDING   32
 336 struct ustctl_enum_entry {
 337         struct ustctl_enum_value start, end; /* start and end are inclusive */
 338         char string[LTTNG_UST_SYM_NAME_LEN];
 339         union {
 340                 struct {
 341                         uint32_t options;
 342                 } LTTNG_PACKED extra;
 343                 char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
 344         } u;
 345 } LTTNG_PACKED;
 346
 347 /* legacy */
 348 #define USTCTL_UST_BASIC_TYPE_PADDING   296
 349 union _ustctl_basic_type {
 350         struct ustctl_integer_type integer;
 351         struct {
 352                 char name[LTTNG_UST_SYM_NAME_LEN];
 353                 struct ustctl_integer_type container_type;
 354                 uint64_t id;    /* enum ID in sessiond. */
 355         } enumeration;
 356         struct {
 357                 int32_t encoding;       /* enum ustctl_string_encodings */
 358         } string;
 359         struct ustctl_float_type _float;
 360         char padding[USTCTL_UST_BASIC_TYPE_PADDING];
 361 } LTTNG_PACKED;
 362
 363 /* legacy */
 364 struct ustctl_basic_type {
 365         enum ustctl_abstract_types atype;
 366         union {
 367                 union _ustctl_basic_type basic;
 368         } u;
 369 } LTTNG_PACKED;
 370
 371 /*
 372  * Padding is derived from largest member: u.legacy.sequence which
 373  * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING.
 374  */
 375 #define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING)
 376 struct ustctl_type {
 377         enum ustctl_abstract_types atype;
 378         union {
 379                 struct ustctl_integer_type integer;
 380                 struct ustctl_float_type _float;
 381                 struct {
 382                         int32_t encoding;       /* enum ustctl_string_encodings */
 383                 } string;
 384                 struct {
 385                         char name[LTTNG_UST_SYM_NAME_LEN];
 386                         uint64_t id;    /* enum ID in sessiond. */
 387                         /* container_type follows after this struct ustctl_field. */
 388                 } enum_nestable;
 389                 struct {
 390                         uint32_t length;                /* num. elems. */
 391                         uint32_t alignment;
 392                         /* elem_type follows after this struct ustctl_field. */
 393                 } array_nestable;
 394                 struct {
 395                         char length_name[LTTNG_UST_SYM_NAME_LEN];
 396                         uint32_t alignment;             /* Alignment before elements. */
 397                         /* elem_type follows after the length_type. */
 398                 } sequence_nestable;
 399                 struct {
 400                         uint32_t nr_fields;
 401                         uint32_t alignment;
 402                         /* Followed by nr_fields struct ustctl_field. */
 403                 } struct_nestable;
 404                 struct {
 405                         uint32_t nr_choices;
 406                         char tag_name[LTTNG_UST_SYM_NAME_LEN];
 407                         uint32_t alignment;
 408                         /* Followed by nr_choices struct ustctl_field. */
 409                 } variant_nestable;
 410
 411                 /* Legacy ABI */
 412                 union {
 413                         union _ustctl_basic_type basic;
 414                         struct {
 415                                 struct ustctl_basic_type elem_type;
 416                                 uint32_t length;                /* num. elems. */
 417                         } array;
 418                         struct {
 419                                 struct ustctl_basic_type length_type;
 420                                 struct ustctl_basic_type elem_type;
 421                         } sequence;
 422                         struct {
 423                                 uint32_t nr_fields;
 424                                 /* Followed by nr_fields struct ustctl_field. */
 425                         } _struct;
 426                         struct {
 427                                 uint32_t nr_choices;
 428                                 char tag_name[LTTNG_UST_SYM_NAME_LEN];
 429                                 /* Followed by nr_choices struct ustctl_field. */
 430                         } variant;
 431                 } legacy;
 432                 char padding[USTCTL_UST_TYPE_PADDING];
 433         } u;
 434 } LTTNG_PACKED;
 435
 436 #define USTCTL_UST_FIELD_PADDING        28
 437 struct ustctl_field {
 438         char name[LTTNG_UST_SYM_NAME_LEN];
 439         struct ustctl_type type;
 440         char padding[USTCTL_UST_FIELD_PADDING];
 441 } LTTNG_PACKED;
 442
 443 /*
 444  * Returns 0 on success, negative error value on error.
 445  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 446  * the output fields are not populated.
 447  */
 448 int ustctl_recv_reg_msg(int sock,
 449         enum ustctl_socket_type *type,
 450         uint32_t *major,
 451         uint32_t *minor,
 452         uint32_t *pid,
 453         uint32_t *ppid,
 454         uint32_t *uid,
 455         uint32_t *gid,
 456         uint32_t *bits_per_long,
 457         uint32_t *uint8_t_alignment,
 458         uint32_t *uint16_t_alignment,
 459         uint32_t *uint32_t_alignment,
 460         uint32_t *uint64_t_alignment,
 461         uint32_t *long_alignment,
 462         int *byte_order,
 463         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 464
 465 /*
 466  * Returns 0 on success, negative UST or system error value on error.
 467  * Receive the notification command. The "notify_cmd" can then be used
 468  * by the caller to find out which ustctl_recv_* function should be
 469  * called to receive the notification, and which ustctl_reply_* is
 470  * appropriate.
 471  */
 472 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
 473
 474 /*
 475  * Returns 0 on success, negative UST or system error value on error.
 476  */
 477 int ustctl_recv_register_event(int sock,
 478         int *session_objd,              /* session descriptor (output) */
 479         int *channel_objd,              /* channel descriptor (output) */
 480         char *event_name,               /*
 481                                          * event name (output,
 482                                          * size LTTNG_UST_SYM_NAME_LEN)
 483                                          */
 484         int *loglevel,
 485         char **signature,               /*
 486                                          * event signature
 487                                          * (output, dynamically
 488                                          * allocated, must be free(3)'d
 489                                          * by the caller if function
 490                                          * returns success.)
 491                                          */
 492         size_t *nr_fields,
 493         struct ustctl_field **fields,
 494         char **model_emf_uri);
 495
 496 /*
 497  * Returns 0 on success, negative error value on error.
 498  */
 499 int ustctl_reply_register_event(int sock,
 500         uint32_t id,                    /* event id (input) */
 501         int ret_code);                  /* return code. 0 ok, negative error */
 502
 503 /*
 504  * Returns 0 on success, negative UST or system error value on error.
 505  */
 506 int ustctl_recv_register_enum(int sock,
 507         int *session_objd,
 508         char *enum_name,
 509         struct ustctl_enum_entry **entries,
 510         size_t *nr_entries);
 511
 512 /*
 513  * Returns 0 on success, negative error value on error.
 514  */
 515 int ustctl_reply_register_enum(int sock,
 516         uint64_t id,                    /* enum id (input) */
 517         int ret_code);
 518
 519 /*
 520  * Returns 0 on success, negative UST or system error value on error.
 521  */
 522 int ustctl_recv_register_channel(int sock,
 523         int *session_objd,              /* session descriptor (output) */
 524         int *channel_objd,              /* channel descriptor (output) */
 525         size_t *nr_fields,              /* context fields */
 526         struct ustctl_field **fields);
 527
 528 /*
 529  * Returns 0 on success, negative error value on error.
 530  */
 531 int ustctl_reply_register_channel(int sock,
 532         uint32_t chan_id,
 533         enum ustctl_channel_header header_type,
 534         int ret_code);                  /* return code. 0 ok, negative error */
 535
 536 #endif /* LTTNG_UST_CTL_INTERNAL_H */