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

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTT_UST_APP_H 
#define _LTT_UST_APP_H

#include <stdint.h>

#include <common/compat/uuid.h>
#include "trace-ust.h"
#include "ust-registry.h"

#define UST_APP_EVENT_LIST_SIZE 32

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

struct lttng_filter_bytecode;
struct lttng_ust_filter_bytecode;

extern int ust_consumerd64_fd, ust_consumerd32_fd;

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

struct ust_app_ht_key {
	const char *name;
	const struct lttng_ust_filter_bytecode *filter;
	enum lttng_ust_loglevel_type loglevel;
};

/*
 * Application registration data structure.
 */
struct ust_register_msg {
	enum ustctl_socket_type type;
	uint32_t major;
	uint32_t minor;
	uint32_t abi_major;
	uint32_t abi_minor;
	pid_t pid;
	pid_t ppid;
	uid_t uid;
	gid_t gid;
	uint32_t bits_per_long;
	uint32_t uint8_t_alignment;
	uint32_t uint16_t_alignment;
	uint32_t uint32_t_alignment;
	uint32_t uint64_t_alignment;
	uint32_t long_alignment;
	int byte_order;		/* BIG_ENDIAN or LITTLE_ENDIAN */
	char name[LTTNG_UST_ABI_PROCNAME_LEN];
};

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

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

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

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

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

struct 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;
	struct lttng_ht *ctx;
	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.
	 */
	int tracing_id;
	uint64_t id;	/* Unique session identifier */
	struct lttng_ht *channels; /* Registered channels */
	struct lttng_ht_node_ulong 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;
};

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

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

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

#ifdef HAVE_LIBLTTNG_UST_CTL

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

void ust_app_clean_list(void);
void ust_app_ht_alloc(void);
struct lttng_ht *ust_app_get_ht(void);
struct ust_app *ust_app_find_by_pid(pid_t pid);
int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
struct ust_app_stream *ust_app_alloc_stream(void);
int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
int ust_app_recv_notify(int sock);
void ust_app_add(struct ust_app *app);
struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
void ust_app_notify_sock_unregister(int sock);
ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
		struct consumer_socket *socket, int send_zero_data);
void ust_app_destroy(struct ust_app *app);

#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;
}

#endif /* HAVE_LIBLTTNG_UST_CTL */

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