[lttng-tools.git] / src / bin / lttng-sessiond / ust-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_UST_REGISTRY_H
#define LTTNG_UST_REGISTRY_H

#include <pthread.h>
#include <stdint.h>

#include <common/hashtable/hashtable.h>
#include <common/compat/uuid.h>

#include "ust-ctl.h"

#define CTF_SPEC_MAJOR	1
#define CTF_SPEC_MINOR	8

struct ust_app;

struct ust_registry_session {
	/*
	 * With multiple writers and readers, use this lock to access
	 * the registry. Can nest within the ust app session lock.
	 * Also acts as a registry serialization lock. Used by registry
	 * readers to serialize the registry information sent from the
	 * sessiond to the consumerd.
	 * The consumer socket lock nests within this lock.
	 */
	pthread_mutex_t lock;
	/* Next channel ID available for a newly registered channel. */
	uint32_t next_channel_id;
	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	uint32_t used_channel_id;
	/* Universal unique identifier used by the tracer. */
	unsigned char uuid[UUID_LEN];

	/* session ABI description */

	/* Size of long, in bits */
	unsigned int bits_per_long;
	/* Alignment, in bits */
	unsigned int uint8_t_alignment,
		uint16_t_alignment,
		uint32_t_alignment,
		uint64_t_alignment,
		long_alignment;
	/* endianness */
	int byte_order;	/* BIG_ENDIAN or LITTLE_ENDIAN */

	/* Generated metadata. */
	char *metadata;		/* NOT null-terminated ! Use memcpy. */
	size_t metadata_len, metadata_alloc_len;
	/* Length of bytes sent to the consumer. */
	size_t metadata_len_sent;

	char root_shm_path[PATH_MAX];
	char shm_path[PATH_MAX];
	char metadata_path[PATH_MAX];
	int metadata_fd;	/* file-backed metadata FD */

	/*
	 * Hash table containing channels sent by the UST tracer. MUST
	 * be accessed with a RCU read side lock acquired.
	 */
	struct lttng_ht *channels;
	/*
	 * Unique key to identify the metadata on the consumer side.
	 */
	uint64_t metadata_key;
	/*
	 * Indicates if the metadata is closed on the consumer side. This is to
	 * avoid double close of metadata when an application unregisters AND
	 * deletes its sessions.
	 */
	unsigned int metadata_closed;

	/* User and group owning the session. */
	uid_t uid;
	gid_t gid;
};

struct ust_registry_channel {
	uint64_t key;
	/* Id set when replying to a register channel. */
	uint32_t chan_id;
	enum ustctl_channel_header header_type;

	/*
	 * Flag for this channel if the metadata was dumped once during
	 * registration. 0 means no, 1 yes.
	 */
	unsigned int metadata_dumped;
	/* Indicates if this channel registry has already been registered. */
	unsigned int register_done;

	/*
	 * Hash table containing events sent by the UST tracer. MUST be accessed
	 * with a RCU read side lock acquired.
	 */
	struct lttng_ht *ht;
	/* Next event ID available for a newly registered event. */
	uint32_t next_event_id;
	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	uint32_t used_event_id;
	/*
	 * Context fields of the registry. Context are per channel. Allocated by a
	 * register channel notification from the UST tracer.
	 */
	size_t nr_ctx_fields;
	struct ustctl_field *ctx_fields;
	struct lttng_ht_node_u64 node;
	/* For delayed reclaim */
	struct rcu_head rcu_head;
};

/*
 * Event registered from a UST tracer sent to the session daemon. This is
 * indexed and matched by <event_name/signature>.
 */
struct ust_registry_event {
	int id;
	/* Both objd are set by the tracer. */
	int session_objd;
	int channel_objd;
	/* Name of the event returned by the tracer. */
	char name[LTTNG_UST_SYM_NAME_LEN];
	char *signature;
	int loglevel_value;
	size_t nr_fields;
	struct ustctl_field *fields;
	char *model_emf_uri;
	/*
	 * Flag for this channel if the metadata was dumped once during
	 * registration. 0 means no, 1 yes.
	 */
	unsigned int metadata_dumped;
	/*
	 * Node in the ust-registry hash table. The event name is used to
	 * initialize the node and the event_name/signature for the match function.
	 */
	struct lttng_ht_node_u64 node;
};

/*
 * Validate that the id has reached the maximum allowed or not.
 *
 * Return 0 if NOT else 1.
 */
static inline int ust_registry_is_max_id(uint32_t id)
{
	return (id == UINT32_MAX) ? 1 : 0;
}

/*
 * Return next available event id and increment the used counter. The
 * ust_registry_is_max_id function MUST be called before in order to validate
 * if the maximum number of IDs have been reached. If not, it is safe to call
 * this function.
 *
 * Return a unique channel ID. If max is reached, the used_event_id counter is
 * returned.
 */
static inline uint32_t ust_registry_get_next_event_id(
		struct ust_registry_channel *r)
{
	if (ust_registry_is_max_id(r->used_event_id)) {
		return r->used_event_id;
	}

	r->used_event_id++;
	return r->next_event_id++;
}

/*
 * Return next available channel id and increment the used counter. The
 * ust_registry_is_max_id function MUST be called before in order to validate
 * if the maximum number of IDs have been reached. If not, it is safe to call
 * this function.
 *
 * Return a unique channel ID. If max is reached, the used_channel_id counter
 * is returned.
 */
static inline uint32_t ust_registry_get_next_chan_id(
		struct ust_registry_session *r)
{
	if (ust_registry_is_max_id(r->used_channel_id)) {
		return r->used_channel_id;
	}

	r->used_channel_id++;
	return r->next_channel_id++;
}

/*
 * Return registry event count. This is read atomically.
 */
static inline uint32_t ust_registry_get_event_count(
		struct ust_registry_channel *r)
{
	return (uint32_t) uatomic_read(&r->used_event_id);
}

#ifdef HAVE_LIBLTTNG_UST_CTL

void ust_registry_channel_destroy(struct ust_registry_session *session,
		struct ust_registry_channel *chan);
struct ust_registry_channel *ust_registry_channel_find(
		struct ust_registry_session *session, uint64_t key);
int ust_registry_channel_add(struct ust_registry_session *session,
		uint64_t key);
void ust_registry_channel_del_free(struct ust_registry_session *session,
		uint64_t key);

int ust_registry_session_init(struct ust_registry_session **sessionp,
		struct ust_app *app,
		uint32_t bits_per_long,
		uint32_t uint8_t_alignment,
		uint32_t uint16_t_alignment,
		uint32_t uint32_t_alignment,
		uint32_t uint64_t_alignment,
		uint32_t long_alignment,
		int byte_order,
		uint32_t major,
		uint32_t minor,
		const char *root_shm_path,
		const char *shm_path,
		uid_t euid,
		gid_t egid);
void ust_registry_session_destroy(struct ust_registry_session *session);

int ust_registry_create_event(struct ust_registry_session *session,
		uint64_t chan_key, int session_objd, int channel_objd, char *name,
		char *sig, size_t nr_fields, struct ustctl_field *fields,
		int loglevel_value, char *model_emf_uri, int buffer_type,
		uint32_t *event_id_p, struct ust_app *app);
struct ust_registry_event *ust_registry_find_event(
		struct ust_registry_channel *chan, char *name, char *sig);
void ust_registry_destroy_event(struct ust_registry_channel *chan,
		struct ust_registry_event *event);

/* app can be NULL for registry shared across applications. */
int ust_metadata_session_statedump(struct ust_registry_session *session,
		struct ust_app *app, uint32_t major, uint32_t minor);
int ust_metadata_channel_statedump(struct ust_registry_session *session,
		struct ust_registry_channel *chan);
int ust_metadata_event_statedump(struct ust_registry_session *session,
		struct ust_registry_channel *chan,
		struct ust_registry_event *event);

#else /* HAVE_LIBLTTNG_UST_CTL */

static inline
void ust_registry_channel_destroy(struct ust_registry_session *session,
		struct ust_registry_channel *chan)
{}
static inline
struct ust_registry_channel *ust_registry_channel_find(
		struct ust_registry_session *session, uint64_t key)
{
	return NULL;
}
static inline
int ust_registry_channel_add(struct ust_registry_session *session,
		uint64_t key)
{
	return 0;
}
static inline
void ust_registry_channel_del_free(struct ust_registry_session *session,
		uint64_t key)
{}
static inline
int ust_registry_session_init(struct ust_registry_session **sessionp,
		struct ust_app *app,
		uint32_t bits_per_long,
		uint32_t uint8_t_alignment,
		uint32_t uint16_t_alignment,
		uint32_t uint32_t_alignment,
		uint32_t uint64_t_alignment,
		uint32_t long_alignment,
		int byte_order)
{
	return 0;
}
static inline
void ust_registry_session_destroy(struct ust_registry_session *session)
{}
static inline
int ust_registry_create_event(struct ust_registry_session *session,
		uint64_t chan_key, int session_objd, int channel_objd, char *name,
		char *sig, size_t nr_fields, struct ustctl_field *fields,
		int loglevel_value, char *model_emf_uri, int buffer_type,
		uint32_t *event_id_p)
{
	return 0;
}
static inline
struct ust_registry_event *ust_registry_find_event(
		struct ust_registry_channel *chan, char *name, char *sig)
{
	return NULL;
}
static inline
void ust_registry_destroy_event(struct ust_registry_channel *chan,
		struct ust_registry_event *event)
{}

/* The app object can be NULL for registry shared across applications. */
static inline
int ust_metadata_session_statedump(struct ust_registry_session *session,
		struct ust_app *app)
{
	return 0;
}
static inline
int ust_metadata_channel_statedump(struct ust_registry_session *session,
		struct ust_registry_channel *chan)
{
	return 0;
}
static inline
int ust_metadata_event_statedump(struct ust_registry_session *session,
		struct ust_registry_channel *chan,
		struct ust_registry_event *event)
{
	return 0;
}

#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* LTTNG_UST_REGISTRY_H */
Commit	Line	Data
d0b96690 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_UST_REGISTRY_H
	19	#define LTTNG_UST_REGISTRY_H
	20
	21	#include <pthread.h>
	22	#include <stdint.h>
d0b96690 DG	23
	24	#include <common/hashtable/hashtable.h>
	25	#include <common/compat/uuid.h>
	26
7972aab2 DG	27	#include "ust-ctl.h"
7972aab2 DG	28
d0b96690 DG	29	#define CTF_SPEC_MAJOR 1
	30	#define CTF_SPEC_MINOR 8
	31
	32	struct ust_app;
	33
	34	struct ust_registry_session {
	35	/*
dc2bbdae MD	36	* With multiple writers and readers, use this lock to access
	37	* the registry. Can nest within the ust app session lock.
	38	* Also acts as a registry serialization lock. Used by registry
	39	* readers to serialize the registry information sent from the
	40	* sessiond to the consumerd.
	41	* The consumer socket lock nests within this lock.
d0b96690 DG	42	*/
	43	pthread_mutex_t lock;
	44	/* Next channel ID available for a newly registered channel. */
	45	uint32_t next_channel_id;
	46	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	47	uint32_t used_channel_id;
	48	/* Universal unique identifier used by the tracer. */
	49	unsigned char uuid[UUID_LEN];
	50
	51	/* session ABI description */
	52
	53	/* Size of long, in bits */
	54	unsigned int bits_per_long;
	55	/* Alignment, in bits */
	56	unsigned int uint8_t_alignment,
	57	uint16_t_alignment,
	58	uint32_t_alignment,
	59	uint64_t_alignment,
	60	long_alignment;
	61	/* endianness */
	62	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	63
	64	/* Generated metadata. */
	65	char metadata; / NOT null-terminated ! Use memcpy. */
	66	size_t metadata_len, metadata_alloc_len;
d88aee68 DG	67	/* Length of bytes sent to the consumer. */
d88aee68 DG	68	size_t metadata_len_sent;
d7ba1388	69
3d071855	70	char root_shm_path[PATH_MAX];
d7ba1388 MD	71	char shm_path[PATH_MAX];
	72	char metadata_path[PATH_MAX];
	73	int metadata_fd; /* file-backed metadata FD */
	74
45893984	75	/*
dc2bbdae MD	76	* Hash table containing channels sent by the UST tracer. MUST
dc2bbdae MD	77	* be accessed with a RCU read side lock acquired.
45893984 DG	78	*/
45893984 DG	79	struct lttng_ht *channels;
dc2bbdae MD	80	/*
	81	* Unique key to identify the metadata on the consumer side.
	82	*/
7972aab2 DG	83	uint64_t metadata_key;
	84	/*
	85	* Indicates if the metadata is closed on the consumer side. This is to
	86	* avoid double close of metadata when an application unregisters AND
	87	* deletes its sessions.
	88	*/
	89	unsigned int metadata_closed;
4628484a MD	90
	91	/* User and group owning the session. */
	92	uid_t uid;
	93	gid_t gid;
d0b96690 DG	94	};
	95
	96	struct ust_registry_channel {
45893984	97	uint64_t key;
d0b96690 DG	98	/* Id set when replying to a register channel. */
	99	uint32_t chan_id;
	100	enum ustctl_channel_header header_type;
	101
7972aab2 DG	102	/*
	103	* Flag for this channel if the metadata was dumped once during
	104	* registration. 0 means no, 1 yes.
	105	*/
	106	unsigned int metadata_dumped;
	107	/* Indicates if this channel registry has already been registered. */
	108	unsigned int register_done;
	109
d0b96690 DG	110	/*
	111	* Hash table containing events sent by the UST tracer. MUST be accessed
	112	* with a RCU read side lock acquired.
	113	*/
	114	struct lttng_ht *ht;
	115	/* Next event ID available for a newly registered event. */
	116	uint32_t next_event_id;
	117	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	118	uint32_t used_event_id;
	119	/*
	120	* Context fields of the registry. Context are per channel. Allocated by a
	121	* register channel notification from the UST tracer.
	122	*/
	123	size_t nr_ctx_fields;
	124	struct ustctl_field *ctx_fields;
45893984	125	struct lttng_ht_node_u64 node;
36b588ed MD	126	/* For delayed reclaim */
36b588ed MD	127	struct rcu_head rcu_head;
d0b96690 DG	128	};
	129
	130	/*
	131	* Event registered from a UST tracer sent to the session daemon. This is
	132	* indexed and matched by <event_name/signature>.
	133	*/
	134	struct ust_registry_event {
	135	int id;
	136	/* Both objd are set by the tracer. */
	137	int session_objd;
	138	int channel_objd;
	139	/* Name of the event returned by the tracer. */
	140	char name[LTTNG_UST_SYM_NAME_LEN];
	141	char *signature;
2106efa0	142	int loglevel_value;
d0b96690 DG	143	size_t nr_fields;
	144	struct ustctl_field *fields;
	145	char *model_emf_uri;
7972aab2 DG	146	/*
	147	* Flag for this channel if the metadata was dumped once during
	148	* registration. 0 means no, 1 yes.
	149	*/
	150	unsigned int metadata_dumped;
d0b96690 DG	151	/*
	152	* Node in the ust-registry hash table. The event name is used to
	153	* initialize the node and the event_name/signature for the match function.
	154	*/
7972aab2	155	struct lttng_ht_node_u64 node;
d0b96690 DG	156	};
	157
	158	/*
	159	* Validate that the id has reached the maximum allowed or not.
	160	*
	161	* Return 0 if NOT else 1.
	162	*/
	163	static inline int ust_registry_is_max_id(uint32_t id)
	164	{
	165	return (id == UINT32_MAX) ? 1 : 0;
	166	}
	167
	168	/*
	169	* Return next available event id and increment the used counter. The
	170	* ust_registry_is_max_id function MUST be called before in order to validate
	171	* if the maximum number of IDs have been reached. If not, it is safe to call
	172	* this function.
	173	*
	174	* Return a unique channel ID. If max is reached, the used_event_id counter is
	175	* returned.
	176	*/
	177	static inline uint32_t ust_registry_get_next_event_id(
	178	struct ust_registry_channel *r)
	179	{
	180	if (ust_registry_is_max_id(r->used_event_id)) {
	181	return r->used_event_id;
	182	}
	183
	184	r->used_event_id++;
	185	return r->next_event_id++;
	186	}
	187
	188	/*
	189	* Return next available channel id and increment the used counter. The
	190	* ust_registry_is_max_id function MUST be called before in order to validate
	191	* if the maximum number of IDs have been reached. If not, it is safe to call
	192	* this function.
	193	*
	194	* Return a unique channel ID. If max is reached, the used_channel_id counter
	195	* is returned.
	196	*/
	197	static inline uint32_t ust_registry_get_next_chan_id(
	198	struct ust_registry_session *r)
	199	{
	200	if (ust_registry_is_max_id(r->used_channel_id)) {
	201	return r->used_channel_id;
	202	}
	203
	204	r->used_channel_id++;
	205	return r->next_channel_id++;
	206	}
	207
	208	/*
	209	* Return registry event count. This is read atomically.
	210	*/
	211	static inline uint32_t ust_registry_get_event_count(
	212	struct ust_registry_channel *r)
	213	{
	214	return (uint32_t) uatomic_read(&r->used_event_id);
	215	}
	216
7972aab2 DG	217	#ifdef HAVE_LIBLTTNG_UST_CTL
7972aab2 DG	218
d0b96690 DG	219	void ust_registry_channel_destroy(struct ust_registry_session *session,
d0b96690 DG	220	struct ust_registry_channel *chan);
45893984 DG	221	struct ust_registry_channel *ust_registry_channel_find(
	222	struct ust_registry_session *session, uint64_t key);
	223	int ust_registry_channel_add(struct ust_registry_session *session,
	224	uint64_t key);
	225	void ust_registry_channel_del_free(struct ust_registry_session *session,
	226	uint64_t key);
	227
	228	int ust_registry_session_init(struct ust_registry_session **sessionp,
d0b96690 DG	229	struct ust_app *app,
	230	uint32_t bits_per_long,
	231	uint32_t uint8_t_alignment,
	232	uint32_t uint16_t_alignment,
	233	uint32_t uint32_t_alignment,
	234	uint32_t uint64_t_alignment,
	235	uint32_t long_alignment,
af6142cf MD	236	int byte_order,
af6142cf MD	237	uint32_t major,
d7ba1388	238	uint32_t minor,
3d071855	239	const char *root_shm_path,
d7ba1388 MD	240	const char *shm_path,
	241	uid_t euid,
	242	gid_t egid);
d0b96690 DG	243	void ust_registry_session_destroy(struct ust_registry_session *session);
	244
	245	int ust_registry_create_event(struct ust_registry_session *session,
45893984	246	uint64_t chan_key, int session_objd, int channel_objd, char *name,
2106efa0 PP	247	char sig, size_t nr_fields, struct ustctl_field fields,
	248	int loglevel_value, char *model_emf_uri, int buffer_type,
	249	uint32_t event_id_p, struct ust_app app);
d0b96690 DG	250	struct ust_registry_event *ust_registry_find_event(
	251	struct ust_registry_channel chan, char name, char *sig);
	252	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	253	struct ust_registry_event *event);
	254
	255	/* app can be NULL for registry shared across applications. */
	256	int ust_metadata_session_statedump(struct ust_registry_session *session,
af6142cf	257	struct ust_app *app, uint32_t major, uint32_t minor);
d0b96690 DG	258	int ust_metadata_channel_statedump(struct ust_registry_session *session,
	259	struct ust_registry_channel *chan);
	260	int ust_metadata_event_statedump(struct ust_registry_session *session,
	261	struct ust_registry_channel *chan,
	262	struct ust_registry_event *event);
	263
7972aab2 DG	264	#else /* HAVE_LIBLTTNG_UST_CTL */
	265
	266	static inline
	267	void ust_registry_channel_destroy(struct ust_registry_session *session,
	268	struct ust_registry_channel *chan)
	269	{}
	270	static inline
	271	struct ust_registry_channel *ust_registry_channel_find(
	272	struct ust_registry_session *session, uint64_t key)
	273	{
	274	return NULL;
	275	}
	276	static inline
	277	int ust_registry_channel_add(struct ust_registry_session *session,
	278	uint64_t key)
	279	{
	280	return 0;
	281	}
	282	static inline
	283	void ust_registry_channel_del_free(struct ust_registry_session *session,
	284	uint64_t key)
	285	{}
	286	static inline
	287	int ust_registry_session_init(struct ust_registry_session **sessionp,
	288	struct ust_app *app,
	289	uint32_t bits_per_long,
	290	uint32_t uint8_t_alignment,
	291	uint32_t uint16_t_alignment,
	292	uint32_t uint32_t_alignment,
	293	uint32_t uint64_t_alignment,
	294	uint32_t long_alignment,
	295	int byte_order)
	296	{
	297	return 0;
	298	}
	299	static inline
	300	void ust_registry_session_destroy(struct ust_registry_session *session)
	301	{}
	302	static inline
	303	int ust_registry_create_event(struct ust_registry_session *session,
	304	uint64_t chan_key, int session_objd, int channel_objd, char *name,
2106efa0 PP	305	char sig, size_t nr_fields, struct ustctl_field fields,
	306	int loglevel_value, char *model_emf_uri, int buffer_type,
	307	uint32_t *event_id_p)
7972aab2 DG	308	{
	309	return 0;
	310	}
	311	static inline
	312	struct ust_registry_event *ust_registry_find_event(
	313	struct ust_registry_channel chan, char name, char *sig)
	314	{
	315	return NULL;
	316	}
	317	static inline
	318	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	319	struct ust_registry_event *event)
	320	{}
	321
	322	/* The app object can be NULL for registry shared across applications. */
	323	static inline
	324	int ust_metadata_session_statedump(struct ust_registry_session *session,
	325	struct ust_app *app)
	326	{
	327	return 0;
	328	}
	329	static inline
	330	int ust_metadata_channel_statedump(struct ust_registry_session *session,
	331	struct ust_registry_channel *chan)
	332	{
	333	return 0;
	334	}
	335	static inline
	336	int ust_metadata_event_statedump(struct ust_registry_session *session,
	337	struct ust_registry_channel *chan,
	338	struct ust_registry_event *event)
	339	{
	340	return 0;
	341	}
	342
	343	#endif /* HAVE_LIBLTTNG_UST_CTL */
	344
d0b96690	345	#endif /* LTTNG_UST_REGISTRY_H */