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 kprobe_opcode_t *get_insn_slot(void);
268extern void free_insn_slot(kprobe_opcode_t *slot, int dirty);
269extern void kprobes_inc_nmissed_count(struct kprobe *p);
270
271#ifdef CONFIG_OPTPROBES
272
273
274
275struct optimized_kprobe {
276 struct kprobe kp;
277 struct list_head list;
278 struct arch_optimized_insn optinsn;
279};
280
281
282extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
283extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
284extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op);
285extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
286extern void arch_optimize_kprobes(struct list_head *oplist);
287extern void arch_unoptimize_kprobes(struct list_head *oplist,
288 struct list_head *done_list);
289extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
290extern kprobe_opcode_t *get_optinsn_slot(void);
291extern void free_optinsn_slot(kprobe_opcode_t *slot, int dirty);
292extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
293 unsigned long addr);
294
295extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs);
296
297#ifdef CONFIG_SYSCTL
298extern int sysctl_kprobes_optimization;
299extern int proc_kprobes_optimization_handler(struct ctl_table *table,
300 int write, void __user *buffer,
301 size_t *length, loff_t *ppos);
302#endif
303
304#endif
305#ifdef CONFIG_KPROBES_ON_FTRACE
306extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
307 struct ftrace_ops *ops, struct pt_regs *regs);
308extern int arch_prepare_kprobe_ftrace(struct kprobe *p);
309#endif
310
311
312
313struct kprobe *get_kprobe(void *addr);
314void kretprobe_hash_lock(struct task_struct *tsk,
315 struct hlist_head **head, unsigned long *flags);
316void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags);
317struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk);
318
319
320static inline struct kprobe *kprobe_running(void)
321{
322 return (__this_cpu_read(current_kprobe));
323}
324
325static inline void reset_current_kprobe(void)
326{
327 __this_cpu_write(current_kprobe, NULL);
328}
329
330static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
331{
332 return (&__get_cpu_var(kprobe_ctlblk));
333}
334
335int register_kprobe(struct kprobe *p);
336void unregister_kprobe(struct kprobe *p);
337int register_kprobes(struct kprobe **kps, int num);
338void unregister_kprobes(struct kprobe **kps, int num);
339int setjmp_pre_handler(struct kprobe *, struct pt_regs *);
340int longjmp_break_handler(struct kprobe *, struct pt_regs *);
341int register_jprobe(struct jprobe *p);
342void unregister_jprobe(struct jprobe *p);
343int register_jprobes(struct jprobe **jps, int num);
344void unregister_jprobes(struct jprobe **jps, int num);
345void jprobe_return(void);
346unsigned long arch_deref_entry_point(void *);
347
348int register_kretprobe(struct kretprobe *rp);
349void unregister_kretprobe(struct kretprobe *rp);
350int register_kretprobes(struct kretprobe **rps, int num);
351void unregister_kretprobes(struct kretprobe **rps, int num);
352
353void kprobe_flush_task(struct task_struct *tk);
354void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head);
355
356int disable_kprobe(struct kprobe *kp);
357int enable_kprobe(struct kprobe *kp);
358
359void dump_kprobe(struct kprobe *kp);
360
361#else
362
363static inline int kprobes_built_in(void)
364{
365 return 0;
366}
367static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
368{
369 return 0;
370}
371static inline struct kprobe *get_kprobe(void *addr)
372{
373 return NULL;
374}
375static inline struct kprobe *kprobe_running(void)
376{
377 return NULL;
378}
379static inline int register_kprobe(struct kprobe *p)
380{
381 return -ENOSYS;
382}
383static inline int register_kprobes(struct kprobe **kps, int num)
384{
385 return -ENOSYS;
386}
387static inline void unregister_kprobe(struct kprobe *p)
388{
389}
390static inline void unregister_kprobes(struct kprobe **kps, int num)
391{
392}
393static inline int register_jprobe(struct jprobe *p)
394{
395 return -ENOSYS;
396}
397static inline int register_jprobes(struct jprobe **jps, int num)
398{
399 return -ENOSYS;
400}
401static inline void unregister_jprobe(struct jprobe *p)
402{
403}
404static inline void unregister_jprobes(struct jprobe **jps, int num)
405{
406}
407static inline void jprobe_return(void)
408{
409}
410static inline int register_kretprobe(struct kretprobe *rp)
411{
412 return -ENOSYS;
413}
414static inline int register_kretprobes(struct kretprobe **rps, int num)
415{
416 return -ENOSYS;
417}
418static inline void unregister_kretprobe(struct kretprobe *rp)
419{
420}
421static inline void unregister_kretprobes(struct kretprobe **rps, int num)
422{
423}
424static inline void kprobe_flush_task(struct task_struct *tk)
425{
426}
427static inline int disable_kprobe(struct kprobe *kp)
428{
429 return -ENOSYS;
430}
431static inline int enable_kprobe(struct kprobe *kp)
432{
433 return -ENOSYS;
434}
435#endif
436static inline int disable_kretprobe(struct kretprobe *rp)
437{
438 return disable_kprobe(&rp->kp);
439}
440static inline int enable_kretprobe(struct kretprobe *rp)
441{
442 return enable_kprobe(&rp->kp);
443}
444static inline int disable_jprobe(struct jprobe *jp)
445{
446 return disable_kprobe(&jp->kp);
447}
448static inline int enable_jprobe(struct jprobe *jp)
449{
450 return enable_kprobe(&jp->kp);
451}
452
453#endif
454