1 #ifndef _LINUX_UPROBES_H
2 #define _LINUX_UPROBES_H
4 * User-space Probes (UProbes)
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.
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.
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.
20 * Copyright (C) IBM Corporation, 2008-2012
24 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
27 #include <linux/errno.h>
28 #include <linux/rbtree.h>
29 #include <linux/types.h>
31 struct vm_area_struct;
34 struct notifier_block;
36 #define UPROBE_HANDLER_REMOVE 1
37 #define UPROBE_HANDLER_MASK 1
39 #define MAX_URETPROBE_DEPTH 64
41 enum uprobe_filter_ctx {
42 UPROBE_FILTER_REGISTER,
43 UPROBE_FILTER_UNREGISTER,
47 struct uprobe_consumer {
48 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
49 int (*ret_handler)(struct uprobe_consumer *self,
51 struct pt_regs *regs);
52 bool (*filter)(struct uprobe_consumer *self,
53 enum uprobe_filter_ctx ctx,
54 struct mm_struct *mm);
56 struct uprobe_consumer *next;
60 #include <asm/uprobes.h>
62 enum uprobe_task_state {
70 * uprobe_task: Metadata of a task while it singlesteps.
73 enum uprobe_task_state state;
77 struct arch_uprobe_task autask;
82 struct callback_head dup_xol_work;
83 unsigned long dup_xol_addr;
87 struct uprobe *active_uprobe;
88 unsigned long xol_vaddr;
90 struct return_instance *return_instances;
96 struct uprobes_state {
97 struct xol_area *xol_area;
100 extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
101 extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
102 extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
103 extern bool __weak is_trap_insn(uprobe_opcode_t *insn);
104 extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
105 extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
106 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
107 extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
108 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
109 extern int uprobe_mmap(struct vm_area_struct *vma);
110 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
111 extern void uprobe_start_dup_mmap(void);
112 extern void uprobe_end_dup_mmap(void);
113 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
114 extern void uprobe_free_utask(struct task_struct *t);
115 extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
116 extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
117 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
118 extern void uprobe_notify_resume(struct pt_regs *regs);
119 extern bool uprobe_deny_signal(void);
120 extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
121 extern void uprobe_clear_state(struct mm_struct *mm);
122 extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
123 extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
124 extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
125 extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
126 extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
127 extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
128 extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
129 #else /* !CONFIG_UPROBES */
130 struct uprobes_state {
133 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
138 uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
143 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
146 static inline int uprobe_mmap(struct vm_area_struct *vma)
151 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
154 static inline void uprobe_start_dup_mmap(void)
157 static inline void uprobe_end_dup_mmap(void)
161 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
164 static inline void uprobe_notify_resume(struct pt_regs *regs)
167 static inline bool uprobe_deny_signal(void)
171 static inline void uprobe_free_utask(struct task_struct *t)
174 static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
177 static inline void uprobe_clear_state(struct mm_struct *mm)
180 #endif /* !CONFIG_UPROBES */
181 #endif /* _LINUX_UPROBES_H */