blob: 221fc58f59e3635655b57a527e9a39aaa3455980 [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>
Josh Stonee8440c12013-01-13 19:03:34 +010030#include <linux/export.h>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053031#include <linux/rmap.h> /* anon_vma_prepare */
32#include <linux/mmu_notifier.h> /* set_pte_at_notify */
33#include <linux/swap.h> /* try_to_free_swap */
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053034#include <linux/ptrace.h> /* user_enable_single_step */
35#include <linux/kdebug.h> /* notifier mechanism */
Oleg Nesterov194f8dc2012-07-29 20:22:49 +020036#include "../../mm/internal.h" /* munlock_vma_page */
Oleg Nesterov32cdba12012-11-14 19:03:42 +010037#include <linux/percpu-rwsem.h>
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010038
Srikar Dronamraju2b144492012-02-09 14:56:42 +053039#include <linux/uprobes.h>
40
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053041#define UINSNS_PER_PAGE (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
42#define MAX_UPROBE_XOL_SLOTS UINSNS_PER_PAGE
43
Srikar Dronamraju2b144492012-02-09 14:56:42 +053044static struct rb_root uprobes_tree = RB_ROOT;
Oleg Nesterov441f1eb72012-11-25 19:54:29 +010045/*
46 * allows us to skip the uprobe_mmap if there are no uprobe events active
47 * at this time. Probably a fine grained per inode count is better?
48 */
49#define no_uprobe_events() RB_EMPTY_ROOT(&uprobes_tree)
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010050
Srikar Dronamraju2b144492012-02-09 14:56:42 +053051static DEFINE_SPINLOCK(uprobes_treelock); /* serialize rbtree access */
52
53#define UPROBES_HASH_SZ 13
Srikar Dronamraju2b144492012-02-09 14:56:42 +053054/* serialize uprobe->pending_list */
55static struct mutex uprobes_mmap_mutex[UPROBES_HASH_SZ];
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010056#define uprobes_mmap_hash(v) (&uprobes_mmap_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
Srikar Dronamraju2b144492012-02-09 14:56:42 +053057
Oleg Nesterov32cdba12012-11-14 19:03:42 +010058static struct percpu_rw_semaphore dup_mmap_sem;
59
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +020060/* Have a copy of original instruction */
Oleg Nesterov71434f22012-09-30 21:12:44 +020061#define UPROBE_COPY_INSN 0
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +020062/* Can skip singlestep */
Oleg Nesterovbb929282012-11-24 18:27:08 +010063#define UPROBE_SKIP_SSTEP 1
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +020064
Srikar Dronamraju3ff54ef2012-02-22 14:46:02 +053065struct uprobe {
66 struct rb_node rb_node; /* node in the rb tree */
67 atomic_t ref;
Oleg Nesterove591c8d2012-11-24 17:29:40 +010068 struct rw_semaphore register_rwsem;
Srikar Dronamraju3ff54ef2012-02-22 14:46:02 +053069 struct rw_semaphore consumer_rwsem;
70 struct list_head pending_list;
71 struct uprobe_consumer *consumers;
72 struct inode *inode; /* Also hold a ref to inode */
73 loff_t offset;
Oleg Nesterov71434f22012-09-30 21:12:44 +020074 unsigned long flags;
Srikar Dronamraju3ff54ef2012-02-22 14:46:02 +053075 struct arch_uprobe arch;
76};
77
Srikar Dronamraju2b144492012-02-09 14:56:42 +053078/*
79 * valid_vma: Verify if the specified vma is an executable vma
80 * Relax restrictions while unregistering: vm_flags might have
81 * changed after breakpoint was inserted.
82 * - is_register: indicates if we are in register context.
83 * - Return 1 if the specified virtual address is in an
84 * executable vma.
85 */
86static bool valid_vma(struct vm_area_struct *vma, bool is_register)
87{
Oleg Nesterove40cfce2012-09-16 19:31:39 +020088 vm_flags_t flags = VM_HUGETLB | VM_MAYEXEC | VM_SHARED;
Srikar Dronamraju2b144492012-02-09 14:56:42 +053089
Oleg Nesterove40cfce2012-09-16 19:31:39 +020090 if (is_register)
91 flags |= VM_WRITE;
Srikar Dronamraju2b144492012-02-09 14:56:42 +053092
Oleg Nesterove40cfce2012-09-16 19:31:39 +020093 return vma->vm_file && (vma->vm_flags & flags) == VM_MAYEXEC;
Srikar Dronamraju2b144492012-02-09 14:56:42 +053094}
95
Oleg Nesterov57683f72012-07-29 20:22:47 +020096static unsigned long offset_to_vaddr(struct vm_area_struct *vma, loff_t offset)
Srikar Dronamraju2b144492012-02-09 14:56:42 +053097{
Oleg Nesterov57683f72012-07-29 20:22:47 +020098 return vma->vm_start + offset - ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
Srikar Dronamraju2b144492012-02-09 14:56:42 +053099}
100
Oleg Nesterovcb113b42012-07-29 20:22:42 +0200101static loff_t vaddr_to_offset(struct vm_area_struct *vma, unsigned long vaddr)
102{
103 return ((loff_t)vma->vm_pgoff << PAGE_SHIFT) + (vaddr - vma->vm_start);
104}
105
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530106/**
107 * __replace_page - replace page in vma by new page.
108 * based on replace_page in mm/ksm.c
109 *
110 * @vma: vma that holds the pte pointing to page
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200111 * @addr: address the old @page is mapped at
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530112 * @page: the cowed page we are replacing by kpage
113 * @kpage: the modified page we replace page by
114 *
115 * Returns 0 on success, -EFAULT on failure.
116 */
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200117static int __replace_page(struct vm_area_struct *vma, unsigned long addr,
118 struct page *page, struct page *kpage)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530119{
120 struct mm_struct *mm = vma->vm_mm;
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200121 spinlock_t *ptl;
122 pte_t *ptep;
Oleg Nesterov9f924482012-07-29 20:22:20 +0200123 int err;
Haggai Eran6bdb9132012-10-08 16:33:35 -0700124 /* For mmu_notifiers */
125 const unsigned long mmun_start = addr;
126 const unsigned long mmun_end = addr + PAGE_SIZE;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530127
Oleg Nesterov194f8dc2012-07-29 20:22:49 +0200128 /* For try_to_free_swap() and munlock_vma_page() below */
Oleg Nesterov9f924482012-07-29 20:22:20 +0200129 lock_page(page);
130
Haggai Eran6bdb9132012-10-08 16:33:35 -0700131 mmu_notifier_invalidate_range_start(mm, mmun_start, mmun_end);
Oleg Nesterov9f924482012-07-29 20:22:20 +0200132 err = -EAGAIN;
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200133 ptep = page_check_address(page, mm, addr, &ptl, 0);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530134 if (!ptep)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200135 goto unlock;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530136
137 get_page(kpage);
138 page_add_new_anon_rmap(kpage, vma, addr);
139
Srikar Dronamraju7396fa82012-04-11 16:05:16 +0530140 if (!PageAnon(page)) {
141 dec_mm_counter(mm, MM_FILEPAGES);
142 inc_mm_counter(mm, MM_ANONPAGES);
143 }
144
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530145 flush_cache_page(vma, addr, pte_pfn(*ptep));
146 ptep_clear_flush(vma, addr, ptep);
147 set_pte_at_notify(mm, addr, ptep, mk_pte(kpage, vma->vm_page_prot));
148
149 page_remove_rmap(page);
150 if (!page_mapped(page))
151 try_to_free_swap(page);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530152 pte_unmap_unlock(ptep, ptl);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530153
Oleg Nesterov194f8dc2012-07-29 20:22:49 +0200154 if (vma->vm_flags & VM_LOCKED)
155 munlock_vma_page(page);
156 put_page(page);
157
Oleg Nesterov9f924482012-07-29 20:22:20 +0200158 err = 0;
159 unlock:
Haggai Eran6bdb9132012-10-08 16:33:35 -0700160 mmu_notifier_invalidate_range_end(mm, mmun_start, mmun_end);
Oleg Nesterov9f924482012-07-29 20:22:20 +0200161 unlock_page(page);
162 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530163}
164
165/**
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530166 * is_swbp_insn - check if instruction is breakpoint instruction.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530167 * @insn: instruction to be checked.
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530168 * Default implementation of is_swbp_insn
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530169 * Returns true if @insn is a breakpoint instruction.
170 */
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530171bool __weak is_swbp_insn(uprobe_opcode_t *insn)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530172{
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530173 return *insn == UPROBE_SWBP_INSN;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530174}
175
Oleg Nesterovcceb55a2012-09-23 21:10:18 +0200176static void copy_opcode(struct page *page, unsigned long vaddr, uprobe_opcode_t *opcode)
177{
178 void *kaddr = kmap_atomic(page);
179 memcpy(opcode, kaddr + (vaddr & ~PAGE_MASK), UPROBE_SWBP_INSN_SIZE);
180 kunmap_atomic(kaddr);
181}
182
Oleg Nesteroved6f6a52012-09-23 21:30:44 +0200183static int verify_opcode(struct page *page, unsigned long vaddr, uprobe_opcode_t *new_opcode)
184{
185 uprobe_opcode_t old_opcode;
186 bool is_swbp;
187
188 copy_opcode(page, vaddr, &old_opcode);
189 is_swbp = is_swbp_insn(&old_opcode);
190
191 if (is_swbp_insn(new_opcode)) {
192 if (is_swbp) /* register: already installed? */
193 return 0;
194 } else {
195 if (!is_swbp) /* unregister: was it changed by us? */
Oleg Nesterov076a3652012-09-30 18:54:53 +0200196 return 0;
Oleg Nesteroved6f6a52012-09-23 21:30:44 +0200197 }
198
199 return 1;
200}
201
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530202/*
203 * NOTE:
204 * Expect the breakpoint instruction to be the smallest size instruction for
205 * the architecture. If an arch has variable length instruction and the
206 * breakpoint instruction is not of the smallest length instruction
Oleg Nesterovcceb55a2012-09-23 21:10:18 +0200207 * supported by that architecture then we need to modify is_swbp_at_addr and
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530208 * write_opcode accordingly. This would never be a problem for archs that
209 * have fixed length instructions.
210 */
211
212/*
213 * write_opcode - write the opcode at a given virtual address.
214 * @mm: the probed process address space.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530215 * @vaddr: the virtual address to store the opcode.
216 * @opcode: opcode to be written at @vaddr.
217 *
218 * Called with mm->mmap_sem held (for read and with a reference to
219 * mm).
220 *
221 * For mm @mm, write the opcode at @vaddr.
222 * Return 0 (success) or a negative errno.
223 */
Oleg Nesterovcceb55a2012-09-23 21:10:18 +0200224static int write_opcode(struct mm_struct *mm, unsigned long vaddr,
225 uprobe_opcode_t opcode)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530226{
227 struct page *old_page, *new_page;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530228 void *vaddr_old, *vaddr_new;
229 struct vm_area_struct *vma;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530230 int ret;
Oleg Nesterovf4030722012-07-29 20:22:12 +0200231
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200232retry:
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530233 /* Read the page with vaddr into memory */
Oleg Nesterov75ed82e2012-09-16 17:20:06 +0200234 ret = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &old_page, &vma);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530235 if (ret <= 0)
236 return ret;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100237
Oleg Nesteroved6f6a52012-09-23 21:30:44 +0200238 ret = verify_opcode(old_page, vaddr, &opcode);
239 if (ret <= 0)
240 goto put_old;
241
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530242 ret = -ENOMEM;
243 new_page = alloc_page_vma(GFP_HIGHUSER_MOVABLE, vma, vaddr);
244 if (!new_page)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200245 goto put_old;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530246
247 __SetPageUptodate(new_page);
248
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530249 /* copy the page now that we've got it stable */
250 vaddr_old = kmap_atomic(old_page);
251 vaddr_new = kmap_atomic(new_page);
252
253 memcpy(vaddr_new, vaddr_old, PAGE_SIZE);
Oleg Nesterovd9c4a302012-06-15 17:43:50 +0200254 memcpy(vaddr_new + (vaddr & ~PAGE_MASK), &opcode, UPROBE_SWBP_INSN_SIZE);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530255
256 kunmap_atomic(vaddr_new);
257 kunmap_atomic(vaddr_old);
258
259 ret = anon_vma_prepare(vma);
260 if (ret)
Oleg Nesterov9f924482012-07-29 20:22:20 +0200261 goto put_new;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530262
Oleg Nesterovc517ee72012-07-29 20:22:16 +0200263 ret = __replace_page(vma, vaddr, old_page, new_page);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530264
Oleg Nesterov9f924482012-07-29 20:22:20 +0200265put_new:
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530266 page_cache_release(new_page);
Oleg Nesterov9f924482012-07-29 20:22:20 +0200267put_old:
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100268 put_page(old_page);
269
Oleg Nesterov5323ce72012-06-15 17:43:28 +0200270 if (unlikely(ret == -EAGAIN))
271 goto retry;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530272 return ret;
273}
274
275/**
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530276 * set_swbp - store breakpoint at a given address.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530277 * @auprobe: arch specific probepoint information.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530278 * @mm: the probed process address space.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530279 * @vaddr: the virtual address to insert the opcode.
280 *
281 * For mm @mm, store the breakpoint instruction at @vaddr.
282 * Return 0 (success) or a negative errno.
283 */
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530284int __weak set_swbp(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530285{
Oleg Nesterovcceb55a2012-09-23 21:10:18 +0200286 return write_opcode(mm, vaddr, UPROBE_SWBP_INSN);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530287}
288
289/**
290 * set_orig_insn - Restore the original instruction.
291 * @mm: the probed process address space.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530292 * @auprobe: arch specific probepoint information.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530293 * @vaddr: the virtual address to insert the opcode.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530294 *
295 * For mm @mm, restore the original opcode (opcode) at @vaddr.
296 * Return 0 (success) or a negative errno.
297 */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100298int __weak
Oleg Nesterovded86e72012-08-08 18:07:03 +0200299set_orig_insn(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530300{
Oleg Nesterovcceb55a2012-09-23 21:10:18 +0200301 return write_opcode(mm, vaddr, *(uprobe_opcode_t *)auprobe->insn);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530302}
303
304static int match_uprobe(struct uprobe *l, struct uprobe *r)
305{
306 if (l->inode < r->inode)
307 return -1;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100308
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530309 if (l->inode > r->inode)
310 return 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530311
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100312 if (l->offset < r->offset)
313 return -1;
314
315 if (l->offset > r->offset)
316 return 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530317
318 return 0;
319}
320
321static struct uprobe *__find_uprobe(struct inode *inode, loff_t offset)
322{
323 struct uprobe u = { .inode = inode, .offset = offset };
324 struct rb_node *n = uprobes_tree.rb_node;
325 struct uprobe *uprobe;
326 int match;
327
328 while (n) {
329 uprobe = rb_entry(n, struct uprobe, rb_node);
330 match = match_uprobe(&u, uprobe);
331 if (!match) {
332 atomic_inc(&uprobe->ref);
333 return uprobe;
334 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100335
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530336 if (match < 0)
337 n = n->rb_left;
338 else
339 n = n->rb_right;
340 }
341 return NULL;
342}
343
344/*
345 * Find a uprobe corresponding to a given inode:offset
346 * Acquires uprobes_treelock
347 */
348static struct uprobe *find_uprobe(struct inode *inode, loff_t offset)
349{
350 struct uprobe *uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530351
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200352 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530353 uprobe = __find_uprobe(inode, offset);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200354 spin_unlock(&uprobes_treelock);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100355
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530356 return uprobe;
357}
358
359static struct uprobe *__insert_uprobe(struct uprobe *uprobe)
360{
361 struct rb_node **p = &uprobes_tree.rb_node;
362 struct rb_node *parent = NULL;
363 struct uprobe *u;
364 int match;
365
366 while (*p) {
367 parent = *p;
368 u = rb_entry(parent, struct uprobe, rb_node);
369 match = match_uprobe(uprobe, u);
370 if (!match) {
371 atomic_inc(&u->ref);
372 return u;
373 }
374
375 if (match < 0)
376 p = &parent->rb_left;
377 else
378 p = &parent->rb_right;
379
380 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100381
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530382 u = NULL;
383 rb_link_node(&uprobe->rb_node, parent, p);
384 rb_insert_color(&uprobe->rb_node, &uprobes_tree);
385 /* get access + creation ref */
386 atomic_set(&uprobe->ref, 2);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100387
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530388 return u;
389}
390
391/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100392 * Acquire uprobes_treelock.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530393 * Matching uprobe already exists in rbtree;
394 * increment (access refcount) and return the matching uprobe.
395 *
396 * No matching uprobe; insert the uprobe in rb_tree;
397 * get a double refcount (access + creation) and return NULL.
398 */
399static struct uprobe *insert_uprobe(struct uprobe *uprobe)
400{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530401 struct uprobe *u;
402
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200403 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530404 u = __insert_uprobe(uprobe);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200405 spin_unlock(&uprobes_treelock);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100406
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530407 return u;
408}
409
410static void put_uprobe(struct uprobe *uprobe)
411{
412 if (atomic_dec_and_test(&uprobe->ref))
413 kfree(uprobe);
414}
415
416static struct uprobe *alloc_uprobe(struct inode *inode, loff_t offset)
417{
418 struct uprobe *uprobe, *cur_uprobe;
419
420 uprobe = kzalloc(sizeof(struct uprobe), GFP_KERNEL);
421 if (!uprobe)
422 return NULL;
423
424 uprobe->inode = igrab(inode);
425 uprobe->offset = offset;
Oleg Nesterove591c8d2012-11-24 17:29:40 +0100426 init_rwsem(&uprobe->register_rwsem);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530427 init_rwsem(&uprobe->consumer_rwsem);
Oleg Nesterovbbc33d02012-11-21 16:55:38 +0100428 /* For now assume that the instruction need not be single-stepped */
429 __set_bit(UPROBE_SKIP_SSTEP, &uprobe->flags);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530430
431 /* add to uprobes_tree, sorted on inode:offset */
432 cur_uprobe = insert_uprobe(uprobe);
433
434 /* a uprobe exists for this inode:offset combination */
435 if (cur_uprobe) {
436 kfree(uprobe);
437 uprobe = cur_uprobe;
438 iput(inode);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100439 }
440
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530441 return uprobe;
442}
443
Oleg Nesterov9a98e032012-11-23 20:15:17 +0100444static void consumer_add(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530445{
446 down_write(&uprobe->consumer_rwsem);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530447 uc->next = uprobe->consumers;
448 uprobe->consumers = uc;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530449 up_write(&uprobe->consumer_rwsem);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530450}
451
452/*
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530453 * For uprobe @uprobe, delete the consumer @uc.
454 * Return true if the @uc is deleted successfully
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530455 * or return false.
456 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530457static bool consumer_del(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530458{
459 struct uprobe_consumer **con;
460 bool ret = false;
461
462 down_write(&uprobe->consumer_rwsem);
463 for (con = &uprobe->consumers; *con; con = &(*con)->next) {
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530464 if (*con == uc) {
465 *con = uc->next;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530466 ret = true;
467 break;
468 }
469 }
470 up_write(&uprobe->consumer_rwsem);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100471
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530472 return ret;
473}
474
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530475static int
Oleg Nesterovd4366152012-06-15 17:43:42 +0200476__copy_insn(struct address_space *mapping, struct file *filp, char *insn,
Oleg Nesterov593609a2012-06-15 17:43:59 +0200477 unsigned long nbytes, loff_t offset)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530478{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530479 struct page *page;
480 void *vaddr;
Oleg Nesterov593609a2012-06-15 17:43:59 +0200481 unsigned long off;
482 pgoff_t idx;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530483
484 if (!filp)
485 return -EINVAL;
486
Oleg Nesterovcc359d12012-06-15 17:43:25 +0200487 if (!mapping->a_ops->readpage)
488 return -EIO;
489
Oleg Nesterov593609a2012-06-15 17:43:59 +0200490 idx = offset >> PAGE_CACHE_SHIFT;
491 off = offset & ~PAGE_MASK;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530492
493 /*
494 * Ensure that the page that has the original instruction is
495 * populated and in page-cache.
496 */
497 page = read_mapping_page(mapping, idx, filp);
498 if (IS_ERR(page))
499 return PTR_ERR(page);
500
501 vaddr = kmap_atomic(page);
Oleg Nesterov593609a2012-06-15 17:43:59 +0200502 memcpy(insn, vaddr + off, nbytes);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530503 kunmap_atomic(vaddr);
504 page_cache_release(page);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100505
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530506 return 0;
507}
508
Oleg Nesterovd4366152012-06-15 17:43:42 +0200509static int copy_insn(struct uprobe *uprobe, struct file *filp)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530510{
511 struct address_space *mapping;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530512 unsigned long nbytes;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100513 int bytes;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530514
Oleg Nesterovd4366152012-06-15 17:43:42 +0200515 nbytes = PAGE_SIZE - (uprobe->offset & ~PAGE_MASK);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530516 mapping = uprobe->inode->i_mapping;
517
518 /* Instruction at end of binary; copy only available bytes */
519 if (uprobe->offset + MAX_UINSN_BYTES > uprobe->inode->i_size)
520 bytes = uprobe->inode->i_size - uprobe->offset;
521 else
522 bytes = MAX_UINSN_BYTES;
523
524 /* Instruction at the page-boundary; copy bytes in second page */
525 if (nbytes < bytes) {
Oleg Nesterovfc36f592012-06-15 17:43:44 +0200526 int err = __copy_insn(mapping, filp, uprobe->arch.insn + nbytes,
527 bytes - nbytes, uprobe->offset + nbytes);
528 if (err)
529 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530530 bytes = nbytes;
531 }
Oleg Nesterovd4366152012-06-15 17:43:42 +0200532 return __copy_insn(mapping, filp, uprobe->arch.insn, bytes, uprobe->offset);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530533}
534
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200535static int prepare_uprobe(struct uprobe *uprobe, struct file *file,
536 struct mm_struct *mm, unsigned long vaddr)
537{
538 int ret = 0;
539
Oleg Nesterov71434f22012-09-30 21:12:44 +0200540 if (test_bit(UPROBE_COPY_INSN, &uprobe->flags))
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200541 return ret;
542
Oleg Nesterovd4d3ccc2012-11-24 18:51:34 +0100543 /* TODO: move this into _register, until then we abuse this sem. */
544 down_write(&uprobe->consumer_rwsem);
Oleg Nesterov71434f22012-09-30 21:12:44 +0200545 if (test_bit(UPROBE_COPY_INSN, &uprobe->flags))
Oleg Nesterov4710f05f2012-09-30 20:31:41 +0200546 goto out;
547
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200548 ret = copy_insn(uprobe, file);
549 if (ret)
550 goto out;
551
552 ret = -ENOTSUPP;
553 if (is_swbp_insn((uprobe_opcode_t *)uprobe->arch.insn))
554 goto out;
555
556 ret = arch_uprobe_analyze_insn(&uprobe->arch, mm, vaddr);
557 if (ret)
558 goto out;
559
560 /* write_opcode() assumes we don't cross page boundary */
561 BUG_ON((uprobe->offset & ~PAGE_MASK) +
562 UPROBE_SWBP_INSN_SIZE > PAGE_SIZE);
563
564 smp_wmb(); /* pairs with rmb() in find_active_uprobe() */
Oleg Nesterov71434f22012-09-30 21:12:44 +0200565 set_bit(UPROBE_COPY_INSN, &uprobe->flags);
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200566
567 out:
Oleg Nesterovd4d3ccc2012-11-24 18:51:34 +0100568 up_write(&uprobe->consumer_rwsem);
Oleg Nesterov4710f05f2012-09-30 20:31:41 +0200569
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200570 return ret;
571}
572
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100573static inline bool consumer_filter(struct uprobe_consumer *uc,
574 enum uprobe_filter_ctx ctx, struct mm_struct *mm)
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100575{
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100576 return !uc->filter || uc->filter(uc, ctx, mm);
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100577}
578
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100579static bool filter_chain(struct uprobe *uprobe,
580 enum uprobe_filter_ctx ctx, struct mm_struct *mm)
Oleg Nesterov63633cb2012-11-22 18:30:15 +0100581{
Oleg Nesterov1ff6fee2012-11-24 18:15:46 +0100582 struct uprobe_consumer *uc;
583 bool ret = false;
584
585 down_read(&uprobe->consumer_rwsem);
586 for (uc = uprobe->consumers; uc; uc = uc->next) {
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100587 ret = consumer_filter(uc, ctx, mm);
Oleg Nesterov1ff6fee2012-11-24 18:15:46 +0100588 if (ret)
589 break;
590 }
591 up_read(&uprobe->consumer_rwsem);
592
593 return ret;
Oleg Nesterov63633cb2012-11-22 18:30:15 +0100594}
595
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530596static int
597install_breakpoint(struct uprobe *uprobe, struct mm_struct *mm,
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200598 struct vm_area_struct *vma, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530599{
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200600 bool first_uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530601 int ret;
602
Oleg Nesterovcb9a19f2012-09-30 20:11:45 +0200603 ret = prepare_uprobe(uprobe, vma->vm_file, mm, vaddr);
604 if (ret)
605 return ret;
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530606
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200607 /*
608 * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
609 * the task can hit this breakpoint right after __replace_page().
610 */
611 first_uprobe = !test_bit(MMF_HAS_UPROBES, &mm->flags);
612 if (first_uprobe)
613 set_bit(MMF_HAS_UPROBES, &mm->flags);
614
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200615 ret = set_swbp(&uprobe->arch, mm, vaddr);
Oleg Nesterov9f68f6722012-08-19 16:15:09 +0200616 if (!ret)
617 clear_bit(MMF_RECALC_UPROBES, &mm->flags);
618 else if (first_uprobe)
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200619 clear_bit(MMF_HAS_UPROBES, &mm->flags);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530620
621 return ret;
622}
623
Oleg Nesterov076a3652012-09-30 18:54:53 +0200624static int
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200625remove_breakpoint(struct uprobe *uprobe, struct mm_struct *mm, unsigned long vaddr)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530626{
Oleg Nesterov9f68f6722012-08-19 16:15:09 +0200627 set_bit(MMF_RECALC_UPROBES, &mm->flags);
Oleg Nesterov076a3652012-09-30 18:54:53 +0200628 return set_orig_insn(&uprobe->arch, mm, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530629}
630
Oleg Nesterov06b7bcd2012-11-25 22:01:42 +0100631static inline bool uprobe_is_active(struct uprobe *uprobe)
632{
633 return !RB_EMPTY_NODE(&uprobe->rb_node);
634}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530635/*
Oleg Nesterov778b0322012-05-29 21:30:08 +0200636 * There could be threads that have already hit the breakpoint. They
637 * will recheck the current insn and restart if find_uprobe() fails.
638 * See find_active_uprobe().
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530639 */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530640static void delete_uprobe(struct uprobe *uprobe)
641{
Oleg Nesterov06b7bcd2012-11-25 22:01:42 +0100642 if (WARN_ON(!uprobe_is_active(uprobe)))
643 return;
644
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200645 spin_lock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530646 rb_erase(&uprobe->rb_node, &uprobes_tree);
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200647 spin_unlock(&uprobes_treelock);
Oleg Nesterov06b7bcd2012-11-25 22:01:42 +0100648 RB_CLEAR_NODE(&uprobe->rb_node); /* for uprobe_is_active() */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530649 iput(uprobe->inode);
650 put_uprobe(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530651}
652
Oleg Nesterov26872092012-06-15 17:43:33 +0200653struct map_info {
654 struct map_info *next;
655 struct mm_struct *mm;
Oleg Nesterov816c03f2012-06-15 17:43:55 +0200656 unsigned long vaddr;
Oleg Nesterov26872092012-06-15 17:43:33 +0200657};
658
659static inline struct map_info *free_map_info(struct map_info *info)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530660{
Oleg Nesterov26872092012-06-15 17:43:33 +0200661 struct map_info *next = info->next;
662 kfree(info);
663 return next;
664}
665
666static struct map_info *
667build_map_info(struct address_space *mapping, loff_t offset, bool is_register)
668{
669 unsigned long pgoff = offset >> PAGE_SHIFT;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530670 struct vm_area_struct *vma;
Oleg Nesterov26872092012-06-15 17:43:33 +0200671 struct map_info *curr = NULL;
672 struct map_info *prev = NULL;
673 struct map_info *info;
674 int more = 0;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100675
Oleg Nesterov26872092012-06-15 17:43:33 +0200676 again:
677 mutex_lock(&mapping->i_mmap_mutex);
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700678 vma_interval_tree_foreach(vma, &mapping->i_mmap, pgoff, pgoff) {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530679 if (!valid_vma(vma, is_register))
680 continue;
681
Oleg Nesterov7a5bfb62012-06-15 17:43:36 +0200682 if (!prev && !more) {
683 /*
684 * Needs GFP_NOWAIT to avoid i_mmap_mutex recursion through
685 * reclaim. This is optimistic, no harm done if it fails.
686 */
687 prev = kmalloc(sizeof(struct map_info),
688 GFP_NOWAIT | __GFP_NOMEMALLOC | __GFP_NOWARN);
689 if (prev)
690 prev->next = NULL;
691 }
Oleg Nesterov26872092012-06-15 17:43:33 +0200692 if (!prev) {
693 more++;
694 continue;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530695 }
696
Oleg Nesterov26872092012-06-15 17:43:33 +0200697 if (!atomic_inc_not_zero(&vma->vm_mm->mm_users))
698 continue;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100699
Oleg Nesterov26872092012-06-15 17:43:33 +0200700 info = prev;
701 prev = prev->next;
702 info->next = curr;
703 curr = info;
704
705 info->mm = vma->vm_mm;
Oleg Nesterov57683f72012-07-29 20:22:47 +0200706 info->vaddr = offset_to_vaddr(vma, offset);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530707 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530708 mutex_unlock(&mapping->i_mmap_mutex);
709
Oleg Nesterov26872092012-06-15 17:43:33 +0200710 if (!more)
711 goto out;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100712
Oleg Nesterov26872092012-06-15 17:43:33 +0200713 prev = curr;
714 while (curr) {
715 mmput(curr->mm);
716 curr = curr->next;
717 }
718
719 do {
720 info = kmalloc(sizeof(struct map_info), GFP_KERNEL);
721 if (!info) {
722 curr = ERR_PTR(-ENOMEM);
723 goto out;
724 }
725 info->next = prev;
726 prev = info;
727 } while (--more);
728
729 goto again;
730 out:
731 while (prev)
732 prev = free_map_info(prev);
733 return curr;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530734}
735
736static int register_for_each_vma(struct uprobe *uprobe, bool is_register)
737{
Oleg Nesterov26872092012-06-15 17:43:33 +0200738 struct map_info *info;
739 int err = 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530740
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100741 percpu_down_write(&dup_mmap_sem);
Oleg Nesterov26872092012-06-15 17:43:33 +0200742 info = build_map_info(uprobe->inode->i_mapping,
743 uprobe->offset, is_register);
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100744 if (IS_ERR(info)) {
745 err = PTR_ERR(info);
746 goto out;
747 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100748
Oleg Nesterov26872092012-06-15 17:43:33 +0200749 while (info) {
750 struct mm_struct *mm = info->mm;
751 struct vm_area_struct *vma;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100752
Oleg Nesterov076a3652012-09-30 18:54:53 +0200753 if (err && is_register)
Oleg Nesterov26872092012-06-15 17:43:33 +0200754 goto free;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100755
Oleg Nesterov77fc4af2012-05-29 21:29:28 +0200756 down_write(&mm->mmap_sem);
Oleg Nesterovf4d6dfe2012-07-29 20:22:44 +0200757 vma = find_vma(mm, info->vaddr);
758 if (!vma || !valid_vma(vma, is_register) ||
759 vma->vm_file->f_mapping->host != uprobe->inode)
Oleg Nesterov26872092012-06-15 17:43:33 +0200760 goto unlock;
761
Oleg Nesterovf4d6dfe2012-07-29 20:22:44 +0200762 if (vma->vm_start > info->vaddr ||
763 vaddr_to_offset(vma, info->vaddr) != uprobe->offset)
Oleg Nesterov26872092012-06-15 17:43:33 +0200764 goto unlock;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530765
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100766 if (is_register) {
767 /* consult only the "caller", new consumer. */
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100768 if (consumer_filter(uprobe->consumers,
769 UPROBE_FILTER_REGISTER, mm))
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100770 err = install_breakpoint(uprobe, mm, vma, info->vaddr);
771 } else if (test_bit(MMF_HAS_UPROBES, &mm->flags)) {
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100772 if (!filter_chain(uprobe,
773 UPROBE_FILTER_UNREGISTER, mm))
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100774 err |= remove_breakpoint(uprobe, mm, info->vaddr);
775 }
Oleg Nesterov78f74112012-08-08 17:35:08 +0200776
Oleg Nesterov26872092012-06-15 17:43:33 +0200777 unlock:
778 up_write(&mm->mmap_sem);
779 free:
780 mmput(mm);
781 info = free_map_info(info);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530782 }
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100783 out:
784 percpu_up_write(&dup_mmap_sem);
Oleg Nesterov26872092012-06-15 17:43:33 +0200785 return err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530786}
787
Oleg Nesterov9a98e032012-11-23 20:15:17 +0100788static int __uprobe_register(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530789{
Oleg Nesterov9a98e032012-11-23 20:15:17 +0100790 consumer_add(uprobe, uc);
Oleg Nesterovbb929282012-11-24 18:27:08 +0100791 return register_for_each_vma(uprobe, true);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530792}
793
Oleg Nesterov04aab9b2012-11-23 19:43:50 +0100794static void __uprobe_unregister(struct uprobe *uprobe, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530795{
Oleg Nesterov04aab9b2012-11-23 19:43:50 +0100796 int err;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530797
Oleg Nesterov04aab9b2012-11-23 19:43:50 +0100798 if (!consumer_del(uprobe, uc)) /* WARN? */
799 return;
800
801 err = register_for_each_vma(uprobe, false);
Oleg Nesterovbb929282012-11-24 18:27:08 +0100802 /* TODO : cant unregister? schedule a worker thread */
803 if (!uprobe->consumers && !err)
804 delete_uprobe(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530805}
806
807/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100808 * uprobe_register - register a probe
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530809 * @inode: the file in which the probe has to be placed.
810 * @offset: offset from the start of the file.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530811 * @uc: information on howto handle the probe..
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530812 *
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100813 * Apart from the access refcount, uprobe_register() takes a creation
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530814 * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
815 * inserted into the rbtree (i.e first consumer for a @inode:@offset
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100816 * tuple). Creation refcount stops uprobe_unregister from freeing the
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530817 * @uprobe even before the register operation is complete. Creation
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530818 * refcount is released when the last @uc for the @uprobe
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530819 * unregisters.
820 *
821 * Return errno if it cannot successully install probes
822 * else return 0 (success)
823 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530824int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530825{
826 struct uprobe *uprobe;
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100827 int ret;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530828
Oleg Nesterovf0744af2012-11-21 18:01:43 +0100829 /* Racy, just to catch the obvious mistakes */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530830 if (offset > i_size_read(inode))
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100831 return -EINVAL;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530832
Oleg Nesterov66d06df2012-11-25 22:48:37 +0100833 retry:
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530834 uprobe = alloc_uprobe(inode, offset);
Oleg Nesterov66d06df2012-11-25 22:48:37 +0100835 if (!uprobe)
836 return -ENOMEM;
837 /*
838 * We can race with uprobe_unregister()->delete_uprobe().
839 * Check uprobe_is_active() and retry if it is false.
840 */
841 down_write(&uprobe->register_rwsem);
842 ret = -EAGAIN;
843 if (likely(uprobe_is_active(uprobe))) {
Oleg Nesterov9a98e032012-11-23 20:15:17 +0100844 ret = __uprobe_register(uprobe, uc);
845 if (ret)
Oleg Nesterov04aab9b2012-11-23 19:43:50 +0100846 __uprobe_unregister(uprobe, uc);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530847 }
Oleg Nesterov66d06df2012-11-25 22:48:37 +0100848 up_write(&uprobe->register_rwsem);
849 put_uprobe(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530850
Oleg Nesterov66d06df2012-11-25 22:48:37 +0100851 if (unlikely(ret == -EAGAIN))
852 goto retry;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530853 return ret;
854}
Josh Stonee8440c12013-01-13 19:03:34 +0100855EXPORT_SYMBOL_GPL(uprobe_register);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530856
857/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100858 * uprobe_unregister - unregister a already registered probe.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530859 * @inode: the file in which the probe has to be removed.
860 * @offset: offset from the start of the file.
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530861 * @uc: identify which probe if multiple probes are colocated.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530862 */
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530863void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530864{
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100865 struct uprobe *uprobe;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530866
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530867 uprobe = find_uprobe(inode, offset);
868 if (!uprobe)
869 return;
870
Oleg Nesterove591c8d2012-11-24 17:29:40 +0100871 down_write(&uprobe->register_rwsem);
Oleg Nesterov04aab9b2012-11-23 19:43:50 +0100872 __uprobe_unregister(uprobe, uc);
Oleg Nesterove591c8d2012-11-24 17:29:40 +0100873 up_write(&uprobe->register_rwsem);
Sasha Levinc91368c2012-12-20 14:11:30 -0500874 put_uprobe(uprobe);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530875}
Josh Stonee8440c12013-01-13 19:03:34 +0100876EXPORT_SYMBOL_GPL(uprobe_unregister);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530877
Oleg Nesterovda1816b2012-12-29 17:49:11 +0100878static int unapply_uprobe(struct uprobe *uprobe, struct mm_struct *mm)
879{
880 struct vm_area_struct *vma;
881 int err = 0;
882
883 down_read(&mm->mmap_sem);
884 for (vma = mm->mmap; vma; vma = vma->vm_next) {
885 unsigned long vaddr;
886 loff_t offset;
887
888 if (!valid_vma(vma, false) ||
889 vma->vm_file->f_mapping->host != uprobe->inode)
890 continue;
891
892 offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
893 if (uprobe->offset < offset ||
894 uprobe->offset >= offset + vma->vm_end - vma->vm_start)
895 continue;
896
897 vaddr = offset_to_vaddr(vma, uprobe->offset);
898 err |= remove_breakpoint(uprobe, mm, vaddr);
899 }
900 up_read(&mm->mmap_sem);
901
902 return err;
903}
904
Oleg Nesterov891c3972012-07-29 20:22:40 +0200905static struct rb_node *
906find_node_in_range(struct inode *inode, loff_t min, loff_t max)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530907{
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530908 struct rb_node *n = uprobes_tree.rb_node;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530909
910 while (n) {
Oleg Nesterov891c3972012-07-29 20:22:40 +0200911 struct uprobe *u = rb_entry(n, struct uprobe, rb_node);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100912
Oleg Nesterov891c3972012-07-29 20:22:40 +0200913 if (inode < u->inode) {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530914 n = n->rb_left;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200915 } else if (inode > u->inode) {
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530916 n = n->rb_right;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200917 } else {
918 if (max < u->offset)
919 n = n->rb_left;
920 else if (min > u->offset)
921 n = n->rb_right;
922 else
923 break;
924 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530925 }
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100926
Oleg Nesterov891c3972012-07-29 20:22:40 +0200927 return n;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530928}
929
930/*
Oleg Nesterov891c3972012-07-29 20:22:40 +0200931 * For a given range in vma, build a list of probes that need to be inserted.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530932 */
Oleg Nesterov891c3972012-07-29 20:22:40 +0200933static void build_probe_list(struct inode *inode,
934 struct vm_area_struct *vma,
935 unsigned long start, unsigned long end,
936 struct list_head *head)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530937{
Oleg Nesterov891c3972012-07-29 20:22:40 +0200938 loff_t min, max;
Oleg Nesterov891c3972012-07-29 20:22:40 +0200939 struct rb_node *n, *t;
940 struct uprobe *u;
941
942 INIT_LIST_HEAD(head);
Oleg Nesterovcb113b42012-07-29 20:22:42 +0200943 min = vaddr_to_offset(vma, start);
Oleg Nesterov891c3972012-07-29 20:22:40 +0200944 max = min + (end - start) - 1;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530945
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200946 spin_lock(&uprobes_treelock);
Oleg Nesterov891c3972012-07-29 20:22:40 +0200947 n = find_node_in_range(inode, min, max);
948 if (n) {
949 for (t = n; t; t = rb_prev(t)) {
950 u = rb_entry(t, struct uprobe, rb_node);
951 if (u->inode != inode || u->offset < min)
952 break;
953 list_add(&u->pending_list, head);
954 atomic_inc(&u->ref);
955 }
956 for (t = n; (t = rb_next(t)); ) {
957 u = rb_entry(t, struct uprobe, rb_node);
958 if (u->inode != inode || u->offset > max)
959 break;
960 list_add(&u->pending_list, head);
961 atomic_inc(&u->ref);
962 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530963 }
Oleg Nesterov6f47caa2012-08-18 17:01:57 +0200964 spin_unlock(&uprobes_treelock);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530965}
966
967/*
Oleg Nesterov5e5be712012-08-06 14:49:56 +0200968 * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530969 *
Oleg Nesterov5e5be712012-08-06 14:49:56 +0200970 * Currently we ignore all errors and always return 0, the callers
971 * can't handle the failure anyway.
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530972 */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100973int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530974{
975 struct list_head tmp_list;
Oleg Nesterov665605a2012-07-29 20:22:29 +0200976 struct uprobe *uprobe, *u;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530977 struct inode *inode;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530978
Oleg Nesterov441f1eb72012-11-25 19:54:29 +0100979 if (no_uprobe_events() || !valid_vma(vma, true))
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100980 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530981
982 inode = vma->vm_file->f_mapping->host;
983 if (!inode)
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100984 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530985
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530986 mutex_lock(uprobes_mmap_hash(inode));
Oleg Nesterov891c3972012-07-29 20:22:40 +0200987 build_probe_list(inode, vma, vma->vm_start, vma->vm_end, &tmp_list);
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100988 /*
989 * We can race with uprobe_unregister(), this uprobe can be already
990 * removed. But in this case filter_chain() must return false, all
991 * consumers have gone away.
992 */
Oleg Nesterov665605a2012-07-29 20:22:29 +0200993 list_for_each_entry_safe(uprobe, u, &tmp_list, pending_list) {
Oleg Nesterov806a98b2012-12-27 18:21:11 +0100994 if (!fatal_signal_pending(current) &&
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +0100995 filter_chain(uprobe, UPROBE_FILTER_MMAP, vma->vm_mm)) {
Oleg Nesterov57683f72012-07-29 20:22:47 +0200996 unsigned long vaddr = offset_to_vaddr(vma, uprobe->offset);
Oleg Nesterov5e5be712012-08-06 14:49:56 +0200997 install_breakpoint(uprobe, vma->vm_mm, vma, vaddr);
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530998 }
999 put_uprobe(uprobe);
1000 }
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301001 mutex_unlock(uprobes_mmap_hash(inode));
1002
Oleg Nesterov5e5be712012-08-06 14:49:56 +02001003 return 0;
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301004}
1005
Oleg Nesterov9f68f6722012-08-19 16:15:09 +02001006static bool
1007vma_has_uprobes(struct vm_area_struct *vma, unsigned long start, unsigned long end)
1008{
1009 loff_t min, max;
1010 struct inode *inode;
1011 struct rb_node *n;
1012
1013 inode = vma->vm_file->f_mapping->host;
1014
1015 min = vaddr_to_offset(vma, start);
1016 max = min + (end - start) - 1;
1017
1018 spin_lock(&uprobes_treelock);
1019 n = find_node_in_range(inode, min, max);
1020 spin_unlock(&uprobes_treelock);
1021
1022 return !!n;
1023}
1024
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301025/*
1026 * Called in context of a munmap of a vma.
1027 */
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +05301028void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301029{
Oleg Nesterov441f1eb72012-11-25 19:54:29 +01001030 if (no_uprobe_events() || !valid_vma(vma, false))
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301031 return;
1032
Oleg Nesterov2fd611a2012-07-29 20:22:31 +02001033 if (!atomic_read(&vma->vm_mm->mm_users)) /* called by mmput() ? */
1034 return;
1035
Oleg Nesterov9f68f6722012-08-19 16:15:09 +02001036 if (!test_bit(MMF_HAS_UPROBES, &vma->vm_mm->flags) ||
1037 test_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags))
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001038 return;
1039
Oleg Nesterov9f68f6722012-08-19 16:15:09 +02001040 if (vma_has_uprobes(vma, start, end))
1041 set_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags);
Srikar Dronamraju682968e2012-03-30 23:56:46 +05301042}
1043
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301044/* Slot allocation for XOL */
1045static int xol_add_vma(struct xol_area *area)
1046{
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001047 struct mm_struct *mm = current->mm;
1048 int ret = -EALREADY;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301049
1050 down_write(&mm->mmap_sem);
1051 if (mm->uprobes_state.xol_area)
1052 goto fail;
1053
1054 ret = -ENOMEM;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301055 /* Try to map as high as possible, this is only a hint. */
1056 area->vaddr = get_unmapped_area(NULL, TASK_SIZE - PAGE_SIZE, PAGE_SIZE, 0, 0);
1057 if (area->vaddr & ~PAGE_MASK) {
1058 ret = area->vaddr;
1059 goto fail;
1060 }
1061
1062 ret = install_special_mapping(mm, area->vaddr, PAGE_SIZE,
1063 VM_EXEC|VM_MAYEXEC|VM_DONTCOPY|VM_IO, &area->page);
1064 if (ret)
1065 goto fail;
1066
1067 smp_wmb(); /* pairs with get_xol_area() */
1068 mm->uprobes_state.xol_area = area;
1069 ret = 0;
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001070 fail:
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301071 up_write(&mm->mmap_sem);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301072
1073 return ret;
1074}
1075
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301076/*
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001077 * get_xol_area - Allocate process's xol_area if necessary.
1078 * This area will be used for storing instructions for execution out of line.
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301079 *
1080 * Returns the allocated area or NULL.
1081 */
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001082static struct xol_area *get_xol_area(void)
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301083{
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001084 struct mm_struct *mm = current->mm;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301085 struct xol_area *area;
1086
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001087 area = mm->uprobes_state.xol_area;
1088 if (area)
1089 goto ret;
1090
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301091 area = kzalloc(sizeof(*area), GFP_KERNEL);
1092 if (unlikely(!area))
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001093 goto out;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301094
1095 area->bitmap = kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE) * sizeof(long), GFP_KERNEL);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301096 if (!area->bitmap)
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001097 goto free_area;
1098
1099 area->page = alloc_page(GFP_HIGHUSER);
1100 if (!area->page)
1101 goto free_bitmap;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301102
1103 init_waitqueue_head(&area->wq);
1104 if (!xol_add_vma(area))
1105 return area;
1106
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001107 __free_page(area->page);
1108 free_bitmap:
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301109 kfree(area->bitmap);
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001110 free_area:
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301111 kfree(area);
Oleg Nesterovc8a82532012-12-30 17:40:39 +01001112 out:
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001113 area = mm->uprobes_state.xol_area;
1114 ret:
1115 smp_read_barrier_depends(); /* pairs with wmb in xol_add_vma() */
1116 return area;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301117}
1118
1119/*
1120 * uprobe_clear_state - Free the area allocated for slots.
1121 */
1122void uprobe_clear_state(struct mm_struct *mm)
1123{
1124 struct xol_area *area = mm->uprobes_state.xol_area;
1125
1126 if (!area)
1127 return;
1128
1129 put_page(area->page);
1130 kfree(area->bitmap);
1131 kfree(area);
1132}
1133
Oleg Nesterov32cdba12012-11-14 19:03:42 +01001134void uprobe_start_dup_mmap(void)
1135{
1136 percpu_down_read(&dup_mmap_sem);
1137}
1138
1139void uprobe_end_dup_mmap(void)
1140{
1141 percpu_up_read(&dup_mmap_sem);
1142}
1143
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001144void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
1145{
Oleg Nesterov61559a82012-08-08 17:17:46 +02001146 newmm->uprobes_state.xol_area = NULL;
1147
Oleg Nesterov9f68f6722012-08-19 16:15:09 +02001148 if (test_bit(MMF_HAS_UPROBES, &oldmm->flags)) {
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001149 set_bit(MMF_HAS_UPROBES, &newmm->flags);
Oleg Nesterov9f68f6722012-08-19 16:15:09 +02001150 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1151 set_bit(MMF_RECALC_UPROBES, &newmm->flags);
1152 }
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001153}
1154
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301155/*
1156 * - search for a free slot.
1157 */
1158static unsigned long xol_take_insn_slot(struct xol_area *area)
1159{
1160 unsigned long slot_addr;
1161 int slot_nr;
1162
1163 do {
1164 slot_nr = find_first_zero_bit(area->bitmap, UINSNS_PER_PAGE);
1165 if (slot_nr < UINSNS_PER_PAGE) {
1166 if (!test_and_set_bit(slot_nr, area->bitmap))
1167 break;
1168
1169 slot_nr = UINSNS_PER_PAGE;
1170 continue;
1171 }
1172 wait_event(area->wq, (atomic_read(&area->slot_count) < UINSNS_PER_PAGE));
1173 } while (slot_nr >= UINSNS_PER_PAGE);
1174
1175 slot_addr = area->vaddr + (slot_nr * UPROBE_XOL_SLOT_BYTES);
1176 atomic_inc(&area->slot_count);
1177
1178 return slot_addr;
1179}
1180
1181/*
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001182 * xol_get_insn_slot - allocate a slot for xol.
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301183 * Returns the allocated slot address or 0.
1184 */
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001185static unsigned long xol_get_insn_slot(struct uprobe *uprobe)
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301186{
1187 struct xol_area *area;
1188 unsigned long offset;
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001189 unsigned long xol_vaddr;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301190 void *vaddr;
1191
Oleg Nesterov9b545df2012-12-31 16:39:49 +01001192 area = get_xol_area();
1193 if (!area)
1194 return 0;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301195
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001196 xol_vaddr = xol_take_insn_slot(area);
1197 if (unlikely(!xol_vaddr))
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301198 return 0;
1199
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001200 /* Initialize the slot */
1201 offset = xol_vaddr & ~PAGE_MASK;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301202 vaddr = kmap_atomic(area->page);
1203 memcpy(vaddr + offset, uprobe->arch.insn, MAX_UINSN_BYTES);
1204 kunmap_atomic(vaddr);
Rabin Vincent65b6ecc2012-11-14 18:27:07 +01001205 /*
1206 * We probably need flush_icache_user_range() but it needs vma.
1207 * This should work on supported architectures too.
1208 */
1209 flush_dcache_page(area->page);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301210
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001211 return xol_vaddr;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301212}
1213
1214/*
1215 * xol_free_insn_slot - If slot was earlier allocated by
1216 * @xol_get_insn_slot(), make the slot available for
1217 * subsequent requests.
1218 */
1219static void xol_free_insn_slot(struct task_struct *tsk)
1220{
1221 struct xol_area *area;
1222 unsigned long vma_end;
1223 unsigned long slot_addr;
1224
1225 if (!tsk->mm || !tsk->mm->uprobes_state.xol_area || !tsk->utask)
1226 return;
1227
1228 slot_addr = tsk->utask->xol_vaddr;
Oleg Nesterovaf4355e2012-12-31 18:37:11 +01001229 if (unlikely(!slot_addr))
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301230 return;
1231
1232 area = tsk->mm->uprobes_state.xol_area;
1233 vma_end = area->vaddr + PAGE_SIZE;
1234 if (area->vaddr <= slot_addr && slot_addr < vma_end) {
1235 unsigned long offset;
1236 int slot_nr;
1237
1238 offset = slot_addr - area->vaddr;
1239 slot_nr = offset / UPROBE_XOL_SLOT_BYTES;
1240 if (slot_nr >= UINSNS_PER_PAGE)
1241 return;
1242
1243 clear_bit(slot_nr, area->bitmap);
1244 atomic_dec(&area->slot_count);
1245 if (waitqueue_active(&area->wq))
1246 wake_up(&area->wq);
1247
1248 tsk->utask->xol_vaddr = 0;
1249 }
1250}
1251
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301252/**
1253 * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1254 * @regs: Reflects the saved state of the task after it has hit a breakpoint
1255 * instruction.
1256 * Return the address of the breakpoint instruction.
1257 */
1258unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs)
1259{
1260 return instruction_pointer(regs) - UPROBE_SWBP_INSN_SIZE;
1261}
1262
1263/*
1264 * Called with no locks held.
1265 * Called in context of a exiting or a exec-ing thread.
1266 */
1267void uprobe_free_utask(struct task_struct *t)
1268{
1269 struct uprobe_task *utask = t->utask;
1270
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301271 if (!utask)
1272 return;
1273
1274 if (utask->active_uprobe)
1275 put_uprobe(utask->active_uprobe);
1276
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301277 xol_free_insn_slot(t);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301278 kfree(utask);
1279 t->utask = NULL;
1280}
1281
1282/*
1283 * Called in context of a new clone/fork from copy_process.
1284 */
1285void uprobe_copy_process(struct task_struct *t)
1286{
1287 t->utask = NULL;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301288}
1289
1290/*
Oleg Nesterov5a2df662012-12-31 17:03:32 +01001291 * Allocate a uprobe_task object for the task if if necessary.
1292 * Called when the thread hits a breakpoint.
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301293 *
1294 * Returns:
1295 * - pointer to new uprobe_task on success
1296 * - NULL otherwise
1297 */
Oleg Nesterov5a2df662012-12-31 17:03:32 +01001298static struct uprobe_task *get_utask(void)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301299{
Oleg Nesterov5a2df662012-12-31 17:03:32 +01001300 if (!current->utask)
1301 current->utask = kzalloc(sizeof(struct uprobe_task), GFP_KERNEL);
1302 return current->utask;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301303}
1304
1305/* Prepare to single-step probed instruction out of line. */
1306static int
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001307pre_ssout(struct uprobe *uprobe, struct pt_regs *regs, unsigned long bp_vaddr)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301308{
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001309 struct uprobe_task *utask;
1310 unsigned long xol_vaddr;
Oleg Nesterovaba51022012-12-31 18:12:48 +01001311 int err;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301312
Oleg Nesterov608e7422012-12-31 18:20:42 +01001313 utask = get_utask();
1314 if (!utask)
1315 return -ENOMEM;
Oleg Nesterova6cb3f62012-12-31 18:00:06 +01001316
1317 xol_vaddr = xol_get_insn_slot(uprobe);
1318 if (!xol_vaddr)
1319 return -ENOMEM;
1320
1321 utask->xol_vaddr = xol_vaddr;
1322 utask->vaddr = bp_vaddr;
1323
Oleg Nesterovaba51022012-12-31 18:12:48 +01001324 err = arch_uprobe_pre_xol(&uprobe->arch, regs);
1325 if (unlikely(err)) {
1326 xol_free_insn_slot(current);
1327 return err;
1328 }
1329
Oleg Nesterov608e7422012-12-31 18:20:42 +01001330 utask->active_uprobe = uprobe;
1331 utask->state = UTASK_SSTEP;
Oleg Nesterovaba51022012-12-31 18:12:48 +01001332 return 0;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301333}
1334
1335/*
1336 * If we are singlestepping, then ensure this thread is not connected to
1337 * non-fatal signals until completion of singlestep. When xol insn itself
1338 * triggers the signal, restart the original insn even if the task is
1339 * already SIGKILL'ed (since coredump should report the correct ip). This
1340 * is even more important if the task has a handler for SIGSEGV/etc, The
1341 * _same_ instruction should be repeated again after return from the signal
1342 * handler, and SSTEP can never finish in this case.
1343 */
1344bool uprobe_deny_signal(void)
1345{
1346 struct task_struct *t = current;
1347 struct uprobe_task *utask = t->utask;
1348
1349 if (likely(!utask || !utask->active_uprobe))
1350 return false;
1351
1352 WARN_ON_ONCE(utask->state != UTASK_SSTEP);
1353
1354 if (signal_pending(t)) {
1355 spin_lock_irq(&t->sighand->siglock);
1356 clear_tsk_thread_flag(t, TIF_SIGPENDING);
1357 spin_unlock_irq(&t->sighand->siglock);
1358
1359 if (__fatal_signal_pending(t) || arch_uprobe_xol_was_trapped(t)) {
1360 utask->state = UTASK_SSTEP_TRAPPED;
1361 set_tsk_thread_flag(t, TIF_UPROBE);
1362 set_tsk_thread_flag(t, TIF_NOTIFY_RESUME);
1363 }
1364 }
1365
1366 return true;
1367}
1368
1369/*
1370 * Avoid singlestepping the original instruction if the original instruction
1371 * is a NOP or can be emulated.
1372 */
1373static bool can_skip_sstep(struct uprobe *uprobe, struct pt_regs *regs)
1374{
Oleg Nesterov71434f22012-09-30 21:12:44 +02001375 if (test_bit(UPROBE_SKIP_SSTEP, &uprobe->flags)) {
Oleg Nesterov0578a972012-09-14 18:31:23 +02001376 if (arch_uprobe_skip_sstep(&uprobe->arch, regs))
1377 return true;
Oleg Nesterov71434f22012-09-30 21:12:44 +02001378 clear_bit(UPROBE_SKIP_SSTEP, &uprobe->flags);
Oleg Nesterov0578a972012-09-14 18:31:23 +02001379 }
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301380 return false;
1381}
1382
Oleg Nesterov499a4f32012-08-19 17:41:34 +02001383static void mmf_recalc_uprobes(struct mm_struct *mm)
1384{
1385 struct vm_area_struct *vma;
1386
1387 for (vma = mm->mmap; vma; vma = vma->vm_next) {
1388 if (!valid_vma(vma, false))
1389 continue;
1390 /*
1391 * This is not strictly accurate, we can race with
1392 * uprobe_unregister() and see the already removed
1393 * uprobe if delete_uprobe() was not yet called.
Oleg Nesterov63633cb2012-11-22 18:30:15 +01001394 * Or this uprobe can be filtered out.
Oleg Nesterov499a4f32012-08-19 17:41:34 +02001395 */
1396 if (vma_has_uprobes(vma, vma->vm_start, vma->vm_end))
1397 return;
1398 }
1399
1400 clear_bit(MMF_HAS_UPROBES, &mm->flags);
1401}
1402
Oleg Nesterovec75fba2012-09-23 21:55:19 +02001403static int is_swbp_at_addr(struct mm_struct *mm, unsigned long vaddr)
1404{
1405 struct page *page;
1406 uprobe_opcode_t opcode;
1407 int result;
1408
1409 pagefault_disable();
1410 result = __copy_from_user_inatomic(&opcode, (void __user*)vaddr,
1411 sizeof(opcode));
1412 pagefault_enable();
1413
1414 if (likely(result == 0))
1415 goto out;
1416
1417 result = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &page, NULL);
1418 if (result < 0)
1419 return result;
1420
1421 copy_opcode(page, vaddr, &opcode);
1422 put_page(page);
1423 out:
1424 return is_swbp_insn(&opcode);
1425}
1426
Oleg Nesterovd790d342012-05-29 21:29:14 +02001427static struct uprobe *find_active_uprobe(unsigned long bp_vaddr, int *is_swbp)
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001428{
1429 struct mm_struct *mm = current->mm;
1430 struct uprobe *uprobe = NULL;
1431 struct vm_area_struct *vma;
1432
1433 down_read(&mm->mmap_sem);
1434 vma = find_vma(mm, bp_vaddr);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001435 if (vma && vma->vm_start <= bp_vaddr) {
1436 if (valid_vma(vma, false)) {
Oleg Nesterovcb113b42012-07-29 20:22:42 +02001437 struct inode *inode = vma->vm_file->f_mapping->host;
1438 loff_t offset = vaddr_to_offset(vma, bp_vaddr);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001439
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001440 uprobe = find_uprobe(inode, offset);
1441 }
Oleg Nesterovd790d342012-05-29 21:29:14 +02001442
1443 if (!uprobe)
1444 *is_swbp = is_swbp_at_addr(mm, bp_vaddr);
1445 } else {
1446 *is_swbp = -EFAULT;
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001447 }
Oleg Nesterov499a4f32012-08-19 17:41:34 +02001448
1449 if (!uprobe && test_and_clear_bit(MMF_RECALC_UPROBES, &mm->flags))
1450 mmf_recalc_uprobes(mm);
Oleg Nesterov3a9ea052012-05-29 21:28:57 +02001451 up_read(&mm->mmap_sem);
1452
1453 return uprobe;
1454}
1455
Oleg Nesterovda1816b2012-12-29 17:49:11 +01001456static void handler_chain(struct uprobe *uprobe, struct pt_regs *regs)
1457{
1458 struct uprobe_consumer *uc;
1459 int remove = UPROBE_HANDLER_REMOVE;
1460
1461 down_read(&uprobe->register_rwsem);
1462 for (uc = uprobe->consumers; uc; uc = uc->next) {
1463 int rc = uc->handler(uc, regs);
1464
1465 WARN(rc & ~UPROBE_HANDLER_MASK,
1466 "bad rc=0x%x from %pf()\n", rc, uc->handler);
1467 remove &= rc;
1468 }
1469
1470 if (remove && uprobe->consumers) {
1471 WARN_ON(!uprobe_is_active(uprobe));
1472 unapply_uprobe(uprobe, current->mm);
1473 }
1474 up_read(&uprobe->register_rwsem);
1475}
1476
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301477/*
1478 * Run handler and ask thread to singlestep.
1479 * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1480 */
1481static void handle_swbp(struct pt_regs *regs)
1482{
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301483 struct uprobe *uprobe;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301484 unsigned long bp_vaddr;
Oleg Nesterov56bb4cf2012-05-29 21:29:47 +02001485 int uninitialized_var(is_swbp);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301486
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301487 bp_vaddr = uprobe_get_swbp_addr(regs);
Oleg Nesterovd790d342012-05-29 21:29:14 +02001488 uprobe = find_active_uprobe(bp_vaddr, &is_swbp);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301489
1490 if (!uprobe) {
Oleg Nesterov56bb4cf2012-05-29 21:29:47 +02001491 if (is_swbp > 0) {
1492 /* No matching uprobe; signal SIGTRAP. */
1493 send_sig(SIGTRAP, current, 0);
1494 } else {
1495 /*
1496 * Either we raced with uprobe_unregister() or we can't
1497 * access this memory. The latter is only possible if
1498 * another thread plays with our ->mm. In both cases
1499 * we can simply restart. If this vma was unmapped we
1500 * can pretend this insn was not executed yet and get
1501 * the (correct) SIGSEGV after restart.
1502 */
1503 instruction_pointer_set(regs, bp_vaddr);
1504 }
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301505 return;
1506 }
Oleg Nesterov74e59df2012-12-30 15:54:08 +01001507
1508 /* change it in advance for ->handler() and restart */
1509 instruction_pointer_set(regs, bp_vaddr);
1510
Oleg Nesterov142b18d2012-09-29 21:56:57 +02001511 /*
1512 * TODO: move copy_insn/etc into _register and remove this hack.
1513 * After we hit the bp, _unregister + _register can install the
1514 * new and not-yet-analyzed uprobe at the same address, restart.
1515 */
1516 smp_rmb(); /* pairs with wmb() in install_breakpoint() */
Oleg Nesterov71434f22012-09-30 21:12:44 +02001517 if (unlikely(!test_bit(UPROBE_COPY_INSN, &uprobe->flags)))
Oleg Nesterov74e59df2012-12-30 15:54:08 +01001518 goto out;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301519
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301520 handler_chain(uprobe, regs);
Oleg Nesterov0578a972012-09-14 18:31:23 +02001521 if (can_skip_sstep(uprobe, regs))
1522 goto out;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301523
Oleg Nesterov608e7422012-12-31 18:20:42 +01001524 if (!pre_ssout(uprobe, regs, bp_vaddr))
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301525 return;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301526
Oleg Nesterov74e59df2012-12-30 15:54:08 +01001527 /* can_skip_sstep() succeeded, or restart if can't singlestep */
Oleg Nesterov0578a972012-09-14 18:31:23 +02001528out:
Sebastian Andrzej Siewior8bd87442012-08-07 18:12:30 +02001529 put_uprobe(uprobe);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301530}
1531
1532/*
1533 * Perform required fix-ups and disable singlestep.
1534 * Allow pending signals to take effect.
1535 */
1536static void handle_singlestep(struct uprobe_task *utask, struct pt_regs *regs)
1537{
1538 struct uprobe *uprobe;
1539
1540 uprobe = utask->active_uprobe;
1541 if (utask->state == UTASK_SSTEP_ACK)
1542 arch_uprobe_post_xol(&uprobe->arch, regs);
1543 else if (utask->state == UTASK_SSTEP_TRAPPED)
1544 arch_uprobe_abort_xol(&uprobe->arch, regs);
1545 else
1546 WARN_ON_ONCE(1);
1547
1548 put_uprobe(uprobe);
1549 utask->active_uprobe = NULL;
1550 utask->state = UTASK_RUNNING;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +05301551 xol_free_insn_slot(current);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301552
1553 spin_lock_irq(&current->sighand->siglock);
1554 recalc_sigpending(); /* see uprobe_deny_signal() */
1555 spin_unlock_irq(&current->sighand->siglock);
1556}
1557
1558/*
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001559 * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1560 * allows the thread to return from interrupt. After that handle_swbp()
1561 * sets utask->active_uprobe.
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301562 *
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001563 * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1564 * and allows the thread to return from interrupt.
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301565 *
1566 * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1567 * uprobe_notify_resume().
1568 */
1569void uprobe_notify_resume(struct pt_regs *regs)
1570{
1571 struct uprobe_task *utask;
1572
Oleg Nesterovdb023ea2012-09-14 19:05:46 +02001573 clear_thread_flag(TIF_UPROBE);
1574
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301575 utask = current->utask;
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001576 if (utask && utask->active_uprobe)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301577 handle_singlestep(utask, regs);
Oleg Nesterov1b08e9072012-09-14 18:52:10 +02001578 else
1579 handle_swbp(regs);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301580}
1581
1582/*
1583 * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1584 * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1585 */
1586int uprobe_pre_sstep_notifier(struct pt_regs *regs)
1587{
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +02001588 if (!current->mm || !test_bit(MMF_HAS_UPROBES, &current->mm->flags))
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301589 return 0;
1590
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301591 set_thread_flag(TIF_UPROBE);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301592 return 1;
1593}
1594
1595/*
1596 * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
1597 * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
1598 */
1599int uprobe_post_sstep_notifier(struct pt_regs *regs)
1600{
1601 struct uprobe_task *utask = current->utask;
1602
1603 if (!current->mm || !utask || !utask->active_uprobe)
1604 /* task is currently not uprobed */
1605 return 0;
1606
1607 utask->state = UTASK_SSTEP_ACK;
1608 set_thread_flag(TIF_UPROBE);
1609 return 1;
1610}
1611
1612static struct notifier_block uprobe_exception_nb = {
1613 .notifier_call = arch_uprobe_exception_notify,
1614 .priority = INT_MAX-1, /* notified after kprobes, kgdb */
1615};
1616
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301617static int __init init_uprobes(void)
1618{
1619 int i;
1620
Oleg Nesterov66d06df2012-11-25 22:48:37 +01001621 for (i = 0; i < UPROBES_HASH_SZ; i++)
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301622 mutex_init(&uprobes_mmap_mutex[i]);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301623
Oleg Nesterov32cdba12012-11-14 19:03:42 +01001624 if (percpu_init_rwsem(&dup_mmap_sem))
1625 return -ENOMEM;
1626
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301627 return register_die_notifier(&uprobe_exception_nb);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301628}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +05301629module_init(init_uprobes);
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301630
1631static void __exit exit_uprobes(void)
1632{
1633}
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301634module_exit(exit_uprobes);