[linux-2.6-block.git] / include / linux / kprobes.h

#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.
 * 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.
 */
#include <linux/compiler.h>
#include <linux/linkage.h>
#include <linux/list.h>
#include <linux/notifier.h>
#include <linux/smp.h>
#include <linux/bug.h>
#include <linux/percpu.h>
#include <linux/spinlock.h>
#include <linux/rcupdate.h>
#include <linux/mutex.h>
#include <linux/ftrace.h>
#include <asm/kprobes.h>

#ifdef CONFIG_KPROBES

/* kprobe_status settings */
#define KPROBE_HIT_ACTIVE	0x00000001
#define KPROBE_HIT_SS		0x00000002
#define KPROBE_REENTER		0x00000004
#define KPROBE_HIT_SSDONE	0x00000008

#else /* CONFIG_KPROBES */
#include <asm-generic/kprobes.h>
typedef int kprobe_opcode_t;
struct arch_specific_insn {
	int dummy;
};
#endif /* CONFIG_KPROBES */

struct kprobe;
struct pt_regs;
struct kretprobe;
struct kretprobe_instance;
typedef int (*kprobe_pre_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);
typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
				    struct pt_regs *);

struct kprobe {
	struct hlist_node hlist;

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

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

	/* location of the probe point */
	kprobe_opcode_t *addr;

	/* Allow user to indicate symbol name of the probe point */
	const char *symbol_name;

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

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

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

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

	/*
	 * Indicates various status flags.
	 * Protected by kprobe_mutex after this kprobe is registered.
	 */
	u32 flags;
};

/* Kprobe status flags */
#define KPROBE_FLAG_GONE	1 /* breakpoint has already gone */
#define KPROBE_FLAG_DISABLED	2 /* probe is temporarily disabled */
#define KPROBE_FLAG_OPTIMIZED	4 /*
				   * probe is really optimized.
				   * NOTE:
				   * this flag is only for optimized_kprobe.
				   */
#define KPROBE_FLAG_FTRACE	8 /* probe is using ftrace */

/* Has this kprobe gone ? */
static inline int kprobe_gone(struct kprobe *p)
{
	return p->flags & KPROBE_FLAG_GONE;
}

/* Is this kprobe disabled ? */
static inline int kprobe_disabled(struct kprobe *p)
{
	return p->flags & (KPROBE_FLAG_DISABLED | KPROBE_FLAG_GONE);
}

/* Is this kprobe really running optimized path ? */
static inline int kprobe_optimized(struct kprobe *p)
{
	return p->flags & KPROBE_FLAG_OPTIMIZED;
}

/* Is this kprobe uses ftrace ? */
static inline int kprobe_ftrace(struct kprobe *p)
{
	return p->flags & KPROBE_FLAG_FTRACE;
}

/*
 * 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;
	kretprobe_handler_t entry_handler;
	int maxactive;
	int nmissed;
	size_t data_size;
	struct hlist_head free_instances;
	raw_spinlock_t lock;
};

struct kretprobe_instance {
	struct hlist_node hlist;
	struct kretprobe *rp;
	kprobe_opcode_t *ret_addr;
	struct task_struct *task;
	char data[0];
};

struct kretprobe_blackpoint {
	const char *name;
	void *addr;
};

struct kprobe_blacklist_entry {
	struct list_head list;
	unsigned long start_addr;
	unsigned long end_addr;
};

#ifdef CONFIG_KPROBES
DECLARE_PER_CPU(struct kprobe *, current_kprobe);
DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);

/*
 * For #ifdef avoidance:
 */
static inline int kprobes_built_in(void)
{
	return 1;
}

#ifdef CONFIG_KRETPROBES
extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
				   struct pt_regs *regs);
extern int arch_trampoline_kprobe(struct kprobe *p);
#else /* CONFIG_KRETPROBES */
static inline void arch_prepare_kretprobe(struct kretprobe *rp,
					struct pt_regs *regs)
{
}
static inline int arch_trampoline_kprobe(struct kprobe *p)
{
	return 0;
}
#endif /* CONFIG_KRETPROBES */

extern struct kretprobe_blackpoint kretprobe_blacklist[];

static inline void kretprobe_assert(struct kretprobe_instance *ri,
	unsigned long orig_ret_address, unsigned long trampoline_address)
{
	if (!orig_ret_address || (orig_ret_address == trampoline_address)) {
		printk("kretprobe BUG!: Processing kretprobe %p @ %p\n",
				ri->rp, ri->rp->kp.addr);
		BUG();
	}
}

#ifdef CONFIG_KPROBES_SANITY_TEST
extern int init_test_probes(void);
#else
static inline int init_test_probes(void)
{
	return 0;
}
#endif /* CONFIG_KPROBES_SANITY_TEST */

extern int arch_prepare_kprobe(struct kprobe *p);
extern void arch_arm_kprobe(struct kprobe *p);
extern void arch_disarm_kprobe(struct kprobe *p);
extern int arch_init_kprobes(void);
extern void show_registers(struct pt_regs *regs);
extern void kprobes_inc_nmissed_count(struct kprobe *p);
extern bool arch_within_kprobe_blacklist(unsigned long addr);
extern bool arch_kprobe_on_func_entry(unsigned long offset);
extern bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset);

extern bool within_kprobe_blacklist(unsigned long addr);

struct kprobe_insn_cache {
	struct mutex mutex;
	void *(*alloc)(void);	/* allocate insn page */
	void (*free)(void *);	/* free insn page */
	struct list_head pages; /* list of kprobe_insn_page */
	size_t insn_size;	/* size of instruction slot */
	int nr_garbage;
};

#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
extern kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c);
extern void __free_insn_slot(struct kprobe_insn_cache *c,
			     kprobe_opcode_t *slot, int dirty);
/* sleep-less address checking routine  */
extern bool __is_insn_slot_addr(struct kprobe_insn_cache *c,
				unsigned long addr);

#define DEFINE_INSN_CACHE_OPS(__name)					\
extern struct kprobe_insn_cache kprobe_##__name##_slots;		\
									\
static inline kprobe_opcode_t *get_##__name##_slot(void)		\
{									\
	return __get_insn_slot(&kprobe_##__name##_slots);		\
}									\
									\
static inline void free_##__name##_slot(kprobe_opcode_t *slot, int dirty)\
{									\
	__free_insn_slot(&kprobe_##__name##_slots, slot, dirty);	\
}									\
									\
static inline bool is_kprobe_##__name##_slot(unsigned long addr)	\
{									\
	return __is_insn_slot_addr(&kprobe_##__name##_slots, addr);	\
}
#else /* __ARCH_WANT_KPROBES_INSN_SLOT */
#define DEFINE_INSN_CACHE_OPS(__name)					\
static inline bool is_kprobe_##__name##_slot(unsigned long addr)	\
{									\
	return 0;							\
}
#endif

DEFINE_INSN_CACHE_OPS(insn);

#ifdef CONFIG_OPTPROBES
/*
 * Internal structure for direct jump optimized probe
 */
struct optimized_kprobe {
	struct kprobe kp;
	struct list_head list;	/* list for optimizing queue */
	struct arch_optimized_insn optinsn;
};

/* Architecture dependent functions for direct jump optimization */
extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op,
					 struct kprobe *orig);
extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
extern void arch_optimize_kprobes(struct list_head *oplist);
extern void arch_unoptimize_kprobes(struct list_head *oplist,
				    struct list_head *done_list);
extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
					unsigned long addr);

extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs);

DEFINE_INSN_CACHE_OPS(optinsn);

#ifdef CONFIG_SYSCTL
extern int sysctl_kprobes_optimization;
extern int proc_kprobes_optimization_handler(struct ctl_table *table,
					     int write, void __user *buffer,
					     size_t *length, loff_t *ppos);
#endif
extern void wait_for_kprobe_optimizer(void);
#else
static inline void wait_for_kprobe_optimizer(void) { }
#endif /* CONFIG_OPTPROBES */
#ifdef CONFIG_KPROBES_ON_FTRACE
extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
				  struct ftrace_ops *ops, struct pt_regs *regs);
extern int arch_prepare_kprobe_ftrace(struct kprobe *p);
#endif

int arch_check_ftrace_location(struct kprobe *p);

/* Get the kprobe at this addr (if any) - called with preemption disabled */
struct kprobe *get_kprobe(void *addr);
void kretprobe_hash_lock(struct task_struct *tsk,
			 struct hlist_head **head, unsigned long *flags);
void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags);
struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);

/* kprobe_running() will just return the current_kprobe on this CPU */
static inline struct kprobe *kprobe_running(void)
{
	return (__this_cpu_read(current_kprobe));
}

static inline void reset_current_kprobe(void)
{
	__this_cpu_write(current_kprobe, NULL);
}

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

kprobe_opcode_t *kprobe_lookup_name(const char *name, unsigned int offset);
int register_kprobe(struct kprobe *p);
void unregister_kprobe(struct kprobe *p);
int register_kprobes(struct kprobe **kps, int num);
void unregister_kprobes(struct kprobe **kps, int num);
unsigned long arch_deref_entry_point(void *);

int register_kretprobe(struct kretprobe *rp);
void unregister_kretprobe(struct kretprobe *rp);
int register_kretprobes(struct kretprobe **rps, int num);
void unregister_kretprobes(struct kretprobe **rps, int num);

void kprobe_flush_task(struct task_struct *tk);
void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);

int disable_kprobe(struct kprobe *kp);
int enable_kprobe(struct kprobe *kp);

void dump_kprobe(struct kprobe *kp);

void *alloc_insn_page(void);
void free_insn_page(void *page);

#else /* !CONFIG_KPROBES: */

static inline int kprobes_built_in(void)
{
	return 0;
}
static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
{
	return 0;
}
static inline struct kprobe *get_kprobe(void *addr)
{
	return NULL;
}
static inline struct kprobe *kprobe_running(void)
{
	return NULL;
}
static inline int register_kprobe(struct kprobe *p)
{
	return -ENOSYS;
}
static inline int register_kprobes(struct kprobe **kps, int num)
{
	return -ENOSYS;
}
static inline void unregister_kprobe(struct kprobe *p)
{
}
static inline void unregister_kprobes(struct kprobe **kps, int num)
{
}
static inline int register_kretprobe(struct kretprobe *rp)
{
	return -ENOSYS;
}
static inline int register_kretprobes(struct kretprobe **rps, int num)
{
	return -ENOSYS;
}
static inline void unregister_kretprobe(struct kretprobe *rp)
{
}
static inline void unregister_kretprobes(struct kretprobe **rps, int num)
{
}
static inline void kprobe_flush_task(struct task_struct *tk)
{
}
static inline int disable_kprobe(struct kprobe *kp)
{
	return -ENOSYS;
}
static inline int enable_kprobe(struct kprobe *kp)
{
	return -ENOSYS;
}
#endif /* CONFIG_KPROBES */
static inline int disable_kretprobe(struct kretprobe *rp)
{
	return disable_kprobe(&rp->kp);
}
static inline int enable_kretprobe(struct kretprobe *rp)
{
	return enable_kprobe(&rp->kp);
}

#ifndef CONFIG_KPROBES
static inline bool is_kprobe_insn_slot(unsigned long addr)
{
	return false;
}
#endif
#ifndef CONFIG_OPTPROBES
static inline bool is_kprobe_optinsn_slot(unsigned long addr)
{
	return false;
}
#endif

#endif /* _LINUX_KPROBES_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_KPROBES_H
	2	#define _LINUX_KPROBES_H
	3	/*
	4	* Kernel Probes (KProbes)
	5	* include/linux/kprobes.h
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	20	*
	21	* Copyright (C) IBM Corporation, 2002, 2004
	22	*
	23	* 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
	24	* Probes initial implementation ( includes suggestions from
	25	* Rusty Russell).
	26	* 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
	27	* interface to access function arguments.
b94cce92 HN	28	* 2005-May Hien Nguyen <hien@us.ibm.com> and Jim Keniston
	29	* <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
	30	* <prasanna@in.ibm.com> added function-return probes.
1da177e4	31	*/
7d134b2c	32	#include <linux/compiler.h>
36dcd67a	33	#include <linux/linkage.h>
1da177e4 LT	34	#include <linux/list.h>
	35	#include <linux/notifier.h>
	36	#include <linux/smp.h>
187f1882	37	#include <linux/bug.h>
e6584523	38	#include <linux/percpu.h>
3516a460 AM	39	#include <linux/spinlock.h>
3516a460 AM	40	#include <linux/rcupdate.h>
7a7d1cf9	41	#include <linux/mutex.h>
ae6aa16f	42	#include <linux/ftrace.h>
7d134b2c	43	#include <asm/kprobes.h>
b94cce92	44
00d7c05a	45	#ifdef CONFIG_KPROBES
1da177e4	46
ea32c65c PP	47	/* kprobe_status settings */
	48	#define KPROBE_HIT_ACTIVE 0x00000001
	49	#define KPROBE_HIT_SS 0x00000002
	50	#define KPROBE_REENTER 0x00000004
	51	#define KPROBE_HIT_SSDONE 0x00000008
	52
dc19835d	53	#else /* CONFIG_KPROBES */
7d134b2c	54	#include <asm-generic/kprobes.h>
dc19835d MH	55	typedef int kprobe_opcode_t;
	56	struct arch_specific_insn {
	57	int dummy;
	58	};
dc19835d	59	#endif /* CONFIG_KPROBES */
d0aaff97	60
1da177e4 LT	61	struct kprobe;
1da177e4 LT	62	struct pt_regs;
b94cce92 HN	63	struct kretprobe;
b94cce92 HN	64	struct kretprobe_instance;
1da177e4	65	typedef int (kprobe_pre_handler_t) (struct kprobe , struct pt_regs *);
1da177e4 LT	66	typedef void (kprobe_post_handler_t) (struct kprobe , struct pt_regs *,
	67	unsigned long flags);
	68	typedef int (kprobe_fault_handler_t) (struct kprobe , struct pt_regs *,
	69	int trapnr);
b94cce92 HN	70	typedef int (kretprobe_handler_t) (struct kretprobe_instance ,
	71	struct pt_regs *);
	72
1da177e4 LT	73	struct kprobe {
	74	struct hlist_node hlist;
	75
64f562c6 AM	76	/* list of kprobes for multi-handler support */
	77	struct list_head list;
	78
ea32c65c PP	79	/count the number of times this probe was temporarily disarmed /
	80	unsigned long nmissed;
	81
1da177e4 LT	82	/* location of the probe point */
	83	kprobe_opcode_t *addr;
	84
3a872d89	85	/* Allow user to indicate symbol name of the probe point */
9b3af29b	86	const char *symbol_name;
3a872d89 AM	87
	88	/* Offset into the symbol */
	89	unsigned int offset;
	90
1da177e4 LT	91	/* Called before addr is executed. */
	92	kprobe_pre_handler_t pre_handler;
	93
	94	/* Called after addr is executed, unless... */
	95	kprobe_post_handler_t post_handler;
	96
cc00e9cf MH	97	/*
	98	* ... called if executing addr causes a fault (eg. page fault).
	99	* Return 1 if it handled fault, otherwise kernel will see it.
	100	*/
1da177e4 LT	101	kprobe_fault_handler_t fault_handler;
1da177e4 LT	102
1da177e4 LT	103	/* Saved opcode (which has been replaced with breakpoint) */
	104	kprobe_opcode_t opcode;
	105
	106	/* copy of the original instruction */
	107	struct arch_specific_insn ainsn;
e8386a0c	108
de5bd88d MH	109	/*
	110	* Indicates various status flags.
	111	* Protected by kprobe_mutex after this kprobe is registered.
	112	*/
e8386a0c	113	u32 flags;
1da177e4 LT	114	};
1da177e4 LT	115
e8386a0c MH	116	/* Kprobe status flags */
e8386a0c MH	117	#define KPROBE_FLAG_GONE 1 /* breakpoint has already gone */
de5bd88d	118	#define KPROBE_FLAG_DISABLED 2 /* probe is temporarily disabled */
afd66255 MH	119	#define KPROBE_FLAG_OPTIMIZED 4 /*
	120	* probe is really optimized.
	121	* NOTE:
	122	* this flag is only for optimized_kprobe.
	123	*/
ae6aa16f	124	#define KPROBE_FLAG_FTRACE 8 /* probe is using ftrace */
e8386a0c	125
de5bd88d	126	/* Has this kprobe gone ? */
e8386a0c MH	127	static inline int kprobe_gone(struct kprobe *p)
	128	{
	129	return p->flags & KPROBE_FLAG_GONE;
	130	}
	131
de5bd88d MH	132	/* Is this kprobe disabled ? */
	133	static inline int kprobe_disabled(struct kprobe *p)
	134	{
	135	return p->flags & (KPROBE_FLAG_DISABLED \| KPROBE_FLAG_GONE);
	136	}
afd66255 MH	137
	138	/* Is this kprobe really running optimized path ? */
	139	static inline int kprobe_optimized(struct kprobe *p)
	140	{
	141	return p->flags & KPROBE_FLAG_OPTIMIZED;
	142	}
ae6aa16f MH	143
	144	/* Is this kprobe uses ftrace ? */
	145	static inline int kprobe_ftrace(struct kprobe *p)
	146	{
	147	return p->flags & KPROBE_FLAG_FTRACE;
	148	}
	149
b94cce92 HN	150	/*
	151	* Function-return probe -
	152	* Note:
	153	* User needs to provide a handler function, and initialize maxactive.
	154	* maxactive - The maximum number of instances of the probed function that
	155	* can be active concurrently.
	156	* nmissed - tracks the number of times the probed function's return was
	157	* ignored, due to maxactive being too low.
	158	*
	159	*/
	160	struct kretprobe {
	161	struct kprobe kp;
	162	kretprobe_handler_t handler;
f47cd9b5	163	kretprobe_handler_t entry_handler;
b94cce92 HN	164	int maxactive;
b94cce92 HN	165	int nmissed;
f47cd9b5	166	size_t data_size;
b94cce92	167	struct hlist_head free_instances;
ec484608	168	raw_spinlock_t lock;
b94cce92 HN	169	};
	170
	171	struct kretprobe_instance {
b94cce92 HN	172	struct hlist_node hlist;
b94cce92 HN	173	struct kretprobe *rp;
802eae7c RL	174	kprobe_opcode_t *ret_addr;
802eae7c RL	175	struct task_struct *task;
f47cd9b5	176	char data[0];
b94cce92 HN	177	};
b94cce92 HN	178
f438d914 MH	179	struct kretprobe_blackpoint {
	180	const char *name;
	181	void *addr;
	182	};
3d8d996e	183
376e2424 MH	184	struct kprobe_blacklist_entry {
376e2424 MH	185	struct list_head list;
3d8d996e	186	unsigned long start_addr;
376e2424	187	unsigned long end_addr;
3d8d996e SD	188	};
3d8d996e SD	189
dc19835d MH	190	#ifdef CONFIG_KPROBES
	191	DECLARE_PER_CPU(struct kprobe *, current_kprobe);
	192	DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
	193
b1801812 IM	194	/*
	195	* For #ifdef avoidance:
	196	*/
	197	static inline int kprobes_built_in(void)
	198	{
	199	return 1;
	200	}
	201
dc19835d MH	202	#ifdef CONFIG_KRETPROBES
	203	extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
	204	struct pt_regs *regs);
	205	extern int arch_trampoline_kprobe(struct kprobe *p);
	206	#else /* CONFIG_KRETPROBES */
	207	static inline void arch_prepare_kretprobe(struct kretprobe *rp,
	208	struct pt_regs *regs)
	209	{
	210	}
	211	static inline int arch_trampoline_kprobe(struct kprobe *p)
	212	{
	213	return 0;
	214	}
	215	#endif /* CONFIG_KRETPROBES */
	216
f438d914 MH	217	extern struct kretprobe_blackpoint kretprobe_blacklist[];
f438d914 MH	218
0f95b7fc AM	219	static inline void kretprobe_assert(struct kretprobe_instance *ri,
	220	unsigned long orig_ret_address, unsigned long trampoline_address)
	221	{
	222	if (!orig_ret_address \|\| (orig_ret_address == trampoline_address)) {
	223	printk("kretprobe BUG!: Processing kretprobe %p @ %p\n",
	224	ri->rp, ri->rp->kp.addr);
	225	BUG();
	226	}
	227	}
	228
8c1c9356 AM	229	#ifdef CONFIG_KPROBES_SANITY_TEST
	230	extern int init_test_probes(void);
	231	#else
	232	static inline int init_test_probes(void)
	233	{
	234	return 0;
	235	}
	236	#endif /* CONFIG_KPROBES_SANITY_TEST */
	237
1da177e4	238	extern int arch_prepare_kprobe(struct kprobe *p);
7e1048b1 RL	239	extern void arch_arm_kprobe(struct kprobe *p);
7e1048b1 RL	240	extern void arch_disarm_kprobe(struct kprobe *p);
6772926b	241	extern int arch_init_kprobes(void);
1da177e4	242	extern void show_registers(struct pt_regs *regs);
bf8d5c52	243	extern void kprobes_inc_nmissed_count(struct kprobe *p);
be8f2743	244	extern bool arch_within_kprobe_blacklist(unsigned long addr);
659b957f NR	245	extern bool arch_kprobe_on_func_entry(unsigned long offset);
659b957f NR	246	extern bool kprobe_on_func_entry(kprobe_opcode_t addr, const char sym, unsigned long offset);
1da177e4	247
e5779e8e AL	248	extern bool within_kprobe_blacklist(unsigned long addr);
e5779e8e AL	249
c802d64a HC	250	struct kprobe_insn_cache {
c802d64a HC	251	struct mutex mutex;
af96397d HC	252	void (alloc)(void); /* allocate insn page */
af96397d HC	253	void (free)(void ); /* free insn page */
c802d64a HC	254	struct list_head pages; /* list of kprobe_insn_page */
	255	size_t insn_size; /* size of instruction slot */
	256	int nr_garbage;
	257	};
	258
5b485629	259	#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
c802d64a HC	260	extern kprobe_opcode_t __get_insn_slot(struct kprobe_insn_cache c);
	261	extern void __free_insn_slot(struct kprobe_insn_cache *c,
	262	kprobe_opcode_t *slot, int dirty);
5b485629 MH	263	/* sleep-less address checking routine */
	264	extern bool __is_insn_slot_addr(struct kprobe_insn_cache *c,
	265	unsigned long addr);
c802d64a HC	266
	267	#define DEFINE_INSN_CACHE_OPS(__name) \
	268	extern struct kprobe_insn_cache kprobe_##__name##_slots; \
	269	\
	270	static inline kprobe_opcode_t *get_##__name##_slot(void) \
	271	{ \
	272	return __get_insn_slot(&kprobe_##__name##_slots); \
	273	} \
	274	\
	275	static inline void free_##__name##_slot(kprobe_opcode_t *slot, int dirty)\
	276	{ \
	277	__free_insn_slot(&kprobe_##__name##_slots, slot, dirty); \
	278	} \
5b485629 MH	279	\
	280	static inline bool is_kprobe_##__name##_slot(unsigned long addr) \
	281	{ \
	282	return __is_insn_slot_addr(&kprobe_##__name##_slots, addr); \
	283	}
	284	#else /* __ARCH_WANT_KPROBES_INSN_SLOT */
	285	#define DEFINE_INSN_CACHE_OPS(__name) \
	286	static inline bool is_kprobe_##__name##_slot(unsigned long addr) \
	287	{ \
	288	return 0; \
	289	}
	290	#endif
c802d64a HC	291
	292	DEFINE_INSN_CACHE_OPS(insn);
	293
afd66255 MH	294	#ifdef CONFIG_OPTPROBES
	295	/*
	296	* Internal structure for direct jump optimized probe
	297	*/
	298	struct optimized_kprobe {
	299	struct kprobe kp;
	300	struct list_head list; /* list for optimizing queue */
	301	struct arch_optimized_insn optinsn;
	302	};
	303
	304	/* Architecture dependent functions for direct jump optimization */
	305	extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
	306	extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
cbf6ab52 MH	307	extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op,
cbf6ab52 MH	308	struct kprobe *orig);
afd66255	309	extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
cd7ebe22	310	extern void arch_optimize_kprobes(struct list_head *oplist);
f984ba4e MH	311	extern void arch_unoptimize_kprobes(struct list_head *oplist,
f984ba4e MH	312	struct list_head *done_list);
afd66255	313	extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
afd66255 MH	314	extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
	315	unsigned long addr);
	316
	317	extern void opt_pre_handler(struct kprobe p, struct pt_regs regs);
b2be84df	318
c802d64a HC	319	DEFINE_INSN_CACHE_OPS(optinsn);
c802d64a HC	320
b2be84df MH	321	#ifdef CONFIG_SYSCTL
	322	extern int sysctl_kprobes_optimization;
	323	extern int proc_kprobes_optimization_handler(struct ctl_table *table,
	324	int write, void __user *buffer,
	325	size_t length, loff_t ppos);
	326	#endif
30e7d894 TG	327	extern void wait_for_kprobe_optimizer(void);
	328	#else
	329	static inline void wait_for_kprobe_optimizer(void) { }
afd66255	330	#endif /* CONFIG_OPTPROBES */
e7dbfe34	331	#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f	332	extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
e5253896	333	struct ftrace_ops ops, struct pt_regs regs);
ae6aa16f MH	334	extern int arch_prepare_kprobe_ftrace(struct kprobe *p);
	335	#endif
	336
f7f242ff	337	int arch_check_ftrace_location(struct kprobe *p);
afd66255	338
d217d545	339	/* Get the kprobe at this addr (if any) - called with preemption disabled */
1da177e4	340	struct kprobe get_kprobe(void addr);
ef53d9c5 S	341	void kretprobe_hash_lock(struct task_struct *tsk,
	342	struct hlist_head *head, unsigned long flags);
	343	void kretprobe_hash_unlock(struct task_struct tsk, unsigned long flags);
b94cce92	344	struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
1da177e4	345
e6584523 AM	346	/* kprobe_running() will just return the current_kprobe on this CPU */
	347	static inline struct kprobe *kprobe_running(void)
	348	{
b76834bc	349	return (__this_cpu_read(current_kprobe));
e6584523 AM	350	}
	351
	352	static inline void reset_current_kprobe(void)
	353	{
b76834bc	354	__this_cpu_write(current_kprobe, NULL);
e6584523 AM	355	}
	356
	357	static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
	358	{
bdffd893	359	return this_cpu_ptr(&kprobe_ctlblk);
e6584523 AM	360	}
e6584523 AM	361
290e3070	362	kprobe_opcode_t kprobe_lookup_name(const char name, unsigned int offset);
1da177e4 LT	363	int register_kprobe(struct kprobe *p);
1da177e4 LT	364	void unregister_kprobe(struct kprobe *p);
9861668f MH	365	int register_kprobes(struct kprobe **kps, int num);
9861668f MH	366	void unregister_kprobes(struct kprobe **kps, int num);
3d7e3382	367	unsigned long arch_deref_entry_point(void *);
1da177e4	368
b94cce92 HN	369	int register_kretprobe(struct kretprobe *rp);
b94cce92 HN	370	void unregister_kretprobe(struct kretprobe *rp);
4a296e07 MH	371	int register_kretprobes(struct kretprobe **rps, int num);
4a296e07 MH	372	void unregister_kretprobes(struct kretprobe **rps, int num);
b94cce92	373
b94cce92	374	void kprobe_flush_task(struct task_struct *tk);
99219a3f	375	void recycle_rp_inst(struct kretprobe_instance ri, struct hlist_head head);
8c1c9356	376
de5bd88d MH	377	int disable_kprobe(struct kprobe *kp);
	378	int enable_kprobe(struct kprobe *kp);
	379
24851d24 FW	380	void dump_kprobe(struct kprobe *kp);
24851d24 FW	381
ad3bc25a BP	382	void *alloc_insn_page(void);
	383	void free_insn_page(void *page);
	384
b1801812	385	#else /* !CONFIG_KPROBES: */
00d7c05a	386
b1801812 IM	387	static inline int kprobes_built_in(void)
	388	{
	389	return 0;
	390	}
	391	static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
	392	{
	393	return 0;
	394	}
785656a4 AS	395	static inline struct kprobe get_kprobe(void addr)
	396	{
	397	return NULL;
	398	}
e6584523	399	static inline struct kprobe *kprobe_running(void)
1da177e4	400	{
e6584523	401	return NULL;
1da177e4 LT	402	}
	403	static inline int register_kprobe(struct kprobe *p)
	404	{
	405	return -ENOSYS;
	406	}
9861668f MH	407	static inline int register_kprobes(struct kprobe **kps, int num)
	408	{
	409	return -ENOSYS;
	410	}
1da177e4 LT	411	static inline void unregister_kprobe(struct kprobe *p)
	412	{
	413	}
9861668f MH	414	static inline void unregister_kprobes(struct kprobe **kps, int num)
	415	{
	416	}
b94cce92 HN	417	static inline int register_kretprobe(struct kretprobe *rp)
	418	{
	419	return -ENOSYS;
	420	}
4a296e07 MH	421	static inline int register_kretprobes(struct kretprobe **rps, int num)
	422	{
	423	return -ENOSYS;
	424	}
b94cce92 HN	425	static inline void unregister_kretprobe(struct kretprobe *rp)
	426	{
	427	}
4a296e07 MH	428	static inline void unregister_kretprobes(struct kretprobe **rps, int num)
	429	{
	430	}
b94cce92 HN	431	static inline void kprobe_flush_task(struct task_struct *tk)
	432	{
	433	}
de5bd88d MH	434	static inline int disable_kprobe(struct kprobe *kp)
	435	{
	436	return -ENOSYS;
	437	}
	438	static inline int enable_kprobe(struct kprobe *kp)
	439	{
	440	return -ENOSYS;
	441	}
b1801812	442	#endif /* CONFIG_KPROBES */
8f9b1528 MH	443	static inline int disable_kretprobe(struct kretprobe *rp)
	444	{
	445	return disable_kprobe(&rp->kp);
	446	}
	447	static inline int enable_kretprobe(struct kretprobe *rp)
	448	{
	449	return enable_kprobe(&rp->kp);
	450	}
8f9b1528	451
5b485629 MH	452	#ifndef CONFIG_KPROBES
	453	static inline bool is_kprobe_insn_slot(unsigned long addr)
	454	{
	455	return false;
	456	}
	457	#endif
	458	#ifndef CONFIG_OPTPROBES
	459	static inline bool is_kprobe_optinsn_slot(unsigned long addr)
	460	{
	461	return false;
	462	}
	463	#endif
	464
b1801812	465	#endif /* _LINUX_KPROBES_H */