2 * Copyright 2013 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * Authors: Jérôme Glisse <jglisse@redhat.com>
17 * Refer to include/linux/hmm.h for information about heterogeneous memory
18 * management or HMM for short.
21 #include <linux/hmm.h>
22 #include <linux/init.h>
23 #include <linux/rmap.h>
24 #include <linux/swap.h>
25 #include <linux/slab.h>
26 #include <linux/sched.h>
27 #include <linux/mmzone.h>
28 #include <linux/pagemap.h>
29 #include <linux/swapops.h>
30 #include <linux/hugetlb.h>
31 #include <linux/memremap.h>
32 #include <linux/jump_label.h>
33 #include <linux/mmu_notifier.h>
34 #include <linux/memory_hotplug.h>
36 #define PA_SECTION_SIZE (1UL << PA_SECTION_SHIFT)
38 #if defined(CONFIG_DEVICE_PRIVATE) || defined(CONFIG_DEVICE_PUBLIC)
40 * Device private memory see HMM (Documentation/vm/hmm.txt) or hmm.h
42 DEFINE_STATIC_KEY_FALSE(device_private_key);
43 EXPORT_SYMBOL(device_private_key);
44 #endif /* CONFIG_DEVICE_PRIVATE || CONFIG_DEVICE_PUBLIC */
47 #if IS_ENABLED(CONFIG_HMM_MIRROR)
48 static const struct mmu_notifier_ops hmm_mmu_notifier_ops;
51 * struct hmm - HMM per mm struct
53 * @mm: mm struct this HMM struct is bound to
54 * @lock: lock protecting ranges list
55 * @sequence: we track updates to the CPU page table with a sequence number
56 * @ranges: list of range being snapshotted
57 * @mirrors: list of mirrors for this mm
58 * @mmu_notifier: mmu notifier to track updates to CPU page table
59 * @mirrors_sem: read/write semaphore protecting the mirrors list
65 struct list_head ranges;
66 struct list_head mirrors;
67 struct mmu_notifier mmu_notifier;
68 struct rw_semaphore mirrors_sem;
72 * hmm_register - register HMM against an mm (HMM internal)
74 * @mm: mm struct to attach to
76 * This is not intended to be used directly by device drivers. It allocates an
77 * HMM struct if mm does not have one, and initializes it.
79 static struct hmm *hmm_register(struct mm_struct *mm)
81 struct hmm *hmm = READ_ONCE(mm->hmm);
85 * The hmm struct can only be freed once the mm_struct goes away,
86 * hence we should always have pre-allocated an new hmm struct
92 hmm = kmalloc(sizeof(*hmm), GFP_KERNEL);
95 INIT_LIST_HEAD(&hmm->mirrors);
96 init_rwsem(&hmm->mirrors_sem);
97 atomic_set(&hmm->sequence, 0);
98 hmm->mmu_notifier.ops = NULL;
99 INIT_LIST_HEAD(&hmm->ranges);
100 spin_lock_init(&hmm->lock);
104 * We should only get here if hold the mmap_sem in write mode ie on
105 * registration of first mirror through hmm_mirror_register()
107 hmm->mmu_notifier.ops = &hmm_mmu_notifier_ops;
108 if (__mmu_notifier_register(&hmm->mmu_notifier, mm)) {
113 spin_lock(&mm->page_table_lock);
118 spin_unlock(&mm->page_table_lock);
121 mmu_notifier_unregister(&hmm->mmu_notifier, mm);
128 void hmm_mm_destroy(struct mm_struct *mm)
133 static void hmm_invalidate_range(struct hmm *hmm,
134 enum hmm_update_type action,
138 struct hmm_mirror *mirror;
139 struct hmm_range *range;
141 spin_lock(&hmm->lock);
142 list_for_each_entry(range, &hmm->ranges, list) {
143 unsigned long addr, idx, npages;
145 if (end < range->start || start >= range->end)
148 range->valid = false;
149 addr = max(start, range->start);
150 idx = (addr - range->start) >> PAGE_SHIFT;
151 npages = (min(range->end, end) - addr) >> PAGE_SHIFT;
152 memset(&range->pfns[idx], 0, sizeof(*range->pfns) * npages);
154 spin_unlock(&hmm->lock);
156 down_read(&hmm->mirrors_sem);
157 list_for_each_entry(mirror, &hmm->mirrors, list)
158 mirror->ops->sync_cpu_device_pagetables(mirror, action,
160 up_read(&hmm->mirrors_sem);
163 static void hmm_release(struct mmu_notifier *mn, struct mm_struct *mm)
165 struct hmm_mirror *mirror;
166 struct hmm *hmm = mm->hmm;
168 down_write(&hmm->mirrors_sem);
169 mirror = list_first_entry_or_null(&hmm->mirrors, struct hmm_mirror,
172 list_del_init(&mirror->list);
173 if (mirror->ops->release) {
175 * Drop mirrors_sem so callback can wait on any pending
176 * work that might itself trigger mmu_notifier callback
177 * and thus would deadlock with us.
179 up_write(&hmm->mirrors_sem);
180 mirror->ops->release(mirror);
181 down_write(&hmm->mirrors_sem);
183 mirror = list_first_entry_or_null(&hmm->mirrors,
184 struct hmm_mirror, list);
186 up_write(&hmm->mirrors_sem);
189 static void hmm_invalidate_range_start(struct mmu_notifier *mn,
190 struct mm_struct *mm,
194 struct hmm *hmm = mm->hmm;
198 atomic_inc(&hmm->sequence);
201 static void hmm_invalidate_range_end(struct mmu_notifier *mn,
202 struct mm_struct *mm,
206 struct hmm *hmm = mm->hmm;
210 hmm_invalidate_range(mm->hmm, HMM_UPDATE_INVALIDATE, start, end);
213 static const struct mmu_notifier_ops hmm_mmu_notifier_ops = {
214 .release = hmm_release,
215 .invalidate_range_start = hmm_invalidate_range_start,
216 .invalidate_range_end = hmm_invalidate_range_end,
220 * hmm_mirror_register() - register a mirror against an mm
222 * @mirror: new mirror struct to register
223 * @mm: mm to register against
225 * To start mirroring a process address space, the device driver must register
226 * an HMM mirror struct.
228 * THE mm->mmap_sem MUST BE HELD IN WRITE MODE !
230 int hmm_mirror_register(struct hmm_mirror *mirror, struct mm_struct *mm)
233 if (!mm || !mirror || !mirror->ops)
236 mirror->hmm = hmm_register(mm);
240 down_write(&mirror->hmm->mirrors_sem);
241 list_add(&mirror->list, &mirror->hmm->mirrors);
242 up_write(&mirror->hmm->mirrors_sem);
246 EXPORT_SYMBOL(hmm_mirror_register);
249 * hmm_mirror_unregister() - unregister a mirror
251 * @mirror: new mirror struct to register
253 * Stop mirroring a process address space, and cleanup.
255 void hmm_mirror_unregister(struct hmm_mirror *mirror)
257 struct hmm *hmm = mirror->hmm;
259 down_write(&hmm->mirrors_sem);
260 list_del_init(&mirror->list);
261 up_write(&hmm->mirrors_sem);
263 EXPORT_SYMBOL(hmm_mirror_unregister);
265 struct hmm_vma_walk {
266 struct hmm_range *range;
273 static int hmm_vma_do_fault(struct mm_walk *walk,
277 unsigned int flags = FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_REMOTE;
278 struct hmm_vma_walk *hmm_vma_walk = walk->private;
279 struct vm_area_struct *vma = walk->vma;
282 flags |= hmm_vma_walk->block ? 0 : FAULT_FLAG_ALLOW_RETRY;
283 flags |= hmm_vma_walk->write ? FAULT_FLAG_WRITE : 0;
284 r = handle_mm_fault(vma, addr, flags);
285 if (r & VM_FAULT_RETRY)
287 if (r & VM_FAULT_ERROR) {
288 *pfn = HMM_PFN_ERROR;
295 static void hmm_pfns_special(hmm_pfn_t *pfns,
299 for (; addr < end; addr += PAGE_SIZE, pfns++)
300 *pfns = HMM_PFN_SPECIAL;
303 static int hmm_pfns_bad(unsigned long addr,
305 struct mm_walk *walk)
307 struct hmm_range *range = walk->private;
308 hmm_pfn_t *pfns = range->pfns;
311 i = (addr - range->start) >> PAGE_SHIFT;
312 for (; addr < end; addr += PAGE_SIZE, i++)
313 pfns[i] = HMM_PFN_ERROR;
318 static void hmm_pfns_clear(hmm_pfn_t *pfns,
322 for (; addr < end; addr += PAGE_SIZE, pfns++)
326 static int hmm_vma_walk_hole(unsigned long addr,
328 struct mm_walk *walk)
330 struct hmm_vma_walk *hmm_vma_walk = walk->private;
331 struct hmm_range *range = hmm_vma_walk->range;
332 hmm_pfn_t *pfns = range->pfns;
335 hmm_vma_walk->last = addr;
336 i = (addr - range->start) >> PAGE_SHIFT;
337 for (; addr < end; addr += PAGE_SIZE, i++) {
338 pfns[i] = HMM_PFN_EMPTY;
339 if (hmm_vma_walk->fault) {
342 ret = hmm_vma_do_fault(walk, addr, &pfns[i]);
348 return hmm_vma_walk->fault ? -EAGAIN : 0;
351 static int hmm_vma_walk_clear(unsigned long addr,
353 struct mm_walk *walk)
355 struct hmm_vma_walk *hmm_vma_walk = walk->private;
356 struct hmm_range *range = hmm_vma_walk->range;
357 hmm_pfn_t *pfns = range->pfns;
360 hmm_vma_walk->last = addr;
361 i = (addr - range->start) >> PAGE_SHIFT;
362 for (; addr < end; addr += PAGE_SIZE, i++) {
364 if (hmm_vma_walk->fault) {
367 ret = hmm_vma_do_fault(walk, addr, &pfns[i]);
373 return hmm_vma_walk->fault ? -EAGAIN : 0;
376 static int hmm_vma_walk_pmd(pmd_t *pmdp,
379 struct mm_walk *walk)
381 struct hmm_vma_walk *hmm_vma_walk = walk->private;
382 struct hmm_range *range = hmm_vma_walk->range;
383 struct vm_area_struct *vma = walk->vma;
384 hmm_pfn_t *pfns = range->pfns;
385 unsigned long addr = start, i;
390 i = (addr - range->start) >> PAGE_SHIFT;
391 flag = vma->vm_flags & VM_READ ? HMM_PFN_READ : 0;
392 write_fault = hmm_vma_walk->fault & hmm_vma_walk->write;
396 return hmm_vma_walk_hole(start, end, walk);
398 if (pmd_huge(*pmdp) && vma->vm_flags & VM_HUGETLB)
399 return hmm_pfns_bad(start, end, walk);
401 if (pmd_devmap(*pmdp) || pmd_trans_huge(*pmdp)) {
406 * No need to take pmd_lock here, even if some other threads
407 * is splitting the huge pmd we will get that event through
408 * mmu_notifier callback.
410 * So just read pmd value and check again its a transparent
411 * huge or device mapping one and compute corresponding pfn
414 pmd = pmd_read_atomic(pmdp);
416 if (!pmd_devmap(pmd) && !pmd_trans_huge(pmd))
418 if (pmd_protnone(pmd))
419 return hmm_vma_walk_clear(start, end, walk);
421 if (write_fault && !pmd_write(pmd))
422 return hmm_vma_walk_clear(start, end, walk);
424 pfn = pmd_pfn(pmd) + pte_index(addr);
425 flag |= pmd_write(pmd) ? HMM_PFN_WRITE : 0;
426 for (; addr < end; addr += PAGE_SIZE, i++, pfn++)
427 pfns[i] = hmm_pfn_t_from_pfn(pfn) | flag;
432 return hmm_pfns_bad(start, end, walk);
434 ptep = pte_offset_map(pmdp, addr);
435 for (; addr < end; addr += PAGE_SIZE, ptep++, i++) {
441 pfns[i] = HMM_PFN_EMPTY;
442 if (hmm_vma_walk->fault)
447 if (!pte_present(pte)) {
448 swp_entry_t entry = pte_to_swp_entry(pte);
450 if (!non_swap_entry(entry)) {
451 if (hmm_vma_walk->fault)
457 * This is a special swap entry, ignore migration, use
458 * device and report anything else as error.
460 if (is_device_private_entry(entry)) {
461 pfns[i] = hmm_pfn_t_from_pfn(swp_offset(entry));
462 if (is_write_device_private_entry(entry)) {
463 pfns[i] |= HMM_PFN_WRITE;
464 } else if (write_fault)
466 pfns[i] |= HMM_PFN_DEVICE_UNADDRESSABLE;
468 } else if (is_migration_entry(entry)) {
469 if (hmm_vma_walk->fault) {
471 hmm_vma_walk->last = addr;
472 migration_entry_wait(vma->vm_mm,
478 /* Report error for everything else */
479 pfns[i] = HMM_PFN_ERROR;
484 if (write_fault && !pte_write(pte))
487 pfns[i] = hmm_pfn_t_from_pfn(pte_pfn(pte)) | flag;
488 pfns[i] |= pte_write(pte) ? HMM_PFN_WRITE : 0;
493 /* Fault all pages in range */
494 return hmm_vma_walk_clear(start, end, walk);
502 * hmm_vma_get_pfns() - snapshot CPU page table for a range of virtual addresses
503 * @vma: virtual memory area containing the virtual address range
504 * @range: used to track snapshot validity
505 * @start: range virtual start address (inclusive)
506 * @end: range virtual end address (exclusive)
507 * @entries: array of hmm_pfn_t: provided by the caller, filled in by function
508 * Returns: -EINVAL if invalid argument, -ENOMEM out of memory, 0 success
510 * This snapshots the CPU page table for a range of virtual addresses. Snapshot
511 * validity is tracked by range struct. See hmm_vma_range_done() for further
514 * The range struct is initialized here. It tracks the CPU page table, but only
515 * if the function returns success (0), in which case the caller must then call
516 * hmm_vma_range_done() to stop CPU page table update tracking on this range.
518 * NOT CALLING hmm_vma_range_done() IF FUNCTION RETURNS 0 WILL LEAD TO SERIOUS
519 * MEMORY CORRUPTION ! YOU HAVE BEEN WARNED !
521 int hmm_vma_get_pfns(struct vm_area_struct *vma,
522 struct hmm_range *range,
527 struct hmm_vma_walk hmm_vma_walk;
528 struct mm_walk mm_walk;
531 /* FIXME support hugetlb fs */
532 if (is_vm_hugetlb_page(vma) || (vma->vm_flags & VM_SPECIAL)) {
533 hmm_pfns_special(pfns, start, end);
537 /* Sanity check, this really should not happen ! */
538 if (start < vma->vm_start || start >= vma->vm_end)
540 if (end < vma->vm_start || end > vma->vm_end)
543 hmm = hmm_register(vma->vm_mm);
546 /* Caller must have registered a mirror, via hmm_mirror_register() ! */
547 if (!hmm->mmu_notifier.ops)
550 /* Initialize range to track CPU page table update */
551 range->start = start;
554 spin_lock(&hmm->lock);
556 list_add_rcu(&range->list, &hmm->ranges);
557 spin_unlock(&hmm->lock);
559 hmm_vma_walk.fault = false;
560 hmm_vma_walk.range = range;
561 mm_walk.private = &hmm_vma_walk;
564 mm_walk.mm = vma->vm_mm;
565 mm_walk.pte_entry = NULL;
566 mm_walk.test_walk = NULL;
567 mm_walk.hugetlb_entry = NULL;
568 mm_walk.pmd_entry = hmm_vma_walk_pmd;
569 mm_walk.pte_hole = hmm_vma_walk_hole;
571 walk_page_range(start, end, &mm_walk);
574 EXPORT_SYMBOL(hmm_vma_get_pfns);
577 * hmm_vma_range_done() - stop tracking change to CPU page table over a range
578 * @vma: virtual memory area containing the virtual address range
579 * @range: range being tracked
580 * Returns: false if range data has been invalidated, true otherwise
582 * Range struct is used to track updates to the CPU page table after a call to
583 * either hmm_vma_get_pfns() or hmm_vma_fault(). Once the device driver is done
584 * using the data, or wants to lock updates to the data it got from those
585 * functions, it must call the hmm_vma_range_done() function, which will then
586 * stop tracking CPU page table updates.
588 * Note that device driver must still implement general CPU page table update
589 * tracking either by using hmm_mirror (see hmm_mirror_register()) or by using
590 * the mmu_notifier API directly.
592 * CPU page table update tracking done through hmm_range is only temporary and
593 * to be used while trying to duplicate CPU page table contents for a range of
596 * There are two ways to use this :
598 * hmm_vma_get_pfns(vma, range, start, end, pfns); or hmm_vma_fault(...);
599 * trans = device_build_page_table_update_transaction(pfns);
600 * device_page_table_lock();
601 * if (!hmm_vma_range_done(vma, range)) {
602 * device_page_table_unlock();
605 * device_commit_transaction(trans);
606 * device_page_table_unlock();
609 * hmm_vma_get_pfns(vma, range, start, end, pfns); or hmm_vma_fault(...);
610 * device_page_table_lock();
611 * hmm_vma_range_done(vma, range);
612 * device_update_page_table(pfns);
613 * device_page_table_unlock();
615 bool hmm_vma_range_done(struct vm_area_struct *vma, struct hmm_range *range)
617 unsigned long npages = (range->end - range->start) >> PAGE_SHIFT;
620 if (range->end <= range->start) {
625 hmm = hmm_register(vma->vm_mm);
627 memset(range->pfns, 0, sizeof(*range->pfns) * npages);
631 spin_lock(&hmm->lock);
632 list_del_rcu(&range->list);
633 spin_unlock(&hmm->lock);
637 EXPORT_SYMBOL(hmm_vma_range_done);
640 * hmm_vma_fault() - try to fault some address in a virtual address range
641 * @vma: virtual memory area containing the virtual address range
642 * @range: use to track pfns array content validity
643 * @start: fault range virtual start address (inclusive)
644 * @end: fault range virtual end address (exclusive)
645 * @pfns: array of hmm_pfn_t, only entry with fault flag set will be faulted
646 * @write: is it a write fault
647 * @block: allow blocking on fault (if true it sleeps and do not drop mmap_sem)
648 * Returns: 0 success, error otherwise (-EAGAIN means mmap_sem have been drop)
650 * This is similar to a regular CPU page fault except that it will not trigger
651 * any memory migration if the memory being faulted is not accessible by CPUs.
653 * On error, for one virtual address in the range, the function will set the
654 * hmm_pfn_t error flag for the corresponding pfn entry.
656 * Expected use pattern:
658 * down_read(&mm->mmap_sem);
659 * // Find vma and address device wants to fault, initialize hmm_pfn_t
660 * // array accordingly
661 * ret = hmm_vma_fault(vma, start, end, pfns, allow_retry);
664 * hmm_vma_range_done(vma, range);
665 * // You might want to rate limit or yield to play nicely, you may
666 * // also commit any valid pfn in the array assuming that you are
667 * // getting true from hmm_vma_range_monitor_end()
673 * up_read(&mm->mmap_sem)
676 * // Take device driver lock that serialize device page table update
677 * driver_lock_device_page_table_update();
678 * hmm_vma_range_done(vma, range);
679 * // Commit pfns we got from hmm_vma_fault()
680 * driver_unlock_device_page_table_update();
681 * up_read(&mm->mmap_sem)
683 * YOU MUST CALL hmm_vma_range_done() AFTER THIS FUNCTION RETURN SUCCESS (0)
684 * BEFORE FREEING THE range struct OR YOU WILL HAVE SERIOUS MEMORY CORRUPTION !
686 * YOU HAVE BEEN WARNED !
688 int hmm_vma_fault(struct vm_area_struct *vma,
689 struct hmm_range *range,
696 struct hmm_vma_walk hmm_vma_walk;
697 struct mm_walk mm_walk;
701 /* Sanity check, this really should not happen ! */
702 if (start < vma->vm_start || start >= vma->vm_end)
704 if (end < vma->vm_start || end > vma->vm_end)
707 hmm = hmm_register(vma->vm_mm);
709 hmm_pfns_clear(pfns, start, end);
712 /* Caller must have registered a mirror using hmm_mirror_register() */
713 if (!hmm->mmu_notifier.ops)
716 /* Initialize range to track CPU page table update */
717 range->start = start;
720 spin_lock(&hmm->lock);
722 list_add_rcu(&range->list, &hmm->ranges);
723 spin_unlock(&hmm->lock);
725 /* FIXME support hugetlb fs */
726 if (is_vm_hugetlb_page(vma) || (vma->vm_flags & VM_SPECIAL)) {
727 hmm_pfns_special(pfns, start, end);
731 hmm_vma_walk.fault = true;
732 hmm_vma_walk.write = write;
733 hmm_vma_walk.block = block;
734 hmm_vma_walk.range = range;
735 mm_walk.private = &hmm_vma_walk;
736 hmm_vma_walk.last = range->start;
739 mm_walk.mm = vma->vm_mm;
740 mm_walk.pte_entry = NULL;
741 mm_walk.test_walk = NULL;
742 mm_walk.hugetlb_entry = NULL;
743 mm_walk.pmd_entry = hmm_vma_walk_pmd;
744 mm_walk.pte_hole = hmm_vma_walk_hole;
747 ret = walk_page_range(start, end, &mm_walk);
748 start = hmm_vma_walk.last;
749 } while (ret == -EAGAIN);
754 i = (hmm_vma_walk.last - range->start) >> PAGE_SHIFT;
755 hmm_pfns_clear(&pfns[i], hmm_vma_walk.last, end);
756 hmm_vma_range_done(vma, range);
760 EXPORT_SYMBOL(hmm_vma_fault);
761 #endif /* IS_ENABLED(CONFIG_HMM_MIRROR) */
764 #if IS_ENABLED(CONFIG_DEVICE_PRIVATE) || IS_ENABLED(CONFIG_DEVICE_PUBLIC)
765 struct page *hmm_vma_alloc_locked_page(struct vm_area_struct *vma,
770 page = alloc_page_vma(GFP_HIGHUSER, vma, addr);
776 EXPORT_SYMBOL(hmm_vma_alloc_locked_page);
779 static void hmm_devmem_ref_release(struct percpu_ref *ref)
781 struct hmm_devmem *devmem;
783 devmem = container_of(ref, struct hmm_devmem, ref);
784 complete(&devmem->completion);
787 static void hmm_devmem_ref_exit(void *data)
789 struct percpu_ref *ref = data;
790 struct hmm_devmem *devmem;
792 devmem = container_of(ref, struct hmm_devmem, ref);
793 percpu_ref_exit(ref);
794 devm_remove_action(devmem->device, &hmm_devmem_ref_exit, data);
797 static void hmm_devmem_ref_kill(void *data)
799 struct percpu_ref *ref = data;
800 struct hmm_devmem *devmem;
802 devmem = container_of(ref, struct hmm_devmem, ref);
803 percpu_ref_kill(ref);
804 wait_for_completion(&devmem->completion);
805 devm_remove_action(devmem->device, &hmm_devmem_ref_kill, data);
808 static int hmm_devmem_fault(struct vm_area_struct *vma,
810 const struct page *page,
814 struct hmm_devmem *devmem = page->pgmap->data;
816 return devmem->ops->fault(devmem, vma, addr, page, flags, pmdp);
819 static void hmm_devmem_free(struct page *page, void *data)
821 struct hmm_devmem *devmem = data;
823 devmem->ops->free(devmem, page);
826 static DEFINE_MUTEX(hmm_devmem_lock);
827 static RADIX_TREE(hmm_devmem_radix, GFP_KERNEL);
829 static void hmm_devmem_radix_release(struct resource *resource)
831 resource_size_t key, align_start, align_size;
833 align_start = resource->start & ~(PA_SECTION_SIZE - 1);
834 align_size = ALIGN(resource_size(resource), PA_SECTION_SIZE);
836 mutex_lock(&hmm_devmem_lock);
837 for (key = resource->start;
838 key <= resource->end;
839 key += PA_SECTION_SIZE)
840 radix_tree_delete(&hmm_devmem_radix, key >> PA_SECTION_SHIFT);
841 mutex_unlock(&hmm_devmem_lock);
844 static void hmm_devmem_release(struct device *dev, void *data)
846 struct hmm_devmem *devmem = data;
847 struct resource *resource = devmem->resource;
848 unsigned long start_pfn, npages;
852 if (percpu_ref_tryget_live(&devmem->ref)) {
853 dev_WARN(dev, "%s: page mapping is still live!\n", __func__);
854 percpu_ref_put(&devmem->ref);
857 /* pages are dead and unused, undo the arch mapping */
858 start_pfn = (resource->start & ~(PA_SECTION_SIZE - 1)) >> PAGE_SHIFT;
859 npages = ALIGN(resource_size(resource), PA_SECTION_SIZE) >> PAGE_SHIFT;
861 page = pfn_to_page(start_pfn);
862 zone = page_zone(page);
865 if (resource->desc == IORES_DESC_DEVICE_PRIVATE_MEMORY)
866 __remove_pages(zone, start_pfn, npages, NULL);
868 arch_remove_memory(start_pfn << PAGE_SHIFT,
869 npages << PAGE_SHIFT, NULL);
872 hmm_devmem_radix_release(resource);
875 static struct hmm_devmem *hmm_devmem_find(resource_size_t phys)
877 WARN_ON_ONCE(!rcu_read_lock_held());
879 return radix_tree_lookup(&hmm_devmem_radix, phys >> PA_SECTION_SHIFT);
882 static int hmm_devmem_pages_create(struct hmm_devmem *devmem)
884 resource_size_t key, align_start, align_size, align_end;
885 struct device *device = devmem->device;
886 int ret, nid, is_ram;
889 align_start = devmem->resource->start & ~(PA_SECTION_SIZE - 1);
890 align_size = ALIGN(devmem->resource->start +
891 resource_size(devmem->resource),
892 PA_SECTION_SIZE) - align_start;
894 is_ram = region_intersects(align_start, align_size,
895 IORESOURCE_SYSTEM_RAM,
897 if (is_ram == REGION_MIXED) {
898 WARN_ONCE(1, "%s attempted on mixed region %pr\n",
899 __func__, devmem->resource);
902 if (is_ram == REGION_INTERSECTS)
905 if (devmem->resource->desc == IORES_DESC_DEVICE_PUBLIC_MEMORY)
906 devmem->pagemap.type = MEMORY_DEVICE_PUBLIC;
908 devmem->pagemap.type = MEMORY_DEVICE_PRIVATE;
910 devmem->pagemap.res = *devmem->resource;
911 devmem->pagemap.page_fault = hmm_devmem_fault;
912 devmem->pagemap.page_free = hmm_devmem_free;
913 devmem->pagemap.dev = devmem->device;
914 devmem->pagemap.ref = &devmem->ref;
915 devmem->pagemap.data = devmem;
917 mutex_lock(&hmm_devmem_lock);
918 align_end = align_start + align_size - 1;
919 for (key = align_start; key <= align_end; key += PA_SECTION_SIZE) {
920 struct hmm_devmem *dup;
923 dup = hmm_devmem_find(key);
926 dev_err(device, "%s: collides with mapping for %s\n",
927 __func__, dev_name(dup->device));
928 mutex_unlock(&hmm_devmem_lock);
932 ret = radix_tree_insert(&hmm_devmem_radix,
933 key >> PA_SECTION_SHIFT,
936 dev_err(device, "%s: failed: %d\n", __func__, ret);
937 mutex_unlock(&hmm_devmem_lock);
941 mutex_unlock(&hmm_devmem_lock);
943 nid = dev_to_node(device);
949 * For device private memory we call add_pages() as we only need to
950 * allocate and initialize struct page for the device memory. More-
951 * over the device memory is un-accessible thus we do not want to
952 * create a linear mapping for the memory like arch_add_memory()
955 * For device public memory, which is accesible by the CPU, we do
956 * want the linear mapping and thus use arch_add_memory().
958 if (devmem->pagemap.type == MEMORY_DEVICE_PUBLIC)
959 ret = arch_add_memory(nid, align_start, align_size, NULL,
962 ret = add_pages(nid, align_start >> PAGE_SHIFT,
963 align_size >> PAGE_SHIFT, NULL, false);
966 goto error_add_memory;
968 move_pfn_range_to_zone(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
969 align_start >> PAGE_SHIFT,
970 align_size >> PAGE_SHIFT, NULL);
973 for (pfn = devmem->pfn_first; pfn < devmem->pfn_last; pfn++) {
974 struct page *page = pfn_to_page(pfn);
976 page->pgmap = &devmem->pagemap;
981 untrack_pfn(NULL, PHYS_PFN(align_start), align_size);
983 hmm_devmem_radix_release(devmem->resource);
988 static int hmm_devmem_match(struct device *dev, void *data, void *match_data)
990 struct hmm_devmem *devmem = data;
992 return devmem->resource == match_data;
995 static void hmm_devmem_pages_remove(struct hmm_devmem *devmem)
997 devres_release(devmem->device, &hmm_devmem_release,
998 &hmm_devmem_match, devmem->resource);
1002 * hmm_devmem_add() - hotplug ZONE_DEVICE memory for device memory
1004 * @ops: memory event device driver callback (see struct hmm_devmem_ops)
1005 * @device: device struct to bind the resource too
1006 * @size: size in bytes of the device memory to add
1007 * Returns: pointer to new hmm_devmem struct ERR_PTR otherwise
1009 * This function first finds an empty range of physical address big enough to
1010 * contain the new resource, and then hotplugs it as ZONE_DEVICE memory, which
1011 * in turn allocates struct pages. It does not do anything beyond that; all
1012 * events affecting the memory will go through the various callbacks provided
1013 * by hmm_devmem_ops struct.
1015 * Device driver should call this function during device initialization and
1016 * is then responsible of memory management. HMM only provides helpers.
1018 struct hmm_devmem *hmm_devmem_add(const struct hmm_devmem_ops *ops,
1019 struct device *device,
1022 struct hmm_devmem *devmem;
1023 resource_size_t addr;
1026 static_branch_enable(&device_private_key);
1028 devmem = devres_alloc_node(&hmm_devmem_release, sizeof(*devmem),
1029 GFP_KERNEL, dev_to_node(device));
1031 return ERR_PTR(-ENOMEM);
1033 init_completion(&devmem->completion);
1034 devmem->pfn_first = -1UL;
1035 devmem->pfn_last = -1UL;
1036 devmem->resource = NULL;
1037 devmem->device = device;
1040 ret = percpu_ref_init(&devmem->ref, &hmm_devmem_ref_release,
1043 goto error_percpu_ref;
1045 ret = devm_add_action(device, hmm_devmem_ref_exit, &devmem->ref);
1047 goto error_devm_add_action;
1049 size = ALIGN(size, PA_SECTION_SIZE);
1050 addr = min((unsigned long)iomem_resource.end,
1051 (1UL << MAX_PHYSMEM_BITS) - 1);
1052 addr = addr - size + 1UL;
1055 * FIXME add a new helper to quickly walk resource tree and find free
1058 * FIXME what about ioport_resource resource ?
1060 for (; addr > size && addr >= iomem_resource.start; addr -= size) {
1061 ret = region_intersects(addr, size, 0, IORES_DESC_NONE);
1062 if (ret != REGION_DISJOINT)
1065 devmem->resource = devm_request_mem_region(device, addr, size,
1067 if (!devmem->resource) {
1069 goto error_no_resource;
1073 if (!devmem->resource) {
1075 goto error_no_resource;
1078 devmem->resource->desc = IORES_DESC_DEVICE_PRIVATE_MEMORY;
1079 devmem->pfn_first = devmem->resource->start >> PAGE_SHIFT;
1080 devmem->pfn_last = devmem->pfn_first +
1081 (resource_size(devmem->resource) >> PAGE_SHIFT);
1083 ret = hmm_devmem_pages_create(devmem);
1087 devres_add(device, devmem);
1089 ret = devm_add_action(device, hmm_devmem_ref_kill, &devmem->ref);
1091 hmm_devmem_remove(devmem);
1092 return ERR_PTR(ret);
1098 devm_release_mem_region(device, devmem->resource->start,
1099 resource_size(devmem->resource));
1101 error_devm_add_action:
1102 hmm_devmem_ref_kill(&devmem->ref);
1103 hmm_devmem_ref_exit(&devmem->ref);
1105 devres_free(devmem);
1106 return ERR_PTR(ret);
1108 EXPORT_SYMBOL(hmm_devmem_add);
1110 struct hmm_devmem *hmm_devmem_add_resource(const struct hmm_devmem_ops *ops,
1111 struct device *device,
1112 struct resource *res)
1114 struct hmm_devmem *devmem;
1117 if (res->desc != IORES_DESC_DEVICE_PUBLIC_MEMORY)
1118 return ERR_PTR(-EINVAL);
1120 static_branch_enable(&device_private_key);
1122 devmem = devres_alloc_node(&hmm_devmem_release, sizeof(*devmem),
1123 GFP_KERNEL, dev_to_node(device));
1125 return ERR_PTR(-ENOMEM);
1127 init_completion(&devmem->completion);
1128 devmem->pfn_first = -1UL;
1129 devmem->pfn_last = -1UL;
1130 devmem->resource = res;
1131 devmem->device = device;
1134 ret = percpu_ref_init(&devmem->ref, &hmm_devmem_ref_release,
1137 goto error_percpu_ref;
1139 ret = devm_add_action(device, hmm_devmem_ref_exit, &devmem->ref);
1141 goto error_devm_add_action;
1144 devmem->pfn_first = devmem->resource->start >> PAGE_SHIFT;
1145 devmem->pfn_last = devmem->pfn_first +
1146 (resource_size(devmem->resource) >> PAGE_SHIFT);
1148 ret = hmm_devmem_pages_create(devmem);
1150 goto error_devm_add_action;
1152 devres_add(device, devmem);
1154 ret = devm_add_action(device, hmm_devmem_ref_kill, &devmem->ref);
1156 hmm_devmem_remove(devmem);
1157 return ERR_PTR(ret);
1162 error_devm_add_action:
1163 hmm_devmem_ref_kill(&devmem->ref);
1164 hmm_devmem_ref_exit(&devmem->ref);
1166 devres_free(devmem);
1167 return ERR_PTR(ret);
1169 EXPORT_SYMBOL(hmm_devmem_add_resource);
1172 * hmm_devmem_remove() - remove device memory (kill and free ZONE_DEVICE)
1174 * @devmem: hmm_devmem struct use to track and manage the ZONE_DEVICE memory
1176 * This will hot-unplug memory that was hotplugged by hmm_devmem_add on behalf
1177 * of the device driver. It will free struct page and remove the resource that
1178 * reserved the physical address range for this device memory.
1180 void hmm_devmem_remove(struct hmm_devmem *devmem)
1182 resource_size_t start, size;
1183 struct device *device;
1189 device = devmem->device;
1190 start = devmem->resource->start;
1191 size = resource_size(devmem->resource);
1193 cdm = devmem->resource->desc == IORES_DESC_DEVICE_PUBLIC_MEMORY;
1194 hmm_devmem_ref_kill(&devmem->ref);
1195 hmm_devmem_ref_exit(&devmem->ref);
1196 hmm_devmem_pages_remove(devmem);
1199 devm_release_mem_region(device, start, size);
1201 EXPORT_SYMBOL(hmm_devmem_remove);
1204 * A device driver that wants to handle multiple devices memory through a
1205 * single fake device can use hmm_device to do so. This is purely a helper
1206 * and it is not needed to make use of any HMM functionality.
1208 #define HMM_DEVICE_MAX 256
1210 static DECLARE_BITMAP(hmm_device_mask, HMM_DEVICE_MAX);
1211 static DEFINE_SPINLOCK(hmm_device_lock);
1212 static struct class *hmm_device_class;
1213 static dev_t hmm_device_devt;
1215 static void hmm_device_release(struct device *device)
1217 struct hmm_device *hmm_device;
1219 hmm_device = container_of(device, struct hmm_device, device);
1220 spin_lock(&hmm_device_lock);
1221 clear_bit(hmm_device->minor, hmm_device_mask);
1222 spin_unlock(&hmm_device_lock);
1227 struct hmm_device *hmm_device_new(void *drvdata)
1229 struct hmm_device *hmm_device;
1231 hmm_device = kzalloc(sizeof(*hmm_device), GFP_KERNEL);
1233 return ERR_PTR(-ENOMEM);
1235 spin_lock(&hmm_device_lock);
1236 hmm_device->minor = find_first_zero_bit(hmm_device_mask, HMM_DEVICE_MAX);
1237 if (hmm_device->minor >= HMM_DEVICE_MAX) {
1238 spin_unlock(&hmm_device_lock);
1240 return ERR_PTR(-EBUSY);
1242 set_bit(hmm_device->minor, hmm_device_mask);
1243 spin_unlock(&hmm_device_lock);
1245 dev_set_name(&hmm_device->device, "hmm_device%d", hmm_device->minor);
1246 hmm_device->device.devt = MKDEV(MAJOR(hmm_device_devt),
1248 hmm_device->device.release = hmm_device_release;
1249 dev_set_drvdata(&hmm_device->device, drvdata);
1250 hmm_device->device.class = hmm_device_class;
1251 device_initialize(&hmm_device->device);
1255 EXPORT_SYMBOL(hmm_device_new);
1257 void hmm_device_put(struct hmm_device *hmm_device)
1259 put_device(&hmm_device->device);
1261 EXPORT_SYMBOL(hmm_device_put);
1263 static int __init hmm_init(void)
1267 ret = alloc_chrdev_region(&hmm_device_devt, 0,
1273 hmm_device_class = class_create(THIS_MODULE, "hmm_device");
1274 if (IS_ERR(hmm_device_class)) {
1275 unregister_chrdev_region(hmm_device_devt, HMM_DEVICE_MAX);
1276 return PTR_ERR(hmm_device_class);
1281 device_initcall(hmm_init);
1282 #endif /* CONFIG_DEVICE_PRIVATE || CONFIG_DEVICE_PUBLIC */