[lttng-tools.git] / src / bin / lttng-sessiond / buffer-registry.hpp

/*
 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef LTTNG_BUFFER_REGISTRY_H
#define LTTNG_BUFFER_REGISTRY_H

#include <stdint.h>
#include <urcu/list.h>

#include <lttng/lttng.h>
#include <common/hashtable/hashtable.hpp>

#include "consumer.hpp"
#include "lttng-ust-ctl.hpp"
#include "ust-registry.hpp"
#include "ust-registry-session.hpp"

struct buffer_reg_stream {
	struct cds_list_head lnode;
	union {
		/* Original object data that MUST be copied over. */
		struct lttng_ust_abi_object_data *ust;
	} obj;
};

struct buffer_reg_channel {
	/* This key is the same as a tracing channel key. */
	uint32_t key;
	/* Key of the channel on the consumer side. */
	uint64_t consumer_key;
	/* Stream registry object of this channel registry. */
	struct cds_list_head streams;
	/* Total number of stream in the list. */
	uint64_t stream_count;
	/* Used to ensure mutual exclusion to the stream's list. */
	pthread_mutex_t stream_list_lock;
	/* Node for hash table usage. */
	struct lttng_ht_node_u64 node;
	/* Size of subbuffers in this channel. */
	size_t subbuf_size;
	/* Number of subbuffers per stream. */
	size_t num_subbuf;
	union {
		/* Original object data that MUST be copied over. */
		struct lttng_ust_abi_object_data *ust;
	} obj;
};

struct buffer_reg_session {
	/* Registry per domain. */
	union {
		lttng::sessiond::ust::registry_session *ust;
	} reg;

	/* Contains buffer registry channel indexed by tracing channel key. */
	struct lttng_ht *channels;
};

/*
 * Registry object for per UID buffers.
 */
struct buffer_reg_uid {
	/*
	 * Keys to match this object in a hash table. The following three variables
	 * identify a unique per UID buffer registry.
	 */
	uint64_t session_id;	/* Unique tracing session id. */
	int bits_per_long;	/* ABI */
	uid_t uid;			/* Owner. */

	enum lttng_domain_type domain;
	struct buffer_reg_session *registry;

	/* Indexed by session id. */
	struct lttng_ht_node_u64 node;
	/* Node of a linked list used to teardown object at a destroy session. */
	struct cds_list_head lnode;

	char root_shm_path[PATH_MAX];
	char shm_path[PATH_MAX];
};

/*
 * Registry object for per PID buffers.
 */
struct buffer_reg_pid {
	uint64_t session_id;

	struct buffer_reg_session *registry;

	/* Indexed by session id. */
	struct lttng_ht_node_u64 node;

	char root_shm_path[PATH_MAX];
	char shm_path[PATH_MAX];
};

/* Buffer registry per UID. */
void buffer_reg_init_uid_registry(void);
int buffer_reg_uid_create(uint64_t session_id, uint32_t bits_per_long, uid_t uid,
		enum lttng_domain_type domain, struct buffer_reg_uid **regp,
		const char *root_shm_path, const char *shm_path);
void buffer_reg_uid_add(struct buffer_reg_uid *reg);
struct buffer_reg_uid *buffer_reg_uid_find(uint64_t session_id,
		uint32_t bits_per_long, uid_t uid);
void buffer_reg_uid_remove(struct buffer_reg_uid *regp);
void buffer_reg_uid_destroy(struct buffer_reg_uid *regp,
		struct consumer_output *consumer);

/* Buffer registry per PID. */
void buffer_reg_init_pid_registry(void);
int buffer_reg_pid_create(uint64_t session_id, struct buffer_reg_pid **regp,
		const char *root_shm_path, const char *shm_path);
void buffer_reg_pid_add(struct buffer_reg_pid *reg);
struct buffer_reg_pid *buffer_reg_pid_find(uint64_t session_id);
void buffer_reg_pid_remove(struct buffer_reg_pid *regp);
void buffer_reg_pid_destroy(struct buffer_reg_pid *regp);

/* Channel */
int buffer_reg_channel_create(uint64_t key, struct buffer_reg_channel **regp);
void buffer_reg_channel_add(struct buffer_reg_session *session,
		struct buffer_reg_channel *channel);
struct buffer_reg_channel *buffer_reg_channel_find(uint64_t key,
		struct buffer_reg_uid *reg);
void buffer_reg_channel_remove(struct buffer_reg_session *session,
		struct buffer_reg_channel *regp);
void buffer_reg_channel_destroy(struct buffer_reg_channel *regp,
		enum lttng_domain_type domain);

/* Stream */
int buffer_reg_stream_create(struct buffer_reg_stream **regp);
void buffer_reg_stream_add(struct buffer_reg_stream *stream,
		struct buffer_reg_channel *channel);
void buffer_reg_stream_destroy(struct buffer_reg_stream *regp,
		enum lttng_domain_type domain);

/* Global registry. */
void buffer_reg_destroy_registries(void);

int buffer_reg_uid_consumer_channel_key(
		struct cds_list_head *buffer_reg_uid_list,
		uint64_t chan_key, uint64_t *consumer_chan_key);

#endif /* LTTNG_BUFFER_REGISTRY_H */
Commit	Line	Data
7972aab2	1	/*
ab5be9fa	2	* Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
7972aab2	3	*
ab5be9fa	4	* SPDX-License-Identifier: GPL-2.0-only
7972aab2	5	*
7972aab2 DG	6	*/
	7
	8	#ifndef LTTNG_BUFFER_REGISTRY_H
	9	#define LTTNG_BUFFER_REGISTRY_H
	10
	11	#include <stdint.h>
7972aab2 DG	12	#include <urcu/list.h>
	13
	14	#include <lttng/lttng.h>
c9e313bc	15	#include <common/hashtable/hashtable.hpp>
7972aab2	16
c9e313bc SM	17	#include "consumer.hpp"
	18	#include "lttng-ust-ctl.hpp"
	19	#include "ust-registry.hpp"
b0f2e8db	20	#include "ust-registry-session.hpp"
7972aab2 DG	21
	22	struct buffer_reg_stream {
	23	struct cds_list_head lnode;
	24	union {
	25	/* Original object data that MUST be copied over. */
fc4b93fa	26	struct lttng_ust_abi_object_data *ust;
7972aab2 DG	27	} obj;
	28	};
	29
	30	struct buffer_reg_channel {
	31	/* This key is the same as a tracing channel key. */
	32	uint32_t key;
	33	/* Key of the channel on the consumer side. */
	34	uint64_t consumer_key;
	35	/* Stream registry object of this channel registry. */
	36	struct cds_list_head streams;
5c786ded JD	37	/* Total number of stream in the list. */
5c786ded JD	38	uint64_t stream_count;
7972aab2 DG	39	/* Used to ensure mutual exclusion to the stream's list. */
	40	pthread_mutex_t stream_list_lock;
	41	/* Node for hash table usage. */
	42	struct lttng_ht_node_u64 node;
8c924c7b MD	43	/* Size of subbuffers in this channel. */
8c924c7b MD	44	size_t subbuf_size;
d07ceecd MD	45	/* Number of subbuffers per stream. */
d07ceecd MD	46	size_t num_subbuf;
7972aab2 DG	47	union {
7972aab2 DG	48	/* Original object data that MUST be copied over. */
fc4b93fa	49	struct lttng_ust_abi_object_data *ust;
7972aab2 DG	50	} obj;
	51	};
	52
	53	struct buffer_reg_session {
	54	/* Registry per domain. */
	55	union {
b0f2e8db	56	lttng::sessiond::ust::registry_session *ust;
7972aab2 DG	57	} reg;
	58
	59	/* Contains buffer registry channel indexed by tracing channel key. */
	60	struct lttng_ht *channels;
	61	};
	62
	63	/*
	64	* Registry object for per UID buffers.
	65	*/
	66	struct buffer_reg_uid {
	67	/*
	68	* Keys to match this object in a hash table. The following three variables
	69	* identify a unique per UID buffer registry.
	70	*/
d9bf3ca4	71	uint64_t session_id; /* Unique tracing session id. */
7972aab2 DG	72	int bits_per_long; /* ABI */
	73	uid_t uid; /* Owner. */
	74
	75	enum lttng_domain_type domain;
	76	struct buffer_reg_session *registry;
	77
	78	/* Indexed by session id. */
	79	struct lttng_ht_node_u64 node;
	80	/* Node of a linked list used to teardown object at a destroy session. */
	81	struct cds_list_head lnode;
d7ba1388	82
3d071855	83	char root_shm_path[PATH_MAX];
d7ba1388	84	char shm_path[PATH_MAX];
7972aab2 DG	85	};
	86
	87	/*
	88	* Registry object for per PID buffers.
	89	*/
	90	struct buffer_reg_pid {
d9bf3ca4	91	uint64_t session_id;
7972aab2 DG	92
	93	struct buffer_reg_session *registry;
	94
	95	/* Indexed by session id. */
d9bf3ca4	96	struct lttng_ht_node_u64 node;
d7ba1388	97
3d071855	98	char root_shm_path[PATH_MAX];
d7ba1388	99	char shm_path[PATH_MAX];
7972aab2 DG	100	};
	101
	102	/* Buffer registry per UID. */
	103	void buffer_reg_init_uid_registry(void);
d9bf3ca4	104	int buffer_reg_uid_create(uint64_t session_id, uint32_t bits_per_long, uid_t uid,
d7ba1388	105	enum lttng_domain_type domain, struct buffer_reg_uid **regp,
3d071855	106	const char root_shm_path, const char shm_path);
7972aab2	107	void buffer_reg_uid_add(struct buffer_reg_uid *reg);
d9bf3ca4	108	struct buffer_reg_uid *buffer_reg_uid_find(uint64_t session_id,
7972aab2 DG	109	uint32_t bits_per_long, uid_t uid);
	110	void buffer_reg_uid_remove(struct buffer_reg_uid *regp);
	111	void buffer_reg_uid_destroy(struct buffer_reg_uid *regp,
	112	struct consumer_output *consumer);
	113
	114	/* Buffer registry per PID. */
	115	void buffer_reg_init_pid_registry(void);
d7ba1388	116	int buffer_reg_pid_create(uint64_t session_id, struct buffer_reg_pid **regp,
3d071855	117	const char root_shm_path, const char shm_path);
7972aab2	118	void buffer_reg_pid_add(struct buffer_reg_pid *reg);
d9bf3ca4	119	struct buffer_reg_pid *buffer_reg_pid_find(uint64_t session_id);
7972aab2 DG	120	void buffer_reg_pid_remove(struct buffer_reg_pid *regp);
	121	void buffer_reg_pid_destroy(struct buffer_reg_pid *regp);
	122
	123	/* Channel */
	124	int buffer_reg_channel_create(uint64_t key, struct buffer_reg_channel **regp);
	125	void buffer_reg_channel_add(struct buffer_reg_session *session,
	126	struct buffer_reg_channel *channel);
	127	struct buffer_reg_channel *buffer_reg_channel_find(uint64_t key,
	128	struct buffer_reg_uid *reg);
	129	void buffer_reg_channel_remove(struct buffer_reg_session *session,
	130	struct buffer_reg_channel *regp);
	131	void buffer_reg_channel_destroy(struct buffer_reg_channel *regp,
	132	enum lttng_domain_type domain);
	133
	134	/* Stream */
	135	int buffer_reg_stream_create(struct buffer_reg_stream **regp);
	136	void buffer_reg_stream_add(struct buffer_reg_stream *stream,
	137	struct buffer_reg_channel *channel);
	138	void buffer_reg_stream_destroy(struct buffer_reg_stream *regp,
	139	enum lttng_domain_type domain);
	140
7972aab2 DG	141	/* Global registry. */
	142	void buffer_reg_destroy_registries(void);
	143
fb83fe64 JD	144	int buffer_reg_uid_consumer_channel_key(
fb83fe64 JD	145	struct cds_list_head *buffer_reg_uid_list,
76604852	146	uint64_t chan_key, uint64_t *consumer_chan_key);
fb83fe64	147
7972aab2	148	#endif /* LTTNG_BUFFER_REGISTRY_H */