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 30 struct vm_area_struct; 31 struct mm_struct; 32 struct inode; 33 34 #ifdef CONFIG_ARCH_SUPPORTS_UPROBES 35 # include <asm/uprobes.h> 36 #endif 37 38 #define UPROBE_HANDLER_REMOVE 1 39 #define UPROBE_HANDLER_MASK 1 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 bool (*filter)(struct uprobe_consumer *self, 50 enum uprobe_filter_ctx ctx, 51 struct mm_struct *mm); 52 53 struct uprobe_consumer *next; 54 }; 55 56 #ifdef CONFIG_UPROBES 57 enum uprobe_task_state { 58 UTASK_RUNNING, 59 UTASK_SSTEP, 60 UTASK_SSTEP_ACK, 61 UTASK_SSTEP_TRAPPED, 62 }; 63 64 /* 65 * uprobe_task: Metadata of a task while it singlesteps. 66 */ 67 struct uprobe_task { 68 enum uprobe_task_state state; 69 struct arch_uprobe_task autask; 70 71 struct uprobe *active_uprobe; 72 73 unsigned long xol_vaddr; 74 unsigned long vaddr; 75 }; 76 77 /* 78 * On a breakpoint hit, thread contests for a slot. It frees the 79 * slot after singlestep. Currently a fixed number of slots are 80 * allocated. 81 */ 82 struct xol_area { 83 wait_queue_head_t wq; /* if all slots are busy */ 84 atomic_t slot_count; /* number of in-use slots */ 85 unsigned long *bitmap; /* 0 = free slot */ 86 struct page *page; 87 88 /* 89 * We keep the vma's vm_start rather than a pointer to the vma 90 * itself. The probed process or a naughty kernel module could make 91 * the vma go away, and we must handle that reasonably gracefully. 92 */ 93 unsigned long vaddr; /* Page(s) of instruction slots */ 94 }; 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 int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); 104 extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool); 105 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); 106 extern int uprobe_mmap(struct vm_area_struct *vma); 107 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end); 108 extern void uprobe_start_dup_mmap(void); 109 extern void uprobe_end_dup_mmap(void); 110 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm); 111 extern void uprobe_free_utask(struct task_struct *t); 112 extern void uprobe_copy_process(struct task_struct *t); 113 extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs); 114 extern int uprobe_post_sstep_notifier(struct pt_regs *regs); 115 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs); 116 extern void uprobe_notify_resume(struct pt_regs *regs); 117 extern bool uprobe_deny_signal(void); 118 extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs); 119 extern void uprobe_clear_state(struct mm_struct *mm); 120 #else /* !CONFIG_UPROBES */ 121 struct uprobes_state { 122 }; 123 static inline int 124 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 125 { 126 return -ENOSYS; 127 } 128 static inline int 129 uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add) 130 { 131 return -ENOSYS; 132 } 133 static inline void 134 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) 135 { 136 } 137 static inline int uprobe_mmap(struct vm_area_struct *vma) 138 { 139 return 0; 140 } 141 static inline void 142 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end) 143 { 144 } 145 static inline void uprobe_start_dup_mmap(void) 146 { 147 } 148 static inline void uprobe_end_dup_mmap(void) 149 { 150 } 151 static inline void 152 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) 153 { 154 } 155 static inline void uprobe_notify_resume(struct pt_regs *regs) 156 { 157 } 158 static inline bool uprobe_deny_signal(void) 159 { 160 return false; 161 } 162 static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs) 163 { 164 return 0; 165 } 166 static inline void uprobe_free_utask(struct task_struct *t) 167 { 168 } 169 static inline void uprobe_copy_process(struct task_struct *t) 170 { 171 } 172 static inline void uprobe_clear_state(struct mm_struct *mm) 173 { 174 } 175 #endif /* !CONFIG_UPROBES */ 176 #endif /* _LINUX_UPROBES_H */ 177