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

#ifndef _LTTNG_ABI_H
#define _LTTNG_ABI_H

/*
 * lttng-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	256

enum lttng_kernel_instrumentation {
	LTTNG_KERNEL_TRACEPOINT	= 0,
	LTTNG_KERNEL_KPROBE	= 1,
	LTTNG_KERNEL_FUNCTION	= 2,
	LTTNG_KERNEL_KRETPROBE	= 3,
	LTTNG_KERNEL_NOOP	= 4,	/* not hooked */
	LTTNG_KERNEL_SYSCALL	= 5,
};

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

struct lttng_kernel_kretprobe {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_SYM_NAME_LEN];
};

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

/*
 * For syscall tracing, name = '\0' means "enable all".
 */
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_kretprobe kretprobe;
		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_calibrate_type {
	LTTNG_KERNEL_CALIBRATE_KRETPROBE,
};

struct lttng_kernel_calibrate {
	enum lttng_kernel_calibrate_type type;	/* type (input) */
};

enum lttng_kernel_context_type {
	LTTNG_KERNEL_CONTEXT_PID		= 0,
	LTTNG_KERNEL_CONTEXT_PERF_COUNTER	= 1,
	LTTNG_KERNEL_CONTEXT_PROCNAME		= 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)
#define LTTNG_KERNEL_CALIBRATE			\
	_IOWR(0xF6, 0x44, struct lttng_kernel_calibrate)

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