1#ifndef _LINUX_KPROBES_H
2#define _LINUX_KPROBES_H
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32#include <linux/linkage.h>
33#include <linux/list.h>
34#include <linux/notifier.h>
35#include <linux/smp.h>
36#include <linux/percpu.h>
37#include <linux/spinlock.h>
38#include <linux/rcupdate.h>
39#include <linux/mutex.h>
40
41#ifdef CONFIG_KPROBES
42#include <asm/kprobes.h>
43
44
45#define KPROBE_HIT_ACTIVE 0x00000001
46#define KPROBE_HIT_SS 0x00000002
47#define KPROBE_REENTER 0x00000004
48#define KPROBE_HIT_SSDONE 0x00000008
49
50
51#define __kprobes __attribute__((__section__(".kprobes.text")))
52#else
53typedef int kprobe_opcode_t;
54struct arch_specific_insn {
55 int dummy;
56};
57#define __kprobes
58#endif
59
60struct kprobe;
61struct pt_regs;
62struct kretprobe;
63struct kretprobe_instance;
64typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
65typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);
66typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
67 unsigned long flags);
68typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *,
69 int trapnr);
70typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
71 struct pt_regs *);
72
73struct kprobe {
74 struct hlist_node hlist;
75
76
77 struct list_head list;
78
79
80 unsigned long nmissed;
81
82
83 kprobe_opcode_t *addr;
84
85
86 const char *symbol_name;
87
88
89 unsigned int offset;
90
91
92 kprobe_pre_handler_t pre_handler;
93
94
95 kprobe_post_handler_t post_handler;
96
97
98
99
100
101 kprobe_fault_handler_t fault_handler;
102
103
104
105
106
107 kprobe_break_handler_t break_handler;
108
109
110 kprobe_opcode_t opcode;
111
112
113 struct arch_specific_insn ainsn;
114
115
116
117
118
119 u32 flags;
120};
121
122
123#define KPROBE_FLAG_GONE 1
124#define KPROBE_FLAG_DISABLED 2
125#define KPROBE_FLAG_OPTIMIZED 4
126
127
128
129
130
131
132static inline int kprobe_gone(struct kprobe *p)
133{
134 return p->flags & KPROBE_FLAG_GONE;
135}
136
137
138static inline int kprobe_disabled(struct kprobe *p)
139{
140 return p->flags & (KPROBE_FLAG_DISABLED | KPROBE_FLAG_GONE);
141}
142
143
144static inline int kprobe_optimized(struct kprobe *p)
145{
146 return p->flags & KPROBE_FLAG_OPTIMIZED;
147}
148
149
150
151
152
153
154
155
156
157
158struct jprobe {
159 struct kprobe kp;
160 void *entry;
161};
162
163
164#define JPROBE_ENTRY(handler) (handler)
165
166
167
168
169
170
171
172
173
174
175
176struct kretprobe {
177 struct kprobe kp;
178 kretprobe_handler_t handler;
179 kretprobe_handler_t entry_handler;
180 int maxactive;
181 int nmissed;
182 size_t data_size;
183 struct hlist_head free_instances;
184 raw_spinlock_t lock;
185};
186
187struct kretprobe_instance {
188 struct hlist_node hlist;
189 struct kretprobe *rp;
190 kprobe_opcode_t *ret_addr;
191 struct task_struct *task;
192 char data[0];
193};
194
195struct kretprobe_blackpoint {
196 const char *name;
197 void *addr;
198};
199
200struct kprobe_blackpoint {
201 const char *name;
202 unsigned long start_addr;
203 unsigned long range;
204};
205
206#ifdef CONFIG_KPROBES
207DECLARE_PER_CPU(struct kprobe *, current_kprobe);
208DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
209
210
211
212
213static inline int kprobes_built_in(void)
214{
215 return 1;
216}
217
218#ifdef CONFIG_KRETPROBES
219extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
220 struct pt_regs *regs);
221extern int arch_trampoline_kprobe(struct kprobe *p);
222#else
223static inline void arch_prepare_kretprobe(struct kretprobe *rp,
224 struct pt_regs *regs)
225{
226}
227static inline int arch_trampoline_kprobe(struct kprobe *p)
228{
229 return 0;
230}
231#endif
232
233extern struct kretprobe_blackpoint kretprobe_blacklist[];
234
235static inline void kretprobe_assert(struct kretprobe_instance *ri,
236 unsigned long orig_ret_address, unsigned long trampoline_address)
237{
238 if (!orig_ret_address || (orig_ret_address == trampoline_address)) {
239 printk("kretprobe BUG!: Processing kretprobe %p @ %p\n",
240 ri->rp, ri->rp->kp.addr);
241 BUG();
242 }
243}
244
245#ifdef CONFIG_KPROBES_SANITY_TEST
246extern int init_test_probes(void);
247#else
248static inline int init_test_probes(void)
249{
250 return 0;
251}
252#endif
253
254extern int arch_prepare_kprobe(struct kprobe *p);
255extern void arch_arm_kprobe(struct kprobe *p);
256extern void arch_disarm_kprobe(struct kprobe *p);
257extern int arch_init_kprobes(void);
258extern void show_registers(struct pt_regs *regs);
259extern kprobe_opcode_t *get_insn_slot(void);
260extern void free_insn_slot(kprobe_opcode_t *slot, int dirty);
261extern void kprobes_inc_nmissed_count(struct kprobe *p);
262
263#ifdef CONFIG_OPTPROBES
264
265
266
267struct optimized_kprobe {
268 struct kprobe kp;
269 struct list_head list;
270 struct arch_optimized_insn optinsn;
271};
272
273
274extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
275extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
276extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op);
277extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
278extern void arch_optimize_kprobes(struct list_head *oplist);
279extern void arch_unoptimize_kprobes(struct list_head *oplist,
280 struct list_head *done_list);
281extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
282extern kprobe_opcode_t *get_optinsn_slot(void);
283extern void free_optinsn_slot(kprobe_opcode_t *slot, int dirty);
284extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
285 unsigned long addr);
286
287extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs);
288
289#ifdef CONFIG_SYSCTL
290extern int sysctl_kprobes_optimization;
291extern int proc_kprobes_optimization_handler(struct ctl_table *table,
292 int write, void __user *buffer,
293 size_t *length, loff_t *ppos);
294#endif
295
296#endif
297
298
299struct kprobe *get_kprobe(void *addr);
300void kretprobe_hash_lock(struct task_struct *tsk,
301 struct hlist_head **head, unsigned long *flags);
302void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags);
303struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
304
305
306static inline struct kprobe *kprobe_running(void)
307{
308 return (__this_cpu_read(current_kprobe));
309}
310
311static inline void reset_current_kprobe(void)
312{
313 __this_cpu_write(current_kprobe, NULL);
314}
315
316static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
317{
318 return (&__get_cpu_var(kprobe_ctlblk));
319}
320
321int register_kprobe(struct kprobe *p);
322void unregister_kprobe(struct kprobe *p);
323int register_kprobes(struct kprobe **kps, int num);
324void unregister_kprobes(struct kprobe **kps, int num);
325int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
326int longjmp_break_handler(struct kprobe *, struct pt_regs *);
327int register_jprobe(struct jprobe *p);
328void unregister_jprobe(struct jprobe *p);
329int register_jprobes(struct jprobe **jps, int num);
330void unregister_jprobes(struct jprobe **jps, int num);
331void jprobe_return(void);
332unsigned long arch_deref_entry_point(void *);
333
334int register_kretprobe(struct kretprobe *rp);
335void unregister_kretprobe(struct kretprobe *rp);
336int register_kretprobes(struct kretprobe **rps, int num);
337void unregister_kretprobes(struct kretprobe **rps, int num);
338
339void kprobe_flush_task(struct task_struct *tk);
340void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);
341
342int disable_kprobe(struct kprobe *kp);
343int enable_kprobe(struct kprobe *kp);
344
345void dump_kprobe(struct kprobe *kp);
346
347#else
348
349static inline int kprobes_built_in(void)
350{
351 return 0;
352}
353static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
354{
355 return 0;
356}
357static inline struct kprobe *get_kprobe(void *addr)
358{
359 return NULL;
360}
361static inline struct kprobe *kprobe_running(void)
362{
363 return NULL;
364}
365static inline int register_kprobe(struct kprobe *p)
366{
367 return -ENOSYS;
368}
369static inline int register_kprobes(struct kprobe **kps, int num)
370{
371 return -ENOSYS;
372}
373static inline void unregister_kprobe(struct kprobe *p)
374{
375}
376static inline void unregister_kprobes(struct kprobe **kps, int num)
377{
378}
379static inline int register_jprobe(struct jprobe *p)
380{
381 return -ENOSYS;
382}
383static inline int register_jprobes(struct jprobe **jps, int num)
384{
385 return -ENOSYS;
386}
387static inline void unregister_jprobe(struct jprobe *p)
388{
389}
390static inline void unregister_jprobes(struct jprobe **jps, int num)
391{
392}
393static inline void jprobe_return(void)
394{
395}
396static inline int register_kretprobe(struct kretprobe *rp)
397{
398 return -ENOSYS;
399}
400static inline int register_kretprobes(struct kretprobe **rps, int num)
401{
402 return -ENOSYS;
403}
404static inline void unregister_kretprobe(struct kretprobe *rp)
405{
406}
407static inline void unregister_kretprobes(struct kretprobe **rps, int num)
408{
409}
410static inline void kprobe_flush_task(struct task_struct *tk)
411{
412}
413static inline int disable_kprobe(struct kprobe *kp)
414{
415 return -ENOSYS;
416}
417static inline int enable_kprobe(struct kprobe *kp)
418{
419 return -ENOSYS;
420}
421#endif
422static inline int disable_kretprobe(struct kretprobe *rp)
423{
424 return disable_kprobe(&rp->kp);
425}
426static inline int enable_kretprobe(struct kretprobe *rp)
427{
428 return enable_kprobe(&rp->kp);
429}
430static inline int disable_jprobe(struct jprobe *jp)
431{
432 return disable_kprobe(&jp->kp);
433}
434static inline int enable_jprobe(struct jprobe *jp)
435{
436 return enable_kprobe(&jp->kp);
437}
438
439#endif
440