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/compiler.h>
33#include <linux/linkage.h>
34#include <linux/list.h>
35#include <linux/notifier.h>
36#include <linux/smp.h>
37#include <linux/bug.h>
38#include <linux/percpu.h>
39#include <linux/spinlock.h>
40#include <linux/rcupdate.h>
41#include <linux/mutex.h>
42#include <linux/ftrace.h>
43
44#ifdef CONFIG_KPROBES
45#include <asm/kprobes.h>
46
47
48#define KPROBE_HIT_ACTIVE 0x00000001
49#define KPROBE_HIT_SS 0x00000002
50#define KPROBE_REENTER 0x00000004
51#define KPROBE_HIT_SSDONE 0x00000008
52
53#else
54typedef int kprobe_opcode_t;
55struct arch_specific_insn {
56 int dummy;
57};
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#define KPROBE_FLAG_FTRACE 8
131
132
133static inline int kprobe_gone(struct kprobe *p)
134{
135 return p->flags & KPROBE_FLAG_GONE;
136}
137
138
139static inline int kprobe_disabled(struct kprobe *p)
140{
141 return p->flags & (KPROBE_FLAG_DISABLED | KPROBE_FLAG_GONE);
142}
143
144
145static inline int kprobe_optimized(struct kprobe *p)
146{
147 return p->flags & KPROBE_FLAG_OPTIMIZED;
148}
149
150
151static inline int kprobe_ftrace(struct kprobe *p)
152{
153 return p->flags & KPROBE_FLAG_FTRACE;
154}
155
156
157
158
159
160
161
162
163
164
165
166struct jprobe {
167 struct kprobe kp;
168 void *entry;
169};
170
171
172#define JPROBE_ENTRY(handler) (handler)
173
174
175
176
177
178
179
180
181
182
183
184struct kretprobe {
185 struct kprobe kp;
186 kretprobe_handler_t handler;
187 kretprobe_handler_t entry_handler;
188 int maxactive;
189 int nmissed;
190 size_t data_size;
191 struct hlist_head free_instances;
192 raw_spinlock_t lock;
193};
194
195struct kretprobe_instance {
196 struct hlist_node hlist;
197 struct kretprobe *rp;
198 kprobe_opcode_t *ret_addr;
199 struct task_struct *task;
200 char data[0];
201};
202
203struct kretprobe_blackpoint {
204 const char *name;
205 void *addr;
206};
207
208struct kprobe_blackpoint {
209 const char *name;
210 unsigned long start_addr;
211 unsigned long range;
212};
213
214#ifdef CONFIG_KPROBES
215DECLARE_PER_CPU(struct kprobe *, current_kprobe);
216DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
217
218
219
220
221static inline int kprobes_built_in(void)
222{
223 return 1;
224}
225
226#ifdef CONFIG_KRETPROBES
227extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
228 struct pt_regs *regs);
229extern int arch_trampoline_kprobe(struct kprobe *p);
230#else
231static inline void arch_prepare_kretprobe(struct kretprobe *rp,
232 struct pt_regs *regs)
233{
234}
235static inline int arch_trampoline_kprobe(struct kprobe *p)
236{
237 return 0;
238}
239#endif
240
241extern struct kretprobe_blackpoint kretprobe_blacklist[];
242
243static inline void kretprobe_assert(struct kretprobe_instance *ri,
244 unsigned long orig_ret_address, unsigned long trampoline_address)
245{
246 if (!orig_ret_address || (orig_ret_address == trampoline_address)) {
247 printk("kretprobe BUG!: Processing kretprobe %p @ %p\n",
248 ri->rp, ri->rp->kp.addr);
249 BUG();
250 }
251}
252
253#ifdef CONFIG_KPROBES_SANITY_TEST
254extern int init_test_probes(void);
255#else
256static inline int init_test_probes(void)
257{
258 return 0;
259}
260#endif
261
262extern int arch_prepare_kprobe(struct kprobe *p);
263extern void arch_arm_kprobe(struct kprobe *p);
264extern void arch_disarm_kprobe(struct kprobe *p);
265extern int arch_init_kprobes(void);
266extern void show_registers(struct pt_regs *regs);
267extern void kprobes_inc_nmissed_count(struct kprobe *p);
268
269struct kprobe_insn_cache {
270 struct mutex mutex;
271 void *(*alloc)(void);
272 void (*free)(void *);
273 struct list_head pages;
274 size_t insn_size;
275 int nr_garbage;
276};
277
278extern kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c);
279extern void __free_insn_slot(struct kprobe_insn_cache *c,
280 kprobe_opcode_t *slot, int dirty);
281
282#define DEFINE_INSN_CACHE_OPS(__name) \
283extern struct kprobe_insn_cache kprobe_##__name##_slots; \
284 \
285static inline kprobe_opcode_t *get_##__name##_slot(void) \
286{ \
287 return __get_insn_slot(&kprobe_##__name##_slots); \
288} \
289 \
290static inline void free_##__name##_slot(kprobe_opcode_t *slot, int dirty)\
291{ \
292 __free_insn_slot(&kprobe_##__name##_slots, slot, dirty); \
293} \
294
295DEFINE_INSN_CACHE_OPS(insn);
296
297#ifdef CONFIG_OPTPROBES
298
299
300
301struct optimized_kprobe {
302 struct kprobe kp;
303 struct list_head list;
304 struct arch_optimized_insn optinsn;
305};
306
307
308extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
309extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
310extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op);
311extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
312extern void arch_optimize_kprobes(struct list_head *oplist);
313extern void arch_unoptimize_kprobes(struct list_head *oplist,
314 struct list_head *done_list);
315extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
316extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
317 unsigned long addr);
318
319extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs);
320
321DEFINE_INSN_CACHE_OPS(optinsn);
322
323#ifdef CONFIG_SYSCTL
324extern int sysctl_kprobes_optimization;
325extern int proc_kprobes_optimization_handler(struct ctl_table *table,
326 int write, void __user *buffer,
327 size_t *length, loff_t *ppos);
328#endif
329
330#endif
331#ifdef CONFIG_KPROBES_ON_FTRACE
332extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
333 struct ftrace_ops *ops, struct pt_regs *regs);
334extern int arch_prepare_kprobe_ftrace(struct kprobe *p);
335#endif
336
337
338
339struct kprobe *get_kprobe(void *addr);
340void kretprobe_hash_lock(struct task_struct *tsk,
341 struct hlist_head **head, unsigned long *flags);
342void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags);
343struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
344
345
346static inline struct kprobe *kprobe_running(void)
347{
348 return (__this_cpu_read(current_kprobe));
349}
350
351static inline void reset_current_kprobe(void)
352{
353 __this_cpu_write(current_kprobe, NULL);
354}
355
356static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
357{
358 return (&__get_cpu_var(kprobe_ctlblk));
359}
360
361int register_kprobe(struct kprobe *p);
362void unregister_kprobe(struct kprobe *p);
363int register_kprobes(struct kprobe **kps, int num);
364void unregister_kprobes(struct kprobe **kps, int num);
365int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
366int longjmp_break_handler(struct kprobe *, struct pt_regs *);
367int register_jprobe(struct jprobe *p);
368void unregister_jprobe(struct jprobe *p);
369int register_jprobes(struct jprobe **jps, int num);
370void unregister_jprobes(struct jprobe **jps, int num);
371void jprobe_return(void);
372unsigned long arch_deref_entry_point(void *);
373
374int register_kretprobe(struct kretprobe *rp);
375void unregister_kretprobe(struct kretprobe *rp);
376int register_kretprobes(struct kretprobe **rps, int num);
377void unregister_kretprobes(struct kretprobe **rps, int num);
378
379void kprobe_flush_task(struct task_struct *tk);
380void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);
381
382int disable_kprobe(struct kprobe *kp);
383int enable_kprobe(struct kprobe *kp);
384
385void dump_kprobe(struct kprobe *kp);
386
387#else
388
389static inline int kprobes_built_in(void)
390{
391 return 0;
392}
393static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
394{
395 return 0;
396}
397static inline struct kprobe *get_kprobe(void *addr)
398{
399 return NULL;
400}
401static inline struct kprobe *kprobe_running(void)
402{
403 return NULL;
404}
405static inline int register_kprobe(struct kprobe *p)
406{
407 return -ENOSYS;
408}
409static inline int register_kprobes(struct kprobe **kps, int num)
410{
411 return -ENOSYS;
412}
413static inline void unregister_kprobe(struct kprobe *p)
414{
415}
416static inline void unregister_kprobes(struct kprobe **kps, int num)
417{
418}
419static inline int register_jprobe(struct jprobe *p)
420{
421 return -ENOSYS;
422}
423static inline int register_jprobes(struct jprobe **jps, int num)
424{
425 return -ENOSYS;
426}
427static inline void unregister_jprobe(struct jprobe *p)
428{
429}
430static inline void unregister_jprobes(struct jprobe **jps, int num)
431{
432}
433static inline void jprobe_return(void)
434{
435}
436static inline int register_kretprobe(struct kretprobe *rp)
437{
438 return -ENOSYS;
439}
440static inline int register_kretprobes(struct kretprobe **rps, int num)
441{
442 return -ENOSYS;
443}
444static inline void unregister_kretprobe(struct kretprobe *rp)
445{
446}
447static inline void unregister_kretprobes(struct kretprobe **rps, int num)
448{
449}
450static inline void kprobe_flush_task(struct task_struct *tk)
451{
452}
453static inline int disable_kprobe(struct kprobe *kp)
454{
455 return -ENOSYS;
456}
457static inline int enable_kprobe(struct kprobe *kp)
458{
459 return -ENOSYS;
460}
461#endif
462static inline int disable_kretprobe(struct kretprobe *rp)
463{
464 return disable_kprobe(&rp->kp);
465}
466static inline int enable_kretprobe(struct kretprobe *rp)
467{
468 return enable_kprobe(&rp->kp);
469}
470static inline int disable_jprobe(struct jprobe *jp)
471{
472 return disable_kprobe(&jp->kp);
473}
474static inline int enable_jprobe(struct jprobe *jp)
475{
476 return enable_kprobe(&jp->kp);
477}
478
479#endif
480