[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_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;
}

#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* _LTT_UST_APP_H */
Commit	Line	Data
	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
	6	* as published by the Free Software Foundation; only version 2
	7	* of the License.
	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
	19	#ifndef _LTT_UST_APP_H
	20	#define _LTT_UST_APP_H
	21
	22	#include <stdint.h>
	23	#include <urcu/list.h>
	24
	25	#include "trace-ust.h"
	26
	27	#define UST_APP_EVENT_LIST_SIZE 32
	28
	29	extern int ust_consumerd64_fd, ust_consumerd32_fd;
	30
	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;
	41	uint32_t bits_per_long;
	42	char name[16];
	43	};
	44
	45	/*
	46	* Global applications HT used by the session daemon.
	47	*/
	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;
	56	};
	57
	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
	65	struct ust_app_event {
	66	int enabled;
	67	int handle;
	68	struct lttng_ust_object_data *obj;
	69	struct lttng_ust_event attr;
	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;
	80	struct lttng_ust_object_data *obj;
	81	struct ltt_ust_stream_list streams;
	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;
	89	/* started: has the session been in started state at any time ? */
	90	int started; /* allows detection of start vs restart. */
	91	int handle; /* Used has unique identifier */
	92	unsigned int uid;
	93	struct ltt_ust_metadata *metadata;
	94	struct cds_lfht channels; / Registered channels */
	95	struct cds_lfht_node node;
	96	char path[PATH_MAX];
	97	};
	98
	99	/*
	100	* Registered traceable applications. Libust registers to the session daemon
	101	* and a linked list is kept of all running traceable app.
	102	*/
	103	struct ust_app {
	104	pid_t ppid;
	105	uid_t uid; /* User ID that owns the apps */
	106	gid_t gid; /* Group ID that owns the apps */
	107	int bits_per_long;
	108	uint32_t v_major; /* Verion major number */
	109	uint32_t v_minor; /* Verion minor number */
	110	char name[17]; /* Process name (short) */
	111	struct cds_lfht *sessions;
	112	struct cds_lfht_node node;
	113	struct ust_app_key key;
	114	};
	115
	116	#ifdef HAVE_LIBLTTNG_UST_CTL
	117
	118	int ust_app_register(struct ust_register_msg *msg, int sock);
	119	void ust_app_unregister(int sock);
	120	unsigned long ust_app_list_count(void);
	121	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app);
	122	int ust_app_stop_trace(struct ltt_ust_session usess, struct ust_app app);
	123	int ust_app_start_trace_all(struct ltt_ust_session *usess);
	124	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
	125	int ust_app_destroy_trace(struct ltt_ust_session usess, struct ust_app app);
	126	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
	127	int ust_app_list_events(struct lttng_event **events);
	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);
	132	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
	133	struct ltt_ust_channel *uchan);
	134	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
	135	struct ltt_ust_channel *uchan);
	136	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
	137	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	138	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
	139	struct ltt_ust_channel *uchan);
	140	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
	141	struct ltt_ust_channel *uchan);
	142	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
	143	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	144	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	145	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	146	struct ltt_ust_context *uctx);
	147	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	148	struct ltt_ust_channel uchan, struct ltt_ust_context uctx);
	149	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
	150
	151	void ust_app_clean_list(void);
	152	void ust_app_ht_alloc(void);
	153	struct cds_lfht *ust_app_get_ht(void);
	154	struct ust_app *ust_app_find_by_pid(pid_t pid);
	155
	156	#else /* HAVE_LIBLTTNG_UST_CTL */
	157
	158	static inline
	159	int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
	160	{
	161	return 0;
	162	}
	163	static inline
	164	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	165	{
	166	return 0;
	167	}
	168	static inline
	169	int ust_app_start_trace_all(struct ltt_ust_session *usess)
	170	{
	171	return 0;
	172	}
	173	static inline
	174	int ust_app_stop_trace_all(struct ltt_ust_session *usess)
	175	{
	176	return 0;
	177	}
	178	static inline
	179	int ust_app_list_events(struct lttng_event **events)
	180	{
	181	return 0;
	182	}
	183	static inline
	184	int ust_app_register(struct ust_register_msg *msg, int sock)
	185	{
	186	return -ENOSYS;
	187	}
	188	static inline
	189	void ust_app_unregister(int sock)
	190	{
	191	}
	192	static inline
	193	unsigned int ust_app_list_count(void)
	194	{
	195	return 0;
	196	}
	197	static inline
	198	void ust_app_lock_list(void)
	199	{
	200	}
	201	static inline
	202	void ust_app_unlock_list(void)
	203	{
	204	}
	205	static inline
	206	void ust_app_clean_list(void)
	207	{
	208	}
	209	static inline
	210	struct ust_app_list *ust_app_get_list(void)
	211	{
	212	return NULL;
	213	}
	214	static inline
	215	struct ust_app *ust_app_get_by_pid(pid_t pid)
	216	{
	217	return NULL;
	218	}
	219	static inline
	220	struct cds_lfht *ust_app_get_ht(void)
	221	{
	222	return NULL;
	223	}
	224	static inline
	225	void ust_app_ht_alloc(void)
	226	{}
	227	static inline
	228	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	229	{}
	230	static inline
	231	int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
	232	struct ltt_ust_channel *uchan)
	233	{
	234	return 0;
	235	}
	236	static inline
	237	int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
	238	struct ltt_ust_channel *uchan)
	239	{
	240	return 0;
	241	}
	242	static inline
	243	int ust_app_create_channel_glb(struct ltt_ust_session *usess,
	244	struct ltt_ust_channel *uchan)
	245	{
	246	return 0;
	247	}
	248	static inline
	249	int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
	250	struct ltt_ust_channel *uchan)
	251	{
	252	return 0;
	253	}
	254	static inline
	255	int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
	256	struct ltt_ust_channel *uchan)
	257	{
	258	return 0;
	259	}
	260	static inline
	261	int ust_app_create_event_glb(struct ltt_ust_session *usess,
	262	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	263	{
	264	return 0;
	265	}
	266	static inline
	267	int ust_app_disable_event_glb(struct ltt_ust_session *usess,
	268	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	269	{
	270	return 0;
	271	}
	272	static inline
	273	int ust_app_enable_event_glb(struct ltt_ust_session *usess,
	274	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	275	{
	276	return 0;
	277	}
	278	static inline
	279	int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
	280	struct ltt_ust_channel uchan, struct ltt_ust_event uevent,
	281	struct ltt_ust_context *uctx)
	282	{
	283	return 0;
	284	}
	285	static inline
	286	int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
	287	struct ltt_ust_channel uchan, struct ltt_ust_context uctx)
	288	{
	289	return 0;
	290	}
	291
	292	#endif /* HAVE_LIBLTTNG_UST_CTL */
	293
	294	#endif /* _LTT_UST_APP_H */