[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_consumer_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 */
	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);
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_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_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)
{
}

#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_consumer_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_event {
	59	int enabled;
	60	int handle;
	61	struct lttng_ust_object_data *obj;
	62	struct lttng_ust_event attr;
	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;
	73	struct lttng_ust_object_data *obj;
	74	struct ltt_ust_stream_list streams;
	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;
	82	/* started: has the session been in started state at any time ? */
	83	int started; /* allows detection of start vs restart. */
	84	int handle; /* Used has unique identifier */
	85	unsigned int uid;
	86	struct ltt_ust_metadata *metadata;
	87	struct cds_lfht channels; / Registered channels */
	88	struct cds_lfht_node node;
	89	char path[PATH_MAX];
	90	};
	91
	92	/*
	93	* Registered traceable applications. Libust registers to the session daemon
	94	* and a linked list is kept of all running traceable app.
	95	*/
	96	struct ust_app {
	97	pid_t ppid;
	98	uid_t uid; /* User ID that owns the apps */
	99	gid_t gid; /* Group ID that owns the apps */
	100	uint32_t v_major; /* Verion major number */
	101	uint32_t v_minor; /* Verion minor number */
	102	char name[17]; /* Process name (short) */
	103	struct cds_lfht *sessions;
	104	struct cds_lfht_node node;
	105	struct ust_app_key key;
	106	};
	107
	108	#ifdef HAVE_LIBLTTNG_UST_CTL
	109
	110	int ust_app_register(struct ust_register_msg *msg, int sock);
	111	void ust_app_unregister(int sock);
	112	int ust_app_create_channel_all(struct ltt_ust_session *usess,
	113	struct ltt_ust_channel *uchan);
	114	int ust_app_create_event_all(struct ltt_ust_session *usess,
	115	struct ltt_ust_channel uchan, struct ltt_ust_event uevent);
	116	unsigned long ust_app_list_count(void);
	117	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app);
	118	int ust_app_stop_trace(struct ltt_ust_session usess, struct ust_app app);
	119	int ust_app_start_trace_all(struct ltt_ust_session *usess);
	120	int ust_app_stop_trace_all(struct ltt_ust_session *usess);
	121	int ust_app_destroy_trace(struct ltt_ust_session usess, struct ust_app app);
	122	int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
	123	int ust_app_list_events(struct lttng_event **events);
	124	void ust_app_global_update(struct ltt_ust_session *usess, int sock);
	125
	126	void ust_app_clean_list(void);
	127	void ust_app_ht_alloc(void);
	128	struct cds_lfht *ust_app_get_ht(void);
	129	struct ust_app *ust_app_find_by_pid(pid_t pid);
	130
	131	#else /* HAVE_LIBLTTNG_UST_CTL */
	132
	133	static inline
	134	int ust_app_start_trace(struct ltt_ust_session usess, struct ust_app app)
	135	{
	136	return 0;
	137	}
	138	static inline
	139	int ust_app_start_trace_all(struct ltt_ust_session *usess)
	140	{
	141	return 0;
	142	}
	143	static inline
	144	int ust_app_list_events(struct lttng_event **events)
	145	{
	146	return 0;
	147	}
	148	static inline
	149	int ust_app_register(struct ust_register_msg *msg, int sock)
	150	{
	151	return -ENOSYS;
	152	}
	153	static inline
	154	void ust_app_unregister(int sock)
	155	{
	156	}
	157	static inline
	158	unsigned int ust_app_list_count(void)
	159	{
	160	return 0;
	161	}
	162	static inline
	163	void ust_app_lock_list(void)
	164	{
	165	}
	166	static inline
	167	void ust_app_unlock_list(void)
	168	{
	169	}
	170	static inline
	171	void ust_app_clean_list(void)
	172	{
	173	}
	174	static inline
	175	struct ust_app_list *ust_app_get_list(void)
	176	{
	177	return NULL;
	178	}
	179	static inline
	180	struct ust_app *ust_app_get_by_pid(pid_t pid)
	181	{
	182	return NULL;
	183	}
	184	static inline
	185	int ust_app_add_channel_all(struct ltt_ust_session *usess,
	186	struct ltt_ust_channel *uchan)
	187	{
	188	return 0;
	189	}
	190	static inline
	191	int ust_app_add_event_all(struct ltt_ust_session *usess,
	192	struct ltt_ust_channel uchan, struct ltt_ust_event uevent)
	193	{
	194	return 0;
	195	}
	196	static inline
	197	struct cds_lfht *ust_app_get_ht(void)
	198	{
	199	return NULL;
	200	}
	201	static inline
	202	void ust_app_ht_alloc(void)
	203	{
	204	}
	205	static inline
	206	void ust_app_global_update(struct ltt_ust_session *usess, int sock)
	207	{
	208	}
	209
	210	#endif /* HAVE_LIBLTTNG_UST_CTL */
	211
	212	#endif /* _LTT_UST_APP_H */