1 /**************************************************************************
3 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
31 #include "ttm/ttm_module.h"
32 #include "ttm/ttm_bo_driver.h"
33 #include "ttm/ttm_placement.h"
34 #include <linux/jiffies.h>
35 #include <linux/slab.h>
36 #include <linux/sched.h>
38 #include <linux/file.h>
39 #include <linux/module.h>
41 #define TTM_ASSERT_LOCKED(param)
42 #define TTM_DEBUG(fmt, arg...)
43 #define TTM_BO_HASH_ORDER 13
45 static int ttm_bo_setup_vm(struct ttm_buffer_object *bo);
46 static void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
47 static int ttm_bo_swapout(struct ttm_mem_shrink *shrink);
49 static inline uint32_t ttm_bo_type_flags(unsigned type)
54 static void ttm_bo_release_list(struct kref *list_kref)
56 struct ttm_buffer_object *bo =
57 container_of(list_kref, struct ttm_buffer_object, list_kref);
58 struct ttm_bo_device *bdev = bo->bdev;
60 BUG_ON(atomic_read(&bo->list_kref.refcount));
61 BUG_ON(atomic_read(&bo->kref.refcount));
62 BUG_ON(atomic_read(&bo->cpu_writers));
63 BUG_ON(bo->sync_obj != NULL);
64 BUG_ON(bo->mem.mm_node != NULL);
65 BUG_ON(!list_empty(&bo->lru));
66 BUG_ON(!list_empty(&bo->ddestroy));
69 ttm_tt_destroy(bo->ttm);
73 ttm_mem_global_free(bdev->mem_glob, bo->acc_size, false);
78 int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo, bool interruptible)
84 ret = wait_event_interruptible(bo->event_queue,
85 atomic_read(&bo->reserved) == 0);
86 if (unlikely(ret != 0))
89 wait_event(bo->event_queue, atomic_read(&bo->reserved) == 0);
94 static void ttm_bo_add_to_lru(struct ttm_buffer_object *bo)
96 struct ttm_bo_device *bdev = bo->bdev;
97 struct ttm_mem_type_manager *man;
99 BUG_ON(!atomic_read(&bo->reserved));
101 if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) {
103 BUG_ON(!list_empty(&bo->lru));
105 man = &bdev->man[bo->mem.mem_type];
106 list_add_tail(&bo->lru, &man->lru);
107 kref_get(&bo->list_kref);
109 if (bo->ttm != NULL) {
110 list_add_tail(&bo->swap, &bdev->swap_lru);
111 kref_get(&bo->list_kref);
117 * Call with the lru_lock held.
120 static int ttm_bo_del_from_lru(struct ttm_buffer_object *bo)
124 if (!list_empty(&bo->swap)) {
125 list_del_init(&bo->swap);
128 if (!list_empty(&bo->lru)) {
129 list_del_init(&bo->lru);
134 * TODO: Add a driver hook to delete from
135 * driver-specific LRU's here.
141 int ttm_bo_reserve_locked(struct ttm_buffer_object *bo,
143 bool no_wait, bool use_sequence, uint32_t sequence)
145 struct ttm_bo_device *bdev = bo->bdev;
148 while (unlikely(atomic_cmpxchg(&bo->reserved, 0, 1) != 0)) {
149 if (use_sequence && bo->seq_valid &&
150 (sequence - bo->val_seq < (1 << 31))) {
157 spin_unlock(&bdev->lru_lock);
158 ret = ttm_bo_wait_unreserved(bo, interruptible);
159 spin_lock(&bdev->lru_lock);
166 bo->val_seq = sequence;
167 bo->seq_valid = true;
169 bo->seq_valid = false;
174 EXPORT_SYMBOL(ttm_bo_reserve);
176 static void ttm_bo_ref_bug(struct kref *list_kref)
181 int ttm_bo_reserve(struct ttm_buffer_object *bo,
183 bool no_wait, bool use_sequence, uint32_t sequence)
185 struct ttm_bo_device *bdev = bo->bdev;
189 spin_lock(&bdev->lru_lock);
190 ret = ttm_bo_reserve_locked(bo, interruptible, no_wait, use_sequence,
192 if (likely(ret == 0))
193 put_count = ttm_bo_del_from_lru(bo);
194 spin_unlock(&bdev->lru_lock);
197 kref_put(&bo->list_kref, ttm_bo_ref_bug);
202 void ttm_bo_unreserve(struct ttm_buffer_object *bo)
204 struct ttm_bo_device *bdev = bo->bdev;
206 spin_lock(&bdev->lru_lock);
207 ttm_bo_add_to_lru(bo);
208 atomic_set(&bo->reserved, 0);
209 wake_up_all(&bo->event_queue);
210 spin_unlock(&bdev->lru_lock);
212 EXPORT_SYMBOL(ttm_bo_unreserve);
215 * Call bo->mutex locked.
218 static int ttm_bo_add_ttm(struct ttm_buffer_object *bo, bool zero_alloc)
220 struct ttm_bo_device *bdev = bo->bdev;
222 uint32_t page_flags = 0;
224 TTM_ASSERT_LOCKED(&bo->mutex);
228 case ttm_bo_type_device:
230 page_flags |= TTM_PAGE_FLAG_ZERO_ALLOC;
231 case ttm_bo_type_kernel:
232 bo->ttm = ttm_tt_create(bdev, bo->num_pages << PAGE_SHIFT,
233 page_flags, bdev->dummy_read_page);
234 if (unlikely(bo->ttm == NULL))
237 case ttm_bo_type_user:
238 bo->ttm = ttm_tt_create(bdev, bo->num_pages << PAGE_SHIFT,
239 page_flags | TTM_PAGE_FLAG_USER,
240 bdev->dummy_read_page);
241 if (unlikely(bo->ttm == NULL))
245 ret = ttm_tt_set_user(bo->ttm, current,
246 bo->buffer_start, bo->num_pages);
247 if (unlikely(ret != 0))
248 ttm_tt_destroy(bo->ttm);
251 printk(KERN_ERR TTM_PFX "Illegal buffer object type\n");
259 static int ttm_bo_handle_move_mem(struct ttm_buffer_object *bo,
260 struct ttm_mem_reg *mem,
261 bool evict, bool interruptible, bool no_wait)
263 struct ttm_bo_device *bdev = bo->bdev;
264 bool old_is_pci = ttm_mem_reg_is_pci(bdev, &bo->mem);
265 bool new_is_pci = ttm_mem_reg_is_pci(bdev, mem);
266 struct ttm_mem_type_manager *old_man = &bdev->man[bo->mem.mem_type];
267 struct ttm_mem_type_manager *new_man = &bdev->man[mem->mem_type];
270 if (old_is_pci || new_is_pci ||
271 ((mem->placement & bo->mem.placement & TTM_PL_MASK_CACHING) == 0))
272 ttm_bo_unmap_virtual(bo);
275 * Create and bind a ttm if required.
278 if (!(new_man->flags & TTM_MEMTYPE_FLAG_FIXED) && (bo->ttm == NULL)) {
279 ret = ttm_bo_add_ttm(bo, false);
283 ret = ttm_tt_set_placement_caching(bo->ttm, mem->placement);
287 if (mem->mem_type != TTM_PL_SYSTEM) {
288 ret = ttm_tt_bind(bo->ttm, mem);
293 if (bo->mem.mem_type == TTM_PL_SYSTEM) {
295 struct ttm_mem_reg *old_mem = &bo->mem;
296 uint32_t save_flags = old_mem->placement;
300 ttm_flag_masked(&save_flags, mem->placement,
301 TTM_PL_MASK_MEMTYPE);
307 if (!(old_man->flags & TTM_MEMTYPE_FLAG_FIXED) &&
308 !(new_man->flags & TTM_MEMTYPE_FLAG_FIXED))
309 ret = ttm_bo_move_ttm(bo, evict, no_wait, mem);
310 else if (bdev->driver->move)
311 ret = bdev->driver->move(bo, evict, interruptible,
314 ret = ttm_bo_move_memcpy(bo, evict, no_wait, mem);
321 ret = bdev->driver->invalidate_caches(bdev, bo->mem.placement);
323 printk(KERN_ERR TTM_PFX "Can not flush read caches\n");
327 if (bo->mem.mm_node) {
328 spin_lock(&bo->lock);
329 bo->offset = (bo->mem.mm_node->start << PAGE_SHIFT) +
330 bdev->man[bo->mem.mem_type].gpu_offset;
331 bo->cur_placement = bo->mem.placement;
332 spin_unlock(&bo->lock);
338 new_man = &bdev->man[bo->mem.mem_type];
339 if ((new_man->flags & TTM_MEMTYPE_FLAG_FIXED) && bo->ttm) {
340 ttm_tt_unbind(bo->ttm);
341 ttm_tt_destroy(bo->ttm);
349 * If bo idle, remove from delayed- and lru lists, and unref.
350 * If not idle, and already on delayed list, do nothing.
351 * If not idle, and not on delayed list, put on delayed list,
352 * up the list_kref and schedule a delayed list check.
355 static int ttm_bo_cleanup_refs(struct ttm_buffer_object *bo, bool remove_all)
357 struct ttm_bo_device *bdev = bo->bdev;
358 struct ttm_bo_driver *driver = bdev->driver;
361 spin_lock(&bo->lock);
362 (void) ttm_bo_wait(bo, false, false, !remove_all);
367 spin_unlock(&bo->lock);
369 spin_lock(&bdev->lru_lock);
370 ret = ttm_bo_reserve_locked(bo, false, false, false, 0);
373 ttm_tt_unbind(bo->ttm);
375 if (!list_empty(&bo->ddestroy)) {
376 list_del_init(&bo->ddestroy);
377 kref_put(&bo->list_kref, ttm_bo_ref_bug);
379 if (bo->mem.mm_node) {
380 drm_mm_put_block(bo->mem.mm_node);
381 bo->mem.mm_node = NULL;
383 put_count = ttm_bo_del_from_lru(bo);
384 spin_unlock(&bdev->lru_lock);
386 atomic_set(&bo->reserved, 0);
389 kref_put(&bo->list_kref, ttm_bo_release_list);
394 spin_lock(&bdev->lru_lock);
395 if (list_empty(&bo->ddestroy)) {
396 void *sync_obj = bo->sync_obj;
397 void *sync_obj_arg = bo->sync_obj_arg;
399 kref_get(&bo->list_kref);
400 list_add_tail(&bo->ddestroy, &bdev->ddestroy);
401 spin_unlock(&bdev->lru_lock);
402 spin_unlock(&bo->lock);
405 driver->sync_obj_flush(sync_obj, sync_obj_arg);
406 schedule_delayed_work(&bdev->wq,
407 ((HZ / 100) < 1) ? 1 : HZ / 100);
411 spin_unlock(&bdev->lru_lock);
412 spin_unlock(&bo->lock);
420 * Traverse the delayed list, and call ttm_bo_cleanup_refs on all
421 * encountered buffers.
424 static int ttm_bo_delayed_delete(struct ttm_bo_device *bdev, bool remove_all)
426 struct ttm_buffer_object *entry, *nentry;
427 struct list_head *list, *next;
430 spin_lock(&bdev->lru_lock);
431 list_for_each_safe(list, next, &bdev->ddestroy) {
432 entry = list_entry(list, struct ttm_buffer_object, ddestroy);
436 * Protect the next list entry from destruction while we
437 * unlock the lru_lock.
440 if (next != &bdev->ddestroy) {
441 nentry = list_entry(next, struct ttm_buffer_object,
443 kref_get(&nentry->list_kref);
445 kref_get(&entry->list_kref);
447 spin_unlock(&bdev->lru_lock);
448 ret = ttm_bo_cleanup_refs(entry, remove_all);
449 kref_put(&entry->list_kref, ttm_bo_release_list);
451 spin_lock(&bdev->lru_lock);
453 bool next_onlist = !list_empty(next);
454 spin_unlock(&bdev->lru_lock);
455 kref_put(&nentry->list_kref, ttm_bo_release_list);
456 spin_lock(&bdev->lru_lock);
458 * Someone might have raced us and removed the
459 * next entry from the list. We don't bother restarting
469 ret = !list_empty(&bdev->ddestroy);
470 spin_unlock(&bdev->lru_lock);
475 static void ttm_bo_delayed_workqueue(struct work_struct *work)
477 struct ttm_bo_device *bdev =
478 container_of(work, struct ttm_bo_device, wq.work);
480 if (ttm_bo_delayed_delete(bdev, false)) {
481 schedule_delayed_work(&bdev->wq,
482 ((HZ / 100) < 1) ? 1 : HZ / 100);
486 static void ttm_bo_release(struct kref *kref)
488 struct ttm_buffer_object *bo =
489 container_of(kref, struct ttm_buffer_object, kref);
490 struct ttm_bo_device *bdev = bo->bdev;
492 if (likely(bo->vm_node != NULL)) {
493 rb_erase(&bo->vm_rb, &bdev->addr_space_rb);
494 drm_mm_put_block(bo->vm_node);
497 write_unlock(&bdev->vm_lock);
498 ttm_bo_cleanup_refs(bo, false);
499 kref_put(&bo->list_kref, ttm_bo_release_list);
500 write_lock(&bdev->vm_lock);
503 void ttm_bo_unref(struct ttm_buffer_object **p_bo)
505 struct ttm_buffer_object *bo = *p_bo;
506 struct ttm_bo_device *bdev = bo->bdev;
509 write_lock(&bdev->vm_lock);
510 kref_put(&bo->kref, ttm_bo_release);
511 write_unlock(&bdev->vm_lock);
513 EXPORT_SYMBOL(ttm_bo_unref);
515 static int ttm_bo_evict(struct ttm_buffer_object *bo, unsigned mem_type,
516 bool interruptible, bool no_wait)
519 struct ttm_bo_device *bdev = bo->bdev;
520 struct ttm_mem_reg evict_mem;
521 uint32_t proposed_placement;
523 if (bo->mem.mem_type != mem_type)
526 spin_lock(&bo->lock);
527 ret = ttm_bo_wait(bo, false, interruptible, no_wait);
528 spin_unlock(&bo->lock);
530 if (unlikely(ret != 0)) {
531 if (ret != -ERESTART) {
532 printk(KERN_ERR TTM_PFX
533 "Failed to expire sync object before "
534 "buffer eviction.\n");
539 BUG_ON(!atomic_read(&bo->reserved));
542 evict_mem.mm_node = NULL;
544 proposed_placement = bdev->driver->evict_flags(bo);
546 ret = ttm_bo_mem_space(bo, proposed_placement,
547 &evict_mem, interruptible, no_wait);
548 if (unlikely(ret != 0 && ret != -ERESTART))
549 ret = ttm_bo_mem_space(bo, TTM_PL_FLAG_SYSTEM,
550 &evict_mem, interruptible, no_wait);
553 if (ret != -ERESTART)
554 printk(KERN_ERR TTM_PFX
555 "Failed to find memory space for "
556 "buffer 0x%p eviction.\n", bo);
560 ret = ttm_bo_handle_move_mem(bo, &evict_mem, true, interruptible,
563 if (ret != -ERESTART)
564 printk(KERN_ERR TTM_PFX "Buffer eviction failed\n");
568 spin_lock(&bdev->lru_lock);
569 if (evict_mem.mm_node) {
570 drm_mm_put_block(evict_mem.mm_node);
571 evict_mem.mm_node = NULL;
573 spin_unlock(&bdev->lru_lock);
580 * Repeatedly evict memory from the LRU for @mem_type until we create enough
581 * space, or we've evicted everything and there isn't enough space.
583 static int ttm_bo_mem_force_space(struct ttm_bo_device *bdev,
584 struct ttm_mem_reg *mem,
586 bool interruptible, bool no_wait)
588 struct drm_mm_node *node;
589 struct ttm_buffer_object *entry;
590 struct ttm_mem_type_manager *man = &bdev->man[mem_type];
591 struct list_head *lru;
592 unsigned long num_pages = mem->num_pages;
597 ret = drm_mm_pre_get(&man->manager);
598 if (unlikely(ret != 0))
601 spin_lock(&bdev->lru_lock);
603 node = drm_mm_search_free(&man->manager, num_pages,
604 mem->page_alignment, 1);
612 entry = list_first_entry(lru, struct ttm_buffer_object, lru);
613 kref_get(&entry->list_kref);
616 ttm_bo_reserve_locked(entry, interruptible, no_wait,
619 if (likely(ret == 0))
620 put_count = ttm_bo_del_from_lru(entry);
622 spin_unlock(&bdev->lru_lock);
624 if (unlikely(ret != 0))
628 kref_put(&entry->list_kref, ttm_bo_ref_bug);
630 ret = ttm_bo_evict(entry, mem_type, interruptible, no_wait);
632 ttm_bo_unreserve(entry);
634 kref_put(&entry->list_kref, ttm_bo_release_list);
638 spin_lock(&bdev->lru_lock);
642 spin_unlock(&bdev->lru_lock);
646 node = drm_mm_get_block_atomic(node, num_pages, mem->page_alignment);
647 if (unlikely(!node)) {
648 spin_unlock(&bdev->lru_lock);
652 spin_unlock(&bdev->lru_lock);
654 mem->mem_type = mem_type;
658 static uint32_t ttm_bo_select_caching(struct ttm_mem_type_manager *man,
659 uint32_t cur_placement,
660 uint32_t proposed_placement)
662 uint32_t caching = proposed_placement & TTM_PL_MASK_CACHING;
663 uint32_t result = proposed_placement & ~TTM_PL_MASK_CACHING;
666 * Keep current caching if possible.
669 if ((cur_placement & caching) != 0)
670 result |= (cur_placement & caching);
671 else if ((man->default_caching & caching) != 0)
672 result |= man->default_caching;
673 else if ((TTM_PL_FLAG_CACHED & caching) != 0)
674 result |= TTM_PL_FLAG_CACHED;
675 else if ((TTM_PL_FLAG_WC & caching) != 0)
676 result |= TTM_PL_FLAG_WC;
677 else if ((TTM_PL_FLAG_UNCACHED & caching) != 0)
678 result |= TTM_PL_FLAG_UNCACHED;
684 static bool ttm_bo_mt_compatible(struct ttm_mem_type_manager *man,
687 uint32_t proposed_placement,
688 uint32_t *masked_placement)
690 uint32_t cur_flags = ttm_bo_type_flags(mem_type);
692 if ((man->flags & TTM_MEMTYPE_FLAG_FIXED) && disallow_fixed)
695 if ((cur_flags & proposed_placement & TTM_PL_MASK_MEM) == 0)
698 if ((proposed_placement & man->available_caching) == 0)
701 cur_flags |= (proposed_placement & man->available_caching);
703 *masked_placement = cur_flags;
708 * Creates space for memory region @mem according to its type.
710 * This function first searches for free space in compatible memory types in
711 * the priority order defined by the driver. If free space isn't found, then
712 * ttm_bo_mem_force_space is attempted in priority order to evict and find
715 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
716 uint32_t proposed_placement,
717 struct ttm_mem_reg *mem,
718 bool interruptible, bool no_wait)
720 struct ttm_bo_device *bdev = bo->bdev;
721 struct ttm_mem_type_manager *man;
723 uint32_t num_prios = bdev->driver->num_mem_type_prio;
724 const uint32_t *prios = bdev->driver->mem_type_prio;
726 uint32_t mem_type = TTM_PL_SYSTEM;
727 uint32_t cur_flags = 0;
728 bool type_found = false;
729 bool type_ok = false;
730 bool has_eagain = false;
731 struct drm_mm_node *node = NULL;
735 for (i = 0; i < num_prios; ++i) {
737 man = &bdev->man[mem_type];
739 type_ok = ttm_bo_mt_compatible(man,
740 bo->type == ttm_bo_type_user,
741 mem_type, proposed_placement,
747 cur_flags = ttm_bo_select_caching(man, bo->mem.placement,
750 if (mem_type == TTM_PL_SYSTEM)
753 if (man->has_type && man->use_type) {
756 ret = drm_mm_pre_get(&man->manager);
760 spin_lock(&bdev->lru_lock);
761 node = drm_mm_search_free(&man->manager,
765 if (unlikely(!node)) {
766 spin_unlock(&bdev->lru_lock);
769 node = drm_mm_get_block_atomic(node,
773 spin_unlock(&bdev->lru_lock);
780 if ((type_ok && (mem_type == TTM_PL_SYSTEM)) || node) {
782 mem->mem_type = mem_type;
783 mem->placement = cur_flags;
790 num_prios = bdev->driver->num_mem_busy_prio;
791 prios = bdev->driver->mem_busy_prio;
793 for (i = 0; i < num_prios; ++i) {
795 man = &bdev->man[mem_type];
800 if (!ttm_bo_mt_compatible(man,
801 bo->type == ttm_bo_type_user,
803 proposed_placement, &cur_flags))
806 cur_flags = ttm_bo_select_caching(man, bo->mem.placement,
809 ret = ttm_bo_mem_force_space(bdev, mem, mem_type,
810 interruptible, no_wait);
812 if (ret == 0 && mem->mm_node) {
813 mem->placement = cur_flags;
817 if (ret == -ERESTART)
821 ret = (has_eagain) ? -ERESTART : -ENOMEM;
824 EXPORT_SYMBOL(ttm_bo_mem_space);
826 int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait)
830 if ((atomic_read(&bo->cpu_writers) > 0) && no_wait)
833 ret = wait_event_interruptible(bo->event_queue,
834 atomic_read(&bo->cpu_writers) == 0);
836 if (ret == -ERESTARTSYS)
842 int ttm_bo_move_buffer(struct ttm_buffer_object *bo,
843 uint32_t proposed_placement,
844 bool interruptible, bool no_wait)
846 struct ttm_bo_device *bdev = bo->bdev;
848 struct ttm_mem_reg mem;
850 BUG_ON(!atomic_read(&bo->reserved));
853 * FIXME: It's possible to pipeline buffer moves.
854 * Have the driver move function wait for idle when necessary,
855 * instead of doing it here.
858 spin_lock(&bo->lock);
859 ret = ttm_bo_wait(bo, false, interruptible, no_wait);
860 spin_unlock(&bo->lock);
865 mem.num_pages = bo->num_pages;
866 mem.size = mem.num_pages << PAGE_SHIFT;
867 mem.page_alignment = bo->mem.page_alignment;
870 * Determine where to move the buffer.
873 ret = ttm_bo_mem_space(bo, proposed_placement, &mem,
874 interruptible, no_wait);
878 ret = ttm_bo_handle_move_mem(bo, &mem, false, interruptible, no_wait);
881 if (ret && mem.mm_node) {
882 spin_lock(&bdev->lru_lock);
883 drm_mm_put_block(mem.mm_node);
884 spin_unlock(&bdev->lru_lock);
889 static int ttm_bo_mem_compat(uint32_t proposed_placement,
890 struct ttm_mem_reg *mem)
892 if ((proposed_placement & mem->placement & TTM_PL_MASK_MEM) == 0)
894 if ((proposed_placement & mem->placement & TTM_PL_MASK_CACHING) == 0)
900 int ttm_buffer_object_validate(struct ttm_buffer_object *bo,
901 uint32_t proposed_placement,
902 bool interruptible, bool no_wait)
906 BUG_ON(!atomic_read(&bo->reserved));
907 bo->proposed_placement = proposed_placement;
909 TTM_DEBUG("Proposed placement 0x%08lx, Old flags 0x%08lx\n",
910 (unsigned long)proposed_placement,
911 (unsigned long)bo->mem.placement);
914 * Check whether we need to move buffer.
917 if (!ttm_bo_mem_compat(bo->proposed_placement, &bo->mem)) {
918 ret = ttm_bo_move_buffer(bo, bo->proposed_placement,
919 interruptible, no_wait);
921 if (ret != -ERESTART)
922 printk(KERN_ERR TTM_PFX
923 "Failed moving buffer. "
924 "Proposed placement 0x%08x\n",
925 bo->proposed_placement);
927 printk(KERN_ERR TTM_PFX
928 "Out of aperture space or "
929 "DRM memory quota.\n");
935 * We might need to add a TTM.
938 if (bo->mem.mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
939 ret = ttm_bo_add_ttm(bo, true);
944 * Validation has succeeded, move the access and other
945 * non-mapping-related flag bits from the proposed flags to
949 ttm_flag_masked(&bo->mem.placement, bo->proposed_placement,
950 ~TTM_PL_MASK_MEMTYPE);
954 EXPORT_SYMBOL(ttm_buffer_object_validate);
957 ttm_bo_check_placement(struct ttm_buffer_object *bo,
958 uint32_t set_flags, uint32_t clr_flags)
960 uint32_t new_mask = set_flags | clr_flags;
962 if ((bo->type == ttm_bo_type_user) &&
963 (clr_flags & TTM_PL_FLAG_CACHED)) {
964 printk(KERN_ERR TTM_PFX
965 "User buffers require cache-coherent memory.\n");
969 if (!capable(CAP_SYS_ADMIN)) {
970 if (new_mask & TTM_PL_FLAG_NO_EVICT) {
971 printk(KERN_ERR TTM_PFX "Need to be root to modify"
972 " NO_EVICT status.\n");
976 if ((clr_flags & bo->mem.placement & TTM_PL_MASK_MEMTYPE) &&
977 (bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) {
978 printk(KERN_ERR TTM_PFX
979 "Incompatible memory specification"
980 " for NO_EVICT buffer.\n");
987 int ttm_buffer_object_init(struct ttm_bo_device *bdev,
988 struct ttm_buffer_object *bo,
990 enum ttm_bo_type type,
992 uint32_t page_alignment,
993 unsigned long buffer_start,
995 struct file *persistant_swap_storage,
997 void (*destroy) (struct ttm_buffer_object *))
1000 unsigned long num_pages;
1002 size += buffer_start & ~PAGE_MASK;
1003 num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1004 if (num_pages == 0) {
1005 printk(KERN_ERR TTM_PFX "Illegal buffer object size.\n");
1008 bo->destroy = destroy;
1010 spin_lock_init(&bo->lock);
1011 kref_init(&bo->kref);
1012 kref_init(&bo->list_kref);
1013 atomic_set(&bo->cpu_writers, 0);
1014 atomic_set(&bo->reserved, 1);
1015 init_waitqueue_head(&bo->event_queue);
1016 INIT_LIST_HEAD(&bo->lru);
1017 INIT_LIST_HEAD(&bo->ddestroy);
1018 INIT_LIST_HEAD(&bo->swap);
1021 bo->num_pages = num_pages;
1022 bo->mem.mem_type = TTM_PL_SYSTEM;
1023 bo->mem.num_pages = bo->num_pages;
1024 bo->mem.mm_node = NULL;
1025 bo->mem.page_alignment = page_alignment;
1026 bo->buffer_start = buffer_start & PAGE_MASK;
1028 bo->mem.placement = (TTM_PL_FLAG_SYSTEM | TTM_PL_FLAG_CACHED);
1029 bo->seq_valid = false;
1030 bo->persistant_swap_storage = persistant_swap_storage;
1031 bo->acc_size = acc_size;
1033 ret = ttm_bo_check_placement(bo, flags, 0ULL);
1034 if (unlikely(ret != 0))
1038 * If no caching attributes are set, accept any form of caching.
1041 if ((flags & TTM_PL_MASK_CACHING) == 0)
1042 flags |= TTM_PL_MASK_CACHING;
1045 * For ttm_bo_type_device buffers, allocate
1046 * address space from the device.
1049 if (bo->type == ttm_bo_type_device) {
1050 ret = ttm_bo_setup_vm(bo);
1055 ret = ttm_buffer_object_validate(bo, flags, interruptible, false);
1059 ttm_bo_unreserve(bo);
1063 ttm_bo_unreserve(bo);
1068 EXPORT_SYMBOL(ttm_buffer_object_init);
1070 static inline size_t ttm_bo_size(struct ttm_bo_device *bdev,
1071 unsigned long num_pages)
1073 size_t page_array_size = (num_pages * sizeof(void *) + PAGE_SIZE - 1) &
1076 return bdev->ttm_bo_size + 2 * page_array_size;
1079 int ttm_buffer_object_create(struct ttm_bo_device *bdev,
1081 enum ttm_bo_type type,
1083 uint32_t page_alignment,
1084 unsigned long buffer_start,
1086 struct file *persistant_swap_storage,
1087 struct ttm_buffer_object **p_bo)
1089 struct ttm_buffer_object *bo;
1091 struct ttm_mem_global *mem_glob = bdev->mem_glob;
1094 ttm_bo_size(bdev, (size + PAGE_SIZE - 1) >> PAGE_SHIFT);
1095 ret = ttm_mem_global_alloc(mem_glob, acc_size, false, false, false);
1096 if (unlikely(ret != 0))
1099 bo = kzalloc(sizeof(*bo), GFP_KERNEL);
1101 if (unlikely(bo == NULL)) {
1102 ttm_mem_global_free(mem_glob, acc_size, false);
1106 ret = ttm_buffer_object_init(bdev, bo, size, type, flags,
1107 page_alignment, buffer_start,
1109 persistant_swap_storage, acc_size, NULL);
1110 if (likely(ret == 0))
1116 static int ttm_bo_leave_list(struct ttm_buffer_object *bo,
1117 uint32_t mem_type, bool allow_errors)
1121 spin_lock(&bo->lock);
1122 ret = ttm_bo_wait(bo, false, false, false);
1123 spin_unlock(&bo->lock);
1125 if (ret && allow_errors)
1128 if (bo->mem.mem_type == mem_type)
1129 ret = ttm_bo_evict(bo, mem_type, false, false);
1136 printk(KERN_ERR TTM_PFX "Cleanup eviction failed\n");
1144 static int ttm_bo_force_list_clean(struct ttm_bo_device *bdev,
1145 struct list_head *head,
1146 unsigned mem_type, bool allow_errors)
1148 struct ttm_buffer_object *entry;
1153 * Can't use standard list traversal since we're unlocking.
1156 spin_lock(&bdev->lru_lock);
1158 while (!list_empty(head)) {
1159 entry = list_first_entry(head, struct ttm_buffer_object, lru);
1160 kref_get(&entry->list_kref);
1161 ret = ttm_bo_reserve_locked(entry, false, false, false, 0);
1162 put_count = ttm_bo_del_from_lru(entry);
1163 spin_unlock(&bdev->lru_lock);
1165 kref_put(&entry->list_kref, ttm_bo_ref_bug);
1167 ret = ttm_bo_leave_list(entry, mem_type, allow_errors);
1168 ttm_bo_unreserve(entry);
1169 kref_put(&entry->list_kref, ttm_bo_release_list);
1170 spin_lock(&bdev->lru_lock);
1173 spin_unlock(&bdev->lru_lock);
1178 int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type)
1180 struct ttm_mem_type_manager *man = &bdev->man[mem_type];
1183 if (mem_type >= TTM_NUM_MEM_TYPES) {
1184 printk(KERN_ERR TTM_PFX "Illegal memory type %d\n", mem_type);
1188 if (!man->has_type) {
1189 printk(KERN_ERR TTM_PFX "Trying to take down uninitialized "
1190 "memory manager type %u\n", mem_type);
1194 man->use_type = false;
1195 man->has_type = false;
1199 ttm_bo_force_list_clean(bdev, &man->lru, mem_type, false);
1201 spin_lock(&bdev->lru_lock);
1202 if (drm_mm_clean(&man->manager))
1203 drm_mm_takedown(&man->manager);
1207 spin_unlock(&bdev->lru_lock);
1212 EXPORT_SYMBOL(ttm_bo_clean_mm);
1214 int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type)
1216 struct ttm_mem_type_manager *man = &bdev->man[mem_type];
1218 if (mem_type == 0 || mem_type >= TTM_NUM_MEM_TYPES) {
1219 printk(KERN_ERR TTM_PFX
1220 "Illegal memory manager memory type %u.\n",
1225 if (!man->has_type) {
1226 printk(KERN_ERR TTM_PFX
1227 "Memory type %u has not been initialized.\n",
1232 return ttm_bo_force_list_clean(bdev, &man->lru, mem_type, true);
1234 EXPORT_SYMBOL(ttm_bo_evict_mm);
1236 int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
1237 unsigned long p_offset, unsigned long p_size)
1240 struct ttm_mem_type_manager *man;
1242 if (type >= TTM_NUM_MEM_TYPES) {
1243 printk(KERN_ERR TTM_PFX "Illegal memory type %d\n", type);
1247 man = &bdev->man[type];
1248 if (man->has_type) {
1249 printk(KERN_ERR TTM_PFX
1250 "Memory manager already initialized for type %d\n",
1255 ret = bdev->driver->init_mem_type(bdev, type, man);
1260 if (type != TTM_PL_SYSTEM) {
1262 printk(KERN_ERR TTM_PFX
1263 "Zero size memory manager type %d\n",
1267 ret = drm_mm_init(&man->manager, p_offset, p_size);
1271 man->has_type = true;
1272 man->use_type = true;
1275 INIT_LIST_HEAD(&man->lru);
1279 EXPORT_SYMBOL(ttm_bo_init_mm);
1281 int ttm_bo_device_release(struct ttm_bo_device *bdev)
1284 unsigned i = TTM_NUM_MEM_TYPES;
1285 struct ttm_mem_type_manager *man;
1288 man = &bdev->man[i];
1289 if (man->has_type) {
1290 man->use_type = false;
1291 if ((i != TTM_PL_SYSTEM) && ttm_bo_clean_mm(bdev, i)) {
1293 printk(KERN_ERR TTM_PFX
1294 "DRM memory manager type %d "
1295 "is not clean.\n", i);
1297 man->has_type = false;
1301 if (!cancel_delayed_work(&bdev->wq))
1302 flush_scheduled_work();
1304 while (ttm_bo_delayed_delete(bdev, true))
1307 spin_lock(&bdev->lru_lock);
1308 if (list_empty(&bdev->ddestroy))
1309 TTM_DEBUG("Delayed destroy list was clean\n");
1311 if (list_empty(&bdev->man[0].lru))
1312 TTM_DEBUG("Swap list was clean\n");
1313 spin_unlock(&bdev->lru_lock);
1315 ttm_mem_unregister_shrink(bdev->mem_glob, &bdev->shrink);
1316 BUG_ON(!drm_mm_clean(&bdev->addr_space_mm));
1317 write_lock(&bdev->vm_lock);
1318 drm_mm_takedown(&bdev->addr_space_mm);
1319 write_unlock(&bdev->vm_lock);
1321 __free_page(bdev->dummy_read_page);
1324 EXPORT_SYMBOL(ttm_bo_device_release);
1327 * This function is intended to be called on drm driver load.
1328 * If you decide to call it from firstopen, you must protect the call
1329 * from a potentially racing ttm_bo_driver_finish in lastclose.
1330 * (This may happen on X server restart).
1333 int ttm_bo_device_init(struct ttm_bo_device *bdev,
1334 struct ttm_mem_global *mem_glob,
1335 struct ttm_bo_driver *driver, uint64_t file_page_offset)
1339 bdev->dummy_read_page = NULL;
1340 rwlock_init(&bdev->vm_lock);
1341 spin_lock_init(&bdev->lru_lock);
1343 bdev->driver = driver;
1344 bdev->mem_glob = mem_glob;
1346 memset(bdev->man, 0, sizeof(bdev->man));
1348 bdev->dummy_read_page = alloc_page(__GFP_ZERO | GFP_DMA32);
1349 if (unlikely(bdev->dummy_read_page == NULL)) {
1355 * Initialize the system memory buffer type.
1356 * Other types need to be driver / IOCTL initialized.
1358 ret = ttm_bo_init_mm(bdev, TTM_PL_SYSTEM, 0, 0);
1359 if (unlikely(ret != 0))
1362 bdev->addr_space_rb = RB_ROOT;
1363 ret = drm_mm_init(&bdev->addr_space_mm, file_page_offset, 0x10000000);
1364 if (unlikely(ret != 0))
1367 INIT_DELAYED_WORK(&bdev->wq, ttm_bo_delayed_workqueue);
1368 bdev->nice_mode = true;
1369 INIT_LIST_HEAD(&bdev->ddestroy);
1370 INIT_LIST_HEAD(&bdev->swap_lru);
1371 bdev->dev_mapping = NULL;
1372 ttm_mem_init_shrink(&bdev->shrink, ttm_bo_swapout);
1373 ret = ttm_mem_register_shrink(mem_glob, &bdev->shrink);
1374 if (unlikely(ret != 0)) {
1375 printk(KERN_ERR TTM_PFX
1376 "Could not register buffer object swapout.\n");
1380 bdev->ttm_bo_extra_size =
1381 ttm_round_pot(sizeof(struct ttm_tt)) +
1382 ttm_round_pot(sizeof(struct ttm_backend));
1384 bdev->ttm_bo_size = bdev->ttm_bo_extra_size +
1385 ttm_round_pot(sizeof(struct ttm_buffer_object));
1389 ttm_bo_clean_mm(bdev, 0);
1391 __free_page(bdev->dummy_read_page);
1395 EXPORT_SYMBOL(ttm_bo_device_init);
1398 * buffer object vm functions.
1401 bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem)
1403 struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
1405 if (!(man->flags & TTM_MEMTYPE_FLAG_FIXED)) {
1406 if (mem->mem_type == TTM_PL_SYSTEM)
1409 if (man->flags & TTM_MEMTYPE_FLAG_CMA)
1412 if (mem->placement & TTM_PL_FLAG_CACHED)
1418 int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
1419 struct ttm_mem_reg *mem,
1420 unsigned long *bus_base,
1421 unsigned long *bus_offset, unsigned long *bus_size)
1423 struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
1426 if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
1429 if (ttm_mem_reg_is_pci(bdev, mem)) {
1430 *bus_offset = mem->mm_node->start << PAGE_SHIFT;
1431 *bus_size = mem->num_pages << PAGE_SHIFT;
1432 *bus_base = man->io_offset;
1438 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo)
1440 struct ttm_bo_device *bdev = bo->bdev;
1441 loff_t offset = (loff_t) bo->addr_space_offset;
1442 loff_t holelen = ((loff_t) bo->mem.num_pages) << PAGE_SHIFT;
1444 if (!bdev->dev_mapping)
1447 unmap_mapping_range(bdev->dev_mapping, offset, holelen, 1);
1450 static void ttm_bo_vm_insert_rb(struct ttm_buffer_object *bo)
1452 struct ttm_bo_device *bdev = bo->bdev;
1453 struct rb_node **cur = &bdev->addr_space_rb.rb_node;
1454 struct rb_node *parent = NULL;
1455 struct ttm_buffer_object *cur_bo;
1456 unsigned long offset = bo->vm_node->start;
1457 unsigned long cur_offset;
1461 cur_bo = rb_entry(parent, struct ttm_buffer_object, vm_rb);
1462 cur_offset = cur_bo->vm_node->start;
1463 if (offset < cur_offset)
1464 cur = &parent->rb_left;
1465 else if (offset > cur_offset)
1466 cur = &parent->rb_right;
1471 rb_link_node(&bo->vm_rb, parent, cur);
1472 rb_insert_color(&bo->vm_rb, &bdev->addr_space_rb);
1478 * @bo: the buffer to allocate address space for
1480 * Allocate address space in the drm device so that applications
1481 * can mmap the buffer and access the contents. This only
1482 * applies to ttm_bo_type_device objects as others are not
1483 * placed in the drm device address space.
1486 static int ttm_bo_setup_vm(struct ttm_buffer_object *bo)
1488 struct ttm_bo_device *bdev = bo->bdev;
1492 ret = drm_mm_pre_get(&bdev->addr_space_mm);
1493 if (unlikely(ret != 0))
1496 write_lock(&bdev->vm_lock);
1497 bo->vm_node = drm_mm_search_free(&bdev->addr_space_mm,
1498 bo->mem.num_pages, 0, 0);
1500 if (unlikely(bo->vm_node == NULL)) {
1505 bo->vm_node = drm_mm_get_block_atomic(bo->vm_node,
1506 bo->mem.num_pages, 0);
1508 if (unlikely(bo->vm_node == NULL)) {
1509 write_unlock(&bdev->vm_lock);
1513 ttm_bo_vm_insert_rb(bo);
1514 write_unlock(&bdev->vm_lock);
1515 bo->addr_space_offset = ((uint64_t) bo->vm_node->start) << PAGE_SHIFT;
1519 write_unlock(&bdev->vm_lock);
1523 int ttm_bo_wait(struct ttm_buffer_object *bo,
1524 bool lazy, bool interruptible, bool no_wait)
1526 struct ttm_bo_driver *driver = bo->bdev->driver;
1531 if (likely(bo->sync_obj == NULL))
1534 while (bo->sync_obj) {
1536 if (driver->sync_obj_signaled(bo->sync_obj, bo->sync_obj_arg)) {
1537 void *tmp_obj = bo->sync_obj;
1538 bo->sync_obj = NULL;
1539 clear_bit(TTM_BO_PRIV_FLAG_MOVING, &bo->priv_flags);
1540 spin_unlock(&bo->lock);
1541 driver->sync_obj_unref(&tmp_obj);
1542 spin_lock(&bo->lock);
1549 sync_obj = driver->sync_obj_ref(bo->sync_obj);
1550 sync_obj_arg = bo->sync_obj_arg;
1551 spin_unlock(&bo->lock);
1552 ret = driver->sync_obj_wait(sync_obj, sync_obj_arg,
1553 lazy, interruptible);
1554 if (unlikely(ret != 0)) {
1555 driver->sync_obj_unref(&sync_obj);
1556 spin_lock(&bo->lock);
1559 spin_lock(&bo->lock);
1560 if (likely(bo->sync_obj == sync_obj &&
1561 bo->sync_obj_arg == sync_obj_arg)) {
1562 void *tmp_obj = bo->sync_obj;
1563 bo->sync_obj = NULL;
1564 clear_bit(TTM_BO_PRIV_FLAG_MOVING,
1566 spin_unlock(&bo->lock);
1567 driver->sync_obj_unref(&sync_obj);
1568 driver->sync_obj_unref(&tmp_obj);
1569 spin_lock(&bo->lock);
1574 EXPORT_SYMBOL(ttm_bo_wait);
1576 void ttm_bo_unblock_reservation(struct ttm_buffer_object *bo)
1578 atomic_set(&bo->reserved, 0);
1579 wake_up_all(&bo->event_queue);
1582 int ttm_bo_block_reservation(struct ttm_buffer_object *bo, bool interruptible,
1587 while (unlikely(atomic_cmpxchg(&bo->reserved, 0, 1) != 0)) {
1590 else if (interruptible) {
1591 ret = wait_event_interruptible
1592 (bo->event_queue, atomic_read(&bo->reserved) == 0);
1593 if (unlikely(ret != 0))
1596 wait_event(bo->event_queue,
1597 atomic_read(&bo->reserved) == 0);
1603 int ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait)
1608 * Using ttm_bo_reserve instead of ttm_bo_block_reservation
1609 * makes sure the lru lists are updated.
1612 ret = ttm_bo_reserve(bo, true, no_wait, false, 0);
1613 if (unlikely(ret != 0))
1615 spin_lock(&bo->lock);
1616 ret = ttm_bo_wait(bo, false, true, no_wait);
1617 spin_unlock(&bo->lock);
1618 if (likely(ret == 0))
1619 atomic_inc(&bo->cpu_writers);
1620 ttm_bo_unreserve(bo);
1624 void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo)
1626 if (atomic_dec_and_test(&bo->cpu_writers))
1627 wake_up_all(&bo->event_queue);
1631 * A buffer object shrink method that tries to swap out the first
1632 * buffer object on the bo_global::swap_lru list.
1635 static int ttm_bo_swapout(struct ttm_mem_shrink *shrink)
1637 struct ttm_bo_device *bdev =
1638 container_of(shrink, struct ttm_bo_device, shrink);
1639 struct ttm_buffer_object *bo;
1642 uint32_t swap_placement = (TTM_PL_FLAG_CACHED | TTM_PL_FLAG_SYSTEM);
1644 spin_lock(&bdev->lru_lock);
1645 while (ret == -EBUSY) {
1646 if (unlikely(list_empty(&bdev->swap_lru))) {
1647 spin_unlock(&bdev->lru_lock);
1651 bo = list_first_entry(&bdev->swap_lru,
1652 struct ttm_buffer_object, swap);
1653 kref_get(&bo->list_kref);
1656 * Reserve buffer. Since we unlock while sleeping, we need
1657 * to re-check that nobody removed us from the swap-list while
1661 ret = ttm_bo_reserve_locked(bo, false, true, false, 0);
1662 if (unlikely(ret == -EBUSY)) {
1663 spin_unlock(&bdev->lru_lock);
1664 ttm_bo_wait_unreserved(bo, false);
1665 kref_put(&bo->list_kref, ttm_bo_release_list);
1666 spin_lock(&bdev->lru_lock);
1671 put_count = ttm_bo_del_from_lru(bo);
1672 spin_unlock(&bdev->lru_lock);
1675 kref_put(&bo->list_kref, ttm_bo_ref_bug);
1678 * Wait for GPU, then move to system cached.
1681 spin_lock(&bo->lock);
1682 ret = ttm_bo_wait(bo, false, false, false);
1683 spin_unlock(&bo->lock);
1685 if (unlikely(ret != 0))
1688 if ((bo->mem.placement & swap_placement) != swap_placement) {
1689 struct ttm_mem_reg evict_mem;
1691 evict_mem = bo->mem;
1692 evict_mem.mm_node = NULL;
1693 evict_mem.placement = TTM_PL_FLAG_SYSTEM | TTM_PL_FLAG_CACHED;
1694 evict_mem.mem_type = TTM_PL_SYSTEM;
1696 ret = ttm_bo_handle_move_mem(bo, &evict_mem, true,
1698 if (unlikely(ret != 0))
1702 ttm_bo_unmap_virtual(bo);
1705 * Swap out. Buffer will be swapped in again as soon as
1706 * anyone tries to access a ttm page.
1709 ret = ttm_tt_swapout(bo->ttm, bo->persistant_swap_storage);
1714 * Unreserve without putting on LRU to avoid swapping out an
1715 * already swapped buffer.
1718 atomic_set(&bo->reserved, 0);
1719 wake_up_all(&bo->event_queue);
1720 kref_put(&bo->list_kref, ttm_bo_release_list);
1724 void ttm_bo_swapout_all(struct ttm_bo_device *bdev)
1726 while (ttm_bo_swapout(&bdev->shrink) == 0)