Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 1 | #ifndef _LINUX_UPROBES_H |
| 2 | #define _LINUX_UPROBES_H |
| 3 | /* |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 4 | * User-space Probes (UProbes) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 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 | * |
Ingo Molnar | 35aa621 | 2012-02-22 11:37:29 +0100 | [diff] [blame] | 20 | * Copyright (C) IBM Corporation, 2008-2012 |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 21 | * Authors: |
| 22 | * Srikar Dronamraju |
| 23 | * Jim Keniston |
Ingo Molnar | 35aa621 | 2012-02-22 11:37:29 +0100 | [diff] [blame] | 24 | * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com> |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 25 | */ |
| 26 | |
| 27 | #include <linux/errno.h> |
| 28 | #include <linux/rbtree.h> |
Oleg Nesterov | 3247343 | 2013-11-08 18:52:21 +0100 | [diff] [blame] | 29 | #include <linux/types.h> |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 30 | |
| 31 | struct vm_area_struct; |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 32 | struct mm_struct; |
| 33 | struct inode; |
David A. Long | 3820b4d | 2013-10-15 17:04:16 -0400 | [diff] [blame] | 34 | struct notifier_block; |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 35 | |
Oleg Nesterov | da1816b | 2012-12-29 17:49:11 +0100 | [diff] [blame] | 36 | #define UPROBE_HANDLER_REMOVE 1 |
| 37 | #define UPROBE_HANDLER_MASK 1 |
| 38 | |
Anton Arapov | ded49c5 | 2013-04-03 18:00:37 +0200 | [diff] [blame] | 39 | #define MAX_URETPROBE_DEPTH 64 |
| 40 | |
Oleg Nesterov | 8a7f2fa | 2012-12-28 17:58:38 +0100 | [diff] [blame] | 41 | enum uprobe_filter_ctx { |
| 42 | UPROBE_FILTER_REGISTER, |
| 43 | UPROBE_FILTER_UNREGISTER, |
| 44 | UPROBE_FILTER_MMAP, |
| 45 | }; |
| 46 | |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 47 | struct uprobe_consumer { |
| 48 | int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs); |
Anton Arapov | ea02487 | 2013-04-03 18:00:31 +0200 | [diff] [blame] | 49 | int (*ret_handler)(struct uprobe_consumer *self, |
| 50 | unsigned long func, |
| 51 | struct pt_regs *regs); |
Oleg Nesterov | 8a7f2fa | 2012-12-28 17:58:38 +0100 | [diff] [blame] | 52 | bool (*filter)(struct uprobe_consumer *self, |
| 53 | enum uprobe_filter_ctx ctx, |
| 54 | struct mm_struct *mm); |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 55 | |
| 56 | struct uprobe_consumer *next; |
| 57 | }; |
| 58 | |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 59 | #ifdef CONFIG_UPROBES |
Oleg Nesterov | c912dae | 2013-11-09 19:49:39 +0100 | [diff] [blame^] | 60 | #include <asm/uprobes.h> |
| 61 | |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 62 | enum uprobe_task_state { |
| 63 | UTASK_RUNNING, |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 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; |
Oleg Nesterov | 3247343 | 2013-11-08 18:52:21 +0100 | [diff] [blame] | 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; |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 89 | |
Anton Arapov | 0dfd0eb | 2013-04-03 18:00:35 +0200 | [diff] [blame] | 90 | struct return_instance *return_instances; |
Anton Arapov | ded49c5 | 2013-04-03 18:00:37 +0200 | [diff] [blame] | 91 | unsigned int depth; |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 92 | }; |
| 93 | |
Oleg Nesterov | c912dae | 2013-11-09 19:49:39 +0100 | [diff] [blame^] | 94 | struct xol_area; |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 95 | |
| 96 | struct uprobes_state { |
| 97 | struct xol_area *xol_area; |
| 98 | }; |
Oleg Nesterov | 647c42d | 2012-08-06 13:15:09 +0200 | [diff] [blame] | 99 | |
Srikar Dronamraju | 5cb4ac3 | 2012-03-12 14:55:45 +0530 | [diff] [blame] | 100 | extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); |
Oleg Nesterov | ded86e7 | 2012-08-08 18:07:03 +0200 | [diff] [blame] | 101 | extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr); |
Srikar Dronamraju | 5cb4ac3 | 2012-03-12 14:55:45 +0530 | [diff] [blame] | 102 | extern bool __weak is_swbp_insn(uprobe_opcode_t *insn); |
Ananth N Mavinakayanahalli | 0908ad6 | 2013-03-22 20:46:27 +0530 | [diff] [blame] | 103 | extern bool __weak is_trap_insn(uprobe_opcode_t *insn); |
Oleg Nesterov | c912dae | 2013-11-09 19:49:39 +0100 | [diff] [blame^] | 104 | extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs); |
Oleg Nesterov | f72d41f | 2013-11-05 19:50:39 +0100 | [diff] [blame] | 105 | extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t); |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 106 | extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); |
Oleg Nesterov | bdf8647 | 2013-02-03 19:21:12 +0100 | [diff] [blame] | 107 | extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool); |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 108 | extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 109 | extern int uprobe_mmap(struct vm_area_struct *vma); |
Srikar Dronamraju | cbc91f7 | 2012-04-11 16:05:27 +0530 | [diff] [blame] | 110 | extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end); |
Oleg Nesterov | 32cdba1 | 2012-11-14 19:03:42 +0100 | [diff] [blame] | 111 | extern void uprobe_start_dup_mmap(void); |
| 112 | extern void uprobe_end_dup_mmap(void); |
Oleg Nesterov | f8ac4ec | 2012-08-08 17:11:42 +0200 | [diff] [blame] | 113 | extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm); |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 114 | extern void uprobe_free_utask(struct task_struct *t); |
Oleg Nesterov | 3ab6796 | 2013-10-16 19:39:37 +0200 | [diff] [blame] | 115 | extern void uprobe_copy_process(struct task_struct *t, unsigned long flags); |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 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); |
Ralf Baechle | c2d3f25 | 2013-10-09 14:08:09 +0200 | [diff] [blame] | 120 | extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs); |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 121 | extern void uprobe_clear_state(struct mm_struct *mm); |
David A. Long | 3820b4d | 2013-10-15 17:04:16 -0400 | [diff] [blame] | 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); |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 129 | #else /* !CONFIG_UPROBES */ |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 130 | struct uprobes_state { |
| 131 | }; |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 132 | static inline int |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 133 | uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 134 | { |
| 135 | return -ENOSYS; |
| 136 | } |
Oleg Nesterov | bdf8647 | 2013-02-03 19:21:12 +0100 | [diff] [blame] | 137 | static inline int |
| 138 | uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add) |
| 139 | { |
| 140 | return -ENOSYS; |
| 141 | } |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 142 | static inline void |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 143 | uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 144 | { |
| 145 | } |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 146 | static inline int uprobe_mmap(struct vm_area_struct *vma) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 147 | { |
| 148 | return 0; |
| 149 | } |
Srikar Dronamraju | cbc91f7 | 2012-04-11 16:05:27 +0530 | [diff] [blame] | 150 | static inline void |
| 151 | uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end) |
Srikar Dronamraju | 682968e | 2012-03-30 23:56:46 +0530 | [diff] [blame] | 152 | { |
| 153 | } |
Oleg Nesterov | 32cdba1 | 2012-11-14 19:03:42 +0100 | [diff] [blame] | 154 | static inline void uprobe_start_dup_mmap(void) |
| 155 | { |
| 156 | } |
| 157 | static inline void uprobe_end_dup_mmap(void) |
| 158 | { |
| 159 | } |
Oleg Nesterov | f8ac4ec | 2012-08-08 17:11:42 +0200 | [diff] [blame] | 160 | static inline void |
| 161 | uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) |
| 162 | { |
| 163 | } |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 164 | static inline void uprobe_notify_resume(struct pt_regs *regs) |
| 165 | { |
| 166 | } |
| 167 | static inline bool uprobe_deny_signal(void) |
| 168 | { |
| 169 | return false; |
| 170 | } |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 171 | static inline void uprobe_free_utask(struct task_struct *t) |
| 172 | { |
| 173 | } |
Oleg Nesterov | 3ab6796 | 2013-10-16 19:39:37 +0200 | [diff] [blame] | 174 | static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags) |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 175 | { |
| 176 | } |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 177 | static inline void uprobe_clear_state(struct mm_struct *mm) |
| 178 | { |
| 179 | } |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 180 | #endif /* !CONFIG_UPROBES */ |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 181 | #endif /* _LINUX_UPROBES_H */ |