blob: 80e8c7b697b9fdd014daae4775ae6991fde353c4 [file] [log] [blame]
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01002 * User-space Probes (UProbes)
Srikar Dronamraju2b144492012-02-09 14:56:42 +05303 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 *
Ingo Molnar35aa6212012-02-22 11:37:29 +010018 * Copyright (C) IBM Corporation, 2008-2012
Srikar Dronamraju2b144492012-02-09 14:56:42 +053019 * Authors:
20 * Srikar Dronamraju
21 * Jim Keniston
Ingo Molnar35aa6212012-02-22 11:37:29 +010022 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053023 */
24
25#include <linux/kernel.h>
26#include <linux/highmem.h>
27#include <linux/pagemap.h> /* read_mapping_page */
28#include <linux/slab.h>
29#include <linux/sched.h>
30#include <linux/rmap.h> /* anon_vma_prepare */
31#include <linux/mmu_notifier.h> /* set_pte_at_notify */
32#include <linux/swap.h> /* try_to_free_swap */
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053033#include <linux/ptrace.h> /* user_enable_single_step */
34#include <linux/kdebug.h> /* notifier mechanism */
Oleg Nesterov194f8dc2012-07-29 20:22:49 +020035#include "../../mm/internal.h" /* munlock_vma_page */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010036
Srikar Dronamraju2b144492012-02-09 14:56:42 +053037#include <linux/uprobes.h>
38
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053039#define UINSNS_PER_PAGE (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
40#define MAX_UPROBE_XOL_SLOTS UINSNS_PER_PAGE
41
Srikar Dronamraju2b144492012-02-09 14:56:42 +053042static struct rb_root uprobes_tree = RB_ROOT;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010043
Srikar Dronamraju2b144492012-02-09 14:56:42 +053044static DEFINE_SPINLOCK(uprobes_treelock); /* serialize rbtree access */
45
46#define UPROBES_HASH_SZ 13
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010047
Peter Zijlstrac5784de2012-06-15 17:43:39 +020048/*
49 * We need separate register/unregister and mmap/munmap lock hashes because
50 * of mmap_sem nesting.
51 *
52 * uprobe_register() needs to install probes on (potentially) all processes
53 * and thus needs to acquire multiple mmap_sems (consequtively, not
54 * concurrently), whereas uprobe_mmap() is called while holding mmap_sem
55 * for the particular process doing the mmap.
56 *
57 * uprobe_register()->register_for_each_vma() needs to drop/acquire mmap_sem
58 * because of lock order against i_mmap_mutex. This means there's a hole in
59 * the register vma iteration where a mmap() can happen.
60 *
61 * Thus uprobe_register() can race with uprobe_mmap() and we can try and
62 * install a probe where one is already installed.
63 */
64
Srikar Dronamraju2b144492012-02-09 14:56:42 +053065/* serialize (un)register */
66static struct mutex uprobes_mutex[UPROBES_HASH_SZ];
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010067
68#define uprobes_hash(v) (&uprobes_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
Srikar Dronamraju2b144492012-02-09 14:56:42 +053069
70/* serialize uprobe->pending_list */
71static struct mutex uprobes_mmap_mutex[UPROBES_HASH_SZ];
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010072#define uprobes_mmap_hash(v) (&uprobes_mmap_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
Srikar Dronamraju2b144492012-02-09 14:56:42 +053073
74/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010075 * uprobe_events allows us to skip the uprobe_mmap if there are no uprobe
Srikar Dronamraju2b144492012-02-09 14:56:42 +053076 * events active at this time. Probably a fine grained per inode count is
77 * better?
78 */
79static atomic_t uprobe_events = ATOMIC_INIT(0);
80
Srikar Dronamraju3ff54ef2012-02-22 14:46:02 +053081struct uprobe {
82 struct rb_node rb_node; /* node in the rb tree */
83 atomic_t ref;
84 struct rw_semaphore consumer_rwsem;
85 struct list_head pending_list;
86 struct uprobe_consumer *consumers;
87 struct inode *inode; /* Also hold a ref to inode */
88 loff_t offset;
89 int flags;
90 struct arch_uprobe arch;
91};
92
Srikar Dronamraju2b144492012-02-09 14:56:42 +053093/*
94 * valid_vma: Verify if the specified vma is an executable vma
95 * Relax restrictions while unregistering: vm_flags might have
96 * changed after breakpoint was inserted.
97 * - is_register: indicates if we are in register context.
98 * - Return 1 if the specified virtual address is in an
99 * executable vma.
100 */
101static bool valid_vma(struct vm_area_struct *vma, bool is_register)
102{
103 if (!vma->vm_file)
104 return false;
105
106 if (!is_register)
107 return true;
108
Oleg Nesterovea131372012-06-15 17:43:22 +0200109 if ((vma->vm_flags & (VM_HUGETLB|VM_READ|VM_WRITE|VM_EXEC|VM_SHARED))
110 == (VM_READ|VM_EXEC))
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530111 return true;
112
113 return false;
114}
115
Oleg Nesterov57683f72012-07-29 20:22:47 +0200116static unsigned long offset_to_vaddr(struct vm_area_struct *vma, loff_t offset)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530117{
Oleg Nesterov57683f72012-07-29 20:22:47 +0200118 return vma->vm_start + offset - ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530119}
120
Oleg Nesterovcb113b42012-07-29 20:22:42 +0200121static loff_t vaddr_to_offset(struct vm_area_struct *vma, unsigned long vaddr)
122{
123 return ((loff_t)vma->vm_pgoff << PAGE_SHIFT) + (vaddr - vma->vm_start);
124}
125
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530126/**
127 * __replace_page - replace page in vma by new page.
128 * based on replace_page in mm/ksm.c
129 *
130 * @vma: vma that holds the pte pointing to page
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200131 * @addr: address the old @page is mapped at
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530132 * @page: the cowed page we are replacing by kpage
133 * @kpage: the modified page we replace page by
134 *
135 * Returns 0 on success, -EFAULT on failure.
136 */
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200137static int __replace_page(struct vm_area_struct *vma, unsigned long addr,
138 struct page *page, struct page *kpage)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530139{
140 struct mm_struct *mm = vma->vm_mm;
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200141 spinlock_t *ptl;
142 pte_t *ptep;
Oleg Nesterov9f924482012-07-29 20:22:20 +0200143 int err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530144
Oleg Nesterov194f8dc2012-07-29 20:22:49 +0200145 /* For try_to_free_swap() and munlock_vma_page() below */
Oleg Nesterov9f924482012-07-29 20:22:20 +0200146 lock_page(page);
147
148 err = -EAGAIN;
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200149 ptep = page_check_address(page, mm, addr, &ptl, 0);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530150 if (!ptep)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200151 goto unlock;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530152
153 get_page(kpage);
154 page_add_new_anon_rmap(kpage, vma, addr);
155
Srikar Dronamraju7396fa82012-04-11 16:05:16 +0530156 if (!PageAnon(page)) {
157 dec_mm_counter(mm, MM_FILEPAGES);
158 inc_mm_counter(mm, MM_ANONPAGES);
159 }
160
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530161 flush_cache_page(vma, addr, pte_pfn(*ptep));
162 ptep_clear_flush(vma, addr, ptep);
163 set_pte_at_notify(mm, addr, ptep, mk_pte(kpage, vma->vm_page_prot));
164
165 page_remove_rmap(page);
166 if (!page_mapped(page))
167 try_to_free_swap(page);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530168 pte_unmap_unlock(ptep, ptl);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530169
Oleg Nesterov194f8dc2012-07-29 20:22:49 +0200170 if (vma->vm_flags & VM_LOCKED)
171 munlock_vma_page(page);
172 put_page(page);
173
Oleg Nesterov9f924482012-07-29 20:22:20 +0200174 err = 0;
175 unlock:
176 unlock_page(page);
177 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530178}
179
180/**
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530181 * is_swbp_insn - check if instruction is breakpoint instruction.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530182 * @insn: instruction to be checked.
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530183 * Default implementation of is_swbp_insn
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530184 * Returns true if @insn is a breakpoint instruction.
185 */
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530186bool __weak is_swbp_insn(uprobe_opcode_t *insn)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530187{
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530188 return *insn == UPROBE_SWBP_INSN;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530189}
190
191/*
192 * NOTE:
193 * Expect the breakpoint instruction to be the smallest size instruction for
194 * the architecture. If an arch has variable length instruction and the
195 * breakpoint instruction is not of the smallest length instruction
196 * supported by that architecture then we need to modify read_opcode /
197 * write_opcode accordingly. This would never be a problem for archs that
198 * have fixed length instructions.
199 */
200
201/*
202 * write_opcode - write the opcode at a given virtual address.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530203 * @auprobe: arch breakpointing information.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530204 * @mm: the probed process address space.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530205 * @vaddr: the virtual address to store the opcode.
206 * @opcode: opcode to be written at @vaddr.
207 *
208 * Called with mm->mmap_sem held (for read and with a reference to
209 * mm).
210 *
211 * For mm @mm, write the opcode at @vaddr.
212 * Return 0 (success) or a negative errno.
213 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530214static int write_opcode(struct arch_uprobe *auprobe, struct mm_struct *mm,
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530215 unsigned long vaddr, uprobe_opcode_t opcode)
216{
217 struct page *old_page, *new_page;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530218 void *vaddr_old, *vaddr_new;
219 struct vm_area_struct *vma;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530220 int ret;
Oleg Nesterovf4030722012-07-29 20:22:12 +0200221
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200222retry:
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530223 /* Read the page with vaddr into memory */
Oleg Nesterov75ed82e2012-09-16 17:20:06 +0200224 ret = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &old_page, &vma);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530225 if (ret <= 0)
226 return ret;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100227
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530228 ret = -ENOMEM;
229 new_page = alloc_page_vma(GFP_HIGHUSER_MOVABLE, vma, vaddr);
230 if (!new_page)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200231 goto put_old;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530232
233 __SetPageUptodate(new_page);
234
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530235 /* copy the page now that we've got it stable */
236 vaddr_old = kmap_atomic(old_page);
237 vaddr_new = kmap_atomic(new_page);
238
239 memcpy(vaddr_new, vaddr_old, PAGE_SIZE);
Oleg Nesterovd9c4a302012-06-15 17:43:50 +0200240 memcpy(vaddr_new + (vaddr & ~PAGE_MASK), &opcode, UPROBE_SWBP_INSN_SIZE);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530241
242 kunmap_atomic(vaddr_new);
243 kunmap_atomic(vaddr_old);
244
245 ret = anon_vma_prepare(vma);
246 if (ret)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200247 goto put_new;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530248
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200249 ret = __replace_page(vma, vaddr, old_page, new_page);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530250
Oleg Nesterov9f924482012-07-29 20:22:20 +0200251put_new:
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530252 page_cache_release(new_page);
Oleg Nesterov9f924482012-07-29 20:22:20 +0200253put_old:
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100254 put_page(old_page);
255
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200256 if (unlikely(ret == -EAGAIN))
257 goto retry;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530258 return ret;
259}
260
261/**
262 * read_opcode - read the opcode at a given virtual address.
263 * @mm: the probed process address space.
264 * @vaddr: the virtual address to read the opcode.
265 * @opcode: location to store the read opcode.
266 *
267 * Called with mm->mmap_sem held (for read and with a reference to
268 * mm.
269 *
270 * For mm @mm, read the opcode at @vaddr and store it in @opcode.
271 * Return 0 (success) or a negative errno.
272 */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100273static int read_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t *opcode)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530274{
275 struct page *page;
276 void *vaddr_new;
277 int ret;
278
Oleg Nesterova3d7bb42012-05-29 21:27:59 +0200279 ret = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &page, NULL);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530280 if (ret <= 0)
281 return ret;
282
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530283 vaddr_new = kmap_atomic(page);
284 vaddr &= ~PAGE_MASK;
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530285 memcpy(opcode, vaddr_new + vaddr, UPROBE_SWBP_INSN_SIZE);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530286 kunmap_atomic(vaddr_new);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100287
288 put_page(page);
289
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530290 return 0;
291}
292
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530293static int is_swbp_at_addr(struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530294{
295 uprobe_opcode_t opcode;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100296 int result;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530297
Oleg Nesterovc00b2752012-05-29 21:27:44 +0200298 if (current->mm == mm) {
299 pagefault_disable();
300 result = __copy_from_user_inatomic(&opcode, (void __user*)vaddr,
301 sizeof(opcode));
302 pagefault_enable();
303
304 if (likely(result == 0))
305 goto out;
306 }
307
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100308 result = read_opcode(mm, vaddr, &opcode);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530309 if (result)
310 return result;
Oleg Nesterovc00b2752012-05-29 21:27:44 +0200311out:
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530312 if (is_swbp_insn(&opcode))
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530313 return 1;
314
315 return 0;
316}
317
318/**
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530319 * set_swbp - store breakpoint at a given address.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530320 * @auprobe: arch specific probepoint information.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530321 * @mm: the probed process address space.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530322 * @vaddr: the virtual address to insert the opcode.
323 *
324 * For mm @mm, store the breakpoint instruction at @vaddr.
325 * Return 0 (success) or a negative errno.
326 */
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530327int __weak set_swbp(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530328{
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100329 int result;
Peter Zijlstrac5784de2012-06-15 17:43:39 +0200330 /*
331 * See the comment near uprobes_hash().
332 */
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530333 result = is_swbp_at_addr(mm, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530334 if (result == 1)
Oleg Nesterov78f74112012-08-08 17:35:08 +0200335 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530336
337 if (result)
338 return result;
339
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530340 return write_opcode(auprobe, mm, vaddr, UPROBE_SWBP_INSN);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530341}
342
343/**
344 * set_orig_insn - Restore the original instruction.
345 * @mm: the probed process address space.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530346 * @auprobe: arch specific probepoint information.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530347 * @vaddr: the virtual address to insert the opcode.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530348 *
349 * For mm @mm, restore the original opcode (opcode) at @vaddr.
350 * Return 0 (success) or a negative errno.
351 */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100352int __weak
Oleg Nesterovded86e72012-08-08 18:07:03 +0200353set_orig_insn(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530354{
Oleg Nesterovded86e72012-08-08 18:07:03 +0200355 int result;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530356
Oleg Nesterovded86e72012-08-08 18:07:03 +0200357 result = is_swbp_at_addr(mm, vaddr);
358 if (!result)
359 return -EINVAL;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530360
Oleg Nesterovded86e72012-08-08 18:07:03 +0200361 if (result != 1)
362 return result;
363
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530364 return write_opcode(auprobe, mm, vaddr, *(uprobe_opcode_t *)auprobe->insn);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530365}
366
367static int match_uprobe(struct uprobe *l, struct uprobe *r)
368{
369 if (l->inode < r->inode)
370 return -1;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100371
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530372 if (l->inode > r->inode)
373 return 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530374
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100375 if (l->offset < r->offset)
376 return -1;
377
378 if (l->offset > r->offset)
379 return 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530380
381 return 0;
382}
383
384static struct uprobe *__find_uprobe(struct inode *inode, loff_t offset)
385{
386 struct uprobe u = { .inode = inode, .offset = offset };
387 struct rb_node *n = uprobes_tree.rb_node;
388 struct uprobe *uprobe;
389 int match;
390
391 while (n) {
392 uprobe = rb_entry(n, struct uprobe, rb_node);
393 match = match_uprobe(&u, uprobe);
394 if (!match) {
395 atomic_inc(&uprobe->ref);
396 return uprobe;
397 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100398
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530399 if (match < 0)
400 n = n->rb_left;
401 else
402 n = n->rb_right;
403 }
404 return NULL;
405}
406
407/*
408 * Find a uprobe corresponding to a given inode:offset
409 * Acquires uprobes_treelock
410 */
411static struct uprobe *find_uprobe(struct inode *inode, loff_t offset)
412{
413 struct uprobe *uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530414
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200415 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530416 uprobe = __find_uprobe(inode, offset);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200417 spin_unlock(&uprobes_treelock);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100418
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530419 return uprobe;
420}
421
422static struct uprobe *__insert_uprobe(struct uprobe *uprobe)
423{
424 struct rb_node **p = &uprobes_tree.rb_node;
425 struct rb_node *parent = NULL;
426 struct uprobe *u;
427 int match;
428
429 while (*p) {
430 parent = *p;
431 u = rb_entry(parent, struct uprobe, rb_node);
432 match = match_uprobe(uprobe, u);
433 if (!match) {
434 atomic_inc(&u->ref);
435 return u;
436 }
437
438 if (match < 0)
439 p = &parent->rb_left;
440 else
441 p = &parent->rb_right;
442
443 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100444
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530445 u = NULL;
446 rb_link_node(&uprobe->rb_node, parent, p);
447 rb_insert_color(&uprobe->rb_node, &uprobes_tree);
448 /* get access + creation ref */
449 atomic_set(&uprobe->ref, 2);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100450
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530451 return u;
452}
453
454/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100455 * Acquire uprobes_treelock.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530456 * Matching uprobe already exists in rbtree;
457 * increment (access refcount) and return the matching uprobe.
458 *
459 * No matching uprobe; insert the uprobe in rb_tree;
460 * get a double refcount (access + creation) and return NULL.
461 */
462static struct uprobe *insert_uprobe(struct uprobe *uprobe)
463{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530464 struct uprobe *u;
465
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200466 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530467 u = __insert_uprobe(uprobe);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200468 spin_unlock(&uprobes_treelock);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100469
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530470 /* For now assume that the instruction need not be single-stepped */
471 uprobe->flags |= UPROBE_SKIP_SSTEP;
472
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530473 return u;
474}
475
476static void put_uprobe(struct uprobe *uprobe)
477{
478 if (atomic_dec_and_test(&uprobe->ref))
479 kfree(uprobe);
480}
481
482static struct uprobe *alloc_uprobe(struct inode *inode, loff_t offset)
483{
484 struct uprobe *uprobe, *cur_uprobe;
485
486 uprobe = kzalloc(sizeof(struct uprobe), GFP_KERNEL);
487 if (!uprobe)
488 return NULL;
489
490 uprobe->inode = igrab(inode);
491 uprobe->offset = offset;
492 init_rwsem(&uprobe->consumer_rwsem);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530493
494 /* add to uprobes_tree, sorted on inode:offset */
495 cur_uprobe = insert_uprobe(uprobe);
496
497 /* a uprobe exists for this inode:offset combination */
498 if (cur_uprobe) {
499 kfree(uprobe);
500 uprobe = cur_uprobe;
501 iput(inode);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100502 } else {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530503 atomic_inc(&uprobe_events);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100504 }
505
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530506 return uprobe;
507}
508
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530509static void handler_chain(struct uprobe *uprobe, struct pt_regs *regs)
510{
511 struct uprobe_consumer *uc;
512
513 if (!(uprobe->flags & UPROBE_RUN_HANDLER))
514 return;
515
516 down_read(&uprobe->consumer_rwsem);
517 for (uc = uprobe->consumers; uc; uc = uc->next) {
518 if (!uc->filter || uc->filter(uc, current))
519 uc->handler(uc, regs);
520 }
521 up_read(&uprobe->consumer_rwsem);
522}
523
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530524/* Returns the previous consumer */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100525static struct uprobe_consumer *
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530526consumer_add(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530527{
528 down_write(&uprobe->consumer_rwsem);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530529 uc->next = uprobe->consumers;
530 uprobe->consumers = uc;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530531 up_write(&uprobe->consumer_rwsem);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100532
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530533 return uc->next;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530534}
535
536/*
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530537 * For uprobe @uprobe, delete the consumer @uc.
538 * Return true if the @uc is deleted successfully
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530539 * or return false.
540 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530541static bool consumer_del(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530542{
543 struct uprobe_consumer **con;
544 bool ret = false;
545
546 down_write(&uprobe->consumer_rwsem);
547 for (con = &uprobe->consumers; *con; con = &(*con)->next) {
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530548 if (*con == uc) {
549 *con = uc->next;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530550 ret = true;
551 break;
552 }
553 }
554 up_write(&uprobe->consumer_rwsem);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100555
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530556 return ret;
557}
558
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530559static int
Oleg Nesterovd4366152012-06-15 17:43:42 +0200560__copy_insn(struct address_space *mapping, struct file *filp, char *insn,
Oleg Nesterov593609a2012-06-15 17:43:59 +0200561 unsigned long nbytes, loff_t offset)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530562{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530563 struct page *page;
564 void *vaddr;
Oleg Nesterov593609a2012-06-15 17:43:59 +0200565 unsigned long off;
566 pgoff_t idx;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530567
568 if (!filp)
569 return -EINVAL;
570
Oleg Nesterovcc359d12012-06-15 17:43:25 +0200571 if (!mapping->a_ops->readpage)
572 return -EIO;
573
Oleg Nesterov593609a2012-06-15 17:43:59 +0200574 idx = offset >> PAGE_CACHE_SHIFT;
575 off = offset & ~PAGE_MASK;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530576
577 /*
578 * Ensure that the page that has the original instruction is
579 * populated and in page-cache.
580 */
581 page = read_mapping_page(mapping, idx, filp);
582 if (IS_ERR(page))
583 return PTR_ERR(page);
584
585 vaddr = kmap_atomic(page);
Oleg Nesterov593609a2012-06-15 17:43:59 +0200586 memcpy(insn, vaddr + off, nbytes);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530587 kunmap_atomic(vaddr);
588 page_cache_release(page);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100589
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530590 return 0;
591}
592
Oleg Nesterovd4366152012-06-15 17:43:42 +0200593static int copy_insn(struct uprobe *uprobe, struct file *filp)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530594{
595 struct address_space *mapping;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530596 unsigned long nbytes;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100597 int bytes;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530598
Oleg Nesterovd4366152012-06-15 17:43:42 +0200599 nbytes = PAGE_SIZE - (uprobe->offset & ~PAGE_MASK);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530600 mapping = uprobe->inode->i_mapping;
601
602 /* Instruction at end of binary; copy only available bytes */
603 if (uprobe->offset + MAX_UINSN_BYTES > uprobe->inode->i_size)
604 bytes = uprobe->inode->i_size - uprobe->offset;
605 else
606 bytes = MAX_UINSN_BYTES;
607
608 /* Instruction at the page-boundary; copy bytes in second page */
609 if (nbytes < bytes) {
Oleg Nesterovfc36f592012-06-15 17:43:44 +0200610 int err = __copy_insn(mapping, filp, uprobe->arch.insn + nbytes,
611 bytes - nbytes, uprobe->offset + nbytes);
612 if (err)
613 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530614 bytes = nbytes;
615 }
Oleg Nesterovd4366152012-06-15 17:43:42 +0200616 return __copy_insn(mapping, filp, uprobe->arch.insn, bytes, uprobe->offset);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530617}
618
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530619/*
620 * How mm->uprobes_state.count gets updated
621 * uprobe_mmap() increments the count if
622 * - it successfully adds a breakpoint.
623 * - it cannot add a breakpoint, but sees that there is a underlying
624 * breakpoint (via a is_swbp_at_addr()).
625 *
626 * uprobe_munmap() decrements the count if
627 * - it sees a underlying breakpoint, (via is_swbp_at_addr)
628 * (Subsequent uprobe_unregister wouldnt find the breakpoint
629 * unless a uprobe_mmap kicks in, since the old vma would be
630 * dropped just after uprobe_munmap.)
631 *
632 * uprobe_register increments the count if:
633 * - it successfully adds a breakpoint.
634 *
635 * uprobe_unregister decrements the count if:
636 * - it sees a underlying breakpoint and removes successfully.
637 * (via is_swbp_at_addr)
638 * (Subsequent uprobe_munmap wouldnt find the breakpoint
639 * since there is no underlying breakpoint after the
640 * breakpoint removal.)
641 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530642static int
643install_breakpoint(struct uprobe *uprobe, struct mm_struct *mm,
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200644 struct vm_area_struct *vma, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530645{
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200646 bool first_uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530647 int ret;
648
649 /*
650 * If probe is being deleted, unregister thread could be done with
651 * the vma-rmap-walk through. Adding a probe now can be fatal since
652 * nobody will be able to cleanup. Also we could be from fork or
653 * mremap path, where the probe might have already been inserted.
654 * Hence behave as if probe already existed.
655 */
656 if (!uprobe->consumers)
Oleg Nesterov78f74112012-08-08 17:35:08 +0200657 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530658
Srikar Dronamraju900771a2012-03-12 14:55:14 +0530659 if (!(uprobe->flags & UPROBE_COPY_INSN)) {
Oleg Nesterovd4366152012-06-15 17:43:42 +0200660 ret = copy_insn(uprobe, vma->vm_file);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530661 if (ret)
662 return ret;
663
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530664 if (is_swbp_insn((uprobe_opcode_t *)uprobe->arch.insn))
Oleg Nesterovc1914a02012-06-15 17:43:31 +0200665 return -ENOTSUPP;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530666
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200667 ret = arch_uprobe_analyze_insn(&uprobe->arch, mm, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530668 if (ret)
669 return ret;
670
Oleg Nesterovd9c4a302012-06-15 17:43:50 +0200671 /* write_opcode() assumes we don't cross page boundary */
672 BUG_ON((uprobe->offset & ~PAGE_MASK) +
673 UPROBE_SWBP_INSN_SIZE > PAGE_SIZE);
674
Srikar Dronamraju900771a2012-03-12 14:55:14 +0530675 uprobe->flags |= UPROBE_COPY_INSN;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530676 }
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530677
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200678 /*
679 * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
680 * the task can hit this breakpoint right after __replace_page().
681 */
682 first_uprobe = !test_bit(MMF_HAS_UPROBES, &mm->flags);
683 if (first_uprobe)
684 set_bit(MMF_HAS_UPROBES, &mm->flags);
685
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200686 ret = set_swbp(&uprobe->arch, mm, vaddr);
Oleg Nesterov9f68f672012-08-19 16:15:09 +0200687 if (!ret)
688 clear_bit(MMF_RECALC_UPROBES, &mm->flags);
689 else if (first_uprobe)
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200690 clear_bit(MMF_HAS_UPROBES, &mm->flags);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530691
692 return ret;
693}
694
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530695static void
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200696remove_breakpoint(struct uprobe *uprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530697{
Oleg Nesterov9f68f672012-08-19 16:15:09 +0200698 /* can happen if uprobe_register() fails */
699 if (!test_bit(MMF_HAS_UPROBES, &mm->flags))
700 return;
701
702 set_bit(MMF_RECALC_UPROBES, &mm->flags);
Oleg Nesterovded86e72012-08-08 18:07:03 +0200703 set_orig_insn(&uprobe->arch, mm, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530704}
705
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530706/*
Oleg Nesterov778b0322012-05-29 21:30:08 +0200707 * There could be threads that have already hit the breakpoint. They
708 * will recheck the current insn and restart if find_uprobe() fails.
709 * See find_active_uprobe().
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530710 */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530711static void delete_uprobe(struct uprobe *uprobe)
712{
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200713 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530714 rb_erase(&uprobe->rb_node, &uprobes_tree);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200715 spin_unlock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530716 iput(uprobe->inode);
717 put_uprobe(uprobe);
718 atomic_dec(&uprobe_events);
719}
720
Oleg Nesterov26872092012-06-15 17:43:33 +0200721struct map_info {
722 struct map_info *next;
723 struct mm_struct *mm;
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200724 unsigned long vaddr;
Oleg Nesterov26872092012-06-15 17:43:33 +0200725};
726
727static inline struct map_info *free_map_info(struct map_info *info)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530728{
Oleg Nesterov26872092012-06-15 17:43:33 +0200729 struct map_info *next = info->next;
730 kfree(info);
731 return next;
732}
733
734static struct map_info *
735build_map_info(struct address_space *mapping, loff_t offset, bool is_register)
736{
737 unsigned long pgoff = offset >> PAGE_SHIFT;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530738 struct prio_tree_iter iter;
739 struct vm_area_struct *vma;
Oleg Nesterov26872092012-06-15 17:43:33 +0200740 struct map_info *curr = NULL;
741 struct map_info *prev = NULL;
742 struct map_info *info;
743 int more = 0;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100744
Oleg Nesterov26872092012-06-15 17:43:33 +0200745 again:
746 mutex_lock(&mapping->i_mmap_mutex);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530747 vma_prio_tree_foreach(vma, &iter, &mapping->i_mmap, pgoff, pgoff) {
748 if (!valid_vma(vma, is_register))
749 continue;
750
Oleg Nesterov7a5bfb62012-06-15 17:43:36 +0200751 if (!prev && !more) {
752 /*
753 * Needs GFP_NOWAIT to avoid i_mmap_mutex recursion through
754 * reclaim. This is optimistic, no harm done if it fails.
755 */
756 prev = kmalloc(sizeof(struct map_info),
757 GFP_NOWAIT | __GFP_NOMEMALLOC | __GFP_NOWARN);
758 if (prev)
759 prev->next = NULL;
760 }
Oleg Nesterov26872092012-06-15 17:43:33 +0200761 if (!prev) {
762 more++;
763 continue;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530764 }
765
Oleg Nesterov26872092012-06-15 17:43:33 +0200766 if (!atomic_inc_not_zero(&vma->vm_mm->mm_users))
767 continue;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100768
Oleg Nesterov26872092012-06-15 17:43:33 +0200769 info = prev;
770 prev = prev->next;
771 info->next = curr;
772 curr = info;
773
774 info->mm = vma->vm_mm;
Oleg Nesterov57683f72012-07-29 20:22:47 +0200775 info->vaddr = offset_to_vaddr(vma, offset);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530776 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530777 mutex_unlock(&mapping->i_mmap_mutex);
778
Oleg Nesterov26872092012-06-15 17:43:33 +0200779 if (!more)
780 goto out;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100781
Oleg Nesterov26872092012-06-15 17:43:33 +0200782 prev = curr;
783 while (curr) {
784 mmput(curr->mm);
785 curr = curr->next;
786 }
787
788 do {
789 info = kmalloc(sizeof(struct map_info), GFP_KERNEL);
790 if (!info) {
791 curr = ERR_PTR(-ENOMEM);
792 goto out;
793 }
794 info->next = prev;
795 prev = info;
796 } while (--more);
797
798 goto again;
799 out:
800 while (prev)
801 prev = free_map_info(prev);
802 return curr;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530803}
804
805static int register_for_each_vma(struct uprobe *uprobe, bool is_register)
806{
Oleg Nesterov26872092012-06-15 17:43:33 +0200807 struct map_info *info;
808 int err = 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530809
Oleg Nesterov26872092012-06-15 17:43:33 +0200810 info = build_map_info(uprobe->inode->i_mapping,
811 uprobe->offset, is_register);
812 if (IS_ERR(info))
813 return PTR_ERR(info);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100814
Oleg Nesterov26872092012-06-15 17:43:33 +0200815 while (info) {
816 struct mm_struct *mm = info->mm;
817 struct vm_area_struct *vma;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100818
Oleg Nesterov26872092012-06-15 17:43:33 +0200819 if (err)
820 goto free;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100821
Oleg Nesterov77fc4af2012-05-29 21:29:28 +0200822 down_write(&mm->mmap_sem);
Oleg Nesterovf4d6dfe2012-07-29 20:22:44 +0200823 vma = find_vma(mm, info->vaddr);
824 if (!vma || !valid_vma(vma, is_register) ||
825 vma->vm_file->f_mapping->host != uprobe->inode)
Oleg Nesterov26872092012-06-15 17:43:33 +0200826 goto unlock;
827
Oleg Nesterovf4d6dfe2012-07-29 20:22:44 +0200828 if (vma->vm_start > info->vaddr ||
829 vaddr_to_offset(vma, info->vaddr) != uprobe->offset)
Oleg Nesterov26872092012-06-15 17:43:33 +0200830 goto unlock;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530831
Oleg Nesterov78f74112012-08-08 17:35:08 +0200832 if (is_register)
Oleg Nesterov26872092012-06-15 17:43:33 +0200833 err = install_breakpoint(uprobe, mm, vma, info->vaddr);
Oleg Nesterov78f74112012-08-08 17:35:08 +0200834 else
Oleg Nesterov26872092012-06-15 17:43:33 +0200835 remove_breakpoint(uprobe, mm, info->vaddr);
Oleg Nesterov78f74112012-08-08 17:35:08 +0200836
Oleg Nesterov26872092012-06-15 17:43:33 +0200837 unlock:
838 up_write(&mm->mmap_sem);
839 free:
840 mmput(mm);
841 info = free_map_info(info);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530842 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100843
Oleg Nesterov26872092012-06-15 17:43:33 +0200844 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530845}
846
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100847static int __uprobe_register(struct uprobe *uprobe)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530848{
849 return register_for_each_vma(uprobe, true);
850}
851
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100852static void __uprobe_unregister(struct uprobe *uprobe)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530853{
854 if (!register_for_each_vma(uprobe, false))
855 delete_uprobe(uprobe);
856
857 /* TODO : cant unregister? schedule a worker thread */
858}
859
860/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100861 * uprobe_register - register a probe
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530862 * @inode: the file in which the probe has to be placed.
863 * @offset: offset from the start of the file.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530864 * @uc: information on howto handle the probe..
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530865 *
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100866 * Apart from the access refcount, uprobe_register() takes a creation
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530867 * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
868 * inserted into the rbtree (i.e first consumer for a @inode:@offset
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100869 * tuple). Creation refcount stops uprobe_unregister from freeing the
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530870 * @uprobe even before the register operation is complete. Creation
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530871 * refcount is released when the last @uc for the @uprobe
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530872 * unregisters.
873 *
874 * Return errno if it cannot successully install probes
875 * else return 0 (success)
876 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530877int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530878{
879 struct uprobe *uprobe;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100880 int ret;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530881
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530882 if (!inode || !uc || uc->next)
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100883 return -EINVAL;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530884
885 if (offset > i_size_read(inode))
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100886 return -EINVAL;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530887
888 ret = 0;
889 mutex_lock(uprobes_hash(inode));
890 uprobe = alloc_uprobe(inode, offset);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100891
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530892 if (uprobe && !consumer_add(uprobe, uc)) {
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100893 ret = __uprobe_register(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530894 if (ret) {
895 uprobe->consumers = NULL;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100896 __uprobe_unregister(uprobe);
897 } else {
Srikar Dronamraju900771a2012-03-12 14:55:14 +0530898 uprobe->flags |= UPROBE_RUN_HANDLER;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100899 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530900 }
901
902 mutex_unlock(uprobes_hash(inode));
Sebastian Andrzej Siewior6d1d8df2012-08-30 19:26:22 +0200903 if (uprobe)
904 put_uprobe(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530905
906 return ret;
907}
908
909/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100910 * uprobe_unregister - unregister a already registered probe.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530911 * @inode: the file in which the probe has to be removed.
912 * @offset: offset from the start of the file.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530913 * @uc: identify which probe if multiple probes are colocated.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530914 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530915void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530916{
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100917 struct uprobe *uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530918
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530919 if (!inode || !uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530920 return;
921
922 uprobe = find_uprobe(inode, offset);
923 if (!uprobe)
924 return;
925
926 mutex_lock(uprobes_hash(inode));
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530927
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530928 if (consumer_del(uprobe, uc)) {
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100929 if (!uprobe->consumers) {
930 __uprobe_unregister(uprobe);
Srikar Dronamraju900771a2012-03-12 14:55:14 +0530931 uprobe->flags &= ~UPROBE_RUN_HANDLER;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100932 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530933 }
934
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530935 mutex_unlock(uprobes_hash(inode));
936 if (uprobe)
937 put_uprobe(uprobe);
938}
939
Oleg Nesterov891c3972012-07-29 20:22:40 +0200940static struct rb_node *
941find_node_in_range(struct inode *inode, loff_t min, loff_t max)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530942{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530943 struct rb_node *n = uprobes_tree.rb_node;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530944
945 while (n) {
Oleg Nesterov891c3972012-07-29 20:22:40 +0200946 struct uprobe *u = rb_entry(n, struct uprobe, rb_node);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100947
Oleg Nesterov891c3972012-07-29 20:22:40 +0200948 if (inode < u->inode) {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530949 n = n->rb_left;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200950 } else if (inode > u->inode) {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530951 n = n->rb_right;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200952 } else {
953 if (max < u->offset)
954 n = n->rb_left;
955 else if (min > u->offset)
956 n = n->rb_right;
957 else
958 break;
959 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530960 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100961
Oleg Nesterov891c3972012-07-29 20:22:40 +0200962 return n;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530963}
964
965/*
Oleg Nesterov891c3972012-07-29 20:22:40 +0200966 * For a given range in vma, build a list of probes that need to be inserted.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530967 */
Oleg Nesterov891c3972012-07-29 20:22:40 +0200968static void build_probe_list(struct inode *inode,
969 struct vm_area_struct *vma,
970 unsigned long start, unsigned long end,
971 struct list_head *head)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530972{
Oleg Nesterov891c3972012-07-29 20:22:40 +0200973 loff_t min, max;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200974 struct rb_node *n, *t;
975 struct uprobe *u;
976
977 INIT_LIST_HEAD(head);
Oleg Nesterovcb113b42012-07-29 20:22:42 +0200978 min = vaddr_to_offset(vma, start);
Oleg Nesterov891c3972012-07-29 20:22:40 +0200979 max = min + (end - start) - 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530980
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200981 spin_lock(&uprobes_treelock);
Oleg Nesterov891c3972012-07-29 20:22:40 +0200982 n = find_node_in_range(inode, min, max);
983 if (n) {
984 for (t = n; t; t = rb_prev(t)) {
985 u = rb_entry(t, struct uprobe, rb_node);
986 if (u->inode != inode || u->offset < min)
987 break;
988 list_add(&u->pending_list, head);
989 atomic_inc(&u->ref);
990 }
991 for (t = n; (t = rb_next(t)); ) {
992 u = rb_entry(t, struct uprobe, rb_node);
993 if (u->inode != inode || u->offset > max)
994 break;
995 list_add(&u->pending_list, head);
996 atomic_inc(&u->ref);
997 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530998 }
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200999 spin_unlock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301000}
1001
1002/*
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001003 * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301004 *
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001005 * Currently we ignore all errors and always return 0, the callers
1006 * can't handle the failure anyway.
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301007 */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01001008int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301009{
1010 struct list_head tmp_list;
Oleg Nesterov665605a2012-07-29 20:22:29 +02001011 struct uprobe *uprobe, *u;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301012 struct inode *inode;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301013
1014 if (!atomic_read(&uprobe_events) || !valid_vma(vma, true))
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01001015 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301016
1017 inode = vma->vm_file->f_mapping->host;
1018 if (!inode)
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01001019 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301020
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301021 mutex_lock(uprobes_mmap_hash(inode));
Oleg Nesterov891c3972012-07-29 20:22:40 +02001022 build_probe_list(inode, vma, vma->vm_start, vma->vm_end, &tmp_list);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01001023
Oleg Nesterov665605a2012-07-29 20:22:29 +02001024 list_for_each_entry_safe(uprobe, u, &tmp_list, pending_list) {
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001025 if (!fatal_signal_pending(current)) {
Oleg Nesterov57683f72012-07-29 20:22:47 +02001026 unsigned long vaddr = offset_to_vaddr(vma, uprobe->offset);
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001027 install_breakpoint(uprobe, vma->vm_mm, vma, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301028 }
1029 put_uprobe(uprobe);
1030 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301031 mutex_unlock(uprobes_mmap_hash(inode));
1032
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001033 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301034}
1035
Oleg Nesterov9f68f672012-08-19 16:15:09 +02001036static bool
1037vma_has_uprobes(struct vm_area_struct *vma, unsigned long start, unsigned long end)
1038{
1039 loff_t min, max;
1040 struct inode *inode;
1041 struct rb_node *n;
1042
1043 inode = vma->vm_file->f_mapping->host;
1044
1045 min = vaddr_to_offset(vma, start);
1046 max = min + (end - start) - 1;
1047
1048 spin_lock(&uprobes_treelock);
1049 n = find_node_in_range(inode, min, max);
1050 spin_unlock(&uprobes_treelock);
1051
1052 return !!n;
1053}
1054
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301055/*
1056 * Called in context of a munmap of a vma.
1057 */
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +05301058void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301059{
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301060 if (!atomic_read(&uprobe_events) || !valid_vma(vma, false))
1061 return;
1062
Oleg Nesterov2fd611a2012-07-29 20:22:31 +02001063 if (!atomic_read(&vma->vm_mm->mm_users)) /* called by mmput() ? */
1064 return;
1065
Oleg Nesterov9f68f672012-08-19 16:15:09 +02001066 if (!test_bit(MMF_HAS_UPROBES, &vma->vm_mm->flags) ||
1067 test_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags))
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001068 return;
1069
Oleg Nesterov9f68f672012-08-19 16:15:09 +02001070 if (vma_has_uprobes(vma, start, end))
1071 set_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags);
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301072}
1073
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301074/* Slot allocation for XOL */
1075static int xol_add_vma(struct xol_area *area)
1076{
1077 struct mm_struct *mm;
1078 int ret;
1079
1080 area->page = alloc_page(GFP_HIGHUSER);
1081 if (!area->page)
1082 return -ENOMEM;
1083
1084 ret = -EALREADY;
1085 mm = current->mm;
1086
1087 down_write(&mm->mmap_sem);
1088 if (mm->uprobes_state.xol_area)
1089 goto fail;
1090
1091 ret = -ENOMEM;
1092
1093 /* Try to map as high as possible, this is only a hint. */
1094 area->vaddr = get_unmapped_area(NULL, TASK_SIZE - PAGE_SIZE, PAGE_SIZE, 0, 0);
1095 if (area->vaddr & ~PAGE_MASK) {
1096 ret = area->vaddr;
1097 goto fail;
1098 }
1099
1100 ret = install_special_mapping(mm, area->vaddr, PAGE_SIZE,
1101 VM_EXEC|VM_MAYEXEC|VM_DONTCOPY|VM_IO, &area->page);
1102 if (ret)
1103 goto fail;
1104
1105 smp_wmb(); /* pairs with get_xol_area() */
1106 mm->uprobes_state.xol_area = area;
1107 ret = 0;
1108
1109fail:
1110 up_write(&mm->mmap_sem);
1111 if (ret)
1112 __free_page(area->page);
1113
1114 return ret;
1115}
1116
1117static struct xol_area *get_xol_area(struct mm_struct *mm)
1118{
1119 struct xol_area *area;
1120
1121 area = mm->uprobes_state.xol_area;
1122 smp_read_barrier_depends(); /* pairs with wmb in xol_add_vma() */
1123
1124 return area;
1125}
1126
1127/*
1128 * xol_alloc_area - Allocate process's xol_area.
1129 * This area will be used for storing instructions for execution out of
1130 * line.
1131 *
1132 * Returns the allocated area or NULL.
1133 */
1134static struct xol_area *xol_alloc_area(void)
1135{
1136 struct xol_area *area;
1137
1138 area = kzalloc(sizeof(*area), GFP_KERNEL);
1139 if (unlikely(!area))
1140 return NULL;
1141
1142 area->bitmap = kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE) * sizeof(long), GFP_KERNEL);
1143
1144 if (!area->bitmap)
1145 goto fail;
1146
1147 init_waitqueue_head(&area->wq);
1148 if (!xol_add_vma(area))
1149 return area;
1150
1151fail:
1152 kfree(area->bitmap);
1153 kfree(area);
1154
1155 return get_xol_area(current->mm);
1156}
1157
1158/*
1159 * uprobe_clear_state - Free the area allocated for slots.
1160 */
1161void uprobe_clear_state(struct mm_struct *mm)
1162{
1163 struct xol_area *area = mm->uprobes_state.xol_area;
1164
1165 if (!area)
1166 return;
1167
1168 put_page(area->page);
1169 kfree(area->bitmap);
1170 kfree(area);
1171}
1172
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001173void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
1174{
Oleg Nesterov61559a82012-08-08 17:17:46 +02001175 newmm->uprobes_state.xol_area = NULL;
1176
Oleg Nesterov9f68f672012-08-19 16:15:09 +02001177 if (test_bit(MMF_HAS_UPROBES, &oldmm->flags)) {
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001178 set_bit(MMF_HAS_UPROBES, &newmm->flags);
Oleg Nesterov9f68f672012-08-19 16:15:09 +02001179 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1180 set_bit(MMF_RECALC_UPROBES, &newmm->flags);
1181 }
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001182}
1183
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301184/*
1185 * - search for a free slot.
1186 */
1187static unsigned long xol_take_insn_slot(struct xol_area *area)
1188{
1189 unsigned long slot_addr;
1190 int slot_nr;
1191
1192 do {
1193 slot_nr = find_first_zero_bit(area->bitmap, UINSNS_PER_PAGE);
1194 if (slot_nr < UINSNS_PER_PAGE) {
1195 if (!test_and_set_bit(slot_nr, area->bitmap))
1196 break;
1197
1198 slot_nr = UINSNS_PER_PAGE;
1199 continue;
1200 }
1201 wait_event(area->wq, (atomic_read(&area->slot_count) < UINSNS_PER_PAGE));
1202 } while (slot_nr >= UINSNS_PER_PAGE);
1203
1204 slot_addr = area->vaddr + (slot_nr * UPROBE_XOL_SLOT_BYTES);
1205 atomic_inc(&area->slot_count);
1206
1207 return slot_addr;
1208}
1209
1210/*
1211 * xol_get_insn_slot - If was not allocated a slot, then
1212 * allocate a slot.
1213 * Returns the allocated slot address or 0.
1214 */
1215static unsigned long xol_get_insn_slot(struct uprobe *uprobe, unsigned long slot_addr)
1216{
1217 struct xol_area *area;
1218 unsigned long offset;
1219 void *vaddr;
1220
1221 area = get_xol_area(current->mm);
1222 if (!area) {
1223 area = xol_alloc_area();
1224 if (!area)
1225 return 0;
1226 }
1227 current->utask->xol_vaddr = xol_take_insn_slot(area);
1228
1229 /*
1230 * Initialize the slot if xol_vaddr points to valid
1231 * instruction slot.
1232 */
1233 if (unlikely(!current->utask->xol_vaddr))
1234 return 0;
1235
1236 current->utask->vaddr = slot_addr;
1237 offset = current->utask->xol_vaddr & ~PAGE_MASK;
1238 vaddr = kmap_atomic(area->page);
1239 memcpy(vaddr + offset, uprobe->arch.insn, MAX_UINSN_BYTES);
1240 kunmap_atomic(vaddr);
1241
1242 return current->utask->xol_vaddr;
1243}
1244
1245/*
1246 * xol_free_insn_slot - If slot was earlier allocated by
1247 * @xol_get_insn_slot(), make the slot available for
1248 * subsequent requests.
1249 */
1250static void xol_free_insn_slot(struct task_struct *tsk)
1251{
1252 struct xol_area *area;
1253 unsigned long vma_end;
1254 unsigned long slot_addr;
1255
1256 if (!tsk->mm || !tsk->mm->uprobes_state.xol_area || !tsk->utask)
1257 return;
1258
1259 slot_addr = tsk->utask->xol_vaddr;
1260
1261 if (unlikely(!slot_addr || IS_ERR_VALUE(slot_addr)))
1262 return;
1263
1264 area = tsk->mm->uprobes_state.xol_area;
1265 vma_end = area->vaddr + PAGE_SIZE;
1266 if (area->vaddr <= slot_addr && slot_addr < vma_end) {
1267 unsigned long offset;
1268 int slot_nr;
1269
1270 offset = slot_addr - area->vaddr;
1271 slot_nr = offset / UPROBE_XOL_SLOT_BYTES;
1272 if (slot_nr >= UINSNS_PER_PAGE)
1273 return;
1274
1275 clear_bit(slot_nr, area->bitmap);
1276 atomic_dec(&area->slot_count);
1277 if (waitqueue_active(&area->wq))
1278 wake_up(&area->wq);
1279
1280 tsk->utask->xol_vaddr = 0;
1281 }
1282}
1283
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301284/**
1285 * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1286 * @regs: Reflects the saved state of the task after it has hit a breakpoint
1287 * instruction.
1288 * Return the address of the breakpoint instruction.
1289 */
1290unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs)
1291{
1292 return instruction_pointer(regs) - UPROBE_SWBP_INSN_SIZE;
1293}
1294
1295/*
1296 * Called with no locks held.
1297 * Called in context of a exiting or a exec-ing thread.
1298 */
1299void uprobe_free_utask(struct task_struct *t)
1300{
1301 struct uprobe_task *utask = t->utask;
1302
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301303 if (!utask)
1304 return;
1305
1306 if (utask->active_uprobe)
1307 put_uprobe(utask->active_uprobe);
1308
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301309 xol_free_insn_slot(t);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301310 kfree(utask);
1311 t->utask = NULL;
1312}
1313
1314/*
1315 * Called in context of a new clone/fork from copy_process.
1316 */
1317void uprobe_copy_process(struct task_struct *t)
1318{
1319 t->utask = NULL;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301320}
1321
1322/*
1323 * Allocate a uprobe_task object for the task.
1324 * Called when the thread hits a breakpoint for the first time.
1325 *
1326 * Returns:
1327 * - pointer to new uprobe_task on success
1328 * - NULL otherwise
1329 */
1330static struct uprobe_task *add_utask(void)
1331{
1332 struct uprobe_task *utask;
1333
1334 utask = kzalloc(sizeof *utask, GFP_KERNEL);
1335 if (unlikely(!utask))
1336 return NULL;
1337
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301338 current->utask = utask;
1339 return utask;
1340}
1341
1342/* Prepare to single-step probed instruction out of line. */
1343static int
1344pre_ssout(struct uprobe *uprobe, struct pt_regs *regs, unsigned long vaddr)
1345{
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301346 if (xol_get_insn_slot(uprobe, vaddr) && !arch_uprobe_pre_xol(&uprobe->arch, regs))
1347 return 0;
1348
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301349 return -EFAULT;
1350}
1351
1352/*
1353 * If we are singlestepping, then ensure this thread is not connected to
1354 * non-fatal signals until completion of singlestep. When xol insn itself
1355 * triggers the signal, restart the original insn even if the task is
1356 * already SIGKILL'ed (since coredump should report the correct ip). This
1357 * is even more important if the task has a handler for SIGSEGV/etc, The
1358 * _same_ instruction should be repeated again after return from the signal
1359 * handler, and SSTEP can never finish in this case.
1360 */
1361bool uprobe_deny_signal(void)
1362{
1363 struct task_struct *t = current;
1364 struct uprobe_task *utask = t->utask;
1365
1366 if (likely(!utask || !utask->active_uprobe))
1367 return false;
1368
1369 WARN_ON_ONCE(utask->state != UTASK_SSTEP);
1370
1371 if (signal_pending(t)) {
1372 spin_lock_irq(&t->sighand->siglock);
1373 clear_tsk_thread_flag(t, TIF_SIGPENDING);
1374 spin_unlock_irq(&t->sighand->siglock);
1375
1376 if (__fatal_signal_pending(t) || arch_uprobe_xol_was_trapped(t)) {
1377 utask->state = UTASK_SSTEP_TRAPPED;
1378 set_tsk_thread_flag(t, TIF_UPROBE);
1379 set_tsk_thread_flag(t, TIF_NOTIFY_RESUME);
1380 }
1381 }
1382
1383 return true;
1384}
1385
1386/*
1387 * Avoid singlestepping the original instruction if the original instruction
1388 * is a NOP or can be emulated.
1389 */
1390static bool can_skip_sstep(struct uprobe *uprobe, struct pt_regs *regs)
1391{
Oleg Nesterov0578a972012-09-14 18:31:23 +02001392 if (uprobe->flags & UPROBE_SKIP_SSTEP) {
1393 if (arch_uprobe_skip_sstep(&uprobe->arch, regs))
1394 return true;
1395 uprobe->flags &= ~UPROBE_SKIP_SSTEP;
1396 }
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301397 return false;
1398}
1399
Oleg Nesterov499a4f32012-08-19 17:41:34 +02001400static void mmf_recalc_uprobes(struct mm_struct *mm)
1401{
1402 struct vm_area_struct *vma;
1403
1404 for (vma = mm->mmap; vma; vma = vma->vm_next) {
1405 if (!valid_vma(vma, false))
1406 continue;
1407 /*
1408 * This is not strictly accurate, we can race with
1409 * uprobe_unregister() and see the already removed
1410 * uprobe if delete_uprobe() was not yet called.
1411 */
1412 if (vma_has_uprobes(vma, vma->vm_start, vma->vm_end))
1413 return;
1414 }
1415
1416 clear_bit(MMF_HAS_UPROBES, &mm->flags);
1417}
1418
Oleg Nesterovd790d342012-05-29 21:29:14 +02001419static struct uprobe *find_active_uprobe(unsigned long bp_vaddr, int *is_swbp)
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001420{
1421 struct mm_struct *mm = current->mm;
1422 struct uprobe *uprobe = NULL;
1423 struct vm_area_struct *vma;
1424
1425 down_read(&mm->mmap_sem);
1426 vma = find_vma(mm, bp_vaddr);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001427 if (vma && vma->vm_start <= bp_vaddr) {
1428 if (valid_vma(vma, false)) {
Oleg Nesterovcb113b42012-07-29 20:22:42 +02001429 struct inode *inode = vma->vm_file->f_mapping->host;
1430 loff_t offset = vaddr_to_offset(vma, bp_vaddr);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001431
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001432 uprobe = find_uprobe(inode, offset);
1433 }
Oleg Nesterovd790d342012-05-29 21:29:14 +02001434
1435 if (!uprobe)
1436 *is_swbp = is_swbp_at_addr(mm, bp_vaddr);
1437 } else {
1438 *is_swbp = -EFAULT;
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001439 }
Oleg Nesterov499a4f32012-08-19 17:41:34 +02001440
1441 if (!uprobe && test_and_clear_bit(MMF_RECALC_UPROBES, &mm->flags))
1442 mmf_recalc_uprobes(mm);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001443 up_read(&mm->mmap_sem);
1444
1445 return uprobe;
1446}
1447
Sebastian Andrzej Siewior9d778782012-08-07 18:12:28 +02001448void __weak arch_uprobe_enable_step(struct arch_uprobe *arch)
1449{
1450 user_enable_single_step(current);
1451}
1452
1453void __weak arch_uprobe_disable_step(struct arch_uprobe *arch)
1454{
1455 user_disable_single_step(current);
1456}
1457
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301458/*
1459 * Run handler and ask thread to singlestep.
1460 * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1461 */
1462static void handle_swbp(struct pt_regs *regs)
1463{
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301464 struct uprobe_task *utask;
1465 struct uprobe *uprobe;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301466 unsigned long bp_vaddr;
Oleg Nesterov56bb4cf2012-05-29 21:29:47 +02001467 int uninitialized_var(is_swbp);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301468
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301469 bp_vaddr = uprobe_get_swbp_addr(regs);
Oleg Nesterovd790d342012-05-29 21:29:14 +02001470 uprobe = find_active_uprobe(bp_vaddr, &is_swbp);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301471
1472 if (!uprobe) {
Oleg Nesterov56bb4cf2012-05-29 21:29:47 +02001473 if (is_swbp > 0) {
1474 /* No matching uprobe; signal SIGTRAP. */
1475 send_sig(SIGTRAP, current, 0);
1476 } else {
1477 /*
1478 * Either we raced with uprobe_unregister() or we can't
1479 * access this memory. The latter is only possible if
1480 * another thread plays with our ->mm. In both cases
1481 * we can simply restart. If this vma was unmapped we
1482 * can pretend this insn was not executed yet and get
1483 * the (correct) SIGSEGV after restart.
1484 */
1485 instruction_pointer_set(regs, bp_vaddr);
1486 }
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301487 return;
1488 }
1489
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001490 utask = current->utask;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301491 if (!utask) {
1492 utask = add_utask();
1493 /* Cannot allocate; re-execute the instruction. */
1494 if (!utask)
Oleg Nesterov0578a972012-09-14 18:31:23 +02001495 goto restart;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301496 }
Oleg Nesterov746a9e62012-09-14 18:23:51 +02001497
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301498 handler_chain(uprobe, regs);
Oleg Nesterov0578a972012-09-14 18:31:23 +02001499 if (can_skip_sstep(uprobe, regs))
1500 goto out;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301501
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301502 if (!pre_ssout(uprobe, regs, bp_vaddr)) {
Sebastian Andrzej Siewior9d778782012-08-07 18:12:28 +02001503 arch_uprobe_enable_step(&uprobe->arch);
Oleg Nesterov746a9e62012-09-14 18:23:51 +02001504 utask->active_uprobe = uprobe;
1505 utask->state = UTASK_SSTEP;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301506 return;
1507 }
1508
Oleg Nesterov0578a972012-09-14 18:31:23 +02001509restart:
1510 /*
1511 * cannot singlestep; cannot skip instruction;
1512 * re-execute the instruction.
1513 */
1514 instruction_pointer_set(regs, bp_vaddr);
1515out:
Sebastian Andrzej Siewior8bd87442012-08-07 18:12:30 +02001516 put_uprobe(uprobe);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301517}
1518
1519/*
1520 * Perform required fix-ups and disable singlestep.
1521 * Allow pending signals to take effect.
1522 */
1523static void handle_singlestep(struct uprobe_task *utask, struct pt_regs *regs)
1524{
1525 struct uprobe *uprobe;
1526
1527 uprobe = utask->active_uprobe;
1528 if (utask->state == UTASK_SSTEP_ACK)
1529 arch_uprobe_post_xol(&uprobe->arch, regs);
1530 else if (utask->state == UTASK_SSTEP_TRAPPED)
1531 arch_uprobe_abort_xol(&uprobe->arch, regs);
1532 else
1533 WARN_ON_ONCE(1);
1534
Sebastian Andrzej Siewior9d778782012-08-07 18:12:28 +02001535 arch_uprobe_disable_step(&uprobe->arch);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301536 put_uprobe(uprobe);
1537 utask->active_uprobe = NULL;
1538 utask->state = UTASK_RUNNING;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301539 xol_free_insn_slot(current);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301540
1541 spin_lock_irq(&current->sighand->siglock);
1542 recalc_sigpending(); /* see uprobe_deny_signal() */
1543 spin_unlock_irq(&current->sighand->siglock);
1544}
1545
1546/*
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001547 * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1548 * allows the thread to return from interrupt. After that handle_swbp()
1549 * sets utask->active_uprobe.
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301550 *
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001551 * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1552 * and allows the thread to return from interrupt.
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301553 *
1554 * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1555 * uprobe_notify_resume().
1556 */
1557void uprobe_notify_resume(struct pt_regs *regs)
1558{
1559 struct uprobe_task *utask;
1560
Oleg Nesterovdb023ea2012-09-14 19:05:46 +02001561 clear_thread_flag(TIF_UPROBE);
1562
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301563 utask = current->utask;
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001564 if (utask && utask->active_uprobe)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301565 handle_singlestep(utask, regs);
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001566 else
1567 handle_swbp(regs);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301568}
1569
1570/*
1571 * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1572 * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1573 */
1574int uprobe_pre_sstep_notifier(struct pt_regs *regs)
1575{
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001576 if (!current->mm || !test_bit(MMF_HAS_UPROBES, &current->mm->flags))
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301577 return 0;
1578
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301579 set_thread_flag(TIF_UPROBE);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301580 return 1;
1581}
1582
1583/*
1584 * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
1585 * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
1586 */
1587int uprobe_post_sstep_notifier(struct pt_regs *regs)
1588{
1589 struct uprobe_task *utask = current->utask;
1590
1591 if (!current->mm || !utask || !utask->active_uprobe)
1592 /* task is currently not uprobed */
1593 return 0;
1594
1595 utask->state = UTASK_SSTEP_ACK;
1596 set_thread_flag(TIF_UPROBE);
1597 return 1;
1598}
1599
1600static struct notifier_block uprobe_exception_nb = {
1601 .notifier_call = arch_uprobe_exception_notify,
1602 .priority = INT_MAX-1, /* notified after kprobes, kgdb */
1603};
1604
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301605static int __init init_uprobes(void)
1606{
1607 int i;
1608
1609 for (i = 0; i < UPROBES_HASH_SZ; i++) {
1610 mutex_init(&uprobes_mutex[i]);
1611 mutex_init(&uprobes_mmap_mutex[i]);
1612 }
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301613
1614 return register_die_notifier(&uprobe_exception_nb);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301615}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301616module_init(init_uprobes);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301617
1618static void __exit exit_uprobes(void)
1619{
1620}
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301621module_exit(exit_uprobes);