drivers/xen/swiotlb-xen.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  Copyright 2010
   4  *  by Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
   5  *
   6  * This code provides a IOMMU for Xen PV guests with PCI passthrough.
   7  *
   8  * PV guests under Xen are running in an non-contiguous memory architecture.
   9  *
  10  * When PCI pass-through is utilized, this necessitates an IOMMU for
  11  * translating bus (DMA) to virtual and vice-versa and also providing a
  12  * mechanism to have contiguous pages for device drivers operations (say DMA
  13  * operations).
  14  *
  15  * Specifically, under Xen the Linux idea of pages is an illusion. It
  16  * assumes that pages start at zero and go up to the available memory. To
  17  * help with that, the Linux Xen MMU provides a lookup mechanism to
  18  * translate the page frame numbers (PFN) to machine frame numbers (MFN)
  19  * and vice-versa. The MFN are the "real" frame numbers. Furthermore
  20  * memory is not contiguous. Xen hypervisor stitches memory for guests
  21  * from different pools, which means there is no guarantee that PFN==MFN
  22  * and PFN+1==MFN+1. Lastly with Xen 4.0, pages (in debug mode) are
  23  * allocated in descending order (high to low), meaning the guest might
  24  * never get any MFN's under the 4GB mark.
  25  */
  26
  27 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
  28
  29 #include <linux/memblock.h>
  30 #include <linux/dma-direct.h>
  31 #include <linux/dma-map-ops.h>
  32 #include <linux/export.h>
  33 #include <xen/swiotlb-xen.h>
  34 #include <xen/page.h>
  35 #include <xen/xen-ops.h>
  36 #include <xen/hvc-console.h>
  37
  38 #include <asm/dma-mapping.h>
  39 #include <asm/xen/page-coherent.h>
  40
  41 #include <trace/events/swiotlb.h>
  42 #define MAX_DMA_BITS 32
  43 /*
  44  * Used to do a quick range check in swiotlb_tbl_unmap_single and
  45  * swiotlb_tbl_sync_single_*, to see if the memory was in fact allocated by this
  46  * API.
  47  */
  48
  49 static char *xen_io_tlb_start;
  50 static unsigned long xen_io_tlb_nslabs;
  51 /*
  52  * Quick lookup value of the bus address of the IOTLB.
  53  */
  54
  55 static inline phys_addr_t xen_phys_to_bus(struct device *dev, phys_addr_t paddr)
  56 {
  57         unsigned long bfn = pfn_to_bfn(XEN_PFN_DOWN(paddr));
  58         phys_addr_t baddr = (phys_addr_t)bfn << XEN_PAGE_SHIFT;
  59
  60         baddr |= paddr & ~XEN_PAGE_MASK;
  61         return baddr;
  62 }
  63
  64 static inline dma_addr_t xen_phys_to_dma(struct device *dev, phys_addr_t paddr)
  65 {
  66         return phys_to_dma(dev, xen_phys_to_bus(dev, paddr));
  67 }
  68
  69 static inline phys_addr_t xen_bus_to_phys(struct device *dev,
  70                                           phys_addr_t baddr)
  71 {
  72         unsigned long xen_pfn = bfn_to_pfn(XEN_PFN_DOWN(baddr));
  73         phys_addr_t paddr = (xen_pfn << XEN_PAGE_SHIFT) |
  74                             (baddr & ~XEN_PAGE_MASK);
  75
  76         return paddr;
  77 }
  78
  79 static inline phys_addr_t xen_dma_to_phys(struct device *dev,
  80                                           dma_addr_t dma_addr)
  81 {
  82         return xen_bus_to_phys(dev, dma_to_phys(dev, dma_addr));
  83 }
  84
  85 static inline int range_straddles_page_boundary(phys_addr_t p, size_t size)
  86 {
  87         unsigned long next_bfn, xen_pfn = XEN_PFN_DOWN(p);
  88         unsigned int i, nr_pages = XEN_PFN_UP(xen_offset_in_page(p) + size);
  89
  90         next_bfn = pfn_to_bfn(xen_pfn);
  91
  92         for (i = 1; i < nr_pages; i++)
  93                 if (pfn_to_bfn(++xen_pfn) != ++next_bfn)
  94                         return 1;
  95
  96         return 0;
  97 }
  98
  99 static int is_xen_swiotlb_buffer(struct device *dev, dma_addr_t dma_addr)
 100 {
 101         unsigned long bfn = XEN_PFN_DOWN(dma_to_phys(dev, dma_addr));
 102         unsigned long xen_pfn = bfn_to_local_pfn(bfn);
 103         phys_addr_t paddr = (phys_addr_t)xen_pfn << XEN_PAGE_SHIFT;
 104
 105         /* If the address is outside our domain, it CAN
 106          * have the same virtual address as another address
 107          * in our domain. Therefore _only_ check address within our domain.
 108          */
 109         if (pfn_valid(PFN_DOWN(paddr)))
 110                 return is_swiotlb_buffer(paddr);
 111         return 0;
 112 }
 113
 114 static int
 115 xen_swiotlb_fixup(void *buf, size_t size, unsigned long nslabs)
 116 {
 117         int i, rc;
 118         int dma_bits;
 119         dma_addr_t dma_handle;
 120         phys_addr_t p = virt_to_phys(buf);
 121
 122         dma_bits = get_order(IO_TLB_SEGSIZE << IO_TLB_SHIFT) + PAGE_SHIFT;
 123
 124         i = 0;
 125         do {
 126                 int slabs = min(nslabs - i, (unsigned long)IO_TLB_SEGSIZE);
 127
 128                 do {
 129                         rc = xen_create_contiguous_region(
 130                                 p + (i << IO_TLB_SHIFT),
 131                                 get_order(slabs << IO_TLB_SHIFT),
 132                                 dma_bits, &dma_handle);
 133                 } while (rc && dma_bits++ < MAX_DMA_BITS);
 134                 if (rc)
 135                         return rc;
 136
 137                 i += slabs;
 138         } while (i < nslabs);
 139         return 0;
 140 }
 141
 142 enum xen_swiotlb_err {
 143         XEN_SWIOTLB_UNKNOWN = 0,
 144         XEN_SWIOTLB_ENOMEM,
 145         XEN_SWIOTLB_EFIXUP
 146 };
 147
 148 static const char *xen_swiotlb_error(enum xen_swiotlb_err err)
 149 {
 150         switch (err) {
 151         case XEN_SWIOTLB_ENOMEM:
 152                 return "Cannot allocate Xen-SWIOTLB buffer\n";
 153         case XEN_SWIOTLB_EFIXUP:
 154                 return "Failed to get contiguous memory for DMA from Xen!\n"\
 155                     "You either: don't have the permissions, do not have"\
 156                     " enough free memory under 4GB, or the hypervisor memory"\
 157                     " is too fragmented!";
 158         default:
 159                 break;
 160         }
 161         return "";
 162 }
 163
 164 #define DEFAULT_NSLABS          ALIGN(SZ_64M >> IO_TLB_SHIFT, IO_TLB_SEGSIZE)
 165
 166 int __ref xen_swiotlb_init(int verbose, bool early)
 167 {
 168         unsigned long bytes, order;
 169         int rc = -ENOMEM;
 170         enum xen_swiotlb_err m_ret = XEN_SWIOTLB_UNKNOWN;
 171         unsigned int repeat = 3;
 172
 173         xen_io_tlb_nslabs = swiotlb_nr_tbl();
 174 retry:
 175         if (!xen_io_tlb_nslabs)
 176                 xen_io_tlb_nslabs = DEFAULT_NSLABS;
 177         bytes = xen_io_tlb_nslabs << IO_TLB_SHIFT;
 178         order = get_order(bytes);
 179
 180         /*
 181          * IO TLB memory already allocated. Just use it.
 182          */
 183         if (io_tlb_start != 0) {
 184                 xen_io_tlb_start = phys_to_virt(io_tlb_start);
 185                 goto end;
 186         }
 187
 188         /*
 189          * Get IO TLB memory from any location.
 190          */
 191         if (early) {
 192                 xen_io_tlb_start = memblock_alloc(PAGE_ALIGN(bytes),
 193                                                   PAGE_SIZE);
 194                 if (!xen_io_tlb_start)
 195                         panic("%s: Failed to allocate %lu bytes align=0x%lx\n",
 196                               __func__, PAGE_ALIGN(bytes), PAGE_SIZE);
 197         } else {
 198 #define SLABS_PER_PAGE (1 << (PAGE_SHIFT - IO_TLB_SHIFT))
 199 #define IO_TLB_MIN_SLABS ((1<<20) >> IO_TLB_SHIFT)
 200                 while ((SLABS_PER_PAGE << order) > IO_TLB_MIN_SLABS) {
 201                         xen_io_tlb_start = (void *)xen_get_swiotlb_free_pages(order);
 202                         if (xen_io_tlb_start)
 203                                 break;
 204                         order--;
 205                 }
 206                 if (order != get_order(bytes)) {
 207                         pr_warn("Warning: only able to allocate %ld MB for software IO TLB\n",
 208                                 (PAGE_SIZE << order) >> 20);
 209                         xen_io_tlb_nslabs = SLABS_PER_PAGE << order;
 210                         bytes = xen_io_tlb_nslabs << IO_TLB_SHIFT;
 211                 }
 212         }
 213         if (!xen_io_tlb_start) {
 214                 m_ret = XEN_SWIOTLB_ENOMEM;
 215                 goto error;
 216         }
 217         /*
 218          * And replace that memory with pages under 4GB.
 219          */
 220         rc = xen_swiotlb_fixup(xen_io_tlb_start,
 221                                bytes,
 222                                xen_io_tlb_nslabs);
 223         if (rc) {
 224                 if (early)
 225                         memblock_free(__pa(xen_io_tlb_start),
 226                                       PAGE_ALIGN(bytes));
 227                 else {
 228                         free_pages((unsigned long)xen_io_tlb_start, order);
 229                         xen_io_tlb_start = NULL;
 230                 }
 231                 m_ret = XEN_SWIOTLB_EFIXUP;
 232                 goto error;
 233         }
 234         if (early) {
 235                 if (swiotlb_init_with_tbl(xen_io_tlb_start, xen_io_tlb_nslabs,
 236                          verbose))
 237                         panic("Cannot allocate SWIOTLB buffer");
 238                 rc = 0;
 239         } else
 240                 rc = swiotlb_late_init_with_tbl(xen_io_tlb_start, xen_io_tlb_nslabs);
 241
 242 end:
 243         if (!rc)
 244                 swiotlb_set_max_segment(PAGE_SIZE);
 245
 246         return rc;
 247 error:
 248         if (repeat--) {
 249                 xen_io_tlb_nslabs = max(1024UL, /* Min is 2MB */
 250                                         (xen_io_tlb_nslabs >> 1));
 251                 pr_info("Lowering to %luMB\n",
 252                         (xen_io_tlb_nslabs << IO_TLB_SHIFT) >> 20);
 253                 goto retry;
 254         }
 255         pr_err("%s (rc:%d)\n", xen_swiotlb_error(m_ret), rc);
 256         if (early)
 257                 panic("%s (rc:%d)", xen_swiotlb_error(m_ret), rc);
 258         else
 259                 free_pages((unsigned long)xen_io_tlb_start, order);
 260         return rc;
 261 }
 262
 263 static void *
 264 xen_swiotlb_alloc_coherent(struct device *hwdev, size_t size,
 265                            dma_addr_t *dma_handle, gfp_t flags,
 266                            unsigned long attrs)
 267 {
 268         void *ret;
 269         int order = get_order(size);
 270         u64 dma_mask = DMA_BIT_MASK(32);
 271         phys_addr_t phys;
 272         dma_addr_t dev_addr;
 273
 274         /*
 275         * Ignore region specifiers - the kernel's ideas of
 276         * pseudo-phys memory layout has nothing to do with the
 277         * machine physical layout.  We can't allocate highmem
 278         * because we can't return a pointer to it.
 279         */
 280         flags &= ~(__GFP_DMA | __GFP_HIGHMEM);
 281
 282         /* Convert the size to actually allocated. */
 283         size = 1UL << (order + XEN_PAGE_SHIFT);
 284
 285         /* On ARM this function returns an ioremap'ped virtual address for
 286          * which virt_to_phys doesn't return the corresponding physical
 287          * address. In fact on ARM virt_to_phys only works for kernel direct
 288          * mapped RAM memory. Also see comment below.
 289          */
 290         ret = xen_alloc_coherent_pages(hwdev, size, dma_handle, flags, attrs);
 291
 292         if (!ret)
 293                 return ret;
 294
 295         if (hwdev && hwdev->coherent_dma_mask)
 296                 dma_mask = hwdev->coherent_dma_mask;
 297
 298         /* At this point dma_handle is the dma address, next we are
 299          * going to set it to the machine address.
 300          * Do not use virt_to_phys(ret) because on ARM it doesn't correspond
 301          * to *dma_handle. */
 302         phys = dma_to_phys(hwdev, *dma_handle);
 303         dev_addr = xen_phys_to_dma(hwdev, phys);
 304         if (((dev_addr + size - 1 <= dma_mask)) &&
 305             !range_straddles_page_boundary(phys, size))
 306                 *dma_handle = dev_addr;
 307         else {
 308                 if (xen_create_contiguous_region(phys, order,
 309                                                  fls64(dma_mask), dma_handle) != 0) {
 310                         xen_free_coherent_pages(hwdev, size, ret, (dma_addr_t)phys, attrs);
 311                         return NULL;
 312                 }
 313                 *dma_handle = phys_to_dma(hwdev, *dma_handle);
 314                 SetPageXenRemapped(virt_to_page(ret));
 315         }
 316         memset(ret, 0, size);
 317         return ret;
 318 }
 319
 320 static void
 321 xen_swiotlb_free_coherent(struct device *hwdev, size_t size, void *vaddr,
 322                           dma_addr_t dev_addr, unsigned long attrs)
 323 {
 324         int order = get_order(size);
 325         phys_addr_t phys;
 326         u64 dma_mask = DMA_BIT_MASK(32);
 327         struct page *page;
 328
 329         if (hwdev && hwdev->coherent_dma_mask)
 330                 dma_mask = hwdev->coherent_dma_mask;
 331
 332         /* do not use virt_to_phys because on ARM it doesn't return you the
 333          * physical address */
 334         phys = xen_dma_to_phys(hwdev, dev_addr);
 335
 336         /* Convert the size to actually allocated. */
 337         size = 1UL << (order + XEN_PAGE_SHIFT);
 338
 339         if (is_vmalloc_addr(vaddr))
 340                 page = vmalloc_to_page(vaddr);
 341         else
 342                 page = virt_to_page(vaddr);
 343
 344         if (!WARN_ON((dev_addr + size - 1 > dma_mask) ||
 345                      range_straddles_page_boundary(phys, size)) &&
 346             TestClearPageXenRemapped(page))
 347                 xen_destroy_contiguous_region(phys, order);
 348
 349         xen_free_coherent_pages(hwdev, size, vaddr, phys_to_dma(hwdev, phys),
 350                                 attrs);
 351 }
 352
 353 /*
 354  * Map a single buffer of the indicated size for DMA in streaming mode.  The
 355  * physical address to use is returned.
 356  *
 357  * Once the device is given the dma address, the device owns this memory until
 358  * either xen_swiotlb_unmap_page or xen_swiotlb_dma_sync_single is performed.
 359  */
 360 static dma_addr_t xen_swiotlb_map_page(struct device *dev, struct page *page,
 361                                 unsigned long offset, size_t size,
 362                                 enum dma_data_direction dir,
 363                                 unsigned long attrs)
 364 {
 365         phys_addr_t map, phys = page_to_phys(page) + offset;
 366         dma_addr_t dev_addr = xen_phys_to_dma(dev, phys);
 367
 368         BUG_ON(dir == DMA_NONE);
 369         /*
 370          * If the address happens to be in the device's DMA window,
 371          * we can safely return the device addr and not worry about bounce
 372          * buffering it.
 373          */
 374         if (dma_capable(dev, dev_addr, size, true) &&
 375             !range_straddles_page_boundary(phys, size) &&
 376                 !xen_arch_need_swiotlb(dev, phys, dev_addr) &&
 377                 swiotlb_force != SWIOTLB_FORCE)
 378                 goto done;
 379
 380         /*
 381          * Oh well, have to allocate and map a bounce buffer.
 382          */
 383         trace_swiotlb_bounced(dev, dev_addr, size, swiotlb_force);
 384
 385         map = swiotlb_tbl_map_single(dev, phys, size, size, dir, attrs);
 386         if (map == (phys_addr_t)DMA_MAPPING_ERROR)
 387                 return DMA_MAPPING_ERROR;
 388
 389         phys = map;
 390         dev_addr = xen_phys_to_dma(dev, map);
 391
 392         /*
 393          * Ensure that the address returned is DMA'ble
 394          */
 395         if (unlikely(!dma_capable(dev, dev_addr, size, true))) {
 396                 swiotlb_tbl_unmap_single(dev, map, size, dir,
 397                                 attrs | DMA_ATTR_SKIP_CPU_SYNC);
 398                 return DMA_MAPPING_ERROR;
 399         }
 400
 401 done:
 402         if (!dev_is_dma_coherent(dev) && !(attrs & DMA_ATTR_SKIP_CPU_SYNC)) {
 403                 if (pfn_valid(PFN_DOWN(dma_to_phys(dev, dev_addr))))
 404                         arch_sync_dma_for_device(phys, size, dir);
 405                 else
 406                         xen_dma_sync_for_device(dev, dev_addr, size, dir);
 407         }
 408         return dev_addr;
 409 }
 410
 411 /*
 412  * Unmap a single streaming mode DMA translation.  The dma_addr and size must
 413  * match what was provided for in a previous xen_swiotlb_map_page call.  All
 414  * other usages are undefined.
 415  *
 416  * After this call, reads by the cpu to the buffer are guaranteed to see
 417  * whatever the device wrote there.
 418  */
 419 static void xen_swiotlb_unmap_page(struct device *hwdev, dma_addr_t dev_addr,
 420                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 421 {
 422         phys_addr_t paddr = xen_dma_to_phys(hwdev, dev_addr);
 423
 424         BUG_ON(dir == DMA_NONE);
 425
 426         if (!dev_is_dma_coherent(hwdev) && !(attrs & DMA_ATTR_SKIP_CPU_SYNC)) {
 427                 if (pfn_valid(PFN_DOWN(dma_to_phys(hwdev, dev_addr))))
 428                         arch_sync_dma_for_cpu(paddr, size, dir);
 429                 else
 430                         xen_dma_sync_for_cpu(hwdev, dev_addr, size, dir);
 431         }
 432
 433         /* NOTE: We use dev_addr here, not paddr! */
 434         if (is_xen_swiotlb_buffer(hwdev, dev_addr))
 435                 swiotlb_tbl_unmap_single(hwdev, paddr, size, dir, attrs);
 436 }
 437
 438 static void
 439 xen_swiotlb_sync_single_for_cpu(struct device *dev, dma_addr_t dma_addr,
 440                 size_t size, enum dma_data_direction dir)
 441 {
 442         phys_addr_t paddr = xen_dma_to_phys(dev, dma_addr);
 443
 444         if (!dev_is_dma_coherent(dev)) {
 445                 if (pfn_valid(PFN_DOWN(dma_to_phys(dev, dma_addr))))
 446                         arch_sync_dma_for_cpu(paddr, size, dir);
 447                 else
 448                         xen_dma_sync_for_cpu(dev, dma_addr, size, dir);
 449         }
 450
 451         if (is_xen_swiotlb_buffer(dev, dma_addr))
 452                 swiotlb_sync_single_for_cpu(dev, paddr, size, dir);
 453 }
 454
 455 static void
 456 xen_swiotlb_sync_single_for_device(struct device *dev, dma_addr_t dma_addr,
 457                 size_t size, enum dma_data_direction dir)
 458 {
 459         phys_addr_t paddr = xen_dma_to_phys(dev, dma_addr);
 460
 461         if (is_xen_swiotlb_buffer(dev, dma_addr))
 462                 swiotlb_sync_single_for_device(dev, paddr, size, dir);
 463
 464         if (!dev_is_dma_coherent(dev)) {
 465                 if (pfn_valid(PFN_DOWN(dma_to_phys(dev, dma_addr))))
 466                         arch_sync_dma_for_device(paddr, size, dir);
 467                 else
 468                         xen_dma_sync_for_device(dev, dma_addr, size, dir);
 469         }
 470 }
 471
 472 /*
 473  * Unmap a set of streaming mode DMA translations.  Again, cpu read rules
 474  * concerning calls here are the same as for swiotlb_unmap_page() above.
 475  */
 476 static void
 477 xen_swiotlb_unmap_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
 478                 enum dma_data_direction dir, unsigned long attrs)
 479 {
 480         struct scatterlist *sg;
 481         int i;
 482
 483         BUG_ON(dir == DMA_NONE);
 484
 485         for_each_sg(sgl, sg, nelems, i)
 486                 xen_swiotlb_unmap_page(hwdev, sg->dma_address, sg_dma_len(sg),
 487                                 dir, attrs);
 488
 489 }
 490
 491 static int
 492 xen_swiotlb_map_sg(struct device *dev, struct scatterlist *sgl, int nelems,
 493                 enum dma_data_direction dir, unsigned long attrs)
 494 {
 495         struct scatterlist *sg;
 496         int i;
 497
 498         BUG_ON(dir == DMA_NONE);
 499
 500         for_each_sg(sgl, sg, nelems, i) {
 501                 sg->dma_address = xen_swiotlb_map_page(dev, sg_page(sg),
 502                                 sg->offset, sg->length, dir, attrs);
 503                 if (sg->dma_address == DMA_MAPPING_ERROR)
 504                         goto out_unmap;
 505                 sg_dma_len(sg) = sg->length;
 506         }
 507
 508         return nelems;
 509 out_unmap:
 510         xen_swiotlb_unmap_sg(dev, sgl, i, dir, attrs | DMA_ATTR_SKIP_CPU_SYNC);
 511         sg_dma_len(sgl) = 0;
 512         return 0;
 513 }
 514
 515 static void
 516 xen_swiotlb_sync_sg_for_cpu(struct device *dev, struct scatterlist *sgl,
 517                             int nelems, enum dma_data_direction dir)
 518 {
 519         struct scatterlist *sg;
 520         int i;
 521
 522         for_each_sg(sgl, sg, nelems, i) {
 523                 xen_swiotlb_sync_single_for_cpu(dev, sg->dma_address,
 524                                 sg->length, dir);
 525         }
 526 }
 527
 528 static void
 529 xen_swiotlb_sync_sg_for_device(struct device *dev, struct scatterlist *sgl,
 530                                int nelems, enum dma_data_direction dir)
 531 {
 532         struct scatterlist *sg;
 533         int i;
 534
 535         for_each_sg(sgl, sg, nelems, i) {
 536                 xen_swiotlb_sync_single_for_device(dev, sg->dma_address,
 537                                 sg->length, dir);
 538         }
 539 }
 540
 541 /*
 542  * Return whether the given device DMA address mask can be supported
 543  * properly.  For example, if your device can only drive the low 24-bits
 544  * during bus mastering, then you would pass 0x00ffffff as the mask to
 545  * this function.
 546  */
 547 static int
 548 xen_swiotlb_dma_supported(struct device *hwdev, u64 mask)
 549 {
 550         return xen_phys_to_dma(hwdev, io_tlb_end - 1) <= mask;
 551 }
 552
 553 const struct dma_map_ops xen_swiotlb_dma_ops = {
 554         .alloc = xen_swiotlb_alloc_coherent,
 555         .free = xen_swiotlb_free_coherent,
 556         .sync_single_for_cpu = xen_swiotlb_sync_single_for_cpu,
 557         .sync_single_for_device = xen_swiotlb_sync_single_for_device,
 558         .sync_sg_for_cpu = xen_swiotlb_sync_sg_for_cpu,
 559         .sync_sg_for_device = xen_swiotlb_sync_sg_for_device,
 560         .map_sg = xen_swiotlb_map_sg,
 561         .unmap_sg = xen_swiotlb_unmap_sg,
 562         .map_page = xen_swiotlb_map_page,
 563         .unmap_page = xen_swiotlb_unmap_page,
 564         .dma_supported = xen_swiotlb_dma_supported,
 565         .mmap = dma_common_mmap,
 566         .get_sgtable = dma_common_get_sgtable,
 567         .alloc_pages = dma_common_alloc_pages,
 568         .free_pages = dma_common_free_pages,
 569 };