kernel/memremap.c

   1 /*
   2  * Copyright(c) 2015 Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  */
  13 #include <linux/radix-tree.h>
  14 #include <linux/memremap.h>
  15 #include <linux/device.h>
  16 #include <linux/types.h>
  17 #include <linux/pfn_t.h>
  18 #include <linux/io.h>
  19 #include <linux/mm.h>
  20 #include <linux/memory_hotplug.h>
  21
  22 #ifndef ioremap_cache
  23 /* temporary while we convert existing ioremap_cache users to memremap */
  24 __weak void __iomem *ioremap_cache(resource_size_t offset, unsigned long size)
  25 {
  26         return ioremap(offset, size);
  27 }
  28 #endif
  29
  30 static void *try_ram_remap(resource_size_t offset, size_t size)
  31 {
  32         unsigned long pfn = PHYS_PFN(offset);
  33
  34         /* In the simple case just return the existing linear address */
  35         if (pfn_valid(pfn) && !PageHighMem(pfn_to_page(pfn)))
  36                 return __va(offset);
  37         return NULL; /* fallback to ioremap_cache */
  38 }
  39
  40 /**
  41  * memremap() - remap an iomem_resource as cacheable memory
  42  * @offset: iomem resource start address
  43  * @size: size of remap
  44  * @flags: either MEMREMAP_WB or MEMREMAP_WT
  45  *
  46  * memremap() is "ioremap" for cases where it is known that the resource
  47  * being mapped does not have i/o side effects and the __iomem
  48  * annotation is not applicable.
  49  *
  50  * MEMREMAP_WB - matches the default mapping for "System RAM" on
  51  * the architecture.  This is usually a read-allocate write-back cache.
  52  * Morever, if MEMREMAP_WB is specified and the requested remap region is RAM
  53  * memremap() will bypass establishing a new mapping and instead return
  54  * a pointer into the direct map.
  55  *
  56  * MEMREMAP_WT - establish a mapping whereby writes either bypass the
  57  * cache or are written through to memory and never exist in a
  58  * cache-dirty state with respect to program visibility.  Attempts to
  59  * map "System RAM" with this mapping type will fail.
  60  */
  61 void *memremap(resource_size_t offset, size_t size, unsigned long flags)
  62 {
  63         int is_ram = region_intersects(offset, size, "System RAM");
  64         void *addr = NULL;
  65
  66         if (is_ram == REGION_MIXED) {
  67                 WARN_ONCE(1, "memremap attempted on mixed range %pa size: %#lx\n",
  68                                 &offset, (unsigned long) size);
  69                 return NULL;
  70         }
  71
  72         /* Try all mapping types requested until one returns non-NULL */
  73         if (flags & MEMREMAP_WB) {
  74                 flags &= ~MEMREMAP_WB;
  75                 /*
  76                  * MEMREMAP_WB is special in that it can be satisifed
  77                  * from the direct map.  Some archs depend on the
  78                  * capability of memremap() to autodetect cases where
  79                  * the requested range is potentially in "System RAM"
  80                  */
  81                 if (is_ram == REGION_INTERSECTS)
  82                         addr = try_ram_remap(offset, size);
  83                 if (!addr)
  84                         addr = ioremap_cache(offset, size);
  85         }
  86
  87         /*
  88          * If we don't have a mapping yet and more request flags are
  89          * pending then we will be attempting to establish a new virtual
  90          * address mapping.  Enforce that this mapping is not aliasing
  91          * "System RAM"
  92          */
  93         if (!addr && is_ram == REGION_INTERSECTS && flags) {
  94                 WARN_ONCE(1, "memremap attempted on ram %pa size: %#lx\n",
  95                                 &offset, (unsigned long) size);
  96                 return NULL;
  97         }
  98
  99         if (!addr && (flags & MEMREMAP_WT)) {
 100                 flags &= ~MEMREMAP_WT;
 101                 addr = ioremap_wt(offset, size);
 102         }
 103
 104         return addr;
 105 }
 106 EXPORT_SYMBOL(memremap);
 107
 108 void memunmap(void *addr)
 109 {
 110         if (is_vmalloc_addr(addr))
 111                 iounmap((void __iomem *) addr);
 112 }
 113 EXPORT_SYMBOL(memunmap);
 114
 115 static void devm_memremap_release(struct device *dev, void *res)
 116 {
 117         memunmap(*(void **)res);
 118 }
 119
 120 static int devm_memremap_match(struct device *dev, void *res, void *match_data)
 121 {
 122         return *(void **)res == match_data;
 123 }
 124
 125 void *devm_memremap(struct device *dev, resource_size_t offset,
 126                 size_t size, unsigned long flags)
 127 {
 128         void **ptr, *addr;
 129
 130         ptr = devres_alloc_node(devm_memremap_release, sizeof(*ptr), GFP_KERNEL,
 131                         dev_to_node(dev));
 132         if (!ptr)
 133                 return ERR_PTR(-ENOMEM);
 134
 135         addr = memremap(offset, size, flags);
 136         if (addr) {
 137                 *ptr = addr;
 138                 devres_add(dev, ptr);
 139         } else {
 140                 devres_free(ptr);
 141                 return ERR_PTR(-ENXIO);
 142         }
 143
 144         return addr;
 145 }
 146 EXPORT_SYMBOL(devm_memremap);
 147
 148 void devm_memunmap(struct device *dev, void *addr)
 149 {
 150         WARN_ON(devres_release(dev, devm_memremap_release,
 151                                 devm_memremap_match, addr));
 152 }
 153 EXPORT_SYMBOL(devm_memunmap);
 154
 155 pfn_t phys_to_pfn_t(phys_addr_t addr, u64 flags)
 156 {
 157         return __pfn_to_pfn_t(addr >> PAGE_SHIFT, flags);
 158 }
 159 EXPORT_SYMBOL(phys_to_pfn_t);
 160
 161 #ifdef CONFIG_ZONE_DEVICE
 162 static DEFINE_MUTEX(pgmap_lock);
 163 static RADIX_TREE(pgmap_radix, GFP_KERNEL);
 164 #define SECTION_MASK ~((1UL << PA_SECTION_SHIFT) - 1)
 165 #define SECTION_SIZE (1UL << PA_SECTION_SHIFT)
 166
 167 struct page_map {
 168         struct resource res;
 169         struct percpu_ref *ref;
 170         struct dev_pagemap pgmap;
 171         struct vmem_altmap altmap;
 172 };
 173
 174 void get_zone_device_page(struct page *page)
 175 {
 176         percpu_ref_get(page->pgmap->ref);
 177 }
 178 EXPORT_SYMBOL(get_zone_device_page);
 179
 180 void put_zone_device_page(struct page *page)
 181 {
 182         put_dev_pagemap(page->pgmap);
 183 }
 184 EXPORT_SYMBOL(put_zone_device_page);
 185
 186 static void pgmap_radix_release(struct resource *res)
 187 {
 188         resource_size_t key, align_start, align_size, align_end;
 189
 190         align_start = res->start & ~(SECTION_SIZE - 1);
 191         align_size = ALIGN(resource_size(res), SECTION_SIZE);
 192         align_end = align_start + align_size - 1;
 193
 194         mutex_lock(&pgmap_lock);
 195         for (key = res->start; key <= res->end; key += SECTION_SIZE)
 196                 radix_tree_delete(&pgmap_radix, key >> PA_SECTION_SHIFT);
 197         mutex_unlock(&pgmap_lock);
 198 }
 199
 200 static unsigned long pfn_first(struct page_map *page_map)
 201 {
 202         struct dev_pagemap *pgmap = &page_map->pgmap;
 203         const struct resource *res = &page_map->res;
 204         struct vmem_altmap *altmap = pgmap->altmap;
 205         unsigned long pfn;
 206
 207         pfn = res->start >> PAGE_SHIFT;
 208         if (altmap)
 209                 pfn += vmem_altmap_offset(altmap);
 210         return pfn;
 211 }
 212
 213 static unsigned long pfn_end(struct page_map *page_map)
 214 {
 215         const struct resource *res = &page_map->res;
 216
 217         return (res->start + resource_size(res)) >> PAGE_SHIFT;
 218 }
 219
 220 #define for_each_device_pfn(pfn, map) \
 221         for (pfn = pfn_first(map); pfn < pfn_end(map); pfn++)
 222
 223 static void devm_memremap_pages_release(struct device *dev, void *data)
 224 {
 225         struct page_map *page_map = data;
 226         struct resource *res = &page_map->res;
 227         resource_size_t align_start, align_size;
 228         struct dev_pagemap *pgmap = &page_map->pgmap;
 229
 230         if (percpu_ref_tryget_live(pgmap->ref)) {
 231                 dev_WARN(dev, "%s: page mapping is still live!\n", __func__);
 232                 percpu_ref_put(pgmap->ref);
 233         }
 234
 235         /* pages are dead and unused, undo the arch mapping */
 236         align_start = res->start & ~(SECTION_SIZE - 1);
 237         align_size = ALIGN(resource_size(res), SECTION_SIZE);
 238         arch_remove_memory(align_start, align_size);
 239         pgmap_radix_release(res);
 240         dev_WARN_ONCE(dev, pgmap->altmap && pgmap->altmap->alloc,
 241                         "%s: failed to free all reserved pages\n", __func__);
 242 }
 243
 244 /* assumes rcu_read_lock() held at entry */
 245 struct dev_pagemap *find_dev_pagemap(resource_size_t phys)
 246 {
 247         struct page_map *page_map;
 248
 249         WARN_ON_ONCE(!rcu_read_lock_held());
 250
 251         page_map = radix_tree_lookup(&pgmap_radix, phys >> PA_SECTION_SHIFT);
 252         return page_map ? &page_map->pgmap : NULL;
 253 }
 254
 255 /**
 256  * devm_memremap_pages - remap and provide memmap backing for the given resource
 257  * @dev: hosting device for @res
 258  * @res: "host memory" address range
 259  * @ref: a live per-cpu reference count
 260  * @altmap: optional descriptor for allocating the memmap from @res
 261  *
 262  * Notes:
 263  * 1/ @ref must be 'live' on entry and 'dead' before devm_memunmap_pages() time
 264  *    (or devm release event).
 265  *
 266  * 2/ @res is expected to be a host memory range that could feasibly be
 267  *    treated as a "System RAM" range, i.e. not a device mmio range, but
 268  *    this is not enforced.
 269  */
 270 void *devm_memremap_pages(struct device *dev, struct resource *res,
 271                 struct percpu_ref *ref, struct vmem_altmap *altmap)
 272 {
 273         resource_size_t key, align_start, align_size, align_end;
 274         struct dev_pagemap *pgmap;
 275         struct page_map *page_map;
 276         int error, nid, is_ram;
 277         unsigned long pfn;
 278
 279         align_start = res->start & ~(SECTION_SIZE - 1);
 280         align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
 281                 - align_start;
 282         is_ram = region_intersects(align_start, align_size, "System RAM");
 283
 284         if (is_ram == REGION_MIXED) {
 285                 WARN_ONCE(1, "%s attempted on mixed region %pr\n",
 286                                 __func__, res);
 287                 return ERR_PTR(-ENXIO);
 288         }
 289
 290         if (is_ram == REGION_INTERSECTS)
 291                 return __va(res->start);
 292
 293         if (altmap && !IS_ENABLED(CONFIG_SPARSEMEM_VMEMMAP)) {
 294                 dev_err(dev, "%s: altmap requires CONFIG_SPARSEMEM_VMEMMAP=y\n",
 295                                 __func__);
 296                 return ERR_PTR(-ENXIO);
 297         }
 298
 299         if (!ref)
 300                 return ERR_PTR(-EINVAL);
 301
 302         page_map = devres_alloc_node(devm_memremap_pages_release,
 303                         sizeof(*page_map), GFP_KERNEL, dev_to_node(dev));
 304         if (!page_map)
 305                 return ERR_PTR(-ENOMEM);
 306         pgmap = &page_map->pgmap;
 307
 308         memcpy(&page_map->res, res, sizeof(*res));
 309
 310         pgmap->dev = dev;
 311         if (altmap) {
 312                 memcpy(&page_map->altmap, altmap, sizeof(*altmap));
 313                 pgmap->altmap = &page_map->altmap;
 314         }
 315         pgmap->ref = ref;
 316         pgmap->res = &page_map->res;
 317
 318         mutex_lock(&pgmap_lock);
 319         error = 0;
 320         align_end = align_start + align_size - 1;
 321         for (key = align_start; key <= align_end; key += SECTION_SIZE) {
 322                 struct dev_pagemap *dup;
 323
 324                 rcu_read_lock();
 325                 dup = find_dev_pagemap(key);
 326                 rcu_read_unlock();
 327                 if (dup) {
 328                         dev_err(dev, "%s: %pr collides with mapping for %s\n",
 329                                         __func__, res, dev_name(dup->dev));
 330                         error = -EBUSY;
 331                         break;
 332                 }
 333                 error = radix_tree_insert(&pgmap_radix, key >> PA_SECTION_SHIFT,
 334                                 page_map);
 335                 if (error) {
 336                         dev_err(dev, "%s: failed: %d\n", __func__, error);
 337                         break;
 338                 }
 339         }
 340         mutex_unlock(&pgmap_lock);
 341         if (error)
 342                 goto err_radix;
 343
 344         nid = dev_to_node(dev);
 345         if (nid < 0)
 346                 nid = numa_mem_id();
 347
 348         error = arch_add_memory(nid, align_start, align_size, true);
 349         if (error)
 350                 goto err_add_memory;
 351
 352         for_each_device_pfn(pfn, page_map) {
 353                 struct page *page = pfn_to_page(pfn);
 354
 355                 /*
 356                  * ZONE_DEVICE pages union ->lru with a ->pgmap back
 357                  * pointer.  It is a bug if a ZONE_DEVICE page is ever
 358                  * freed or placed on a driver-private list.  Seed the
 359                  * storage with LIST_POISON* values.
 360                  */
 361                 list_del(&page->lru);
 362                 page->pgmap = pgmap;
 363         }
 364         devres_add(dev, page_map);
 365         return __va(res->start);
 366
 367  err_add_memory:
 368  err_radix:
 369         pgmap_radix_release(res);
 370         devres_free(page_map);
 371         return ERR_PTR(error);
 372 }
 373 EXPORT_SYMBOL(devm_memremap_pages);
 374
 375 unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
 376 {
 377         /* number of pfns from base where pfn_to_page() is valid */
 378         return altmap->reserve + altmap->free;
 379 }
 380
 381 void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
 382 {
 383         altmap->alloc -= nr_pfns;
 384 }
 385
 386 #ifdef CONFIG_SPARSEMEM_VMEMMAP
 387 struct vmem_altmap *to_vmem_altmap(unsigned long memmap_start)
 388 {
 389         /*
 390          * 'memmap_start' is the virtual address for the first "struct
 391          * page" in this range of the vmemmap array.  In the case of
 392          * CONFIG_SPARSE_VMEMMAP a page_to_pfn conversion is simple
 393          * pointer arithmetic, so we can perform this to_vmem_altmap()
 394          * conversion without concern for the initialization state of
 395          * the struct page fields.
 396          */
 397         struct page *page = (struct page *) memmap_start;
 398         struct dev_pagemap *pgmap;
 399
 400         /*
 401          * Uncoditionally retrieve a dev_pagemap associated with the
 402          * given physical address, this is only for use in the
 403          * arch_{add|remove}_memory() for setting up and tearing down
 404          * the memmap.
 405          */
 406         rcu_read_lock();
 407         pgmap = find_dev_pagemap(__pfn_to_phys(page_to_pfn(page)));
 408         rcu_read_unlock();
 409
 410         return pgmap ? pgmap->altmap : NULL;
 411 }
 412 #endif /* CONFIG_SPARSEMEM_VMEMMAP */
 413 #endif /* CONFIG_ZONE_DEVICE */