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

/*
 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU 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_BUFFER_REGISTRY_H
#define LTTNG_BUFFER_REGISTRY_H

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

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

#include "consumer.h"
#include "ust-ctl.h"
#include "ust-registry.h"

struct buffer_reg_stream {
	struct cds_list_head lnode;
	union {
		/* Original object data that MUST be copied over. */
		struct lttng_ust_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_object_data *ust;
	} obj;
};

struct buffer_reg_session {
	/* Registry per domain. */
	union {
		struct 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 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 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 *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 *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);

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