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