xref: /openbmc/linux/drivers/gpu/drm/ttm/ttm_bo.c (revision c4c11dd1)
1 /**************************************************************************
2  *
3  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 /*
28  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
29  */
30 
31 #define pr_fmt(fmt) "[TTM] " fmt
32 
33 #include <drm/ttm/ttm_module.h>
34 #include <drm/ttm/ttm_bo_driver.h>
35 #include <drm/ttm/ttm_placement.h>
36 #include <linux/jiffies.h>
37 #include <linux/slab.h>
38 #include <linux/sched.h>
39 #include <linux/mm.h>
40 #include <linux/file.h>
41 #include <linux/module.h>
42 #include <linux/atomic.h>
43 
44 #define TTM_ASSERT_LOCKED(param)
45 #define TTM_DEBUG(fmt, arg...)
46 #define TTM_BO_HASH_ORDER 13
47 
48 static int ttm_bo_swapout(struct ttm_mem_shrink *shrink);
49 static void ttm_bo_global_kobj_release(struct kobject *kobj);
50 
51 static struct attribute ttm_bo_count = {
52 	.name = "bo_count",
53 	.mode = S_IRUGO
54 };
55 
56 static inline int ttm_mem_type_from_flags(uint32_t flags, uint32_t *mem_type)
57 {
58 	int i;
59 
60 	for (i = 0; i <= TTM_PL_PRIV5; i++)
61 		if (flags & (1 << i)) {
62 			*mem_type = i;
63 			return 0;
64 		}
65 	return -EINVAL;
66 }
67 
68 static void ttm_mem_type_debug(struct ttm_bo_device *bdev, int mem_type)
69 {
70 	struct ttm_mem_type_manager *man = &bdev->man[mem_type];
71 
72 	pr_err("    has_type: %d\n", man->has_type);
73 	pr_err("    use_type: %d\n", man->use_type);
74 	pr_err("    flags: 0x%08X\n", man->flags);
75 	pr_err("    gpu_offset: 0x%08lX\n", man->gpu_offset);
76 	pr_err("    size: %llu\n", man->size);
77 	pr_err("    available_caching: 0x%08X\n", man->available_caching);
78 	pr_err("    default_caching: 0x%08X\n", man->default_caching);
79 	if (mem_type != TTM_PL_SYSTEM)
80 		(*man->func->debug)(man, TTM_PFX);
81 }
82 
83 static void ttm_bo_mem_space_debug(struct ttm_buffer_object *bo,
84 					struct ttm_placement *placement)
85 {
86 	int i, ret, mem_type;
87 
88 	pr_err("No space for %p (%lu pages, %luK, %luM)\n",
89 	       bo, bo->mem.num_pages, bo->mem.size >> 10,
90 	       bo->mem.size >> 20);
91 	for (i = 0; i < placement->num_placement; i++) {
92 		ret = ttm_mem_type_from_flags(placement->placement[i],
93 						&mem_type);
94 		if (ret)
95 			return;
96 		pr_err("  placement[%d]=0x%08X (%d)\n",
97 		       i, placement->placement[i], mem_type);
98 		ttm_mem_type_debug(bo->bdev, mem_type);
99 	}
100 }
101 
102 static ssize_t ttm_bo_global_show(struct kobject *kobj,
103 				  struct attribute *attr,
104 				  char *buffer)
105 {
106 	struct ttm_bo_global *glob =
107 		container_of(kobj, struct ttm_bo_global, kobj);
108 
109 	return snprintf(buffer, PAGE_SIZE, "%lu\n",
110 			(unsigned long) atomic_read(&glob->bo_count));
111 }
112 
113 static struct attribute *ttm_bo_global_attrs[] = {
114 	&ttm_bo_count,
115 	NULL
116 };
117 
118 static const struct sysfs_ops ttm_bo_global_ops = {
119 	.show = &ttm_bo_global_show
120 };
121 
122 static struct kobj_type ttm_bo_glob_kobj_type  = {
123 	.release = &ttm_bo_global_kobj_release,
124 	.sysfs_ops = &ttm_bo_global_ops,
125 	.default_attrs = ttm_bo_global_attrs
126 };
127 
128 
129 static inline uint32_t ttm_bo_type_flags(unsigned type)
130 {
131 	return 1 << (type);
132 }
133 
134 static void ttm_bo_release_list(struct kref *list_kref)
135 {
136 	struct ttm_buffer_object *bo =
137 	    container_of(list_kref, struct ttm_buffer_object, list_kref);
138 	struct ttm_bo_device *bdev = bo->bdev;
139 	size_t acc_size = bo->acc_size;
140 
141 	BUG_ON(atomic_read(&bo->list_kref.refcount));
142 	BUG_ON(atomic_read(&bo->kref.refcount));
143 	BUG_ON(atomic_read(&bo->cpu_writers));
144 	BUG_ON(bo->sync_obj != NULL);
145 	BUG_ON(bo->mem.mm_node != NULL);
146 	BUG_ON(!list_empty(&bo->lru));
147 	BUG_ON(!list_empty(&bo->ddestroy));
148 
149 	if (bo->ttm)
150 		ttm_tt_destroy(bo->ttm);
151 	atomic_dec(&bo->glob->bo_count);
152 	if (bo->resv == &bo->ttm_resv)
153 		reservation_object_fini(&bo->ttm_resv);
154 
155 	if (bo->destroy)
156 		bo->destroy(bo);
157 	else {
158 		kfree(bo);
159 	}
160 	ttm_mem_global_free(bdev->glob->mem_glob, acc_size);
161 }
162 
163 void ttm_bo_add_to_lru(struct ttm_buffer_object *bo)
164 {
165 	struct ttm_bo_device *bdev = bo->bdev;
166 	struct ttm_mem_type_manager *man;
167 
168 	lockdep_assert_held(&bo->resv->lock.base);
169 
170 	if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) {
171 
172 		BUG_ON(!list_empty(&bo->lru));
173 
174 		man = &bdev->man[bo->mem.mem_type];
175 		list_add_tail(&bo->lru, &man->lru);
176 		kref_get(&bo->list_kref);
177 
178 		if (bo->ttm != NULL) {
179 			list_add_tail(&bo->swap, &bo->glob->swap_lru);
180 			kref_get(&bo->list_kref);
181 		}
182 	}
183 }
184 EXPORT_SYMBOL(ttm_bo_add_to_lru);
185 
186 int ttm_bo_del_from_lru(struct ttm_buffer_object *bo)
187 {
188 	int put_count = 0;
189 
190 	if (!list_empty(&bo->swap)) {
191 		list_del_init(&bo->swap);
192 		++put_count;
193 	}
194 	if (!list_empty(&bo->lru)) {
195 		list_del_init(&bo->lru);
196 		++put_count;
197 	}
198 
199 	/*
200 	 * TODO: Add a driver hook to delete from
201 	 * driver-specific LRU's here.
202 	 */
203 
204 	return put_count;
205 }
206 
207 static void ttm_bo_ref_bug(struct kref *list_kref)
208 {
209 	BUG();
210 }
211 
212 void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
213 			 bool never_free)
214 {
215 	kref_sub(&bo->list_kref, count,
216 		 (never_free) ? ttm_bo_ref_bug : ttm_bo_release_list);
217 }
218 
219 void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo)
220 {
221 	int put_count;
222 
223 	spin_lock(&bo->glob->lru_lock);
224 	put_count = ttm_bo_del_from_lru(bo);
225 	spin_unlock(&bo->glob->lru_lock);
226 	ttm_bo_list_ref_sub(bo, put_count, true);
227 }
228 EXPORT_SYMBOL(ttm_bo_del_sub_from_lru);
229 
230 /*
231  * Call bo->mutex locked.
232  */
233 static int ttm_bo_add_ttm(struct ttm_buffer_object *bo, bool zero_alloc)
234 {
235 	struct ttm_bo_device *bdev = bo->bdev;
236 	struct ttm_bo_global *glob = bo->glob;
237 	int ret = 0;
238 	uint32_t page_flags = 0;
239 
240 	TTM_ASSERT_LOCKED(&bo->mutex);
241 	bo->ttm = NULL;
242 
243 	if (bdev->need_dma32)
244 		page_flags |= TTM_PAGE_FLAG_DMA32;
245 
246 	switch (bo->type) {
247 	case ttm_bo_type_device:
248 		if (zero_alloc)
249 			page_flags |= TTM_PAGE_FLAG_ZERO_ALLOC;
250 	case ttm_bo_type_kernel:
251 		bo->ttm = bdev->driver->ttm_tt_create(bdev, bo->num_pages << PAGE_SHIFT,
252 						      page_flags, glob->dummy_read_page);
253 		if (unlikely(bo->ttm == NULL))
254 			ret = -ENOMEM;
255 		break;
256 	case ttm_bo_type_sg:
257 		bo->ttm = bdev->driver->ttm_tt_create(bdev, bo->num_pages << PAGE_SHIFT,
258 						      page_flags | TTM_PAGE_FLAG_SG,
259 						      glob->dummy_read_page);
260 		if (unlikely(bo->ttm == NULL)) {
261 			ret = -ENOMEM;
262 			break;
263 		}
264 		bo->ttm->sg = bo->sg;
265 		break;
266 	default:
267 		pr_err("Illegal buffer object type\n");
268 		ret = -EINVAL;
269 		break;
270 	}
271 
272 	return ret;
273 }
274 
275 static int ttm_bo_handle_move_mem(struct ttm_buffer_object *bo,
276 				  struct ttm_mem_reg *mem,
277 				  bool evict, bool interruptible,
278 				  bool no_wait_gpu)
279 {
280 	struct ttm_bo_device *bdev = bo->bdev;
281 	bool old_is_pci = ttm_mem_reg_is_pci(bdev, &bo->mem);
282 	bool new_is_pci = ttm_mem_reg_is_pci(bdev, mem);
283 	struct ttm_mem_type_manager *old_man = &bdev->man[bo->mem.mem_type];
284 	struct ttm_mem_type_manager *new_man = &bdev->man[mem->mem_type];
285 	int ret = 0;
286 
287 	if (old_is_pci || new_is_pci ||
288 	    ((mem->placement & bo->mem.placement & TTM_PL_MASK_CACHING) == 0)) {
289 		ret = ttm_mem_io_lock(old_man, true);
290 		if (unlikely(ret != 0))
291 			goto out_err;
292 		ttm_bo_unmap_virtual_locked(bo);
293 		ttm_mem_io_unlock(old_man);
294 	}
295 
296 	/*
297 	 * Create and bind a ttm if required.
298 	 */
299 
300 	if (!(new_man->flags & TTM_MEMTYPE_FLAG_FIXED)) {
301 		if (bo->ttm == NULL) {
302 			bool zero = !(old_man->flags & TTM_MEMTYPE_FLAG_FIXED);
303 			ret = ttm_bo_add_ttm(bo, zero);
304 			if (ret)
305 				goto out_err;
306 		}
307 
308 		ret = ttm_tt_set_placement_caching(bo->ttm, mem->placement);
309 		if (ret)
310 			goto out_err;
311 
312 		if (mem->mem_type != TTM_PL_SYSTEM) {
313 			ret = ttm_tt_bind(bo->ttm, mem);
314 			if (ret)
315 				goto out_err;
316 		}
317 
318 		if (bo->mem.mem_type == TTM_PL_SYSTEM) {
319 			if (bdev->driver->move_notify)
320 				bdev->driver->move_notify(bo, mem);
321 			bo->mem = *mem;
322 			mem->mm_node = NULL;
323 			goto moved;
324 		}
325 	}
326 
327 	if (bdev->driver->move_notify)
328 		bdev->driver->move_notify(bo, mem);
329 
330 	if (!(old_man->flags & TTM_MEMTYPE_FLAG_FIXED) &&
331 	    !(new_man->flags & TTM_MEMTYPE_FLAG_FIXED))
332 		ret = ttm_bo_move_ttm(bo, evict, no_wait_gpu, mem);
333 	else if (bdev->driver->move)
334 		ret = bdev->driver->move(bo, evict, interruptible,
335 					 no_wait_gpu, mem);
336 	else
337 		ret = ttm_bo_move_memcpy(bo, evict, no_wait_gpu, mem);
338 
339 	if (ret) {
340 		if (bdev->driver->move_notify) {
341 			struct ttm_mem_reg tmp_mem = *mem;
342 			*mem = bo->mem;
343 			bo->mem = tmp_mem;
344 			bdev->driver->move_notify(bo, mem);
345 			bo->mem = *mem;
346 			*mem = tmp_mem;
347 		}
348 
349 		goto out_err;
350 	}
351 
352 moved:
353 	if (bo->evicted) {
354 		ret = bdev->driver->invalidate_caches(bdev, bo->mem.placement);
355 		if (ret)
356 			pr_err("Can not flush read caches\n");
357 		bo->evicted = false;
358 	}
359 
360 	if (bo->mem.mm_node) {
361 		bo->offset = (bo->mem.start << PAGE_SHIFT) +
362 		    bdev->man[bo->mem.mem_type].gpu_offset;
363 		bo->cur_placement = bo->mem.placement;
364 	} else
365 		bo->offset = 0;
366 
367 	return 0;
368 
369 out_err:
370 	new_man = &bdev->man[bo->mem.mem_type];
371 	if ((new_man->flags & TTM_MEMTYPE_FLAG_FIXED) && bo->ttm) {
372 		ttm_tt_unbind(bo->ttm);
373 		ttm_tt_destroy(bo->ttm);
374 		bo->ttm = NULL;
375 	}
376 
377 	return ret;
378 }
379 
380 /**
381  * Call bo::reserved.
382  * Will release GPU memory type usage on destruction.
383  * This is the place to put in driver specific hooks to release
384  * driver private resources.
385  * Will release the bo::reserved lock.
386  */
387 
388 static void ttm_bo_cleanup_memtype_use(struct ttm_buffer_object *bo)
389 {
390 	if (bo->bdev->driver->move_notify)
391 		bo->bdev->driver->move_notify(bo, NULL);
392 
393 	if (bo->ttm) {
394 		ttm_tt_unbind(bo->ttm);
395 		ttm_tt_destroy(bo->ttm);
396 		bo->ttm = NULL;
397 	}
398 	ttm_bo_mem_put(bo, &bo->mem);
399 
400 	ww_mutex_unlock (&bo->resv->lock);
401 }
402 
403 static void ttm_bo_cleanup_refs_or_queue(struct ttm_buffer_object *bo)
404 {
405 	struct ttm_bo_device *bdev = bo->bdev;
406 	struct ttm_bo_global *glob = bo->glob;
407 	struct ttm_bo_driver *driver = bdev->driver;
408 	void *sync_obj = NULL;
409 	int put_count;
410 	int ret;
411 
412 	spin_lock(&glob->lru_lock);
413 	ret = ttm_bo_reserve_nolru(bo, false, true, false, 0);
414 
415 	spin_lock(&bdev->fence_lock);
416 	(void) ttm_bo_wait(bo, false, false, true);
417 	if (!ret && !bo->sync_obj) {
418 		spin_unlock(&bdev->fence_lock);
419 		put_count = ttm_bo_del_from_lru(bo);
420 
421 		spin_unlock(&glob->lru_lock);
422 		ttm_bo_cleanup_memtype_use(bo);
423 
424 		ttm_bo_list_ref_sub(bo, put_count, true);
425 
426 		return;
427 	}
428 	if (bo->sync_obj)
429 		sync_obj = driver->sync_obj_ref(bo->sync_obj);
430 	spin_unlock(&bdev->fence_lock);
431 
432 	if (!ret)
433 		ww_mutex_unlock(&bo->resv->lock);
434 
435 	kref_get(&bo->list_kref);
436 	list_add_tail(&bo->ddestroy, &bdev->ddestroy);
437 	spin_unlock(&glob->lru_lock);
438 
439 	if (sync_obj) {
440 		driver->sync_obj_flush(sync_obj);
441 		driver->sync_obj_unref(&sync_obj);
442 	}
443 	schedule_delayed_work(&bdev->wq,
444 			      ((HZ / 100) < 1) ? 1 : HZ / 100);
445 }
446 
447 /**
448  * function ttm_bo_cleanup_refs_and_unlock
449  * If bo idle, remove from delayed- and lru lists, and unref.
450  * If not idle, do nothing.
451  *
452  * Must be called with lru_lock and reservation held, this function
453  * will drop both before returning.
454  *
455  * @interruptible         Any sleeps should occur interruptibly.
456  * @no_wait_gpu           Never wait for gpu. Return -EBUSY instead.
457  */
458 
459 static int ttm_bo_cleanup_refs_and_unlock(struct ttm_buffer_object *bo,
460 					  bool interruptible,
461 					  bool no_wait_gpu)
462 {
463 	struct ttm_bo_device *bdev = bo->bdev;
464 	struct ttm_bo_driver *driver = bdev->driver;
465 	struct ttm_bo_global *glob = bo->glob;
466 	int put_count;
467 	int ret;
468 
469 	spin_lock(&bdev->fence_lock);
470 	ret = ttm_bo_wait(bo, false, false, true);
471 
472 	if (ret && !no_wait_gpu) {
473 		void *sync_obj;
474 
475 		/*
476 		 * Take a reference to the fence and unreserve,
477 		 * at this point the buffer should be dead, so
478 		 * no new sync objects can be attached.
479 		 */
480 		sync_obj = driver->sync_obj_ref(bo->sync_obj);
481 		spin_unlock(&bdev->fence_lock);
482 
483 		ww_mutex_unlock(&bo->resv->lock);
484 		spin_unlock(&glob->lru_lock);
485 
486 		ret = driver->sync_obj_wait(sync_obj, false, interruptible);
487 		driver->sync_obj_unref(&sync_obj);
488 		if (ret)
489 			return ret;
490 
491 		/*
492 		 * remove sync_obj with ttm_bo_wait, the wait should be
493 		 * finished, and no new wait object should have been added.
494 		 */
495 		spin_lock(&bdev->fence_lock);
496 		ret = ttm_bo_wait(bo, false, false, true);
497 		WARN_ON(ret);
498 		spin_unlock(&bdev->fence_lock);
499 		if (ret)
500 			return ret;
501 
502 		spin_lock(&glob->lru_lock);
503 		ret = ttm_bo_reserve_nolru(bo, false, true, false, 0);
504 
505 		/*
506 		 * We raced, and lost, someone else holds the reservation now,
507 		 * and is probably busy in ttm_bo_cleanup_memtype_use.
508 		 *
509 		 * Even if it's not the case, because we finished waiting any
510 		 * delayed destruction would succeed, so just return success
511 		 * here.
512 		 */
513 		if (ret) {
514 			spin_unlock(&glob->lru_lock);
515 			return 0;
516 		}
517 	} else
518 		spin_unlock(&bdev->fence_lock);
519 
520 	if (ret || unlikely(list_empty(&bo->ddestroy))) {
521 		ww_mutex_unlock(&bo->resv->lock);
522 		spin_unlock(&glob->lru_lock);
523 		return ret;
524 	}
525 
526 	put_count = ttm_bo_del_from_lru(bo);
527 	list_del_init(&bo->ddestroy);
528 	++put_count;
529 
530 	spin_unlock(&glob->lru_lock);
531 	ttm_bo_cleanup_memtype_use(bo);
532 
533 	ttm_bo_list_ref_sub(bo, put_count, true);
534 
535 	return 0;
536 }
537 
538 /**
539  * Traverse the delayed list, and call ttm_bo_cleanup_refs on all
540  * encountered buffers.
541  */
542 
543 static int ttm_bo_delayed_delete(struct ttm_bo_device *bdev, bool remove_all)
544 {
545 	struct ttm_bo_global *glob = bdev->glob;
546 	struct ttm_buffer_object *entry = NULL;
547 	int ret = 0;
548 
549 	spin_lock(&glob->lru_lock);
550 	if (list_empty(&bdev->ddestroy))
551 		goto out_unlock;
552 
553 	entry = list_first_entry(&bdev->ddestroy,
554 		struct ttm_buffer_object, ddestroy);
555 	kref_get(&entry->list_kref);
556 
557 	for (;;) {
558 		struct ttm_buffer_object *nentry = NULL;
559 
560 		if (entry->ddestroy.next != &bdev->ddestroy) {
561 			nentry = list_first_entry(&entry->ddestroy,
562 				struct ttm_buffer_object, ddestroy);
563 			kref_get(&nentry->list_kref);
564 		}
565 
566 		ret = ttm_bo_reserve_nolru(entry, false, true, false, 0);
567 		if (remove_all && ret) {
568 			spin_unlock(&glob->lru_lock);
569 			ret = ttm_bo_reserve_nolru(entry, false, false,
570 						   false, 0);
571 			spin_lock(&glob->lru_lock);
572 		}
573 
574 		if (!ret)
575 			ret = ttm_bo_cleanup_refs_and_unlock(entry, false,
576 							     !remove_all);
577 		else
578 			spin_unlock(&glob->lru_lock);
579 
580 		kref_put(&entry->list_kref, ttm_bo_release_list);
581 		entry = nentry;
582 
583 		if (ret || !entry)
584 			goto out;
585 
586 		spin_lock(&glob->lru_lock);
587 		if (list_empty(&entry->ddestroy))
588 			break;
589 	}
590 
591 out_unlock:
592 	spin_unlock(&glob->lru_lock);
593 out:
594 	if (entry)
595 		kref_put(&entry->list_kref, ttm_bo_release_list);
596 	return ret;
597 }
598 
599 static void ttm_bo_delayed_workqueue(struct work_struct *work)
600 {
601 	struct ttm_bo_device *bdev =
602 	    container_of(work, struct ttm_bo_device, wq.work);
603 
604 	if (ttm_bo_delayed_delete(bdev, false)) {
605 		schedule_delayed_work(&bdev->wq,
606 				      ((HZ / 100) < 1) ? 1 : HZ / 100);
607 	}
608 }
609 
610 static void ttm_bo_release(struct kref *kref)
611 {
612 	struct ttm_buffer_object *bo =
613 	    container_of(kref, struct ttm_buffer_object, kref);
614 	struct ttm_bo_device *bdev = bo->bdev;
615 	struct ttm_mem_type_manager *man = &bdev->man[bo->mem.mem_type];
616 
617 	drm_vma_offset_remove(&bdev->vma_manager, &bo->vma_node);
618 	ttm_mem_io_lock(man, false);
619 	ttm_mem_io_free_vm(bo);
620 	ttm_mem_io_unlock(man);
621 	ttm_bo_cleanup_refs_or_queue(bo);
622 	kref_put(&bo->list_kref, ttm_bo_release_list);
623 }
624 
625 void ttm_bo_unref(struct ttm_buffer_object **p_bo)
626 {
627 	struct ttm_buffer_object *bo = *p_bo;
628 
629 	*p_bo = NULL;
630 	kref_put(&bo->kref, ttm_bo_release);
631 }
632 EXPORT_SYMBOL(ttm_bo_unref);
633 
634 int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev)
635 {
636 	return cancel_delayed_work_sync(&bdev->wq);
637 }
638 EXPORT_SYMBOL(ttm_bo_lock_delayed_workqueue);
639 
640 void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev, int resched)
641 {
642 	if (resched)
643 		schedule_delayed_work(&bdev->wq,
644 				      ((HZ / 100) < 1) ? 1 : HZ / 100);
645 }
646 EXPORT_SYMBOL(ttm_bo_unlock_delayed_workqueue);
647 
648 static int ttm_bo_evict(struct ttm_buffer_object *bo, bool interruptible,
649 			bool no_wait_gpu)
650 {
651 	struct ttm_bo_device *bdev = bo->bdev;
652 	struct ttm_mem_reg evict_mem;
653 	struct ttm_placement placement;
654 	int ret = 0;
655 
656 	spin_lock(&bdev->fence_lock);
657 	ret = ttm_bo_wait(bo, false, interruptible, no_wait_gpu);
658 	spin_unlock(&bdev->fence_lock);
659 
660 	if (unlikely(ret != 0)) {
661 		if (ret != -ERESTARTSYS) {
662 			pr_err("Failed to expire sync object before buffer eviction\n");
663 		}
664 		goto out;
665 	}
666 
667 	lockdep_assert_held(&bo->resv->lock.base);
668 
669 	evict_mem = bo->mem;
670 	evict_mem.mm_node = NULL;
671 	evict_mem.bus.io_reserved_vm = false;
672 	evict_mem.bus.io_reserved_count = 0;
673 
674 	placement.fpfn = 0;
675 	placement.lpfn = 0;
676 	placement.num_placement = 0;
677 	placement.num_busy_placement = 0;
678 	bdev->driver->evict_flags(bo, &placement);
679 	ret = ttm_bo_mem_space(bo, &placement, &evict_mem, interruptible,
680 				no_wait_gpu);
681 	if (ret) {
682 		if (ret != -ERESTARTSYS) {
683 			pr_err("Failed to find memory space for buffer 0x%p eviction\n",
684 			       bo);
685 			ttm_bo_mem_space_debug(bo, &placement);
686 		}
687 		goto out;
688 	}
689 
690 	ret = ttm_bo_handle_move_mem(bo, &evict_mem, true, interruptible,
691 				     no_wait_gpu);
692 	if (ret) {
693 		if (ret != -ERESTARTSYS)
694 			pr_err("Buffer eviction failed\n");
695 		ttm_bo_mem_put(bo, &evict_mem);
696 		goto out;
697 	}
698 	bo->evicted = true;
699 out:
700 	return ret;
701 }
702 
703 static int ttm_mem_evict_first(struct ttm_bo_device *bdev,
704 				uint32_t mem_type,
705 				bool interruptible,
706 				bool no_wait_gpu)
707 {
708 	struct ttm_bo_global *glob = bdev->glob;
709 	struct ttm_mem_type_manager *man = &bdev->man[mem_type];
710 	struct ttm_buffer_object *bo;
711 	int ret = -EBUSY, put_count;
712 
713 	spin_lock(&glob->lru_lock);
714 	list_for_each_entry(bo, &man->lru, lru) {
715 		ret = ttm_bo_reserve_nolru(bo, false, true, false, 0);
716 		if (!ret)
717 			break;
718 	}
719 
720 	if (ret) {
721 		spin_unlock(&glob->lru_lock);
722 		return ret;
723 	}
724 
725 	kref_get(&bo->list_kref);
726 
727 	if (!list_empty(&bo->ddestroy)) {
728 		ret = ttm_bo_cleanup_refs_and_unlock(bo, interruptible,
729 						     no_wait_gpu);
730 		kref_put(&bo->list_kref, ttm_bo_release_list);
731 		return ret;
732 	}
733 
734 	put_count = ttm_bo_del_from_lru(bo);
735 	spin_unlock(&glob->lru_lock);
736 
737 	BUG_ON(ret != 0);
738 
739 	ttm_bo_list_ref_sub(bo, put_count, true);
740 
741 	ret = ttm_bo_evict(bo, interruptible, no_wait_gpu);
742 	ttm_bo_unreserve(bo);
743 
744 	kref_put(&bo->list_kref, ttm_bo_release_list);
745 	return ret;
746 }
747 
748 void ttm_bo_mem_put(struct ttm_buffer_object *bo, struct ttm_mem_reg *mem)
749 {
750 	struct ttm_mem_type_manager *man = &bo->bdev->man[mem->mem_type];
751 
752 	if (mem->mm_node)
753 		(*man->func->put_node)(man, mem);
754 }
755 EXPORT_SYMBOL(ttm_bo_mem_put);
756 
757 /**
758  * Repeatedly evict memory from the LRU for @mem_type until we create enough
759  * space, or we've evicted everything and there isn't enough space.
760  */
761 static int ttm_bo_mem_force_space(struct ttm_buffer_object *bo,
762 					uint32_t mem_type,
763 					struct ttm_placement *placement,
764 					struct ttm_mem_reg *mem,
765 					bool interruptible,
766 					bool no_wait_gpu)
767 {
768 	struct ttm_bo_device *bdev = bo->bdev;
769 	struct ttm_mem_type_manager *man = &bdev->man[mem_type];
770 	int ret;
771 
772 	do {
773 		ret = (*man->func->get_node)(man, bo, placement, mem);
774 		if (unlikely(ret != 0))
775 			return ret;
776 		if (mem->mm_node)
777 			break;
778 		ret = ttm_mem_evict_first(bdev, mem_type,
779 					  interruptible, no_wait_gpu);
780 		if (unlikely(ret != 0))
781 			return ret;
782 	} while (1);
783 	if (mem->mm_node == NULL)
784 		return -ENOMEM;
785 	mem->mem_type = mem_type;
786 	return 0;
787 }
788 
789 static uint32_t ttm_bo_select_caching(struct ttm_mem_type_manager *man,
790 				      uint32_t cur_placement,
791 				      uint32_t proposed_placement)
792 {
793 	uint32_t caching = proposed_placement & TTM_PL_MASK_CACHING;
794 	uint32_t result = proposed_placement & ~TTM_PL_MASK_CACHING;
795 
796 	/**
797 	 * Keep current caching if possible.
798 	 */
799 
800 	if ((cur_placement & caching) != 0)
801 		result |= (cur_placement & caching);
802 	else if ((man->default_caching & caching) != 0)
803 		result |= man->default_caching;
804 	else if ((TTM_PL_FLAG_CACHED & caching) != 0)
805 		result |= TTM_PL_FLAG_CACHED;
806 	else if ((TTM_PL_FLAG_WC & caching) != 0)
807 		result |= TTM_PL_FLAG_WC;
808 	else if ((TTM_PL_FLAG_UNCACHED & caching) != 0)
809 		result |= TTM_PL_FLAG_UNCACHED;
810 
811 	return result;
812 }
813 
814 static bool ttm_bo_mt_compatible(struct ttm_mem_type_manager *man,
815 				 uint32_t mem_type,
816 				 uint32_t proposed_placement,
817 				 uint32_t *masked_placement)
818 {
819 	uint32_t cur_flags = ttm_bo_type_flags(mem_type);
820 
821 	if ((cur_flags & proposed_placement & TTM_PL_MASK_MEM) == 0)
822 		return false;
823 
824 	if ((proposed_placement & man->available_caching) == 0)
825 		return false;
826 
827 	cur_flags |= (proposed_placement & man->available_caching);
828 
829 	*masked_placement = cur_flags;
830 	return true;
831 }
832 
833 /**
834  * Creates space for memory region @mem according to its type.
835  *
836  * This function first searches for free space in compatible memory types in
837  * the priority order defined by the driver.  If free space isn't found, then
838  * ttm_bo_mem_force_space is attempted in priority order to evict and find
839  * space.
840  */
841 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
842 			struct ttm_placement *placement,
843 			struct ttm_mem_reg *mem,
844 			bool interruptible,
845 			bool no_wait_gpu)
846 {
847 	struct ttm_bo_device *bdev = bo->bdev;
848 	struct ttm_mem_type_manager *man;
849 	uint32_t mem_type = TTM_PL_SYSTEM;
850 	uint32_t cur_flags = 0;
851 	bool type_found = false;
852 	bool type_ok = false;
853 	bool has_erestartsys = false;
854 	int i, ret;
855 
856 	mem->mm_node = NULL;
857 	for (i = 0; i < placement->num_placement; ++i) {
858 		ret = ttm_mem_type_from_flags(placement->placement[i],
859 						&mem_type);
860 		if (ret)
861 			return ret;
862 		man = &bdev->man[mem_type];
863 
864 		type_ok = ttm_bo_mt_compatible(man,
865 						mem_type,
866 						placement->placement[i],
867 						&cur_flags);
868 
869 		if (!type_ok)
870 			continue;
871 
872 		cur_flags = ttm_bo_select_caching(man, bo->mem.placement,
873 						  cur_flags);
874 		/*
875 		 * Use the access and other non-mapping-related flag bits from
876 		 * the memory placement flags to the current flags
877 		 */
878 		ttm_flag_masked(&cur_flags, placement->placement[i],
879 				~TTM_PL_MASK_MEMTYPE);
880 
881 		if (mem_type == TTM_PL_SYSTEM)
882 			break;
883 
884 		if (man->has_type && man->use_type) {
885 			type_found = true;
886 			ret = (*man->func->get_node)(man, bo, placement, mem);
887 			if (unlikely(ret))
888 				return ret;
889 		}
890 		if (mem->mm_node)
891 			break;
892 	}
893 
894 	if ((type_ok && (mem_type == TTM_PL_SYSTEM)) || mem->mm_node) {
895 		mem->mem_type = mem_type;
896 		mem->placement = cur_flags;
897 		return 0;
898 	}
899 
900 	if (!type_found)
901 		return -EINVAL;
902 
903 	for (i = 0; i < placement->num_busy_placement; ++i) {
904 		ret = ttm_mem_type_from_flags(placement->busy_placement[i],
905 						&mem_type);
906 		if (ret)
907 			return ret;
908 		man = &bdev->man[mem_type];
909 		if (!man->has_type)
910 			continue;
911 		if (!ttm_bo_mt_compatible(man,
912 						mem_type,
913 						placement->busy_placement[i],
914 						&cur_flags))
915 			continue;
916 
917 		cur_flags = ttm_bo_select_caching(man, bo->mem.placement,
918 						  cur_flags);
919 		/*
920 		 * Use the access and other non-mapping-related flag bits from
921 		 * the memory placement flags to the current flags
922 		 */
923 		ttm_flag_masked(&cur_flags, placement->busy_placement[i],
924 				~TTM_PL_MASK_MEMTYPE);
925 
926 
927 		if (mem_type == TTM_PL_SYSTEM) {
928 			mem->mem_type = mem_type;
929 			mem->placement = cur_flags;
930 			mem->mm_node = NULL;
931 			return 0;
932 		}
933 
934 		ret = ttm_bo_mem_force_space(bo, mem_type, placement, mem,
935 						interruptible, no_wait_gpu);
936 		if (ret == 0 && mem->mm_node) {
937 			mem->placement = cur_flags;
938 			return 0;
939 		}
940 		if (ret == -ERESTARTSYS)
941 			has_erestartsys = true;
942 	}
943 	ret = (has_erestartsys) ? -ERESTARTSYS : -ENOMEM;
944 	return ret;
945 }
946 EXPORT_SYMBOL(ttm_bo_mem_space);
947 
948 int ttm_bo_move_buffer(struct ttm_buffer_object *bo,
949 			struct ttm_placement *placement,
950 			bool interruptible,
951 			bool no_wait_gpu)
952 {
953 	int ret = 0;
954 	struct ttm_mem_reg mem;
955 	struct ttm_bo_device *bdev = bo->bdev;
956 
957 	lockdep_assert_held(&bo->resv->lock.base);
958 
959 	/*
960 	 * FIXME: It's possible to pipeline buffer moves.
961 	 * Have the driver move function wait for idle when necessary,
962 	 * instead of doing it here.
963 	 */
964 	spin_lock(&bdev->fence_lock);
965 	ret = ttm_bo_wait(bo, false, interruptible, no_wait_gpu);
966 	spin_unlock(&bdev->fence_lock);
967 	if (ret)
968 		return ret;
969 	mem.num_pages = bo->num_pages;
970 	mem.size = mem.num_pages << PAGE_SHIFT;
971 	mem.page_alignment = bo->mem.page_alignment;
972 	mem.bus.io_reserved_vm = false;
973 	mem.bus.io_reserved_count = 0;
974 	/*
975 	 * Determine where to move the buffer.
976 	 */
977 	ret = ttm_bo_mem_space(bo, placement, &mem,
978 			       interruptible, no_wait_gpu);
979 	if (ret)
980 		goto out_unlock;
981 	ret = ttm_bo_handle_move_mem(bo, &mem, false,
982 				     interruptible, no_wait_gpu);
983 out_unlock:
984 	if (ret && mem.mm_node)
985 		ttm_bo_mem_put(bo, &mem);
986 	return ret;
987 }
988 
989 static int ttm_bo_mem_compat(struct ttm_placement *placement,
990 			     struct ttm_mem_reg *mem)
991 {
992 	int i;
993 
994 	if (mem->mm_node && placement->lpfn != 0 &&
995 	    (mem->start < placement->fpfn ||
996 	     mem->start + mem->num_pages > placement->lpfn))
997 		return -1;
998 
999 	for (i = 0; i < placement->num_placement; i++) {
1000 		if ((placement->placement[i] & mem->placement &
1001 			TTM_PL_MASK_CACHING) &&
1002 			(placement->placement[i] & mem->placement &
1003 			TTM_PL_MASK_MEM))
1004 			return i;
1005 	}
1006 	return -1;
1007 }
1008 
1009 int ttm_bo_validate(struct ttm_buffer_object *bo,
1010 			struct ttm_placement *placement,
1011 			bool interruptible,
1012 			bool no_wait_gpu)
1013 {
1014 	int ret;
1015 
1016 	lockdep_assert_held(&bo->resv->lock.base);
1017 	/* Check that range is valid */
1018 	if (placement->lpfn || placement->fpfn)
1019 		if (placement->fpfn > placement->lpfn ||
1020 			(placement->lpfn - placement->fpfn) < bo->num_pages)
1021 			return -EINVAL;
1022 	/*
1023 	 * Check whether we need to move buffer.
1024 	 */
1025 	ret = ttm_bo_mem_compat(placement, &bo->mem);
1026 	if (ret < 0) {
1027 		ret = ttm_bo_move_buffer(bo, placement, interruptible,
1028 					 no_wait_gpu);
1029 		if (ret)
1030 			return ret;
1031 	} else {
1032 		/*
1033 		 * Use the access and other non-mapping-related flag bits from
1034 		 * the compatible memory placement flags to the active flags
1035 		 */
1036 		ttm_flag_masked(&bo->mem.placement, placement->placement[ret],
1037 				~TTM_PL_MASK_MEMTYPE);
1038 	}
1039 	/*
1040 	 * We might need to add a TTM.
1041 	 */
1042 	if (bo->mem.mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
1043 		ret = ttm_bo_add_ttm(bo, true);
1044 		if (ret)
1045 			return ret;
1046 	}
1047 	return 0;
1048 }
1049 EXPORT_SYMBOL(ttm_bo_validate);
1050 
1051 int ttm_bo_check_placement(struct ttm_buffer_object *bo,
1052 				struct ttm_placement *placement)
1053 {
1054 	BUG_ON((placement->fpfn || placement->lpfn) &&
1055 	       (bo->mem.num_pages > (placement->lpfn - placement->fpfn)));
1056 
1057 	return 0;
1058 }
1059 
1060 int ttm_bo_init(struct ttm_bo_device *bdev,
1061 		struct ttm_buffer_object *bo,
1062 		unsigned long size,
1063 		enum ttm_bo_type type,
1064 		struct ttm_placement *placement,
1065 		uint32_t page_alignment,
1066 		bool interruptible,
1067 		struct file *persistent_swap_storage,
1068 		size_t acc_size,
1069 		struct sg_table *sg,
1070 		void (*destroy) (struct ttm_buffer_object *))
1071 {
1072 	int ret = 0;
1073 	unsigned long num_pages;
1074 	struct ttm_mem_global *mem_glob = bdev->glob->mem_glob;
1075 	bool locked;
1076 
1077 	ret = ttm_mem_global_alloc(mem_glob, acc_size, false, false);
1078 	if (ret) {
1079 		pr_err("Out of kernel memory\n");
1080 		if (destroy)
1081 			(*destroy)(bo);
1082 		else
1083 			kfree(bo);
1084 		return -ENOMEM;
1085 	}
1086 
1087 	num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1088 	if (num_pages == 0) {
1089 		pr_err("Illegal buffer object size\n");
1090 		if (destroy)
1091 			(*destroy)(bo);
1092 		else
1093 			kfree(bo);
1094 		ttm_mem_global_free(mem_glob, acc_size);
1095 		return -EINVAL;
1096 	}
1097 	bo->destroy = destroy;
1098 
1099 	kref_init(&bo->kref);
1100 	kref_init(&bo->list_kref);
1101 	atomic_set(&bo->cpu_writers, 0);
1102 	INIT_LIST_HEAD(&bo->lru);
1103 	INIT_LIST_HEAD(&bo->ddestroy);
1104 	INIT_LIST_HEAD(&bo->swap);
1105 	INIT_LIST_HEAD(&bo->io_reserve_lru);
1106 	bo->bdev = bdev;
1107 	bo->glob = bdev->glob;
1108 	bo->type = type;
1109 	bo->num_pages = num_pages;
1110 	bo->mem.size = num_pages << PAGE_SHIFT;
1111 	bo->mem.mem_type = TTM_PL_SYSTEM;
1112 	bo->mem.num_pages = bo->num_pages;
1113 	bo->mem.mm_node = NULL;
1114 	bo->mem.page_alignment = page_alignment;
1115 	bo->mem.bus.io_reserved_vm = false;
1116 	bo->mem.bus.io_reserved_count = 0;
1117 	bo->priv_flags = 0;
1118 	bo->mem.placement = (TTM_PL_FLAG_SYSTEM | TTM_PL_FLAG_CACHED);
1119 	bo->persistent_swap_storage = persistent_swap_storage;
1120 	bo->acc_size = acc_size;
1121 	bo->sg = sg;
1122 	bo->resv = &bo->ttm_resv;
1123 	reservation_object_init(bo->resv);
1124 	atomic_inc(&bo->glob->bo_count);
1125 	drm_vma_node_reset(&bo->vma_node);
1126 
1127 	ret = ttm_bo_check_placement(bo, placement);
1128 
1129 	/*
1130 	 * For ttm_bo_type_device buffers, allocate
1131 	 * address space from the device.
1132 	 */
1133 	if (likely(!ret) &&
1134 	    (bo->type == ttm_bo_type_device ||
1135 	     bo->type == ttm_bo_type_sg))
1136 		ret = drm_vma_offset_add(&bdev->vma_manager, &bo->vma_node,
1137 					 bo->mem.num_pages);
1138 
1139 	locked = ww_mutex_trylock(&bo->resv->lock);
1140 	WARN_ON(!locked);
1141 
1142 	if (likely(!ret))
1143 		ret = ttm_bo_validate(bo, placement, interruptible, false);
1144 
1145 	ttm_bo_unreserve(bo);
1146 
1147 	if (unlikely(ret))
1148 		ttm_bo_unref(&bo);
1149 
1150 	return ret;
1151 }
1152 EXPORT_SYMBOL(ttm_bo_init);
1153 
1154 size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
1155 		       unsigned long bo_size,
1156 		       unsigned struct_size)
1157 {
1158 	unsigned npages = (PAGE_ALIGN(bo_size)) >> PAGE_SHIFT;
1159 	size_t size = 0;
1160 
1161 	size += ttm_round_pot(struct_size);
1162 	size += PAGE_ALIGN(npages * sizeof(void *));
1163 	size += ttm_round_pot(sizeof(struct ttm_tt));
1164 	return size;
1165 }
1166 EXPORT_SYMBOL(ttm_bo_acc_size);
1167 
1168 size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
1169 			   unsigned long bo_size,
1170 			   unsigned struct_size)
1171 {
1172 	unsigned npages = (PAGE_ALIGN(bo_size)) >> PAGE_SHIFT;
1173 	size_t size = 0;
1174 
1175 	size += ttm_round_pot(struct_size);
1176 	size += PAGE_ALIGN(npages * sizeof(void *));
1177 	size += PAGE_ALIGN(npages * sizeof(dma_addr_t));
1178 	size += ttm_round_pot(sizeof(struct ttm_dma_tt));
1179 	return size;
1180 }
1181 EXPORT_SYMBOL(ttm_bo_dma_acc_size);
1182 
1183 int ttm_bo_create(struct ttm_bo_device *bdev,
1184 			unsigned long size,
1185 			enum ttm_bo_type type,
1186 			struct ttm_placement *placement,
1187 			uint32_t page_alignment,
1188 			bool interruptible,
1189 			struct file *persistent_swap_storage,
1190 			struct ttm_buffer_object **p_bo)
1191 {
1192 	struct ttm_buffer_object *bo;
1193 	size_t acc_size;
1194 	int ret;
1195 
1196 	bo = kzalloc(sizeof(*bo), GFP_KERNEL);
1197 	if (unlikely(bo == NULL))
1198 		return -ENOMEM;
1199 
1200 	acc_size = ttm_bo_acc_size(bdev, size, sizeof(struct ttm_buffer_object));
1201 	ret = ttm_bo_init(bdev, bo, size, type, placement, page_alignment,
1202 			  interruptible, persistent_swap_storage, acc_size,
1203 			  NULL, NULL);
1204 	if (likely(ret == 0))
1205 		*p_bo = bo;
1206 
1207 	return ret;
1208 }
1209 EXPORT_SYMBOL(ttm_bo_create);
1210 
1211 static int ttm_bo_force_list_clean(struct ttm_bo_device *bdev,
1212 					unsigned mem_type, bool allow_errors)
1213 {
1214 	struct ttm_mem_type_manager *man = &bdev->man[mem_type];
1215 	struct ttm_bo_global *glob = bdev->glob;
1216 	int ret;
1217 
1218 	/*
1219 	 * Can't use standard list traversal since we're unlocking.
1220 	 */
1221 
1222 	spin_lock(&glob->lru_lock);
1223 	while (!list_empty(&man->lru)) {
1224 		spin_unlock(&glob->lru_lock);
1225 		ret = ttm_mem_evict_first(bdev, mem_type, false, false);
1226 		if (ret) {
1227 			if (allow_errors) {
1228 				return ret;
1229 			} else {
1230 				pr_err("Cleanup eviction failed\n");
1231 			}
1232 		}
1233 		spin_lock(&glob->lru_lock);
1234 	}
1235 	spin_unlock(&glob->lru_lock);
1236 	return 0;
1237 }
1238 
1239 int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type)
1240 {
1241 	struct ttm_mem_type_manager *man;
1242 	int ret = -EINVAL;
1243 
1244 	if (mem_type >= TTM_NUM_MEM_TYPES) {
1245 		pr_err("Illegal memory type %d\n", mem_type);
1246 		return ret;
1247 	}
1248 	man = &bdev->man[mem_type];
1249 
1250 	if (!man->has_type) {
1251 		pr_err("Trying to take down uninitialized memory manager type %u\n",
1252 		       mem_type);
1253 		return ret;
1254 	}
1255 
1256 	man->use_type = false;
1257 	man->has_type = false;
1258 
1259 	ret = 0;
1260 	if (mem_type > 0) {
1261 		ttm_bo_force_list_clean(bdev, mem_type, false);
1262 
1263 		ret = (*man->func->takedown)(man);
1264 	}
1265 
1266 	return ret;
1267 }
1268 EXPORT_SYMBOL(ttm_bo_clean_mm);
1269 
1270 int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type)
1271 {
1272 	struct ttm_mem_type_manager *man = &bdev->man[mem_type];
1273 
1274 	if (mem_type == 0 || mem_type >= TTM_NUM_MEM_TYPES) {
1275 		pr_err("Illegal memory manager memory type %u\n", mem_type);
1276 		return -EINVAL;
1277 	}
1278 
1279 	if (!man->has_type) {
1280 		pr_err("Memory type %u has not been initialized\n", mem_type);
1281 		return 0;
1282 	}
1283 
1284 	return ttm_bo_force_list_clean(bdev, mem_type, true);
1285 }
1286 EXPORT_SYMBOL(ttm_bo_evict_mm);
1287 
1288 int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
1289 			unsigned long p_size)
1290 {
1291 	int ret = -EINVAL;
1292 	struct ttm_mem_type_manager *man;
1293 
1294 	BUG_ON(type >= TTM_NUM_MEM_TYPES);
1295 	man = &bdev->man[type];
1296 	BUG_ON(man->has_type);
1297 	man->io_reserve_fastpath = true;
1298 	man->use_io_reserve_lru = false;
1299 	mutex_init(&man->io_reserve_mutex);
1300 	INIT_LIST_HEAD(&man->io_reserve_lru);
1301 
1302 	ret = bdev->driver->init_mem_type(bdev, type, man);
1303 	if (ret)
1304 		return ret;
1305 	man->bdev = bdev;
1306 
1307 	ret = 0;
1308 	if (type != TTM_PL_SYSTEM) {
1309 		ret = (*man->func->init)(man, p_size);
1310 		if (ret)
1311 			return ret;
1312 	}
1313 	man->has_type = true;
1314 	man->use_type = true;
1315 	man->size = p_size;
1316 
1317 	INIT_LIST_HEAD(&man->lru);
1318 
1319 	return 0;
1320 }
1321 EXPORT_SYMBOL(ttm_bo_init_mm);
1322 
1323 static void ttm_bo_global_kobj_release(struct kobject *kobj)
1324 {
1325 	struct ttm_bo_global *glob =
1326 		container_of(kobj, struct ttm_bo_global, kobj);
1327 
1328 	ttm_mem_unregister_shrink(glob->mem_glob, &glob->shrink);
1329 	__free_page(glob->dummy_read_page);
1330 	kfree(glob);
1331 }
1332 
1333 void ttm_bo_global_release(struct drm_global_reference *ref)
1334 {
1335 	struct ttm_bo_global *glob = ref->object;
1336 
1337 	kobject_del(&glob->kobj);
1338 	kobject_put(&glob->kobj);
1339 }
1340 EXPORT_SYMBOL(ttm_bo_global_release);
1341 
1342 int ttm_bo_global_init(struct drm_global_reference *ref)
1343 {
1344 	struct ttm_bo_global_ref *bo_ref =
1345 		container_of(ref, struct ttm_bo_global_ref, ref);
1346 	struct ttm_bo_global *glob = ref->object;
1347 	int ret;
1348 
1349 	mutex_init(&glob->device_list_mutex);
1350 	spin_lock_init(&glob->lru_lock);
1351 	glob->mem_glob = bo_ref->mem_glob;
1352 	glob->dummy_read_page = alloc_page(__GFP_ZERO | GFP_DMA32);
1353 
1354 	if (unlikely(glob->dummy_read_page == NULL)) {
1355 		ret = -ENOMEM;
1356 		goto out_no_drp;
1357 	}
1358 
1359 	INIT_LIST_HEAD(&glob->swap_lru);
1360 	INIT_LIST_HEAD(&glob->device_list);
1361 
1362 	ttm_mem_init_shrink(&glob->shrink, ttm_bo_swapout);
1363 	ret = ttm_mem_register_shrink(glob->mem_glob, &glob->shrink);
1364 	if (unlikely(ret != 0)) {
1365 		pr_err("Could not register buffer object swapout\n");
1366 		goto out_no_shrink;
1367 	}
1368 
1369 	atomic_set(&glob->bo_count, 0);
1370 
1371 	ret = kobject_init_and_add(
1372 		&glob->kobj, &ttm_bo_glob_kobj_type, ttm_get_kobj(), "buffer_objects");
1373 	if (unlikely(ret != 0))
1374 		kobject_put(&glob->kobj);
1375 	return ret;
1376 out_no_shrink:
1377 	__free_page(glob->dummy_read_page);
1378 out_no_drp:
1379 	kfree(glob);
1380 	return ret;
1381 }
1382 EXPORT_SYMBOL(ttm_bo_global_init);
1383 
1384 
1385 int ttm_bo_device_release(struct ttm_bo_device *bdev)
1386 {
1387 	int ret = 0;
1388 	unsigned i = TTM_NUM_MEM_TYPES;
1389 	struct ttm_mem_type_manager *man;
1390 	struct ttm_bo_global *glob = bdev->glob;
1391 
1392 	while (i--) {
1393 		man = &bdev->man[i];
1394 		if (man->has_type) {
1395 			man->use_type = false;
1396 			if ((i != TTM_PL_SYSTEM) && ttm_bo_clean_mm(bdev, i)) {
1397 				ret = -EBUSY;
1398 				pr_err("DRM memory manager type %d is not clean\n",
1399 				       i);
1400 			}
1401 			man->has_type = false;
1402 		}
1403 	}
1404 
1405 	mutex_lock(&glob->device_list_mutex);
1406 	list_del(&bdev->device_list);
1407 	mutex_unlock(&glob->device_list_mutex);
1408 
1409 	cancel_delayed_work_sync(&bdev->wq);
1410 
1411 	while (ttm_bo_delayed_delete(bdev, true))
1412 		;
1413 
1414 	spin_lock(&glob->lru_lock);
1415 	if (list_empty(&bdev->ddestroy))
1416 		TTM_DEBUG("Delayed destroy list was clean\n");
1417 
1418 	if (list_empty(&bdev->man[0].lru))
1419 		TTM_DEBUG("Swap list was clean\n");
1420 	spin_unlock(&glob->lru_lock);
1421 
1422 	drm_vma_offset_manager_destroy(&bdev->vma_manager);
1423 
1424 	return ret;
1425 }
1426 EXPORT_SYMBOL(ttm_bo_device_release);
1427 
1428 int ttm_bo_device_init(struct ttm_bo_device *bdev,
1429 		       struct ttm_bo_global *glob,
1430 		       struct ttm_bo_driver *driver,
1431 		       uint64_t file_page_offset,
1432 		       bool need_dma32)
1433 {
1434 	int ret = -EINVAL;
1435 
1436 	bdev->driver = driver;
1437 
1438 	memset(bdev->man, 0, sizeof(bdev->man));
1439 
1440 	/*
1441 	 * Initialize the system memory buffer type.
1442 	 * Other types need to be driver / IOCTL initialized.
1443 	 */
1444 	ret = ttm_bo_init_mm(bdev, TTM_PL_SYSTEM, 0);
1445 	if (unlikely(ret != 0))
1446 		goto out_no_sys;
1447 
1448 	drm_vma_offset_manager_init(&bdev->vma_manager, file_page_offset,
1449 				    0x10000000);
1450 	INIT_DELAYED_WORK(&bdev->wq, ttm_bo_delayed_workqueue);
1451 	INIT_LIST_HEAD(&bdev->ddestroy);
1452 	bdev->dev_mapping = NULL;
1453 	bdev->glob = glob;
1454 	bdev->need_dma32 = need_dma32;
1455 	bdev->val_seq = 0;
1456 	spin_lock_init(&bdev->fence_lock);
1457 	mutex_lock(&glob->device_list_mutex);
1458 	list_add_tail(&bdev->device_list, &glob->device_list);
1459 	mutex_unlock(&glob->device_list_mutex);
1460 
1461 	return 0;
1462 out_no_sys:
1463 	return ret;
1464 }
1465 EXPORT_SYMBOL(ttm_bo_device_init);
1466 
1467 /*
1468  * buffer object vm functions.
1469  */
1470 
1471 bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem)
1472 {
1473 	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
1474 
1475 	if (!(man->flags & TTM_MEMTYPE_FLAG_FIXED)) {
1476 		if (mem->mem_type == TTM_PL_SYSTEM)
1477 			return false;
1478 
1479 		if (man->flags & TTM_MEMTYPE_FLAG_CMA)
1480 			return false;
1481 
1482 		if (mem->placement & TTM_PL_FLAG_CACHED)
1483 			return false;
1484 	}
1485 	return true;
1486 }
1487 
1488 void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo)
1489 {
1490 	struct ttm_bo_device *bdev = bo->bdev;
1491 
1492 	drm_vma_node_unmap(&bo->vma_node, bdev->dev_mapping);
1493 	ttm_mem_io_free_vm(bo);
1494 }
1495 
1496 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo)
1497 {
1498 	struct ttm_bo_device *bdev = bo->bdev;
1499 	struct ttm_mem_type_manager *man = &bdev->man[bo->mem.mem_type];
1500 
1501 	ttm_mem_io_lock(man, false);
1502 	ttm_bo_unmap_virtual_locked(bo);
1503 	ttm_mem_io_unlock(man);
1504 }
1505 
1506 
1507 EXPORT_SYMBOL(ttm_bo_unmap_virtual);
1508 
1509 
1510 int ttm_bo_wait(struct ttm_buffer_object *bo,
1511 		bool lazy, bool interruptible, bool no_wait)
1512 {
1513 	struct ttm_bo_driver *driver = bo->bdev->driver;
1514 	struct ttm_bo_device *bdev = bo->bdev;
1515 	void *sync_obj;
1516 	int ret = 0;
1517 
1518 	if (likely(bo->sync_obj == NULL))
1519 		return 0;
1520 
1521 	while (bo->sync_obj) {
1522 
1523 		if (driver->sync_obj_signaled(bo->sync_obj)) {
1524 			void *tmp_obj = bo->sync_obj;
1525 			bo->sync_obj = NULL;
1526 			clear_bit(TTM_BO_PRIV_FLAG_MOVING, &bo->priv_flags);
1527 			spin_unlock(&bdev->fence_lock);
1528 			driver->sync_obj_unref(&tmp_obj);
1529 			spin_lock(&bdev->fence_lock);
1530 			continue;
1531 		}
1532 
1533 		if (no_wait)
1534 			return -EBUSY;
1535 
1536 		sync_obj = driver->sync_obj_ref(bo->sync_obj);
1537 		spin_unlock(&bdev->fence_lock);
1538 		ret = driver->sync_obj_wait(sync_obj,
1539 					    lazy, interruptible);
1540 		if (unlikely(ret != 0)) {
1541 			driver->sync_obj_unref(&sync_obj);
1542 			spin_lock(&bdev->fence_lock);
1543 			return ret;
1544 		}
1545 		spin_lock(&bdev->fence_lock);
1546 		if (likely(bo->sync_obj == sync_obj)) {
1547 			void *tmp_obj = bo->sync_obj;
1548 			bo->sync_obj = NULL;
1549 			clear_bit(TTM_BO_PRIV_FLAG_MOVING,
1550 				  &bo->priv_flags);
1551 			spin_unlock(&bdev->fence_lock);
1552 			driver->sync_obj_unref(&sync_obj);
1553 			driver->sync_obj_unref(&tmp_obj);
1554 			spin_lock(&bdev->fence_lock);
1555 		} else {
1556 			spin_unlock(&bdev->fence_lock);
1557 			driver->sync_obj_unref(&sync_obj);
1558 			spin_lock(&bdev->fence_lock);
1559 		}
1560 	}
1561 	return 0;
1562 }
1563 EXPORT_SYMBOL(ttm_bo_wait);
1564 
1565 int ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait)
1566 {
1567 	struct ttm_bo_device *bdev = bo->bdev;
1568 	int ret = 0;
1569 
1570 	/*
1571 	 * Using ttm_bo_reserve makes sure the lru lists are updated.
1572 	 */
1573 
1574 	ret = ttm_bo_reserve(bo, true, no_wait, false, 0);
1575 	if (unlikely(ret != 0))
1576 		return ret;
1577 	spin_lock(&bdev->fence_lock);
1578 	ret = ttm_bo_wait(bo, false, true, no_wait);
1579 	spin_unlock(&bdev->fence_lock);
1580 	if (likely(ret == 0))
1581 		atomic_inc(&bo->cpu_writers);
1582 	ttm_bo_unreserve(bo);
1583 	return ret;
1584 }
1585 EXPORT_SYMBOL(ttm_bo_synccpu_write_grab);
1586 
1587 void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo)
1588 {
1589 	atomic_dec(&bo->cpu_writers);
1590 }
1591 EXPORT_SYMBOL(ttm_bo_synccpu_write_release);
1592 
1593 /**
1594  * A buffer object shrink method that tries to swap out the first
1595  * buffer object on the bo_global::swap_lru list.
1596  */
1597 
1598 static int ttm_bo_swapout(struct ttm_mem_shrink *shrink)
1599 {
1600 	struct ttm_bo_global *glob =
1601 	    container_of(shrink, struct ttm_bo_global, shrink);
1602 	struct ttm_buffer_object *bo;
1603 	int ret = -EBUSY;
1604 	int put_count;
1605 	uint32_t swap_placement = (TTM_PL_FLAG_CACHED | TTM_PL_FLAG_SYSTEM);
1606 
1607 	spin_lock(&glob->lru_lock);
1608 	list_for_each_entry(bo, &glob->swap_lru, swap) {
1609 		ret = ttm_bo_reserve_nolru(bo, false, true, false, 0);
1610 		if (!ret)
1611 			break;
1612 	}
1613 
1614 	if (ret) {
1615 		spin_unlock(&glob->lru_lock);
1616 		return ret;
1617 	}
1618 
1619 	kref_get(&bo->list_kref);
1620 
1621 	if (!list_empty(&bo->ddestroy)) {
1622 		ret = ttm_bo_cleanup_refs_and_unlock(bo, false, false);
1623 		kref_put(&bo->list_kref, ttm_bo_release_list);
1624 		return ret;
1625 	}
1626 
1627 	put_count = ttm_bo_del_from_lru(bo);
1628 	spin_unlock(&glob->lru_lock);
1629 
1630 	ttm_bo_list_ref_sub(bo, put_count, true);
1631 
1632 	/**
1633 	 * Wait for GPU, then move to system cached.
1634 	 */
1635 
1636 	spin_lock(&bo->bdev->fence_lock);
1637 	ret = ttm_bo_wait(bo, false, false, false);
1638 	spin_unlock(&bo->bdev->fence_lock);
1639 
1640 	if (unlikely(ret != 0))
1641 		goto out;
1642 
1643 	if ((bo->mem.placement & swap_placement) != swap_placement) {
1644 		struct ttm_mem_reg evict_mem;
1645 
1646 		evict_mem = bo->mem;
1647 		evict_mem.mm_node = NULL;
1648 		evict_mem.placement = TTM_PL_FLAG_SYSTEM | TTM_PL_FLAG_CACHED;
1649 		evict_mem.mem_type = TTM_PL_SYSTEM;
1650 
1651 		ret = ttm_bo_handle_move_mem(bo, &evict_mem, true,
1652 					     false, false);
1653 		if (unlikely(ret != 0))
1654 			goto out;
1655 	}
1656 
1657 	ttm_bo_unmap_virtual(bo);
1658 
1659 	/**
1660 	 * Swap out. Buffer will be swapped in again as soon as
1661 	 * anyone tries to access a ttm page.
1662 	 */
1663 
1664 	if (bo->bdev->driver->swap_notify)
1665 		bo->bdev->driver->swap_notify(bo);
1666 
1667 	ret = ttm_tt_swapout(bo->ttm, bo->persistent_swap_storage);
1668 out:
1669 
1670 	/**
1671 	 *
1672 	 * Unreserve without putting on LRU to avoid swapping out an
1673 	 * already swapped buffer.
1674 	 */
1675 
1676 	ww_mutex_unlock(&bo->resv->lock);
1677 	kref_put(&bo->list_kref, ttm_bo_release_list);
1678 	return ret;
1679 }
1680 
1681 void ttm_bo_swapout_all(struct ttm_bo_device *bdev)
1682 {
1683 	while (ttm_bo_swapout(&bdev->glob->shrink) == 0)
1684 		;
1685 }
1686 EXPORT_SYMBOL(ttm_bo_swapout_all);
1687