[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	= 0,
	LTTNG_KERNEL_KPROBE	= 1,
	LTTNG_KERNEL_FUNCTION	= 2,
};

/*
 * LTTng consumer mode
 */
enum lttng_kernel_output {
	LTTNG_KERNEL_SPLICE	= 0,
	LTTNG_KERNEL_MMAP	= 1,
};

/*
 * 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 */
	enum lttng_kernel_output output;	/* splice, mmap */
};

/*
 * 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		= 0,
	LTTNG_KERNEL_CONTEXT_PERF_COUNTER	= 1,
	LTTNG_KERNEL_CONTEXT_COMM		= 2,
	LTTNG_KERNEL_CONTEXT_PRIO		= 3,
	LTTNG_KERNEL_CONTEXT_NICE		= 4,
	LTTNG_KERNEL_CONTEXT_VPID		= 5,
	LTTNG_KERNEL_CONTEXT_TID		= 6,
	LTTNG_KERNEL_CONTEXT_VTID		= 7,
	LTTNG_KERNEL_CONTEXT_PPID		= 8,
	LTTNG_KERNEL_CONTEXT_VPPID		= 9,
};

struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_SYM_NAME_LEN];
};

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)
#define LTTNG_KERNEL_WAIT_QUIESCENT		_IO(0xF6, 0x43)

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

/* Event, Channel and Session ioctl */
#define LTTNG_KERNEL_ENABLE			_IO(0xF6, 0x80)
#define LTTNG_KERNEL_DISABLE			_IO(0xF6, 0x81)

#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 = 0,
	20	LTTNG_KERNEL_KPROBE = 1,
	21	LTTNG_KERNEL_FUNCTION = 2,
	22	};
	23
	24	/*
	25	* LTTng consumer mode
	26	*/
	27	enum lttng_kernel_output {
	28	LTTNG_KERNEL_SPLICE = 0,
	29	LTTNG_KERNEL_MMAP = 1,
	30	};
	31
	32	/*
	33	* LTTng DebugFS ABI structures.
	34	*/
	35
	36	struct lttng_kernel_channel {
	37	int overwrite; /* 1: overwrite, 0: discard */
	38	uint64_t subbuf_size; /* in bytes */
	39	uint64_t num_subbuf;
	40	unsigned int switch_timer_interval; /* usecs */
	41	unsigned int read_timer_interval; /* usecs */
	42	enum lttng_kernel_output output; /* splice, mmap */
	43	};
	44
	45	/*
	46	* Either addr is used, or symbol_name and offset.
	47	*/
	48	struct lttng_kernel_kprobe {
	49	uint64_t addr;
	50
	51	uint64_t offset;
	52	char symbol_name[LTTNG_SYM_NAME_LEN];
	53	};
	54
	55	struct lttng_kernel_function_tracer {
	56	char symbol_name[LTTNG_SYM_NAME_LEN];
	57	};
	58
	59	struct lttng_kernel_event {
	60	char name[LTTNG_SYM_NAME_LEN]; /* event name */
	61	enum lttng_kernel_instrumentation instrumentation;
	62	/* Per instrumentation type configuration */
	63	union {
	64	struct lttng_kernel_kprobe kprobe;
	65	struct lttng_kernel_function_tracer ftrace;
	66	} u;
	67	};
	68
	69	struct lttng_kernel_tracer_version {
	70	uint32_t version;
	71	uint32_t patchlevel;
	72	uint32_t sublevel;
	73	};
	74
	75	enum lttng_kernel_context_type {
	76	LTTNG_KERNEL_CONTEXT_PID = 0,
	77	LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
	78	LTTNG_KERNEL_CONTEXT_COMM = 2,
	79	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	80	LTTNG_KERNEL_CONTEXT_NICE = 4,
	81	LTTNG_KERNEL_CONTEXT_VPID = 5,
	82	LTTNG_KERNEL_CONTEXT_TID = 6,
	83	LTTNG_KERNEL_CONTEXT_VTID = 7,
	84	LTTNG_KERNEL_CONTEXT_PPID = 8,
	85	LTTNG_KERNEL_CONTEXT_VPPID = 9,
	86	};
	87
	88	struct lttng_kernel_perf_counter_ctx {
	89	uint32_t type;
	90	uint64_t config;
	91	char name[LTTNG_SYM_NAME_LEN];
	92	};
	93
	94	struct lttng_kernel_context {
	95	enum lttng_kernel_context_type ctx;
	96	union {
	97	struct lttng_kernel_perf_counter_ctx perf_counter;
	98	} u;
	99	};
	100
	101	/* LTTng file descriptor ioctl */
	102	#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x40)
	103	#define LTTNG_KERNEL_TRACER_VERSION \
	104	_IOR(0xF6, 0x41, struct lttng_kernel_tracer_version)
	105	#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x42)
	106	#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x43)
	107
	108	/* Session FD ioctl */
	109	#define LTTNG_KERNEL_METADATA \
	110	_IOW(0xF6, 0x50, struct lttng_kernel_channel)
	111	#define LTTNG_KERNEL_CHANNEL \
	112	_IOW(0xF6, 0x51, struct lttng_kernel_channel)
	113	#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x52)
	114	#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x53)
	115
	116	/* Channel FD ioctl */
	117	#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x60)
	118	#define LTTNG_KERNEL_EVENT \
	119	_IOW(0xF6, 0x61, struct lttng_kernel_event)
	120
	121	/* Event and Channel FD ioctl */
	122	#define LTTNG_KERNEL_CONTEXT \
	123	_IOW(0xF6, 0x70, struct lttng_kernel_context)
	124
	125	/* Event, Channel and Session ioctl */
	126	#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x80)
	127	#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x81)
	128
	129	#endif /* _LTT_DEBUGFS_ABI_H */