[lttng-tools.git] / src / common / lttng-kernel.h

/*
 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *                      David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTTNG_KERNEL_H
#define _LTTNG_KERNEL_H

#include <stdint.h>

#define LTTNG_KERNEL_SYM_NAME_LEN  256

/*
 * LTTng DebugFS ABI structures.
 *
 * This is the kernel ABI copied from lttng-modules tree.
 */

enum lttng_kernel_instrumentation {
	LTTNG_KERNEL_ALL           = -1,   /* Used within lttng-tools */
	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,
};

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,
};

/* Perf counter attributes */
struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_KERNEL_SYM_NAME_LEN];
};

/* Event/Channel context */
#define LTTNG_KERNEL_CONTEXT_PADDING1  16
#define LTTNG_KERNEL_CONTEXT_PADDING2  LTTNG_KERNEL_SYM_NAME_LEN + 32
struct lttng_kernel_context {
	enum lttng_kernel_context_type ctx;
	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];

	union {
		struct lttng_kernel_perf_counter_ctx perf_counter;
		char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
	} u;
};

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

/* Function tracer */
struct lttng_kernel_function {
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
};

#define LTTNG_KERNEL_EVENT_PADDING1    16
#define LTTNG_KERNEL_EVENT_PADDING2    LTTNG_KERNEL_SYM_NAME_LEN + 32
struct lttng_kernel_event {
	char name[LTTNG_KERNEL_SYM_NAME_LEN];
	enum lttng_kernel_instrumentation instrumentation;
	char padding[LTTNG_KERNEL_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		struct lttng_kernel_kretprobe kretprobe;
		struct lttng_kernel_kprobe kprobe;
		struct lttng_kernel_function ftrace;
		char padding[LTTNG_KERNEL_EVENT_PADDING2];
	} u;
};

struct lttng_kernel_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
};

enum lttng_kernel_calibrate_type {
	LTTNG_KERNEL_CALIBRATE_KRETPROBE,
};

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

#endif /* _LTTNG_KERNEL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	* David Goulet <david.goulet@polymtl.ca>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License, version 2 only,
	8	* as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; if not, write to the Free Software Foundation, Inc.,
	17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	18	*/
	19
	20	#ifndef _LTTNG_KERNEL_H
	21	#define _LTTNG_KERNEL_H
	22
	23	#include <stdint.h>
	24
	25	#define LTTNG_KERNEL_SYM_NAME_LEN 256
	26
	27	/*
	28	* LTTng DebugFS ABI structures.
	29	*
	30	* This is the kernel ABI copied from lttng-modules tree.
	31	*/
	32
	33	enum lttng_kernel_instrumentation {
	34	LTTNG_KERNEL_ALL = -1, /* Used within lttng-tools */
	35	LTTNG_KERNEL_TRACEPOINT = 0,
	36	LTTNG_KERNEL_KPROBE = 1,
	37	LTTNG_KERNEL_FUNCTION = 2,
	38	LTTNG_KERNEL_KRETPROBE = 3,
	39	LTTNG_KERNEL_NOOP = 4, /* not hooked */
	40	LTTNG_KERNEL_SYSCALL = 5,
	41	};
	42
	43	enum lttng_kernel_context_type {
	44	LTTNG_KERNEL_CONTEXT_PID = 0,
	45	LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
	46	LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
	47	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	48	LTTNG_KERNEL_CONTEXT_NICE = 4,
	49	LTTNG_KERNEL_CONTEXT_VPID = 5,
	50	LTTNG_KERNEL_CONTEXT_TID = 6,
	51	LTTNG_KERNEL_CONTEXT_VTID = 7,
	52	LTTNG_KERNEL_CONTEXT_PPID = 8,
	53	LTTNG_KERNEL_CONTEXT_VPPID = 9,
	54	};
	55
	56	/* Perf counter attributes */
	57	struct lttng_kernel_perf_counter_ctx {
	58	uint32_t type;
	59	uint64_t config;
	60	char name[LTTNG_KERNEL_SYM_NAME_LEN];
	61	};
	62
	63	/* Event/Channel context */
	64	#define LTTNG_KERNEL_CONTEXT_PADDING1 16
	65	#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
	66	struct lttng_kernel_context {
	67	enum lttng_kernel_context_type ctx;
	68	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
	69
	70	union {
	71	struct lttng_kernel_perf_counter_ctx perf_counter;
	72	char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
	73	} u;
	74	};
	75
	76	struct lttng_kernel_kretprobe {
	77	uint64_t addr;
	78
	79	uint64_t offset;
	80	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	81	};
	82
	83	/*
	84	* Either addr is used, or symbol_name and offset.
	85	*/
	86	struct lttng_kernel_kprobe {
	87	uint64_t addr;
	88
	89	uint64_t offset;
	90	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	91	};
	92
	93	/* Function tracer */
	94	struct lttng_kernel_function {
	95	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	96	};
	97
	98	#define LTTNG_KERNEL_EVENT_PADDING1 16
	99	#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
	100	struct lttng_kernel_event {
	101	char name[LTTNG_KERNEL_SYM_NAME_LEN];
	102	enum lttng_kernel_instrumentation instrumentation;
	103	char padding[LTTNG_KERNEL_EVENT_PADDING1];
	104
	105	/* Per instrumentation type configuration */
	106	union {
	107	struct lttng_kernel_kretprobe kretprobe;
	108	struct lttng_kernel_kprobe kprobe;
	109	struct lttng_kernel_function ftrace;
	110	char padding[LTTNG_KERNEL_EVENT_PADDING2];
	111	} u;
	112	};
	113
	114	struct lttng_kernel_tracer_version {
	115	uint32_t major;
	116	uint32_t minor;
	117	uint32_t patchlevel;
	118	};
	119
	120	enum lttng_kernel_calibrate_type {
	121	LTTNG_KERNEL_CALIBRATE_KRETPROBE,
	122	};
	123
	124	struct lttng_kernel_calibrate {
	125	enum lttng_kernel_calibrate_type type; /* type (input) */
	126	};
	127
	128	#endif /* _LTTNG_KERNEL_H */