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 <[email protected]> 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 36 #define UPROBE_HANDLER_REMOVE 1 37 #define UPROBE_HANDLER_MASK 1 38 39 #define MAX_URETPROBE_DEPTH 64 40 41 enum uprobe_filter_ctx { 42 UPROBE_FILTER_REGISTER, 43 UPROBE_FILTER_UNREGISTER, 44 UPROBE_FILTER_MMAP, 45 }; 46 47 struct uprobe_consumer { 48 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs); 49 int (*ret_handler)(struct uprobe_consumer *self, 50 unsigned long func, 51 struct pt_regs *regs); 52 bool (*filter)(struct uprobe_consumer *self, 53 enum uprobe_filter_ctx ctx, 54 struct mm_struct *mm); 55 56 struct uprobe_consumer *next; 57 }; 58 59 #ifdef CONFIG_UPROBES 60 #include <asm/uprobes.h> 61 62 enum uprobe_task_state { 63 UTASK_RUNNING, 64 UTASK_SSTEP, 65 UTASK_SSTEP_ACK, 66 UTASK_SSTEP_TRAPPED, 67 }; 68 69 /* 70 * uprobe_task: Metadata of a task while it singlesteps. 71 */ 72 struct uprobe_task { 73 enum uprobe_task_state state; 74 75 union { 76 struct { 77 struct arch_uprobe_task autask; 78 unsigned long vaddr; 79 }; 80 81 struct { 82 struct callback_head dup_xol_work; 83 unsigned long dup_xol_addr; 84 }; 85 }; 86 87 struct uprobe *active_uprobe; 88 unsigned long xol_vaddr; 89 90 struct return_instance *return_instances; 91 unsigned int depth; 92 }; 93 94 struct xol_area; 95 96 struct uprobes_state { 97 struct xol_area *xol_area; 98 }; 99 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 extern bool __weak arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs); 130 #else /* !CONFIG_UPROBES */ 131 struct uprobes_state { 132 }; 133 static inline int 134 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 135 { 136 return -ENOSYS; 137 } 138 static inline int 139 uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add) 140 { 141 return -ENOSYS; 142 } 143 static inline void 144 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 145 { 146 } 147 static inline int uprobe_mmap(struct vm_area_struct *vma) 148 { 149 return 0; 150 } 151 static inline void 152 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end) 153 { 154 } 155 static inline void uprobe_start_dup_mmap(void) 156 { 157 } 158 static inline void uprobe_end_dup_mmap(void) 159 { 160 } 161 static inline void 162 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) 163 { 164 } 165 static inline void uprobe_notify_resume(struct pt_regs *regs) 166 { 167 } 168 static inline bool uprobe_deny_signal(void) 169 { 170 return false; 171 } 172 static inline void uprobe_free_utask(struct task_struct *t) 173 { 174 } 175 static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags) 176 { 177 } 178 static inline void uprobe_clear_state(struct mm_struct *mm) 179 { 180 } 181 #endif /* !CONFIG_UPROBES */ 182 #endif /* _LINUX_UPROBES_H */ 183