mm/memremap.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* Copyright(c) 2015 Intel Corporation. All rights reserved. */
   3 #include <linux/device.h>
   4 #include <linux/io.h>
   5 #include <linux/kasan.h>
   6 #include <linux/memory_hotplug.h>
   7 #include <linux/mm.h>
   8 #include <linux/pfn_t.h>
   9 #include <linux/swap.h>
  10 #include <linux/mmzone.h>
  11 #include <linux/swapops.h>
  12 #include <linux/types.h>
  13 #include <linux/wait_bit.h>
  14 #include <linux/xarray.h>
  15
  16 static DEFINE_XARRAY(pgmap_array);
  17
  18 /*
  19  * The memremap() and memremap_pages() interfaces are alternately used
  20  * to map persistent memory namespaces. These interfaces place different
  21  * constraints on the alignment and size of the mapping (namespace).
  22  * memremap() can map individual PAGE_SIZE pages. memremap_pages() can
  23  * only map subsections (2MB), and at least one architecture (PowerPC)
  24  * the minimum mapping granularity of memremap_pages() is 16MB.
  25  *
  26  * The role of memremap_compat_align() is to communicate the minimum
  27  * arch supported alignment of a namespace such that it can freely
  28  * switch modes without violating the arch constraint. Namely, do not
  29  * allow a namespace to be PAGE_SIZE aligned since that namespace may be
  30  * reconfigured into a mode that requires SUBSECTION_SIZE alignment.
  31  */
  32 #ifndef CONFIG_ARCH_HAS_MEMREMAP_COMPAT_ALIGN
  33 unsigned long memremap_compat_align(void)
  34 {
  35         return SUBSECTION_SIZE;
  36 }
  37 EXPORT_SYMBOL_GPL(memremap_compat_align);
  38 #endif
  39
  40 #ifdef CONFIG_DEV_PAGEMAP_OPS
  41 DEFINE_STATIC_KEY_FALSE(devmap_managed_key);
  42 EXPORT_SYMBOL(devmap_managed_key);
  43
  44 static void devmap_managed_enable_put(struct dev_pagemap *pgmap)
  45 {
  46         if (pgmap->type == MEMORY_DEVICE_PRIVATE ||
  47             pgmap->type == MEMORY_DEVICE_FS_DAX)
  48                 static_branch_dec(&devmap_managed_key);
  49 }
  50
  51 static void devmap_managed_enable_get(struct dev_pagemap *pgmap)
  52 {
  53         if (pgmap->type == MEMORY_DEVICE_PRIVATE ||
  54             pgmap->type == MEMORY_DEVICE_FS_DAX)
  55                 static_branch_inc(&devmap_managed_key);
  56 }
  57 #else
  58 static void devmap_managed_enable_get(struct dev_pagemap *pgmap)
  59 {
  60 }
  61 static void devmap_managed_enable_put(struct dev_pagemap *pgmap)
  62 {
  63 }
  64 #endif /* CONFIG_DEV_PAGEMAP_OPS */
  65
  66 static void pgmap_array_delete(struct range *range)
  67 {
  68         xa_store_range(&pgmap_array, PHYS_PFN(range->start), PHYS_PFN(range->end),
  69                         NULL, GFP_KERNEL);
  70         synchronize_rcu();
  71 }
  72
  73 static unsigned long pfn_first(struct dev_pagemap *pgmap, int range_id)
  74 {
  75         struct range *range = &pgmap->ranges[range_id];
  76         unsigned long pfn = PHYS_PFN(range->start);
  77
  78         if (range_id)
  79                 return pfn;
  80         return pfn + vmem_altmap_offset(pgmap_altmap(pgmap));
  81 }
  82
  83 bool pgmap_pfn_valid(struct dev_pagemap *pgmap, unsigned long pfn)
  84 {
  85         int i;
  86
  87         for (i = 0; i < pgmap->nr_range; i++) {
  88                 struct range *range = &pgmap->ranges[i];
  89
  90                 if (pfn >= PHYS_PFN(range->start) &&
  91                     pfn <= PHYS_PFN(range->end))
  92                         return pfn >= pfn_first(pgmap, i);
  93         }
  94
  95         return false;
  96 }
  97
  98 static unsigned long pfn_end(struct dev_pagemap *pgmap, int range_id)
  99 {
 100         const struct range *range = &pgmap->ranges[range_id];
 101
 102         return (range->start + range_len(range)) >> PAGE_SHIFT;
 103 }
 104
 105 static unsigned long pfn_next(unsigned long pfn)
 106 {
 107         if (pfn % 1024 == 0)
 108                 cond_resched();
 109         return pfn + 1;
 110 }
 111
 112 #define for_each_device_pfn(pfn, map, i) \
 113         for (pfn = pfn_first(map, i); pfn < pfn_end(map, i); pfn = pfn_next(pfn))
 114
 115 static void pageunmap_range(struct dev_pagemap *pgmap, int range_id)
 116 {
 117         struct range *range = &pgmap->ranges[range_id];
 118         struct page *first_page;
 119
 120         /* make sure to access a memmap that was actually initialized */
 121         first_page = pfn_to_page(pfn_first(pgmap, range_id));
 122
 123         /* pages are dead and unused, undo the arch mapping */
 124         mem_hotplug_begin();
 125         remove_pfn_range_from_zone(page_zone(first_page), PHYS_PFN(range->start),
 126                                    PHYS_PFN(range_len(range)));
 127         if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
 128                 __remove_pages(PHYS_PFN(range->start),
 129                                PHYS_PFN(range_len(range)), NULL);
 130         } else {
 131                 arch_remove_memory(range->start, range_len(range),
 132                                 pgmap_altmap(pgmap));
 133                 kasan_remove_zero_shadow(__va(range->start), range_len(range));
 134         }
 135         mem_hotplug_done();
 136
 137         untrack_pfn(NULL, PHYS_PFN(range->start), range_len(range));
 138         pgmap_array_delete(range);
 139 }
 140
 141 void memunmap_pages(struct dev_pagemap *pgmap)
 142 {
 143         unsigned long pfn;
 144         int i;
 145
 146         percpu_ref_kill(&pgmap->ref);
 147         for (i = 0; i < pgmap->nr_range; i++)
 148                 for_each_device_pfn(pfn, pgmap, i)
 149                         put_page(pfn_to_page(pfn));
 150         wait_for_completion(&pgmap->done);
 151
 152         for (i = 0; i < pgmap->nr_range; i++)
 153                 pageunmap_range(pgmap, i);
 154         percpu_ref_exit(&pgmap->ref);
 155
 156         WARN_ONCE(pgmap->altmap.alloc, "failed to free all reserved pages\n");
 157         devmap_managed_enable_put(pgmap);
 158 }
 159 EXPORT_SYMBOL_GPL(memunmap_pages);
 160
 161 static void devm_memremap_pages_release(void *data)
 162 {
 163         memunmap_pages(data);
 164 }
 165
 166 static void dev_pagemap_percpu_release(struct percpu_ref *ref)
 167 {
 168         struct dev_pagemap *pgmap = container_of(ref, struct dev_pagemap, ref);
 169
 170         complete(&pgmap->done);
 171 }
 172
 173 static int pagemap_range(struct dev_pagemap *pgmap, struct mhp_params *params,
 174                 int range_id, int nid)
 175 {
 176         const bool is_private = pgmap->type == MEMORY_DEVICE_PRIVATE;
 177         struct range *range = &pgmap->ranges[range_id];
 178         struct dev_pagemap *conflict_pgmap;
 179         int error, is_ram;
 180
 181         if (WARN_ONCE(pgmap_altmap(pgmap) && range_id > 0,
 182                                 "altmap not supported for multiple ranges\n"))
 183                 return -EINVAL;
 184
 185         conflict_pgmap = get_dev_pagemap(PHYS_PFN(range->start), NULL);
 186         if (conflict_pgmap) {
 187                 WARN(1, "Conflicting mapping in same section\n");
 188                 put_dev_pagemap(conflict_pgmap);
 189                 return -ENOMEM;
 190         }
 191
 192         conflict_pgmap = get_dev_pagemap(PHYS_PFN(range->end), NULL);
 193         if (conflict_pgmap) {
 194                 WARN(1, "Conflicting mapping in same section\n");
 195                 put_dev_pagemap(conflict_pgmap);
 196                 return -ENOMEM;
 197         }
 198
 199         is_ram = region_intersects(range->start, range_len(range),
 200                 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
 201
 202         if (is_ram != REGION_DISJOINT) {
 203                 WARN_ONCE(1, "attempted on %s region %#llx-%#llx\n",
 204                                 is_ram == REGION_MIXED ? "mixed" : "ram",
 205                                 range->start, range->end);
 206                 return -ENXIO;
 207         }
 208
 209         error = xa_err(xa_store_range(&pgmap_array, PHYS_PFN(range->start),
 210                                 PHYS_PFN(range->end), pgmap, GFP_KERNEL));
 211         if (error)
 212                 return error;
 213
 214         if (nid < 0)
 215                 nid = numa_mem_id();
 216
 217         error = track_pfn_remap(NULL, &params->pgprot, PHYS_PFN(range->start), 0,
 218                         range_len(range));
 219         if (error)
 220                 goto err_pfn_remap;
 221
 222         if (!mhp_range_allowed(range->start, range_len(range), !is_private)) {
 223                 error = -EINVAL;
 224                 goto err_kasan;
 225         }
 226
 227         mem_hotplug_begin();
 228
 229         /*
 230          * For device private memory we call add_pages() as we only need to
 231          * allocate and initialize struct page for the device memory. More-
 232          * over the device memory is un-accessible thus we do not want to
 233          * create a linear mapping for the memory like arch_add_memory()
 234          * would do.
 235          *
 236          * For all other device memory types, which are accessible by
 237          * the CPU, we do want the linear mapping and thus use
 238          * arch_add_memory().
 239          */
 240         if (is_private) {
 241                 error = add_pages(nid, PHYS_PFN(range->start),
 242                                 PHYS_PFN(range_len(range)), params);
 243         } else {
 244                 error = kasan_add_zero_shadow(__va(range->start), range_len(range));
 245                 if (error) {
 246                         mem_hotplug_done();
 247                         goto err_kasan;
 248                 }
 249
 250                 error = arch_add_memory(nid, range->start, range_len(range),
 251                                         params);
 252         }
 253
 254         if (!error) {
 255                 struct zone *zone;
 256
 257                 zone = &NODE_DATA(nid)->node_zones[ZONE_DEVICE];
 258                 move_pfn_range_to_zone(zone, PHYS_PFN(range->start),
 259                                 PHYS_PFN(range_len(range)), params->altmap,
 260                                 MIGRATE_MOVABLE);
 261         }
 262
 263         mem_hotplug_done();
 264         if (error)
 265                 goto err_add_memory;
 266
 267         /*
 268          * Initialization of the pages has been deferred until now in order
 269          * to allow us to do the work while not holding the hotplug lock.
 270          */
 271         memmap_init_zone_device(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
 272                                 PHYS_PFN(range->start),
 273                                 PHYS_PFN(range_len(range)), pgmap);
 274         percpu_ref_get_many(&pgmap->ref,
 275                 pfn_end(pgmap, range_id) - pfn_first(pgmap, range_id));
 276         return 0;
 277
 278 err_add_memory:
 279         kasan_remove_zero_shadow(__va(range->start), range_len(range));
 280 err_kasan:
 281         untrack_pfn(NULL, PHYS_PFN(range->start), range_len(range));
 282 err_pfn_remap:
 283         pgmap_array_delete(range);
 284         return error;
 285 }
 286
 287
 288 /*
 289  * Not device managed version of dev_memremap_pages, undone by
 290  * memunmap_pages().  Please use dev_memremap_pages if you have a struct
 291  * device available.
 292  */
 293 void *memremap_pages(struct dev_pagemap *pgmap, int nid)
 294 {
 295         struct mhp_params params = {
 296                 .altmap = pgmap_altmap(pgmap),
 297                 .pgprot = PAGE_KERNEL,
 298         };
 299         const int nr_range = pgmap->nr_range;
 300         int error, i;
 301
 302         if (WARN_ONCE(!nr_range, "nr_range must be specified\n"))
 303                 return ERR_PTR(-EINVAL);
 304
 305         switch (pgmap->type) {
 306         case MEMORY_DEVICE_PRIVATE:
 307                 if (!IS_ENABLED(CONFIG_DEVICE_PRIVATE)) {
 308                         WARN(1, "Device private memory not supported\n");
 309                         return ERR_PTR(-EINVAL);
 310                 }
 311                 if (!pgmap->ops || !pgmap->ops->migrate_to_ram) {
 312                         WARN(1, "Missing migrate_to_ram method\n");
 313                         return ERR_PTR(-EINVAL);
 314                 }
 315                 if (!pgmap->ops->page_free) {
 316                         WARN(1, "Missing page_free method\n");
 317                         return ERR_PTR(-EINVAL);
 318                 }
 319                 if (!pgmap->owner) {
 320                         WARN(1, "Missing owner\n");
 321                         return ERR_PTR(-EINVAL);
 322                 }
 323                 break;
 324         case MEMORY_DEVICE_FS_DAX:
 325                 if (!IS_ENABLED(CONFIG_ZONE_DEVICE) ||
 326                     IS_ENABLED(CONFIG_FS_DAX_LIMITED)) {
 327                         WARN(1, "File system DAX not supported\n");
 328                         return ERR_PTR(-EINVAL);
 329                 }
 330                 params.pgprot = pgprot_decrypted(params.pgprot);
 331                 break;
 332         case MEMORY_DEVICE_GENERIC:
 333                 break;
 334         case MEMORY_DEVICE_PCI_P2PDMA:
 335                 params.pgprot = pgprot_noncached(params.pgprot);
 336                 break;
 337         default:
 338                 WARN(1, "Invalid pgmap type %d\n", pgmap->type);
 339                 break;
 340         }
 341
 342         init_completion(&pgmap->done);
 343         error = percpu_ref_init(&pgmap->ref, dev_pagemap_percpu_release, 0,
 344                                 GFP_KERNEL);
 345         if (error)
 346                 return ERR_PTR(error);
 347
 348         devmap_managed_enable_get(pgmap);
 349
 350         /*
 351          * Clear the pgmap nr_range as it will be incremented for each
 352          * successfully processed range. This communicates how many
 353          * regions to unwind in the abort case.
 354          */
 355         pgmap->nr_range = 0;
 356         error = 0;
 357         for (i = 0; i < nr_range; i++) {
 358                 error = pagemap_range(pgmap, &params, i, nid);
 359                 if (error)
 360                         break;
 361                 pgmap->nr_range++;
 362         }
 363
 364         if (i < nr_range) {
 365                 memunmap_pages(pgmap);
 366                 pgmap->nr_range = nr_range;
 367                 return ERR_PTR(error);
 368         }
 369
 370         return __va(pgmap->ranges[0].start);
 371 }
 372 EXPORT_SYMBOL_GPL(memremap_pages);
 373
 374 /**
 375  * devm_memremap_pages - remap and provide memmap backing for the given resource
 376  * @dev: hosting device for @res
 377  * @pgmap: pointer to a struct dev_pagemap
 378  *
 379  * Notes:
 380  * 1/ At a minimum the res and type members of @pgmap must be initialized
 381  *    by the caller before passing it to this function
 382  *
 383  * 2/ The altmap field may optionally be initialized, in which case
 384  *    PGMAP_ALTMAP_VALID must be set in pgmap->flags.
 385  *
 386  * 3/ The ref field may optionally be provided, in which pgmap->ref must be
 387  *    'live' on entry and will be killed and reaped at
 388  *    devm_memremap_pages_release() time, or if this routine fails.
 389  *
 390  * 4/ range is expected to be a host memory range that could feasibly be
 391  *    treated as a "System RAM" range, i.e. not a device mmio range, but
 392  *    this is not enforced.
 393  */
 394 void *devm_memremap_pages(struct device *dev, struct dev_pagemap *pgmap)
 395 {
 396         int error;
 397         void *ret;
 398
 399         ret = memremap_pages(pgmap, dev_to_node(dev));
 400         if (IS_ERR(ret))
 401                 return ret;
 402
 403         error = devm_add_action_or_reset(dev, devm_memremap_pages_release,
 404                         pgmap);
 405         if (error)
 406                 return ERR_PTR(error);
 407         return ret;
 408 }
 409 EXPORT_SYMBOL_GPL(devm_memremap_pages);
 410
 411 void devm_memunmap_pages(struct device *dev, struct dev_pagemap *pgmap)
 412 {
 413         devm_release_action(dev, devm_memremap_pages_release, pgmap);
 414 }
 415 EXPORT_SYMBOL_GPL(devm_memunmap_pages);
 416
 417 unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
 418 {
 419         /* number of pfns from base where pfn_to_page() is valid */
 420         if (altmap)
 421                 return altmap->reserve + altmap->free;
 422         return 0;
 423 }
 424
 425 void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
 426 {
 427         altmap->alloc -= nr_pfns;
 428 }
 429
 430 /**
 431  * get_dev_pagemap() - take a new live reference on the dev_pagemap for @pfn
 432  * @pfn: page frame number to lookup page_map
 433  * @pgmap: optional known pgmap that already has a reference
 434  *
 435  * If @pgmap is non-NULL and covers @pfn it will be returned as-is.  If @pgmap
 436  * is non-NULL but does not cover @pfn the reference to it will be released.
 437  */
 438 struct dev_pagemap *get_dev_pagemap(unsigned long pfn,
 439                 struct dev_pagemap *pgmap)
 440 {
 441         resource_size_t phys = PFN_PHYS(pfn);
 442
 443         /*
 444          * In the cached case we're already holding a live reference.
 445          */
 446         if (pgmap) {
 447                 if (phys >= pgmap->range.start && phys <= pgmap->range.end)
 448                         return pgmap;
 449                 put_dev_pagemap(pgmap);
 450         }
 451
 452         /* fall back to slow path lookup */
 453         rcu_read_lock();
 454         pgmap = xa_load(&pgmap_array, PHYS_PFN(phys));
 455         if (pgmap && !percpu_ref_tryget_live(&pgmap->ref))
 456                 pgmap = NULL;
 457         rcu_read_unlock();
 458
 459         return pgmap;
 460 }
 461 EXPORT_SYMBOL_GPL(get_dev_pagemap);
 462
 463 #ifdef CONFIG_DEV_PAGEMAP_OPS
 464 void free_devmap_managed_page(struct page *page)
 465 {
 466         /* notify page idle for dax */
 467         if (!is_device_private_page(page)) {
 468                 wake_up_var(&page->_refcount);
 469                 return;
 470         }
 471
 472         __ClearPageWaiters(page);
 473
 474         mem_cgroup_uncharge(page);
 475
 476         /*
 477          * When a device_private page is freed, the page->mapping field
 478          * may still contain a (stale) mapping value. For example, the
 479          * lower bits of page->mapping may still identify the page as an
 480          * anonymous page. Ultimately, this entire field is just stale
 481          * and wrong, and it will cause errors if not cleared.  One
 482          * example is:
 483          *
 484          *  migrate_vma_pages()
 485          *    migrate_vma_insert_page()
 486          *      page_add_new_anon_rmap()
 487          *        __page_set_anon_rmap()
 488          *          ...checks page->mapping, via PageAnon(page) call,
 489          *            and incorrectly concludes that the page is an
 490          *            anonymous page. Therefore, it incorrectly,
 491          *            silently fails to set up the new anon rmap.
 492          *
 493          * For other types of ZONE_DEVICE pages, migration is either
 494          * handled differently or not done at all, so there is no need
 495          * to clear page->mapping.
 496          */
 497         page->mapping = NULL;
 498         page->pgmap->ops->page_free(page);
 499 }
 500 #endif /* CONFIG_DEV_PAGEMAP_OPS */