powerpc: Fix missing 'blr' in _tlbia()
[deliverable/linux.git] / include / linux / kprobes.h
CommitLineData
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 */
36dcd67a 32#include <linux/linkage.h>
1da177e4
LT
33#include <linux/list.h>
34#include <linux/notifier.h>
35#include <linux/smp.h>
e6584523 36#include <linux/percpu.h>
3516a460
AM
37#include <linux/spinlock.h>
38#include <linux/rcupdate.h>
7a7d1cf9 39#include <linux/mutex.h>
b94cce92 40
00d7c05a 41#ifdef CONFIG_KPROBES
1da177e4
LT
42#include <asm/kprobes.h>
43
ea32c65c
PP
44/* kprobe_status settings */
45#define KPROBE_HIT_ACTIVE 0x00000001
46#define KPROBE_HIT_SS 0x00000002
47#define KPROBE_REENTER 0x00000004
48#define KPROBE_HIT_SSDONE 0x00000008
49
d0aaff97 50/* Attach to insert probes on any functions which should be ignored*/
36dcd67a 51#define __kprobes __attribute__((__section__(".kprobes.text"))) notrace
d0aaff97 52
1da177e4
LT
53struct kprobe;
54struct pt_regs;
b94cce92
HN
55struct kretprobe;
56struct kretprobe_instance;
1da177e4
LT
57typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
58typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);
59typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
60 unsigned long flags);
61typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *,
62 int trapnr);
b94cce92
HN
63typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
64 struct pt_regs *);
65
1da177e4
LT
66struct kprobe {
67 struct hlist_node hlist;
68
64f562c6
AM
69 /* list of kprobes for multi-handler support */
70 struct list_head list;
71
df019b1d
KA
72 /* Indicates that the corresponding module has been ref counted */
73 unsigned int mod_refcounted;
74
ea32c65c
PP
75 /*count the number of times this probe was temporarily disarmed */
76 unsigned long nmissed;
77
1da177e4
LT
78 /* location of the probe point */
79 kprobe_opcode_t *addr;
80
3a872d89 81 /* Allow user to indicate symbol name of the probe point */
9b3af29b 82 const char *symbol_name;
3a872d89
AM
83
84 /* Offset into the symbol */
85 unsigned int offset;
86
1da177e4
LT
87 /* Called before addr is executed. */
88 kprobe_pre_handler_t pre_handler;
89
90 /* Called after addr is executed, unless... */
91 kprobe_post_handler_t post_handler;
92
93 /* ... called if executing addr causes a fault (eg. page fault).
94 * Return 1 if it handled fault, otherwise kernel will see it. */
95 kprobe_fault_handler_t fault_handler;
96
97 /* ... called if breakpoint trap occurs in probe handler.
98 * Return 1 if it handled break, otherwise kernel will see it. */
99 kprobe_break_handler_t break_handler;
100
101 /* Saved opcode (which has been replaced with breakpoint) */
102 kprobe_opcode_t opcode;
103
104 /* copy of the original instruction */
105 struct arch_specific_insn ainsn;
106};
107
108/*
109 * Special probe type that uses setjmp-longjmp type tricks to resume
110 * execution at a specified entry with a matching prototype corresponding
111 * to the probed function - a trick to enable arguments to become
112 * accessible seamlessly by probe handling logic.
113 * Note:
114 * Because of the way compilers allocate stack space for local variables
115 * etc upfront, regardless of sub-scopes within a function, this mirroring
116 * principle currently works only for probes placed on function entry points.
117 */
118struct jprobe {
119 struct kprobe kp;
81eae375 120 void *entry; /* probe handling code to jump to */
1da177e4
LT
121};
122
9e367d85
ME
123/* For backward compatibility with old code using JPROBE_ENTRY() */
124#define JPROBE_ENTRY(handler) (handler)
125
e6584523
AM
126DECLARE_PER_CPU(struct kprobe *, current_kprobe);
127DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
128
9edddaa2 129#ifdef CONFIG_KRETPROBES
4c4308cb
CH
130extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
131 struct pt_regs *regs);
bf8f6e5b 132extern int arch_trampoline_kprobe(struct kprobe *p);
9edddaa2 133#else /* CONFIG_KRETPROBES */
b94cce92
HN
134static inline void arch_prepare_kretprobe(struct kretprobe *rp,
135 struct pt_regs *regs)
136{
137}
bf8f6e5b
AM
138static inline int arch_trampoline_kprobe(struct kprobe *p)
139{
140 return 0;
141}
9edddaa2 142#endif /* CONFIG_KRETPROBES */
b94cce92
HN
143/*
144 * Function-return probe -
145 * Note:
146 * User needs to provide a handler function, and initialize maxactive.
147 * maxactive - The maximum number of instances of the probed function that
148 * can be active concurrently.
149 * nmissed - tracks the number of times the probed function's return was
150 * ignored, due to maxactive being too low.
151 *
152 */
153struct kretprobe {
154 struct kprobe kp;
155 kretprobe_handler_t handler;
f47cd9b5 156 kretprobe_handler_t entry_handler;
b94cce92
HN
157 int maxactive;
158 int nmissed;
f47cd9b5 159 size_t data_size;
b94cce92 160 struct hlist_head free_instances;
ef53d9c5 161 spinlock_t lock;
b94cce92
HN
162};
163
164struct kretprobe_instance {
b94cce92
HN
165 struct hlist_node hlist;
166 struct kretprobe *rp;
802eae7c
RL
167 kprobe_opcode_t *ret_addr;
168 struct task_struct *task;
f47cd9b5 169 char data[0];
b94cce92
HN
170};
171
f438d914
MH
172struct kretprobe_blackpoint {
173 const char *name;
174 void *addr;
175};
3d8d996e
SD
176
177struct kprobe_blackpoint {
178 const char *name;
179 unsigned long start_addr;
180 unsigned long range;
181};
182
f438d914
MH
183extern struct kretprobe_blackpoint kretprobe_blacklist[];
184
0f95b7fc
AM
185static inline void kretprobe_assert(struct kretprobe_instance *ri,
186 unsigned long orig_ret_address, unsigned long trampoline_address)
187{
188 if (!orig_ret_address || (orig_ret_address == trampoline_address)) {
189 printk("kretprobe BUG!: Processing kretprobe %p @ %p\n",
190 ri->rp, ri->rp->kp.addr);
191 BUG();
192 }
193}
194
8c1c9356
AM
195#ifdef CONFIG_KPROBES_SANITY_TEST
196extern int init_test_probes(void);
197#else
198static inline int init_test_probes(void)
199{
200 return 0;
201}
202#endif /* CONFIG_KPROBES_SANITY_TEST */
203
7a7d1cf9 204extern struct mutex kprobe_mutex;
1da177e4 205extern int arch_prepare_kprobe(struct kprobe *p);
7e1048b1
RL
206extern void arch_arm_kprobe(struct kprobe *p);
207extern void arch_disarm_kprobe(struct kprobe *p);
6772926b 208extern int arch_init_kprobes(void);
1da177e4 209extern void show_registers(struct pt_regs *regs);
9ec4b1f3 210extern kprobe_opcode_t *get_insn_slot(void);
b4c6c34a 211extern void free_insn_slot(kprobe_opcode_t *slot, int dirty);
bf8d5c52 212extern void kprobes_inc_nmissed_count(struct kprobe *p);
1da177e4 213
d217d545 214/* Get the kprobe at this addr (if any) - called with preemption disabled */
1da177e4 215struct kprobe *get_kprobe(void *addr);
ef53d9c5
S
216void kretprobe_hash_lock(struct task_struct *tsk,
217 struct hlist_head **head, unsigned long *flags);
218void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags);
b94cce92 219struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
1da177e4 220
e6584523
AM
221/* kprobe_running() will just return the current_kprobe on this CPU */
222static inline struct kprobe *kprobe_running(void)
223{
224 return (__get_cpu_var(current_kprobe));
225}
226
227static inline void reset_current_kprobe(void)
228{
229 __get_cpu_var(current_kprobe) = NULL;
230}
231
232static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
233{
234 return (&__get_cpu_var(kprobe_ctlblk));
235}
236
1da177e4
LT
237int register_kprobe(struct kprobe *p);
238void unregister_kprobe(struct kprobe *p);
9861668f
MH
239int register_kprobes(struct kprobe **kps, int num);
240void unregister_kprobes(struct kprobe **kps, int num);
1da177e4
LT
241int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
242int longjmp_break_handler(struct kprobe *, struct pt_regs *);
243int register_jprobe(struct jprobe *p);
244void unregister_jprobe(struct jprobe *p);
26b31c19
MH
245int register_jprobes(struct jprobe **jps, int num);
246void unregister_jprobes(struct jprobe **jps, int num);
1da177e4 247void jprobe_return(void);
3d7e3382 248unsigned long arch_deref_entry_point(void *);
1da177e4 249
b94cce92
HN
250int register_kretprobe(struct kretprobe *rp);
251void unregister_kretprobe(struct kretprobe *rp);
4a296e07
MH
252int register_kretprobes(struct kretprobe **rps, int num);
253void unregister_kretprobes(struct kretprobe **rps, int num);
b94cce92 254
b94cce92 255void kprobe_flush_task(struct task_struct *tk);
99219a3f 256void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);
8c1c9356 257
b94cce92 258#else /* CONFIG_KPROBES */
00d7c05a 259
36dcd67a 260#define __kprobes notrace
00d7c05a
KA
261struct jprobe;
262struct kretprobe;
263
785656a4
AS
264static inline struct kprobe *get_kprobe(void *addr)
265{
266 return NULL;
267}
e6584523 268static inline struct kprobe *kprobe_running(void)
1da177e4 269{
e6584523 270 return NULL;
1da177e4
LT
271}
272static inline int register_kprobe(struct kprobe *p)
273{
274 return -ENOSYS;
275}
9861668f
MH
276static inline int register_kprobes(struct kprobe **kps, int num)
277{
278 return -ENOSYS;
279}
1da177e4
LT
280static inline void unregister_kprobe(struct kprobe *p)
281{
282}
9861668f
MH
283static inline void unregister_kprobes(struct kprobe **kps, int num)
284{
285}
1da177e4
LT
286static inline int register_jprobe(struct jprobe *p)
287{
288 return -ENOSYS;
289}
26b31c19
MH
290static inline int register_jprobes(struct jprobe **jps, int num)
291{
292 return -ENOSYS;
293}
1da177e4
LT
294static inline void unregister_jprobe(struct jprobe *p)
295{
296}
26b31c19
MH
297static inline void unregister_jprobes(struct jprobe **jps, int num)
298{
299}
1da177e4
LT
300static inline void jprobe_return(void)
301{
302}
b94cce92
HN
303static inline int register_kretprobe(struct kretprobe *rp)
304{
305 return -ENOSYS;
306}
4a296e07
MH
307static inline int register_kretprobes(struct kretprobe **rps, int num)
308{
309 return -ENOSYS;
310}
b94cce92
HN
311static inline void unregister_kretprobe(struct kretprobe *rp)
312{
313}
4a296e07
MH
314static inline void unregister_kretprobes(struct kretprobe **rps, int num)
315{
316}
b94cce92
HN
317static inline void kprobe_flush_task(struct task_struct *tk)
318{
319}
320#endif /* CONFIG_KPROBES */
1da177e4 321#endif /* _LINUX_KPROBES_H */
This page took 0.615918 seconds and 5 git commands to generate.