[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_ust_filter_bytecode *filter;
	enum lttng_ust_loglevel_type loglevel;
	const struct lttng_ust_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_ust_filter_bytecode *filter;
	struct lttng_ust_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 */

	/*
	 * 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 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, int sock);

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, 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_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
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	24
022d91ba	25	#include "agent.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;
0c53bbad	53	const struct lttng_ust_event_exclusion *exclusion;
18eace3b DG	54	};
18eace3b DG	55
099e26bd DG	56	/*
	57	* Application registration data structure.
	58	*/
	59	struct ust_register_msg {
d0b96690	60	enum ustctl_socket_type type;
099e26bd DG	61	uint32_t major;
099e26bd DG	62	uint32_t minor;
d0b96690 DG	63	uint32_t abi_major;
d0b96690 DG	64	uint32_t abi_minor;
099e26bd DG	65	pid_t pid;
	66	pid_t ppid;
	67	uid_t uid;
	68	gid_t gid;
0df502fd	69	uint32_t bits_per_long;
d0b96690 DG	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];
099e26bd DG	77	};
099e26bd DG	78
48842b30	79	/*
852d0037 DG	80	* Global applications HT used by the session daemon. This table is indexed by
852d0037 DG	81	* PID using the pid_n node and pid value of an ust_app.
48842b30	82	*/
bec39940	83	struct lttng_ht *ust_app_ht;
f6a9efaa	84
852d0037 DG	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;
91d76f53	90
d0b96690 DG	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
030a66fa DG	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
55cc08a6 DG	103	struct ust_app_ctx {
	104	int handle;
	105	struct lttng_ust_context ctx;
	106	struct lttng_ust_object_data *obj;
bec39940	107	struct lttng_ht_node_ulong node;
31746f93	108	struct cds_list_head list;
55cc08a6 DG	109	};
55cc08a6 DG	110
48842b30 DG	111	struct ust_app_event {
	112	int enabled;
	113	int handle;
13161846	114	struct lttng_ust_object_data *obj;
284d8f55	115	struct lttng_ust_event attr;
48842b30	116	char name[LTTNG_UST_SYM_NAME_LEN];
bec39940	117	struct lttng_ht_node_str node;
53a80697	118	struct lttng_ust_filter_bytecode *filter;
0c53bbad	119	struct lttng_ust_event_exclusion *exclusion;
48842b30 DG	120	};
48842b30 DG	121
030a66fa DG	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
48842b30 DG	132	struct ust_app_channel {
	133	int enabled;
	134	int handle;
ffe60014 DG	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. */
d88aee68	138	uint64_t key;
7972aab2 DG	139	/* Id of the tracing channel set on creation. */
7972aab2 DG	140	uint64_t tracing_channel_id;
ffe60014 DG	141	/* Number of stream that this channel is expected to receive. */
ffe60014 DG	142	unsigned int expected_stream_count;
48842b30	143	char name[LTTNG_UST_SYM_NAME_LEN];
13161846	144	struct lttng_ust_object_data *obj;
ffe60014	145	struct ustctl_consumer_channel_attr attr;
030a66fa	146	struct ust_app_stream_list streams;
d0b96690 DG	147	/* Session pointer that owns this object. */
d0b96690 DG	148	struct ust_app_session *session;
31746f93 DG	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	*/
bec39940	154	struct lttng_ht *ctx;
31746f93 DG	155	struct cds_list_head ctx_list;
31746f93 DG	156
bec39940	157	struct lttng_ht *events;
1624d5b7 JD	158	uint64_t tracefile_size;
1624d5b7 JD	159	uint64_t tracefile_count;
d0b96690 DG	160	/*
	161	* Node indexed by channel name in the channels' hash table of a session.
	162	*/
bec39940	163	struct lttng_ht_node_str node;
d0b96690 DG	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;
36b588ed MD	169	/* For delayed reclaim */
36b588ed MD	170	struct rcu_head rcu_head;
48842b30 DG	171	};
	172
	173	struct ust_app_session {
d0b96690 DG	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
48842b30	181	int enabled;
8be98f9a MD	182	/* started: has the session been in started state at any time ? */
8be98f9a MD	183	int started; /* allows detection of start vs restart. */
a991f516	184	int handle; /* used has unique identifier for app session */
7972aab2 DG	185
	186	/*
	187	* Tracing session ID. Multiple ust app session can have the same tracing
	188	* session id making this value NOT unique to the object.
	189	*/
d9bf3ca4	190	uint64_t tracing_id;
7972aab2	191	uint64_t id; /* Unique session identifier */
bec39940	192	struct lttng_ht channels; / Registered channels */
d9bf3ca4	193	struct lttng_ht_node_u64 node;
bec39940	194	char path[PATH_MAX];
7972aab2	195	/* UID/GID of the application owning the session */
6df2e2c9 MD	196	uid_t uid;
6df2e2c9 MD	197	gid_t gid;
7972aab2 DG	198	/* Effective UID and GID. Same as the tracing session. */
	199	uid_t euid;
	200	gid_t egid;
d42f20df	201	struct cds_list_head teardown_node;
d88aee68 DG	202	/*
	203	* Once at least one session is created onto the application, the
	204	* corresponding consumer is set so we can use it on unregistration.
	205	*/
	206	struct consumer_output *consumer;
7972aab2 DG	207	enum lttng_buffer_type buffer_type;
	208	/* ABI of the session. Same value as the application. */
	209	uint32_t bits_per_long;
36b588ed MD	210	/* For delayed reclaim */
36b588ed MD	211	struct rcu_head rcu_head;
2bba9e53 DG	212	/* If the channel's streams have to be outputed or not. */
2bba9e53 DG	213	unsigned int output_traces;
ecc48a90	214	unsigned int live_timer_interval; /* usec */
ad7a9107 DG	215
	216	/* Metadata channel attributes. */
	217	struct ustctl_consumer_channel_attr metadata_attr;
d7ba1388 MD	218
d7ba1388 MD	219	char shm_path[PATH_MAX];
48842b30 DG	220	};
48842b30 DG	221
f6a9efaa DG	222	/*
f6a9efaa DG	223	* Registered traceable applications. Libust registers to the session daemon
050349bb	224	* and a linked list is kept of all running traceable app.
91d76f53	225	*/
56fff090	226	struct ust_app {
852d0037	227	int sock;
d0b96690	228	int notify_sock;
852d0037	229	pid_t pid;
099e26bd DG	230	pid_t ppid;
099e26bd DG	231	uid_t uid; /* User ID that owns the apps */
aea829b3	232	gid_t gid; /* Group ID that owns the apps */
d0b96690 DG	233
	234	/* App ABI */
	235	uint32_t bits_per_long;
	236	uint32_t uint8_t_alignment;
	237	uint32_t uint16_t_alignment;
	238	uint32_t uint32_t_alignment;
	239	uint32_t uint64_t_alignment;
	240	uint32_t long_alignment;
	241	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	242
e0c7ec2b DG	243	int compatible; /* If the lttng-ust tracer version does not match the
	244	supported version of the session daemon, this flag is
	245	set to 0 (NOT compatible) else 1. */
	246	struct lttng_ust_tracer_version version;
d0b96690 DG	247	uint32_t v_major; /* Version major number */
d0b96690 DG	248	uint32_t v_minor; /* Version minor number */
d88aee68 DG	249	/* Extra for the NULL byte. */
d88aee68 DG	250	char name[UST_APP_PROCNAME_LEN + 1];
7972aab2 DG	251	/* Type of buffer this application uses. */
7972aab2 DG	252	enum lttng_buffer_type buffer_type;
bec39940	253	struct lttng_ht *sessions;
852d0037 DG	254	struct lttng_ht_node_ulong pid_n;
852d0037 DG	255	struct lttng_ht_node_ulong sock_n;
d0b96690	256	struct lttng_ht_node_ulong notify_sock_n;
d42f20df DG	257	/*
	258	* This is a list of ust app session that, once the app is going into
	259	* teardown mode, in the RCU call, each node in this list is removed and
	260	* deleted.
	261	*
	262	* Element of the list are added when an application unregisters after each
	263	* ht_del of ust_app_session associated to this app. This list is NOT used
	264	* when a session is destroyed.
	265	*/
	266	struct cds_list_head teardown_head;
d0b96690 DG	267	/*
	268	* Hash table containing ust_app_channel indexed by channel objd.
	269	*/
	270	struct lttng_ht *ust_objd;
022d91ba	271
f20baf8e	272	/*
022d91ba DG	273	* If this application is of the agent domain and this is non negative then
	274	* a lookup MUST be done to acquire a read side reference to the
	275	* corresponding agent app object. If the lookup fails, this should be set
	276	* to a negative value indicating that the agent application is gone.
f20baf8e	277	*/
022d91ba	278	int agent_app_sock;
91d76f53 DG	279	};
91d76f53 DG	280
74d0b642	281	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	282
56fff090	283	int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25 GF	284	static inline
	285	int ust_app_register_done(int sock)
	286	{
	287	return ustctl_register_done(sock);
	288	}
d0b96690	289	int ust_app_version(struct ust_app *app);
56fff090	290	void ust_app_unregister(int sock);
421cb601	291	int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a	292	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6	293	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063	294	int ust_app_list_events(struct lttng_event **events);
f37d259d	295	int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d DG	296	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	297	struct ltt_ust_channel *uchan);
	298	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	299	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
76d45b40 DG	300	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	301	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	302	pid_t pid);
35a9059d	303	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	304	struct ltt_ust_channel *uchan);
35a9059d	305	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	306	struct ltt_ust_channel *uchan);
35a9059d	307	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388	308	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
35a9059d	309	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e	310	struct ltt_ust_channel *uchan);
35a9059d DG	311	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
35a9059d DG	312	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
55cc08a6 DG	313	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
55cc08a6 DG	314	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
487cf67c	315	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53	316
56fff090	317	void ust_app_clean_list(void);
57703f6e	318	int ust_app_ht_alloc(void);
f6a9efaa	319	struct ust_app *ust_app_find_by_pid(pid_t pid);
4466912f	320	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
ffe60014	321	struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690 DG	322	int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
	323	int ust_app_recv_notify(int sock);
	324	void ust_app_add(struct ust_app *app);
	325	struct ust_app ust_app_create(struct ust_register_msg msg, int sock);
d88aee68	326	void ust_app_notify_sock_unregister(int sock);
331744e3 JD	327	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
331744e3 JD	328	struct consumer_socket *socket, int send_zero_data);
f45e313d	329	void ust_app_destroy(struct ust_app *app);
6dc3064a	330	int ust_app_snapshot_record(struct ltt_ust_session *usess,
d07ceecd MD	331	struct snapshot_output *output, int wait,
d07ceecd MD	332	uint64_t nb_packets_per_stream);
16f35901 JG	333	uint64_t ust_app_get_size_one_more_packet_per_stream(
16f35901 JG	334	struct ltt_ust_session *usess, uint64_t cur_nr_packets);
f20baf8e	335	struct ust_app *ust_app_find_by_sock(int sock);
44d3bd01	336
b51ec5b4 MD	337	static inline
	338	int ust_app_supported(void)
	339	{
	340	return 1;
	341	}
	342
74d0b642	343	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	344
cc920def DG	345	static inline
	346	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	347	{
	348	return 0;
	349	}
d974f197	350	static inline
421cb601 DG	351	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	352	{
	353	return 0;
	354	}
	355	static inline
	356	int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197	357	{
5cf5d0e7	358	return 0;
d974f197	359	}
3bd1e081	360	static inline
cc920def DG	361	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	362	{
	363	return 0;
	364	}
	365	static inline
b551a063 DG	366	int ust_app_list_events(struct lttng_event **events)
b551a063 DG	367	{
db7c0497	368	return -ENOSYS;
b551a063 DG	369	}
b551a063 DG	370	static inline
da0bdb87 MD	371	int ust_app_list_event_fields(struct lttng_event_field **fields)
	372	{
	373	return -ENOSYS;
	374	}
	375	static inline
3bd1e081 MD	376	int ust_app_register(struct ust_register_msg *msg, int sock)
	377	{
	378	return -ENOSYS;
	379	}
	380	static inline
f2ca2e25 GF	381	int ust_app_register_done(int sock)
	382	{
	383	return -ENOSYS;
	384	}
	385	static inline
d0b96690 DG	386	int ust_app_version(struct ust_app *app)
	387	{
	388	return -ENOSYS;
	389	}
	390	static inline
3bd1e081 MD	391	void ust_app_unregister(int sock)
	392	{
	393	}
	394	static inline
3bd1e081 MD	395	void ust_app_lock_list(void)
	396	{
	397	}
	398	static inline
	399	void ust_app_unlock_list(void)
	400	{
	401	}
	402	static inline
	403	void ust_app_clean_list(void)
	404	{
	405	}
	406	static inline
	407	struct ust_app_list *ust_app_get_list(void)
	408	{
	409	return NULL;
	410	}
	411	static inline
	412	struct ust_app *ust_app_get_by_pid(pid_t pid)
	413	{
	414	return NULL;
	415	}
48842b30	416	static inline
12a84043 JG	417	int ust_app_ht_alloc(void)
	418	{
	419	return 0;
	420	}
cc920def DG	421	static inline
	422	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	423	{}
	424	static inline
35a9059d	425	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def	426	struct ltt_ust_channel *uchan)
d974f197	427	{
cc920def	428	return 0;
d974f197	429	}
487cf67c	430	static inline
35a9059d	431	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def	432	struct ltt_ust_channel *uchan)
487cf67c	433	{
cc920def DG	434	return 0;
	435	}
	436	static inline
35a9059d	437	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def DG	438	struct ltt_ust_channel *uchan)
	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	479	static inline
d0b96690	480	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
e0c7ec2b DG	481	{
	482	return 0;
	483	}
4466912f	484	static inline
d0b96690 DG	485	int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
	486	{
	487	return 0;
	488	}
	489	static inline
	490	int ust_app_recv_notify(int sock)
4466912f DG	491	{
	492	return 0;
	493	}
d0b96690 DG	494	static inline
	495	struct ust_app ust_app_create(struct ust_register_msg msg, int sock)
	496	{
	497	return NULL;
	498	}
	499	static inline
	500	void ust_app_add(struct ust_app *app)
	501	{
	502	}
d88aee68 DG	503	static inline
	504	void ust_app_notify_sock_unregister(int sock)
	505	{
	506	}
331744e3 JD	507	static inline
	508	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
	509	struct consumer_socket *socket, int send_zero_data)
	510	{
	511	return 0;
	512	}
f45e313d DG	513	static inline
	514	void ust_app_destroy(struct ust_app *app)
	515	{
	516	return;
	517	}
6dc3064a DG	518	static inline
6dc3064a DG	519	int ust_app_snapshot_record(struct ltt_ust_session *usess,
68808f4e	520	struct snapshot_output *output, int wait, uint64_t max_stream_size)
5c786ded JD	521	{
	522	return 0;
	523	}
	524	static inline
	525	unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
6dc3064a DG	526	{
	527	return 0;
	528	}
48842b30	529
b51ec5b4 MD	530	static inline
	531	int ust_app_supported(void)
	532	{
	533	return 0;
	534	}
f20baf8e DG	535	static inline
	536	struct ust_app *ust_app_find_by_sock(int sock)
	537	{
	538	return NULL;
	539	}
95b1d17c DG	540	static inline
	541	struct ust_app *ust_app_find_by_pid(pid_t pid)
	542	{
	543	return NULL;
	544	}
16f35901 JG	545	static inline
	546	uint64_t ust_app_get_size_one_more_packet_per_stream(
	547	struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
	548	return 0;
	549	}
b51ec5b4	550
74d0b642	551	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	552
f6a9efaa	553	#endif /* _LTT_UST_APP_H */