1 /* SPDX-License-Identifier: MIT */
3 * Copyright © 2021 Intel Corporation
9 #include "xe_bo_types.h"
10 #include "xe_macros.h"
12 #include "xe_vm_types.h"
18 struct ttm_buffer_object;
19 struct ttm_validate_buffer;
26 struct xe_vm *xe_vm_create(struct xe_device *xe, u32 flags);
28 struct xe_vm *xe_vm_lookup(struct xe_file *xef, u32 id);
29 int xe_vma_cmp_vma_cb(const void *key, const struct rb_node *node);
31 static inline struct xe_vm *xe_vm_get(struct xe_vm *vm)
33 drm_gpuvm_get(&vm->gpuvm);
37 static inline void xe_vm_put(struct xe_vm *vm)
39 drm_gpuvm_put(&vm->gpuvm);
42 int xe_vm_lock(struct xe_vm *vm, bool intr);
44 void xe_vm_unlock(struct xe_vm *vm);
46 static inline bool xe_vm_is_closed(struct xe_vm *vm)
48 /* Only guaranteed not to change when vm->lock is held */
52 static inline bool xe_vm_is_banned(struct xe_vm *vm)
54 return vm->flags & XE_VM_FLAG_BANNED;
57 static inline bool xe_vm_is_closed_or_banned(struct xe_vm *vm)
59 lockdep_assert_held(&vm->lock);
60 return xe_vm_is_closed(vm) || xe_vm_is_banned(vm);
64 xe_vm_find_overlapping_vma(struct xe_vm *vm, u64 start, u64 range);
67 * xe_vm_has_scratch() - Whether the vm is configured for scratch PTEs
70 * Return: whether the vm populates unmapped areas with scratch PTEs
72 static inline bool xe_vm_has_scratch(const struct xe_vm *vm)
74 return vm->flags & XE_VM_FLAG_SCRATCH_PAGE;
78 * gpuvm_to_vm() - Return the embedding xe_vm from a struct drm_gpuvm pointer
79 * @gpuvm: The struct drm_gpuvm pointer
81 * Return: Pointer to the embedding struct xe_vm.
83 static inline struct xe_vm *gpuvm_to_vm(struct drm_gpuvm *gpuvm)
85 return container_of(gpuvm, struct xe_vm, gpuvm);
88 static inline struct xe_vm *gpuva_to_vm(struct drm_gpuva *gpuva)
90 return gpuvm_to_vm(gpuva->vm);
93 static inline struct xe_vma *gpuva_to_vma(struct drm_gpuva *gpuva)
95 return container_of(gpuva, struct xe_vma, gpuva);
98 static inline struct xe_vma_op *gpuva_op_to_vma_op(struct drm_gpuva_op *op)
100 return container_of(op, struct xe_vma_op, base);
104 * DOC: Provide accessors for vma members to facilitate easy change of
107 static inline u64 xe_vma_start(struct xe_vma *vma)
109 return vma->gpuva.va.addr;
112 static inline u64 xe_vma_size(struct xe_vma *vma)
114 return vma->gpuva.va.range;
117 static inline u64 xe_vma_end(struct xe_vma *vma)
119 return xe_vma_start(vma) + xe_vma_size(vma);
122 static inline u64 xe_vma_bo_offset(struct xe_vma *vma)
124 return vma->gpuva.gem.offset;
127 static inline struct xe_bo *xe_vma_bo(struct xe_vma *vma)
129 return !vma->gpuva.gem.obj ? NULL :
130 container_of(vma->gpuva.gem.obj, struct xe_bo, ttm.base);
133 static inline struct xe_vm *xe_vma_vm(struct xe_vma *vma)
135 return container_of(vma->gpuva.vm, struct xe_vm, gpuvm);
138 static inline bool xe_vma_read_only(struct xe_vma *vma)
140 return vma->gpuva.flags & XE_VMA_READ_ONLY;
143 static inline u64 xe_vma_userptr(struct xe_vma *vma)
145 return vma->gpuva.gem.offset;
148 static inline bool xe_vma_is_null(struct xe_vma *vma)
150 return vma->gpuva.flags & DRM_GPUVA_SPARSE;
153 static inline bool xe_vma_has_no_bo(struct xe_vma *vma)
155 return !xe_vma_bo(vma);
158 static inline bool xe_vma_is_userptr(struct xe_vma *vma)
160 return xe_vma_has_no_bo(vma) && !xe_vma_is_null(vma);
164 * to_userptr_vma() - Return a pointer to an embedding userptr vma
165 * @vma: Pointer to the embedded struct xe_vma
167 * Return: Pointer to the embedding userptr vma
169 static inline struct xe_userptr_vma *to_userptr_vma(struct xe_vma *vma)
171 xe_assert(xe_vma_vm(vma)->xe, xe_vma_is_userptr(vma));
172 return container_of(vma, struct xe_userptr_vma, vma);
175 u64 xe_vm_pdp4_descriptor(struct xe_vm *vm, struct xe_tile *tile);
177 int xe_vm_create_ioctl(struct drm_device *dev, void *data,
178 struct drm_file *file);
179 int xe_vm_destroy_ioctl(struct drm_device *dev, void *data,
180 struct drm_file *file);
181 int xe_vm_bind_ioctl(struct drm_device *dev, void *data,
182 struct drm_file *file);
184 void xe_vm_close_and_put(struct xe_vm *vm);
186 static inline bool xe_vm_in_fault_mode(struct xe_vm *vm)
188 return vm->flags & XE_VM_FLAG_FAULT_MODE;
191 static inline bool xe_vm_in_lr_mode(struct xe_vm *vm)
193 return vm->flags & XE_VM_FLAG_LR_MODE;
196 static inline bool xe_vm_in_preempt_fence_mode(struct xe_vm *vm)
198 return xe_vm_in_lr_mode(vm) && !xe_vm_in_fault_mode(vm);
201 int xe_vm_add_compute_exec_queue(struct xe_vm *vm, struct xe_exec_queue *q);
202 void xe_vm_remove_compute_exec_queue(struct xe_vm *vm, struct xe_exec_queue *q);
204 int xe_vm_userptr_pin(struct xe_vm *vm);
206 int __xe_vm_userptr_needs_repin(struct xe_vm *vm);
208 int xe_vm_userptr_check_repin(struct xe_vm *vm);
210 int xe_vm_rebind(struct xe_vm *vm, bool rebind_worker);
212 int xe_vm_invalidate_vma(struct xe_vma *vma);
214 static inline void xe_vm_queue_rebind_worker(struct xe_vm *vm)
216 xe_assert(vm->xe, xe_vm_in_preempt_fence_mode(vm));
217 queue_work(vm->xe->ordered_wq, &vm->preempt.rebind_work);
221 * xe_vm_reactivate_rebind() - Reactivate the rebind functionality on compute
225 * If the rebind functionality on a compute vm was disabled due
226 * to nothing to execute. Reactivate it and run the rebind worker.
227 * This function should be called after submitting a batch to a compute vm.
229 static inline void xe_vm_reactivate_rebind(struct xe_vm *vm)
231 if (xe_vm_in_preempt_fence_mode(vm) && vm->preempt.rebind_deactivated) {
232 vm->preempt.rebind_deactivated = false;
233 xe_vm_queue_rebind_worker(vm);
237 int xe_vma_userptr_pin_pages(struct xe_userptr_vma *uvma);
239 int xe_vma_userptr_check_repin(struct xe_userptr_vma *uvma);
241 bool xe_vm_validate_should_retry(struct drm_exec *exec, int err, ktime_t *end);
243 int xe_analyze_vm(struct drm_printer *p, struct xe_vm *vm, int gt_id);
245 int xe_vm_lock_vma(struct drm_exec *exec, struct xe_vma *vma);
247 int xe_vm_validate_rebind(struct xe_vm *vm, struct drm_exec *exec,
248 unsigned int num_fences);
251 * xe_vm_resv() - Return's the vm's reservation object
254 * Return: Pointer to the vm's reservation object.
256 static inline struct dma_resv *xe_vm_resv(struct xe_vm *vm)
258 return drm_gpuvm_resv(&vm->gpuvm);
262 * xe_vm_assert_held(vm) - Assert that the vm's reservation object is held.
265 #define xe_vm_assert_held(vm) dma_resv_assert_held(xe_vm_resv(vm))
267 #if IS_ENABLED(CONFIG_DRM_XE_DEBUG_VM)
268 #define vm_dbg drm_dbg
271 static inline void vm_dbg(const struct drm_device *dev,
272 const char *format, ...)
277 struct xe_vm_snapshot *xe_vm_snapshot_capture(struct xe_vm *vm);
278 void xe_vm_snapshot_capture_delayed(struct xe_vm_snapshot *snap);
279 void xe_vm_snapshot_print(struct xe_vm_snapshot *snap, struct drm_printer *p);
280 void xe_vm_snapshot_free(struct xe_vm_snapshot *snap);