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

/* 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;
};

/* Kernel channel */
struct ltt_kernel_channel {
	int fd;
	int enabled;
	unsigned int stream_count;
	unsigned int event_count;
	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;
};

/* Metadata */
struct ltt_kernel_metadata {
	int fd;
	struct lttng_channel *conf;
};

/* Channel stream */
struct ltt_kernel_stream {
	int fd;
	int state;
	int cpu;
	/* 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;
	/*
	 * Two consumer_output object are needed where one is needed for the
	 * current output object and the second one is the temporary object used to
	 * store URI being set by the lttng_set_consumer_uri call. Once
	 * lttng_enable_consumer is called, the two pointers are swapped.
	 */
	struct consumer_output *consumer;
	struct consumer_output *tmp_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_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);
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);

/*
 * 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	};
	49
	50	/* Kernel event */
	51	struct ltt_kernel_event {
	52	int fd;
	53	int enabled;
	54	enum lttng_event_type type;
	55	struct lttng_kernel_event *event;
	56	struct cds_list_head list;
	57	};
	58
	59	/* Kernel channel */
	60	struct ltt_kernel_channel {
	61	int fd;
	62	int enabled;
	63	unsigned int stream_count;
	64	unsigned int event_count;
	65	struct cds_list_head ctx_list;
	66	struct lttng_channel *channel;
	67	struct ltt_kernel_event_list events_list;
	68	struct ltt_kernel_stream_list stream_list;
	69	struct cds_list_head list;
	70	/* Session pointer which has a reference to this object. */
	71	struct ltt_kernel_session *session;
	72	};
	73
	74	/* Metadata */
	75	struct ltt_kernel_metadata {
	76	int fd;
	77	struct lttng_channel *conf;
	78	};
	79
	80	/* Channel stream */
	81	struct ltt_kernel_stream {
	82	int fd;
	83	int state;
	84	int cpu;
	85	/* Format is %s_%d respectively channel name and CPU number. */
	86	char name[DEFAULT_STREAM_NAME_LEN];
	87	uint64_t tracefile_size;
	88	uint64_t tracefile_count;
	89	struct cds_list_head list;
	90	};
	91
	92	/* Kernel session */
	93	struct ltt_kernel_session {
	94	int fd;
	95	int metadata_stream_fd;
	96	int consumer_fds_sent;
	97	unsigned int channel_count;
	98	unsigned int stream_count_global;
	99	struct ltt_kernel_metadata *metadata;
	100	struct ltt_kernel_channel_list channel_list;
	101	/* UID/GID of the user owning the session */
	102	uid_t uid;
	103	gid_t gid;
	104	/*
	105	* Two consumer_output object are needed where one is needed for the
	106	* current output object and the second one is the temporary object used to
	107	* store URI being set by the lttng_set_consumer_uri call. Once
	108	* lttng_enable_consumer is called, the two pointers are swapped.
	109	*/
	110	struct consumer_output *consumer;
	111	struct consumer_output *tmp_consumer;
	112	/* Tracing session id */
	113	uint64_t id;
	114	/* Session is active or not meaning it has been started or stopped. */
	115	unsigned int active:1;
	116	/* Tell or not if the session has to output the traces. */
	117	unsigned int output_traces;
	118	unsigned int snapshot_mode;
	119	unsigned int has_non_default_channel;
	120	};
	121
	122	/*
	123	* Lookup functions. NULL is returned if not found.
	124	*/
	125	struct ltt_kernel_event *trace_kernel_get_event_by_name(
	126	char name, struct ltt_kernel_channel channel,
	127	enum lttng_event_type type);
	128	struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
	129	char name, struct ltt_kernel_session session);
	130
	131	/*
	132	* Create functions malloc() the data structure.
	133	*/
	134	struct ltt_kernel_session *trace_kernel_create_session(void);
	135	struct ltt_kernel_channel *trace_kernel_create_channel(
	136	struct lttng_channel *chan);
	137	struct ltt_kernel_event trace_kernel_create_event(struct lttng_event ev);
	138	struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
	139	struct ltt_kernel_stream trace_kernel_create_stream(const char name,
	140	unsigned int count);
	141	struct ltt_kernel_context *trace_kernel_create_context(
	142	struct lttng_kernel_context *ctx);
	143
	144	/*
	145	* Destroy functions free() the data structure and remove from linked list if
	146	* it's applies.
	147	*/
	148	void trace_kernel_destroy_session(struct ltt_kernel_session *session);
	149	void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
	150	void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
	151	void trace_kernel_destroy_event(struct ltt_kernel_event *event);
	152	void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
	153	void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
	154
	155	#endif /* _LTT_TRACE_KERNEL_H */