1 // SPDX-License-Identifier: GPL-2.0
3 * High memory handling common code and variables.
5 * (C) 1999 Andrea Arcangeli, SuSE GmbH, andrea@suse.de
6 * Gerhard Wichert, Siemens AG, Gerhard.Wichert@pdb.siemens.de
9 * Redesigned the x86 32-bit VM architecture to deal with
10 * 64-bit physical space. With current x86 CPUs this
11 * means up to 64 Gigabytes physical RAM.
13 * Rewrote high memory support to move the page cache into
14 * high memory. Implemented permanent (schedulable) kmaps
15 * based on Linus' idea.
17 * Copyright (C) 1999 Ingo Molnar <mingo@redhat.com>
21 #include <linux/export.h>
22 #include <linux/swap.h>
23 #include <linux/bio.h>
24 #include <linux/pagemap.h>
25 #include <linux/mempool.h>
26 #include <linux/init.h>
27 #include <linux/hash.h>
28 #include <linux/highmem.h>
29 #include <linux/kgdb.h>
30 #include <asm/tlbflush.h>
31 #include <linux/vmalloc.h>
33 #ifdef CONFIG_KMAP_LOCAL
34 static inline int kmap_local_calc_idx(int idx)
36 return idx + KM_MAX_IDX * smp_processor_id();
39 #ifndef arch_kmap_local_map_idx
40 #define arch_kmap_local_map_idx(idx, pfn) kmap_local_calc_idx(idx)
42 #endif /* CONFIG_KMAP_LOCAL */
45 * Virtual_count is not a pure "count".
46 * 0 means that it is not mapped, and has not been mapped
47 * since a TLB flush - it is usable.
48 * 1 means that there are no users, but it has been mapped
49 * since the last TLB flush - so we can't use it.
50 * n means that there are (n-1) current users of it.
55 * Architecture with aliasing data cache may define the following family of
56 * helper functions in its asm/highmem.h to control cache color of virtual
57 * addresses where physical memory pages are mapped by kmap.
59 #ifndef get_pkmap_color
62 * Determine color of virtual address where the page should be mapped.
64 static inline unsigned int get_pkmap_color(struct page *page)
68 #define get_pkmap_color get_pkmap_color
71 * Get next index for mapping inside PKMAP region for page with given color.
73 static inline unsigned int get_next_pkmap_nr(unsigned int color)
75 static unsigned int last_pkmap_nr;
77 last_pkmap_nr = (last_pkmap_nr + 1) & LAST_PKMAP_MASK;
82 * Determine if page index inside PKMAP region (pkmap_nr) of given color
83 * has wrapped around PKMAP region end. When this happens an attempt to
84 * flush all unused PKMAP slots is made.
86 static inline int no_more_pkmaps(unsigned int pkmap_nr, unsigned int color)
92 * Get the number of PKMAP entries of the given color. If no free slot is
93 * found after checking that many entries, kmap will sleep waiting for
94 * someone to call kunmap and free PKMAP slot.
96 static inline int get_pkmap_entries_count(unsigned int color)
102 * Get head of a wait queue for PKMAP entries of the given color.
103 * Wait queues for different mapping colors should be independent to avoid
104 * unnecessary wakeups caused by freeing of slots of other colors.
106 static inline wait_queue_head_t *get_pkmap_wait_queue_head(unsigned int color)
108 static DECLARE_WAIT_QUEUE_HEAD(pkmap_map_wait);
110 return &pkmap_map_wait;
114 atomic_long_t _totalhigh_pages __read_mostly;
115 EXPORT_SYMBOL(_totalhigh_pages);
117 unsigned int __nr_free_highpages(void)
120 unsigned int pages = 0;
122 for_each_populated_zone(zone) {
123 if (is_highmem(zone))
124 pages += zone_page_state(zone, NR_FREE_PAGES);
130 static int pkmap_count[LAST_PKMAP];
131 static __cacheline_aligned_in_smp DEFINE_SPINLOCK(kmap_lock);
133 pte_t *pkmap_page_table;
136 * Most architectures have no use for kmap_high_get(), so let's abstract
137 * the disabling of IRQ out of the locking in that case to save on a
138 * potential useless overhead.
140 #ifdef ARCH_NEEDS_KMAP_HIGH_GET
141 #define lock_kmap() spin_lock_irq(&kmap_lock)
142 #define unlock_kmap() spin_unlock_irq(&kmap_lock)
143 #define lock_kmap_any(flags) spin_lock_irqsave(&kmap_lock, flags)
144 #define unlock_kmap_any(flags) spin_unlock_irqrestore(&kmap_lock, flags)
146 #define lock_kmap() spin_lock(&kmap_lock)
147 #define unlock_kmap() spin_unlock(&kmap_lock)
148 #define lock_kmap_any(flags) \
149 do { spin_lock(&kmap_lock); (void)(flags); } while (0)
150 #define unlock_kmap_any(flags) \
151 do { spin_unlock(&kmap_lock); (void)(flags); } while (0)
154 struct page *__kmap_to_page(void *vaddr)
156 unsigned long base = (unsigned long) vaddr & PAGE_MASK;
157 struct kmap_ctrl *kctrl = ¤t->kmap_ctrl;
158 unsigned long addr = (unsigned long)vaddr;
161 /* kmap() mappings */
162 if (WARN_ON_ONCE(addr >= PKMAP_ADDR(0) &&
163 addr < PKMAP_ADDR(LAST_PKMAP)))
164 return pte_page(pkmap_page_table[PKMAP_NR(addr)]);
166 /* kmap_local_page() mappings */
167 if (WARN_ON_ONCE(base >= __fix_to_virt(FIX_KMAP_END) &&
168 base < __fix_to_virt(FIX_KMAP_BEGIN))) {
169 for (i = 0; i < kctrl->idx; i++) {
170 unsigned long base_addr;
173 idx = arch_kmap_local_map_idx(i, pte_pfn(pteval));
174 base_addr = __fix_to_virt(FIX_KMAP_BEGIN + idx);
176 if (base_addr == base)
177 return pte_page(kctrl->pteval[i]);
181 return virt_to_page(vaddr);
183 EXPORT_SYMBOL(__kmap_to_page);
185 static void flush_all_zero_pkmaps(void)
192 for (i = 0; i < LAST_PKMAP; i++) {
196 * zero means we don't have anything to do,
197 * >1 means that it is still in use. Only
198 * a count of 1 means that it is free but
199 * needs to be unmapped
201 if (pkmap_count[i] != 1)
206 BUG_ON(pte_none(pkmap_page_table[i]));
209 * Don't need an atomic fetch-and-clear op here;
210 * no-one has the page mapped, and cannot get at
211 * its virtual address (and hence PTE) without first
212 * getting the kmap_lock (which is held here).
213 * So no dangers, even with speculative execution.
215 page = pte_page(pkmap_page_table[i]);
216 pte_clear(&init_mm, PKMAP_ADDR(i), &pkmap_page_table[i]);
218 set_page_address(page, NULL);
222 flush_tlb_kernel_range(PKMAP_ADDR(0), PKMAP_ADDR(LAST_PKMAP));
225 void __kmap_flush_unused(void)
228 flush_all_zero_pkmaps();
232 static inline unsigned long map_new_virtual(struct page *page)
236 unsigned int last_pkmap_nr;
237 unsigned int color = get_pkmap_color(page);
240 count = get_pkmap_entries_count(color);
241 /* Find an empty entry */
243 last_pkmap_nr = get_next_pkmap_nr(color);
244 if (no_more_pkmaps(last_pkmap_nr, color)) {
245 flush_all_zero_pkmaps();
246 count = get_pkmap_entries_count(color);
248 if (!pkmap_count[last_pkmap_nr])
249 break; /* Found a usable entry */
254 * Sleep for somebody else to unmap their entries
257 DECLARE_WAITQUEUE(wait, current);
258 wait_queue_head_t *pkmap_map_wait =
259 get_pkmap_wait_queue_head(color);
261 __set_current_state(TASK_UNINTERRUPTIBLE);
262 add_wait_queue(pkmap_map_wait, &wait);
265 remove_wait_queue(pkmap_map_wait, &wait);
268 /* Somebody else might have mapped it while we slept */
269 if (page_address(page))
270 return (unsigned long)page_address(page);
276 vaddr = PKMAP_ADDR(last_pkmap_nr);
277 set_pte_at(&init_mm, vaddr,
278 &(pkmap_page_table[last_pkmap_nr]), mk_pte(page, kmap_prot));
280 pkmap_count[last_pkmap_nr] = 1;
281 set_page_address(page, (void *)vaddr);
287 * kmap_high - map a highmem page into memory
288 * @page: &struct page to map
290 * Returns the page's virtual memory address.
292 * We cannot call this from interrupts, as it may block.
294 void *kmap_high(struct page *page)
299 * For highmem pages, we can't trust "virtual" until
300 * after we have the lock.
303 vaddr = (unsigned long)page_address(page);
305 vaddr = map_new_virtual(page);
306 pkmap_count[PKMAP_NR(vaddr)]++;
307 BUG_ON(pkmap_count[PKMAP_NR(vaddr)] < 2);
309 return (void *) vaddr;
311 EXPORT_SYMBOL(kmap_high);
313 #ifdef ARCH_NEEDS_KMAP_HIGH_GET
315 * kmap_high_get - pin a highmem page into memory
316 * @page: &struct page to pin
318 * Returns the page's current virtual memory address, or NULL if no mapping
319 * exists. If and only if a non null address is returned then a
320 * matching call to kunmap_high() is necessary.
322 * This can be called from any context.
324 void *kmap_high_get(struct page *page)
326 unsigned long vaddr, flags;
328 lock_kmap_any(flags);
329 vaddr = (unsigned long)page_address(page);
331 BUG_ON(pkmap_count[PKMAP_NR(vaddr)] < 1);
332 pkmap_count[PKMAP_NR(vaddr)]++;
334 unlock_kmap_any(flags);
335 return (void *) vaddr;
340 * kunmap_high - unmap a highmem page into memory
341 * @page: &struct page to unmap
343 * If ARCH_NEEDS_KMAP_HIGH_GET is not defined then this may be called
344 * only from user context.
346 void kunmap_high(struct page *page)
352 unsigned int color = get_pkmap_color(page);
353 wait_queue_head_t *pkmap_map_wait;
355 lock_kmap_any(flags);
356 vaddr = (unsigned long)page_address(page);
358 nr = PKMAP_NR(vaddr);
361 * A count must never go down to zero
362 * without a TLB flush!
365 switch (--pkmap_count[nr]) {
370 * Avoid an unnecessary wake_up() function call.
371 * The common case is pkmap_count[] == 1, but
373 * The tasks queued in the wait-queue are guarded
374 * by both the lock in the wait-queue-head and by
375 * the kmap_lock. As the kmap_lock is held here,
376 * no need for the wait-queue-head's lock. Simply
377 * test if the queue is empty.
379 pkmap_map_wait = get_pkmap_wait_queue_head(color);
380 need_wakeup = waitqueue_active(pkmap_map_wait);
382 unlock_kmap_any(flags);
384 /* do wake-up, if needed, race-free outside of the spin lock */
386 wake_up(pkmap_map_wait);
388 EXPORT_SYMBOL(kunmap_high);
390 void zero_user_segments(struct page *page, unsigned start1, unsigned end1,
391 unsigned start2, unsigned end2)
395 BUG_ON(end1 > page_size(page) || end2 > page_size(page));
402 for (i = 0; i < compound_nr(page); i++) {
405 if (start1 >= PAGE_SIZE) {
409 unsigned this_end = min_t(unsigned, end1, PAGE_SIZE);
412 kaddr = kmap_local_page(page + i);
413 memset(kaddr + start1, 0, this_end - start1);
419 if (start2 >= PAGE_SIZE) {
423 unsigned this_end = min_t(unsigned, end2, PAGE_SIZE);
427 kaddr = kmap_local_page(page + i);
428 memset(kaddr + start2, 0, this_end - start2);
436 flush_dcache_page(page + i);
443 BUG_ON((start1 | start2 | end1 | end2) != 0);
445 EXPORT_SYMBOL(zero_user_segments);
446 #endif /* CONFIG_HIGHMEM */
448 #ifdef CONFIG_KMAP_LOCAL
450 #include <asm/kmap_size.h>
453 * With DEBUG_KMAP_LOCAL the stack depth is doubled and every second
454 * slot is unused which acts as a guard page
456 #ifdef CONFIG_DEBUG_KMAP_LOCAL
462 static inline int kmap_local_idx_push(void)
464 WARN_ON_ONCE(in_hardirq() && !irqs_disabled());
465 current->kmap_ctrl.idx += KM_INCR;
466 BUG_ON(current->kmap_ctrl.idx >= KM_MAX_IDX);
467 return current->kmap_ctrl.idx - 1;
470 static inline int kmap_local_idx(void)
472 return current->kmap_ctrl.idx - 1;
475 static inline void kmap_local_idx_pop(void)
477 current->kmap_ctrl.idx -= KM_INCR;
478 BUG_ON(current->kmap_ctrl.idx < 0);
481 #ifndef arch_kmap_local_post_map
482 # define arch_kmap_local_post_map(vaddr, pteval) do { } while (0)
485 #ifndef arch_kmap_local_pre_unmap
486 # define arch_kmap_local_pre_unmap(vaddr) do { } while (0)
489 #ifndef arch_kmap_local_post_unmap
490 # define arch_kmap_local_post_unmap(vaddr) do { } while (0)
493 #ifndef arch_kmap_local_unmap_idx
494 #define arch_kmap_local_unmap_idx(idx, vaddr) kmap_local_calc_idx(idx)
497 #ifndef arch_kmap_local_high_get
498 static inline void *arch_kmap_local_high_get(struct page *page)
504 #ifndef arch_kmap_local_set_pte
505 #define arch_kmap_local_set_pte(mm, vaddr, ptep, ptev) \
506 set_pte_at(mm, vaddr, ptep, ptev)
509 /* Unmap a local mapping which was obtained by kmap_high_get() */
510 static inline bool kmap_high_unmap_local(unsigned long vaddr)
512 #ifdef ARCH_NEEDS_KMAP_HIGH_GET
513 if (vaddr >= PKMAP_ADDR(0) && vaddr < PKMAP_ADDR(LAST_PKMAP)) {
514 kunmap_high(pte_page(pkmap_page_table[PKMAP_NR(vaddr)]));
521 static pte_t *__kmap_pte;
523 static pte_t *kmap_get_pte(unsigned long vaddr, int idx)
525 if (IS_ENABLED(CONFIG_KMAP_LOCAL_NON_LINEAR_PTE_ARRAY))
527 * Set by the arch if __kmap_pte[-idx] does not produce
530 return virt_to_kpte(vaddr);
532 __kmap_pte = virt_to_kpte(__fix_to_virt(FIX_KMAP_BEGIN));
533 return &__kmap_pte[-idx];
536 void *__kmap_local_pfn_prot(unsigned long pfn, pgprot_t prot)
538 pte_t pteval, *kmap_pte;
543 * Disable migration so resulting virtual address is stable
548 idx = arch_kmap_local_map_idx(kmap_local_idx_push(), pfn);
549 vaddr = __fix_to_virt(FIX_KMAP_BEGIN + idx);
550 kmap_pte = kmap_get_pte(vaddr, idx);
551 BUG_ON(!pte_none(*kmap_pte));
552 pteval = pfn_pte(pfn, prot);
553 arch_kmap_local_set_pte(&init_mm, vaddr, kmap_pte, pteval);
554 arch_kmap_local_post_map(vaddr, pteval);
555 current->kmap_ctrl.pteval[kmap_local_idx()] = pteval;
558 return (void *)vaddr;
560 EXPORT_SYMBOL_GPL(__kmap_local_pfn_prot);
562 void *__kmap_local_page_prot(struct page *page, pgprot_t prot)
567 * To broaden the usage of the actual kmap_local() machinery always map
568 * pages when debugging is enabled and the architecture has no problems
569 * with alias mappings.
571 if (!IS_ENABLED(CONFIG_DEBUG_KMAP_LOCAL_FORCE_MAP) && !PageHighMem(page))
572 return page_address(page);
574 /* Try kmap_high_get() if architecture has it enabled */
575 kmap = arch_kmap_local_high_get(page);
579 return __kmap_local_pfn_prot(page_to_pfn(page), prot);
581 EXPORT_SYMBOL(__kmap_local_page_prot);
583 void kunmap_local_indexed(const void *vaddr)
585 unsigned long addr = (unsigned long) vaddr & PAGE_MASK;
589 if (addr < __fix_to_virt(FIX_KMAP_END) ||
590 addr > __fix_to_virt(FIX_KMAP_BEGIN)) {
591 if (IS_ENABLED(CONFIG_DEBUG_KMAP_LOCAL_FORCE_MAP)) {
592 /* This _should_ never happen! See above. */
597 * Handle mappings which were obtained by kmap_high_get()
598 * first as the virtual address of such mappings is below
599 * PAGE_OFFSET. Warn for all other addresses which are in
600 * the user space part of the virtual address space.
602 if (!kmap_high_unmap_local(addr))
603 WARN_ON_ONCE(addr < PAGE_OFFSET);
608 idx = arch_kmap_local_unmap_idx(kmap_local_idx(), addr);
609 WARN_ON_ONCE(addr != __fix_to_virt(FIX_KMAP_BEGIN + idx));
611 kmap_pte = kmap_get_pte(addr, idx);
612 arch_kmap_local_pre_unmap(addr);
613 pte_clear(&init_mm, addr, kmap_pte);
614 arch_kmap_local_post_unmap(addr);
615 current->kmap_ctrl.pteval[kmap_local_idx()] = __pte(0);
616 kmap_local_idx_pop();
620 EXPORT_SYMBOL(kunmap_local_indexed);
623 * Invoked before switch_to(). This is safe even when during or after
624 * clearing the maps an interrupt which needs a kmap_local happens because
625 * the task::kmap_ctrl.idx is not modified by the unmapping code so a
626 * nested kmap_local will use the next unused index and restore the index
627 * on unmap. The already cleared kmaps of the outgoing task are irrelevant
628 * because the interrupt context does not know about them. The same applies
629 * when scheduling back in for an interrupt which happens before the
630 * restore is complete.
632 void __kmap_local_sched_out(void)
634 struct task_struct *tsk = current;
639 for (i = 0; i < tsk->kmap_ctrl.idx; i++) {
640 pte_t pteval = tsk->kmap_ctrl.pteval[i];
644 /* With debug all even slots are unmapped and act as guard */
645 if (IS_ENABLED(CONFIG_DEBUG_KMAP_LOCAL) && !(i & 0x01)) {
646 WARN_ON_ONCE(pte_val(pteval) != 0);
649 if (WARN_ON_ONCE(pte_none(pteval)))
653 * This is a horrible hack for XTENSA to calculate the
654 * coloured PTE index. Uses the PFN encoded into the pteval
655 * and the map index calculation because the actual mapped
656 * virtual address is not stored in task::kmap_ctrl.
657 * For any sane architecture this is optimized out.
659 idx = arch_kmap_local_map_idx(i, pte_pfn(pteval));
661 addr = __fix_to_virt(FIX_KMAP_BEGIN + idx);
662 kmap_pte = kmap_get_pte(addr, idx);
663 arch_kmap_local_pre_unmap(addr);
664 pte_clear(&init_mm, addr, kmap_pte);
665 arch_kmap_local_post_unmap(addr);
669 void __kmap_local_sched_in(void)
671 struct task_struct *tsk = current;
676 for (i = 0; i < tsk->kmap_ctrl.idx; i++) {
677 pte_t pteval = tsk->kmap_ctrl.pteval[i];
681 /* With debug all even slots are unmapped and act as guard */
682 if (IS_ENABLED(CONFIG_DEBUG_KMAP_LOCAL) && !(i & 0x01)) {
683 WARN_ON_ONCE(pte_val(pteval) != 0);
686 if (WARN_ON_ONCE(pte_none(pteval)))
689 /* See comment in __kmap_local_sched_out() */
690 idx = arch_kmap_local_map_idx(i, pte_pfn(pteval));
691 addr = __fix_to_virt(FIX_KMAP_BEGIN + idx);
692 kmap_pte = kmap_get_pte(addr, idx);
693 set_pte_at(&init_mm, addr, kmap_pte, pteval);
694 arch_kmap_local_post_map(addr, pteval);
698 void kmap_local_fork(struct task_struct *tsk)
700 if (WARN_ON_ONCE(tsk->kmap_ctrl.idx))
701 memset(&tsk->kmap_ctrl, 0, sizeof(tsk->kmap_ctrl));
706 #if defined(HASHED_PAGE_VIRTUAL)
708 #define PA_HASH_ORDER 7
711 * Describes one page->virtual association
713 struct page_address_map {
716 struct list_head list;
719 static struct page_address_map page_address_maps[LAST_PKMAP];
724 static struct page_address_slot {
725 struct list_head lh; /* List of page_address_maps */
726 spinlock_t lock; /* Protect this bucket's list */
727 } ____cacheline_aligned_in_smp page_address_htable[1<<PA_HASH_ORDER];
729 static struct page_address_slot *page_slot(const struct page *page)
731 return &page_address_htable[hash_ptr(page, PA_HASH_ORDER)];
735 * page_address - get the mapped virtual address of a page
736 * @page: &struct page to get the virtual address of
738 * Returns the page's virtual address.
740 void *page_address(const struct page *page)
744 struct page_address_slot *pas;
746 if (!PageHighMem(page))
747 return lowmem_page_address(page);
749 pas = page_slot(page);
751 spin_lock_irqsave(&pas->lock, flags);
752 if (!list_empty(&pas->lh)) {
753 struct page_address_map *pam;
755 list_for_each_entry(pam, &pas->lh, list) {
756 if (pam->page == page) {
763 spin_unlock_irqrestore(&pas->lock, flags);
766 EXPORT_SYMBOL(page_address);
769 * set_page_address - set a page's virtual address
770 * @page: &struct page to set
771 * @virtual: virtual address to use
773 void set_page_address(struct page *page, void *virtual)
776 struct page_address_slot *pas;
777 struct page_address_map *pam;
779 BUG_ON(!PageHighMem(page));
781 pas = page_slot(page);
782 if (virtual) { /* Add */
783 pam = &page_address_maps[PKMAP_NR((unsigned long)virtual)];
785 pam->virtual = virtual;
787 spin_lock_irqsave(&pas->lock, flags);
788 list_add_tail(&pam->list, &pas->lh);
789 spin_unlock_irqrestore(&pas->lock, flags);
790 } else { /* Remove */
791 spin_lock_irqsave(&pas->lock, flags);
792 list_for_each_entry(pam, &pas->lh, list) {
793 if (pam->page == page) {
794 list_del(&pam->list);
798 spin_unlock_irqrestore(&pas->lock, flags);
804 void __init page_address_init(void)
808 for (i = 0; i < ARRAY_SIZE(page_address_htable); i++) {
809 INIT_LIST_HEAD(&page_address_htable[i].lh);
810 spin_lock_init(&page_address_htable[i].lock);
814 #endif /* defined(HASHED_PAGE_VIRTUAL) */