[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;
	/*
	 * 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;
};

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;
	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);
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,
		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,
		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;
45893984	69	/*
dc2bbdae MD	70	* Hash table containing channels sent by the UST tracer. MUST
dc2bbdae MD	71	* be accessed with a RCU read side lock acquired.
45893984 DG	72	*/
45893984 DG	73	struct lttng_ht *channels;
dc2bbdae MD	74	/*
	75	* Unique key to identify the metadata on the consumer side.
	76	*/
7972aab2 DG	77	uint64_t metadata_key;
	78	/*
	79	* Indicates if the metadata is closed on the consumer side. This is to
	80	* avoid double close of metadata when an application unregisters AND
	81	* deletes its sessions.
	82	*/
	83	unsigned int metadata_closed;
d0b96690 DG	84	};
	85
	86	struct ust_registry_channel {
45893984	87	uint64_t key;
d0b96690 DG	88	/* Id set when replying to a register channel. */
	89	uint32_t chan_id;
	90	enum ustctl_channel_header header_type;
	91
7972aab2 DG	92	/*
	93	* Flag for this channel if the metadata was dumped once during
	94	* registration. 0 means no, 1 yes.
	95	*/
	96	unsigned int metadata_dumped;
	97	/* Indicates if this channel registry has already been registered. */
	98	unsigned int register_done;
	99
d0b96690 DG	100	/*
	101	* Hash table containing events sent by the UST tracer. MUST be accessed
	102	* with a RCU read side lock acquired.
	103	*/
	104	struct lttng_ht *ht;
	105	/* Next event ID available for a newly registered event. */
	106	uint32_t next_event_id;
	107	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	108	uint32_t used_event_id;
	109	/*
	110	* Context fields of the registry. Context are per channel. Allocated by a
	111	* register channel notification from the UST tracer.
	112	*/
	113	size_t nr_ctx_fields;
	114	struct ustctl_field *ctx_fields;
45893984	115	struct lttng_ht_node_u64 node;
36b588ed MD	116	/* For delayed reclaim */
36b588ed MD	117	struct rcu_head rcu_head;
d0b96690 DG	118	};
	119
	120	/*
	121	* Event registered from a UST tracer sent to the session daemon. This is
	122	* indexed and matched by <event_name/signature>.
	123	*/
	124	struct ust_registry_event {
	125	int id;
	126	/* Both objd are set by the tracer. */
	127	int session_objd;
	128	int channel_objd;
	129	/* Name of the event returned by the tracer. */
	130	char name[LTTNG_UST_SYM_NAME_LEN];
	131	char *signature;
	132	int loglevel;
	133	size_t nr_fields;
	134	struct ustctl_field *fields;
	135	char *model_emf_uri;
7972aab2 DG	136	/*
	137	* Flag for this channel if the metadata was dumped once during
	138	* registration. 0 means no, 1 yes.
	139	*/
	140	unsigned int metadata_dumped;
d0b96690 DG	141	/*
	142	* Node in the ust-registry hash table. The event name is used to
	143	* initialize the node and the event_name/signature for the match function.
	144	*/
7972aab2	145	struct lttng_ht_node_u64 node;
d0b96690 DG	146	};
	147
	148	/*
	149	* Validate that the id has reached the maximum allowed or not.
	150	*
	151	* Return 0 if NOT else 1.
	152	*/
	153	static inline int ust_registry_is_max_id(uint32_t id)
	154	{
	155	return (id == UINT32_MAX) ? 1 : 0;
	156	}
	157
	158	/*
	159	* Return next available event id and increment the used counter. The
	160	* ust_registry_is_max_id function MUST be called before in order to validate
	161	* if the maximum number of IDs have been reached. If not, it is safe to call
	162	* this function.
	163	*
	164	* Return a unique channel ID. If max is reached, the used_event_id counter is
	165	* returned.
	166	*/
	167	static inline uint32_t ust_registry_get_next_event_id(
	168	struct ust_registry_channel *r)
	169	{
	170	if (ust_registry_is_max_id(r->used_event_id)) {
	171	return r->used_event_id;
	172	}
	173
	174	r->used_event_id++;
	175	return r->next_event_id++;
	176	}
	177
	178	/*
	179	* Return next available channel id and increment the used counter. The
	180	* ust_registry_is_max_id function MUST be called before in order to validate
	181	* if the maximum number of IDs have been reached. If not, it is safe to call
	182	* this function.
	183	*
	184	* Return a unique channel ID. If max is reached, the used_channel_id counter
	185	* is returned.
	186	*/
	187	static inline uint32_t ust_registry_get_next_chan_id(
	188	struct ust_registry_session *r)
	189	{
	190	if (ust_registry_is_max_id(r->used_channel_id)) {
	191	return r->used_channel_id;
	192	}
	193
	194	r->used_channel_id++;
	195	return r->next_channel_id++;
	196	}
	197
	198	/*
	199	* Return registry event count. This is read atomically.
	200	*/
	201	static inline uint32_t ust_registry_get_event_count(
	202	struct ust_registry_channel *r)
	203	{
	204	return (uint32_t) uatomic_read(&r->used_event_id);
	205	}
	206
7972aab2 DG	207	#ifdef HAVE_LIBLTTNG_UST_CTL
7972aab2 DG	208
d0b96690 DG	209	void ust_registry_channel_destroy(struct ust_registry_session *session,
d0b96690 DG	210	struct ust_registry_channel *chan);
45893984 DG	211	struct ust_registry_channel *ust_registry_channel_find(
	212	struct ust_registry_session *session, uint64_t key);
	213	int ust_registry_channel_add(struct ust_registry_session *session,
	214	uint64_t key);
	215	void ust_registry_channel_del_free(struct ust_registry_session *session,
	216	uint64_t key);
	217
	218	int ust_registry_session_init(struct ust_registry_session **sessionp,
d0b96690 DG	219	struct ust_app *app,
	220	uint32_t bits_per_long,
	221	uint32_t uint8_t_alignment,
	222	uint32_t uint16_t_alignment,
	223	uint32_t uint32_t_alignment,
	224	uint32_t uint64_t_alignment,
	225	uint32_t long_alignment,
af6142cf MD	226	int byte_order,
	227	uint32_t major,
	228	uint32_t minor);
d0b96690 DG	229	void ust_registry_session_destroy(struct ust_registry_session *session);
	230
	231	int ust_registry_create_event(struct ust_registry_session *session,
45893984 DG	232	uint64_t chan_key, int session_objd, int channel_objd, char *name,
45893984 DG	233	char sig, size_t nr_fields, struct ustctl_field fields, int loglevel,
8494bda5 MD	234	char model_emf_uri, int buffer_type, uint32_t event_id_p,
8494bda5 MD	235	struct ust_app *app);
d0b96690 DG	236	struct ust_registry_event *ust_registry_find_event(
	237	struct ust_registry_channel chan, char name, char *sig);
	238	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	239	struct ust_registry_event *event);
	240
	241	/* app can be NULL for registry shared across applications. */
	242	int ust_metadata_session_statedump(struct ust_registry_session *session,
af6142cf	243	struct ust_app *app, uint32_t major, uint32_t minor);
d0b96690 DG	244	int ust_metadata_channel_statedump(struct ust_registry_session *session,
	245	struct ust_registry_channel *chan);
	246	int ust_metadata_event_statedump(struct ust_registry_session *session,
	247	struct ust_registry_channel *chan,
	248	struct ust_registry_event *event);
	249
7972aab2 DG	250	#else /* HAVE_LIBLTTNG_UST_CTL */
	251
	252	static inline
	253	void ust_registry_channel_destroy(struct ust_registry_session *session,
	254	struct ust_registry_channel *chan)
	255	{}
	256	static inline
	257	struct ust_registry_channel *ust_registry_channel_find(
	258	struct ust_registry_session *session, uint64_t key)
	259	{
	260	return NULL;
	261	}
	262	static inline
	263	int ust_registry_channel_add(struct ust_registry_session *session,
	264	uint64_t key)
	265	{
	266	return 0;
	267	}
	268	static inline
	269	void ust_registry_channel_del_free(struct ust_registry_session *session,
	270	uint64_t key)
	271	{}
	272	static inline
	273	int ust_registry_session_init(struct ust_registry_session **sessionp,
	274	struct ust_app *app,
	275	uint32_t bits_per_long,
	276	uint32_t uint8_t_alignment,
	277	uint32_t uint16_t_alignment,
	278	uint32_t uint32_t_alignment,
	279	uint32_t uint64_t_alignment,
	280	uint32_t long_alignment,
	281	int byte_order)
	282	{
	283	return 0;
	284	}
	285	static inline
	286	void ust_registry_session_destroy(struct ust_registry_session *session)
	287	{}
	288	static inline
	289	int ust_registry_create_event(struct ust_registry_session *session,
	290	uint64_t chan_key, int session_objd, int channel_objd, char *name,
	291	char sig, size_t nr_fields, struct ustctl_field fields, int loglevel,
	292	char model_emf_uri, int buffer_type, uint32_t event_id_p)
	293	{
	294	return 0;
	295	}
	296	static inline
	297	struct ust_registry_event *ust_registry_find_event(
	298	struct ust_registry_channel chan, char name, char *sig)
	299	{
	300	return NULL;
	301	}
	302	static inline
	303	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	304	struct ust_registry_event *event)
	305	{}
	306
	307	/* The app object can be NULL for registry shared across applications. */
	308	static inline
	309	int ust_metadata_session_statedump(struct ust_registry_session *session,
	310	struct ust_app *app)
	311	{
	312	return 0;
	313	}
314	static inline
315	int ust_metadata_channel_statedump(struct ust_registry_session *session,
316	struct ust_registry_channel *chan)
317	{
318	return 0;
319	}
320	static inline
321	int ust_metadata_event_statedump(struct ust_registry_session *session,
322	struct ust_registry_channel *chan,
323	struct ust_registry_event *event)
324	{
325	return 0;
326	}
327
328	#endif /* HAVE_LIBLTTNG_UST_CTL */
329
d0b96690	330	#endif /* LTTNG_UST_REGISTRY_H */