include/lttng/ust-ctl.h

   1 // SPDX-FileCopyrightText: 2011 EfficiOS Inc.
   2 // SPDX-FileCopyrightText: 2011-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   3 //
   4 // SPDX-License-Identifier: GPL-2.0-only
   5
   6 #ifndef _LTTNG_UST_CTL_H
   7 #define _LTTNG_UST_CTL_H
   8
   9 #include <limits.h>
  10 #include <stddef.h>
  11 #include <stdint.h>
  12 #include <stdbool.h>
  13 #include <sys/types.h>
  14
  15 #include <lttng/ust-abi.h>
  16 #include <lttng/ust-utils.h>
  17 #include <lttng/ust-sigbus.h>
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 #ifndef LTTNG_UST_UUID_LEN
  24 #define LTTNG_UST_UUID_LEN      16
  25 #endif
  26
  27 /* Default unix socket path */
  28 #define LTTNG_UST_SOCK_FILENAME                                 \
  29         "lttng-ust-sock-"                                       \
  30         lttng_ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE)
  31
  32 /*
  33  * Shared memory files path are automatically related to shm root, e.g.
  34  * /dev/shm under linux.
  35  */
  36 #define LTTNG_UST_WAIT_FILENAME                                 \
  37         "lttng-ust-wait-"                                       \
  38         lttng_ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE)
  39
  40 struct lttng_ust_ctl_consumer_channel_attr {
  41         enum lttng_ust_abi_chan_type type;
  42         uint64_t subbuf_size;                   /* bytes */
  43         uint64_t num_subbuf;                    /* power of 2 */
  44         int overwrite;                          /* 1: overwrite, 0: discard */
  45         unsigned int switch_timer_interval;     /* usec */
  46         unsigned int read_timer_interval;       /* usec */
  47         enum lttng_ust_abi_output output;       /* splice, mmap */
  48         uint32_t chan_id;                       /* channel ID */
  49         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
  50         int64_t blocking_timeout;                       /* Blocking timeout (usec) */
  51 } __attribute__((packed));
  52
  53 /*
  54  * API used by sessiond.
  55  */
  56
  57 struct lttng_ust_context_attr {
  58         enum lttng_ust_abi_context_type ctx;
  59         union {
  60                 struct lttng_ust_abi_perf_counter_ctx perf_counter;
  61                 struct {
  62                         char *provider_name;
  63                         char *ctx_name;
  64                 } app_ctx;
  65         } u;
  66 };
  67
  68 /*
  69  * Error values: all the following functions return:
  70  * >= 0: Success (LTTNG_UST_OK)
  71  * < 0: error code.
  72  */
  73 int lttng_ust_ctl_register_done(int sock);
  74 int lttng_ust_ctl_create_session(int sock);
  75 int lttng_ust_ctl_create_event(int sock, struct lttng_ust_abi_event *ev,
  76                 struct lttng_ust_abi_object_data *channel_data,
  77                 struct lttng_ust_abi_object_data **event_data);
  78 int lttng_ust_ctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
  79                 struct lttng_ust_abi_object_data *obj_data,
  80                 struct lttng_ust_abi_object_data **context_data);
  81 int lttng_ust_ctl_set_filter(int sock, struct lttng_ust_abi_filter_bytecode *bytecode,
  82                 struct lttng_ust_abi_object_data *obj_data);
  83 int lttng_ust_ctl_set_capture(int sock, struct lttng_ust_abi_capture_bytecode *bytecode,
  84                 struct lttng_ust_abi_object_data *obj_data);
  85 int lttng_ust_ctl_set_exclusion(int sock, struct lttng_ust_abi_event_exclusion *exclusion,
  86                 struct lttng_ust_abi_object_data *obj_data);
  87
  88 int lttng_ust_ctl_enable(int sock, struct lttng_ust_abi_object_data *object);
  89 int lttng_ust_ctl_disable(int sock, struct lttng_ust_abi_object_data *object);
  90 int lttng_ust_ctl_start_session(int sock, int handle);
  91 int lttng_ust_ctl_stop_session(int sock, int handle);
  92
  93 /*
  94  * lttng_ust_ctl_create_event notifier_group creates a event notifier group. It
  95  * establishes the connection with the application by providing a file
  96  * descriptor of the pipe to be used by the application when a event notifier
  97  * of that group is fired. It returns a handle to be used when creating event
  98  * notifier in that group.
  99  */
 100 int lttng_ust_ctl_create_event_notifier_group(int sock, int pipe_fd,
 101                 struct lttng_ust_abi_object_data **event_notifier_group);
 102
 103 /*
 104  * lttng_ust_ctl_create_event notifier creates a event notifier in a event notifier
 105  * group giving a event notifier description and a event notifier group handle.
 106  * It returns a event notifier handle to be used when enabling the event
 107  * notifier, attaching filter, attaching exclusion, and disabling the event
 108  * notifier.
 109  */
 110 int lttng_ust_ctl_create_event_notifier(int sock,
 111                 struct lttng_ust_abi_event_notifier *event_notifier,
 112                 struct lttng_ust_abi_object_data *event_notifier_group,
 113                 struct lttng_ust_abi_object_data **event_notifier_data);
 114
 115 /*
 116  * lttng_ust_ctl_tracepoint_list returns a tracepoint list handle, or negative
 117  * error value.
 118  */
 119 int lttng_ust_ctl_tracepoint_list(int sock);
 120
 121 /*
 122  * lttng_ust_ctl_tracepoint_list_get is used to iterate on the tp list
 123  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 124  * returned.
 125  */
 126 int lttng_ust_ctl_tracepoint_list_get(int sock, int tp_list_handle,
 127                 struct lttng_ust_abi_tracepoint_iter *iter);
 128
 129 /*
 130  * lttng_ust_ctl_tracepoint_field_list returns a tracepoint field list handle,
 131  * or negative error value.
 132  */
 133 int lttng_ust_ctl_tracepoint_field_list(int sock);
 134
 135 /*
 136  * lttng_ust_ctl_tracepoint_field_list_get is used to iterate on the tp field
 137  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 138  * returned.
 139  */
 140 int lttng_ust_ctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 141                 struct lttng_ust_abi_field_iter *iter);
 142
 143 int lttng_ust_ctl_tracer_version(int sock, struct lttng_ust_abi_tracer_version *v);
 144 int lttng_ust_ctl_wait_quiescent(int sock);
 145
 146 int lttng_ust_ctl_sock_flush_buffer(int sock, struct lttng_ust_abi_object_data *object);
 147
 148 int lttng_ust_ctl_calibrate(int sock, struct lttng_ust_abi_calibrate *calibrate);
 149
 150 /* Release object created by members of this API. */
 151 int lttng_ust_ctl_release_object(int sock, struct lttng_ust_abi_object_data *data);
 152 /* Release handle returned by create session. */
 153 int lttng_ust_ctl_release_handle(int sock, int handle);
 154
 155 int lttng_ust_ctl_recv_channel_from_consumer(int sock,
 156                 struct lttng_ust_abi_object_data **channel_data);
 157 int lttng_ust_ctl_recv_stream_from_consumer(int sock,
 158                 struct lttng_ust_abi_object_data **stream_data);
 159 int lttng_ust_ctl_send_channel_to_ust(int sock, int session_handle,
 160                 struct lttng_ust_abi_object_data *channel_data);
 161 int lttng_ust_ctl_send_stream_to_ust(int sock,
 162                 struct lttng_ust_abi_object_data *channel_data,
 163                 struct lttng_ust_abi_object_data *stream_data);
 164
 165 /*
 166  * lttng_ust_ctl_duplicate_ust_object_data allocated a new object in "dest" if
 167  * it succeeds (returns 0). It must be released using
 168  * lttng_ust_ctl_release_object() and then freed with free().
 169  */
 170 int lttng_ust_ctl_duplicate_ust_object_data(struct lttng_ust_abi_object_data **dest,
 171                 struct lttng_ust_abi_object_data *src);
 172
 173 /*
 174  * API used by consumer.
 175  */
 176
 177 struct lttng_ust_ctl_consumer_channel;
 178 struct lttng_ust_ctl_consumer_stream;
 179 struct lttng_ust_ctl_consumer_channel_attr;
 180
 181 int lttng_ust_ctl_get_nr_stream_per_channel(void);
 182
 183 struct lttng_ust_ctl_consumer_channel *
 184         lttng_ust_ctl_create_channel(struct lttng_ust_ctl_consumer_channel_attr *attr,
 185                 const int *stream_fds, int nr_stream_fds);
 186 /*
 187  * Each stream created needs to be destroyed before calling
 188  * lttng_ust_ctl_destroy_channel().
 189  */
 190 void lttng_ust_ctl_destroy_channel(struct lttng_ust_ctl_consumer_channel *chan);
 191
 192 int lttng_ust_ctl_send_channel_to_sessiond(int sock,
 193                 struct lttng_ust_ctl_consumer_channel *channel);
 194 int lttng_ust_ctl_channel_close_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 195 int lttng_ust_ctl_channel_close_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 196 int lttng_ust_ctl_channel_get_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 197 int lttng_ust_ctl_channel_get_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 198
 199 int lttng_ust_ctl_write_metadata_to_channel(
 200                 struct lttng_ust_ctl_consumer_channel *channel,
 201                 const char *metadata_str,       /* NOT null-terminated */
 202                 size_t len);                    /* metadata length */
 203 ssize_t lttng_ust_ctl_write_one_packet_to_channel(
 204                 struct lttng_ust_ctl_consumer_channel *channel,
 205                 const char *metadata_str,       /* NOT null-terminated */
 206                 size_t len);                    /* metadata length */
 207
 208 /*
 209  * Send a NULL stream to finish iteration over all streams of a given
 210  * channel.
 211  */
 212 int lttng_ust_ctl_send_stream_to_sessiond(int sock,
 213                 struct lttng_ust_ctl_consumer_stream *stream);
 214 int lttng_ust_ctl_stream_close_wait_fd(struct lttng_ust_ctl_consumer_stream *stream);
 215 int lttng_ust_ctl_stream_close_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream);
 216 int lttng_ust_ctl_stream_get_wait_fd(struct lttng_ust_ctl_consumer_stream *stream);
 217 int lttng_ust_ctl_stream_get_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream);
 218
 219 /* Create/destroy stream buffers for read */
 220 struct lttng_ust_ctl_consumer_stream *
 221         lttng_ust_ctl_create_stream(struct lttng_ust_ctl_consumer_channel *channel,
 222                         int cpu);
 223 void lttng_ust_ctl_destroy_stream(struct lttng_ust_ctl_consumer_stream *stream);
 224
 225 /* For mmap mode, readable without "get" operation */
 226 int lttng_ust_ctl_get_mmap_len(struct lttng_ust_ctl_consumer_stream *stream,
 227                 unsigned long *len);
 228 int lttng_ust_ctl_get_max_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 229                 unsigned long *len);
 230
 231 /*
 232  * For mmap mode, operate on the current packet (between get/put or
 233  * get_next/put_next).
 234  */
 235 void *lttng_ust_ctl_get_mmap_base(struct lttng_ust_ctl_consumer_stream *stream);
 236 int lttng_ust_ctl_get_mmap_read_offset(struct lttng_ust_ctl_consumer_stream *stream,
 237                 unsigned long *off);
 238 int lttng_ust_ctl_get_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 239                 unsigned long *len);
 240 int lttng_ust_ctl_get_padded_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 241                 unsigned long *len);
 242 int lttng_ust_ctl_get_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 243 int lttng_ust_ctl_put_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 244
 245 /* snapshot */
 246
 247 int lttng_ust_ctl_snapshot(struct lttng_ust_ctl_consumer_stream *stream);
 248 int lttng_ust_ctl_snapshot_sample_positions(struct lttng_ust_ctl_consumer_stream *stream);
 249 int lttng_ust_ctl_snapshot_get_consumed(struct lttng_ust_ctl_consumer_stream *stream,
 250                 unsigned long *pos);
 251 int lttng_ust_ctl_snapshot_get_produced(struct lttng_ust_ctl_consumer_stream *stream,
 252                 unsigned long *pos);
 253 int lttng_ust_ctl_get_subbuf(struct lttng_ust_ctl_consumer_stream *stream,
 254                 unsigned long *pos);
 255 int lttng_ust_ctl_put_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 256
 257 int lttng_ust_ctl_flush_buffer(struct lttng_ust_ctl_consumer_stream *stream,
 258                 int producer_active);
 259 int lttng_ust_ctl_clear_buffer(struct lttng_ust_ctl_consumer_stream *stream);
 260
 261 /* index */
 262
 263 /*
 264  * Getters which need to be used on the current packet (between get/put
 265  * or get_next/put_next.
 266  */
 267
 268 int lttng_ust_ctl_get_timestamp_begin(struct lttng_ust_ctl_consumer_stream *stream,
 269                 uint64_t *timestamp_begin);
 270 int lttng_ust_ctl_get_timestamp_end(struct lttng_ust_ctl_consumer_stream *stream,
 271         uint64_t *timestamp_end);
 272 int lttng_ust_ctl_get_events_discarded(struct lttng_ust_ctl_consumer_stream *stream,
 273         uint64_t *events_discarded);
 274 int lttng_ust_ctl_get_content_size(struct lttng_ust_ctl_consumer_stream *stream,
 275         uint64_t *content_size);
 276 int lttng_ust_ctl_get_packet_size(struct lttng_ust_ctl_consumer_stream *stream,
 277         uint64_t *packet_size);
 278 int lttng_ust_ctl_get_sequence_number(struct lttng_ust_ctl_consumer_stream *stream,
 279                 uint64_t *seq);
 280
 281 /*
 282  * Getter returning state invariant for the stream, which can be used
 283  * without "get" operation.
 284  */
 285
 286 int lttng_ust_ctl_get_stream_id(struct lttng_ust_ctl_consumer_stream *stream,
 287                 uint64_t *stream_id);
 288 int lttng_ust_ctl_get_instance_id(struct lttng_ust_ctl_consumer_stream *stream,
 289                 uint64_t *id);
 290
 291 /*
 292  * Getter returning the current timestamp as perceived from the
 293  * tracer.
 294  */
 295 int lttng_ust_ctl_get_current_timestamp(struct lttng_ust_ctl_consumer_stream *stream,
 296                 uint64_t *ts);
 297
 298 /* returns whether UST has perf counters support. */
 299 int lttng_ust_ctl_has_perf_counters(void);
 300
 301 /* Regenerate the statedump. */
 302 int lttng_ust_ctl_regenerate_statedump(int sock, int handle);
 303
 304 /* event registry management */
 305
 306 enum lttng_ust_ctl_socket_type {
 307         LTTNG_UST_CTL_SOCKET_CMD = 0,
 308         LTTNG_UST_CTL_SOCKET_NOTIFY = 1,
 309 };
 310
 311 enum lttng_ust_ctl_notify_cmd {
 312         LTTNG_UST_CTL_NOTIFY_CMD_EVENT = 0,
 313         LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL = 1,
 314         LTTNG_UST_CTL_NOTIFY_CMD_ENUM = 2,
 315         LTTNG_UST_CTL_NOTIFY_CMD_KEY = 3,
 316 };
 317
 318 enum lttng_ust_ctl_channel_header {
 319         LTTNG_UST_CTL_CHANNEL_HEADER_UNKNOWN = 0,
 320         LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT = 1,
 321         LTTNG_UST_CTL_CHANNEL_HEADER_LARGE = 2,
 322 };
 323
 324 /* event type structures */
 325
 326 enum lttng_ust_ctl_abstract_types {
 327         lttng_ust_ctl_atype_integer,
 328         lttng_ust_ctl_atype_enum,       /* legacy */
 329         lttng_ust_ctl_atype_array,      /* legacy */
 330         lttng_ust_ctl_atype_sequence,   /* legacy */
 331         lttng_ust_ctl_atype_string,
 332         lttng_ust_ctl_atype_float,
 333         lttng_ust_ctl_atype_variant,    /* legacy */
 334         lttng_ust_ctl_atype_struct,     /* legacy */
 335         lttng_ust_ctl_atype_enum_nestable,
 336         lttng_ust_ctl_atype_array_nestable,
 337         lttng_ust_ctl_atype_sequence_nestable,
 338         lttng_ust_ctl_atype_struct_nestable,
 339         lttng_ust_ctl_atype_variant_nestable,
 340         NR_LTTNG_UST_CTL_ABSTRACT_TYPES,
 341 };
 342
 343 enum lttng_ust_ctl_string_encodings {
 344         lttng_ust_ctl_encode_none = 0,
 345         lttng_ust_ctl_encode_UTF8 = 1,
 346         lttng_ust_ctl_encode_ASCII = 2,
 347         NR_LTTNG_UST_CTL_STRING_ENCODINGS,
 348 };
 349
 350 #define LTTNG_UST_CTL_UST_INTEGER_TYPE_PADDING  24
 351 struct lttng_ust_ctl_integer_type {
 352         uint32_t size;          /* in bits */
 353         uint32_t signedness;
 354         uint32_t reverse_byte_order;
 355         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 356         int32_t encoding;       /* enum lttng_ust_ctl_string_encodings */
 357         uint16_t alignment;     /* in bits */
 358         char padding[LTTNG_UST_CTL_UST_INTEGER_TYPE_PADDING];
 359 } __attribute__((packed));
 360
 361 #define LTTNG_UST_CTL_UST_FLOAT_TYPE_PADDING    24
 362 struct lttng_ust_ctl_float_type {
 363         uint32_t exp_dig;               /* exponent digits, in bits */
 364         uint32_t mant_dig;              /* mantissa digits, in bits */
 365         uint32_t reverse_byte_order;
 366         uint16_t alignment;     /* in bits */
 367         char padding[LTTNG_UST_CTL_UST_FLOAT_TYPE_PADDING];
 368 } __attribute__((packed));
 369
 370 #define LTTNG_UST_CTL_UST_ENUM_VALUE_PADDING    15
 371 struct lttng_ust_ctl_enum_value {
 372         uint64_t value;
 373         uint8_t signedness;
 374         char padding[LTTNG_UST_CTL_UST_ENUM_VALUE_PADDING];
 375 } __attribute__((packed));
 376
 377 enum lttng_ust_ctl_ust_enum_entry_options {
 378         LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 379 };
 380
 381 #define LTTNG_UST_CTL_UST_ENUM_ENTRY_PADDING    32
 382 struct lttng_ust_ctl_enum_entry {
 383         struct lttng_ust_ctl_enum_value start, end; /* start and end are inclusive */
 384         char string[LTTNG_UST_ABI_SYM_NAME_LEN];
 385         union {
 386                 struct {
 387                         uint32_t options;
 388                 } __attribute__((packed)) extra;
 389                 char padding[LTTNG_UST_CTL_UST_ENUM_ENTRY_PADDING];
 390         } u;
 391 } __attribute__((packed));
 392
 393 /* legacy */
 394 #define LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING    296
 395 union _lttng_ust_ctl_basic_type {
 396         struct lttng_ust_ctl_integer_type integer;
 397         struct {
 398                 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
 399                 struct lttng_ust_ctl_integer_type container_type;
 400                 uint64_t id;    /* enum ID in sessiond. */
 401         } enumeration;
 402         struct {
 403                 int32_t encoding;       /* enum lttng_ust_ctl_string_encodings */
 404         } string;
 405         struct lttng_ust_ctl_float_type _float;
 406         char padding[LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING];
 407 } __attribute__((packed));
 408
 409 /* legacy */
 410 struct lttng_ust_ctl_basic_type {
 411         enum lttng_ust_ctl_abstract_types atype;
 412         union {
 413                 union _lttng_ust_ctl_basic_type basic;
 414         } u;
 415 } __attribute__((packed));
 416
 417 /*
 418  * Padding is derived from largest member: u.legacy.sequence which
 419  * contains two basic types, each with LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING.
 420  */
 421 #define LTTNG_UST_CTL_UST_TYPE_PADDING  (2 * LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING)
 422 struct lttng_ust_ctl_type {
 423         enum lttng_ust_ctl_abstract_types atype;
 424         union {
 425                 struct lttng_ust_ctl_integer_type integer;
 426                 struct lttng_ust_ctl_float_type _float;
 427                 struct {
 428                         int32_t encoding;       /* enum lttng_ust_ctl_string_encodings */
 429                 } string;
 430                 struct {
 431                         char name[LTTNG_UST_ABI_SYM_NAME_LEN];
 432                         uint64_t id;    /* enum ID in sessiond. */
 433                         /* container_type follows after this struct lttng_ust_ctl_field. */
 434                 } enum_nestable;
 435                 struct {
 436                         uint32_t length;                /* num. elems. */
 437                         uint32_t alignment;
 438                         /* elem_type follows after this struct lttng_ust_ctl_field. */
 439                 } array_nestable;
 440                 struct {
 441                         char length_name[LTTNG_UST_ABI_SYM_NAME_LEN];
 442                         uint32_t alignment;             /* Alignment before elements. */
 443                         /* elem_type follows after the length_type. */
 444                 } sequence_nestable;
 445                 struct {
 446                         uint32_t nr_fields;
 447                         uint32_t alignment;
 448                         /* Followed by nr_fields struct lttng_ust_ctl_field. */
 449                 } struct_nestable;
 450                 struct {
 451                         uint32_t nr_choices;
 452                         char tag_name[LTTNG_UST_ABI_SYM_NAME_LEN];
 453                         uint32_t alignment;
 454                         /* Followed by nr_choices struct lttng_ust_ctl_field. */
 455                 } variant_nestable;
 456
 457                 /* Legacy ABI */
 458                 union {
 459                         union _lttng_ust_ctl_basic_type basic;
 460                         struct {
 461                                 struct lttng_ust_ctl_basic_type elem_type;
 462                                 uint32_t length;                /* num. elems. */
 463                         } array;
 464                         struct {
 465                                 struct lttng_ust_ctl_basic_type length_type;
 466                                 struct lttng_ust_ctl_basic_type elem_type;
 467                         } sequence;
 468                         struct {
 469                                 uint32_t nr_fields;
 470                                 /* Followed by nr_fields struct lttng_ust_ctl_field. */
 471                         } _struct;
 472                         struct {
 473                                 uint32_t nr_choices;
 474                                 char tag_name[LTTNG_UST_ABI_SYM_NAME_LEN];
 475                                 /* Followed by nr_choices struct lttng_ust_ctl_field. */
 476                         } variant;
 477                 } legacy;
 478                 char padding[LTTNG_UST_CTL_UST_TYPE_PADDING];
 479         } u;
 480 } __attribute__((packed));
 481
 482 #define LTTNG_UST_CTL_UST_FIELD_PADDING 28
 483 struct lttng_ust_ctl_field {
 484         char name[LTTNG_UST_ABI_SYM_NAME_LEN];
 485         struct lttng_ust_ctl_type type;
 486         char padding[LTTNG_UST_CTL_UST_FIELD_PADDING];
 487 } __attribute__((packed));
 488
 489 /*
 490  * Returns 0 on success, negative error value on error.
 491  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 492  * the output fields are not populated.
 493  */
 494 int lttng_ust_ctl_recv_reg_msg(int sock,
 495         enum lttng_ust_ctl_socket_type *type,
 496         uint32_t *major,
 497         uint32_t *minor,
 498         uint32_t *pid,
 499         uint32_t *ppid,
 500         uint32_t *uid,
 501         uint32_t *gid,
 502         uint32_t *bits_per_long,
 503         uint32_t *uint8_t_alignment,
 504         uint32_t *uint16_t_alignment,
 505         uint32_t *uint32_t_alignment,
 506         uint32_t *uint64_t_alignment,
 507         uint32_t *long_alignment,
 508         int *byte_order,
 509         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 510
 511 /*
 512  * Returns 0 on success, negative UST or system error value on error.
 513  * Receive the notification command. The "notify_cmd" can then be used
 514  * by the caller to find out which lttng_ust_ctl_recv_* function should be
 515  * called to receive the notification, and which lttng_ust_ctl_reply_* is
 516  * appropriate.
 517  */
 518 int lttng_ust_ctl_recv_notify(int sock, enum lttng_ust_ctl_notify_cmd *notify_cmd);
 519
 520 /*
 521  * Returns 0 on success, negative UST or system error value on error.
 522  */
 523 int lttng_ust_ctl_recv_register_event(int sock,
 524         int *session_objd,              /* session descriptor (output) */
 525         int *channel_objd,              /* channel descriptor (output) */
 526         char *event_name,               /*
 527                                          * event name (output,
 528                                          * size LTTNG_UST_ABI_SYM_NAME_LEN)
 529                                          */
 530         int *loglevel,
 531         char **signature,               /*
 532                                          * event signature
 533                                          * (output, dynamically
 534                                          * allocated, must be free(3)'d
 535                                          * by the caller if function
 536                                          * returns success.)
 537                                          */
 538         size_t *nr_fields,
 539         struct lttng_ust_ctl_field **fields,
 540         char **model_emf_uri,
 541         uint64_t *user_token);
 542
 543 /*
 544  * Returns 0 on success, negative error value on error.
 545  */
 546 int lttng_ust_ctl_reply_register_event(int sock,
 547         uint32_t id,                    /* id (input) */
 548         int ret_code);                  /* return code. 0 ok, negative error */
 549
 550 /*
 551  * Returns 0 on success, negative UST or system error value on error.
 552  */
 553 int lttng_ust_ctl_recv_register_key(int sock,
 554         int *session_objd,              /* session descriptor (output) */
 555         int *map_objd,                  /* map descriptor (output) */
 556         uint32_t *dimension,            /*
 557                                          * Against which dimension is
 558                                          * this key expressed. (output)
 559                                          */
 560         uint64_t **dimension_indexes,   /*
 561                                          * Indexes (output,
 562                                          * dynamically
 563                                          * allocated, must be
 564                                          * free(3)'d by the
 565                                          * caller if function
 566                                          * returns success.)
 567                                          * Contains @dimension
 568                                          * elements.
 569                                          */
 570         char **key_string,              /*
 571                                          * key string (output,
 572                                          * dynamically allocated, must
 573                                          * be free(3)'d by the caller if
 574                                          * function returns success.)
 575                                          */
 576         uint64_t *user_token);
 577
 578 /*
 579  * Returns 0 on success, negative error value on error.
 580  */
 581 int lttng_ust_ctl_reply_register_key(int sock,
 582         uint64_t index,                 /* Index within dimension (input) */
 583         int ret_code);                  /* return code. 0 ok, negative error */
 584
 585 /*
 586  * Returns 0 on success, negative UST or system error value on error.
 587  */
 588 int lttng_ust_ctl_recv_register_enum(int sock,
 589         int *session_objd,
 590         char *enum_name,
 591         struct lttng_ust_ctl_enum_entry **entries,
 592         size_t *nr_entries);
 593
 594 /*
 595  * Returns 0 on success, negative error value on error.
 596  */
 597 int lttng_ust_ctl_reply_register_enum(int sock,
 598         uint64_t id,                    /* enum id (input) */
 599         int ret_code);
 600
 601 /*
 602  * Returns 0 on success, negative UST or system error value on error.
 603  */
 604 int lttng_ust_ctl_recv_register_channel(int sock,
 605         int *session_objd,              /* session descriptor (output) */
 606         int *channel_objd,              /* channel descriptor (output) */
 607         size_t *nr_fields,              /* context fields */
 608         struct lttng_ust_ctl_field **fields);
 609
 610 /*
 611  * Returns 0 on success, negative error value on error.
 612  */
 613 int lttng_ust_ctl_reply_register_channel(int sock,
 614         uint32_t chan_id,
 615         enum lttng_ust_ctl_channel_header header_type,
 616         int ret_code);                  /* return code. 0 ok, negative error */
 617
 618 /*
 619  * Counter API.
 620  */
 621
 622 enum lttng_ust_ctl_counter_bitness {
 623         LTTNG_UST_CTL_COUNTER_BITNESS_32 = 0,
 624         LTTNG_UST_CTL_COUNTER_BITNESS_64 = 1,
 625 };
 626
 627 enum lttng_ust_ctl_counter_arithmetic {
 628         LTTNG_UST_CTL_COUNTER_ARITHMETIC_MODULAR        = 0,
 629         LTTNG_UST_CTL_COUNTER_ARITHMETIC_SATURATION     = 1,
 630 };
 631
 632 enum lttng_ust_ctl_key_type {
 633         LTTNG_UST_CTL_KEY_TYPE_TOKENS = 0,
 634         LTTNG_UST_CTL_KEY_TYPE_INTEGER = 1,
 635 };
 636
 637 /* Used as alloc flags. */
 638 enum lttng_ust_ctl_counter_alloc {
 639         LTTNG_UST_CTL_COUNTER_ALLOC_PER_CPU = (1 << 0),
 640         LTTNG_UST_CTL_COUNTER_ALLOC_GLOBAL = (1 << 1),
 641 };
 642
 643 struct lttng_ust_ctl_daemon_counter;
 644
 645 int lttng_ust_ctl_get_nr_cpu_per_counter(void);
 646
 647 struct lttng_ust_ctl_counter_dimension {
 648         uint64_t size;
 649         uint64_t underflow_index;
 650         uint64_t overflow_index;
 651         enum lttng_ust_ctl_key_type key_type;
 652         uint8_t has_underflow;
 653         uint8_t has_overflow;
 654 };
 655
 656 struct lttng_ust_ctl_daemon_counter *
 657         lttng_ust_ctl_create_counter(size_t nr_dimensions,
 658                 const struct lttng_ust_ctl_counter_dimension *dimensions,
 659                 int64_t global_sum_step,
 660                 int global_counter_fd,
 661                 int nr_counter_cpu_fds,
 662                 const int *counter_cpu_fds,
 663                 enum lttng_ust_ctl_counter_bitness bitness,
 664                 enum lttng_ust_ctl_counter_arithmetic arithmetic,
 665                 uint32_t alloc_flags,
 666                 bool coalesce_hits);
 667
 668 int lttng_ust_ctl_create_counter_data(struct lttng_ust_ctl_daemon_counter *counter,
 669                 struct lttng_ust_abi_object_data **counter_data);
 670
 671 int lttng_ust_ctl_create_counter_global_data(struct lttng_ust_ctl_daemon_counter *counter,
 672                 struct lttng_ust_abi_object_data **counter_global_data);
 673 int lttng_ust_ctl_create_counter_cpu_data(struct lttng_ust_ctl_daemon_counter *counter, int cpu,
 674                 struct lttng_ust_abi_object_data **counter_cpu_data);
 675
 676 /*
 677  * Each counter data and counter cpu data created need to be destroyed
 678  * before calling lttng_ust_ctl_destroy_counter().
 679  */
 680 void lttng_ust_ctl_destroy_counter(struct lttng_ust_ctl_daemon_counter *counter);
 681
 682 int lttng_ust_ctl_send_counter_data_to_ust(int sock, int parent_handle,
 683                 struct lttng_ust_abi_object_data *counter_data);
 684 int lttng_ust_ctl_send_counter_global_data_to_ust(int sock,
 685                 struct lttng_ust_abi_object_data *counter_data,
 686                 struct lttng_ust_abi_object_data *counter_global_data);
 687 int lttng_ust_ctl_send_counter_cpu_data_to_ust(int sock,
 688                 struct lttng_ust_abi_object_data *counter_data,
 689                 struct lttng_ust_abi_object_data *counter_cpu_data);
 690
 691 int lttng_ust_ctl_counter_read(struct lttng_ust_ctl_daemon_counter *counter,
 692                 const size_t *dimension_indexes,
 693                 int cpu, int64_t *value,
 694                 bool *overflow, bool *underflow);
 695 int lttng_ust_ctl_counter_aggregate(struct lttng_ust_ctl_daemon_counter *counter,
 696                 const size_t *dimension_indexes,
 697                 int64_t *value,
 698                 bool *overflow, bool *underflow);
 699 int lttng_ust_ctl_counter_clear(struct lttng_ust_ctl_daemon_counter *counter,
 700                 const size_t *dimension_indexes);
 701
 702 int lttng_ust_ctl_counter_create_event(int sock,
 703                 struct lttng_ust_abi_counter_event *counter_event,
 704                 size_t counter_event_len,
 705                 struct lttng_ust_abi_object_data *counter_data,
 706                 struct lttng_ust_abi_object_data **counter_event_data);
 707
 708 void lttng_ust_ctl_sigbus_handle(void *addr);
 709
 710 int lttng_ust_ctl_get_version(uint32_t *major, uint32_t *minor, uint32_t *patchlevel);
 711
 712 #ifdef __cplusplus
 713 }
 714 #endif
 715
 716 #endif /* _LTTNG_UST_CTL_H */