[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * 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 _LTT_UST_APP_H 
#define _LTT_UST_APP_H

#include <stdint.h>

#include <common/compat/uuid.h>

#include "agent.h"
#include "trace-ust.h"
#include "ust-registry.h"

#define UST_APP_EVENT_LIST_SIZE 32

/* Process name (short). */
#define UST_APP_PROCNAME_LEN	16

struct lttng_filter_bytecode;
struct lttng_ust_filter_bytecode;

extern int ust_consumerd64_fd, ust_consumerd32_fd;

/*
 * Object used to close the notify socket in a call_rcu(). Since the
 * application might not be found, we need an independant object containing the
 * notify socket fd.
 */
struct ust_app_notify_sock_obj {
	int fd;
	struct rcu_head head;
};

struct ust_app_ht_key {
	const char *name;
	const struct lttng_filter_bytecode *filter;
	enum lttng_ust_loglevel_type loglevel;
	const struct lttng_event_exclusion *exclusion;
};

/*
 * Application registration data structure.
 */
struct ust_register_msg {
	enum ustctl_socket_type type;
	uint32_t major;
	uint32_t minor;
	uint32_t abi_major;
	uint32_t abi_minor;
	pid_t pid;
	pid_t ppid;
	uid_t uid;
	gid_t gid;
	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;		/* BIG_ENDIAN or LITTLE_ENDIAN */
	char name[LTTNG_UST_ABI_PROCNAME_LEN];
};

/*
 * Global applications HT used by the session daemon. This table is indexed by
 * PID using the pid_n node and pid value of an ust_app.
 */
struct lttng_ht *ust_app_ht;

/*
 * Global applications HT used by the session daemon. This table is indexed by
 * socket using the sock_n node and sock value of an ust_app.
 */
struct lttng_ht *ust_app_ht_by_sock;

/*
 * Global applications HT used by the session daemon. This table is indexed by
 * socket using the notify_sock_n node and notify_sock value of an ust_app.
 */
struct lttng_ht *ust_app_ht_by_notify_sock;

/* Stream list containing ust_app_stream. */
struct ust_app_stream_list {
	unsigned int count;
	struct cds_list_head head;
};

struct ust_app_ctx {
	int handle;
	struct lttng_ust_context ctx;
	struct lttng_ust_object_data *obj;
	struct lttng_ht_node_ulong node;
	struct cds_list_head list;
};

struct ust_app_event {
	int enabled;
	int handle;
	struct lttng_ust_object_data *obj;
	struct lttng_ust_event attr;
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct lttng_ht_node_str node;
	struct lttng_filter_bytecode *filter;
	struct lttng_event_exclusion *exclusion;
};

struct ust_app_stream {
	int handle;
	char pathname[PATH_MAX];
	/* Format is %s_%d respectively channel name and CPU number. */
	char name[DEFAULT_STREAM_NAME_LEN];
	struct lttng_ust_object_data *obj;
	/* Using a list of streams to keep order. */
	struct cds_list_head list;
};

struct ust_app_channel {
	int enabled;
	int handle;
	/* Channel and streams were sent to the UST tracer. */
	int is_sent;
	/* Unique key used to identify the channel on the consumer side. */
	uint64_t key;
	/* Id of the tracing channel set on creation. */
	uint64_t tracing_channel_id;
	/* Number of stream that this channel is expected to receive. */
	unsigned int expected_stream_count;
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct lttng_ust_object_data *obj;
	struct ustctl_consumer_channel_attr attr;
	struct ust_app_stream_list streams;
	/* Session pointer that owns this object. */
	struct ust_app_session *session;
	/*
	 * Contexts are kept in a hash table for fast lookup and in an ordered list
	 * so we are able to enable them on the tracer side in the same order the
	 * user added them.
	 */
	struct lttng_ht *ctx;
	struct cds_list_head ctx_list;

	struct lttng_ht *events;
	uint64_t tracefile_size;
	uint64_t tracefile_count;
	/*
	 * Node indexed by channel name in the channels' hash table of a session.
	 */
	struct lttng_ht_node_str node;
	/*
	 * Node indexed by UST channel object descriptor (handle). Stored in the
	 * ust_objd hash table in the ust_app object.
	 */
	struct lttng_ht_node_ulong ust_objd_node;
	/* For delayed reclaim */
	struct rcu_head rcu_head;
};

struct ust_app_session {
	/*
	 * Lock protecting this session's ust app interaction. Held
	 * across command send/recv to/from app. Never nests within the
	 * session registry lock.
	 */
	pthread_mutex_t lock;

	int enabled;
	/* started: has the session been in started state at any time ? */
	int started;  /* allows detection of start vs restart. */
	int handle;   /* used has unique identifier for app session */

	bool deleted;	/* Session deleted flag. Check with lock held. */

	/*
	 * Tracing session ID. Multiple ust app session can have the same tracing
	 * session id making this value NOT unique to the object.
	 */
	uint64_t tracing_id;
	uint64_t id;	/* Unique session identifier */
	struct lttng_ht *channels; /* Registered channels */
	struct lttng_ht_node_u64 node;
	char path[PATH_MAX];
	/* UID/GID of the application owning the session */
	uid_t uid;
	gid_t gid;
	/* Effective UID and GID. Same as the tracing session. */
	uid_t euid;
	gid_t egid;
	struct cds_list_head teardown_node;
	/*
	 * Once at least *one* session is created onto the application, the
	 * corresponding consumer is set so we can use it on unregistration.
	 */
	struct consumer_output *consumer;
	enum lttng_buffer_type buffer_type;
	/* ABI of the session. Same value as the application. */
	uint32_t bits_per_long;
	/* For delayed reclaim */
	struct rcu_head rcu_head;
	/* If the channel's streams have to be outputed or not. */
	unsigned int output_traces;
	unsigned int live_timer_interval;	/* usec */

	/* Metadata channel attributes. */
	struct ustctl_consumer_channel_attr metadata_attr;

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

/*
 * Registered traceable applications. Libust registers to the session daemon
 * and a linked list is kept of all running traceable app.
 */
struct ust_app {
	int sock;
	int notify_sock;
	pid_t pid;
	pid_t ppid;
	uid_t uid;           /* User ID that owns the apps */
	gid_t gid;           /* Group ID that owns the apps */

	/* App ABI */
	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;		/* BIG_ENDIAN or LITTLE_ENDIAN */

	int compatible; /* If the lttng-ust tracer version does not match the
					   supported version of the session daemon, this flag is
					   set to 0 (NOT compatible) else 1. */
	struct lttng_ust_tracer_version version;
	uint32_t v_major;    /* Version major number */
	uint32_t v_minor;    /* Version minor number */
	/* Extra for the NULL byte. */
	char name[UST_APP_PROCNAME_LEN + 1];
	/* Type of buffer this application uses. */
	enum lttng_buffer_type buffer_type;
	struct lttng_ht *sessions;
	struct lttng_ht_node_ulong pid_n;
	struct lttng_ht_node_ulong sock_n;
	struct lttng_ht_node_ulong notify_sock_n;
	/*
	 * This is a list of ust app session that, once the app is going into
	 * teardown mode, in the RCU call, each node in this list is removed and
	 * deleted.
	 *
	 * Element of the list are added when an application unregisters after each
	 * ht_del of ust_app_session associated to this app. This list is NOT used
	 * when a session is destroyed.
	 */
	struct cds_list_head teardown_head;
	/*
	 * Hash table containing ust_app_channel indexed by channel objd.
	 */
	struct lttng_ht *ust_objd;

	/*
	 * If this application is of the agent domain and this is non negative then
	 * a lookup MUST be done to acquire a read side reference to the
	 * corresponding agent app object. If the lookup fails, this should be set
	 * to a negative value indicating that the agent application is gone.
	 */
	int agent_app_sock;
};

#ifdef HAVE_LIBLTTNG_UST_CTL

int ust_app_register(struct ust_register_msg *msg, int sock);
static inline
int ust_app_register_done(int sock)
{
	return ustctl_register_done(sock);
}
int ust_app_version(struct ust_app *app);
void ust_app_unregister(int sock);
int ust_app_start_trace_all(struct ltt_ust_session *usess);
int ust_app_stop_trace_all(struct ltt_ust_session *usess);
int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
int ust_app_list_events(struct lttng_event **events);
int ust_app_list_event_fields(struct lttng_event_field **fields);
int ust_app_create_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_create_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
int ust_app_enable_event_pid(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
		pid_t pid);
int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_enable_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_disable_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
void ust_app_global_update_all(struct ltt_ust_session *usess);

void ust_app_clean_list(void);
int ust_app_ht_alloc(void);
struct ust_app *ust_app_find_by_pid(pid_t pid);
int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
struct ust_app_stream *ust_app_alloc_stream(void);
int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
int ust_app_recv_notify(int sock);
void ust_app_add(struct ust_app *app);
struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
void ust_app_notify_sock_unregister(int sock);
ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
		struct consumer_socket *socket, int send_zero_data);
void ust_app_destroy(struct ust_app *app);
int ust_app_snapshot_record(struct ltt_ust_session *usess,
		struct snapshot_output *output, int wait,
		uint64_t nb_packets_per_stream);
uint64_t ust_app_get_size_one_more_packet_per_stream(
		struct ltt_ust_session *usess, uint64_t cur_nr_packets);
struct ust_app *ust_app_find_by_sock(int sock);

static inline
int ust_app_supported(void)
{
	return 1;
}

#else /* HAVE_LIBLTTNG_UST_CTL */

static inline
int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
{
	return 0;
}
static inline
int ust_app_start_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_stop_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_list_events(struct lttng_event **events)
{
	return -ENOSYS;
}
static inline
int ust_app_list_event_fields(struct lttng_event_field **fields)
{
	return -ENOSYS;
}
static inline
int ust_app_register(struct ust_register_msg *msg, int sock)
{
	return -ENOSYS;
}
static inline
int ust_app_register_done(int sock)
{
	return -ENOSYS;
}
static inline
int ust_app_version(struct ust_app *app)
{
	return -ENOSYS;
}
static inline
void ust_app_unregister(int sock)
{
}
static inline
void ust_app_lock_list(void)
{
}
static inline
void ust_app_unlock_list(void)
{
}
static inline
void ust_app_clean_list(void)
{
}
static inline
struct ust_app_list *ust_app_get_list(void)
{
	return NULL;
}
static inline
struct ust_app *ust_app_get_by_pid(pid_t pid)
{
	return NULL;
}
static inline
int ust_app_ht_alloc(void)
{
	return 0;
}
static inline
void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
{}
static inline
int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_create_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_create_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	return 0;
}
static inline
int ust_app_disable_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	return 0;
}
static inline
int ust_app_enable_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	return 0;
}
static inline
int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
{
	return 0;
}
static inline
int ust_app_enable_event_pid(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
		pid_t pid)
{
	return 0;
}
static inline
int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
{
	return 0;
}
static inline
int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
{
	return 0;
}
static inline
int ust_app_recv_notify(int sock)
{
	return 0;
}
static inline
struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
{
	return NULL;
}
static inline
void ust_app_add(struct ust_app *app)
{
}
static inline
void ust_app_notify_sock_unregister(int sock)
{
}
static inline
ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
		struct consumer_socket *socket, int send_zero_data)
{
	return 0;
}
static inline
void ust_app_destroy(struct ust_app *app)
{
	return;
}
static inline
int ust_app_snapshot_record(struct ltt_ust_session *usess,
		struct snapshot_output *output, int wait, uint64_t max_stream_size)
{
	return 0;
}
static inline
unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
{
	return 0;
}

static inline
int ust_app_supported(void)
{
	return 0;
}
static inline
struct ust_app *ust_app_find_by_sock(int sock)
{
	return NULL;
}
static inline
struct ust_app *ust_app_find_by_pid(pid_t pid)
{
	return NULL;
}
static inline
uint64_t ust_app_get_size_one_more_packet_per_stream(
		struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
	return 0;
}

#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* _LTT_UST_APP_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License, version 2 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along
	14	* with this program; if not, write to the Free Software Foundation, Inc.,
	15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef _LTT_UST_APP_H
	19	#define _LTT_UST_APP_H
	20
	21	#include <stdint.h>
	22
	23	#include <common/compat/uuid.h>
	24
	25	#include "agent.h"
	26	#include "trace-ust.h"
	27	#include "ust-registry.h"
	28
	29	#define UST_APP_EVENT_LIST_SIZE 32
	30
	31	/* Process name (short). */
	32	#define UST_APP_PROCNAME_LEN 16
	33
	34	struct lttng_filter_bytecode;
	35	struct lttng_ust_filter_bytecode;
	36
	37	extern int ust_consumerd64_fd, ust_consumerd32_fd;
	38
	39	/*
	40	* Object used to close the notify socket in a call_rcu(). Since the
	41	* application might not be found, we need an independant object containing the
	42	* notify socket fd.
	43	*/
	44	struct ust_app_notify_sock_obj {
	45	int fd;
	46	struct rcu_head head;
	47	};
	48
	49	struct ust_app_ht_key {
	50	const char *name;
	51	const struct lttng_filter_bytecode *filter;
	52	enum lttng_ust_loglevel_type loglevel;
	53	const struct lttng_event_exclusion *exclusion;
	54	};
	55
	56	/*
	57	* Application registration data structure.
	58	*/
	59	struct ust_register_msg {
	60	enum ustctl_socket_type type;
	61	uint32_t major;
	62	uint32_t minor;
	63	uint32_t abi_major;
	64	uint32_t abi_minor;
	65	pid_t pid;
	66	pid_t ppid;
	67	uid_t uid;
	68	gid_t gid;
	69	uint32_t bits_per_long;
	70	uint32_t uint8_t_alignment;
	71	uint32_t uint16_t_alignment;
	72	uint32_t uint32_t_alignment;
	73	uint32_t uint64_t_alignment;
	74	uint32_t long_alignment;
	75	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	76	char name[LTTNG_UST_ABI_PROCNAME_LEN];
	77	};
	78
	79	/*
	80	* Global applications HT used by the session daemon. This table is indexed by
	81	* PID using the pid_n node and pid value of an ust_app.
	82	*/
	83	struct lttng_ht *ust_app_ht;
	84
	85	/*
	86	* Global applications HT used by the session daemon. This table is indexed by
	87	* socket using the sock_n node and sock value of an ust_app.
	88	*/
	89	struct lttng_ht *ust_app_ht_by_sock;
	90
	91	/*
	92	* Global applications HT used by the session daemon. This table is indexed by
	93	* socket using the notify_sock_n node and notify_sock value of an ust_app.
	94	*/
	95	struct lttng_ht *ust_app_ht_by_notify_sock;
	96
	97	/* Stream list containing ust_app_stream. */
	98	struct ust_app_stream_list {
	99	unsigned int count;
	100	struct cds_list_head head;
	101	};
	102
	103	struct ust_app_ctx {
	104	int handle;
	105	struct lttng_ust_context ctx;
	106	struct lttng_ust_object_data *obj;
	107	struct lttng_ht_node_ulong node;
	108	struct cds_list_head list;
	109	};
	110
	111	struct ust_app_event {
	112	int enabled;
	113	int handle;
	114	struct lttng_ust_object_data *obj;
	115	struct lttng_ust_event attr;
	116	char name[LTTNG_UST_SYM_NAME_LEN];
	117	struct lttng_ht_node_str node;
	118	struct lttng_filter_bytecode *filter;
	119	struct lttng_event_exclusion *exclusion;
	120	};
	121
	122	struct ust_app_stream {
	123	int handle;
	124	char pathname[PATH_MAX];
	125	/* Format is %s_%d respectively channel name and CPU number. */
	126	char name[DEFAULT_STREAM_NAME_LEN];
	127	struct lttng_ust_object_data *obj;
	128	/* Using a list of streams to keep order. */
	129	struct cds_list_head list;
	130	};
	131
	132	struct ust_app_channel {
	133	int enabled;
	134	int handle;
	135	/* Channel and streams were sent to the UST tracer. */
	136	int is_sent;
	137	/* Unique key used to identify the channel on the consumer side. */
	138	uint64_t key;
	139	/* Id of the tracing channel set on creation. */
	140	uint64_t tracing_channel_id;
	141	/* Number of stream that this channel is expected to receive. */
	142	unsigned int expected_stream_count;
	143	char name[LTTNG_UST_SYM_NAME_LEN];
	144	struct lttng_ust_object_data *obj;
	145	struct ustctl_consumer_channel_attr attr;
	146	struct ust_app_stream_list streams;
	147	/* Session pointer that owns this object. */
	148	struct ust_app_session *session;
	149	/*
	150	* Contexts are kept in a hash table for fast lookup and in an ordered list
	151	* so we are able to enable them on the tracer side in the same order the
	152	* user added them.
	153	*/
	154	struct lttng_ht *ctx;
	155	struct cds_list_head ctx_list;
	156
	157	struct lttng_ht *events;
	158	uint64_t tracefile_size;
	159	uint64_t tracefile_count;
	160	/*
	161	* Node indexed by channel name in the channels' hash table of a session.
	162	*/
	163	struct lttng_ht_node_str node;
	164	/*
	165	* Node indexed by UST channel object descriptor (handle). Stored in the
	166	* ust_objd hash table in the ust_app object.
	167	*/
	168	struct lttng_ht_node_ulong ust_objd_node;
	169	/* For delayed reclaim */
	170	struct rcu_head rcu_head;
	171	};
	172
	173	struct ust_app_session {
	174	/*
	175	* Lock protecting this session's ust app interaction. Held
	176	* across command send/recv to/from app. Never nests within the
	177	* session registry lock.
	178	*/
	179	pthread_mutex_t lock;
	180
	181	int enabled;
	182	/* started: has the session been in started state at any time ? */
	183	int started; /* allows detection of start vs restart. */
	184	int handle; /* used has unique identifier for app session */
	185
	186	bool deleted; /* Session deleted flag. Check with lock held. */
	187
	188	/*
	189	* Tracing session ID. Multiple ust app session can have the same tracing
	190	* session id making this value NOT unique to the object.
	191	*/
	192	uint64_t tracing_id;
	193	uint64_t id; /* Unique session identifier */
	194	struct lttng_ht channels; / Registered channels */
	195	struct lttng_ht_node_u64 node;
	196	char path[PATH_MAX];
	197	/* UID/GID of the application owning the session */
	198	uid_t uid;
	199	gid_t gid;
	200	/* Effective UID and GID. Same as the tracing session. */
	201	uid_t euid;
	202	gid_t egid;
	203	struct cds_list_head teardown_node;
	204	/*
	205	* Once at least one session is created onto the application, the
	206	* corresponding consumer is set so we can use it on unregistration.
	207	*/
	208	struct consumer_output *consumer;
	209	enum lttng_buffer_type buffer_type;
	210	/* ABI of the session. Same value as the application. */
	211	uint32_t bits_per_long;
	212	/* For delayed reclaim */
	213	struct rcu_head rcu_head;
	214	/* If the channel's streams have to be outputed or not. */
	215	unsigned int output_traces;
	216	unsigned int live_timer_interval; /* usec */
	217
	218	/* Metadata channel attributes. */
	219	struct ustctl_consumer_channel_attr metadata_attr;
	220
	221	char root_shm_path[PATH_MAX];
	222	char shm_path[PATH_MAX];
	223	};
	224
	225	/*
	226	* Registered traceable applications. Libust registers to the session daemon
	227	* and a linked list is kept of all running traceable app.
	228	*/
	229	struct ust_app {
	230	int sock;
	231	int notify_sock;
	232	pid_t pid;
	233	pid_t ppid;
	234	uid_t uid; /* User ID that owns the apps */
	235	gid_t gid; /* Group ID that owns the apps */
	236
	237	/* App ABI */
	238	uint32_t bits_per_long;
	239	uint32_t uint8_t_alignment;
	240	uint32_t uint16_t_alignment;
	241	uint32_t uint32_t_alignment;
	242	uint32_t uint64_t_alignment;
	243	uint32_t long_alignment;
	244	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	245
	246	int compatible; /* If the lttng-ust tracer version does not match the
	247	supported version of the session daemon, this flag is
	248	set to 0 (NOT compatible) else 1. */
	249	struct lttng_ust_tracer_version version;
	250	uint32_t v_major; /* Version major number */
	251	uint32_t v_minor; /* Version minor number */
	252	/* Extra for the NULL byte. */
	253	char name[UST_APP_PROCNAME_LEN + 1];
	254	/* Type of buffer this application uses. */
	255	enum lttng_buffer_type buffer_type;
	256	struct lttng_ht *sessions;
	257	struct lttng_ht_node_ulong pid_n;
	258	struct lttng_ht_node_ulong sock_n;
	259	struct lttng_ht_node_ulong notify_sock_n;
	260	/*
	261	* This is a list of ust app session that, once the app is going into
	262	* teardown mode, in the RCU call, each node in this list is removed and
	263	* deleted.
	264	*
	265	* Element of the list are added when an application unregisters after each
	266	* ht_del of ust_app_session associated to this app. This list is NOT used
	267	* when a session is destroyed.
	268	*/
	269	struct cds_list_head teardown_head;
	270	/*
	271	* Hash table containing ust_app_channel indexed by channel objd.
	272	*/
	273	struct lttng_ht *ust_objd;
	274
	275	/*
	276	* If this application is of the agent domain and this is non negative then
	277	* a lookup MUST be done to acquire a read side reference to the
	278	* corresponding agent app object. If the lookup fails, this should be set
	279	* to a negative value indicating that the agent application is gone.
	280	*/
	281	int agent_app_sock;
	282	};
	283
	284	#ifdef HAVE_LIBLTTNG_UST_CTL
	285
	286	int ust_app_register(struct ust_register_msg *msg, int sock);
	287	static inline
	288	int ust_app_register_done(int sock)
	289	{
	290	return ustctl_register_done(sock);
	291	}
	292	int ust_app_version(struct ust_app *app);
	293	void ust_app_unregister(int sock);
	294	int ust_app_start_trace_all(struct ltt_ust_session *usess);
	295	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
	296	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
	297	int ust_app_list_events(struct lttng_event **events);
	298	int ust_app_list_event_fields(struct lttng_event_field **fields);
	299	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	300	struct ltt_ust_channel *uchan);
	301	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	302	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	303	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	304	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	305	pid_t pid);
	306	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
	307	struct ltt_ust_channel *uchan);
	308	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
	309	struct ltt_ust_channel *uchan);
	310	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
	311	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	312	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
	313	struct ltt_ust_channel *uchan);
	314	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
	315	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	316	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	317	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
	318	void ust_app_global_update(struct ltt_ust_session usess, struct ust_app app);
	319	void ust_app_global_update_all(struct ltt_ust_session *usess);
	320
	321	void ust_app_clean_list(void);
	322	int ust_app_ht_alloc(void);
	323	struct ust_app *ust_app_find_by_pid(pid_t pid);
	324	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
	325	struct ust_app_stream *ust_app_alloc_stream(void);
	326	int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
	327	int ust_app_recv_notify(int sock);
	328	void ust_app_add(struct ust_app *app);
	329	struct ust_app ust_app_create(struct ust_register_msg msg, int sock);
	330	void ust_app_notify_sock_unregister(int sock);
	331	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
	332	struct consumer_socket *socket, int send_zero_data);
	333	void ust_app_destroy(struct ust_app *app);
	334	int ust_app_snapshot_record(struct ltt_ust_session *usess,
	335	struct snapshot_output *output, int wait,
	336	uint64_t nb_packets_per_stream);
	337	uint64_t ust_app_get_size_one_more_packet_per_stream(
	338	struct ltt_ust_session *usess, uint64_t cur_nr_packets);
	339	struct ust_app *ust_app_find_by_sock(int sock);
	340
	341	static inline
	342	int ust_app_supported(void)
	343	{
	344	return 1;
	345	}
	346
	347	#else /* HAVE_LIBLTTNG_UST_CTL */
	348
	349	static inline
	350	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	351	{
	352	return 0;
	353	}
	354	static inline
	355	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	356	{
	357	return 0;
	358	}
	359	static inline
	360	int ust_app_start_trace_all(struct ltt_ust_session *usess)
	361	{
	362	return 0;
	363	}
	364	static inline
	365	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	366	{
	367	return 0;
	368	}
	369	static inline
	370	int ust_app_list_events(struct lttng_event **events)
	371	{
	372	return -ENOSYS;
	373	}
	374	static inline
	375	int ust_app_list_event_fields(struct lttng_event_field **fields)
	376	{
	377	return -ENOSYS;
	378	}
	379	static inline
	380	int ust_app_register(struct ust_register_msg *msg, int sock)
	381	{
	382	return -ENOSYS;
	383	}
	384	static inline
	385	int ust_app_register_done(int sock)
	386	{
	387	return -ENOSYS;
	388	}
	389	static inline
	390	int ust_app_version(struct ust_app *app)
	391	{
	392	return -ENOSYS;
	393	}
	394	static inline
	395	void ust_app_unregister(int sock)
	396	{
	397	}
	398	static inline
	399	void ust_app_lock_list(void)
	400	{
	401	}
	402	static inline
	403	void ust_app_unlock_list(void)
	404	{
	405	}
	406	static inline
	407	void ust_app_clean_list(void)
	408	{
	409	}
	410	static inline
	411	struct ust_app_list *ust_app_get_list(void)
	412	{
	413	return NULL;
	414	}
	415	static inline
	416	struct ust_app *ust_app_get_by_pid(pid_t pid)
	417	{
	418	return NULL;
	419	}
	420	static inline
	421	int ust_app_ht_alloc(void)
	422	{
	423	return 0;
	424	}
	425	static inline
	426	void ust_app_global_update(struct ltt_ust_session usess, struct ust_app app)
	427	{}
	428	static inline
	429	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
	430	struct ltt_ust_channel *uchan)
	431	{
	432	return 0;
	433	}
	434	static inline
	435	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
	436	struct ltt_ust_channel *uchan)
	437	{
	438	return 0;
	439	}
	440	static inline
	441	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	442	struct ltt_ust_channel *uchan)
	443	{
	444	return 0;
	445	}
	446	static inline
	447	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
	448	struct ltt_ust_channel *uchan)
	449	{
	450	return 0;
	451	}
	452	static inline
	453	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	454	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	455	{
	456	return 0;
	457	}
	458	static inline
	459	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
	460	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	461	{
	462	return 0;
	463	}
	464	static inline
	465	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
	466	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	467	{
	468	return 0;
	469	}
	470	static inline
	471	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	472	struct ltt_ust_channel uchan, struct ltt_ust_context uctx)
	473	{
	474	return 0;
	475	}
	476	static inline
	477	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	478	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	479	pid_t pid)
	480	{
	481	return 0;
	482	}
	483	static inline
	484	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
	485	{
	486	return 0;
	487	}
	488	static inline
	489	int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
	490	{
	491	return 0;
	492	}
	493	static inline
	494	int ust_app_recv_notify(int sock)
	495	{
	496	return 0;
	497	}
	498	static inline
	499	struct ust_app ust_app_create(struct ust_register_msg msg, int sock)
	500	{
	501	return NULL;
	502	}
	503	static inline
	504	void ust_app_add(struct ust_app *app)
	505	{
	506	}
	507	static inline
	508	void ust_app_notify_sock_unregister(int sock)
	509	{
	510	}
	511	static inline
	512	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
	513	struct consumer_socket *socket, int send_zero_data)
	514	{
	515	return 0;
	516	}
	517	static inline
	518	void ust_app_destroy(struct ust_app *app)
	519	{
	520	return;
	521	}
	522	static inline
	523	int ust_app_snapshot_record(struct ltt_ust_session *usess,
	524	struct snapshot_output *output, int wait, uint64_t max_stream_size)
	525	{
	526	return 0;
	527	}
	528	static inline
	529	unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
	530	{
	531	return 0;
	532	}
	533
	534	static inline
	535	int ust_app_supported(void)
	536	{
	537	return 0;
	538	}
	539	static inline
	540	struct ust_app *ust_app_find_by_sock(int sock)
	541	{
	542	return NULL;
	543	}
	544	static inline
	545	struct ust_app *ust_app_find_by_pid(pid_t pid)
	546	{
	547	return NULL;
	548	}
	549	static inline
	550	uint64_t ust_app_get_size_one_more_packet_per_stream(
	551	struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
	552	return 0;
	553	}
	554
	555	#endif /* HAVE_LIBLTTNG_UST_CTL */
	556
	557	#endif /* _LTT_UST_APP_H */