]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - kernel/events/uprobes.c
uprobes/x86: Reimplement arch_uretprobe_is_alive()
[karo-tx-linux.git] / kernel / events / uprobes.c
1 /*
2  * User-space Probes (UProbes)
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  * Copyright (C) IBM Corporation, 2008-2012
19  * Authors:
20  *      Srikar Dronamraju
21  *      Jim Keniston
22  * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
23  */
24
25 #include <linux/kernel.h>
26 #include <linux/highmem.h>
27 #include <linux/pagemap.h>      /* read_mapping_page */
28 #include <linux/slab.h>
29 #include <linux/sched.h>
30 #include <linux/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>
40
41 #include <linux/uprobes.h>
42
43 #define UINSNS_PER_PAGE                 (PAGE_SIZE/UPROBE_XOL_SLOT_BYTES)
44 #define MAX_UPROBE_XOL_SLOTS            UINSNS_PER_PAGE
45
46 static struct rb_root uprobes_tree = RB_ROOT;
47 /*
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?
50  */
51 #define no_uprobe_events()      RB_EMPTY_ROOT(&uprobes_tree)
52
53 static DEFINE_SPINLOCK(uprobes_treelock);       /* serialize rbtree access */
54
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])
59
60 static struct percpu_rw_semaphore dup_mmap_sem;
61
62 /* Have a copy of original instruction */
63 #define UPROBE_COPY_INSN        0
64
65 struct uprobe {
66         struct rb_node          rb_node;        /* node in the rb tree */
67         atomic_t                ref;
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 */
73         loff_t                  offset;
74         unsigned long           flags;
75
76         /*
77          * The generic code assumes that it has two members of unknown type
78          * owned by the arch-specific code:
79          *
80          *      insn -  copy_insn() saves the original instruction here for
81          *              arch_uprobe_analyze_insn().
82          *
83          *      ixol -  potentially modified instruction to execute out of
84          *              line, copied to xol_area by xol_get_insn_slot().
85          */
86         struct arch_uprobe      arch;
87 };
88
89 /*
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().
93  *
94  * On a breakpoint hit, thread contests for a slot.  It frees the
95  * slot after singlestep. Currently a fixed number of slots are
96  * allocated.
97  */
98 struct xol_area {
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 */
102         struct page             *page;
103
104         /*
105          * We keep the vma's vm_start rather than a pointer to the vma
106          * itself.  The probed process or a naughty kernel module could make
107          * the vma go away, and we must handle that reasonably gracefully.
108          */
109         unsigned long           vaddr;          /* Page(s) of instruction slots */
110 };
111
112 /*
113  * valid_vma: Verify if the specified vma is an executable vma
114  * Relax restrictions while unregistering: vm_flags might have
115  * changed after breakpoint was inserted.
116  *      - is_register: indicates if we are in register context.
117  *      - Return 1 if the specified virtual address is in an
118  *        executable vma.
119  */
120 static bool valid_vma(struct vm_area_struct *vma, bool is_register)
121 {
122         vm_flags_t flags = VM_HUGETLB | VM_MAYEXEC | VM_MAYSHARE;
123
124         if (is_register)
125                 flags |= VM_WRITE;
126
127         return vma->vm_file && (vma->vm_flags & flags) == VM_MAYEXEC;
128 }
129
130 static unsigned long offset_to_vaddr(struct vm_area_struct *vma, loff_t offset)
131 {
132         return vma->vm_start + offset - ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
133 }
134
135 static loff_t vaddr_to_offset(struct vm_area_struct *vma, unsigned long vaddr)
136 {
137         return ((loff_t)vma->vm_pgoff << PAGE_SHIFT) + (vaddr - vma->vm_start);
138 }
139
140 /**
141  * __replace_page - replace page in vma by new page.
142  * based on replace_page in mm/ksm.c
143  *
144  * @vma:      vma that holds the pte pointing to page
145  * @addr:     address the old @page is mapped at
146  * @page:     the cowed page we are replacing by kpage
147  * @kpage:    the modified page we replace page by
148  *
149  * Returns 0 on success, -EFAULT on failure.
150  */
151 static int __replace_page(struct vm_area_struct *vma, unsigned long addr,
152                                 struct page *page, struct page *kpage)
153 {
154         struct mm_struct *mm = vma->vm_mm;
155         spinlock_t *ptl;
156         pte_t *ptep;
157         int err;
158         /* For mmu_notifiers */
159         const unsigned long mmun_start = addr;
160         const unsigned long mmun_end   = addr + PAGE_SIZE;
161         struct mem_cgroup *memcg;
162
163         err = mem_cgroup_try_charge(kpage, vma->vm_mm, GFP_KERNEL, &memcg);
164         if (err)
165                 return err;
166
167         /* For try_to_free_swap() and munlock_vma_page() below */
168         lock_page(page);
169
170         mmu_notifier_invalidate_range_start(mm, mmun_start, mmun_end);
171         err = -EAGAIN;
172         ptep = page_check_address(page, mm, addr, &ptl, 0);
173         if (!ptep)
174                 goto unlock;
175
176         get_page(kpage);
177         page_add_new_anon_rmap(kpage, vma, addr);
178         mem_cgroup_commit_charge(kpage, memcg, false);
179         lru_cache_add_active_or_unevictable(kpage, vma);
180
181         if (!PageAnon(page)) {
182                 dec_mm_counter(mm, MM_FILEPAGES);
183                 inc_mm_counter(mm, MM_ANONPAGES);
184         }
185
186         flush_cache_page(vma, addr, pte_pfn(*ptep));
187         ptep_clear_flush_notify(vma, addr, ptep);
188         set_pte_at_notify(mm, addr, ptep, mk_pte(kpage, vma->vm_page_prot));
189
190         page_remove_rmap(page);
191         if (!page_mapped(page))
192                 try_to_free_swap(page);
193         pte_unmap_unlock(ptep, ptl);
194
195         if (vma->vm_flags & VM_LOCKED)
196                 munlock_vma_page(page);
197         put_page(page);
198
199         err = 0;
200  unlock:
201         mem_cgroup_cancel_charge(kpage, memcg);
202         mmu_notifier_invalidate_range_end(mm, mmun_start, mmun_end);
203         unlock_page(page);
204         return err;
205 }
206
207 /**
208  * is_swbp_insn - check if instruction is breakpoint instruction.
209  * @insn: instruction to be checked.
210  * Default implementation of is_swbp_insn
211  * Returns true if @insn is a breakpoint instruction.
212  */
213 bool __weak is_swbp_insn(uprobe_opcode_t *insn)
214 {
215         return *insn == UPROBE_SWBP_INSN;
216 }
217
218 /**
219  * is_trap_insn - check if instruction is breakpoint instruction.
220  * @insn: instruction to be checked.
221  * Default implementation of is_trap_insn
222  * Returns true if @insn is a breakpoint instruction.
223  *
224  * This function is needed for the case where an architecture has multiple
225  * trap instructions (like powerpc).
226  */
227 bool __weak is_trap_insn(uprobe_opcode_t *insn)
228 {
229         return is_swbp_insn(insn);
230 }
231
232 static void copy_from_page(struct page *page, unsigned long vaddr, void *dst, int len)
233 {
234         void *kaddr = kmap_atomic(page);
235         memcpy(dst, kaddr + (vaddr & ~PAGE_MASK), len);
236         kunmap_atomic(kaddr);
237 }
238
239 static void copy_to_page(struct page *page, unsigned long vaddr, const void *src, int len)
240 {
241         void *kaddr = kmap_atomic(page);
242         memcpy(kaddr + (vaddr & ~PAGE_MASK), src, len);
243         kunmap_atomic(kaddr);
244 }
245
246 static int verify_opcode(struct page *page, unsigned long vaddr, uprobe_opcode_t *new_opcode)
247 {
248         uprobe_opcode_t old_opcode;
249         bool is_swbp;
250
251         /*
252          * Note: We only check if the old_opcode is UPROBE_SWBP_INSN here.
253          * We do not check if it is any other 'trap variant' which could
254          * be conditional trap instruction such as the one powerpc supports.
255          *
256          * The logic is that we do not care if the underlying instruction
257          * is a trap variant; uprobes always wins over any other (gdb)
258          * breakpoint.
259          */
260         copy_from_page(page, vaddr, &old_opcode, UPROBE_SWBP_INSN_SIZE);
261         is_swbp = is_swbp_insn(&old_opcode);
262
263         if (is_swbp_insn(new_opcode)) {
264                 if (is_swbp)            /* register: already installed? */
265                         return 0;
266         } else {
267                 if (!is_swbp)           /* unregister: was it changed by us? */
268                         return 0;
269         }
270
271         return 1;
272 }
273
274 /*
275  * NOTE:
276  * Expect the breakpoint instruction to be the smallest size instruction for
277  * the architecture. If an arch has variable length instruction and the
278  * breakpoint instruction is not of the smallest length instruction
279  * supported by that architecture then we need to modify is_trap_at_addr and
280  * uprobe_write_opcode accordingly. This would never be a problem for archs
281  * that have fixed length instructions.
282  *
283  * uprobe_write_opcode - write the opcode at a given virtual address.
284  * @mm: the probed process address space.
285  * @vaddr: the virtual address to store the opcode.
286  * @opcode: opcode to be written at @vaddr.
287  *
288  * Called with mm->mmap_sem held for write.
289  * Return 0 (success) or a negative errno.
290  */
291 int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr,
292                         uprobe_opcode_t opcode)
293 {
294         struct page *old_page, *new_page;
295         struct vm_area_struct *vma;
296         int ret;
297
298 retry:
299         /* Read the page with vaddr into memory */
300         ret = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &old_page, &vma);
301         if (ret <= 0)
302                 return ret;
303
304         ret = verify_opcode(old_page, vaddr, &opcode);
305         if (ret <= 0)
306                 goto put_old;
307
308         ret = anon_vma_prepare(vma);
309         if (ret)
310                 goto put_old;
311
312         ret = -ENOMEM;
313         new_page = alloc_page_vma(GFP_HIGHUSER_MOVABLE, vma, vaddr);
314         if (!new_page)
315                 goto put_old;
316
317         __SetPageUptodate(new_page);
318         copy_highpage(new_page, old_page);
319         copy_to_page(new_page, vaddr, &opcode, UPROBE_SWBP_INSN_SIZE);
320
321         ret = __replace_page(vma, vaddr, old_page, new_page);
322         page_cache_release(new_page);
323 put_old:
324         put_page(old_page);
325
326         if (unlikely(ret == -EAGAIN))
327                 goto retry;
328         return ret;
329 }
330
331 /**
332  * set_swbp - store breakpoint at a given address.
333  * @auprobe: arch specific probepoint information.
334  * @mm: the probed process address space.
335  * @vaddr: the virtual address to insert the opcode.
336  *
337  * For mm @mm, store the breakpoint instruction at @vaddr.
338  * Return 0 (success) or a negative errno.
339  */
340 int __weak set_swbp(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
341 {
342         return uprobe_write_opcode(mm, vaddr, UPROBE_SWBP_INSN);
343 }
344
345 /**
346  * set_orig_insn - Restore the original instruction.
347  * @mm: the probed process address space.
348  * @auprobe: arch specific probepoint information.
349  * @vaddr: the virtual address to insert the opcode.
350  *
351  * For mm @mm, restore the original opcode (opcode) at @vaddr.
352  * Return 0 (success) or a negative errno.
353  */
354 int __weak
355 set_orig_insn(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long vaddr)
356 {
357         return uprobe_write_opcode(mm, vaddr, *(uprobe_opcode_t *)&auprobe->insn);
358 }
359
360 static struct uprobe *get_uprobe(struct uprobe *uprobe)
361 {
362         atomic_inc(&uprobe->ref);
363         return uprobe;
364 }
365
366 static void put_uprobe(struct uprobe *uprobe)
367 {
368         if (atomic_dec_and_test(&uprobe->ref))
369                 kfree(uprobe);
370 }
371
372 static int match_uprobe(struct uprobe *l, struct uprobe *r)
373 {
374         if (l->inode < r->inode)
375                 return -1;
376
377         if (l->inode > r->inode)
378                 return 1;
379
380         if (l->offset < r->offset)
381                 return -1;
382
383         if (l->offset > r->offset)
384                 return 1;
385
386         return 0;
387 }
388
389 static struct uprobe *__find_uprobe(struct inode *inode, loff_t offset)
390 {
391         struct uprobe u = { .inode = inode, .offset = offset };
392         struct rb_node *n = uprobes_tree.rb_node;
393         struct uprobe *uprobe;
394         int match;
395
396         while (n) {
397                 uprobe = rb_entry(n, struct uprobe, rb_node);
398                 match = match_uprobe(&u, uprobe);
399                 if (!match)
400                         return get_uprobe(uprobe);
401
402                 if (match < 0)
403                         n = n->rb_left;
404                 else
405                         n = n->rb_right;
406         }
407         return NULL;
408 }
409
410 /*
411  * Find a uprobe corresponding to a given inode:offset
412  * Acquires uprobes_treelock
413  */
414 static struct uprobe *find_uprobe(struct inode *inode, loff_t offset)
415 {
416         struct uprobe *uprobe;
417
418         spin_lock(&uprobes_treelock);
419         uprobe = __find_uprobe(inode, offset);
420         spin_unlock(&uprobes_treelock);
421
422         return uprobe;
423 }
424
425 static struct uprobe *__insert_uprobe(struct uprobe *uprobe)
426 {
427         struct rb_node **p = &uprobes_tree.rb_node;
428         struct rb_node *parent = NULL;
429         struct uprobe *u;
430         int match;
431
432         while (*p) {
433                 parent = *p;
434                 u = rb_entry(parent, struct uprobe, rb_node);
435                 match = match_uprobe(uprobe, u);
436                 if (!match)
437                         return get_uprobe(u);
438
439                 if (match < 0)
440                         p = &parent->rb_left;
441                 else
442                         p = &parent->rb_right;
443
444         }
445
446         u = NULL;
447         rb_link_node(&uprobe->rb_node, parent, p);
448         rb_insert_color(&uprobe->rb_node, &uprobes_tree);
449         /* get access + creation ref */
450         atomic_set(&uprobe->ref, 2);
451
452         return u;
453 }
454
455 /*
456  * Acquire uprobes_treelock.
457  * Matching uprobe already exists in rbtree;
458  *      increment (access refcount) and return the matching uprobe.
459  *
460  * No matching uprobe; insert the uprobe in rb_tree;
461  *      get a double refcount (access + creation) and return NULL.
462  */
463 static struct uprobe *insert_uprobe(struct uprobe *uprobe)
464 {
465         struct uprobe *u;
466
467         spin_lock(&uprobes_treelock);
468         u = __insert_uprobe(uprobe);
469         spin_unlock(&uprobes_treelock);
470
471         return u;
472 }
473
474 static struct uprobe *alloc_uprobe(struct inode *inode, loff_t offset)
475 {
476         struct uprobe *uprobe, *cur_uprobe;
477
478         uprobe = kzalloc(sizeof(struct uprobe), GFP_KERNEL);
479         if (!uprobe)
480                 return NULL;
481
482         uprobe->inode = igrab(inode);
483         uprobe->offset = offset;
484         init_rwsem(&uprobe->register_rwsem);
485         init_rwsem(&uprobe->consumer_rwsem);
486
487         /* add to uprobes_tree, sorted on inode:offset */
488         cur_uprobe = insert_uprobe(uprobe);
489         /* a uprobe exists for this inode:offset combination */
490         if (cur_uprobe) {
491                 kfree(uprobe);
492                 uprobe = cur_uprobe;
493                 iput(inode);
494         }
495
496         return uprobe;
497 }
498
499 static void consumer_add(struct uprobe *uprobe, struct uprobe_consumer *uc)
500 {
501         down_write(&uprobe->consumer_rwsem);
502         uc->next = uprobe->consumers;
503         uprobe->consumers = uc;
504         up_write(&uprobe->consumer_rwsem);
505 }
506
507 /*
508  * For uprobe @uprobe, delete the consumer @uc.
509  * Return true if the @uc is deleted successfully
510  * or return false.
511  */
512 static bool consumer_del(struct uprobe *uprobe, struct uprobe_consumer *uc)
513 {
514         struct uprobe_consumer **con;
515         bool ret = false;
516
517         down_write(&uprobe->consumer_rwsem);
518         for (con = &uprobe->consumers; *con; con = &(*con)->next) {
519                 if (*con == uc) {
520                         *con = uc->next;
521                         ret = true;
522                         break;
523                 }
524         }
525         up_write(&uprobe->consumer_rwsem);
526
527         return ret;
528 }
529
530 static int __copy_insn(struct address_space *mapping, struct file *filp,
531                         void *insn, int nbytes, loff_t offset)
532 {
533         struct page *page;
534         /*
535          * Ensure that the page that has the original instruction is populated
536          * and in page-cache. If ->readpage == NULL it must be shmem_mapping(),
537          * see uprobe_register().
538          */
539         if (mapping->a_ops->readpage)
540                 page = read_mapping_page(mapping, offset >> PAGE_CACHE_SHIFT, filp);
541         else
542                 page = shmem_read_mapping_page(mapping, offset >> PAGE_CACHE_SHIFT);
543         if (IS_ERR(page))
544                 return PTR_ERR(page);
545
546         copy_from_page(page, offset, insn, nbytes);
547         page_cache_release(page);
548
549         return 0;
550 }
551
552 static int copy_insn(struct uprobe *uprobe, struct file *filp)
553 {
554         struct address_space *mapping = uprobe->inode->i_mapping;
555         loff_t offs = uprobe->offset;
556         void *insn = &uprobe->arch.insn;
557         int size = sizeof(uprobe->arch.insn);
558         int len, err = -EIO;
559
560         /* Copy only available bytes, -EIO if nothing was read */
561         do {
562                 if (offs >= i_size_read(uprobe->inode))
563                         break;
564
565                 len = min_t(int, size, PAGE_SIZE - (offs & ~PAGE_MASK));
566                 err = __copy_insn(mapping, filp, insn, len, offs);
567                 if (err)
568                         break;
569
570                 insn += len;
571                 offs += len;
572                 size -= len;
573         } while (size);
574
575         return err;
576 }
577
578 static int prepare_uprobe(struct uprobe *uprobe, struct file *file,
579                                 struct mm_struct *mm, unsigned long vaddr)
580 {
581         int ret = 0;
582
583         if (test_bit(UPROBE_COPY_INSN, &uprobe->flags))
584                 return ret;
585
586         /* TODO: move this into _register, until then we abuse this sem. */
587         down_write(&uprobe->consumer_rwsem);
588         if (test_bit(UPROBE_COPY_INSN, &uprobe->flags))
589                 goto out;
590
591         ret = copy_insn(uprobe, file);
592         if (ret)
593                 goto out;
594
595         ret = -ENOTSUPP;
596         if (is_trap_insn((uprobe_opcode_t *)&uprobe->arch.insn))
597                 goto out;
598
599         ret = arch_uprobe_analyze_insn(&uprobe->arch, mm, vaddr);
600         if (ret)
601                 goto out;
602
603         /* uprobe_write_opcode() assumes we don't cross page boundary */
604         BUG_ON((uprobe->offset & ~PAGE_MASK) +
605                         UPROBE_SWBP_INSN_SIZE > PAGE_SIZE);
606
607         smp_wmb(); /* pairs with rmb() in find_active_uprobe() */
608         set_bit(UPROBE_COPY_INSN, &uprobe->flags);
609
610  out:
611         up_write(&uprobe->consumer_rwsem);
612
613         return ret;
614 }
615
616 static inline bool consumer_filter(struct uprobe_consumer *uc,
617                                    enum uprobe_filter_ctx ctx, struct mm_struct *mm)
618 {
619         return !uc->filter || uc->filter(uc, ctx, mm);
620 }
621
622 static bool filter_chain(struct uprobe *uprobe,
623                          enum uprobe_filter_ctx ctx, struct mm_struct *mm)
624 {
625         struct uprobe_consumer *uc;
626         bool ret = false;
627
628         down_read(&uprobe->consumer_rwsem);
629         for (uc = uprobe->consumers; uc; uc = uc->next) {
630                 ret = consumer_filter(uc, ctx, mm);
631                 if (ret)
632                         break;
633         }
634         up_read(&uprobe->consumer_rwsem);
635
636         return ret;
637 }
638
639 static int
640 install_breakpoint(struct uprobe *uprobe, struct mm_struct *mm,
641                         struct vm_area_struct *vma, unsigned long vaddr)
642 {
643         bool first_uprobe;
644         int ret;
645
646         ret = prepare_uprobe(uprobe, vma->vm_file, mm, vaddr);
647         if (ret)
648                 return ret;
649
650         /*
651          * set MMF_HAS_UPROBES in advance for uprobe_pre_sstep_notifier(),
652          * the task can hit this breakpoint right after __replace_page().
653          */
654         first_uprobe = !test_bit(MMF_HAS_UPROBES, &mm->flags);
655         if (first_uprobe)
656                 set_bit(MMF_HAS_UPROBES, &mm->flags);
657
658         ret = set_swbp(&uprobe->arch, mm, vaddr);
659         if (!ret)
660                 clear_bit(MMF_RECALC_UPROBES, &mm->flags);
661         else if (first_uprobe)
662                 clear_bit(MMF_HAS_UPROBES, &mm->flags);
663
664         return ret;
665 }
666
667 static int
668 remove_breakpoint(struct uprobe *uprobe, struct mm_struct *mm, unsigned long vaddr)
669 {
670         set_bit(MMF_RECALC_UPROBES, &mm->flags);
671         return set_orig_insn(&uprobe->arch, mm, vaddr);
672 }
673
674 static inline bool uprobe_is_active(struct uprobe *uprobe)
675 {
676         return !RB_EMPTY_NODE(&uprobe->rb_node);
677 }
678 /*
679  * There could be threads that have already hit the breakpoint. They
680  * will recheck the current insn and restart if find_uprobe() fails.
681  * See find_active_uprobe().
682  */
683 static void delete_uprobe(struct uprobe *uprobe)
684 {
685         if (WARN_ON(!uprobe_is_active(uprobe)))
686                 return;
687
688         spin_lock(&uprobes_treelock);
689         rb_erase(&uprobe->rb_node, &uprobes_tree);
690         spin_unlock(&uprobes_treelock);
691         RB_CLEAR_NODE(&uprobe->rb_node); /* for uprobe_is_active() */
692         iput(uprobe->inode);
693         put_uprobe(uprobe);
694 }
695
696 struct map_info {
697         struct map_info *next;
698         struct mm_struct *mm;
699         unsigned long vaddr;
700 };
701
702 static inline struct map_info *free_map_info(struct map_info *info)
703 {
704         struct map_info *next = info->next;
705         kfree(info);
706         return next;
707 }
708
709 static struct map_info *
710 build_map_info(struct address_space *mapping, loff_t offset, bool is_register)
711 {
712         unsigned long pgoff = offset >> PAGE_SHIFT;
713         struct vm_area_struct *vma;
714         struct map_info *curr = NULL;
715         struct map_info *prev = NULL;
716         struct map_info *info;
717         int more = 0;
718
719  again:
720         i_mmap_lock_read(mapping);
721         vma_interval_tree_foreach(vma, &mapping->i_mmap, pgoff, pgoff) {
722                 if (!valid_vma(vma, is_register))
723                         continue;
724
725                 if (!prev && !more) {
726                         /*
727                          * Needs GFP_NOWAIT to avoid i_mmap_rwsem recursion through
728                          * reclaim. This is optimistic, no harm done if it fails.
729                          */
730                         prev = kmalloc(sizeof(struct map_info),
731                                         GFP_NOWAIT | __GFP_NOMEMALLOC | __GFP_NOWARN);
732                         if (prev)
733                                 prev->next = NULL;
734                 }
735                 if (!prev) {
736                         more++;
737                         continue;
738                 }
739
740                 if (!atomic_inc_not_zero(&vma->vm_mm->mm_users))
741                         continue;
742
743                 info = prev;
744                 prev = prev->next;
745                 info->next = curr;
746                 curr = info;
747
748                 info->mm = vma->vm_mm;
749                 info->vaddr = offset_to_vaddr(vma, offset);
750         }
751         i_mmap_unlock_read(mapping);
752
753         if (!more)
754                 goto out;
755
756         prev = curr;
757         while (curr) {
758                 mmput(curr->mm);
759                 curr = curr->next;
760         }
761
762         do {
763                 info = kmalloc(sizeof(struct map_info), GFP_KERNEL);
764                 if (!info) {
765                         curr = ERR_PTR(-ENOMEM);
766                         goto out;
767                 }
768                 info->next = prev;
769                 prev = info;
770         } while (--more);
771
772         goto again;
773  out:
774         while (prev)
775                 prev = free_map_info(prev);
776         return curr;
777 }
778
779 static int
780 register_for_each_vma(struct uprobe *uprobe, struct uprobe_consumer *new)
781 {
782         bool is_register = !!new;
783         struct map_info *info;
784         int err = 0;
785
786         percpu_down_write(&dup_mmap_sem);
787         info = build_map_info(uprobe->inode->i_mapping,
788                                         uprobe->offset, is_register);
789         if (IS_ERR(info)) {
790                 err = PTR_ERR(info);
791                 goto out;
792         }
793
794         while (info) {
795                 struct mm_struct *mm = info->mm;
796                 struct vm_area_struct *vma;
797
798                 if (err && is_register)
799                         goto free;
800
801                 down_write(&mm->mmap_sem);
802                 vma = find_vma(mm, info->vaddr);
803                 if (!vma || !valid_vma(vma, is_register) ||
804                     file_inode(vma->vm_file) != uprobe->inode)
805                         goto unlock;
806
807                 if (vma->vm_start > info->vaddr ||
808                     vaddr_to_offset(vma, info->vaddr) != uprobe->offset)
809                         goto unlock;
810
811                 if (is_register) {
812                         /* consult only the "caller", new consumer. */
813                         if (consumer_filter(new,
814                                         UPROBE_FILTER_REGISTER, mm))
815                                 err = install_breakpoint(uprobe, mm, vma, info->vaddr);
816                 } else if (test_bit(MMF_HAS_UPROBES, &mm->flags)) {
817                         if (!filter_chain(uprobe,
818                                         UPROBE_FILTER_UNREGISTER, mm))
819                                 err |= remove_breakpoint(uprobe, mm, info->vaddr);
820                 }
821
822  unlock:
823                 up_write(&mm->mmap_sem);
824  free:
825                 mmput(mm);
826                 info = free_map_info(info);
827         }
828  out:
829         percpu_up_write(&dup_mmap_sem);
830         return err;
831 }
832
833 static int __uprobe_register(struct uprobe *uprobe, struct uprobe_consumer *uc)
834 {
835         consumer_add(uprobe, uc);
836         return register_for_each_vma(uprobe, uc);
837 }
838
839 static void __uprobe_unregister(struct uprobe *uprobe, struct uprobe_consumer *uc)
840 {
841         int err;
842
843         if (WARN_ON(!consumer_del(uprobe, uc)))
844                 return;
845
846         err = register_for_each_vma(uprobe, NULL);
847         /* TODO : cant unregister? schedule a worker thread */
848         if (!uprobe->consumers && !err)
849                 delete_uprobe(uprobe);
850 }
851
852 /*
853  * uprobe_register - register a probe
854  * @inode: the file in which the probe has to be placed.
855  * @offset: offset from the start of the file.
856  * @uc: information on howto handle the probe..
857  *
858  * Apart from the access refcount, uprobe_register() takes a creation
859  * refcount (thro alloc_uprobe) if and only if this @uprobe is getting
860  * inserted into the rbtree (i.e first consumer for a @inode:@offset
861  * tuple).  Creation refcount stops uprobe_unregister from freeing the
862  * @uprobe even before the register operation is complete. Creation
863  * refcount is released when the last @uc for the @uprobe
864  * unregisters.
865  *
866  * Return errno if it cannot successully install probes
867  * else return 0 (success)
868  */
869 int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
870 {
871         struct uprobe *uprobe;
872         int ret;
873
874         /* Uprobe must have at least one set consumer */
875         if (!uc->handler && !uc->ret_handler)
876                 return -EINVAL;
877
878         /* copy_insn() uses read_mapping_page() or shmem_read_mapping_page() */
879         if (!inode->i_mapping->a_ops->readpage && !shmem_mapping(inode->i_mapping))
880                 return -EIO;
881         /* Racy, just to catch the obvious mistakes */
882         if (offset > i_size_read(inode))
883                 return -EINVAL;
884
885  retry:
886         uprobe = alloc_uprobe(inode, offset);
887         if (!uprobe)
888                 return -ENOMEM;
889         /*
890          * We can race with uprobe_unregister()->delete_uprobe().
891          * Check uprobe_is_active() and retry if it is false.
892          */
893         down_write(&uprobe->register_rwsem);
894         ret = -EAGAIN;
895         if (likely(uprobe_is_active(uprobe))) {
896                 ret = __uprobe_register(uprobe, uc);
897                 if (ret)
898                         __uprobe_unregister(uprobe, uc);
899         }
900         up_write(&uprobe->register_rwsem);
901         put_uprobe(uprobe);
902
903         if (unlikely(ret == -EAGAIN))
904                 goto retry;
905         return ret;
906 }
907 EXPORT_SYMBOL_GPL(uprobe_register);
908
909 /*
910  * uprobe_apply - unregister a already registered probe.
911  * @inode: the file in which the probe has to be removed.
912  * @offset: offset from the start of the file.
913  * @uc: consumer which wants to add more or remove some breakpoints
914  * @add: add or remove the breakpoints
915  */
916 int uprobe_apply(struct inode *inode, loff_t offset,
917                         struct uprobe_consumer *uc, bool add)
918 {
919         struct uprobe *uprobe;
920         struct uprobe_consumer *con;
921         int ret = -ENOENT;
922
923         uprobe = find_uprobe(inode, offset);
924         if (WARN_ON(!uprobe))
925                 return ret;
926
927         down_write(&uprobe->register_rwsem);
928         for (con = uprobe->consumers; con && con != uc ; con = con->next)
929                 ;
930         if (con)
931                 ret = register_for_each_vma(uprobe, add ? uc : NULL);
932         up_write(&uprobe->register_rwsem);
933         put_uprobe(uprobe);
934
935         return ret;
936 }
937
938 /*
939  * uprobe_unregister - unregister a already registered probe.
940  * @inode: the file in which the probe has to be removed.
941  * @offset: offset from the start of the file.
942  * @uc: identify which probe if multiple probes are colocated.
943  */
944 void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
945 {
946         struct uprobe *uprobe;
947
948         uprobe = find_uprobe(inode, offset);
949         if (WARN_ON(!uprobe))
950                 return;
951
952         down_write(&uprobe->register_rwsem);
953         __uprobe_unregister(uprobe, uc);
954         up_write(&uprobe->register_rwsem);
955         put_uprobe(uprobe);
956 }
957 EXPORT_SYMBOL_GPL(uprobe_unregister);
958
959 static int unapply_uprobe(struct uprobe *uprobe, struct mm_struct *mm)
960 {
961         struct vm_area_struct *vma;
962         int err = 0;
963
964         down_read(&mm->mmap_sem);
965         for (vma = mm->mmap; vma; vma = vma->vm_next) {
966                 unsigned long vaddr;
967                 loff_t offset;
968
969                 if (!valid_vma(vma, false) ||
970                     file_inode(vma->vm_file) != uprobe->inode)
971                         continue;
972
973                 offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
974                 if (uprobe->offset <  offset ||
975                     uprobe->offset >= offset + vma->vm_end - vma->vm_start)
976                         continue;
977
978                 vaddr = offset_to_vaddr(vma, uprobe->offset);
979                 err |= remove_breakpoint(uprobe, mm, vaddr);
980         }
981         up_read(&mm->mmap_sem);
982
983         return err;
984 }
985
986 static struct rb_node *
987 find_node_in_range(struct inode *inode, loff_t min, loff_t max)
988 {
989         struct rb_node *n = uprobes_tree.rb_node;
990
991         while (n) {
992                 struct uprobe *u = rb_entry(n, struct uprobe, rb_node);
993
994                 if (inode < u->inode) {
995                         n = n->rb_left;
996                 } else if (inode > u->inode) {
997                         n = n->rb_right;
998                 } else {
999                         if (max < u->offset)
1000                                 n = n->rb_left;
1001                         else if (min > u->offset)
1002                                 n = n->rb_right;
1003                         else
1004                                 break;
1005                 }
1006         }
1007
1008         return n;
1009 }
1010
1011 /*
1012  * For a given range in vma, build a list of probes that need to be inserted.
1013  */
1014 static void build_probe_list(struct inode *inode,
1015                                 struct vm_area_struct *vma,
1016                                 unsigned long start, unsigned long end,
1017                                 struct list_head *head)
1018 {
1019         loff_t min, max;
1020         struct rb_node *n, *t;
1021         struct uprobe *u;
1022
1023         INIT_LIST_HEAD(head);
1024         min = vaddr_to_offset(vma, start);
1025         max = min + (end - start) - 1;
1026
1027         spin_lock(&uprobes_treelock);
1028         n = find_node_in_range(inode, min, max);
1029         if (n) {
1030                 for (t = n; t; t = rb_prev(t)) {
1031                         u = rb_entry(t, struct uprobe, rb_node);
1032                         if (u->inode != inode || u->offset < min)
1033                                 break;
1034                         list_add(&u->pending_list, head);
1035                         get_uprobe(u);
1036                 }
1037                 for (t = n; (t = rb_next(t)); ) {
1038                         u = rb_entry(t, struct uprobe, rb_node);
1039                         if (u->inode != inode || u->offset > max)
1040                                 break;
1041                         list_add(&u->pending_list, head);
1042                         get_uprobe(u);
1043                 }
1044         }
1045         spin_unlock(&uprobes_treelock);
1046 }
1047
1048 /*
1049  * Called from mmap_region/vma_adjust with mm->mmap_sem acquired.
1050  *
1051  * Currently we ignore all errors and always return 0, the callers
1052  * can't handle the failure anyway.
1053  */
1054 int uprobe_mmap(struct vm_area_struct *vma)
1055 {
1056         struct list_head tmp_list;
1057         struct uprobe *uprobe, *u;
1058         struct inode *inode;
1059
1060         if (no_uprobe_events() || !valid_vma(vma, true))
1061                 return 0;
1062
1063         inode = file_inode(vma->vm_file);
1064         if (!inode)
1065                 return 0;
1066
1067         mutex_lock(uprobes_mmap_hash(inode));
1068         build_probe_list(inode, vma, vma->vm_start, vma->vm_end, &tmp_list);
1069         /*
1070          * We can race with uprobe_unregister(), this uprobe can be already
1071          * removed. But in this case filter_chain() must return false, all
1072          * consumers have gone away.
1073          */
1074         list_for_each_entry_safe(uprobe, u, &tmp_list, pending_list) {
1075                 if (!fatal_signal_pending(current) &&
1076                     filter_chain(uprobe, UPROBE_FILTER_MMAP, vma->vm_mm)) {
1077                         unsigned long vaddr = offset_to_vaddr(vma, uprobe->offset);
1078                         install_breakpoint(uprobe, vma->vm_mm, vma, vaddr);
1079                 }
1080                 put_uprobe(uprobe);
1081         }
1082         mutex_unlock(uprobes_mmap_hash(inode));
1083
1084         return 0;
1085 }
1086
1087 static bool
1088 vma_has_uprobes(struct vm_area_struct *vma, unsigned long start, unsigned long end)
1089 {
1090         loff_t min, max;
1091         struct inode *inode;
1092         struct rb_node *n;
1093
1094         inode = file_inode(vma->vm_file);
1095
1096         min = vaddr_to_offset(vma, start);
1097         max = min + (end - start) - 1;
1098
1099         spin_lock(&uprobes_treelock);
1100         n = find_node_in_range(inode, min, max);
1101         spin_unlock(&uprobes_treelock);
1102
1103         return !!n;
1104 }
1105
1106 /*
1107  * Called in context of a munmap of a vma.
1108  */
1109 void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
1110 {
1111         if (no_uprobe_events() || !valid_vma(vma, false))
1112                 return;
1113
1114         if (!atomic_read(&vma->vm_mm->mm_users)) /* called by mmput() ? */
1115                 return;
1116
1117         if (!test_bit(MMF_HAS_UPROBES, &vma->vm_mm->flags) ||
1118              test_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags))
1119                 return;
1120
1121         if (vma_has_uprobes(vma, start, end))
1122                 set_bit(MMF_RECALC_UPROBES, &vma->vm_mm->flags);
1123 }
1124
1125 /* Slot allocation for XOL */
1126 static int xol_add_vma(struct mm_struct *mm, struct xol_area *area)
1127 {
1128         int ret = -EALREADY;
1129
1130         down_write(&mm->mmap_sem);
1131         if (mm->uprobes_state.xol_area)
1132                 goto fail;
1133
1134         if (!area->vaddr) {
1135                 /* Try to map as high as possible, this is only a hint. */
1136                 area->vaddr = get_unmapped_area(NULL, TASK_SIZE - PAGE_SIZE,
1137                                                 PAGE_SIZE, 0, 0);
1138                 if (area->vaddr & ~PAGE_MASK) {
1139                         ret = area->vaddr;
1140                         goto fail;
1141                 }
1142         }
1143
1144         ret = install_special_mapping(mm, area->vaddr, PAGE_SIZE,
1145                                 VM_EXEC|VM_MAYEXEC|VM_DONTCOPY|VM_IO, &area->page);
1146         if (ret)
1147                 goto fail;
1148
1149         smp_wmb();      /* pairs with get_xol_area() */
1150         mm->uprobes_state.xol_area = area;
1151  fail:
1152         up_write(&mm->mmap_sem);
1153
1154         return ret;
1155 }
1156
1157 static struct xol_area *__create_xol_area(unsigned long vaddr)
1158 {
1159         struct mm_struct *mm = current->mm;
1160         uprobe_opcode_t insn = UPROBE_SWBP_INSN;
1161         struct xol_area *area;
1162
1163         area = kmalloc(sizeof(*area), GFP_KERNEL);
1164         if (unlikely(!area))
1165                 goto out;
1166
1167         area->bitmap = kzalloc(BITS_TO_LONGS(UINSNS_PER_PAGE) * sizeof(long), GFP_KERNEL);
1168         if (!area->bitmap)
1169                 goto free_area;
1170
1171         area->page = alloc_page(GFP_HIGHUSER);
1172         if (!area->page)
1173                 goto free_bitmap;
1174
1175         area->vaddr = vaddr;
1176         init_waitqueue_head(&area->wq);
1177         /* Reserve the 1st slot for get_trampoline_vaddr() */
1178         set_bit(0, area->bitmap);
1179         atomic_set(&area->slot_count, 1);
1180         copy_to_page(area->page, 0, &insn, UPROBE_SWBP_INSN_SIZE);
1181
1182         if (!xol_add_vma(mm, area))
1183                 return area;
1184
1185         __free_page(area->page);
1186  free_bitmap:
1187         kfree(area->bitmap);
1188  free_area:
1189         kfree(area);
1190  out:
1191         return NULL;
1192 }
1193
1194 /*
1195  * get_xol_area - Allocate process's xol_area if necessary.
1196  * This area will be used for storing instructions for execution out of line.
1197  *
1198  * Returns the allocated area or NULL.
1199  */
1200 static struct xol_area *get_xol_area(void)
1201 {
1202         struct mm_struct *mm = current->mm;
1203         struct xol_area *area;
1204
1205         if (!mm->uprobes_state.xol_area)
1206                 __create_xol_area(0);
1207
1208         area = mm->uprobes_state.xol_area;
1209         smp_read_barrier_depends();     /* pairs with wmb in xol_add_vma() */
1210         return area;
1211 }
1212
1213 /*
1214  * uprobe_clear_state - Free the area allocated for slots.
1215  */
1216 void uprobe_clear_state(struct mm_struct *mm)
1217 {
1218         struct xol_area *area = mm->uprobes_state.xol_area;
1219
1220         if (!area)
1221                 return;
1222
1223         put_page(area->page);
1224         kfree(area->bitmap);
1225         kfree(area);
1226 }
1227
1228 void uprobe_start_dup_mmap(void)
1229 {
1230         percpu_down_read(&dup_mmap_sem);
1231 }
1232
1233 void uprobe_end_dup_mmap(void)
1234 {
1235         percpu_up_read(&dup_mmap_sem);
1236 }
1237
1238 void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
1239 {
1240         newmm->uprobes_state.xol_area = NULL;
1241
1242         if (test_bit(MMF_HAS_UPROBES, &oldmm->flags)) {
1243                 set_bit(MMF_HAS_UPROBES, &newmm->flags);
1244                 /* unconditionally, dup_mmap() skips VM_DONTCOPY vmas */
1245                 set_bit(MMF_RECALC_UPROBES, &newmm->flags);
1246         }
1247 }
1248
1249 /*
1250  *  - search for a free slot.
1251  */
1252 static unsigned long xol_take_insn_slot(struct xol_area *area)
1253 {
1254         unsigned long slot_addr;
1255         int slot_nr;
1256
1257         do {
1258                 slot_nr = find_first_zero_bit(area->bitmap, UINSNS_PER_PAGE);
1259                 if (slot_nr < UINSNS_PER_PAGE) {
1260                         if (!test_and_set_bit(slot_nr, area->bitmap))
1261                                 break;
1262
1263                         slot_nr = UINSNS_PER_PAGE;
1264                         continue;
1265                 }
1266                 wait_event(area->wq, (atomic_read(&area->slot_count) < UINSNS_PER_PAGE));
1267         } while (slot_nr >= UINSNS_PER_PAGE);
1268
1269         slot_addr = area->vaddr + (slot_nr * UPROBE_XOL_SLOT_BYTES);
1270         atomic_inc(&area->slot_count);
1271
1272         return slot_addr;
1273 }
1274
1275 /*
1276  * xol_get_insn_slot - allocate a slot for xol.
1277  * Returns the allocated slot address or 0.
1278  */
1279 static unsigned long xol_get_insn_slot(struct uprobe *uprobe)
1280 {
1281         struct xol_area *area;
1282         unsigned long xol_vaddr;
1283
1284         area = get_xol_area();
1285         if (!area)
1286                 return 0;
1287
1288         xol_vaddr = xol_take_insn_slot(area);
1289         if (unlikely(!xol_vaddr))
1290                 return 0;
1291
1292         arch_uprobe_copy_ixol(area->page, xol_vaddr,
1293                               &uprobe->arch.ixol, sizeof(uprobe->arch.ixol));
1294
1295         return xol_vaddr;
1296 }
1297
1298 /*
1299  * xol_free_insn_slot - If slot was earlier allocated by
1300  * @xol_get_insn_slot(), make the slot available for
1301  * subsequent requests.
1302  */
1303 static void xol_free_insn_slot(struct task_struct *tsk)
1304 {
1305         struct xol_area *area;
1306         unsigned long vma_end;
1307         unsigned long slot_addr;
1308
1309         if (!tsk->mm || !tsk->mm->uprobes_state.xol_area || !tsk->utask)
1310                 return;
1311
1312         slot_addr = tsk->utask->xol_vaddr;
1313         if (unlikely(!slot_addr))
1314                 return;
1315
1316         area = tsk->mm->uprobes_state.xol_area;
1317         vma_end = area->vaddr + PAGE_SIZE;
1318         if (area->vaddr <= slot_addr && slot_addr < vma_end) {
1319                 unsigned long offset;
1320                 int slot_nr;
1321
1322                 offset = slot_addr - area->vaddr;
1323                 slot_nr = offset / UPROBE_XOL_SLOT_BYTES;
1324                 if (slot_nr >= UINSNS_PER_PAGE)
1325                         return;
1326
1327                 clear_bit(slot_nr, area->bitmap);
1328                 atomic_dec(&area->slot_count);
1329                 if (waitqueue_active(&area->wq))
1330                         wake_up(&area->wq);
1331
1332                 tsk->utask->xol_vaddr = 0;
1333         }
1334 }
1335
1336 void __weak arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr,
1337                                   void *src, unsigned long len)
1338 {
1339         /* Initialize the slot */
1340         copy_to_page(page, vaddr, src, len);
1341
1342         /*
1343          * We probably need flush_icache_user_range() but it needs vma.
1344          * This should work on most of architectures by default. If
1345          * architecture needs to do something different it can define
1346          * its own version of the function.
1347          */
1348         flush_dcache_page(page);
1349 }
1350
1351 /**
1352  * uprobe_get_swbp_addr - compute address of swbp given post-swbp regs
1353  * @regs: Reflects the saved state of the task after it has hit a breakpoint
1354  * instruction.
1355  * Return the address of the breakpoint instruction.
1356  */
1357 unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs)
1358 {
1359         return instruction_pointer(regs) - UPROBE_SWBP_INSN_SIZE;
1360 }
1361
1362 unsigned long uprobe_get_trap_addr(struct pt_regs *regs)
1363 {
1364         struct uprobe_task *utask = current->utask;
1365
1366         if (unlikely(utask && utask->active_uprobe))
1367                 return utask->vaddr;
1368
1369         return instruction_pointer(regs);
1370 }
1371
1372 static struct return_instance *free_ret_instance(struct return_instance *ri)
1373 {
1374         struct return_instance *next = ri->next;
1375         put_uprobe(ri->uprobe);
1376         kfree(ri);
1377         return next;
1378 }
1379
1380 /*
1381  * Called with no locks held.
1382  * Called in context of a exiting or a exec-ing thread.
1383  */
1384 void uprobe_free_utask(struct task_struct *t)
1385 {
1386         struct uprobe_task *utask = t->utask;
1387         struct return_instance *ri;
1388
1389         if (!utask)
1390                 return;
1391
1392         if (utask->active_uprobe)
1393                 put_uprobe(utask->active_uprobe);
1394
1395         ri = utask->return_instances;
1396         while (ri)
1397                 ri = free_ret_instance(ri);
1398
1399         xol_free_insn_slot(t);
1400         kfree(utask);
1401         t->utask = NULL;
1402 }
1403
1404 /*
1405  * Allocate a uprobe_task object for the task if if necessary.
1406  * Called when the thread hits a breakpoint.
1407  *
1408  * Returns:
1409  * - pointer to new uprobe_task on success
1410  * - NULL otherwise
1411  */
1412 static struct uprobe_task *get_utask(void)
1413 {
1414         if (!current->utask)
1415                 current->utask = kzalloc(sizeof(struct uprobe_task), GFP_KERNEL);
1416         return current->utask;
1417 }
1418
1419 static int dup_utask(struct task_struct *t, struct uprobe_task *o_utask)
1420 {
1421         struct uprobe_task *n_utask;
1422         struct return_instance **p, *o, *n;
1423
1424         n_utask = kzalloc(sizeof(struct uprobe_task), GFP_KERNEL);
1425         if (!n_utask)
1426                 return -ENOMEM;
1427         t->utask = n_utask;
1428
1429         p = &n_utask->return_instances;
1430         for (o = o_utask->return_instances; o; o = o->next) {
1431                 n = kmalloc(sizeof(struct return_instance), GFP_KERNEL);
1432                 if (!n)
1433                         return -ENOMEM;
1434
1435                 *n = *o;
1436                 get_uprobe(n->uprobe);
1437                 n->next = NULL;
1438
1439                 *p = n;
1440                 p = &n->next;
1441                 n_utask->depth++;
1442         }
1443
1444         return 0;
1445 }
1446
1447 static void uprobe_warn(struct task_struct *t, const char *msg)
1448 {
1449         pr_warn("uprobe: %s:%d failed to %s\n",
1450                         current->comm, current->pid, msg);
1451 }
1452
1453 static void dup_xol_work(struct callback_head *work)
1454 {
1455         if (current->flags & PF_EXITING)
1456                 return;
1457
1458         if (!__create_xol_area(current->utask->dup_xol_addr))
1459                 uprobe_warn(current, "dup xol area");
1460 }
1461
1462 /*
1463  * Called in context of a new clone/fork from copy_process.
1464  */
1465 void uprobe_copy_process(struct task_struct *t, unsigned long flags)
1466 {
1467         struct uprobe_task *utask = current->utask;
1468         struct mm_struct *mm = current->mm;
1469         struct xol_area *area;
1470
1471         t->utask = NULL;
1472
1473         if (!utask || !utask->return_instances)
1474                 return;
1475
1476         if (mm == t->mm && !(flags & CLONE_VFORK))
1477                 return;
1478
1479         if (dup_utask(t, utask))
1480                 return uprobe_warn(t, "dup ret instances");
1481
1482         /* The task can fork() after dup_xol_work() fails */
1483         area = mm->uprobes_state.xol_area;
1484         if (!area)
1485                 return uprobe_warn(t, "dup xol area");
1486
1487         if (mm == t->mm)
1488                 return;
1489
1490         t->utask->dup_xol_addr = area->vaddr;
1491         init_task_work(&t->utask->dup_xol_work, dup_xol_work);
1492         task_work_add(t, &t->utask->dup_xol_work, true);
1493 }
1494
1495 /*
1496  * Current area->vaddr notion assume the trampoline address is always
1497  * equal area->vaddr.
1498  *
1499  * Returns -1 in case the xol_area is not allocated.
1500  */
1501 static unsigned long get_trampoline_vaddr(void)
1502 {
1503         struct xol_area *area;
1504         unsigned long trampoline_vaddr = -1;
1505
1506         area = current->mm->uprobes_state.xol_area;
1507         smp_read_barrier_depends();
1508         if (area)
1509                 trampoline_vaddr = area->vaddr;
1510
1511         return trampoline_vaddr;
1512 }
1513
1514 static void prepare_uretprobe(struct uprobe *uprobe, struct pt_regs *regs)
1515 {
1516         struct return_instance *ri;
1517         struct uprobe_task *utask;
1518         unsigned long orig_ret_vaddr, trampoline_vaddr;
1519         bool chained = false;
1520
1521         if (!get_xol_area())
1522                 return;
1523
1524         utask = get_utask();
1525         if (!utask)
1526                 return;
1527
1528         if (utask->depth >= MAX_URETPROBE_DEPTH) {
1529                 printk_ratelimited(KERN_INFO "uprobe: omit uretprobe due to"
1530                                 " nestedness limit pid/tgid=%d/%d\n",
1531                                 current->pid, current->tgid);
1532                 return;
1533         }
1534
1535         ri = kmalloc(sizeof(struct return_instance), GFP_KERNEL);
1536         if (!ri)
1537                 return;
1538
1539         trampoline_vaddr = get_trampoline_vaddr();
1540         orig_ret_vaddr = arch_uretprobe_hijack_return_addr(trampoline_vaddr, regs);
1541         if (orig_ret_vaddr == -1)
1542                 goto fail;
1543
1544         /*
1545          * We don't want to keep trampoline address in stack, rather keep the
1546          * original return address of first caller thru all the consequent
1547          * instances. This also makes breakpoint unwrapping easier.
1548          */
1549         if (orig_ret_vaddr == trampoline_vaddr) {
1550                 if (!utask->return_instances) {
1551                         /*
1552                          * This situation is not possible. Likely we have an
1553                          * attack from user-space.
1554                          */
1555                         uprobe_warn(current, "handle tail call");
1556                         goto fail;
1557                 }
1558
1559                 chained = true;
1560                 orig_ret_vaddr = utask->return_instances->orig_ret_vaddr;
1561         }
1562
1563         ri->uprobe = get_uprobe(uprobe);
1564         ri->func = instruction_pointer(regs);
1565         ri->stack = user_stack_pointer(regs);
1566         ri->orig_ret_vaddr = orig_ret_vaddr;
1567         ri->chained = chained;
1568
1569         utask->depth++;
1570         ri->next = utask->return_instances;
1571         utask->return_instances = ri;
1572
1573         return;
1574  fail:
1575         kfree(ri);
1576 }
1577
1578 /* Prepare to single-step probed instruction out of line. */
1579 static int
1580 pre_ssout(struct uprobe *uprobe, struct pt_regs *regs, unsigned long bp_vaddr)
1581 {
1582         struct uprobe_task *utask;
1583         unsigned long xol_vaddr;
1584         int err;
1585
1586         utask = get_utask();
1587         if (!utask)
1588                 return -ENOMEM;
1589
1590         xol_vaddr = xol_get_insn_slot(uprobe);
1591         if (!xol_vaddr)
1592                 return -ENOMEM;
1593
1594         utask->xol_vaddr = xol_vaddr;
1595         utask->vaddr = bp_vaddr;
1596
1597         err = arch_uprobe_pre_xol(&uprobe->arch, regs);
1598         if (unlikely(err)) {
1599                 xol_free_insn_slot(current);
1600                 return err;
1601         }
1602
1603         utask->active_uprobe = uprobe;
1604         utask->state = UTASK_SSTEP;
1605         return 0;
1606 }
1607
1608 /*
1609  * If we are singlestepping, then ensure this thread is not connected to
1610  * non-fatal signals until completion of singlestep.  When xol insn itself
1611  * triggers the signal,  restart the original insn even if the task is
1612  * already SIGKILL'ed (since coredump should report the correct ip).  This
1613  * is even more important if the task has a handler for SIGSEGV/etc, The
1614  * _same_ instruction should be repeated again after return from the signal
1615  * handler, and SSTEP can never finish in this case.
1616  */
1617 bool uprobe_deny_signal(void)
1618 {
1619         struct task_struct *t = current;
1620         struct uprobe_task *utask = t->utask;
1621
1622         if (likely(!utask || !utask->active_uprobe))
1623                 return false;
1624
1625         WARN_ON_ONCE(utask->state != UTASK_SSTEP);
1626
1627         if (signal_pending(t)) {
1628                 spin_lock_irq(&t->sighand->siglock);
1629                 clear_tsk_thread_flag(t, TIF_SIGPENDING);
1630                 spin_unlock_irq(&t->sighand->siglock);
1631
1632                 if (__fatal_signal_pending(t) || arch_uprobe_xol_was_trapped(t)) {
1633                         utask->state = UTASK_SSTEP_TRAPPED;
1634                         set_tsk_thread_flag(t, TIF_UPROBE);
1635                 }
1636         }
1637
1638         return true;
1639 }
1640
1641 static void mmf_recalc_uprobes(struct mm_struct *mm)
1642 {
1643         struct vm_area_struct *vma;
1644
1645         for (vma = mm->mmap; vma; vma = vma->vm_next) {
1646                 if (!valid_vma(vma, false))
1647                         continue;
1648                 /*
1649                  * This is not strictly accurate, we can race with
1650                  * uprobe_unregister() and see the already removed
1651                  * uprobe if delete_uprobe() was not yet called.
1652                  * Or this uprobe can be filtered out.
1653                  */
1654                 if (vma_has_uprobes(vma, vma->vm_start, vma->vm_end))
1655                         return;
1656         }
1657
1658         clear_bit(MMF_HAS_UPROBES, &mm->flags);
1659 }
1660
1661 static int is_trap_at_addr(struct mm_struct *mm, unsigned long vaddr)
1662 {
1663         struct page *page;
1664         uprobe_opcode_t opcode;
1665         int result;
1666
1667         pagefault_disable();
1668         result = __copy_from_user_inatomic(&opcode, (void __user*)vaddr,
1669                                                         sizeof(opcode));
1670         pagefault_enable();
1671
1672         if (likely(result == 0))
1673                 goto out;
1674
1675         result = get_user_pages(NULL, mm, vaddr, 1, 0, 1, &page, NULL);
1676         if (result < 0)
1677                 return result;
1678
1679         copy_from_page(page, vaddr, &opcode, UPROBE_SWBP_INSN_SIZE);
1680         put_page(page);
1681  out:
1682         /* This needs to return true for any variant of the trap insn */
1683         return is_trap_insn(&opcode);
1684 }
1685
1686 static struct uprobe *find_active_uprobe(unsigned long bp_vaddr, int *is_swbp)
1687 {
1688         struct mm_struct *mm = current->mm;
1689         struct uprobe *uprobe = NULL;
1690         struct vm_area_struct *vma;
1691
1692         down_read(&mm->mmap_sem);
1693         vma = find_vma(mm, bp_vaddr);
1694         if (vma && vma->vm_start <= bp_vaddr) {
1695                 if (valid_vma(vma, false)) {
1696                         struct inode *inode = file_inode(vma->vm_file);
1697                         loff_t offset = vaddr_to_offset(vma, bp_vaddr);
1698
1699                         uprobe = find_uprobe(inode, offset);
1700                 }
1701
1702                 if (!uprobe)
1703                         *is_swbp = is_trap_at_addr(mm, bp_vaddr);
1704         } else {
1705                 *is_swbp = -EFAULT;
1706         }
1707
1708         if (!uprobe && test_and_clear_bit(MMF_RECALC_UPROBES, &mm->flags))
1709                 mmf_recalc_uprobes(mm);
1710         up_read(&mm->mmap_sem);
1711
1712         return uprobe;
1713 }
1714
1715 static void handler_chain(struct uprobe *uprobe, struct pt_regs *regs)
1716 {
1717         struct uprobe_consumer *uc;
1718         int remove = UPROBE_HANDLER_REMOVE;
1719         bool need_prep = false; /* prepare return uprobe, when needed */
1720
1721         down_read(&uprobe->register_rwsem);
1722         for (uc = uprobe->consumers; uc; uc = uc->next) {
1723                 int rc = 0;
1724
1725                 if (uc->handler) {
1726                         rc = uc->handler(uc, regs);
1727                         WARN(rc & ~UPROBE_HANDLER_MASK,
1728                                 "bad rc=0x%x from %pf()\n", rc, uc->handler);
1729                 }
1730
1731                 if (uc->ret_handler)
1732                         need_prep = true;
1733
1734                 remove &= rc;
1735         }
1736
1737         if (need_prep && !remove)
1738                 prepare_uretprobe(uprobe, regs); /* put bp at return */
1739
1740         if (remove && uprobe->consumers) {
1741                 WARN_ON(!uprobe_is_active(uprobe));
1742                 unapply_uprobe(uprobe, current->mm);
1743         }
1744         up_read(&uprobe->register_rwsem);
1745 }
1746
1747 static void
1748 handle_uretprobe_chain(struct return_instance *ri, struct pt_regs *regs)
1749 {
1750         struct uprobe *uprobe = ri->uprobe;
1751         struct uprobe_consumer *uc;
1752
1753         down_read(&uprobe->register_rwsem);
1754         for (uc = uprobe->consumers; uc; uc = uc->next) {
1755                 if (uc->ret_handler)
1756                         uc->ret_handler(uc, ri->func, regs);
1757         }
1758         up_read(&uprobe->register_rwsem);
1759 }
1760
1761 static struct return_instance *find_next_ret_chain(struct return_instance *ri)
1762 {
1763         bool chained;
1764
1765         do {
1766                 chained = ri->chained;
1767                 ri = ri->next;  /* can't be NULL if chained */
1768         } while (chained);
1769
1770         return ri;
1771 }
1772
1773 static void handle_trampoline(struct pt_regs *regs)
1774 {
1775         struct uprobe_task *utask;
1776         struct return_instance *ri, *next;
1777
1778         utask = current->utask;
1779         if (!utask)
1780                 goto sigill;
1781
1782         ri = utask->return_instances;
1783         if (!ri)
1784                 goto sigill;
1785
1786         next = find_next_ret_chain(ri);
1787         /*
1788          * TODO: we should throw out return_instance's invalidated by
1789          * longjmp(), currently we assume that the probed function always
1790          * returns.
1791          */
1792         instruction_pointer_set(regs, ri->orig_ret_vaddr);
1793         do {
1794                 handle_uretprobe_chain(ri, regs);
1795                 ri = free_ret_instance(ri);
1796                 utask->depth--;
1797         } while (ri != next);
1798
1799         utask->return_instances = ri;
1800         return;
1801
1802  sigill:
1803         uprobe_warn(current, "handle uretprobe, sending SIGILL.");
1804         force_sig_info(SIGILL, SEND_SIG_FORCED, current);
1805
1806 }
1807
1808 bool __weak arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs)
1809 {
1810         return false;
1811 }
1812
1813 bool __weak arch_uretprobe_is_alive(struct return_instance *ret, struct pt_regs *regs)
1814 {
1815         return true;
1816 }
1817
1818 /*
1819  * Run handler and ask thread to singlestep.
1820  * Ensure all non-fatal signals cannot interrupt thread while it singlesteps.
1821  */
1822 static void handle_swbp(struct pt_regs *regs)
1823 {
1824         struct uprobe *uprobe;
1825         unsigned long bp_vaddr;
1826         int uninitialized_var(is_swbp);
1827
1828         bp_vaddr = uprobe_get_swbp_addr(regs);
1829         if (bp_vaddr == get_trampoline_vaddr())
1830                 return handle_trampoline(regs);
1831
1832         uprobe = find_active_uprobe(bp_vaddr, &is_swbp);
1833         if (!uprobe) {
1834                 if (is_swbp > 0) {
1835                         /* No matching uprobe; signal SIGTRAP. */
1836                         send_sig(SIGTRAP, current, 0);
1837                 } else {
1838                         /*
1839                          * Either we raced with uprobe_unregister() or we can't
1840                          * access this memory. The latter is only possible if
1841                          * another thread plays with our ->mm. In both cases
1842                          * we can simply restart. If this vma was unmapped we
1843                          * can pretend this insn was not executed yet and get
1844                          * the (correct) SIGSEGV after restart.
1845                          */
1846                         instruction_pointer_set(regs, bp_vaddr);
1847                 }
1848                 return;
1849         }
1850
1851         /* change it in advance for ->handler() and restart */
1852         instruction_pointer_set(regs, bp_vaddr);
1853
1854         /*
1855          * TODO: move copy_insn/etc into _register and remove this hack.
1856          * After we hit the bp, _unregister + _register can install the
1857          * new and not-yet-analyzed uprobe at the same address, restart.
1858          */
1859         smp_rmb(); /* pairs with wmb() in install_breakpoint() */
1860         if (unlikely(!test_bit(UPROBE_COPY_INSN, &uprobe->flags)))
1861                 goto out;
1862
1863         /* Tracing handlers use ->utask to communicate with fetch methods */
1864         if (!get_utask())
1865                 goto out;
1866
1867         if (arch_uprobe_ignore(&uprobe->arch, regs))
1868                 goto out;
1869
1870         handler_chain(uprobe, regs);
1871
1872         if (arch_uprobe_skip_sstep(&uprobe->arch, regs))
1873                 goto out;
1874
1875         if (!pre_ssout(uprobe, regs, bp_vaddr))
1876                 return;
1877
1878         /* arch_uprobe_skip_sstep() succeeded, or restart if can't singlestep */
1879 out:
1880         put_uprobe(uprobe);
1881 }
1882
1883 /*
1884  * Perform required fix-ups and disable singlestep.
1885  * Allow pending signals to take effect.
1886  */
1887 static void handle_singlestep(struct uprobe_task *utask, struct pt_regs *regs)
1888 {
1889         struct uprobe *uprobe;
1890         int err = 0;
1891
1892         uprobe = utask->active_uprobe;
1893         if (utask->state == UTASK_SSTEP_ACK)
1894                 err = arch_uprobe_post_xol(&uprobe->arch, regs);
1895         else if (utask->state == UTASK_SSTEP_TRAPPED)
1896                 arch_uprobe_abort_xol(&uprobe->arch, regs);
1897         else
1898                 WARN_ON_ONCE(1);
1899
1900         put_uprobe(uprobe);
1901         utask->active_uprobe = NULL;
1902         utask->state = UTASK_RUNNING;
1903         xol_free_insn_slot(current);
1904
1905         spin_lock_irq(&current->sighand->siglock);
1906         recalc_sigpending(); /* see uprobe_deny_signal() */
1907         spin_unlock_irq(&current->sighand->siglock);
1908
1909         if (unlikely(err)) {
1910                 uprobe_warn(current, "execute the probed insn, sending SIGILL.");
1911                 force_sig_info(SIGILL, SEND_SIG_FORCED, current);
1912         }
1913 }
1914
1915 /*
1916  * On breakpoint hit, breakpoint notifier sets the TIF_UPROBE flag and
1917  * allows the thread to return from interrupt. After that handle_swbp()
1918  * sets utask->active_uprobe.
1919  *
1920  * On singlestep exception, singlestep notifier sets the TIF_UPROBE flag
1921  * and allows the thread to return from interrupt.
1922  *
1923  * While returning to userspace, thread notices the TIF_UPROBE flag and calls
1924  * uprobe_notify_resume().
1925  */
1926 void uprobe_notify_resume(struct pt_regs *regs)
1927 {
1928         struct uprobe_task *utask;
1929
1930         clear_thread_flag(TIF_UPROBE);
1931
1932         utask = current->utask;
1933         if (utask && utask->active_uprobe)
1934                 handle_singlestep(utask, regs);
1935         else
1936                 handle_swbp(regs);
1937 }
1938
1939 /*
1940  * uprobe_pre_sstep_notifier gets called from interrupt context as part of
1941  * notifier mechanism. Set TIF_UPROBE flag and indicate breakpoint hit.
1942  */
1943 int uprobe_pre_sstep_notifier(struct pt_regs *regs)
1944 {
1945         if (!current->mm)
1946                 return 0;
1947
1948         if (!test_bit(MMF_HAS_UPROBES, &current->mm->flags) &&
1949             (!current->utask || !current->utask->return_instances))
1950                 return 0;
1951
1952         set_thread_flag(TIF_UPROBE);
1953         return 1;
1954 }
1955
1956 /*
1957  * uprobe_post_sstep_notifier gets called in interrupt context as part of notifier
1958  * mechanism. Set TIF_UPROBE flag and indicate completion of singlestep.
1959  */
1960 int uprobe_post_sstep_notifier(struct pt_regs *regs)
1961 {
1962         struct uprobe_task *utask = current->utask;
1963
1964         if (!current->mm || !utask || !utask->active_uprobe)
1965                 /* task is currently not uprobed */
1966                 return 0;
1967
1968         utask->state = UTASK_SSTEP_ACK;
1969         set_thread_flag(TIF_UPROBE);
1970         return 1;
1971 }
1972
1973 static struct notifier_block uprobe_exception_nb = {
1974         .notifier_call          = arch_uprobe_exception_notify,
1975         .priority               = INT_MAX-1,    /* notified after kprobes, kgdb */
1976 };
1977
1978 static int __init init_uprobes(void)
1979 {
1980         int i;
1981
1982         for (i = 0; i < UPROBES_HASH_SZ; i++)
1983                 mutex_init(&uprobes_mmap_mutex[i]);
1984
1985         if (percpu_init_rwsem(&dup_mmap_sem))
1986                 return -ENOMEM;
1987
1988         return register_die_notifier(&uprobe_exception_nb);
1989 }
1990 __initcall(init_uprobes);