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> |
| 29 | |
| 30 | struct vm_area_struct; |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 31 | struct mm_struct; |
| 32 | struct inode; |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 33 | |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 34 | #ifdef CONFIG_ARCH_SUPPORTS_UPROBES |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 35 | # include <asm/uprobes.h> |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 36 | #endif |
| 37 | |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 38 | struct uprobe_consumer { |
| 39 | int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs); |
| 40 | /* |
| 41 | * filter is optional; If a filter exists, handler is run |
| 42 | * if and only if filter returns true. |
| 43 | */ |
| 44 | bool (*filter)(struct uprobe_consumer *self, struct task_struct *task); |
| 45 | |
| 46 | struct uprobe_consumer *next; |
| 47 | }; |
| 48 | |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 49 | #ifdef CONFIG_UPROBES |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 50 | enum uprobe_task_state { |
| 51 | UTASK_RUNNING, |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 52 | UTASK_SSTEP, |
| 53 | UTASK_SSTEP_ACK, |
| 54 | UTASK_SSTEP_TRAPPED, |
| 55 | }; |
| 56 | |
| 57 | /* |
| 58 | * uprobe_task: Metadata of a task while it singlesteps. |
| 59 | */ |
| 60 | struct uprobe_task { |
| 61 | enum uprobe_task_state state; |
| 62 | struct arch_uprobe_task autask; |
| 63 | |
| 64 | struct uprobe *active_uprobe; |
| 65 | |
| 66 | unsigned long xol_vaddr; |
| 67 | unsigned long vaddr; |
| 68 | }; |
| 69 | |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 70 | /* |
| 71 | * On a breakpoint hit, thread contests for a slot. It frees the |
| 72 | * slot after singlestep. Currently a fixed number of slots are |
| 73 | * allocated. |
| 74 | */ |
| 75 | struct xol_area { |
| 76 | wait_queue_head_t wq; /* if all slots are busy */ |
| 77 | atomic_t slot_count; /* number of in-use slots */ |
| 78 | unsigned long *bitmap; /* 0 = free slot */ |
| 79 | struct page *page; |
| 80 | |
| 81 | /* |
| 82 | * We keep the vma's vm_start rather than a pointer to the vma |
| 83 | * itself. The probed process or a naughty kernel module could make |
| 84 | * the vma go away, and we must handle that reasonably gracefully. |
| 85 | */ |
| 86 | unsigned long vaddr; /* Page(s) of instruction slots */ |
| 87 | }; |
| 88 | |
| 89 | struct uprobes_state { |
| 90 | struct xol_area *xol_area; |
| 91 | }; |
Oleg Nesterov | 647c42d | 2012-08-06 13:15:09 +0200 | [diff] [blame] | 92 | |
Srikar Dronamraju | 5cb4ac3 | 2012-03-12 14:55:45 +0530 | [diff] [blame] | 93 | 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] | 94 | 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] | 95 | extern bool __weak is_swbp_insn(uprobe_opcode_t *insn); |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 96 | extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc); |
| 97 | 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] | 98 | extern int uprobe_mmap(struct vm_area_struct *vma); |
Srikar Dronamraju | cbc91f7 | 2012-04-11 16:05:27 +0530 | [diff] [blame] | 99 | 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] | 100 | extern void uprobe_start_dup_mmap(void); |
| 101 | extern void uprobe_end_dup_mmap(void); |
Oleg Nesterov | f8ac4ec | 2012-08-08 17:11:42 +0200 | [diff] [blame] | 102 | 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] | 103 | extern void uprobe_free_utask(struct task_struct *t); |
| 104 | extern void uprobe_copy_process(struct task_struct *t); |
| 105 | extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs); |
| 106 | extern int uprobe_post_sstep_notifier(struct pt_regs *regs); |
| 107 | extern int uprobe_pre_sstep_notifier(struct pt_regs *regs); |
| 108 | extern void uprobe_notify_resume(struct pt_regs *regs); |
| 109 | extern bool uprobe_deny_signal(void); |
| 110 | extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs); |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 111 | extern void uprobe_clear_state(struct mm_struct *mm); |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 112 | #else /* !CONFIG_UPROBES */ |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 113 | struct uprobes_state { |
| 114 | }; |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 115 | static inline int |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 116 | uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 117 | { |
| 118 | return -ENOSYS; |
| 119 | } |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 120 | static inline void |
Srikar Dronamraju | e3343e6 | 2012-03-12 14:55:30 +0530 | [diff] [blame] | 121 | uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 122 | { |
| 123 | } |
Ingo Molnar | 7b2d81d | 2012-02-17 09:27:41 +0100 | [diff] [blame] | 124 | static inline int uprobe_mmap(struct vm_area_struct *vma) |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 125 | { |
| 126 | return 0; |
| 127 | } |
Srikar Dronamraju | cbc91f7 | 2012-04-11 16:05:27 +0530 | [diff] [blame] | 128 | static inline void |
| 129 | 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] | 130 | { |
| 131 | } |
Oleg Nesterov | 32cdba1 | 2012-11-14 19:03:42 +0100 | [diff] [blame] | 132 | static inline void uprobe_start_dup_mmap(void) |
| 133 | { |
| 134 | } |
| 135 | static inline void uprobe_end_dup_mmap(void) |
| 136 | { |
| 137 | } |
Oleg Nesterov | f8ac4ec | 2012-08-08 17:11:42 +0200 | [diff] [blame] | 138 | static inline void |
| 139 | uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm) |
| 140 | { |
| 141 | } |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 142 | static inline void uprobe_notify_resume(struct pt_regs *regs) |
| 143 | { |
| 144 | } |
| 145 | static inline bool uprobe_deny_signal(void) |
| 146 | { |
| 147 | return false; |
| 148 | } |
| 149 | static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs) |
| 150 | { |
| 151 | return 0; |
| 152 | } |
| 153 | static inline void uprobe_free_utask(struct task_struct *t) |
| 154 | { |
| 155 | } |
| 156 | static inline void uprobe_copy_process(struct task_struct *t) |
| 157 | { |
| 158 | } |
Srikar Dronamraju | d4b3b63 | 2012-03-30 23:56:31 +0530 | [diff] [blame] | 159 | static inline void uprobe_clear_state(struct mm_struct *mm) |
| 160 | { |
| 161 | } |
Srikar Dronamraju | 0326f5a | 2012-03-13 23:30:11 +0530 | [diff] [blame] | 162 | #endif /* !CONFIG_UPROBES */ |
Srikar Dronamraju | 2b14449 | 2012-02-09 14:56:42 +0530 | [diff] [blame] | 163 | #endif /* _LINUX_UPROBES_H */ |