[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 root_shm_path[PATH_MAX];
	char shm_path[PATH_MAX];
};

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

	/* App ABI */
	uint32_t bits_per_long;
	uint32_t uint8_t_alignment;
	uint32_t uint16_t_alignment;
	uint32_t uint32_t_alignment;
	uint32_t uint64_t_alignment;
	uint32_t long_alignment;
	int byte_order;		/* BIG_ENDIAN or LITTLE_ENDIAN */

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

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

#ifdef HAVE_LIBLTTNG_UST_CTL

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

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

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

#else /* HAVE_LIBLTTNG_UST_CTL */

static inline
int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
{
	return 0;
}
static inline
int ust_app_start_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_stop_trace_all(struct ltt_ust_session *usess)
{
	return 0;
}
static inline
int ust_app_list_events(struct lttng_event **events)
{
	return -ENOSYS;
}
static inline
int ust_app_list_event_fields(struct lttng_event_field **fields)
{
	return -ENOSYS;
}
static inline
int ust_app_register(struct ust_register_msg *msg, int sock)
{
	return -ENOSYS;
}
static inline
int ust_app_register_done(int sock)
{
	return -ENOSYS;
}
static inline
int ust_app_version(struct ust_app *app)
{
	return -ENOSYS;
}
static inline
void ust_app_unregister(int sock)
{
}
static inline
void ust_app_lock_list(void)
{
}
static inline
void ust_app_unlock_list(void)
{
}
static inline
void ust_app_clean_list(void)
{
}
static inline
struct ust_app_list *ust_app_get_list(void)
{
	return NULL;
}
static inline
struct ust_app *ust_app_get_by_pid(pid_t pid)
{
	return NULL;
}
static inline
int ust_app_ht_alloc(void)
{
	return 0;
}
static inline
void ust_app_global_update(struct ltt_ust_session *usess, 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	218
3d071855	219	char root_shm_path[PATH_MAX];
d7ba1388	220	char shm_path[PATH_MAX];
48842b30 DG	221	};
48842b30 DG	222
f6a9efaa DG	223	/*
f6a9efaa DG	224	* Registered traceable applications. Libust registers to the session daemon
050349bb	225	* and a linked list is kept of all running traceable app.
91d76f53	226	*/
56fff090	227	struct ust_app {
852d0037	228	int sock;
d0b96690	229	int notify_sock;
852d0037	230	pid_t pid;
099e26bd DG	231	pid_t ppid;
099e26bd DG	232	uid_t uid; /* User ID that owns the apps */
aea829b3	233	gid_t gid; /* Group ID that owns the apps */
d0b96690 DG	234
	235	/* App ABI */
	236	uint32_t bits_per_long;
	237	uint32_t uint8_t_alignment;
	238	uint32_t uint16_t_alignment;
	239	uint32_t uint32_t_alignment;
	240	uint32_t uint64_t_alignment;
	241	uint32_t long_alignment;
	242	int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
	243
e0c7ec2b DG	244	int compatible; /* If the lttng-ust tracer version does not match the
	245	supported version of the session daemon, this flag is
	246	set to 0 (NOT compatible) else 1. */
	247	struct lttng_ust_tracer_version version;
d0b96690 DG	248	uint32_t v_major; /* Version major number */
d0b96690 DG	249	uint32_t v_minor; /* Version minor number */
d88aee68 DG	250	/* Extra for the NULL byte. */
d88aee68 DG	251	char name[UST_APP_PROCNAME_LEN + 1];
7972aab2 DG	252	/* Type of buffer this application uses. */
7972aab2 DG	253	enum lttng_buffer_type buffer_type;
bec39940	254	struct lttng_ht *sessions;
852d0037 DG	255	struct lttng_ht_node_ulong pid_n;
852d0037 DG	256	struct lttng_ht_node_ulong sock_n;
d0b96690	257	struct lttng_ht_node_ulong notify_sock_n;
d42f20df DG	258	/*
	259	* This is a list of ust app session that, once the app is going into
	260	* teardown mode, in the RCU call, each node in this list is removed and
	261	* deleted.
	262	*
	263	* Element of the list are added when an application unregisters after each
	264	* ht_del of ust_app_session associated to this app. This list is NOT used
	265	* when a session is destroyed.
	266	*/
	267	struct cds_list_head teardown_head;
d0b96690 DG	268	/*
	269	* Hash table containing ust_app_channel indexed by channel objd.
	270	*/
	271	struct lttng_ht *ust_objd;
022d91ba	272
f20baf8e	273	/*
022d91ba DG	274	* If this application is of the agent domain and this is non negative then
	275	* a lookup MUST be done to acquire a read side reference to the
	276	* corresponding agent app object. If the lookup fails, this should be set
	277	* to a negative value indicating that the agent application is gone.
f20baf8e	278	*/
022d91ba	279	int agent_app_sock;
91d76f53 DG	280	};
91d76f53 DG	281
74d0b642	282	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	283
56fff090	284	int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25 GF	285	static inline
	286	int ust_app_register_done(int sock)
	287	{
	288	return ustctl_register_done(sock);
	289	}
d0b96690	290	int ust_app_version(struct ust_app *app);
56fff090	291	void ust_app_unregister(int sock);
421cb601	292	int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a	293	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6	294	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063	295	int ust_app_list_events(struct lttng_event **events);
f37d259d	296	int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d DG	297	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	298	struct ltt_ust_channel *uchan);
	299	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	300	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
76d45b40 DG	301	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	302	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	303	pid_t pid);
35a9059d	304	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	305	struct ltt_ust_channel *uchan);
35a9059d	306	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	307	struct ltt_ust_channel *uchan);
35a9059d	308	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388	309	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
35a9059d	310	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e	311	struct ltt_ust_channel *uchan);
35a9059d DG	312	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
35a9059d DG	313	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
55cc08a6 DG	314	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
55cc08a6 DG	315	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
a9ad0c8f MD	316	void ust_app_global_update(struct ltt_ust_session usess, struct ust_app app);
a9ad0c8f MD	317	void ust_app_global_update_all(struct ltt_ust_session *usess);
91d76f53	318
56fff090	319	void ust_app_clean_list(void);
57703f6e	320	int ust_app_ht_alloc(void);
f6a9efaa	321	struct ust_app *ust_app_find_by_pid(pid_t pid);
4466912f	322	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
ffe60014	323	struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690 DG	324	int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
	325	int ust_app_recv_notify(int sock);
	326	void ust_app_add(struct ust_app *app);
	327	struct ust_app ust_app_create(struct ust_register_msg msg, int sock);
d88aee68	328	void ust_app_notify_sock_unregister(int sock);
331744e3 JD	329	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
331744e3 JD	330	struct consumer_socket *socket, int send_zero_data);
f45e313d	331	void ust_app_destroy(struct ust_app *app);
6dc3064a	332	int ust_app_snapshot_record(struct ltt_ust_session *usess,
d07ceecd MD	333	struct snapshot_output *output, int wait,
d07ceecd MD	334	uint64_t nb_packets_per_stream);
16f35901 JG	335	uint64_t ust_app_get_size_one_more_packet_per_stream(
16f35901 JG	336	struct ltt_ust_session *usess, uint64_t cur_nr_packets);
f20baf8e	337	struct ust_app *ust_app_find_by_sock(int sock);
44d3bd01	338
b51ec5b4 MD	339	static inline
	340	int ust_app_supported(void)
	341	{
	342	return 1;
	343	}
	344
74d0b642	345	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	346
cc920def DG	347	static inline
	348	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	349	{
	350	return 0;
	351	}
d974f197	352	static inline
421cb601 DG	353	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	354	{
	355	return 0;
	356	}
	357	static inline
	358	int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197	359	{
5cf5d0e7	360	return 0;
d974f197	361	}
3bd1e081	362	static inline
cc920def DG	363	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	364	{
	365	return 0;
	366	}
	367	static inline
b551a063 DG	368	int ust_app_list_events(struct lttng_event **events)
b551a063 DG	369	{
db7c0497	370	return -ENOSYS;
b551a063 DG	371	}
b551a063 DG	372	static inline
da0bdb87 MD	373	int ust_app_list_event_fields(struct lttng_event_field **fields)
	374	{
	375	return -ENOSYS;
	376	}
	377	static inline
3bd1e081 MD	378	int ust_app_register(struct ust_register_msg *msg, int sock)
	379	{
	380	return -ENOSYS;
	381	}
	382	static inline
f2ca2e25 GF	383	int ust_app_register_done(int sock)
	384	{
	385	return -ENOSYS;
	386	}
	387	static inline
d0b96690 DG	388	int ust_app_version(struct ust_app *app)
	389	{
	390	return -ENOSYS;
	391	}
	392	static inline
3bd1e081 MD	393	void ust_app_unregister(int sock)
	394	{
	395	}
	396	static inline
3bd1e081 MD	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
12a84043 JG	419	int ust_app_ht_alloc(void)
	420	{
	421	return 0;
	422	}
cc920def DG	423	static inline
	424	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	425	{}
	426	static inline
35a9059d	427	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def	428	struct ltt_ust_channel *uchan)
d974f197	429	{
cc920def	430	return 0;
d974f197	431	}
487cf67c	432	static inline
35a9059d	433	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def	434	struct ltt_ust_channel *uchan)
487cf67c	435	{
cc920def DG	436	return 0;
	437	}
	438	static inline
35a9059d	439	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def DG	440	struct ltt_ust_channel *uchan)
	441	{
	442	return 0;
	443	}
	444	static inline
35a9059d	445	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def DG	446	struct ltt_ust_channel *uchan)
	447	{
	448	return 0;
	449	}
	450	static inline
35a9059d DG	451	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	452	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	453	{
	454	return 0;
	455	}
	456	static inline
	457	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def DG	458	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	459	{
	460	return 0;
487cf67c	461	}
edb67388	462	static inline
35a9059d	463	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 DG	464	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	465	{
	466	return 0;
	467	}
55cc08a6	468	static inline
55cc08a6 DG	469	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	470	struct ltt_ust_channel uchan, struct ltt_ust_context uctx)
	471	{
	472	return 0;
	473	}
76d45b40 DG	474	static inline
	475	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	476	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	477	pid_t pid)
	478	{
	479	return 0;
	480	}
7f79d3a1	481	static inline
d0b96690	482	int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
e0c7ec2b DG	483	{
	484	return 0;
	485	}
4466912f	486	static inline
d0b96690 DG	487	int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
	488	{
	489	return 0;
	490	}
	491	static inline
	492	int ust_app_recv_notify(int sock)
4466912f DG	493	{
	494	return 0;
	495	}
d0b96690 DG	496	static inline
	497	struct ust_app ust_app_create(struct ust_register_msg msg, int sock)
	498	{
	499	return NULL;
	500	}
	501	static inline
	502	void ust_app_add(struct ust_app *app)
	503	{
	504	}
d88aee68 DG	505	static inline
	506	void ust_app_notify_sock_unregister(int sock)
	507	{
	508	}
331744e3 JD	509	static inline
	510	ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
	511	struct consumer_socket *socket, int send_zero_data)
	512	{
	513	return 0;
	514	}
f45e313d DG	515	static inline
	516	void ust_app_destroy(struct ust_app *app)
	517	{
	518	return;
	519	}
6dc3064a DG	520	static inline
6dc3064a DG	521	int ust_app_snapshot_record(struct ltt_ust_session *usess,
68808f4e	522	struct snapshot_output *output, int wait, uint64_t max_stream_size)
5c786ded JD	523	{
	524	return 0;
	525	}
	526	static inline
	527	unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
6dc3064a DG	528	{
	529	return 0;
	530	}
48842b30	531
b51ec5b4 MD	532	static inline
	533	int ust_app_supported(void)
	534	{
	535	return 0;
	536	}
f20baf8e DG	537	static inline
	538	struct ust_app *ust_app_find_by_sock(int sock)
	539	{
	540	return NULL;
	541	}
95b1d17c DG	542	static inline
	543	struct ust_app *ust_app_find_by_pid(pid_t pid)
	544	{
	545	return NULL;
	546	}
16f35901 JG	547	static inline
	548	uint64_t ust_app_get_size_one_more_packet_per_stream(
	549	struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
	550	return 0;
	551	}
b51ec5b4	552
74d0b642	553	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	554
f6a9efaa	555	#endif /* _LTT_UST_APP_H */