[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 ABI header
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#include <linux/fs.h>

#define LTTNG_KERNEL_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_KERNEL_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_KERNEL_SYM_NAME_LEN];
};

struct lttng_kernel_function_tracer {
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
};

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