[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;
	/* Next enumeration ID available. */
	uint64_t next_enum_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;
	/* Current version of the metadata. */
	uint64_t metadata_version;

	/*
	 * Those fields are only used when a session is created with
	 * the --shm-path option. In this case, the metadata is output
	 * twice: once to the consumer, as ususal, but a second time
	 * also in the shm path directly. This is done so that a copy
	 * of the metadata that is as fresh as possible is available
	 * on the event of a crash.
	 *
	 * root_shm_path contains the shm-path provided by the user, along with
	 * the session's name and timestamp:
	 *   e.g. /tmp/my_shm/my_session-20180612-135822
	 *
	 * shm_path contains the full path of the memory buffers:
	 *   e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit
	 *
	 * metadata_path contains the full path to the metadata file that
	 * is kept for the "crash buffer" extraction:
	 *  e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit/metadata
	 *
	 * Note that this is not the trace's final metadata file. It is
	 * only meant to be used to read the contents of the ring buffers
	 * in the event of a crash.
	 *
	 * metadata_fd is a file descriptor that points to the file at
	 * 'metadata_path'.
	 */
	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;

	/* Enumerations table. */
	struct lttng_ht *enums;

	/*
	 * Copy of the tracer version when the first app is registered.
	 * It is used if we need to regenerate the metadata.
	 */
	uint32_t major;
	uint32_t minor;
};

struct ust_registry_channel {
	uint64_t key;
	uint64_t consumer_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;
};

struct ust_registry_enum {
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct ustctl_enum_entry *entries;
	size_t nr_entries;
	uint64_t id;	/* enum id in session */
	/* Enumeration node in session hash table. */
	struct lttng_ht_node_str node;
	/* For delayed reclaim. */
	struct rcu_head rcu_head;
};

/*
 * 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, bool notif);

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);
int ust_registry_create_or_find_enum(struct ust_registry_session *session,
		int session_objd, char *name,
		struct ustctl_enum_entry *entries, size_t nr_entries,
		uint64_t *enum_id);
struct ust_registry_enum *
	ust_registry_lookup_enum_by_id(struct ust_registry_session *session,
		const char *name, uint64_t id);

#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, bool notif)
{}
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, uint32_t major, uint32_t minor)
{
	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;
}
static inline
int ust_registry_create_or_find_enum(struct ust_registry_session *session,
		int session_objd, char *name,
		struct ustctl_enum_entry *entries, size_t nr_entries,
		uint64_t *enum_id)
{
	return 0;
}
static inline
struct ust_registry_enum *
	ust_registry_lookup_enum_by_id(struct ust_registry_session *session,
		const char *name, uint64_t id)
{
	return NULL;
}

#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;
10b56aef MD	48	/* Next enumeration ID available. */
10b56aef MD	49	uint64_t next_enum_id;
d0b96690 DG	50	/* Universal unique identifier used by the tracer. */
	51	unsigned char uuid[UUID_LEN];
	52
	53	/* session ABI description */
	54
	55	/* Size of long, in bits */
	56	unsigned int bits_per_long;
	57	/* Alignment, in bits */
	58	unsigned int uint8_t_alignment,
	59	uint16_t_alignment,
	60	uint32_t_alignment,
	61	uint64_t_alignment,
	62	long_alignment;
	63	/* endianness */
	64	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	65
	66	/* Generated metadata. */
	67	char metadata; / NOT null-terminated ! Use memcpy. */
	68	size_t metadata_len, metadata_alloc_len;
d88aee68 DG	69	/* Length of bytes sent to the consumer. */
d88aee68 DG	70	size_t metadata_len_sent;
93ec662e JD	71	/* Current version of the metadata. */
93ec662e JD	72	uint64_t metadata_version;
d7ba1388	73
9aed4377 JG	74	/*
	75	* Those fields are only used when a session is created with
	76	* the --shm-path option. In this case, the metadata is output
	77	* twice: once to the consumer, as ususal, but a second time
	78	* also in the shm path directly. This is done so that a copy
	79	* of the metadata that is as fresh as possible is available
	80	* on the event of a crash.
	81	*
	82	* root_shm_path contains the shm-path provided by the user, along with
	83	* the session's name and timestamp:
	84	* e.g. /tmp/my_shm/my_session-20180612-135822
	85	*
	86	* shm_path contains the full path of the memory buffers:
	87	* e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit
	88	*
	89	* metadata_path contains the full path to the metadata file that
	90	* is kept for the "crash buffer" extraction:
	91	* e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit/metadata
	92	*
	93	* Note that this is not the trace's final metadata file. It is
	94	* only meant to be used to read the contents of the ring buffers
	95	* in the event of a crash.
	96	*
	97	* metadata_fd is a file descriptor that points to the file at
	98	* 'metadata_path'.
	99	*/
3d071855	100	char root_shm_path[PATH_MAX];
d7ba1388 MD	101	char shm_path[PATH_MAX];
	102	char metadata_path[PATH_MAX];
	103	int metadata_fd; /* file-backed metadata FD */
	104
45893984	105	/*
dc2bbdae MD	106	* Hash table containing channels sent by the UST tracer. MUST
dc2bbdae MD	107	* be accessed with a RCU read side lock acquired.
45893984 DG	108	*/
45893984 DG	109	struct lttng_ht *channels;
dc2bbdae MD	110	/*
	111	* Unique key to identify the metadata on the consumer side.
	112	*/
7972aab2 DG	113	uint64_t metadata_key;
	114	/*
	115	* Indicates if the metadata is closed on the consumer side. This is to
	116	* avoid double close of metadata when an application unregisters AND
	117	* deletes its sessions.
	118	*/
	119	unsigned int metadata_closed;
4628484a MD	120
	121	/* User and group owning the session. */
	122	uid_t uid;
	123	gid_t gid;
10b56aef MD	124
	125	/* Enumerations table. */
	126	struct lttng_ht *enums;
7062f070 JD	127
	128	/*
	129	* Copy of the tracer version when the first app is registered.
	130	* It is used if we need to regenerate the metadata.
	131	*/
	132	uint32_t major;
	133	uint32_t minor;
d0b96690 DG	134	};
	135
	136	struct ust_registry_channel {
45893984	137	uint64_t key;
e9404c27	138	uint64_t consumer_key;
d0b96690 DG	139	/* Id set when replying to a register channel. */
	140	uint32_t chan_id;
	141	enum ustctl_channel_header header_type;
	142
7972aab2 DG	143	/*
	144	* Flag for this channel if the metadata was dumped once during
	145	* registration. 0 means no, 1 yes.
	146	*/
	147	unsigned int metadata_dumped;
	148	/* Indicates if this channel registry has already been registered. */
	149	unsigned int register_done;
	150
d0b96690 DG	151	/*
	152	* Hash table containing events sent by the UST tracer. MUST be accessed
	153	* with a RCU read side lock acquired.
	154	*/
	155	struct lttng_ht *ht;
	156	/* Next event ID available for a newly registered event. */
	157	uint32_t next_event_id;
	158	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	159	uint32_t used_event_id;
	160	/*
	161	* Context fields of the registry. Context are per channel. Allocated by a
	162	* register channel notification from the UST tracer.
	163	*/
	164	size_t nr_ctx_fields;
	165	struct ustctl_field *ctx_fields;
45893984	166	struct lttng_ht_node_u64 node;
36b588ed MD	167	/* For delayed reclaim */
36b588ed MD	168	struct rcu_head rcu_head;
d0b96690 DG	169	};
	170
	171	/*
	172	* Event registered from a UST tracer sent to the session daemon. This is
	173	* indexed and matched by <event_name/signature>.
	174	*/
	175	struct ust_registry_event {
	176	int id;
	177	/* Both objd are set by the tracer. */
	178	int session_objd;
	179	int channel_objd;
	180	/* Name of the event returned by the tracer. */
	181	char name[LTTNG_UST_SYM_NAME_LEN];
	182	char *signature;
2106efa0	183	int loglevel_value;
d0b96690 DG	184	size_t nr_fields;
	185	struct ustctl_field *fields;
	186	char *model_emf_uri;
7972aab2 DG	187	/*
	188	* Flag for this channel if the metadata was dumped once during
	189	* registration. 0 means no, 1 yes.
	190	*/
	191	unsigned int metadata_dumped;
d0b96690 DG	192	/*
	193	* Node in the ust-registry hash table. The event name is used to
	194	* initialize the node and the event_name/signature for the match function.
	195	*/
7972aab2	196	struct lttng_ht_node_u64 node;
d0b96690 DG	197	};
d0b96690 DG	198
10b56aef MD	199	struct ust_registry_enum {
	200	char name[LTTNG_UST_SYM_NAME_LEN];
	201	struct ustctl_enum_entry *entries;
	202	size_t nr_entries;
	203	uint64_t id; /* enum id in session */
	204	/* Enumeration node in session hash table. */
	205	struct lttng_ht_node_str node;
	206	/* For delayed reclaim. */
	207	struct rcu_head rcu_head;
	208	};
	209
d0b96690 DG	210	/*
	211	* Validate that the id has reached the maximum allowed or not.
	212	*
	213	* Return 0 if NOT else 1.
	214	*/
	215	static inline int ust_registry_is_max_id(uint32_t id)
	216	{
	217	return (id == UINT32_MAX) ? 1 : 0;
	218	}
	219
	220	/*
	221	* Return next available event id and increment the used counter. The
	222	* ust_registry_is_max_id function MUST be called before in order to validate
	223	* if the maximum number of IDs have been reached. If not, it is safe to call
	224	* this function.
	225	*
	226	* Return a unique channel ID. If max is reached, the used_event_id counter is
	227	* returned.
	228	*/
	229	static inline uint32_t ust_registry_get_next_event_id(
	230	struct ust_registry_channel *r)
	231	{
	232	if (ust_registry_is_max_id(r->used_event_id)) {
	233	return r->used_event_id;
	234	}
	235
	236	r->used_event_id++;
	237	return r->next_event_id++;
	238	}
	239
	240	/*
	241	* Return next available channel id and increment the used counter. The
	242	* ust_registry_is_max_id function MUST be called before in order to validate
	243	* if the maximum number of IDs have been reached. If not, it is safe to call
	244	* this function.
	245	*
	246	* Return a unique channel ID. If max is reached, the used_channel_id counter
	247	* is returned.
	248	*/
	249	static inline uint32_t ust_registry_get_next_chan_id(
	250	struct ust_registry_session *r)
	251	{
	252	if (ust_registry_is_max_id(r->used_channel_id)) {
	253	return r->used_channel_id;
	254	}
	255
	256	r->used_channel_id++;
	257	return r->next_channel_id++;
	258	}
	259
	260	/*
	261	* Return registry event count. This is read atomically.
	262	*/
	263	static inline uint32_t ust_registry_get_event_count(
	264	struct ust_registry_channel *r)
	265	{
	266	return (uint32_t) uatomic_read(&r->used_event_id);
	267	}
	268
7972aab2 DG	269	#ifdef HAVE_LIBLTTNG_UST_CTL
7972aab2 DG	270
d0b96690 DG	271	void ust_registry_channel_destroy(struct ust_registry_session *session,
d0b96690 DG	272	struct ust_registry_channel *chan);
45893984 DG	273	struct ust_registry_channel *ust_registry_channel_find(
	274	struct ust_registry_session *session, uint64_t key);
	275	int ust_registry_channel_add(struct ust_registry_session *session,
	276	uint64_t key);
	277	void ust_registry_channel_del_free(struct ust_registry_session *session,
e9404c27	278	uint64_t key, bool notif);
45893984 DG	279
45893984 DG	280	int ust_registry_session_init(struct ust_registry_session **sessionp,
d0b96690 DG	281	struct ust_app *app,
	282	uint32_t bits_per_long,
	283	uint32_t uint8_t_alignment,
	284	uint32_t uint16_t_alignment,
	285	uint32_t uint32_t_alignment,
	286	uint32_t uint64_t_alignment,
	287	uint32_t long_alignment,
af6142cf MD	288	int byte_order,
af6142cf MD	289	uint32_t major,
d7ba1388	290	uint32_t minor,
3d071855	291	const char *root_shm_path,
d7ba1388 MD	292	const char *shm_path,
	293	uid_t euid,
	294	gid_t egid);
d0b96690 DG	295	void ust_registry_session_destroy(struct ust_registry_session *session);
	296
	297	int ust_registry_create_event(struct ust_registry_session *session,
45893984	298	uint64_t chan_key, int session_objd, int channel_objd, char *name,
2106efa0 PP	299	char sig, size_t nr_fields, struct ustctl_field fields,
	300	int loglevel_value, char *model_emf_uri, int buffer_type,
	301	uint32_t event_id_p, struct ust_app app);
d0b96690 DG	302	struct ust_registry_event *ust_registry_find_event(
	303	struct ust_registry_channel chan, char name, char *sig);
	304	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	305	struct ust_registry_event *event);
	306
	307	/* app can be NULL for registry shared across applications. */
	308	int ust_metadata_session_statedump(struct ust_registry_session *session,
af6142cf	309	struct ust_app *app, uint32_t major, uint32_t minor);
d0b96690 DG	310	int ust_metadata_channel_statedump(struct ust_registry_session *session,
	311	struct ust_registry_channel *chan);
	312	int ust_metadata_event_statedump(struct ust_registry_session *session,
	313	struct ust_registry_channel *chan,
	314	struct ust_registry_event *event);
10b56aef MD	315	int ust_registry_create_or_find_enum(struct ust_registry_session *session,
	316	int session_objd, char *name,
	317	struct ustctl_enum_entry *entries, size_t nr_entries,
	318	uint64_t *enum_id);
	319	struct ust_registry_enum *
	320	ust_registry_lookup_enum_by_id(struct ust_registry_session *session,
	321	const char *name, uint64_t id);
d0b96690	322
7972aab2 DG	323	#else /* HAVE_LIBLTTNG_UST_CTL */
	324
	325	static inline
	326	void ust_registry_channel_destroy(struct ust_registry_session *session,
	327	struct ust_registry_channel *chan)
	328	{}
	329	static inline
	330	struct ust_registry_channel *ust_registry_channel_find(
	331	struct ust_registry_session *session, uint64_t key)
	332	{
	333	return NULL;
	334	}
	335	static inline
	336	int ust_registry_channel_add(struct ust_registry_session *session,
	337	uint64_t key)
	338	{
	339	return 0;
	340	}
	341	static inline
	342	void ust_registry_channel_del_free(struct ust_registry_session *session,
e9404c27	343	uint64_t key, bool notif)
7972aab2 DG	344	{}
	345	static inline
	346	int ust_registry_session_init(struct ust_registry_session **sessionp,
	347	struct ust_app *app,
	348	uint32_t bits_per_long,
	349	uint32_t uint8_t_alignment,
	350	uint32_t uint16_t_alignment,
	351	uint32_t uint32_t_alignment,
	352	uint32_t uint64_t_alignment,
	353	uint32_t long_alignment,
	354	int byte_order)
	355	{
	356	return 0;
	357	}
	358	static inline
	359	void ust_registry_session_destroy(struct ust_registry_session *session)
	360	{}
	361	static inline
	362	int ust_registry_create_event(struct ust_registry_session *session,
	363	uint64_t chan_key, int session_objd, int channel_objd, char *name,
2106efa0 PP	364	char sig, size_t nr_fields, struct ustctl_field fields,
	365	int loglevel_value, char *model_emf_uri, int buffer_type,
	366	uint32_t *event_id_p)
7972aab2 DG	367	{
	368	return 0;
	369	}
	370	static inline
	371	struct ust_registry_event *ust_registry_find_event(
	372	struct ust_registry_channel chan, char name, char *sig)
	373	{
	374	return NULL;
	375	}
	376	static inline
	377	void ust_registry_destroy_event(struct ust_registry_channel *chan,
	378	struct ust_registry_event *event)
	379	{}
	380
	381	/* The app object can be NULL for registry shared across applications. */
	382	static inline
	383	int ust_metadata_session_statedump(struct ust_registry_session *session,
9804676e	384	struct ust_app *app, uint32_t major, uint32_t minor)
7972aab2 DG	385	{
	386	return 0;
	387	}
	388	static inline
	389	int ust_metadata_channel_statedump(struct ust_registry_session *session,
	390	struct ust_registry_channel *chan)
	391	{
	392	return 0;
	393	}
	394	static inline
	395	int ust_metadata_event_statedump(struct ust_registry_session *session,
	396	struct ust_registry_channel *chan,
	397	struct ust_registry_event *event)
	398	{
	399	return 0;
	400	}
10b56aef MD	401	static inline
	402	int ust_registry_create_or_find_enum(struct ust_registry_session *session,
	403	int session_objd, char *name,
	404	struct ustctl_enum_entry *entries, size_t nr_entries,
	405	uint64_t *enum_id)
	406	{
	407	return 0;
	408	}
	409	static inline
	410	struct ust_registry_enum *
	411	ust_registry_lookup_enum_by_id(struct ust_registry_session *session,
	412	const char *name, uint64_t id)
	413	{
	414	return NULL;
	415	}
7972aab2 DG	416
	417	#endif /* HAVE_LIBLTTNG_UST_CTL */
	418
d0b96690	419	#endif /* LTTNG_UST_REGISTRY_H */