[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.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_TRACE_UST_H
#define _LTT_TRACE_UST_H

#include <config.h>
#include <limits.h>
#include <urcu/list.h>

#include <lttng/lttng.h>
#include <common/hashtable/hashtable.h>
#include <common/defaults.h>

#include "consumer.h"
#include "agent.h"
#include "ust-ctl.h"

struct ltt_ust_ht_key {
	const char *name;
	const struct lttng_filter_bytecode *filter;
	enum lttng_ust_loglevel_type loglevel;
	const struct lttng_event_exclusion *exclusion;
};

/* Context hash table nodes */
struct ltt_ust_context {
	struct lttng_ust_context ctx;
	struct lttng_ht_node_ulong node;
	struct cds_list_head list;
};

/* UST event */
struct ltt_ust_event {
	unsigned int enabled;
	struct lttng_ust_event attr;
	struct lttng_ht_node_str node;
	char *filter_expression;
	struct lttng_filter_bytecode *filter;
	struct lttng_event_exclusion *exclusion;
	bool internal;
};

/* UST channel */
struct ltt_ust_channel {
	uint64_t id;	/* unique id per session. */
	unsigned int enabled;
	/*
	 * A UST channel can be part of a userspace sub-domain such as JUL,
	 * Log4j, Python.
	 */
	enum lttng_domain_type domain;
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct lttng_ust_channel_attr attr;
	struct lttng_ht *ctx;
	struct cds_list_head ctx_list;
	struct lttng_ht *events;
	struct lttng_ht_node_str node;
	uint64_t tracefile_size;
	uint64_t tracefile_count;
};

/* UST domain global (LTTNG_DOMAIN_UST) */
struct ltt_ust_domain_global {
	struct lttng_ht *channels;
	struct cds_list_head registry_buffer_uid_list;
};

struct ust_pid_tracker_node {
	struct lttng_ht_node_ulong node;
};

struct ust_pid_tracker {
	struct lttng_ht *ht;
};

/* UST session */
struct ltt_ust_session {
	uint64_t id;    /* Unique identifier of session */
	struct ltt_ust_domain_global domain_global;
	/* Hash table of agent indexed by agent domain. */
	struct lttng_ht *agents;
	/* UID/GID of the user owning the session */
	uid_t uid;
	gid_t gid;
	/* Is the session active meaning has is been started or stopped. */
	unsigned int active:1;
	struct consumer_output *consumer;
	/* Sequence number for filters so the tracer knows the ordering. */
	uint64_t filter_seq_num;
	/* This indicates which type of buffer this session is set for. */
	enum lttng_buffer_type buffer_type;
	/* If set to 1, the buffer_type can not be changed anymore. */
	int buffer_type_changed;
	/* For per UID buffer, every buffer reg object is kept of this session */
	struct cds_list_head buffer_reg_uid_list;
	/* Next channel ID available for a newly registered channel. */
	uint64_t next_channel_id;
	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	uint64_t used_channel_id;
	/* Tell or not if the session has to output the traces. */
	unsigned int output_traces;
	unsigned int snapshot_mode;
	unsigned int has_non_default_channel;
	unsigned int live_timer_interval;	/* usec */

	/* Metadata channel attributes. */
	struct lttng_ust_channel_attr metadata_attr;

	/*
	 * Path where to keep the shared memory files.
	 */
	char root_shm_path[PATH_MAX];
	char shm_path[PATH_MAX];

	struct ust_pid_tracker pid_tracker;
};

/*
 * Validate that the id has reached the maximum allowed or not.
 *
 * Return 0 if NOT else 1.
 */
static inline int trace_ust_is_max_id(uint64_t id)
{
	return (id == UINT64_MAX) ? 1 : 0;
}

/*
 * Return next available channel id and increment the used counter. The
 * trace_ust_is_max_id function MUST be called before in order to validate if
 * the maximum number of IDs have been reached. If not, it is safe to call this
 * function.
 *
 * Return a unique channel ID. If max is reached, the used_channel_id counter
 * is returned.
 */
static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
{
	if (trace_ust_is_max_id(s->used_channel_id)) {
		return s->used_channel_id;
	}

	s->used_channel_id++;
	return s->next_channel_id++;
}

#ifdef HAVE_LIBLTTNG_UST_CTL

int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
		const void *_key);

/*
 * Lookup functions. NULL is returned if not found.
 */
struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
		char *name, struct lttng_filter_bytecode *filter, int loglevel,
		struct lttng_event_exclusion *exclusion);
struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
		char *name);
struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
		enum lttng_domain_type domain_type);

/*
 * Create functions malloc() the data structure.
 */
struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
		enum lttng_domain_type domain);
struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
		char *filter_expression,
		struct lttng_filter_bytecode *filter,
		struct lttng_event_exclusion *exclusion,
		bool internal_event);
struct ltt_ust_context *trace_ust_create_context(
		struct lttng_event_context *ctx);
int trace_ust_match_context(struct ltt_ust_context *uctx,
		struct lttng_event_context *ctx);
void trace_ust_delete_channel(struct lttng_ht *ht,
		struct ltt_ust_channel *channel);

/*
 * Destroy functions free() the data structure and remove from linked list if
 * it's applies.
 */
void trace_ust_destroy_session(struct ltt_ust_session *session);
void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
void trace_ust_destroy_event(struct ltt_ust_event *event);

int trace_ust_track_pid(struct ltt_ust_session *session, int pid);
int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid);

int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid);

ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
		int32_t **_pids);

#else /* HAVE_LIBLTTNG_UST_CTL */

static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
		const void *_key)
{
	return 0;
}
static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
		const void *_key)
{
	return 0;
}
static inline
struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
		char *name)
{
	return NULL;
}

static inline
struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
{
	return NULL;
}
static inline
struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
		enum lttng_domain_type domain)
{
	return NULL;
}
static inline
struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
		const char *filter_expression,
		struct lttng_filter_bytecode *filter,
		struct lttng_event_exclusion *exclusion,
		bool internal_event)
{
	return NULL;
}
static inline
void trace_ust_destroy_session(struct ltt_ust_session *session)
{
}

static inline
void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
{
}

static inline
void trace_ust_destroy_event(struct ltt_ust_event *event)
{
}
static inline
struct ltt_ust_context *trace_ust_create_context(
		struct lttng_event_context *ctx)
{
	return NULL;
}
static inline
int trace_ust_match_context(struct ltt_ust_context *uctx,
		struct lttng_event_context *ctx)
{
	return 0;
}
static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
		char *name, struct lttng_filter_bytecode *filter, int loglevel,
		struct lttng_event_exclusion *exclusion)
{
	return NULL;
}
static inline
void trace_ust_delete_channel(struct lttng_ht *ht,
		struct ltt_ust_channel *channel)
{
	return;
}
static inline
struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
		enum lttng_domain_type domain_type)
{
	return NULL;
}
static inline
int trace_ust_track_pid(struct ltt_ust_session *session, int pid)
{
	return 0;
}
static inline
int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
{
	return 0;
}
static inline
int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
{
	return 0;
}
static inline
ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
		int32_t **_pids)
{
	return -1;
}
#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* _LTT_TRACE_UST_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_TRACE_UST_H
	19	#define _LTT_TRACE_UST_H
	20
	21	#include <config.h>
	22	#include <limits.h>
	23	#include <urcu/list.h>
	24
	25	#include <lttng/lttng.h>
	26	#include <common/hashtable/hashtable.h>
	27	#include <common/defaults.h>
	28
	29	#include "consumer.h"
	30	#include "agent.h"
	31	#include "ust-ctl.h"
	32
	33	struct ltt_ust_ht_key {
	34	const char *name;
	35	const struct lttng_filter_bytecode *filter;
	36	enum lttng_ust_loglevel_type loglevel;
	37	const struct lttng_event_exclusion *exclusion;
	38	};
	39
	40	/* Context hash table nodes */
	41	struct ltt_ust_context {
	42	struct lttng_ust_context ctx;
	43	struct lttng_ht_node_ulong node;
	44	struct cds_list_head list;
	45	};
	46
	47	/* UST event */
	48	struct ltt_ust_event {
	49	unsigned int enabled;
	50	struct lttng_ust_event attr;
	51	struct lttng_ht_node_str node;
	52	char *filter_expression;
	53	struct lttng_filter_bytecode *filter;
	54	struct lttng_event_exclusion *exclusion;
	55	bool internal;
	56	};
	57
	58	/* UST channel */
	59	struct ltt_ust_channel {
	60	uint64_t id; /* unique id per session. */
	61	unsigned int enabled;
	62	/*
	63	* A UST channel can be part of a userspace sub-domain such as JUL,
	64	* Log4j, Python.
	65	*/
	66	enum lttng_domain_type domain;
	67	char name[LTTNG_UST_SYM_NAME_LEN];
	68	struct lttng_ust_channel_attr attr;
	69	struct lttng_ht *ctx;
	70	struct cds_list_head ctx_list;
	71	struct lttng_ht *events;
	72	struct lttng_ht_node_str node;
	73	uint64_t tracefile_size;
	74	uint64_t tracefile_count;
	75	};
	76
	77	/* UST domain global (LTTNG_DOMAIN_UST) */
	78	struct ltt_ust_domain_global {
	79	struct lttng_ht *channels;
	80	struct cds_list_head registry_buffer_uid_list;
	81	};
	82
	83	struct ust_pid_tracker_node {
	84	struct lttng_ht_node_ulong node;
	85	};
	86
	87	struct ust_pid_tracker {
	88	struct lttng_ht *ht;
	89	};
	90
	91	/* UST session */
	92	struct ltt_ust_session {
	93	uint64_t id; /* Unique identifier of session */
	94	struct ltt_ust_domain_global domain_global;
	95	/* Hash table of agent indexed by agent domain. */
	96	struct lttng_ht *agents;
	97	/* UID/GID of the user owning the session */
	98	uid_t uid;
	99	gid_t gid;
	100	/* Is the session active meaning has is been started or stopped. */
	101	unsigned int active:1;
	102	struct consumer_output *consumer;
	103	/* Sequence number for filters so the tracer knows the ordering. */
	104	uint64_t filter_seq_num;
	105	/* This indicates which type of buffer this session is set for. */
	106	enum lttng_buffer_type buffer_type;
	107	/* If set to 1, the buffer_type can not be changed anymore. */
	108	int buffer_type_changed;
	109	/* For per UID buffer, every buffer reg object is kept of this session */
	110	struct cds_list_head buffer_reg_uid_list;
	111	/* Next channel ID available for a newly registered channel. */
	112	uint64_t next_channel_id;
	113	/* Once this value reaches UINT32_MAX, no more id can be allocated. */
	114	uint64_t used_channel_id;
	115	/* Tell or not if the session has to output the traces. */
	116	unsigned int output_traces;
	117	unsigned int snapshot_mode;
	118	unsigned int has_non_default_channel;
	119	unsigned int live_timer_interval; /* usec */
	120
	121	/* Metadata channel attributes. */
	122	struct lttng_ust_channel_attr metadata_attr;
	123
	124	/*
	125	* Path where to keep the shared memory files.
	126	*/
	127	char root_shm_path[PATH_MAX];
	128	char shm_path[PATH_MAX];
	129
	130	struct ust_pid_tracker pid_tracker;
	131	};
	132
	133	/*
	134	* Validate that the id has reached the maximum allowed or not.
	135	*
	136	* Return 0 if NOT else 1.
	137	*/
	138	static inline int trace_ust_is_max_id(uint64_t id)
	139	{
	140	return (id == UINT64_MAX) ? 1 : 0;
	141	}
	142
	143	/*
	144	* Return next available channel id and increment the used counter. The
	145	* trace_ust_is_max_id function MUST be called before in order to validate if
	146	* the maximum number of IDs have been reached. If not, it is safe to call this
	147	* function.
	148	*
	149	* Return a unique channel ID. If max is reached, the used_channel_id counter
	150	* is returned.
	151	*/
	152	static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
	153	{
	154	if (trace_ust_is_max_id(s->used_channel_id)) {
	155	return s->used_channel_id;
	156	}
	157
	158	s->used_channel_id++;
	159	return s->next_channel_id++;
	160	}
	161
	162	#ifdef HAVE_LIBLTTNG_UST_CTL
	163
	164	int trace_ust_ht_match_event(struct cds_lfht_node node, const void _key);
	165	int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
	166	const void *_key);
	167
	168	/*
	169	* Lookup functions. NULL is returned if not found.
	170	*/
	171	struct ltt_ust_event trace_ust_find_event(struct lttng_ht ht,
	172	char name, struct lttng_filter_bytecode filter, int loglevel,
	173	struct lttng_event_exclusion *exclusion);
	174	struct ltt_ust_channel trace_ust_find_channel_by_name(struct lttng_ht ht,
	175	char *name);
	176	struct agent trace_ust_find_agent(struct ltt_ust_session session,
	177	enum lttng_domain_type domain_type);
	178
	179	/*
	180	* Create functions malloc() the data structure.
	181	*/
	182	struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
	183	struct ltt_ust_channel trace_ust_create_channel(struct lttng_channel attr,
	184	enum lttng_domain_type domain);
	185	struct ltt_ust_event trace_ust_create_event(struct lttng_event ev,
	186	char *filter_expression,
	187	struct lttng_filter_bytecode *filter,
	188	struct lttng_event_exclusion *exclusion,
	189	bool internal_event);
	190	struct ltt_ust_context *trace_ust_create_context(
	191	struct lttng_event_context *ctx);
	192	int trace_ust_match_context(struct ltt_ust_context *uctx,
	193	struct lttng_event_context *ctx);
	194	void trace_ust_delete_channel(struct lttng_ht *ht,
	195	struct ltt_ust_channel *channel);
	196
	197	/*
	198	* Destroy functions free() the data structure and remove from linked list if
	199	* it's applies.
	200	*/
	201	void trace_ust_destroy_session(struct ltt_ust_session *session);
	202	void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
	203	void trace_ust_destroy_event(struct ltt_ust_event *event);
	204
	205	int trace_ust_track_pid(struct ltt_ust_session *session, int pid);
	206	int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid);
	207
	208	int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid);
	209
	210	ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
	211	int32_t **_pids);
	212
	213	#else /* HAVE_LIBLTTNG_UST_CTL */
	214
	215	static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
	216	const void *_key)
	217	{
	218	return 0;
	219	}
	220	static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
	221	const void *_key)
	222	{
	223	return 0;
	224	}
	225	static inline
	226	struct ltt_ust_channel trace_ust_find_channel_by_name(struct lttng_ht ht,
	227	char *name)
	228	{
	229	return NULL;
	230	}
	231
	232	static inline
	233	struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
	234	{
	235	return NULL;
	236	}
	237	static inline
	238	struct ltt_ust_channel trace_ust_create_channel(struct lttng_channel attr,
	239	enum lttng_domain_type domain)
	240	{
	241	return NULL;
	242	}
	243	static inline
	244	struct ltt_ust_event trace_ust_create_event(struct lttng_event ev,
	245	const char *filter_expression,
	246	struct lttng_filter_bytecode *filter,
	247	struct lttng_event_exclusion *exclusion,
	248	bool internal_event)
	249	{
	250	return NULL;
	251	}
	252	static inline
	253	void trace_ust_destroy_session(struct ltt_ust_session *session)
	254	{
	255	}
	256
	257	static inline
	258	void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
	259	{
	260	}
	261
	262	static inline
	263	void trace_ust_destroy_event(struct ltt_ust_event *event)
	264	{
	265	}
	266	static inline
	267	struct ltt_ust_context *trace_ust_create_context(
	268	struct lttng_event_context *ctx)
	269	{
	270	return NULL;
	271	}
	272	static inline
	273	int trace_ust_match_context(struct ltt_ust_context *uctx,
	274	struct lttng_event_context *ctx)
	275	{
	276	return 0;
	277	}
	278	static inline struct ltt_ust_event trace_ust_find_event(struct lttng_ht ht,
	279	char name, struct lttng_filter_bytecode filter, int loglevel,
	280	struct lttng_event_exclusion *exclusion)
	281	{
	282	return NULL;
	283	}
	284	static inline
	285	void trace_ust_delete_channel(struct lttng_ht *ht,
	286	struct ltt_ust_channel *channel)
	287	{
	288	return;
	289	}
	290	static inline
	291	struct agent trace_ust_find_agent(struct ltt_ust_session session,
	292	enum lttng_domain_type domain_type)
	293	{
	294	return NULL;
	295	}
	296	static inline
	297	int trace_ust_track_pid(struct ltt_ust_session *session, int pid)
	298	{
	299	return 0;
	300	}
	301	static inline
	302	int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
	303	{
	304	return 0;
	305	}
	306	static inline
	307	int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
	308	{
	309	return 0;
	310	}
	311	static inline
	312	ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
	313	int32_t **_pids)
	314	{
	315	return -1;
	316	}
	317	#endif /* HAVE_LIBLTTNG_UST_CTL */
	318
	319	#endif /* _LTT_TRACE_UST_H */