5 * Kernel Probes (KProbes)
6 * include/linux/kprobes.h
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * Copyright (C) IBM Corporation, 2002, 2004
26 * Dynamic Binary Instrumentation Module based on KProbes
27 * modules/kprobe/dbi_kprobes.h
29 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License as published by
31 * the Free Software Foundation; either version 2 of the License, or
32 * (at your option) any later version.
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
43 * Copyright (C) Samsung Electronics, 2006-2010
45 * 2006-2007 Ekaterina Gorelkina <e.gorelkina@samsung.com>: initial implementation for ARM and MIPS
46 * 2008-2009 Alexey Gerenkov <a.gerenkov@samsung.com> User-Space
47 * Probes initial implementation; Support x86/ARM/MIPS for both user and kernel spaces.
48 * 2010 Ekaterina Gorelkina <e.gorelkina@samsung.com>: redesign module for separating core and arch parts
55 #include <linux/version.h> // LINUX_VERSION_CODE, KERNEL_VERSION()
57 //#include <linux/list.h>
58 #include <linux/notifier.h>
59 //#include <linux/smp.h>
60 #include <linux/percpu.h>
61 #include <linux/spinlock.h>
62 #include <linux/rcupdate.h>
63 #include <linux/sched.h>
64 #include <linux/pagemap.h>
66 #include "arch/asm/dbi_kprobes.h"
68 /* kprobe_status settings */
69 #define KPROBE_HIT_ACTIVE 0x00000001
70 #define KPROBE_HIT_SS 0x00000002
71 #define KPROBE_REENTER 0x00000004
72 #define KPROBE_HIT_SSDONE 0x00000008
74 #define HIWORD(x) (((x) & 0xFFFF0000) >> 16)
75 #define LOWORD(x) ((x) & 0x0000FFFF)
77 #define INVALID_VALUE 0xFFFFFFFF
78 #define INVALID_POINTER (void*)INVALID_VALUE
80 #define JPROBE_ENTRY(pentry) (kprobe_opcode_t *)pentry
85 struct kretprobe_instance;
86 typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
87 typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);
88 typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *, unsigned long flags);
89 typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *, int trapnr);
90 typedef int (*kretprobe_handler_t) (struct kretprobe_instance *, struct pt_regs *, void *);
94 struct hlist_node hlist;
96 /*list of probes to search by instruction slot*/
97 struct hlist_node is_hlist;
99 /* list of kprobes for multi-handler support */
100 struct list_head list;
102 /* Indicates that the corresponding module has been ref counted */
103 unsigned int mod_refcounted;
105 /*count the number of times this probe was temporarily disarmed */
106 unsigned long nmissed;
108 /* location of the probe point */
109 kprobe_opcode_t *addr;
111 /* Allow user to indicate symbol name of the probe point */
114 /* Offset into the symbol */
117 /* Called before addr is executed. */
118 kprobe_pre_handler_t pre_handler;
120 /* Called after addr is executed, unless... */
121 kprobe_post_handler_t post_handler;
123 /* ... called if executing addr causes a fault (eg. page fault).
124 * Return 1 if it handled fault, otherwise kernel will see it. */
125 kprobe_fault_handler_t fault_handler;
127 /* ... called if breakpoint trap occurs in probe handler.
128 * Return 1 if it handled break, otherwise kernel will see it. */
129 kprobe_break_handler_t break_handler;
131 /* Saved opcode (which has been replaced with breakpoint) */
132 kprobe_opcode_t opcode;
134 /* copy of the original instruction */
135 struct arch_specific_insn ainsn;
136 // TGID to which probe belongs
138 // override single-step target address,
139 // may be used to redirect control-flow to arbitrary address after probe point
140 // without invocation of original instruction;
141 // useful for functions replacement
142 // if jprobe.entry should return address of function or NULL
143 // if original function should be called
144 // not supported for X86, not tested for MIPS
145 kprobe_opcode_t *ss_addr;
148 typedef unsigned long (*kprobe_pre_entry_handler_t) (void *priv_arg, struct pt_regs * regs);
151 * Special probe type that uses setjmp-longjmp type tricks to resume
152 * execution at a specified entry with a matching prototype corresponding
153 * to the probed function - a trick to enable arguments to become
154 * accessible seamlessly by probe handling logic.
156 * Because of the way compilers allocate stack space for local variables
157 * etc upfront, regardless of sub-scopes within a function, this mirroring
158 * principle currently works only for probes placed on function entry points.
163 kprobe_opcode_t *entry; /* probe handling code to jump to */
164 kprobe_pre_entry_handler_t pre_entry; /*handler whichw willb bec called before 'entry' */
168 struct jprobe_instance
170 struct hlist_node uflist; /* either on free list or used list */
171 struct hlist_node hlist;
173 struct task_struct *task;
181 * Function-return probe -
183 * User needs to provide a handler function, and initialize maxactive.
184 * maxactive - The maximum number of instances of the probed function that
185 * can be active concurrently.
186 * nmissed - tracks the number of times the probed function's return was
187 * ignored, due to maxactive being too low.
193 kretprobe_handler_t handler;
198 struct hlist_head free_instances;
199 struct hlist_head used_instances;
202 struct kretprobe_instance
204 struct hlist_node uflist; /* either on free list or used list */
205 struct hlist_node hlist;
206 struct kretprobe *rp;
207 kprobe_opcode_t *ret_addr;
208 struct kretprobe *rp2;
209 struct task_struct *task;
213 extern void show_registers (struct pt_regs *regs);
214 extern void kprobes_inc_nmissed_count (struct kprobe *p);
216 #define KPROBE_HASH_BITS 6
217 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
220 /* Get the kprobe at this addr (if any) - called with preemption disabled */
221 struct kprobe *get_kprobe (void *addr, int pid, struct task_struct *ctask);
222 struct kprobe *get_kprobe_by_insn_slot (void *addr, int tgid, struct task_struct *ctask);
223 struct hlist_head *kretprobe_inst_table_head (void *hash_key);
226 int register_kprobe (struct kprobe *p, int atomic);
227 void unregister_kprobe (struct kprobe *p, struct task_struct *task, int atomic);
229 int register_aggr_kprobe (struct kprobe *old_p, struct kprobe *p);
230 int pre_handler_kretprobe (struct kprobe *p, struct pt_regs *regs);
232 int setjmp_pre_handler (struct kprobe *, struct pt_regs *);
233 int longjmp_break_handler (struct kprobe *, struct pt_regs *);
235 int register_jprobe (struct jprobe *p, int atomic);
236 void unregister_jprobe (struct jprobe *p, int atomic);
237 void jprobe_return (void);
238 void jprobe_return_end (void);
240 struct kretprobe * clone_kretprobe (struct kretprobe *rp);
241 struct kretprobe_instance * get_used_rp_inst (struct kretprobe *rp);
244 int alloc_nodes_kretprobe(struct kretprobe *rp);
245 int register_kretprobe (struct kretprobe *rp, int atomic);
246 void unregister_kretprobe (struct kretprobe *rp, int atomic);
248 void kretprobe_assert (struct kretprobe_instance *ri,
249 unsigned long orig_ret_address, unsigned long trampoline_address);
252 struct kretprobe_instance *get_free_rp_inst (struct kretprobe *rp);
253 struct kretprobe_instance *get_free_rp_inst_no_alloc (struct kretprobe *rp);
254 void free_rp_inst (struct kretprobe *rp);
255 void add_rp_inst (struct kretprobe_instance *ri);
256 void recycle_rp_inst (struct kretprobe_instance *ri, struct hlist_head *head);
258 //void kretprobe_trampoline_holder (void);
259 int trampoline_probe_handler (struct kprobe *p, struct pt_regs *regs);
261 #ifdef KPROBES_PROFILE
262 int pre_handler_kretprobe (struct kprobe *p, struct pt_regs *regs, struct vm_area_struct **vma, struct page **page, unsigned long **kaddr);
263 void set_normalized_timeval (struct timeval *tv, time_t sec, suseconds_t usec);
267 #endif /* _DBI_KPROBES_H */