[lttng-ust.git] / libcounter / counter.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2020 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * LTTng Counters API
 */

#ifndef _LTTNG_COUNTER_H
#define _LTTNG_COUNTER_H

#include <stdint.h>
#include <lttng/ust-config.h>
#include "counter-types.h"

/* max_nr_elem is for each dimension. */
struct lib_counter *lttng_counter_create(const struct lib_counter_config *config,
					 size_t nr_dimensions,
					 const size_t *max_nr_elem,
					 int64_t global_sum_step,
					 int global_counter_fd,
					 int nr_counter_cpu_fds,
					 const int *counter_cpu_fds,
					 bool is_daemon)
	__attribute__((visibility("hidden")));

void lttng_counter_destroy(struct lib_counter *counter)
	__attribute__((visibility("hidden")));

int lttng_counter_set_global_shm(struct lib_counter *counter, int fd)
	__attribute__((visibility("hidden")));

int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd)
	__attribute__((visibility("hidden")));

int lttng_counter_get_global_shm(struct lib_counter *counter, int *fd, size_t *len)
	__attribute__((visibility("hidden")));

int lttng_counter_get_cpu_shm(struct lib_counter *counter, int cpu, int *fd, size_t *len)
	__attribute__((visibility("hidden")));

int lttng_counter_read(const struct lib_counter_config *config,
		       struct lib_counter *counter,
		       const size_t *dimension_indexes,
		       int cpu, int64_t *value,
		       bool *overflow, bool *underflow)
	__attribute__((visibility("hidden")));

int lttng_counter_aggregate(const struct lib_counter_config *config,
			    struct lib_counter *counter,
			    const size_t *dimension_indexes,
			    int64_t *value,
			    bool *overflow, bool *underflow)
	__attribute__((visibility("hidden")));

int lttng_counter_clear(const struct lib_counter_config *config,
			struct lib_counter *counter,
			const size_t *dimension_indexes)
	__attribute__((visibility("hidden")));

#endif /* _LTTNG_COUNTER_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright (C) 2020 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	*
	6	* LTTng Counters API
	7	*/
	8
	9	#ifndef _LTTNG_COUNTER_H
	10	#define _LTTNG_COUNTER_H
	11
	12	#include <stdint.h>
	13	#include <lttng/ust-config.h>
	14	#include "counter-types.h"
	15
	16	/* max_nr_elem is for each dimension. */
	17	struct lib_counter lttng_counter_create(const struct lib_counter_config config,
	18	size_t nr_dimensions,
	19	const size_t *max_nr_elem,
	20	int64_t global_sum_step,
	21	int global_counter_fd,
	22	int nr_counter_cpu_fds,
	23	const int *counter_cpu_fds,
	24	bool is_daemon)
	25	__attribute__((visibility("hidden")));
	26
	27	void lttng_counter_destroy(struct lib_counter *counter)
	28	__attribute__((visibility("hidden")));
	29
	30	int lttng_counter_set_global_shm(struct lib_counter *counter, int fd)
	31	__attribute__((visibility("hidden")));
	32
	33	int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd)
	34	__attribute__((visibility("hidden")));
	35
	36	int lttng_counter_get_global_shm(struct lib_counter counter, int fd, size_t *len)
	37	__attribute__((visibility("hidden")));
	38
	39	int lttng_counter_get_cpu_shm(struct lib_counter counter, int cpu, int fd, size_t *len)
	40	__attribute__((visibility("hidden")));
	41
	42	int lttng_counter_read(const struct lib_counter_config *config,
	43	struct lib_counter *counter,
	44	const size_t *dimension_indexes,
	45	int cpu, int64_t *value,
	46	bool overflow, bool underflow)
	47	__attribute__((visibility("hidden")));
	48
	49	int lttng_counter_aggregate(const struct lib_counter_config *config,
	50	struct lib_counter *counter,
	51	const size_t *dimension_indexes,
	52	int64_t *value,
	53	bool overflow, bool underflow)
	54	__attribute__((visibility("hidden")));
	55
	56	int lttng_counter_clear(const struct lib_counter_config *config,
	57	struct lib_counter *counter,
	58	const size_t *dimension_indexes)
	59	__attribute__((visibility("hidden")));
	60
	61	#endif /* _LTTNG_COUNTER_H */