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

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