1 // SPDX-License-Identifier: MIT
3 * Copyright © 2022 Intel Corporation
10 #include "xe_drm_client.h"
12 #include "xe_gt_tlb_invalidation.h"
13 #include "xe_migrate.h"
14 #include "xe_pt_types.h"
15 #include "xe_pt_walk.h"
16 #include "xe_res_cursor.h"
18 #include "xe_ttm_stolen_mgr.h"
23 /** @children: Array of page-table child nodes */
24 struct xe_ptw *children[XE_PDES];
27 #if IS_ENABLED(CONFIG_DRM_XE_DEBUG_VM)
28 #define xe_pt_set_addr(__xe_pt, __addr) ((__xe_pt)->addr = (__addr))
29 #define xe_pt_addr(__xe_pt) ((__xe_pt)->addr)
31 #define xe_pt_set_addr(__xe_pt, __addr)
32 #define xe_pt_addr(__xe_pt) 0ull
35 static const u64 xe_normal_pt_shifts[] = {12, 21, 30, 39, 48};
36 static const u64 xe_compact_pt_shifts[] = {16, 21, 30, 39, 48};
38 #define XE_PT_HIGHEST_LEVEL (ARRAY_SIZE(xe_normal_pt_shifts) - 1)
40 static struct xe_pt_dir *as_xe_pt_dir(struct xe_pt *pt)
42 return container_of(pt, struct xe_pt_dir, pt);
45 static struct xe_pt *xe_pt_entry(struct xe_pt_dir *pt_dir, unsigned int index)
47 return container_of(pt_dir->children[index], struct xe_pt, base);
50 static u64 __xe_pt_empty_pte(struct xe_tile *tile, struct xe_vm *vm,
53 struct xe_device *xe = tile_to_xe(tile);
54 u16 pat_index = xe->pat.idx[XE_CACHE_WB];
57 if (!xe_vm_has_scratch(vm))
60 if (level > MAX_HUGEPTE_LEVEL)
61 return vm->pt_ops->pde_encode_bo(vm->scratch_pt[id][level - 1]->bo,
64 return vm->pt_ops->pte_encode_addr(xe, 0, pat_index, level, IS_DGFX(xe), 0) |
68 static void xe_pt_free(struct xe_pt *pt)
71 kfree(as_xe_pt_dir(pt));
77 * xe_pt_create() - Create a page-table.
78 * @vm: The vm to create for.
79 * @tile: The tile to create for.
80 * @level: The page-table level.
82 * Allocate and initialize a single struct xe_pt metadata structure. Also
83 * create the corresponding page-table bo, but don't initialize it. If the
84 * level is grater than zero, then it's assumed to be a directory page-
85 * table and the directory structure is also allocated and initialized to
88 * Return: A valid struct xe_pt pointer on success, Pointer error code on
91 struct xe_pt *xe_pt_create(struct xe_vm *vm, struct xe_tile *tile,
99 struct xe_pt_dir *dir = kzalloc(sizeof(*dir), GFP_KERNEL);
101 pt = (dir) ? &dir->pt : NULL;
103 pt = kzalloc(sizeof(*pt), GFP_KERNEL);
106 return ERR_PTR(-ENOMEM);
109 bo = xe_bo_create_pin_map(vm->xe, tile, vm, SZ_4K,
111 XE_BO_CREATE_VRAM_IF_DGFX(tile) |
112 XE_BO_CREATE_IGNORE_MIN_PAGE_SIZE_BIT |
113 XE_BO_CREATE_PINNED_BIT |
114 XE_BO_CREATE_NO_RESV_EVICT |
121 pt->base.children = level ? as_xe_pt_dir(pt)->children : NULL;
124 xe_drm_client_add_bo(vm->xef->client, pt->bo);
125 xe_tile_assert(tile, level <= XE_VM_MAX_LEVEL);
135 * xe_pt_populate_empty() - Populate a page-table bo with scratch- or zero
137 * @tile: The tile the scratch pagetable of which to use.
138 * @vm: The vm we populate for.
139 * @pt: The pagetable the bo of which to initialize.
141 * Populate the page-table bo of @pt with entries pointing into the tile's
142 * scratch page-table tree if any. Otherwise populate with zeros.
144 void xe_pt_populate_empty(struct xe_tile *tile, struct xe_vm *vm,
147 struct iosys_map *map = &pt->bo->vmap;
151 if (!xe_vm_has_scratch(vm)) {
153 * FIXME: Some memory is allocated already allocated to zero?
154 * Find out which memory that is and avoid this memset...
156 xe_map_memset(vm->xe, map, 0, 0, SZ_4K);
158 empty = __xe_pt_empty_pte(tile, vm, pt->level);
159 for (i = 0; i < XE_PDES; i++)
160 xe_pt_write(vm->xe, map, i, empty);
165 * xe_pt_shift() - Return the ilog2 value of the size of the address range of
166 * a page-table at a certain level.
169 * Return: The ilog2 value of the size of the address range of a page-table
172 unsigned int xe_pt_shift(unsigned int level)
174 return XE_PTE_SHIFT + XE_PDE_SHIFT * level;
178 * xe_pt_destroy() - Destroy a page-table tree.
179 * @pt: The root of the page-table tree to destroy.
180 * @flags: vm flags. Currently unused.
181 * @deferred: List head of lockless list for deferred putting. NULL for
184 * Puts the page-table bo, recursively calls xe_pt_destroy on all children
185 * and finally frees @pt. TODO: Can we remove the @flags argument?
187 void xe_pt_destroy(struct xe_pt *pt, u32 flags, struct llist_head *deferred)
194 XE_WARN_ON(!list_empty(&pt->bo->ttm.base.gpuva.list));
196 xe_bo_put_deferred(pt->bo, deferred);
198 if (pt->level > 0 && pt->num_live) {
199 struct xe_pt_dir *pt_dir = as_xe_pt_dir(pt);
201 for (i = 0; i < XE_PDES; i++) {
202 if (xe_pt_entry(pt_dir, i))
203 xe_pt_destroy(xe_pt_entry(pt_dir, i), flags,
211 * DOC: Pagetable building
213 * Below we use the term "page-table" for both page-directories, containing
214 * pointers to lower level page-directories or page-tables, and level 0
215 * page-tables that contain only page-table-entries pointing to memory pages.
217 * When inserting an address range in an already existing page-table tree
218 * there will typically be a set of page-tables that are shared with other
219 * address ranges, and a set that are private to this address range.
220 * The set of shared page-tables can be at most two per level,
221 * and those can't be updated immediately because the entries of those
222 * page-tables may still be in use by the gpu for other mappings. Therefore
223 * when inserting entries into those, we instead stage those insertions by
224 * adding insertion data into struct xe_vm_pgtable_update structures. This
225 * data, (subtrees for the cpu and page-table-entries for the gpu) is then
226 * added in a separate commit step. CPU-data is committed while still under the
227 * vm lock, the object lock and for userptr, the notifier lock in read mode.
228 * The GPU async data is committed either by the GPU or CPU after fulfilling
229 * relevant dependencies.
230 * For non-shared page-tables (and, in fact, for shared ones that aren't
231 * existing at the time of staging), we add the data in-place without the
232 * special update structures. This private part of the page-table tree will
233 * remain disconnected from the vm page-table tree until data is committed to
234 * the shared page tables of the vm tree in the commit phase.
237 struct xe_pt_update {
238 /** @update: The update structure we're building for this parent. */
239 struct xe_vm_pgtable_update *update;
240 /** @parent: The parent. Used to detect a parent change. */
241 struct xe_pt *parent;
242 /** @preexisting: Whether the parent was pre-existing or allocated */
246 struct xe_pt_stage_bind_walk {
247 /** base: The base class. */
248 struct xe_pt_walk base;
250 /* Input parameters for the walk */
251 /** @vm: The vm we're building for. */
253 /** @tile: The tile we're building for. */
254 struct xe_tile *tile;
255 /** @default_pte: PTE flag only template. No address is associated */
257 /** @dma_offset: DMA offset to add to the PTE. */
260 * @needs_64k: This address range enforces 64K alignment and
265 * @vma: VMA being mapped
269 /* Also input, but is updated during the walk*/
270 /** @curs: The DMA address cursor. */
271 struct xe_res_cursor *curs;
272 /** @va_curs_start: The Virtual address coresponding to @curs->start */
276 struct xe_walk_update {
277 /** @wupd.entries: Caller provided storage. */
278 struct xe_vm_pgtable_update *entries;
279 /** @wupd.num_used_entries: Number of update @entries used. */
280 unsigned int num_used_entries;
281 /** @wupd.updates: Tracks the update entry at a given level */
282 struct xe_pt_update updates[XE_VM_MAX_LEVEL + 1];
287 * @l0_end_addr: The end address of the current l0 leaf. Used for
288 * 64K granularity detection.
291 /** @addr_64K: The start address of the current 64K chunk. */
293 /** @found_64: Whether @add_64K actually points to a 64K chunk. */
298 xe_pt_new_shared(struct xe_walk_update *wupd, struct xe_pt *parent,
299 pgoff_t offset, bool alloc_entries)
301 struct xe_pt_update *upd = &wupd->updates[parent->level];
302 struct xe_vm_pgtable_update *entry;
305 * For *each level*, we could only have one active
306 * struct xt_pt_update at any one time. Once we move on to a
307 * new parent and page-directory, the old one is complete, and
308 * updates are either already stored in the build tree or in
311 if (likely(upd->parent == parent))
314 upd->parent = parent;
315 upd->preexisting = true;
317 if (wupd->num_used_entries == XE_VM_MAX_LEVEL * 2 + 1)
320 entry = wupd->entries + wupd->num_used_entries++;
323 entry->pt_bo = parent->bo;
329 entry->pt_entries = kmalloc_array(XE_PDES,
330 sizeof(*entry->pt_entries),
332 if (!entry->pt_entries)
340 * NOTE: This is a very frequently called function so we allow ourselves
341 * to annotate (using branch prediction hints) the fastpath of updating a
342 * non-pre-existing pagetable with leaf ptes.
345 xe_pt_insert_entry(struct xe_pt_stage_bind_walk *xe_walk, struct xe_pt *parent,
346 pgoff_t offset, struct xe_pt *xe_child, u64 pte)
348 struct xe_pt_update *upd = &xe_walk->wupd.updates[parent->level];
349 struct xe_pt_update *child_upd = xe_child ?
350 &xe_walk->wupd.updates[xe_child->level] : NULL;
353 ret = xe_pt_new_shared(&xe_walk->wupd, parent, offset, true);
358 * Register this new pagetable so that it won't be recognized as
359 * a shared pagetable by a subsequent insertion.
361 if (unlikely(child_upd)) {
362 child_upd->update = NULL;
363 child_upd->parent = xe_child;
364 child_upd->preexisting = false;
367 if (likely(!upd->preexisting)) {
368 /* Continue building a non-connected subtree. */
369 struct iosys_map *map = &parent->bo->vmap;
371 if (unlikely(xe_child))
372 parent->base.children[offset] = &xe_child->base;
374 xe_pt_write(xe_walk->vm->xe, map, offset, pte);
377 /* Shared pt. Stage update. */
379 struct xe_vm_pgtable_update *entry = upd->update;
381 idx = offset - entry->ofs;
382 entry->pt_entries[idx].pt = xe_child;
383 entry->pt_entries[idx].pte = pte;
390 static bool xe_pt_hugepte_possible(u64 addr, u64 next, unsigned int level,
391 struct xe_pt_stage_bind_walk *xe_walk)
395 if (level > MAX_HUGEPTE_LEVEL)
398 /* Does the virtual range requested cover a huge pte? */
399 if (!xe_pt_covers(addr, next, level, &xe_walk->base))
402 /* Does the DMA segment cover the whole pte? */
403 if (next - xe_walk->va_curs_start > xe_walk->curs->size)
406 /* null VMA's do not have dma addresses */
407 if (xe_vma_is_null(xe_walk->vma))
410 /* Is the DMA address huge PTE size aligned? */
412 dma = addr - xe_walk->va_curs_start + xe_res_dma(xe_walk->curs);
414 return IS_ALIGNED(dma, size);
418 * Scan the requested mapping to check whether it can be done entirely
422 xe_pt_scan_64K(u64 addr, u64 next, struct xe_pt_stage_bind_walk *xe_walk)
424 struct xe_res_cursor curs = *xe_walk->curs;
426 if (!IS_ALIGNED(addr, SZ_64K))
429 if (next > xe_walk->l0_end_addr)
432 /* null VMA's do not have dma addresses */
433 if (xe_vma_is_null(xe_walk->vma))
436 xe_res_next(&curs, addr - xe_walk->va_curs_start);
437 for (; addr < next; addr += SZ_64K) {
438 if (!IS_ALIGNED(xe_res_dma(&curs), SZ_64K) || curs.size < SZ_64K)
441 xe_res_next(&curs, SZ_64K);
448 * For non-compact "normal" 4K level-0 pagetables, we want to try to group
449 * addresses together in 64K-contigous regions to add a 64K TLB hint for the
451 * This function determines whether the address is part of such a
452 * segment. For VRAM in normal pagetables, this is strictly necessary on
456 xe_pt_is_pte_ps64K(u64 addr, u64 next, struct xe_pt_stage_bind_walk *xe_walk)
458 /* Address is within an already found 64k region */
459 if (xe_walk->found_64K && addr - xe_walk->addr_64K < SZ_64K)
462 xe_walk->found_64K = xe_pt_scan_64K(addr, addr + SZ_64K, xe_walk);
463 xe_walk->addr_64K = addr;
465 return xe_walk->found_64K;
469 xe_pt_stage_bind_entry(struct xe_ptw *parent, pgoff_t offset,
470 unsigned int level, u64 addr, u64 next,
471 struct xe_ptw **child,
472 enum page_walk_action *action,
473 struct xe_pt_walk *walk)
475 struct xe_pt_stage_bind_walk *xe_walk =
476 container_of(walk, typeof(*xe_walk), base);
477 u16 pat_index = xe_walk->vma->pat_index;
478 struct xe_pt *xe_parent = container_of(parent, typeof(*xe_parent), base);
479 struct xe_vm *vm = xe_walk->vm;
480 struct xe_pt *xe_child;
485 /* Is this a leaf entry ?*/
486 if (level == 0 || xe_pt_hugepte_possible(addr, next, level, xe_walk)) {
487 struct xe_res_cursor *curs = xe_walk->curs;
488 bool is_null = xe_vma_is_null(xe_walk->vma);
490 XE_WARN_ON(xe_walk->va_curs_start != addr);
492 pte = vm->pt_ops->pte_encode_vma(is_null ? 0 :
493 xe_res_dma(curs) + xe_walk->dma_offset,
494 xe_walk->vma, pat_index, level);
495 pte |= xe_walk->default_pte;
498 * Set the XE_PTE_PS64 hint if possible, otherwise if
499 * this device *requires* 64K PTE size for VRAM, fail.
501 if (level == 0 && !xe_parent->is_compact) {
502 if (xe_pt_is_pte_ps64K(addr, next, xe_walk)) {
503 xe_walk->vma->gpuva.flags |= XE_VMA_PTE_64K;
505 } else if (XE_WARN_ON(xe_walk->needs_64K)) {
510 ret = xe_pt_insert_entry(xe_walk, xe_parent, offset, NULL, pte);
515 xe_res_next(curs, next - addr);
516 xe_walk->va_curs_start = next;
517 xe_walk->vma->gpuva.flags |= (XE_VMA_PTE_4K << level);
518 *action = ACTION_CONTINUE;
524 * Descending to lower level. Determine if we need to allocate a
525 * new page table or -directory, which we do if there is no
526 * previous one or there is one we can completely replace.
529 walk->shifts = xe_normal_pt_shifts;
530 xe_walk->l0_end_addr = next;
533 covers = xe_pt_covers(addr, next, level, &xe_walk->base);
534 if (covers || !*child) {
537 xe_child = xe_pt_create(xe_walk->vm, xe_walk->tile, level - 1);
538 if (IS_ERR(xe_child))
539 return PTR_ERR(xe_child);
541 xe_pt_set_addr(xe_child,
542 round_down(addr, 1ull << walk->shifts[level]));
545 xe_pt_populate_empty(xe_walk->tile, xe_walk->vm, xe_child);
547 *child = &xe_child->base;
550 * Prefer the compact pagetable layout for L0 if possible. Only
551 * possible if VMA covers entire 2MB region as compact 64k and
552 * 4k pages cannot be mixed within a 2MB region.
553 * TODO: Suballocate the pt bo to avoid wasting a lot of
556 if (GRAPHICS_VERx100(tile_to_xe(xe_walk->tile)) >= 1250 && level == 1 &&
557 covers && xe_pt_scan_64K(addr, next, xe_walk)) {
558 walk->shifts = xe_compact_pt_shifts;
559 xe_walk->vma->gpuva.flags |= XE_VMA_PTE_COMPACT;
561 xe_child->is_compact = true;
564 pte = vm->pt_ops->pde_encode_bo(xe_child->bo, 0, pat_index) | flags;
565 ret = xe_pt_insert_entry(xe_walk, xe_parent, offset, xe_child,
569 *action = ACTION_SUBTREE;
573 static const struct xe_pt_walk_ops xe_pt_stage_bind_ops = {
574 .pt_entry = xe_pt_stage_bind_entry,
578 * xe_pt_stage_bind() - Build a disconnected page-table tree for a given address
580 * @tile: The tile we're building for.
581 * @vma: The vma indicating the address range.
582 * @entries: Storage for the update entries used for connecting the tree to
583 * the main tree at commit time.
584 * @num_entries: On output contains the number of @entries used.
586 * This function builds a disconnected page-table tree for a given address
587 * range. The tree is connected to the main vm tree for the gpu using
588 * xe_migrate_update_pgtables() and for the cpu using xe_pt_commit_bind().
589 * The function builds xe_vm_pgtable_update structures for already existing
590 * shared page-tables, and non-existing shared and non-shared page-tables
591 * are built and populated directly.
593 * Return 0 on success, negative error code on error.
596 xe_pt_stage_bind(struct xe_tile *tile, struct xe_vma *vma,
597 struct xe_vm_pgtable_update *entries, u32 *num_entries)
599 struct xe_device *xe = tile_to_xe(tile);
600 struct xe_bo *bo = xe_vma_bo(vma);
601 bool is_devmem = !xe_vma_is_userptr(vma) && bo &&
602 (xe_bo_is_vram(bo) || xe_bo_is_stolen_devmem(bo));
603 struct xe_res_cursor curs;
604 struct xe_pt_stage_bind_walk xe_walk = {
606 .ops = &xe_pt_stage_bind_ops,
607 .shifts = xe_normal_pt_shifts,
608 .max_level = XE_PT_HIGHEST_LEVEL,
610 .vm = xe_vma_vm(vma),
613 .va_curs_start = xe_vma_start(vma),
615 .wupd.entries = entries,
616 .needs_64K = (xe_vma_vm(vma)->flags & XE_VM_FLAG_64K) && is_devmem,
618 struct xe_pt *pt = xe_vma_vm(vma)->pt_root[tile->id];
621 if (vma && (vma->gpuva.flags & XE_VMA_ATOMIC_PTE_BIT) &&
622 (is_devmem || !IS_DGFX(xe)))
623 xe_walk.default_pte |= XE_USM_PPGTT_PTE_AE;
626 xe_walk.default_pte |= XE_PPGTT_PTE_DM;
627 xe_walk.dma_offset = vram_region_gpu_offset(bo->ttm.resource);
630 if (!xe_vma_has_no_bo(vma) && xe_bo_is_stolen(bo))
631 xe_walk.dma_offset = xe_ttm_stolen_gpu_offset(xe_bo_device(bo));
633 xe_bo_assert_held(bo);
635 if (!xe_vma_is_null(vma)) {
636 if (xe_vma_is_userptr(vma))
637 xe_res_first_sg(to_userptr_vma(vma)->userptr.sg, 0,
638 xe_vma_size(vma), &curs);
639 else if (xe_bo_is_vram(bo) || xe_bo_is_stolen(bo))
640 xe_res_first(bo->ttm.resource, xe_vma_bo_offset(vma),
641 xe_vma_size(vma), &curs);
643 xe_res_first_sg(xe_bo_sg(bo), xe_vma_bo_offset(vma),
644 xe_vma_size(vma), &curs);
646 curs.size = xe_vma_size(vma);
649 ret = xe_pt_walk_range(&pt->base, pt->level, xe_vma_start(vma),
650 xe_vma_end(vma), &xe_walk.base);
652 *num_entries = xe_walk.wupd.num_used_entries;
657 * xe_pt_nonshared_offsets() - Determine the non-shared entry offsets of a
659 * @addr: The start address within the non-shared pagetable.
660 * @end: The end address within the non-shared pagetable.
661 * @level: The level of the non-shared pagetable.
662 * @walk: Walk info. The function adjusts the walk action.
663 * @action: next action to perform (see enum page_walk_action)
664 * @offset: Ignored on input, First non-shared entry on output.
665 * @end_offset: Ignored on input, Last non-shared entry + 1 on output.
667 * A non-shared page-table has some entries that belong to the address range
668 * and others that don't. This function determines the entries that belong
669 * fully to the address range. Depending on level, some entries may
670 * partially belong to the address range (that can't happen at level 0).
671 * The function detects that and adjust those offsets to not include those
672 * partial entries. Iff it does detect partial entries, we know that there must
673 * be shared page tables also at lower levels, so it adjusts the walk action
676 * Return: true if there were non-shared entries, false otherwise.
678 static bool xe_pt_nonshared_offsets(u64 addr, u64 end, unsigned int level,
679 struct xe_pt_walk *walk,
680 enum page_walk_action *action,
681 pgoff_t *offset, pgoff_t *end_offset)
683 u64 size = 1ull << walk->shifts[level];
685 *offset = xe_pt_offset(addr, level, walk);
686 *end_offset = xe_pt_num_entries(addr, end, level, walk) + *offset;
692 * If addr or next are not size aligned, there are shared pts at lower
693 * level, so in that case traverse down the subtree
695 *action = ACTION_CONTINUE;
696 if (!IS_ALIGNED(addr, size)) {
697 *action = ACTION_SUBTREE;
701 if (!IS_ALIGNED(end, size)) {
702 *action = ACTION_SUBTREE;
706 return *end_offset > *offset;
709 struct xe_pt_zap_ptes_walk {
710 /** @base: The walk base-class */
711 struct xe_pt_walk base;
713 /* Input parameters for the walk */
714 /** @tile: The tile we're building for */
715 struct xe_tile *tile;
718 /** @needs_invalidate: Whether we need to invalidate TLB*/
719 bool needs_invalidate;
722 static int xe_pt_zap_ptes_entry(struct xe_ptw *parent, pgoff_t offset,
723 unsigned int level, u64 addr, u64 next,
724 struct xe_ptw **child,
725 enum page_walk_action *action,
726 struct xe_pt_walk *walk)
728 struct xe_pt_zap_ptes_walk *xe_walk =
729 container_of(walk, typeof(*xe_walk), base);
730 struct xe_pt *xe_child = container_of(*child, typeof(*xe_child), base);
734 XE_WARN_ON(!level && xe_child->is_compact);
737 * Note that we're called from an entry callback, and we're dealing
738 * with the child of that entry rather than the parent, so need to
741 if (xe_pt_nonshared_offsets(addr, next, --level, walk, action, &offset,
743 xe_map_memset(tile_to_xe(xe_walk->tile), &xe_child->bo->vmap,
744 offset * sizeof(u64), 0,
745 (end_offset - offset) * sizeof(u64));
746 xe_walk->needs_invalidate = true;
752 static const struct xe_pt_walk_ops xe_pt_zap_ptes_ops = {
753 .pt_entry = xe_pt_zap_ptes_entry,
757 * xe_pt_zap_ptes() - Zap (zero) gpu ptes of an address range
758 * @tile: The tile we're zapping for.
759 * @vma: GPU VMA detailing address range.
761 * Eviction and Userptr invalidation needs to be able to zap the
762 * gpu ptes of a given address range in pagefaulting mode.
763 * In order to be able to do that, that function needs access to the shared
764 * page-table entrieaso it can either clear the leaf PTEs or
765 * clear the pointers to lower-level page-tables. The caller is required
766 * to hold the necessary locks to ensure neither the page-table connectivity
767 * nor the page-table entries of the range is updated from under us.
769 * Return: Whether ptes were actually updated and a TLB invalidation is
772 bool xe_pt_zap_ptes(struct xe_tile *tile, struct xe_vma *vma)
774 struct xe_pt_zap_ptes_walk xe_walk = {
776 .ops = &xe_pt_zap_ptes_ops,
777 .shifts = xe_normal_pt_shifts,
778 .max_level = XE_PT_HIGHEST_LEVEL,
782 struct xe_pt *pt = xe_vma_vm(vma)->pt_root[tile->id];
784 if (!(vma->tile_present & BIT(tile->id)))
787 (void)xe_pt_walk_shared(&pt->base, pt->level, xe_vma_start(vma),
788 xe_vma_end(vma), &xe_walk.base);
790 return xe_walk.needs_invalidate;
794 xe_vm_populate_pgtable(struct xe_migrate_pt_update *pt_update, struct xe_tile *tile,
795 struct iosys_map *map, void *data,
796 u32 qword_ofs, u32 num_qwords,
797 const struct xe_vm_pgtable_update *update)
799 struct xe_pt_entry *ptes = update->pt_entries;
803 for (i = 0; i < num_qwords; i++) {
805 xe_map_wr(tile_to_xe(tile), map, (qword_ofs + i) *
806 sizeof(u64), u64, ptes[i].pte);
808 ptr[i] = ptes[i].pte;
812 static void xe_pt_abort_bind(struct xe_vma *vma,
813 struct xe_vm_pgtable_update *entries,
818 for (i = 0; i < num_entries; i++) {
819 if (!entries[i].pt_entries)
822 for (j = 0; j < entries[i].qwords; j++)
823 xe_pt_destroy(entries[i].pt_entries[j].pt, xe_vma_vm(vma)->flags, NULL);
824 kfree(entries[i].pt_entries);
828 static void xe_pt_commit_locks_assert(struct xe_vma *vma)
830 struct xe_vm *vm = xe_vma_vm(vma);
832 lockdep_assert_held(&vm->lock);
834 if (xe_vma_is_userptr(vma))
835 lockdep_assert_held_read(&vm->userptr.notifier_lock);
836 else if (!xe_vma_is_null(vma))
837 dma_resv_assert_held(xe_vma_bo(vma)->ttm.base.resv);
839 xe_vm_assert_held(vm);
842 static void xe_pt_commit_bind(struct xe_vma *vma,
843 struct xe_vm_pgtable_update *entries,
844 u32 num_entries, bool rebind,
845 struct llist_head *deferred)
849 xe_pt_commit_locks_assert(vma);
851 for (i = 0; i < num_entries; i++) {
852 struct xe_pt *pt = entries[i].pt;
853 struct xe_pt_dir *pt_dir;
856 pt->num_live += entries[i].qwords;
859 kfree(entries[i].pt_entries);
863 pt_dir = as_xe_pt_dir(pt);
864 for (j = 0; j < entries[i].qwords; j++) {
865 u32 j_ = j + entries[i].ofs;
866 struct xe_pt *newpte = entries[i].pt_entries[j].pt;
868 if (xe_pt_entry(pt_dir, j_))
869 xe_pt_destroy(xe_pt_entry(pt_dir, j_),
870 xe_vma_vm(vma)->flags, deferred);
872 pt_dir->children[j_] = &newpte->base;
874 kfree(entries[i].pt_entries);
879 xe_pt_prepare_bind(struct xe_tile *tile, struct xe_vma *vma,
880 struct xe_vm_pgtable_update *entries, u32 *num_entries)
885 err = xe_pt_stage_bind(tile, vma, entries, num_entries);
887 xe_tile_assert(tile, *num_entries);
889 xe_pt_abort_bind(vma, entries, *num_entries);
894 static void xe_vm_dbg_print_entries(struct xe_device *xe,
895 const struct xe_vm_pgtable_update *entries,
896 unsigned int num_entries)
897 #if (IS_ENABLED(CONFIG_DRM_XE_DEBUG_VM))
901 vm_dbg(&xe->drm, "%u entries to update\n", num_entries);
902 for (i = 0; i < num_entries; i++) {
903 const struct xe_vm_pgtable_update *entry = &entries[i];
904 struct xe_pt *xe_pt = entry->pt;
905 u64 page_size = 1ull << xe_pt_shift(xe_pt->level);
909 xe_assert(xe, !entry->pt->is_compact);
910 start = entry->ofs * page_size;
911 end = start + page_size * entry->qwords;
913 "\t%u: Update level %u at (%u + %u) [%llx...%llx) f:%x\n",
914 i, xe_pt->level, entry->ofs, entry->qwords,
915 xe_pt_addr(xe_pt) + start, xe_pt_addr(xe_pt) + end, 0);
922 #ifdef CONFIG_DRM_XE_USERPTR_INVAL_INJECT
924 static int xe_pt_userptr_inject_eagain(struct xe_userptr_vma *uvma)
926 u32 divisor = uvma->userptr.divisor ? uvma->userptr.divisor : 2;
929 if (count++ % divisor == divisor - 1) {
930 struct xe_vm *vm = xe_vma_vm(&uvma->vma);
932 uvma->userptr.divisor = divisor << 1;
933 spin_lock(&vm->userptr.invalidated_lock);
934 list_move_tail(&uvma->userptr.invalidate_link,
935 &vm->userptr.invalidated);
936 spin_unlock(&vm->userptr.invalidated_lock);
945 static bool xe_pt_userptr_inject_eagain(struct xe_userptr_vma *uvma)
953 * struct xe_pt_migrate_pt_update - Callback argument for pre-commit callbacks
954 * @base: Base we derive from.
955 * @bind: Whether this is a bind or an unbind operation. A bind operation
956 * makes the pre-commit callback error with -EAGAIN if it detects a
957 * pending invalidation.
958 * @locked: Whether the pre-commit callback locked the userptr notifier lock
959 * and it needs unlocking.
961 struct xe_pt_migrate_pt_update {
962 struct xe_migrate_pt_update base;
968 * This function adds the needed dependencies to a page-table update job
969 * to make sure racing jobs for separate bind engines don't race writing
970 * to the same page-table range, wreaking havoc. Initially use a single
971 * fence for the entire VM. An optimization would use smaller granularity.
973 static int xe_pt_vm_dependencies(struct xe_sched_job *job,
974 struct xe_range_fence_tree *rftree,
977 struct xe_range_fence *rtfence;
978 struct dma_fence *fence;
981 rtfence = xe_range_fence_tree_first(rftree, start, last);
983 fence = rtfence->fence;
985 if (!dma_fence_is_signaled(fence)) {
987 * Is this a CPU update? GPU is busy updating, so return
993 dma_fence_get(fence);
994 err = drm_sched_job_add_dependency(&job->drm, fence);
999 rtfence = xe_range_fence_tree_next(rtfence, start, last);
1005 static int xe_pt_pre_commit(struct xe_migrate_pt_update *pt_update)
1007 struct xe_range_fence_tree *rftree =
1008 &xe_vma_vm(pt_update->vma)->rftree[pt_update->tile_id];
1010 return xe_pt_vm_dependencies(pt_update->job, rftree,
1011 pt_update->start, pt_update->last);
1014 static int xe_pt_userptr_pre_commit(struct xe_migrate_pt_update *pt_update)
1016 struct xe_pt_migrate_pt_update *userptr_update =
1017 container_of(pt_update, typeof(*userptr_update), base);
1018 struct xe_userptr_vma *uvma = to_userptr_vma(pt_update->vma);
1019 unsigned long notifier_seq = uvma->userptr.notifier_seq;
1020 struct xe_vm *vm = xe_vma_vm(&uvma->vma);
1021 int err = xe_pt_vm_dependencies(pt_update->job,
1022 &vm->rftree[pt_update->tile_id],
1029 userptr_update->locked = false;
1032 * Wait until nobody is running the invalidation notifier, and
1033 * since we're exiting the loop holding the notifier lock,
1034 * nobody can proceed invalidating either.
1036 * Note that we don't update the vma->userptr.notifier_seq since
1037 * we don't update the userptr pages.
1040 down_read(&vm->userptr.notifier_lock);
1041 if (!mmu_interval_read_retry(&uvma->userptr.notifier,
1045 up_read(&vm->userptr.notifier_lock);
1047 if (userptr_update->bind)
1050 notifier_seq = mmu_interval_read_begin(&uvma->userptr.notifier);
1053 /* Inject errors to test_whether they are handled correctly */
1054 if (userptr_update->bind && xe_pt_userptr_inject_eagain(uvma)) {
1055 up_read(&vm->userptr.notifier_lock);
1059 userptr_update->locked = true;
1064 static const struct xe_migrate_pt_update_ops bind_ops = {
1065 .populate = xe_vm_populate_pgtable,
1066 .pre_commit = xe_pt_pre_commit,
1069 static const struct xe_migrate_pt_update_ops userptr_bind_ops = {
1070 .populate = xe_vm_populate_pgtable,
1071 .pre_commit = xe_pt_userptr_pre_commit,
1074 struct invalidation_fence {
1075 struct xe_gt_tlb_invalidation_fence base;
1078 struct dma_fence *fence;
1079 struct dma_fence_cb cb;
1080 struct work_struct work;
1084 invalidation_fence_get_driver_name(struct dma_fence *dma_fence)
1090 invalidation_fence_get_timeline_name(struct dma_fence *dma_fence)
1092 return "invalidation_fence";
1095 static const struct dma_fence_ops invalidation_fence_ops = {
1096 .get_driver_name = invalidation_fence_get_driver_name,
1097 .get_timeline_name = invalidation_fence_get_timeline_name,
1100 static void invalidation_fence_cb(struct dma_fence *fence,
1101 struct dma_fence_cb *cb)
1103 struct invalidation_fence *ifence =
1104 container_of(cb, struct invalidation_fence, cb);
1106 trace_xe_gt_tlb_invalidation_fence_cb(&ifence->base);
1107 if (!ifence->fence->error) {
1108 queue_work(system_wq, &ifence->work);
1110 ifence->base.base.error = ifence->fence->error;
1111 dma_fence_signal(&ifence->base.base);
1112 dma_fence_put(&ifence->base.base);
1114 dma_fence_put(ifence->fence);
1117 static void invalidation_fence_work_func(struct work_struct *w)
1119 struct invalidation_fence *ifence =
1120 container_of(w, struct invalidation_fence, work);
1122 trace_xe_gt_tlb_invalidation_fence_work_func(&ifence->base);
1123 xe_gt_tlb_invalidation_vma(ifence->gt, &ifence->base, ifence->vma);
1126 static int invalidation_fence_init(struct xe_gt *gt,
1127 struct invalidation_fence *ifence,
1128 struct dma_fence *fence,
1133 trace_xe_gt_tlb_invalidation_fence_create(&ifence->base);
1135 spin_lock_irq(>->tlb_invalidation.lock);
1136 dma_fence_init(&ifence->base.base, &invalidation_fence_ops,
1137 >->tlb_invalidation.lock,
1138 gt->tlb_invalidation.fence_context,
1139 ++gt->tlb_invalidation.fence_seqno);
1140 spin_unlock_irq(>->tlb_invalidation.lock);
1142 INIT_LIST_HEAD(&ifence->base.link);
1144 dma_fence_get(&ifence->base.base); /* Ref for caller */
1145 ifence->fence = fence;
1149 INIT_WORK(&ifence->work, invalidation_fence_work_func);
1150 ret = dma_fence_add_callback(fence, &ifence->cb, invalidation_fence_cb);
1151 if (ret == -ENOENT) {
1152 dma_fence_put(ifence->fence); /* Usually dropped in CB */
1153 invalidation_fence_work_func(&ifence->work);
1155 dma_fence_put(&ifence->base.base); /* Caller ref */
1156 dma_fence_put(&ifence->base.base); /* Creation ref */
1159 xe_gt_assert(gt, !ret || ret == -ENOENT);
1161 return ret && ret != -ENOENT ? ret : 0;
1164 static void xe_pt_calc_rfence_interval(struct xe_vma *vma,
1165 struct xe_pt_migrate_pt_update *update,
1166 struct xe_vm_pgtable_update *entries,
1171 for (i = 0; i < num_entries; i++) {
1172 const struct xe_vm_pgtable_update *entry = &entries[i];
1174 if (entry->pt->level > level)
1175 level = entry->pt->level;
1178 /* Greedy (non-optimal) calculation but simple */
1179 update->base.start = ALIGN_DOWN(xe_vma_start(vma),
1180 0x1ull << xe_pt_shift(level));
1181 update->base.last = ALIGN(xe_vma_end(vma),
1182 0x1ull << xe_pt_shift(level)) - 1;
1186 * __xe_pt_bind_vma() - Build and connect a page-table tree for the vma
1188 * @tile: The tile to bind for.
1189 * @vma: The vma to bind.
1190 * @q: The exec_queue with which to do pipelined page-table updates.
1191 * @syncs: Entries to sync on before binding the built tree to the live vm tree.
1192 * @num_syncs: Number of @sync entries.
1193 * @rebind: Whether we're rebinding this vma to the same address range without
1194 * an unbind in-between.
1196 * This function builds a page-table tree (see xe_pt_stage_bind() for more
1197 * information on page-table building), and the xe_vm_pgtable_update entries
1198 * abstracting the operations needed to attach it to the main vm tree. It
1199 * then takes the relevant locks and updates the metadata side of the main
1200 * vm tree and submits the operations for pipelined attachment of the
1201 * gpu page-table to the vm main tree, (which can be done either by the
1204 * Return: A valid dma-fence representing the pipelined attachment operation
1205 * on success, an error pointer on error.
1208 __xe_pt_bind_vma(struct xe_tile *tile, struct xe_vma *vma, struct xe_exec_queue *q,
1209 struct xe_sync_entry *syncs, u32 num_syncs,
1212 struct xe_vm_pgtable_update entries[XE_VM_MAX_LEVEL * 2 + 1];
1213 struct xe_pt_migrate_pt_update bind_pt_update = {
1215 .ops = xe_vma_is_userptr(vma) ? &userptr_bind_ops : &bind_ops,
1217 .tile_id = tile->id,
1221 struct xe_vm *vm = xe_vma_vm(vma);
1223 struct dma_fence *fence;
1224 struct invalidation_fence *ifence = NULL;
1225 struct xe_range_fence *rfence;
1228 bind_pt_update.locked = false;
1229 xe_bo_assert_held(xe_vma_bo(vma));
1230 xe_vm_assert_held(vm);
1232 vm_dbg(&xe_vma_vm(vma)->xe->drm,
1233 "Preparing bind, with range [%llx...%llx) engine %p.\n",
1234 xe_vma_start(vma), xe_vma_end(vma), q);
1236 err = xe_pt_prepare_bind(tile, vma, entries, &num_entries);
1239 xe_tile_assert(tile, num_entries <= ARRAY_SIZE(entries));
1241 xe_vm_dbg_print_entries(tile_to_xe(tile), entries, num_entries);
1242 xe_pt_calc_rfence_interval(vma, &bind_pt_update, entries,
1246 * If rebind, we have to invalidate TLB on !LR vms to invalidate
1247 * cached PTEs point to freed memory. on LR vms this is done
1248 * automatically when the context is re-enabled by the rebind worker,
1249 * or in fault mode it was invalidated on PTE zapping.
1251 * If !rebind, and scratch enabled VMs, there is a chance the scratch
1252 * PTE is already cached in the TLB so it needs to be invalidated.
1253 * on !LR VMs this is done in the ring ops preceding a batch, but on
1254 * non-faulting LR, in particular on user-space batch buffer chaining,
1255 * it needs to be done here.
1257 if ((!rebind && xe_vm_has_scratch(vm) && xe_vm_in_preempt_fence_mode(vm))) {
1258 ifence = kzalloc(sizeof(*ifence), GFP_KERNEL);
1260 return ERR_PTR(-ENOMEM);
1261 } else if (rebind && !xe_vm_in_lr_mode(vm)) {
1262 /* We bump also if batch_invalidate_tlb is true */
1263 vm->tlb_flush_seqno++;
1266 rfence = kzalloc(sizeof(*rfence), GFP_KERNEL);
1269 return ERR_PTR(-ENOMEM);
1272 fence = xe_migrate_update_pgtables(tile->migrate,
1273 vm, xe_vma_bo(vma), q,
1274 entries, num_entries,
1276 &bind_pt_update.base);
1277 if (!IS_ERR(fence)) {
1278 bool last_munmap_rebind = vma->gpuva.flags & XE_VMA_LAST_REBIND;
1279 LLIST_HEAD(deferred);
1282 err = xe_range_fence_insert(&vm->rftree[tile->id], rfence,
1283 &xe_range_fence_kfree_ops,
1284 bind_pt_update.base.start,
1285 bind_pt_update.base.last, fence);
1287 dma_fence_wait(fence, false);
1289 /* TLB invalidation must be done before signaling rebind */
1291 int err = invalidation_fence_init(tile->primary_gt, ifence, fence,
1294 dma_fence_put(fence);
1296 return ERR_PTR(err);
1298 fence = &ifence->base.base;
1301 /* add shared fence now for pagetable delayed destroy */
1302 dma_resv_add_fence(xe_vm_resv(vm), fence, rebind ||
1303 last_munmap_rebind ?
1304 DMA_RESV_USAGE_KERNEL :
1305 DMA_RESV_USAGE_BOOKKEEP);
1307 if (!xe_vma_has_no_bo(vma) && !xe_vma_bo(vma)->vm)
1308 dma_resv_add_fence(xe_vma_bo(vma)->ttm.base.resv, fence,
1309 DMA_RESV_USAGE_BOOKKEEP);
1310 xe_pt_commit_bind(vma, entries, num_entries, rebind,
1311 bind_pt_update.locked ? &deferred : NULL);
1313 /* This vma is live (again?) now */
1314 vma->tile_present |= BIT(tile->id);
1316 if (bind_pt_update.locked) {
1317 to_userptr_vma(vma)->userptr.initial_bind = true;
1318 up_read(&vm->userptr.notifier_lock);
1319 xe_bo_put_commit(&deferred);
1321 if (!rebind && last_munmap_rebind &&
1322 xe_vm_in_preempt_fence_mode(vm))
1323 xe_vm_queue_rebind_worker(vm);
1327 if (bind_pt_update.locked)
1328 up_read(&vm->userptr.notifier_lock);
1329 xe_pt_abort_bind(vma, entries, num_entries);
1335 return ERR_PTR(err);
1338 struct xe_pt_stage_unbind_walk {
1339 /** @base: The pagewalk base-class. */
1340 struct xe_pt_walk base;
1342 /* Input parameters for the walk */
1343 /** @tile: The tile we're unbinding from. */
1344 struct xe_tile *tile;
1347 * @modified_start: Walk range start, modified to include any
1348 * shared pagetables that we're the only user of and can thus
1352 /** @modified_end: Walk range start, modified like @modified_start. */
1356 /* @wupd: Structure to track the page-table updates we're building */
1357 struct xe_walk_update wupd;
1361 * Check whether this range is the only one populating this pagetable,
1362 * and in that case, update the walk range checks so that higher levels don't
1363 * view us as a shared pagetable.
1365 static bool xe_pt_check_kill(u64 addr, u64 next, unsigned int level,
1366 const struct xe_pt *child,
1367 enum page_walk_action *action,
1368 struct xe_pt_walk *walk)
1370 struct xe_pt_stage_unbind_walk *xe_walk =
1371 container_of(walk, typeof(*xe_walk), base);
1372 unsigned int shift = walk->shifts[level];
1373 u64 size = 1ull << shift;
1375 if (IS_ALIGNED(addr, size) && IS_ALIGNED(next, size) &&
1376 ((next - addr) >> shift) == child->num_live) {
1377 u64 size = 1ull << walk->shifts[level + 1];
1379 *action = ACTION_CONTINUE;
1381 if (xe_walk->modified_start >= addr)
1382 xe_walk->modified_start = round_down(addr, size);
1383 if (xe_walk->modified_end <= next)
1384 xe_walk->modified_end = round_up(next, size);
1392 static int xe_pt_stage_unbind_entry(struct xe_ptw *parent, pgoff_t offset,
1393 unsigned int level, u64 addr, u64 next,
1394 struct xe_ptw **child,
1395 enum page_walk_action *action,
1396 struct xe_pt_walk *walk)
1398 struct xe_pt *xe_child = container_of(*child, typeof(*xe_child), base);
1400 XE_WARN_ON(!*child);
1401 XE_WARN_ON(!level && xe_child->is_compact);
1403 xe_pt_check_kill(addr, next, level - 1, xe_child, action, walk);
1409 xe_pt_stage_unbind_post_descend(struct xe_ptw *parent, pgoff_t offset,
1410 unsigned int level, u64 addr, u64 next,
1411 struct xe_ptw **child,
1412 enum page_walk_action *action,
1413 struct xe_pt_walk *walk)
1415 struct xe_pt_stage_unbind_walk *xe_walk =
1416 container_of(walk, typeof(*xe_walk), base);
1417 struct xe_pt *xe_child = container_of(*child, typeof(*xe_child), base);
1419 u64 size = 1ull << walk->shifts[--level];
1421 if (!IS_ALIGNED(addr, size))
1422 addr = xe_walk->modified_start;
1423 if (!IS_ALIGNED(next, size))
1424 next = xe_walk->modified_end;
1426 /* Parent == *child is the root pt. Don't kill it. */
1427 if (parent != *child &&
1428 xe_pt_check_kill(addr, next, level, xe_child, action, walk))
1431 if (!xe_pt_nonshared_offsets(addr, next, level, walk, action, &offset,
1435 (void)xe_pt_new_shared(&xe_walk->wupd, xe_child, offset, false);
1436 xe_walk->wupd.updates[level].update->qwords = end_offset - offset;
1441 static const struct xe_pt_walk_ops xe_pt_stage_unbind_ops = {
1442 .pt_entry = xe_pt_stage_unbind_entry,
1443 .pt_post_descend = xe_pt_stage_unbind_post_descend,
1447 * xe_pt_stage_unbind() - Build page-table update structures for an unbind
1449 * @tile: The tile we're unbinding for.
1450 * @vma: The vma we're unbinding.
1451 * @entries: Caller-provided storage for the update structures.
1453 * Builds page-table update structures for an unbind operation. The function
1454 * will attempt to remove all page-tables that we're the only user
1455 * of, and for that to work, the unbind operation must be committed in the
1456 * same critical section that blocks racing binds to the same page-table tree.
1458 * Return: The number of entries used.
1460 static unsigned int xe_pt_stage_unbind(struct xe_tile *tile, struct xe_vma *vma,
1461 struct xe_vm_pgtable_update *entries)
1463 struct xe_pt_stage_unbind_walk xe_walk = {
1465 .ops = &xe_pt_stage_unbind_ops,
1466 .shifts = xe_normal_pt_shifts,
1467 .max_level = XE_PT_HIGHEST_LEVEL,
1470 .modified_start = xe_vma_start(vma),
1471 .modified_end = xe_vma_end(vma),
1472 .wupd.entries = entries,
1474 struct xe_pt *pt = xe_vma_vm(vma)->pt_root[tile->id];
1476 (void)xe_pt_walk_shared(&pt->base, pt->level, xe_vma_start(vma),
1477 xe_vma_end(vma), &xe_walk.base);
1479 return xe_walk.wupd.num_used_entries;
1483 xe_migrate_clear_pgtable_callback(struct xe_migrate_pt_update *pt_update,
1484 struct xe_tile *tile, struct iosys_map *map,
1485 void *ptr, u32 qword_ofs, u32 num_qwords,
1486 const struct xe_vm_pgtable_update *update)
1488 struct xe_vma *vma = pt_update->vma;
1489 u64 empty = __xe_pt_empty_pte(tile, xe_vma_vm(vma), update->pt->level);
1492 if (map && map->is_iomem)
1493 for (i = 0; i < num_qwords; ++i)
1494 xe_map_wr(tile_to_xe(tile), map, (qword_ofs + i) *
1495 sizeof(u64), u64, empty);
1497 memset64(map->vaddr + qword_ofs * sizeof(u64), empty,
1500 memset64(ptr, empty, num_qwords);
1504 xe_pt_commit_unbind(struct xe_vma *vma,
1505 struct xe_vm_pgtable_update *entries, u32 num_entries,
1506 struct llist_head *deferred)
1510 xe_pt_commit_locks_assert(vma);
1512 for (j = 0; j < num_entries; ++j) {
1513 struct xe_vm_pgtable_update *entry = &entries[j];
1514 struct xe_pt *pt = entry->pt;
1516 pt->num_live -= entry->qwords;
1518 struct xe_pt_dir *pt_dir = as_xe_pt_dir(pt);
1521 for (i = entry->ofs; i < entry->ofs + entry->qwords;
1523 if (xe_pt_entry(pt_dir, i))
1524 xe_pt_destroy(xe_pt_entry(pt_dir, i),
1525 xe_vma_vm(vma)->flags, deferred);
1527 pt_dir->children[i] = NULL;
1533 static const struct xe_migrate_pt_update_ops unbind_ops = {
1534 .populate = xe_migrate_clear_pgtable_callback,
1535 .pre_commit = xe_pt_pre_commit,
1538 static const struct xe_migrate_pt_update_ops userptr_unbind_ops = {
1539 .populate = xe_migrate_clear_pgtable_callback,
1540 .pre_commit = xe_pt_userptr_pre_commit,
1544 * __xe_pt_unbind_vma() - Disconnect and free a page-table tree for the vma
1546 * @tile: The tile to unbind for.
1547 * @vma: The vma to unbind.
1548 * @q: The exec_queue with which to do pipelined page-table updates.
1549 * @syncs: Entries to sync on before disconnecting the tree to be destroyed.
1550 * @num_syncs: Number of @sync entries.
1552 * This function builds a the xe_vm_pgtable_update entries abstracting the
1553 * operations needed to detach the page-table tree to be destroyed from the
1555 * It then takes the relevant locks and submits the operations for
1556 * pipelined detachment of the gpu page-table from the vm main tree,
1557 * (which can be done either by the cpu and the GPU), Finally it frees the
1558 * detached page-table tree.
1560 * Return: A valid dma-fence representing the pipelined detachment operation
1561 * on success, an error pointer on error.
1564 __xe_pt_unbind_vma(struct xe_tile *tile, struct xe_vma *vma, struct xe_exec_queue *q,
1565 struct xe_sync_entry *syncs, u32 num_syncs)
1567 struct xe_vm_pgtable_update entries[XE_VM_MAX_LEVEL * 2 + 1];
1568 struct xe_pt_migrate_pt_update unbind_pt_update = {
1570 .ops = xe_vma_is_userptr(vma) ? &userptr_unbind_ops :
1573 .tile_id = tile->id,
1576 struct xe_vm *vm = xe_vma_vm(vma);
1578 struct dma_fence *fence = NULL;
1579 struct invalidation_fence *ifence;
1580 struct xe_range_fence *rfence;
1582 LLIST_HEAD(deferred);
1584 xe_bo_assert_held(xe_vma_bo(vma));
1585 xe_vm_assert_held(vm);
1587 vm_dbg(&xe_vma_vm(vma)->xe->drm,
1588 "Preparing unbind, with range [%llx...%llx) engine %p.\n",
1589 xe_vma_start(vma), xe_vma_end(vma), q);
1591 num_entries = xe_pt_stage_unbind(tile, vma, entries);
1592 xe_tile_assert(tile, num_entries <= ARRAY_SIZE(entries));
1594 xe_vm_dbg_print_entries(tile_to_xe(tile), entries, num_entries);
1595 xe_pt_calc_rfence_interval(vma, &unbind_pt_update, entries,
1598 ifence = kzalloc(sizeof(*ifence), GFP_KERNEL);
1600 return ERR_PTR(-ENOMEM);
1602 rfence = kzalloc(sizeof(*rfence), GFP_KERNEL);
1605 return ERR_PTR(-ENOMEM);
1609 * Even if we were already evicted and unbind to destroy, we need to
1610 * clear again here. The eviction may have updated pagetables at a
1611 * lower level, because it needs to be more conservative.
1613 fence = xe_migrate_update_pgtables(tile->migrate,
1616 entries, num_entries,
1618 &unbind_pt_update.base);
1619 if (!IS_ERR(fence)) {
1622 err = xe_range_fence_insert(&vm->rftree[tile->id], rfence,
1623 &xe_range_fence_kfree_ops,
1624 unbind_pt_update.base.start,
1625 unbind_pt_update.base.last, fence);
1627 dma_fence_wait(fence, false);
1629 /* TLB invalidation must be done before signaling unbind */
1630 err = invalidation_fence_init(tile->primary_gt, ifence, fence, vma);
1632 dma_fence_put(fence);
1634 return ERR_PTR(err);
1636 fence = &ifence->base.base;
1638 /* add shared fence now for pagetable delayed destroy */
1639 dma_resv_add_fence(xe_vm_resv(vm), fence,
1640 DMA_RESV_USAGE_BOOKKEEP);
1642 /* This fence will be installed by caller when doing eviction */
1643 if (!xe_vma_has_no_bo(vma) && !xe_vma_bo(vma)->vm)
1644 dma_resv_add_fence(xe_vma_bo(vma)->ttm.base.resv, fence,
1645 DMA_RESV_USAGE_BOOKKEEP);
1646 xe_pt_commit_unbind(vma, entries, num_entries,
1647 unbind_pt_update.locked ? &deferred : NULL);
1648 vma->tile_present &= ~BIT(tile->id);
1654 if (!vma->tile_present)
1655 list_del_init(&vma->combined_links.rebind);
1657 if (unbind_pt_update.locked) {
1658 xe_tile_assert(tile, xe_vma_is_userptr(vma));
1660 if (!vma->tile_present) {
1661 spin_lock(&vm->userptr.invalidated_lock);
1662 list_del_init(&to_userptr_vma(vma)->userptr.invalidate_link);
1663 spin_unlock(&vm->userptr.invalidated_lock);
1665 up_read(&vm->userptr.notifier_lock);
1666 xe_bo_put_commit(&deferred);