[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"
#include "helper.h"

/* max_nr_elem is for each dimension. */
LTTNG_HIDDEN
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);
LTTNG_HIDDEN
void lttng_counter_destroy(struct lib_counter *counter);

LTTNG_HIDDEN
int lttng_counter_set_global_shm(struct lib_counter *counter, int fd);
LTTNG_HIDDEN
int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd);

LTTNG_HIDDEN
int lttng_counter_get_global_shm(struct lib_counter *counter, int *fd, size_t *len);
LTTNG_HIDDEN
int lttng_counter_get_cpu_shm(struct lib_counter *counter, int cpu, int *fd, size_t *len);

LTTNG_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);
LTTNG_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);
LTTNG_HIDDEN
int lttng_counter_clear(const struct lib_counter_config *config,
			struct lib_counter *counter,
			const size_t *dimension_indexes);

#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	#include "helper.h"
	16
	17	/* max_nr_elem is for each dimension. */
	18	LTTNG_HIDDEN
	19	struct lib_counter lttng_counter_create(const struct lib_counter_config config,
	20	size_t nr_dimensions,
	21	const size_t *max_nr_elem,
	22	int64_t global_sum_step,
	23	int global_counter_fd,
	24	int nr_counter_cpu_fds,
	25	const int *counter_cpu_fds,
	26	bool is_daemon);
	27	LTTNG_HIDDEN
	28	void lttng_counter_destroy(struct lib_counter *counter);
	29
	30	LTTNG_HIDDEN
	31	int lttng_counter_set_global_shm(struct lib_counter *counter, int fd);
	32	LTTNG_HIDDEN
	33	int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd);
	34
	35	LTTNG_HIDDEN
	36	int lttng_counter_get_global_shm(struct lib_counter counter, int fd, size_t *len);
	37	LTTNG_HIDDEN
	38	int lttng_counter_get_cpu_shm(struct lib_counter counter, int cpu, int fd, size_t *len);
	39
	40	LTTNG_HIDDEN
	41	int lttng_counter_read(const struct lib_counter_config *config,
	42	struct lib_counter *counter,
	43	const size_t *dimension_indexes,
	44	int cpu, int64_t *value,
	45	bool overflow, bool underflow);
	46	LTTNG_HIDDEN
	47	int lttng_counter_aggregate(const struct lib_counter_config *config,
	48	struct lib_counter *counter,
	49	const size_t *dimension_indexes,
	50	int64_t *value,
	51	bool overflow, bool underflow);
	52	LTTNG_HIDDEN
	53	int lttng_counter_clear(const struct lib_counter_config *config,
	54	struct lib_counter *counter,
	55	const size_t *dimension_indexes);
	56
	57	#endif /* _LTTNG_COUNTER_H */