1 /*
2  * Copyright 2009 Jerome Glisse.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sub license, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
20  *
21  * The above copyright notice and this permission notice (including the
22  * next paragraph) shall be included in all copies or substantial portions
23  * of the Software.
24  *
25  */
26 /*
27  * Authors:
28  *    Jerome Glisse <glisse@freedesktop.org>
29  *    Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
30  *    Dave Airlie
31  */
32 #include <linux/list.h>
33 #include <linux/slab.h>
34 #include <linux/dma-buf.h>
35 
36 #include <drm/amdgpu_drm.h>
37 #include <drm/drm_cache.h>
38 #include "amdgpu.h"
39 #include "amdgpu_trace.h"
40 #include "amdgpu_amdkfd.h"
41 
42 /**
43  * DOC: amdgpu_object
44  *
45  * This defines the interfaces to operate on an &amdgpu_bo buffer object which
46  * represents memory used by driver (VRAM, system memory, etc.). The driver
47  * provides DRM/GEM APIs to userspace. DRM/GEM APIs then use these interfaces
48  * to create/destroy/set buffer object which are then managed by the kernel TTM
49  * memory manager.
50  * The interfaces are also used internally by kernel clients, including gfx,
51  * uvd, etc. for kernel managed allocations used by the GPU.
52  *
53  */
54 
55 /**
56  * amdgpu_bo_subtract_pin_size - Remove BO from pin_size accounting
57  *
58  * @bo: &amdgpu_bo buffer object
59  *
60  * This function is called when a BO stops being pinned, and updates the
61  * &amdgpu_device pin_size values accordingly.
62  */
63 static void amdgpu_bo_subtract_pin_size(struct amdgpu_bo *bo)
64 {
65 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
66 
67 	if (bo->tbo.mem.mem_type == TTM_PL_VRAM) {
68 		atomic64_sub(amdgpu_bo_size(bo), &adev->vram_pin_size);
69 		atomic64_sub(amdgpu_vram_mgr_bo_visible_size(bo),
70 			     &adev->visible_pin_size);
71 	} else if (bo->tbo.mem.mem_type == TTM_PL_TT) {
72 		atomic64_sub(amdgpu_bo_size(bo), &adev->gart_pin_size);
73 	}
74 }
75 
76 static void amdgpu_bo_destroy(struct ttm_buffer_object *tbo)
77 {
78 	struct amdgpu_device *adev = amdgpu_ttm_adev(tbo->bdev);
79 	struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
80 
81 	if (bo->tbo.pin_count > 0)
82 		amdgpu_bo_subtract_pin_size(bo);
83 
84 	amdgpu_bo_kunmap(bo);
85 
86 	if (bo->tbo.base.import_attach)
87 		drm_prime_gem_destroy(&bo->tbo.base, bo->tbo.sg);
88 	drm_gem_object_release(&bo->tbo.base);
89 	/* in case amdgpu_device_recover_vram got NULL of bo->parent */
90 	if (!list_empty(&bo->shadow_list)) {
91 		mutex_lock(&adev->shadow_list_lock);
92 		list_del_init(&bo->shadow_list);
93 		mutex_unlock(&adev->shadow_list_lock);
94 	}
95 	amdgpu_bo_unref(&bo->parent);
96 
97 	kfree(bo->metadata);
98 	kfree(bo);
99 }
100 
101 /**
102  * amdgpu_bo_is_amdgpu_bo - check if the buffer object is an &amdgpu_bo
103  * @bo: buffer object to be checked
104  *
105  * Uses destroy function associated with the object to determine if this is
106  * an &amdgpu_bo.
107  *
108  * Returns:
109  * true if the object belongs to &amdgpu_bo, false if not.
110  */
111 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo)
112 {
113 	if (bo->destroy == &amdgpu_bo_destroy)
114 		return true;
115 	return false;
116 }
117 
118 /**
119  * amdgpu_bo_placement_from_domain - set buffer's placement
120  * @abo: &amdgpu_bo buffer object whose placement is to be set
121  * @domain: requested domain
122  *
123  * Sets buffer's placement according to requested domain and the buffer's
124  * flags.
125  */
126 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain)
127 {
128 	struct amdgpu_device *adev = amdgpu_ttm_adev(abo->tbo.bdev);
129 	struct ttm_placement *placement = &abo->placement;
130 	struct ttm_place *places = abo->placements;
131 	u64 flags = abo->flags;
132 	u32 c = 0;
133 
134 	if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
135 		unsigned visible_pfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
136 
137 		places[c].fpfn = 0;
138 		places[c].lpfn = 0;
139 		places[c].mem_type = TTM_PL_VRAM;
140 		places[c].flags = 0;
141 
142 		if (flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
143 			places[c].lpfn = visible_pfn;
144 		else
145 			places[c].flags |= TTM_PL_FLAG_TOPDOWN;
146 
147 		if (flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS)
148 			places[c].flags |= TTM_PL_FLAG_CONTIGUOUS;
149 		c++;
150 	}
151 
152 	if (domain & AMDGPU_GEM_DOMAIN_GTT) {
153 		places[c].fpfn = 0;
154 		places[c].lpfn = 0;
155 		places[c].mem_type = TTM_PL_TT;
156 		places[c].flags = 0;
157 		c++;
158 	}
159 
160 	if (domain & AMDGPU_GEM_DOMAIN_CPU) {
161 		places[c].fpfn = 0;
162 		places[c].lpfn = 0;
163 		places[c].mem_type = TTM_PL_SYSTEM;
164 		places[c].flags = 0;
165 		c++;
166 	}
167 
168 	if (domain & AMDGPU_GEM_DOMAIN_GDS) {
169 		places[c].fpfn = 0;
170 		places[c].lpfn = 0;
171 		places[c].mem_type = AMDGPU_PL_GDS;
172 		places[c].flags = 0;
173 		c++;
174 	}
175 
176 	if (domain & AMDGPU_GEM_DOMAIN_GWS) {
177 		places[c].fpfn = 0;
178 		places[c].lpfn = 0;
179 		places[c].mem_type = AMDGPU_PL_GWS;
180 		places[c].flags = 0;
181 		c++;
182 	}
183 
184 	if (domain & AMDGPU_GEM_DOMAIN_OA) {
185 		places[c].fpfn = 0;
186 		places[c].lpfn = 0;
187 		places[c].mem_type = AMDGPU_PL_OA;
188 		places[c].flags = 0;
189 		c++;
190 	}
191 
192 	if (!c) {
193 		places[c].fpfn = 0;
194 		places[c].lpfn = 0;
195 		places[c].mem_type = TTM_PL_SYSTEM;
196 		places[c].flags = 0;
197 		c++;
198 	}
199 
200 	BUG_ON(c >= AMDGPU_BO_MAX_PLACEMENTS);
201 
202 	placement->num_placement = c;
203 	placement->placement = places;
204 
205 	placement->num_busy_placement = c;
206 	placement->busy_placement = places;
207 }
208 
209 /**
210  * amdgpu_bo_create_reserved - create reserved BO for kernel use
211  *
212  * @adev: amdgpu device object
213  * @size: size for the new BO
214  * @align: alignment for the new BO
215  * @domain: where to place it
216  * @bo_ptr: used to initialize BOs in structures
217  * @gpu_addr: GPU addr of the pinned BO
218  * @cpu_addr: optional CPU address mapping
219  *
220  * Allocates and pins a BO for kernel internal use, and returns it still
221  * reserved.
222  *
223  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
224  *
225  * Returns:
226  * 0 on success, negative error code otherwise.
227  */
228 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
229 			      unsigned long size, int align,
230 			      u32 domain, struct amdgpu_bo **bo_ptr,
231 			      u64 *gpu_addr, void **cpu_addr)
232 {
233 	struct amdgpu_bo_param bp;
234 	bool free = false;
235 	int r;
236 
237 	if (!size) {
238 		amdgpu_bo_unref(bo_ptr);
239 		return 0;
240 	}
241 
242 	memset(&bp, 0, sizeof(bp));
243 	bp.size = size;
244 	bp.byte_align = align;
245 	bp.domain = domain;
246 	bp.flags = cpu_addr ? AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED
247 		: AMDGPU_GEM_CREATE_NO_CPU_ACCESS;
248 	bp.flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
249 	bp.type = ttm_bo_type_kernel;
250 	bp.resv = NULL;
251 
252 	if (!*bo_ptr) {
253 		r = amdgpu_bo_create(adev, &bp, bo_ptr);
254 		if (r) {
255 			dev_err(adev->dev, "(%d) failed to allocate kernel bo\n",
256 				r);
257 			return r;
258 		}
259 		free = true;
260 	}
261 
262 	r = amdgpu_bo_reserve(*bo_ptr, false);
263 	if (r) {
264 		dev_err(adev->dev, "(%d) failed to reserve kernel bo\n", r);
265 		goto error_free;
266 	}
267 
268 	r = amdgpu_bo_pin(*bo_ptr, domain);
269 	if (r) {
270 		dev_err(adev->dev, "(%d) kernel bo pin failed\n", r);
271 		goto error_unreserve;
272 	}
273 
274 	r = amdgpu_ttm_alloc_gart(&(*bo_ptr)->tbo);
275 	if (r) {
276 		dev_err(adev->dev, "%p bind failed\n", *bo_ptr);
277 		goto error_unpin;
278 	}
279 
280 	if (gpu_addr)
281 		*gpu_addr = amdgpu_bo_gpu_offset(*bo_ptr);
282 
283 	if (cpu_addr) {
284 		r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
285 		if (r) {
286 			dev_err(adev->dev, "(%d) kernel bo map failed\n", r);
287 			goto error_unpin;
288 		}
289 	}
290 
291 	return 0;
292 
293 error_unpin:
294 	amdgpu_bo_unpin(*bo_ptr);
295 error_unreserve:
296 	amdgpu_bo_unreserve(*bo_ptr);
297 
298 error_free:
299 	if (free)
300 		amdgpu_bo_unref(bo_ptr);
301 
302 	return r;
303 }
304 
305 /**
306  * amdgpu_bo_create_kernel - create BO for kernel use
307  *
308  * @adev: amdgpu device object
309  * @size: size for the new BO
310  * @align: alignment for the new BO
311  * @domain: where to place it
312  * @bo_ptr:  used to initialize BOs in structures
313  * @gpu_addr: GPU addr of the pinned BO
314  * @cpu_addr: optional CPU address mapping
315  *
316  * Allocates and pins a BO for kernel internal use.
317  *
318  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
319  *
320  * Returns:
321  * 0 on success, negative error code otherwise.
322  */
323 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
324 			    unsigned long size, int align,
325 			    u32 domain, struct amdgpu_bo **bo_ptr,
326 			    u64 *gpu_addr, void **cpu_addr)
327 {
328 	int r;
329 
330 	r = amdgpu_bo_create_reserved(adev, size, align, domain, bo_ptr,
331 				      gpu_addr, cpu_addr);
332 
333 	if (r)
334 		return r;
335 
336 	if (*bo_ptr)
337 		amdgpu_bo_unreserve(*bo_ptr);
338 
339 	return 0;
340 }
341 
342 /**
343  * amdgpu_bo_create_kernel_at - create BO for kernel use at specific location
344  *
345  * @adev: amdgpu device object
346  * @offset: offset of the BO
347  * @size: size of the BO
348  * @domain: where to place it
349  * @bo_ptr:  used to initialize BOs in structures
350  * @cpu_addr: optional CPU address mapping
351  *
352  * Creates a kernel BO at a specific offset in the address space of the domain.
353  *
354  * Returns:
355  * 0 on success, negative error code otherwise.
356  */
357 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
358 			       uint64_t offset, uint64_t size, uint32_t domain,
359 			       struct amdgpu_bo **bo_ptr, void **cpu_addr)
360 {
361 	struct ttm_operation_ctx ctx = { false, false };
362 	unsigned int i;
363 	int r;
364 
365 	offset &= PAGE_MASK;
366 	size = ALIGN(size, PAGE_SIZE);
367 
368 	r = amdgpu_bo_create_reserved(adev, size, PAGE_SIZE, domain, bo_ptr,
369 				      NULL, cpu_addr);
370 	if (r)
371 		return r;
372 
373 	if ((*bo_ptr) == NULL)
374 		return 0;
375 
376 	/*
377 	 * Remove the original mem node and create a new one at the request
378 	 * position.
379 	 */
380 	if (cpu_addr)
381 		amdgpu_bo_kunmap(*bo_ptr);
382 
383 	ttm_resource_free(&(*bo_ptr)->tbo, &(*bo_ptr)->tbo.mem);
384 
385 	for (i = 0; i < (*bo_ptr)->placement.num_placement; ++i) {
386 		(*bo_ptr)->placements[i].fpfn = offset >> PAGE_SHIFT;
387 		(*bo_ptr)->placements[i].lpfn = (offset + size) >> PAGE_SHIFT;
388 	}
389 	r = ttm_bo_mem_space(&(*bo_ptr)->tbo, &(*bo_ptr)->placement,
390 			     &(*bo_ptr)->tbo.mem, &ctx);
391 	if (r)
392 		goto error;
393 
394 	if (cpu_addr) {
395 		r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
396 		if (r)
397 			goto error;
398 	}
399 
400 	amdgpu_bo_unreserve(*bo_ptr);
401 	return 0;
402 
403 error:
404 	amdgpu_bo_unreserve(*bo_ptr);
405 	amdgpu_bo_unref(bo_ptr);
406 	return r;
407 }
408 
409 /**
410  * amdgpu_bo_free_kernel - free BO for kernel use
411  *
412  * @bo: amdgpu BO to free
413  * @gpu_addr: pointer to where the BO's GPU memory space address was stored
414  * @cpu_addr: pointer to where the BO's CPU memory space address was stored
415  *
416  * unmaps and unpin a BO for kernel internal use.
417  */
418 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
419 			   void **cpu_addr)
420 {
421 	if (*bo == NULL)
422 		return;
423 
424 	if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
425 		if (cpu_addr)
426 			amdgpu_bo_kunmap(*bo);
427 
428 		amdgpu_bo_unpin(*bo);
429 		amdgpu_bo_unreserve(*bo);
430 	}
431 	amdgpu_bo_unref(bo);
432 
433 	if (gpu_addr)
434 		*gpu_addr = 0;
435 
436 	if (cpu_addr)
437 		*cpu_addr = NULL;
438 }
439 
440 /* Validate bo size is bit bigger then the request domain */
441 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
442 					  unsigned long size, u32 domain)
443 {
444 	struct ttm_resource_manager *man = NULL;
445 
446 	/*
447 	 * If GTT is part of requested domains the check must succeed to
448 	 * allow fall back to GTT
449 	 */
450 	if (domain & AMDGPU_GEM_DOMAIN_GTT) {
451 		man = ttm_manager_type(&adev->mman.bdev, TTM_PL_TT);
452 
453 		if (size < (man->size << PAGE_SHIFT))
454 			return true;
455 		else
456 			goto fail;
457 	}
458 
459 	if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
460 		man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
461 
462 		if (size < (man->size << PAGE_SHIFT))
463 			return true;
464 		else
465 			goto fail;
466 	}
467 
468 
469 	/* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
470 	return true;
471 
472 fail:
473 	DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
474 		  man->size << PAGE_SHIFT);
475 	return false;
476 }
477 
478 bool amdgpu_bo_support_uswc(u64 bo_flags)
479 {
480 
481 #ifdef CONFIG_X86_32
482 	/* XXX: Write-combined CPU mappings of GTT seem broken on 32-bit
483 	 * See https://bugs.freedesktop.org/show_bug.cgi?id=84627
484 	 */
485 	return false;
486 #elif defined(CONFIG_X86) && !defined(CONFIG_X86_PAT)
487 	/* Don't try to enable write-combining when it can't work, or things
488 	 * may be slow
489 	 * See https://bugs.freedesktop.org/show_bug.cgi?id=88758
490 	 */
491 
492 #ifndef CONFIG_COMPILE_TEST
493 #warning Please enable CONFIG_MTRR and CONFIG_X86_PAT for better performance \
494 	 thanks to write-combining
495 #endif
496 
497 	if (bo_flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
498 		DRM_INFO_ONCE("Please enable CONFIG_MTRR and CONFIG_X86_PAT for "
499 			      "better performance thanks to write-combining\n");
500 	return false;
501 #else
502 	/* For architectures that don't support WC memory,
503 	 * mask out the WC flag from the BO
504 	 */
505 	if (!drm_arch_can_wc_memory())
506 		return false;
507 
508 	return true;
509 #endif
510 }
511 
512 static int amdgpu_bo_do_create(struct amdgpu_device *adev,
513 			       struct amdgpu_bo_param *bp,
514 			       struct amdgpu_bo **bo_ptr)
515 {
516 	struct ttm_operation_ctx ctx = {
517 		.interruptible = (bp->type != ttm_bo_type_kernel),
518 		.no_wait_gpu = bp->no_wait_gpu,
519 		/* We opt to avoid OOM on system pages allocations */
520 		.gfp_retry_mayfail = true,
521 		.allow_res_evict = bp->type != ttm_bo_type_kernel,
522 		.resv = bp->resv
523 	};
524 	struct amdgpu_bo *bo;
525 	unsigned long page_align, size = bp->size;
526 	size_t acc_size;
527 	int r;
528 
529 	/* Note that GDS/GWS/OA allocates 1 page per byte/resource. */
530 	if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA)) {
531 		/* GWS and OA don't need any alignment. */
532 		page_align = bp->byte_align;
533 		size <<= PAGE_SHIFT;
534 	} else if (bp->domain & AMDGPU_GEM_DOMAIN_GDS) {
535 		/* Both size and alignment must be a multiple of 4. */
536 		page_align = ALIGN(bp->byte_align, 4);
537 		size = ALIGN(size, 4) << PAGE_SHIFT;
538 	} else {
539 		/* Memory should be aligned at least to a page size. */
540 		page_align = ALIGN(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
541 		size = ALIGN(size, PAGE_SIZE);
542 	}
543 
544 	if (!amdgpu_bo_validate_size(adev, size, bp->domain))
545 		return -ENOMEM;
546 
547 	*bo_ptr = NULL;
548 
549 	acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
550 				       sizeof(struct amdgpu_bo));
551 
552 	bo = kzalloc(sizeof(struct amdgpu_bo), GFP_KERNEL);
553 	if (bo == NULL)
554 		return -ENOMEM;
555 	drm_gem_private_object_init(adev_to_drm(adev), &bo->tbo.base, size);
556 	INIT_LIST_HEAD(&bo->shadow_list);
557 	bo->vm_bo = NULL;
558 	bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
559 		bp->domain;
560 	bo->allowed_domains = bo->preferred_domains;
561 	if (bp->type != ttm_bo_type_kernel &&
562 	    bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
563 		bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
564 
565 	bo->flags = bp->flags;
566 
567 	if (!amdgpu_bo_support_uswc(bo->flags))
568 		bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
569 
570 	bo->tbo.bdev = &adev->mman.bdev;
571 	if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA |
572 			  AMDGPU_GEM_DOMAIN_GDS))
573 		amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
574 	else
575 		amdgpu_bo_placement_from_domain(bo, bp->domain);
576 	if (bp->type == ttm_bo_type_kernel)
577 		bo->tbo.priority = 1;
578 
579 	r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
580 				 &bo->placement, page_align, &ctx, acc_size,
581 				 NULL, bp->resv, &amdgpu_bo_destroy);
582 	if (unlikely(r != 0))
583 		return r;
584 
585 	if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
586 	    bo->tbo.mem.mem_type == TTM_PL_VRAM &&
587 	    bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
588 		amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
589 					     ctx.bytes_moved);
590 	else
591 		amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
592 
593 	if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
594 	    bo->tbo.mem.mem_type == TTM_PL_VRAM) {
595 		struct dma_fence *fence;
596 
597 		r = amdgpu_fill_buffer(bo, 0, bo->tbo.base.resv, &fence);
598 		if (unlikely(r))
599 			goto fail_unreserve;
600 
601 		amdgpu_bo_fence(bo, fence, false);
602 		dma_fence_put(bo->tbo.moving);
603 		bo->tbo.moving = dma_fence_get(fence);
604 		dma_fence_put(fence);
605 	}
606 	if (!bp->resv)
607 		amdgpu_bo_unreserve(bo);
608 	*bo_ptr = bo;
609 
610 	trace_amdgpu_bo_create(bo);
611 
612 	/* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
613 	if (bp->type == ttm_bo_type_device)
614 		bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
615 
616 	return 0;
617 
618 fail_unreserve:
619 	if (!bp->resv)
620 		dma_resv_unlock(bo->tbo.base.resv);
621 	amdgpu_bo_unref(&bo);
622 	return r;
623 }
624 
625 static int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
626 				   unsigned long size,
627 				   struct amdgpu_bo *bo)
628 {
629 	struct amdgpu_bo_param bp;
630 	int r;
631 
632 	if (bo->shadow)
633 		return 0;
634 
635 	memset(&bp, 0, sizeof(bp));
636 	bp.size = size;
637 	bp.domain = AMDGPU_GEM_DOMAIN_GTT;
638 	bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC |
639 		AMDGPU_GEM_CREATE_SHADOW;
640 	bp.type = ttm_bo_type_kernel;
641 	bp.resv = bo->tbo.base.resv;
642 
643 	r = amdgpu_bo_do_create(adev, &bp, &bo->shadow);
644 	if (!r) {
645 		bo->shadow->parent = amdgpu_bo_ref(bo);
646 		mutex_lock(&adev->shadow_list_lock);
647 		list_add_tail(&bo->shadow->shadow_list, &adev->shadow_list);
648 		mutex_unlock(&adev->shadow_list_lock);
649 	}
650 
651 	return r;
652 }
653 
654 /**
655  * amdgpu_bo_create - create an &amdgpu_bo buffer object
656  * @adev: amdgpu device object
657  * @bp: parameters to be used for the buffer object
658  * @bo_ptr: pointer to the buffer object pointer
659  *
660  * Creates an &amdgpu_bo buffer object; and if requested, also creates a
661  * shadow object.
662  * Shadow object is used to backup the original buffer object, and is always
663  * in GTT.
664  *
665  * Returns:
666  * 0 for success or a negative error code on failure.
667  */
668 int amdgpu_bo_create(struct amdgpu_device *adev,
669 		     struct amdgpu_bo_param *bp,
670 		     struct amdgpu_bo **bo_ptr)
671 {
672 	u64 flags = bp->flags;
673 	int r;
674 
675 	bp->flags = bp->flags & ~AMDGPU_GEM_CREATE_SHADOW;
676 	r = amdgpu_bo_do_create(adev, bp, bo_ptr);
677 	if (r)
678 		return r;
679 
680 	if ((flags & AMDGPU_GEM_CREATE_SHADOW) && !(adev->flags & AMD_IS_APU)) {
681 		if (!bp->resv)
682 			WARN_ON(dma_resv_lock((*bo_ptr)->tbo.base.resv,
683 							NULL));
684 
685 		r = amdgpu_bo_create_shadow(adev, bp->size, *bo_ptr);
686 
687 		if (!bp->resv)
688 			dma_resv_unlock((*bo_ptr)->tbo.base.resv);
689 
690 		if (r)
691 			amdgpu_bo_unref(bo_ptr);
692 	}
693 
694 	return r;
695 }
696 
697 /**
698  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
699  * @bo: pointer to the buffer object
700  *
701  * Sets placement according to domain; and changes placement and caching
702  * policy of the buffer object according to the placement.
703  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
704  * make sure the buffer is resident where it needs to be.
705  *
706  * Returns:
707  * 0 for success or a negative error code on failure.
708  */
709 int amdgpu_bo_validate(struct amdgpu_bo *bo)
710 {
711 	struct ttm_operation_ctx ctx = { false, false };
712 	uint32_t domain;
713 	int r;
714 
715 	if (bo->tbo.pin_count)
716 		return 0;
717 
718 	domain = bo->preferred_domains;
719 
720 retry:
721 	amdgpu_bo_placement_from_domain(bo, domain);
722 	r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
723 	if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
724 		domain = bo->allowed_domains;
725 		goto retry;
726 	}
727 
728 	return r;
729 }
730 
731 /**
732  * amdgpu_bo_restore_shadow - restore an &amdgpu_bo shadow
733  *
734  * @shadow: &amdgpu_bo shadow to be restored
735  * @fence: dma_fence associated with the operation
736  *
737  * Copies a buffer object's shadow content back to the object.
738  * This is used for recovering a buffer from its shadow in case of a gpu
739  * reset where vram context may be lost.
740  *
741  * Returns:
742  * 0 for success or a negative error code on failure.
743  */
744 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow, struct dma_fence **fence)
745 
746 {
747 	struct amdgpu_device *adev = amdgpu_ttm_adev(shadow->tbo.bdev);
748 	struct amdgpu_ring *ring = adev->mman.buffer_funcs_ring;
749 	uint64_t shadow_addr, parent_addr;
750 
751 	shadow_addr = amdgpu_bo_gpu_offset(shadow);
752 	parent_addr = amdgpu_bo_gpu_offset(shadow->parent);
753 
754 	return amdgpu_copy_buffer(ring, shadow_addr, parent_addr,
755 				  amdgpu_bo_size(shadow), NULL, fence,
756 				  true, false, false);
757 }
758 
759 /**
760  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
761  * @bo: &amdgpu_bo buffer object to be mapped
762  * @ptr: kernel virtual address to be returned
763  *
764  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
765  * amdgpu_bo_kptr() to get the kernel virtual address.
766  *
767  * Returns:
768  * 0 for success or a negative error code on failure.
769  */
770 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
771 {
772 	void *kptr;
773 	long r;
774 
775 	if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
776 		return -EPERM;
777 
778 	kptr = amdgpu_bo_kptr(bo);
779 	if (kptr) {
780 		if (ptr)
781 			*ptr = kptr;
782 		return 0;
783 	}
784 
785 	r = dma_resv_wait_timeout_rcu(bo->tbo.base.resv, false, false,
786 						MAX_SCHEDULE_TIMEOUT);
787 	if (r < 0)
788 		return r;
789 
790 	r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.num_pages, &bo->kmap);
791 	if (r)
792 		return r;
793 
794 	if (ptr)
795 		*ptr = amdgpu_bo_kptr(bo);
796 
797 	return 0;
798 }
799 
800 /**
801  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
802  * @bo: &amdgpu_bo buffer object
803  *
804  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
805  *
806  * Returns:
807  * the virtual address of a buffer object area.
808  */
809 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
810 {
811 	bool is_iomem;
812 
813 	return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
814 }
815 
816 /**
817  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
818  * @bo: &amdgpu_bo buffer object to be unmapped
819  *
820  * Unmaps a kernel map set up by amdgpu_bo_kmap().
821  */
822 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
823 {
824 	if (bo->kmap.bo)
825 		ttm_bo_kunmap(&bo->kmap);
826 }
827 
828 /**
829  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
830  * @bo: &amdgpu_bo buffer object
831  *
832  * References the contained &ttm_buffer_object.
833  *
834  * Returns:
835  * a refcounted pointer to the &amdgpu_bo buffer object.
836  */
837 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
838 {
839 	if (bo == NULL)
840 		return NULL;
841 
842 	ttm_bo_get(&bo->tbo);
843 	return bo;
844 }
845 
846 /**
847  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
848  * @bo: &amdgpu_bo buffer object
849  *
850  * Unreferences the contained &ttm_buffer_object and clear the pointer
851  */
852 void amdgpu_bo_unref(struct amdgpu_bo **bo)
853 {
854 	struct ttm_buffer_object *tbo;
855 
856 	if ((*bo) == NULL)
857 		return;
858 
859 	tbo = &((*bo)->tbo);
860 	ttm_bo_put(tbo);
861 	*bo = NULL;
862 }
863 
864 /**
865  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
866  * @bo: &amdgpu_bo buffer object to be pinned
867  * @domain: domain to be pinned to
868  * @min_offset: the start of requested address range
869  * @max_offset: the end of requested address range
870  *
871  * Pins the buffer object according to requested domain and address range. If
872  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
873  * pin_count and pin_size accordingly.
874  *
875  * Pinning means to lock pages in memory along with keeping them at a fixed
876  * offset. It is required when a buffer can not be moved, for example, when
877  * a display buffer is being scanned out.
878  *
879  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
880  * where to pin a buffer if there are specific restrictions on where a buffer
881  * must be located.
882  *
883  * Returns:
884  * 0 for success or a negative error code on failure.
885  */
886 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
887 			     u64 min_offset, u64 max_offset)
888 {
889 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
890 	struct ttm_operation_ctx ctx = { false, false };
891 	int r, i;
892 
893 	if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
894 		return -EPERM;
895 
896 	if (WARN_ON_ONCE(min_offset > max_offset))
897 		return -EINVAL;
898 
899 	/* A shared bo cannot be migrated to VRAM */
900 	if (bo->prime_shared_count || bo->tbo.base.import_attach) {
901 		if (domain & AMDGPU_GEM_DOMAIN_GTT)
902 			domain = AMDGPU_GEM_DOMAIN_GTT;
903 		else
904 			return -EINVAL;
905 	}
906 
907 	/* This assumes only APU display buffers are pinned with (VRAM|GTT).
908 	 * See function amdgpu_display_supported_domains()
909 	 */
910 	domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
911 
912 	if (bo->tbo.pin_count) {
913 		uint32_t mem_type = bo->tbo.mem.mem_type;
914 
915 		if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
916 			return -EINVAL;
917 
918 		ttm_bo_pin(&bo->tbo);
919 
920 		if (max_offset != 0) {
921 			u64 domain_start = amdgpu_ttm_domain_start(adev,
922 								   mem_type);
923 			WARN_ON_ONCE(max_offset <
924 				     (amdgpu_bo_gpu_offset(bo) - domain_start));
925 		}
926 
927 		return 0;
928 	}
929 
930 	if (bo->tbo.base.import_attach)
931 		dma_buf_pin(bo->tbo.base.import_attach);
932 
933 	bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
934 	/* force to pin into visible video ram */
935 	if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
936 		bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
937 	amdgpu_bo_placement_from_domain(bo, domain);
938 	for (i = 0; i < bo->placement.num_placement; i++) {
939 		unsigned fpfn, lpfn;
940 
941 		fpfn = min_offset >> PAGE_SHIFT;
942 		lpfn = max_offset >> PAGE_SHIFT;
943 
944 		if (fpfn > bo->placements[i].fpfn)
945 			bo->placements[i].fpfn = fpfn;
946 		if (!bo->placements[i].lpfn ||
947 		    (lpfn && lpfn < bo->placements[i].lpfn))
948 			bo->placements[i].lpfn = lpfn;
949 	}
950 
951 	r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
952 	if (unlikely(r)) {
953 		dev_err(adev->dev, "%p pin failed\n", bo);
954 		goto error;
955 	}
956 
957 	ttm_bo_pin(&bo->tbo);
958 
959 	domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
960 	if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
961 		atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
962 		atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
963 			     &adev->visible_pin_size);
964 	} else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
965 		atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
966 	}
967 
968 error:
969 	return r;
970 }
971 
972 /**
973  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
974  * @bo: &amdgpu_bo buffer object to be pinned
975  * @domain: domain to be pinned to
976  *
977  * A simple wrapper to amdgpu_bo_pin_restricted().
978  * Provides a simpler API for buffers that do not have any strict restrictions
979  * on where a buffer must be located.
980  *
981  * Returns:
982  * 0 for success or a negative error code on failure.
983  */
984 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
985 {
986 	return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
987 }
988 
989 /**
990  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
991  * @bo: &amdgpu_bo buffer object to be unpinned
992  *
993  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
994  * Changes placement and pin size accordingly.
995  *
996  * Returns:
997  * 0 for success or a negative error code on failure.
998  */
999 void amdgpu_bo_unpin(struct amdgpu_bo *bo)
1000 {
1001 	ttm_bo_unpin(&bo->tbo);
1002 	if (bo->tbo.pin_count)
1003 		return;
1004 
1005 	amdgpu_bo_subtract_pin_size(bo);
1006 
1007 	if (bo->tbo.base.import_attach)
1008 		dma_buf_unpin(bo->tbo.base.import_attach);
1009 }
1010 
1011 /**
1012  * amdgpu_bo_evict_vram - evict VRAM buffers
1013  * @adev: amdgpu device object
1014  *
1015  * Evicts all VRAM buffers on the lru list of the memory type.
1016  * Mainly used for evicting vram at suspend time.
1017  *
1018  * Returns:
1019  * 0 for success or a negative error code on failure.
1020  */
1021 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1022 {
1023 	struct ttm_resource_manager *man;
1024 
1025 	/* late 2.6.33 fix IGP hibernate - we need pm ops to do this correct */
1026 #ifndef CONFIG_HIBERNATION
1027 	if (adev->flags & AMD_IS_APU) {
1028 		/* Useless to evict on IGP chips */
1029 		return 0;
1030 	}
1031 #endif
1032 
1033 	man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
1034 	return ttm_resource_manager_evict_all(&adev->mman.bdev, man);
1035 }
1036 
1037 static const char *amdgpu_vram_names[] = {
1038 	"UNKNOWN",
1039 	"GDDR1",
1040 	"DDR2",
1041 	"GDDR3",
1042 	"GDDR4",
1043 	"GDDR5",
1044 	"HBM",
1045 	"DDR3",
1046 	"DDR4",
1047 	"GDDR6",
1048 	"DDR5"
1049 };
1050 
1051 /**
1052  * amdgpu_bo_init - initialize memory manager
1053  * @adev: amdgpu device object
1054  *
1055  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1056  *
1057  * Returns:
1058  * 0 for success or a negative error code on failure.
1059  */
1060 int amdgpu_bo_init(struct amdgpu_device *adev)
1061 {
1062 	/* reserve PAT memory space to WC for VRAM */
1063 	arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1064 				   adev->gmc.aper_size);
1065 
1066 	/* Add an MTRR for the VRAM */
1067 	adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1068 					      adev->gmc.aper_size);
1069 	DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1070 		 adev->gmc.mc_vram_size >> 20,
1071 		 (unsigned long long)adev->gmc.aper_size >> 20);
1072 	DRM_INFO("RAM width %dbits %s\n",
1073 		 adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1074 	return amdgpu_ttm_init(adev);
1075 }
1076 
1077 /**
1078  * amdgpu_bo_fini - tear down memory manager
1079  * @adev: amdgpu device object
1080  *
1081  * Reverses amdgpu_bo_init() to tear down memory manager.
1082  */
1083 void amdgpu_bo_fini(struct amdgpu_device *adev)
1084 {
1085 	amdgpu_ttm_fini(adev);
1086 	arch_phys_wc_del(adev->gmc.vram_mtrr);
1087 	arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1088 }
1089 
1090 /**
1091  * amdgpu_bo_fbdev_mmap - mmap fbdev memory
1092  * @bo: &amdgpu_bo buffer object
1093  * @vma: vma as input from the fbdev mmap method
1094  *
1095  * Calls ttm_fbdev_mmap() to mmap fbdev memory if it is backed by a bo.
1096  *
1097  * Returns:
1098  * 0 for success or a negative error code on failure.
1099  */
1100 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
1101 			     struct vm_area_struct *vma)
1102 {
1103 	if (vma->vm_pgoff != 0)
1104 		return -EACCES;
1105 
1106 	return ttm_bo_mmap_obj(vma, &bo->tbo);
1107 }
1108 
1109 /**
1110  * amdgpu_bo_set_tiling_flags - set tiling flags
1111  * @bo: &amdgpu_bo buffer object
1112  * @tiling_flags: new flags
1113  *
1114  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1115  * kernel driver to set the tiling flags on a buffer.
1116  *
1117  * Returns:
1118  * 0 for success or a negative error code on failure.
1119  */
1120 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1121 {
1122 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1123 
1124 	if (adev->family <= AMDGPU_FAMILY_CZ &&
1125 	    AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1126 		return -EINVAL;
1127 
1128 	bo->tiling_flags = tiling_flags;
1129 	return 0;
1130 }
1131 
1132 /**
1133  * amdgpu_bo_get_tiling_flags - get tiling flags
1134  * @bo: &amdgpu_bo buffer object
1135  * @tiling_flags: returned flags
1136  *
1137  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1138  * set the tiling flags on a buffer.
1139  */
1140 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1141 {
1142 	dma_resv_assert_held(bo->tbo.base.resv);
1143 
1144 	if (tiling_flags)
1145 		*tiling_flags = bo->tiling_flags;
1146 }
1147 
1148 /**
1149  * amdgpu_bo_set_metadata - set metadata
1150  * @bo: &amdgpu_bo buffer object
1151  * @metadata: new metadata
1152  * @metadata_size: size of the new metadata
1153  * @flags: flags of the new metadata
1154  *
1155  * Sets buffer object's metadata, its size and flags.
1156  * Used via GEM ioctl.
1157  *
1158  * Returns:
1159  * 0 for success or a negative error code on failure.
1160  */
1161 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
1162 			    uint32_t metadata_size, uint64_t flags)
1163 {
1164 	void *buffer;
1165 
1166 	if (!metadata_size) {
1167 		if (bo->metadata_size) {
1168 			kfree(bo->metadata);
1169 			bo->metadata = NULL;
1170 			bo->metadata_size = 0;
1171 		}
1172 		return 0;
1173 	}
1174 
1175 	if (metadata == NULL)
1176 		return -EINVAL;
1177 
1178 	buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1179 	if (buffer == NULL)
1180 		return -ENOMEM;
1181 
1182 	kfree(bo->metadata);
1183 	bo->metadata_flags = flags;
1184 	bo->metadata = buffer;
1185 	bo->metadata_size = metadata_size;
1186 
1187 	return 0;
1188 }
1189 
1190 /**
1191  * amdgpu_bo_get_metadata - get metadata
1192  * @bo: &amdgpu_bo buffer object
1193  * @buffer: returned metadata
1194  * @buffer_size: size of the buffer
1195  * @metadata_size: size of the returned metadata
1196  * @flags: flags of the returned metadata
1197  *
1198  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1199  * less than metadata_size.
1200  * Used via GEM ioctl.
1201  *
1202  * Returns:
1203  * 0 for success or a negative error code on failure.
1204  */
1205 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1206 			   size_t buffer_size, uint32_t *metadata_size,
1207 			   uint64_t *flags)
1208 {
1209 	if (!buffer && !metadata_size)
1210 		return -EINVAL;
1211 
1212 	if (buffer) {
1213 		if (buffer_size < bo->metadata_size)
1214 			return -EINVAL;
1215 
1216 		if (bo->metadata_size)
1217 			memcpy(buffer, bo->metadata, bo->metadata_size);
1218 	}
1219 
1220 	if (metadata_size)
1221 		*metadata_size = bo->metadata_size;
1222 	if (flags)
1223 		*flags = bo->metadata_flags;
1224 
1225 	return 0;
1226 }
1227 
1228 /**
1229  * amdgpu_bo_move_notify - notification about a memory move
1230  * @bo: pointer to a buffer object
1231  * @evict: if this move is evicting the buffer from the graphics address space
1232  * @new_mem: new information of the bufer object
1233  *
1234  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1235  * bookkeeping.
1236  * TTM driver callback which is called when ttm moves a buffer.
1237  */
1238 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1239 			   bool evict,
1240 			   struct ttm_resource *new_mem)
1241 {
1242 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1243 	struct amdgpu_bo *abo;
1244 	struct ttm_resource *old_mem = &bo->mem;
1245 
1246 	if (!amdgpu_bo_is_amdgpu_bo(bo))
1247 		return;
1248 
1249 	abo = ttm_to_amdgpu_bo(bo);
1250 	amdgpu_vm_bo_invalidate(adev, abo, evict);
1251 
1252 	amdgpu_bo_kunmap(abo);
1253 
1254 	if (abo->tbo.base.dma_buf && !abo->tbo.base.import_attach &&
1255 	    bo->mem.mem_type != TTM_PL_SYSTEM)
1256 		dma_buf_move_notify(abo->tbo.base.dma_buf);
1257 
1258 	/* remember the eviction */
1259 	if (evict)
1260 		atomic64_inc(&adev->num_evictions);
1261 
1262 	/* update statistics */
1263 	if (!new_mem)
1264 		return;
1265 
1266 	/* move_notify is called before move happens */
1267 	trace_amdgpu_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1268 }
1269 
1270 /**
1271  * amdgpu_bo_release_notify - notification about a BO being released
1272  * @bo: pointer to a buffer object
1273  *
1274  * Wipes VRAM buffers whose contents should not be leaked before the
1275  * memory is released.
1276  */
1277 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo)
1278 {
1279 	struct dma_fence *fence = NULL;
1280 	struct amdgpu_bo *abo;
1281 	int r;
1282 
1283 	if (!amdgpu_bo_is_amdgpu_bo(bo))
1284 		return;
1285 
1286 	abo = ttm_to_amdgpu_bo(bo);
1287 
1288 	if (abo->kfd_bo)
1289 		amdgpu_amdkfd_unreserve_memory_limit(abo);
1290 
1291 	/* We only remove the fence if the resv has individualized. */
1292 	WARN_ON_ONCE(bo->type == ttm_bo_type_kernel
1293 			&& bo->base.resv != &bo->base._resv);
1294 	if (bo->base.resv == &bo->base._resv)
1295 		amdgpu_amdkfd_remove_fence_on_pt_pd_bos(abo);
1296 
1297 	if (bo->mem.mem_type != TTM_PL_VRAM || !bo->mem.mm_node ||
1298 	    !(abo->flags & AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE))
1299 		return;
1300 
1301 	dma_resv_lock(bo->base.resv, NULL);
1302 
1303 	r = amdgpu_fill_buffer(abo, AMDGPU_POISON, bo->base.resv, &fence);
1304 	if (!WARN_ON(r)) {
1305 		amdgpu_bo_fence(abo, fence, false);
1306 		dma_fence_put(fence);
1307 	}
1308 
1309 	dma_resv_unlock(bo->base.resv);
1310 }
1311 
1312 /**
1313  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1314  * @bo: pointer to a buffer object
1315  *
1316  * Notifies the driver we are taking a fault on this BO and have reserved it,
1317  * also performs bookkeeping.
1318  * TTM driver callback for dealing with vm faults.
1319  *
1320  * Returns:
1321  * 0 for success or a negative error code on failure.
1322  */
1323 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1324 {
1325 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1326 	struct ttm_operation_ctx ctx = { false, false };
1327 	struct amdgpu_bo *abo = ttm_to_amdgpu_bo(bo);
1328 	unsigned long offset, size;
1329 	int r;
1330 
1331 	/* Remember that this BO was accessed by the CPU */
1332 	abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1333 
1334 	if (bo->mem.mem_type != TTM_PL_VRAM)
1335 		return 0;
1336 
1337 	size = bo->mem.num_pages << PAGE_SHIFT;
1338 	offset = bo->mem.start << PAGE_SHIFT;
1339 	if ((offset + size) <= adev->gmc.visible_vram_size)
1340 		return 0;
1341 
1342 	/* Can't move a pinned BO to visible VRAM */
1343 	if (abo->tbo.pin_count > 0)
1344 		return VM_FAULT_SIGBUS;
1345 
1346 	/* hurrah the memory is not visible ! */
1347 	atomic64_inc(&adev->num_vram_cpu_page_faults);
1348 	amdgpu_bo_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1349 					AMDGPU_GEM_DOMAIN_GTT);
1350 
1351 	/* Avoid costly evictions; only set GTT as a busy placement */
1352 	abo->placement.num_busy_placement = 1;
1353 	abo->placement.busy_placement = &abo->placements[1];
1354 
1355 	r = ttm_bo_validate(bo, &abo->placement, &ctx);
1356 	if (unlikely(r == -EBUSY || r == -ERESTARTSYS))
1357 		return VM_FAULT_NOPAGE;
1358 	else if (unlikely(r))
1359 		return VM_FAULT_SIGBUS;
1360 
1361 	offset = bo->mem.start << PAGE_SHIFT;
1362 	/* this should never happen */
1363 	if (bo->mem.mem_type == TTM_PL_VRAM &&
1364 	    (offset + size) > adev->gmc.visible_vram_size)
1365 		return VM_FAULT_SIGBUS;
1366 
1367 	ttm_bo_move_to_lru_tail_unlocked(bo);
1368 	return 0;
1369 }
1370 
1371 /**
1372  * amdgpu_bo_fence - add fence to buffer object
1373  *
1374  * @bo: buffer object in question
1375  * @fence: fence to add
1376  * @shared: true if fence should be added shared
1377  *
1378  */
1379 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1380 		     bool shared)
1381 {
1382 	struct dma_resv *resv = bo->tbo.base.resv;
1383 
1384 	if (shared)
1385 		dma_resv_add_shared_fence(resv, fence);
1386 	else
1387 		dma_resv_add_excl_fence(resv, fence);
1388 }
1389 
1390 /**
1391  * amdgpu_bo_sync_wait_resv - Wait for BO reservation fences
1392  *
1393  * @adev: amdgpu device pointer
1394  * @resv: reservation object to sync to
1395  * @sync_mode: synchronization mode
1396  * @owner: fence owner
1397  * @intr: Whether the wait is interruptible
1398  *
1399  * Extract the fences from the reservation object and waits for them to finish.
1400  *
1401  * Returns:
1402  * 0 on success, errno otherwise.
1403  */
1404 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
1405 			     enum amdgpu_sync_mode sync_mode, void *owner,
1406 			     bool intr)
1407 {
1408 	struct amdgpu_sync sync;
1409 	int r;
1410 
1411 	amdgpu_sync_create(&sync);
1412 	amdgpu_sync_resv(adev, &sync, resv, sync_mode, owner);
1413 	r = amdgpu_sync_wait(&sync, intr);
1414 	amdgpu_sync_free(&sync);
1415 	return r;
1416 }
1417 
1418 /**
1419  * amdgpu_bo_sync_wait - Wrapper for amdgpu_bo_sync_wait_resv
1420  * @bo: buffer object to wait for
1421  * @owner: fence owner
1422  * @intr: Whether the wait is interruptible
1423  *
1424  * Wrapper to wait for fences in a BO.
1425  * Returns:
1426  * 0 on success, errno otherwise.
1427  */
1428 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr)
1429 {
1430 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1431 
1432 	return amdgpu_bo_sync_wait_resv(adev, bo->tbo.base.resv,
1433 					AMDGPU_SYNC_NE_OWNER, owner, intr);
1434 }
1435 
1436 /**
1437  * amdgpu_bo_gpu_offset - return GPU offset of bo
1438  * @bo:	amdgpu object for which we query the offset
1439  *
1440  * Note: object should either be pinned or reserved when calling this
1441  * function, it might be useful to add check for this for debugging.
1442  *
1443  * Returns:
1444  * current GPU offset of the object.
1445  */
1446 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1447 {
1448 	WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_SYSTEM);
1449 	WARN_ON_ONCE(!dma_resv_is_locked(bo->tbo.base.resv) &&
1450 		     !bo->tbo.pin_count && bo->tbo.type != ttm_bo_type_kernel);
1451 	WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1452 	WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1453 		     !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1454 
1455 	return amdgpu_bo_gpu_offset_no_check(bo);
1456 }
1457 
1458 /**
1459  * amdgpu_bo_gpu_offset_no_check - return GPU offset of bo
1460  * @bo:	amdgpu object for which we query the offset
1461  *
1462  * Returns:
1463  * current GPU offset of the object without raising warnings.
1464  */
1465 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo)
1466 {
1467 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1468 	uint64_t offset;
1469 
1470 	offset = (bo->tbo.mem.start << PAGE_SHIFT) +
1471 		 amdgpu_ttm_domain_start(adev, bo->tbo.mem.mem_type);
1472 
1473 	return amdgpu_gmc_sign_extend(offset);
1474 }
1475 
1476 /**
1477  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1478  * @adev: amdgpu device object
1479  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1480  *
1481  * Returns:
1482  * Which of the allowed domains is preferred for pinning the BO for scanout.
1483  */
1484 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1485 					    uint32_t domain)
1486 {
1487 	if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1488 		domain = AMDGPU_GEM_DOMAIN_VRAM;
1489 		if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1490 			domain = AMDGPU_GEM_DOMAIN_GTT;
1491 	}
1492 	return domain;
1493 }
1494 
1495 #if defined(CONFIG_DEBUG_FS)
1496 #define amdgpu_bo_print_flag(m, bo, flag)		        \
1497 	do {							\
1498 		if (bo->flags & (AMDGPU_GEM_CREATE_ ## flag)) {	\
1499 			seq_printf((m), " " #flag);		\
1500 		}						\
1501 	} while (0)
1502 
1503 /**
1504  * amdgpu_bo_print_info - print BO info in debugfs file
1505  *
1506  * @id: Index or Id of the BO
1507  * @bo: Requested BO for printing info
1508  * @m: debugfs file
1509  *
1510  * Print BO information in debugfs file
1511  *
1512  * Returns:
1513  * Size of the BO in bytes.
1514  */
1515 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m)
1516 {
1517 	struct dma_buf_attachment *attachment;
1518 	struct dma_buf *dma_buf;
1519 	unsigned int domain;
1520 	const char *placement;
1521 	unsigned int pin_count;
1522 	u64 size;
1523 
1524 	domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
1525 	switch (domain) {
1526 	case AMDGPU_GEM_DOMAIN_VRAM:
1527 		placement = "VRAM";
1528 		break;
1529 	case AMDGPU_GEM_DOMAIN_GTT:
1530 		placement = " GTT";
1531 		break;
1532 	case AMDGPU_GEM_DOMAIN_CPU:
1533 	default:
1534 		placement = " CPU";
1535 		break;
1536 	}
1537 
1538 	size = amdgpu_bo_size(bo);
1539 	seq_printf(m, "\t\t0x%08x: %12lld byte %s",
1540 			id, size, placement);
1541 
1542 	pin_count = READ_ONCE(bo->tbo.pin_count);
1543 	if (pin_count)
1544 		seq_printf(m, " pin count %d", pin_count);
1545 
1546 	dma_buf = READ_ONCE(bo->tbo.base.dma_buf);
1547 	attachment = READ_ONCE(bo->tbo.base.import_attach);
1548 
1549 	if (attachment)
1550 		seq_printf(m, " imported from %p", dma_buf);
1551 	else if (dma_buf)
1552 		seq_printf(m, " exported as %p", dma_buf);
1553 
1554 	amdgpu_bo_print_flag(m, bo, CPU_ACCESS_REQUIRED);
1555 	amdgpu_bo_print_flag(m, bo, NO_CPU_ACCESS);
1556 	amdgpu_bo_print_flag(m, bo, CPU_GTT_USWC);
1557 	amdgpu_bo_print_flag(m, bo, VRAM_CLEARED);
1558 	amdgpu_bo_print_flag(m, bo, SHADOW);
1559 	amdgpu_bo_print_flag(m, bo, VRAM_CONTIGUOUS);
1560 	amdgpu_bo_print_flag(m, bo, VM_ALWAYS_VALID);
1561 	amdgpu_bo_print_flag(m, bo, EXPLICIT_SYNC);
1562 
1563 	seq_puts(m, "\n");
1564 
1565 	return size;
1566 }
1567 #endif
1568