[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
 * as published by the Free Software Foundation; only version 2
 * of the License.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef _LTT_UST_APP_H 
#define _LTT_UST_APP_H

#include <stdint.h>

#include "trace-ust.h"

#define UST_APP_EVENT_LIST_SIZE 32

extern int ust_consumerd64_fd, ust_consumerd32_fd;

/*
 * Application registration data structure.
 */
struct ust_register_msg {
	uint32_t major;
	uint32_t minor;
	pid_t pid;
	pid_t ppid;
	uid_t uid;
	gid_t gid;
	uint32_t bits_per_long;
	char name[16];
};

/*
 * Global applications HT used by the session daemon.
 */
struct lttng_ht *ust_app_ht;

struct lttng_ht *ust_app_sock_key_map;

struct ust_app_key {
	pid_t pid;
	int sock;
	struct lttng_ht_node_ulong node;
};

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 *ctx;
	struct lttng_ht_node_str node;
};

struct ust_app_channel {
	int enabled;
	int handle;
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct lttng_ust_channel attr;
	struct lttng_ust_object_data *obj;
	struct ltt_ust_stream_list streams;
	struct lttng_ht *ctx;
	struct lttng_ht *events;
	struct lttng_ht_node_str node;
};

struct ust_app_session {
	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 */
	int id;       /* session unique identifier */
	struct ltt_ust_metadata *metadata;
	struct lttng_ht *channels; /* Registered channels */
	struct lttng_ht_node_ulong node;
	char path[PATH_MAX];
	/* UID/GID of the user owning the session */
	uid_t uid;
	gid_t gid;
};

/*
 * Registered traceable applications. Libust registers to the session daemon
 * and a linked list is kept of all running traceable app.
 */
struct ust_app {
	pid_t ppid;
	uid_t uid;           /* User ID that owns the apps */
	gid_t gid;           /* Group ID that owns the apps */
	int bits_per_long;
	uint32_t v_major;    /* Verion major number */
	uint32_t v_minor;    /* Verion minor number */
	char name[17];       /* Process name (short) */
	struct lttng_ht *sessions;
	struct lttng_ht_node_ulong node;
	struct ust_app_key key;
};

#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);
}
void ust_app_unregister(int sock);
unsigned long ust_app_list_count(void);
int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
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(struct ltt_ust_session *usess, struct ust_app *app);
int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
int ust_app_list_events(struct lttng_event **events);
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_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
		struct ltt_ust_context *uctx);
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);

#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 0;
}
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
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_event_glb(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
		struct ltt_ust_context *uctx)
{
	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;
}

#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	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
82a3637f DG	6	* as published by the Free Software Foundation; only version 2
82a3637f DG	7	* of the License.
91d76f53 DG	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
f6a9efaa DG	19	#ifndef _LTT_UST_APP_H
f6a9efaa DG	20	#define _LTT_UST_APP_H
91d76f53	21
099e26bd	22	#include <stdint.h>
1e307fab	23
44d3bd01 DG	24	#include "trace-ust.h"
44d3bd01 DG	25
b551a063 DG	26	#define UST_APP_EVENT_LIST_SIZE 32
b551a063 DG	27
7753dea8	28	extern int ust_consumerd64_fd, ust_consumerd32_fd;
ba5d816e	29
099e26bd DG	30	/*
	31	* Application registration data structure.
	32	*/
	33	struct ust_register_msg {
	34	uint32_t major;
	35	uint32_t minor;
	36	pid_t pid;
	37	pid_t ppid;
	38	uid_t uid;
	39	gid_t gid;
0df502fd	40	uint32_t bits_per_long;
099e26bd DG	41	char name[16];
	42	};
	43
48842b30 DG	44	/*
	45	* Global applications HT used by the session daemon.
	46	*/
bec39940	47	struct lttng_ht *ust_app_ht;
f6a9efaa	48
bec39940	49	struct lttng_ht *ust_app_sock_key_map;
f6a9efaa DG	50
	51	struct ust_app_key {
	52	pid_t pid;
	53	int sock;
bec39940	54	struct lttng_ht_node_ulong node;
91d76f53 DG	55	};
91d76f53 DG	56
55cc08a6 DG	57	struct ust_app_ctx {
	58	int handle;
	59	struct lttng_ust_context ctx;
	60	struct lttng_ust_object_data *obj;
bec39940	61	struct lttng_ht_node_ulong node;
55cc08a6 DG	62	};
55cc08a6 DG	63
48842b30 DG	64	struct ust_app_event {
	65	int enabled;
	66	int handle;
13161846	67	struct lttng_ust_object_data *obj;
284d8f55	68	struct lttng_ust_event attr;
48842b30	69	char name[LTTNG_UST_SYM_NAME_LEN];
bec39940 DG	70	struct lttng_ht *ctx;
bec39940 DG	71	struct lttng_ht_node_str node;
48842b30 DG	72	};
	73
	74	struct ust_app_channel {
	75	int enabled;
	76	int handle;
	77	char name[LTTNG_UST_SYM_NAME_LEN];
	78	struct lttng_ust_channel attr;
13161846	79	struct lttng_ust_object_data *obj;
5af2f756	80	struct ltt_ust_stream_list streams;
bec39940 DG	81	struct lttng_ht *ctx;
	82	struct lttng_ht *events;
	83	struct lttng_ht_node_str node;
48842b30 DG	84	};
	85
	86	struct ust_app_session {
	87	int enabled;
8be98f9a MD	88	/* started: has the session been in started state at any time ? */
8be98f9a MD	89	int started; /* allows detection of start vs restart. */
a991f516 MD	90	int handle; /* used has unique identifier for app session */
a991f516 MD	91	int id; /* session unique identifier */
48842b30	92	struct ltt_ust_metadata *metadata;
bec39940 DG	93	struct lttng_ht channels; / Registered channels */
	94	struct lttng_ht_node_ulong node;
	95	char path[PATH_MAX];
6df2e2c9 MD	96	/* UID/GID of the user owning the session */
	97	uid_t uid;
	98	gid_t gid;
48842b30 DG	99	};
48842b30 DG	100
f6a9efaa DG	101	/*
f6a9efaa DG	102	* Registered traceable applications. Libust registers to the session daemon
050349bb	103	* and a linked list is kept of all running traceable app.
91d76f53	104	*/
56fff090	105	struct ust_app {
099e26bd DG	106	pid_t ppid;
099e26bd DG	107	uid_t uid; /* User ID that owns the apps */
aea829b3	108	gid_t gid; /* Group ID that owns the apps */
7753dea8	109	int bits_per_long;
099e26bd DG	110	uint32_t v_major; /* Verion major number */
	111	uint32_t v_minor; /* Verion minor number */
	112	char name[17]; /* Process name (short) */
bec39940 DG	113	struct lttng_ht *sessions;
bec39940 DG	114	struct lttng_ht_node_ulong node;
f6a9efaa	115	struct ust_app_key key;
91d76f53 DG	116	};
91d76f53 DG	117
74d0b642	118	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	119
56fff090	120	int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25 GF	121	static inline
	122	int ust_app_register_done(int sock)
	123	{
	124	return ustctl_register_done(sock);
	125	}
56fff090	126	void ust_app_unregister(int sock);
f6a9efaa	127	unsigned long ust_app_list_count(void);
421cb601	128	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app);
8be98f9a	129	int ust_app_stop_trace(struct ltt_ust_session usess, struct ust_app app);
421cb601	130	int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a	131	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 MD	132	int ust_app_destroy_trace(struct ltt_ust_session usess, struct ust_app app);
84cd17c6 MD	133	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063	134	int ust_app_list_events(struct lttng_event **events);
35a9059d DG	135	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	136	struct ltt_ust_channel *uchan);
	137	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	138	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
7f79d3a1 DG	139	int ust_app_disable_event_pid(struct ltt_ust_session *usess,
	140	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	141	pid_t pid);
76d45b40 DG	142	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	143	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	144	pid_t pid);
35a9059d	145	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	146	struct ltt_ust_channel *uchan);
35a9059d	147	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	148	struct ltt_ust_channel *uchan);
35a9059d	149	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388	150	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
35a9059d DG	151	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
	152	struct ltt_ust_channel *uchan);
	153	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e	154	struct ltt_ust_channel *uchan);
35a9059d DG	155	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
35a9059d DG	156	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
55cc08a6 DG	157	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	158	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	159	struct ltt_ust_context *uctx);
	160	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	161	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
487cf67c	162	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53	163
56fff090	164	void ust_app_clean_list(void);
f6a9efaa	165	void ust_app_ht_alloc(void);
bec39940	166	struct lttng_ht *ust_app_get_ht(void);
f6a9efaa	167	struct ust_app *ust_app_find_by_pid(pid_t pid);
44d3bd01	168
74d0b642	169	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	170
cc920def DG	171	static inline
	172	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	173	{
	174	return 0;
	175	}
d974f197	176	static inline
421cb601 DG	177	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	178	{
	179	return 0;
	180	}
	181	static inline
	182	int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197	183	{
5cf5d0e7	184	return 0;
d974f197	185	}
3bd1e081	186	static inline
cc920def DG	187	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	188	{
	189	return 0;
	190	}
	191	static inline
b551a063 DG	192	int ust_app_list_events(struct lttng_event **events)
	193	{
	194	return 0;
	195	}
	196	static inline
3bd1e081 MD	197	int ust_app_register(struct ust_register_msg *msg, int sock)
	198	{
	199	return -ENOSYS;
	200	}
	201	static inline
f2ca2e25 GF	202	int ust_app_register_done(int sock)
	203	{
	204	return -ENOSYS;
	205	}
	206	static inline
3bd1e081 MD	207	void ust_app_unregister(int sock)
	208	{
	209	}
	210	static inline
	211	unsigned int ust_app_list_count(void)
	212	{
	213	return 0;
	214	}
3bd1e081 MD	215	static inline
	216	void ust_app_lock_list(void)
	217	{
	218	}
	219	static inline
	220	void ust_app_unlock_list(void)
	221	{
	222	}
	223	static inline
	224	void ust_app_clean_list(void)
	225	{
	226	}
	227	static inline
	228	struct ust_app_list *ust_app_get_list(void)
	229	{
	230	return NULL;
	231	}
	232	static inline
	233	struct ust_app *ust_app_get_by_pid(pid_t pid)
	234	{
	235	return NULL;
	236	}
48842b30	237	static inline
bec39940	238	struct lttng_ht *ust_app_get_ht(void)
d974f197 DG	239	{
	240	return NULL;
	241	}
	242	static inline
	243	void ust_app_ht_alloc(void)
cc920def DG	244	{}
	245	static inline
	246	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	247	{}
	248	static inline
35a9059d	249	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def	250	struct ltt_ust_channel *uchan)
d974f197	251	{
cc920def	252	return 0;
d974f197	253	}
487cf67c	254	static inline
35a9059d	255	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def	256	struct ltt_ust_channel *uchan)
487cf67c	257	{
cc920def DG	258	return 0;
	259	}
	260	static inline
35a9059d	261	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def DG	262	struct ltt_ust_channel *uchan)
	263	{
	264	return 0;
	265	}
	266	static inline
35a9059d DG	267	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
35a9059d DG	268	struct ltt_ust_channel *uchan)
cc920def DG	269	{
	270	return 0;
	271	}
	272	static inline
35a9059d	273	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def DG	274	struct ltt_ust_channel *uchan)
	275	{
	276	return 0;
	277	}
	278	static inline
35a9059d DG	279	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	280	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	281	{
	282	return 0;
	283	}
	284	static inline
	285	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def DG	286	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	287	{
	288	return 0;
487cf67c	289	}
edb67388	290	static inline
35a9059d	291	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 DG	292	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	293	{
	294	return 0;
	295	}
55cc08a6 DG	296	static inline
	297	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	298	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	299	struct ltt_ust_context *uctx)
	300	{
	301	return 0;
	302	}
	303	static inline
	304	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	305	struct ltt_ust_channel uchan, struct ltt_ust_context uctx)
	306	{
	307	return 0;
	308	}
76d45b40 DG	309	static inline
	310	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	311	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	312	pid_t pid)
	313	{
	314	return 0;
	315	}
7f79d3a1 DG	316	static inline
	317	int ust_app_disable_event_pid(struct ltt_ust_session *usess,
	318	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	319	pid_t pid)
	320	{
	321	return 0;
	322	}
48842b30	323
74d0b642	324	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	325
f6a9efaa	326	#endif /* _LTT_UST_APP_H */