[ust.git] / libust / channels.h

#ifndef UST_CHANNELS_H
#define UST_CHANNELS_H

/*
 * Copyright (C) 2008 Mathieu Desnoyers (mathieu.desnoyers@polymtl.ca)
 *
 * Dynamic tracer channel allocation.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <linux/limits.h>
#include <errno.h>

#include <ust/kernelcompat.h>
#include <kcompat/kref.h>

#define EVENTS_PER_CHANNEL	65536
#define MAX_CPUS		32

struct ltt_trace_struct;

struct ust_buffer;

struct ust_channel {
	/* First 32 bytes cache-hot cacheline */
	struct ltt_trace_struct	*trace;
	int *buf_struct_shmids;
	struct ust_buffer **buf;
	int overwrite:1;
	int active:1;
	unsigned int n_subbufs_order;
	unsigned long commit_count_mask;	/*
						 * Commit count mask, removing
						 * the MSBs corresponding to
						 * bits used to represent the
						 * subbuffer index.
						 */
	/* End of first 32 bytes cacheline */

	/*
	 * buffer_begin - called on buffer-switch to a new sub-buffer
	 * @buf: the channel buffer containing the new sub-buffer
	 */
	void (*buffer_begin) (struct ust_buffer *buf,
			u64 tsc, unsigned int subbuf_idx);
	/*
	 * buffer_end - called on buffer-switch to a new sub-buffer
	 * @buf: the channel buffer containing the previous sub-buffer
	 */
	void (*buffer_end) (struct ust_buffer *buf,
			u64 tsc, unsigned int offset, unsigned int subbuf_idx);
	struct kref kref;	/* Channel transport reference count */
	size_t subbuf_size;
	int subbuf_size_order;
	unsigned int subbuf_cnt;
	const char *channel_name;
	int n_cpus;

	u32 version;
	size_t alloc_size;
	struct list_head list;
} ____cacheline_aligned;

struct ltt_channel_setting {
	unsigned int subbuf_size;
	unsigned int subbuf_cnt;
	struct kref kref;	/* Number of references to structure content */
	struct list_head list;
	unsigned int index;	/* index of channel in trace channel array */
	u16 free_event_id;	/* Next event ID to allocate */
	char name[PATH_MAX];
};

extern int ltt_channels_register(const char *name);
extern int ltt_channels_unregister(const char *name);
extern int ltt_channels_set_default(const char *name,
			     unsigned int subbuf_size,
			     unsigned int subbuf_cnt);
extern const char *ltt_channels_get_name_from_index(unsigned int index);
extern int ltt_channels_get_index_from_name(const char *name);
extern struct ust_channel *ltt_channels_trace_alloc(unsigned int *nr_channels,
						    int overwrite,
						    int active);
extern void ltt_channels_trace_free(struct ust_channel *channels);
extern int _ltt_channels_get_event_id(const char *channel, const char *name);
extern int ltt_channels_get_event_id(const char *channel, const char *name);

#endif /* UST_CHANNELS_H */
Commit	Line	Data
23e47a47 PMF	1	#ifndef UST_CHANNELS_H
23e47a47 PMF	2	#define UST_CHANNELS_H
99054cee PMF	3
	4	/*
	5	* Copyright (C) 2008 Mathieu Desnoyers (mathieu.desnoyers@polymtl.ca)
	6	*
	7	* Dynamic tracer channel allocation.
8fc2d8db PMF	8	*
	9	* This library is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU Lesser General Public
	11	* License as published by the Free Software Foundation; either
	12	* version 2.1 of the License, or (at your option) any later version.
	13	*
	14	* This library is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* Lesser General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU Lesser General Public
	20	* License along with this library; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
99054cee PMF	22	*/
	23
	24	#include <linux/limits.h>
b6bf28ec	25	#include <errno.h>
59b161cd	26
fbca6b62	27	#include <ust/kernelcompat.h>
79d4d545	28	#include <kcompat/kref.h>
99054cee PMF	29
99054cee PMF	30	#define EVENTS_PER_CHANNEL 65536
204141ee	31	#define MAX_CPUS 32
99054cee PMF	32
99054cee PMF	33	struct ltt_trace_struct;
99054cee	34
b5b073e2 PMF	35	struct ust_buffer;
	36
	37	struct ust_channel {
99054cee PMF	38	/* First 32 bytes cache-hot cacheline */
99054cee PMF	39	struct ltt_trace_struct *trace;
204141ee PMF	40	int *buf_struct_shmids;
204141ee PMF	41	struct ust_buffer **buf;
99054cee PMF	42	int overwrite:1;
	43	int active:1;
	44	unsigned int n_subbufs_order;
	45	unsigned long commit_count_mask; /*
	46	* Commit count mask, removing
	47	* the MSBs corresponding to
	48	* bits used to represent the
	49	* subbuffer index.
	50	*/
	51	/* End of first 32 bytes cacheline */
	52
	53	/*
	54	* buffer_begin - called on buffer-switch to a new sub-buffer
	55	* @buf: the channel buffer containing the new sub-buffer
	56	*/
b5b073e2	57	void (buffer_begin) (struct ust_buffer buf,
99054cee PMF	58	u64 tsc, unsigned int subbuf_idx);
	59	/*
	60	* buffer_end - called on buffer-switch to a new sub-buffer
	61	* @buf: the channel buffer containing the previous sub-buffer
	62	*/
b5b073e2	63	void (buffer_end) (struct ust_buffer buf,
99054cee PMF	64	u64 tsc, unsigned int offset, unsigned int subbuf_idx);
99054cee PMF	65	struct kref kref; /* Channel transport reference count */
b5b073e2 PMF	66	size_t subbuf_size;
b5b073e2 PMF	67	int subbuf_size_order;
99054cee PMF	68	unsigned int subbuf_cnt;
99054cee PMF	69	const char *channel_name;
204141ee	70	int n_cpus;
b5b073e2 PMF	71
	72	u32 version;
	73	size_t alloc_size;
	74	struct list_head list;
99054cee PMF	75	} ____cacheline_aligned;
	76
	77	struct ltt_channel_setting {
	78	unsigned int subbuf_size;
	79	unsigned int subbuf_cnt;
	80	struct kref kref; /* Number of references to structure content */
	81	struct list_head list;
	82	unsigned int index; /* index of channel in trace channel array */
	83	u16 free_event_id; /* Next event ID to allocate */
	84	char name[PATH_MAX];
	85	};
	86
064842c6 PMF	87	extern int ltt_channels_register(const char *name);
	88	extern int ltt_channels_unregister(const char *name);
	89	extern int ltt_channels_set_default(const char *name,
99054cee PMF	90	unsigned int subbuf_size,
99054cee PMF	91	unsigned int subbuf_cnt);
064842c6 PMF	92	extern const char *ltt_channels_get_name_from_index(unsigned int index);
064842c6 PMF	93	extern int ltt_channels_get_index_from_name(const char *name);
b5b073e2	94	extern struct ust_channel ltt_channels_trace_alloc(unsigned int nr_channels,
99054cee PMF	95	int overwrite,
99054cee PMF	96	int active);
b5b073e2	97	extern void ltt_channels_trace_free(struct ust_channel *channels);
064842c6 PMF	98	extern int _ltt_channels_get_event_id(const char channel, const char name);
064842c6 PMF	99	extern int ltt_channels_get_event_id(const char channel, const char name);
99054cee	100
23e47a47	101	#endif /* UST_CHANNELS_H */