amdgpu_vm.h revision 1.1 1 /* $NetBSD: amdgpu_vm.h,v 1.1 2021/12/18 20:11:13 riastradh Exp $ */
2
3 /*
4 * Copyright 2016 Advanced Micro Devices, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * Authors: Christian Knig
25 */
26 #ifndef __AMDGPU_VM_H__
27 #define __AMDGPU_VM_H__
28
29 #include <linux/idr.h>
30 #include <linux/kfifo.h>
31 #include <linux/rbtree.h>
32 #include <drm/gpu_scheduler.h>
33 #include <drm/drm_file.h>
34 #include <drm/ttm/ttm_bo_driver.h>
35 #include <linux/sched/mm.h>
36
37 #include "amdgpu_sync.h"
38 #include "amdgpu_ring.h"
39 #include "amdgpu_ids.h"
40
41 struct amdgpu_bo_va;
42 struct amdgpu_job;
43 struct amdgpu_bo_list_entry;
44
45 /*
46 * GPUVM handling
47 */
48
49 /* Maximum number of PTEs the hardware can write with one command */
50 #define AMDGPU_VM_MAX_UPDATE_SIZE 0x3FFFF
51
52 /* number of entries in page table */
53 #define AMDGPU_VM_PTE_COUNT(adev) (1 << (adev)->vm_manager.block_size)
54
55 #define AMDGPU_PTE_VALID (1ULL << 0)
56 #define AMDGPU_PTE_SYSTEM (1ULL << 1)
57 #define AMDGPU_PTE_SNOOPED (1ULL << 2)
58
59 /* VI only */
60 #define AMDGPU_PTE_EXECUTABLE (1ULL << 4)
61
62 #define AMDGPU_PTE_READABLE (1ULL << 5)
63 #define AMDGPU_PTE_WRITEABLE (1ULL << 6)
64
65 #define AMDGPU_PTE_FRAG(x) ((x & 0x1fULL) << 7)
66
67 /* TILED for VEGA10, reserved for older ASICs */
68 #define AMDGPU_PTE_PRT (1ULL << 51)
69
70 /* PDE is handled as PTE for VEGA10 */
71 #define AMDGPU_PDE_PTE (1ULL << 54)
72
73 #define AMDGPU_PTE_LOG (1ULL << 55)
74
75 /* PTE is handled as PDE for VEGA10 (Translate Further) */
76 #define AMDGPU_PTE_TF (1ULL << 56)
77
78 /* PDE Block Fragment Size for VEGA10 */
79 #define AMDGPU_PDE_BFS(a) ((uint64_t)a << 59)
80
81
82 /* For GFX9 */
83 #define AMDGPU_PTE_MTYPE_VG10(a) ((uint64_t)(a) << 57)
84 #define AMDGPU_PTE_MTYPE_VG10_MASK AMDGPU_PTE_MTYPE_VG10(3ULL)
85
86 #define AMDGPU_MTYPE_NC 0
87 #define AMDGPU_MTYPE_CC 2
88
89 #define AMDGPU_PTE_DEFAULT_ATC (AMDGPU_PTE_SYSTEM \
90 | AMDGPU_PTE_SNOOPED \
91 | AMDGPU_PTE_EXECUTABLE \
92 | AMDGPU_PTE_READABLE \
93 | AMDGPU_PTE_WRITEABLE \
94 | AMDGPU_PTE_MTYPE_VG10(AMDGPU_MTYPE_CC))
95
96 /* gfx10 */
97 #define AMDGPU_PTE_MTYPE_NV10(a) ((uint64_t)(a) << 48)
98 #define AMDGPU_PTE_MTYPE_NV10_MASK AMDGPU_PTE_MTYPE_NV10(7ULL)
99
100 /* How to programm VM fault handling */
101 #define AMDGPU_VM_FAULT_STOP_NEVER 0
102 #define AMDGPU_VM_FAULT_STOP_FIRST 1
103 #define AMDGPU_VM_FAULT_STOP_ALWAYS 2
104
105 /* Reserve 4MB VRAM for page tables */
106 #define AMDGPU_VM_RESERVED_VRAM (4ULL << 20)
107
108 /* max number of VMHUB */
109 #define AMDGPU_MAX_VMHUBS 3
110 #define AMDGPU_GFXHUB_0 0
111 #define AMDGPU_MMHUB_0 1
112 #define AMDGPU_MMHUB_1 2
113
114 /* hardcode that limit for now */
115 #define AMDGPU_VA_RESERVED_SIZE (1ULL << 20)
116
117 /* max vmids dedicated for process */
118 #define AMDGPU_VM_MAX_RESERVED_VMID 1
119
120 #define AMDGPU_VM_CONTEXT_GFX 0
121 #define AMDGPU_VM_CONTEXT_COMPUTE 1
122
123 /* See vm_update_mode */
124 #define AMDGPU_VM_USE_CPU_FOR_GFX (1 << 0)
125 #define AMDGPU_VM_USE_CPU_FOR_COMPUTE (1 << 1)
126
127 /* VMPT level enumerate, and the hiberachy is:
128 * PDB2->PDB1->PDB0->PTB
129 */
130 enum amdgpu_vm_level {
131 AMDGPU_VM_PDB2,
132 AMDGPU_VM_PDB1,
133 AMDGPU_VM_PDB0,
134 AMDGPU_VM_PTB
135 };
136
137 /* base structure for tracking BO usage in a VM */
138 struct amdgpu_vm_bo_base {
139 /* constant after initialization */
140 struct amdgpu_vm *vm;
141 struct amdgpu_bo *bo;
142
143 /* protected by bo being reserved */
144 struct amdgpu_vm_bo_base *next;
145
146 /* protected by spinlock */
147 struct list_head vm_status;
148
149 /* protected by the BO being reserved */
150 bool moved;
151 };
152
153 struct amdgpu_vm_pt {
154 struct amdgpu_vm_bo_base base;
155
156 /* array of page tables, one for each directory entry */
157 struct amdgpu_vm_pt *entries;
158 };
159
160 /* provided by hw blocks that can write ptes, e.g., sdma */
161 struct amdgpu_vm_pte_funcs {
162 /* number of dw to reserve per operation */
163 unsigned copy_pte_num_dw;
164
165 /* copy pte entries from GART */
166 void (*copy_pte)(struct amdgpu_ib *ib,
167 uint64_t pe, uint64_t src,
168 unsigned count);
169
170 /* write pte one entry at a time with addr mapping */
171 void (*write_pte)(struct amdgpu_ib *ib, uint64_t pe,
172 uint64_t value, unsigned count,
173 uint32_t incr);
174 /* for linear pte/pde updates without addr mapping */
175 void (*set_pte_pde)(struct amdgpu_ib *ib,
176 uint64_t pe,
177 uint64_t addr, unsigned count,
178 uint32_t incr, uint64_t flags);
179 };
180
181 struct amdgpu_task_info {
182 char process_name[TASK_COMM_LEN];
183 char task_name[TASK_COMM_LEN];
184 pid_t pid;
185 pid_t tgid;
186 };
187
188 /**
189 * struct amdgpu_vm_update_params
190 *
191 * Encapsulate some VM table update parameters to reduce
192 * the number of function parameters
193 *
194 */
195 struct amdgpu_vm_update_params {
196
197 /**
198 * @adev: amdgpu device we do this update for
199 */
200 struct amdgpu_device *adev;
201
202 /**
203 * @vm: optional amdgpu_vm we do this update for
204 */
205 struct amdgpu_vm *vm;
206
207 /**
208 * @direct: if changes should be made directly
209 */
210 bool direct;
211
212 /**
213 * @pages_addr:
214 *
215 * DMA addresses to use for mapping
216 */
217 dma_addr_t *pages_addr;
218
219 /**
220 * @job: job to used for hw submission
221 */
222 struct amdgpu_job *job;
223
224 /**
225 * @num_dw_left: number of dw left for the IB
226 */
227 unsigned int num_dw_left;
228 };
229
230 struct amdgpu_vm_update_funcs {
231 int (*map_table)(struct amdgpu_bo *bo);
232 int (*prepare)(struct amdgpu_vm_update_params *p, void * owner,
233 struct dma_fence *exclusive);
234 int (*update)(struct amdgpu_vm_update_params *p,
235 struct amdgpu_bo *bo, uint64_t pe, uint64_t addr,
236 unsigned count, uint32_t incr, uint64_t flags);
237 int (*commit)(struct amdgpu_vm_update_params *p,
238 struct dma_fence **fence);
239 };
240
241 struct amdgpu_vm {
242 /* tree of virtual addresses mapped */
243 struct rb_root_cached va;
244
245 /* Lock to prevent eviction while we are updating page tables
246 * use vm_eviction_lock/unlock(vm)
247 */
248 struct mutex eviction_lock;
249 bool evicting;
250 unsigned int saved_flags;
251
252 /* BOs who needs a validation */
253 struct list_head evicted;
254
255 /* PT BOs which relocated and their parent need an update */
256 struct list_head relocated;
257
258 /* per VM BOs moved, but not yet updated in the PT */
259 struct list_head moved;
260
261 /* All BOs of this VM not currently in the state machine */
262 struct list_head idle;
263
264 /* regular invalidated BOs, but not yet updated in the PT */
265 struct list_head invalidated;
266 spinlock_t invalidated_lock;
267
268 /* BO mappings freed, but not yet updated in the PT */
269 struct list_head freed;
270
271 /* contains the page directory */
272 struct amdgpu_vm_pt root;
273 struct dma_fence *last_update;
274
275 /* Scheduler entities for page table updates */
276 struct drm_sched_entity direct;
277 struct drm_sched_entity delayed;
278
279 /* Last submission to the scheduler entities */
280 struct dma_fence *last_direct;
281 struct dma_fence *last_delayed;
282
283 unsigned int pasid;
284 /* dedicated to vm */
285 struct amdgpu_vmid *reserved_vmid[AMDGPU_MAX_VMHUBS];
286
287 /* Flag to indicate if VM tables are updated by CPU or GPU (SDMA) */
288 bool use_cpu_for_update;
289
290 /* Functions to use for VM table updates */
291 const struct amdgpu_vm_update_funcs *update_funcs;
292
293 /* Flag to indicate ATS support from PTE for GFX9 */
294 bool pte_support_ats;
295
296 /* Up to 128 pending retry page faults */
297 DECLARE_KFIFO(faults, u64, 128);
298
299 /* Points to the KFD process VM info */
300 struct amdkfd_process_info *process_info;
301
302 /* List node in amdkfd_process_info.vm_list_head */
303 struct list_head vm_list_node;
304
305 /* Valid while the PD is reserved or fenced */
306 uint64_t pd_phys_addr;
307
308 /* Some basic info about the task */
309 struct amdgpu_task_info task_info;
310
311 /* Store positions of group of BOs */
312 struct ttm_lru_bulk_move lru_bulk_move;
313 /* mark whether can do the bulk move */
314 bool bulk_moveable;
315 /* Flag to indicate if VM is used for compute */
316 bool is_compute_context;
317 };
318
319 struct amdgpu_vm_manager {
320 /* Handling of VMIDs */
321 struct amdgpu_vmid_mgr id_mgr[AMDGPU_MAX_VMHUBS];
322
323 /* Handling of VM fences */
324 u64 fence_context;
325 unsigned seqno[AMDGPU_MAX_RINGS];
326
327 uint64_t max_pfn;
328 uint32_t num_level;
329 uint32_t block_size;
330 uint32_t fragment_size;
331 enum amdgpu_vm_level root_level;
332 /* vram base address for page table entry */
333 u64 vram_base_offset;
334 /* vm pte handling */
335 const struct amdgpu_vm_pte_funcs *vm_pte_funcs;
336 struct drm_gpu_scheduler *vm_pte_scheds[AMDGPU_MAX_RINGS];
337 unsigned vm_pte_num_scheds;
338 struct amdgpu_ring *page_fault;
339
340 /* partial resident texture handling */
341 spinlock_t prt_lock;
342 atomic_t num_prt_users;
343
344 /* controls how VM page tables are updated for Graphics and Compute.
345 * BIT0[= 0] Graphics updated by SDMA [= 1] by CPU
346 * BIT1[= 0] Compute updated by SDMA [= 1] by CPU
347 */
348 int vm_update_mode;
349
350 /* PASID to VM mapping, will be used in interrupt context to
351 * look up VM of a page fault
352 */
353 struct idr pasid_idr;
354 spinlock_t pasid_lock;
355
356 /* counter of mapped memory through xgmi */
357 uint32_t xgmi_map_counter;
358 struct mutex lock_pstate;
359 };
360
361 #define amdgpu_vm_copy_pte(adev, ib, pe, src, count) ((adev)->vm_manager.vm_pte_funcs->copy_pte((ib), (pe), (src), (count)))
362 #define amdgpu_vm_write_pte(adev, ib, pe, value, count, incr) ((adev)->vm_manager.vm_pte_funcs->write_pte((ib), (pe), (value), (count), (incr)))
363 #define amdgpu_vm_set_pte_pde(adev, ib, pe, addr, count, incr, flags) ((adev)->vm_manager.vm_pte_funcs->set_pte_pde((ib), (pe), (addr), (count), (incr), (flags)))
364
365 extern const struct amdgpu_vm_update_funcs amdgpu_vm_cpu_funcs;
366 extern const struct amdgpu_vm_update_funcs amdgpu_vm_sdma_funcs;
367
368 void amdgpu_vm_manager_init(struct amdgpu_device *adev);
369 void amdgpu_vm_manager_fini(struct amdgpu_device *adev);
370
371 long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout);
372 int amdgpu_vm_init(struct amdgpu_device *adev, struct amdgpu_vm *vm,
373 int vm_context, unsigned int pasid);
374 int amdgpu_vm_make_compute(struct amdgpu_device *adev, struct amdgpu_vm *vm, unsigned int pasid);
375 void amdgpu_vm_release_compute(struct amdgpu_device *adev, struct amdgpu_vm *vm);
376 void amdgpu_vm_fini(struct amdgpu_device *adev, struct amdgpu_vm *vm);
377 void amdgpu_vm_get_pd_bo(struct amdgpu_vm *vm,
378 struct list_head *validated,
379 struct amdgpu_bo_list_entry *entry);
380 bool amdgpu_vm_ready(struct amdgpu_vm *vm);
381 int amdgpu_vm_validate_pt_bos(struct amdgpu_device *adev, struct amdgpu_vm *vm,
382 int (*callback)(void *p, struct amdgpu_bo *bo),
383 void *param);
384 int amdgpu_vm_flush(struct amdgpu_ring *ring, struct amdgpu_job *job, bool need_pipe_sync);
385 int amdgpu_vm_update_pdes(struct amdgpu_device *adev,
386 struct amdgpu_vm *vm, bool direct);
387 int amdgpu_vm_clear_freed(struct amdgpu_device *adev,
388 struct amdgpu_vm *vm,
389 struct dma_fence **fence);
390 int amdgpu_vm_handle_moved(struct amdgpu_device *adev,
391 struct amdgpu_vm *vm);
392 int amdgpu_vm_bo_update(struct amdgpu_device *adev,
393 struct amdgpu_bo_va *bo_va,
394 bool clear);
395 bool amdgpu_vm_evictable(struct amdgpu_bo *bo);
396 void amdgpu_vm_bo_invalidate(struct amdgpu_device *adev,
397 struct amdgpu_bo *bo, bool evicted);
398 uint64_t amdgpu_vm_map_gart(const dma_addr_t *pages_addr, uint64_t addr);
399 struct amdgpu_bo_va *amdgpu_vm_bo_find(struct amdgpu_vm *vm,
400 struct amdgpu_bo *bo);
401 struct amdgpu_bo_va *amdgpu_vm_bo_add(struct amdgpu_device *adev,
402 struct amdgpu_vm *vm,
403 struct amdgpu_bo *bo);
404 int amdgpu_vm_bo_map(struct amdgpu_device *adev,
405 struct amdgpu_bo_va *bo_va,
406 uint64_t addr, uint64_t offset,
407 uint64_t size, uint64_t flags);
408 int amdgpu_vm_bo_replace_map(struct amdgpu_device *adev,
409 struct amdgpu_bo_va *bo_va,
410 uint64_t addr, uint64_t offset,
411 uint64_t size, uint64_t flags);
412 int amdgpu_vm_bo_unmap(struct amdgpu_device *adev,
413 struct amdgpu_bo_va *bo_va,
414 uint64_t addr);
415 int amdgpu_vm_bo_clear_mappings(struct amdgpu_device *adev,
416 struct amdgpu_vm *vm,
417 uint64_t saddr, uint64_t size);
418 struct amdgpu_bo_va_mapping *amdgpu_vm_bo_lookup_mapping(struct amdgpu_vm *vm,
419 uint64_t addr);
420 void amdgpu_vm_bo_trace_cs(struct amdgpu_vm *vm, struct ww_acquire_ctx *ticket);
421 void amdgpu_vm_bo_rmv(struct amdgpu_device *adev,
422 struct amdgpu_bo_va *bo_va);
423 void amdgpu_vm_adjust_size(struct amdgpu_device *adev, uint32_t min_vm_size,
424 uint32_t fragment_size_default, unsigned max_level,
425 unsigned max_bits);
426 int amdgpu_vm_ioctl(struct drm_device *dev, void *data, struct drm_file *filp);
427 bool amdgpu_vm_need_pipeline_sync(struct amdgpu_ring *ring,
428 struct amdgpu_job *job);
429 void amdgpu_vm_check_compute_bug(struct amdgpu_device *adev);
430
431 void amdgpu_vm_get_task_info(struct amdgpu_device *adev, unsigned int pasid,
432 struct amdgpu_task_info *task_info);
433 bool amdgpu_vm_handle_fault(struct amdgpu_device *adev, unsigned int pasid,
434 uint64_t addr);
435
436 void amdgpu_vm_set_task_info(struct amdgpu_vm *vm);
437
438 void amdgpu_vm_move_to_lru_tail(struct amdgpu_device *adev,
439 struct amdgpu_vm *vm);
440 void amdgpu_vm_del_from_lru_notify(struct ttm_buffer_object *bo);
441
442 #endif
443