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
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/sched/mm.h>
31 #include <linux/sched/coredump.h>
32 #include <linux/export.h>
33 #include <linux/rmap.h> /* anon_vma_prepare */
34 #include <linux/mmu_notifier.h> /* set_pte_at_notify */
35 #include <linux/swap.h> /* try_to_free_swap */
36 #include <linux/ptrace.h> /* user_enable_single_step */
37 #include <linux/kdebug.h> /* notifier mechanism */
38 #include "../../mm/internal.h" /* munlock_vma_page */
39 #include <linux/percpu-rwsem.h>
40 #include <linux/task_work.h>
41 #include <linux/shmem_fs.h>
43 #include <linux/uprobes.h>
45 #define UINSNS_PER_PAGE (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
46 #define MAX_UPROBE_XOL_SLOTS UINSNS_PER_PAGE
48 static struct rb_root uprobes_tree
= RB_ROOT
;
50 * allows us to skip the uprobe_mmap if there are no uprobe events active
51 * at this time. Probably a fine grained per inode count is better?
53 #define no_uprobe_events() RB_EMPTY_ROOT(&uprobes_tree)
55 static DEFINE_SPINLOCK(uprobes_treelock
); /* serialize rbtree access */
57 #define UPROBES_HASH_SZ 13
58 /* serialize uprobe->pending_list */
59 static struct mutex uprobes_mmap_mutex
[UPROBES_HASH_SZ
];
60 #define uprobes_mmap_hash(v) (&uprobes_mmap_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
62 static struct percpu_rw_semaphore dup_mmap_sem
;
64 /* Have a copy of original instruction */
65 #define UPROBE_COPY_INSN 0
68 struct rb_node rb_node
; /* node in the rb tree */
70 struct rw_semaphore register_rwsem
;
71 struct rw_semaphore consumer_rwsem
;
72 struct list_head pending_list
;
73 struct uprobe_consumer
*consumers
;
74 struct inode
*inode
; /* Also hold a ref to inode */
79 * The generic code assumes that it has two members of unknown type
80 * owned by the arch-specific code:
82 * insn - copy_insn() saves the original instruction here for
83 * arch_uprobe_analyze_insn().
85 * ixol - potentially modified instruction to execute out of
86 * line, copied to xol_area by xol_get_insn_slot().
88 struct arch_uprobe arch
;
92 * Execute out of line area: anonymous executable mapping installed
93 * by the probed task to execute the copy of the original instruction
94 * mangled by set_swbp().
96 * On a breakpoint hit, thread contests for a slot. It frees the
97 * slot after singlestep. Currently a fixed number of slots are
101 wait_queue_head_t wq
; /* if all slots are busy */
102 atomic_t slot_count
; /* number of in-use slots */
103 unsigned long *bitmap
; /* 0 = free slot */
105 struct vm_special_mapping xol_mapping
;
106 struct page
*pages
[2];
108 * We keep the vma's vm_start rather than a pointer to the vma
109 * itself. The probed process or a naughty kernel module could make
110 * the vma go away, and we must handle that reasonably gracefully.
112 unsigned long vaddr
; /* Page(s) of instruction slots */
116 * valid_vma: Verify if the specified vma is an executable vma
117 * Relax restrictions while unregistering: vm_flags might have
118 * changed after breakpoint was inserted.
119 * - is_register: indicates if we are in register context.
120 * - Return 1 if the specified virtual address is in an
123 static bool valid_vma(struct vm_area_struct
*vma
, bool is_register
)
125 vm_flags_t flags
= VM_HUGETLB
| VM_MAYEXEC
| VM_MAYSHARE
;
130 return vma
->vm_file
&& (vma
->vm_flags
& flags
) == VM_MAYEXEC
;
133 static unsigned long offset_to_vaddr(struct vm_area_struct
*vma
, loff_t offset
)
135 return vma
->vm_start
+ offset
- ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
);
138 static loff_t
vaddr_to_offset(struct vm_area_struct
*vma
, unsigned long vaddr
)
140 return ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
) + (vaddr
- vma
->vm_start
);
144 * __replace_page - replace page in vma by new page.
145 * based on replace_page in mm/ksm.c
147 * @vma: vma that holds the pte pointing to page
148 * @addr: address the old @page is mapped at
149 * @page: the cowed page we are replacing by kpage
150 * @kpage: the modified page we replace page by
152 * Returns 0 on success, -EFAULT on failure.
154 static int __replace_page(struct vm_area_struct
*vma
, unsigned long addr
,
155 struct page
*old_page
, struct page
*new_page
)
157 struct mm_struct
*mm
= vma
->vm_mm
;
158 struct page_vma_mapped_walk pvmw
= {
164 /* For mmu_notifiers */
165 const unsigned long mmun_start
= addr
;
166 const unsigned long mmun_end
= addr
+ PAGE_SIZE
;
167 struct mem_cgroup
*memcg
;
169 VM_BUG_ON_PAGE(PageTransHuge(old_page
), old_page
);
171 err
= mem_cgroup_try_charge(new_page
, vma
->vm_mm
, GFP_KERNEL
, &memcg
,
176 /* For try_to_free_swap() and munlock_vma_page() below */
179 mmu_notifier_invalidate_range_start(mm
, mmun_start
, mmun_end
);
181 if (!page_vma_mapped_walk(&pvmw
)) {
182 mem_cgroup_cancel_charge(new_page
, memcg
, false);
185 VM_BUG_ON_PAGE(addr
!= pvmw
.address
, old_page
);
188 page_add_new_anon_rmap(new_page
, vma
, addr
, false);
189 mem_cgroup_commit_charge(new_page
, memcg
, false, false);
190 lru_cache_add_active_or_unevictable(new_page
, vma
);
192 if (!PageAnon(old_page
)) {
193 dec_mm_counter(mm
, mm_counter_file(old_page
));
194 inc_mm_counter(mm
, MM_ANONPAGES
);
197 flush_cache_page(vma
, addr
, pte_pfn(*pvmw
.pte
));
198 ptep_clear_flush_notify(vma
, addr
, pvmw
.pte
);
199 set_pte_at_notify(mm
, addr
, pvmw
.pte
,
200 mk_pte(new_page
, vma
->vm_page_prot
));
202 page_remove_rmap(old_page
, false);
203 if (!page_mapped(old_page
))
204 try_to_free_swap(old_page
);
205 page_vma_mapped_walk_done(&pvmw
);
207 if (vma
->vm_flags
& VM_LOCKED
)
208 munlock_vma_page(old_page
);
213 mmu_notifier_invalidate_range_end(mm
, mmun_start
, mmun_end
);
214 unlock_page(old_page
);
219 * is_swbp_insn - check if instruction is breakpoint instruction.
220 * @insn: instruction to be checked.
221 * Default implementation of is_swbp_insn
222 * Returns true if @insn is a breakpoint instruction.
224 bool __weak
is_swbp_insn(uprobe_opcode_t
*insn
)
226 return *insn
== UPROBE_SWBP_INSN
;
230 * is_trap_insn - check if instruction is breakpoint instruction.
231 * @insn: instruction to be checked.
232 * Default implementation of is_trap_insn
233 * Returns true if @insn is a breakpoint instruction.
235 * This function is needed for the case where an architecture has multiple
236 * trap instructions (like powerpc).
238 bool __weak
is_trap_insn(uprobe_opcode_t
*insn
)
240 return is_swbp_insn(insn
);
243 static void copy_from_page(struct page
*page
, unsigned long vaddr
, void *dst
, int len
)
245 void *kaddr
= kmap_atomic(page
);
246 memcpy(dst
, kaddr
+ (vaddr
& ~PAGE_MASK
), len
);
247 kunmap_atomic(kaddr
);
250 static void copy_to_page(struct page
*page
, unsigned long vaddr
, const void *src
, int len
)
252 void *kaddr
= kmap_atomic(page
);
253 memcpy(kaddr
+ (vaddr
& ~PAGE_MASK
), src
, len
);
254 kunmap_atomic(kaddr
);
257 static int verify_opcode(struct page
*page
, unsigned long vaddr
, uprobe_opcode_t
*new_opcode
)
259 uprobe_opcode_t old_opcode
;
263 * Note: We only check if the old_opcode is UPROBE_SWBP_INSN here.
264 * We do not check if it is any other 'trap variant' which could
265 * be conditional trap instruction such as the one powerpc supports.
267 * The logic is that we do not care if the underlying instruction
268 * is a trap variant; uprobes always wins over any other (gdb)
271 copy_from_page(page
, vaddr
, &old_opcode
, UPROBE_SWBP_INSN_SIZE
);
272 is_swbp
= is_swbp_insn(&old_opcode
);
274 if (is_swbp_insn(new_opcode
)) {
275 if (is_swbp
) /* register: already installed? */
278 if (!is_swbp
) /* unregister: was it changed by us? */
287 * Expect the breakpoint instruction to be the smallest size instruction for
288 * the architecture. If an arch has variable length instruction and the
289 * breakpoint instruction is not of the smallest length instruction
290 * supported by that architecture then we need to modify is_trap_at_addr and
291 * uprobe_write_opcode accordingly. This would never be a problem for archs
292 * that have fixed length instructions.
294 * uprobe_write_opcode - write the opcode at a given virtual address.
295 * @mm: the probed process address space.
296 * @vaddr: the virtual address to store the opcode.
297 * @opcode: opcode to be written at @vaddr.
299 * Called with mm->mmap_sem held for write.
300 * Return 0 (success) or a negative errno.
302 int uprobe_write_opcode(struct mm_struct
*mm
, unsigned long vaddr
,
303 uprobe_opcode_t opcode
)
305 struct page
*old_page
, *new_page
;
306 struct vm_area_struct
*vma
;
310 /* Read the page with vaddr into memory */
311 ret
= get_user_pages_remote(NULL
, mm
, vaddr
, 1,
312 FOLL_FORCE
| FOLL_SPLIT
, &old_page
, &vma
, NULL
);
316 ret
= verify_opcode(old_page
, vaddr
, &opcode
);
320 ret
= anon_vma_prepare(vma
);
325 new_page
= alloc_page_vma(GFP_HIGHUSER_MOVABLE
, vma
, vaddr
);
329 __SetPageUptodate(new_page
);
330 copy_highpage(new_page
, old_page
);
331 copy_to_page(new_page
, vaddr
, &opcode
, UPROBE_SWBP_INSN_SIZE
);
333 ret
= __replace_page(vma
, vaddr
, old_page
, new_page
);
338 if (unlikely(ret
== -EAGAIN
))
344 * set_swbp - store breakpoint at a given address.
345 * @auprobe: arch specific probepoint information.
346 * @mm: the probed process address space.
347 * @vaddr: the virtual address to insert the opcode.
349 * For mm @mm, store the breakpoint instruction at @vaddr.
350 * Return 0 (success) or a negative errno.
352 int __weak
set_swbp(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
354 return uprobe_write_opcode(mm
, vaddr
, UPROBE_SWBP_INSN
);
358 * set_orig_insn - Restore the original instruction.
359 * @mm: the probed process address space.
360 * @auprobe: arch specific probepoint information.
361 * @vaddr: the virtual address to insert the opcode.
363 * For mm @mm, restore the original opcode (opcode) at @vaddr.
364 * Return 0 (success) or a negative errno.
367 set_orig_insn(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
369 return uprobe_write_opcode(mm
, vaddr
, *(uprobe_opcode_t
*)&auprobe
->insn
);
372 static struct uprobe
*get_uprobe(struct uprobe
*uprobe
)
374 atomic_inc(&uprobe
->ref
);
378 static void put_uprobe(struct uprobe
*uprobe
)
380 if (atomic_dec_and_test(&uprobe
->ref
))
384 static int match_uprobe(struct uprobe
*l
, struct uprobe
*r
)
386 if (l
->inode
< r
->inode
)
389 if (l
->inode
> r
->inode
)
392 if (l
->offset
< r
->offset
)
395 if (l
->offset
> r
->offset
)
401 static struct uprobe
*__find_uprobe(struct inode
*inode
, loff_t offset
)
403 struct uprobe u
= { .inode
= inode
, .offset
= offset
};
404 struct rb_node
*n
= uprobes_tree
.rb_node
;
405 struct uprobe
*uprobe
;
409 uprobe
= rb_entry(n
, struct uprobe
, rb_node
);
410 match
= match_uprobe(&u
, uprobe
);
412 return get_uprobe(uprobe
);
423 * Find a uprobe corresponding to a given inode:offset
424 * Acquires uprobes_treelock
426 static struct uprobe
*find_uprobe(struct inode
*inode
, loff_t offset
)
428 struct uprobe
*uprobe
;
430 spin_lock(&uprobes_treelock
);
431 uprobe
= __find_uprobe(inode
, offset
);
432 spin_unlock(&uprobes_treelock
);
437 static struct uprobe
*__insert_uprobe(struct uprobe
*uprobe
)
439 struct rb_node
**p
= &uprobes_tree
.rb_node
;
440 struct rb_node
*parent
= NULL
;
446 u
= rb_entry(parent
, struct uprobe
, rb_node
);
447 match
= match_uprobe(uprobe
, u
);
449 return get_uprobe(u
);
452 p
= &parent
->rb_left
;
454 p
= &parent
->rb_right
;
459 rb_link_node(&uprobe
->rb_node
, parent
, p
);
460 rb_insert_color(&uprobe
->rb_node
, &uprobes_tree
);
461 /* get access + creation ref */
462 atomic_set(&uprobe
->ref
, 2);
468 * Acquire uprobes_treelock.
469 * Matching uprobe already exists in rbtree;
470 * increment (access refcount) and return the matching uprobe.
472 * No matching uprobe; insert the uprobe in rb_tree;
473 * get a double refcount (access + creation) and return NULL.
475 static struct uprobe
*insert_uprobe(struct uprobe
*uprobe
)
479 spin_lock(&uprobes_treelock
);
480 u
= __insert_uprobe(uprobe
);
481 spin_unlock(&uprobes_treelock
);
486 static struct uprobe
*alloc_uprobe(struct inode
*inode
, loff_t offset
)
488 struct uprobe
*uprobe
, *cur_uprobe
;
490 uprobe
= kzalloc(sizeof(struct uprobe
), GFP_KERNEL
);
494 uprobe
->inode
= igrab(inode
);
495 uprobe
->offset
= offset
;
496 init_rwsem(&uprobe
->register_rwsem
);
497 init_rwsem(&uprobe
->consumer_rwsem
);
499 /* add to uprobes_tree, sorted on inode:offset */
500 cur_uprobe
= insert_uprobe(uprobe
);
501 /* a uprobe exists for this inode:offset combination */
511 static void consumer_add(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
513 down_write(&uprobe
->consumer_rwsem
);
514 uc
->next
= uprobe
->consumers
;
515 uprobe
->consumers
= uc
;
516 up_write(&uprobe
->consumer_rwsem
);
520 * For uprobe @uprobe, delete the consumer @uc.
521 * Return true if the @uc is deleted successfully
524 static bool consumer_del(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
526 struct uprobe_consumer
**con
;
529 down_write(&uprobe
->consumer_rwsem
);
530 for (con
= &uprobe
->consumers
; *con
; con
= &(*con
)->next
) {
537 up_write(&uprobe
->consumer_rwsem
);
542 static int __copy_insn(struct address_space
*mapping
, struct file
*filp
,
543 void *insn
, int nbytes
, loff_t offset
)
547 * Ensure that the page that has the original instruction is populated
548 * and in page-cache. If ->readpage == NULL it must be shmem_mapping(),
549 * see uprobe_register().
551 if (mapping
->a_ops
->readpage
)
552 page
= read_mapping_page(mapping
, offset
>> PAGE_SHIFT
, filp
);
554 page
= shmem_read_mapping_page(mapping
, offset
>> PAGE_SHIFT
);
556 return PTR_ERR(page
);
558 copy_from_page(page
, offset
, insn
, nbytes
);
564 static int copy_insn(struct uprobe
*uprobe
, struct file
*filp
)
566 struct address_space
*mapping
= uprobe
->inode
->i_mapping
;
567 loff_t offs
= uprobe
->offset
;
568 void *insn
= &uprobe
->arch
.insn
;
569 int size
= sizeof(uprobe
->arch
.insn
);
572 /* Copy only available bytes, -EIO if nothing was read */
574 if (offs
>= i_size_read(uprobe
->inode
))
577 len
= min_t(int, size
, PAGE_SIZE
- (offs
& ~PAGE_MASK
));
578 err
= __copy_insn(mapping
, filp
, insn
, len
, offs
);
590 static int prepare_uprobe(struct uprobe
*uprobe
, struct file
*file
,
591 struct mm_struct
*mm
, unsigned long vaddr
)
595 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
598 /* TODO: move this into _register, until then we abuse this sem. */
599 down_write(&uprobe
->consumer_rwsem
);
600 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
603 ret
= copy_insn(uprobe
, file
);
608 if (is_trap_insn((uprobe_opcode_t
*)&uprobe
->arch
.insn
))
611 ret
= arch_uprobe_analyze_insn(&uprobe
->arch
, mm
, vaddr
);
615 /* uprobe_write_opcode() assumes we don't cross page boundary */
616 BUG_ON((uprobe
->offset
& ~PAGE_MASK
) +
617 UPROBE_SWBP_INSN_SIZE
> PAGE_SIZE
);
619 smp_wmb(); /* pairs with rmb() in find_active_uprobe() */
620 set_bit(UPROBE_COPY_INSN
, &uprobe
->flags
);
623 up_write(&uprobe
->consumer_rwsem
);
628 static inline bool consumer_filter(struct uprobe_consumer
*uc
,
629 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
631 return !uc
->filter
|| uc
->filter(uc
, ctx
, mm
);
634 static bool filter_chain(struct uprobe
*uprobe
,
635 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
637 struct uprobe_consumer
*uc
;
640 down_read(&uprobe
->consumer_rwsem
);
641 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
642 ret
= consumer_filter(uc
, ctx
, mm
);
646 up_read(&uprobe
->consumer_rwsem
);
652 install_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
,
653 struct vm_area_struct
*vma
, unsigned long vaddr
)
658 ret
= prepare_uprobe(uprobe
, vma
->vm_file
, mm
, vaddr
);
663 * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
664 * the task can hit this breakpoint right after __replace_page().
666 first_uprobe
= !test_bit(MMF_HAS_UPROBES
, &mm
->flags
);
668 set_bit(MMF_HAS_UPROBES
, &mm
->flags
);
670 ret
= set_swbp(&uprobe
->arch
, mm
, vaddr
);
672 clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
673 else if (first_uprobe
)
674 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
680 remove_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
682 set_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
683 return set_orig_insn(&uprobe
->arch
, mm
, vaddr
);
686 static inline bool uprobe_is_active(struct uprobe
*uprobe
)
688 return !RB_EMPTY_NODE(&uprobe
->rb_node
);
691 * There could be threads that have already hit the breakpoint. They
692 * will recheck the current insn and restart if find_uprobe() fails.
693 * See find_active_uprobe().
695 static void delete_uprobe(struct uprobe
*uprobe
)
697 if (WARN_ON(!uprobe_is_active(uprobe
)))
700 spin_lock(&uprobes_treelock
);
701 rb_erase(&uprobe
->rb_node
, &uprobes_tree
);
702 spin_unlock(&uprobes_treelock
);
703 RB_CLEAR_NODE(&uprobe
->rb_node
); /* for uprobe_is_active() */
709 struct map_info
*next
;
710 struct mm_struct
*mm
;
714 static inline struct map_info
*free_map_info(struct map_info
*info
)
716 struct map_info
*next
= info
->next
;
721 static struct map_info
*
722 build_map_info(struct address_space
*mapping
, loff_t offset
, bool is_register
)
724 unsigned long pgoff
= offset
>> PAGE_SHIFT
;
725 struct vm_area_struct
*vma
;
726 struct map_info
*curr
= NULL
;
727 struct map_info
*prev
= NULL
;
728 struct map_info
*info
;
732 i_mmap_lock_read(mapping
);
733 vma_interval_tree_foreach(vma
, &mapping
->i_mmap
, pgoff
, pgoff
) {
734 if (!valid_vma(vma
, is_register
))
737 if (!prev
&& !more
) {
739 * Needs GFP_NOWAIT to avoid i_mmap_rwsem recursion through
740 * reclaim. This is optimistic, no harm done if it fails.
742 prev
= kmalloc(sizeof(struct map_info
),
743 GFP_NOWAIT
| __GFP_NOMEMALLOC
| __GFP_NOWARN
);
752 if (!mmget_not_zero(vma
->vm_mm
))
760 info
->mm
= vma
->vm_mm
;
761 info
->vaddr
= offset_to_vaddr(vma
, offset
);
763 i_mmap_unlock_read(mapping
);
775 info
= kmalloc(sizeof(struct map_info
), GFP_KERNEL
);
777 curr
= ERR_PTR(-ENOMEM
);
787 prev
= free_map_info(prev
);
792 register_for_each_vma(struct uprobe
*uprobe
, struct uprobe_consumer
*new)
794 bool is_register
= !!new;
795 struct map_info
*info
;
798 percpu_down_write(&dup_mmap_sem
);
799 info
= build_map_info(uprobe
->inode
->i_mapping
,
800 uprobe
->offset
, is_register
);
807 struct mm_struct
*mm
= info
->mm
;
808 struct vm_area_struct
*vma
;
810 if (err
&& is_register
)
813 down_write(&mm
->mmap_sem
);
814 vma
= find_vma(mm
, info
->vaddr
);
815 if (!vma
|| !valid_vma(vma
, is_register
) ||
816 file_inode(vma
->vm_file
) != uprobe
->inode
)
819 if (vma
->vm_start
> info
->vaddr
||
820 vaddr_to_offset(vma
, info
->vaddr
) != uprobe
->offset
)
824 /* consult only the "caller", new consumer. */
825 if (consumer_filter(new,
826 UPROBE_FILTER_REGISTER
, mm
))
827 err
= install_breakpoint(uprobe
, mm
, vma
, info
->vaddr
);
828 } else if (test_bit(MMF_HAS_UPROBES
, &mm
->flags
)) {
829 if (!filter_chain(uprobe
,
830 UPROBE_FILTER_UNREGISTER
, mm
))
831 err
|= remove_breakpoint(uprobe
, mm
, info
->vaddr
);
835 up_write(&mm
->mmap_sem
);
838 info
= free_map_info(info
);
841 percpu_up_write(&dup_mmap_sem
);
845 static int __uprobe_register(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
847 consumer_add(uprobe
, uc
);
848 return register_for_each_vma(uprobe
, uc
);
851 static void __uprobe_unregister(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
855 if (WARN_ON(!consumer_del(uprobe
, uc
)))
858 err
= register_for_each_vma(uprobe
, NULL
);
859 /* TODO : cant unregister? schedule a worker thread */
860 if (!uprobe
->consumers
&& !err
)
861 delete_uprobe(uprobe
);
865 * uprobe_register - register a probe
866 * @inode: the file in which the probe has to be placed.
867 * @offset: offset from the start of the file.
868 * @uc: information on howto handle the probe..
870 * Apart from the access refcount, uprobe_register() takes a creation
871 * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
872 * inserted into the rbtree (i.e first consumer for a @inode:@offset
873 * tuple). Creation refcount stops uprobe_unregister from freeing the
874 * @uprobe even before the register operation is complete. Creation
875 * refcount is released when the last @uc for the @uprobe
878 * Return errno if it cannot successully install probes
879 * else return 0 (success)
881 int uprobe_register(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
883 struct uprobe
*uprobe
;
886 /* Uprobe must have at least one set consumer */
887 if (!uc
->handler
&& !uc
->ret_handler
)
890 /* copy_insn() uses read_mapping_page() or shmem_read_mapping_page() */
891 if (!inode
->i_mapping
->a_ops
->readpage
&& !shmem_mapping(inode
->i_mapping
))
893 /* Racy, just to catch the obvious mistakes */
894 if (offset
> i_size_read(inode
))
898 uprobe
= alloc_uprobe(inode
, offset
);
902 * We can race with uprobe_unregister()->delete_uprobe().
903 * Check uprobe_is_active() and retry if it is false.
905 down_write(&uprobe
->register_rwsem
);
907 if (likely(uprobe_is_active(uprobe
))) {
908 ret
= __uprobe_register(uprobe
, uc
);
910 __uprobe_unregister(uprobe
, uc
);
912 up_write(&uprobe
->register_rwsem
);
915 if (unlikely(ret
== -EAGAIN
))
919 EXPORT_SYMBOL_GPL(uprobe_register
);
922 * uprobe_apply - unregister a already registered probe.
923 * @inode: the file in which the probe has to be removed.
924 * @offset: offset from the start of the file.
925 * @uc: consumer which wants to add more or remove some breakpoints
926 * @add: add or remove the breakpoints
928 int uprobe_apply(struct inode
*inode
, loff_t offset
,
929 struct uprobe_consumer
*uc
, bool add
)
931 struct uprobe
*uprobe
;
932 struct uprobe_consumer
*con
;
935 uprobe
= find_uprobe(inode
, offset
);
936 if (WARN_ON(!uprobe
))
939 down_write(&uprobe
->register_rwsem
);
940 for (con
= uprobe
->consumers
; con
&& con
!= uc
; con
= con
->next
)
943 ret
= register_for_each_vma(uprobe
, add
? uc
: NULL
);
944 up_write(&uprobe
->register_rwsem
);
951 * uprobe_unregister - unregister a already registered probe.
952 * @inode: the file in which the probe has to be removed.
953 * @offset: offset from the start of the file.
954 * @uc: identify which probe if multiple probes are colocated.
956 void uprobe_unregister(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
958 struct uprobe
*uprobe
;
960 uprobe
= find_uprobe(inode
, offset
);
961 if (WARN_ON(!uprobe
))
964 down_write(&uprobe
->register_rwsem
);
965 __uprobe_unregister(uprobe
, uc
);
966 up_write(&uprobe
->register_rwsem
);
969 EXPORT_SYMBOL_GPL(uprobe_unregister
);
971 static int unapply_uprobe(struct uprobe
*uprobe
, struct mm_struct
*mm
)
973 struct vm_area_struct
*vma
;
976 down_read(&mm
->mmap_sem
);
977 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
981 if (!valid_vma(vma
, false) ||
982 file_inode(vma
->vm_file
) != uprobe
->inode
)
985 offset
= (loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
;
986 if (uprobe
->offset
< offset
||
987 uprobe
->offset
>= offset
+ vma
->vm_end
- vma
->vm_start
)
990 vaddr
= offset_to_vaddr(vma
, uprobe
->offset
);
991 err
|= remove_breakpoint(uprobe
, mm
, vaddr
);
993 up_read(&mm
->mmap_sem
);
998 static struct rb_node
*
999 find_node_in_range(struct inode
*inode
, loff_t min
, loff_t max
)
1001 struct rb_node
*n
= uprobes_tree
.rb_node
;
1004 struct uprobe
*u
= rb_entry(n
, struct uprobe
, rb_node
);
1006 if (inode
< u
->inode
) {
1008 } else if (inode
> u
->inode
) {
1011 if (max
< u
->offset
)
1013 else if (min
> u
->offset
)
1024 * For a given range in vma, build a list of probes that need to be inserted.
1026 static void build_probe_list(struct inode
*inode
,
1027 struct vm_area_struct
*vma
,
1028 unsigned long start
, unsigned long end
,
1029 struct list_head
*head
)
1032 struct rb_node
*n
, *t
;
1035 INIT_LIST_HEAD(head
);
1036 min
= vaddr_to_offset(vma
, start
);
1037 max
= min
+ (end
- start
) - 1;
1039 spin_lock(&uprobes_treelock
);
1040 n
= find_node_in_range(inode
, min
, max
);
1042 for (t
= n
; t
; t
= rb_prev(t
)) {
1043 u
= rb_entry(t
, struct uprobe
, rb_node
);
1044 if (u
->inode
!= inode
|| u
->offset
< min
)
1046 list_add(&u
->pending_list
, head
);
1049 for (t
= n
; (t
= rb_next(t
)); ) {
1050 u
= rb_entry(t
, struct uprobe
, rb_node
);
1051 if (u
->inode
!= inode
|| u
->offset
> max
)
1053 list_add(&u
->pending_list
, head
);
1057 spin_unlock(&uprobes_treelock
);
1061 * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
1063 * Currently we ignore all errors and always return 0, the callers
1064 * can't handle the failure anyway.
1066 int uprobe_mmap(struct vm_area_struct
*vma
)
1068 struct list_head tmp_list
;
1069 struct uprobe
*uprobe
, *u
;
1070 struct inode
*inode
;
1072 if (no_uprobe_events() || !valid_vma(vma
, true))
1075 inode
= file_inode(vma
->vm_file
);
1079 mutex_lock(uprobes_mmap_hash(inode
));
1080 build_probe_list(inode
, vma
, vma
->vm_start
, vma
->vm_end
, &tmp_list
);
1082 * We can race with uprobe_unregister(), this uprobe can be already
1083 * removed. But in this case filter_chain() must return false, all
1084 * consumers have gone away.
1086 list_for_each_entry_safe(uprobe
, u
, &tmp_list
, pending_list
) {
1087 if (!fatal_signal_pending(current
) &&
1088 filter_chain(uprobe
, UPROBE_FILTER_MMAP
, vma
->vm_mm
)) {
1089 unsigned long vaddr
= offset_to_vaddr(vma
, uprobe
->offset
);
1090 install_breakpoint(uprobe
, vma
->vm_mm
, vma
, vaddr
);
1094 mutex_unlock(uprobes_mmap_hash(inode
));
1100 vma_has_uprobes(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1103 struct inode
*inode
;
1106 inode
= file_inode(vma
->vm_file
);
1108 min
= vaddr_to_offset(vma
, start
);
1109 max
= min
+ (end
- start
) - 1;
1111 spin_lock(&uprobes_treelock
);
1112 n
= find_node_in_range(inode
, min
, max
);
1113 spin_unlock(&uprobes_treelock
);
1119 * Called in context of a munmap of a vma.
1121 void uprobe_munmap(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1123 if (no_uprobe_events() || !valid_vma(vma
, false))
1126 if (!atomic_read(&vma
->vm_mm
->mm_users
)) /* called by mmput() ? */
1129 if (!test_bit(MMF_HAS_UPROBES
, &vma
->vm_mm
->flags
) ||
1130 test_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
))
1133 if (vma_has_uprobes(vma
, start
, end
))
1134 set_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
);
1137 /* Slot allocation for XOL */
1138 static int xol_add_vma(struct mm_struct
*mm
, struct xol_area
*area
)
1140 struct vm_area_struct
*vma
;
1143 if (down_write_killable(&mm
->mmap_sem
))
1146 if (mm
->uprobes_state
.xol_area
) {
1152 /* Try to map as high as possible, this is only a hint. */
1153 area
->vaddr
= get_unmapped_area(NULL
, TASK_SIZE
- PAGE_SIZE
,
1155 if (area
->vaddr
& ~PAGE_MASK
) {
1161 vma
= _install_special_mapping(mm
, area
->vaddr
, PAGE_SIZE
,
1162 VM_EXEC
|VM_MAYEXEC
|VM_DONTCOPY
|VM_IO
,
1163 &area
->xol_mapping
);
1170 smp_wmb(); /* pairs with get_xol_area() */
1171 mm
->uprobes_state
.xol_area
= area
;
1173 up_write(&mm
->mmap_sem
);
1178 static struct xol_area
*__create_xol_area(unsigned long vaddr
)
1180 struct mm_struct
*mm
= current
->mm
;
1181 uprobe_opcode_t insn
= UPROBE_SWBP_INSN
;
1182 struct xol_area
*area
;
1184 area
= kmalloc(sizeof(*area
), GFP_KERNEL
);
1185 if (unlikely(!area
))
1188 area
->bitmap
= kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE
) * sizeof(long), GFP_KERNEL
);
1192 area
->xol_mapping
.name
= "[uprobes]";
1193 area
->xol_mapping
.fault
= NULL
;
1194 area
->xol_mapping
.pages
= area
->pages
;
1195 area
->pages
[0] = alloc_page(GFP_HIGHUSER
);
1196 if (!area
->pages
[0])
1198 area
->pages
[1] = NULL
;
1200 area
->vaddr
= vaddr
;
1201 init_waitqueue_head(&area
->wq
);
1202 /* Reserve the 1st slot for get_trampoline_vaddr() */
1203 set_bit(0, area
->bitmap
);
1204 atomic_set(&area
->slot_count
, 1);
1205 arch_uprobe_copy_ixol(area
->pages
[0], 0, &insn
, UPROBE_SWBP_INSN_SIZE
);
1207 if (!xol_add_vma(mm
, area
))
1210 __free_page(area
->pages
[0]);
1212 kfree(area
->bitmap
);
1220 * get_xol_area - Allocate process's xol_area if necessary.
1221 * This area will be used for storing instructions for execution out of line.
1223 * Returns the allocated area or NULL.
1225 static struct xol_area
*get_xol_area(void)
1227 struct mm_struct
*mm
= current
->mm
;
1228 struct xol_area
*area
;
1230 if (!mm
->uprobes_state
.xol_area
)
1231 __create_xol_area(0);
1233 area
= mm
->uprobes_state
.xol_area
;
1234 smp_read_barrier_depends(); /* pairs with wmb in xol_add_vma() */
1239 * uprobe_clear_state - Free the area allocated for slots.
1241 void uprobe_clear_state(struct mm_struct
*mm
)
1243 struct xol_area
*area
= mm
->uprobes_state
.xol_area
;
1248 put_page(area
->pages
[0]);
1249 kfree(area
->bitmap
);
1253 void uprobe_start_dup_mmap(void)
1255 percpu_down_read(&dup_mmap_sem
);
1258 void uprobe_end_dup_mmap(void)
1260 percpu_up_read(&dup_mmap_sem
);
1263 void uprobe_dup_mmap(struct mm_struct
*oldmm
, struct mm_struct
*newmm
)
1265 newmm
->uprobes_state
.xol_area
= NULL
;
1267 if (test_bit(MMF_HAS_UPROBES
, &oldmm
->flags
)) {
1268 set_bit(MMF_HAS_UPROBES
, &newmm
->flags
);
1269 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1270 set_bit(MMF_RECALC_UPROBES
, &newmm
->flags
);
1275 * - search for a free slot.
1277 static unsigned long xol_take_insn_slot(struct xol_area
*area
)
1279 unsigned long slot_addr
;
1283 slot_nr
= find_first_zero_bit(area
->bitmap
, UINSNS_PER_PAGE
);
1284 if (slot_nr
< UINSNS_PER_PAGE
) {
1285 if (!test_and_set_bit(slot_nr
, area
->bitmap
))
1288 slot_nr
= UINSNS_PER_PAGE
;
1291 wait_event(area
->wq
, (atomic_read(&area
->slot_count
) < UINSNS_PER_PAGE
));
1292 } while (slot_nr
>= UINSNS_PER_PAGE
);
1294 slot_addr
= area
->vaddr
+ (slot_nr
* UPROBE_XOL_SLOT_BYTES
);
1295 atomic_inc(&area
->slot_count
);
1301 * xol_get_insn_slot - allocate a slot for xol.
1302 * Returns the allocated slot address or 0.
1304 static unsigned long xol_get_insn_slot(struct uprobe
*uprobe
)
1306 struct xol_area
*area
;
1307 unsigned long xol_vaddr
;
1309 area
= get_xol_area();
1313 xol_vaddr
= xol_take_insn_slot(area
);
1314 if (unlikely(!xol_vaddr
))
1317 arch_uprobe_copy_ixol(area
->pages
[0], xol_vaddr
,
1318 &uprobe
->arch
.ixol
, sizeof(uprobe
->arch
.ixol
));
1324 * xol_free_insn_slot - If slot was earlier allocated by
1325 * @xol_get_insn_slot(), make the slot available for
1326 * subsequent requests.
1328 static void xol_free_insn_slot(struct task_struct
*tsk
)
1330 struct xol_area
*area
;
1331 unsigned long vma_end
;
1332 unsigned long slot_addr
;
1334 if (!tsk
->mm
|| !tsk
->mm
->uprobes_state
.xol_area
|| !tsk
->utask
)
1337 slot_addr
= tsk
->utask
->xol_vaddr
;
1338 if (unlikely(!slot_addr
))
1341 area
= tsk
->mm
->uprobes_state
.xol_area
;
1342 vma_end
= area
->vaddr
+ PAGE_SIZE
;
1343 if (area
->vaddr
<= slot_addr
&& slot_addr
< vma_end
) {
1344 unsigned long offset
;
1347 offset
= slot_addr
- area
->vaddr
;
1348 slot_nr
= offset
/ UPROBE_XOL_SLOT_BYTES
;
1349 if (slot_nr
>= UINSNS_PER_PAGE
)
1352 clear_bit(slot_nr
, area
->bitmap
);
1353 atomic_dec(&area
->slot_count
);
1354 smp_mb__after_atomic(); /* pairs with prepare_to_wait() */
1355 if (waitqueue_active(&area
->wq
))
1358 tsk
->utask
->xol_vaddr
= 0;
1362 void __weak
arch_uprobe_copy_ixol(struct page
*page
, unsigned long vaddr
,
1363 void *src
, unsigned long len
)
1365 /* Initialize the slot */
1366 copy_to_page(page
, vaddr
, src
, len
);
1369 * We probably need flush_icache_user_range() but it needs vma.
1370 * This should work on most of architectures by default. If
1371 * architecture needs to do something different it can define
1372 * its own version of the function.
1374 flush_dcache_page(page
);
1378 * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1379 * @regs: Reflects the saved state of the task after it has hit a breakpoint
1381 * Return the address of the breakpoint instruction.
1383 unsigned long __weak
uprobe_get_swbp_addr(struct pt_regs
*regs
)
1385 return instruction_pointer(regs
) - UPROBE_SWBP_INSN_SIZE
;
1388 unsigned long uprobe_get_trap_addr(struct pt_regs
*regs
)
1390 struct uprobe_task
*utask
= current
->utask
;
1392 if (unlikely(utask
&& utask
->active_uprobe
))
1393 return utask
->vaddr
;
1395 return instruction_pointer(regs
);
1398 static struct return_instance
*free_ret_instance(struct return_instance
*ri
)
1400 struct return_instance
*next
= ri
->next
;
1401 put_uprobe(ri
->uprobe
);
1407 * Called with no locks held.
1408 * Called in context of a exiting or a exec-ing thread.
1410 void uprobe_free_utask(struct task_struct
*t
)
1412 struct uprobe_task
*utask
= t
->utask
;
1413 struct return_instance
*ri
;
1418 if (utask
->active_uprobe
)
1419 put_uprobe(utask
->active_uprobe
);
1421 ri
= utask
->return_instances
;
1423 ri
= free_ret_instance(ri
);
1425 xol_free_insn_slot(t
);
1431 * Allocate a uprobe_task object for the task if if necessary.
1432 * Called when the thread hits a breakpoint.
1435 * - pointer to new uprobe_task on success
1438 static struct uprobe_task
*get_utask(void)
1440 if (!current
->utask
)
1441 current
->utask
= kzalloc(sizeof(struct uprobe_task
), GFP_KERNEL
);
1442 return current
->utask
;
1445 static int dup_utask(struct task_struct
*t
, struct uprobe_task
*o_utask
)
1447 struct uprobe_task
*n_utask
;
1448 struct return_instance
**p
, *o
, *n
;
1450 n_utask
= kzalloc(sizeof(struct uprobe_task
), GFP_KERNEL
);
1455 p
= &n_utask
->return_instances
;
1456 for (o
= o_utask
->return_instances
; o
; o
= o
->next
) {
1457 n
= kmalloc(sizeof(struct return_instance
), GFP_KERNEL
);
1462 get_uprobe(n
->uprobe
);
1473 static void uprobe_warn(struct task_struct
*t
, const char *msg
)
1475 pr_warn("uprobe: %s:%d failed to %s\n",
1476 current
->comm
, current
->pid
, msg
);
1479 static void dup_xol_work(struct callback_head
*work
)
1481 if (current
->flags
& PF_EXITING
)
1484 if (!__create_xol_area(current
->utask
->dup_xol_addr
) &&
1485 !fatal_signal_pending(current
))
1486 uprobe_warn(current
, "dup xol area");
1490 * Called in context of a new clone/fork from copy_process.
1492 void uprobe_copy_process(struct task_struct
*t
, unsigned long flags
)
1494 struct uprobe_task
*utask
= current
->utask
;
1495 struct mm_struct
*mm
= current
->mm
;
1496 struct xol_area
*area
;
1500 if (!utask
|| !utask
->return_instances
)
1503 if (mm
== t
->mm
&& !(flags
& CLONE_VFORK
))
1506 if (dup_utask(t
, utask
))
1507 return uprobe_warn(t
, "dup ret instances");
1509 /* The task can fork() after dup_xol_work() fails */
1510 area
= mm
->uprobes_state
.xol_area
;
1512 return uprobe_warn(t
, "dup xol area");
1517 t
->utask
->dup_xol_addr
= area
->vaddr
;
1518 init_task_work(&t
->utask
->dup_xol_work
, dup_xol_work
);
1519 task_work_add(t
, &t
->utask
->dup_xol_work
, true);
1523 * Current area->vaddr notion assume the trampoline address is always
1524 * equal area->vaddr.
1526 * Returns -1 in case the xol_area is not allocated.
1528 static unsigned long get_trampoline_vaddr(void)
1530 struct xol_area
*area
;
1531 unsigned long trampoline_vaddr
= -1;
1533 area
= current
->mm
->uprobes_state
.xol_area
;
1534 smp_read_barrier_depends();
1536 trampoline_vaddr
= area
->vaddr
;
1538 return trampoline_vaddr
;
1541 static void cleanup_return_instances(struct uprobe_task
*utask
, bool chained
,
1542 struct pt_regs
*regs
)
1544 struct return_instance
*ri
= utask
->return_instances
;
1545 enum rp_check ctx
= chained
? RP_CHECK_CHAIN_CALL
: RP_CHECK_CALL
;
1547 while (ri
&& !arch_uretprobe_is_alive(ri
, ctx
, regs
)) {
1548 ri
= free_ret_instance(ri
);
1551 utask
->return_instances
= ri
;
1554 static void prepare_uretprobe(struct uprobe
*uprobe
, struct pt_regs
*regs
)
1556 struct return_instance
*ri
;
1557 struct uprobe_task
*utask
;
1558 unsigned long orig_ret_vaddr
, trampoline_vaddr
;
1561 if (!get_xol_area())
1564 utask
= get_utask();
1568 if (utask
->depth
>= MAX_URETPROBE_DEPTH
) {
1569 printk_ratelimited(KERN_INFO
"uprobe: omit uretprobe due to"
1570 " nestedness limit pid/tgid=%d/%d\n",
1571 current
->pid
, current
->tgid
);
1575 ri
= kmalloc(sizeof(struct return_instance
), GFP_KERNEL
);
1579 trampoline_vaddr
= get_trampoline_vaddr();
1580 orig_ret_vaddr
= arch_uretprobe_hijack_return_addr(trampoline_vaddr
, regs
);
1581 if (orig_ret_vaddr
== -1)
1584 /* drop the entries invalidated by longjmp() */
1585 chained
= (orig_ret_vaddr
== trampoline_vaddr
);
1586 cleanup_return_instances(utask
, chained
, regs
);
1589 * We don't want to keep trampoline address in stack, rather keep the
1590 * original return address of first caller thru all the consequent
1591 * instances. This also makes breakpoint unwrapping easier.
1594 if (!utask
->return_instances
) {
1596 * This situation is not possible. Likely we have an
1597 * attack from user-space.
1599 uprobe_warn(current
, "handle tail call");
1602 orig_ret_vaddr
= utask
->return_instances
->orig_ret_vaddr
;
1605 ri
->uprobe
= get_uprobe(uprobe
);
1606 ri
->func
= instruction_pointer(regs
);
1607 ri
->stack
= user_stack_pointer(regs
);
1608 ri
->orig_ret_vaddr
= orig_ret_vaddr
;
1609 ri
->chained
= chained
;
1612 ri
->next
= utask
->return_instances
;
1613 utask
->return_instances
= ri
;
1620 /* Prepare to single-step probed instruction out of line. */
1622 pre_ssout(struct uprobe
*uprobe
, struct pt_regs
*regs
, unsigned long bp_vaddr
)
1624 struct uprobe_task
*utask
;
1625 unsigned long xol_vaddr
;
1628 utask
= get_utask();
1632 xol_vaddr
= xol_get_insn_slot(uprobe
);
1636 utask
->xol_vaddr
= xol_vaddr
;
1637 utask
->vaddr
= bp_vaddr
;
1639 err
= arch_uprobe_pre_xol(&uprobe
->arch
, regs
);
1640 if (unlikely(err
)) {
1641 xol_free_insn_slot(current
);
1645 utask
->active_uprobe
= uprobe
;
1646 utask
->state
= UTASK_SSTEP
;
1651 * If we are singlestepping, then ensure this thread is not connected to
1652 * non-fatal signals until completion of singlestep. When xol insn itself
1653 * triggers the signal, restart the original insn even if the task is
1654 * already SIGKILL'ed (since coredump should report the correct ip). This
1655 * is even more important if the task has a handler for SIGSEGV/etc, The
1656 * _same_ instruction should be repeated again after return from the signal
1657 * handler, and SSTEP can never finish in this case.
1659 bool uprobe_deny_signal(void)
1661 struct task_struct
*t
= current
;
1662 struct uprobe_task
*utask
= t
->utask
;
1664 if (likely(!utask
|| !utask
->active_uprobe
))
1667 WARN_ON_ONCE(utask
->state
!= UTASK_SSTEP
);
1669 if (signal_pending(t
)) {
1670 spin_lock_irq(&t
->sighand
->siglock
);
1671 clear_tsk_thread_flag(t
, TIF_SIGPENDING
);
1672 spin_unlock_irq(&t
->sighand
->siglock
);
1674 if (__fatal_signal_pending(t
) || arch_uprobe_xol_was_trapped(t
)) {
1675 utask
->state
= UTASK_SSTEP_TRAPPED
;
1676 set_tsk_thread_flag(t
, TIF_UPROBE
);
1683 static void mmf_recalc_uprobes(struct mm_struct
*mm
)
1685 struct vm_area_struct
*vma
;
1687 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
1688 if (!valid_vma(vma
, false))
1691 * This is not strictly accurate, we can race with
1692 * uprobe_unregister() and see the already removed
1693 * uprobe if delete_uprobe() was not yet called.
1694 * Or this uprobe can be filtered out.
1696 if (vma_has_uprobes(vma
, vma
->vm_start
, vma
->vm_end
))
1700 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
1703 static int is_trap_at_addr(struct mm_struct
*mm
, unsigned long vaddr
)
1706 uprobe_opcode_t opcode
;
1709 pagefault_disable();
1710 result
= __get_user(opcode
, (uprobe_opcode_t __user
*)vaddr
);
1713 if (likely(result
== 0))
1717 * The NULL 'tsk' here ensures that any faults that occur here
1718 * will not be accounted to the task. 'mm' *is* current->mm,
1719 * but we treat this as a 'remote' access since it is
1720 * essentially a kernel access to the memory.
1722 result
= get_user_pages_remote(NULL
, mm
, vaddr
, 1, FOLL_FORCE
, &page
,
1727 copy_from_page(page
, vaddr
, &opcode
, UPROBE_SWBP_INSN_SIZE
);
1730 /* This needs to return true for any variant of the trap insn */
1731 return is_trap_insn(&opcode
);
1734 static struct uprobe
*find_active_uprobe(unsigned long bp_vaddr
, int *is_swbp
)
1736 struct mm_struct
*mm
= current
->mm
;
1737 struct uprobe
*uprobe
= NULL
;
1738 struct vm_area_struct
*vma
;
1740 down_read(&mm
->mmap_sem
);
1741 vma
= find_vma(mm
, bp_vaddr
);
1742 if (vma
&& vma
->vm_start
<= bp_vaddr
) {
1743 if (valid_vma(vma
, false)) {
1744 struct inode
*inode
= file_inode(vma
->vm_file
);
1745 loff_t offset
= vaddr_to_offset(vma
, bp_vaddr
);
1747 uprobe
= find_uprobe(inode
, offset
);
1751 *is_swbp
= is_trap_at_addr(mm
, bp_vaddr
);
1756 if (!uprobe
&& test_and_clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
))
1757 mmf_recalc_uprobes(mm
);
1758 up_read(&mm
->mmap_sem
);
1763 static void handler_chain(struct uprobe
*uprobe
, struct pt_regs
*regs
)
1765 struct uprobe_consumer
*uc
;
1766 int remove
= UPROBE_HANDLER_REMOVE
;
1767 bool need_prep
= false; /* prepare return uprobe, when needed */
1769 down_read(&uprobe
->register_rwsem
);
1770 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
1774 rc
= uc
->handler(uc
, regs
);
1775 WARN(rc
& ~UPROBE_HANDLER_MASK
,
1776 "bad rc=0x%x from %pf()\n", rc
, uc
->handler
);
1779 if (uc
->ret_handler
)
1785 if (need_prep
&& !remove
)
1786 prepare_uretprobe(uprobe
, regs
); /* put bp at return */
1788 if (remove
&& uprobe
->consumers
) {
1789 WARN_ON(!uprobe_is_active(uprobe
));
1790 unapply_uprobe(uprobe
, current
->mm
);
1792 up_read(&uprobe
->register_rwsem
);
1796 handle_uretprobe_chain(struct return_instance
*ri
, struct pt_regs
*regs
)
1798 struct uprobe
*uprobe
= ri
->uprobe
;
1799 struct uprobe_consumer
*uc
;
1801 down_read(&uprobe
->register_rwsem
);
1802 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
1803 if (uc
->ret_handler
)
1804 uc
->ret_handler(uc
, ri
->func
, regs
);
1806 up_read(&uprobe
->register_rwsem
);
1809 static struct return_instance
*find_next_ret_chain(struct return_instance
*ri
)
1814 chained
= ri
->chained
;
1815 ri
= ri
->next
; /* can't be NULL if chained */
1821 static void handle_trampoline(struct pt_regs
*regs
)
1823 struct uprobe_task
*utask
;
1824 struct return_instance
*ri
, *next
;
1827 utask
= current
->utask
;
1831 ri
= utask
->return_instances
;
1837 * We should throw out the frames invalidated by longjmp().
1838 * If this chain is valid, then the next one should be alive
1839 * or NULL; the latter case means that nobody but ri->func
1840 * could hit this trampoline on return. TODO: sigaltstack().
1842 next
= find_next_ret_chain(ri
);
1843 valid
= !next
|| arch_uretprobe_is_alive(next
, RP_CHECK_RET
, regs
);
1845 instruction_pointer_set(regs
, ri
->orig_ret_vaddr
);
1848 handle_uretprobe_chain(ri
, regs
);
1849 ri
= free_ret_instance(ri
);
1851 } while (ri
!= next
);
1854 utask
->return_instances
= ri
;
1858 uprobe_warn(current
, "handle uretprobe, sending SIGILL.");
1859 force_sig_info(SIGILL
, SEND_SIG_FORCED
, current
);
1863 bool __weak
arch_uprobe_ignore(struct arch_uprobe
*aup
, struct pt_regs
*regs
)
1868 bool __weak
arch_uretprobe_is_alive(struct return_instance
*ret
, enum rp_check ctx
,
1869 struct pt_regs
*regs
)
1875 * Run handler and ask thread to singlestep.
1876 * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1878 static void handle_swbp(struct pt_regs
*regs
)
1880 struct uprobe
*uprobe
;
1881 unsigned long bp_vaddr
;
1882 int uninitialized_var(is_swbp
);
1884 bp_vaddr
= uprobe_get_swbp_addr(regs
);
1885 if (bp_vaddr
== get_trampoline_vaddr())
1886 return handle_trampoline(regs
);
1888 uprobe
= find_active_uprobe(bp_vaddr
, &is_swbp
);
1891 /* No matching uprobe; signal SIGTRAP. */
1892 send_sig(SIGTRAP
, current
, 0);
1895 * Either we raced with uprobe_unregister() or we can't
1896 * access this memory. The latter is only possible if
1897 * another thread plays with our ->mm. In both cases
1898 * we can simply restart. If this vma was unmapped we
1899 * can pretend this insn was not executed yet and get
1900 * the (correct) SIGSEGV after restart.
1902 instruction_pointer_set(regs
, bp_vaddr
);
1907 /* change it in advance for ->handler() and restart */
1908 instruction_pointer_set(regs
, bp_vaddr
);
1911 * TODO: move copy_insn/etc into _register and remove this hack.
1912 * After we hit the bp, _unregister + _register can install the
1913 * new and not-yet-analyzed uprobe at the same address, restart.
1915 smp_rmb(); /* pairs with wmb() in install_breakpoint() */
1916 if (unlikely(!test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
)))
1919 /* Tracing handlers use ->utask to communicate with fetch methods */
1923 if (arch_uprobe_ignore(&uprobe
->arch
, regs
))
1926 handler_chain(uprobe
, regs
);
1928 if (arch_uprobe_skip_sstep(&uprobe
->arch
, regs
))
1931 if (!pre_ssout(uprobe
, regs
, bp_vaddr
))
1934 /* arch_uprobe_skip_sstep() succeeded, or restart if can't singlestep */
1940 * Perform required fix-ups and disable singlestep.
1941 * Allow pending signals to take effect.
1943 static void handle_singlestep(struct uprobe_task
*utask
, struct pt_regs
*regs
)
1945 struct uprobe
*uprobe
;
1948 uprobe
= utask
->active_uprobe
;
1949 if (utask
->state
== UTASK_SSTEP_ACK
)
1950 err
= arch_uprobe_post_xol(&uprobe
->arch
, regs
);
1951 else if (utask
->state
== UTASK_SSTEP_TRAPPED
)
1952 arch_uprobe_abort_xol(&uprobe
->arch
, regs
);
1957 utask
->active_uprobe
= NULL
;
1958 utask
->state
= UTASK_RUNNING
;
1959 xol_free_insn_slot(current
);
1961 spin_lock_irq(¤t
->sighand
->siglock
);
1962 recalc_sigpending(); /* see uprobe_deny_signal() */
1963 spin_unlock_irq(¤t
->sighand
->siglock
);
1965 if (unlikely(err
)) {
1966 uprobe_warn(current
, "execute the probed insn, sending SIGILL.");
1967 force_sig_info(SIGILL
, SEND_SIG_FORCED
, current
);
1972 * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1973 * allows the thread to return from interrupt. After that handle_swbp()
1974 * sets utask->active_uprobe.
1976 * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1977 * and allows the thread to return from interrupt.
1979 * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1980 * uprobe_notify_resume().
1982 void uprobe_notify_resume(struct pt_regs
*regs
)
1984 struct uprobe_task
*utask
;
1986 clear_thread_flag(TIF_UPROBE
);
1988 utask
= current
->utask
;
1989 if (utask
&& utask
->active_uprobe
)
1990 handle_singlestep(utask
, regs
);
1996 * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1997 * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1999 int uprobe_pre_sstep_notifier(struct pt_regs
*regs
)
2004 if (!test_bit(MMF_HAS_UPROBES
, ¤t
->mm
->flags
) &&
2005 (!current
->utask
|| !current
->utask
->return_instances
))
2008 set_thread_flag(TIF_UPROBE
);
2013 * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
2014 * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
2016 int uprobe_post_sstep_notifier(struct pt_regs
*regs
)
2018 struct uprobe_task
*utask
= current
->utask
;
2020 if (!current
->mm
|| !utask
|| !utask
->active_uprobe
)
2021 /* task is currently not uprobed */
2024 utask
->state
= UTASK_SSTEP_ACK
;
2025 set_thread_flag(TIF_UPROBE
);
2029 static struct notifier_block uprobe_exception_nb
= {
2030 .notifier_call
= arch_uprobe_exception_notify
,
2031 .priority
= INT_MAX
-1, /* notified after kprobes, kgdb */
2034 static int __init
init_uprobes(void)
2038 for (i
= 0; i
< UPROBES_HASH_SZ
; i
++)
2039 mutex_init(&uprobes_mmap_mutex
[i
]);
2041 if (percpu_init_rwsem(&dup_mmap_sem
))
2044 return register_die_notifier(&uprobe_exception_nb
);
2046 __initcall(init_uprobes
);