2 * Copyright 2014-2018 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
22 #include <linux/dma-buf.h>
23 #include <linux/list.h>
24 #include <linux/pagemap.h>
25 #include <linux/sched/mm.h>
26 #include <linux/sched/task.h>
28 #include "amdgpu_object.h"
29 #include "amdgpu_vm.h"
30 #include "amdgpu_amdkfd.h"
31 #include "amdgpu_dma_buf.h"
32 #include <uapi/linux/kfd_ioctl.h>
34 /* BO flag to indicate a KFD userptr BO */
35 #define AMDGPU_AMDKFD_USERPTR_BO (1ULL << 63)
37 /* Userptr restore delay, just long enough to allow consecutive VM
38 * changes to accumulate
40 #define AMDGPU_USERPTR_RESTORE_DELAY_MS 1
42 /* Impose limit on how much memory KFD can use */
44 uint64_t max_system_mem_limit;
45 uint64_t max_ttm_mem_limit;
46 int64_t system_mem_used;
48 spinlock_t mem_limit_lock;
51 /* Struct used for amdgpu_amdkfd_bo_validate */
52 struct amdgpu_vm_parser {
57 static const char * const domain_bit_to_string[] = {
66 #define domain_string(domain) domain_bit_to_string[ffs(domain)-1]
68 static void amdgpu_amdkfd_restore_userptr_worker(struct work_struct *work);
71 static inline struct amdgpu_device *get_amdgpu_device(struct kgd_dev *kgd)
73 return (struct amdgpu_device *)kgd;
76 static bool check_if_add_bo_to_vm(struct amdgpu_vm *avm,
79 struct kfd_bo_va_list *entry;
81 list_for_each_entry(entry, &mem->bo_va_list, bo_list)
82 if (entry->bo_va->base.vm == avm)
88 /* Set memory usage limits. Current, limits are
89 * System (TTM + userptr) memory - 15/16th System RAM
90 * TTM memory - 3/8th System RAM
92 void amdgpu_amdkfd_gpuvm_init_mem_limits(void)
98 mem = si.totalram - si.totalhigh;
101 spin_lock_init(&kfd_mem_limit.mem_limit_lock);
102 kfd_mem_limit.max_system_mem_limit = mem - (mem >> 4);
103 kfd_mem_limit.max_ttm_mem_limit = (mem >> 1) - (mem >> 3);
104 pr_debug("Kernel memory limit %lluM, TTM limit %lluM\n",
105 (kfd_mem_limit.max_system_mem_limit >> 20),
106 (kfd_mem_limit.max_ttm_mem_limit >> 20));
109 /* Estimate page table size needed to represent a given memory size
111 * With 4KB pages, we need one 8 byte PTE for each 4KB of memory
112 * (factor 512, >> 9). With 2MB pages, we need one 8 byte PTE for 2MB
113 * of memory (factor 256K, >> 18). ROCm user mode tries to optimize
114 * for 2MB pages for TLB efficiency. However, small allocations and
115 * fragmented system memory still need some 4KB pages. We choose a
116 * compromise that should work in most cases without reserving too
117 * much memory for page tables unnecessarily (factor 16K, >> 14).
119 #define ESTIMATE_PT_SIZE(mem_size) ((mem_size) >> 14)
121 static int amdgpu_amdkfd_reserve_mem_limit(struct amdgpu_device *adev,
122 uint64_t size, u32 domain, bool sg)
124 uint64_t reserved_for_pt =
125 ESTIMATE_PT_SIZE(amdgpu_amdkfd_total_mem_size);
126 size_t acc_size, system_mem_needed, ttm_mem_needed, vram_needed;
129 acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
130 sizeof(struct amdgpu_bo));
133 if (domain == AMDGPU_GEM_DOMAIN_GTT) {
135 system_mem_needed = acc_size + size;
136 ttm_mem_needed = acc_size + size;
137 } else if (domain == AMDGPU_GEM_DOMAIN_CPU && !sg) {
139 system_mem_needed = acc_size + size;
140 ttm_mem_needed = acc_size;
143 system_mem_needed = acc_size;
144 ttm_mem_needed = acc_size;
145 if (domain == AMDGPU_GEM_DOMAIN_VRAM)
149 spin_lock(&kfd_mem_limit.mem_limit_lock);
151 if (kfd_mem_limit.system_mem_used + system_mem_needed >
152 kfd_mem_limit.max_system_mem_limit)
153 pr_debug("Set no_system_mem_limit=1 if using shared memory\n");
155 if ((kfd_mem_limit.system_mem_used + system_mem_needed >
156 kfd_mem_limit.max_system_mem_limit && !no_system_mem_limit) ||
157 (kfd_mem_limit.ttm_mem_used + ttm_mem_needed >
158 kfd_mem_limit.max_ttm_mem_limit) ||
159 (adev->kfd.vram_used + vram_needed >
160 adev->gmc.real_vram_size - reserved_for_pt)) {
163 kfd_mem_limit.system_mem_used += system_mem_needed;
164 kfd_mem_limit.ttm_mem_used += ttm_mem_needed;
165 adev->kfd.vram_used += vram_needed;
168 spin_unlock(&kfd_mem_limit.mem_limit_lock);
172 static void unreserve_mem_limit(struct amdgpu_device *adev,
173 uint64_t size, u32 domain, bool sg)
177 acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
178 sizeof(struct amdgpu_bo));
180 spin_lock(&kfd_mem_limit.mem_limit_lock);
181 if (domain == AMDGPU_GEM_DOMAIN_GTT) {
182 kfd_mem_limit.system_mem_used -= (acc_size + size);
183 kfd_mem_limit.ttm_mem_used -= (acc_size + size);
184 } else if (domain == AMDGPU_GEM_DOMAIN_CPU && !sg) {
185 kfd_mem_limit.system_mem_used -= (acc_size + size);
186 kfd_mem_limit.ttm_mem_used -= acc_size;
188 kfd_mem_limit.system_mem_used -= acc_size;
189 kfd_mem_limit.ttm_mem_used -= acc_size;
190 if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
191 adev->kfd.vram_used -= size;
192 WARN_ONCE(adev->kfd.vram_used < 0,
193 "kfd VRAM memory accounting unbalanced");
196 WARN_ONCE(kfd_mem_limit.system_mem_used < 0,
197 "kfd system memory accounting unbalanced");
198 WARN_ONCE(kfd_mem_limit.ttm_mem_used < 0,
199 "kfd TTM memory accounting unbalanced");
201 spin_unlock(&kfd_mem_limit.mem_limit_lock);
204 void amdgpu_amdkfd_unreserve_memory_limit(struct amdgpu_bo *bo)
206 struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
207 u32 domain = bo->preferred_domains;
208 bool sg = (bo->preferred_domains == AMDGPU_GEM_DOMAIN_CPU);
210 if (bo->flags & AMDGPU_AMDKFD_USERPTR_BO) {
211 domain = AMDGPU_GEM_DOMAIN_CPU;
215 unreserve_mem_limit(adev, amdgpu_bo_size(bo), domain, sg);
219 /* amdgpu_amdkfd_remove_eviction_fence - Removes eviction fence from BO's
220 * reservation object.
222 * @bo: [IN] Remove eviction fence(s) from this BO
223 * @ef: [IN] This eviction fence is removed if it
224 * is present in the shared list.
226 * NOTE: Must be called with BO reserved i.e. bo->tbo.resv->lock held.
228 static int amdgpu_amdkfd_remove_eviction_fence(struct amdgpu_bo *bo,
229 struct amdgpu_amdkfd_fence *ef)
231 struct dma_resv *resv = bo->tbo.base.resv;
232 struct dma_resv_list *old, *new;
233 unsigned int i, j, k;
238 old = dma_resv_get_list(resv);
242 new = kmalloc(offsetof(typeof(*new), shared[old->shared_max]),
247 /* Go through all the shared fences in the resevation object and sort
248 * the interesting ones to the end of the list.
250 for (i = 0, j = old->shared_count, k = 0; i < old->shared_count; ++i) {
253 f = rcu_dereference_protected(old->shared[i],
254 dma_resv_held(resv));
256 if (f->context == ef->base.context)
257 RCU_INIT_POINTER(new->shared[--j], f);
259 RCU_INIT_POINTER(new->shared[k++], f);
261 new->shared_max = old->shared_max;
262 new->shared_count = k;
264 /* Install the new fence list, seqcount provides the barriers */
266 write_seqcount_begin(&resv->seq);
267 RCU_INIT_POINTER(resv->fence, new);
268 write_seqcount_end(&resv->seq);
271 /* Drop the references to the removed fences or move them to ef_list */
272 for (i = j, k = 0; i < old->shared_count; ++i) {
275 f = rcu_dereference_protected(new->shared[i],
276 dma_resv_held(resv));
284 int amdgpu_amdkfd_remove_fence_on_pt_pd_bos(struct amdgpu_bo *bo)
286 struct amdgpu_bo *root = bo;
287 struct amdgpu_vm_bo_base *vm_bo;
288 struct amdgpu_vm *vm;
289 struct amdkfd_process_info *info;
290 struct amdgpu_amdkfd_fence *ef;
293 /* we can always get vm_bo from root PD bo.*/
305 info = vm->process_info;
306 if (!info || !info->eviction_fence)
309 ef = container_of(dma_fence_get(&info->eviction_fence->base),
310 struct amdgpu_amdkfd_fence, base);
312 BUG_ON(!dma_resv_trylock(bo->tbo.base.resv));
313 ret = amdgpu_amdkfd_remove_eviction_fence(bo, ef);
314 dma_resv_unlock(bo->tbo.base.resv);
316 dma_fence_put(&ef->base);
320 static int amdgpu_amdkfd_bo_validate(struct amdgpu_bo *bo, uint32_t domain,
323 struct ttm_operation_ctx ctx = { false, false };
326 if (WARN(amdgpu_ttm_tt_get_usermm(bo->tbo.ttm),
327 "Called with userptr BO"))
330 amdgpu_bo_placement_from_domain(bo, domain);
332 ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
336 amdgpu_bo_sync_wait(bo, AMDGPU_FENCE_OWNER_KFD, false);
342 static int amdgpu_amdkfd_validate(void *param, struct amdgpu_bo *bo)
344 struct amdgpu_vm_parser *p = param;
346 return amdgpu_amdkfd_bo_validate(bo, p->domain, p->wait);
349 /* vm_validate_pt_pd_bos - Validate page table and directory BOs
351 * Page directories are not updated here because huge page handling
352 * during page table updates can invalidate page directory entries
353 * again. Page directories are only updated after updating page
356 static int vm_validate_pt_pd_bos(struct amdgpu_vm *vm)
358 struct amdgpu_bo *pd = vm->root.base.bo;
359 struct amdgpu_device *adev = amdgpu_ttm_adev(pd->tbo.bdev);
360 struct amdgpu_vm_parser param;
363 param.domain = AMDGPU_GEM_DOMAIN_VRAM;
366 ret = amdgpu_vm_validate_pt_bos(adev, vm, amdgpu_amdkfd_validate,
369 pr_err("failed to validate PT BOs\n");
373 ret = amdgpu_amdkfd_validate(¶m, pd);
375 pr_err("failed to validate PD\n");
379 vm->pd_phys_addr = amdgpu_gmc_pd_addr(vm->root.base.bo);
381 if (vm->use_cpu_for_update) {
382 ret = amdgpu_bo_kmap(pd, NULL);
384 pr_err("failed to kmap PD, ret=%d\n", ret);
392 static int vm_update_pds(struct amdgpu_vm *vm, struct amdgpu_sync *sync)
394 struct amdgpu_bo *pd = vm->root.base.bo;
395 struct amdgpu_device *adev = amdgpu_ttm_adev(pd->tbo.bdev);
398 ret = amdgpu_vm_update_pdes(adev, vm, false);
402 return amdgpu_sync_fence(sync, vm->last_update);
405 static uint64_t get_pte_flags(struct amdgpu_device *adev, struct kgd_mem *mem)
407 struct amdgpu_device *bo_adev = amdgpu_ttm_adev(mem->bo->tbo.bdev);
408 bool coherent = mem->alloc_flags & KFD_IOC_ALLOC_MEM_FLAGS_COHERENT;
409 uint32_t mapping_flags;
411 mapping_flags = AMDGPU_VM_PAGE_READABLE;
412 if (mem->alloc_flags & KFD_IOC_ALLOC_MEM_FLAGS_WRITABLE)
413 mapping_flags |= AMDGPU_VM_PAGE_WRITEABLE;
414 if (mem->alloc_flags & KFD_IOC_ALLOC_MEM_FLAGS_EXECUTABLE)
415 mapping_flags |= AMDGPU_VM_PAGE_EXECUTABLE;
417 switch (adev->asic_type) {
419 if (mem->alloc_flags & KFD_IOC_ALLOC_MEM_FLAGS_VRAM) {
421 mapping_flags |= coherent ?
422 AMDGPU_VM_MTYPE_CC : AMDGPU_VM_MTYPE_RW;
424 mapping_flags |= AMDGPU_VM_MTYPE_UC;
426 mapping_flags |= coherent ?
427 AMDGPU_VM_MTYPE_UC : AMDGPU_VM_MTYPE_NC;
431 mapping_flags |= coherent ?
432 AMDGPU_VM_MTYPE_UC : AMDGPU_VM_MTYPE_NC;
435 return amdgpu_gem_va_map_flags(adev, mapping_flags);
438 /* add_bo_to_vm - Add a BO to a VM
440 * Everything that needs to bo done only once when a BO is first added
441 * to a VM. It can later be mapped and unmapped many times without
442 * repeating these steps.
444 * 1. Allocate and initialize BO VA entry data structure
445 * 2. Add BO to the VM
446 * 3. Determine ASIC-specific PTE flags
447 * 4. Alloc page tables and directories if needed
448 * 4a. Validate new page tables and directories
450 static int add_bo_to_vm(struct amdgpu_device *adev, struct kgd_mem *mem,
451 struct amdgpu_vm *vm, bool is_aql,
452 struct kfd_bo_va_list **p_bo_va_entry)
455 struct kfd_bo_va_list *bo_va_entry;
456 struct amdgpu_bo *bo = mem->bo;
457 uint64_t va = mem->va;
458 struct list_head *list_bo_va = &mem->bo_va_list;
459 unsigned long bo_size = bo->tbo.mem.size;
462 pr_err("Invalid VA when adding BO to VM\n");
469 bo_va_entry = kzalloc(sizeof(*bo_va_entry), GFP_KERNEL);
473 pr_debug("\t add VA 0x%llx - 0x%llx to vm %p\n", va,
476 /* Add BO to VM internal data structures*/
477 bo_va_entry->bo_va = amdgpu_vm_bo_add(adev, vm, bo);
478 if (!bo_va_entry->bo_va) {
480 pr_err("Failed to add BO object to VM. ret == %d\n",
485 bo_va_entry->va = va;
486 bo_va_entry->pte_flags = get_pte_flags(adev, mem);
487 bo_va_entry->kgd_dev = (void *)adev;
488 list_add(&bo_va_entry->bo_list, list_bo_va);
491 *p_bo_va_entry = bo_va_entry;
493 /* Allocate validate page tables if needed */
494 ret = vm_validate_pt_pd_bos(vm);
496 pr_err("validate_pt_pd_bos() failed\n");
503 amdgpu_vm_bo_rmv(adev, bo_va_entry->bo_va);
504 list_del(&bo_va_entry->bo_list);
510 static void remove_bo_from_vm(struct amdgpu_device *adev,
511 struct kfd_bo_va_list *entry, unsigned long size)
513 pr_debug("\t remove VA 0x%llx - 0x%llx in entry %p\n",
515 entry->va + size, entry);
516 amdgpu_vm_bo_rmv(adev, entry->bo_va);
517 list_del(&entry->bo_list);
521 static void add_kgd_mem_to_kfd_bo_list(struct kgd_mem *mem,
522 struct amdkfd_process_info *process_info,
525 struct ttm_validate_buffer *entry = &mem->validate_list;
526 struct amdgpu_bo *bo = mem->bo;
528 INIT_LIST_HEAD(&entry->head);
529 entry->num_shared = 1;
530 entry->bo = &bo->tbo;
531 mutex_lock(&process_info->lock);
533 list_add_tail(&entry->head, &process_info->userptr_valid_list);
535 list_add_tail(&entry->head, &process_info->kfd_bo_list);
536 mutex_unlock(&process_info->lock);
539 static void remove_kgd_mem_from_kfd_bo_list(struct kgd_mem *mem,
540 struct amdkfd_process_info *process_info)
542 struct ttm_validate_buffer *bo_list_entry;
544 bo_list_entry = &mem->validate_list;
545 mutex_lock(&process_info->lock);
546 list_del(&bo_list_entry->head);
547 mutex_unlock(&process_info->lock);
550 /* Initializes user pages. It registers the MMU notifier and validates
551 * the userptr BO in the GTT domain.
553 * The BO must already be on the userptr_valid_list. Otherwise an
554 * eviction and restore may happen that leaves the new BO unmapped
555 * with the user mode queues running.
557 * Takes the process_info->lock to protect against concurrent restore
560 * Returns 0 for success, negative errno for errors.
562 static int init_user_pages(struct kgd_mem *mem, uint64_t user_addr)
564 struct amdkfd_process_info *process_info = mem->process_info;
565 struct amdgpu_bo *bo = mem->bo;
566 struct ttm_operation_ctx ctx = { true, false };
569 mutex_lock(&process_info->lock);
571 ret = amdgpu_ttm_tt_set_userptr(bo->tbo.ttm, user_addr, 0);
573 pr_err("%s: Failed to set userptr: %d\n", __func__, ret);
577 ret = amdgpu_mn_register(bo, user_addr);
579 pr_err("%s: Failed to register MMU notifier: %d\n",
584 ret = amdgpu_ttm_tt_get_user_pages(bo, bo->tbo.ttm->pages);
586 pr_err("%s: Failed to get user pages: %d\n", __func__, ret);
590 ret = amdgpu_bo_reserve(bo, true);
592 pr_err("%s: Failed to reserve BO\n", __func__);
595 amdgpu_bo_placement_from_domain(bo, mem->domain);
596 ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
598 pr_err("%s: failed to validate BO\n", __func__);
599 amdgpu_bo_unreserve(bo);
602 amdgpu_ttm_tt_get_user_pages_done(bo->tbo.ttm);
605 amdgpu_mn_unregister(bo);
607 mutex_unlock(&process_info->lock);
611 /* Reserving a BO and its page table BOs must happen atomically to
612 * avoid deadlocks. Some operations update multiple VMs at once. Track
613 * all the reservation info in a context structure. Optionally a sync
614 * object can track VM updates.
616 struct bo_vm_reservation_context {
617 struct amdgpu_bo_list_entry kfd_bo; /* BO list entry for the KFD BO */
618 unsigned int n_vms; /* Number of VMs reserved */
619 struct amdgpu_bo_list_entry *vm_pd; /* Array of VM BO list entries */
620 struct ww_acquire_ctx ticket; /* Reservation ticket */
621 struct list_head list, duplicates; /* BO lists */
622 struct amdgpu_sync *sync; /* Pointer to sync object */
623 bool reserved; /* Whether BOs are reserved */
627 BO_VM_NOT_MAPPED = 0, /* Match VMs where a BO is not mapped */
628 BO_VM_MAPPED, /* Match VMs where a BO is mapped */
629 BO_VM_ALL, /* Match all VMs a BO was added to */
633 * reserve_bo_and_vm - reserve a BO and a VM unconditionally.
634 * @mem: KFD BO structure.
635 * @vm: the VM to reserve.
636 * @ctx: the struct that will be used in unreserve_bo_and_vms().
638 static int reserve_bo_and_vm(struct kgd_mem *mem,
639 struct amdgpu_vm *vm,
640 struct bo_vm_reservation_context *ctx)
642 struct amdgpu_bo *bo = mem->bo;
647 ctx->reserved = false;
649 ctx->sync = &mem->sync;
651 INIT_LIST_HEAD(&ctx->list);
652 INIT_LIST_HEAD(&ctx->duplicates);
654 ctx->vm_pd = kcalloc(ctx->n_vms, sizeof(*ctx->vm_pd), GFP_KERNEL);
658 ctx->kfd_bo.priority = 0;
659 ctx->kfd_bo.tv.bo = &bo->tbo;
660 ctx->kfd_bo.tv.num_shared = 1;
661 list_add(&ctx->kfd_bo.tv.head, &ctx->list);
663 amdgpu_vm_get_pd_bo(vm, &ctx->list, &ctx->vm_pd[0]);
665 ret = ttm_eu_reserve_buffers(&ctx->ticket, &ctx->list,
666 false, &ctx->duplicates);
668 pr_err("Failed to reserve buffers in ttm.\n");
674 ctx->reserved = true;
679 * reserve_bo_and_cond_vms - reserve a BO and some VMs conditionally
680 * @mem: KFD BO structure.
681 * @vm: the VM to reserve. If NULL, then all VMs associated with the BO
682 * is used. Otherwise, a single VM associated with the BO.
683 * @map_type: the mapping status that will be used to filter the VMs.
684 * @ctx: the struct that will be used in unreserve_bo_and_vms().
686 * Returns 0 for success, negative for failure.
688 static int reserve_bo_and_cond_vms(struct kgd_mem *mem,
689 struct amdgpu_vm *vm, enum bo_vm_match map_type,
690 struct bo_vm_reservation_context *ctx)
692 struct amdgpu_bo *bo = mem->bo;
693 struct kfd_bo_va_list *entry;
697 ctx->reserved = false;
700 ctx->sync = &mem->sync;
702 INIT_LIST_HEAD(&ctx->list);
703 INIT_LIST_HEAD(&ctx->duplicates);
705 list_for_each_entry(entry, &mem->bo_va_list, bo_list) {
706 if ((vm && vm != entry->bo_va->base.vm) ||
707 (entry->is_mapped != map_type
708 && map_type != BO_VM_ALL))
714 if (ctx->n_vms != 0) {
715 ctx->vm_pd = kcalloc(ctx->n_vms, sizeof(*ctx->vm_pd),
721 ctx->kfd_bo.priority = 0;
722 ctx->kfd_bo.tv.bo = &bo->tbo;
723 ctx->kfd_bo.tv.num_shared = 1;
724 list_add(&ctx->kfd_bo.tv.head, &ctx->list);
727 list_for_each_entry(entry, &mem->bo_va_list, bo_list) {
728 if ((vm && vm != entry->bo_va->base.vm) ||
729 (entry->is_mapped != map_type
730 && map_type != BO_VM_ALL))
733 amdgpu_vm_get_pd_bo(entry->bo_va->base.vm, &ctx->list,
738 ret = ttm_eu_reserve_buffers(&ctx->ticket, &ctx->list,
739 false, &ctx->duplicates);
741 pr_err("Failed to reserve buffers in ttm.\n");
747 ctx->reserved = true;
752 * unreserve_bo_and_vms - Unreserve BO and VMs from a reservation context
753 * @ctx: Reservation context to unreserve
754 * @wait: Optionally wait for a sync object representing pending VM updates
755 * @intr: Whether the wait is interruptible
757 * Also frees any resources allocated in
758 * reserve_bo_and_(cond_)vm(s). Returns the status from
761 static int unreserve_bo_and_vms(struct bo_vm_reservation_context *ctx,
762 bool wait, bool intr)
767 ret = amdgpu_sync_wait(ctx->sync, intr);
770 ttm_eu_backoff_reservation(&ctx->ticket, &ctx->list);
775 ctx->reserved = false;
781 static int unmap_bo_from_gpuvm(struct amdgpu_device *adev,
782 struct kfd_bo_va_list *entry,
783 struct amdgpu_sync *sync)
785 struct amdgpu_bo_va *bo_va = entry->bo_va;
786 struct amdgpu_vm *vm = bo_va->base.vm;
788 amdgpu_vm_bo_unmap(adev, bo_va, entry->va);
790 amdgpu_vm_clear_freed(adev, vm, &bo_va->last_pt_update);
792 amdgpu_sync_fence(sync, bo_va->last_pt_update);
797 static int update_gpuvm_pte(struct amdgpu_device *adev,
798 struct kfd_bo_va_list *entry,
799 struct amdgpu_sync *sync)
802 struct amdgpu_bo_va *bo_va = entry->bo_va;
804 /* Update the page tables */
805 ret = amdgpu_vm_bo_update(adev, bo_va, false);
807 pr_err("amdgpu_vm_bo_update failed\n");
811 return amdgpu_sync_fence(sync, bo_va->last_pt_update);
814 static int map_bo_to_gpuvm(struct amdgpu_device *adev,
815 struct kfd_bo_va_list *entry, struct amdgpu_sync *sync,
820 /* Set virtual address for the allocation */
821 ret = amdgpu_vm_bo_map(adev, entry->bo_va, entry->va, 0,
822 amdgpu_bo_size(entry->bo_va->base.bo),
825 pr_err("Failed to map VA 0x%llx in vm. ret %d\n",
833 ret = update_gpuvm_pte(adev, entry, sync);
835 pr_err("update_gpuvm_pte() failed\n");
836 goto update_gpuvm_pte_failed;
841 update_gpuvm_pte_failed:
842 unmap_bo_from_gpuvm(adev, entry, sync);
846 static struct sg_table *create_doorbell_sg(uint64_t addr, uint32_t size)
848 struct sg_table *sg = kmalloc(sizeof(*sg), GFP_KERNEL);
852 if (sg_alloc_table(sg, 1, GFP_KERNEL)) {
856 sg->sgl->dma_address = addr;
857 sg->sgl->length = size;
858 #ifdef CONFIG_NEED_SG_DMA_LENGTH
859 sg->sgl->dma_length = size;
864 static int process_validate_vms(struct amdkfd_process_info *process_info)
866 struct amdgpu_vm *peer_vm;
869 list_for_each_entry(peer_vm, &process_info->vm_list_head,
871 ret = vm_validate_pt_pd_bos(peer_vm);
879 static int process_sync_pds_resv(struct amdkfd_process_info *process_info,
880 struct amdgpu_sync *sync)
882 struct amdgpu_vm *peer_vm;
885 list_for_each_entry(peer_vm, &process_info->vm_list_head,
887 struct amdgpu_bo *pd = peer_vm->root.base.bo;
889 ret = amdgpu_sync_resv(NULL, sync, pd->tbo.base.resv,
890 AMDGPU_SYNC_NE_OWNER,
891 AMDGPU_FENCE_OWNER_KFD);
899 static int process_update_pds(struct amdkfd_process_info *process_info,
900 struct amdgpu_sync *sync)
902 struct amdgpu_vm *peer_vm;
905 list_for_each_entry(peer_vm, &process_info->vm_list_head,
907 ret = vm_update_pds(peer_vm, sync);
915 static int init_kfd_vm(struct amdgpu_vm *vm, void **process_info,
916 struct dma_fence **ef)
918 struct amdkfd_process_info *info = NULL;
921 if (!*process_info) {
922 info = kzalloc(sizeof(*info), GFP_KERNEL);
926 mutex_init(&info->lock);
927 INIT_LIST_HEAD(&info->vm_list_head);
928 INIT_LIST_HEAD(&info->kfd_bo_list);
929 INIT_LIST_HEAD(&info->userptr_valid_list);
930 INIT_LIST_HEAD(&info->userptr_inval_list);
932 info->eviction_fence =
933 amdgpu_amdkfd_fence_create(dma_fence_context_alloc(1),
935 if (!info->eviction_fence) {
936 pr_err("Failed to create eviction fence\n");
938 goto create_evict_fence_fail;
941 info->pid = get_task_pid(current->group_leader, PIDTYPE_PID);
942 atomic_set(&info->evicted_bos, 0);
943 INIT_DELAYED_WORK(&info->restore_userptr_work,
944 amdgpu_amdkfd_restore_userptr_worker);
946 *process_info = info;
947 *ef = dma_fence_get(&info->eviction_fence->base);
950 vm->process_info = *process_info;
952 /* Validate page directory and attach eviction fence */
953 ret = amdgpu_bo_reserve(vm->root.base.bo, true);
955 goto reserve_pd_fail;
956 ret = vm_validate_pt_pd_bos(vm);
958 pr_err("validate_pt_pd_bos() failed\n");
959 goto validate_pd_fail;
961 ret = amdgpu_bo_sync_wait(vm->root.base.bo,
962 AMDGPU_FENCE_OWNER_KFD, false);
965 ret = dma_resv_reserve_shared(vm->root.base.bo->tbo.base.resv, 1);
967 goto reserve_shared_fail;
968 amdgpu_bo_fence(vm->root.base.bo,
969 &vm->process_info->eviction_fence->base, true);
970 amdgpu_bo_unreserve(vm->root.base.bo);
972 /* Update process info */
973 mutex_lock(&vm->process_info->lock);
974 list_add_tail(&vm->vm_list_node,
975 &(vm->process_info->vm_list_head));
976 vm->process_info->n_vms++;
977 mutex_unlock(&vm->process_info->lock);
984 amdgpu_bo_unreserve(vm->root.base.bo);
986 vm->process_info = NULL;
988 /* Two fence references: one in info and one in *ef */
989 dma_fence_put(&info->eviction_fence->base);
992 *process_info = NULL;
994 create_evict_fence_fail:
995 mutex_destroy(&info->lock);
1001 int amdgpu_amdkfd_gpuvm_create_process_vm(struct kgd_dev *kgd, unsigned int pasid,
1002 void **vm, void **process_info,
1003 struct dma_fence **ef)
1005 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1006 struct amdgpu_vm *new_vm;
1009 new_vm = kzalloc(sizeof(*new_vm), GFP_KERNEL);
1013 /* Initialize AMDGPU part of the VM */
1014 ret = amdgpu_vm_init(adev, new_vm, AMDGPU_VM_CONTEXT_COMPUTE, pasid);
1016 pr_err("Failed init vm ret %d\n", ret);
1017 goto amdgpu_vm_init_fail;
1020 /* Initialize KFD part of the VM and process info */
1021 ret = init_kfd_vm(new_vm, process_info, ef);
1023 goto init_kfd_vm_fail;
1025 *vm = (void *) new_vm;
1030 amdgpu_vm_fini(adev, new_vm);
1031 amdgpu_vm_init_fail:
1036 int amdgpu_amdkfd_gpuvm_acquire_process_vm(struct kgd_dev *kgd,
1037 struct file *filp, unsigned int pasid,
1038 void **vm, void **process_info,
1039 struct dma_fence **ef)
1041 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1042 struct drm_file *drm_priv = filp->private_data;
1043 struct amdgpu_fpriv *drv_priv = drm_priv->driver_priv;
1044 struct amdgpu_vm *avm = &drv_priv->vm;
1047 /* Already a compute VM? */
1048 if (avm->process_info)
1051 /* Convert VM into a compute VM */
1052 ret = amdgpu_vm_make_compute(adev, avm, pasid);
1056 /* Initialize KFD part of the VM and process info */
1057 ret = init_kfd_vm(avm, process_info, ef);
1066 void amdgpu_amdkfd_gpuvm_destroy_cb(struct amdgpu_device *adev,
1067 struct amdgpu_vm *vm)
1069 struct amdkfd_process_info *process_info = vm->process_info;
1070 struct amdgpu_bo *pd = vm->root.base.bo;
1075 /* Release eviction fence from PD */
1076 amdgpu_bo_reserve(pd, false);
1077 amdgpu_bo_fence(pd, NULL, false);
1078 amdgpu_bo_unreserve(pd);
1080 /* Update process info */
1081 mutex_lock(&process_info->lock);
1082 process_info->n_vms--;
1083 list_del(&vm->vm_list_node);
1084 mutex_unlock(&process_info->lock);
1086 vm->process_info = NULL;
1088 /* Release per-process resources when last compute VM is destroyed */
1089 if (!process_info->n_vms) {
1090 WARN_ON(!list_empty(&process_info->kfd_bo_list));
1091 WARN_ON(!list_empty(&process_info->userptr_valid_list));
1092 WARN_ON(!list_empty(&process_info->userptr_inval_list));
1094 dma_fence_put(&process_info->eviction_fence->base);
1095 cancel_delayed_work_sync(&process_info->restore_userptr_work);
1096 put_pid(process_info->pid);
1097 mutex_destroy(&process_info->lock);
1098 kfree(process_info);
1102 void amdgpu_amdkfd_gpuvm_destroy_process_vm(struct kgd_dev *kgd, void *vm)
1104 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1105 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1107 if (WARN_ON(!kgd || !vm))
1110 pr_debug("Destroying process vm %p\n", vm);
1112 /* Release the VM context */
1113 amdgpu_vm_fini(adev, avm);
1117 void amdgpu_amdkfd_gpuvm_release_process_vm(struct kgd_dev *kgd, void *vm)
1119 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1120 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1122 if (WARN_ON(!kgd || !vm))
1125 pr_debug("Releasing process vm %p\n", vm);
1127 /* The original pasid of amdgpu vm has already been
1128 * released during making a amdgpu vm to a compute vm
1129 * The current pasid is managed by kfd and will be
1130 * released on kfd process destroy. Set amdgpu pasid
1131 * to 0 to avoid duplicate release.
1133 amdgpu_vm_release_compute(adev, avm);
1136 uint64_t amdgpu_amdkfd_gpuvm_get_process_page_dir(void *vm)
1138 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1139 struct amdgpu_bo *pd = avm->root.base.bo;
1140 struct amdgpu_device *adev = amdgpu_ttm_adev(pd->tbo.bdev);
1142 if (adev->asic_type < CHIP_VEGA10)
1143 return avm->pd_phys_addr >> AMDGPU_GPU_PAGE_SHIFT;
1144 return avm->pd_phys_addr;
1147 int amdgpu_amdkfd_gpuvm_alloc_memory_of_gpu(
1148 struct kgd_dev *kgd, uint64_t va, uint64_t size,
1149 void *vm, struct kgd_mem **mem,
1150 uint64_t *offset, uint32_t flags)
1152 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1153 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1154 enum ttm_bo_type bo_type = ttm_bo_type_device;
1155 struct sg_table *sg = NULL;
1156 uint64_t user_addr = 0;
1157 struct amdgpu_bo *bo;
1158 struct amdgpu_bo_param bp;
1159 u32 domain, alloc_domain;
1164 * Check on which domain to allocate BO
1166 if (flags & KFD_IOC_ALLOC_MEM_FLAGS_VRAM) {
1167 domain = alloc_domain = AMDGPU_GEM_DOMAIN_VRAM;
1168 alloc_flags = AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE;
1169 alloc_flags |= (flags & KFD_IOC_ALLOC_MEM_FLAGS_PUBLIC) ?
1170 AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED :
1171 AMDGPU_GEM_CREATE_NO_CPU_ACCESS;
1172 } else if (flags & KFD_IOC_ALLOC_MEM_FLAGS_GTT) {
1173 domain = alloc_domain = AMDGPU_GEM_DOMAIN_GTT;
1175 } else if (flags & KFD_IOC_ALLOC_MEM_FLAGS_USERPTR) {
1176 domain = AMDGPU_GEM_DOMAIN_GTT;
1177 alloc_domain = AMDGPU_GEM_DOMAIN_CPU;
1179 if (!offset || !*offset)
1181 user_addr = untagged_addr(*offset);
1182 } else if (flags & (KFD_IOC_ALLOC_MEM_FLAGS_DOORBELL |
1183 KFD_IOC_ALLOC_MEM_FLAGS_MMIO_REMAP)) {
1184 domain = AMDGPU_GEM_DOMAIN_GTT;
1185 alloc_domain = AMDGPU_GEM_DOMAIN_CPU;
1186 bo_type = ttm_bo_type_sg;
1188 if (size > UINT_MAX)
1190 sg = create_doorbell_sg(*offset, size);
1197 *mem = kzalloc(sizeof(struct kgd_mem), GFP_KERNEL);
1202 INIT_LIST_HEAD(&(*mem)->bo_va_list);
1203 mutex_init(&(*mem)->lock);
1204 (*mem)->aql_queue = !!(flags & KFD_IOC_ALLOC_MEM_FLAGS_AQL_QUEUE_MEM);
1206 /* Workaround for AQL queue wraparound bug. Map the same
1207 * memory twice. That means we only actually allocate half
1210 if ((*mem)->aql_queue)
1213 (*mem)->alloc_flags = flags;
1215 amdgpu_sync_create(&(*mem)->sync);
1217 ret = amdgpu_amdkfd_reserve_mem_limit(adev, size, alloc_domain, !!sg);
1219 pr_debug("Insufficient system memory\n");
1220 goto err_reserve_limit;
1223 pr_debug("\tcreate BO VA 0x%llx size 0x%llx domain %s\n",
1224 va, size, domain_string(alloc_domain));
1226 memset(&bp, 0, sizeof(bp));
1229 bp.domain = alloc_domain;
1230 bp.flags = alloc_flags;
1233 ret = amdgpu_bo_create(adev, &bp, &bo);
1235 pr_debug("Failed to create BO on domain %s. ret %d\n",
1236 domain_string(alloc_domain), ret);
1239 if (bo_type == ttm_bo_type_sg) {
1241 bo->tbo.ttm->sg = sg;
1246 bo->flags |= AMDGPU_AMDKFD_USERPTR_BO;
1249 (*mem)->domain = domain;
1250 (*mem)->mapped_to_gpu_memory = 0;
1251 (*mem)->process_info = avm->process_info;
1252 add_kgd_mem_to_kfd_bo_list(*mem, avm->process_info, user_addr);
1255 ret = init_user_pages(*mem, user_addr);
1257 goto allocate_init_user_pages_failed;
1261 *offset = amdgpu_bo_mmap_offset(bo);
1265 allocate_init_user_pages_failed:
1266 remove_kgd_mem_from_kfd_bo_list(*mem, avm->process_info);
1267 amdgpu_bo_unref(&bo);
1268 /* Don't unreserve system mem limit twice */
1269 goto err_reserve_limit;
1271 unreserve_mem_limit(adev, size, alloc_domain, !!sg);
1273 mutex_destroy(&(*mem)->lock);
1283 int amdgpu_amdkfd_gpuvm_free_memory_of_gpu(
1284 struct kgd_dev *kgd, struct kgd_mem *mem, uint64_t *size)
1286 struct amdkfd_process_info *process_info = mem->process_info;
1287 unsigned long bo_size = mem->bo->tbo.mem.size;
1288 struct kfd_bo_va_list *entry, *tmp;
1289 struct bo_vm_reservation_context ctx;
1290 struct ttm_validate_buffer *bo_list_entry;
1291 unsigned int mapped_to_gpu_memory;
1293 bool is_imported = 0;
1295 mutex_lock(&mem->lock);
1296 mapped_to_gpu_memory = mem->mapped_to_gpu_memory;
1297 is_imported = mem->is_imported;
1298 mutex_unlock(&mem->lock);
1299 /* lock is not needed after this, since mem is unused and will
1303 if (mapped_to_gpu_memory > 0) {
1304 pr_debug("BO VA 0x%llx size 0x%lx is still mapped.\n",
1309 /* Make sure restore workers don't access the BO any more */
1310 bo_list_entry = &mem->validate_list;
1311 mutex_lock(&process_info->lock);
1312 list_del(&bo_list_entry->head);
1313 mutex_unlock(&process_info->lock);
1315 /* No more MMU notifiers */
1316 amdgpu_mn_unregister(mem->bo);
1318 ret = reserve_bo_and_cond_vms(mem, NULL, BO_VM_ALL, &ctx);
1322 /* The eviction fence should be removed by the last unmap.
1323 * TODO: Log an error condition if the bo still has the eviction fence
1326 amdgpu_amdkfd_remove_eviction_fence(mem->bo,
1327 process_info->eviction_fence);
1328 pr_debug("Release VA 0x%llx - 0x%llx\n", mem->va,
1329 mem->va + bo_size * (1 + mem->aql_queue));
1331 /* Remove from VM internal data structures */
1332 list_for_each_entry_safe(entry, tmp, &mem->bo_va_list, bo_list)
1333 remove_bo_from_vm((struct amdgpu_device *)entry->kgd_dev,
1336 ret = unreserve_bo_and_vms(&ctx, false, false);
1338 /* Free the sync object */
1339 amdgpu_sync_free(&mem->sync);
1341 /* If the SG is not NULL, it's one we created for a doorbell or mmio
1342 * remap BO. We need to free it.
1344 if (mem->bo->tbo.sg) {
1345 sg_free_table(mem->bo->tbo.sg);
1346 kfree(mem->bo->tbo.sg);
1349 /* Update the size of the BO being freed if it was allocated from
1350 * VRAM and is not imported.
1353 if ((mem->bo->preferred_domains == AMDGPU_GEM_DOMAIN_VRAM) &&
1361 drm_gem_object_put(&mem->bo->tbo.base);
1362 mutex_destroy(&mem->lock);
1368 int amdgpu_amdkfd_gpuvm_map_memory_to_gpu(
1369 struct kgd_dev *kgd, struct kgd_mem *mem, void *vm)
1371 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1372 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1374 struct amdgpu_bo *bo;
1376 struct kfd_bo_va_list *entry;
1377 struct bo_vm_reservation_context ctx;
1378 struct kfd_bo_va_list *bo_va_entry = NULL;
1379 struct kfd_bo_va_list *bo_va_entry_aql = NULL;
1380 unsigned long bo_size;
1381 bool is_invalid_userptr = false;
1385 pr_err("Invalid BO when mapping memory to GPU\n");
1389 /* Make sure restore is not running concurrently. Since we
1390 * don't map invalid userptr BOs, we rely on the next restore
1391 * worker to do the mapping
1393 mutex_lock(&mem->process_info->lock);
1395 /* Lock mmap-sem. If we find an invalid userptr BO, we can be
1396 * sure that the MMU notifier is no longer running
1397 * concurrently and the queues are actually stopped
1399 if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm)) {
1400 mmap_write_lock(current->mm);
1401 is_invalid_userptr = atomic_read(&mem->invalid);
1402 mmap_write_unlock(current->mm);
1405 mutex_lock(&mem->lock);
1407 domain = mem->domain;
1408 bo_size = bo->tbo.mem.size;
1410 pr_debug("Map VA 0x%llx - 0x%llx to vm %p domain %s\n",
1412 mem->va + bo_size * (1 + mem->aql_queue),
1413 vm, domain_string(domain));
1415 ret = reserve_bo_and_vm(mem, vm, &ctx);
1419 /* Userptr can be marked as "not invalid", but not actually be
1420 * validated yet (still in the system domain). In that case
1421 * the queues are still stopped and we can leave mapping for
1422 * the next restore worker
1424 if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm) &&
1425 bo->tbo.mem.mem_type == TTM_PL_SYSTEM)
1426 is_invalid_userptr = true;
1428 if (check_if_add_bo_to_vm(avm, mem)) {
1429 ret = add_bo_to_vm(adev, mem, avm, false,
1432 goto add_bo_to_vm_failed;
1433 if (mem->aql_queue) {
1434 ret = add_bo_to_vm(adev, mem, avm,
1435 true, &bo_va_entry_aql);
1437 goto add_bo_to_vm_failed_aql;
1440 ret = vm_validate_pt_pd_bos(avm);
1442 goto add_bo_to_vm_failed;
1445 if (mem->mapped_to_gpu_memory == 0 &&
1446 !amdgpu_ttm_tt_get_usermm(bo->tbo.ttm)) {
1447 /* Validate BO only once. The eviction fence gets added to BO
1448 * the first time it is mapped. Validate will wait for all
1449 * background evictions to complete.
1451 ret = amdgpu_amdkfd_bo_validate(bo, domain, true);
1453 pr_debug("Validate failed\n");
1454 goto map_bo_to_gpuvm_failed;
1458 list_for_each_entry(entry, &mem->bo_va_list, bo_list) {
1459 if (entry->bo_va->base.vm == vm && !entry->is_mapped) {
1460 pr_debug("\t map VA 0x%llx - 0x%llx in entry %p\n",
1461 entry->va, entry->va + bo_size,
1464 ret = map_bo_to_gpuvm(adev, entry, ctx.sync,
1465 is_invalid_userptr);
1467 pr_err("Failed to map bo to gpuvm\n");
1468 goto map_bo_to_gpuvm_failed;
1471 ret = vm_update_pds(vm, ctx.sync);
1473 pr_err("Failed to update page directories\n");
1474 goto map_bo_to_gpuvm_failed;
1477 entry->is_mapped = true;
1478 mem->mapped_to_gpu_memory++;
1479 pr_debug("\t INC mapping count %d\n",
1480 mem->mapped_to_gpu_memory);
1484 if (!amdgpu_ttm_tt_get_usermm(bo->tbo.ttm) && !bo->pin_count)
1486 &avm->process_info->eviction_fence->base,
1488 ret = unreserve_bo_and_vms(&ctx, false, false);
1492 map_bo_to_gpuvm_failed:
1493 if (bo_va_entry_aql)
1494 remove_bo_from_vm(adev, bo_va_entry_aql, bo_size);
1495 add_bo_to_vm_failed_aql:
1497 remove_bo_from_vm(adev, bo_va_entry, bo_size);
1498 add_bo_to_vm_failed:
1499 unreserve_bo_and_vms(&ctx, false, false);
1501 mutex_unlock(&mem->process_info->lock);
1502 mutex_unlock(&mem->lock);
1506 int amdgpu_amdkfd_gpuvm_unmap_memory_from_gpu(
1507 struct kgd_dev *kgd, struct kgd_mem *mem, void *vm)
1509 struct amdgpu_device *adev = get_amdgpu_device(kgd);
1510 struct amdkfd_process_info *process_info =
1511 ((struct amdgpu_vm *)vm)->process_info;
1512 unsigned long bo_size = mem->bo->tbo.mem.size;
1513 struct kfd_bo_va_list *entry;
1514 struct bo_vm_reservation_context ctx;
1517 mutex_lock(&mem->lock);
1519 ret = reserve_bo_and_cond_vms(mem, vm, BO_VM_MAPPED, &ctx);
1522 /* If no VMs were reserved, it means the BO wasn't actually mapped */
1523 if (ctx.n_vms == 0) {
1528 ret = vm_validate_pt_pd_bos((struct amdgpu_vm *)vm);
1532 pr_debug("Unmap VA 0x%llx - 0x%llx from vm %p\n",
1534 mem->va + bo_size * (1 + mem->aql_queue),
1537 list_for_each_entry(entry, &mem->bo_va_list, bo_list) {
1538 if (entry->bo_va->base.vm == vm && entry->is_mapped) {
1539 pr_debug("\t unmap VA 0x%llx - 0x%llx from entry %p\n",
1541 entry->va + bo_size,
1544 ret = unmap_bo_from_gpuvm(adev, entry, ctx.sync);
1546 entry->is_mapped = false;
1548 pr_err("failed to unmap VA 0x%llx\n",
1553 mem->mapped_to_gpu_memory--;
1554 pr_debug("\t DEC mapping count %d\n",
1555 mem->mapped_to_gpu_memory);
1559 /* If BO is unmapped from all VMs, unfence it. It can be evicted if
1562 if (mem->mapped_to_gpu_memory == 0 &&
1563 !amdgpu_ttm_tt_get_usermm(mem->bo->tbo.ttm) && !mem->bo->pin_count)
1564 amdgpu_amdkfd_remove_eviction_fence(mem->bo,
1565 process_info->eviction_fence);
1568 unreserve_bo_and_vms(&ctx, false, false);
1570 mutex_unlock(&mem->lock);
1574 int amdgpu_amdkfd_gpuvm_sync_memory(
1575 struct kgd_dev *kgd, struct kgd_mem *mem, bool intr)
1577 struct amdgpu_sync sync;
1580 amdgpu_sync_create(&sync);
1582 mutex_lock(&mem->lock);
1583 amdgpu_sync_clone(&mem->sync, &sync);
1584 mutex_unlock(&mem->lock);
1586 ret = amdgpu_sync_wait(&sync, intr);
1587 amdgpu_sync_free(&sync);
1591 int amdgpu_amdkfd_gpuvm_map_gtt_bo_to_kernel(struct kgd_dev *kgd,
1592 struct kgd_mem *mem, void **kptr, uint64_t *size)
1595 struct amdgpu_bo *bo = mem->bo;
1597 if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm)) {
1598 pr_err("userptr can't be mapped to kernel\n");
1602 /* delete kgd_mem from kfd_bo_list to avoid re-validating
1603 * this BO in BO's restoring after eviction.
1605 mutex_lock(&mem->process_info->lock);
1607 ret = amdgpu_bo_reserve(bo, true);
1609 pr_err("Failed to reserve bo. ret %d\n", ret);
1610 goto bo_reserve_failed;
1613 ret = amdgpu_bo_pin(bo, AMDGPU_GEM_DOMAIN_GTT);
1615 pr_err("Failed to pin bo. ret %d\n", ret);
1619 ret = amdgpu_bo_kmap(bo, kptr);
1621 pr_err("Failed to map bo to kernel. ret %d\n", ret);
1625 amdgpu_amdkfd_remove_eviction_fence(
1626 bo, mem->process_info->eviction_fence);
1627 list_del_init(&mem->validate_list.head);
1630 *size = amdgpu_bo_size(bo);
1632 amdgpu_bo_unreserve(bo);
1634 mutex_unlock(&mem->process_info->lock);
1638 amdgpu_bo_unpin(bo);
1640 amdgpu_bo_unreserve(bo);
1642 mutex_unlock(&mem->process_info->lock);
1647 int amdgpu_amdkfd_gpuvm_get_vm_fault_info(struct kgd_dev *kgd,
1648 struct kfd_vm_fault_info *mem)
1650 struct amdgpu_device *adev;
1652 adev = (struct amdgpu_device *)kgd;
1653 if (atomic_read(&adev->gmc.vm_fault_info_updated) == 1) {
1654 *mem = *adev->gmc.vm_fault_info;
1656 atomic_set(&adev->gmc.vm_fault_info_updated, 0);
1661 int amdgpu_amdkfd_gpuvm_import_dmabuf(struct kgd_dev *kgd,
1662 struct dma_buf *dma_buf,
1663 uint64_t va, void *vm,
1664 struct kgd_mem **mem, uint64_t *size,
1665 uint64_t *mmap_offset)
1667 struct amdgpu_device *adev = (struct amdgpu_device *)kgd;
1668 struct drm_gem_object *obj;
1669 struct amdgpu_bo *bo;
1670 struct amdgpu_vm *avm = (struct amdgpu_vm *)vm;
1672 if (dma_buf->ops != &amdgpu_dmabuf_ops)
1673 /* Can't handle non-graphics buffers */
1676 obj = dma_buf->priv;
1677 if (obj->dev->dev_private != adev)
1678 /* Can't handle buffers from other devices */
1681 bo = gem_to_amdgpu_bo(obj);
1682 if (!(bo->preferred_domains & (AMDGPU_GEM_DOMAIN_VRAM |
1683 AMDGPU_GEM_DOMAIN_GTT)))
1684 /* Only VRAM and GTT BOs are supported */
1687 *mem = kzalloc(sizeof(struct kgd_mem), GFP_KERNEL);
1692 *size = amdgpu_bo_size(bo);
1695 *mmap_offset = amdgpu_bo_mmap_offset(bo);
1697 INIT_LIST_HEAD(&(*mem)->bo_va_list);
1698 mutex_init(&(*mem)->lock);
1700 (*mem)->alloc_flags =
1701 ((bo->preferred_domains & AMDGPU_GEM_DOMAIN_VRAM) ?
1702 KFD_IOC_ALLOC_MEM_FLAGS_VRAM : KFD_IOC_ALLOC_MEM_FLAGS_GTT)
1703 | KFD_IOC_ALLOC_MEM_FLAGS_WRITABLE
1704 | KFD_IOC_ALLOC_MEM_FLAGS_EXECUTABLE;
1706 drm_gem_object_get(&bo->tbo.base);
1709 (*mem)->domain = (bo->preferred_domains & AMDGPU_GEM_DOMAIN_VRAM) ?
1710 AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT;
1711 (*mem)->mapped_to_gpu_memory = 0;
1712 (*mem)->process_info = avm->process_info;
1713 add_kgd_mem_to_kfd_bo_list(*mem, avm->process_info, false);
1714 amdgpu_sync_create(&(*mem)->sync);
1715 (*mem)->is_imported = true;
1720 /* Evict a userptr BO by stopping the queues if necessary
1722 * Runs in MMU notifier, may be in RECLAIM_FS context. This means it
1723 * cannot do any memory allocations, and cannot take any locks that
1724 * are held elsewhere while allocating memory. Therefore this is as
1725 * simple as possible, using atomic counters.
1727 * It doesn't do anything to the BO itself. The real work happens in
1728 * restore, where we get updated page addresses. This function only
1729 * ensures that GPU access to the BO is stopped.
1731 int amdgpu_amdkfd_evict_userptr(struct kgd_mem *mem,
1732 struct mm_struct *mm)
1734 struct amdkfd_process_info *process_info = mem->process_info;
1738 atomic_inc(&mem->invalid);
1739 evicted_bos = atomic_inc_return(&process_info->evicted_bos);
1740 if (evicted_bos == 1) {
1741 /* First eviction, stop the queues */
1742 r = kgd2kfd_quiesce_mm(mm);
1744 pr_err("Failed to quiesce KFD\n");
1745 schedule_delayed_work(&process_info->restore_userptr_work,
1746 msecs_to_jiffies(AMDGPU_USERPTR_RESTORE_DELAY_MS));
1752 /* Update invalid userptr BOs
1754 * Moves invalidated (evicted) userptr BOs from userptr_valid_list to
1755 * userptr_inval_list and updates user pages for all BOs that have
1756 * been invalidated since their last update.
1758 static int update_invalid_user_pages(struct amdkfd_process_info *process_info,
1759 struct mm_struct *mm)
1761 struct kgd_mem *mem, *tmp_mem;
1762 struct amdgpu_bo *bo;
1763 struct ttm_operation_ctx ctx = { false, false };
1766 /* Move all invalidated BOs to the userptr_inval_list and
1767 * release their user pages by migration to the CPU domain
1769 list_for_each_entry_safe(mem, tmp_mem,
1770 &process_info->userptr_valid_list,
1771 validate_list.head) {
1772 if (!atomic_read(&mem->invalid))
1773 continue; /* BO is still valid */
1777 if (amdgpu_bo_reserve(bo, true))
1779 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
1780 ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
1781 amdgpu_bo_unreserve(bo);
1783 pr_err("%s: Failed to invalidate userptr BO\n",
1788 list_move_tail(&mem->validate_list.head,
1789 &process_info->userptr_inval_list);
1792 if (list_empty(&process_info->userptr_inval_list))
1793 return 0; /* All evicted userptr BOs were freed */
1795 /* Go through userptr_inval_list and update any invalid user_pages */
1796 list_for_each_entry(mem, &process_info->userptr_inval_list,
1797 validate_list.head) {
1798 invalid = atomic_read(&mem->invalid);
1800 /* BO hasn't been invalidated since the last
1801 * revalidation attempt. Keep its BO list.
1807 /* Get updated user pages */
1808 ret = amdgpu_ttm_tt_get_user_pages(bo, bo->tbo.ttm->pages);
1810 pr_debug("%s: Failed to get user pages: %d\n",
1813 /* Return error -EBUSY or -ENOMEM, retry restore */
1818 * FIXME: Cannot ignore the return code, must hold
1821 amdgpu_ttm_tt_get_user_pages_done(bo->tbo.ttm);
1823 /* Mark the BO as valid unless it was invalidated
1824 * again concurrently.
1826 if (atomic_cmpxchg(&mem->invalid, invalid, 0) != invalid)
1833 /* Validate invalid userptr BOs
1835 * Validates BOs on the userptr_inval_list, and moves them back to the
1836 * userptr_valid_list. Also updates GPUVM page tables with new page
1837 * addresses and waits for the page table updates to complete.
1839 static int validate_invalid_user_pages(struct amdkfd_process_info *process_info)
1841 struct amdgpu_bo_list_entry *pd_bo_list_entries;
1842 struct list_head resv_list, duplicates;
1843 struct ww_acquire_ctx ticket;
1844 struct amdgpu_sync sync;
1846 struct amdgpu_vm *peer_vm;
1847 struct kgd_mem *mem, *tmp_mem;
1848 struct amdgpu_bo *bo;
1849 struct ttm_operation_ctx ctx = { false, false };
1852 pd_bo_list_entries = kcalloc(process_info->n_vms,
1853 sizeof(struct amdgpu_bo_list_entry),
1855 if (!pd_bo_list_entries) {
1856 pr_err("%s: Failed to allocate PD BO list entries\n", __func__);
1861 INIT_LIST_HEAD(&resv_list);
1862 INIT_LIST_HEAD(&duplicates);
1864 /* Get all the page directory BOs that need to be reserved */
1866 list_for_each_entry(peer_vm, &process_info->vm_list_head,
1868 amdgpu_vm_get_pd_bo(peer_vm, &resv_list,
1869 &pd_bo_list_entries[i++]);
1870 /* Add the userptr_inval_list entries to resv_list */
1871 list_for_each_entry(mem, &process_info->userptr_inval_list,
1872 validate_list.head) {
1873 list_add_tail(&mem->resv_list.head, &resv_list);
1874 mem->resv_list.bo = mem->validate_list.bo;
1875 mem->resv_list.num_shared = mem->validate_list.num_shared;
1878 /* Reserve all BOs and page tables for validation */
1879 ret = ttm_eu_reserve_buffers(&ticket, &resv_list, false, &duplicates);
1880 WARN(!list_empty(&duplicates), "Duplicates should be empty");
1884 amdgpu_sync_create(&sync);
1886 ret = process_validate_vms(process_info);
1890 /* Validate BOs and update GPUVM page tables */
1891 list_for_each_entry_safe(mem, tmp_mem,
1892 &process_info->userptr_inval_list,
1893 validate_list.head) {
1894 struct kfd_bo_va_list *bo_va_entry;
1898 /* Validate the BO if we got user pages */
1899 if (bo->tbo.ttm->pages[0]) {
1900 amdgpu_bo_placement_from_domain(bo, mem->domain);
1901 ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
1903 pr_err("%s: failed to validate BO\n", __func__);
1908 list_move_tail(&mem->validate_list.head,
1909 &process_info->userptr_valid_list);
1911 /* Update mapping. If the BO was not validated
1912 * (because we couldn't get user pages), this will
1913 * clear the page table entries, which will result in
1914 * VM faults if the GPU tries to access the invalid
1917 list_for_each_entry(bo_va_entry, &mem->bo_va_list, bo_list) {
1918 if (!bo_va_entry->is_mapped)
1921 ret = update_gpuvm_pte((struct amdgpu_device *)
1922 bo_va_entry->kgd_dev,
1923 bo_va_entry, &sync);
1925 pr_err("%s: update PTE failed\n", __func__);
1926 /* make sure this gets validated again */
1927 atomic_inc(&mem->invalid);
1933 /* Update page directories */
1934 ret = process_update_pds(process_info, &sync);
1937 ttm_eu_backoff_reservation(&ticket, &resv_list);
1938 amdgpu_sync_wait(&sync, false);
1939 amdgpu_sync_free(&sync);
1941 kfree(pd_bo_list_entries);
1947 /* Worker callback to restore evicted userptr BOs
1949 * Tries to update and validate all userptr BOs. If successful and no
1950 * concurrent evictions happened, the queues are restarted. Otherwise,
1951 * reschedule for another attempt later.
1953 static void amdgpu_amdkfd_restore_userptr_worker(struct work_struct *work)
1955 struct delayed_work *dwork = to_delayed_work(work);
1956 struct amdkfd_process_info *process_info =
1957 container_of(dwork, struct amdkfd_process_info,
1958 restore_userptr_work);
1959 struct task_struct *usertask;
1960 struct mm_struct *mm;
1963 evicted_bos = atomic_read(&process_info->evicted_bos);
1967 /* Reference task and mm in case of concurrent process termination */
1968 usertask = get_pid_task(process_info->pid, PIDTYPE_PID);
1971 mm = get_task_mm(usertask);
1973 put_task_struct(usertask);
1977 mutex_lock(&process_info->lock);
1979 if (update_invalid_user_pages(process_info, mm))
1981 /* userptr_inval_list can be empty if all evicted userptr BOs
1982 * have been freed. In that case there is nothing to validate
1983 * and we can just restart the queues.
1985 if (!list_empty(&process_info->userptr_inval_list)) {
1986 if (atomic_read(&process_info->evicted_bos) != evicted_bos)
1987 goto unlock_out; /* Concurrent eviction, try again */
1989 if (validate_invalid_user_pages(process_info))
1992 /* Final check for concurrent evicton and atomic update. If
1993 * another eviction happens after successful update, it will
1994 * be a first eviction that calls quiesce_mm. The eviction
1995 * reference counting inside KFD will handle this case.
1997 if (atomic_cmpxchg(&process_info->evicted_bos, evicted_bos, 0) !=
2001 if (kgd2kfd_resume_mm(mm)) {
2002 pr_err("%s: Failed to resume KFD\n", __func__);
2003 /* No recovery from this failure. Probably the CP is
2004 * hanging. No point trying again.
2009 mutex_unlock(&process_info->lock);
2011 put_task_struct(usertask);
2013 /* If validation failed, reschedule another attempt */
2015 schedule_delayed_work(&process_info->restore_userptr_work,
2016 msecs_to_jiffies(AMDGPU_USERPTR_RESTORE_DELAY_MS));
2019 /** amdgpu_amdkfd_gpuvm_restore_process_bos - Restore all BOs for the given
2020 * KFD process identified by process_info
2022 * @process_info: amdkfd_process_info of the KFD process
2024 * After memory eviction, restore thread calls this function. The function
2025 * should be called when the Process is still valid. BO restore involves -
2027 * 1. Release old eviction fence and create new one
2028 * 2. Get two copies of PD BO list from all the VMs. Keep one copy as pd_list.
2029 * 3 Use the second PD list and kfd_bo_list to create a list (ctx.list) of
2030 * BOs that need to be reserved.
2031 * 4. Reserve all the BOs
2032 * 5. Validate of PD and PT BOs.
2033 * 6. Validate all KFD BOs using kfd_bo_list and Map them and add new fence
2034 * 7. Add fence to all PD and PT BOs.
2035 * 8. Unreserve all BOs
2037 int amdgpu_amdkfd_gpuvm_restore_process_bos(void *info, struct dma_fence **ef)
2039 struct amdgpu_bo_list_entry *pd_bo_list;
2040 struct amdkfd_process_info *process_info = info;
2041 struct amdgpu_vm *peer_vm;
2042 struct kgd_mem *mem;
2043 struct bo_vm_reservation_context ctx;
2044 struct amdgpu_amdkfd_fence *new_fence;
2046 struct list_head duplicate_save;
2047 struct amdgpu_sync sync_obj;
2049 INIT_LIST_HEAD(&duplicate_save);
2050 INIT_LIST_HEAD(&ctx.list);
2051 INIT_LIST_HEAD(&ctx.duplicates);
2053 pd_bo_list = kcalloc(process_info->n_vms,
2054 sizeof(struct amdgpu_bo_list_entry),
2060 mutex_lock(&process_info->lock);
2061 list_for_each_entry(peer_vm, &process_info->vm_list_head,
2063 amdgpu_vm_get_pd_bo(peer_vm, &ctx.list, &pd_bo_list[i++]);
2065 /* Reserve all BOs and page tables/directory. Add all BOs from
2066 * kfd_bo_list to ctx.list
2068 list_for_each_entry(mem, &process_info->kfd_bo_list,
2069 validate_list.head) {
2071 list_add_tail(&mem->resv_list.head, &ctx.list);
2072 mem->resv_list.bo = mem->validate_list.bo;
2073 mem->resv_list.num_shared = mem->validate_list.num_shared;
2076 ret = ttm_eu_reserve_buffers(&ctx.ticket, &ctx.list,
2077 false, &duplicate_save);
2079 pr_debug("Memory eviction: TTM Reserve Failed. Try again\n");
2080 goto ttm_reserve_fail;
2083 amdgpu_sync_create(&sync_obj);
2085 /* Validate PDs and PTs */
2086 ret = process_validate_vms(process_info);
2088 goto validate_map_fail;
2090 ret = process_sync_pds_resv(process_info, &sync_obj);
2092 pr_debug("Memory eviction: Failed to sync to PD BO moving fence. Try again\n");
2093 goto validate_map_fail;
2096 /* Validate BOs and map them to GPUVM (update VM page tables). */
2097 list_for_each_entry(mem, &process_info->kfd_bo_list,
2098 validate_list.head) {
2100 struct amdgpu_bo *bo = mem->bo;
2101 uint32_t domain = mem->domain;
2102 struct kfd_bo_va_list *bo_va_entry;
2104 ret = amdgpu_amdkfd_bo_validate(bo, domain, false);
2106 pr_debug("Memory eviction: Validate BOs failed. Try again\n");
2107 goto validate_map_fail;
2109 ret = amdgpu_sync_fence(&sync_obj, bo->tbo.moving);
2111 pr_debug("Memory eviction: Sync BO fence failed. Try again\n");
2112 goto validate_map_fail;
2114 list_for_each_entry(bo_va_entry, &mem->bo_va_list,
2116 ret = update_gpuvm_pte((struct amdgpu_device *)
2117 bo_va_entry->kgd_dev,
2121 pr_debug("Memory eviction: update PTE failed. Try again\n");
2122 goto validate_map_fail;
2127 /* Update page directories */
2128 ret = process_update_pds(process_info, &sync_obj);
2130 pr_debug("Memory eviction: update PDs failed. Try again\n");
2131 goto validate_map_fail;
2134 /* Wait for validate and PT updates to finish */
2135 amdgpu_sync_wait(&sync_obj, false);
2137 /* Release old eviction fence and create new one, because fence only
2138 * goes from unsignaled to signaled, fence cannot be reused.
2139 * Use context and mm from the old fence.
2141 new_fence = amdgpu_amdkfd_fence_create(
2142 process_info->eviction_fence->base.context,
2143 process_info->eviction_fence->mm);
2145 pr_err("Failed to create eviction fence\n");
2147 goto validate_map_fail;
2149 dma_fence_put(&process_info->eviction_fence->base);
2150 process_info->eviction_fence = new_fence;
2151 *ef = dma_fence_get(&new_fence->base);
2153 /* Attach new eviction fence to all BOs */
2154 list_for_each_entry(mem, &process_info->kfd_bo_list,
2156 amdgpu_bo_fence(mem->bo,
2157 &process_info->eviction_fence->base, true);
2159 /* Attach eviction fence to PD / PT BOs */
2160 list_for_each_entry(peer_vm, &process_info->vm_list_head,
2162 struct amdgpu_bo *bo = peer_vm->root.base.bo;
2164 amdgpu_bo_fence(bo, &process_info->eviction_fence->base, true);
2168 ttm_eu_backoff_reservation(&ctx.ticket, &ctx.list);
2169 amdgpu_sync_free(&sync_obj);
2171 mutex_unlock(&process_info->lock);
2176 int amdgpu_amdkfd_add_gws_to_process(void *info, void *gws, struct kgd_mem **mem)
2178 struct amdkfd_process_info *process_info = (struct amdkfd_process_info *)info;
2179 struct amdgpu_bo *gws_bo = (struct amdgpu_bo *)gws;
2185 *mem = kzalloc(sizeof(struct kgd_mem), GFP_KERNEL);
2189 mutex_init(&(*mem)->lock);
2190 INIT_LIST_HEAD(&(*mem)->bo_va_list);
2191 (*mem)->bo = amdgpu_bo_ref(gws_bo);
2192 (*mem)->domain = AMDGPU_GEM_DOMAIN_GWS;
2193 (*mem)->process_info = process_info;
2194 add_kgd_mem_to_kfd_bo_list(*mem, process_info, false);
2195 amdgpu_sync_create(&(*mem)->sync);
2198 /* Validate gws bo the first time it is added to process */
2199 mutex_lock(&(*mem)->process_info->lock);
2200 ret = amdgpu_bo_reserve(gws_bo, false);
2201 if (unlikely(ret)) {
2202 pr_err("Reserve gws bo failed %d\n", ret);
2203 goto bo_reservation_failure;
2206 ret = amdgpu_amdkfd_bo_validate(gws_bo, AMDGPU_GEM_DOMAIN_GWS, true);
2208 pr_err("GWS BO validate failed %d\n", ret);
2209 goto bo_validation_failure;
2211 /* GWS resource is shared b/t amdgpu and amdkfd
2212 * Add process eviction fence to bo so they can
2215 ret = dma_resv_reserve_shared(gws_bo->tbo.base.resv, 1);
2217 goto reserve_shared_fail;
2218 amdgpu_bo_fence(gws_bo, &process_info->eviction_fence->base, true);
2219 amdgpu_bo_unreserve(gws_bo);
2220 mutex_unlock(&(*mem)->process_info->lock);
2224 reserve_shared_fail:
2225 bo_validation_failure:
2226 amdgpu_bo_unreserve(gws_bo);
2227 bo_reservation_failure:
2228 mutex_unlock(&(*mem)->process_info->lock);
2229 amdgpu_sync_free(&(*mem)->sync);
2230 remove_kgd_mem_from_kfd_bo_list(*mem, process_info);
2231 amdgpu_bo_unref(&gws_bo);
2232 mutex_destroy(&(*mem)->lock);
2238 int amdgpu_amdkfd_remove_gws_from_process(void *info, void *mem)
2241 struct amdkfd_process_info *process_info = (struct amdkfd_process_info *)info;
2242 struct kgd_mem *kgd_mem = (struct kgd_mem *)mem;
2243 struct amdgpu_bo *gws_bo = kgd_mem->bo;
2245 /* Remove BO from process's validate list so restore worker won't touch
2248 remove_kgd_mem_from_kfd_bo_list(kgd_mem, process_info);
2250 ret = amdgpu_bo_reserve(gws_bo, false);
2251 if (unlikely(ret)) {
2252 pr_err("Reserve gws bo failed %d\n", ret);
2253 //TODO add BO back to validate_list?
2256 amdgpu_amdkfd_remove_eviction_fence(gws_bo,
2257 process_info->eviction_fence);
2258 amdgpu_bo_unreserve(gws_bo);
2259 amdgpu_sync_free(&kgd_mem->sync);
2260 amdgpu_bo_unref(&gws_bo);
2261 mutex_destroy(&kgd_mem->lock);
2266 /* Returns GPU-specific tiling mode information */
2267 int amdgpu_amdkfd_get_tile_config(struct kgd_dev *kgd,
2268 struct tile_config *config)
2270 struct amdgpu_device *adev = (struct amdgpu_device *)kgd;
2272 config->gb_addr_config = adev->gfx.config.gb_addr_config;
2273 config->tile_config_ptr = adev->gfx.config.tile_mode_array;
2274 config->num_tile_configs =
2275 ARRAY_SIZE(adev->gfx.config.tile_mode_array);
2276 config->macro_tile_config_ptr =
2277 adev->gfx.config.macrotile_mode_array;
2278 config->num_macro_tile_configs =
2279 ARRAY_SIZE(adev->gfx.config.macrotile_mode_array);
2281 /* Those values are not set from GFX9 onwards */
2282 config->num_banks = adev->gfx.config.num_banks;
2283 config->num_ranks = adev->gfx.config.num_ranks;