2 * Copyright © 2016 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
28 #include "intel_ringbuffer.h"
29 #include "intel_frontbuffer.h"
31 #include <drm/drm_gem.h>
34 i915_vma_retire(struct i915_gem_active *active,
35 struct drm_i915_gem_request *rq)
37 const unsigned int idx = rq->engine->id;
38 struct i915_vma *vma =
39 container_of(active, struct i915_vma, last_read[idx]);
40 struct drm_i915_gem_object *obj = vma->obj;
42 GEM_BUG_ON(!i915_vma_has_active_engine(vma, idx));
44 i915_vma_clear_active(vma, idx);
45 if (i915_vma_is_active(vma))
48 list_move_tail(&vma->vm_link, &vma->vm->inactive_list);
49 if (unlikely(i915_vma_is_closed(vma) && !i915_vma_is_pinned(vma)))
50 WARN_ON(i915_vma_unbind(vma));
52 GEM_BUG_ON(!i915_gem_object_is_active(obj));
53 if (--obj->active_count)
56 /* Bump our place on the bound list to keep it roughly in LRU order
57 * so that we don't steal from recently used but inactive objects
58 * (unless we are forced to ofc!)
61 list_move_tail(&obj->global_link, &rq->i915->mm.bound_list);
63 obj->mm.dirty = true; /* be paranoid */
65 if (i915_gem_object_has_active_reference(obj)) {
66 i915_gem_object_clear_active_reference(obj);
67 i915_gem_object_put(obj);
71 static struct i915_vma *
72 __i915_vma_create(struct drm_i915_gem_object *obj,
73 struct i915_address_space *vm,
74 const struct i915_ggtt_view *view)
77 struct rb_node *rb, **p;
80 GEM_BUG_ON(vm->closed);
82 vma = kmem_cache_zalloc(to_i915(obj->base.dev)->vmas, GFP_KERNEL);
84 return ERR_PTR(-ENOMEM);
86 INIT_LIST_HEAD(&vma->exec_list);
87 for (i = 0; i < ARRAY_SIZE(vma->last_read); i++)
88 init_request_active(&vma->last_read[i], i915_vma_retire);
89 init_request_active(&vma->last_fence, NULL);
90 list_add(&vma->vm_link, &vm->unbound_list);
93 vma->size = obj->base.size;
96 vma->ggtt_view = *view;
97 if (view->type == I915_GGTT_VIEW_PARTIAL) {
98 vma->size = view->params.partial.size;
99 vma->size <<= PAGE_SHIFT;
100 } else if (view->type == I915_GGTT_VIEW_ROTATED) {
102 intel_rotation_info_size(&view->params.rotated);
103 vma->size <<= PAGE_SHIFT;
107 if (i915_is_ggtt(vm)) {
108 vma->flags |= I915_VMA_GGTT;
109 list_add(&vma->obj_link, &obj->vma_list);
111 i915_ppgtt_get(i915_vm_to_ppgtt(vm));
112 list_add_tail(&vma->obj_link, &obj->vma_list);
116 p = &obj->vma_tree.rb_node;
118 struct i915_vma *pos;
121 pos = rb_entry(rb, struct i915_vma, obj_node);
122 if (i915_vma_compare(pos, vm, view) < 0)
127 rb_link_node(&vma->obj_node, rb, p);
128 rb_insert_color(&vma->obj_node, &obj->vma_tree);
134 i915_vma_create(struct drm_i915_gem_object *obj,
135 struct i915_address_space *vm,
136 const struct i915_ggtt_view *view)
138 lockdep_assert_held(&obj->base.dev->struct_mutex);
139 GEM_BUG_ON(view && !i915_is_ggtt(vm));
140 GEM_BUG_ON(i915_gem_obj_to_vma(obj, vm, view));
142 return __i915_vma_create(obj, vm, view);
146 * i915_vma_bind - Sets up PTEs for an VMA in it's corresponding address space.
148 * @cache_level: mapping cache level
149 * @flags: flags like global or local mapping
151 * DMA addresses are taken from the scatter-gather table of this object (or of
152 * this VMA in case of non-default GGTT views) and PTE entries set up.
153 * Note that DMA addresses are also the only part of the SG table we care about.
155 int i915_vma_bind(struct i915_vma *vma, enum i915_cache_level cache_level,
162 if (WARN_ON(flags == 0))
166 if (flags & PIN_GLOBAL)
167 bind_flags |= I915_VMA_GLOBAL_BIND;
168 if (flags & PIN_USER)
169 bind_flags |= I915_VMA_LOCAL_BIND;
171 vma_flags = vma->flags & (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND);
172 if (flags & PIN_UPDATE)
173 bind_flags |= vma_flags;
175 bind_flags &= ~vma_flags;
179 if (GEM_WARN_ON(vma->node.start + vma->node.size < vma->node.start))
182 if (GEM_WARN_ON(vma->node.start + vma->node.size > vma->vm->total))
185 if (vma_flags == 0 && vma->vm->allocate_va_range) {
186 trace_i915_va_alloc(vma);
187 ret = vma->vm->allocate_va_range(vma->vm,
194 ret = vma->vm->bind_vma(vma, cache_level, bind_flags);
198 vma->flags |= bind_flags;
202 void __iomem *i915_vma_pin_iomap(struct i915_vma *vma)
206 /* Access through the GTT requires the device to be awake. */
207 assert_rpm_wakelock_held(vma->vm->i915);
209 lockdep_assert_held(&vma->vm->i915->drm.struct_mutex);
210 if (WARN_ON(!i915_vma_is_map_and_fenceable(vma)))
211 return IO_ERR_PTR(-ENODEV);
213 GEM_BUG_ON(!i915_vma_is_ggtt(vma));
214 GEM_BUG_ON((vma->flags & I915_VMA_GLOBAL_BIND) == 0);
218 ptr = io_mapping_map_wc(&i915_vm_to_ggtt(vma->vm)->mappable,
222 return IO_ERR_PTR(-ENOMEM);
231 void i915_vma_unpin_and_release(struct i915_vma **p_vma)
233 struct i915_vma *vma;
234 struct drm_i915_gem_object *obj;
236 vma = fetch_and_zero(p_vma);
245 __i915_gem_object_release_unless_active(obj);
249 i915_vma_misplaced(struct i915_vma *vma, u64 size, u64 alignment, u64 flags)
251 if (!drm_mm_node_allocated(&vma->node))
254 if (vma->node.size < size)
257 if (alignment && vma->node.start & (alignment - 1))
260 if (flags & PIN_MAPPABLE && !i915_vma_is_map_and_fenceable(vma))
263 if (flags & PIN_OFFSET_BIAS &&
264 vma->node.start < (flags & PIN_OFFSET_MASK))
267 if (flags & PIN_OFFSET_FIXED &&
268 vma->node.start != (flags & PIN_OFFSET_MASK))
274 void __i915_vma_set_map_and_fenceable(struct i915_vma *vma)
276 struct drm_i915_gem_object *obj = vma->obj;
277 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
278 bool mappable, fenceable;
279 u32 fence_size, fence_alignment;
281 fence_size = i915_gem_get_ggtt_size(dev_priv,
283 i915_gem_object_get_tiling(obj));
284 fence_alignment = i915_gem_get_ggtt_alignment(dev_priv,
286 i915_gem_object_get_tiling(obj),
289 fenceable = (vma->node.size == fence_size &&
290 (vma->node.start & (fence_alignment - 1)) == 0);
292 mappable = (vma->node.start + fence_size <=
293 dev_priv->ggtt.mappable_end);
296 * Explicitly disable for rotated VMA since the display does not
297 * need the fence and the VMA is not accessible to other users.
299 if (mappable && fenceable &&
300 vma->ggtt_view.type != I915_GGTT_VIEW_ROTATED)
301 vma->flags |= I915_VMA_CAN_FENCE;
303 vma->flags &= ~I915_VMA_CAN_FENCE;
306 static bool color_differs(struct drm_mm_node *node, unsigned long color)
308 return node->allocated && node->color != color;
311 bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long cache_level)
313 struct drm_mm_node *node = &vma->node;
314 struct drm_mm_node *other;
317 * On some machines we have to be careful when putting differing types
318 * of snoopable memory together to avoid the prefetcher crossing memory
319 * domains and dying. During vm initialisation, we decide whether or not
320 * these constraints apply and set the drm_mm.color_adjust
323 if (vma->vm->mm.color_adjust == NULL)
326 /* Only valid to be called on an already inserted vma */
327 GEM_BUG_ON(!drm_mm_node_allocated(node));
328 GEM_BUG_ON(list_empty(&node->node_list));
330 other = list_prev_entry(node, node_list);
331 if (color_differs(other, cache_level) && !other->hole_follows)
334 other = list_next_entry(node, node_list);
335 if (color_differs(other, cache_level) && !node->hole_follows)
342 * i915_vma_insert - finds a slot for the vma in its address space
344 * @size: requested size in bytes (can be larger than the VMA)
345 * @alignment: required alignment
346 * @flags: mask of PIN_* flags to use
348 * First we try to allocate some free space that meets the requirements for
349 * the VMA. Failiing that, if the flags permit, it will evict an old VMA,
350 * preferrably the oldest idle entry to make room for the new VMA.
353 * 0 on success, negative error code otherwise.
356 i915_vma_insert(struct i915_vma *vma, u64 size, u64 alignment, u64 flags)
358 struct drm_i915_private *dev_priv = vma->vm->i915;
359 struct drm_i915_gem_object *obj = vma->obj;
363 GEM_BUG_ON(vma->flags & (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND));
364 GEM_BUG_ON(drm_mm_node_allocated(&vma->node));
366 size = max(size, vma->size);
367 if (flags & PIN_MAPPABLE)
368 size = i915_gem_get_ggtt_size(dev_priv, size,
369 i915_gem_object_get_tiling(obj));
371 alignment = max(max(alignment, vma->display_alignment),
372 i915_gem_get_ggtt_alignment(dev_priv, size,
373 i915_gem_object_get_tiling(obj),
374 flags & PIN_MAPPABLE));
376 start = flags & PIN_OFFSET_BIAS ? flags & PIN_OFFSET_MASK : 0;
378 end = vma->vm->total;
379 if (flags & PIN_MAPPABLE)
380 end = min_t(u64, end, dev_priv->ggtt.mappable_end);
381 if (flags & PIN_ZONE_4G)
382 end = min_t(u64, end, (1ULL << 32) - PAGE_SIZE);
384 /* If binding the object/GGTT view requires more space than the entire
385 * aperture has, reject it early before evicting everything in a vain
386 * attempt to find space.
389 DRM_DEBUG("Attempting to bind an object larger than the aperture: request=%llu [object=%zd] > %s aperture=%llu\n",
390 size, obj->base.size,
391 flags & PIN_MAPPABLE ? "mappable" : "total",
396 ret = i915_gem_object_pin_pages(obj);
400 if (flags & PIN_OFFSET_FIXED) {
401 u64 offset = flags & PIN_OFFSET_MASK;
402 if (offset & (alignment - 1) || offset > end - size) {
407 vma->node.start = offset;
408 vma->node.size = size;
409 vma->node.color = obj->cache_level;
410 ret = drm_mm_reserve_node(&vma->vm->mm, &vma->node);
412 ret = i915_gem_evict_for_vma(vma, flags);
414 ret = drm_mm_reserve_node(&vma->vm->mm, &vma->node);
419 u32 search_flag, alloc_flag;
421 if (flags & PIN_HIGH) {
422 search_flag = DRM_MM_SEARCH_BELOW;
423 alloc_flag = DRM_MM_CREATE_TOP;
425 search_flag = DRM_MM_SEARCH_DEFAULT;
426 alloc_flag = DRM_MM_CREATE_DEFAULT;
429 /* We only allocate in PAGE_SIZE/GTT_PAGE_SIZE (4096) chunks,
430 * so we know that we always have a minimum alignment of 4096.
431 * The drm_mm range manager is optimised to return results
432 * with zero alignment, so where possible use the optimal
435 if (alignment <= 4096)
439 ret = drm_mm_insert_node_in_range_generic(&vma->vm->mm,
447 ret = i915_gem_evict_something(vma->vm, size, alignment,
457 GEM_BUG_ON(vma->node.start < start);
458 GEM_BUG_ON(vma->node.start + vma->node.size > end);
460 GEM_BUG_ON(!i915_gem_valid_gtt_space(vma, obj->cache_level));
462 list_move_tail(&obj->global_link, &dev_priv->mm.bound_list);
463 list_move_tail(&vma->vm_link, &vma->vm->inactive_list);
465 GEM_BUG_ON(atomic_read(&obj->mm.pages_pin_count) < obj->bind_count);
470 i915_gem_object_unpin_pages(obj);
474 int __i915_vma_do_pin(struct i915_vma *vma,
475 u64 size, u64 alignment, u64 flags)
477 unsigned int bound = vma->flags;
480 lockdep_assert_held(&vma->vm->i915->drm.struct_mutex);
481 GEM_BUG_ON((flags & (PIN_GLOBAL | PIN_USER)) == 0);
482 GEM_BUG_ON((flags & PIN_GLOBAL) && !i915_vma_is_ggtt(vma));
484 if (WARN_ON(bound & I915_VMA_PIN_OVERFLOW)) {
489 if ((bound & I915_VMA_BIND_MASK) == 0) {
490 ret = i915_vma_insert(vma, size, alignment, flags);
495 ret = i915_vma_bind(vma, vma->obj->cache_level, flags);
499 if ((bound ^ vma->flags) & I915_VMA_GLOBAL_BIND)
500 __i915_vma_set_map_and_fenceable(vma);
502 GEM_BUG_ON(i915_vma_misplaced(vma, size, alignment, flags));
506 __i915_vma_unpin(vma);
510 void i915_vma_destroy(struct i915_vma *vma)
512 GEM_BUG_ON(vma->node.allocated);
513 GEM_BUG_ON(i915_vma_is_active(vma));
514 GEM_BUG_ON(!i915_vma_is_closed(vma));
515 GEM_BUG_ON(vma->fence);
517 list_del(&vma->vm_link);
518 if (!i915_vma_is_ggtt(vma))
519 i915_ppgtt_put(i915_vm_to_ppgtt(vma->vm));
521 kmem_cache_free(to_i915(vma->obj->base.dev)->vmas, vma);
524 void i915_vma_close(struct i915_vma *vma)
526 GEM_BUG_ON(i915_vma_is_closed(vma));
527 vma->flags |= I915_VMA_CLOSED;
529 list_del(&vma->obj_link);
530 rb_erase(&vma->obj_node, &vma->obj->vma_tree);
532 if (!i915_vma_is_active(vma) && !i915_vma_is_pinned(vma))
533 WARN_ON(i915_vma_unbind(vma));
536 static void __i915_vma_iounmap(struct i915_vma *vma)
538 GEM_BUG_ON(i915_vma_is_pinned(vma));
540 if (vma->iomap == NULL)
543 io_mapping_unmap(vma->iomap);
547 int i915_vma_unbind(struct i915_vma *vma)
549 struct drm_i915_gem_object *obj = vma->obj;
550 unsigned long active;
553 lockdep_assert_held(&obj->base.dev->struct_mutex);
555 /* First wait upon any activity as retiring the request may
556 * have side-effects such as unpinning or even unbinding this vma.
558 active = i915_vma_get_active(vma);
562 /* When a closed VMA is retired, it is unbound - eek.
563 * In order to prevent it from being recursively closed,
564 * take a pin on the vma so that the second unbind is
567 * Even more scary is that the retire callback may free
568 * the object (last active vma). To prevent the explosion
569 * we defer the actual object free to a worker that can
570 * only proceed once it acquires the struct_mutex (which
571 * we currently hold, therefore it cannot free this object
572 * before we are finished).
576 for_each_active(active, idx) {
577 ret = i915_gem_active_retire(&vma->last_read[idx],
578 &vma->vm->i915->drm.struct_mutex);
583 __i915_vma_unpin(vma);
587 GEM_BUG_ON(i915_vma_is_active(vma));
590 if (i915_vma_is_pinned(vma))
593 if (!drm_mm_node_allocated(&vma->node))
596 GEM_BUG_ON(obj->bind_count == 0);
597 GEM_BUG_ON(!i915_gem_object_has_pinned_pages(obj));
599 if (i915_vma_is_map_and_fenceable(vma)) {
600 /* release the fence reg _after_ flushing */
601 ret = i915_vma_put_fence(vma);
605 /* Force a pagefault for domain tracking on next user access */
606 i915_gem_release_mmap(obj);
608 __i915_vma_iounmap(vma);
609 vma->flags &= ~I915_VMA_CAN_FENCE;
612 if (likely(!vma->vm->closed)) {
613 trace_i915_vma_unbind(vma);
614 vma->vm->unbind_vma(vma);
616 vma->flags &= ~(I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND);
618 drm_mm_remove_node(&vma->node);
619 list_move_tail(&vma->vm_link, &vma->vm->unbound_list);
621 if (vma->pages != obj->mm.pages) {
622 GEM_BUG_ON(!vma->pages);
623 sg_free_table(vma->pages);
628 /* Since the unbound list is global, only move to that list if
629 * no more VMAs exist. */
630 if (--obj->bind_count == 0)
631 list_move_tail(&obj->global_link,
632 &to_i915(obj->base.dev)->mm.unbound_list);
634 /* And finally now the object is completely decoupled from this vma,
635 * we can drop its hold on the backing storage and allow it to be
636 * reaped by the shrinker.
638 i915_gem_object_unpin_pages(obj);
641 if (unlikely(i915_vma_is_closed(vma)))
642 i915_vma_destroy(vma);