xref: /openbsd/sys/dev/pci/drm/ttm/ttm_bo_vm.c (revision 55cc5ba3)
1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
3  *
4  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
5  * All Rights Reserved.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sub license, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice (including the
16  * next paragraph) shall be included in all copies or substantial portions
17  * of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25  * USE OR OTHER DEALINGS IN THE SOFTWARE.
26  *
27  **************************************************************************/
28 /*
29  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
30  */
31 
32 #define pr_fmt(fmt) "[TTM] " fmt
33 
34 #include <drm/ttm/ttm_module.h>
35 #include <drm/ttm/ttm_bo_driver.h>
36 #include <drm/ttm/ttm_placement.h>
37 #include <drm/drm_vma_manager.h>
38 #include <linux/mm.h>
39 #include <linux/pfn_t.h>
40 #include <linux/rbtree.h>
41 #include <linux/module.h>
42 #include <linux/uaccess.h>
43 #include <linux/mem_encrypt.h>
44 
45 #ifdef __linux__
46 
47 static vm_fault_t ttm_bo_vm_fault_idle(struct ttm_buffer_object *bo,
48 				struct vm_fault *vmf)
49 {
50 	vm_fault_t ret = 0;
51 	int err = 0;
52 
53 	if (likely(!bo->moving))
54 		goto out_unlock;
55 
56 	/*
57 	 * Quick non-stalling check for idle.
58 	 */
59 	if (dma_fence_is_signaled(bo->moving))
60 		goto out_clear;
61 
62 	/*
63 	 * If possible, avoid waiting for GPU with mmap_sem
64 	 * held.  We only do this if the fault allows retry and this
65 	 * is the first attempt.
66 	 */
67 	if (fault_flag_allow_retry_first(vmf->flags)) {
68 		ret = VM_FAULT_RETRY;
69 		if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
70 			goto out_unlock;
71 
72 		ttm_bo_get(bo);
73 		up_read(&vmf->vma->vm_mm->mmap_sem);
74 		(void) dma_fence_wait(bo->moving, true);
75 		dma_resv_unlock(bo->base.resv);
76 		ttm_bo_put(bo);
77 		goto out_unlock;
78 	}
79 
80 	/*
81 	 * Ordinary wait.
82 	 */
83 	err = dma_fence_wait(bo->moving, true);
84 	if (unlikely(err != 0)) {
85 		ret = (err != -ERESTARTSYS) ? VM_FAULT_SIGBUS :
86 			VM_FAULT_NOPAGE;
87 		goto out_unlock;
88 	}
89 
90 out_clear:
91 	dma_fence_put(bo->moving);
92 	bo->moving = NULL;
93 
94 out_unlock:
95 	return ret;
96 }
97 
98 static unsigned long ttm_bo_io_mem_pfn(struct ttm_buffer_object *bo,
99 				       unsigned long page_offset)
100 {
101 	struct ttm_bo_device *bdev = bo->bdev;
102 
103 	if (bdev->driver->io_mem_pfn)
104 		return bdev->driver->io_mem_pfn(bo, page_offset);
105 
106 	return ((bo->mem.bus.base + bo->mem.bus.offset) >> PAGE_SHIFT)
107 		+ page_offset;
108 }
109 
110 /**
111  * ttm_bo_vm_reserve - Reserve a buffer object in a retryable vm callback
112  * @bo: The buffer object
113  * @vmf: The fault structure handed to the callback
114  *
115  * vm callbacks like fault() and *_mkwrite() allow for the mm_sem to be dropped
116  * during long waits, and after the wait the callback will be restarted. This
117  * is to allow other threads using the same virtual memory space concurrent
118  * access to map(), unmap() completely unrelated buffer objects. TTM buffer
119  * object reservations sometimes wait for GPU and should therefore be
120  * considered long waits. This function reserves the buffer object interruptibly
121  * taking this into account. Starvation is avoided by the vm system not
122  * allowing too many repeated restarts.
123  * This function is intended to be used in customized fault() and _mkwrite()
124  * handlers.
125  *
126  * Return:
127  *    0 on success and the bo was reserved.
128  *    VM_FAULT_RETRY if blocking wait.
129  *    VM_FAULT_NOPAGE if blocking wait and retrying was not allowed.
130  */
131 vm_fault_t ttm_bo_vm_reserve(struct ttm_buffer_object *bo,
132 			     struct vm_fault *vmf)
133 {
134 	/*
135 	 * Work around locking order reversal in fault / nopfn
136 	 * between mmap_sem and bo_reserve: Perform a trylock operation
137 	 * for reserve, and if it fails, retry the fault after waiting
138 	 * for the buffer to become unreserved.
139 	 */
140 	if (unlikely(!dma_resv_trylock(bo->base.resv))) {
141 		/*
142 		 * If the fault allows retry and this is the first
143 		 * fault attempt, we try to release the mmap_sem
144 		 * before waiting
145 		 */
146 		if (fault_flag_allow_retry_first(vmf->flags)) {
147 			if (!(vmf->flags & FAULT_FLAG_RETRY_NOWAIT)) {
148 				ttm_bo_get(bo);
149 				up_read(&vmf->vma->vm_mm->mmap_sem);
150 				if (!dma_resv_lock_interruptible(bo->base.resv,
151 								 NULL))
152 					dma_resv_unlock(bo->base.resv);
153 				ttm_bo_put(bo);
154 			}
155 
156 			return VM_FAULT_RETRY;
157 		}
158 
159 		if (dma_resv_lock_interruptible(bo->base.resv, NULL))
160 			return VM_FAULT_NOPAGE;
161 	}
162 
163 	return 0;
164 }
165 EXPORT_SYMBOL(ttm_bo_vm_reserve);
166 
167 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
168 /**
169  * ttm_bo_vm_insert_huge - Insert a pfn for PUD or PMD faults
170  * @vmf: Fault data
171  * @bo: The buffer object
172  * @page_offset: Page offset from bo start
173  * @fault_page_size: The size of the fault in pages.
174  * @pgprot: The page protections.
175  * Does additional checking whether it's possible to insert a PUD or PMD
176  * pfn and performs the insertion.
177  *
178  * Return: VM_FAULT_NOPAGE on successful insertion, VM_FAULT_FALLBACK if
179  * a huge fault was not possible, or on insertion error.
180  */
181 static vm_fault_t ttm_bo_vm_insert_huge(struct vm_fault *vmf,
182 					struct ttm_buffer_object *bo,
183 					pgoff_t page_offset,
184 					pgoff_t fault_page_size,
185 					pgprot_t pgprot)
186 {
187 	pgoff_t i;
188 	vm_fault_t ret;
189 	unsigned long pfn;
190 	pfn_t pfnt;
191 	struct ttm_tt *ttm = bo->ttm;
192 	bool write = vmf->flags & FAULT_FLAG_WRITE;
193 
194 	/* Fault should not cross bo boundary. */
195 	page_offset &= ~(fault_page_size - 1);
196 	if (page_offset + fault_page_size > bo->num_pages)
197 		goto out_fallback;
198 
199 	if (bo->mem.bus.is_iomem)
200 		pfn = ttm_bo_io_mem_pfn(bo, page_offset);
201 	else
202 		pfn = page_to_pfn(ttm->pages[page_offset]);
203 
204 	/* pfn must be fault_page_size aligned. */
205 	if ((pfn & (fault_page_size - 1)) != 0)
206 		goto out_fallback;
207 
208 	/* Check that memory is contiguous. */
209 	if (!bo->mem.bus.is_iomem) {
210 		for (i = 1; i < fault_page_size; ++i) {
211 			if (page_to_pfn(ttm->pages[page_offset + i]) != pfn + i)
212 				goto out_fallback;
213 		}
214 	} else if (bo->bdev->driver->io_mem_pfn) {
215 		for (i = 1; i < fault_page_size; ++i) {
216 			if (ttm_bo_io_mem_pfn(bo, page_offset + i) != pfn + i)
217 				goto out_fallback;
218 		}
219 	}
220 
221 	pfnt = __pfn_to_pfn_t(pfn, PFN_DEV);
222 	if (fault_page_size == (HPAGE_PMD_SIZE >> PAGE_SHIFT))
223 		ret = vmf_insert_pfn_pmd_prot(vmf, pfnt, pgprot, write);
224 #ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
225 	else if (fault_page_size == (HPAGE_PUD_SIZE >> PAGE_SHIFT))
226 		ret = vmf_insert_pfn_pud_prot(vmf, pfnt, pgprot, write);
227 #endif
228 	else
229 		WARN_ON_ONCE(ret = VM_FAULT_FALLBACK);
230 
231 	if (ret != VM_FAULT_NOPAGE)
232 		goto out_fallback;
233 
234 	return VM_FAULT_NOPAGE;
235 out_fallback:
236 	count_vm_event(THP_FAULT_FALLBACK);
237 	return VM_FAULT_FALLBACK;
238 }
239 #else
240 static vm_fault_t ttm_bo_vm_insert_huge(struct vm_fault *vmf,
241 					struct ttm_buffer_object *bo,
242 					pgoff_t page_offset,
243 					pgoff_t fault_page_size,
244 					pgprot_t pgprot)
245 {
246 	return VM_FAULT_FALLBACK;
247 }
248 #endif
249 
250 /**
251  * ttm_bo_vm_fault_reserved - TTM fault helper
252  * @vmf: The struct vm_fault given as argument to the fault callback
253  * @prot: The page protection to be used for this memory area.
254  * @num_prefault: Maximum number of prefault pages. The caller may want to
255  * specify this based on madvice settings and the size of the GPU object
256  * backed by the memory.
257  * @fault_page_size: The size of the fault in pages.
258  *
259  * This function inserts one or more page table entries pointing to the
260  * memory backing the buffer object, and then returns a return code
261  * instructing the caller to retry the page access.
262  *
263  * Return:
264  *   VM_FAULT_NOPAGE on success or pending signal
265  *   VM_FAULT_SIGBUS on unspecified error
266  *   VM_FAULT_OOM on out-of-memory
267  *   VM_FAULT_RETRY if retryable wait
268  */
269 vm_fault_t ttm_bo_vm_fault_reserved(struct vm_fault *vmf,
270 				    pgprot_t prot,
271 				    pgoff_t num_prefault,
272 				    pgoff_t fault_page_size)
273 {
274 	struct vm_area_struct *vma = vmf->vma;
275 	struct ttm_buffer_object *bo = vma->vm_private_data;
276 	struct ttm_bo_device *bdev = bo->bdev;
277 	unsigned long page_offset;
278 	unsigned long page_last;
279 	unsigned long pfn;
280 	struct ttm_tt *ttm = NULL;
281 	struct vm_page *page;
282 	int err;
283 	pgoff_t i;
284 	vm_fault_t ret = VM_FAULT_NOPAGE;
285 	unsigned long address = vmf->address;
286 	struct ttm_mem_type_manager *man =
287 		&bdev->man[bo->mem.mem_type];
288 
289 	/*
290 	 * Refuse to fault imported pages. This should be handled
291 	 * (if at all) by redirecting mmap to the exporter.
292 	 */
293 	if (bo->ttm && (bo->ttm->page_flags & TTM_PAGE_FLAG_SG))
294 		return VM_FAULT_SIGBUS;
295 
296 	if (bdev->driver->fault_reserve_notify) {
297 		struct dma_fence *moving = dma_fence_get(bo->moving);
298 
299 		err = bdev->driver->fault_reserve_notify(bo);
300 		switch (err) {
301 		case 0:
302 			break;
303 		case -EBUSY:
304 		case -ERESTARTSYS:
305 			dma_fence_put(moving);
306 			return VM_FAULT_NOPAGE;
307 		default:
308 			dma_fence_put(moving);
309 			return VM_FAULT_SIGBUS;
310 		}
311 
312 		if (bo->moving != moving) {
313 			spin_lock(&ttm_bo_glob.lru_lock);
314 			ttm_bo_move_to_lru_tail(bo, NULL);
315 			spin_unlock(&ttm_bo_glob.lru_lock);
316 		}
317 		dma_fence_put(moving);
318 	}
319 
320 	/*
321 	 * Wait for buffer data in transit, due to a pipelined
322 	 * move.
323 	 */
324 	ret = ttm_bo_vm_fault_idle(bo, vmf);
325 	if (unlikely(ret != 0))
326 		return ret;
327 
328 	err = ttm_mem_io_lock(man, true);
329 	if (unlikely(err != 0))
330 		return VM_FAULT_NOPAGE;
331 	err = ttm_mem_io_reserve_vm(bo);
332 	if (unlikely(err != 0)) {
333 		ret = VM_FAULT_SIGBUS;
334 		goto out_io_unlock;
335 	}
336 
337 	page_offset = ((address - vma->vm_start) >> PAGE_SHIFT) +
338 		vma->vm_pgoff - drm_vma_node_start(&bo->base.vma_node);
339 	page_last = vma_pages(vma) + vma->vm_pgoff -
340 		drm_vma_node_start(&bo->base.vma_node);
341 
342 	if (unlikely(page_offset >= bo->num_pages)) {
343 		ret = VM_FAULT_SIGBUS;
344 		goto out_io_unlock;
345 	}
346 
347 	prot = ttm_io_prot(bo->mem.placement, prot);
348 	if (!bo->mem.bus.is_iomem) {
349 		struct ttm_operation_ctx ctx = {
350 			.interruptible = false,
351 			.no_wait_gpu = false,
352 			.flags = TTM_OPT_FLAG_FORCE_ALLOC
353 
354 		};
355 
356 		ttm = bo->ttm;
357 		if (ttm_tt_populate(bo->ttm, &ctx)) {
358 			ret = VM_FAULT_OOM;
359 			goto out_io_unlock;
360 		}
361 	} else {
362 		/* Iomem should not be marked encrypted */
363 		prot = pgprot_decrypted(prot);
364 	}
365 
366 	/* We don't prefault on huge faults. Yet. */
367 	if (IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE) && fault_page_size != 1) {
368 		ret = ttm_bo_vm_insert_huge(vmf, bo, page_offset,
369 					    fault_page_size, prot);
370 		goto out_io_unlock;
371 	}
372 
373 	/*
374 	 * Speculatively prefault a number of pages. Only error on
375 	 * first page.
376 	 */
377 	for (i = 0; i < num_prefault; ++i) {
378 		if (bo->mem.bus.is_iomem) {
379 			pfn = ttm_bo_io_mem_pfn(bo, page_offset);
380 		} else {
381 			page = ttm->pages[page_offset];
382 			if (unlikely(!page && i == 0)) {
383 				ret = VM_FAULT_OOM;
384 				goto out_io_unlock;
385 			} else if (unlikely(!page)) {
386 				break;
387 			}
388 			page->index = drm_vma_node_start(&bo->base.vma_node) +
389 				page_offset;
390 			pfn = page_to_pfn(page);
391 		}
392 
393 		/*
394 		 * Note that the value of @prot at this point may differ from
395 		 * the value of @vma->vm_page_prot in the caching- and
396 		 * encryption bits. This is because the exact location of the
397 		 * data may not be known at mmap() time and may also change
398 		 * at arbitrary times while the data is mmap'ed.
399 		 * See vmf_insert_mixed_prot() for a discussion.
400 		 */
401 		if (vma->vm_flags & VM_MIXEDMAP)
402 			ret = vmf_insert_mixed_prot(vma, address,
403 						    __pfn_to_pfn_t(pfn, PFN_DEV),
404 						    prot);
405 		else
406 			ret = vmf_insert_pfn_prot(vma, address, pfn, prot);
407 
408 		/* Never error on prefaulted PTEs */
409 		if (unlikely((ret & VM_FAULT_ERROR))) {
410 			if (i == 0)
411 				goto out_io_unlock;
412 			else
413 				break;
414 		}
415 
416 		address += PAGE_SIZE;
417 		if (unlikely(++page_offset >= page_last))
418 			break;
419 	}
420 	ret = VM_FAULT_NOPAGE;
421 out_io_unlock:
422 	ttm_mem_io_unlock(man);
423 	return ret;
424 }
425 EXPORT_SYMBOL(ttm_bo_vm_fault_reserved);
426 
427 vm_fault_t ttm_bo_vm_fault(struct vm_fault *vmf)
428 {
429 	struct vm_area_struct *vma = vmf->vma;
430 	pgprot_t prot;
431 	struct ttm_buffer_object *bo = vma->vm_private_data;
432 	vm_fault_t ret;
433 
434 	ret = ttm_bo_vm_reserve(bo, vmf);
435 	if (ret)
436 		return ret;
437 
438 	prot = vma->vm_page_prot;
439 	ret = ttm_bo_vm_fault_reserved(vmf, prot, TTM_BO_VM_NUM_PREFAULT, 1);
440 	if (ret == VM_FAULT_RETRY && !(vmf->flags & FAULT_FLAG_RETRY_NOWAIT))
441 		return ret;
442 
443 	dma_resv_unlock(bo->base.resv);
444 
445 	return ret;
446 }
447 EXPORT_SYMBOL(ttm_bo_vm_fault);
448 
449 #else /* !__linux__ */
450 
451 #define VM_FAULT_NOPAGE		1
452 #define VM_FAULT_SIGBUS		2
453 #define VM_FAULT_RETRY		3
454 #define VM_FAULT_OOM		4
455 
456 static vm_fault_t ttm_bo_vm_fault_idle(struct ttm_buffer_object *bo,
457     struct uvm_faultinfo *ufi)
458 {
459 	vm_fault_t ret = 0;
460 	int err = 0;
461 
462 	if (likely(!bo->moving))
463 		goto out_unlock;
464 
465 	/*
466 	 * Quick non-stalling check for idle.
467 	 */
468 	if (dma_fence_is_signaled(bo->moving))
469 		goto out_clear;
470 
471 #ifdef __linux__
472 	/*
473 	 * If possible, avoid waiting for GPU with mmap_sem
474 	 * held.  We only do this if the fault allows retry and this
475 	 * is the first attempt.
476 	 */
477 	if (fault_flag_allow_retry_first(vmf->flags)) {
478 		ret = VM_FAULT_RETRY;
479 		if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
480 			goto out_unlock;
481 
482 		ttm_bo_get(bo);
483 		up_read(&vmf->vma->vm_mm->mmap_sem);
484 		(void) dma_fence_wait(bo->moving, true);
485 		dma_resv_unlock(bo->base.resv);
486 		ttm_bo_put(bo);
487 		goto out_unlock;
488 	}
489 #endif
490 
491 	/*
492 	 * Ordinary wait.
493 	 */
494 	err = dma_fence_wait(bo->moving, true);
495 	if (unlikely(err != 0)) {
496 		ret = (err != -ERESTARTSYS) ? VM_FAULT_SIGBUS :
497 			VM_FAULT_NOPAGE;
498 		goto out_unlock;
499 	}
500 
501 out_clear:
502 	dma_fence_put(bo->moving);
503 	bo->moving = NULL;
504 
505 out_unlock:
506 	return ret;
507 }
508 
509 static unsigned long ttm_bo_io_mem_pfn(struct ttm_buffer_object *bo,
510 				       unsigned long page_offset)
511 {
512 	struct ttm_bo_device *bdev = bo->bdev;
513 
514 	if (bdev->driver->io_mem_pfn)
515 		return bdev->driver->io_mem_pfn(bo, page_offset);
516 
517 	return ((bo->mem.bus.base + bo->mem.bus.offset) >> PAGE_SHIFT)
518 		+ page_offset;
519 }
520 
521 /**
522  * ttm_bo_vm_reserve - Reserve a buffer object in a retryable vm callback
523  * @bo: The buffer object
524  * @vmf: The fault structure handed to the callback
525  *
526  * vm callbacks like fault() and *_mkwrite() allow for the mm_sem to be dropped
527  * during long waits, and after the wait the callback will be restarted. This
528  * is to allow other threads using the same virtual memory space concurrent
529  * access to map(), unmap() completely unrelated buffer objects. TTM buffer
530  * object reservations sometimes wait for GPU and should therefore be
531  * considered long waits. This function reserves the buffer object interruptibly
532  * taking this into account. Starvation is avoided by the vm system not
533  * allowing too many repeated restarts.
534  * This function is intended to be used in customized fault() and _mkwrite()
535  * handlers.
536  *
537  * Return:
538  *    0 on success and the bo was reserved.
539  *    VM_FAULT_RETRY if blocking wait.
540  *    VM_FAULT_NOPAGE if blocking wait and retrying was not allowed.
541  */
542 vm_fault_t ttm_bo_vm_reserve(struct ttm_buffer_object *bo)
543 {
544 	/*
545 	 * Work around locking order reversal in fault / nopfn
546 	 * between mmap_sem and bo_reserve: Perform a trylock operation
547 	 * for reserve, and if it fails, retry the fault after waiting
548 	 * for the buffer to become unreserved.
549 	 */
550 	if (unlikely(!dma_resv_trylock(bo->base.resv))) {
551 #ifdef __linux__
552 		/*
553 		 * If the fault allows retry and this is the first
554 		 * fault attempt, we try to release the mmap_sem
555 		 * before waiting
556 		 */
557 		if (fault_flag_allow_retry_first(vmf->flags)) {
558 			if (!(vmf->flags & FAULT_FLAG_RETRY_NOWAIT)) {
559 				ttm_bo_get(bo);
560 				up_read(&vmf->vma->vm_mm->mmap_sem);
561 				if (!dma_resv_lock_interruptible(bo->base.resv,
562 								 NULL))
563 					dma_resv_unlock(bo->base.resv);
564 				ttm_bo_put(bo);
565 			}
566 
567 			return VM_FAULT_RETRY;
568 		}
569 #endif
570 
571 		if (dma_resv_lock_interruptible(bo->base.resv, NULL))
572 			return VM_FAULT_NOPAGE;
573 	}
574 
575 	return 0;
576 }
577 
578 vm_fault_t ttm_bo_vm_fault_reserved(struct uvm_faultinfo *ufi,
579 				    vaddr_t vaddr,
580 				    pgoff_t num_prefault,
581 				    pgoff_t fault_page_size)
582 {
583 	struct uvm_object *uobj = ufi->entry->object.uvm_obj;
584 	struct ttm_buffer_object *bo = (struct ttm_buffer_object *)uobj;
585 	struct ttm_bo_device *bdev = bo->bdev;
586 	unsigned long page_offset;
587 	unsigned long page_last;
588 	unsigned long pfn;
589 	struct ttm_tt *ttm = NULL;
590 	struct vm_page *page;
591 	bus_addr_t addr;
592 	paddr_t paddr;
593 	vm_prot_t prot;
594 	int pmap_flags;
595 	int err;
596 	pgoff_t i;
597 	vm_fault_t ret = VM_FAULT_NOPAGE;
598 	unsigned long address = (unsigned long)vaddr;
599 	struct ttm_mem_type_manager *man =
600 		&bdev->man[bo->mem.mem_type];
601 
602 	/*
603 	 * Refuse to fault imported pages. This should be handled
604 	 * (if at all) by redirecting mmap to the exporter.
605 	 */
606 	if (bo->ttm && (bo->ttm->page_flags & TTM_PAGE_FLAG_SG))
607 		return VM_FAULT_SIGBUS;
608 
609 	if (bdev->driver->fault_reserve_notify) {
610 		struct dma_fence *moving = dma_fence_get(bo->moving);
611 
612 		err = bdev->driver->fault_reserve_notify(bo);
613 		switch (err) {
614 		case 0:
615 			break;
616 		case -EBUSY:
617 		case -ERESTARTSYS:
618 			dma_fence_put(moving);
619 			return VM_FAULT_NOPAGE;
620 		default:
621 			dma_fence_put(moving);
622 			return VM_FAULT_SIGBUS;
623 		}
624 
625 		if (bo->moving != moving) {
626 			spin_lock(&ttm_bo_glob.lru_lock);
627 			ttm_bo_move_to_lru_tail(bo, NULL);
628 			spin_unlock(&ttm_bo_glob.lru_lock);
629 		}
630 		dma_fence_put(moving);
631 	}
632 
633 	/*
634 	 * Wait for buffer data in transit, due to a pipelined
635 	 * move.
636 	 */
637 	ret = ttm_bo_vm_fault_idle(bo, ufi);
638 	if (unlikely(ret != 0))
639 		return ret;
640 
641 	err = ttm_mem_io_lock(man, true);
642 	if (unlikely(err != 0))
643 		return VM_FAULT_NOPAGE;
644 	err = ttm_mem_io_reserve_vm(bo);
645 	if (unlikely(err != 0)) {
646 		ret = VM_FAULT_SIGBUS;
647 		goto out_io_unlock;
648 	}
649 
650 	page_offset = ((address - ufi->entry->start) >> PAGE_SHIFT) +
651 	    drm_vma_node_start(&bo->base.vma_node) - (ufi->entry->offset >> PAGE_SHIFT);
652 	page_last = ((ufi->entry->end - ufi->entry->start) >> PAGE_SHIFT) +
653 	    drm_vma_node_start(&bo->base.vma_node) - (ufi->entry->offset >> PAGE_SHIFT);
654 
655 	if (unlikely(page_offset >= bo->num_pages)) {
656 		ret = VM_FAULT_SIGBUS;
657 		goto out_io_unlock;
658 	}
659 
660 	prot = ufi->entry->protection;
661 	pmap_flags = ttm_io_prot(bo->mem.placement, 0);
662 	if (!bo->mem.bus.is_iomem) {
663 		struct ttm_operation_ctx ctx = {
664 			.interruptible = false,
665 			.no_wait_gpu = false,
666 			.flags = TTM_OPT_FLAG_FORCE_ALLOC
667 
668 		};
669 
670 		ttm = bo->ttm;
671 		if (ttm_tt_populate(ttm, &ctx)) {
672 			ret = VM_FAULT_OOM;
673 			goto out_io_unlock;
674 		}
675 	}
676 
677 #ifdef __linux__
678 	/* We don't prefault on huge faults. Yet. */
679 	if (IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE) && fault_page_size != 1) {
680 		ret = ttm_bo_vm_insert_huge(vmf, bo, page_offset,
681 					    fault_page_size, prot);
682 		goto out_io_unlock;
683 	}
684 #endif
685 
686 	/*
687 	 * Speculatively prefault a number of pages. Only error on
688 	 * first page.
689 	 */
690 	for (i = 0; i < num_prefault; ++i) {
691 		if (bo->mem.bus.is_iomem) {
692 			pfn = ttm_bo_io_mem_pfn(bo, page_offset);
693 			addr = pfn << PAGE_SHIFT;
694 			paddr = bus_space_mmap(bdev->memt, addr, 0, prot, 0);
695 		} else {
696 			page = ttm->pages[page_offset];
697 			if (unlikely(!page && i == 0)) {
698 				ret = VM_FAULT_OOM;
699 				goto out_io_unlock;
700 			} else if (unlikely(!page)) {
701 				break;
702 			}
703 			paddr = VM_PAGE_TO_PHYS(page);
704 		}
705 
706 		err = pmap_enter(ufi->orig_map->pmap, address,
707 		    paddr | pmap_flags, prot, PMAP_CANFAIL | prot);
708 
709 		/* Never error on prefaulted PTEs */
710 		if (unlikely(err)) {
711 			ret = VM_FAULT_OOM;
712 			if (i == 0)
713 				goto out_io_unlock;
714 			else
715 				break;
716 		}
717 
718 		address += PAGE_SIZE;
719 		if (unlikely(++page_offset >= page_last))
720 			break;
721 	}
722 	pmap_update(ufi->orig_map->pmap);
723 	ret = VM_FAULT_NOPAGE;
724 out_io_unlock:
725 	ttm_mem_io_unlock(man);
726 	return ret;
727 }
728 EXPORT_SYMBOL(ttm_bo_vm_fault_reserved);
729 
730 int
731 ttm_bo_vm_fault(struct uvm_faultinfo *ufi, vaddr_t vaddr, vm_page_t *pps,
732     int npages, int centeridx, vm_fault_t fault_type,
733     vm_prot_t access_type, int flags)
734 {
735 	struct uvm_object *uobj = ufi->entry->object.uvm_obj;
736 	struct ttm_buffer_object *bo = (struct ttm_buffer_object *)uobj;
737 	vm_fault_t ret;
738 
739 	ret = ttm_bo_vm_reserve(bo);
740 	if (ret) {
741 		switch (ret) {
742 		case VM_FAULT_NOPAGE:
743 			ret = VM_PAGER_OK;
744 			break;
745 		case VM_FAULT_RETRY:
746 			ret = VM_PAGER_REFAULT;
747 			break;
748 		default:
749 			ret = VM_PAGER_BAD;
750 			break;
751 		}
752 
753 		uvmfault_unlockall(ufi, NULL, NULL);
754 		return ret;
755 	}
756 
757 	ret = ttm_bo_vm_fault_reserved(ufi, vaddr, TTM_BO_VM_NUM_PREFAULT, 1);
758 	switch (ret) {
759 	case VM_FAULT_NOPAGE:
760 		ret = VM_PAGER_OK;
761 		break;
762 	case VM_FAULT_RETRY:
763 		ret = VM_PAGER_REFAULT;
764 		break;
765 	default:
766 		ret = VM_PAGER_BAD;
767 		break;
768 	}
769 
770 	dma_resv_unlock(bo->base.resv);
771 
772 	uvmfault_unlockall(ufi, NULL, NULL);
773 	return ret;
774 }
775 EXPORT_SYMBOL(ttm_bo_vm_fault);
776 
777 #endif /* !__linux__ */
778 
779 #ifdef notyet
780 void ttm_bo_vm_open(struct vm_area_struct *vma)
781 {
782 	struct ttm_buffer_object *bo = vma->vm_private_data;
783 
784 	WARN_ON(bo->bdev->dev_mapping != vma->vm_file->f_mapping);
785 
786 	ttm_bo_get(bo);
787 }
788 EXPORT_SYMBOL(ttm_bo_vm_open);
789 
790 void ttm_bo_vm_close(struct vm_area_struct *vma)
791 {
792 	struct ttm_buffer_object *bo = vma->vm_private_data;
793 
794 	ttm_bo_put(bo);
795 	vma->vm_private_data = NULL;
796 }
797 EXPORT_SYMBOL(ttm_bo_vm_close);
798 
799 static int ttm_bo_vm_access_kmap(struct ttm_buffer_object *bo,
800 				 unsigned long offset,
801 				 uint8_t *buf, int len, int write)
802 {
803 	unsigned long page = offset >> PAGE_SHIFT;
804 	unsigned long bytes_left = len;
805 	int ret;
806 
807 	/* Copy a page at a time, that way no extra virtual address
808 	 * mapping is needed
809 	 */
810 	offset -= page << PAGE_SHIFT;
811 	do {
812 		unsigned long bytes = min(bytes_left, PAGE_SIZE - offset);
813 		struct ttm_bo_kmap_obj map;
814 		void *ptr;
815 		bool is_iomem;
816 
817 		ret = ttm_bo_kmap(bo, page, 1, &map);
818 		if (ret)
819 			return ret;
820 
821 		ptr = (uint8_t *)ttm_kmap_obj_virtual(&map, &is_iomem) + offset;
822 		WARN_ON_ONCE(is_iomem);
823 		if (write)
824 			memcpy(ptr, buf, bytes);
825 		else
826 			memcpy(buf, ptr, bytes);
827 		ttm_bo_kunmap(&map);
828 
829 		page++;
830 		buf += bytes;
831 		bytes_left -= bytes;
832 		offset = 0;
833 	} while (bytes_left);
834 
835 	return len;
836 }
837 
838 int ttm_bo_vm_access(struct vm_area_struct *vma, unsigned long addr,
839 		     void *buf, int len, int write)
840 {
841 	struct ttm_buffer_object *bo = vma->vm_private_data;
842 	unsigned long offset = (addr) - vma->vm_start +
843 		((vma->vm_pgoff - drm_vma_node_start(&bo->base.vma_node))
844 		 << PAGE_SHIFT);
845 	int ret;
846 
847 	if (len < 1 || (offset + len) >> PAGE_SHIFT > bo->num_pages)
848 		return -EIO;
849 
850 	ret = ttm_bo_reserve(bo, true, false, NULL);
851 	if (ret)
852 		return ret;
853 
854 	switch (bo->mem.mem_type) {
855 	case TTM_PL_SYSTEM:
856 		if (unlikely(bo->ttm->page_flags & TTM_PAGE_FLAG_SWAPPED)) {
857 			ret = ttm_tt_swapin(bo->ttm);
858 			if (unlikely(ret != 0))
859 				return ret;
860 		}
861 		/* fall through */
862 	case TTM_PL_TT:
863 		ret = ttm_bo_vm_access_kmap(bo, offset, buf, len, write);
864 		break;
865 	default:
866 		if (bo->bdev->driver->access_memory)
867 			ret = bo->bdev->driver->access_memory(
868 				bo, offset, buf, len, write);
869 		else
870 			ret = -EIO;
871 	}
872 
873 	ttm_bo_unreserve(bo);
874 
875 	return ret;
876 }
877 EXPORT_SYMBOL(ttm_bo_vm_access);
878 
879 static const struct vm_operations_struct ttm_bo_vm_ops = {
880 	.fault = ttm_bo_vm_fault,
881 	.open = ttm_bo_vm_open,
882 	.close = ttm_bo_vm_close,
883 	.access = ttm_bo_vm_access,
884 };
885 #endif
886 
887 void
888 ttm_bo_vm_reference(struct uvm_object *uobj)
889 {
890 	struct ttm_buffer_object *bo =
891 	    (struct ttm_buffer_object *)uobj;
892 
893 	ttm_bo_get(bo);
894 	uobj->uo_refs++;
895 }
896 
897 void
898 ttm_bo_vm_detach(struct uvm_object *uobj)
899 {
900 	struct ttm_buffer_object *bo = (struct ttm_buffer_object *)uobj;
901 
902 	uobj->uo_refs--;
903 	ttm_bo_put(bo);
904 }
905 
906 const struct uvm_pagerops ttm_bo_vm_ops = {
907 	.pgo_fault = ttm_bo_vm_fault,
908 	.pgo_reference = ttm_bo_vm_reference,
909 	.pgo_detach = ttm_bo_vm_detach
910 };
911 
912 static struct ttm_buffer_object *ttm_bo_vm_lookup(struct ttm_bo_device *bdev,
913 						  unsigned long offset,
914 						  unsigned long pages)
915 {
916 	struct drm_vma_offset_node *node;
917 	struct ttm_buffer_object *bo = NULL;
918 
919 	drm_vma_offset_lock_lookup(bdev->vma_manager);
920 
921 	node = drm_vma_offset_lookup_locked(bdev->vma_manager, offset, pages);
922 	if (likely(node)) {
923 		bo = container_of(node, struct ttm_buffer_object,
924 				  base.vma_node);
925 		bo = ttm_bo_get_unless_zero(bo);
926 	}
927 
928 	drm_vma_offset_unlock_lookup(bdev->vma_manager);
929 
930 	if (!bo)
931 		pr_err("Could not find buffer object to map\n");
932 
933 	return bo;
934 }
935 
936 #ifdef notyet
937 static void ttm_bo_mmap_vma_setup(struct ttm_buffer_object *bo, struct vm_area_struct *vma)
938 {
939 	vma->vm_ops = &ttm_bo_vm_ops;
940 
941 	/*
942 	 * Note: We're transferring the bo reference to
943 	 * vma->vm_private_data here.
944 	 */
945 
946 	vma->vm_private_data = bo;
947 
948 	/*
949 	 * We'd like to use VM_PFNMAP on shared mappings, where
950 	 * (vma->vm_flags & VM_SHARED) != 0, for performance reasons,
951 	 * but for some reason VM_PFNMAP + x86 PAT + write-combine is very
952 	 * bad for performance. Until that has been sorted out, use
953 	 * VM_MIXEDMAP on all mappings. See freedesktop.org bug #75719
954 	 */
955 	vma->vm_flags |= VM_MIXEDMAP;
956 	vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
957 }
958 #endif
959 
960 #ifdef __linux__
961 int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
962 		struct ttm_bo_device *bdev)
963 {
964 	struct ttm_bo_driver *driver;
965 	struct ttm_buffer_object *bo;
966 	int ret;
967 
968 	if (unlikely(vma->vm_pgoff < DRM_FILE_PAGE_OFFSET_START))
969 		return -EINVAL;
970 
971 	bo = ttm_bo_vm_lookup(bdev, vma->vm_pgoff, vma_pages(vma));
972 	if (unlikely(!bo))
973 		return -EINVAL;
974 
975 	driver = bo->bdev->driver;
976 	if (unlikely(!driver->verify_access)) {
977 		ret = -EPERM;
978 		goto out_unref;
979 	}
980 	ret = driver->verify_access(bo, filp);
981 	if (unlikely(ret != 0))
982 		goto out_unref;
983 
984 	ttm_bo_mmap_vma_setup(bo, vma);
985 	return 0;
986 out_unref:
987 	ttm_bo_put(bo);
988 	return ret;
989 }
990 EXPORT_SYMBOL(ttm_bo_mmap);
991 #else
992 struct uvm_object *
993 ttm_bo_mmap(struct file *filp, voff_t off, vsize_t size,
994 	    struct ttm_bo_device *bdev)
995 {
996 	struct ttm_bo_driver *driver;
997 	struct ttm_buffer_object *bo;
998 	int ret;
999 
1000 	bo = ttm_bo_vm_lookup(bdev, off >> PAGE_SHIFT, size >> PAGE_SHIFT);
1001 	if (unlikely(!bo))
1002 		return NULL;
1003 
1004 	driver = bo->bdev->driver;
1005 	if (unlikely(!driver->verify_access)) {
1006 		ret = -EPERM;
1007 		goto out_unref;
1008 	}
1009 	ret = driver->verify_access(bo, filp);
1010 	if (unlikely(ret != 0))
1011 		goto out_unref;
1012 
1013 	bo->base.uobj.pgops = &ttm_bo_vm_ops;
1014 	bo->base.uobj.uo_refs++;
1015 	return &bo->base.uobj;
1016 out_unref:
1017 	ttm_bo_put(bo);
1018 	return NULL;
1019 }
1020 #endif
1021 
1022 #ifdef notyet
1023 int ttm_bo_mmap_obj(struct vm_area_struct *vma, struct ttm_buffer_object *bo)
1024 {
1025 	ttm_bo_get(bo);
1026 	ttm_bo_mmap_vma_setup(bo, vma);
1027 	return 0;
1028 }
1029 EXPORT_SYMBOL(ttm_bo_mmap_obj);
1030 #endif
1031