2 * User-space Probes (UProbes)
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.
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.
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.
18 * Copyright (C) IBM Corporation, 2008-2012
22 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
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 */
33 #include <linux/ptrace.h> /* user_enable_single_step */
34 #include <linux/kdebug.h> /* notifier mechanism */
35 #include "../../mm/internal.h" /* munlock_vma_page */
37 #include <linux/uprobes.h>
39 #define UINSNS_PER_PAGE (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
40 #define MAX_UPROBE_XOL_SLOTS UINSNS_PER_PAGE
42 static struct rb_root uprobes_tree
= RB_ROOT
;
44 static DEFINE_SPINLOCK(uprobes_treelock
); /* serialize rbtree access */
46 #define UPROBES_HASH_SZ 13
49 * We need separate register/unregister and mmap/munmap lock hashes because
50 * of mmap_sem nesting.
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.
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.
61 * Thus uprobe_register() can race with uprobe_mmap() and we can try and
62 * install a probe where one is already installed.
65 /* serialize (un)register */
66 static struct mutex uprobes_mutex
[UPROBES_HASH_SZ
];
68 #define uprobes_hash(v) (&uprobes_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
70 /* serialize uprobe->pending_list */
71 static struct mutex uprobes_mmap_mutex
[UPROBES_HASH_SZ
];
72 #define uprobes_mmap_hash(v) (&uprobes_mmap_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
75 * uprobe_events allows us to skip the uprobe_mmap if there are no uprobe
76 * events active at this time. Probably a fine grained per inode count is
79 static atomic_t uprobe_events
= ATOMIC_INIT(0);
81 /* Have a copy of original instruction */
82 #define UPROBE_COPY_INSN 0
83 /* Dont run handlers when first register/ last unregister in progress*/
84 #define UPROBE_RUN_HANDLER 1
85 /* Can skip singlestep */
86 #define UPROBE_SKIP_SSTEP 2
89 struct rb_node rb_node
; /* node in the rb tree */
91 struct rw_semaphore consumer_rwsem
;
92 struct mutex copy_mutex
; /* TODO: kill me and UPROBE_COPY_INSN */
93 struct list_head pending_list
;
94 struct uprobe_consumer
*consumers
;
95 struct inode
*inode
; /* Also hold a ref to inode */
98 struct arch_uprobe arch
;
102 * valid_vma: Verify if the specified vma is an executable vma
103 * Relax restrictions while unregistering: vm_flags might have
104 * changed after breakpoint was inserted.
105 * - is_register: indicates if we are in register context.
106 * - Return 1 if the specified virtual address is in an
109 static bool valid_vma(struct vm_area_struct
*vma
, bool is_register
)
111 vm_flags_t flags
= VM_HUGETLB
| VM_MAYEXEC
| VM_SHARED
;
116 return vma
->vm_file
&& (vma
->vm_flags
& flags
) == VM_MAYEXEC
;
119 static unsigned long offset_to_vaddr(struct vm_area_struct
*vma
, loff_t offset
)
121 return vma
->vm_start
+ offset
- ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
);
124 static loff_t
vaddr_to_offset(struct vm_area_struct
*vma
, unsigned long vaddr
)
126 return ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
) + (vaddr
- vma
->vm_start
);
130 * __replace_page - replace page in vma by new page.
131 * based on replace_page in mm/ksm.c
133 * @vma: vma that holds the pte pointing to page
134 * @addr: address the old @page is mapped at
135 * @page: the cowed page we are replacing by kpage
136 * @kpage: the modified page we replace page by
138 * Returns 0 on success, -EFAULT on failure.
140 static int __replace_page(struct vm_area_struct
*vma
, unsigned long addr
,
141 struct page
*page
, struct page
*kpage
)
143 struct mm_struct
*mm
= vma
->vm_mm
;
147 /* For mmu_notifiers */
148 const unsigned long mmun_start
= addr
;
149 const unsigned long mmun_end
= addr
+ PAGE_SIZE
;
151 /* For try_to_free_swap() and munlock_vma_page() below */
154 mmu_notifier_invalidate_range_start(mm
, mmun_start
, mmun_end
);
156 ptep
= page_check_address(page
, mm
, addr
, &ptl
, 0);
161 page_add_new_anon_rmap(kpage
, vma
, addr
);
163 if (!PageAnon(page
)) {
164 dec_mm_counter(mm
, MM_FILEPAGES
);
165 inc_mm_counter(mm
, MM_ANONPAGES
);
168 flush_cache_page(vma
, addr
, pte_pfn(*ptep
));
169 ptep_clear_flush(vma
, addr
, ptep
);
170 set_pte_at_notify(mm
, addr
, ptep
, mk_pte(kpage
, vma
->vm_page_prot
));
172 page_remove_rmap(page
);
173 if (!page_mapped(page
))
174 try_to_free_swap(page
);
175 pte_unmap_unlock(ptep
, ptl
);
177 if (vma
->vm_flags
& VM_LOCKED
)
178 munlock_vma_page(page
);
183 mmu_notifier_invalidate_range_end(mm
, mmun_start
, mmun_end
);
189 * is_swbp_insn - check if instruction is breakpoint instruction.
190 * @insn: instruction to be checked.
191 * Default implementation of is_swbp_insn
192 * Returns true if @insn is a breakpoint instruction.
194 bool __weak
is_swbp_insn(uprobe_opcode_t
*insn
)
196 return *insn
== UPROBE_SWBP_INSN
;
199 static void copy_opcode(struct page
*page
, unsigned long vaddr
, uprobe_opcode_t
*opcode
)
201 void *kaddr
= kmap_atomic(page
);
202 memcpy(opcode
, kaddr
+ (vaddr
& ~PAGE_MASK
), UPROBE_SWBP_INSN_SIZE
);
203 kunmap_atomic(kaddr
);
206 static int verify_opcode(struct page
*page
, unsigned long vaddr
, uprobe_opcode_t
*new_opcode
)
208 uprobe_opcode_t old_opcode
;
211 copy_opcode(page
, vaddr
, &old_opcode
);
212 is_swbp
= is_swbp_insn(&old_opcode
);
214 if (is_swbp_insn(new_opcode
)) {
215 if (is_swbp
) /* register: already installed? */
218 if (!is_swbp
) /* unregister: was it changed by us? */
227 * Expect the breakpoint instruction to be the smallest size instruction for
228 * the architecture. If an arch has variable length instruction and the
229 * breakpoint instruction is not of the smallest length instruction
230 * supported by that architecture then we need to modify is_swbp_at_addr and
231 * write_opcode accordingly. This would never be a problem for archs that
232 * have fixed length instructions.
236 * write_opcode - write the opcode at a given virtual address.
237 * @mm: the probed process address space.
238 * @vaddr: the virtual address to store the opcode.
239 * @opcode: opcode to be written at @vaddr.
241 * Called with mm->mmap_sem held (for read and with a reference to
244 * For mm @mm, write the opcode at @vaddr.
245 * Return 0 (success) or a negative errno.
247 static int write_opcode(struct mm_struct
*mm
, unsigned long vaddr
,
248 uprobe_opcode_t opcode
)
250 struct page
*old_page
, *new_page
;
251 void *vaddr_old
, *vaddr_new
;
252 struct vm_area_struct
*vma
;
256 /* Read the page with vaddr into memory */
257 ret
= get_user_pages(NULL
, mm
, vaddr
, 1, 0, 1, &old_page
, &vma
);
261 ret
= verify_opcode(old_page
, vaddr
, &opcode
);
266 new_page
= alloc_page_vma(GFP_HIGHUSER_MOVABLE
, vma
, vaddr
);
270 __SetPageUptodate(new_page
);
272 /* copy the page now that we've got it stable */
273 vaddr_old
= kmap_atomic(old_page
);
274 vaddr_new
= kmap_atomic(new_page
);
276 memcpy(vaddr_new
, vaddr_old
, PAGE_SIZE
);
277 memcpy(vaddr_new
+ (vaddr
& ~PAGE_MASK
), &opcode
, UPROBE_SWBP_INSN_SIZE
);
279 kunmap_atomic(vaddr_new
);
280 kunmap_atomic(vaddr_old
);
282 ret
= anon_vma_prepare(vma
);
286 ret
= __replace_page(vma
, vaddr
, old_page
, new_page
);
289 page_cache_release(new_page
);
293 if (unlikely(ret
== -EAGAIN
))
299 * set_swbp - store breakpoint at a given address.
300 * @auprobe: arch specific probepoint information.
301 * @mm: the probed process address space.
302 * @vaddr: the virtual address to insert the opcode.
304 * For mm @mm, store the breakpoint instruction at @vaddr.
305 * Return 0 (success) or a negative errno.
307 int __weak
set_swbp(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
309 return write_opcode(mm
, vaddr
, UPROBE_SWBP_INSN
);
313 * set_orig_insn - Restore the original instruction.
314 * @mm: the probed process address space.
315 * @auprobe: arch specific probepoint information.
316 * @vaddr: the virtual address to insert the opcode.
318 * For mm @mm, restore the original opcode (opcode) at @vaddr.
319 * Return 0 (success) or a negative errno.
322 set_orig_insn(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
324 return write_opcode(mm
, vaddr
, *(uprobe_opcode_t
*)auprobe
->insn
);
327 static int match_uprobe(struct uprobe
*l
, struct uprobe
*r
)
329 if (l
->inode
< r
->inode
)
332 if (l
->inode
> r
->inode
)
335 if (l
->offset
< r
->offset
)
338 if (l
->offset
> r
->offset
)
344 static struct uprobe
*__find_uprobe(struct inode
*inode
, loff_t offset
)
346 struct uprobe u
= { .inode
= inode
, .offset
= offset
};
347 struct rb_node
*n
= uprobes_tree
.rb_node
;
348 struct uprobe
*uprobe
;
352 uprobe
= rb_entry(n
, struct uprobe
, rb_node
);
353 match
= match_uprobe(&u
, uprobe
);
355 atomic_inc(&uprobe
->ref
);
368 * Find a uprobe corresponding to a given inode:offset
369 * Acquires uprobes_treelock
371 static struct uprobe
*find_uprobe(struct inode
*inode
, loff_t offset
)
373 struct uprobe
*uprobe
;
375 spin_lock(&uprobes_treelock
);
376 uprobe
= __find_uprobe(inode
, offset
);
377 spin_unlock(&uprobes_treelock
);
382 static struct uprobe
*__insert_uprobe(struct uprobe
*uprobe
)
384 struct rb_node
**p
= &uprobes_tree
.rb_node
;
385 struct rb_node
*parent
= NULL
;
391 u
= rb_entry(parent
, struct uprobe
, rb_node
);
392 match
= match_uprobe(uprobe
, u
);
399 p
= &parent
->rb_left
;
401 p
= &parent
->rb_right
;
406 rb_link_node(&uprobe
->rb_node
, parent
, p
);
407 rb_insert_color(&uprobe
->rb_node
, &uprobes_tree
);
408 /* get access + creation ref */
409 atomic_set(&uprobe
->ref
, 2);
415 * Acquire uprobes_treelock.
416 * Matching uprobe already exists in rbtree;
417 * increment (access refcount) and return the matching uprobe.
419 * No matching uprobe; insert the uprobe in rb_tree;
420 * get a double refcount (access + creation) and return NULL.
422 static struct uprobe
*insert_uprobe(struct uprobe
*uprobe
)
426 spin_lock(&uprobes_treelock
);
427 u
= __insert_uprobe(uprobe
);
428 spin_unlock(&uprobes_treelock
);
430 /* For now assume that the instruction need not be single-stepped */
431 __set_bit(UPROBE_SKIP_SSTEP
, &uprobe
->flags
);
436 static void put_uprobe(struct uprobe
*uprobe
)
438 if (atomic_dec_and_test(&uprobe
->ref
))
442 static struct uprobe
*alloc_uprobe(struct inode
*inode
, loff_t offset
)
444 struct uprobe
*uprobe
, *cur_uprobe
;
446 uprobe
= kzalloc(sizeof(struct uprobe
), GFP_KERNEL
);
450 uprobe
->inode
= igrab(inode
);
451 uprobe
->offset
= offset
;
452 init_rwsem(&uprobe
->consumer_rwsem
);
453 mutex_init(&uprobe
->copy_mutex
);
455 /* add to uprobes_tree, sorted on inode:offset */
456 cur_uprobe
= insert_uprobe(uprobe
);
458 /* a uprobe exists for this inode:offset combination */
464 atomic_inc(&uprobe_events
);
470 static void handler_chain(struct uprobe
*uprobe
, struct pt_regs
*regs
)
472 struct uprobe_consumer
*uc
;
474 if (!test_bit(UPROBE_RUN_HANDLER
, &uprobe
->flags
))
477 down_read(&uprobe
->consumer_rwsem
);
478 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
479 if (!uc
->filter
|| uc
->filter(uc
, current
))
480 uc
->handler(uc
, regs
);
482 up_read(&uprobe
->consumer_rwsem
);
485 /* Returns the previous consumer */
486 static struct uprobe_consumer
*
487 consumer_add(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
489 down_write(&uprobe
->consumer_rwsem
);
490 uc
->next
= uprobe
->consumers
;
491 uprobe
->consumers
= uc
;
492 up_write(&uprobe
->consumer_rwsem
);
498 * For uprobe @uprobe, delete the consumer @uc.
499 * Return true if the @uc is deleted successfully
502 static bool consumer_del(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
504 struct uprobe_consumer
**con
;
507 down_write(&uprobe
->consumer_rwsem
);
508 for (con
= &uprobe
->consumers
; *con
; con
= &(*con
)->next
) {
515 up_write(&uprobe
->consumer_rwsem
);
521 __copy_insn(struct address_space
*mapping
, struct file
*filp
, char *insn
,
522 unsigned long nbytes
, loff_t offset
)
532 if (!mapping
->a_ops
->readpage
)
535 idx
= offset
>> PAGE_CACHE_SHIFT
;
536 off
= offset
& ~PAGE_MASK
;
539 * Ensure that the page that has the original instruction is
540 * populated and in page-cache.
542 page
= read_mapping_page(mapping
, idx
, filp
);
544 return PTR_ERR(page
);
546 vaddr
= kmap_atomic(page
);
547 memcpy(insn
, vaddr
+ off
, nbytes
);
548 kunmap_atomic(vaddr
);
549 page_cache_release(page
);
554 static int copy_insn(struct uprobe
*uprobe
, struct file
*filp
)
556 struct address_space
*mapping
;
557 unsigned long nbytes
;
560 nbytes
= PAGE_SIZE
- (uprobe
->offset
& ~PAGE_MASK
);
561 mapping
= uprobe
->inode
->i_mapping
;
563 /* Instruction at end of binary; copy only available bytes */
564 if (uprobe
->offset
+ MAX_UINSN_BYTES
> uprobe
->inode
->i_size
)
565 bytes
= uprobe
->inode
->i_size
- uprobe
->offset
;
567 bytes
= MAX_UINSN_BYTES
;
569 /* Instruction at the page-boundary; copy bytes in second page */
570 if (nbytes
< bytes
) {
571 int err
= __copy_insn(mapping
, filp
, uprobe
->arch
.insn
+ nbytes
,
572 bytes
- nbytes
, uprobe
->offset
+ nbytes
);
577 return __copy_insn(mapping
, filp
, uprobe
->arch
.insn
, bytes
, uprobe
->offset
);
580 static int prepare_uprobe(struct uprobe
*uprobe
, struct file
*file
,
581 struct mm_struct
*mm
, unsigned long vaddr
)
585 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
588 mutex_lock(&uprobe
->copy_mutex
);
589 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
592 ret
= copy_insn(uprobe
, file
);
597 if (is_swbp_insn((uprobe_opcode_t
*)uprobe
->arch
.insn
))
600 ret
= arch_uprobe_analyze_insn(&uprobe
->arch
, mm
, vaddr
);
604 /* write_opcode() assumes we don't cross page boundary */
605 BUG_ON((uprobe
->offset
& ~PAGE_MASK
) +
606 UPROBE_SWBP_INSN_SIZE
> PAGE_SIZE
);
608 smp_wmb(); /* pairs with rmb() in find_active_uprobe() */
609 set_bit(UPROBE_COPY_INSN
, &uprobe
->flags
);
612 mutex_unlock(&uprobe
->copy_mutex
);
618 install_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
,
619 struct vm_area_struct
*vma
, unsigned long vaddr
)
625 * If probe is being deleted, unregister thread could be done with
626 * the vma-rmap-walk through. Adding a probe now can be fatal since
627 * nobody will be able to cleanup. Also we could be from fork or
628 * mremap path, where the probe might have already been inserted.
629 * Hence behave as if probe already existed.
631 if (!uprobe
->consumers
)
634 ret
= prepare_uprobe(uprobe
, vma
->vm_file
, mm
, vaddr
);
639 * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
640 * the task can hit this breakpoint right after __replace_page().
642 first_uprobe
= !test_bit(MMF_HAS_UPROBES
, &mm
->flags
);
644 set_bit(MMF_HAS_UPROBES
, &mm
->flags
);
646 ret
= set_swbp(&uprobe
->arch
, mm
, vaddr
);
648 clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
649 else if (first_uprobe
)
650 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
656 remove_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
658 /* can happen if uprobe_register() fails */
659 if (!test_bit(MMF_HAS_UPROBES
, &mm
->flags
))
662 set_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
663 return set_orig_insn(&uprobe
->arch
, mm
, vaddr
);
667 * There could be threads that have already hit the breakpoint. They
668 * will recheck the current insn and restart if find_uprobe() fails.
669 * See find_active_uprobe().
671 static void delete_uprobe(struct uprobe
*uprobe
)
673 spin_lock(&uprobes_treelock
);
674 rb_erase(&uprobe
->rb_node
, &uprobes_tree
);
675 spin_unlock(&uprobes_treelock
);
678 atomic_dec(&uprobe_events
);
682 struct map_info
*next
;
683 struct mm_struct
*mm
;
687 static inline struct map_info
*free_map_info(struct map_info
*info
)
689 struct map_info
*next
= info
->next
;
694 static struct map_info
*
695 build_map_info(struct address_space
*mapping
, loff_t offset
, bool is_register
)
697 unsigned long pgoff
= offset
>> PAGE_SHIFT
;
698 struct vm_area_struct
*vma
;
699 struct map_info
*curr
= NULL
;
700 struct map_info
*prev
= NULL
;
701 struct map_info
*info
;
705 mutex_lock(&mapping
->i_mmap_mutex
);
706 vma_interval_tree_foreach(vma
, &mapping
->i_mmap
, pgoff
, pgoff
) {
707 if (!valid_vma(vma
, is_register
))
710 if (!prev
&& !more
) {
712 * Needs GFP_NOWAIT to avoid i_mmap_mutex recursion through
713 * reclaim. This is optimistic, no harm done if it fails.
715 prev
= kmalloc(sizeof(struct map_info
),
716 GFP_NOWAIT
| __GFP_NOMEMALLOC
| __GFP_NOWARN
);
725 if (!atomic_inc_not_zero(&vma
->vm_mm
->mm_users
))
733 info
->mm
= vma
->vm_mm
;
734 info
->vaddr
= offset_to_vaddr(vma
, offset
);
736 mutex_unlock(&mapping
->i_mmap_mutex
);
748 info
= kmalloc(sizeof(struct map_info
), GFP_KERNEL
);
750 curr
= ERR_PTR(-ENOMEM
);
760 prev
= free_map_info(prev
);
764 static int register_for_each_vma(struct uprobe
*uprobe
, bool is_register
)
766 struct map_info
*info
;
769 info
= build_map_info(uprobe
->inode
->i_mapping
,
770 uprobe
->offset
, is_register
);
772 return PTR_ERR(info
);
775 struct mm_struct
*mm
= info
->mm
;
776 struct vm_area_struct
*vma
;
778 if (err
&& is_register
)
781 down_write(&mm
->mmap_sem
);
782 vma
= find_vma(mm
, info
->vaddr
);
783 if (!vma
|| !valid_vma(vma
, is_register
) ||
784 vma
->vm_file
->f_mapping
->host
!= uprobe
->inode
)
787 if (vma
->vm_start
> info
->vaddr
||
788 vaddr_to_offset(vma
, info
->vaddr
) != uprobe
->offset
)
792 err
= install_breakpoint(uprobe
, mm
, vma
, info
->vaddr
);
794 err
|= remove_breakpoint(uprobe
, mm
, info
->vaddr
);
797 up_write(&mm
->mmap_sem
);
800 info
= free_map_info(info
);
806 static int __uprobe_register(struct uprobe
*uprobe
)
808 return register_for_each_vma(uprobe
, true);
811 static void __uprobe_unregister(struct uprobe
*uprobe
)
813 if (!register_for_each_vma(uprobe
, false))
814 delete_uprobe(uprobe
);
816 /* TODO : cant unregister? schedule a worker thread */
820 * uprobe_register - register a probe
821 * @inode: the file in which the probe has to be placed.
822 * @offset: offset from the start of the file.
823 * @uc: information on howto handle the probe..
825 * Apart from the access refcount, uprobe_register() takes a creation
826 * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
827 * inserted into the rbtree (i.e first consumer for a @inode:@offset
828 * tuple). Creation refcount stops uprobe_unregister from freeing the
829 * @uprobe even before the register operation is complete. Creation
830 * refcount is released when the last @uc for the @uprobe
833 * Return errno if it cannot successully install probes
834 * else return 0 (success)
836 int uprobe_register(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
838 struct uprobe
*uprobe
;
841 if (!inode
|| !uc
|| uc
->next
)
844 if (offset
> i_size_read(inode
))
848 mutex_lock(uprobes_hash(inode
));
849 uprobe
= alloc_uprobe(inode
, offset
);
853 } else if (!consumer_add(uprobe
, uc
)) {
854 ret
= __uprobe_register(uprobe
);
856 uprobe
->consumers
= NULL
;
857 __uprobe_unregister(uprobe
);
859 set_bit(UPROBE_RUN_HANDLER
, &uprobe
->flags
);
863 mutex_unlock(uprobes_hash(inode
));
871 * uprobe_unregister - unregister a already registered probe.
872 * @inode: the file in which the probe has to be removed.
873 * @offset: offset from the start of the file.
874 * @uc: identify which probe if multiple probes are colocated.
876 void uprobe_unregister(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
878 struct uprobe
*uprobe
;
883 uprobe
= find_uprobe(inode
, offset
);
887 mutex_lock(uprobes_hash(inode
));
889 if (consumer_del(uprobe
, uc
)) {
890 if (!uprobe
->consumers
) {
891 __uprobe_unregister(uprobe
);
892 clear_bit(UPROBE_RUN_HANDLER
, &uprobe
->flags
);
896 mutex_unlock(uprobes_hash(inode
));
901 static struct rb_node
*
902 find_node_in_range(struct inode
*inode
, loff_t min
, loff_t max
)
904 struct rb_node
*n
= uprobes_tree
.rb_node
;
907 struct uprobe
*u
= rb_entry(n
, struct uprobe
, rb_node
);
909 if (inode
< u
->inode
) {
911 } else if (inode
> u
->inode
) {
916 else if (min
> u
->offset
)
927 * For a given range in vma, build a list of probes that need to be inserted.
929 static void build_probe_list(struct inode
*inode
,
930 struct vm_area_struct
*vma
,
931 unsigned long start
, unsigned long end
,
932 struct list_head
*head
)
935 struct rb_node
*n
, *t
;
938 INIT_LIST_HEAD(head
);
939 min
= vaddr_to_offset(vma
, start
);
940 max
= min
+ (end
- start
) - 1;
942 spin_lock(&uprobes_treelock
);
943 n
= find_node_in_range(inode
, min
, max
);
945 for (t
= n
; t
; t
= rb_prev(t
)) {
946 u
= rb_entry(t
, struct uprobe
, rb_node
);
947 if (u
->inode
!= inode
|| u
->offset
< min
)
949 list_add(&u
->pending_list
, head
);
952 for (t
= n
; (t
= rb_next(t
)); ) {
953 u
= rb_entry(t
, struct uprobe
, rb_node
);
954 if (u
->inode
!= inode
|| u
->offset
> max
)
956 list_add(&u
->pending_list
, head
);
960 spin_unlock(&uprobes_treelock
);
964 * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
966 * Currently we ignore all errors and always return 0, the callers
967 * can't handle the failure anyway.
969 int uprobe_mmap(struct vm_area_struct
*vma
)
971 struct list_head tmp_list
;
972 struct uprobe
*uprobe
, *u
;
975 if (!atomic_read(&uprobe_events
) || !valid_vma(vma
, true))
978 inode
= vma
->vm_file
->f_mapping
->host
;
982 mutex_lock(uprobes_mmap_hash(inode
));
983 build_probe_list(inode
, vma
, vma
->vm_start
, vma
->vm_end
, &tmp_list
);
985 list_for_each_entry_safe(uprobe
, u
, &tmp_list
, pending_list
) {
986 if (!fatal_signal_pending(current
)) {
987 unsigned long vaddr
= offset_to_vaddr(vma
, uprobe
->offset
);
988 install_breakpoint(uprobe
, vma
->vm_mm
, vma
, vaddr
);
992 mutex_unlock(uprobes_mmap_hash(inode
));
998 vma_has_uprobes(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1001 struct inode
*inode
;
1004 inode
= vma
->vm_file
->f_mapping
->host
;
1006 min
= vaddr_to_offset(vma
, start
);
1007 max
= min
+ (end
- start
) - 1;
1009 spin_lock(&uprobes_treelock
);
1010 n
= find_node_in_range(inode
, min
, max
);
1011 spin_unlock(&uprobes_treelock
);
1017 * Called in context of a munmap of a vma.
1019 void uprobe_munmap(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1021 if (!atomic_read(&uprobe_events
) || !valid_vma(vma
, false))
1024 if (!atomic_read(&vma
->vm_mm
->mm_users
)) /* called by mmput() ? */
1027 if (!test_bit(MMF_HAS_UPROBES
, &vma
->vm_mm
->flags
) ||
1028 test_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
))
1031 if (vma_has_uprobes(vma
, start
, end
))
1032 set_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
);
1035 /* Slot allocation for XOL */
1036 static int xol_add_vma(struct xol_area
*area
)
1038 struct mm_struct
*mm
;
1041 area
->page
= alloc_page(GFP_HIGHUSER
);
1048 down_write(&mm
->mmap_sem
);
1049 if (mm
->uprobes_state
.xol_area
)
1054 /* Try to map as high as possible, this is only a hint. */
1055 area
->vaddr
= get_unmapped_area(NULL
, TASK_SIZE
- PAGE_SIZE
, PAGE_SIZE
, 0, 0);
1056 if (area
->vaddr
& ~PAGE_MASK
) {
1061 ret
= install_special_mapping(mm
, area
->vaddr
, PAGE_SIZE
,
1062 VM_EXEC
|VM_MAYEXEC
|VM_DONTCOPY
|VM_IO
, &area
->page
);
1066 smp_wmb(); /* pairs with get_xol_area() */
1067 mm
->uprobes_state
.xol_area
= area
;
1071 up_write(&mm
->mmap_sem
);
1073 __free_page(area
->page
);
1078 static struct xol_area
*get_xol_area(struct mm_struct
*mm
)
1080 struct xol_area
*area
;
1082 area
= mm
->uprobes_state
.xol_area
;
1083 smp_read_barrier_depends(); /* pairs with wmb in xol_add_vma() */
1089 * xol_alloc_area - Allocate process's xol_area.
1090 * This area will be used for storing instructions for execution out of
1093 * Returns the allocated area or NULL.
1095 static struct xol_area
*xol_alloc_area(void)
1097 struct xol_area
*area
;
1099 area
= kzalloc(sizeof(*area
), GFP_KERNEL
);
1100 if (unlikely(!area
))
1103 area
->bitmap
= kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE
) * sizeof(long), GFP_KERNEL
);
1108 init_waitqueue_head(&area
->wq
);
1109 if (!xol_add_vma(area
))
1113 kfree(area
->bitmap
);
1116 return get_xol_area(current
->mm
);
1120 * uprobe_clear_state - Free the area allocated for slots.
1122 void uprobe_clear_state(struct mm_struct
*mm
)
1124 struct xol_area
*area
= mm
->uprobes_state
.xol_area
;
1129 put_page(area
->page
);
1130 kfree(area
->bitmap
);
1134 void uprobe_dup_mmap(struct mm_struct
*oldmm
, struct mm_struct
*newmm
)
1136 newmm
->uprobes_state
.xol_area
= NULL
;
1138 if (test_bit(MMF_HAS_UPROBES
, &oldmm
->flags
)) {
1139 set_bit(MMF_HAS_UPROBES
, &newmm
->flags
);
1140 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1141 set_bit(MMF_RECALC_UPROBES
, &newmm
->flags
);
1146 * - search for a free slot.
1148 static unsigned long xol_take_insn_slot(struct xol_area
*area
)
1150 unsigned long slot_addr
;
1154 slot_nr
= find_first_zero_bit(area
->bitmap
, UINSNS_PER_PAGE
);
1155 if (slot_nr
< UINSNS_PER_PAGE
) {
1156 if (!test_and_set_bit(slot_nr
, area
->bitmap
))
1159 slot_nr
= UINSNS_PER_PAGE
;
1162 wait_event(area
->wq
, (atomic_read(&area
->slot_count
) < UINSNS_PER_PAGE
));
1163 } while (slot_nr
>= UINSNS_PER_PAGE
);
1165 slot_addr
= area
->vaddr
+ (slot_nr
* UPROBE_XOL_SLOT_BYTES
);
1166 atomic_inc(&area
->slot_count
);
1172 * xol_get_insn_slot - If was not allocated a slot, then
1174 * Returns the allocated slot address or 0.
1176 static unsigned long xol_get_insn_slot(struct uprobe
*uprobe
, unsigned long slot_addr
)
1178 struct xol_area
*area
;
1179 unsigned long offset
;
1182 area
= get_xol_area(current
->mm
);
1184 area
= xol_alloc_area();
1188 current
->utask
->xol_vaddr
= xol_take_insn_slot(area
);
1191 * Initialize the slot if xol_vaddr points to valid
1194 if (unlikely(!current
->utask
->xol_vaddr
))
1197 current
->utask
->vaddr
= slot_addr
;
1198 offset
= current
->utask
->xol_vaddr
& ~PAGE_MASK
;
1199 vaddr
= kmap_atomic(area
->page
);
1200 memcpy(vaddr
+ offset
, uprobe
->arch
.insn
, MAX_UINSN_BYTES
);
1201 kunmap_atomic(vaddr
);
1203 return current
->utask
->xol_vaddr
;
1207 * xol_free_insn_slot - If slot was earlier allocated by
1208 * @xol_get_insn_slot(), make the slot available for
1209 * subsequent requests.
1211 static void xol_free_insn_slot(struct task_struct
*tsk
)
1213 struct xol_area
*area
;
1214 unsigned long vma_end
;
1215 unsigned long slot_addr
;
1217 if (!tsk
->mm
|| !tsk
->mm
->uprobes_state
.xol_area
|| !tsk
->utask
)
1220 slot_addr
= tsk
->utask
->xol_vaddr
;
1222 if (unlikely(!slot_addr
|| IS_ERR_VALUE(slot_addr
)))
1225 area
= tsk
->mm
->uprobes_state
.xol_area
;
1226 vma_end
= area
->vaddr
+ PAGE_SIZE
;
1227 if (area
->vaddr
<= slot_addr
&& slot_addr
< vma_end
) {
1228 unsigned long offset
;
1231 offset
= slot_addr
- area
->vaddr
;
1232 slot_nr
= offset
/ UPROBE_XOL_SLOT_BYTES
;
1233 if (slot_nr
>= UINSNS_PER_PAGE
)
1236 clear_bit(slot_nr
, area
->bitmap
);
1237 atomic_dec(&area
->slot_count
);
1238 if (waitqueue_active(&area
->wq
))
1241 tsk
->utask
->xol_vaddr
= 0;
1246 * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1247 * @regs: Reflects the saved state of the task after it has hit a breakpoint
1249 * Return the address of the breakpoint instruction.
1251 unsigned long __weak
uprobe_get_swbp_addr(struct pt_regs
*regs
)
1253 return instruction_pointer(regs
) - UPROBE_SWBP_INSN_SIZE
;
1257 * Called with no locks held.
1258 * Called in context of a exiting or a exec-ing thread.
1260 void uprobe_free_utask(struct task_struct
*t
)
1262 struct uprobe_task
*utask
= t
->utask
;
1267 if (utask
->active_uprobe
)
1268 put_uprobe(utask
->active_uprobe
);
1270 xol_free_insn_slot(t
);
1276 * Called in context of a new clone/fork from copy_process.
1278 void uprobe_copy_process(struct task_struct
*t
)
1284 * Allocate a uprobe_task object for the task.
1285 * Called when the thread hits a breakpoint for the first time.
1288 * - pointer to new uprobe_task on success
1291 static struct uprobe_task
*add_utask(void)
1293 struct uprobe_task
*utask
;
1295 utask
= kzalloc(sizeof *utask
, GFP_KERNEL
);
1296 if (unlikely(!utask
))
1299 current
->utask
= utask
;
1303 /* Prepare to single-step probed instruction out of line. */
1305 pre_ssout(struct uprobe
*uprobe
, struct pt_regs
*regs
, unsigned long vaddr
)
1307 if (xol_get_insn_slot(uprobe
, vaddr
) && !arch_uprobe_pre_xol(&uprobe
->arch
, regs
))
1314 * If we are singlestepping, then ensure this thread is not connected to
1315 * non-fatal signals until completion of singlestep. When xol insn itself
1316 * triggers the signal, restart the original insn even if the task is
1317 * already SIGKILL'ed (since coredump should report the correct ip). This
1318 * is even more important if the task has a handler for SIGSEGV/etc, The
1319 * _same_ instruction should be repeated again after return from the signal
1320 * handler, and SSTEP can never finish in this case.
1322 bool uprobe_deny_signal(void)
1324 struct task_struct
*t
= current
;
1325 struct uprobe_task
*utask
= t
->utask
;
1327 if (likely(!utask
|| !utask
->active_uprobe
))
1330 WARN_ON_ONCE(utask
->state
!= UTASK_SSTEP
);
1332 if (signal_pending(t
)) {
1333 spin_lock_irq(&t
->sighand
->siglock
);
1334 clear_tsk_thread_flag(t
, TIF_SIGPENDING
);
1335 spin_unlock_irq(&t
->sighand
->siglock
);
1337 if (__fatal_signal_pending(t
) || arch_uprobe_xol_was_trapped(t
)) {
1338 utask
->state
= UTASK_SSTEP_TRAPPED
;
1339 set_tsk_thread_flag(t
, TIF_UPROBE
);
1340 set_tsk_thread_flag(t
, TIF_NOTIFY_RESUME
);
1348 * Avoid singlestepping the original instruction if the original instruction
1349 * is a NOP or can be emulated.
1351 static bool can_skip_sstep(struct uprobe
*uprobe
, struct pt_regs
*regs
)
1353 if (test_bit(UPROBE_SKIP_SSTEP
, &uprobe
->flags
)) {
1354 if (arch_uprobe_skip_sstep(&uprobe
->arch
, regs
))
1356 clear_bit(UPROBE_SKIP_SSTEP
, &uprobe
->flags
);
1361 static void mmf_recalc_uprobes(struct mm_struct
*mm
)
1363 struct vm_area_struct
*vma
;
1365 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
1366 if (!valid_vma(vma
, false))
1369 * This is not strictly accurate, we can race with
1370 * uprobe_unregister() and see the already removed
1371 * uprobe if delete_uprobe() was not yet called.
1373 if (vma_has_uprobes(vma
, vma
->vm_start
, vma
->vm_end
))
1377 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
1380 static int is_swbp_at_addr(struct mm_struct
*mm
, unsigned long vaddr
)
1383 uprobe_opcode_t opcode
;
1386 pagefault_disable();
1387 result
= __copy_from_user_inatomic(&opcode
, (void __user
*)vaddr
,
1391 if (likely(result
== 0))
1394 result
= get_user_pages(NULL
, mm
, vaddr
, 1, 0, 1, &page
, NULL
);
1398 copy_opcode(page
, vaddr
, &opcode
);
1401 return is_swbp_insn(&opcode
);
1404 static struct uprobe
*find_active_uprobe(unsigned long bp_vaddr
, int *is_swbp
)
1406 struct mm_struct
*mm
= current
->mm
;
1407 struct uprobe
*uprobe
= NULL
;
1408 struct vm_area_struct
*vma
;
1410 down_read(&mm
->mmap_sem
);
1411 vma
= find_vma(mm
, bp_vaddr
);
1412 if (vma
&& vma
->vm_start
<= bp_vaddr
) {
1413 if (valid_vma(vma
, false)) {
1414 struct inode
*inode
= vma
->vm_file
->f_mapping
->host
;
1415 loff_t offset
= vaddr_to_offset(vma
, bp_vaddr
);
1417 uprobe
= find_uprobe(inode
, offset
);
1421 *is_swbp
= is_swbp_at_addr(mm
, bp_vaddr
);
1426 if (!uprobe
&& test_and_clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
))
1427 mmf_recalc_uprobes(mm
);
1428 up_read(&mm
->mmap_sem
);
1433 void __weak
arch_uprobe_enable_step(struct arch_uprobe
*arch
)
1435 user_enable_single_step(current
);
1438 void __weak
arch_uprobe_disable_step(struct arch_uprobe
*arch
)
1440 user_disable_single_step(current
);
1444 * Run handler and ask thread to singlestep.
1445 * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1447 static void handle_swbp(struct pt_regs
*regs
)
1449 struct uprobe_task
*utask
;
1450 struct uprobe
*uprobe
;
1451 unsigned long bp_vaddr
;
1452 int uninitialized_var(is_swbp
);
1454 bp_vaddr
= uprobe_get_swbp_addr(regs
);
1455 uprobe
= find_active_uprobe(bp_vaddr
, &is_swbp
);
1459 /* No matching uprobe; signal SIGTRAP. */
1460 send_sig(SIGTRAP
, current
, 0);
1463 * Either we raced with uprobe_unregister() or we can't
1464 * access this memory. The latter is only possible if
1465 * another thread plays with our ->mm. In both cases
1466 * we can simply restart. If this vma was unmapped we
1467 * can pretend this insn was not executed yet and get
1468 * the (correct) SIGSEGV after restart.
1470 instruction_pointer_set(regs
, bp_vaddr
);
1475 * TODO: move copy_insn/etc into _register and remove this hack.
1476 * After we hit the bp, _unregister + _register can install the
1477 * new and not-yet-analyzed uprobe at the same address, restart.
1479 smp_rmb(); /* pairs with wmb() in install_breakpoint() */
1480 if (unlikely(!test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
)))
1483 utask
= current
->utask
;
1485 utask
= add_utask();
1486 /* Cannot allocate; re-execute the instruction. */
1491 handler_chain(uprobe
, regs
);
1492 if (can_skip_sstep(uprobe
, regs
))
1495 if (!pre_ssout(uprobe
, regs
, bp_vaddr
)) {
1496 arch_uprobe_enable_step(&uprobe
->arch
);
1497 utask
->active_uprobe
= uprobe
;
1498 utask
->state
= UTASK_SSTEP
;
1504 * cannot singlestep; cannot skip instruction;
1505 * re-execute the instruction.
1507 instruction_pointer_set(regs
, bp_vaddr
);
1513 * Perform required fix-ups and disable singlestep.
1514 * Allow pending signals to take effect.
1516 static void handle_singlestep(struct uprobe_task
*utask
, struct pt_regs
*regs
)
1518 struct uprobe
*uprobe
;
1520 uprobe
= utask
->active_uprobe
;
1521 if (utask
->state
== UTASK_SSTEP_ACK
)
1522 arch_uprobe_post_xol(&uprobe
->arch
, regs
);
1523 else if (utask
->state
== UTASK_SSTEP_TRAPPED
)
1524 arch_uprobe_abort_xol(&uprobe
->arch
, regs
);
1528 arch_uprobe_disable_step(&uprobe
->arch
);
1530 utask
->active_uprobe
= NULL
;
1531 utask
->state
= UTASK_RUNNING
;
1532 xol_free_insn_slot(current
);
1534 spin_lock_irq(¤t
->sighand
->siglock
);
1535 recalc_sigpending(); /* see uprobe_deny_signal() */
1536 spin_unlock_irq(¤t
->sighand
->siglock
);
1540 * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1541 * allows the thread to return from interrupt. After that handle_swbp()
1542 * sets utask->active_uprobe.
1544 * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1545 * and allows the thread to return from interrupt.
1547 * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1548 * uprobe_notify_resume().
1550 void uprobe_notify_resume(struct pt_regs
*regs
)
1552 struct uprobe_task
*utask
;
1554 clear_thread_flag(TIF_UPROBE
);
1556 utask
= current
->utask
;
1557 if (utask
&& utask
->active_uprobe
)
1558 handle_singlestep(utask
, regs
);
1564 * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1565 * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1567 int uprobe_pre_sstep_notifier(struct pt_regs
*regs
)
1569 if (!current
->mm
|| !test_bit(MMF_HAS_UPROBES
, ¤t
->mm
->flags
))
1572 set_thread_flag(TIF_UPROBE
);
1577 * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
1578 * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
1580 int uprobe_post_sstep_notifier(struct pt_regs
*regs
)
1582 struct uprobe_task
*utask
= current
->utask
;
1584 if (!current
->mm
|| !utask
|| !utask
->active_uprobe
)
1585 /* task is currently not uprobed */
1588 utask
->state
= UTASK_SSTEP_ACK
;
1589 set_thread_flag(TIF_UPROBE
);
1593 static struct notifier_block uprobe_exception_nb
= {
1594 .notifier_call
= arch_uprobe_exception_notify
,
1595 .priority
= INT_MAX
-1, /* notified after kprobes, kgdb */
1598 static int __init
init_uprobes(void)
1602 for (i
= 0; i
< UPROBES_HASH_SZ
; i
++) {
1603 mutex_init(&uprobes_mutex
[i
]);
1604 mutex_init(&uprobes_mmap_mutex
[i
]);
1607 return register_die_notifier(&uprobe_exception_nb
);
1609 module_init(init_uprobes
);
1611 static void __exit
exit_uprobes(void)
1614 module_exit(exit_uprobes
);