Merge tag 'pm+acpi-4.4-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael...
[firefly-linux-kernel-4.4.55.git] / include / linux / uprobes.h
1 #ifndef _LINUX_UPROBES_H
2 #define _LINUX_UPROBES_H
3 /*
4  * User-space Probes (UProbes)
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  *
20  * Copyright (C) IBM Corporation, 2008-2012
21  * Authors:
22  *      Srikar Dronamraju
23  *      Jim Keniston
24  * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
25  */
26
27 #include <linux/errno.h>
28 #include <linux/rbtree.h>
29 #include <linux/types.h>
30
31 struct vm_area_struct;
32 struct mm_struct;
33 struct inode;
34 struct notifier_block;
35 struct page;
36
37 #define UPROBE_HANDLER_REMOVE           1
38 #define UPROBE_HANDLER_MASK             1
39
40 #define MAX_URETPROBE_DEPTH             64
41
42 enum uprobe_filter_ctx {
43         UPROBE_FILTER_REGISTER,
44         UPROBE_FILTER_UNREGISTER,
45         UPROBE_FILTER_MMAP,
46 };
47
48 struct uprobe_consumer {
49         int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
50         int (*ret_handler)(struct uprobe_consumer *self,
51                                 unsigned long func,
52                                 struct pt_regs *regs);
53         bool (*filter)(struct uprobe_consumer *self,
54                                 enum uprobe_filter_ctx ctx,
55                                 struct mm_struct *mm);
56
57         struct uprobe_consumer *next;
58 };
59
60 #ifdef CONFIG_UPROBES
61 #include <asm/uprobes.h>
62
63 enum uprobe_task_state {
64         UTASK_RUNNING,
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;
75
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         };
87
88         struct uprobe                   *active_uprobe;
89         unsigned long                   xol_vaddr;
90
91         struct return_instance          *return_instances;
92         unsigned int                    depth;
93 };
94
95 struct return_instance {
96         struct uprobe           *uprobe;
97         unsigned long           func;
98         unsigned long           stack;          /* stack pointer */
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
105 enum rp_check {
106         RP_CHECK_CALL,
107         RP_CHECK_CHAIN_CALL,
108         RP_CHECK_RET,
109 };
110
111 struct xol_area;
112
113 struct uprobes_state {
114         struct xol_area         *xol_area;
115 };
116
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);
122 extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs);
123 extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
124 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
125 extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
126 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
127 extern int uprobe_mmap(struct vm_area_struct *vma);
128 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
129 extern void uprobe_start_dup_mmap(void);
130 extern void uprobe_end_dup_mmap(void);
131 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
132 extern void uprobe_free_utask(struct task_struct *t);
133 extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
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);
138 extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
139 extern void uprobe_clear_state(struct mm_struct *mm);
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);
147 extern bool arch_uretprobe_is_alive(struct return_instance *ret, enum rp_check ctx, struct pt_regs *regs);
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,
150                                          void *src, unsigned long len);
151 #else /* !CONFIG_UPROBES */
152 struct uprobes_state {
153 };
154
155 #define uprobe_get_trap_addr(regs)      instruction_pointer(regs)
156
157 static inline int
158 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
159 {
160         return -ENOSYS;
161 }
162 static inline int
163 uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
164 {
165         return -ENOSYS;
166 }
167 static inline void
168 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
169 {
170 }
171 static inline int uprobe_mmap(struct vm_area_struct *vma)
172 {
173         return 0;
174 }
175 static inline void
176 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
177 {
178 }
179 static inline void uprobe_start_dup_mmap(void)
180 {
181 }
182 static inline void uprobe_end_dup_mmap(void)
183 {
184 }
185 static inline void
186 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
187 {
188 }
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 }
196 static inline void uprobe_free_utask(struct task_struct *t)
197 {
198 }
199 static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
200 {
201 }
202 static inline void uprobe_clear_state(struct mm_struct *mm)
203 {
204 }
205 #endif /* !CONFIG_UPROBES */
206 #endif  /* _LINUX_UPROBES_H */