[PATCH] kprobes: moves lock-unlock to non-arch kprobe_flush_task
[linux-2.6.git] / include / linux / kprobes.h
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.
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.
31  */
32 #include <linux/config.h>
33 #include <linux/list.h>
34 #include <linux/notifier.h>
35 #include <linux/smp.h>
36
37 #include <asm/kprobes.h>
38
39 struct kprobe;
40 struct pt_regs;
41 struct kretprobe;
42 struct kretprobe_instance;
43 typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
44 typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);
45 typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
46                                        unsigned long flags);
47 typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *,
48                                        int trapnr);
49 typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
50                                     struct pt_regs *);
51
52 struct kprobe {
53         struct hlist_node hlist;
54
55         /* list of kprobes for multi-handler support */
56         struct list_head list;
57
58         /* location of the probe point */
59         kprobe_opcode_t *addr;
60
61         /* Called before addr is executed. */
62         kprobe_pre_handler_t pre_handler;
63
64         /* Called after addr is executed, unless... */
65         kprobe_post_handler_t post_handler;
66
67         /* ... called if executing addr causes a fault (eg. page fault).
68          * Return 1 if it handled fault, otherwise kernel will see it. */
69         kprobe_fault_handler_t fault_handler;
70
71         /* ... called if breakpoint trap occurs in probe handler.
72          * Return 1 if it handled break, otherwise kernel will see it. */
73         kprobe_break_handler_t break_handler;
74
75         /* Saved opcode (which has been replaced with breakpoint) */
76         kprobe_opcode_t opcode;
77
78         /* copy of the original instruction */
79         struct arch_specific_insn ainsn;
80 };
81
82 /*
83  * Special probe type that uses setjmp-longjmp type tricks to resume
84  * execution at a specified entry with a matching prototype corresponding
85  * to the probed function - a trick to enable arguments to become
86  * accessible seamlessly by probe handling logic.
87  * Note:
88  * Because of the way compilers allocate stack space for local variables
89  * etc upfront, regardless of sub-scopes within a function, this mirroring
90  * principle currently works only for probes placed on function entry points.
91  */
92 struct jprobe {
93         struct kprobe kp;
94         kprobe_opcode_t *entry; /* probe handling code to jump to */
95 };
96
97 #ifdef ARCH_SUPPORTS_KRETPROBES
98 extern int trampoline_probe_handler(struct kprobe *p, struct pt_regs *regs);
99 extern void trampoline_post_handler(struct kprobe *p, struct pt_regs *regs,
100                                                         unsigned long flags);
101 extern struct task_struct *arch_get_kprobe_task(void *ptr);
102 extern void arch_prepare_kretprobe(struct kretprobe *rp, struct pt_regs *regs);
103 extern void arch_kprobe_flush_task(struct task_struct *tk);
104 #else /* ARCH_SUPPORTS_KRETPROBES */
105 static inline void kretprobe_trampoline(void)
106 {
107 }
108 static inline int trampoline_probe_handler(struct kprobe *p,
109                                                 struct pt_regs *regs)
110 {
111         return 0;
112 }
113 static inline void trampoline_post_handler(struct kprobe *p,
114                                 struct pt_regs *regs, unsigned long flags)
115 {
116 }
117 static inline void arch_prepare_kretprobe(struct kretprobe *rp,
118                                         struct pt_regs *regs)
119 {
120 }
121 static inline void arch_kprobe_flush_task(struct task_struct *tk)
122 {
123 }
124 #define arch_get_kprobe_task(ptr) ((struct task_struct *)NULL)
125 #endif /* ARCH_SUPPORTS_KRETPROBES */
126 /*
127  * Function-return probe -
128  * Note:
129  * User needs to provide a handler function, and initialize maxactive.
130  * maxactive - The maximum number of instances of the probed function that
131  * can be active concurrently.
132  * nmissed - tracks the number of times the probed function's return was
133  * ignored, due to maxactive being too low.
134  *
135  */
136 struct kretprobe {
137         struct kprobe kp;
138         kretprobe_handler_t handler;
139         int maxactive;
140         int nmissed;
141         struct hlist_head free_instances;
142         struct hlist_head used_instances;
143 };
144
145 struct kretprobe_instance {
146         struct hlist_node uflist; /* either on free list or used list */
147         struct hlist_node hlist;
148         struct kretprobe *rp;
149         void *ret_addr;
150         void *stack_addr;
151 };
152
153 #ifdef CONFIG_KPROBES
154 /* Locks kprobe: irq must be disabled */
155 void lock_kprobes(void);
156 void unlock_kprobes(void);
157
158 /* kprobe running now on this CPU? */
159 static inline int kprobe_running(void)
160 {
161         extern unsigned int kprobe_cpu;
162         return kprobe_cpu == smp_processor_id();
163 }
164
165 extern int arch_prepare_kprobe(struct kprobe *p);
166 extern void arch_copy_kprobe(struct kprobe *p);
167 extern void arch_arm_kprobe(struct kprobe *p);
168 extern void arch_disarm_kprobe(struct kprobe *p);
169 extern void arch_remove_kprobe(struct kprobe *p);
170 extern void show_registers(struct pt_regs *regs);
171
172 /* Get the kprobe at this addr (if any).  Must have called lock_kprobes */
173 struct kprobe *get_kprobe(void *addr);
174 struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
175
176 int register_kprobe(struct kprobe *p);
177 void unregister_kprobe(struct kprobe *p);
178 int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
179 int longjmp_break_handler(struct kprobe *, struct pt_regs *);
180 int register_jprobe(struct jprobe *p);
181 void unregister_jprobe(struct jprobe *p);
182 void jprobe_return(void);
183
184 int register_kretprobe(struct kretprobe *rp);
185 void unregister_kretprobe(struct kretprobe *rp);
186
187 struct kretprobe_instance *get_free_rp_inst(struct kretprobe *rp);
188 struct kretprobe_instance *get_rp_inst(void *sara);
189 struct kretprobe_instance *get_rp_inst_tsk(struct task_struct *tk);
190 void add_rp_inst(struct kretprobe_instance *ri);
191 void kprobe_flush_task(struct task_struct *tk);
192 void recycle_rp_inst(struct kretprobe_instance *ri);
193 #else /* CONFIG_KPROBES */
194 static inline int kprobe_running(void)
195 {
196         return 0;
197 }
198 static inline int register_kprobe(struct kprobe *p)
199 {
200         return -ENOSYS;
201 }
202 static inline void unregister_kprobe(struct kprobe *p)
203 {
204 }
205 static inline int register_jprobe(struct jprobe *p)
206 {
207         return -ENOSYS;
208 }
209 static inline void unregister_jprobe(struct jprobe *p)
210 {
211 }
212 static inline void jprobe_return(void)
213 {
214 }
215 static inline int register_kretprobe(struct kretprobe *rp)
216 {
217         return -ENOSYS;
218 }
219 static inline void unregister_kretprobe(struct kretprobe *rp)
220 {
221 }
222 static inline void kprobe_flush_task(struct task_struct *tk)
223 {
224 }
225 #endif                          /* CONFIG_KPROBES */
226 #endif                          /* _LINUX_KPROBES_H */