[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_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);
int ust_app_create_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_create_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
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_disable_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_enable_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_enable_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
int ust_app_disable_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan);
int ust_app_disable_event(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, char *event_name);
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
int ust_app_add_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_add_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	return 0;
}
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_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_enable_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_disable_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_disable_event(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, char *event_name)
{
	return 0;
}
static inline
int ust_app_create_channel_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan)
{
	return 0;
}
static inline
int ust_app_create_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	return 0;
}
static inline
int ust_app_enable_event_all(struct ltt_ust_session *usess,
		struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
	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
48842b30 DG	58	struct ust_app_event {
	59	int enabled;
	60	int handle;
13161846	61	struct lttng_ust_object_data *obj;
284d8f55	62	struct lttng_ust_event attr;
48842b30 DG	63	char name[LTTNG_UST_SYM_NAME_LEN];
	64	struct cds_lfht *ctx;
	65	struct cds_lfht_node node;
	66	};
	67
	68	struct ust_app_channel {
	69	int enabled;
	70	int handle;
	71	char name[LTTNG_UST_SYM_NAME_LEN];
	72	struct lttng_ust_channel attr;
13161846	73	struct lttng_ust_object_data *obj;
5af2f756	74	struct ltt_ust_stream_list streams;
48842b30 DG	75	struct cds_lfht *ctx;
	76	struct cds_lfht *events;
	77	struct cds_lfht_node node;
	78	};
	79
	80	struct ust_app_session {
	81	int enabled;
8be98f9a MD	82	/* started: has the session been in started state at any time ? */
8be98f9a MD	83	int started; /* allows detection of start vs restart. */
48842b30 DG	84	int handle; /* Used has unique identifier */
	85	unsigned int uid;
	86	struct ltt_ust_metadata *metadata;
48842b30 DG	87	struct cds_lfht channels; / Registered channels */
48842b30 DG	88	struct cds_lfht_node node;
477d7741	89	char path[PATH_MAX];
48842b30 DG	90	};
48842b30 DG	91
f6a9efaa DG	92	/*
f6a9efaa DG	93	* Registered traceable applications. Libust registers to the session daemon
050349bb	94	* and a linked list is kept of all running traceable app.
91d76f53	95	*/
56fff090	96	struct ust_app {
099e26bd DG	97	pid_t ppid;
099e26bd DG	98	uid_t uid; /* User ID that owns the apps */
aea829b3	99	gid_t gid; /* Group ID that owns the apps */
7753dea8	100	int bits_per_long;
099e26bd DG	101	uint32_t v_major; /* Verion major number */
	102	uint32_t v_minor; /* Verion minor number */
	103	char name[17]; /* Process name (short) */
48842b30	104	struct cds_lfht *sessions;
f6a9efaa DG	105	struct cds_lfht_node node;
f6a9efaa DG	106	struct ust_app_key key;
91d76f53 DG	107	};
91d76f53 DG	108
74d0b642	109	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	110
56fff090 DG	111	int ust_app_register(struct ust_register_msg *msg, int sock);
56fff090 DG	112	void ust_app_unregister(int sock);
5b4a0ec0	113	int ust_app_create_channel_all(struct ltt_ust_session *usess,
48842b30	114	struct ltt_ust_channel *uchan);
5b4a0ec0	115	int ust_app_create_event_all(struct ltt_ust_session *usess,
48842b30	116	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
f6a9efaa	117	unsigned long ust_app_list_count(void);
421cb601	118	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app);
8be98f9a	119	int ust_app_stop_trace(struct ltt_ust_session usess, struct ust_app app);
421cb601	120	int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a	121	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 MD	122	int ust_app_destroy_trace(struct ltt_ust_session usess, struct ust_app app);
84cd17c6 MD	123	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063	124	int ust_app_list_events(struct lttng_event **events);
78f0bacd DG	125	int ust_app_disable_channel_all(struct ltt_ust_session *usess,
	126	struct ltt_ust_channel *uchan);
	127	int ust_app_enable_channel_all(struct ltt_ust_session *usess,
	128	struct ltt_ust_channel *uchan);
edb67388 DG	129	int ust_app_enable_event_all(struct ltt_ust_session *usess,
edb67388 DG	130	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
9730260e DG	131	int ust_app_disable_event_all(struct ltt_ust_session *usess,
9730260e DG	132	struct ltt_ust_channel *uchan);
b0a40d28 DG	133	int ust_app_disable_event(struct ltt_ust_session *usess,
b0a40d28 DG	134	struct ltt_ust_channel uchan, char event_name);
487cf67c	135	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53	136
56fff090	137	void ust_app_clean_list(void);
f6a9efaa DG	138	void ust_app_ht_alloc(void);
	139	struct cds_lfht *ust_app_get_ht(void);
	140	struct ust_app *ust_app_find_by_pid(pid_t pid);
44d3bd01	141
74d0b642	142	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	143
cc920def DG	144	static inline
	145	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	146	{
	147	return 0;
	148	}
d974f197	149	static inline
421cb601 DG	150	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	151	{
	152	return 0;
	153	}
	154	static inline
	155	int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197	156	{
5cf5d0e7	157	return 0;
d974f197	158	}
3bd1e081	159	static inline
cc920def DG	160	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	161	{
	162	return 0;
	163	}
	164	static inline
b551a063 DG	165	int ust_app_list_events(struct lttng_event **events)
	166	{
	167	return 0;
	168	}
	169	static inline
3bd1e081 MD	170	int ust_app_register(struct ust_register_msg *msg, int sock)
	171	{
	172	return -ENOSYS;
	173	}
	174	static inline
	175	void ust_app_unregister(int sock)
	176	{
	177	}
	178	static inline
	179	unsigned int ust_app_list_count(void)
	180	{
	181	return 0;
	182	}
3bd1e081 MD	183	static inline
	184	void ust_app_lock_list(void)
	185	{
	186	}
	187	static inline
	188	void ust_app_unlock_list(void)
	189	{
	190	}
	191	static inline
	192	void ust_app_clean_list(void)
	193	{
	194	}
	195	static inline
	196	struct ust_app_list *ust_app_get_list(void)
	197	{
	198	return NULL;
	199	}
	200	static inline
	201	struct ust_app *ust_app_get_by_pid(pid_t pid)
	202	{
	203	return NULL;
	204	}
48842b30	205	static inline
421cb601	206	int ust_app_add_channel_all(struct ltt_ust_session *usess,
48842b30 DG	207	struct ltt_ust_channel *uchan)
	208	{
	209	return 0;
	210	}
d974f197	211	static inline
421cb601	212	int ust_app_add_event_all(struct ltt_ust_session *usess,
d974f197 DG	213	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
d974f197 DG	214	{
5cf5d0e7	215	return 0;
d974f197 DG	216	}
	217	static inline
	218	struct cds_lfht *ust_app_get_ht(void)
	219	{
	220	return NULL;
	221	}
	222	static inline
	223	void ust_app_ht_alloc(void)
cc920def DG	224	{}
	225	static inline
	226	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	227	{}
	228	static inline
	229	int ust_app_disable_channel_all(struct ltt_ust_session *usess,
	230	struct ltt_ust_channel *uchan)
d974f197	231	{
cc920def	232	return 0;
d974f197	233	}
487cf67c	234	static inline
cc920def DG	235	int ust_app_enable_channel_all(struct ltt_ust_session *usess,
cc920def DG	236	struct ltt_ust_channel *uchan)
487cf67c	237	{
cc920def DG	238	return 0;
	239	}
	240	static inline
	241	int ust_app_disable_event_all(struct ltt_ust_session *usess,
	242	struct ltt_ust_channel *uchan)
	243	{
	244	return 0;
	245	}
	246	static inline
	247	int ust_app_disable_event(struct ltt_ust_session *usess,
	248	struct ltt_ust_channel uchan, char event_name)
	249	{
	250	return 0;
	251	}
	252	static inline
	253	int ust_app_create_channel_all(struct ltt_ust_session *usess,
	254	struct ltt_ust_channel *uchan)
	255	{
	256	return 0;
	257	}
	258	static inline
	259	int ust_app_create_event_all(struct ltt_ust_session *usess,
	260	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	261	{
	262	return 0;
487cf67c	263	}
edb67388 DG	264	static inline
	265	int ust_app_enable_event_all(struct ltt_ust_session *usess,
	266	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	267	{
	268	return 0;
	269	}
48842b30	270
74d0b642	271	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	272
f6a9efaa	273	#endif /* _LTT_UST_APP_H */