[deliverable/linux.git] / arch / x86 / include / asm / kprobes.h

#ifndef _ASM_X86_KPROBES_H
#define _ASM_X86_KPROBES_H
/*
 *  Kernel Probes (KProbes)
 *
 * 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
 *
 * See arch/x86/kernel/kprobes.c for x86 kprobes history.
 */
#include <linux/types.h>
#include <linux/ptrace.h>
#include <linux/percpu.h>
#include <asm/insn.h>

#define  __ARCH_WANT_KPROBES_INSN_SLOT

struct pt_regs;
struct kprobe;

typedef u8 kprobe_opcode_t;
#define BREAKPOINT_INSTRUCTION	0xcc
#define RELATIVEJUMP_OPCODE 0xe9
#define RELATIVEJUMP_SIZE 5
#define RELATIVECALL_OPCODE 0xe8
#define RELATIVE_ADDR_SIZE 4
#define MAX_STACK_SIZE 64
#define MIN_STACK_SIZE(ADDR)					       \
	(((MAX_STACK_SIZE) < (((unsigned long)current_thread_info()) + \
			      THREAD_SIZE - (unsigned long)(ADDR)))    \
	 ? (MAX_STACK_SIZE)					       \
	 : (((unsigned long)current_thread_info()) +		       \
	    THREAD_SIZE - (unsigned long)(ADDR)))

#define flush_insn_slot(p)	do { } while (0)

/* optinsn template addresses */
extern __visible kprobe_opcode_t optprobe_template_entry;
extern __visible kprobe_opcode_t optprobe_template_val;
extern __visible kprobe_opcode_t optprobe_template_call;
extern __visible kprobe_opcode_t optprobe_template_end;
#define MAX_OPTIMIZED_LENGTH (MAX_INSN_SIZE + RELATIVE_ADDR_SIZE)
#define MAX_OPTINSN_SIZE 				\
	(((unsigned long)&optprobe_template_end -	\
	  (unsigned long)&optprobe_template_entry) +	\
	 MAX_OPTIMIZED_LENGTH + RELATIVEJUMP_SIZE)

extern const int kretprobe_blacklist_size;

void arch_remove_kprobe(struct kprobe *p);
asmlinkage void kretprobe_trampoline(void);

/* Architecture specific copy of original instruction*/
struct arch_specific_insn {
	/* copy of the original instruction */
	kprobe_opcode_t *insn;
	/*
	 * boostable = -1: This instruction type is not boostable.
	 * boostable = 0: This instruction type is boostable.
	 * boostable = 1: This instruction has been boosted: we have
	 * added a relative jump after the instruction copy in insn,
	 * so no single-step and fixup are needed (unless there's
	 * a post_handler or break_handler).
	 */
	int boostable;
	bool if_modifier;
};

struct arch_optimized_insn {
	/* copy of the original instructions */
	kprobe_opcode_t copied_insn[RELATIVE_ADDR_SIZE];
	/* detour code buffer */
	kprobe_opcode_t *insn;
	/* the size of instructions copied to detour code buffer */
	size_t size;
};

/* Return true (!0) if optinsn is prepared for optimization. */
static inline int arch_prepared_optinsn(struct arch_optimized_insn *optinsn)
{
	return optinsn->size;
}

struct prev_kprobe {
	struct kprobe *kp;
	unsigned long status;
	unsigned long old_flags;
	unsigned long saved_flags;
};

/* per-cpu kprobe control block */
struct kprobe_ctlblk {
	unsigned long kprobe_status;
	unsigned long kprobe_old_flags;
	unsigned long kprobe_saved_flags;
	unsigned long *jprobe_saved_sp;
	struct pt_regs jprobe_saved_regs;
	kprobe_opcode_t jprobes_stack[MAX_STACK_SIZE];
	struct prev_kprobe prev_kprobe;
};

extern int kprobe_fault_handler(struct pt_regs *regs, int trapnr);
extern int kprobe_exceptions_notify(struct notifier_block *self,
				    unsigned long val, void *data);
extern int kprobe_int3_handler(struct pt_regs *regs);
extern int kprobe_debug_handler(struct pt_regs *regs);
#endif /* _ASM_X86_KPROBES_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_KPROBES_H
1965aae3 PA	2	#define _ASM_X86_KPROBES_H
d6be29b8 MH	3	/*
	4	* Kernel Probes (KProbes)
	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 as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*
	20	* Copyright (C) IBM Corporation, 2002, 2004
	21	*
	22	* See arch/x86/kernel/kprobes.c for x86 kprobes history.
	23	*/
	24	#include <linux/types.h>
	25	#include <linux/ptrace.h>
	26	#include <linux/percpu.h>
30a813ae	27	#include <asm/insn.h>
d6be29b8 MH	28
	29	#define __ARCH_WANT_KPROBES_INSN_SLOT
	30
	31	struct pt_regs;
	32	struct kprobe;
	33
	34	typedef u8 kprobe_opcode_t;
	35	#define BREAKPOINT_INSTRUCTION 0xcc
d498f763	36	#define RELATIVEJUMP_OPCODE 0xe9
c0f7ac3a MH	37	#define RELATIVEJUMP_SIZE 5
	38	#define RELATIVECALL_OPCODE 0xe8
	39	#define RELATIVE_ADDR_SIZE 4
d6be29b8	40	#define MAX_STACK_SIZE 64
864dfa13 JP	41	#define MIN_STACK_SIZE(ADDR) \
	42	(((MAX_STACK_SIZE) < (((unsigned long)current_thread_info()) + \
	43	THREAD_SIZE - (unsigned long)(ADDR))) \
	44	? (MAX_STACK_SIZE) \
	45	: (((unsigned long)current_thread_info()) + \
	46	THREAD_SIZE - (unsigned long)(ADDR)))
d6be29b8	47
d6be29b8 MH	48	#define flush_insn_slot(p) do { } while (0)
d6be29b8 MH	49
c0f7ac3a	50	/* optinsn template addresses */
04bb591c AK	51	extern __visible kprobe_opcode_t optprobe_template_entry;
	52	extern __visible kprobe_opcode_t optprobe_template_val;
	53	extern __visible kprobe_opcode_t optprobe_template_call;
	54	extern __visible kprobe_opcode_t optprobe_template_end;
c0f7ac3a MH	55	#define MAX_OPTIMIZED_LENGTH (MAX_INSN_SIZE + RELATIVE_ADDR_SIZE)
	56	#define MAX_OPTINSN_SIZE \
	57	(((unsigned long)&optprobe_template_end - \
	58	(unsigned long)&optprobe_template_entry) + \
	59	MAX_OPTIMIZED_LENGTH + RELATIVEJUMP_SIZE)
	60
d6be29b8 MH	61	extern const int kretprobe_blacklist_size;
	62
	63	void arch_remove_kprobe(struct kprobe *p);
04bb591c	64	asmlinkage void kretprobe_trampoline(void);
d6be29b8 MH	65
	66	/* Architecture specific copy of original instruction*/
	67	struct arch_specific_insn {
	68	/* copy of the original instruction */
	69	kprobe_opcode_t *insn;
	70	/*
	71	* boostable = -1: This instruction type is not boostable.
	72	* boostable = 0: This instruction type is boostable.
	73	* boostable = 1: This instruction has been boosted: we have
	74	* added a relative jump after the instruction copy in insn,
	75	* so no single-step and fixup are needed (unless there's
	76	* a post_handler or break_handler).
	77	*/
	78	int boostable;
9a556ab9	79	bool if_modifier;
d6be29b8 MH	80	};
d6be29b8 MH	81
c0f7ac3a MH	82	struct arch_optimized_insn {
	83	/* copy of the original instructions */
	84	kprobe_opcode_t copied_insn[RELATIVE_ADDR_SIZE];
	85	/* detour code buffer */
	86	kprobe_opcode_t *insn;
	87	/* the size of instructions copied to detour code buffer */
	88	size_t size;
	89	};
	90
	91	/* Return true (!0) if optinsn is prepared for optimization. */
	92	static inline int arch_prepared_optinsn(struct arch_optimized_insn *optinsn)
	93	{
	94	return optinsn->size;
	95	}
	96
d6be29b8 MH	97	struct prev_kprobe {
	98	struct kprobe *kp;
	99	unsigned long status;
	100	unsigned long old_flags;
	101	unsigned long saved_flags;
	102	};
	103
	104	/* per-cpu kprobe control block */
	105	struct kprobe_ctlblk {
	106	unsigned long kprobe_status;
	107	unsigned long kprobe_old_flags;
	108	unsigned long kprobe_saved_flags;
	109	unsigned long *jprobe_saved_sp;
	110	struct pt_regs jprobe_saved_regs;
	111	kprobe_opcode_t jprobes_stack[MAX_STACK_SIZE];
	112	struct prev_kprobe prev_kprobe;
	113	};
	114
d6be29b8 MH	115	extern int kprobe_fault_handler(struct pt_regs *regs, int trapnr);
	116	extern int kprobe_exceptions_notify(struct notifier_block *self,
	117	unsigned long val, void *data);
6f6343f5 MH	118	extern int kprobe_int3_handler(struct pt_regs *regs);
6f6343f5 MH	119	extern int kprobe_debug_handler(struct pt_regs *regs);
1965aae3	120	#endif /* _ASM_X86_KPROBES_H */