[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 "jul.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;
	unsigned int live_timer_interval;	/* usec */
};

/*
 * 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 JUL domain and this is non negative then a
	 * lookup MUST be done to acquire a read side reference to the
	 * corresponding JUL app object. If the lookup fails, this should be set to
	 * a negative value indicating that the JUL application is gone.
	 */
	int jul_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);
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);
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
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;
}
static inline
struct ust_app *ust_app_find_by_sock(int sock)
{
	return NULL;
}

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