[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 "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_ust_filter_bytecode *filter;
	enum lttng_ust_loglevel_type loglevel;
};

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

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 */

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

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

#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);
unsigned long ust_app_list_count(void);
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_disable_event_pid(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
		pid_t pid);
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_disable_all_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
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, int sock);

void ust_app_clean_list(void);
void ust_app_ht_alloc(void);
struct lttng_ht *ust_app_get_ht(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, unsigned int nb_streams);
unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess);

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
unsigned int ust_app_list_count(void)
{
	return 0;
}
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
struct lttng_ht *ust_app_get_ht(void)
{
	return NULL;
}
static inline
void ust_app_ht_alloc(void)
{}
static inline
void ust_app_global_update(struct ltt_ust_session *usess, int sock)
{}
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_disable_all_event_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_disable_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, unsigned int nb_stream)
{
	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;
}

#endif /* HAVE_LIBLTTNG_UST_CTL */

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