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 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 #ifndef LTTNG_UST_UUID_LEN
  22 #define LTTNG_UST_UUID_LEN      16
  23 #endif
  24
  25 /* Default unix socket path */
  26 #define LTTNG_UST_SOCK_FILENAME                                 \
  27         "lttng-ust-sock-"                                       \
  28         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE)
  29
  30 /*
  31  * Shared memory files path are automatically related to shm root, e.g.
  32  * /dev/shm under linux.
  33  */
  34 #define LTTNG_UST_WAIT_FILENAME                                 \
  35         "lttng-ust-wait-"                                       \
  36         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE)
  37
  38 struct lttng_ust_shm_handle;
  39 struct lttng_ust_lib_ring_buffer;
  40
  41 struct lttng_ust_ctl_consumer_channel_attr {
  42         enum lttng_ust_abi_chan_type type;
  43         uint64_t subbuf_size;                   /* bytes */
  44         uint64_t num_subbuf;                    /* power of 2 */
  45         int overwrite;                          /* 1: overwrite, 0: discard */
  46         unsigned int switch_timer_interval;     /* usec */
  47         unsigned int read_timer_interval;       /* usec */
  48         enum lttng_ust_abi_output output;       /* splice, mmap */
  49         uint32_t chan_id;                       /* channel ID */
  50         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
  51         int64_t blocking_timeout;                       /* Blocking timeout (usec) */
  52 } LTTNG_PACKED;
  53
  54 /*
  55  * API used by sessiond.
  56  */
  57
  58 struct lttng_ust_context_attr {
  59         enum lttng_ust_abi_context_type ctx;
  60         union {
  61                 struct lttng_ust_abi_perf_counter_ctx perf_counter;
  62                 struct {
  63                         char *provider_name;
  64                         char *ctx_name;
  65                 } app_ctx;
  66         } u;
  67 };
  68
  69 /*
  70  * Error values: all the following functions return:
  71  * >= 0: Success (LTTNG_UST_OK)
  72  * < 0: error code.
  73  */
  74 int lttng_ust_ctl_register_done(int sock);
  75 int lttng_ust_ctl_create_session(int sock);
  76 int lttng_ust_ctl_create_event(int sock, struct lttng_ust_abi_event *ev,
  77                 struct lttng_ust_abi_object_data *channel_data,
  78                 struct lttng_ust_abi_object_data **event_data);
  79 int lttng_ust_ctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
  80                 struct lttng_ust_abi_object_data *obj_data,
  81                 struct lttng_ust_abi_object_data **context_data);
  82 int lttng_ust_ctl_set_filter(int sock, struct lttng_ust_abi_filter_bytecode *bytecode,
  83                 struct lttng_ust_abi_object_data *obj_data);
  84 int lttng_ust_ctl_set_capture(int sock, struct lttng_ust_abi_capture_bytecode *bytecode,
  85                 struct lttng_ust_abi_object_data *obj_data);
  86 int lttng_ust_ctl_set_exclusion(int sock, struct lttng_ust_abi_event_exclusion *exclusion,
  87                 struct lttng_ust_abi_object_data *obj_data);
  88
  89 int lttng_ust_ctl_enable(int sock, struct lttng_ust_abi_object_data *object);
  90 int lttng_ust_ctl_disable(int sock, struct lttng_ust_abi_object_data *object);
  91 int lttng_ust_ctl_start_session(int sock, int handle);
  92 int lttng_ust_ctl_stop_session(int sock, int handle);
  93
  94 /*
  95  * lttng_ust_ctl_create_event notifier_group creates a event notifier group. It
  96  * establishes the connection with the application by providing a file
  97  * descriptor of the pipe to be used by the application when a event notifier
  98  * of that group is fired. It returns a handle to be used when creating event
  99  * notifier in that group.
 100  */
 101 int lttng_ust_ctl_create_event_notifier_group(int sock, int pipe_fd,
 102                 struct lttng_ust_abi_object_data **event_notifier_group);
 103
 104 /*
 105  * lttng_ust_ctl_create_event notifier creates a event notifier in a event notifier
 106  * group giving a event notifier description and a event notifier group handle.
 107  * It returns a event notifier handle to be used when enabling the event
 108  * notifier, attaching filter, attaching exclusion, and disabling the event
 109  * notifier.
 110  */
 111 int lttng_ust_ctl_create_event_notifier(int sock,
 112                 struct lttng_ust_abi_event_notifier *event_notifier,
 113                 struct lttng_ust_abi_object_data *event_notifier_group,
 114                 struct lttng_ust_abi_object_data **event_notifier_data);
 115
 116 /*
 117  * lttng_ust_ctl_tracepoint_list returns a tracepoint list handle, or negative
 118  * error value.
 119  */
 120 int lttng_ust_ctl_tracepoint_list(int sock);
 121
 122 /*
 123  * lttng_ust_ctl_tracepoint_list_get is used to iterate on the tp list
 124  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 125  * returned.
 126  */
 127 int lttng_ust_ctl_tracepoint_list_get(int sock, int tp_list_handle,
 128                 struct lttng_ust_abi_tracepoint_iter *iter);
 129
 130 /*
 131  * lttng_ust_ctl_tracepoint_field_list returns a tracepoint field list handle,
 132  * or negative error value.
 133  */
 134 int lttng_ust_ctl_tracepoint_field_list(int sock);
 135
 136 /*
 137  * lttng_ust_ctl_tracepoint_field_list_get is used to iterate on the tp field
 138  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 139  * returned.
 140  */
 141 int lttng_ust_ctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 142                 struct lttng_ust_abi_field_iter *iter);
 143
 144 int lttng_ust_ctl_tracer_version(int sock, struct lttng_ust_abi_tracer_version *v);
 145 int lttng_ust_ctl_wait_quiescent(int sock);
 146
 147 int lttng_ust_ctl_sock_flush_buffer(int sock, struct lttng_ust_abi_object_data *object);
 148
 149 int lttng_ust_ctl_calibrate(int sock, struct lttng_ust_abi_calibrate *calibrate);
 150
 151 /* Release object created by members of this API. */
 152 int lttng_ust_ctl_release_object(int sock, struct lttng_ust_abi_object_data *data);
 153 /* Release handle returned by create session. */
 154 int lttng_ust_ctl_release_handle(int sock, int handle);
 155
 156 int lttng_ust_ctl_recv_channel_from_consumer(int sock,
 157                 struct lttng_ust_abi_object_data **channel_data);
 158 int lttng_ust_ctl_recv_stream_from_consumer(int sock,
 159                 struct lttng_ust_abi_object_data **stream_data);
 160 int lttng_ust_ctl_send_channel_to_ust(int sock, int session_handle,
 161                 struct lttng_ust_abi_object_data *channel_data);
 162 int lttng_ust_ctl_send_stream_to_ust(int sock,
 163                 struct lttng_ust_abi_object_data *channel_data,
 164                 struct lttng_ust_abi_object_data *stream_data);
 165
 166 /*
 167  * lttng_ust_ctl_duplicate_ust_object_data allocated a new object in "dest" if
 168  * it succeeds (returns 0). It must be released using
 169  * lttng_ust_ctl_release_object() and then freed with free().
 170  */
 171 int lttng_ust_ctl_duplicate_ust_object_data(struct lttng_ust_abi_object_data **dest,
 172                 struct lttng_ust_abi_object_data *src);
 173
 174 /*
 175  * API used by consumer.
 176  */
 177
 178 struct lttng_ust_ctl_consumer_channel;
 179 struct lttng_ust_ctl_consumer_stream;
 180 struct lttng_ust_ctl_consumer_channel_attr;
 181
 182 int lttng_ust_ctl_get_nr_stream_per_channel(void);
 183
 184 struct lttng_ust_ctl_consumer_channel *
 185         lttng_ust_ctl_create_channel(struct lttng_ust_ctl_consumer_channel_attr *attr,
 186                 const int *stream_fds, int nr_stream_fds);
 187 /*
 188  * Each stream created needs to be destroyed before calling
 189  * lttng_ust_ctl_destroy_channel().
 190  */
 191 void lttng_ust_ctl_destroy_channel(struct lttng_ust_ctl_consumer_channel *chan);
 192
 193 int lttng_ust_ctl_send_channel_to_sessiond(int sock,
 194                 struct lttng_ust_ctl_consumer_channel *channel);
 195 int lttng_ust_ctl_channel_close_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 196 int lttng_ust_ctl_channel_close_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 197 int lttng_ust_ctl_channel_get_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 198 int lttng_ust_ctl_channel_get_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan);
 199
 200 int lttng_ust_ctl_write_metadata_to_channel(
 201                 struct lttng_ust_ctl_consumer_channel *channel,
 202                 const char *metadata_str,       /* NOT null-terminated */
 203                 size_t len);                    /* metadata length */
 204 ssize_t lttng_ust_ctl_write_one_packet_to_channel(
 205                 struct lttng_ust_ctl_consumer_channel *channel,
 206                 const char *metadata_str,       /* NOT null-terminated */
 207                 size_t len);                    /* metadata length */
 208
 209 /*
 210  * Send a NULL stream to finish iteration over all streams of a given
 211  * channel.
 212  */
 213 int lttng_ust_ctl_send_stream_to_sessiond(int sock,
 214                 struct lttng_ust_ctl_consumer_stream *stream);
 215 int lttng_ust_ctl_stream_close_wait_fd(struct lttng_ust_ctl_consumer_stream *stream);
 216 int lttng_ust_ctl_stream_close_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream);
 217 int lttng_ust_ctl_stream_get_wait_fd(struct lttng_ust_ctl_consumer_stream *stream);
 218 int lttng_ust_ctl_stream_get_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream);
 219
 220 /* Create/destroy stream buffers for read */
 221 struct lttng_ust_ctl_consumer_stream *
 222         lttng_ust_ctl_create_stream(struct lttng_ust_ctl_consumer_channel *channel,
 223                         int cpu);
 224 void lttng_ust_ctl_destroy_stream(struct lttng_ust_ctl_consumer_stream *stream);
 225
 226 /* For mmap mode, readable without "get" operation */
 227 int lttng_ust_ctl_get_mmap_len(struct lttng_ust_ctl_consumer_stream *stream,
 228                 unsigned long *len);
 229 int lttng_ust_ctl_get_max_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 230                 unsigned long *len);
 231
 232 /*
 233  * For mmap mode, operate on the current packet (between get/put or
 234  * get_next/put_next).
 235  */
 236 void *lttng_ust_ctl_get_mmap_base(struct lttng_ust_ctl_consumer_stream *stream);
 237 int lttng_ust_ctl_get_mmap_read_offset(struct lttng_ust_ctl_consumer_stream *stream,
 238                 unsigned long *off);
 239 int lttng_ust_ctl_get_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 240                 unsigned long *len);
 241 int lttng_ust_ctl_get_padded_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream,
 242                 unsigned long *len);
 243 int lttng_ust_ctl_get_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 244 int lttng_ust_ctl_put_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 245
 246 /* snapshot */
 247
 248 int lttng_ust_ctl_snapshot(struct lttng_ust_ctl_consumer_stream *stream);
 249 int lttng_ust_ctl_snapshot_sample_positions(struct lttng_ust_ctl_consumer_stream *stream);
 250 int lttng_ust_ctl_snapshot_get_consumed(struct lttng_ust_ctl_consumer_stream *stream,
 251                 unsigned long *pos);
 252 int lttng_ust_ctl_snapshot_get_produced(struct lttng_ust_ctl_consumer_stream *stream,
 253                 unsigned long *pos);
 254 int lttng_ust_ctl_get_subbuf(struct lttng_ust_ctl_consumer_stream *stream,
 255                 unsigned long *pos);
 256 int lttng_ust_ctl_put_subbuf(struct lttng_ust_ctl_consumer_stream *stream);
 257
 258 int lttng_ust_ctl_flush_buffer(struct lttng_ust_ctl_consumer_stream *stream,
 259                 int producer_active);
 260 int lttng_ust_ctl_clear_buffer(struct lttng_ust_ctl_consumer_stream *stream);
 261
 262 /* index */
 263
 264 /*
 265  * Getters which need to be used on the current packet (between get/put
 266  * or get_next/put_next.
 267  */
 268
 269 int lttng_ust_ctl_get_timestamp_begin(struct lttng_ust_ctl_consumer_stream *stream,
 270                 uint64_t *timestamp_begin);
 271 int lttng_ust_ctl_get_timestamp_end(struct lttng_ust_ctl_consumer_stream *stream,
 272         uint64_t *timestamp_end);
 273 int lttng_ust_ctl_get_events_discarded(struct lttng_ust_ctl_consumer_stream *stream,
 274         uint64_t *events_discarded);
 275 int lttng_ust_ctl_get_content_size(struct lttng_ust_ctl_consumer_stream *stream,
 276         uint64_t *content_size);
 277 int lttng_ust_ctl_get_packet_size(struct lttng_ust_ctl_consumer_stream *stream,
 278         uint64_t *packet_size);
 279 int lttng_ust_ctl_get_sequence_number(struct lttng_ust_ctl_consumer_stream *stream,
 280                 uint64_t *seq);
 281
 282 /*
 283  * Getter returning state invariant for the stream, which can be used
 284  * without "get" operation.
 285  */
 286
 287 int lttng_ust_ctl_get_stream_id(struct lttng_ust_ctl_consumer_stream *stream,
 288                 uint64_t *stream_id);
 289 int lttng_ust_ctl_get_instance_id(struct lttng_ust_ctl_consumer_stream *stream,
 290                 uint64_t *id);
 291
 292 /*
 293  * Getter returning the current timestamp as perceived from the
 294  * tracer.
 295  */
 296 int lttng_ust_ctl_get_current_timestamp(struct lttng_ust_ctl_consumer_stream *stream,
 297                 uint64_t *ts);
 298
 299 /* returns whether UST has perf counters support. */
 300 int lttng_ust_ctl_has_perf_counters(void);
 301
 302 /* Regenerate the statedump. */
 303 int lttng_ust_ctl_regenerate_statedump(int sock, int handle);
 304
 305 /* event registry management */
 306
 307 enum lttng_ust_ctl_socket_type {
 308         LTTNG_UST_CTL_SOCKET_CMD = 0,
 309         LTTNG_UST_CTL_SOCKET_NOTIFY = 1,
 310 };
 311
 312 enum lttng_ust_ctl_notify_cmd {
 313         LTTNG_UST_CTL_NOTIFY_CMD_EVENT = 0,
 314         LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL = 1,
 315         LTTNG_UST_CTL_NOTIFY_CMD_ENUM = 2,
 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 } LTTNG_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 } LTTNG_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 } LTTNG_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                 } LTTNG_PACKED extra;
 389                 char padding[LTTNG_UST_CTL_UST_ENUM_ENTRY_PADDING];
 390         } u;
 391 } LTTNG_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 } LTTNG_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 } LTTNG_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 } LTTNG_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 } LTTNG_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
 542 /*
 543  * Returns 0 on success, negative error value on error.
 544  */
 545 int lttng_ust_ctl_reply_register_event(int sock,
 546         uint32_t id,                    /* event id (input) */
 547         int ret_code);                  /* return code. 0 ok, negative error */
 548
 549 /*
 550  * Returns 0 on success, negative UST or system error value on error.
 551  */
 552 int lttng_ust_ctl_recv_register_enum(int sock,
 553         int *session_objd,
 554         char *enum_name,
 555         struct lttng_ust_ctl_enum_entry **entries,
 556         size_t *nr_entries);
 557
 558 /*
 559  * Returns 0 on success, negative error value on error.
 560  */
 561 int lttng_ust_ctl_reply_register_enum(int sock,
 562         uint64_t id,                    /* enum id (input) */
 563         int ret_code);
 564
 565 /*
 566  * Returns 0 on success, negative UST or system error value on error.
 567  */
 568 int lttng_ust_ctl_recv_register_channel(int sock,
 569         int *session_objd,              /* session descriptor (output) */
 570         int *channel_objd,              /* channel descriptor (output) */
 571         size_t *nr_fields,              /* context fields */
 572         struct lttng_ust_ctl_field **fields);
 573
 574 /*
 575  * Returns 0 on success, negative error value on error.
 576  */
 577 int lttng_ust_ctl_reply_register_channel(int sock,
 578         uint32_t chan_id,
 579         enum lttng_ust_ctl_channel_header header_type,
 580         int ret_code);                  /* return code. 0 ok, negative error */
 581
 582 /*
 583  * Counter API.
 584  */
 585
 586 enum lttng_ust_ctl_counter_bitness {
 587         LTTNG_UST_CTL_COUNTER_BITNESS_32 = 0,
 588         LTTNG_UST_CTL_COUNTER_BITNESS_64 = 1,
 589 };
 590
 591 enum lttng_ust_ctl_counter_arithmetic {
 592         LTTNG_UST_CTL_COUNTER_ARITHMETIC_MODULAR        = 0,
 593         LTTNG_UST_CTL_COUNTER_ARITHMETIC_SATURATION     = 1,
 594 };
 595
 596 /* Used as alloc flags. */
 597 enum lttng_ust_ctl_counter_alloc {
 598         LTTNG_UST_CTL_COUNTER_ALLOC_PER_CPU = (1 << 0),
 599         LTTNG_UST_CTL_COUNTER_ALLOC_GLOBAL = (1 << 1),
 600 };
 601
 602 struct lttng_ust_ctl_daemon_counter;
 603
 604 int lttng_ust_ctl_get_nr_cpu_per_counter(void);
 605
 606 struct lttng_ust_ctl_counter_dimension {
 607         uint64_t size;
 608         uint64_t underflow_index;
 609         uint64_t overflow_index;
 610         uint8_t has_underflow;
 611         uint8_t has_overflow;
 612 };
 613
 614 struct lttng_ust_ctl_daemon_counter *
 615         lttng_ust_ctl_create_counter(size_t nr_dimensions,
 616                 const struct lttng_ust_ctl_counter_dimension *dimensions,
 617                 int64_t global_sum_step,
 618                 int global_counter_fd,
 619                 int nr_counter_cpu_fds,
 620                 const int *counter_cpu_fds,
 621                 enum lttng_ust_ctl_counter_bitness bitness,
 622                 enum lttng_ust_ctl_counter_arithmetic arithmetic,
 623                 uint32_t alloc_flags,
 624                 bool coalesce_hits);
 625
 626 int lttng_ust_ctl_create_counter_data(struct lttng_ust_ctl_daemon_counter *counter,
 627                 struct lttng_ust_abi_object_data **counter_data);
 628
 629 int lttng_ust_ctl_create_counter_global_data(struct lttng_ust_ctl_daemon_counter *counter,
 630                 struct lttng_ust_abi_object_data **counter_global_data);
 631 int lttng_ust_ctl_create_counter_cpu_data(struct lttng_ust_ctl_daemon_counter *counter, int cpu,
 632                 struct lttng_ust_abi_object_data **counter_cpu_data);
 633
 634 /*
 635  * Each counter data and counter cpu data created need to be destroyed
 636  * before calling lttng_ust_ctl_destroy_counter().
 637  */
 638 void lttng_ust_ctl_destroy_counter(struct lttng_ust_ctl_daemon_counter *counter);
 639
 640 int lttng_ust_ctl_send_counter_data_to_ust(int sock, int parent_handle,
 641                 struct lttng_ust_abi_object_data *counter_data);
 642 int lttng_ust_ctl_send_counter_global_data_to_ust(int sock,
 643                 struct lttng_ust_abi_object_data *counter_data,
 644                 struct lttng_ust_abi_object_data *counter_global_data);
 645 int lttng_ust_ctl_send_counter_cpu_data_to_ust(int sock,
 646                 struct lttng_ust_abi_object_data *counter_data,
 647                 struct lttng_ust_abi_object_data *counter_cpu_data);
 648
 649 int lttng_ust_ctl_counter_read(struct lttng_ust_ctl_daemon_counter *counter,
 650                 const size_t *dimension_indexes,
 651                 int cpu, int64_t *value,
 652                 bool *overflow, bool *underflow);
 653 int lttng_ust_ctl_counter_aggregate(struct lttng_ust_ctl_daemon_counter *counter,
 654                 const size_t *dimension_indexes,
 655                 int64_t *value,
 656                 bool *overflow, bool *underflow);
 657 int lttng_ust_ctl_counter_clear(struct lttng_ust_ctl_daemon_counter *counter,
 658                 const size_t *dimension_indexes);
 659
 660 void lttng_ust_ctl_sigbus_handle(void *addr);
 661
 662 #ifdef __cplusplus
 663 }
 664 #endif
 665
 666 #endif /* LTTNG_UST_CTL_INTERNAL_H */