[lttng-tools.git] / src / common / trace-chunk-registry.h

/*
 * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, version 2.1 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef LTTNG_TRACE_CHUNK_REGISTRY_H
#define LTTNG_TRACE_CHUNK_REGISTRY_H

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <common/macros.h>
#include <common/trace-chunk.h>

struct lttng_trace_chunk_registry;

/*
 * Create an lttng_trace_chunk registry.
 *
 * A trace chunk registry maintains an association between a
 * (session_id, chunk_id) tuple and a trace chunk object. The chunk_id can
 * be "unset" in the case of an anonymous trace chunk.
 *
 * Note that a trace chunk registry holds no ownership of its trace
 * chunks. Trace chunks are unpublished when their last reference is released.
 * See the documentation of lttng_trace_chunk.
 *
 * Returns a trace chunk registry on success, NULL on error.
 *
 * Note that a trace chunk registry may only be accessed by an RCU thread.
 */
LTTNG_HIDDEN
struct lttng_trace_chunk_registry *lttng_trace_chunk_registry_create(void);

/*
 * Destroy an lttng trace chunk registry. The registry must be emptied
 * (i.e. all references to the trace chunks it contains must be released) before
 * it is destroyed.
 */
LTTNG_HIDDEN
void lttng_trace_chunk_registry_destroy(
		struct lttng_trace_chunk_registry *registry);

/*
 * Publish a trace chunk for a given session id.
 * A reference is acquired on behalf of the caller.
 *
 * The trace chunk that is returned is the published version of the trace
 * chunk. The chunk provided should be discarded on success and it's
 * published version used in its place.
 *
 * See the documentation of lttng_trace_chunk for more information on
 * the usage of the various parameters.
 *
 * Returns an lttng_trace_chunk on success, NULL on error.
 */
LTTNG_HIDDEN
struct lttng_trace_chunk *lttng_trace_chunk_registry_publish_chunk(
		struct lttng_trace_chunk_registry *registry,
		uint64_t session_id, struct lttng_trace_chunk *chunk);

/*
 * Look-up a trace chunk by session_id and chunk_id.
 * A reference is acquired on behalf of the caller.
 *
 * Returns an lttng_trace_chunk on success, NULL if the chunk does not exist.
 */
LTTNG_HIDDEN
struct lttng_trace_chunk *
lttng_trace_chunk_registry_find_chunk(
		const struct lttng_trace_chunk_registry *registry,
		uint64_t session_id, uint64_t chunk_id);

/*
 * Query the existence of a trace chunk by session_id and chunk_id.
 *
 * Returns 0 on success, a negative value on error.
 */
LTTNG_HIDDEN
int lttng_trace_chunk_registry_chunk_exists(
		const struct lttng_trace_chunk_registry *registry,
		uint64_t session_id, uint64_t chunk_id, bool *chunk_exists);

/*
 * Look-up an anonymous trace chunk by session_id.
 * A reference is acquired on behalf of the caller.
 *
 * Returns an lttng_trace_chunk on success, NULL if the chunk does not exist.
 */
LTTNG_HIDDEN
struct lttng_trace_chunk *
lttng_trace_chunk_registry_find_anonymous_chunk(
		const struct lttng_trace_chunk_registry *registry,
		uint64_t session_id);

LTTNG_HIDDEN
unsigned int lttng_trace_chunk_registry_put_each_chunk(
		const struct lttng_trace_chunk_registry *registry);

#endif /* LTTNG_TRACE_CHUNK_REGISTRY_H */
Commit	Line	Data
2c5ff4e4 JG	1	/*
	2	* Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU Lesser General Public License, version 2.1 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
	11	* for more details.
	12	*
	13	* You should have received a copy of the GNU Lesser General Public License
	14	* along with this program; if not, write to the Free Software Foundation,
	15	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16	*/
	17
	18	#ifndef LTTNG_TRACE_CHUNK_REGISTRY_H
	19	#define LTTNG_TRACE_CHUNK_REGISTRY_H
	20
	21	#include <stddef.h>
	22	#include <stdint.h>
	23	#include <stdbool.h>
	24	#include <common/macros.h>
	25	#include <common/trace-chunk.h>
	26
	27	struct lttng_trace_chunk_registry;
	28
	29	/*
	30	* Create an lttng_trace_chunk registry.
	31	*
	32	* A trace chunk registry maintains an association between a
	33	* (session_id, chunk_id) tuple and a trace chunk object. The chunk_id can
	34	* be "unset" in the case of an anonymous trace chunk.
	35	*
	36	* Note that a trace chunk registry holds no ownership of its trace
	37	* chunks. Trace chunks are unpublished when their last reference is released.
	38	* See the documentation of lttng_trace_chunk.
	39	*
	40	* Returns a trace chunk registry on success, NULL on error.
	41	*
	42	* Note that a trace chunk registry may only be accessed by an RCU thread.
	43	*/
	44	LTTNG_HIDDEN
	45	struct lttng_trace_chunk_registry *lttng_trace_chunk_registry_create(void);
	46
	47	/*
	48	* Destroy an lttng trace chunk registry. The registry must be emptied
	49	* (i.e. all references to the trace chunks it contains must be released) before
	50	* it is destroyed.
	51	*/
	52	LTTNG_HIDDEN
	53	void lttng_trace_chunk_registry_destroy(
	54	struct lttng_trace_chunk_registry *registry);
	55
	56	/*
	57	* Publish a trace chunk for a given session id.
	58	* A reference is acquired on behalf of the caller.
	59	*
	60	* The trace chunk that is returned is the published version of the trace
	61	* chunk. The chunk provided should be discarded on success and it's
	62	* published version used in its place.
	63	*
	64	* See the documentation of lttng_trace_chunk for more information on
65	* the usage of the various parameters.
66	*
67	* Returns an lttng_trace_chunk on success, NULL on error.
68	*/
69	LTTNG_HIDDEN
70	struct lttng_trace_chunk *lttng_trace_chunk_registry_publish_chunk(
71	struct lttng_trace_chunk_registry *registry,
72	uint64_t session_id, struct lttng_trace_chunk *chunk);
73
74	/*
75	* Look-up a trace chunk by session_id and chunk_id.
76	* A reference is acquired on behalf of the caller.
77	*
78	* Returns an lttng_trace_chunk on success, NULL if the chunk does not exist.
79	*/
80	LTTNG_HIDDEN
81	struct lttng_trace_chunk *
82	lttng_trace_chunk_registry_find_chunk(
83	const struct lttng_trace_chunk_registry *registry,
84	uint64_t session_id, uint64_t chunk_id);
85
6b584c2e JG	86	/*
	87	* Query the existence of a trace chunk by session_id and chunk_id.
	88	*
	89	* Returns 0 on success, a negative value on error.
	90	*/
	91	LTTNG_HIDDEN
	92	int lttng_trace_chunk_registry_chunk_exists(
	93	const struct lttng_trace_chunk_registry *registry,
	94	uint64_t session_id, uint64_t chunk_id, bool *chunk_exists);
	95
2c5ff4e4 JG	96	/*
	97	* Look-up an anonymous trace chunk by session_id.
	98	* A reference is acquired on behalf of the caller.
	99	*
	100	* Returns an lttng_trace_chunk on success, NULL if the chunk does not exist.
	101	*/
	102	LTTNG_HIDDEN
	103	struct lttng_trace_chunk *
	104	lttng_trace_chunk_registry_find_anonymous_chunk(
	105	const struct lttng_trace_chunk_registry *registry,
	106	uint64_t session_id);
	107
e10aec8f MD	108	LTTNG_HIDDEN
e10aec8f MD	109	unsigned int lttng_trace_chunk_registry_put_each_chunk(
8ced4811	110	const struct lttng_trace_chunk_registry *registry);
e10aec8f	111
2c5ff4e4	112	#endif /* LTTNG_TRACE_CHUNK_REGISTRY_H */