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 dev_pagemap_kill(struct dev_pagemap *pgmap)
 116 {
 117         if (pgmap->ops && pgmap->ops->kill)
 118                 pgmap->ops->kill(pgmap);
 119         else
 120                 percpu_ref_kill(pgmap->ref);
 121 }
 122
 123 static void dev_pagemap_cleanup(struct dev_pagemap *pgmap)
 124 {
 125         if (pgmap->ops && pgmap->ops->cleanup) {
 126                 pgmap->ops->cleanup(pgmap);
 127         } else {
 128                 wait_for_completion(&pgmap->done);
 129                 percpu_ref_exit(pgmap->ref);
 130         }
 131         /*
 132          * Undo the pgmap ref assignment for the internal case as the
 133          * caller may re-enable the same pgmap.
 134          */
 135         if (pgmap->ref == &pgmap->internal_ref)
 136                 pgmap->ref = NULL;
 137 }
 138
 139 static void pageunmap_range(struct dev_pagemap *pgmap, int range_id)
 140 {
 141         struct range *range = &pgmap->ranges[range_id];
 142         struct page *first_page;
 143         int nid;
 144
 145         /* make sure to access a memmap that was actually initialized */
 146         first_page = pfn_to_page(pfn_first(pgmap, range_id));
 147
 148         /* pages are dead and unused, undo the arch mapping */
 149         nid = page_to_nid(first_page);
 150
 151         mem_hotplug_begin();
 152         remove_pfn_range_from_zone(page_zone(first_page), PHYS_PFN(range->start),
 153                                    PHYS_PFN(range_len(range)));
 154         if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
 155                 __remove_pages(PHYS_PFN(range->start),
 156                                PHYS_PFN(range_len(range)), NULL);
 157         } else {
 158                 arch_remove_memory(nid, range->start, range_len(range),
 159                                 pgmap_altmap(pgmap));
 160                 kasan_remove_zero_shadow(__va(range->start), range_len(range));
 161         }
 162         mem_hotplug_done();
 163
 164         untrack_pfn(NULL, PHYS_PFN(range->start), range_len(range));
 165         pgmap_array_delete(range);
 166 }
 167
 168 void memunmap_pages(struct dev_pagemap *pgmap)
 169 {
 170         unsigned long pfn;
 171         int i;
 172
 173         dev_pagemap_kill(pgmap);
 174         for (i = 0; i < pgmap->nr_range; i++)
 175                 for_each_device_pfn(pfn, pgmap, i)
 176                         put_page(pfn_to_page(pfn));
 177         dev_pagemap_cleanup(pgmap);
 178
 179         for (i = 0; i < pgmap->nr_range; i++)
 180                 pageunmap_range(pgmap, i);
 181
 182         WARN_ONCE(pgmap->altmap.alloc, "failed to free all reserved pages\n");
 183         devmap_managed_enable_put(pgmap);
 184 }
 185 EXPORT_SYMBOL_GPL(memunmap_pages);
 186
 187 static void devm_memremap_pages_release(void *data)
 188 {
 189         memunmap_pages(data);
 190 }
 191
 192 static void dev_pagemap_percpu_release(struct percpu_ref *ref)
 193 {
 194         struct dev_pagemap *pgmap =
 195                 container_of(ref, struct dev_pagemap, internal_ref);
 196
 197         complete(&pgmap->done);
 198 }
 199
 200 static int pagemap_range(struct dev_pagemap *pgmap, struct mhp_params *params,
 201                 int range_id, int nid)
 202 {
 203         struct range *range = &pgmap->ranges[range_id];
 204         struct dev_pagemap *conflict_pgmap;
 205         int error, is_ram;
 206
 207         if (WARN_ONCE(pgmap_altmap(pgmap) && range_id > 0,
 208                                 "altmap not supported for multiple ranges\n"))
 209                 return -EINVAL;
 210
 211         conflict_pgmap = get_dev_pagemap(PHYS_PFN(range->start), NULL);
 212         if (conflict_pgmap) {
 213                 WARN(1, "Conflicting mapping in same section\n");
 214                 put_dev_pagemap(conflict_pgmap);
 215                 return -ENOMEM;
 216         }
 217
 218         conflict_pgmap = get_dev_pagemap(PHYS_PFN(range->end), NULL);
 219         if (conflict_pgmap) {
 220                 WARN(1, "Conflicting mapping in same section\n");
 221                 put_dev_pagemap(conflict_pgmap);
 222                 return -ENOMEM;
 223         }
 224
 225         is_ram = region_intersects(range->start, range_len(range),
 226                 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
 227
 228         if (is_ram != REGION_DISJOINT) {
 229                 WARN_ONCE(1, "attempted on %s region %#llx-%#llx\n",
 230                                 is_ram == REGION_MIXED ? "mixed" : "ram",
 231                                 range->start, range->end);
 232                 return -ENXIO;
 233         }
 234
 235         error = xa_err(xa_store_range(&pgmap_array, PHYS_PFN(range->start),
 236                                 PHYS_PFN(range->end), pgmap, GFP_KERNEL));
 237         if (error)
 238                 return error;
 239
 240         if (nid < 0)
 241                 nid = numa_mem_id();
 242
 243         error = track_pfn_remap(NULL, &params->pgprot, PHYS_PFN(range->start), 0,
 244                         range_len(range));
 245         if (error)
 246                 goto err_pfn_remap;
 247
 248         mem_hotplug_begin();
 249
 250         /*
 251          * For device private memory we call add_pages() as we only need to
 252          * allocate and initialize struct page for the device memory. More-
 253          * over the device memory is un-accessible thus we do not want to
 254          * create a linear mapping for the memory like arch_add_memory()
 255          * would do.
 256          *
 257          * For all other device memory types, which are accessible by
 258          * the CPU, we do want the linear mapping and thus use
 259          * arch_add_memory().
 260          */
 261         if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
 262                 error = add_pages(nid, PHYS_PFN(range->start),
 263                                 PHYS_PFN(range_len(range)), params);
 264         } else {
 265                 error = kasan_add_zero_shadow(__va(range->start), range_len(range));
 266                 if (error) {
 267                         mem_hotplug_done();
 268                         goto err_kasan;
 269                 }
 270
 271                 error = arch_add_memory(nid, range->start, range_len(range),
 272                                         params);
 273         }
 274
 275         if (!error) {
 276                 struct zone *zone;
 277
 278                 zone = &NODE_DATA(nid)->node_zones[ZONE_DEVICE];
 279                 move_pfn_range_to_zone(zone, PHYS_PFN(range->start),
 280                                 PHYS_PFN(range_len(range)), params->altmap,
 281                                 MIGRATE_MOVABLE);
 282         }
 283
 284         mem_hotplug_done();
 285         if (error)
 286                 goto err_add_memory;
 287
 288         /*
 289          * Initialization of the pages has been deferred until now in order
 290          * to allow us to do the work while not holding the hotplug lock.
 291          */
 292         memmap_init_zone_device(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
 293                                 PHYS_PFN(range->start),
 294                                 PHYS_PFN(range_len(range)), pgmap);
 295         percpu_ref_get_many(pgmap->ref, pfn_end(pgmap, range_id)
 296                         - pfn_first(pgmap, range_id));
 297         return 0;
 298
 299 err_add_memory:
 300         kasan_remove_zero_shadow(__va(range->start), range_len(range));
 301 err_kasan:
 302         untrack_pfn(NULL, PHYS_PFN(range->start), range_len(range));
 303 err_pfn_remap:
 304         pgmap_array_delete(range);
 305         return error;
 306 }
 307
 308
 309 /*
 310  * Not device managed version of dev_memremap_pages, undone by
 311  * memunmap_pages().  Please use dev_memremap_pages if you have a struct
 312  * device available.
 313  */
 314 void *memremap_pages(struct dev_pagemap *pgmap, int nid)
 315 {
 316         struct mhp_params params = {
 317                 .altmap = pgmap_altmap(pgmap),
 318                 .pgprot = PAGE_KERNEL,
 319         };
 320         const int nr_range = pgmap->nr_range;
 321         int error, i;
 322
 323         if (WARN_ONCE(!nr_range, "nr_range must be specified\n"))
 324                 return ERR_PTR(-EINVAL);
 325
 326         switch (pgmap->type) {
 327         case MEMORY_DEVICE_PRIVATE:
 328                 if (!IS_ENABLED(CONFIG_DEVICE_PRIVATE)) {
 329                         WARN(1, "Device private memory not supported\n");
 330                         return ERR_PTR(-EINVAL);
 331                 }
 332                 if (!pgmap->ops || !pgmap->ops->migrate_to_ram) {
 333                         WARN(1, "Missing migrate_to_ram method\n");
 334                         return ERR_PTR(-EINVAL);
 335                 }
 336                 if (!pgmap->ops->page_free) {
 337                         WARN(1, "Missing page_free method\n");
 338                         return ERR_PTR(-EINVAL);
 339                 }
 340                 if (!pgmap->owner) {
 341                         WARN(1, "Missing owner\n");
 342                         return ERR_PTR(-EINVAL);
 343                 }
 344                 break;
 345         case MEMORY_DEVICE_FS_DAX:
 346                 if (!IS_ENABLED(CONFIG_ZONE_DEVICE) ||
 347                     IS_ENABLED(CONFIG_FS_DAX_LIMITED)) {
 348                         WARN(1, "File system DAX not supported\n");
 349                         return ERR_PTR(-EINVAL);
 350                 }
 351                 params.pgprot = pgprot_decrypted(params.pgprot);
 352                 break;
 353         case MEMORY_DEVICE_GENERIC:
 354                 break;
 355         case MEMORY_DEVICE_PCI_P2PDMA:
 356                 params.pgprot = pgprot_noncached(params.pgprot);
 357                 break;
 358         default:
 359                 WARN(1, "Invalid pgmap type %d\n", pgmap->type);
 360                 break;
 361         }
 362
 363         if (!pgmap->ref) {
 364                 if (pgmap->ops && (pgmap->ops->kill || pgmap->ops->cleanup))
 365                         return ERR_PTR(-EINVAL);
 366
 367                 init_completion(&pgmap->done);
 368                 error = percpu_ref_init(&pgmap->internal_ref,
 369                                 dev_pagemap_percpu_release, 0, GFP_KERNEL);
 370                 if (error)
 371                         return ERR_PTR(error);
 372                 pgmap->ref = &pgmap->internal_ref;
 373         } else {
 374                 if (!pgmap->ops || !pgmap->ops->kill || !pgmap->ops->cleanup) {
 375                         WARN(1, "Missing reference count teardown definition\n");
 376                         return ERR_PTR(-EINVAL);
 377                 }
 378         }
 379
 380         devmap_managed_enable_get(pgmap);
 381
 382         /*
 383          * Clear the pgmap nr_range as it will be incremented for each
 384          * successfully processed range. This communicates how many
 385          * regions to unwind in the abort case.
 386          */
 387         pgmap->nr_range = 0;
 388         error = 0;
 389         for (i = 0; i < nr_range; i++) {
 390                 error = pagemap_range(pgmap, &params, i, nid);
 391                 if (error)
 392                         break;
 393                 pgmap->nr_range++;
 394         }
 395
 396         if (i < nr_range) {
 397                 memunmap_pages(pgmap);
 398                 pgmap->nr_range = nr_range;
 399                 return ERR_PTR(error);
 400         }
 401
 402         return __va(pgmap->ranges[0].start);
 403 }
 404 EXPORT_SYMBOL_GPL(memremap_pages);
 405
 406 /**
 407  * devm_memremap_pages - remap and provide memmap backing for the given resource
 408  * @dev: hosting device for @res
 409  * @pgmap: pointer to a struct dev_pagemap
 410  *
 411  * Notes:
 412  * 1/ At a minimum the res and type members of @pgmap must be initialized
 413  *    by the caller before passing it to this function
 414  *
 415  * 2/ The altmap field may optionally be initialized, in which case
 416  *    PGMAP_ALTMAP_VALID must be set in pgmap->flags.
 417  *
 418  * 3/ The ref field may optionally be provided, in which pgmap->ref must be
 419  *    'live' on entry and will be killed and reaped at
 420  *    devm_memremap_pages_release() time, or if this routine fails.
 421  *
 422  * 4/ range is expected to be a host memory range that could feasibly be
 423  *    treated as a "System RAM" range, i.e. not a device mmio range, but
 424  *    this is not enforced.
 425  */
 426 void *devm_memremap_pages(struct device *dev, struct dev_pagemap *pgmap)
 427 {
 428         int error;
 429         void *ret;
 430
 431         ret = memremap_pages(pgmap, dev_to_node(dev));
 432         if (IS_ERR(ret))
 433                 return ret;
 434
 435         error = devm_add_action_or_reset(dev, devm_memremap_pages_release,
 436                         pgmap);
 437         if (error)
 438                 return ERR_PTR(error);
 439         return ret;
 440 }
 441 EXPORT_SYMBOL_GPL(devm_memremap_pages);
 442
 443 void devm_memunmap_pages(struct device *dev, struct dev_pagemap *pgmap)
 444 {
 445         devm_release_action(dev, devm_memremap_pages_release, pgmap);
 446 }
 447 EXPORT_SYMBOL_GPL(devm_memunmap_pages);
 448
 449 unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
 450 {
 451         /* number of pfns from base where pfn_to_page() is valid */
 452         if (altmap)
 453                 return altmap->reserve + altmap->free;
 454         return 0;
 455 }
 456
 457 void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
 458 {
 459         altmap->alloc -= nr_pfns;
 460 }
 461
 462 /**
 463  * get_dev_pagemap() - take a new live reference on the dev_pagemap for @pfn
 464  * @pfn: page frame number to lookup page_map
 465  * @pgmap: optional known pgmap that already has a reference
 466  *
 467  * If @pgmap is non-NULL and covers @pfn it will be returned as-is.  If @pgmap
 468  * is non-NULL but does not cover @pfn the reference to it will be released.
 469  */
 470 struct dev_pagemap *get_dev_pagemap(unsigned long pfn,
 471                 struct dev_pagemap *pgmap)
 472 {
 473         resource_size_t phys = PFN_PHYS(pfn);
 474
 475         /*
 476          * In the cached case we're already holding a live reference.
 477          */
 478         if (pgmap) {
 479                 if (phys >= pgmap->range.start && phys <= pgmap->range.end)
 480                         return pgmap;
 481                 put_dev_pagemap(pgmap);
 482         }
 483
 484         /* fall back to slow path lookup */
 485         rcu_read_lock();
 486         pgmap = xa_load(&pgmap_array, PHYS_PFN(phys));
 487         if (pgmap && !percpu_ref_tryget_live(pgmap->ref))
 488                 pgmap = NULL;
 489         rcu_read_unlock();
 490
 491         return pgmap;
 492 }
 493 EXPORT_SYMBOL_GPL(get_dev_pagemap);
 494
 495 #ifdef CONFIG_DEV_PAGEMAP_OPS
 496 void free_devmap_managed_page(struct page *page)
 497 {
 498         /* notify page idle for dax */
 499         if (!is_device_private_page(page)) {
 500                 wake_up_var(&page->_refcount);
 501                 return;
 502         }
 503
 504         __ClearPageWaiters(page);
 505
 506         mem_cgroup_uncharge(page);
 507
 508         /*
 509          * When a device_private page is freed, the page->mapping field
 510          * may still contain a (stale) mapping value. For example, the
 511          * lower bits of page->mapping may still identify the page as an
 512          * anonymous page. Ultimately, this entire field is just stale
 513          * and wrong, and it will cause errors if not cleared.  One
 514          * example is:
 515          *
 516          *  migrate_vma_pages()
 517          *    migrate_vma_insert_page()
 518          *      page_add_new_anon_rmap()
 519          *        __page_set_anon_rmap()
 520          *          ...checks page->mapping, via PageAnon(page) call,
 521          *            and incorrectly concludes that the page is an
 522          *            anonymous page. Therefore, it incorrectly,
 523          *            silently fails to set up the new anon rmap.
 524          *
 525          * For other types of ZONE_DEVICE pages, migration is either
 526          * handled differently or not done at all, so there is no need
 527          * to clear page->mapping.
 528          */
 529         page->mapping = NULL;
 530         page->pgmap->ops->page_free(page);
 531 }
 532 #endif /* CONFIG_DEV_PAGEMAP_OPS */