Commit | Line | Data |
---|---|---|
2b144498 SD |
1 | #ifndef _LINUX_UPROBES_H |
2 | #define _LINUX_UPROBES_H | |
3 | /* | |
7b2d81d4 | 4 | * User-space Probes (UProbes) |
2b144498 SD |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
19 | * | |
35aa621b | 20 | * Copyright (C) IBM Corporation, 2008-2012 |
2b144498 SD |
21 | * Authors: |
22 | * Srikar Dronamraju | |
23 | * Jim Keniston | |
90eec103 | 24 | * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra |
2b144498 SD |
25 | */ |
26 | ||
27 | #include <linux/errno.h> | |
28 | #include <linux/rbtree.h> | |
32473431 | 29 | #include <linux/types.h> |
2b144498 SD |
30 | |
31 | struct vm_area_struct; | |
d4b3b638 SD |
32 | struct mm_struct; |
33 | struct inode; | |
3820b4d2 | 34 | struct notifier_block; |
72e6ae28 | 35 | struct page; |
0326f5a9 | 36 | |
da1816b1 ON |
37 | #define UPROBE_HANDLER_REMOVE 1 |
38 | #define UPROBE_HANDLER_MASK 1 | |
39 | ||
ded49c55 AA |
40 | #define MAX_URETPROBE_DEPTH 64 |
41 | ||
8a7f2fa0 ON |
42 | enum uprobe_filter_ctx { |
43 | UPROBE_FILTER_REGISTER, | |
44 | UPROBE_FILTER_UNREGISTER, | |
45 | UPROBE_FILTER_MMAP, | |
46 | }; | |
47 | ||
2b144498 SD |
48 | struct uprobe_consumer { |
49 | int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs); | |
ea024870 AA |
50 | int (*ret_handler)(struct uprobe_consumer *self, |
51 | unsigned long func, | |
52 | struct pt_regs *regs); | |
8a7f2fa0 ON |
53 | bool (*filter)(struct uprobe_consumer *self, |
54 | enum uprobe_filter_ctx ctx, | |
55 | struct mm_struct *mm); | |
2b144498 SD |
56 | |
57 | struct uprobe_consumer *next; | |
58 | }; | |
59 | ||
2b144498 | 60 | #ifdef CONFIG_UPROBES |
c912dae6 ON |
61 | #include <asm/uprobes.h> |
62 | ||
0326f5a9 SD |
63 | enum uprobe_task_state { |
64 | UTASK_RUNNING, | |
0326f5a9 SD |
65 | UTASK_SSTEP, |
66 | UTASK_SSTEP_ACK, | |
67 | UTASK_SSTEP_TRAPPED, | |
68 | }; | |
69 | ||
70 | /* | |
71 | * uprobe_task: Metadata of a task while it singlesteps. | |
72 | */ | |
73 | struct uprobe_task { | |
74 | enum uprobe_task_state state; | |
0326f5a9 | 75 | |
32473431 ON |
76 | union { |
77 | struct { | |
78 | struct arch_uprobe_task autask; | |
79 | unsigned long vaddr; | |
80 | }; | |
81 | ||
82 | struct { | |
83 | struct callback_head dup_xol_work; | |
84 | unsigned long dup_xol_addr; | |
85 | }; | |
86 | }; | |
0326f5a9 | 87 | |
32473431 | 88 | struct uprobe *active_uprobe; |
0326f5a9 | 89 | unsigned long xol_vaddr; |
32473431 ON |
90 | |
91 | struct return_instance *return_instances; | |
92 | unsigned int depth; | |
0326f5a9 SD |
93 | }; |
94 | ||
97da8976 ON |
95 | struct return_instance { |
96 | struct uprobe *uprobe; | |
97 | unsigned long func; | |
7b868e48 | 98 | unsigned long stack; /* stack pointer */ |
97da8976 ON |
99 | unsigned long orig_ret_vaddr; /* original return address */ |
100 | bool chained; /* true, if instance is nested */ | |
101 | ||
102 | struct return_instance *next; /* keep as stack */ | |
103 | }; | |
104 | ||
86dcb702 ON |
105 | enum rp_check { |
106 | RP_CHECK_CALL, | |
db087ef6 | 107 | RP_CHECK_CHAIN_CALL, |
86dcb702 ON |
108 | RP_CHECK_RET, |
109 | }; | |
110 | ||
c912dae6 | 111 | struct xol_area; |
d4b3b638 SD |
112 | |
113 | struct uprobes_state { | |
114 | struct xol_area *xol_area; | |
115 | }; | |
647c42df | 116 | |
271a9c35 BH |
117 | extern int set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); |
118 | extern int set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); | |
119 | extern bool is_swbp_insn(uprobe_opcode_t *insn); | |
120 | extern bool is_trap_insn(uprobe_opcode_t *insn); | |
121 | extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs); | |
b02ef20a | 122 | extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs); |
f72d41fa | 123 | extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t); |
e3343e6a | 124 | extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); |
bdf8647c | 125 | extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool); |
e3343e6a | 126 | extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); |
7b2d81d4 | 127 | extern int uprobe_mmap(struct vm_area_struct *vma); |
cbc91f71 | 128 | extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end); |
32cdba1e ON |
129 | extern void uprobe_start_dup_mmap(void); |
130 | extern void uprobe_end_dup_mmap(void); | |
f8ac4ec9 | 131 | extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm); |
0326f5a9 | 132 | extern void uprobe_free_utask(struct task_struct *t); |
3ab67966 | 133 | extern void uprobe_copy_process(struct task_struct *t, unsigned long flags); |
0326f5a9 SD |
134 | extern int uprobe_post_sstep_notifier(struct pt_regs *regs); |
135 | extern int uprobe_pre_sstep_notifier(struct pt_regs *regs); | |
136 | extern void uprobe_notify_resume(struct pt_regs *regs); | |
137 | extern bool uprobe_deny_signal(void); | |
c2d3f25d | 138 | extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs); |
d4b3b638 | 139 | extern void uprobe_clear_state(struct mm_struct *mm); |
3820b4d2 DL |
140 | extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr); |
141 | extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs); | |
142 | extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs); | |
143 | extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk); | |
144 | extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data); | |
145 | extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs); | |
146 | extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs); | |
86dcb702 | 147 | extern bool arch_uretprobe_is_alive(struct return_instance *ret, enum rp_check ctx, struct pt_regs *regs); |
271a9c35 BH |
148 | extern bool arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs); |
149 | extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr, | |
72e6ae28 | 150 | void *src, unsigned long len); |
0326f5a9 | 151 | #else /* !CONFIG_UPROBES */ |
d4b3b638 SD |
152 | struct uprobes_state { |
153 | }; | |
b02ef20a ON |
154 | |
155 | #define uprobe_get_trap_addr(regs) instruction_pointer(regs) | |
156 | ||
7b2d81d4 | 157 | static inline int |
e3343e6a | 158 | uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
2b144498 SD |
159 | { |
160 | return -ENOSYS; | |
161 | } | |
bdf8647c ON |
162 | static inline int |
163 | uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add) | |
164 | { | |
165 | return -ENOSYS; | |
166 | } | |
7b2d81d4 | 167 | static inline void |
e3343e6a | 168 | uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
2b144498 SD |
169 | { |
170 | } | |
7b2d81d4 | 171 | static inline int uprobe_mmap(struct vm_area_struct *vma) |
2b144498 SD |
172 | { |
173 | return 0; | |
174 | } | |
cbc91f71 SD |
175 | static inline void |
176 | uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end) | |
682968e0 SD |
177 | { |
178 | } | |
32cdba1e ON |
179 | static inline void uprobe_start_dup_mmap(void) |
180 | { | |
181 | } | |
182 | static inline void uprobe_end_dup_mmap(void) | |
183 | { | |
184 | } | |
f8ac4ec9 ON |
185 | static inline void |
186 | uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) | |
187 | { | |
188 | } | |
0326f5a9 SD |
189 | static inline void uprobe_notify_resume(struct pt_regs *regs) |
190 | { | |
191 | } | |
192 | static inline bool uprobe_deny_signal(void) | |
193 | { | |
194 | return false; | |
195 | } | |
0326f5a9 SD |
196 | static inline void uprobe_free_utask(struct task_struct *t) |
197 | { | |
198 | } | |
3ab67966 | 199 | static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags) |
0326f5a9 SD |
200 | { |
201 | } | |
d4b3b638 SD |
202 | static inline void uprobe_clear_state(struct mm_struct *mm) |
203 | { | |
204 | } | |
0326f5a9 | 205 | #endif /* !CONFIG_UPROBES */ |
2b144498 | 206 | #endif /* _LINUX_UPROBES_H */ |