[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, version 2 only,
 * as published by the Free Software Foundation.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTT_UST_APP_H 
#define _LTT_UST_APP_H

#include <stdint.h>

#include "trace-ust.h"

/* lttng-ust supported version. */
#define LTTNG_UST_COMM_MAJOR          2	/* comm protocol major version */
#define UST_APP_MAJOR_VERSION         2 /* UST version supported */

#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. This table is indexed by
 * PID using the pid_n node and pid value of an ust_app.
 */
struct lttng_ht *ust_app_ht;

/*
 * Global applications HT used by the session daemon. This table is indexed by
 * socket using the sock_n node and sock value of an ust_app.
 */
struct lttng_ht *ust_app_ht_by_sock;

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 {
	int sock;
	pid_t pid;
	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;
	int compatible; /* If the lttng-ust tracer version does not match the
					   supported version of the session daemon, this flag is
					   set to 0 (NOT compatible) else 1. */
	struct lttng_ust_tracer_version version;
	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 pid_n;
	struct lttng_ht_node_ulong sock_n;
};

#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);
int ust_app_validate_version(int sock);
int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);

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