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

/*
 * lttng/counter.h
 *
 * LTTng Counters API
 *
 * Copyright (C) 2020 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#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
ebabbf58 MD	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"
3d5db36a	33	#include "helper.h"
ebabbf58 MD	34
ebabbf58 MD	35	/* max_nr_elem is for each dimension. */
3d5db36a	36	LTTNG_HIDDEN
ebabbf58 MD	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);
3d5db36a	45	LTTNG_HIDDEN
ebabbf58 MD	46	void lttng_counter_destroy(struct lib_counter *counter);
ebabbf58 MD	47
3d5db36a	48	LTTNG_HIDDEN
ebabbf58	49	int lttng_counter_set_global_shm(struct lib_counter *counter, int fd);
3d5db36a	50	LTTNG_HIDDEN
ebabbf58 MD	51	int lttng_counter_set_cpu_shm(struct lib_counter *counter, int cpu, int fd);
ebabbf58 MD	52
3d5db36a	53	LTTNG_HIDDEN
ebabbf58	54	int lttng_counter_get_global_shm(struct lib_counter counter, int fd, size_t *len);
3d5db36a	55	LTTNG_HIDDEN
ebabbf58 MD	56	int lttng_counter_get_cpu_shm(struct lib_counter counter, int cpu, int fd, size_t *len);
ebabbf58 MD	57
3d5db36a	58	LTTNG_HIDDEN
ebabbf58 MD	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);
3d5db36a	64	LTTNG_HIDDEN
ebabbf58 MD	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);
3d5db36a	70	LTTNG_HIDDEN
ebabbf58 MD	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 */