kprobes.h 7.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
#ifndef _LINUX_KPROBES_H
#define _LINUX_KPROBES_H
/*
 *  Kernel Probes (KProbes)
 *  include/linux/kprobes.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * Copyright (C) IBM Corporation, 2002, 2004
 *
 * 2002-Oct	Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
 *		Probes initial implementation ( includes suggestions from
 *		Rusty Russell).
 * 2004-July	Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
 *		interface to access function arguments.
28 29 30
 * 2005-May	Hien Nguyen <hien@us.ibm.com> and Jim Keniston
 *		<jkenisto@us.ibm.com>  and Prasanna S Panchamukhi
 *		<prasanna@in.ibm.com> added function-return probes.
L
Linus Torvalds 已提交
31 32 33 34
 */
#include <linux/list.h>
#include <linux/notifier.h>
#include <linux/smp.h>
35
#include <linux/percpu.h>
36 37
#include <linux/spinlock.h>
#include <linux/rcupdate.h>
I
Ingo Molnar 已提交
38
#include <linux/mutex.h>
39

40
#ifdef CONFIG_KPROBES
L
Linus Torvalds 已提交
41 42
#include <asm/kprobes.h>

43 44 45 46 47 48
/* kprobe_status settings */
#define KPROBE_HIT_ACTIVE	0x00000001
#define KPROBE_HIT_SS		0x00000002
#define KPROBE_REENTER		0x00000004
#define KPROBE_HIT_SSDONE	0x00000008

49 50 51
/* Attach to insert probes on any functions which should be ignored*/
#define __kprobes	__attribute__((__section__(".kprobes.text")))

L
Linus Torvalds 已提交
52 53
struct kprobe;
struct pt_regs;
54 55
struct kretprobe;
struct kretprobe_instance;
L
Linus Torvalds 已提交
56 57 58 59 60 61
typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);
typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
				       unsigned long flags);
typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *,
				       int trapnr);
62 63 64
typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
				    struct pt_regs *);

L
Linus Torvalds 已提交
65 66 67
struct kprobe {
	struct hlist_node hlist;

68 69 70
	/* list of kprobes for multi-handler support */
	struct list_head list;

71 72 73
	/* Indicates that the corresponding module has been ref counted */
	unsigned int mod_refcounted;

74 75 76
	/*count the number of times this probe was temporarily disarmed */
	unsigned long nmissed;

L
Linus Torvalds 已提交
77 78 79
	/* location of the probe point */
	kprobe_opcode_t *addr;

80 81 82 83 84 85
	/* Allow user to indicate symbol name of the probe point */
	char *symbol_name;

	/* Offset into the symbol */
	unsigned int offset;

L
Linus Torvalds 已提交
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
	/* Called before addr is executed. */
	kprobe_pre_handler_t pre_handler;

	/* Called after addr is executed, unless... */
	kprobe_post_handler_t post_handler;

	/* ... called if executing addr causes a fault (eg. page fault).
	 * Return 1 if it handled fault, otherwise kernel will see it. */
	kprobe_fault_handler_t fault_handler;

	/* ... called if breakpoint trap occurs in probe handler.
	 * Return 1 if it handled break, otherwise kernel will see it. */
	kprobe_break_handler_t break_handler;

	/* Saved opcode (which has been replaced with breakpoint) */
	kprobe_opcode_t opcode;

	/* copy of the original instruction */
	struct arch_specific_insn ainsn;
};

/*
 * Special probe type that uses setjmp-longjmp type tricks to resume
 * execution at a specified entry with a matching prototype corresponding
 * to the probed function - a trick to enable arguments to become
 * accessible seamlessly by probe handling logic.
 * Note:
 * Because of the way compilers allocate stack space for local variables
 * etc upfront, regardless of sub-scopes within a function, this mirroring
 * principle currently works only for probes placed on function entry points.
 */
struct jprobe {
	struct kprobe kp;
	kprobe_opcode_t *entry;	/* probe handling code to jump to */
};

122 123 124
DECLARE_PER_CPU(struct kprobe *, current_kprobe);
DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
#ifdef ARCH_SUPPORTS_KRETPROBES
extern void arch_prepare_kretprobe(struct kretprobe *rp, struct pt_regs *regs);
#else /* ARCH_SUPPORTS_KRETPROBES */
static inline void arch_prepare_kretprobe(struct kretprobe *rp,
					struct pt_regs *regs)
{
}
#endif /* ARCH_SUPPORTS_KRETPROBES */
/*
 * Function-return probe -
 * Note:
 * User needs to provide a handler function, and initialize maxactive.
 * maxactive - The maximum number of instances of the probed function that
 * can be active concurrently.
 * nmissed - tracks the number of times the probed function's return was
 * ignored, due to maxactive being too low.
 *
 */
struct kretprobe {
	struct kprobe kp;
	kretprobe_handler_t handler;
	int maxactive;
	int nmissed;
	struct hlist_head free_instances;
	struct hlist_head used_instances;
};

struct kretprobe_instance {
	struct hlist_node uflist; /* either on free list or used list */
	struct hlist_node hlist;
	struct kretprobe *rp;
156 157
	kprobe_opcode_t *ret_addr;
	struct task_struct *task;
158 159
};

160
extern spinlock_t kretprobe_lock;
I
Ingo Molnar 已提交
161
extern struct mutex kprobe_mutex;
L
Linus Torvalds 已提交
162
extern int arch_prepare_kprobe(struct kprobe *p);
163 164
extern void arch_arm_kprobe(struct kprobe *p);
extern void arch_disarm_kprobe(struct kprobe *p);
165
extern int arch_init_kprobes(void);
L
Linus Torvalds 已提交
166
extern void show_registers(struct pt_regs *regs);
167
extern kprobe_opcode_t *get_insn_slot(void);
168
extern void free_insn_slot(kprobe_opcode_t *slot, int dirty);
169
extern void kprobes_inc_nmissed_count(struct kprobe *p);
L
Linus Torvalds 已提交
170

171
/* Get the kprobe at this addr (if any) - called with preemption disabled */
L
Linus Torvalds 已提交
172
struct kprobe *get_kprobe(void *addr);
173
struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
L
Linus Torvalds 已提交
174

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/* kprobe_running() will just return the current_kprobe on this CPU */
static inline struct kprobe *kprobe_running(void)
{
	return (__get_cpu_var(current_kprobe));
}

static inline void reset_current_kprobe(void)
{
	__get_cpu_var(current_kprobe) = NULL;
}

static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
{
	return (&__get_cpu_var(kprobe_ctlblk));
}

L
Linus Torvalds 已提交
191 192 193 194 195 196 197 198
int register_kprobe(struct kprobe *p);
void unregister_kprobe(struct kprobe *p);
int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
int longjmp_break_handler(struct kprobe *, struct pt_regs *);
int register_jprobe(struct jprobe *p);
void unregister_jprobe(struct jprobe *p);
void jprobe_return(void);

199 200 201 202 203 204
int register_kretprobe(struct kretprobe *rp);
void unregister_kretprobe(struct kretprobe *rp);

struct kretprobe_instance *get_free_rp_inst(struct kretprobe *rp);
void add_rp_inst(struct kretprobe_instance *ri);
void kprobe_flush_task(struct task_struct *tk);
205
void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);
206
#else /* CONFIG_KPROBES */
207 208 209 210 211

#define __kprobes	/**/
struct jprobe;
struct kretprobe;

212
static inline struct kprobe *kprobe_running(void)
L
Linus Torvalds 已提交
213
{
214
	return NULL;
L
Linus Torvalds 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
}
static inline int register_kprobe(struct kprobe *p)
{
	return -ENOSYS;
}
static inline void unregister_kprobe(struct kprobe *p)
{
}
static inline int register_jprobe(struct jprobe *p)
{
	return -ENOSYS;
}
static inline void unregister_jprobe(struct jprobe *p)
{
}
static inline void jprobe_return(void)
{
}
233 234 235 236 237 238 239 240 241 242 243
static inline int register_kretprobe(struct kretprobe *rp)
{
	return -ENOSYS;
}
static inline void unregister_kretprobe(struct kretprobe *rp)
{
}
static inline void kprobe_flush_task(struct task_struct *tk)
{
}
#endif				/* CONFIG_KPROBES */
L
Linus Torvalds 已提交
244
#endif				/* _LINUX_KPROBES_H */