[lttng-modules.git] / ltt-debugfs-abi.h

#ifndef _LTT_DEBUGFS_ABI_H
#define _LTT_DEBUGFS_ABI_H

/*
 * ltt-debugfs-abi.h
 *
 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * LTTng debugfs ABI header
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#include <linux/fs.h>

#define LTTNG_SYM_NAME_LEN	128

enum lttng_kernel_instrumentation {
	LTTNG_KERNEL_TRACEPOINT,
	LTTNG_KERNEL_KPROBE,
	LTTNG_KERNEL_FUNCTION,
};

/*
 * LTTng DebugFS ABI structures.
 */

struct lttng_kernel_channel {
	int overwrite;				/* 1: overwrite, 0: discard */
	uint64_t subbuf_size;			/* in bytes */
	uint64_t num_subbuf;
	unsigned int switch_timer_interval;	/* usecs */
	unsigned int read_timer_interval;	/* usecs */
};

/*
 * Either addr is used, or symbol_name and offset.
 */
struct lttng_kernel_kprobe {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_SYM_NAME_LEN];
};

struct lttng_kernel_function_tracer {
	char symbol_name[LTTNG_SYM_NAME_LEN];
};

struct lttng_kernel_event {
	char name[LTTNG_SYM_NAME_LEN];	/* event name */
	enum lttng_kernel_instrumentation instrumentation;
	/* Per instrumentation type configuration */
	union {
		struct lttng_kernel_kprobe kprobe;
		struct lttng_kernel_function_tracer ftrace;
	} u;
};

struct lttng_kernel_tracer_version {
	uint32_t version;
	uint32_t patchlevel;
	uint32_t sublevel;
};

enum lttng_kernel_context_type {
	LTTNG_KERNEL_CONTEXT_PID,
	LTTNG_KERNEL_CONTEXT_PERF_COUNTER,
	LTTNG_KERNEL_CONTEXT_COMM,
	LTTNG_KERNEL_CONTEXT_PRIO,
	LTTNG_KERNEL_CONTEXT_NICE,
};

struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
};

struct lttng_kernel_context {
	enum lttng_kernel_context_type ctx;
	union {
		struct lttng_kernel_perf_counter_ctx perf_counter;
	} u;
};

/* LTTng file descriptor ioctl */
#define LTTNG_KERNEL_SESSION			_IO(0xF6, 0x40)
#define LTTNG_KERNEL_TRACER_VERSION		\
	_IOR(0xF6, 0x41, struct lttng_kernel_tracer_version)
#define LTTNG_KERNEL_TRACEPOINT_LIST		_IO(0xF6, 0x42)

/* Session FD ioctl */
#define LTTNG_KERNEL_METADATA			\
	_IOW(0xF6, 0x50, struct lttng_kernel_channel)
#define LTTNG_KERNEL_CHANNEL			\
	_IOW(0xF6, 0x51, struct lttng_kernel_channel)
#define LTTNG_KERNEL_SESSION_START		_IO(0xF6, 0x52)
#define LTTNG_KERNEL_SESSION_STOP		_IO(0xF6, 0x53)

/* Channel FD ioctl */
#define LTTNG_KERNEL_STREAM			_IO(0xF6, 0x60)
#define LTTNG_KERNEL_EVENT			\
	_IOW(0xF6, 0x61, struct lttng_kernel_event)

/* Event and Channel FD ioctl */
#define LTTNG_KERNEL_CONTEXT			\
	_IOW(0xF6, 0x70, struct lttng_kernel_context)

#endif /* _LTT_DEBUGFS_ABI_H */
Commit	Line	Data
	1	#ifndef _LTT_DEBUGFS_ABI_H
	2	#define _LTT_DEBUGFS_ABI_H
	3
	4	/*
	5	* ltt-debugfs-abi.h
	6	*
	7	* Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* LTTng debugfs ABI header
	10	*
	11	* Dual LGPL v2.1/GPL v2 license.
	12	*/
	13
	14	#include <linux/fs.h>
	15
	16	#define LTTNG_SYM_NAME_LEN 128
	17
	18	enum lttng_kernel_instrumentation {
	19	LTTNG_KERNEL_TRACEPOINT,
	20	LTTNG_KERNEL_KPROBE,
	21	LTTNG_KERNEL_FUNCTION,
	22	};
	23
	24	/*
	25	* LTTng DebugFS ABI structures.
	26	*/
	27
	28	struct lttng_kernel_channel {
	29	int overwrite; /* 1: overwrite, 0: discard */
	30	uint64_t subbuf_size; /* in bytes */
	31	uint64_t num_subbuf;
	32	unsigned int switch_timer_interval; /* usecs */
	33	unsigned int read_timer_interval; /* usecs */
	34	};
	35
	36	/*
	37	* Either addr is used, or symbol_name and offset.
	38	*/
	39	struct lttng_kernel_kprobe {
	40	uint64_t addr;
	41
	42	uint64_t offset;
	43	char symbol_name[LTTNG_SYM_NAME_LEN];
	44	};
	45
	46	struct lttng_kernel_function_tracer {
	47	char symbol_name[LTTNG_SYM_NAME_LEN];
	48	};
	49
	50	struct lttng_kernel_event {
	51	char name[LTTNG_SYM_NAME_LEN]; /* event name */
	52	enum lttng_kernel_instrumentation instrumentation;
	53	/* Per instrumentation type configuration */
	54	union {
	55	struct lttng_kernel_kprobe kprobe;
	56	struct lttng_kernel_function_tracer ftrace;
	57	} u;
	58	};
	59
	60	struct lttng_kernel_tracer_version {
	61	uint32_t version;
	62	uint32_t patchlevel;
	63	uint32_t sublevel;
	64	};
	65
	66	enum lttng_kernel_context_type {
	67	LTTNG_KERNEL_CONTEXT_PID,
	68	LTTNG_KERNEL_CONTEXT_PERF_COUNTER,
	69	LTTNG_KERNEL_CONTEXT_COMM,
	70	LTTNG_KERNEL_CONTEXT_PRIO,
	71	LTTNG_KERNEL_CONTEXT_NICE,
	72	};
	73
	74	struct lttng_kernel_perf_counter_ctx {
	75	uint32_t type;
	76	uint64_t config;
	77	};
	78
	79	struct lttng_kernel_context {
	80	enum lttng_kernel_context_type ctx;
	81	union {
	82	struct lttng_kernel_perf_counter_ctx perf_counter;
	83	} u;
	84	};
	85
	86	/* LTTng file descriptor ioctl */
	87	#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x40)
	88	#define LTTNG_KERNEL_TRACER_VERSION \
	89	_IOR(0xF6, 0x41, struct lttng_kernel_tracer_version)
	90	#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x42)
	91
	92	/* Session FD ioctl */
	93	#define LTTNG_KERNEL_METADATA \
	94	_IOW(0xF6, 0x50, struct lttng_kernel_channel)
	95	#define LTTNG_KERNEL_CHANNEL \
	96	_IOW(0xF6, 0x51, struct lttng_kernel_channel)
	97	#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x52)
	98	#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x53)
	99
	100	/* Channel FD ioctl */
	101	#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x60)
	102	#define LTTNG_KERNEL_EVENT \
	103	_IOW(0xF6, 0x61, struct lttng_kernel_event)
	104
	105	/* Event and Channel FD ioctl */
	106	#define LTTNG_KERNEL_CONTEXT \
	107	_IOW(0xF6, 0x70, struct lttng_kernel_context)
	108
	109	#endif /* _LTT_DEBUGFS_ABI_H */