[lttng-tools.git] / src / bin / lttng-sessiond / trace-kernel.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_KERNEL_H
#define _LTT_TRACE_KERNEL_H

#include <urcu/list.h>

#include <lttng/lttng.h>
#include <common/lttng-kernel.h>
#include <common/lttng-kernel-old.h>
#include <common/defaults.h>

#include "consumer.h"

/* Kernel event list */
struct ltt_kernel_event_list {
	struct cds_list_head head;
};

/* Channel stream list */
struct ltt_kernel_stream_list {
	struct cds_list_head head;
};

/* Channel list */
struct ltt_kernel_channel_list {
	struct cds_list_head head;
};

struct ltt_kernel_context {
	struct lttng_kernel_context ctx;
	struct cds_list_head list;
	/* Indicates whether or not the context is in a list. */
	bool in_list;
};

/* Kernel event */
struct ltt_kernel_event {
	int fd;
	int enabled;
	enum lttng_event_type type;
	struct lttng_kernel_event *event;
	struct cds_list_head list;
	char *filter_expression;
	struct lttng_filter_bytecode *filter;
};

/* Kernel channel */
struct ltt_kernel_channel {
	int fd;
	uint64_t key; /* Key to reference this channel with the consumer. */
	int enabled;
	unsigned int stream_count;
	unsigned int event_count;
	bool published_to_notification_thread;
	struct cds_list_head ctx_list;
	struct lttng_channel *channel;
	struct ltt_kernel_event_list events_list;
	struct ltt_kernel_stream_list stream_list;
	struct cds_list_head list;
	/* Session pointer which has a reference to this object. */
	struct ltt_kernel_session *session;
	bool sent_to_consumer;
};

/* Metadata */
struct ltt_kernel_metadata {
	int fd;
	uint64_t key; /* Key to reference this channel with the consumer. */
	struct lttng_channel *conf;
};

/* Channel stream */
struct ltt_kernel_stream {
	int fd;
	int state;
	int cpu;
	bool sent_to_consumer;
	/* Format is %s_%d respectively channel name and CPU number. */
	char name[DEFAULT_STREAM_NAME_LEN];
	uint64_t tracefile_size;
	uint64_t tracefile_count;
	struct cds_list_head list;
};

/* Kernel session */
struct ltt_kernel_session {
	int fd;
	int metadata_stream_fd;
	int consumer_fds_sent;
	unsigned int channel_count;
	unsigned int stream_count_global;
	struct ltt_kernel_metadata *metadata;
	struct ltt_kernel_channel_list channel_list;
	/* UID/GID of the user owning the session */
	uid_t uid;
	gid_t gid;
	struct consumer_output *consumer;
	/* Tracing session id */
	uint64_t id;
	/* Session is active or not meaning it has been started or stopped. */
	unsigned int active:1;
	/* 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;
};

/*
 * Lookup functions. NULL is returned if not found.
 */
struct ltt_kernel_event *trace_kernel_get_event_by_name(
		char *name, struct ltt_kernel_channel *channel,
		enum lttng_event_type type);
struct ltt_kernel_event *trace_kernel_find_event(
		char *name, struct ltt_kernel_channel *channel,
		enum lttng_event_type type,
		struct lttng_filter_bytecode *filter);
struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
		char *name, struct ltt_kernel_session *session);

/*
 * Create functions malloc() the data structure.
 */
struct ltt_kernel_session *trace_kernel_create_session(void);
struct ltt_kernel_channel *trace_kernel_create_channel(
		struct lttng_channel *chan);
struct ltt_kernel_event *trace_kernel_create_event(struct lttng_event *ev,
		char *filter_expression, struct lttng_filter_bytecode *filter);
struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
struct ltt_kernel_stream *trace_kernel_create_stream(const char *name,
		unsigned int count);
struct ltt_kernel_context *trace_kernel_create_context(
		struct lttng_kernel_context *ctx);
struct ltt_kernel_context *trace_kernel_copy_context(
		struct ltt_kernel_context *ctx);

/*
 * Destroy functions free() the data structure and remove from linked list if
 * it's applies.
 */
void trace_kernel_destroy_session(struct ltt_kernel_session *session);
void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
void trace_kernel_destroy_event(struct ltt_kernel_event *event);
void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);

#endif /* _LTT_TRACE_KERNEL_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_KERNEL_H
	19	#define _LTT_TRACE_KERNEL_H
	20
	21	#include <urcu/list.h>
	22
	23	#include <lttng/lttng.h>
	24	#include <common/lttng-kernel.h>
	25	#include <common/lttng-kernel-old.h>
	26	#include <common/defaults.h>
	27
	28	#include "consumer.h"
	29
	30	/* Kernel event list */
	31	struct ltt_kernel_event_list {
	32	struct cds_list_head head;
	33	};
	34
	35	/* Channel stream list */
	36	struct ltt_kernel_stream_list {
	37	struct cds_list_head head;
	38	};
	39
	40	/* Channel list */
	41	struct ltt_kernel_channel_list {
	42	struct cds_list_head head;
	43	};
	44
	45	struct ltt_kernel_context {
	46	struct lttng_kernel_context ctx;
	47	struct cds_list_head list;
	48	/* Indicates whether or not the context is in a list. */
	49	bool in_list;
	50	};
	51
	52	/* Kernel event */
	53	struct ltt_kernel_event {
	54	int fd;
	55	int enabled;
	56	enum lttng_event_type type;
	57	struct lttng_kernel_event *event;
	58	struct cds_list_head list;
	59	char *filter_expression;
	60	struct lttng_filter_bytecode *filter;
	61	};
	62
	63	/* Kernel channel */
	64	struct ltt_kernel_channel {
	65	int fd;
	66	uint64_t key; /* Key to reference this channel with the consumer. */
	67	int enabled;
	68	unsigned int stream_count;
	69	unsigned int event_count;
	70	bool published_to_notification_thread;
	71	struct cds_list_head ctx_list;
	72	struct lttng_channel *channel;
	73	struct ltt_kernel_event_list events_list;
	74	struct ltt_kernel_stream_list stream_list;
	75	struct cds_list_head list;
	76	/* Session pointer which has a reference to this object. */
	77	struct ltt_kernel_session *session;
	78	bool sent_to_consumer;
	79	};
	80
	81	/* Metadata */
	82	struct ltt_kernel_metadata {
	83	int fd;
	84	uint64_t key; /* Key to reference this channel with the consumer. */
	85	struct lttng_channel *conf;
	86	};
	87
	88	/* Channel stream */
	89	struct ltt_kernel_stream {
	90	int fd;
	91	int state;
	92	int cpu;
	93	bool sent_to_consumer;
	94	/* Format is %s_%d respectively channel name and CPU number. */
	95	char name[DEFAULT_STREAM_NAME_LEN];
	96	uint64_t tracefile_size;
	97	uint64_t tracefile_count;
	98	struct cds_list_head list;
	99	};
	100
	101	/* Kernel session */
	102	struct ltt_kernel_session {
	103	int fd;
	104	int metadata_stream_fd;
	105	int consumer_fds_sent;
	106	unsigned int channel_count;
	107	unsigned int stream_count_global;
	108	struct ltt_kernel_metadata *metadata;
	109	struct ltt_kernel_channel_list channel_list;
	110	/* UID/GID of the user owning the session */
	111	uid_t uid;
	112	gid_t gid;
	113	struct consumer_output *consumer;
	114	/* Tracing session id */
	115	uint64_t id;
	116	/* Session is active or not meaning it has been started or stopped. */
	117	unsigned int active:1;
	118	/* Tell or not if the session has to output the traces. */
	119	unsigned int output_traces;
	120	unsigned int snapshot_mode;
	121	unsigned int has_non_default_channel;
	122	};
	123
	124	/*
	125	* Lookup functions. NULL is returned if not found.
	126	*/
	127	struct ltt_kernel_event *trace_kernel_get_event_by_name(
	128	char name, struct ltt_kernel_channel channel,
	129	enum lttng_event_type type);
	130	struct ltt_kernel_event *trace_kernel_find_event(
	131	char name, struct ltt_kernel_channel channel,
	132	enum lttng_event_type type,
	133	struct lttng_filter_bytecode *filter);
	134	struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
	135	char name, struct ltt_kernel_session session);
	136
	137	/*
	138	* Create functions malloc() the data structure.
	139	*/
	140	struct ltt_kernel_session *trace_kernel_create_session(void);
	141	struct ltt_kernel_channel *trace_kernel_create_channel(
	142	struct lttng_channel *chan);
	143	struct ltt_kernel_event trace_kernel_create_event(struct lttng_event ev,
	144	char filter_expression, struct lttng_filter_bytecode filter);
	145	struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
	146	struct ltt_kernel_stream trace_kernel_create_stream(const char name,
	147	unsigned int count);
	148	struct ltt_kernel_context *trace_kernel_create_context(
	149	struct lttng_kernel_context *ctx);
	150	struct ltt_kernel_context *trace_kernel_copy_context(
	151	struct ltt_kernel_context *ctx);
	152
	153	/*
	154	* Destroy functions free() the data structure and remove from linked list if
	155	* it's applies.
	156	*/
	157	void trace_kernel_destroy_session(struct ltt_kernel_session *session);
	158	void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
	159	void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
	160	void trace_kernel_destroy_event(struct ltt_kernel_event *event);
	161	void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
	162	void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
	163
	164	#endif /* _LTT_TRACE_KERNEL_H */