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/export.h>
31 #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 */
34 #include <linux/ptrace.h> /* user_enable_single_step */
35 #include <linux/kdebug.h> /* notifier mechanism */
36 #include "../../mm/internal.h" /* munlock_vma_page */
37 #include <linux/percpu-rwsem.h>
38 #include <linux/task_work.h>
39 #include <linux/shmem_fs.h>
41 #include <linux/uprobes.h>
43 #define UINSNS_PER_PAGE (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
44 #define MAX_UPROBE_XOL_SLOTS UINSNS_PER_PAGE
46 static struct rb_root uprobes_tree
= RB_ROOT
;
48 * allows us to skip the uprobe_mmap if there are no uprobe events active
49 * at this time. Probably a fine grained per inode count is better?
51 #define no_uprobe_events() RB_EMPTY_ROOT(&uprobes_tree)
53 static DEFINE_SPINLOCK(uprobes_treelock
); /* serialize rbtree access */
55 #define UPROBES_HASH_SZ 13
56 /* serialize uprobe->pending_list */
57 static struct mutex uprobes_mmap_mutex
[UPROBES_HASH_SZ
];
58 #define uprobes_mmap_hash(v) (&uprobes_mmap_mutex[((unsigned long)(v)) % UPROBES_HASH_SZ])
60 static struct percpu_rw_semaphore dup_mmap_sem
;
62 /* Have a copy of original instruction */
63 #define UPROBE_COPY_INSN 0
66 struct rb_node rb_node
; /* node in the rb tree */
68 struct rw_semaphore register_rwsem
;
69 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 */
77 * The generic code assumes that it has two members of unknown type
78 * owned by the arch-specific code:
80 * insn - copy_insn() saves the original instruction here for
81 * arch_uprobe_analyze_insn().
83 * ixol - potentially modified instruction to execute out of
84 * line, copied to xol_area by xol_get_insn_slot().
86 struct arch_uprobe arch
;
90 * Execute out of line area: anonymous executable mapping installed
91 * by the probed task to execute the copy of the original instruction
92 * mangled by set_swbp().
94 * On a breakpoint hit, thread contests for a slot. It frees the
95 * slot after singlestep. Currently a fixed number of slots are
99 wait_queue_head_t wq
; /* if all slots are busy */
100 atomic_t slot_count
; /* number of in-use slots */
101 unsigned long *bitmap
; /* 0 = free slot */
103 struct vm_special_mapping xol_mapping
;
104 struct page
*pages
[2];
106 * We keep the vma's vm_start rather than a pointer to the vma
107 * itself. The probed process or a naughty kernel module could make
108 * the vma go away, and we must handle that reasonably gracefully.
110 unsigned long vaddr
; /* Page(s) of instruction slots */
114 * valid_vma: Verify if the specified vma is an executable vma
115 * Relax restrictions while unregistering: vm_flags might have
116 * changed after breakpoint was inserted.
117 * - is_register: indicates if we are in register context.
118 * - Return 1 if the specified virtual address is in an
121 static bool valid_vma(struct vm_area_struct
*vma
, bool is_register
)
123 vm_flags_t flags
= VM_HUGETLB
| VM_MAYEXEC
| VM_MAYSHARE
;
128 return vma
->vm_file
&& (vma
->vm_flags
& flags
) == VM_MAYEXEC
;
131 static unsigned long offset_to_vaddr(struct vm_area_struct
*vma
, loff_t offset
)
133 return vma
->vm_start
+ offset
- ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
);
136 static loff_t
vaddr_to_offset(struct vm_area_struct
*vma
, unsigned long vaddr
)
138 return ((loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
) + (vaddr
- vma
->vm_start
);
142 * __replace_page - replace page in vma by new page.
143 * based on replace_page in mm/ksm.c
145 * @vma: vma that holds the pte pointing to page
146 * @addr: address the old @page is mapped at
147 * @page: the cowed page we are replacing by kpage
148 * @kpage: the modified page we replace page by
150 * Returns 0 on success, -EFAULT on failure.
152 static int __replace_page(struct vm_area_struct
*vma
, unsigned long addr
,
153 struct page
*page
, struct page
*kpage
)
155 struct mm_struct
*mm
= vma
->vm_mm
;
159 /* For mmu_notifiers */
160 const unsigned long mmun_start
= addr
;
161 const unsigned long mmun_end
= addr
+ PAGE_SIZE
;
162 struct mem_cgroup
*memcg
;
164 err
= mem_cgroup_try_charge(kpage
, vma
->vm_mm
, GFP_KERNEL
, &memcg
);
168 /* For try_to_free_swap() and munlock_vma_page() below */
171 mmu_notifier_invalidate_range_start(mm
, mmun_start
, mmun_end
);
173 ptep
= page_check_address(page
, mm
, addr
, &ptl
, 0);
178 page_add_new_anon_rmap(kpage
, vma
, addr
);
179 mem_cgroup_commit_charge(kpage
, memcg
, false);
180 lru_cache_add_active_or_unevictable(kpage
, vma
);
182 if (!PageAnon(page
)) {
183 dec_mm_counter(mm
, MM_FILEPAGES
);
184 inc_mm_counter(mm
, MM_ANONPAGES
);
187 flush_cache_page(vma
, addr
, pte_pfn(*ptep
));
188 ptep_clear_flush_notify(vma
, addr
, ptep
);
189 set_pte_at_notify(mm
, addr
, ptep
, mk_pte(kpage
, vma
->vm_page_prot
));
191 page_remove_rmap(page
);
192 if (!page_mapped(page
))
193 try_to_free_swap(page
);
194 pte_unmap_unlock(ptep
, ptl
);
196 if (vma
->vm_flags
& VM_LOCKED
)
197 munlock_vma_page(page
);
202 mem_cgroup_cancel_charge(kpage
, memcg
);
203 mmu_notifier_invalidate_range_end(mm
, mmun_start
, mmun_end
);
209 * is_swbp_insn - check if instruction is breakpoint instruction.
210 * @insn: instruction to be checked.
211 * Default implementation of is_swbp_insn
212 * Returns true if @insn is a breakpoint instruction.
214 bool __weak
is_swbp_insn(uprobe_opcode_t
*insn
)
216 return *insn
== UPROBE_SWBP_INSN
;
220 * is_trap_insn - check if instruction is breakpoint instruction.
221 * @insn: instruction to be checked.
222 * Default implementation of is_trap_insn
223 * Returns true if @insn is a breakpoint instruction.
225 * This function is needed for the case where an architecture has multiple
226 * trap instructions (like powerpc).
228 bool __weak
is_trap_insn(uprobe_opcode_t
*insn
)
230 return is_swbp_insn(insn
);
233 static void copy_from_page(struct page
*page
, unsigned long vaddr
, void *dst
, int len
)
235 void *kaddr
= kmap_atomic(page
);
236 memcpy(dst
, kaddr
+ (vaddr
& ~PAGE_MASK
), len
);
237 kunmap_atomic(kaddr
);
240 static void copy_to_page(struct page
*page
, unsigned long vaddr
, const void *src
, int len
)
242 void *kaddr
= kmap_atomic(page
);
243 memcpy(kaddr
+ (vaddr
& ~PAGE_MASK
), src
, len
);
244 kunmap_atomic(kaddr
);
247 static int verify_opcode(struct page
*page
, unsigned long vaddr
, uprobe_opcode_t
*new_opcode
)
249 uprobe_opcode_t old_opcode
;
253 * Note: We only check if the old_opcode is UPROBE_SWBP_INSN here.
254 * We do not check if it is any other 'trap variant' which could
255 * be conditional trap instruction such as the one powerpc supports.
257 * The logic is that we do not care if the underlying instruction
258 * is a trap variant; uprobes always wins over any other (gdb)
261 copy_from_page(page
, vaddr
, &old_opcode
, UPROBE_SWBP_INSN_SIZE
);
262 is_swbp
= is_swbp_insn(&old_opcode
);
264 if (is_swbp_insn(new_opcode
)) {
265 if (is_swbp
) /* register: already installed? */
268 if (!is_swbp
) /* unregister: was it changed by us? */
277 * Expect the breakpoint instruction to be the smallest size instruction for
278 * the architecture. If an arch has variable length instruction and the
279 * breakpoint instruction is not of the smallest length instruction
280 * supported by that architecture then we need to modify is_trap_at_addr and
281 * uprobe_write_opcode accordingly. This would never be a problem for archs
282 * that have fixed length instructions.
284 * uprobe_write_opcode - write the opcode at a given virtual address.
285 * @mm: the probed process address space.
286 * @vaddr: the virtual address to store the opcode.
287 * @opcode: opcode to be written at @vaddr.
289 * Called with mm->mmap_sem held for write.
290 * Return 0 (success) or a negative errno.
292 int uprobe_write_opcode(struct mm_struct
*mm
, unsigned long vaddr
,
293 uprobe_opcode_t opcode
)
295 struct page
*old_page
, *new_page
;
296 struct vm_area_struct
*vma
;
300 /* Read the page with vaddr into memory */
301 ret
= get_user_pages(NULL
, mm
, vaddr
, 1, 0, 1, &old_page
, &vma
);
305 ret
= verify_opcode(old_page
, vaddr
, &opcode
);
309 ret
= anon_vma_prepare(vma
);
314 new_page
= alloc_page_vma(GFP_HIGHUSER_MOVABLE
, vma
, vaddr
);
318 __SetPageUptodate(new_page
);
319 copy_highpage(new_page
, old_page
);
320 copy_to_page(new_page
, vaddr
, &opcode
, UPROBE_SWBP_INSN_SIZE
);
322 ret
= __replace_page(vma
, vaddr
, old_page
, new_page
);
323 page_cache_release(new_page
);
327 if (unlikely(ret
== -EAGAIN
))
333 * set_swbp - store breakpoint at a given address.
334 * @auprobe: arch specific probepoint information.
335 * @mm: the probed process address space.
336 * @vaddr: the virtual address to insert the opcode.
338 * For mm @mm, store the breakpoint instruction at @vaddr.
339 * Return 0 (success) or a negative errno.
341 int __weak
set_swbp(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
343 return uprobe_write_opcode(mm
, vaddr
, UPROBE_SWBP_INSN
);
347 * set_orig_insn - Restore the original instruction.
348 * @mm: the probed process address space.
349 * @auprobe: arch specific probepoint information.
350 * @vaddr: the virtual address to insert the opcode.
352 * For mm @mm, restore the original opcode (opcode) at @vaddr.
353 * Return 0 (success) or a negative errno.
356 set_orig_insn(struct arch_uprobe
*auprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
358 return uprobe_write_opcode(mm
, vaddr
, *(uprobe_opcode_t
*)&auprobe
->insn
);
361 static struct uprobe
*get_uprobe(struct uprobe
*uprobe
)
363 atomic_inc(&uprobe
->ref
);
367 static void put_uprobe(struct uprobe
*uprobe
)
369 if (atomic_dec_and_test(&uprobe
->ref
))
373 static int match_uprobe(struct uprobe
*l
, struct uprobe
*r
)
375 if (l
->inode
< r
->inode
)
378 if (l
->inode
> r
->inode
)
381 if (l
->offset
< r
->offset
)
384 if (l
->offset
> r
->offset
)
390 static struct uprobe
*__find_uprobe(struct inode
*inode
, loff_t offset
)
392 struct uprobe u
= { .inode
= inode
, .offset
= offset
};
393 struct rb_node
*n
= uprobes_tree
.rb_node
;
394 struct uprobe
*uprobe
;
398 uprobe
= rb_entry(n
, struct uprobe
, rb_node
);
399 match
= match_uprobe(&u
, uprobe
);
401 return get_uprobe(uprobe
);
412 * Find a uprobe corresponding to a given inode:offset
413 * Acquires uprobes_treelock
415 static struct uprobe
*find_uprobe(struct inode
*inode
, loff_t offset
)
417 struct uprobe
*uprobe
;
419 spin_lock(&uprobes_treelock
);
420 uprobe
= __find_uprobe(inode
, offset
);
421 spin_unlock(&uprobes_treelock
);
426 static struct uprobe
*__insert_uprobe(struct uprobe
*uprobe
)
428 struct rb_node
**p
= &uprobes_tree
.rb_node
;
429 struct rb_node
*parent
= NULL
;
435 u
= rb_entry(parent
, struct uprobe
, rb_node
);
436 match
= match_uprobe(uprobe
, u
);
438 return get_uprobe(u
);
441 p
= &parent
->rb_left
;
443 p
= &parent
->rb_right
;
448 rb_link_node(&uprobe
->rb_node
, parent
, p
);
449 rb_insert_color(&uprobe
->rb_node
, &uprobes_tree
);
450 /* get access + creation ref */
451 atomic_set(&uprobe
->ref
, 2);
457 * Acquire uprobes_treelock.
458 * Matching uprobe already exists in rbtree;
459 * increment (access refcount) and return the matching uprobe.
461 * No matching uprobe; insert the uprobe in rb_tree;
462 * get a double refcount (access + creation) and return NULL.
464 static struct uprobe
*insert_uprobe(struct uprobe
*uprobe
)
468 spin_lock(&uprobes_treelock
);
469 u
= __insert_uprobe(uprobe
);
470 spin_unlock(&uprobes_treelock
);
475 static struct uprobe
*alloc_uprobe(struct inode
*inode
, loff_t offset
)
477 struct uprobe
*uprobe
, *cur_uprobe
;
479 uprobe
= kzalloc(sizeof(struct uprobe
), GFP_KERNEL
);
483 uprobe
->inode
= igrab(inode
);
484 uprobe
->offset
= offset
;
485 init_rwsem(&uprobe
->register_rwsem
);
486 init_rwsem(&uprobe
->consumer_rwsem
);
488 /* add to uprobes_tree, sorted on inode:offset */
489 cur_uprobe
= insert_uprobe(uprobe
);
490 /* a uprobe exists for this inode:offset combination */
500 static void consumer_add(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
502 down_write(&uprobe
->consumer_rwsem
);
503 uc
->next
= uprobe
->consumers
;
504 uprobe
->consumers
= uc
;
505 up_write(&uprobe
->consumer_rwsem
);
509 * For uprobe @uprobe, delete the consumer @uc.
510 * Return true if the @uc is deleted successfully
513 static bool consumer_del(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
515 struct uprobe_consumer
**con
;
518 down_write(&uprobe
->consumer_rwsem
);
519 for (con
= &uprobe
->consumers
; *con
; con
= &(*con
)->next
) {
526 up_write(&uprobe
->consumer_rwsem
);
531 static int __copy_insn(struct address_space
*mapping
, struct file
*filp
,
532 void *insn
, int nbytes
, loff_t offset
)
536 * Ensure that the page that has the original instruction is populated
537 * and in page-cache. If ->readpage == NULL it must be shmem_mapping(),
538 * see uprobe_register().
540 if (mapping
->a_ops
->readpage
)
541 page
= read_mapping_page(mapping
, offset
>> PAGE_CACHE_SHIFT
, filp
);
543 page
= shmem_read_mapping_page(mapping
, offset
>> PAGE_CACHE_SHIFT
);
545 return PTR_ERR(page
);
547 copy_from_page(page
, offset
, insn
, nbytes
);
548 page_cache_release(page
);
553 static int copy_insn(struct uprobe
*uprobe
, struct file
*filp
)
555 struct address_space
*mapping
= uprobe
->inode
->i_mapping
;
556 loff_t offs
= uprobe
->offset
;
557 void *insn
= &uprobe
->arch
.insn
;
558 int size
= sizeof(uprobe
->arch
.insn
);
561 /* Copy only available bytes, -EIO if nothing was read */
563 if (offs
>= i_size_read(uprobe
->inode
))
566 len
= min_t(int, size
, PAGE_SIZE
- (offs
& ~PAGE_MASK
));
567 err
= __copy_insn(mapping
, filp
, insn
, len
, offs
);
579 static int prepare_uprobe(struct uprobe
*uprobe
, struct file
*file
,
580 struct mm_struct
*mm
, unsigned long vaddr
)
584 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
587 /* TODO: move this into _register, until then we abuse this sem. */
588 down_write(&uprobe
->consumer_rwsem
);
589 if (test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
))
592 ret
= copy_insn(uprobe
, file
);
597 if (is_trap_insn((uprobe_opcode_t
*)&uprobe
->arch
.insn
))
600 ret
= arch_uprobe_analyze_insn(&uprobe
->arch
, mm
, vaddr
);
604 /* uprobe_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 up_write(&uprobe
->consumer_rwsem
);
617 static inline bool consumer_filter(struct uprobe_consumer
*uc
,
618 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
620 return !uc
->filter
|| uc
->filter(uc
, ctx
, mm
);
623 static bool filter_chain(struct uprobe
*uprobe
,
624 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
626 struct uprobe_consumer
*uc
;
629 down_read(&uprobe
->consumer_rwsem
);
630 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
631 ret
= consumer_filter(uc
, ctx
, mm
);
635 up_read(&uprobe
->consumer_rwsem
);
641 install_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
,
642 struct vm_area_struct
*vma
, unsigned long vaddr
)
647 ret
= prepare_uprobe(uprobe
, vma
->vm_file
, mm
, vaddr
);
652 * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
653 * the task can hit this breakpoint right after __replace_page().
655 first_uprobe
= !test_bit(MMF_HAS_UPROBES
, &mm
->flags
);
657 set_bit(MMF_HAS_UPROBES
, &mm
->flags
);
659 ret
= set_swbp(&uprobe
->arch
, mm
, vaddr
);
661 clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
662 else if (first_uprobe
)
663 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
669 remove_breakpoint(struct uprobe
*uprobe
, struct mm_struct
*mm
, unsigned long vaddr
)
671 set_bit(MMF_RECALC_UPROBES
, &mm
->flags
);
672 return set_orig_insn(&uprobe
->arch
, mm
, vaddr
);
675 static inline bool uprobe_is_active(struct uprobe
*uprobe
)
677 return !RB_EMPTY_NODE(&uprobe
->rb_node
);
680 * There could be threads that have already hit the breakpoint. They
681 * will recheck the current insn and restart if find_uprobe() fails.
682 * See find_active_uprobe().
684 static void delete_uprobe(struct uprobe
*uprobe
)
686 if (WARN_ON(!uprobe_is_active(uprobe
)))
689 spin_lock(&uprobes_treelock
);
690 rb_erase(&uprobe
->rb_node
, &uprobes_tree
);
691 spin_unlock(&uprobes_treelock
);
692 RB_CLEAR_NODE(&uprobe
->rb_node
); /* for uprobe_is_active() */
698 struct map_info
*next
;
699 struct mm_struct
*mm
;
703 static inline struct map_info
*free_map_info(struct map_info
*info
)
705 struct map_info
*next
= info
->next
;
710 static struct map_info
*
711 build_map_info(struct address_space
*mapping
, loff_t offset
, bool is_register
)
713 unsigned long pgoff
= offset
>> PAGE_SHIFT
;
714 struct vm_area_struct
*vma
;
715 struct map_info
*curr
= NULL
;
716 struct map_info
*prev
= NULL
;
717 struct map_info
*info
;
721 i_mmap_lock_read(mapping
);
722 vma_interval_tree_foreach(vma
, &mapping
->i_mmap
, pgoff
, pgoff
) {
723 if (!valid_vma(vma
, is_register
))
726 if (!prev
&& !more
) {
728 * Needs GFP_NOWAIT to avoid i_mmap_rwsem recursion through
729 * reclaim. This is optimistic, no harm done if it fails.
731 prev
= kmalloc(sizeof(struct map_info
),
732 GFP_NOWAIT
| __GFP_NOMEMALLOC
| __GFP_NOWARN
);
741 if (!atomic_inc_not_zero(&vma
->vm_mm
->mm_users
))
749 info
->mm
= vma
->vm_mm
;
750 info
->vaddr
= offset_to_vaddr(vma
, offset
);
752 i_mmap_unlock_read(mapping
);
764 info
= kmalloc(sizeof(struct map_info
), GFP_KERNEL
);
766 curr
= ERR_PTR(-ENOMEM
);
776 prev
= free_map_info(prev
);
781 register_for_each_vma(struct uprobe
*uprobe
, struct uprobe_consumer
*new)
783 bool is_register
= !!new;
784 struct map_info
*info
;
787 percpu_down_write(&dup_mmap_sem
);
788 info
= build_map_info(uprobe
->inode
->i_mapping
,
789 uprobe
->offset
, is_register
);
796 struct mm_struct
*mm
= info
->mm
;
797 struct vm_area_struct
*vma
;
799 if (err
&& is_register
)
802 down_write(&mm
->mmap_sem
);
803 vma
= find_vma(mm
, info
->vaddr
);
804 if (!vma
|| !valid_vma(vma
, is_register
) ||
805 file_inode(vma
->vm_file
) != uprobe
->inode
)
808 if (vma
->vm_start
> info
->vaddr
||
809 vaddr_to_offset(vma
, info
->vaddr
) != uprobe
->offset
)
813 /* consult only the "caller", new consumer. */
814 if (consumer_filter(new,
815 UPROBE_FILTER_REGISTER
, mm
))
816 err
= install_breakpoint(uprobe
, mm
, vma
, info
->vaddr
);
817 } else if (test_bit(MMF_HAS_UPROBES
, &mm
->flags
)) {
818 if (!filter_chain(uprobe
,
819 UPROBE_FILTER_UNREGISTER
, mm
))
820 err
|= remove_breakpoint(uprobe
, mm
, info
->vaddr
);
824 up_write(&mm
->mmap_sem
);
827 info
= free_map_info(info
);
830 percpu_up_write(&dup_mmap_sem
);
834 static int __uprobe_register(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
836 consumer_add(uprobe
, uc
);
837 return register_for_each_vma(uprobe
, uc
);
840 static void __uprobe_unregister(struct uprobe
*uprobe
, struct uprobe_consumer
*uc
)
844 if (WARN_ON(!consumer_del(uprobe
, uc
)))
847 err
= register_for_each_vma(uprobe
, NULL
);
848 /* TODO : cant unregister? schedule a worker thread */
849 if (!uprobe
->consumers
&& !err
)
850 delete_uprobe(uprobe
);
854 * uprobe_register - register a probe
855 * @inode: the file in which the probe has to be placed.
856 * @offset: offset from the start of the file.
857 * @uc: information on howto handle the probe..
859 * Apart from the access refcount, uprobe_register() takes a creation
860 * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
861 * inserted into the rbtree (i.e first consumer for a @inode:@offset
862 * tuple). Creation refcount stops uprobe_unregister from freeing the
863 * @uprobe even before the register operation is complete. Creation
864 * refcount is released when the last @uc for the @uprobe
867 * Return errno if it cannot successully install probes
868 * else return 0 (success)
870 int uprobe_register(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
872 struct uprobe
*uprobe
;
875 /* Uprobe must have at least one set consumer */
876 if (!uc
->handler
&& !uc
->ret_handler
)
879 /* copy_insn() uses read_mapping_page() or shmem_read_mapping_page() */
880 if (!inode
->i_mapping
->a_ops
->readpage
&& !shmem_mapping(inode
->i_mapping
))
882 /* Racy, just to catch the obvious mistakes */
883 if (offset
> i_size_read(inode
))
887 uprobe
= alloc_uprobe(inode
, offset
);
891 * We can race with uprobe_unregister()->delete_uprobe().
892 * Check uprobe_is_active() and retry if it is false.
894 down_write(&uprobe
->register_rwsem
);
896 if (likely(uprobe_is_active(uprobe
))) {
897 ret
= __uprobe_register(uprobe
, uc
);
899 __uprobe_unregister(uprobe
, uc
);
901 up_write(&uprobe
->register_rwsem
);
904 if (unlikely(ret
== -EAGAIN
))
908 EXPORT_SYMBOL_GPL(uprobe_register
);
911 * uprobe_apply - unregister a already registered probe.
912 * @inode: the file in which the probe has to be removed.
913 * @offset: offset from the start of the file.
914 * @uc: consumer which wants to add more or remove some breakpoints
915 * @add: add or remove the breakpoints
917 int uprobe_apply(struct inode
*inode
, loff_t offset
,
918 struct uprobe_consumer
*uc
, bool add
)
920 struct uprobe
*uprobe
;
921 struct uprobe_consumer
*con
;
924 uprobe
= find_uprobe(inode
, offset
);
925 if (WARN_ON(!uprobe
))
928 down_write(&uprobe
->register_rwsem
);
929 for (con
= uprobe
->consumers
; con
&& con
!= uc
; con
= con
->next
)
932 ret
= register_for_each_vma(uprobe
, add
? uc
: NULL
);
933 up_write(&uprobe
->register_rwsem
);
940 * uprobe_unregister - unregister a already registered probe.
941 * @inode: the file in which the probe has to be removed.
942 * @offset: offset from the start of the file.
943 * @uc: identify which probe if multiple probes are colocated.
945 void uprobe_unregister(struct inode
*inode
, loff_t offset
, struct uprobe_consumer
*uc
)
947 struct uprobe
*uprobe
;
949 uprobe
= find_uprobe(inode
, offset
);
950 if (WARN_ON(!uprobe
))
953 down_write(&uprobe
->register_rwsem
);
954 __uprobe_unregister(uprobe
, uc
);
955 up_write(&uprobe
->register_rwsem
);
958 EXPORT_SYMBOL_GPL(uprobe_unregister
);
960 static int unapply_uprobe(struct uprobe
*uprobe
, struct mm_struct
*mm
)
962 struct vm_area_struct
*vma
;
965 down_read(&mm
->mmap_sem
);
966 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
970 if (!valid_vma(vma
, false) ||
971 file_inode(vma
->vm_file
) != uprobe
->inode
)
974 offset
= (loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
;
975 if (uprobe
->offset
< offset
||
976 uprobe
->offset
>= offset
+ vma
->vm_end
- vma
->vm_start
)
979 vaddr
= offset_to_vaddr(vma
, uprobe
->offset
);
980 err
|= remove_breakpoint(uprobe
, mm
, vaddr
);
982 up_read(&mm
->mmap_sem
);
987 static struct rb_node
*
988 find_node_in_range(struct inode
*inode
, loff_t min
, loff_t max
)
990 struct rb_node
*n
= uprobes_tree
.rb_node
;
993 struct uprobe
*u
= rb_entry(n
, struct uprobe
, rb_node
);
995 if (inode
< u
->inode
) {
997 } else if (inode
> u
->inode
) {
1000 if (max
< u
->offset
)
1002 else if (min
> u
->offset
)
1013 * For a given range in vma, build a list of probes that need to be inserted.
1015 static void build_probe_list(struct inode
*inode
,
1016 struct vm_area_struct
*vma
,
1017 unsigned long start
, unsigned long end
,
1018 struct list_head
*head
)
1021 struct rb_node
*n
, *t
;
1024 INIT_LIST_HEAD(head
);
1025 min
= vaddr_to_offset(vma
, start
);
1026 max
= min
+ (end
- start
) - 1;
1028 spin_lock(&uprobes_treelock
);
1029 n
= find_node_in_range(inode
, min
, max
);
1031 for (t
= n
; t
; t
= rb_prev(t
)) {
1032 u
= rb_entry(t
, struct uprobe
, rb_node
);
1033 if (u
->inode
!= inode
|| u
->offset
< min
)
1035 list_add(&u
->pending_list
, head
);
1038 for (t
= n
; (t
= rb_next(t
)); ) {
1039 u
= rb_entry(t
, struct uprobe
, rb_node
);
1040 if (u
->inode
!= inode
|| u
->offset
> max
)
1042 list_add(&u
->pending_list
, head
);
1046 spin_unlock(&uprobes_treelock
);
1050 * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
1052 * Currently we ignore all errors and always return 0, the callers
1053 * can't handle the failure anyway.
1055 int uprobe_mmap(struct vm_area_struct
*vma
)
1057 struct list_head tmp_list
;
1058 struct uprobe
*uprobe
, *u
;
1059 struct inode
*inode
;
1061 if (no_uprobe_events() || !valid_vma(vma
, true))
1064 inode
= file_inode(vma
->vm_file
);
1068 mutex_lock(uprobes_mmap_hash(inode
));
1069 build_probe_list(inode
, vma
, vma
->vm_start
, vma
->vm_end
, &tmp_list
);
1071 * We can race with uprobe_unregister(), this uprobe can be already
1072 * removed. But in this case filter_chain() must return false, all
1073 * consumers have gone away.
1075 list_for_each_entry_safe(uprobe
, u
, &tmp_list
, pending_list
) {
1076 if (!fatal_signal_pending(current
) &&
1077 filter_chain(uprobe
, UPROBE_FILTER_MMAP
, vma
->vm_mm
)) {
1078 unsigned long vaddr
= offset_to_vaddr(vma
, uprobe
->offset
);
1079 install_breakpoint(uprobe
, vma
->vm_mm
, vma
, vaddr
);
1083 mutex_unlock(uprobes_mmap_hash(inode
));
1089 vma_has_uprobes(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1092 struct inode
*inode
;
1095 inode
= file_inode(vma
->vm_file
);
1097 min
= vaddr_to_offset(vma
, start
);
1098 max
= min
+ (end
- start
) - 1;
1100 spin_lock(&uprobes_treelock
);
1101 n
= find_node_in_range(inode
, min
, max
);
1102 spin_unlock(&uprobes_treelock
);
1108 * Called in context of a munmap of a vma.
1110 void uprobe_munmap(struct vm_area_struct
*vma
, unsigned long start
, unsigned long end
)
1112 if (no_uprobe_events() || !valid_vma(vma
, false))
1115 if (!atomic_read(&vma
->vm_mm
->mm_users
)) /* called by mmput() ? */
1118 if (!test_bit(MMF_HAS_UPROBES
, &vma
->vm_mm
->flags
) ||
1119 test_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
))
1122 if (vma_has_uprobes(vma
, start
, end
))
1123 set_bit(MMF_RECALC_UPROBES
, &vma
->vm_mm
->flags
);
1126 /* Slot allocation for XOL */
1127 static int xol_add_vma(struct mm_struct
*mm
, struct xol_area
*area
)
1129 struct vm_area_struct
*vma
;
1132 down_write(&mm
->mmap_sem
);
1133 if (mm
->uprobes_state
.xol_area
) {
1139 /* Try to map as high as possible, this is only a hint. */
1140 area
->vaddr
= get_unmapped_area(NULL
, TASK_SIZE
- PAGE_SIZE
,
1142 if (area
->vaddr
& ~PAGE_MASK
) {
1148 vma
= _install_special_mapping(mm
, area
->vaddr
, PAGE_SIZE
,
1149 VM_EXEC
|VM_MAYEXEC
|VM_DONTCOPY
|VM_IO
,
1150 &area
->xol_mapping
);
1157 smp_wmb(); /* pairs with get_xol_area() */
1158 mm
->uprobes_state
.xol_area
= area
;
1160 up_write(&mm
->mmap_sem
);
1165 static struct xol_area
*__create_xol_area(unsigned long vaddr
)
1167 struct mm_struct
*mm
= current
->mm
;
1168 uprobe_opcode_t insn
= UPROBE_SWBP_INSN
;
1169 struct xol_area
*area
;
1171 area
= kmalloc(sizeof(*area
), GFP_KERNEL
);
1172 if (unlikely(!area
))
1175 area
->bitmap
= kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE
) * sizeof(long), GFP_KERNEL
);
1179 area
->xol_mapping
.name
= "[uprobes]";
1180 area
->xol_mapping
.pages
= area
->pages
;
1181 area
->pages
[0] = alloc_page(GFP_HIGHUSER
);
1182 if (!area
->pages
[0])
1184 area
->pages
[1] = NULL
;
1186 area
->vaddr
= vaddr
;
1187 init_waitqueue_head(&area
->wq
);
1188 /* Reserve the 1st slot for get_trampoline_vaddr() */
1189 set_bit(0, area
->bitmap
);
1190 atomic_set(&area
->slot_count
, 1);
1191 copy_to_page(area
->pages
[0], 0, &insn
, UPROBE_SWBP_INSN_SIZE
);
1193 if (!xol_add_vma(mm
, area
))
1196 __free_page(area
->pages
[0]);
1198 kfree(area
->bitmap
);
1206 * get_xol_area - Allocate process's xol_area if necessary.
1207 * This area will be used for storing instructions for execution out of line.
1209 * Returns the allocated area or NULL.
1211 static struct xol_area
*get_xol_area(void)
1213 struct mm_struct
*mm
= current
->mm
;
1214 struct xol_area
*area
;
1216 if (!mm
->uprobes_state
.xol_area
)
1217 __create_xol_area(0);
1219 area
= mm
->uprobes_state
.xol_area
;
1220 smp_read_barrier_depends(); /* pairs with wmb in xol_add_vma() */
1225 * uprobe_clear_state - Free the area allocated for slots.
1227 void uprobe_clear_state(struct mm_struct
*mm
)
1229 struct xol_area
*area
= mm
->uprobes_state
.xol_area
;
1234 put_page(area
->pages
[0]);
1235 kfree(area
->bitmap
);
1239 void uprobe_start_dup_mmap(void)
1241 percpu_down_read(&dup_mmap_sem
);
1244 void uprobe_end_dup_mmap(void)
1246 percpu_up_read(&dup_mmap_sem
);
1249 void uprobe_dup_mmap(struct mm_struct
*oldmm
, struct mm_struct
*newmm
)
1251 newmm
->uprobes_state
.xol_area
= NULL
;
1253 if (test_bit(MMF_HAS_UPROBES
, &oldmm
->flags
)) {
1254 set_bit(MMF_HAS_UPROBES
, &newmm
->flags
);
1255 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1256 set_bit(MMF_RECALC_UPROBES
, &newmm
->flags
);
1261 * - search for a free slot.
1263 static unsigned long xol_take_insn_slot(struct xol_area
*area
)
1265 unsigned long slot_addr
;
1269 slot_nr
= find_first_zero_bit(area
->bitmap
, UINSNS_PER_PAGE
);
1270 if (slot_nr
< UINSNS_PER_PAGE
) {
1271 if (!test_and_set_bit(slot_nr
, area
->bitmap
))
1274 slot_nr
= UINSNS_PER_PAGE
;
1277 wait_event(area
->wq
, (atomic_read(&area
->slot_count
) < UINSNS_PER_PAGE
));
1278 } while (slot_nr
>= UINSNS_PER_PAGE
);
1280 slot_addr
= area
->vaddr
+ (slot_nr
* UPROBE_XOL_SLOT_BYTES
);
1281 atomic_inc(&area
->slot_count
);
1287 * xol_get_insn_slot - allocate a slot for xol.
1288 * Returns the allocated slot address or 0.
1290 static unsigned long xol_get_insn_slot(struct uprobe
*uprobe
)
1292 struct xol_area
*area
;
1293 unsigned long xol_vaddr
;
1295 area
= get_xol_area();
1299 xol_vaddr
= xol_take_insn_slot(area
);
1300 if (unlikely(!xol_vaddr
))
1303 arch_uprobe_copy_ixol(area
->pages
[0], xol_vaddr
,
1304 &uprobe
->arch
.ixol
, sizeof(uprobe
->arch
.ixol
));
1310 * xol_free_insn_slot - If slot was earlier allocated by
1311 * @xol_get_insn_slot(), make the slot available for
1312 * subsequent requests.
1314 static void xol_free_insn_slot(struct task_struct
*tsk
)
1316 struct xol_area
*area
;
1317 unsigned long vma_end
;
1318 unsigned long slot_addr
;
1320 if (!tsk
->mm
|| !tsk
->mm
->uprobes_state
.xol_area
|| !tsk
->utask
)
1323 slot_addr
= tsk
->utask
->xol_vaddr
;
1324 if (unlikely(!slot_addr
))
1327 area
= tsk
->mm
->uprobes_state
.xol_area
;
1328 vma_end
= area
->vaddr
+ PAGE_SIZE
;
1329 if (area
->vaddr
<= slot_addr
&& slot_addr
< vma_end
) {
1330 unsigned long offset
;
1333 offset
= slot_addr
- area
->vaddr
;
1334 slot_nr
= offset
/ UPROBE_XOL_SLOT_BYTES
;
1335 if (slot_nr
>= UINSNS_PER_PAGE
)
1338 clear_bit(slot_nr
, area
->bitmap
);
1339 atomic_dec(&area
->slot_count
);
1340 smp_mb__after_atomic(); /* pairs with prepare_to_wait() */
1341 if (waitqueue_active(&area
->wq
))
1344 tsk
->utask
->xol_vaddr
= 0;
1348 void __weak
arch_uprobe_copy_ixol(struct page
*page
, unsigned long vaddr
,
1349 void *src
, unsigned long len
)
1351 /* Initialize the slot */
1352 copy_to_page(page
, vaddr
, src
, len
);
1355 * We probably need flush_icache_user_range() but it needs vma.
1356 * This should work on most of architectures by default. If
1357 * architecture needs to do something different it can define
1358 * its own version of the function.
1360 flush_dcache_page(page
);
1364 * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1365 * @regs: Reflects the saved state of the task after it has hit a breakpoint
1367 * Return the address of the breakpoint instruction.
1369 unsigned long __weak
uprobe_get_swbp_addr(struct pt_regs
*regs
)
1371 return instruction_pointer(regs
) - UPROBE_SWBP_INSN_SIZE
;
1374 unsigned long uprobe_get_trap_addr(struct pt_regs
*regs
)
1376 struct uprobe_task
*utask
= current
->utask
;
1378 if (unlikely(utask
&& utask
->active_uprobe
))
1379 return utask
->vaddr
;
1381 return instruction_pointer(regs
);
1384 static struct return_instance
*free_ret_instance(struct return_instance
*ri
)
1386 struct return_instance
*next
= ri
->next
;
1387 put_uprobe(ri
->uprobe
);
1393 * Called with no locks held.
1394 * Called in context of a exiting or a exec-ing thread.
1396 void uprobe_free_utask(struct task_struct
*t
)
1398 struct uprobe_task
*utask
= t
->utask
;
1399 struct return_instance
*ri
;
1404 if (utask
->active_uprobe
)
1405 put_uprobe(utask
->active_uprobe
);
1407 ri
= utask
->return_instances
;
1409 ri
= free_ret_instance(ri
);
1411 xol_free_insn_slot(t
);
1417 * Allocate a uprobe_task object for the task if if necessary.
1418 * Called when the thread hits a breakpoint.
1421 * - pointer to new uprobe_task on success
1424 static struct uprobe_task
*get_utask(void)
1426 if (!current
->utask
)
1427 current
->utask
= kzalloc(sizeof(struct uprobe_task
), GFP_KERNEL
);
1428 return current
->utask
;
1431 static int dup_utask(struct task_struct
*t
, struct uprobe_task
*o_utask
)
1433 struct uprobe_task
*n_utask
;
1434 struct return_instance
**p
, *o
, *n
;
1436 n_utask
= kzalloc(sizeof(struct uprobe_task
), GFP_KERNEL
);
1441 p
= &n_utask
->return_instances
;
1442 for (o
= o_utask
->return_instances
; o
; o
= o
->next
) {
1443 n
= kmalloc(sizeof(struct return_instance
), GFP_KERNEL
);
1448 get_uprobe(n
->uprobe
);
1459 static void uprobe_warn(struct task_struct
*t
, const char *msg
)
1461 pr_warn("uprobe: %s:%d failed to %s\n",
1462 current
->comm
, current
->pid
, msg
);
1465 static void dup_xol_work(struct callback_head
*work
)
1467 if (current
->flags
& PF_EXITING
)
1470 if (!__create_xol_area(current
->utask
->dup_xol_addr
))
1471 uprobe_warn(current
, "dup xol area");
1475 * Called in context of a new clone/fork from copy_process.
1477 void uprobe_copy_process(struct task_struct
*t
, unsigned long flags
)
1479 struct uprobe_task
*utask
= current
->utask
;
1480 struct mm_struct
*mm
= current
->mm
;
1481 struct xol_area
*area
;
1485 if (!utask
|| !utask
->return_instances
)
1488 if (mm
== t
->mm
&& !(flags
& CLONE_VFORK
))
1491 if (dup_utask(t
, utask
))
1492 return uprobe_warn(t
, "dup ret instances");
1494 /* The task can fork() after dup_xol_work() fails */
1495 area
= mm
->uprobes_state
.xol_area
;
1497 return uprobe_warn(t
, "dup xol area");
1502 t
->utask
->dup_xol_addr
= area
->vaddr
;
1503 init_task_work(&t
->utask
->dup_xol_work
, dup_xol_work
);
1504 task_work_add(t
, &t
->utask
->dup_xol_work
, true);
1508 * Current area->vaddr notion assume the trampoline address is always
1509 * equal area->vaddr.
1511 * Returns -1 in case the xol_area is not allocated.
1513 static unsigned long get_trampoline_vaddr(void)
1515 struct xol_area
*area
;
1516 unsigned long trampoline_vaddr
= -1;
1518 area
= current
->mm
->uprobes_state
.xol_area
;
1519 smp_read_barrier_depends();
1521 trampoline_vaddr
= area
->vaddr
;
1523 return trampoline_vaddr
;
1526 static void cleanup_return_instances(struct uprobe_task
*utask
, bool chained
,
1527 struct pt_regs
*regs
)
1529 struct return_instance
*ri
= utask
->return_instances
;
1530 enum rp_check ctx
= chained
? RP_CHECK_CHAIN_CALL
: RP_CHECK_CALL
;
1532 while (ri
&& !arch_uretprobe_is_alive(ri
, ctx
, regs
)) {
1533 ri
= free_ret_instance(ri
);
1536 utask
->return_instances
= ri
;
1539 static void prepare_uretprobe(struct uprobe
*uprobe
, struct pt_regs
*regs
)
1541 struct return_instance
*ri
;
1542 struct uprobe_task
*utask
;
1543 unsigned long orig_ret_vaddr
, trampoline_vaddr
;
1546 if (!get_xol_area())
1549 utask
= get_utask();
1553 if (utask
->depth
>= MAX_URETPROBE_DEPTH
) {
1554 printk_ratelimited(KERN_INFO
"uprobe: omit uretprobe due to"
1555 " nestedness limit pid/tgid=%d/%d\n",
1556 current
->pid
, current
->tgid
);
1560 ri
= kmalloc(sizeof(struct return_instance
), GFP_KERNEL
);
1564 trampoline_vaddr
= get_trampoline_vaddr();
1565 orig_ret_vaddr
= arch_uretprobe_hijack_return_addr(trampoline_vaddr
, regs
);
1566 if (orig_ret_vaddr
== -1)
1569 /* drop the entries invalidated by longjmp() */
1570 chained
= (orig_ret_vaddr
== trampoline_vaddr
);
1571 cleanup_return_instances(utask
, chained
, regs
);
1574 * We don't want to keep trampoline address in stack, rather keep the
1575 * original return address of first caller thru all the consequent
1576 * instances. This also makes breakpoint unwrapping easier.
1579 if (!utask
->return_instances
) {
1581 * This situation is not possible. Likely we have an
1582 * attack from user-space.
1584 uprobe_warn(current
, "handle tail call");
1587 orig_ret_vaddr
= utask
->return_instances
->orig_ret_vaddr
;
1590 ri
->uprobe
= get_uprobe(uprobe
);
1591 ri
->func
= instruction_pointer(regs
);
1592 ri
->stack
= user_stack_pointer(regs
);
1593 ri
->orig_ret_vaddr
= orig_ret_vaddr
;
1594 ri
->chained
= chained
;
1597 ri
->next
= utask
->return_instances
;
1598 utask
->return_instances
= ri
;
1605 /* Prepare to single-step probed instruction out of line. */
1607 pre_ssout(struct uprobe
*uprobe
, struct pt_regs
*regs
, unsigned long bp_vaddr
)
1609 struct uprobe_task
*utask
;
1610 unsigned long xol_vaddr
;
1613 utask
= get_utask();
1617 xol_vaddr
= xol_get_insn_slot(uprobe
);
1621 utask
->xol_vaddr
= xol_vaddr
;
1622 utask
->vaddr
= bp_vaddr
;
1624 err
= arch_uprobe_pre_xol(&uprobe
->arch
, regs
);
1625 if (unlikely(err
)) {
1626 xol_free_insn_slot(current
);
1630 utask
->active_uprobe
= uprobe
;
1631 utask
->state
= UTASK_SSTEP
;
1636 * If we are singlestepping, then ensure this thread is not connected to
1637 * non-fatal signals until completion of singlestep. When xol insn itself
1638 * triggers the signal, restart the original insn even if the task is
1639 * already SIGKILL'ed (since coredump should report the correct ip). This
1640 * is even more important if the task has a handler for SIGSEGV/etc, The
1641 * _same_ instruction should be repeated again after return from the signal
1642 * handler, and SSTEP can never finish in this case.
1644 bool uprobe_deny_signal(void)
1646 struct task_struct
*t
= current
;
1647 struct uprobe_task
*utask
= t
->utask
;
1649 if (likely(!utask
|| !utask
->active_uprobe
))
1652 WARN_ON_ONCE(utask
->state
!= UTASK_SSTEP
);
1654 if (signal_pending(t
)) {
1655 spin_lock_irq(&t
->sighand
->siglock
);
1656 clear_tsk_thread_flag(t
, TIF_SIGPENDING
);
1657 spin_unlock_irq(&t
->sighand
->siglock
);
1659 if (__fatal_signal_pending(t
) || arch_uprobe_xol_was_trapped(t
)) {
1660 utask
->state
= UTASK_SSTEP_TRAPPED
;
1661 set_tsk_thread_flag(t
, TIF_UPROBE
);
1668 static void mmf_recalc_uprobes(struct mm_struct
*mm
)
1670 struct vm_area_struct
*vma
;
1672 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
1673 if (!valid_vma(vma
, false))
1676 * This is not strictly accurate, we can race with
1677 * uprobe_unregister() and see the already removed
1678 * uprobe if delete_uprobe() was not yet called.
1679 * Or this uprobe can be filtered out.
1681 if (vma_has_uprobes(vma
, vma
->vm_start
, vma
->vm_end
))
1685 clear_bit(MMF_HAS_UPROBES
, &mm
->flags
);
1688 static int is_trap_at_addr(struct mm_struct
*mm
, unsigned long vaddr
)
1691 uprobe_opcode_t opcode
;
1694 pagefault_disable();
1695 result
= __copy_from_user_inatomic(&opcode
, (void __user
*)vaddr
,
1699 if (likely(result
== 0))
1702 result
= get_user_pages(NULL
, mm
, vaddr
, 1, 0, 1, &page
, NULL
);
1706 copy_from_page(page
, vaddr
, &opcode
, UPROBE_SWBP_INSN_SIZE
);
1709 /* This needs to return true for any variant of the trap insn */
1710 return is_trap_insn(&opcode
);
1713 static struct uprobe
*find_active_uprobe(unsigned long bp_vaddr
, int *is_swbp
)
1715 struct mm_struct
*mm
= current
->mm
;
1716 struct uprobe
*uprobe
= NULL
;
1717 struct vm_area_struct
*vma
;
1719 down_read(&mm
->mmap_sem
);
1720 vma
= find_vma(mm
, bp_vaddr
);
1721 if (vma
&& vma
->vm_start
<= bp_vaddr
) {
1722 if (valid_vma(vma
, false)) {
1723 struct inode
*inode
= file_inode(vma
->vm_file
);
1724 loff_t offset
= vaddr_to_offset(vma
, bp_vaddr
);
1726 uprobe
= find_uprobe(inode
, offset
);
1730 *is_swbp
= is_trap_at_addr(mm
, bp_vaddr
);
1735 if (!uprobe
&& test_and_clear_bit(MMF_RECALC_UPROBES
, &mm
->flags
))
1736 mmf_recalc_uprobes(mm
);
1737 up_read(&mm
->mmap_sem
);
1742 static void handler_chain(struct uprobe
*uprobe
, struct pt_regs
*regs
)
1744 struct uprobe_consumer
*uc
;
1745 int remove
= UPROBE_HANDLER_REMOVE
;
1746 bool need_prep
= false; /* prepare return uprobe, when needed */
1748 down_read(&uprobe
->register_rwsem
);
1749 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
1753 rc
= uc
->handler(uc
, regs
);
1754 WARN(rc
& ~UPROBE_HANDLER_MASK
,
1755 "bad rc=0x%x from %pf()\n", rc
, uc
->handler
);
1758 if (uc
->ret_handler
)
1764 if (need_prep
&& !remove
)
1765 prepare_uretprobe(uprobe
, regs
); /* put bp at return */
1767 if (remove
&& uprobe
->consumers
) {
1768 WARN_ON(!uprobe_is_active(uprobe
));
1769 unapply_uprobe(uprobe
, current
->mm
);
1771 up_read(&uprobe
->register_rwsem
);
1775 handle_uretprobe_chain(struct return_instance
*ri
, struct pt_regs
*regs
)
1777 struct uprobe
*uprobe
= ri
->uprobe
;
1778 struct uprobe_consumer
*uc
;
1780 down_read(&uprobe
->register_rwsem
);
1781 for (uc
= uprobe
->consumers
; uc
; uc
= uc
->next
) {
1782 if (uc
->ret_handler
)
1783 uc
->ret_handler(uc
, ri
->func
, regs
);
1785 up_read(&uprobe
->register_rwsem
);
1788 static struct return_instance
*find_next_ret_chain(struct return_instance
*ri
)
1793 chained
= ri
->chained
;
1794 ri
= ri
->next
; /* can't be NULL if chained */
1800 static void handle_trampoline(struct pt_regs
*regs
)
1802 struct uprobe_task
*utask
;
1803 struct return_instance
*ri
, *next
;
1806 utask
= current
->utask
;
1810 ri
= utask
->return_instances
;
1816 * We should throw out the frames invalidated by longjmp().
1817 * If this chain is valid, then the next one should be alive
1818 * or NULL; the latter case means that nobody but ri->func
1819 * could hit this trampoline on return. TODO: sigaltstack().
1821 next
= find_next_ret_chain(ri
);
1822 valid
= !next
|| arch_uretprobe_is_alive(next
, RP_CHECK_RET
, regs
);
1824 instruction_pointer_set(regs
, ri
->orig_ret_vaddr
);
1827 handle_uretprobe_chain(ri
, regs
);
1828 ri
= free_ret_instance(ri
);
1830 } while (ri
!= next
);
1833 utask
->return_instances
= ri
;
1837 uprobe_warn(current
, "handle uretprobe, sending SIGILL.");
1838 force_sig_info(SIGILL
, SEND_SIG_FORCED
, current
);
1842 bool __weak
arch_uprobe_ignore(struct arch_uprobe
*aup
, struct pt_regs
*regs
)
1847 bool __weak
arch_uretprobe_is_alive(struct return_instance
*ret
, enum rp_check ctx
,
1848 struct pt_regs
*regs
)
1854 * Run handler and ask thread to singlestep.
1855 * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1857 static void handle_swbp(struct pt_regs
*regs
)
1859 struct uprobe
*uprobe
;
1860 unsigned long bp_vaddr
;
1861 int uninitialized_var(is_swbp
);
1863 bp_vaddr
= uprobe_get_swbp_addr(regs
);
1864 if (bp_vaddr
== get_trampoline_vaddr())
1865 return handle_trampoline(regs
);
1867 uprobe
= find_active_uprobe(bp_vaddr
, &is_swbp
);
1870 /* No matching uprobe; signal SIGTRAP. */
1871 send_sig(SIGTRAP
, current
, 0);
1874 * Either we raced with uprobe_unregister() or we can't
1875 * access this memory. The latter is only possible if
1876 * another thread plays with our ->mm. In both cases
1877 * we can simply restart. If this vma was unmapped we
1878 * can pretend this insn was not executed yet and get
1879 * the (correct) SIGSEGV after restart.
1881 instruction_pointer_set(regs
, bp_vaddr
);
1886 /* change it in advance for ->handler() and restart */
1887 instruction_pointer_set(regs
, bp_vaddr
);
1890 * TODO: move copy_insn/etc into _register and remove this hack.
1891 * After we hit the bp, _unregister + _register can install the
1892 * new and not-yet-analyzed uprobe at the same address, restart.
1894 smp_rmb(); /* pairs with wmb() in install_breakpoint() */
1895 if (unlikely(!test_bit(UPROBE_COPY_INSN
, &uprobe
->flags
)))
1898 /* Tracing handlers use ->utask to communicate with fetch methods */
1902 if (arch_uprobe_ignore(&uprobe
->arch
, regs
))
1905 handler_chain(uprobe
, regs
);
1907 if (arch_uprobe_skip_sstep(&uprobe
->arch
, regs
))
1910 if (!pre_ssout(uprobe
, regs
, bp_vaddr
))
1913 /* arch_uprobe_skip_sstep() succeeded, or restart if can't singlestep */
1919 * Perform required fix-ups and disable singlestep.
1920 * Allow pending signals to take effect.
1922 static void handle_singlestep(struct uprobe_task
*utask
, struct pt_regs
*regs
)
1924 struct uprobe
*uprobe
;
1927 uprobe
= utask
->active_uprobe
;
1928 if (utask
->state
== UTASK_SSTEP_ACK
)
1929 err
= arch_uprobe_post_xol(&uprobe
->arch
, regs
);
1930 else if (utask
->state
== UTASK_SSTEP_TRAPPED
)
1931 arch_uprobe_abort_xol(&uprobe
->arch
, regs
);
1936 utask
->active_uprobe
= NULL
;
1937 utask
->state
= UTASK_RUNNING
;
1938 xol_free_insn_slot(current
);
1940 spin_lock_irq(¤t
->sighand
->siglock
);
1941 recalc_sigpending(); /* see uprobe_deny_signal() */
1942 spin_unlock_irq(¤t
->sighand
->siglock
);
1944 if (unlikely(err
)) {
1945 uprobe_warn(current
, "execute the probed insn, sending SIGILL.");
1946 force_sig_info(SIGILL
, SEND_SIG_FORCED
, current
);
1951 * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1952 * allows the thread to return from interrupt. After that handle_swbp()
1953 * sets utask->active_uprobe.
1955 * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1956 * and allows the thread to return from interrupt.
1958 * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1959 * uprobe_notify_resume().
1961 void uprobe_notify_resume(struct pt_regs
*regs
)
1963 struct uprobe_task
*utask
;
1965 clear_thread_flag(TIF_UPROBE
);
1967 utask
= current
->utask
;
1968 if (utask
&& utask
->active_uprobe
)
1969 handle_singlestep(utask
, regs
);
1975 * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1976 * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1978 int uprobe_pre_sstep_notifier(struct pt_regs
*regs
)
1983 if (!test_bit(MMF_HAS_UPROBES
, ¤t
->mm
->flags
) &&
1984 (!current
->utask
|| !current
->utask
->return_instances
))
1987 set_thread_flag(TIF_UPROBE
);
1992 * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
1993 * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
1995 int uprobe_post_sstep_notifier(struct pt_regs
*regs
)
1997 struct uprobe_task
*utask
= current
->utask
;
1999 if (!current
->mm
|| !utask
|| !utask
->active_uprobe
)
2000 /* task is currently not uprobed */
2003 utask
->state
= UTASK_SSTEP_ACK
;
2004 set_thread_flag(TIF_UPROBE
);
2008 static struct notifier_block uprobe_exception_nb
= {
2009 .notifier_call
= arch_uprobe_exception_notify
,
2010 .priority
= INT_MAX
-1, /* notified after kprobes, kgdb */
2013 static int __init
init_uprobes(void)
2017 for (i
= 0; i
< UPROBES_HASH_SZ
; i
++)
2018 mutex_init(&uprobes_mmap_mutex
[i
]);
2020 if (percpu_init_rwsem(&dup_mmap_sem
))
2023 return register_die_notifier(&uprobe_exception_nb
);
2025 __initcall(init_uprobes
);