db24062fb34335a7c81761c1fbb47968430504f6
[linux-2.6-microblaze.git] / drivers / vfio / vfio_iommu_type1.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * VFIO: IOMMU DMA mapping support for Type1 IOMMU
4  *
5  * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
6  *     Author: Alex Williamson <alex.williamson@redhat.com>
7  *
8  * Derived from original vfio:
9  * Copyright 2010 Cisco Systems, Inc.  All rights reserved.
10  * Author: Tom Lyon, pugs@cisco.com
11  *
12  * We arbitrarily define a Type1 IOMMU as one matching the below code.
13  * It could be called the x86 IOMMU as it's designed for AMD-Vi & Intel
14  * VT-d, but that makes it harder to re-use as theoretically anyone
15  * implementing a similar IOMMU could make use of this.  We expect the
16  * IOMMU to support the IOMMU API and have few to no restrictions around
17  * the IOVA range that can be mapped.  The Type1 IOMMU is currently
18  * optimized for relatively static mappings of a userspace process with
19  * userspace pages pinned into memory.  We also assume devices and IOMMU
20  * domains are PCI based as the IOMMU API is still centered around a
21  * device/bus interface rather than a group interface.
22  */
23
24 #include <linux/compat.h>
25 #include <linux/device.h>
26 #include <linux/fs.h>
27 #include <linux/highmem.h>
28 #include <linux/iommu.h>
29 #include <linux/module.h>
30 #include <linux/mm.h>
31 #include <linux/kthread.h>
32 #include <linux/rbtree.h>
33 #include <linux/sched/signal.h>
34 #include <linux/sched/mm.h>
35 #include <linux/slab.h>
36 #include <linux/uaccess.h>
37 #include <linux/vfio.h>
38 #include <linux/workqueue.h>
39 #include <linux/notifier.h>
40 #include <linux/dma-iommu.h>
41 #include <linux/irqdomain.h>
42 #include "vfio.h"
43
44 #define DRIVER_VERSION  "0.2"
45 #define DRIVER_AUTHOR   "Alex Williamson <alex.williamson@redhat.com>"
46 #define DRIVER_DESC     "Type1 IOMMU driver for VFIO"
47
48 static bool allow_unsafe_interrupts;
49 module_param_named(allow_unsafe_interrupts,
50                    allow_unsafe_interrupts, bool, S_IRUGO | S_IWUSR);
51 MODULE_PARM_DESC(allow_unsafe_interrupts,
52                  "Enable VFIO IOMMU support for on platforms without interrupt remapping support.");
53
54 static bool disable_hugepages;
55 module_param_named(disable_hugepages,
56                    disable_hugepages, bool, S_IRUGO | S_IWUSR);
57 MODULE_PARM_DESC(disable_hugepages,
58                  "Disable VFIO IOMMU support for IOMMU hugepages.");
59
60 static unsigned int dma_entry_limit __read_mostly = U16_MAX;
61 module_param_named(dma_entry_limit, dma_entry_limit, uint, 0644);
62 MODULE_PARM_DESC(dma_entry_limit,
63                  "Maximum number of user DMA mappings per container (65535).");
64
65 struct vfio_iommu {
66         struct list_head        domain_list;
67         struct list_head        iova_list;
68         struct mutex            lock;
69         struct rb_root          dma_list;
70         struct blocking_notifier_head notifier;
71         unsigned int            dma_avail;
72         unsigned int            vaddr_invalid_count;
73         uint64_t                pgsize_bitmap;
74         uint64_t                num_non_pinned_groups;
75         wait_queue_head_t       vaddr_wait;
76         bool                    v2;
77         bool                    nesting;
78         bool                    dirty_page_tracking;
79         bool                    container_open;
80         struct list_head        emulated_iommu_groups;
81 };
82
83 struct vfio_domain {
84         struct iommu_domain     *domain;
85         struct list_head        next;
86         struct list_head        group_list;
87         bool                    fgsp : 1;       /* Fine-grained super pages */
88         bool                    enforce_cache_coherency : 1;
89 };
90
91 struct vfio_dma {
92         struct rb_node          node;
93         dma_addr_t              iova;           /* Device address */
94         unsigned long           vaddr;          /* Process virtual addr */
95         size_t                  size;           /* Map size (bytes) */
96         int                     prot;           /* IOMMU_READ/WRITE */
97         bool                    iommu_mapped;
98         bool                    lock_cap;       /* capable(CAP_IPC_LOCK) */
99         bool                    vaddr_invalid;
100         struct task_struct      *task;
101         struct rb_root          pfn_list;       /* Ex-user pinned pfn list */
102         unsigned long           *bitmap;
103 };
104
105 struct vfio_batch {
106         struct page             **pages;        /* for pin_user_pages_remote */
107         struct page             *fallback_page; /* if pages alloc fails */
108         int                     capacity;       /* length of pages array */
109         int                     size;           /* of batch currently */
110         int                     offset;         /* of next entry in pages */
111 };
112
113 struct vfio_iommu_group {
114         struct iommu_group      *iommu_group;
115         struct list_head        next;
116         bool                    pinned_page_dirty_scope;
117 };
118
119 struct vfio_iova {
120         struct list_head        list;
121         dma_addr_t              start;
122         dma_addr_t              end;
123 };
124
125 /*
126  * Guest RAM pinning working set or DMA target
127  */
128 struct vfio_pfn {
129         struct rb_node          node;
130         dma_addr_t              iova;           /* Device address */
131         unsigned long           pfn;            /* Host pfn */
132         unsigned int            ref_count;
133 };
134
135 struct vfio_regions {
136         struct list_head list;
137         dma_addr_t iova;
138         phys_addr_t phys;
139         size_t len;
140 };
141
142 #define DIRTY_BITMAP_BYTES(n)   (ALIGN(n, BITS_PER_TYPE(u64)) / BITS_PER_BYTE)
143
144 /*
145  * Input argument of number of bits to bitmap_set() is unsigned integer, which
146  * further casts to signed integer for unaligned multi-bit operation,
147  * __bitmap_set().
148  * Then maximum bitmap size supported is 2^31 bits divided by 2^3 bits/byte,
149  * that is 2^28 (256 MB) which maps to 2^31 * 2^12 = 2^43 (8TB) on 4K page
150  * system.
151  */
152 #define DIRTY_BITMAP_PAGES_MAX   ((u64)INT_MAX)
153 #define DIRTY_BITMAP_SIZE_MAX    DIRTY_BITMAP_BYTES(DIRTY_BITMAP_PAGES_MAX)
154
155 #define WAITED 1
156
157 static int put_pfn(unsigned long pfn, int prot);
158
159 static struct vfio_iommu_group*
160 vfio_iommu_find_iommu_group(struct vfio_iommu *iommu,
161                             struct iommu_group *iommu_group);
162
163 /*
164  * This code handles mapping and unmapping of user data buffers
165  * into DMA'ble space using the IOMMU
166  */
167
168 static struct vfio_dma *vfio_find_dma(struct vfio_iommu *iommu,
169                                       dma_addr_t start, size_t size)
170 {
171         struct rb_node *node = iommu->dma_list.rb_node;
172
173         while (node) {
174                 struct vfio_dma *dma = rb_entry(node, struct vfio_dma, node);
175
176                 if (start + size <= dma->iova)
177                         node = node->rb_left;
178                 else if (start >= dma->iova + dma->size)
179                         node = node->rb_right;
180                 else
181                         return dma;
182         }
183
184         return NULL;
185 }
186
187 static struct rb_node *vfio_find_dma_first_node(struct vfio_iommu *iommu,
188                                                 dma_addr_t start, u64 size)
189 {
190         struct rb_node *res = NULL;
191         struct rb_node *node = iommu->dma_list.rb_node;
192         struct vfio_dma *dma_res = NULL;
193
194         while (node) {
195                 struct vfio_dma *dma = rb_entry(node, struct vfio_dma, node);
196
197                 if (start < dma->iova + dma->size) {
198                         res = node;
199                         dma_res = dma;
200                         if (start >= dma->iova)
201                                 break;
202                         node = node->rb_left;
203                 } else {
204                         node = node->rb_right;
205                 }
206         }
207         if (res && size && dma_res->iova >= start + size)
208                 res = NULL;
209         return res;
210 }
211
212 static void vfio_link_dma(struct vfio_iommu *iommu, struct vfio_dma *new)
213 {
214         struct rb_node **link = &iommu->dma_list.rb_node, *parent = NULL;
215         struct vfio_dma *dma;
216
217         while (*link) {
218                 parent = *link;
219                 dma = rb_entry(parent, struct vfio_dma, node);
220
221                 if (new->iova + new->size <= dma->iova)
222                         link = &(*link)->rb_left;
223                 else
224                         link = &(*link)->rb_right;
225         }
226
227         rb_link_node(&new->node, parent, link);
228         rb_insert_color(&new->node, &iommu->dma_list);
229 }
230
231 static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)
232 {
233         rb_erase(&old->node, &iommu->dma_list);
234 }
235
236
237 static int vfio_dma_bitmap_alloc(struct vfio_dma *dma, size_t pgsize)
238 {
239         uint64_t npages = dma->size / pgsize;
240
241         if (npages > DIRTY_BITMAP_PAGES_MAX)
242                 return -EINVAL;
243
244         /*
245          * Allocate extra 64 bits that are used to calculate shift required for
246          * bitmap_shift_left() to manipulate and club unaligned number of pages
247          * in adjacent vfio_dma ranges.
248          */
249         dma->bitmap = kvzalloc(DIRTY_BITMAP_BYTES(npages) + sizeof(u64),
250                                GFP_KERNEL);
251         if (!dma->bitmap)
252                 return -ENOMEM;
253
254         return 0;
255 }
256
257 static void vfio_dma_bitmap_free(struct vfio_dma *dma)
258 {
259         kvfree(dma->bitmap);
260         dma->bitmap = NULL;
261 }
262
263 static void vfio_dma_populate_bitmap(struct vfio_dma *dma, size_t pgsize)
264 {
265         struct rb_node *p;
266         unsigned long pgshift = __ffs(pgsize);
267
268         for (p = rb_first(&dma->pfn_list); p; p = rb_next(p)) {
269                 struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn, node);
270
271                 bitmap_set(dma->bitmap, (vpfn->iova - dma->iova) >> pgshift, 1);
272         }
273 }
274
275 static void vfio_iommu_populate_bitmap_full(struct vfio_iommu *iommu)
276 {
277         struct rb_node *n;
278         unsigned long pgshift = __ffs(iommu->pgsize_bitmap);
279
280         for (n = rb_first(&iommu->dma_list); n; n = rb_next(n)) {
281                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
282
283                 bitmap_set(dma->bitmap, 0, dma->size >> pgshift);
284         }
285 }
286
287 static int vfio_dma_bitmap_alloc_all(struct vfio_iommu *iommu, size_t pgsize)
288 {
289         struct rb_node *n;
290
291         for (n = rb_first(&iommu->dma_list); n; n = rb_next(n)) {
292                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
293                 int ret;
294
295                 ret = vfio_dma_bitmap_alloc(dma, pgsize);
296                 if (ret) {
297                         struct rb_node *p;
298
299                         for (p = rb_prev(n); p; p = rb_prev(p)) {
300                                 struct vfio_dma *dma = rb_entry(n,
301                                                         struct vfio_dma, node);
302
303                                 vfio_dma_bitmap_free(dma);
304                         }
305                         return ret;
306                 }
307                 vfio_dma_populate_bitmap(dma, pgsize);
308         }
309         return 0;
310 }
311
312 static void vfio_dma_bitmap_free_all(struct vfio_iommu *iommu)
313 {
314         struct rb_node *n;
315
316         for (n = rb_first(&iommu->dma_list); n; n = rb_next(n)) {
317                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
318
319                 vfio_dma_bitmap_free(dma);
320         }
321 }
322
323 /*
324  * Helper Functions for host iova-pfn list
325  */
326 static struct vfio_pfn *vfio_find_vpfn(struct vfio_dma *dma, dma_addr_t iova)
327 {
328         struct vfio_pfn *vpfn;
329         struct rb_node *node = dma->pfn_list.rb_node;
330
331         while (node) {
332                 vpfn = rb_entry(node, struct vfio_pfn, node);
333
334                 if (iova < vpfn->iova)
335                         node = node->rb_left;
336                 else if (iova > vpfn->iova)
337                         node = node->rb_right;
338                 else
339                         return vpfn;
340         }
341         return NULL;
342 }
343
344 static void vfio_link_pfn(struct vfio_dma *dma,
345                           struct vfio_pfn *new)
346 {
347         struct rb_node **link, *parent = NULL;
348         struct vfio_pfn *vpfn;
349
350         link = &dma->pfn_list.rb_node;
351         while (*link) {
352                 parent = *link;
353                 vpfn = rb_entry(parent, struct vfio_pfn, node);
354
355                 if (new->iova < vpfn->iova)
356                         link = &(*link)->rb_left;
357                 else
358                         link = &(*link)->rb_right;
359         }
360
361         rb_link_node(&new->node, parent, link);
362         rb_insert_color(&new->node, &dma->pfn_list);
363 }
364
365 static void vfio_unlink_pfn(struct vfio_dma *dma, struct vfio_pfn *old)
366 {
367         rb_erase(&old->node, &dma->pfn_list);
368 }
369
370 static int vfio_add_to_pfn_list(struct vfio_dma *dma, dma_addr_t iova,
371                                 unsigned long pfn)
372 {
373         struct vfio_pfn *vpfn;
374
375         vpfn = kzalloc(sizeof(*vpfn), GFP_KERNEL);
376         if (!vpfn)
377                 return -ENOMEM;
378
379         vpfn->iova = iova;
380         vpfn->pfn = pfn;
381         vpfn->ref_count = 1;
382         vfio_link_pfn(dma, vpfn);
383         return 0;
384 }
385
386 static void vfio_remove_from_pfn_list(struct vfio_dma *dma,
387                                       struct vfio_pfn *vpfn)
388 {
389         vfio_unlink_pfn(dma, vpfn);
390         kfree(vpfn);
391 }
392
393 static struct vfio_pfn *vfio_iova_get_vfio_pfn(struct vfio_dma *dma,
394                                                unsigned long iova)
395 {
396         struct vfio_pfn *vpfn = vfio_find_vpfn(dma, iova);
397
398         if (vpfn)
399                 vpfn->ref_count++;
400         return vpfn;
401 }
402
403 static int vfio_iova_put_vfio_pfn(struct vfio_dma *dma, struct vfio_pfn *vpfn)
404 {
405         int ret = 0;
406
407         vpfn->ref_count--;
408         if (!vpfn->ref_count) {
409                 ret = put_pfn(vpfn->pfn, dma->prot);
410                 vfio_remove_from_pfn_list(dma, vpfn);
411         }
412         return ret;
413 }
414
415 static int vfio_lock_acct(struct vfio_dma *dma, long npage, bool async)
416 {
417         struct mm_struct *mm;
418         int ret;
419
420         if (!npage)
421                 return 0;
422
423         mm = async ? get_task_mm(dma->task) : dma->task->mm;
424         if (!mm)
425                 return -ESRCH; /* process exited */
426
427         ret = mmap_write_lock_killable(mm);
428         if (!ret) {
429                 ret = __account_locked_vm(mm, abs(npage), npage > 0, dma->task,
430                                           dma->lock_cap);
431                 mmap_write_unlock(mm);
432         }
433
434         if (async)
435                 mmput(mm);
436
437         return ret;
438 }
439
440 /*
441  * Some mappings aren't backed by a struct page, for example an mmap'd
442  * MMIO range for our own or another device.  These use a different
443  * pfn conversion and shouldn't be tracked as locked pages.
444  * For compound pages, any driver that sets the reserved bit in head
445  * page needs to set the reserved bit in all subpages to be safe.
446  */
447 static bool is_invalid_reserved_pfn(unsigned long pfn)
448 {
449         if (pfn_valid(pfn))
450                 return PageReserved(pfn_to_page(pfn));
451
452         return true;
453 }
454
455 static int put_pfn(unsigned long pfn, int prot)
456 {
457         if (!is_invalid_reserved_pfn(pfn)) {
458                 struct page *page = pfn_to_page(pfn);
459
460                 unpin_user_pages_dirty_lock(&page, 1, prot & IOMMU_WRITE);
461                 return 1;
462         }
463         return 0;
464 }
465
466 #define VFIO_BATCH_MAX_CAPACITY (PAGE_SIZE / sizeof(struct page *))
467
468 static void vfio_batch_init(struct vfio_batch *batch)
469 {
470         batch->size = 0;
471         batch->offset = 0;
472
473         if (unlikely(disable_hugepages))
474                 goto fallback;
475
476         batch->pages = (struct page **) __get_free_page(GFP_KERNEL);
477         if (!batch->pages)
478                 goto fallback;
479
480         batch->capacity = VFIO_BATCH_MAX_CAPACITY;
481         return;
482
483 fallback:
484         batch->pages = &batch->fallback_page;
485         batch->capacity = 1;
486 }
487
488 static void vfio_batch_unpin(struct vfio_batch *batch, struct vfio_dma *dma)
489 {
490         while (batch->size) {
491                 unsigned long pfn = page_to_pfn(batch->pages[batch->offset]);
492
493                 put_pfn(pfn, dma->prot);
494                 batch->offset++;
495                 batch->size--;
496         }
497 }
498
499 static void vfio_batch_fini(struct vfio_batch *batch)
500 {
501         if (batch->capacity == VFIO_BATCH_MAX_CAPACITY)
502                 free_page((unsigned long)batch->pages);
503 }
504
505 static int follow_fault_pfn(struct vm_area_struct *vma, struct mm_struct *mm,
506                             unsigned long vaddr, unsigned long *pfn,
507                             bool write_fault)
508 {
509         pte_t *ptep;
510         spinlock_t *ptl;
511         int ret;
512
513         ret = follow_pte(vma->vm_mm, vaddr, &ptep, &ptl);
514         if (ret) {
515                 bool unlocked = false;
516
517                 ret = fixup_user_fault(mm, vaddr,
518                                        FAULT_FLAG_REMOTE |
519                                        (write_fault ?  FAULT_FLAG_WRITE : 0),
520                                        &unlocked);
521                 if (unlocked)
522                         return -EAGAIN;
523
524                 if (ret)
525                         return ret;
526
527                 ret = follow_pte(vma->vm_mm, vaddr, &ptep, &ptl);
528                 if (ret)
529                         return ret;
530         }
531
532         if (write_fault && !pte_write(*ptep))
533                 ret = -EFAULT;
534         else
535                 *pfn = pte_pfn(*ptep);
536
537         pte_unmap_unlock(ptep, ptl);
538         return ret;
539 }
540
541 /*
542  * Returns the positive number of pfns successfully obtained or a negative
543  * error code.
544  */
545 static int vaddr_get_pfns(struct mm_struct *mm, unsigned long vaddr,
546                           long npages, int prot, unsigned long *pfn,
547                           struct page **pages)
548 {
549         struct vm_area_struct *vma;
550         unsigned int flags = 0;
551         int ret;
552
553         if (prot & IOMMU_WRITE)
554                 flags |= FOLL_WRITE;
555
556         mmap_read_lock(mm);
557         ret = pin_user_pages_remote(mm, vaddr, npages, flags | FOLL_LONGTERM,
558                                     pages, NULL, NULL);
559         if (ret > 0) {
560                 *pfn = page_to_pfn(pages[0]);
561                 goto done;
562         }
563
564         vaddr = untagged_addr(vaddr);
565
566 retry:
567         vma = vma_lookup(mm, vaddr);
568
569         if (vma && vma->vm_flags & VM_PFNMAP) {
570                 ret = follow_fault_pfn(vma, mm, vaddr, pfn, prot & IOMMU_WRITE);
571                 if (ret == -EAGAIN)
572                         goto retry;
573
574                 if (!ret) {
575                         if (is_invalid_reserved_pfn(*pfn))
576                                 ret = 1;
577                         else
578                                 ret = -EFAULT;
579                 }
580         }
581 done:
582         mmap_read_unlock(mm);
583         return ret;
584 }
585
586 static int vfio_wait(struct vfio_iommu *iommu)
587 {
588         DEFINE_WAIT(wait);
589
590         prepare_to_wait(&iommu->vaddr_wait, &wait, TASK_KILLABLE);
591         mutex_unlock(&iommu->lock);
592         schedule();
593         mutex_lock(&iommu->lock);
594         finish_wait(&iommu->vaddr_wait, &wait);
595         if (kthread_should_stop() || !iommu->container_open ||
596             fatal_signal_pending(current)) {
597                 return -EFAULT;
598         }
599         return WAITED;
600 }
601
602 /*
603  * Find dma struct and wait for its vaddr to be valid.  iommu lock is dropped
604  * if the task waits, but is re-locked on return.  Return result in *dma_p.
605  * Return 0 on success with no waiting, WAITED on success if waited, and -errno
606  * on error.
607  */
608 static int vfio_find_dma_valid(struct vfio_iommu *iommu, dma_addr_t start,
609                                size_t size, struct vfio_dma **dma_p)
610 {
611         int ret = 0;
612
613         do {
614                 *dma_p = vfio_find_dma(iommu, start, size);
615                 if (!*dma_p)
616                         return -EINVAL;
617                 else if (!(*dma_p)->vaddr_invalid)
618                         return ret;
619                 else
620                         ret = vfio_wait(iommu);
621         } while (ret == WAITED);
622
623         return ret;
624 }
625
626 /*
627  * Wait for all vaddr in the dma_list to become valid.  iommu lock is dropped
628  * if the task waits, but is re-locked on return.  Return 0 on success with no
629  * waiting, WAITED on success if waited, and -errno on error.
630  */
631 static int vfio_wait_all_valid(struct vfio_iommu *iommu)
632 {
633         int ret = 0;
634
635         while (iommu->vaddr_invalid_count && ret >= 0)
636                 ret = vfio_wait(iommu);
637
638         return ret;
639 }
640
641 /*
642  * Attempt to pin pages.  We really don't want to track all the pfns and
643  * the iommu can only map chunks of consecutive pfns anyway, so get the
644  * first page and all consecutive pages with the same locking.
645  */
646 static long vfio_pin_pages_remote(struct vfio_dma *dma, unsigned long vaddr,
647                                   long npage, unsigned long *pfn_base,
648                                   unsigned long limit, struct vfio_batch *batch)
649 {
650         unsigned long pfn;
651         struct mm_struct *mm = current->mm;
652         long ret, pinned = 0, lock_acct = 0;
653         bool rsvd;
654         dma_addr_t iova = vaddr - dma->vaddr + dma->iova;
655
656         /* This code path is only user initiated */
657         if (!mm)
658                 return -ENODEV;
659
660         if (batch->size) {
661                 /* Leftover pages in batch from an earlier call. */
662                 *pfn_base = page_to_pfn(batch->pages[batch->offset]);
663                 pfn = *pfn_base;
664                 rsvd = is_invalid_reserved_pfn(*pfn_base);
665         } else {
666                 *pfn_base = 0;
667         }
668
669         while (npage) {
670                 if (!batch->size) {
671                         /* Empty batch, so refill it. */
672                         long req_pages = min_t(long, npage, batch->capacity);
673
674                         ret = vaddr_get_pfns(mm, vaddr, req_pages, dma->prot,
675                                              &pfn, batch->pages);
676                         if (ret < 0)
677                                 goto unpin_out;
678
679                         batch->size = ret;
680                         batch->offset = 0;
681
682                         if (!*pfn_base) {
683                                 *pfn_base = pfn;
684                                 rsvd = is_invalid_reserved_pfn(*pfn_base);
685                         }
686                 }
687
688                 /*
689                  * pfn is preset for the first iteration of this inner loop and
690                  * updated at the end to handle a VM_PFNMAP pfn.  In that case,
691                  * batch->pages isn't valid (there's no struct page), so allow
692                  * batch->pages to be touched only when there's more than one
693                  * pfn to check, which guarantees the pfns are from a
694                  * !VM_PFNMAP vma.
695                  */
696                 while (true) {
697                         if (pfn != *pfn_base + pinned ||
698                             rsvd != is_invalid_reserved_pfn(pfn))
699                                 goto out;
700
701                         /*
702                          * Reserved pages aren't counted against the user,
703                          * externally pinned pages are already counted against
704                          * the user.
705                          */
706                         if (!rsvd && !vfio_find_vpfn(dma, iova)) {
707                                 if (!dma->lock_cap &&
708                                     mm->locked_vm + lock_acct + 1 > limit) {
709                                         pr_warn("%s: RLIMIT_MEMLOCK (%ld) exceeded\n",
710                                                 __func__, limit << PAGE_SHIFT);
711                                         ret = -ENOMEM;
712                                         goto unpin_out;
713                                 }
714                                 lock_acct++;
715                         }
716
717                         pinned++;
718                         npage--;
719                         vaddr += PAGE_SIZE;
720                         iova += PAGE_SIZE;
721                         batch->offset++;
722                         batch->size--;
723
724                         if (!batch->size)
725                                 break;
726
727                         pfn = page_to_pfn(batch->pages[batch->offset]);
728                 }
729
730                 if (unlikely(disable_hugepages))
731                         break;
732         }
733
734 out:
735         ret = vfio_lock_acct(dma, lock_acct, false);
736
737 unpin_out:
738         if (batch->size == 1 && !batch->offset) {
739                 /* May be a VM_PFNMAP pfn, which the batch can't remember. */
740                 put_pfn(pfn, dma->prot);
741                 batch->size = 0;
742         }
743
744         if (ret < 0) {
745                 if (pinned && !rsvd) {
746                         for (pfn = *pfn_base ; pinned ; pfn++, pinned--)
747                                 put_pfn(pfn, dma->prot);
748                 }
749                 vfio_batch_unpin(batch, dma);
750
751                 return ret;
752         }
753
754         return pinned;
755 }
756
757 static long vfio_unpin_pages_remote(struct vfio_dma *dma, dma_addr_t iova,
758                                     unsigned long pfn, long npage,
759                                     bool do_accounting)
760 {
761         long unlocked = 0, locked = 0;
762         long i;
763
764         for (i = 0; i < npage; i++, iova += PAGE_SIZE) {
765                 if (put_pfn(pfn++, dma->prot)) {
766                         unlocked++;
767                         if (vfio_find_vpfn(dma, iova))
768                                 locked++;
769                 }
770         }
771
772         if (do_accounting)
773                 vfio_lock_acct(dma, locked - unlocked, true);
774
775         return unlocked;
776 }
777
778 static int vfio_pin_page_external(struct vfio_dma *dma, unsigned long vaddr,
779                                   unsigned long *pfn_base, bool do_accounting)
780 {
781         struct page *pages[1];
782         struct mm_struct *mm;
783         int ret;
784
785         mm = get_task_mm(dma->task);
786         if (!mm)
787                 return -ENODEV;
788
789         ret = vaddr_get_pfns(mm, vaddr, 1, dma->prot, pfn_base, pages);
790         if (ret != 1)
791                 goto out;
792
793         ret = 0;
794
795         if (do_accounting && !is_invalid_reserved_pfn(*pfn_base)) {
796                 ret = vfio_lock_acct(dma, 1, true);
797                 if (ret) {
798                         put_pfn(*pfn_base, dma->prot);
799                         if (ret == -ENOMEM)
800                                 pr_warn("%s: Task %s (%d) RLIMIT_MEMLOCK "
801                                         "(%ld) exceeded\n", __func__,
802                                         dma->task->comm, task_pid_nr(dma->task),
803                                         task_rlimit(dma->task, RLIMIT_MEMLOCK));
804                 }
805         }
806
807 out:
808         mmput(mm);
809         return ret;
810 }
811
812 static int vfio_unpin_page_external(struct vfio_dma *dma, dma_addr_t iova,
813                                     bool do_accounting)
814 {
815         int unlocked;
816         struct vfio_pfn *vpfn = vfio_find_vpfn(dma, iova);
817
818         if (!vpfn)
819                 return 0;
820
821         unlocked = vfio_iova_put_vfio_pfn(dma, vpfn);
822
823         if (do_accounting)
824                 vfio_lock_acct(dma, -unlocked, true);
825
826         return unlocked;
827 }
828
829 static int vfio_iommu_type1_pin_pages(void *iommu_data,
830                                       struct iommu_group *iommu_group,
831                                       unsigned long *user_pfn,
832                                       int npage, int prot,
833                                       unsigned long *phys_pfn)
834 {
835         struct vfio_iommu *iommu = iommu_data;
836         struct vfio_iommu_group *group;
837         int i, j, ret;
838         unsigned long remote_vaddr;
839         struct vfio_dma *dma;
840         bool do_accounting;
841         dma_addr_t iova;
842
843         if (!iommu || !user_pfn || !phys_pfn)
844                 return -EINVAL;
845
846         /* Supported for v2 version only */
847         if (!iommu->v2)
848                 return -EACCES;
849
850         mutex_lock(&iommu->lock);
851
852         /*
853          * Wait for all necessary vaddr's to be valid so they can be used in
854          * the main loop without dropping the lock, to avoid racing vs unmap.
855          */
856 again:
857         if (iommu->vaddr_invalid_count) {
858                 for (i = 0; i < npage; i++) {
859                         iova = user_pfn[i] << PAGE_SHIFT;
860                         ret = vfio_find_dma_valid(iommu, iova, PAGE_SIZE, &dma);
861                         if (ret < 0)
862                                 goto pin_done;
863                         if (ret == WAITED)
864                                 goto again;
865                 }
866         }
867
868         /* Fail if notifier list is empty */
869         if (!iommu->notifier.head) {
870                 ret = -EINVAL;
871                 goto pin_done;
872         }
873
874         /*
875          * If iommu capable domain exist in the container then all pages are
876          * already pinned and accounted. Accounting should be done if there is no
877          * iommu capable domain in the container.
878          */
879         do_accounting = list_empty(&iommu->domain_list);
880
881         for (i = 0; i < npage; i++) {
882                 struct vfio_pfn *vpfn;
883
884                 iova = user_pfn[i] << PAGE_SHIFT;
885                 dma = vfio_find_dma(iommu, iova, PAGE_SIZE);
886                 if (!dma) {
887                         ret = -EINVAL;
888                         goto pin_unwind;
889                 }
890
891                 if ((dma->prot & prot) != prot) {
892                         ret = -EPERM;
893                         goto pin_unwind;
894                 }
895
896                 vpfn = vfio_iova_get_vfio_pfn(dma, iova);
897                 if (vpfn) {
898                         phys_pfn[i] = vpfn->pfn;
899                         continue;
900                 }
901
902                 remote_vaddr = dma->vaddr + (iova - dma->iova);
903                 ret = vfio_pin_page_external(dma, remote_vaddr, &phys_pfn[i],
904                                              do_accounting);
905                 if (ret)
906                         goto pin_unwind;
907
908                 ret = vfio_add_to_pfn_list(dma, iova, phys_pfn[i]);
909                 if (ret) {
910                         if (put_pfn(phys_pfn[i], dma->prot) && do_accounting)
911                                 vfio_lock_acct(dma, -1, true);
912                         goto pin_unwind;
913                 }
914
915                 if (iommu->dirty_page_tracking) {
916                         unsigned long pgshift = __ffs(iommu->pgsize_bitmap);
917
918                         /*
919                          * Bitmap populated with the smallest supported page
920                          * size
921                          */
922                         bitmap_set(dma->bitmap,
923                                    (iova - dma->iova) >> pgshift, 1);
924                 }
925         }
926         ret = i;
927
928         group = vfio_iommu_find_iommu_group(iommu, iommu_group);
929         if (!group->pinned_page_dirty_scope) {
930                 group->pinned_page_dirty_scope = true;
931                 iommu->num_non_pinned_groups--;
932         }
933
934         goto pin_done;
935
936 pin_unwind:
937         phys_pfn[i] = 0;
938         for (j = 0; j < i; j++) {
939                 dma_addr_t iova;
940
941                 iova = user_pfn[j] << PAGE_SHIFT;
942                 dma = vfio_find_dma(iommu, iova, PAGE_SIZE);
943                 vfio_unpin_page_external(dma, iova, do_accounting);
944                 phys_pfn[j] = 0;
945         }
946 pin_done:
947         mutex_unlock(&iommu->lock);
948         return ret;
949 }
950
951 static int vfio_iommu_type1_unpin_pages(void *iommu_data,
952                                         unsigned long *user_pfn,
953                                         int npage)
954 {
955         struct vfio_iommu *iommu = iommu_data;
956         bool do_accounting;
957         int i;
958
959         if (!iommu || !user_pfn || npage <= 0)
960                 return -EINVAL;
961
962         /* Supported for v2 version only */
963         if (!iommu->v2)
964                 return -EACCES;
965
966         mutex_lock(&iommu->lock);
967
968         do_accounting = list_empty(&iommu->domain_list);
969         for (i = 0; i < npage; i++) {
970                 struct vfio_dma *dma;
971                 dma_addr_t iova;
972
973                 iova = user_pfn[i] << PAGE_SHIFT;
974                 dma = vfio_find_dma(iommu, iova, PAGE_SIZE);
975                 if (!dma)
976                         break;
977
978                 vfio_unpin_page_external(dma, iova, do_accounting);
979         }
980
981         mutex_unlock(&iommu->lock);
982         return i > 0 ? i : -EINVAL;
983 }
984
985 static long vfio_sync_unpin(struct vfio_dma *dma, struct vfio_domain *domain,
986                             struct list_head *regions,
987                             struct iommu_iotlb_gather *iotlb_gather)
988 {
989         long unlocked = 0;
990         struct vfio_regions *entry, *next;
991
992         iommu_iotlb_sync(domain->domain, iotlb_gather);
993
994         list_for_each_entry_safe(entry, next, regions, list) {
995                 unlocked += vfio_unpin_pages_remote(dma,
996                                                     entry->iova,
997                                                     entry->phys >> PAGE_SHIFT,
998                                                     entry->len >> PAGE_SHIFT,
999                                                     false);
1000                 list_del(&entry->list);
1001                 kfree(entry);
1002         }
1003
1004         cond_resched();
1005
1006         return unlocked;
1007 }
1008
1009 /*
1010  * Generally, VFIO needs to unpin remote pages after each IOTLB flush.
1011  * Therefore, when using IOTLB flush sync interface, VFIO need to keep track
1012  * of these regions (currently using a list).
1013  *
1014  * This value specifies maximum number of regions for each IOTLB flush sync.
1015  */
1016 #define VFIO_IOMMU_TLB_SYNC_MAX         512
1017
1018 static size_t unmap_unpin_fast(struct vfio_domain *domain,
1019                                struct vfio_dma *dma, dma_addr_t *iova,
1020                                size_t len, phys_addr_t phys, long *unlocked,
1021                                struct list_head *unmapped_list,
1022                                int *unmapped_cnt,
1023                                struct iommu_iotlb_gather *iotlb_gather)
1024 {
1025         size_t unmapped = 0;
1026         struct vfio_regions *entry = kzalloc(sizeof(*entry), GFP_KERNEL);
1027
1028         if (entry) {
1029                 unmapped = iommu_unmap_fast(domain->domain, *iova, len,
1030                                             iotlb_gather);
1031
1032                 if (!unmapped) {
1033                         kfree(entry);
1034                 } else {
1035                         entry->iova = *iova;
1036                         entry->phys = phys;
1037                         entry->len  = unmapped;
1038                         list_add_tail(&entry->list, unmapped_list);
1039
1040                         *iova += unmapped;
1041                         (*unmapped_cnt)++;
1042                 }
1043         }
1044
1045         /*
1046          * Sync if the number of fast-unmap regions hits the limit
1047          * or in case of errors.
1048          */
1049         if (*unmapped_cnt >= VFIO_IOMMU_TLB_SYNC_MAX || !unmapped) {
1050                 *unlocked += vfio_sync_unpin(dma, domain, unmapped_list,
1051                                              iotlb_gather);
1052                 *unmapped_cnt = 0;
1053         }
1054
1055         return unmapped;
1056 }
1057
1058 static size_t unmap_unpin_slow(struct vfio_domain *domain,
1059                                struct vfio_dma *dma, dma_addr_t *iova,
1060                                size_t len, phys_addr_t phys,
1061                                long *unlocked)
1062 {
1063         size_t unmapped = iommu_unmap(domain->domain, *iova, len);
1064
1065         if (unmapped) {
1066                 *unlocked += vfio_unpin_pages_remote(dma, *iova,
1067                                                      phys >> PAGE_SHIFT,
1068                                                      unmapped >> PAGE_SHIFT,
1069                                                      false);
1070                 *iova += unmapped;
1071                 cond_resched();
1072         }
1073         return unmapped;
1074 }
1075
1076 static long vfio_unmap_unpin(struct vfio_iommu *iommu, struct vfio_dma *dma,
1077                              bool do_accounting)
1078 {
1079         dma_addr_t iova = dma->iova, end = dma->iova + dma->size;
1080         struct vfio_domain *domain, *d;
1081         LIST_HEAD(unmapped_region_list);
1082         struct iommu_iotlb_gather iotlb_gather;
1083         int unmapped_region_cnt = 0;
1084         long unlocked = 0;
1085
1086         if (!dma->size)
1087                 return 0;
1088
1089         if (list_empty(&iommu->domain_list))
1090                 return 0;
1091
1092         /*
1093          * We use the IOMMU to track the physical addresses, otherwise we'd
1094          * need a much more complicated tracking system.  Unfortunately that
1095          * means we need to use one of the iommu domains to figure out the
1096          * pfns to unpin.  The rest need to be unmapped in advance so we have
1097          * no iommu translations remaining when the pages are unpinned.
1098          */
1099         domain = d = list_first_entry(&iommu->domain_list,
1100                                       struct vfio_domain, next);
1101
1102         list_for_each_entry_continue(d, &iommu->domain_list, next) {
1103                 iommu_unmap(d->domain, dma->iova, dma->size);
1104                 cond_resched();
1105         }
1106
1107         iommu_iotlb_gather_init(&iotlb_gather);
1108         while (iova < end) {
1109                 size_t unmapped, len;
1110                 phys_addr_t phys, next;
1111
1112                 phys = iommu_iova_to_phys(domain->domain, iova);
1113                 if (WARN_ON(!phys)) {
1114                         iova += PAGE_SIZE;
1115                         continue;
1116                 }
1117
1118                 /*
1119                  * To optimize for fewer iommu_unmap() calls, each of which
1120                  * may require hardware cache flushing, try to find the
1121                  * largest contiguous physical memory chunk to unmap.
1122                  */
1123                 for (len = PAGE_SIZE;
1124                      !domain->fgsp && iova + len < end; len += PAGE_SIZE) {
1125                         next = iommu_iova_to_phys(domain->domain, iova + len);
1126                         if (next != phys + len)
1127                                 break;
1128                 }
1129
1130                 /*
1131                  * First, try to use fast unmap/unpin. In case of failure,
1132                  * switch to slow unmap/unpin path.
1133                  */
1134                 unmapped = unmap_unpin_fast(domain, dma, &iova, len, phys,
1135                                             &unlocked, &unmapped_region_list,
1136                                             &unmapped_region_cnt,
1137                                             &iotlb_gather);
1138                 if (!unmapped) {
1139                         unmapped = unmap_unpin_slow(domain, dma, &iova, len,
1140                                                     phys, &unlocked);
1141                         if (WARN_ON(!unmapped))
1142                                 break;
1143                 }
1144         }
1145
1146         dma->iommu_mapped = false;
1147
1148         if (unmapped_region_cnt) {
1149                 unlocked += vfio_sync_unpin(dma, domain, &unmapped_region_list,
1150                                             &iotlb_gather);
1151         }
1152
1153         if (do_accounting) {
1154                 vfio_lock_acct(dma, -unlocked, true);
1155                 return 0;
1156         }
1157         return unlocked;
1158 }
1159
1160 static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma)
1161 {
1162         WARN_ON(!RB_EMPTY_ROOT(&dma->pfn_list));
1163         vfio_unmap_unpin(iommu, dma, true);
1164         vfio_unlink_dma(iommu, dma);
1165         put_task_struct(dma->task);
1166         vfio_dma_bitmap_free(dma);
1167         if (dma->vaddr_invalid) {
1168                 iommu->vaddr_invalid_count--;
1169                 wake_up_all(&iommu->vaddr_wait);
1170         }
1171         kfree(dma);
1172         iommu->dma_avail++;
1173 }
1174
1175 static void vfio_update_pgsize_bitmap(struct vfio_iommu *iommu)
1176 {
1177         struct vfio_domain *domain;
1178
1179         iommu->pgsize_bitmap = ULONG_MAX;
1180
1181         list_for_each_entry(domain, &iommu->domain_list, next)
1182                 iommu->pgsize_bitmap &= domain->domain->pgsize_bitmap;
1183
1184         /*
1185          * In case the IOMMU supports page sizes smaller than PAGE_SIZE
1186          * we pretend PAGE_SIZE is supported and hide sub-PAGE_SIZE sizes.
1187          * That way the user will be able to map/unmap buffers whose size/
1188          * start address is aligned with PAGE_SIZE. Pinning code uses that
1189          * granularity while iommu driver can use the sub-PAGE_SIZE size
1190          * to map the buffer.
1191          */
1192         if (iommu->pgsize_bitmap & ~PAGE_MASK) {
1193                 iommu->pgsize_bitmap &= PAGE_MASK;
1194                 iommu->pgsize_bitmap |= PAGE_SIZE;
1195         }
1196 }
1197
1198 static int update_user_bitmap(u64 __user *bitmap, struct vfio_iommu *iommu,
1199                               struct vfio_dma *dma, dma_addr_t base_iova,
1200                               size_t pgsize)
1201 {
1202         unsigned long pgshift = __ffs(pgsize);
1203         unsigned long nbits = dma->size >> pgshift;
1204         unsigned long bit_offset = (dma->iova - base_iova) >> pgshift;
1205         unsigned long copy_offset = bit_offset / BITS_PER_LONG;
1206         unsigned long shift = bit_offset % BITS_PER_LONG;
1207         unsigned long leftover;
1208
1209         /*
1210          * mark all pages dirty if any IOMMU capable device is not able
1211          * to report dirty pages and all pages are pinned and mapped.
1212          */
1213         if (iommu->num_non_pinned_groups && dma->iommu_mapped)
1214                 bitmap_set(dma->bitmap, 0, nbits);
1215
1216         if (shift) {
1217                 bitmap_shift_left(dma->bitmap, dma->bitmap, shift,
1218                                   nbits + shift);
1219
1220                 if (copy_from_user(&leftover,
1221                                    (void __user *)(bitmap + copy_offset),
1222                                    sizeof(leftover)))
1223                         return -EFAULT;
1224
1225                 bitmap_or(dma->bitmap, dma->bitmap, &leftover, shift);
1226         }
1227
1228         if (copy_to_user((void __user *)(bitmap + copy_offset), dma->bitmap,
1229                          DIRTY_BITMAP_BYTES(nbits + shift)))
1230                 return -EFAULT;
1231
1232         return 0;
1233 }
1234
1235 static int vfio_iova_dirty_bitmap(u64 __user *bitmap, struct vfio_iommu *iommu,
1236                                   dma_addr_t iova, size_t size, size_t pgsize)
1237 {
1238         struct vfio_dma *dma;
1239         struct rb_node *n;
1240         unsigned long pgshift = __ffs(pgsize);
1241         int ret;
1242
1243         /*
1244          * GET_BITMAP request must fully cover vfio_dma mappings.  Multiple
1245          * vfio_dma mappings may be clubbed by specifying large ranges, but
1246          * there must not be any previous mappings bisected by the range.
1247          * An error will be returned if these conditions are not met.
1248          */
1249         dma = vfio_find_dma(iommu, iova, 1);
1250         if (dma && dma->iova != iova)
1251                 return -EINVAL;
1252
1253         dma = vfio_find_dma(iommu, iova + size - 1, 0);
1254         if (dma && dma->iova + dma->size != iova + size)
1255                 return -EINVAL;
1256
1257         for (n = rb_first(&iommu->dma_list); n; n = rb_next(n)) {
1258                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
1259
1260                 if (dma->iova < iova)
1261                         continue;
1262
1263                 if (dma->iova > iova + size - 1)
1264                         break;
1265
1266                 ret = update_user_bitmap(bitmap, iommu, dma, iova, pgsize);
1267                 if (ret)
1268                         return ret;
1269
1270                 /*
1271                  * Re-populate bitmap to include all pinned pages which are
1272                  * considered as dirty but exclude pages which are unpinned and
1273                  * pages which are marked dirty by vfio_dma_rw()
1274                  */
1275                 bitmap_clear(dma->bitmap, 0, dma->size >> pgshift);
1276                 vfio_dma_populate_bitmap(dma, pgsize);
1277         }
1278         return 0;
1279 }
1280
1281 static int verify_bitmap_size(uint64_t npages, uint64_t bitmap_size)
1282 {
1283         if (!npages || !bitmap_size || (bitmap_size > DIRTY_BITMAP_SIZE_MAX) ||
1284             (bitmap_size < DIRTY_BITMAP_BYTES(npages)))
1285                 return -EINVAL;
1286
1287         return 0;
1288 }
1289
1290 static int vfio_dma_do_unmap(struct vfio_iommu *iommu,
1291                              struct vfio_iommu_type1_dma_unmap *unmap,
1292                              struct vfio_bitmap *bitmap)
1293 {
1294         struct vfio_dma *dma, *dma_last = NULL;
1295         size_t unmapped = 0, pgsize;
1296         int ret = -EINVAL, retries = 0;
1297         unsigned long pgshift;
1298         dma_addr_t iova = unmap->iova;
1299         u64 size = unmap->size;
1300         bool unmap_all = unmap->flags & VFIO_DMA_UNMAP_FLAG_ALL;
1301         bool invalidate_vaddr = unmap->flags & VFIO_DMA_UNMAP_FLAG_VADDR;
1302         struct rb_node *n, *first_n;
1303
1304         mutex_lock(&iommu->lock);
1305
1306         pgshift = __ffs(iommu->pgsize_bitmap);
1307         pgsize = (size_t)1 << pgshift;
1308
1309         if (iova & (pgsize - 1))
1310                 goto unlock;
1311
1312         if (unmap_all) {
1313                 if (iova || size)
1314                         goto unlock;
1315                 size = U64_MAX;
1316         } else if (!size || size & (pgsize - 1) ||
1317                    iova + size - 1 < iova || size > SIZE_MAX) {
1318                 goto unlock;
1319         }
1320
1321         /* When dirty tracking is enabled, allow only min supported pgsize */
1322         if ((unmap->flags & VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP) &&
1323             (!iommu->dirty_page_tracking || (bitmap->pgsize != pgsize))) {
1324                 goto unlock;
1325         }
1326
1327         WARN_ON((pgsize - 1) & PAGE_MASK);
1328 again:
1329         /*
1330          * vfio-iommu-type1 (v1) - User mappings were coalesced together to
1331          * avoid tracking individual mappings.  This means that the granularity
1332          * of the original mapping was lost and the user was allowed to attempt
1333          * to unmap any range.  Depending on the contiguousness of physical
1334          * memory and page sizes supported by the IOMMU, arbitrary unmaps may
1335          * or may not have worked.  We only guaranteed unmap granularity
1336          * matching the original mapping; even though it was untracked here,
1337          * the original mappings are reflected in IOMMU mappings.  This
1338          * resulted in a couple unusual behaviors.  First, if a range is not
1339          * able to be unmapped, ex. a set of 4k pages that was mapped as a
1340          * 2M hugepage into the IOMMU, the unmap ioctl returns success but with
1341          * a zero sized unmap.  Also, if an unmap request overlaps the first
1342          * address of a hugepage, the IOMMU will unmap the entire hugepage.
1343          * This also returns success and the returned unmap size reflects the
1344          * actual size unmapped.
1345          *
1346          * We attempt to maintain compatibility with this "v1" interface, but
1347          * we take control out of the hands of the IOMMU.  Therefore, an unmap
1348          * request offset from the beginning of the original mapping will
1349          * return success with zero sized unmap.  And an unmap request covering
1350          * the first iova of mapping will unmap the entire range.
1351          *
1352          * The v2 version of this interface intends to be more deterministic.
1353          * Unmap requests must fully cover previous mappings.  Multiple
1354          * mappings may still be unmaped by specifying large ranges, but there
1355          * must not be any previous mappings bisected by the range.  An error
1356          * will be returned if these conditions are not met.  The v2 interface
1357          * will only return success and a size of zero if there were no
1358          * mappings within the range.
1359          */
1360         if (iommu->v2 && !unmap_all) {
1361                 dma = vfio_find_dma(iommu, iova, 1);
1362                 if (dma && dma->iova != iova)
1363                         goto unlock;
1364
1365                 dma = vfio_find_dma(iommu, iova + size - 1, 0);
1366                 if (dma && dma->iova + dma->size != iova + size)
1367                         goto unlock;
1368         }
1369
1370         ret = 0;
1371         n = first_n = vfio_find_dma_first_node(iommu, iova, size);
1372
1373         while (n) {
1374                 dma = rb_entry(n, struct vfio_dma, node);
1375                 if (dma->iova >= iova + size)
1376                         break;
1377
1378                 if (!iommu->v2 && iova > dma->iova)
1379                         break;
1380
1381                 if (invalidate_vaddr) {
1382                         if (dma->vaddr_invalid) {
1383                                 struct rb_node *last_n = n;
1384
1385                                 for (n = first_n; n != last_n; n = rb_next(n)) {
1386                                         dma = rb_entry(n,
1387                                                        struct vfio_dma, node);
1388                                         dma->vaddr_invalid = false;
1389                                         iommu->vaddr_invalid_count--;
1390                                 }
1391                                 ret = -EINVAL;
1392                                 unmapped = 0;
1393                                 break;
1394                         }
1395                         dma->vaddr_invalid = true;
1396                         iommu->vaddr_invalid_count++;
1397                         unmapped += dma->size;
1398                         n = rb_next(n);
1399                         continue;
1400                 }
1401
1402                 if (!RB_EMPTY_ROOT(&dma->pfn_list)) {
1403                         struct vfio_iommu_type1_dma_unmap nb_unmap;
1404
1405                         if (dma_last == dma) {
1406                                 BUG_ON(++retries > 10);
1407                         } else {
1408                                 dma_last = dma;
1409                                 retries = 0;
1410                         }
1411
1412                         nb_unmap.iova = dma->iova;
1413                         nb_unmap.size = dma->size;
1414
1415                         /*
1416                          * Notify anyone (mdev vendor drivers) to invalidate and
1417                          * unmap iovas within the range we're about to unmap.
1418                          * Vendor drivers MUST unpin pages in response to an
1419                          * invalidation.
1420                          */
1421                         mutex_unlock(&iommu->lock);
1422                         blocking_notifier_call_chain(&iommu->notifier,
1423                                                     VFIO_IOMMU_NOTIFY_DMA_UNMAP,
1424                                                     &nb_unmap);
1425                         mutex_lock(&iommu->lock);
1426                         goto again;
1427                 }
1428
1429                 if (unmap->flags & VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP) {
1430                         ret = update_user_bitmap(bitmap->data, iommu, dma,
1431                                                  iova, pgsize);
1432                         if (ret)
1433                                 break;
1434                 }
1435
1436                 unmapped += dma->size;
1437                 n = rb_next(n);
1438                 vfio_remove_dma(iommu, dma);
1439         }
1440
1441 unlock:
1442         mutex_unlock(&iommu->lock);
1443
1444         /* Report how much was unmapped */
1445         unmap->size = unmapped;
1446
1447         return ret;
1448 }
1449
1450 static int vfio_iommu_map(struct vfio_iommu *iommu, dma_addr_t iova,
1451                           unsigned long pfn, long npage, int prot)
1452 {
1453         struct vfio_domain *d;
1454         int ret;
1455
1456         list_for_each_entry(d, &iommu->domain_list, next) {
1457                 ret = iommu_map(d->domain, iova, (phys_addr_t)pfn << PAGE_SHIFT,
1458                                 npage << PAGE_SHIFT, prot | IOMMU_CACHE);
1459                 if (ret)
1460                         goto unwind;
1461
1462                 cond_resched();
1463         }
1464
1465         return 0;
1466
1467 unwind:
1468         list_for_each_entry_continue_reverse(d, &iommu->domain_list, next) {
1469                 iommu_unmap(d->domain, iova, npage << PAGE_SHIFT);
1470                 cond_resched();
1471         }
1472
1473         return ret;
1474 }
1475
1476 static int vfio_pin_map_dma(struct vfio_iommu *iommu, struct vfio_dma *dma,
1477                             size_t map_size)
1478 {
1479         dma_addr_t iova = dma->iova;
1480         unsigned long vaddr = dma->vaddr;
1481         struct vfio_batch batch;
1482         size_t size = map_size;
1483         long npage;
1484         unsigned long pfn, limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
1485         int ret = 0;
1486
1487         vfio_batch_init(&batch);
1488
1489         while (size) {
1490                 /* Pin a contiguous chunk of memory */
1491                 npage = vfio_pin_pages_remote(dma, vaddr + dma->size,
1492                                               size >> PAGE_SHIFT, &pfn, limit,
1493                                               &batch);
1494                 if (npage <= 0) {
1495                         WARN_ON(!npage);
1496                         ret = (int)npage;
1497                         break;
1498                 }
1499
1500                 /* Map it! */
1501                 ret = vfio_iommu_map(iommu, iova + dma->size, pfn, npage,
1502                                      dma->prot);
1503                 if (ret) {
1504                         vfio_unpin_pages_remote(dma, iova + dma->size, pfn,
1505                                                 npage, true);
1506                         vfio_batch_unpin(&batch, dma);
1507                         break;
1508                 }
1509
1510                 size -= npage << PAGE_SHIFT;
1511                 dma->size += npage << PAGE_SHIFT;
1512         }
1513
1514         vfio_batch_fini(&batch);
1515         dma->iommu_mapped = true;
1516
1517         if (ret)
1518                 vfio_remove_dma(iommu, dma);
1519
1520         return ret;
1521 }
1522
1523 /*
1524  * Check dma map request is within a valid iova range
1525  */
1526 static bool vfio_iommu_iova_dma_valid(struct vfio_iommu *iommu,
1527                                       dma_addr_t start, dma_addr_t end)
1528 {
1529         struct list_head *iova = &iommu->iova_list;
1530         struct vfio_iova *node;
1531
1532         list_for_each_entry(node, iova, list) {
1533                 if (start >= node->start && end <= node->end)
1534                         return true;
1535         }
1536
1537         /*
1538          * Check for list_empty() as well since a container with
1539          * a single mdev device will have an empty list.
1540          */
1541         return list_empty(iova);
1542 }
1543
1544 static int vfio_dma_do_map(struct vfio_iommu *iommu,
1545                            struct vfio_iommu_type1_dma_map *map)
1546 {
1547         bool set_vaddr = map->flags & VFIO_DMA_MAP_FLAG_VADDR;
1548         dma_addr_t iova = map->iova;
1549         unsigned long vaddr = map->vaddr;
1550         size_t size = map->size;
1551         int ret = 0, prot = 0;
1552         size_t pgsize;
1553         struct vfio_dma *dma;
1554
1555         /* Verify that none of our __u64 fields overflow */
1556         if (map->size != size || map->vaddr != vaddr || map->iova != iova)
1557                 return -EINVAL;
1558
1559         /* READ/WRITE from device perspective */
1560         if (map->flags & VFIO_DMA_MAP_FLAG_WRITE)
1561                 prot |= IOMMU_WRITE;
1562         if (map->flags & VFIO_DMA_MAP_FLAG_READ)
1563                 prot |= IOMMU_READ;
1564
1565         if ((prot && set_vaddr) || (!prot && !set_vaddr))
1566                 return -EINVAL;
1567
1568         mutex_lock(&iommu->lock);
1569
1570         pgsize = (size_t)1 << __ffs(iommu->pgsize_bitmap);
1571
1572         WARN_ON((pgsize - 1) & PAGE_MASK);
1573
1574         if (!size || (size | iova | vaddr) & (pgsize - 1)) {
1575                 ret = -EINVAL;
1576                 goto out_unlock;
1577         }
1578
1579         /* Don't allow IOVA or virtual address wrap */
1580         if (iova + size - 1 < iova || vaddr + size - 1 < vaddr) {
1581                 ret = -EINVAL;
1582                 goto out_unlock;
1583         }
1584
1585         dma = vfio_find_dma(iommu, iova, size);
1586         if (set_vaddr) {
1587                 if (!dma) {
1588                         ret = -ENOENT;
1589                 } else if (!dma->vaddr_invalid || dma->iova != iova ||
1590                            dma->size != size) {
1591                         ret = -EINVAL;
1592                 } else {
1593                         dma->vaddr = vaddr;
1594                         dma->vaddr_invalid = false;
1595                         iommu->vaddr_invalid_count--;
1596                         wake_up_all(&iommu->vaddr_wait);
1597                 }
1598                 goto out_unlock;
1599         } else if (dma) {
1600                 ret = -EEXIST;
1601                 goto out_unlock;
1602         }
1603
1604         if (!iommu->dma_avail) {
1605                 ret = -ENOSPC;
1606                 goto out_unlock;
1607         }
1608
1609         if (!vfio_iommu_iova_dma_valid(iommu, iova, iova + size - 1)) {
1610                 ret = -EINVAL;
1611                 goto out_unlock;
1612         }
1613
1614         dma = kzalloc(sizeof(*dma), GFP_KERNEL);
1615         if (!dma) {
1616                 ret = -ENOMEM;
1617                 goto out_unlock;
1618         }
1619
1620         iommu->dma_avail--;
1621         dma->iova = iova;
1622         dma->vaddr = vaddr;
1623         dma->prot = prot;
1624
1625         /*
1626          * We need to be able to both add to a task's locked memory and test
1627          * against the locked memory limit and we need to be able to do both
1628          * outside of this call path as pinning can be asynchronous via the
1629          * external interfaces for mdev devices.  RLIMIT_MEMLOCK requires a
1630          * task_struct and VM locked pages requires an mm_struct, however
1631          * holding an indefinite mm reference is not recommended, therefore we
1632          * only hold a reference to a task.  We could hold a reference to
1633          * current, however QEMU uses this call path through vCPU threads,
1634          * which can be killed resulting in a NULL mm and failure in the unmap
1635          * path when called via a different thread.  Avoid this problem by
1636          * using the group_leader as threads within the same group require
1637          * both CLONE_THREAD and CLONE_VM and will therefore use the same
1638          * mm_struct.
1639          *
1640          * Previously we also used the task for testing CAP_IPC_LOCK at the
1641          * time of pinning and accounting, however has_capability() makes use
1642          * of real_cred, a copy-on-write field, so we can't guarantee that it
1643          * matches group_leader, or in fact that it might not change by the
1644          * time it's evaluated.  If a process were to call MAP_DMA with
1645          * CAP_IPC_LOCK but later drop it, it doesn't make sense that they
1646          * possibly see different results for an iommu_mapped vfio_dma vs
1647          * externally mapped.  Therefore track CAP_IPC_LOCK in vfio_dma at the
1648          * time of calling MAP_DMA.
1649          */
1650         get_task_struct(current->group_leader);
1651         dma->task = current->group_leader;
1652         dma->lock_cap = capable(CAP_IPC_LOCK);
1653
1654         dma->pfn_list = RB_ROOT;
1655
1656         /* Insert zero-sized and grow as we map chunks of it */
1657         vfio_link_dma(iommu, dma);
1658
1659         /* Don't pin and map if container doesn't contain IOMMU capable domain*/
1660         if (list_empty(&iommu->domain_list))
1661                 dma->size = size;
1662         else
1663                 ret = vfio_pin_map_dma(iommu, dma, size);
1664
1665         if (!ret && iommu->dirty_page_tracking) {
1666                 ret = vfio_dma_bitmap_alloc(dma, pgsize);
1667                 if (ret)
1668                         vfio_remove_dma(iommu, dma);
1669         }
1670
1671 out_unlock:
1672         mutex_unlock(&iommu->lock);
1673         return ret;
1674 }
1675
1676 static int vfio_iommu_replay(struct vfio_iommu *iommu,
1677                              struct vfio_domain *domain)
1678 {
1679         struct vfio_batch batch;
1680         struct vfio_domain *d = NULL;
1681         struct rb_node *n;
1682         unsigned long limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
1683         int ret;
1684
1685         ret = vfio_wait_all_valid(iommu);
1686         if (ret < 0)
1687                 return ret;
1688
1689         /* Arbitrarily pick the first domain in the list for lookups */
1690         if (!list_empty(&iommu->domain_list))
1691                 d = list_first_entry(&iommu->domain_list,
1692                                      struct vfio_domain, next);
1693
1694         vfio_batch_init(&batch);
1695
1696         n = rb_first(&iommu->dma_list);
1697
1698         for (; n; n = rb_next(n)) {
1699                 struct vfio_dma *dma;
1700                 dma_addr_t iova;
1701
1702                 dma = rb_entry(n, struct vfio_dma, node);
1703                 iova = dma->iova;
1704
1705                 while (iova < dma->iova + dma->size) {
1706                         phys_addr_t phys;
1707                         size_t size;
1708
1709                         if (dma->iommu_mapped) {
1710                                 phys_addr_t p;
1711                                 dma_addr_t i;
1712
1713                                 if (WARN_ON(!d)) { /* mapped w/o a domain?! */
1714                                         ret = -EINVAL;
1715                                         goto unwind;
1716                                 }
1717
1718                                 phys = iommu_iova_to_phys(d->domain, iova);
1719
1720                                 if (WARN_ON(!phys)) {
1721                                         iova += PAGE_SIZE;
1722                                         continue;
1723                                 }
1724
1725                                 size = PAGE_SIZE;
1726                                 p = phys + size;
1727                                 i = iova + size;
1728                                 while (i < dma->iova + dma->size &&
1729                                        p == iommu_iova_to_phys(d->domain, i)) {
1730                                         size += PAGE_SIZE;
1731                                         p += PAGE_SIZE;
1732                                         i += PAGE_SIZE;
1733                                 }
1734                         } else {
1735                                 unsigned long pfn;
1736                                 unsigned long vaddr = dma->vaddr +
1737                                                      (iova - dma->iova);
1738                                 size_t n = dma->iova + dma->size - iova;
1739                                 long npage;
1740
1741                                 npage = vfio_pin_pages_remote(dma, vaddr,
1742                                                               n >> PAGE_SHIFT,
1743                                                               &pfn, limit,
1744                                                               &batch);
1745                                 if (npage <= 0) {
1746                                         WARN_ON(!npage);
1747                                         ret = (int)npage;
1748                                         goto unwind;
1749                                 }
1750
1751                                 phys = pfn << PAGE_SHIFT;
1752                                 size = npage << PAGE_SHIFT;
1753                         }
1754
1755                         ret = iommu_map(domain->domain, iova, phys,
1756                                         size, dma->prot | IOMMU_CACHE);
1757                         if (ret) {
1758                                 if (!dma->iommu_mapped) {
1759                                         vfio_unpin_pages_remote(dma, iova,
1760                                                         phys >> PAGE_SHIFT,
1761                                                         size >> PAGE_SHIFT,
1762                                                         true);
1763                                         vfio_batch_unpin(&batch, dma);
1764                                 }
1765                                 goto unwind;
1766                         }
1767
1768                         iova += size;
1769                 }
1770         }
1771
1772         /* All dmas are now mapped, defer to second tree walk for unwind */
1773         for (n = rb_first(&iommu->dma_list); n; n = rb_next(n)) {
1774                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
1775
1776                 dma->iommu_mapped = true;
1777         }
1778
1779         vfio_batch_fini(&batch);
1780         return 0;
1781
1782 unwind:
1783         for (; n; n = rb_prev(n)) {
1784                 struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node);
1785                 dma_addr_t iova;
1786
1787                 if (dma->iommu_mapped) {
1788                         iommu_unmap(domain->domain, dma->iova, dma->size);
1789                         continue;
1790                 }
1791
1792                 iova = dma->iova;
1793                 while (iova < dma->iova + dma->size) {
1794                         phys_addr_t phys, p;
1795                         size_t size;
1796                         dma_addr_t i;
1797
1798                         phys = iommu_iova_to_phys(domain->domain, iova);
1799                         if (!phys) {
1800                                 iova += PAGE_SIZE;
1801                                 continue;
1802                         }
1803
1804                         size = PAGE_SIZE;
1805                         p = phys + size;
1806                         i = iova + size;
1807                         while (i < dma->iova + dma->size &&
1808                                p == iommu_iova_to_phys(domain->domain, i)) {
1809                                 size += PAGE_SIZE;
1810                                 p += PAGE_SIZE;
1811                                 i += PAGE_SIZE;
1812                         }
1813
1814                         iommu_unmap(domain->domain, iova, size);
1815                         vfio_unpin_pages_remote(dma, iova, phys >> PAGE_SHIFT,
1816                                                 size >> PAGE_SHIFT, true);
1817                 }
1818         }
1819
1820         vfio_batch_fini(&batch);
1821         return ret;
1822 }
1823
1824 /*
1825  * We change our unmap behavior slightly depending on whether the IOMMU
1826  * supports fine-grained superpages.  IOMMUs like AMD-Vi will use a superpage
1827  * for practically any contiguous power-of-two mapping we give it.  This means
1828  * we don't need to look for contiguous chunks ourselves to make unmapping
1829  * more efficient.  On IOMMUs with coarse-grained super pages, like Intel VT-d
1830  * with discrete 2M/1G/512G/1T superpages, identifying contiguous chunks
1831  * significantly boosts non-hugetlbfs mappings and doesn't seem to hurt when
1832  * hugetlbfs is in use.
1833  */
1834 static void vfio_test_domain_fgsp(struct vfio_domain *domain)
1835 {
1836         struct page *pages;
1837         int ret, order = get_order(PAGE_SIZE * 2);
1838
1839         pages = alloc_pages(GFP_KERNEL | __GFP_ZERO, order);
1840         if (!pages)
1841                 return;
1842
1843         ret = iommu_map(domain->domain, 0, page_to_phys(pages), PAGE_SIZE * 2,
1844                         IOMMU_READ | IOMMU_WRITE | IOMMU_CACHE);
1845         if (!ret) {
1846                 size_t unmapped = iommu_unmap(domain->domain, 0, PAGE_SIZE);
1847
1848                 if (unmapped == PAGE_SIZE)
1849                         iommu_unmap(domain->domain, PAGE_SIZE, PAGE_SIZE);
1850                 else
1851                         domain->fgsp = true;
1852         }
1853
1854         __free_pages(pages, order);
1855 }
1856
1857 static struct vfio_iommu_group *find_iommu_group(struct vfio_domain *domain,
1858                                                  struct iommu_group *iommu_group)
1859 {
1860         struct vfio_iommu_group *g;
1861
1862         list_for_each_entry(g, &domain->group_list, next) {
1863                 if (g->iommu_group == iommu_group)
1864                         return g;
1865         }
1866
1867         return NULL;
1868 }
1869
1870 static struct vfio_iommu_group*
1871 vfio_iommu_find_iommu_group(struct vfio_iommu *iommu,
1872                             struct iommu_group *iommu_group)
1873 {
1874         struct vfio_iommu_group *group;
1875         struct vfio_domain *domain;
1876
1877         list_for_each_entry(domain, &iommu->domain_list, next) {
1878                 group = find_iommu_group(domain, iommu_group);
1879                 if (group)
1880                         return group;
1881         }
1882
1883         list_for_each_entry(group, &iommu->emulated_iommu_groups, next)
1884                 if (group->iommu_group == iommu_group)
1885                         return group;
1886         return NULL;
1887 }
1888
1889 static bool vfio_iommu_has_sw_msi(struct list_head *group_resv_regions,
1890                                   phys_addr_t *base)
1891 {
1892         struct iommu_resv_region *region;
1893         bool ret = false;
1894
1895         list_for_each_entry(region, group_resv_regions, list) {
1896                 /*
1897                  * The presence of any 'real' MSI regions should take
1898                  * precedence over the software-managed one if the
1899                  * IOMMU driver happens to advertise both types.
1900                  */
1901                 if (region->type == IOMMU_RESV_MSI) {
1902                         ret = false;
1903                         break;
1904                 }
1905
1906                 if (region->type == IOMMU_RESV_SW_MSI) {
1907                         *base = region->start;
1908                         ret = true;
1909                 }
1910         }
1911
1912         return ret;
1913 }
1914
1915 /*
1916  * This is a helper function to insert an address range to iova list.
1917  * The list is initially created with a single entry corresponding to
1918  * the IOMMU domain geometry to which the device group is attached.
1919  * The list aperture gets modified when a new domain is added to the
1920  * container if the new aperture doesn't conflict with the current one
1921  * or with any existing dma mappings. The list is also modified to
1922  * exclude any reserved regions associated with the device group.
1923  */
1924 static int vfio_iommu_iova_insert(struct list_head *head,
1925                                   dma_addr_t start, dma_addr_t end)
1926 {
1927         struct vfio_iova *region;
1928
1929         region = kmalloc(sizeof(*region), GFP_KERNEL);
1930         if (!region)
1931                 return -ENOMEM;
1932
1933         INIT_LIST_HEAD(&region->list);
1934         region->start = start;
1935         region->end = end;
1936
1937         list_add_tail(&region->list, head);
1938         return 0;
1939 }
1940
1941 /*
1942  * Check the new iommu aperture conflicts with existing aper or with any
1943  * existing dma mappings.
1944  */
1945 static bool vfio_iommu_aper_conflict(struct vfio_iommu *iommu,
1946                                      dma_addr_t start, dma_addr_t end)
1947 {
1948         struct vfio_iova *first, *last;
1949         struct list_head *iova = &iommu->iova_list;
1950
1951         if (list_empty(iova))
1952                 return false;
1953
1954         /* Disjoint sets, return conflict */
1955         first = list_first_entry(iova, struct vfio_iova, list);
1956         last = list_last_entry(iova, struct vfio_iova, list);
1957         if (start > last->end || end < first->start)
1958                 return true;
1959
1960         /* Check for any existing dma mappings below the new start */
1961         if (start > first->start) {
1962                 if (vfio_find_dma(iommu, first->start, start - first->start))
1963                         return true;
1964         }
1965
1966         /* Check for any existing dma mappings beyond the new end */
1967         if (end < last->end) {
1968                 if (vfio_find_dma(iommu, end + 1, last->end - end))
1969                         return true;
1970         }
1971
1972         return false;
1973 }
1974
1975 /*
1976  * Resize iommu iova aperture window. This is called only if the new
1977  * aperture has no conflict with existing aperture and dma mappings.
1978  */
1979 static int vfio_iommu_aper_resize(struct list_head *iova,
1980                                   dma_addr_t start, dma_addr_t end)
1981 {
1982         struct vfio_iova *node, *next;
1983
1984         if (list_empty(iova))
1985                 return vfio_iommu_iova_insert(iova, start, end);
1986
1987         /* Adjust iova list start */
1988         list_for_each_entry_safe(node, next, iova, list) {
1989                 if (start < node->start)
1990                         break;
1991                 if (start >= node->start && start < node->end) {
1992                         node->start = start;
1993                         break;
1994                 }
1995                 /* Delete nodes before new start */
1996                 list_del(&node->list);
1997                 kfree(node);
1998         }
1999
2000         /* Adjust iova list end */
2001         list_for_each_entry_safe(node, next, iova, list) {
2002                 if (end > node->end)
2003                         continue;
2004                 if (end > node->start && end <= node->end) {
2005                         node->end = end;
2006                         continue;
2007                 }
2008                 /* Delete nodes after new end */
2009                 list_del(&node->list);
2010                 kfree(node);
2011         }
2012
2013         return 0;
2014 }
2015
2016 /*
2017  * Check reserved region conflicts with existing dma mappings
2018  */
2019 static bool vfio_iommu_resv_conflict(struct vfio_iommu *iommu,
2020                                      struct list_head *resv_regions)
2021 {
2022         struct iommu_resv_region *region;
2023
2024         /* Check for conflict with existing dma mappings */
2025         list_for_each_entry(region, resv_regions, list) {
2026                 if (region->type == IOMMU_RESV_DIRECT_RELAXABLE)
2027                         continue;
2028
2029                 if (vfio_find_dma(iommu, region->start, region->length))
2030                         return true;
2031         }
2032
2033         return false;
2034 }
2035
2036 /*
2037  * Check iova region overlap with  reserved regions and
2038  * exclude them from the iommu iova range
2039  */
2040 static int vfio_iommu_resv_exclude(struct list_head *iova,
2041                                    struct list_head *resv_regions)
2042 {
2043         struct iommu_resv_region *resv;
2044         struct vfio_iova *n, *next;
2045
2046         list_for_each_entry(resv, resv_regions, list) {
2047                 phys_addr_t start, end;
2048
2049                 if (resv->type == IOMMU_RESV_DIRECT_RELAXABLE)
2050                         continue;
2051
2052                 start = resv->start;
2053                 end = resv->start + resv->length - 1;
2054
2055                 list_for_each_entry_safe(n, next, iova, list) {
2056                         int ret = 0;
2057
2058                         /* No overlap */
2059                         if (start > n->end || end < n->start)
2060                                 continue;
2061                         /*
2062                          * Insert a new node if current node overlaps with the
2063                          * reserve region to exclude that from valid iova range.
2064                          * Note that, new node is inserted before the current
2065                          * node and finally the current node is deleted keeping
2066                          * the list updated and sorted.
2067                          */
2068                         if (start > n->start)
2069                                 ret = vfio_iommu_iova_insert(&n->list, n->start,
2070                                                              start - 1);
2071                         if (!ret && end < n->end)
2072                                 ret = vfio_iommu_iova_insert(&n->list, end + 1,
2073                                                              n->end);
2074                         if (ret)
2075                                 return ret;
2076
2077                         list_del(&n->list);
2078                         kfree(n);
2079                 }
2080         }
2081
2082         if (list_empty(iova))
2083                 return -EINVAL;
2084
2085         return 0;
2086 }
2087
2088 static void vfio_iommu_resv_free(struct list_head *resv_regions)
2089 {
2090         struct iommu_resv_region *n, *next;
2091
2092         list_for_each_entry_safe(n, next, resv_regions, list) {
2093                 list_del(&n->list);
2094                 kfree(n);
2095         }
2096 }
2097
2098 static void vfio_iommu_iova_free(struct list_head *iova)
2099 {
2100         struct vfio_iova *n, *next;
2101
2102         list_for_each_entry_safe(n, next, iova, list) {
2103                 list_del(&n->list);
2104                 kfree(n);
2105         }
2106 }
2107
2108 static int vfio_iommu_iova_get_copy(struct vfio_iommu *iommu,
2109                                     struct list_head *iova_copy)
2110 {
2111         struct list_head *iova = &iommu->iova_list;
2112         struct vfio_iova *n;
2113         int ret;
2114
2115         list_for_each_entry(n, iova, list) {
2116                 ret = vfio_iommu_iova_insert(iova_copy, n->start, n->end);
2117                 if (ret)
2118                         goto out_free;
2119         }
2120
2121         return 0;
2122
2123 out_free:
2124         vfio_iommu_iova_free(iova_copy);
2125         return ret;
2126 }
2127
2128 static void vfio_iommu_iova_insert_copy(struct vfio_iommu *iommu,
2129                                         struct list_head *iova_copy)
2130 {
2131         struct list_head *iova = &iommu->iova_list;
2132
2133         vfio_iommu_iova_free(iova);
2134
2135         list_splice_tail(iova_copy, iova);
2136 }
2137
2138 /* Redundantly walks non-present capabilities to simplify caller */
2139 static int vfio_iommu_device_capable(struct device *dev, void *data)
2140 {
2141         return device_iommu_capable(dev, (enum iommu_cap)data);
2142 }
2143
2144 static int vfio_iommu_domain_alloc(struct device *dev, void *data)
2145 {
2146         struct iommu_domain **domain = data;
2147
2148         *domain = iommu_domain_alloc(dev->bus);
2149         return 1; /* Don't iterate */
2150 }
2151
2152 static int vfio_iommu_type1_attach_group(void *iommu_data,
2153                 struct iommu_group *iommu_group, enum vfio_group_type type)
2154 {
2155         struct vfio_iommu *iommu = iommu_data;
2156         struct vfio_iommu_group *group;
2157         struct vfio_domain *domain, *d;
2158         bool resv_msi, msi_remap;
2159         phys_addr_t resv_msi_base = 0;
2160         struct iommu_domain_geometry *geo;
2161         LIST_HEAD(iova_copy);
2162         LIST_HEAD(group_resv_regions);
2163         int ret = -EINVAL;
2164
2165         mutex_lock(&iommu->lock);
2166
2167         /* Check for duplicates */
2168         if (vfio_iommu_find_iommu_group(iommu, iommu_group))
2169                 goto out_unlock;
2170
2171         ret = -ENOMEM;
2172         group = kzalloc(sizeof(*group), GFP_KERNEL);
2173         if (!group)
2174                 goto out_unlock;
2175         group->iommu_group = iommu_group;
2176
2177         if (type == VFIO_EMULATED_IOMMU) {
2178                 list_add(&group->next, &iommu->emulated_iommu_groups);
2179                 /*
2180                  * An emulated IOMMU group cannot dirty memory directly, it can
2181                  * only use interfaces that provide dirty tracking.
2182                  * The iommu scope can only be promoted with the addition of a
2183                  * dirty tracking group.
2184                  */
2185                 group->pinned_page_dirty_scope = true;
2186                 ret = 0;
2187                 goto out_unlock;
2188         }
2189
2190         ret = -ENOMEM;
2191         domain = kzalloc(sizeof(*domain), GFP_KERNEL);
2192         if (!domain)
2193                 goto out_free_group;
2194
2195         /*
2196          * Going via the iommu_group iterator avoids races, and trivially gives
2197          * us a representative device for the IOMMU API call. We don't actually
2198          * want to iterate beyond the first device (if any).
2199          */
2200         ret = -EIO;
2201         iommu_group_for_each_dev(iommu_group, &domain->domain,
2202                                  vfio_iommu_domain_alloc);
2203         if (!domain->domain)
2204                 goto out_free_domain;
2205
2206         if (iommu->nesting) {
2207                 ret = iommu_enable_nesting(domain->domain);
2208                 if (ret)
2209                         goto out_domain;
2210         }
2211
2212         ret = iommu_attach_group(domain->domain, group->iommu_group);
2213         if (ret)
2214                 goto out_domain;
2215
2216         /* Get aperture info */
2217         geo = &domain->domain->geometry;
2218         if (vfio_iommu_aper_conflict(iommu, geo->aperture_start,
2219                                      geo->aperture_end)) {
2220                 ret = -EINVAL;
2221                 goto out_detach;
2222         }
2223
2224         ret = iommu_get_group_resv_regions(iommu_group, &group_resv_regions);
2225         if (ret)
2226                 goto out_detach;
2227
2228         if (vfio_iommu_resv_conflict(iommu, &group_resv_regions)) {
2229                 ret = -EINVAL;
2230                 goto out_detach;
2231         }
2232
2233         /*
2234          * We don't want to work on the original iova list as the list
2235          * gets modified and in case of failure we have to retain the
2236          * original list. Get a copy here.
2237          */
2238         ret = vfio_iommu_iova_get_copy(iommu, &iova_copy);
2239         if (ret)
2240                 goto out_detach;
2241
2242         ret = vfio_iommu_aper_resize(&iova_copy, geo->aperture_start,
2243                                      geo->aperture_end);
2244         if (ret)
2245                 goto out_detach;
2246
2247         ret = vfio_iommu_resv_exclude(&iova_copy, &group_resv_regions);
2248         if (ret)
2249                 goto out_detach;
2250
2251         resv_msi = vfio_iommu_has_sw_msi(&group_resv_regions, &resv_msi_base);
2252
2253         INIT_LIST_HEAD(&domain->group_list);
2254         list_add(&group->next, &domain->group_list);
2255
2256         msi_remap = irq_domain_check_msi_remap() ||
2257                     iommu_group_for_each_dev(iommu_group, (void *)IOMMU_CAP_INTR_REMAP,
2258                                              vfio_iommu_device_capable);
2259
2260         if (!allow_unsafe_interrupts && !msi_remap) {
2261                 pr_warn("%s: No interrupt remapping support.  Use the module param \"allow_unsafe_interrupts\" to enable VFIO IOMMU support on this platform\n",
2262                        __func__);
2263                 ret = -EPERM;
2264                 goto out_detach;
2265         }
2266
2267         /*
2268          * If the IOMMU can block non-coherent operations (ie PCIe TLPs with
2269          * no-snoop set) then VFIO always turns this feature on because on Intel
2270          * platforms it optimizes KVM to disable wbinvd emulation.
2271          */
2272         if (domain->domain->ops->enforce_cache_coherency)
2273                 domain->enforce_cache_coherency =
2274                         domain->domain->ops->enforce_cache_coherency(
2275                                 domain->domain);
2276
2277         /*
2278          * Try to match an existing compatible domain.  We don't want to
2279          * preclude an IOMMU driver supporting multiple bus_types and being
2280          * able to include different bus_types in the same IOMMU domain, so
2281          * we test whether the domains use the same iommu_ops rather than
2282          * testing if they're on the same bus_type.
2283          */
2284         list_for_each_entry(d, &iommu->domain_list, next) {
2285                 if (d->domain->ops == domain->domain->ops &&
2286                     d->enforce_cache_coherency ==
2287                             domain->enforce_cache_coherency) {
2288                         iommu_detach_group(domain->domain, group->iommu_group);
2289                         if (!iommu_attach_group(d->domain,
2290                                                 group->iommu_group)) {
2291                                 list_add(&group->next, &d->group_list);
2292                                 iommu_domain_free(domain->domain);
2293                                 kfree(domain);
2294                                 goto done;
2295                         }
2296
2297                         ret = iommu_attach_group(domain->domain,
2298                                                  group->iommu_group);
2299                         if (ret)
2300                                 goto out_domain;
2301                 }
2302         }
2303
2304         vfio_test_domain_fgsp(domain);
2305
2306         /* replay mappings on new domains */
2307         ret = vfio_iommu_replay(iommu, domain);
2308         if (ret)
2309                 goto out_detach;
2310
2311         if (resv_msi) {
2312                 ret = iommu_get_msi_cookie(domain->domain, resv_msi_base);
2313                 if (ret && ret != -ENODEV)
2314                         goto out_detach;
2315         }
2316
2317         list_add(&domain->next, &iommu->domain_list);
2318         vfio_update_pgsize_bitmap(iommu);
2319 done:
2320         /* Delete the old one and insert new iova list */
2321         vfio_iommu_iova_insert_copy(iommu, &iova_copy);
2322
2323         /*
2324          * An iommu backed group can dirty memory directly and therefore
2325          * demotes the iommu scope until it declares itself dirty tracking
2326          * capable via the page pinning interface.
2327          */
2328         iommu->num_non_pinned_groups++;
2329         mutex_unlock(&iommu->lock);
2330         vfio_iommu_resv_free(&group_resv_regions);
2331
2332         return 0;
2333
2334 out_detach:
2335         iommu_detach_group(domain->domain, group->iommu_group);
2336 out_domain:
2337         iommu_domain_free(domain->domain);
2338         vfio_iommu_iova_free(&iova_copy);
2339         vfio_iommu_resv_free(&group_resv_regions);
2340 out_free_domain:
2341         kfree(domain);
2342 out_free_group:
2343         kfree(group);
2344 out_unlock:
2345         mutex_unlock(&iommu->lock);
2346         return ret;
2347 }
2348
2349 static void vfio_iommu_unmap_unpin_all(struct vfio_iommu *iommu)
2350 {
2351         struct rb_node *node;
2352
2353         while ((node = rb_first(&iommu->dma_list)))
2354                 vfio_remove_dma(iommu, rb_entry(node, struct vfio_dma, node));
2355 }
2356
2357 static void vfio_iommu_unmap_unpin_reaccount(struct vfio_iommu *iommu)
2358 {
2359         struct rb_node *n, *p;
2360
2361         n = rb_first(&iommu->dma_list);
2362         for (; n; n = rb_next(n)) {
2363                 struct vfio_dma *dma;
2364                 long locked = 0, unlocked = 0;
2365
2366                 dma = rb_entry(n, struct vfio_dma, node);
2367                 unlocked += vfio_unmap_unpin(iommu, dma, false);
2368                 p = rb_first(&dma->pfn_list);
2369                 for (; p; p = rb_next(p)) {
2370                         struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn,
2371                                                          node);
2372
2373                         if (!is_invalid_reserved_pfn(vpfn->pfn))
2374                                 locked++;
2375                 }
2376                 vfio_lock_acct(dma, locked - unlocked, true);
2377         }
2378 }
2379
2380 /*
2381  * Called when a domain is removed in detach. It is possible that
2382  * the removed domain decided the iova aperture window. Modify the
2383  * iova aperture with the smallest window among existing domains.
2384  */
2385 static void vfio_iommu_aper_expand(struct vfio_iommu *iommu,
2386                                    struct list_head *iova_copy)
2387 {
2388         struct vfio_domain *domain;
2389         struct vfio_iova *node;
2390         dma_addr_t start = 0;
2391         dma_addr_t end = (dma_addr_t)~0;
2392
2393         if (list_empty(iova_copy))
2394                 return;
2395
2396         list_for_each_entry(domain, &iommu->domain_list, next) {
2397                 struct iommu_domain_geometry *geo = &domain->domain->geometry;
2398
2399                 if (geo->aperture_start > start)
2400                         start = geo->aperture_start;
2401                 if (geo->aperture_end < end)
2402                         end = geo->aperture_end;
2403         }
2404
2405         /* Modify aperture limits. The new aper is either same or bigger */
2406         node = list_first_entry(iova_copy, struct vfio_iova, list);
2407         node->start = start;
2408         node = list_last_entry(iova_copy, struct vfio_iova, list);
2409         node->end = end;
2410 }
2411
2412 /*
2413  * Called when a group is detached. The reserved regions for that
2414  * group can be part of valid iova now. But since reserved regions
2415  * may be duplicated among groups, populate the iova valid regions
2416  * list again.
2417  */
2418 static int vfio_iommu_resv_refresh(struct vfio_iommu *iommu,
2419                                    struct list_head *iova_copy)
2420 {
2421         struct vfio_domain *d;
2422         struct vfio_iommu_group *g;
2423         struct vfio_iova *node;
2424         dma_addr_t start, end;
2425         LIST_HEAD(resv_regions);
2426         int ret;
2427
2428         if (list_empty(iova_copy))
2429                 return -EINVAL;
2430
2431         list_for_each_entry(d, &iommu->domain_list, next) {
2432                 list_for_each_entry(g, &d->group_list, next) {
2433                         ret = iommu_get_group_resv_regions(g->iommu_group,
2434                                                            &resv_regions);
2435                         if (ret)
2436                                 goto done;
2437                 }
2438         }
2439
2440         node = list_first_entry(iova_copy, struct vfio_iova, list);
2441         start = node->start;
2442         node = list_last_entry(iova_copy, struct vfio_iova, list);
2443         end = node->end;
2444
2445         /* purge the iova list and create new one */
2446         vfio_iommu_iova_free(iova_copy);
2447
2448         ret = vfio_iommu_aper_resize(iova_copy, start, end);
2449         if (ret)
2450                 goto done;
2451
2452         /* Exclude current reserved regions from iova ranges */
2453         ret = vfio_iommu_resv_exclude(iova_copy, &resv_regions);
2454 done:
2455         vfio_iommu_resv_free(&resv_regions);
2456         return ret;
2457 }
2458
2459 static void vfio_iommu_type1_detach_group(void *iommu_data,
2460                                           struct iommu_group *iommu_group)
2461 {
2462         struct vfio_iommu *iommu = iommu_data;
2463         struct vfio_domain *domain;
2464         struct vfio_iommu_group *group;
2465         bool update_dirty_scope = false;
2466         LIST_HEAD(iova_copy);
2467
2468         mutex_lock(&iommu->lock);
2469         list_for_each_entry(group, &iommu->emulated_iommu_groups, next) {
2470                 if (group->iommu_group != iommu_group)
2471                         continue;
2472                 update_dirty_scope = !group->pinned_page_dirty_scope;
2473                 list_del(&group->next);
2474                 kfree(group);
2475
2476                 if (list_empty(&iommu->emulated_iommu_groups) &&
2477                     list_empty(&iommu->domain_list)) {
2478                         WARN_ON(iommu->notifier.head);
2479                         vfio_iommu_unmap_unpin_all(iommu);
2480                 }
2481                 goto detach_group_done;
2482         }
2483
2484         /*
2485          * Get a copy of iova list. This will be used to update
2486          * and to replace the current one later. Please note that
2487          * we will leave the original list as it is if update fails.
2488          */
2489         vfio_iommu_iova_get_copy(iommu, &iova_copy);
2490
2491         list_for_each_entry(domain, &iommu->domain_list, next) {
2492                 group = find_iommu_group(domain, iommu_group);
2493                 if (!group)
2494                         continue;
2495
2496                 iommu_detach_group(domain->domain, group->iommu_group);
2497                 update_dirty_scope = !group->pinned_page_dirty_scope;
2498                 list_del(&group->next);
2499                 kfree(group);
2500                 /*
2501                  * Group ownership provides privilege, if the group list is
2502                  * empty, the domain goes away. If it's the last domain with
2503                  * iommu and external domain doesn't exist, then all the
2504                  * mappings go away too. If it's the last domain with iommu and
2505                  * external domain exist, update accounting
2506                  */
2507                 if (list_empty(&domain->group_list)) {
2508                         if (list_is_singular(&iommu->domain_list)) {
2509                                 if (list_empty(&iommu->emulated_iommu_groups)) {
2510                                         WARN_ON(iommu->notifier.head);
2511                                         vfio_iommu_unmap_unpin_all(iommu);
2512                                 } else {
2513                                         vfio_iommu_unmap_unpin_reaccount(iommu);
2514                                 }
2515                         }
2516                         iommu_domain_free(domain->domain);
2517                         list_del(&domain->next);
2518                         kfree(domain);
2519                         vfio_iommu_aper_expand(iommu, &iova_copy);
2520                         vfio_update_pgsize_bitmap(iommu);
2521                 }
2522                 break;
2523         }
2524
2525         if (!vfio_iommu_resv_refresh(iommu, &iova_copy))
2526                 vfio_iommu_iova_insert_copy(iommu, &iova_copy);
2527         else
2528                 vfio_iommu_iova_free(&iova_copy);
2529
2530 detach_group_done:
2531         /*
2532          * Removal of a group without dirty tracking may allow the iommu scope
2533          * to be promoted.
2534          */
2535         if (update_dirty_scope) {
2536                 iommu->num_non_pinned_groups--;
2537                 if (iommu->dirty_page_tracking)
2538                         vfio_iommu_populate_bitmap_full(iommu);
2539         }
2540         mutex_unlock(&iommu->lock);
2541 }
2542
2543 static void *vfio_iommu_type1_open(unsigned long arg)
2544 {
2545         struct vfio_iommu *iommu;
2546
2547         iommu = kzalloc(sizeof(*iommu), GFP_KERNEL);
2548         if (!iommu)
2549                 return ERR_PTR(-ENOMEM);
2550
2551         switch (arg) {
2552         case VFIO_TYPE1_IOMMU:
2553                 break;
2554         case VFIO_TYPE1_NESTING_IOMMU:
2555                 iommu->nesting = true;
2556                 fallthrough;
2557         case VFIO_TYPE1v2_IOMMU:
2558                 iommu->v2 = true;
2559                 break;
2560         default:
2561                 kfree(iommu);
2562                 return ERR_PTR(-EINVAL);
2563         }
2564
2565         INIT_LIST_HEAD(&iommu->domain_list);
2566         INIT_LIST_HEAD(&iommu->iova_list);
2567         iommu->dma_list = RB_ROOT;
2568         iommu->dma_avail = dma_entry_limit;
2569         iommu->container_open = true;
2570         mutex_init(&iommu->lock);
2571         BLOCKING_INIT_NOTIFIER_HEAD(&iommu->notifier);
2572         init_waitqueue_head(&iommu->vaddr_wait);
2573         iommu->pgsize_bitmap = PAGE_MASK;
2574         INIT_LIST_HEAD(&iommu->emulated_iommu_groups);
2575
2576         return iommu;
2577 }
2578
2579 static void vfio_release_domain(struct vfio_domain *domain)
2580 {
2581         struct vfio_iommu_group *group, *group_tmp;
2582
2583         list_for_each_entry_safe(group, group_tmp,
2584                                  &domain->group_list, next) {
2585                 iommu_detach_group(domain->domain, group->iommu_group);
2586                 list_del(&group->next);
2587                 kfree(group);
2588         }
2589
2590         iommu_domain_free(domain->domain);
2591 }
2592
2593 static void vfio_iommu_type1_release(void *iommu_data)
2594 {
2595         struct vfio_iommu *iommu = iommu_data;
2596         struct vfio_domain *domain, *domain_tmp;
2597         struct vfio_iommu_group *group, *next_group;
2598
2599         list_for_each_entry_safe(group, next_group,
2600                         &iommu->emulated_iommu_groups, next) {
2601                 list_del(&group->next);
2602                 kfree(group);
2603         }
2604
2605         vfio_iommu_unmap_unpin_all(iommu);
2606
2607         list_for_each_entry_safe(domain, domain_tmp,
2608                                  &iommu->domain_list, next) {
2609                 vfio_release_domain(domain);
2610                 list_del(&domain->next);
2611                 kfree(domain);
2612         }
2613
2614         vfio_iommu_iova_free(&iommu->iova_list);
2615
2616         kfree(iommu);
2617 }
2618
2619 static int vfio_domains_have_enforce_cache_coherency(struct vfio_iommu *iommu)
2620 {
2621         struct vfio_domain *domain;
2622         int ret = 1;
2623
2624         mutex_lock(&iommu->lock);
2625         list_for_each_entry(domain, &iommu->domain_list, next) {
2626                 if (!(domain->enforce_cache_coherency)) {
2627                         ret = 0;
2628                         break;
2629                 }
2630         }
2631         mutex_unlock(&iommu->lock);
2632
2633         return ret;
2634 }
2635
2636 static int vfio_iommu_type1_check_extension(struct vfio_iommu *iommu,
2637                                             unsigned long arg)
2638 {
2639         switch (arg) {
2640         case VFIO_TYPE1_IOMMU:
2641         case VFIO_TYPE1v2_IOMMU:
2642         case VFIO_TYPE1_NESTING_IOMMU:
2643         case VFIO_UNMAP_ALL:
2644         case VFIO_UPDATE_VADDR:
2645                 return 1;
2646         case VFIO_DMA_CC_IOMMU:
2647                 if (!iommu)
2648                         return 0;
2649                 return vfio_domains_have_enforce_cache_coherency(iommu);
2650         default:
2651                 return 0;
2652         }
2653 }
2654
2655 static int vfio_iommu_iova_add_cap(struct vfio_info_cap *caps,
2656                  struct vfio_iommu_type1_info_cap_iova_range *cap_iovas,
2657                  size_t size)
2658 {
2659         struct vfio_info_cap_header *header;
2660         struct vfio_iommu_type1_info_cap_iova_range *iova_cap;
2661
2662         header = vfio_info_cap_add(caps, size,
2663                                    VFIO_IOMMU_TYPE1_INFO_CAP_IOVA_RANGE, 1);
2664         if (IS_ERR(header))
2665                 return PTR_ERR(header);
2666
2667         iova_cap = container_of(header,
2668                                 struct vfio_iommu_type1_info_cap_iova_range,
2669                                 header);
2670         iova_cap->nr_iovas = cap_iovas->nr_iovas;
2671         memcpy(iova_cap->iova_ranges, cap_iovas->iova_ranges,
2672                cap_iovas->nr_iovas * sizeof(*cap_iovas->iova_ranges));
2673         return 0;
2674 }
2675
2676 static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,
2677                                       struct vfio_info_cap *caps)
2678 {
2679         struct vfio_iommu_type1_info_cap_iova_range *cap_iovas;
2680         struct vfio_iova *iova;
2681         size_t size;
2682         int iovas = 0, i = 0, ret;
2683
2684         list_for_each_entry(iova, &iommu->iova_list, list)
2685                 iovas++;
2686
2687         if (!iovas) {
2688                 /*
2689                  * Return 0 as a container with a single mdev device
2690                  * will have an empty list
2691                  */
2692                 return 0;
2693         }
2694
2695         size = struct_size(cap_iovas, iova_ranges, iovas);
2696
2697         cap_iovas = kzalloc(size, GFP_KERNEL);
2698         if (!cap_iovas)
2699                 return -ENOMEM;
2700
2701         cap_iovas->nr_iovas = iovas;
2702
2703         list_for_each_entry(iova, &iommu->iova_list, list) {
2704                 cap_iovas->iova_ranges[i].start = iova->start;
2705                 cap_iovas->iova_ranges[i].end = iova->end;
2706                 i++;
2707         }
2708
2709         ret = vfio_iommu_iova_add_cap(caps, cap_iovas, size);
2710
2711         kfree(cap_iovas);
2712         return ret;
2713 }
2714
2715 static int vfio_iommu_migration_build_caps(struct vfio_iommu *iommu,
2716                                            struct vfio_info_cap *caps)
2717 {
2718         struct vfio_iommu_type1_info_cap_migration cap_mig;
2719
2720         cap_mig.header.id = VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION;
2721         cap_mig.header.version = 1;
2722
2723         cap_mig.flags = 0;
2724         /* support minimum pgsize */
2725         cap_mig.pgsize_bitmap = (size_t)1 << __ffs(iommu->pgsize_bitmap);
2726         cap_mig.max_dirty_bitmap_size = DIRTY_BITMAP_SIZE_MAX;
2727
2728         return vfio_info_add_capability(caps, &cap_mig.header, sizeof(cap_mig));
2729 }
2730
2731 static int vfio_iommu_dma_avail_build_caps(struct vfio_iommu *iommu,
2732                                            struct vfio_info_cap *caps)
2733 {
2734         struct vfio_iommu_type1_info_dma_avail cap_dma_avail;
2735
2736         cap_dma_avail.header.id = VFIO_IOMMU_TYPE1_INFO_DMA_AVAIL;
2737         cap_dma_avail.header.version = 1;
2738
2739         cap_dma_avail.avail = iommu->dma_avail;
2740
2741         return vfio_info_add_capability(caps, &cap_dma_avail.header,
2742                                         sizeof(cap_dma_avail));
2743 }
2744
2745 static int vfio_iommu_type1_get_info(struct vfio_iommu *iommu,
2746                                      unsigned long arg)
2747 {
2748         struct vfio_iommu_type1_info info;
2749         unsigned long minsz;
2750         struct vfio_info_cap caps = { .buf = NULL, .size = 0 };
2751         unsigned long capsz;
2752         int ret;
2753
2754         minsz = offsetofend(struct vfio_iommu_type1_info, iova_pgsizes);
2755
2756         /* For backward compatibility, cannot require this */
2757         capsz = offsetofend(struct vfio_iommu_type1_info, cap_offset);
2758
2759         if (copy_from_user(&info, (void __user *)arg, minsz))
2760                 return -EFAULT;
2761
2762         if (info.argsz < minsz)
2763                 return -EINVAL;
2764
2765         if (info.argsz >= capsz) {
2766                 minsz = capsz;
2767                 info.cap_offset = 0; /* output, no-recopy necessary */
2768         }
2769
2770         mutex_lock(&iommu->lock);
2771         info.flags = VFIO_IOMMU_INFO_PGSIZES;
2772
2773         info.iova_pgsizes = iommu->pgsize_bitmap;
2774
2775         ret = vfio_iommu_migration_build_caps(iommu, &caps);
2776
2777         if (!ret)
2778                 ret = vfio_iommu_dma_avail_build_caps(iommu, &caps);
2779
2780         if (!ret)
2781                 ret = vfio_iommu_iova_build_caps(iommu, &caps);
2782
2783         mutex_unlock(&iommu->lock);
2784
2785         if (ret)
2786                 return ret;
2787
2788         if (caps.size) {
2789                 info.flags |= VFIO_IOMMU_INFO_CAPS;
2790
2791                 if (info.argsz < sizeof(info) + caps.size) {
2792                         info.argsz = sizeof(info) + caps.size;
2793                 } else {
2794                         vfio_info_cap_shift(&caps, sizeof(info));
2795                         if (copy_to_user((void __user *)arg +
2796                                         sizeof(info), caps.buf,
2797                                         caps.size)) {
2798                                 kfree(caps.buf);
2799                                 return -EFAULT;
2800                         }
2801                         info.cap_offset = sizeof(info);
2802                 }
2803
2804                 kfree(caps.buf);
2805         }
2806
2807         return copy_to_user((void __user *)arg, &info, minsz) ?
2808                         -EFAULT : 0;
2809 }
2810
2811 static int vfio_iommu_type1_map_dma(struct vfio_iommu *iommu,
2812                                     unsigned long arg)
2813 {
2814         struct vfio_iommu_type1_dma_map map;
2815         unsigned long minsz;
2816         uint32_t mask = VFIO_DMA_MAP_FLAG_READ | VFIO_DMA_MAP_FLAG_WRITE |
2817                         VFIO_DMA_MAP_FLAG_VADDR;
2818
2819         minsz = offsetofend(struct vfio_iommu_type1_dma_map, size);
2820
2821         if (copy_from_user(&map, (void __user *)arg, minsz))
2822                 return -EFAULT;
2823
2824         if (map.argsz < minsz || map.flags & ~mask)
2825                 return -EINVAL;
2826
2827         return vfio_dma_do_map(iommu, &map);
2828 }
2829
2830 static int vfio_iommu_type1_unmap_dma(struct vfio_iommu *iommu,
2831                                       unsigned long arg)
2832 {
2833         struct vfio_iommu_type1_dma_unmap unmap;
2834         struct vfio_bitmap bitmap = { 0 };
2835         uint32_t mask = VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP |
2836                         VFIO_DMA_UNMAP_FLAG_VADDR |
2837                         VFIO_DMA_UNMAP_FLAG_ALL;
2838         unsigned long minsz;
2839         int ret;
2840
2841         minsz = offsetofend(struct vfio_iommu_type1_dma_unmap, size);
2842
2843         if (copy_from_user(&unmap, (void __user *)arg, minsz))
2844                 return -EFAULT;
2845
2846         if (unmap.argsz < minsz || unmap.flags & ~mask)
2847                 return -EINVAL;
2848
2849         if ((unmap.flags & VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP) &&
2850             (unmap.flags & (VFIO_DMA_UNMAP_FLAG_ALL |
2851                             VFIO_DMA_UNMAP_FLAG_VADDR)))
2852                 return -EINVAL;
2853
2854         if (unmap.flags & VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP) {
2855                 unsigned long pgshift;
2856
2857                 if (unmap.argsz < (minsz + sizeof(bitmap)))
2858                         return -EINVAL;
2859
2860                 if (copy_from_user(&bitmap,
2861                                    (void __user *)(arg + minsz),
2862                                    sizeof(bitmap)))
2863                         return -EFAULT;
2864
2865                 if (!access_ok((void __user *)bitmap.data, bitmap.size))
2866                         return -EINVAL;
2867
2868                 pgshift = __ffs(bitmap.pgsize);
2869                 ret = verify_bitmap_size(unmap.size >> pgshift,
2870                                          bitmap.size);
2871                 if (ret)
2872                         return ret;
2873         }
2874
2875         ret = vfio_dma_do_unmap(iommu, &unmap, &bitmap);
2876         if (ret)
2877                 return ret;
2878
2879         return copy_to_user((void __user *)arg, &unmap, minsz) ?
2880                         -EFAULT : 0;
2881 }
2882
2883 static int vfio_iommu_type1_dirty_pages(struct vfio_iommu *iommu,
2884                                         unsigned long arg)
2885 {
2886         struct vfio_iommu_type1_dirty_bitmap dirty;
2887         uint32_t mask = VFIO_IOMMU_DIRTY_PAGES_FLAG_START |
2888                         VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP |
2889                         VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP;
2890         unsigned long minsz;
2891         int ret = 0;
2892
2893         if (!iommu->v2)
2894                 return -EACCES;
2895
2896         minsz = offsetofend(struct vfio_iommu_type1_dirty_bitmap, flags);
2897
2898         if (copy_from_user(&dirty, (void __user *)arg, minsz))
2899                 return -EFAULT;
2900
2901         if (dirty.argsz < minsz || dirty.flags & ~mask)
2902                 return -EINVAL;
2903
2904         /* only one flag should be set at a time */
2905         if (__ffs(dirty.flags) != __fls(dirty.flags))
2906                 return -EINVAL;
2907
2908         if (dirty.flags & VFIO_IOMMU_DIRTY_PAGES_FLAG_START) {
2909                 size_t pgsize;
2910
2911                 mutex_lock(&iommu->lock);
2912                 pgsize = 1 << __ffs(iommu->pgsize_bitmap);
2913                 if (!iommu->dirty_page_tracking) {
2914                         ret = vfio_dma_bitmap_alloc_all(iommu, pgsize);
2915                         if (!ret)
2916                                 iommu->dirty_page_tracking = true;
2917                 }
2918                 mutex_unlock(&iommu->lock);
2919                 return ret;
2920         } else if (dirty.flags & VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP) {
2921                 mutex_lock(&iommu->lock);
2922                 if (iommu->dirty_page_tracking) {
2923                         iommu->dirty_page_tracking = false;
2924                         vfio_dma_bitmap_free_all(iommu);
2925                 }
2926                 mutex_unlock(&iommu->lock);
2927                 return 0;
2928         } else if (dirty.flags & VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) {
2929                 struct vfio_iommu_type1_dirty_bitmap_get range;
2930                 unsigned long pgshift;
2931                 size_t data_size = dirty.argsz - minsz;
2932                 size_t iommu_pgsize;
2933
2934                 if (!data_size || data_size < sizeof(range))
2935                         return -EINVAL;
2936
2937                 if (copy_from_user(&range, (void __user *)(arg + minsz),
2938                                    sizeof(range)))
2939                         return -EFAULT;
2940
2941                 if (range.iova + range.size < range.iova)
2942                         return -EINVAL;
2943                 if (!access_ok((void __user *)range.bitmap.data,
2944                                range.bitmap.size))
2945                         return -EINVAL;
2946
2947                 pgshift = __ffs(range.bitmap.pgsize);
2948                 ret = verify_bitmap_size(range.size >> pgshift,
2949                                          range.bitmap.size);
2950                 if (ret)
2951                         return ret;
2952
2953                 mutex_lock(&iommu->lock);
2954
2955                 iommu_pgsize = (size_t)1 << __ffs(iommu->pgsize_bitmap);
2956
2957                 /* allow only smallest supported pgsize */
2958                 if (range.bitmap.pgsize != iommu_pgsize) {
2959                         ret = -EINVAL;
2960                         goto out_unlock;
2961                 }
2962                 if (range.iova & (iommu_pgsize - 1)) {
2963                         ret = -EINVAL;
2964                         goto out_unlock;
2965                 }
2966                 if (!range.size || range.size & (iommu_pgsize - 1)) {
2967                         ret = -EINVAL;
2968                         goto out_unlock;
2969                 }
2970
2971                 if (iommu->dirty_page_tracking)
2972                         ret = vfio_iova_dirty_bitmap(range.bitmap.data,
2973                                                      iommu, range.iova,
2974                                                      range.size,
2975                                                      range.bitmap.pgsize);
2976                 else
2977                         ret = -EINVAL;
2978 out_unlock:
2979                 mutex_unlock(&iommu->lock);
2980
2981                 return ret;
2982         }
2983
2984         return -EINVAL;
2985 }
2986
2987 static long vfio_iommu_type1_ioctl(void *iommu_data,
2988                                    unsigned int cmd, unsigned long arg)
2989 {
2990         struct vfio_iommu *iommu = iommu_data;
2991
2992         switch (cmd) {
2993         case VFIO_CHECK_EXTENSION:
2994                 return vfio_iommu_type1_check_extension(iommu, arg);
2995         case VFIO_IOMMU_GET_INFO:
2996                 return vfio_iommu_type1_get_info(iommu, arg);
2997         case VFIO_IOMMU_MAP_DMA:
2998                 return vfio_iommu_type1_map_dma(iommu, arg);
2999         case VFIO_IOMMU_UNMAP_DMA:
3000                 return vfio_iommu_type1_unmap_dma(iommu, arg);
3001         case VFIO_IOMMU_DIRTY_PAGES:
3002                 return vfio_iommu_type1_dirty_pages(iommu, arg);
3003         default:
3004                 return -ENOTTY;
3005         }
3006 }
3007
3008 static int vfio_iommu_type1_register_notifier(void *iommu_data,
3009                                               unsigned long *events,
3010                                               struct notifier_block *nb)
3011 {
3012         struct vfio_iommu *iommu = iommu_data;
3013
3014         /* clear known events */
3015         *events &= ~VFIO_IOMMU_NOTIFY_DMA_UNMAP;
3016
3017         /* refuse to register if still events remaining */
3018         if (*events)
3019                 return -EINVAL;
3020
3021         return blocking_notifier_chain_register(&iommu->notifier, nb);
3022 }
3023
3024 static int vfio_iommu_type1_unregister_notifier(void *iommu_data,
3025                                                 struct notifier_block *nb)
3026 {
3027         struct vfio_iommu *iommu = iommu_data;
3028
3029         return blocking_notifier_chain_unregister(&iommu->notifier, nb);
3030 }
3031
3032 static int vfio_iommu_type1_dma_rw_chunk(struct vfio_iommu *iommu,
3033                                          dma_addr_t user_iova, void *data,
3034                                          size_t count, bool write,
3035                                          size_t *copied)
3036 {
3037         struct mm_struct *mm;
3038         unsigned long vaddr;
3039         struct vfio_dma *dma;
3040         bool kthread = current->mm == NULL;
3041         size_t offset;
3042         int ret;
3043
3044         *copied = 0;
3045
3046         ret = vfio_find_dma_valid(iommu, user_iova, 1, &dma);
3047         if (ret < 0)
3048                 return ret;
3049
3050         if ((write && !(dma->prot & IOMMU_WRITE)) ||
3051                         !(dma->prot & IOMMU_READ))
3052                 return -EPERM;
3053
3054         mm = get_task_mm(dma->task);
3055
3056         if (!mm)
3057                 return -EPERM;
3058
3059         if (kthread)
3060                 kthread_use_mm(mm);
3061         else if (current->mm != mm)
3062                 goto out;
3063
3064         offset = user_iova - dma->iova;
3065
3066         if (count > dma->size - offset)
3067                 count = dma->size - offset;
3068
3069         vaddr = dma->vaddr + offset;
3070
3071         if (write) {
3072                 *copied = copy_to_user((void __user *)vaddr, data,
3073                                          count) ? 0 : count;
3074                 if (*copied && iommu->dirty_page_tracking) {
3075                         unsigned long pgshift = __ffs(iommu->pgsize_bitmap);
3076                         /*
3077                          * Bitmap populated with the smallest supported page
3078                          * size
3079                          */
3080                         bitmap_set(dma->bitmap, offset >> pgshift,
3081                                    ((offset + *copied - 1) >> pgshift) -
3082                                    (offset >> pgshift) + 1);
3083                 }
3084         } else
3085                 *copied = copy_from_user(data, (void __user *)vaddr,
3086                                            count) ? 0 : count;
3087         if (kthread)
3088                 kthread_unuse_mm(mm);
3089 out:
3090         mmput(mm);
3091         return *copied ? 0 : -EFAULT;
3092 }
3093
3094 static int vfio_iommu_type1_dma_rw(void *iommu_data, dma_addr_t user_iova,
3095                                    void *data, size_t count, bool write)
3096 {
3097         struct vfio_iommu *iommu = iommu_data;
3098         int ret = 0;
3099         size_t done;
3100
3101         mutex_lock(&iommu->lock);
3102         while (count > 0) {
3103                 ret = vfio_iommu_type1_dma_rw_chunk(iommu, user_iova, data,
3104                                                     count, write, &done);
3105                 if (ret)
3106                         break;
3107
3108                 count -= done;
3109                 data += done;
3110                 user_iova += done;
3111         }
3112
3113         mutex_unlock(&iommu->lock);
3114         return ret;
3115 }
3116
3117 static struct iommu_domain *
3118 vfio_iommu_type1_group_iommu_domain(void *iommu_data,
3119                                     struct iommu_group *iommu_group)
3120 {
3121         struct iommu_domain *domain = ERR_PTR(-ENODEV);
3122         struct vfio_iommu *iommu = iommu_data;
3123         struct vfio_domain *d;
3124
3125         if (!iommu || !iommu_group)
3126                 return ERR_PTR(-EINVAL);
3127
3128         mutex_lock(&iommu->lock);
3129         list_for_each_entry(d, &iommu->domain_list, next) {
3130                 if (find_iommu_group(d, iommu_group)) {
3131                         domain = d->domain;
3132                         break;
3133                 }
3134         }
3135         mutex_unlock(&iommu->lock);
3136
3137         return domain;
3138 }
3139
3140 static void vfio_iommu_type1_notify(void *iommu_data,
3141                                     enum vfio_iommu_notify_type event)
3142 {
3143         struct vfio_iommu *iommu = iommu_data;
3144
3145         if (event != VFIO_IOMMU_CONTAINER_CLOSE)
3146                 return;
3147         mutex_lock(&iommu->lock);
3148         iommu->container_open = false;
3149         mutex_unlock(&iommu->lock);
3150         wake_up_all(&iommu->vaddr_wait);
3151 }
3152
3153 static const struct vfio_iommu_driver_ops vfio_iommu_driver_ops_type1 = {
3154         .name                   = "vfio-iommu-type1",
3155         .owner                  = THIS_MODULE,
3156         .open                   = vfio_iommu_type1_open,
3157         .release                = vfio_iommu_type1_release,
3158         .ioctl                  = vfio_iommu_type1_ioctl,
3159         .attach_group           = vfio_iommu_type1_attach_group,
3160         .detach_group           = vfio_iommu_type1_detach_group,
3161         .pin_pages              = vfio_iommu_type1_pin_pages,
3162         .unpin_pages            = vfio_iommu_type1_unpin_pages,
3163         .register_notifier      = vfio_iommu_type1_register_notifier,
3164         .unregister_notifier    = vfio_iommu_type1_unregister_notifier,
3165         .dma_rw                 = vfio_iommu_type1_dma_rw,
3166         .group_iommu_domain     = vfio_iommu_type1_group_iommu_domain,
3167         .notify                 = vfio_iommu_type1_notify,
3168 };
3169
3170 static int __init vfio_iommu_type1_init(void)
3171 {
3172         return vfio_register_iommu_driver(&vfio_iommu_driver_ops_type1);
3173 }
3174
3175 static void __exit vfio_iommu_type1_cleanup(void)
3176 {
3177         vfio_unregister_iommu_driver(&vfio_iommu_driver_ops_type1);
3178 }
3179
3180 module_init(vfio_iommu_type1_init);
3181 module_exit(vfio_iommu_type1_cleanup);
3182
3183 MODULE_VERSION(DRIVER_VERSION);
3184 MODULE_LICENSE("GPL v2");
3185 MODULE_AUTHOR(DRIVER_AUTHOR);
3186 MODULE_DESCRIPTION(DRIVER_DESC);