1 // SPDX-License-Identifier: GPL-2.0
3 * Virtual Memory Map support
5 * (C) 2007 sgi. Christoph Lameter.
7 * Virtual memory maps allow VM primitives pfn_to_page, page_to_pfn,
8 * virt_to_page, page_address() to be implemented as a base offset
9 * calculation without memory access.
11 * However, virtual mappings need a page table and TLBs. Many Linux
12 * architectures already map their physical space using 1-1 mappings
13 * via TLBs. For those arches the virtual memory map is essentially
14 * for free if we use the same page size as the 1-1 mappings. In that
15 * case the overhead consists of a few additional pages that are
16 * allocated to create a view of memory for vmemmap.
18 * The architecture is expected to provide a vmemmap_populate() function
19 * to instantiate the mapping.
22 #include <linux/mmzone.h>
23 #include <linux/memblock.h>
24 #include <linux/memremap.h>
25 #include <linux/highmem.h>
26 #include <linux/slab.h>
27 #include <linux/spinlock.h>
28 #include <linux/vmalloc.h>
29 #include <linux/sched.h>
30 #include <linux/pgtable.h>
31 #include <linux/bootmem_info.h>
34 #include <asm/pgalloc.h>
35 #include <asm/tlbflush.h>
38 * struct vmemmap_remap_walk - walk vmemmap page table
40 * @remap_pte: called for each lowest-level entry (PTE).
41 * @nr_walked: the number of walked pte.
42 * @reuse_page: the page which is reused for the tail vmemmap pages.
43 * @reuse_addr: the virtual address of the @reuse_page page.
44 * @vmemmap_pages: the list head of the vmemmap pages that can be freed
47 struct vmemmap_remap_walk {
48 void (*remap_pte)(pte_t *pte, unsigned long addr,
49 struct vmemmap_remap_walk *walk);
50 unsigned long nr_walked;
51 struct page *reuse_page;
52 unsigned long reuse_addr;
53 struct list_head *vmemmap_pages;
56 static int split_vmemmap_huge_pmd(pmd_t *pmd, unsigned long start,
57 struct vmemmap_remap_walk *walk)
61 unsigned long addr = start;
62 struct page *page = pmd_page(*pmd);
63 pte_t *pgtable = pte_alloc_one_kernel(&init_mm);
68 pmd_populate_kernel(&init_mm, &__pmd, pgtable);
70 for (i = 0; i < PMD_SIZE / PAGE_SIZE; i++, addr += PAGE_SIZE) {
72 pgprot_t pgprot = PAGE_KERNEL;
74 entry = mk_pte(page + i, pgprot);
75 pte = pte_offset_kernel(&__pmd, addr);
76 set_pte_at(&init_mm, addr, pte, entry);
79 /* Make pte visible before pmd. See comment in pmd_install(). */
81 pmd_populate_kernel(&init_mm, pmd, pgtable);
83 flush_tlb_kernel_range(start, start + PMD_SIZE);
88 static void vmemmap_pte_range(pmd_t *pmd, unsigned long addr,
90 struct vmemmap_remap_walk *walk)
92 pte_t *pte = pte_offset_kernel(pmd, addr);
95 * The reuse_page is found 'first' in table walk before we start
96 * remapping (which is calling @walk->remap_pte).
98 if (!walk->reuse_page) {
99 walk->reuse_page = pte_page(*pte);
101 * Because the reuse address is part of the range that we are
102 * walking, skip the reuse address range.
109 for (; addr != end; addr += PAGE_SIZE, pte++) {
110 walk->remap_pte(pte, addr, walk);
115 static int vmemmap_pmd_range(pud_t *pud, unsigned long addr,
117 struct vmemmap_remap_walk *walk)
122 pmd = pmd_offset(pud, addr);
124 if (pmd_leaf(*pmd)) {
127 ret = split_vmemmap_huge_pmd(pmd, addr & PMD_MASK, walk);
131 next = pmd_addr_end(addr, end);
132 vmemmap_pte_range(pmd, addr, next, walk);
133 } while (pmd++, addr = next, addr != end);
138 static int vmemmap_pud_range(p4d_t *p4d, unsigned long addr,
140 struct vmemmap_remap_walk *walk)
145 pud = pud_offset(p4d, addr);
149 next = pud_addr_end(addr, end);
150 ret = vmemmap_pmd_range(pud, addr, next, walk);
153 } while (pud++, addr = next, addr != end);
158 static int vmemmap_p4d_range(pgd_t *pgd, unsigned long addr,
160 struct vmemmap_remap_walk *walk)
165 p4d = p4d_offset(pgd, addr);
169 next = p4d_addr_end(addr, end);
170 ret = vmemmap_pud_range(p4d, addr, next, walk);
173 } while (p4d++, addr = next, addr != end);
178 static int vmemmap_remap_range(unsigned long start, unsigned long end,
179 struct vmemmap_remap_walk *walk)
181 unsigned long addr = start;
185 VM_BUG_ON(!IS_ALIGNED(start, PAGE_SIZE));
186 VM_BUG_ON(!IS_ALIGNED(end, PAGE_SIZE));
188 pgd = pgd_offset_k(addr);
192 next = pgd_addr_end(addr, end);
193 ret = vmemmap_p4d_range(pgd, addr, next, walk);
196 } while (pgd++, addr = next, addr != end);
199 * We only change the mapping of the vmemmap virtual address range
200 * [@start + PAGE_SIZE, end), so we only need to flush the TLB which
201 * belongs to the range.
203 flush_tlb_kernel_range(start + PAGE_SIZE, end);
209 * Free a vmemmap page. A vmemmap page can be allocated from the memblock
210 * allocator or buddy allocator. If the PG_reserved flag is set, it means
211 * that it allocated from the memblock allocator, just free it via the
212 * free_bootmem_page(). Otherwise, use __free_page().
214 static inline void free_vmemmap_page(struct page *page)
216 if (PageReserved(page))
217 free_bootmem_page(page);
222 /* Free a list of the vmemmap pages */
223 static void free_vmemmap_page_list(struct list_head *list)
225 struct page *page, *next;
227 list_for_each_entry_safe(page, next, list, lru) {
228 list_del(&page->lru);
229 free_vmemmap_page(page);
233 static void vmemmap_remap_pte(pte_t *pte, unsigned long addr,
234 struct vmemmap_remap_walk *walk)
237 * Remap the tail pages as read-only to catch illegal write operation
240 pgprot_t pgprot = PAGE_KERNEL_RO;
241 pte_t entry = mk_pte(walk->reuse_page, pgprot);
242 struct page *page = pte_page(*pte);
244 list_add_tail(&page->lru, walk->vmemmap_pages);
245 set_pte_at(&init_mm, addr, pte, entry);
249 * How many struct page structs need to be reset. When we reuse the head
250 * struct page, the special metadata (e.g. page->flags or page->mapping)
251 * cannot copy to the tail struct page structs. The invalid value will be
252 * checked in the free_tail_pages_check(). In order to avoid the message
253 * of "corrupted mapping in tail page". We need to reset at least 3 (one
254 * head struct page struct and two tail struct page structs) struct page
257 #define NR_RESET_STRUCT_PAGE 3
259 static inline void reset_struct_pages(struct page *start)
262 struct page *from = start + NR_RESET_STRUCT_PAGE;
264 for (i = 0; i < NR_RESET_STRUCT_PAGE; i++)
265 memcpy(start + i, from, sizeof(*from));
268 static void vmemmap_restore_pte(pte_t *pte, unsigned long addr,
269 struct vmemmap_remap_walk *walk)
271 pgprot_t pgprot = PAGE_KERNEL;
275 BUG_ON(pte_page(*pte) != walk->reuse_page);
277 page = list_first_entry(walk->vmemmap_pages, struct page, lru);
278 list_del(&page->lru);
279 to = page_to_virt(page);
280 copy_page(to, (void *)walk->reuse_addr);
281 reset_struct_pages(to);
283 set_pte_at(&init_mm, addr, pte, mk_pte(page, pgprot));
287 * vmemmap_remap_free - remap the vmemmap virtual address range [@start, @end)
288 * to the page which @reuse is mapped to, then free vmemmap
289 * which the range are mapped to.
290 * @start: start address of the vmemmap virtual address range that we want
292 * @end: end address of the vmemmap virtual address range that we want to
294 * @reuse: reuse address.
296 * Return: %0 on success, negative error code otherwise.
298 int vmemmap_remap_free(unsigned long start, unsigned long end,
302 LIST_HEAD(vmemmap_pages);
303 struct vmemmap_remap_walk walk = {
304 .remap_pte = vmemmap_remap_pte,
306 .vmemmap_pages = &vmemmap_pages,
310 * In order to make remapping routine most efficient for the huge pages,
311 * the routine of vmemmap page table walking has the following rules
312 * (see more details from the vmemmap_pte_range()):
314 * - The range [@start, @end) and the range [@reuse, @reuse + PAGE_SIZE)
315 * should be continuous.
316 * - The @reuse address is part of the range [@reuse, @end) that we are
317 * walking which is passed to vmemmap_remap_range().
318 * - The @reuse address is the first in the complete range.
320 * So we need to make sure that @start and @reuse meet the above rules.
322 BUG_ON(start - reuse != PAGE_SIZE);
324 mmap_write_lock(&init_mm);
325 ret = vmemmap_remap_range(reuse, end, &walk);
326 mmap_write_downgrade(&init_mm);
328 if (ret && walk.nr_walked) {
329 end = reuse + walk.nr_walked * PAGE_SIZE;
331 * vmemmap_pages contains pages from the previous
332 * vmemmap_remap_range call which failed. These
333 * are pages which were removed from the vmemmap.
334 * They will be restored in the following call.
336 walk = (struct vmemmap_remap_walk) {
337 .remap_pte = vmemmap_restore_pte,
339 .vmemmap_pages = &vmemmap_pages,
342 vmemmap_remap_range(reuse, end, &walk);
344 mmap_read_unlock(&init_mm);
346 free_vmemmap_page_list(&vmemmap_pages);
351 static int alloc_vmemmap_page_list(unsigned long start, unsigned long end,
352 gfp_t gfp_mask, struct list_head *list)
354 unsigned long nr_pages = (end - start) >> PAGE_SHIFT;
355 int nid = page_to_nid((struct page *)start);
356 struct page *page, *next;
359 page = alloc_pages_node(nid, gfp_mask, 0);
362 list_add_tail(&page->lru, list);
367 list_for_each_entry_safe(page, next, list, lru)
368 __free_pages(page, 0);
373 * vmemmap_remap_alloc - remap the vmemmap virtual address range [@start, end)
374 * to the page which is from the @vmemmap_pages
376 * @start: start address of the vmemmap virtual address range that we want
378 * @end: end address of the vmemmap virtual address range that we want to
380 * @reuse: reuse address.
381 * @gfp_mask: GFP flag for allocating vmemmap pages.
383 * Return: %0 on success, negative error code otherwise.
385 int vmemmap_remap_alloc(unsigned long start, unsigned long end,
386 unsigned long reuse, gfp_t gfp_mask)
388 LIST_HEAD(vmemmap_pages);
389 struct vmemmap_remap_walk walk = {
390 .remap_pte = vmemmap_restore_pte,
392 .vmemmap_pages = &vmemmap_pages,
395 /* See the comment in the vmemmap_remap_free(). */
396 BUG_ON(start - reuse != PAGE_SIZE);
398 if (alloc_vmemmap_page_list(start, end, gfp_mask, &vmemmap_pages))
401 mmap_read_lock(&init_mm);
402 vmemmap_remap_range(reuse, end, &walk);
403 mmap_read_unlock(&init_mm);
409 * Allocate a block of memory to be used to back the virtual memory map
410 * or to back the page tables that are used to create the mapping.
411 * Uses the main allocators if they are available, else bootmem.
414 static void * __ref __earlyonly_bootmem_alloc(int node,
419 return memblock_alloc_try_nid_raw(size, align, goal,
420 MEMBLOCK_ALLOC_ACCESSIBLE, node);
423 void * __meminit vmemmap_alloc_block(unsigned long size, int node)
425 /* If the main allocator is up use that, fallback to bootmem. */
426 if (slab_is_available()) {
427 gfp_t gfp_mask = GFP_KERNEL|__GFP_RETRY_MAYFAIL|__GFP_NOWARN;
428 int order = get_order(size);
432 page = alloc_pages_node(node, gfp_mask, order);
434 return page_address(page);
437 warn_alloc(gfp_mask & ~__GFP_NOWARN, NULL,
438 "vmemmap alloc failure: order:%u", order);
443 return __earlyonly_bootmem_alloc(node, size, size,
444 __pa(MAX_DMA_ADDRESS));
447 static void * __meminit altmap_alloc_block_buf(unsigned long size,
448 struct vmem_altmap *altmap);
450 /* need to make sure size is all the same during early stage */
451 void * __meminit vmemmap_alloc_block_buf(unsigned long size, int node,
452 struct vmem_altmap *altmap)
457 return altmap_alloc_block_buf(size, altmap);
459 ptr = sparse_buffer_alloc(size);
461 ptr = vmemmap_alloc_block(size, node);
465 static unsigned long __meminit vmem_altmap_next_pfn(struct vmem_altmap *altmap)
467 return altmap->base_pfn + altmap->reserve + altmap->alloc
471 static unsigned long __meminit vmem_altmap_nr_free(struct vmem_altmap *altmap)
473 unsigned long allocated = altmap->alloc + altmap->align;
475 if (altmap->free > allocated)
476 return altmap->free - allocated;
480 static void * __meminit altmap_alloc_block_buf(unsigned long size,
481 struct vmem_altmap *altmap)
483 unsigned long pfn, nr_pfns, nr_align;
485 if (size & ~PAGE_MASK) {
486 pr_warn_once("%s: allocations must be multiple of PAGE_SIZE (%ld)\n",
491 pfn = vmem_altmap_next_pfn(altmap);
492 nr_pfns = size >> PAGE_SHIFT;
493 nr_align = 1UL << find_first_bit(&nr_pfns, BITS_PER_LONG);
494 nr_align = ALIGN(pfn, nr_align) - pfn;
495 if (nr_pfns + nr_align > vmem_altmap_nr_free(altmap))
498 altmap->alloc += nr_pfns;
499 altmap->align += nr_align;
502 pr_debug("%s: pfn: %#lx alloc: %ld align: %ld nr: %#lx\n",
503 __func__, pfn, altmap->alloc, altmap->align, nr_pfns);
504 return __va(__pfn_to_phys(pfn));
507 void __meminit vmemmap_verify(pte_t *pte, int node,
508 unsigned long start, unsigned long end)
510 unsigned long pfn = pte_pfn(*pte);
511 int actual_node = early_pfn_to_nid(pfn);
513 if (node_distance(actual_node, node) > LOCAL_DISTANCE)
514 pr_warn("[%lx-%lx] potential offnode page_structs\n",
518 pte_t * __meminit vmemmap_pte_populate(pmd_t *pmd, unsigned long addr, int node,
519 struct vmem_altmap *altmap)
521 pte_t *pte = pte_offset_kernel(pmd, addr);
522 if (pte_none(*pte)) {
526 p = vmemmap_alloc_block_buf(PAGE_SIZE, node, altmap);
529 entry = pfn_pte(__pa(p) >> PAGE_SHIFT, PAGE_KERNEL);
530 set_pte_at(&init_mm, addr, pte, entry);
535 static void * __meminit vmemmap_alloc_block_zero(unsigned long size, int node)
537 void *p = vmemmap_alloc_block(size, node);
546 pmd_t * __meminit vmemmap_pmd_populate(pud_t *pud, unsigned long addr, int node)
548 pmd_t *pmd = pmd_offset(pud, addr);
549 if (pmd_none(*pmd)) {
550 void *p = vmemmap_alloc_block_zero(PAGE_SIZE, node);
553 pmd_populate_kernel(&init_mm, pmd, p);
558 pud_t * __meminit vmemmap_pud_populate(p4d_t *p4d, unsigned long addr, int node)
560 pud_t *pud = pud_offset(p4d, addr);
561 if (pud_none(*pud)) {
562 void *p = vmemmap_alloc_block_zero(PAGE_SIZE, node);
565 pud_populate(&init_mm, pud, p);
570 p4d_t * __meminit vmemmap_p4d_populate(pgd_t *pgd, unsigned long addr, int node)
572 p4d_t *p4d = p4d_offset(pgd, addr);
573 if (p4d_none(*p4d)) {
574 void *p = vmemmap_alloc_block_zero(PAGE_SIZE, node);
577 p4d_populate(&init_mm, p4d, p);
582 pgd_t * __meminit vmemmap_pgd_populate(unsigned long addr, int node)
584 pgd_t *pgd = pgd_offset_k(addr);
585 if (pgd_none(*pgd)) {
586 void *p = vmemmap_alloc_block_zero(PAGE_SIZE, node);
589 pgd_populate(&init_mm, pgd, p);
594 int __meminit vmemmap_populate_basepages(unsigned long start, unsigned long end,
595 int node, struct vmem_altmap *altmap)
597 unsigned long addr = start;
604 for (; addr < end; addr += PAGE_SIZE) {
605 pgd = vmemmap_pgd_populate(addr, node);
608 p4d = vmemmap_p4d_populate(pgd, addr, node);
611 pud = vmemmap_pud_populate(p4d, addr, node);
614 pmd = vmemmap_pmd_populate(pud, addr, node);
617 pte = vmemmap_pte_populate(pmd, addr, node, altmap);
620 vmemmap_verify(pte, node, addr, addr + PAGE_SIZE);
626 struct page * __meminit __populate_section_memmap(unsigned long pfn,
627 unsigned long nr_pages, int nid, struct vmem_altmap *altmap)
629 unsigned long start = (unsigned long) pfn_to_page(pfn);
630 unsigned long end = start + nr_pages * sizeof(struct page);
632 if (WARN_ON_ONCE(!IS_ALIGNED(pfn, PAGES_PER_SUBSECTION) ||
633 !IS_ALIGNED(nr_pages, PAGES_PER_SUBSECTION)))
636 if (vmemmap_populate(start, end, nid, altmap))
639 return pfn_to_page(pfn);