[lttng-tools.git] / 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 <urcu/list.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 cds_lfht *ust_app_ht;

struct cds_lfht *ust_app_sock_key_map;

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

struct ust_app_ctx {
	int handle;
	struct lttng_ust_context ctx;
	struct lttng_ust_object_data *obj;
	struct cds_lfht_node 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 cds_lfht *ctx;
	struct cds_lfht_node 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 cds_lfht *ctx;
	struct cds_lfht *events;
	struct cds_lfht_node 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 cds_lfht *channels; /* Registered channels */
	struct cds_lfht_node node;
	/* UID/GID of the user owning the session */
	uid_t uid;
	gid_t gid;
	char 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 {
	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 cds_lfht *sessions;
	struct cds_lfht_node node;
	struct ust_app_key key;
};

#ifdef HAVE_LIBLTTNG_UST_CTL

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