[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 */
	unsigned int uid;
	struct ltt_ust_metadata *metadata;
	struct cds_lfht *channels; /* Registered channels */
	struct cds_lfht_node node;
	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_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;
}

#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. */
48842b30 DG	91	int handle; /* Used has unique identifier */
	92	unsigned int uid;
	93	struct ltt_ust_metadata *metadata;
48842b30 DG	94	struct cds_lfht channels; / Registered channels */
48842b30 DG	95	struct cds_lfht_node node;
477d7741	96	char path[PATH_MAX];
48842b30 DG	97	};
48842b30 DG	98
f6a9efaa DG	99	/*
f6a9efaa DG	100	* Registered traceable applications. Libust registers to the session daemon
050349bb	101	* and a linked list is kept of all running traceable app.
91d76f53	102	*/
56fff090	103	struct ust_app {
099e26bd DG	104	pid_t ppid;
099e26bd DG	105	uid_t uid; /* User ID that owns the apps */
aea829b3	106	gid_t gid; /* Group ID that owns the apps */
7753dea8	107	int bits_per_long;
099e26bd DG	108	uint32_t v_major; /* Verion major number */
	109	uint32_t v_minor; /* Verion minor number */
	110	char name[17]; /* Process name (short) */
48842b30	111	struct cds_lfht *sessions;
f6a9efaa DG	112	struct cds_lfht_node node;
f6a9efaa DG	113	struct ust_app_key key;
91d76f53 DG	114	};
91d76f53 DG	115
74d0b642	116	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	117
56fff090 DG	118	int ust_app_register(struct ust_register_msg *msg, int sock);
56fff090 DG	119	void ust_app_unregister(int sock);
f6a9efaa	120	unsigned long ust_app_list_count(void);
421cb601	121	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app);
8be98f9a	122	int ust_app_stop_trace(struct ltt_ust_session usess, struct ust_app app);
421cb601	123	int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a	124	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 MD	125	int ust_app_destroy_trace(struct ltt_ust_session usess, struct ust_app app);
84cd17c6 MD	126	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063	127	int ust_app_list_events(struct lttng_event **events);
35a9059d DG	128	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	129	struct ltt_ust_channel *uchan);
	130	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	131	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
76d45b40 DG	132	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	133	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	134	pid_t pid);
35a9059d	135	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	136	struct ltt_ust_channel *uchan);
35a9059d	137	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd	138	struct ltt_ust_channel *uchan);
35a9059d	139	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388	140	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
35a9059d DG	141	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
	142	struct ltt_ust_channel *uchan);
	143	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e	144	struct ltt_ust_channel *uchan);
35a9059d DG	145	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
35a9059d DG	146	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
55cc08a6 DG	147	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	148	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	149	struct ltt_ust_context *uctx);
	150	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	151	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
487cf67c	152	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53	153
56fff090	154	void ust_app_clean_list(void);
f6a9efaa DG	155	void ust_app_ht_alloc(void);
	156	struct cds_lfht *ust_app_get_ht(void);
	157	struct ust_app *ust_app_find_by_pid(pid_t pid);
44d3bd01	158
74d0b642	159	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	160
cc920def DG	161	static inline
	162	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	163	{
	164	return 0;
	165	}
d974f197	166	static inline
421cb601 DG	167	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	168	{
	169	return 0;
	170	}
	171	static inline
	172	int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197	173	{
5cf5d0e7	174	return 0;
d974f197	175	}
3bd1e081	176	static inline
cc920def DG	177	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	178	{
	179	return 0;
	180	}
	181	static inline
b551a063 DG	182	int ust_app_list_events(struct lttng_event **events)
	183	{
	184	return 0;
	185	}
	186	static inline
3bd1e081 MD	187	int ust_app_register(struct ust_register_msg *msg, int sock)
	188	{
	189	return -ENOSYS;
	190	}
	191	static inline
	192	void ust_app_unregister(int sock)
	193	{
	194	}
	195	static inline
	196	unsigned int ust_app_list_count(void)
	197	{
	198	return 0;
	199	}
3bd1e081 MD	200	static inline
	201	void ust_app_lock_list(void)
	202	{
	203	}
	204	static inline
	205	void ust_app_unlock_list(void)
	206	{
	207	}
	208	static inline
	209	void ust_app_clean_list(void)
	210	{
	211	}
	212	static inline
	213	struct ust_app_list *ust_app_get_list(void)
	214	{
	215	return NULL;
	216	}
	217	static inline
	218	struct ust_app *ust_app_get_by_pid(pid_t pid)
	219	{
	220	return NULL;
	221	}
48842b30	222	static inline
d974f197 DG	223	struct cds_lfht *ust_app_get_ht(void)
	224	{
	225	return NULL;
	226	}
	227	static inline
	228	void ust_app_ht_alloc(void)
cc920def DG	229	{}
	230	static inline
	231	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	232	{}
	233	static inline
35a9059d	234	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def	235	struct ltt_ust_channel *uchan)
d974f197	236	{
cc920def	237	return 0;
d974f197	238	}
487cf67c	239	static inline
35a9059d	240	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def	241	struct ltt_ust_channel *uchan)
487cf67c	242	{
cc920def DG	243	return 0;
	244	}
	245	static inline
35a9059d	246	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def DG	247	struct ltt_ust_channel *uchan)
	248	{
	249	return 0;
	250	}
	251	static inline
35a9059d DG	252	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
35a9059d DG	253	struct ltt_ust_channel *uchan)
cc920def DG	254	{
	255	return 0;
	256	}
	257	static inline
35a9059d	258	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def DG	259	struct ltt_ust_channel *uchan)
	260	{
	261	return 0;
	262	}
	263	static inline
35a9059d DG	264	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	265	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	266	{
	267	return 0;
	268	}
	269	static inline
	270	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def DG	271	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	272	{
	273	return 0;
487cf67c	274	}
edb67388	275	static inline
35a9059d	276	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 DG	277	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	278	{
	279	return 0;
	280	}
55cc08a6 DG	281	static inline
	282	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	283	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	284	struct ltt_ust_context *uctx)
	285	{
	286	return 0;
	287	}
	288	static inline
	289	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	290	struct ltt_ust_channel uchan, struct ltt_ust_context uctx)
	291	{
	292	return 0;
	293	}
76d45b40 DG	294	static inline
	295	int ust_app_enable_event_pid(struct ltt_ust_session *usess,
	296	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	297	pid_t pid)
	298	{
	299	return 0;
	300	}
48842b30	301
74d0b642	302	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	303
f6a9efaa	304	#endif /* _LTT_UST_APP_H */