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

/* Kernel event */
struct ltt_kernel_event {
	int fd;
	int enabled;
	/*
	 * TODO: need internal representation to support more than a
	 * single context.
	 */
	struct lttng_kernel_context *ctx;
	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;
	/*
	 * TODO: need internal representation to support more than a
	 * single context.
	 */
	struct lttng_kernel_context *ctx;
	struct lttng_channel *channel;
	struct ltt_kernel_event_list events_list;
	struct ltt_kernel_stream_list stream_list;
	struct cds_list_head list;
};

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

/* Channel stream */
struct ltt_kernel_stream {
	int fd;
	int state;
	/* Format is %s_%d respectively channel name and CPU number. */
	char name[LTTNG_SYMBOL_NAME_LEN];
	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;
	char *trace_path;
	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 */
	unsigned int id;
};

/*
 * 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);
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(char *path);
struct ltt_kernel_channel *trace_kernel_create_channel(struct lttng_channel *chan, char *path);
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);

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

#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
	27	#include "consumer.h"
	28
	29	/* Kernel event list */
	30	struct ltt_kernel_event_list {
	31	struct cds_list_head head;
	32	};
	33
	34	/* Channel stream list */
	35	struct ltt_kernel_stream_list {
	36	struct cds_list_head head;
	37	};
	38
	39	/* Channel list */
	40	struct ltt_kernel_channel_list {
	41	struct cds_list_head head;
	42	};
	43
	44	/* Kernel event */
	45	struct ltt_kernel_event {
	46	int fd;
	47	int enabled;
	48	/*
	49	* TODO: need internal representation to support more than a
	50	* single context.
	51	*/
	52	struct lttng_kernel_context *ctx;
	53	struct lttng_kernel_event *event;
	54	struct cds_list_head list;
	55	};
	56
	57	/* Kernel channel */
	58	struct ltt_kernel_channel {
	59	int fd;
	60	int enabled;
	61	unsigned int stream_count;
	62	unsigned int event_count;
	63	/*
	64	* TODO: need internal representation to support more than a
	65	* single context.
	66	*/
	67	struct lttng_kernel_context *ctx;
	68	struct lttng_channel *channel;
	69	struct ltt_kernel_event_list events_list;
	70	struct ltt_kernel_stream_list stream_list;
	71	struct cds_list_head list;
	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	/* Format is %s_%d respectively channel name and CPU number. */
	85	char name[LTTNG_SYMBOL_NAME_LEN];
	86	struct cds_list_head list;
	87	};
	88
	89	/* Kernel session */
	90	struct ltt_kernel_session {
	91	int fd;
	92	int metadata_stream_fd;
	93	int consumer_fds_sent;
	94	unsigned int channel_count;
	95	unsigned int stream_count_global;
	96	char *trace_path;
	97	struct ltt_kernel_metadata *metadata;
	98	struct ltt_kernel_channel_list channel_list;
	99	/* UID/GID of the user owning the session */
	100	uid_t uid;
	101	gid_t gid;
	102	/*
	103	* Two consumer_output object are needed where one is needed for the
	104	* current output object and the second one is the temporary object used to
	105	* store URI being set by the lttng_set_consumer_uri call. Once
	106	* lttng_enable_consumer is called, the two pointers are swapped.
	107	*/
	108	struct consumer_output *consumer;
	109	struct consumer_output *tmp_consumer;
	110	/* Tracing session id */
	111	unsigned int id;
	112	};
	113
	114	/*
	115	* Lookup functions. NULL is returned if not found.
	116	*/
	117	struct ltt_kernel_event *trace_kernel_get_event_by_name(
	118	char name, struct ltt_kernel_channel channel);
	119	struct ltt_kernel_channel *trace_kernel_get_channel_by_name(
	120	char name, struct ltt_kernel_session session);
	121
	122	/*
	123	* Create functions malloc() the data structure.
	124	*/
	125	struct ltt_kernel_session trace_kernel_create_session(char path);
	126	struct ltt_kernel_channel trace_kernel_create_channel(struct lttng_channel chan, char *path);
	127	struct ltt_kernel_event trace_kernel_create_event(struct lttng_event ev);
	128	struct ltt_kernel_metadata *trace_kernel_create_metadata(void);
	129	struct ltt_kernel_stream trace_kernel_create_stream(const char name,
	130	unsigned int count);
	131
	132	/*
	133	* Destroy functions free() the data structure and remove from linked list if
	134	* it's applies.
	135	*/
	136	void trace_kernel_destroy_session(struct ltt_kernel_session *session);
	137	void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
	138	void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
	139	void trace_kernel_destroy_event(struct ltt_kernel_event *event);
	140	void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
	141
	142	#endif /* _LTT_TRACE_KERNEL_H */