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 25 */ 26 27 #include <linux/errno.h> 28 #include <linux/rbtree.h> 29 #include <linux/types.h> 30 #include <linux/wait.h> 31 32 struct vm_area_struct; 33 struct mm_struct; 34 struct inode; 35 struct notifier_block; 36 struct page; 37 38 #define UPROBE_HANDLER_REMOVE 1 39 #define UPROBE_HANDLER_MASK 1 40 41 #define MAX_URETPROBE_DEPTH 64 42 43 enum uprobe_filter_ctx { 44 UPROBE_FILTER_REGISTER, 45 UPROBE_FILTER_UNREGISTER, 46 UPROBE_FILTER_MMAP, 47 }; 48 49 struct uprobe_consumer { 50 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs); 51 int (*ret_handler)(struct uprobe_consumer *self, 52 unsigned long func, 53 struct pt_regs *regs); 54 bool (*filter)(struct uprobe_consumer *self, 55 enum uprobe_filter_ctx ctx, 56 struct mm_struct *mm); 57 58 struct uprobe_consumer *next; 59 }; 60 61 #ifdef CONFIG_UPROBES 62 #include <asm/uprobes.h> 63 64 enum uprobe_task_state { 65 UTASK_RUNNING, 66 UTASK_SSTEP, 67 UTASK_SSTEP_ACK, 68 UTASK_SSTEP_TRAPPED, 69 }; 70 71 /* 72 * uprobe_task: Metadata of a task while it singlesteps. 73 */ 74 struct uprobe_task { 75 enum uprobe_task_state state; 76 77 union { 78 struct { 79 struct arch_uprobe_task autask; 80 unsigned long vaddr; 81 }; 82 83 struct { 84 struct callback_head dup_xol_work; 85 unsigned long dup_xol_addr; 86 }; 87 }; 88 89 struct uprobe *active_uprobe; 90 unsigned long xol_vaddr; 91 92 struct return_instance *return_instances; 93 unsigned int depth; 94 }; 95 96 struct return_instance { 97 struct uprobe *uprobe; 98 unsigned long func; 99 unsigned long stack; /* stack pointer */ 100 unsigned long orig_ret_vaddr; /* original return address */ 101 bool chained; /* true, if instance is nested */ 102 103 struct return_instance *next; /* keep as stack */ 104 }; 105 106 enum rp_check { 107 RP_CHECK_CALL, 108 RP_CHECK_CHAIN_CALL, 109 RP_CHECK_RET, 110 }; 111 112 struct xol_area; 113 114 struct uprobes_state { 115 struct xol_area *xol_area; 116 }; 117 118 extern int set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); 119 extern int set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); 120 extern bool is_swbp_insn(uprobe_opcode_t *insn); 121 extern bool is_trap_insn(uprobe_opcode_t *insn); 122 extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs); 123 extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs); 124 extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t); 125 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); 126 extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool); 127 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); 128 extern int uprobe_mmap(struct vm_area_struct *vma); 129 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end); 130 extern void uprobe_start_dup_mmap(void); 131 extern void uprobe_end_dup_mmap(void); 132 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm); 133 extern void uprobe_free_utask(struct task_struct *t); 134 extern void uprobe_copy_process(struct task_struct *t, unsigned long flags); 135 extern int uprobe_post_sstep_notifier(struct pt_regs *regs); 136 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs); 137 extern void uprobe_notify_resume(struct pt_regs *regs); 138 extern bool uprobe_deny_signal(void); 139 extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs); 140 extern void uprobe_clear_state(struct mm_struct *mm); 141 extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr); 142 extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs); 143 extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs); 144 extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk); 145 extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data); 146 extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs); 147 extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs); 148 extern bool arch_uretprobe_is_alive(struct return_instance *ret, enum rp_check ctx, struct pt_regs *regs); 149 extern bool arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs); 150 extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr, 151 void *src, unsigned long len); 152 #else /* !CONFIG_UPROBES */ 153 struct uprobes_state { 154 }; 155 156 #define uprobe_get_trap_addr(regs) instruction_pointer(regs) 157 158 static inline int 159 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 160 { 161 return -ENOSYS; 162 } 163 static inline int 164 uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add) 165 { 166 return -ENOSYS; 167 } 168 static inline void 169 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 170 { 171 } 172 static inline int uprobe_mmap(struct vm_area_struct *vma) 173 { 174 return 0; 175 } 176 static inline void 177 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end) 178 { 179 } 180 static inline void uprobe_start_dup_mmap(void) 181 { 182 } 183 static inline void uprobe_end_dup_mmap(void) 184 { 185 } 186 static inline void 187 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) 188 { 189 } 190 static inline void uprobe_notify_resume(struct pt_regs *regs) 191 { 192 } 193 static inline bool uprobe_deny_signal(void) 194 { 195 return false; 196 } 197 static inline void uprobe_free_utask(struct task_struct *t) 198 { 199 } 200 static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags) 201 { 202 } 203 static inline void uprobe_clear_state(struct mm_struct *mm) 204 { 205 } 206 #endif /* !CONFIG_UPROBES */ 207 #endif /* _LINUX_UPROBES_H */ 208