include/lttng/ust-ctl.h

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