libcounter/counter.h

   1 /*
   2  * lttng/counter.h
   3  *
   4  * LTTng Counters API
   5  *
   6  * Copyright (C) 2020 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #ifndef _LTTNG_COUNTER_H
  28 #define _LTTNG_COUNTER_H
  29
  30 #include <stdint.h>
  31 #include <lttng/ust-config.h>
  32 #include "counter-types.h"
  33 #include "helper.h"
  34
  35 /* max_nr_elem is for each dimension. */
  36 LTTNG_HIDDEN
  37 struct lib_counter *lttng_counter_create(const struct lib_counter_config *config,
  38                                          size_t nr_dimensions,
  39                                          const size_t *max_nr_elem,
  40                                          int64_t global_sum_step,
  41                                          int global_counter_fd,
  42                                          int nr_counter_cpu_fds,
  43                                          const int *counter_cpu_fds,
  44                                          bool is_daemon);
  45 LTTNG_HIDDEN
  46 void lttng_counter_destroy(struct lib_counter *counter);
  47
  48 LTTNG_HIDDEN
  49 int lttng_counter_set_global_shm(struct lib_counter *counter, int fd);
  50 LTTNG_HIDDEN
  51 int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd);
  52
  53 LTTNG_HIDDEN
  54 int lttng_counter_get_global_shm(struct lib_counter *counter, int *fd, size_t *len);
  55 LTTNG_HIDDEN
  56 int lttng_counter_get_cpu_shm(struct lib_counter *counter, int cpu, int *fd, size_t *len);
  57
  58 LTTNG_HIDDEN
  59 int lttng_counter_read(const struct lib_counter_config *config,
  60                        struct lib_counter *counter,
  61                        const size_t *dimension_indexes,
  62                        int cpu, int64_t *value,
  63                        bool *overflow, bool *underflow);
  64 LTTNG_HIDDEN
  65 int lttng_counter_aggregate(const struct lib_counter_config *config,
  66                             struct lib_counter *counter,
  67                             const size_t *dimension_indexes,
  68                             int64_t *value,
  69                             bool *overflow, bool *underflow);
  70 LTTNG_HIDDEN
  71 int lttng_counter_clear(const struct lib_counter_config *config,
  72                         struct lib_counter *counter,
  73                         const size_t *dimension_indexes);
  74
  75 #endif /* _LTTNG_COUNTER_H */