2 * Copyright © 2008-2015 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
24 * Eric Anholt <eric@anholt.net>
29 #include <drm/drm_vma_manager.h>
30 #include <drm/i915_drm.h>
32 #include "i915_vgpu.h"
33 #include "i915_trace.h"
34 #include "intel_drv.h"
35 #include "intel_frontbuffer.h"
36 #include "intel_mocs.h"
37 #include <linux/dma-fence-array.h>
38 #include <linux/reservation.h>
39 #include <linux/shmem_fs.h>
40 #include <linux/slab.h>
41 #include <linux/stop_machine.h>
42 #include <linux/swap.h>
43 #include <linux/pci.h>
44 #include <linux/dma-buf.h>
46 static void i915_gem_flush_free_objects(struct drm_i915_private *i915);
47 static void i915_gem_object_flush_gtt_write_domain(struct drm_i915_gem_object *obj);
48 static void i915_gem_object_flush_cpu_write_domain(struct drm_i915_gem_object *obj);
50 static bool cpu_cache_is_coherent(struct drm_device *dev,
51 enum i915_cache_level level)
53 return HAS_LLC(to_i915(dev)) || level != I915_CACHE_NONE;
56 static bool cpu_write_needs_clflush(struct drm_i915_gem_object *obj)
58 if (obj->base.write_domain == I915_GEM_DOMAIN_CPU)
61 if (!cpu_cache_is_coherent(obj->base.dev, obj->cache_level))
64 return obj->pin_display;
68 insert_mappable_node(struct i915_ggtt *ggtt,
69 struct drm_mm_node *node, u32 size)
71 memset(node, 0, sizeof(*node));
72 return drm_mm_insert_node_in_range_generic(&ggtt->base.mm, node,
74 0, ggtt->mappable_end,
75 DRM_MM_SEARCH_DEFAULT,
76 DRM_MM_CREATE_DEFAULT);
80 remove_mappable_node(struct drm_mm_node *node)
82 drm_mm_remove_node(node);
85 /* some bookkeeping */
86 static void i915_gem_info_add_obj(struct drm_i915_private *dev_priv,
89 spin_lock(&dev_priv->mm.object_stat_lock);
90 dev_priv->mm.object_count++;
91 dev_priv->mm.object_memory += size;
92 spin_unlock(&dev_priv->mm.object_stat_lock);
95 static void i915_gem_info_remove_obj(struct drm_i915_private *dev_priv,
98 spin_lock(&dev_priv->mm.object_stat_lock);
99 dev_priv->mm.object_count--;
100 dev_priv->mm.object_memory -= size;
101 spin_unlock(&dev_priv->mm.object_stat_lock);
105 i915_gem_wait_for_error(struct i915_gpu_error *error)
111 if (!i915_reset_in_progress(error))
115 * Only wait 10 seconds for the gpu reset to complete to avoid hanging
116 * userspace. If it takes that long something really bad is going on and
117 * we should simply try to bail out and fail as gracefully as possible.
119 ret = wait_event_interruptible_timeout(error->reset_queue,
120 !i915_reset_in_progress(error),
123 DRM_ERROR("Timed out waiting for the gpu reset to complete\n");
125 } else if (ret < 0) {
132 int i915_mutex_lock_interruptible(struct drm_device *dev)
134 struct drm_i915_private *dev_priv = to_i915(dev);
137 ret = i915_gem_wait_for_error(&dev_priv->gpu_error);
141 ret = mutex_lock_interruptible(&dev->struct_mutex);
149 i915_gem_get_aperture_ioctl(struct drm_device *dev, void *data,
150 struct drm_file *file)
152 struct drm_i915_private *dev_priv = to_i915(dev);
153 struct i915_ggtt *ggtt = &dev_priv->ggtt;
154 struct drm_i915_gem_get_aperture *args = data;
155 struct i915_vma *vma;
159 mutex_lock(&dev->struct_mutex);
160 list_for_each_entry(vma, &ggtt->base.active_list, vm_link)
161 if (i915_vma_is_pinned(vma))
162 pinned += vma->node.size;
163 list_for_each_entry(vma, &ggtt->base.inactive_list, vm_link)
164 if (i915_vma_is_pinned(vma))
165 pinned += vma->node.size;
166 mutex_unlock(&dev->struct_mutex);
168 args->aper_size = ggtt->base.total;
169 args->aper_available_size = args->aper_size - pinned;
174 static struct sg_table *
175 i915_gem_object_get_pages_phys(struct drm_i915_gem_object *obj)
177 struct address_space *mapping = obj->base.filp->f_mapping;
178 char *vaddr = obj->phys_handle->vaddr;
180 struct scatterlist *sg;
183 if (WARN_ON(i915_gem_object_needs_bit17_swizzle(obj)))
184 return ERR_PTR(-EINVAL);
186 for (i = 0; i < obj->base.size / PAGE_SIZE; i++) {
190 page = shmem_read_mapping_page(mapping, i);
192 return ERR_CAST(page);
194 src = kmap_atomic(page);
195 memcpy(vaddr, src, PAGE_SIZE);
196 drm_clflush_virt_range(vaddr, PAGE_SIZE);
203 i915_gem_chipset_flush(to_i915(obj->base.dev));
205 st = kmalloc(sizeof(*st), GFP_KERNEL);
207 return ERR_PTR(-ENOMEM);
209 if (sg_alloc_table(st, 1, GFP_KERNEL)) {
211 return ERR_PTR(-ENOMEM);
216 sg->length = obj->base.size;
218 sg_dma_address(sg) = obj->phys_handle->busaddr;
219 sg_dma_len(sg) = obj->base.size;
225 __i915_gem_object_release_shmem(struct drm_i915_gem_object *obj,
226 struct sg_table *pages)
228 GEM_BUG_ON(obj->mm.madv == __I915_MADV_PURGED);
230 if (obj->mm.madv == I915_MADV_DONTNEED)
231 obj->mm.dirty = false;
233 if ((obj->base.read_domains & I915_GEM_DOMAIN_CPU) == 0 &&
234 !cpu_cache_is_coherent(obj->base.dev, obj->cache_level))
235 drm_clflush_sg(pages);
237 obj->base.read_domains = I915_GEM_DOMAIN_CPU;
238 obj->base.write_domain = I915_GEM_DOMAIN_CPU;
242 i915_gem_object_put_pages_phys(struct drm_i915_gem_object *obj,
243 struct sg_table *pages)
245 __i915_gem_object_release_shmem(obj, pages);
248 struct address_space *mapping = obj->base.filp->f_mapping;
249 char *vaddr = obj->phys_handle->vaddr;
252 for (i = 0; i < obj->base.size / PAGE_SIZE; i++) {
256 page = shmem_read_mapping_page(mapping, i);
260 dst = kmap_atomic(page);
261 drm_clflush_virt_range(vaddr, PAGE_SIZE);
262 memcpy(dst, vaddr, PAGE_SIZE);
265 set_page_dirty(page);
266 if (obj->mm.madv == I915_MADV_WILLNEED)
267 mark_page_accessed(page);
271 obj->mm.dirty = false;
274 sg_free_table(pages);
279 i915_gem_object_release_phys(struct drm_i915_gem_object *obj)
281 drm_pci_free(obj->base.dev, obj->phys_handle);
282 i915_gem_object_unpin_pages(obj);
285 static const struct drm_i915_gem_object_ops i915_gem_phys_ops = {
286 .get_pages = i915_gem_object_get_pages_phys,
287 .put_pages = i915_gem_object_put_pages_phys,
288 .release = i915_gem_object_release_phys,
291 int i915_gem_object_unbind(struct drm_i915_gem_object *obj)
293 struct i915_vma *vma;
294 LIST_HEAD(still_in_list);
297 lockdep_assert_held(&obj->base.dev->struct_mutex);
299 /* Closed vma are removed from the obj->vma_list - but they may
300 * still have an active binding on the object. To remove those we
301 * must wait for all rendering to complete to the object (as unbinding
302 * must anyway), and retire the requests.
304 ret = i915_gem_object_wait(obj,
305 I915_WAIT_INTERRUPTIBLE |
308 MAX_SCHEDULE_TIMEOUT,
313 i915_gem_retire_requests(to_i915(obj->base.dev));
315 while ((vma = list_first_entry_or_null(&obj->vma_list,
318 list_move_tail(&vma->obj_link, &still_in_list);
319 ret = i915_vma_unbind(vma);
323 list_splice(&still_in_list, &obj->vma_list);
329 i915_gem_object_wait_fence(struct dma_fence *fence,
332 struct intel_rps_client *rps)
334 struct drm_i915_gem_request *rq;
336 BUILD_BUG_ON(I915_WAIT_INTERRUPTIBLE != 0x1);
338 if (test_bit(DMA_FENCE_FLAG_SIGNALED_BIT, &fence->flags))
341 if (!dma_fence_is_i915(fence))
342 return dma_fence_wait_timeout(fence,
343 flags & I915_WAIT_INTERRUPTIBLE,
346 rq = to_request(fence);
347 if (i915_gem_request_completed(rq))
350 /* This client is about to stall waiting for the GPU. In many cases
351 * this is undesirable and limits the throughput of the system, as
352 * many clients cannot continue processing user input/output whilst
353 * blocked. RPS autotuning may take tens of milliseconds to respond
354 * to the GPU load and thus incurs additional latency for the client.
355 * We can circumvent that by promoting the GPU frequency to maximum
356 * before we wait. This makes the GPU throttle up much more quickly
357 * (good for benchmarks and user experience, e.g. window animations),
358 * but at a cost of spending more power processing the workload
359 * (bad for battery). Not all clients even want their results
360 * immediately and for them we should just let the GPU select its own
361 * frequency to maximise efficiency. To prevent a single client from
362 * forcing the clocks too high for the whole system, we only allow
363 * each client to waitboost once in a busy period.
366 if (INTEL_GEN(rq->i915) >= 6)
367 gen6_rps_boost(rq->i915, rps, rq->emitted_jiffies);
372 timeout = i915_wait_request(rq, flags, timeout);
375 if (flags & I915_WAIT_LOCKED && i915_gem_request_completed(rq))
376 i915_gem_request_retire_upto(rq);
378 if (rps && rq->global_seqno == intel_engine_last_submit(rq->engine)) {
379 /* The GPU is now idle and this client has stalled.
380 * Since no other client has submitted a request in the
381 * meantime, assume that this client is the only one
382 * supplying work to the GPU but is unable to keep that
383 * work supplied because it is waiting. Since the GPU is
384 * then never kept fully busy, RPS autoclocking will
385 * keep the clocks relatively low, causing further delays.
386 * Compensate by giving the synchronous client credit for
387 * a waitboost next time.
389 spin_lock(&rq->i915->rps.client_lock);
390 list_del_init(&rps->link);
391 spin_unlock(&rq->i915->rps.client_lock);
398 i915_gem_object_wait_reservation(struct reservation_object *resv,
401 struct intel_rps_client *rps)
403 struct dma_fence *excl;
405 if (flags & I915_WAIT_ALL) {
406 struct dma_fence **shared;
407 unsigned int count, i;
410 ret = reservation_object_get_fences_rcu(resv,
411 &excl, &count, &shared);
415 for (i = 0; i < count; i++) {
416 timeout = i915_gem_object_wait_fence(shared[i],
422 dma_fence_put(shared[i]);
425 for (; i < count; i++)
426 dma_fence_put(shared[i]);
429 excl = reservation_object_get_excl_rcu(resv);
432 if (excl && timeout > 0)
433 timeout = i915_gem_object_wait_fence(excl, flags, timeout, rps);
440 static void __fence_set_priority(struct dma_fence *fence, int prio)
442 struct drm_i915_gem_request *rq;
443 struct intel_engine_cs *engine;
445 if (!dma_fence_is_i915(fence))
448 rq = to_request(fence);
450 if (!engine->schedule)
453 engine->schedule(rq, prio);
456 static void fence_set_priority(struct dma_fence *fence, int prio)
458 /* Recurse once into a fence-array */
459 if (dma_fence_is_array(fence)) {
460 struct dma_fence_array *array = to_dma_fence_array(fence);
463 for (i = 0; i < array->num_fences; i++)
464 __fence_set_priority(array->fences[i], prio);
466 __fence_set_priority(fence, prio);
471 i915_gem_object_wait_priority(struct drm_i915_gem_object *obj,
475 struct dma_fence *excl;
477 if (flags & I915_WAIT_ALL) {
478 struct dma_fence **shared;
479 unsigned int count, i;
482 ret = reservation_object_get_fences_rcu(obj->resv,
483 &excl, &count, &shared);
487 for (i = 0; i < count; i++) {
488 fence_set_priority(shared[i], prio);
489 dma_fence_put(shared[i]);
494 excl = reservation_object_get_excl_rcu(obj->resv);
498 fence_set_priority(excl, prio);
505 * Waits for rendering to the object to be completed
506 * @obj: i915 gem object
507 * @flags: how to wait (under a lock, for all rendering or just for writes etc)
508 * @timeout: how long to wait
509 * @rps: client (user process) to charge for any waitboosting
512 i915_gem_object_wait(struct drm_i915_gem_object *obj,
515 struct intel_rps_client *rps)
518 #if IS_ENABLED(CONFIG_LOCKDEP)
519 GEM_BUG_ON(debug_locks &&
520 !!lockdep_is_held(&obj->base.dev->struct_mutex) !=
521 !!(flags & I915_WAIT_LOCKED));
523 GEM_BUG_ON(timeout < 0);
525 timeout = i915_gem_object_wait_reservation(obj->resv,
528 return timeout < 0 ? timeout : 0;
531 static struct intel_rps_client *to_rps_client(struct drm_file *file)
533 struct drm_i915_file_private *fpriv = file->driver_priv;
539 i915_gem_object_attach_phys(struct drm_i915_gem_object *obj,
542 drm_dma_handle_t *phys;
545 if (obj->phys_handle) {
546 if ((unsigned long)obj->phys_handle->vaddr & (align -1))
552 if (obj->mm.madv != I915_MADV_WILLNEED)
555 if (obj->base.filp == NULL)
558 ret = i915_gem_object_unbind(obj);
562 __i915_gem_object_put_pages(obj, I915_MM_NORMAL);
566 /* create a new object */
567 phys = drm_pci_alloc(obj->base.dev, obj->base.size, align);
571 obj->phys_handle = phys;
572 obj->ops = &i915_gem_phys_ops;
574 return i915_gem_object_pin_pages(obj);
578 i915_gem_phys_pwrite(struct drm_i915_gem_object *obj,
579 struct drm_i915_gem_pwrite *args,
580 struct drm_file *file)
582 struct drm_device *dev = obj->base.dev;
583 void *vaddr = obj->phys_handle->vaddr + args->offset;
584 char __user *user_data = u64_to_user_ptr(args->data_ptr);
587 /* We manually control the domain here and pretend that it
588 * remains coherent i.e. in the GTT domain, like shmem_pwrite.
590 lockdep_assert_held(&obj->base.dev->struct_mutex);
591 ret = i915_gem_object_wait(obj,
592 I915_WAIT_INTERRUPTIBLE |
595 MAX_SCHEDULE_TIMEOUT,
596 to_rps_client(file));
600 intel_fb_obj_invalidate(obj, ORIGIN_CPU);
601 if (__copy_from_user_inatomic_nocache(vaddr, user_data, args->size)) {
602 unsigned long unwritten;
604 /* The physical object once assigned is fixed for the lifetime
605 * of the obj, so we can safely drop the lock and continue
608 mutex_unlock(&dev->struct_mutex);
609 unwritten = copy_from_user(vaddr, user_data, args->size);
610 mutex_lock(&dev->struct_mutex);
617 drm_clflush_virt_range(vaddr, args->size);
618 i915_gem_chipset_flush(to_i915(dev));
621 intel_fb_obj_flush(obj, false, ORIGIN_CPU);
625 void *i915_gem_object_alloc(struct drm_i915_private *dev_priv)
627 return kmem_cache_zalloc(dev_priv->objects, GFP_KERNEL);
630 void i915_gem_object_free(struct drm_i915_gem_object *obj)
632 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
633 kmem_cache_free(dev_priv->objects, obj);
637 i915_gem_create(struct drm_file *file,
638 struct drm_i915_private *dev_priv,
642 struct drm_i915_gem_object *obj;
646 size = roundup(size, PAGE_SIZE);
650 /* Allocate the new object */
651 obj = i915_gem_object_create(dev_priv, size);
655 ret = drm_gem_handle_create(file, &obj->base, &handle);
656 /* drop reference from allocate - handle holds it now */
657 i915_gem_object_put(obj);
666 i915_gem_dumb_create(struct drm_file *file,
667 struct drm_device *dev,
668 struct drm_mode_create_dumb *args)
670 /* have to work out size/pitch and return them */
671 args->pitch = ALIGN(args->width * DIV_ROUND_UP(args->bpp, 8), 64);
672 args->size = args->pitch * args->height;
673 return i915_gem_create(file, to_i915(dev),
674 args->size, &args->handle);
678 * Creates a new mm object and returns a handle to it.
679 * @dev: drm device pointer
680 * @data: ioctl data blob
681 * @file: drm file pointer
684 i915_gem_create_ioctl(struct drm_device *dev, void *data,
685 struct drm_file *file)
687 struct drm_i915_private *dev_priv = to_i915(dev);
688 struct drm_i915_gem_create *args = data;
690 i915_gem_flush_free_objects(dev_priv);
692 return i915_gem_create(file, dev_priv,
693 args->size, &args->handle);
697 __copy_to_user_swizzled(char __user *cpu_vaddr,
698 const char *gpu_vaddr, int gpu_offset,
701 int ret, cpu_offset = 0;
704 int cacheline_end = ALIGN(gpu_offset + 1, 64);
705 int this_length = min(cacheline_end - gpu_offset, length);
706 int swizzled_gpu_offset = gpu_offset ^ 64;
708 ret = __copy_to_user(cpu_vaddr + cpu_offset,
709 gpu_vaddr + swizzled_gpu_offset,
714 cpu_offset += this_length;
715 gpu_offset += this_length;
716 length -= this_length;
723 __copy_from_user_swizzled(char *gpu_vaddr, int gpu_offset,
724 const char __user *cpu_vaddr,
727 int ret, cpu_offset = 0;
730 int cacheline_end = ALIGN(gpu_offset + 1, 64);
731 int this_length = min(cacheline_end - gpu_offset, length);
732 int swizzled_gpu_offset = gpu_offset ^ 64;
734 ret = __copy_from_user(gpu_vaddr + swizzled_gpu_offset,
735 cpu_vaddr + cpu_offset,
740 cpu_offset += this_length;
741 gpu_offset += this_length;
742 length -= this_length;
749 * Pins the specified object's pages and synchronizes the object with
750 * GPU accesses. Sets needs_clflush to non-zero if the caller should
751 * flush the object from the CPU cache.
753 int i915_gem_obj_prepare_shmem_read(struct drm_i915_gem_object *obj,
754 unsigned int *needs_clflush)
758 lockdep_assert_held(&obj->base.dev->struct_mutex);
761 if (!i915_gem_object_has_struct_page(obj))
764 ret = i915_gem_object_wait(obj,
765 I915_WAIT_INTERRUPTIBLE |
767 MAX_SCHEDULE_TIMEOUT,
772 ret = i915_gem_object_pin_pages(obj);
776 i915_gem_object_flush_gtt_write_domain(obj);
778 /* If we're not in the cpu read domain, set ourself into the gtt
779 * read domain and manually flush cachelines (if required). This
780 * optimizes for the case when the gpu will dirty the data
781 * anyway again before the next pread happens.
783 if (!(obj->base.read_domains & I915_GEM_DOMAIN_CPU))
784 *needs_clflush = !cpu_cache_is_coherent(obj->base.dev,
787 if (*needs_clflush && !static_cpu_has(X86_FEATURE_CLFLUSH)) {
788 ret = i915_gem_object_set_to_cpu_domain(obj, false);
795 /* return with the pages pinned */
799 i915_gem_object_unpin_pages(obj);
803 int i915_gem_obj_prepare_shmem_write(struct drm_i915_gem_object *obj,
804 unsigned int *needs_clflush)
808 lockdep_assert_held(&obj->base.dev->struct_mutex);
811 if (!i915_gem_object_has_struct_page(obj))
814 ret = i915_gem_object_wait(obj,
815 I915_WAIT_INTERRUPTIBLE |
818 MAX_SCHEDULE_TIMEOUT,
823 ret = i915_gem_object_pin_pages(obj);
827 i915_gem_object_flush_gtt_write_domain(obj);
829 /* If we're not in the cpu write domain, set ourself into the
830 * gtt write domain and manually flush cachelines (as required).
831 * This optimizes for the case when the gpu will use the data
832 * right away and we therefore have to clflush anyway.
834 if (obj->base.write_domain != I915_GEM_DOMAIN_CPU)
835 *needs_clflush |= cpu_write_needs_clflush(obj) << 1;
837 /* Same trick applies to invalidate partially written cachelines read
840 if (!(obj->base.read_domains & I915_GEM_DOMAIN_CPU))
841 *needs_clflush |= !cpu_cache_is_coherent(obj->base.dev,
844 if (*needs_clflush && !static_cpu_has(X86_FEATURE_CLFLUSH)) {
845 ret = i915_gem_object_set_to_cpu_domain(obj, true);
852 if ((*needs_clflush & CLFLUSH_AFTER) == 0)
853 obj->cache_dirty = true;
855 intel_fb_obj_invalidate(obj, ORIGIN_CPU);
856 obj->mm.dirty = true;
857 /* return with the pages pinned */
861 i915_gem_object_unpin_pages(obj);
866 shmem_clflush_swizzled_range(char *addr, unsigned long length,
869 if (unlikely(swizzled)) {
870 unsigned long start = (unsigned long) addr;
871 unsigned long end = (unsigned long) addr + length;
873 /* For swizzling simply ensure that we always flush both
874 * channels. Lame, but simple and it works. Swizzled
875 * pwrite/pread is far from a hotpath - current userspace
876 * doesn't use it at all. */
877 start = round_down(start, 128);
878 end = round_up(end, 128);
880 drm_clflush_virt_range((void *)start, end - start);
882 drm_clflush_virt_range(addr, length);
887 /* Only difference to the fast-path function is that this can handle bit17
888 * and uses non-atomic copy and kmap functions. */
890 shmem_pread_slow(struct page *page, int offset, int length,
891 char __user *user_data,
892 bool page_do_bit17_swizzling, bool needs_clflush)
899 shmem_clflush_swizzled_range(vaddr + offset, length,
900 page_do_bit17_swizzling);
902 if (page_do_bit17_swizzling)
903 ret = __copy_to_user_swizzled(user_data, vaddr, offset, length);
905 ret = __copy_to_user(user_data, vaddr + offset, length);
908 return ret ? - EFAULT : 0;
912 shmem_pread(struct page *page, int offset, int length, char __user *user_data,
913 bool page_do_bit17_swizzling, bool needs_clflush)
918 if (!page_do_bit17_swizzling) {
919 char *vaddr = kmap_atomic(page);
922 drm_clflush_virt_range(vaddr + offset, length);
923 ret = __copy_to_user_inatomic(user_data, vaddr + offset, length);
924 kunmap_atomic(vaddr);
929 return shmem_pread_slow(page, offset, length, user_data,
930 page_do_bit17_swizzling, needs_clflush);
934 i915_gem_shmem_pread(struct drm_i915_gem_object *obj,
935 struct drm_i915_gem_pread *args)
937 char __user *user_data;
939 unsigned int obj_do_bit17_swizzling;
940 unsigned int needs_clflush;
941 unsigned int idx, offset;
944 obj_do_bit17_swizzling = 0;
945 if (i915_gem_object_needs_bit17_swizzle(obj))
946 obj_do_bit17_swizzling = BIT(17);
948 ret = mutex_lock_interruptible(&obj->base.dev->struct_mutex);
952 ret = i915_gem_obj_prepare_shmem_read(obj, &needs_clflush);
953 mutex_unlock(&obj->base.dev->struct_mutex);
958 user_data = u64_to_user_ptr(args->data_ptr);
959 offset = offset_in_page(args->offset);
960 for (idx = args->offset >> PAGE_SHIFT; remain; idx++) {
961 struct page *page = i915_gem_object_get_page(obj, idx);
965 if (offset + length > PAGE_SIZE)
966 length = PAGE_SIZE - offset;
968 ret = shmem_pread(page, offset, length, user_data,
969 page_to_phys(page) & obj_do_bit17_swizzling,
979 i915_gem_obj_finish_shmem_access(obj);
984 gtt_user_read(struct io_mapping *mapping,
985 loff_t base, int offset,
986 char __user *user_data, int length)
989 unsigned long unwritten;
991 /* We can use the cpu mem copy function because this is X86. */
992 vaddr = (void __force *)io_mapping_map_atomic_wc(mapping, base);
993 unwritten = __copy_to_user_inatomic(user_data, vaddr + offset, length);
994 io_mapping_unmap_atomic(vaddr);
996 vaddr = (void __force *)
997 io_mapping_map_wc(mapping, base, PAGE_SIZE);
998 unwritten = copy_to_user(user_data, vaddr + offset, length);
999 io_mapping_unmap(vaddr);
1005 i915_gem_gtt_pread(struct drm_i915_gem_object *obj,
1006 const struct drm_i915_gem_pread *args)
1008 struct drm_i915_private *i915 = to_i915(obj->base.dev);
1009 struct i915_ggtt *ggtt = &i915->ggtt;
1010 struct drm_mm_node node;
1011 struct i915_vma *vma;
1012 void __user *user_data;
1016 ret = mutex_lock_interruptible(&i915->drm.struct_mutex);
1020 intel_runtime_pm_get(i915);
1021 vma = i915_gem_object_ggtt_pin(obj, NULL, 0, 0,
1022 PIN_MAPPABLE | PIN_NONBLOCK);
1024 node.start = i915_ggtt_offset(vma);
1025 node.allocated = false;
1026 ret = i915_vma_put_fence(vma);
1028 i915_vma_unpin(vma);
1033 ret = insert_mappable_node(ggtt, &node, PAGE_SIZE);
1036 GEM_BUG_ON(!node.allocated);
1039 ret = i915_gem_object_set_to_gtt_domain(obj, false);
1043 mutex_unlock(&i915->drm.struct_mutex);
1045 user_data = u64_to_user_ptr(args->data_ptr);
1046 remain = args->size;
1047 offset = args->offset;
1049 while (remain > 0) {
1050 /* Operation in this page
1052 * page_base = page offset within aperture
1053 * page_offset = offset within page
1054 * page_length = bytes to copy for this page
1056 u32 page_base = node.start;
1057 unsigned page_offset = offset_in_page(offset);
1058 unsigned page_length = PAGE_SIZE - page_offset;
1059 page_length = remain < page_length ? remain : page_length;
1060 if (node.allocated) {
1062 ggtt->base.insert_page(&ggtt->base,
1063 i915_gem_object_get_dma_address(obj, offset >> PAGE_SHIFT),
1064 node.start, I915_CACHE_NONE, 0);
1067 page_base += offset & PAGE_MASK;
1070 if (gtt_user_read(&ggtt->mappable, page_base, page_offset,
1071 user_data, page_length)) {
1076 remain -= page_length;
1077 user_data += page_length;
1078 offset += page_length;
1081 mutex_lock(&i915->drm.struct_mutex);
1083 if (node.allocated) {
1085 ggtt->base.clear_range(&ggtt->base,
1086 node.start, node.size);
1087 remove_mappable_node(&node);
1089 i915_vma_unpin(vma);
1092 intel_runtime_pm_put(i915);
1093 mutex_unlock(&i915->drm.struct_mutex);
1099 * Reads data from the object referenced by handle.
1100 * @dev: drm device pointer
1101 * @data: ioctl data blob
1102 * @file: drm file pointer
1104 * On error, the contents of *data are undefined.
1107 i915_gem_pread_ioctl(struct drm_device *dev, void *data,
1108 struct drm_file *file)
1110 struct drm_i915_gem_pread *args = data;
1111 struct drm_i915_gem_object *obj;
1114 if (args->size == 0)
1117 if (!access_ok(VERIFY_WRITE,
1118 u64_to_user_ptr(args->data_ptr),
1122 obj = i915_gem_object_lookup(file, args->handle);
1126 /* Bounds check source. */
1127 if (args->offset > obj->base.size ||
1128 args->size > obj->base.size - args->offset) {
1133 trace_i915_gem_object_pread(obj, args->offset, args->size);
1135 ret = i915_gem_object_wait(obj,
1136 I915_WAIT_INTERRUPTIBLE,
1137 MAX_SCHEDULE_TIMEOUT,
1138 to_rps_client(file));
1142 ret = i915_gem_object_pin_pages(obj);
1146 ret = i915_gem_shmem_pread(obj, args);
1147 if (ret == -EFAULT || ret == -ENODEV)
1148 ret = i915_gem_gtt_pread(obj, args);
1150 i915_gem_object_unpin_pages(obj);
1152 i915_gem_object_put(obj);
1156 /* This is the fast write path which cannot handle
1157 * page faults in the source data
1161 ggtt_write(struct io_mapping *mapping,
1162 loff_t base, int offset,
1163 char __user *user_data, int length)
1166 unsigned long unwritten;
1168 /* We can use the cpu mem copy function because this is X86. */
1169 vaddr = (void __force *)io_mapping_map_atomic_wc(mapping, base);
1170 unwritten = __copy_from_user_inatomic_nocache(vaddr + offset,
1172 io_mapping_unmap_atomic(vaddr);
1174 vaddr = (void __force *)
1175 io_mapping_map_wc(mapping, base, PAGE_SIZE);
1176 unwritten = copy_from_user(vaddr + offset, user_data, length);
1177 io_mapping_unmap(vaddr);
1184 * This is the fast pwrite path, where we copy the data directly from the
1185 * user into the GTT, uncached.
1186 * @obj: i915 GEM object
1187 * @args: pwrite arguments structure
1190 i915_gem_gtt_pwrite_fast(struct drm_i915_gem_object *obj,
1191 const struct drm_i915_gem_pwrite *args)
1193 struct drm_i915_private *i915 = to_i915(obj->base.dev);
1194 struct i915_ggtt *ggtt = &i915->ggtt;
1195 struct drm_mm_node node;
1196 struct i915_vma *vma;
1198 void __user *user_data;
1201 ret = mutex_lock_interruptible(&i915->drm.struct_mutex);
1205 intel_runtime_pm_get(i915);
1206 vma = i915_gem_object_ggtt_pin(obj, NULL, 0, 0,
1207 PIN_MAPPABLE | PIN_NONBLOCK);
1209 node.start = i915_ggtt_offset(vma);
1210 node.allocated = false;
1211 ret = i915_vma_put_fence(vma);
1213 i915_vma_unpin(vma);
1218 ret = insert_mappable_node(ggtt, &node, PAGE_SIZE);
1221 GEM_BUG_ON(!node.allocated);
1224 ret = i915_gem_object_set_to_gtt_domain(obj, true);
1228 mutex_unlock(&i915->drm.struct_mutex);
1230 intel_fb_obj_invalidate(obj, ORIGIN_CPU);
1232 user_data = u64_to_user_ptr(args->data_ptr);
1233 offset = args->offset;
1234 remain = args->size;
1236 /* Operation in this page
1238 * page_base = page offset within aperture
1239 * page_offset = offset within page
1240 * page_length = bytes to copy for this page
1242 u32 page_base = node.start;
1243 unsigned int page_offset = offset_in_page(offset);
1244 unsigned int page_length = PAGE_SIZE - page_offset;
1245 page_length = remain < page_length ? remain : page_length;
1246 if (node.allocated) {
1247 wmb(); /* flush the write before we modify the GGTT */
1248 ggtt->base.insert_page(&ggtt->base,
1249 i915_gem_object_get_dma_address(obj, offset >> PAGE_SHIFT),
1250 node.start, I915_CACHE_NONE, 0);
1251 wmb(); /* flush modifications to the GGTT (insert_page) */
1253 page_base += offset & PAGE_MASK;
1255 /* If we get a fault while copying data, then (presumably) our
1256 * source page isn't available. Return the error and we'll
1257 * retry in the slow path.
1258 * If the object is non-shmem backed, we retry again with the
1259 * path that handles page fault.
1261 if (ggtt_write(&ggtt->mappable, page_base, page_offset,
1262 user_data, page_length)) {
1267 remain -= page_length;
1268 user_data += page_length;
1269 offset += page_length;
1271 intel_fb_obj_flush(obj, false, ORIGIN_CPU);
1273 mutex_lock(&i915->drm.struct_mutex);
1275 if (node.allocated) {
1277 ggtt->base.clear_range(&ggtt->base,
1278 node.start, node.size);
1279 remove_mappable_node(&node);
1281 i915_vma_unpin(vma);
1284 intel_runtime_pm_put(i915);
1285 mutex_unlock(&i915->drm.struct_mutex);
1290 shmem_pwrite_slow(struct page *page, int offset, int length,
1291 char __user *user_data,
1292 bool page_do_bit17_swizzling,
1293 bool needs_clflush_before,
1294 bool needs_clflush_after)
1300 if (unlikely(needs_clflush_before || page_do_bit17_swizzling))
1301 shmem_clflush_swizzled_range(vaddr + offset, length,
1302 page_do_bit17_swizzling);
1303 if (page_do_bit17_swizzling)
1304 ret = __copy_from_user_swizzled(vaddr, offset, user_data,
1307 ret = __copy_from_user(vaddr + offset, user_data, length);
1308 if (needs_clflush_after)
1309 shmem_clflush_swizzled_range(vaddr + offset, length,
1310 page_do_bit17_swizzling);
1313 return ret ? -EFAULT : 0;
1316 /* Per-page copy function for the shmem pwrite fastpath.
1317 * Flushes invalid cachelines before writing to the target if
1318 * needs_clflush_before is set and flushes out any written cachelines after
1319 * writing if needs_clflush is set.
1322 shmem_pwrite(struct page *page, int offset, int len, char __user *user_data,
1323 bool page_do_bit17_swizzling,
1324 bool needs_clflush_before,
1325 bool needs_clflush_after)
1330 if (!page_do_bit17_swizzling) {
1331 char *vaddr = kmap_atomic(page);
1333 if (needs_clflush_before)
1334 drm_clflush_virt_range(vaddr + offset, len);
1335 ret = __copy_from_user_inatomic(vaddr + offset, user_data, len);
1336 if (needs_clflush_after)
1337 drm_clflush_virt_range(vaddr + offset, len);
1339 kunmap_atomic(vaddr);
1344 return shmem_pwrite_slow(page, offset, len, user_data,
1345 page_do_bit17_swizzling,
1346 needs_clflush_before,
1347 needs_clflush_after);
1351 i915_gem_shmem_pwrite(struct drm_i915_gem_object *obj,
1352 const struct drm_i915_gem_pwrite *args)
1354 struct drm_i915_private *i915 = to_i915(obj->base.dev);
1355 void __user *user_data;
1357 unsigned int obj_do_bit17_swizzling;
1358 unsigned int partial_cacheline_write;
1359 unsigned int needs_clflush;
1360 unsigned int offset, idx;
1363 ret = mutex_lock_interruptible(&i915->drm.struct_mutex);
1367 ret = i915_gem_obj_prepare_shmem_write(obj, &needs_clflush);
1368 mutex_unlock(&i915->drm.struct_mutex);
1372 obj_do_bit17_swizzling = 0;
1373 if (i915_gem_object_needs_bit17_swizzle(obj))
1374 obj_do_bit17_swizzling = BIT(17);
1376 /* If we don't overwrite a cacheline completely we need to be
1377 * careful to have up-to-date data by first clflushing. Don't
1378 * overcomplicate things and flush the entire patch.
1380 partial_cacheline_write = 0;
1381 if (needs_clflush & CLFLUSH_BEFORE)
1382 partial_cacheline_write = boot_cpu_data.x86_clflush_size - 1;
1384 user_data = u64_to_user_ptr(args->data_ptr);
1385 remain = args->size;
1386 offset = offset_in_page(args->offset);
1387 for (idx = args->offset >> PAGE_SHIFT; remain; idx++) {
1388 struct page *page = i915_gem_object_get_page(obj, idx);
1392 if (offset + length > PAGE_SIZE)
1393 length = PAGE_SIZE - offset;
1395 ret = shmem_pwrite(page, offset, length, user_data,
1396 page_to_phys(page) & obj_do_bit17_swizzling,
1397 (offset | length) & partial_cacheline_write,
1398 needs_clflush & CLFLUSH_AFTER);
1403 user_data += length;
1407 intel_fb_obj_flush(obj, false, ORIGIN_CPU);
1408 i915_gem_obj_finish_shmem_access(obj);
1413 * Writes data to the object referenced by handle.
1415 * @data: ioctl data blob
1418 * On error, the contents of the buffer that were to be modified are undefined.
1421 i915_gem_pwrite_ioctl(struct drm_device *dev, void *data,
1422 struct drm_file *file)
1424 struct drm_i915_gem_pwrite *args = data;
1425 struct drm_i915_gem_object *obj;
1428 if (args->size == 0)
1431 if (!access_ok(VERIFY_READ,
1432 u64_to_user_ptr(args->data_ptr),
1436 obj = i915_gem_object_lookup(file, args->handle);
1440 /* Bounds check destination. */
1441 if (args->offset > obj->base.size ||
1442 args->size > obj->base.size - args->offset) {
1447 trace_i915_gem_object_pwrite(obj, args->offset, args->size);
1449 ret = i915_gem_object_wait(obj,
1450 I915_WAIT_INTERRUPTIBLE |
1452 MAX_SCHEDULE_TIMEOUT,
1453 to_rps_client(file));
1457 ret = i915_gem_object_pin_pages(obj);
1462 /* We can only do the GTT pwrite on untiled buffers, as otherwise
1463 * it would end up going through the fenced access, and we'll get
1464 * different detiling behavior between reading and writing.
1465 * pread/pwrite currently are reading and writing from the CPU
1466 * perspective, requiring manual detiling by the client.
1468 if (!i915_gem_object_has_struct_page(obj) ||
1469 cpu_write_needs_clflush(obj))
1470 /* Note that the gtt paths might fail with non-page-backed user
1471 * pointers (e.g. gtt mappings when moving data between
1472 * textures). Fallback to the shmem path in that case.
1474 ret = i915_gem_gtt_pwrite_fast(obj, args);
1476 if (ret == -EFAULT || ret == -ENOSPC) {
1477 if (obj->phys_handle)
1478 ret = i915_gem_phys_pwrite(obj, args, file);
1480 ret = i915_gem_shmem_pwrite(obj, args);
1483 i915_gem_object_unpin_pages(obj);
1485 i915_gem_object_put(obj);
1489 static inline enum fb_op_origin
1490 write_origin(struct drm_i915_gem_object *obj, unsigned domain)
1492 return (domain == I915_GEM_DOMAIN_GTT ?
1493 obj->frontbuffer_ggtt_origin : ORIGIN_CPU);
1496 static void i915_gem_object_bump_inactive_ggtt(struct drm_i915_gem_object *obj)
1498 struct drm_i915_private *i915;
1499 struct list_head *list;
1500 struct i915_vma *vma;
1502 list_for_each_entry(vma, &obj->vma_list, obj_link) {
1503 if (!i915_vma_is_ggtt(vma))
1506 if (i915_vma_is_active(vma))
1509 if (!drm_mm_node_allocated(&vma->node))
1512 list_move_tail(&vma->vm_link, &vma->vm->inactive_list);
1515 i915 = to_i915(obj->base.dev);
1516 list = obj->bind_count ? &i915->mm.bound_list : &i915->mm.unbound_list;
1517 list_move_tail(&obj->global_link, list);
1521 * Called when user space prepares to use an object with the CPU, either
1522 * through the mmap ioctl's mapping or a GTT mapping.
1524 * @data: ioctl data blob
1528 i915_gem_set_domain_ioctl(struct drm_device *dev, void *data,
1529 struct drm_file *file)
1531 struct drm_i915_gem_set_domain *args = data;
1532 struct drm_i915_gem_object *obj;
1533 uint32_t read_domains = args->read_domains;
1534 uint32_t write_domain = args->write_domain;
1537 /* Only handle setting domains to types used by the CPU. */
1538 if ((write_domain | read_domains) & I915_GEM_GPU_DOMAINS)
1541 /* Having something in the write domain implies it's in the read
1542 * domain, and only that read domain. Enforce that in the request.
1544 if (write_domain != 0 && read_domains != write_domain)
1547 obj = i915_gem_object_lookup(file, args->handle);
1551 /* Try to flush the object off the GPU without holding the lock.
1552 * We will repeat the flush holding the lock in the normal manner
1553 * to catch cases where we are gazumped.
1555 err = i915_gem_object_wait(obj,
1556 I915_WAIT_INTERRUPTIBLE |
1557 (write_domain ? I915_WAIT_ALL : 0),
1558 MAX_SCHEDULE_TIMEOUT,
1559 to_rps_client(file));
1563 /* Flush and acquire obj->pages so that we are coherent through
1564 * direct access in memory with previous cached writes through
1565 * shmemfs and that our cache domain tracking remains valid.
1566 * For example, if the obj->filp was moved to swap without us
1567 * being notified and releasing the pages, we would mistakenly
1568 * continue to assume that the obj remained out of the CPU cached
1571 err = i915_gem_object_pin_pages(obj);
1575 err = i915_mutex_lock_interruptible(dev);
1579 if (read_domains & I915_GEM_DOMAIN_GTT)
1580 err = i915_gem_object_set_to_gtt_domain(obj, write_domain != 0);
1582 err = i915_gem_object_set_to_cpu_domain(obj, write_domain != 0);
1584 /* And bump the LRU for this access */
1585 i915_gem_object_bump_inactive_ggtt(obj);
1587 mutex_unlock(&dev->struct_mutex);
1589 if (write_domain != 0)
1590 intel_fb_obj_invalidate(obj, write_origin(obj, write_domain));
1593 i915_gem_object_unpin_pages(obj);
1595 i915_gem_object_put(obj);
1600 * Called when user space has done writes to this buffer
1602 * @data: ioctl data blob
1606 i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
1607 struct drm_file *file)
1609 struct drm_i915_gem_sw_finish *args = data;
1610 struct drm_i915_gem_object *obj;
1613 obj = i915_gem_object_lookup(file, args->handle);
1617 /* Pinned buffers may be scanout, so flush the cache */
1618 if (READ_ONCE(obj->pin_display)) {
1619 err = i915_mutex_lock_interruptible(dev);
1621 i915_gem_object_flush_cpu_write_domain(obj);
1622 mutex_unlock(&dev->struct_mutex);
1626 i915_gem_object_put(obj);
1631 * i915_gem_mmap_ioctl - Maps the contents of an object, returning the address
1634 * @data: ioctl data blob
1637 * While the mapping holds a reference on the contents of the object, it doesn't
1638 * imply a ref on the object itself.
1642 * DRM driver writers who look a this function as an example for how to do GEM
1643 * mmap support, please don't implement mmap support like here. The modern way
1644 * to implement DRM mmap support is with an mmap offset ioctl (like
1645 * i915_gem_mmap_gtt) and then using the mmap syscall on the DRM fd directly.
1646 * That way debug tooling like valgrind will understand what's going on, hiding
1647 * the mmap call in a driver private ioctl will break that. The i915 driver only
1648 * does cpu mmaps this way because we didn't know better.
1651 i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
1652 struct drm_file *file)
1654 struct drm_i915_gem_mmap *args = data;
1655 struct drm_i915_gem_object *obj;
1658 if (args->flags & ~(I915_MMAP_WC))
1661 if (args->flags & I915_MMAP_WC && !boot_cpu_has(X86_FEATURE_PAT))
1664 obj = i915_gem_object_lookup(file, args->handle);
1668 /* prime objects have no backing filp to GEM mmap
1671 if (!obj->base.filp) {
1672 i915_gem_object_put(obj);
1676 addr = vm_mmap(obj->base.filp, 0, args->size,
1677 PROT_READ | PROT_WRITE, MAP_SHARED,
1679 if (args->flags & I915_MMAP_WC) {
1680 struct mm_struct *mm = current->mm;
1681 struct vm_area_struct *vma;
1683 if (down_write_killable(&mm->mmap_sem)) {
1684 i915_gem_object_put(obj);
1687 vma = find_vma(mm, addr);
1690 pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
1693 up_write(&mm->mmap_sem);
1695 /* This may race, but that's ok, it only gets set */
1696 WRITE_ONCE(obj->frontbuffer_ggtt_origin, ORIGIN_CPU);
1698 i915_gem_object_put(obj);
1699 if (IS_ERR((void *)addr))
1702 args->addr_ptr = (uint64_t) addr;
1707 static unsigned int tile_row_pages(struct drm_i915_gem_object *obj)
1711 size = i915_gem_object_get_stride(obj);
1712 size *= i915_gem_object_get_tiling(obj) == I915_TILING_Y ? 32 : 8;
1714 return size >> PAGE_SHIFT;
1718 * i915_gem_mmap_gtt_version - report the current feature set for GTT mmaps
1720 * A history of the GTT mmap interface:
1722 * 0 - Everything had to fit into the GTT. Both parties of a memcpy had to
1723 * aligned and suitable for fencing, and still fit into the available
1724 * mappable space left by the pinned display objects. A classic problem
1725 * we called the page-fault-of-doom where we would ping-pong between
1726 * two objects that could not fit inside the GTT and so the memcpy
1727 * would page one object in at the expense of the other between every
1730 * 1 - Objects can be any size, and have any compatible fencing (X Y, or none
1731 * as set via i915_gem_set_tiling() [DRM_I915_GEM_SET_TILING]). If the
1732 * object is too large for the available space (or simply too large
1733 * for the mappable aperture!), a view is created instead and faulted
1734 * into userspace. (This view is aligned and sized appropriately for
1739 * * snoopable objects cannot be accessed via the GTT. It can cause machine
1740 * hangs on some architectures, corruption on others. An attempt to service
1741 * a GTT page fault from a snoopable object will generate a SIGBUS.
1743 * * the object must be able to fit into RAM (physical memory, though no
1744 * limited to the mappable aperture).
1749 * * a new GTT page fault will synchronize rendering from the GPU and flush
1750 * all data to system memory. Subsequent access will not be synchronized.
1752 * * all mappings are revoked on runtime device suspend.
1754 * * there are only 8, 16 or 32 fence registers to share between all users
1755 * (older machines require fence register for display and blitter access
1756 * as well). Contention of the fence registers will cause the previous users
1757 * to be unmapped and any new access will generate new page faults.
1759 * * running out of memory while servicing a fault may generate a SIGBUS,
1760 * rather than the expected SIGSEGV.
1762 int i915_gem_mmap_gtt_version(void)
1768 * i915_gem_fault - fault a page into the GTT
1769 * @area: CPU VMA in question
1772 * The fault handler is set up by drm_gem_mmap() when a object is GTT mapped
1773 * from userspace. The fault handler takes care of binding the object to
1774 * the GTT (if needed), allocating and programming a fence register (again,
1775 * only if needed based on whether the old reg is still valid or the object
1776 * is tiled) and inserting a new PTE into the faulting process.
1778 * Note that the faulting process may involve evicting existing objects
1779 * from the GTT and/or fence registers to make room. So performance may
1780 * suffer if the GTT working set is large or there are few fence registers
1783 * The current feature set supported by i915_gem_fault() and thus GTT mmaps
1784 * is exposed via I915_PARAM_MMAP_GTT_VERSION (see i915_gem_mmap_gtt_version).
1786 int i915_gem_fault(struct vm_area_struct *area, struct vm_fault *vmf)
1788 #define MIN_CHUNK_PAGES ((1 << 20) >> PAGE_SHIFT) /* 1 MiB */
1789 struct drm_i915_gem_object *obj = to_intel_bo(area->vm_private_data);
1790 struct drm_device *dev = obj->base.dev;
1791 struct drm_i915_private *dev_priv = to_i915(dev);
1792 struct i915_ggtt *ggtt = &dev_priv->ggtt;
1793 bool write = !!(vmf->flags & FAULT_FLAG_WRITE);
1794 struct i915_vma *vma;
1795 pgoff_t page_offset;
1799 /* We don't use vmf->pgoff since that has the fake offset */
1800 page_offset = ((unsigned long)vmf->virtual_address - area->vm_start) >>
1803 trace_i915_gem_object_fault(obj, page_offset, true, write);
1805 /* Try to flush the object off the GPU first without holding the lock.
1806 * Upon acquiring the lock, we will perform our sanity checks and then
1807 * repeat the flush holding the lock in the normal manner to catch cases
1808 * where we are gazumped.
1810 ret = i915_gem_object_wait(obj,
1811 I915_WAIT_INTERRUPTIBLE,
1812 MAX_SCHEDULE_TIMEOUT,
1817 ret = i915_gem_object_pin_pages(obj);
1821 intel_runtime_pm_get(dev_priv);
1823 ret = i915_mutex_lock_interruptible(dev);
1827 /* Access to snoopable pages through the GTT is incoherent. */
1828 if (obj->cache_level != I915_CACHE_NONE && !HAS_LLC(dev_priv)) {
1833 /* If the object is smaller than a couple of partial vma, it is
1834 * not worth only creating a single partial vma - we may as well
1835 * clear enough space for the full object.
1837 flags = PIN_MAPPABLE;
1838 if (obj->base.size > 2 * MIN_CHUNK_PAGES << PAGE_SHIFT)
1839 flags |= PIN_NONBLOCK | PIN_NONFAULT;
1841 /* Now pin it into the GTT as needed */
1842 vma = i915_gem_object_ggtt_pin(obj, NULL, 0, 0, flags);
1844 struct i915_ggtt_view view;
1845 unsigned int chunk_size;
1847 /* Use a partial view if it is bigger than available space */
1848 chunk_size = MIN_CHUNK_PAGES;
1849 if (i915_gem_object_is_tiled(obj))
1850 chunk_size = roundup(chunk_size, tile_row_pages(obj));
1852 memset(&view, 0, sizeof(view));
1853 view.type = I915_GGTT_VIEW_PARTIAL;
1854 view.params.partial.offset = rounddown(page_offset, chunk_size);
1855 view.params.partial.size =
1856 min_t(unsigned int, chunk_size,
1857 vma_pages(area) - view.params.partial.offset);
1859 /* If the partial covers the entire object, just create a
1862 if (chunk_size >= obj->base.size >> PAGE_SHIFT)
1863 view.type = I915_GGTT_VIEW_NORMAL;
1865 /* Userspace is now writing through an untracked VMA, abandon
1866 * all hope that the hardware is able to track future writes.
1868 obj->frontbuffer_ggtt_origin = ORIGIN_CPU;
1870 vma = i915_gem_object_ggtt_pin(obj, &view, 0, 0, PIN_MAPPABLE);
1877 ret = i915_gem_object_set_to_gtt_domain(obj, write);
1881 ret = i915_vma_get_fence(vma);
1885 /* Mark as being mmapped into userspace for later revocation */
1886 assert_rpm_wakelock_held(dev_priv);
1887 if (list_empty(&obj->userfault_link))
1888 list_add(&obj->userfault_link, &dev_priv->mm.userfault_list);
1890 /* Finally, remap it using the new GTT offset */
1891 ret = remap_io_mapping(area,
1892 area->vm_start + (vma->ggtt_view.params.partial.offset << PAGE_SHIFT),
1893 (ggtt->mappable_base + vma->node.start) >> PAGE_SHIFT,
1894 min_t(u64, vma->size, area->vm_end - area->vm_start),
1898 __i915_vma_unpin(vma);
1900 mutex_unlock(&dev->struct_mutex);
1902 intel_runtime_pm_put(dev_priv);
1903 i915_gem_object_unpin_pages(obj);
1908 * We eat errors when the gpu is terminally wedged to avoid
1909 * userspace unduly crashing (gl has no provisions for mmaps to
1910 * fail). But any other -EIO isn't ours (e.g. swap in failure)
1911 * and so needs to be reported.
1913 if (!i915_terminally_wedged(&dev_priv->gpu_error)) {
1914 ret = VM_FAULT_SIGBUS;
1919 * EAGAIN means the gpu is hung and we'll wait for the error
1920 * handler to reset everything when re-faulting in
1921 * i915_mutex_lock_interruptible.
1928 * EBUSY is ok: this just means that another thread
1929 * already did the job.
1931 ret = VM_FAULT_NOPAGE;
1938 ret = VM_FAULT_SIGBUS;
1941 WARN_ONCE(ret, "unhandled error in i915_gem_fault: %i\n", ret);
1942 ret = VM_FAULT_SIGBUS;
1949 * i915_gem_release_mmap - remove physical page mappings
1950 * @obj: obj in question
1952 * Preserve the reservation of the mmapping with the DRM core code, but
1953 * relinquish ownership of the pages back to the system.
1955 * It is vital that we remove the page mapping if we have mapped a tiled
1956 * object through the GTT and then lose the fence register due to
1957 * resource pressure. Similarly if the object has been moved out of the
1958 * aperture, than pages mapped into userspace must be revoked. Removing the
1959 * mapping will then trigger a page fault on the next user access, allowing
1960 * fixup by i915_gem_fault().
1963 i915_gem_release_mmap(struct drm_i915_gem_object *obj)
1965 struct drm_i915_private *i915 = to_i915(obj->base.dev);
1967 /* Serialisation between user GTT access and our code depends upon
1968 * revoking the CPU's PTE whilst the mutex is held. The next user
1969 * pagefault then has to wait until we release the mutex.
1971 * Note that RPM complicates somewhat by adding an additional
1972 * requirement that operations to the GGTT be made holding the RPM
1975 lockdep_assert_held(&i915->drm.struct_mutex);
1976 intel_runtime_pm_get(i915);
1978 if (list_empty(&obj->userfault_link))
1981 list_del_init(&obj->userfault_link);
1982 drm_vma_node_unmap(&obj->base.vma_node,
1983 obj->base.dev->anon_inode->i_mapping);
1985 /* Ensure that the CPU's PTE are revoked and there are not outstanding
1986 * memory transactions from userspace before we return. The TLB
1987 * flushing implied above by changing the PTE above *should* be
1988 * sufficient, an extra barrier here just provides us with a bit
1989 * of paranoid documentation about our requirement to serialise
1990 * memory writes before touching registers / GSM.
1995 intel_runtime_pm_put(i915);
1998 void i915_gem_runtime_suspend(struct drm_i915_private *dev_priv)
2000 struct drm_i915_gem_object *obj, *on;
2004 * Only called during RPM suspend. All users of the userfault_list
2005 * must be holding an RPM wakeref to ensure that this can not
2006 * run concurrently with themselves (and use the struct_mutex for
2007 * protection between themselves).
2010 list_for_each_entry_safe(obj, on,
2011 &dev_priv->mm.userfault_list, userfault_link) {
2012 list_del_init(&obj->userfault_link);
2013 drm_vma_node_unmap(&obj->base.vma_node,
2014 obj->base.dev->anon_inode->i_mapping);
2017 /* The fence will be lost when the device powers down. If any were
2018 * in use by hardware (i.e. they are pinned), we should not be powering
2019 * down! All other fences will be reacquired by the user upon waking.
2021 for (i = 0; i < dev_priv->num_fence_regs; i++) {
2022 struct drm_i915_fence_reg *reg = &dev_priv->fence_regs[i];
2024 if (WARN_ON(reg->pin_count))
2030 GEM_BUG_ON(!list_empty(®->vma->obj->userfault_link));
2036 * i915_gem_get_ggtt_size - return required global GTT size for an object
2037 * @dev_priv: i915 device
2038 * @size: object size
2039 * @tiling_mode: tiling mode
2041 * Return the required global GTT size for an object, taking into account
2042 * potential fence register mapping.
2044 u64 i915_gem_get_ggtt_size(struct drm_i915_private *dev_priv,
2045 u64 size, int tiling_mode)
2049 GEM_BUG_ON(size == 0);
2051 if (INTEL_GEN(dev_priv) >= 4 ||
2052 tiling_mode == I915_TILING_NONE)
2055 /* Previous chips need a power-of-two fence region when tiling */
2056 if (IS_GEN3(dev_priv))
2057 ggtt_size = 1024*1024;
2059 ggtt_size = 512*1024;
2061 while (ggtt_size < size)
2068 * i915_gem_get_ggtt_alignment - return required global GTT alignment
2069 * @dev_priv: i915 device
2070 * @size: object size
2071 * @tiling_mode: tiling mode
2072 * @fenced: is fenced alignment required or not
2074 * Return the required global GTT alignment for an object, taking into account
2075 * potential fence register mapping.
2077 u64 i915_gem_get_ggtt_alignment(struct drm_i915_private *dev_priv, u64 size,
2078 int tiling_mode, bool fenced)
2080 GEM_BUG_ON(size == 0);
2083 * Minimum alignment is 4k (GTT page size), but might be greater
2084 * if a fence register is needed for the object.
2086 if (INTEL_GEN(dev_priv) >= 4 || (!fenced && IS_G33(dev_priv)) ||
2087 tiling_mode == I915_TILING_NONE)
2091 * Previous chips need to be aligned to the size of the smallest
2092 * fence register that can contain the object.
2094 return i915_gem_get_ggtt_size(dev_priv, size, tiling_mode);
2097 static int i915_gem_object_create_mmap_offset(struct drm_i915_gem_object *obj)
2099 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
2102 err = drm_gem_create_mmap_offset(&obj->base);
2106 /* We can idle the GPU locklessly to flush stale objects, but in order
2107 * to claim that space for ourselves, we need to take the big
2108 * struct_mutex to free the requests+objects and allocate our slot.
2110 err = i915_gem_wait_for_idle(dev_priv, I915_WAIT_INTERRUPTIBLE);
2114 err = i915_mutex_lock_interruptible(&dev_priv->drm);
2116 i915_gem_retire_requests(dev_priv);
2117 err = drm_gem_create_mmap_offset(&obj->base);
2118 mutex_unlock(&dev_priv->drm.struct_mutex);
2124 static void i915_gem_object_free_mmap_offset(struct drm_i915_gem_object *obj)
2126 drm_gem_free_mmap_offset(&obj->base);
2130 i915_gem_mmap_gtt(struct drm_file *file,
2131 struct drm_device *dev,
2135 struct drm_i915_gem_object *obj;
2138 obj = i915_gem_object_lookup(file, handle);
2142 ret = i915_gem_object_create_mmap_offset(obj);
2144 *offset = drm_vma_node_offset_addr(&obj->base.vma_node);
2146 i915_gem_object_put(obj);
2151 * i915_gem_mmap_gtt_ioctl - prepare an object for GTT mmap'ing
2153 * @data: GTT mapping ioctl data
2154 * @file: GEM object info
2156 * Simply returns the fake offset to userspace so it can mmap it.
2157 * The mmap call will end up in drm_gem_mmap(), which will set things
2158 * up so we can get faults in the handler above.
2160 * The fault handler will take care of binding the object into the GTT
2161 * (since it may have been evicted to make room for something), allocating
2162 * a fence register, and mapping the appropriate aperture address into
2166 i915_gem_mmap_gtt_ioctl(struct drm_device *dev, void *data,
2167 struct drm_file *file)
2169 struct drm_i915_gem_mmap_gtt *args = data;
2171 return i915_gem_mmap_gtt(file, dev, args->handle, &args->offset);
2174 /* Immediately discard the backing storage */
2176 i915_gem_object_truncate(struct drm_i915_gem_object *obj)
2178 i915_gem_object_free_mmap_offset(obj);
2180 if (obj->base.filp == NULL)
2183 /* Our goal here is to return as much of the memory as
2184 * is possible back to the system as we are called from OOM.
2185 * To do this we must instruct the shmfs to drop all of its
2186 * backing pages, *now*.
2188 shmem_truncate_range(file_inode(obj->base.filp), 0, (loff_t)-1);
2189 obj->mm.madv = __I915_MADV_PURGED;
2192 /* Try to discard unwanted pages */
2193 void __i915_gem_object_invalidate(struct drm_i915_gem_object *obj)
2195 struct address_space *mapping;
2197 lockdep_assert_held(&obj->mm.lock);
2198 GEM_BUG_ON(obj->mm.pages);
2200 switch (obj->mm.madv) {
2201 case I915_MADV_DONTNEED:
2202 i915_gem_object_truncate(obj);
2203 case __I915_MADV_PURGED:
2207 if (obj->base.filp == NULL)
2210 mapping = obj->base.filp->f_mapping,
2211 invalidate_mapping_pages(mapping, 0, (loff_t)-1);
2215 i915_gem_object_put_pages_gtt(struct drm_i915_gem_object *obj,
2216 struct sg_table *pages)
2218 struct sgt_iter sgt_iter;
2221 __i915_gem_object_release_shmem(obj, pages);
2223 i915_gem_gtt_finish_pages(obj, pages);
2225 if (i915_gem_object_needs_bit17_swizzle(obj))
2226 i915_gem_object_save_bit_17_swizzle(obj, pages);
2228 for_each_sgt_page(page, sgt_iter, pages) {
2230 set_page_dirty(page);
2232 if (obj->mm.madv == I915_MADV_WILLNEED)
2233 mark_page_accessed(page);
2237 obj->mm.dirty = false;
2239 sg_free_table(pages);
2243 static void __i915_gem_object_reset_page_iter(struct drm_i915_gem_object *obj)
2245 struct radix_tree_iter iter;
2248 radix_tree_for_each_slot(slot, &obj->mm.get_page.radix, &iter, 0)
2249 radix_tree_delete(&obj->mm.get_page.radix, iter.index);
2252 void __i915_gem_object_put_pages(struct drm_i915_gem_object *obj,
2253 enum i915_mm_subclass subclass)
2255 struct sg_table *pages;
2257 if (i915_gem_object_has_pinned_pages(obj))
2260 GEM_BUG_ON(obj->bind_count);
2261 if (!READ_ONCE(obj->mm.pages))
2264 /* May be called by shrinker from within get_pages() (on another bo) */
2265 mutex_lock_nested(&obj->mm.lock, subclass);
2266 if (unlikely(atomic_read(&obj->mm.pages_pin_count)))
2269 /* ->put_pages might need to allocate memory for the bit17 swizzle
2270 * array, hence protect them from being reaped by removing them from gtt
2272 pages = fetch_and_zero(&obj->mm.pages);
2275 if (obj->mm.mapping) {
2278 ptr = ptr_mask_bits(obj->mm.mapping);
2279 if (is_vmalloc_addr(ptr))
2282 kunmap(kmap_to_page(ptr));
2284 obj->mm.mapping = NULL;
2287 __i915_gem_object_reset_page_iter(obj);
2289 obj->ops->put_pages(obj, pages);
2291 mutex_unlock(&obj->mm.lock);
2294 static unsigned int swiotlb_max_size(void)
2296 #if IS_ENABLED(CONFIG_SWIOTLB)
2297 return rounddown(swiotlb_nr_tbl() << IO_TLB_SHIFT, PAGE_SIZE);
2303 static void i915_sg_trim(struct sg_table *orig_st)
2305 struct sg_table new_st;
2306 struct scatterlist *sg, *new_sg;
2309 if (orig_st->nents == orig_st->orig_nents)
2312 if (sg_alloc_table(&new_st, orig_st->nents, GFP_KERNEL))
2315 new_sg = new_st.sgl;
2316 for_each_sg(orig_st->sgl, sg, orig_st->nents, i) {
2317 sg_set_page(new_sg, sg_page(sg), sg->length, 0);
2318 /* called before being DMA mapped, no need to copy sg->dma_* */
2319 new_sg = sg_next(new_sg);
2322 sg_free_table(orig_st);
2327 static struct sg_table *
2328 i915_gem_object_get_pages_gtt(struct drm_i915_gem_object *obj)
2330 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
2332 struct address_space *mapping;
2333 struct sg_table *st;
2334 struct scatterlist *sg;
2335 struct sgt_iter sgt_iter;
2337 unsigned long last_pfn = 0; /* suppress gcc warning */
2338 unsigned int max_segment;
2342 /* Assert that the object is not currently in any GPU domain. As it
2343 * wasn't in the GTT, there shouldn't be any way it could have been in
2346 GEM_BUG_ON(obj->base.read_domains & I915_GEM_GPU_DOMAINS);
2347 GEM_BUG_ON(obj->base.write_domain & I915_GEM_GPU_DOMAINS);
2349 max_segment = swiotlb_max_size();
2351 max_segment = rounddown(UINT_MAX, PAGE_SIZE);
2353 st = kmalloc(sizeof(*st), GFP_KERNEL);
2355 return ERR_PTR(-ENOMEM);
2357 page_count = obj->base.size / PAGE_SIZE;
2358 if (sg_alloc_table(st, page_count, GFP_KERNEL)) {
2360 return ERR_PTR(-ENOMEM);
2363 /* Get the list of pages out of our struct file. They'll be pinned
2364 * at this point until we release them.
2366 * Fail silently without starting the shrinker
2368 mapping = obj->base.filp->f_mapping;
2369 gfp = mapping_gfp_constraint(mapping, ~(__GFP_IO | __GFP_RECLAIM));
2370 gfp |= __GFP_NORETRY | __GFP_NOWARN;
2373 for (i = 0; i < page_count; i++) {
2374 page = shmem_read_mapping_page_gfp(mapping, i, gfp);
2376 i915_gem_shrink(dev_priv,
2379 I915_SHRINK_UNBOUND |
2380 I915_SHRINK_PURGEABLE);
2381 page = shmem_read_mapping_page_gfp(mapping, i, gfp);
2384 /* We've tried hard to allocate the memory by reaping
2385 * our own buffer, now let the real VM do its job and
2386 * go down in flames if truly OOM.
2388 page = shmem_read_mapping_page(mapping, i);
2390 ret = PTR_ERR(page);
2395 sg->length >= max_segment ||
2396 page_to_pfn(page) != last_pfn + 1) {
2400 sg_set_page(sg, page, PAGE_SIZE, 0);
2402 sg->length += PAGE_SIZE;
2404 last_pfn = page_to_pfn(page);
2406 /* Check that the i965g/gm workaround works. */
2407 WARN_ON((gfp & __GFP_DMA32) && (last_pfn >= 0x00100000UL));
2409 if (sg) /* loop terminated early; short sg table */
2412 /* Trim unused sg entries to avoid wasting memory. */
2415 ret = i915_gem_gtt_prepare_pages(obj, st);
2419 if (i915_gem_object_needs_bit17_swizzle(obj))
2420 i915_gem_object_do_bit_17_swizzle(obj, st);
2427 for_each_sgt_page(page, sgt_iter, st)
2432 /* shmemfs first checks if there is enough memory to allocate the page
2433 * and reports ENOSPC should there be insufficient, along with the usual
2434 * ENOMEM for a genuine allocation failure.
2436 * We use ENOSPC in our driver to mean that we have run out of aperture
2437 * space and so want to translate the error from shmemfs back to our
2438 * usual understanding of ENOMEM.
2443 return ERR_PTR(ret);
2446 void __i915_gem_object_set_pages(struct drm_i915_gem_object *obj,
2447 struct sg_table *pages)
2449 lockdep_assert_held(&obj->mm.lock);
2451 obj->mm.get_page.sg_pos = pages->sgl;
2452 obj->mm.get_page.sg_idx = 0;
2454 obj->mm.pages = pages;
2456 if (i915_gem_object_is_tiled(obj) &&
2457 to_i915(obj->base.dev)->quirks & QUIRK_PIN_SWIZZLED_PAGES) {
2458 GEM_BUG_ON(obj->mm.quirked);
2459 __i915_gem_object_pin_pages(obj);
2460 obj->mm.quirked = true;
2464 static int ____i915_gem_object_get_pages(struct drm_i915_gem_object *obj)
2466 struct sg_table *pages;
2468 GEM_BUG_ON(i915_gem_object_has_pinned_pages(obj));
2470 if (unlikely(obj->mm.madv != I915_MADV_WILLNEED)) {
2471 DRM_DEBUG("Attempting to obtain a purgeable object\n");
2475 pages = obj->ops->get_pages(obj);
2476 if (unlikely(IS_ERR(pages)))
2477 return PTR_ERR(pages);
2479 __i915_gem_object_set_pages(obj, pages);
2483 /* Ensure that the associated pages are gathered from the backing storage
2484 * and pinned into our object. i915_gem_object_pin_pages() may be called
2485 * multiple times before they are released by a single call to
2486 * i915_gem_object_unpin_pages() - once the pages are no longer referenced
2487 * either as a result of memory pressure (reaping pages under the shrinker)
2488 * or as the object is itself released.
2490 int __i915_gem_object_get_pages(struct drm_i915_gem_object *obj)
2494 err = mutex_lock_interruptible(&obj->mm.lock);
2498 if (unlikely(!obj->mm.pages)) {
2499 err = ____i915_gem_object_get_pages(obj);
2503 smp_mb__before_atomic();
2505 atomic_inc(&obj->mm.pages_pin_count);
2508 mutex_unlock(&obj->mm.lock);
2512 /* The 'mapping' part of i915_gem_object_pin_map() below */
2513 static void *i915_gem_object_map(const struct drm_i915_gem_object *obj,
2514 enum i915_map_type type)
2516 unsigned long n_pages = obj->base.size >> PAGE_SHIFT;
2517 struct sg_table *sgt = obj->mm.pages;
2518 struct sgt_iter sgt_iter;
2520 struct page *stack_pages[32];
2521 struct page **pages = stack_pages;
2522 unsigned long i = 0;
2526 /* A single page can always be kmapped */
2527 if (n_pages == 1 && type == I915_MAP_WB)
2528 return kmap(sg_page(sgt->sgl));
2530 if (n_pages > ARRAY_SIZE(stack_pages)) {
2531 /* Too big for stack -- allocate temporary array instead */
2532 pages = drm_malloc_gfp(n_pages, sizeof(*pages), GFP_TEMPORARY);
2537 for_each_sgt_page(page, sgt_iter, sgt)
2540 /* Check that we have the expected number of pages */
2541 GEM_BUG_ON(i != n_pages);
2545 pgprot = PAGE_KERNEL;
2548 pgprot = pgprot_writecombine(PAGE_KERNEL_IO);
2551 addr = vmap(pages, n_pages, 0, pgprot);
2553 if (pages != stack_pages)
2554 drm_free_large(pages);
2559 /* get, pin, and map the pages of the object into kernel space */
2560 void *i915_gem_object_pin_map(struct drm_i915_gem_object *obj,
2561 enum i915_map_type type)
2563 enum i915_map_type has_type;
2568 GEM_BUG_ON(!i915_gem_object_has_struct_page(obj));
2570 ret = mutex_lock_interruptible(&obj->mm.lock);
2572 return ERR_PTR(ret);
2575 if (!atomic_inc_not_zero(&obj->mm.pages_pin_count)) {
2576 if (unlikely(!obj->mm.pages)) {
2577 ret = ____i915_gem_object_get_pages(obj);
2581 smp_mb__before_atomic();
2583 atomic_inc(&obj->mm.pages_pin_count);
2586 GEM_BUG_ON(!obj->mm.pages);
2588 ptr = ptr_unpack_bits(obj->mm.mapping, has_type);
2589 if (ptr && has_type != type) {
2595 if (is_vmalloc_addr(ptr))
2598 kunmap(kmap_to_page(ptr));
2600 ptr = obj->mm.mapping = NULL;
2604 ptr = i915_gem_object_map(obj, type);
2610 obj->mm.mapping = ptr_pack_bits(ptr, type);
2614 mutex_unlock(&obj->mm.lock);
2618 atomic_dec(&obj->mm.pages_pin_count);
2624 static bool i915_context_is_banned(const struct i915_gem_context *ctx)
2632 if (ctx->ban_score >= CONTEXT_SCORE_BAN_THRESHOLD) {
2633 DRM_DEBUG("context hanging too often, banning!\n");
2640 static void i915_gem_context_mark_guilty(struct i915_gem_context *ctx)
2642 ctx->ban_score += CONTEXT_SCORE_GUILTY;
2644 ctx->banned = i915_context_is_banned(ctx);
2645 ctx->guilty_count++;
2647 DRM_DEBUG_DRIVER("context %s marked guilty (score %d) banned? %s\n",
2648 ctx->name, ctx->ban_score,
2649 yesno(ctx->banned));
2651 if (!ctx->banned || IS_ERR_OR_NULL(ctx->file_priv))
2654 ctx->file_priv->context_bans++;
2655 DRM_DEBUG_DRIVER("client %s has had %d context banned\n",
2656 ctx->name, ctx->file_priv->context_bans);
2659 static void i915_gem_context_mark_innocent(struct i915_gem_context *ctx)
2661 ctx->active_count++;
2664 struct drm_i915_gem_request *
2665 i915_gem_find_active_request(struct intel_engine_cs *engine)
2667 struct drm_i915_gem_request *request;
2669 /* We are called by the error capture and reset at a random
2670 * point in time. In particular, note that neither is crucially
2671 * ordered with an interrupt. After a hang, the GPU is dead and we
2672 * assume that no more writes can happen (we waited long enough for
2673 * all writes that were in transaction to be flushed) - adding an
2674 * extra delay for a recent interrupt is pointless. Hence, we do
2675 * not need an engine->irq_seqno_barrier() before the seqno reads.
2677 list_for_each_entry(request, &engine->timeline->requests, link) {
2678 if (__i915_gem_request_completed(request))
2687 static void reset_request(struct drm_i915_gem_request *request)
2689 void *vaddr = request->ring->vaddr;
2692 /* As this request likely depends on state from the lost
2693 * context, clear out all the user operations leaving the
2694 * breadcrumb at the end (so we get the fence notifications).
2696 head = request->head;
2697 if (request->postfix < head) {
2698 memset(vaddr + head, 0, request->ring->size - head);
2701 memset(vaddr + head, 0, request->postfix - head);
2704 static void i915_gem_reset_engine(struct intel_engine_cs *engine)
2706 struct drm_i915_gem_request *request;
2707 struct i915_gem_context *incomplete_ctx;
2708 struct intel_timeline *timeline;
2711 if (engine->irq_seqno_barrier)
2712 engine->irq_seqno_barrier(engine);
2714 request = i915_gem_find_active_request(engine);
2718 ring_hung = engine->hangcheck.stalled;
2719 if (engine->hangcheck.seqno != intel_engine_get_seqno(engine)) {
2720 DRM_DEBUG_DRIVER("%s pardoned, was guilty? %s\n",
2727 i915_gem_context_mark_guilty(request->ctx);
2729 i915_gem_context_mark_innocent(request->ctx);
2734 DRM_DEBUG_DRIVER("resetting %s to restart from tail of request 0x%x\n",
2735 engine->name, request->global_seqno);
2737 /* Setup the CS to resume from the breadcrumb of the hung request */
2738 engine->reset_hw(engine, request);
2740 /* Users of the default context do not rely on logical state
2741 * preserved between batches. They have to emit full state on
2742 * every batch and so it is safe to execute queued requests following
2745 * Other contexts preserve state, now corrupt. We want to skip all
2746 * queued requests that reference the corrupt context.
2748 incomplete_ctx = request->ctx;
2749 if (i915_gem_context_is_default(incomplete_ctx))
2752 list_for_each_entry_continue(request, &engine->timeline->requests, link)
2753 if (request->ctx == incomplete_ctx)
2754 reset_request(request);
2756 timeline = i915_gem_context_lookup_timeline(incomplete_ctx, engine);
2757 list_for_each_entry(request, &timeline->requests, link)
2758 reset_request(request);
2761 void i915_gem_reset(struct drm_i915_private *dev_priv)
2763 struct intel_engine_cs *engine;
2764 enum intel_engine_id id;
2766 lockdep_assert_held(&dev_priv->drm.struct_mutex);
2768 i915_gem_retire_requests(dev_priv);
2770 for_each_engine(engine, dev_priv, id)
2771 i915_gem_reset_engine(engine);
2773 i915_gem_restore_fences(dev_priv);
2775 if (dev_priv->gt.awake) {
2776 intel_sanitize_gt_powersave(dev_priv);
2777 intel_enable_gt_powersave(dev_priv);
2778 if (INTEL_GEN(dev_priv) >= 6)
2779 gen6_rps_busy(dev_priv);
2783 static void nop_submit_request(struct drm_i915_gem_request *request)
2785 i915_gem_request_submit(request);
2786 intel_engine_init_global_seqno(request->engine, request->global_seqno);
2789 static void i915_gem_cleanup_engine(struct intel_engine_cs *engine)
2791 /* We need to be sure that no thread is running the old callback as
2792 * we install the nop handler (otherwise we would submit a request
2793 * to hardware that will never complete). In order to prevent this
2794 * race, we wait until the machine is idle before making the swap
2795 * (using stop_machine()).
2797 engine->submit_request = nop_submit_request;
2799 /* Mark all pending requests as complete so that any concurrent
2800 * (lockless) lookup doesn't try and wait upon the request as we
2803 intel_engine_init_global_seqno(engine,
2804 intel_engine_last_submit(engine));
2807 * Clear the execlists queue up before freeing the requests, as those
2808 * are the ones that keep the context and ringbuffer backing objects
2812 if (i915.enable_execlists) {
2813 unsigned long flags;
2815 spin_lock_irqsave(&engine->timeline->lock, flags);
2817 i915_gem_request_put(engine->execlist_port[0].request);
2818 i915_gem_request_put(engine->execlist_port[1].request);
2819 memset(engine->execlist_port, 0, sizeof(engine->execlist_port));
2820 engine->execlist_queue = RB_ROOT;
2821 engine->execlist_first = NULL;
2823 spin_unlock_irqrestore(&engine->timeline->lock, flags);
2827 static int __i915_gem_set_wedged_BKL(void *data)
2829 struct drm_i915_private *i915 = data;
2830 struct intel_engine_cs *engine;
2831 enum intel_engine_id id;
2833 for_each_engine(engine, i915, id)
2834 i915_gem_cleanup_engine(engine);
2839 void i915_gem_set_wedged(struct drm_i915_private *dev_priv)
2841 lockdep_assert_held(&dev_priv->drm.struct_mutex);
2842 set_bit(I915_WEDGED, &dev_priv->gpu_error.flags);
2844 stop_machine(__i915_gem_set_wedged_BKL, dev_priv, NULL);
2846 i915_gem_context_lost(dev_priv);
2847 i915_gem_retire_requests(dev_priv);
2849 mod_delayed_work(dev_priv->wq, &dev_priv->gt.idle_work, 0);
2853 i915_gem_retire_work_handler(struct work_struct *work)
2855 struct drm_i915_private *dev_priv =
2856 container_of(work, typeof(*dev_priv), gt.retire_work.work);
2857 struct drm_device *dev = &dev_priv->drm;
2859 /* Come back later if the device is busy... */
2860 if (mutex_trylock(&dev->struct_mutex)) {
2861 i915_gem_retire_requests(dev_priv);
2862 mutex_unlock(&dev->struct_mutex);
2865 /* Keep the retire handler running until we are finally idle.
2866 * We do not need to do this test under locking as in the worst-case
2867 * we queue the retire worker once too often.
2869 if (READ_ONCE(dev_priv->gt.awake)) {
2870 i915_queue_hangcheck(dev_priv);
2871 queue_delayed_work(dev_priv->wq,
2872 &dev_priv->gt.retire_work,
2873 round_jiffies_up_relative(HZ));
2878 i915_gem_idle_work_handler(struct work_struct *work)
2880 struct drm_i915_private *dev_priv =
2881 container_of(work, typeof(*dev_priv), gt.idle_work.work);
2882 struct drm_device *dev = &dev_priv->drm;
2883 struct intel_engine_cs *engine;
2884 enum intel_engine_id id;
2885 bool rearm_hangcheck;
2887 if (!READ_ONCE(dev_priv->gt.awake))
2891 * Wait for last execlists context complete, but bail out in case a
2892 * new request is submitted.
2894 wait_for(READ_ONCE(dev_priv->gt.active_requests) ||
2895 intel_execlists_idle(dev_priv), 10);
2897 if (READ_ONCE(dev_priv->gt.active_requests))
2901 cancel_delayed_work_sync(&dev_priv->gpu_error.hangcheck_work);
2903 if (!mutex_trylock(&dev->struct_mutex)) {
2904 /* Currently busy, come back later */
2905 mod_delayed_work(dev_priv->wq,
2906 &dev_priv->gt.idle_work,
2907 msecs_to_jiffies(50));
2912 * New request retired after this work handler started, extend active
2913 * period until next instance of the work.
2915 if (work_pending(work))
2918 if (dev_priv->gt.active_requests)
2921 if (wait_for(intel_execlists_idle(dev_priv), 10))
2922 DRM_ERROR("Timeout waiting for engines to idle\n");
2924 for_each_engine(engine, dev_priv, id)
2925 i915_gem_batch_pool_fini(&engine->batch_pool);
2927 GEM_BUG_ON(!dev_priv->gt.awake);
2928 dev_priv->gt.awake = false;
2929 rearm_hangcheck = false;
2931 if (INTEL_GEN(dev_priv) >= 6)
2932 gen6_rps_idle(dev_priv);
2933 intel_runtime_pm_put(dev_priv);
2935 mutex_unlock(&dev->struct_mutex);
2938 if (rearm_hangcheck) {
2939 GEM_BUG_ON(!dev_priv->gt.awake);
2940 i915_queue_hangcheck(dev_priv);
2944 void i915_gem_close_object(struct drm_gem_object *gem, struct drm_file *file)
2946 struct drm_i915_gem_object *obj = to_intel_bo(gem);
2947 struct drm_i915_file_private *fpriv = file->driver_priv;
2948 struct i915_vma *vma, *vn;
2950 mutex_lock(&obj->base.dev->struct_mutex);
2951 list_for_each_entry_safe(vma, vn, &obj->vma_list, obj_link)
2952 if (vma->vm->file == fpriv)
2953 i915_vma_close(vma);
2955 if (i915_gem_object_is_active(obj) &&
2956 !i915_gem_object_has_active_reference(obj)) {
2957 i915_gem_object_set_active_reference(obj);
2958 i915_gem_object_get(obj);
2960 mutex_unlock(&obj->base.dev->struct_mutex);
2963 static unsigned long to_wait_timeout(s64 timeout_ns)
2966 return MAX_SCHEDULE_TIMEOUT;
2968 if (timeout_ns == 0)
2971 return nsecs_to_jiffies_timeout(timeout_ns);
2975 * i915_gem_wait_ioctl - implements DRM_IOCTL_I915_GEM_WAIT
2976 * @dev: drm device pointer
2977 * @data: ioctl data blob
2978 * @file: drm file pointer
2980 * Returns 0 if successful, else an error is returned with the remaining time in
2981 * the timeout parameter.
2982 * -ETIME: object is still busy after timeout
2983 * -ERESTARTSYS: signal interrupted the wait
2984 * -ENONENT: object doesn't exist
2985 * Also possible, but rare:
2986 * -EAGAIN: GPU wedged
2988 * -ENODEV: Internal IRQ fail
2989 * -E?: The add request failed
2991 * The wait ioctl with a timeout of 0 reimplements the busy ioctl. With any
2992 * non-zero timeout parameter the wait ioctl will wait for the given number of
2993 * nanoseconds on an object becoming unbusy. Since the wait itself does so
2994 * without holding struct_mutex the object may become re-busied before this
2995 * function completes. A similar but shorter * race condition exists in the busy
2999 i915_gem_wait_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
3001 struct drm_i915_gem_wait *args = data;
3002 struct drm_i915_gem_object *obj;
3006 if (args->flags != 0)
3009 obj = i915_gem_object_lookup(file, args->bo_handle);
3013 start = ktime_get();
3015 ret = i915_gem_object_wait(obj,
3016 I915_WAIT_INTERRUPTIBLE | I915_WAIT_ALL,
3017 to_wait_timeout(args->timeout_ns),
3018 to_rps_client(file));
3020 if (args->timeout_ns > 0) {
3021 args->timeout_ns -= ktime_to_ns(ktime_sub(ktime_get(), start));
3022 if (args->timeout_ns < 0)
3023 args->timeout_ns = 0;
3026 i915_gem_object_put(obj);
3030 static int wait_for_timeline(struct i915_gem_timeline *tl, unsigned int flags)
3034 for (i = 0; i < ARRAY_SIZE(tl->engine); i++) {
3035 ret = i915_gem_active_wait(&tl->engine[i].last_request, flags);
3043 int i915_gem_wait_for_idle(struct drm_i915_private *i915, unsigned int flags)
3047 if (flags & I915_WAIT_LOCKED) {
3048 struct i915_gem_timeline *tl;
3050 lockdep_assert_held(&i915->drm.struct_mutex);
3052 list_for_each_entry(tl, &i915->gt.timelines, link) {
3053 ret = wait_for_timeline(tl, flags);
3058 ret = wait_for_timeline(&i915->gt.global_timeline, flags);
3066 void i915_gem_clflush_object(struct drm_i915_gem_object *obj,
3069 /* If we don't have a page list set up, then we're not pinned
3070 * to GPU, and we can ignore the cache flush because it'll happen
3071 * again at bind time.
3077 * Stolen memory is always coherent with the GPU as it is explicitly
3078 * marked as wc by the system, or the system is cache-coherent.
3080 if (obj->stolen || obj->phys_handle)
3083 /* If the GPU is snooping the contents of the CPU cache,
3084 * we do not need to manually clear the CPU cache lines. However,
3085 * the caches are only snooped when the render cache is
3086 * flushed/invalidated. As we always have to emit invalidations
3087 * and flushes when moving into and out of the RENDER domain, correct
3088 * snooping behaviour occurs naturally as the result of our domain
3091 if (!force && cpu_cache_is_coherent(obj->base.dev, obj->cache_level)) {
3092 obj->cache_dirty = true;
3096 trace_i915_gem_object_clflush(obj);
3097 drm_clflush_sg(obj->mm.pages);
3098 obj->cache_dirty = false;
3101 /** Flushes the GTT write domain for the object if it's dirty. */
3103 i915_gem_object_flush_gtt_write_domain(struct drm_i915_gem_object *obj)
3105 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
3107 if (obj->base.write_domain != I915_GEM_DOMAIN_GTT)
3110 /* No actual flushing is required for the GTT write domain. Writes
3111 * to it "immediately" go to main memory as far as we know, so there's
3112 * no chipset flush. It also doesn't land in render cache.
3114 * However, we do have to enforce the order so that all writes through
3115 * the GTT land before any writes to the device, such as updates to
3118 * We also have to wait a bit for the writes to land from the GTT.
3119 * An uncached read (i.e. mmio) seems to be ideal for the round-trip
3120 * timing. This issue has only been observed when switching quickly
3121 * between GTT writes and CPU reads from inside the kernel on recent hw,
3122 * and it appears to only affect discrete GTT blocks (i.e. on LLC
3123 * system agents we cannot reproduce this behaviour).
3126 if (INTEL_GEN(dev_priv) >= 6 && !HAS_LLC(dev_priv))
3127 POSTING_READ(RING_ACTHD(dev_priv->engine[RCS]->mmio_base));
3129 intel_fb_obj_flush(obj, false, write_origin(obj, I915_GEM_DOMAIN_GTT));
3131 obj->base.write_domain = 0;
3132 trace_i915_gem_object_change_domain(obj,
3133 obj->base.read_domains,
3134 I915_GEM_DOMAIN_GTT);
3137 /** Flushes the CPU write domain for the object if it's dirty. */
3139 i915_gem_object_flush_cpu_write_domain(struct drm_i915_gem_object *obj)
3141 if (obj->base.write_domain != I915_GEM_DOMAIN_CPU)
3144 i915_gem_clflush_object(obj, obj->pin_display);
3145 intel_fb_obj_flush(obj, false, ORIGIN_CPU);
3147 obj->base.write_domain = 0;
3148 trace_i915_gem_object_change_domain(obj,
3149 obj->base.read_domains,
3150 I915_GEM_DOMAIN_CPU);
3154 * Moves a single object to the GTT read, and possibly write domain.
3155 * @obj: object to act on
3156 * @write: ask for write access or read only
3158 * This function returns when the move is complete, including waiting on
3162 i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj, bool write)
3164 uint32_t old_write_domain, old_read_domains;
3167 lockdep_assert_held(&obj->base.dev->struct_mutex);
3169 ret = i915_gem_object_wait(obj,
3170 I915_WAIT_INTERRUPTIBLE |
3172 (write ? I915_WAIT_ALL : 0),
3173 MAX_SCHEDULE_TIMEOUT,
3178 if (obj->base.write_domain == I915_GEM_DOMAIN_GTT)
3181 /* Flush and acquire obj->pages so that we are coherent through
3182 * direct access in memory with previous cached writes through
3183 * shmemfs and that our cache domain tracking remains valid.
3184 * For example, if the obj->filp was moved to swap without us
3185 * being notified and releasing the pages, we would mistakenly
3186 * continue to assume that the obj remained out of the CPU cached
3189 ret = i915_gem_object_pin_pages(obj);
3193 i915_gem_object_flush_cpu_write_domain(obj);
3195 /* Serialise direct access to this object with the barriers for
3196 * coherent writes from the GPU, by effectively invalidating the
3197 * GTT domain upon first access.
3199 if ((obj->base.read_domains & I915_GEM_DOMAIN_GTT) == 0)
3202 old_write_domain = obj->base.write_domain;
3203 old_read_domains = obj->base.read_domains;
3205 /* It should now be out of any other write domains, and we can update
3206 * the domain values for our changes.
3208 GEM_BUG_ON((obj->base.write_domain & ~I915_GEM_DOMAIN_GTT) != 0);
3209 obj->base.read_domains |= I915_GEM_DOMAIN_GTT;
3211 obj->base.read_domains = I915_GEM_DOMAIN_GTT;
3212 obj->base.write_domain = I915_GEM_DOMAIN_GTT;
3213 obj->mm.dirty = true;
3216 trace_i915_gem_object_change_domain(obj,
3220 i915_gem_object_unpin_pages(obj);
3225 * Changes the cache-level of an object across all VMA.
3226 * @obj: object to act on
3227 * @cache_level: new cache level to set for the object
3229 * After this function returns, the object will be in the new cache-level
3230 * across all GTT and the contents of the backing storage will be coherent,
3231 * with respect to the new cache-level. In order to keep the backing storage
3232 * coherent for all users, we only allow a single cache level to be set
3233 * globally on the object and prevent it from being changed whilst the
3234 * hardware is reading from the object. That is if the object is currently
3235 * on the scanout it will be set to uncached (or equivalent display
3236 * cache coherency) and all non-MOCS GPU access will also be uncached so
3237 * that all direct access to the scanout remains coherent.
3239 int i915_gem_object_set_cache_level(struct drm_i915_gem_object *obj,
3240 enum i915_cache_level cache_level)
3242 struct i915_vma *vma;
3245 lockdep_assert_held(&obj->base.dev->struct_mutex);
3247 if (obj->cache_level == cache_level)
3250 /* Inspect the list of currently bound VMA and unbind any that would
3251 * be invalid given the new cache-level. This is principally to
3252 * catch the issue of the CS prefetch crossing page boundaries and
3253 * reading an invalid PTE on older architectures.
3256 list_for_each_entry(vma, &obj->vma_list, obj_link) {
3257 if (!drm_mm_node_allocated(&vma->node))
3260 if (i915_vma_is_pinned(vma)) {
3261 DRM_DEBUG("can not change the cache level of pinned objects\n");
3265 if (i915_gem_valid_gtt_space(vma, cache_level))
3268 ret = i915_vma_unbind(vma);
3272 /* As unbinding may affect other elements in the
3273 * obj->vma_list (due to side-effects from retiring
3274 * an active vma), play safe and restart the iterator.
3279 /* We can reuse the existing drm_mm nodes but need to change the
3280 * cache-level on the PTE. We could simply unbind them all and
3281 * rebind with the correct cache-level on next use. However since
3282 * we already have a valid slot, dma mapping, pages etc, we may as
3283 * rewrite the PTE in the belief that doing so tramples upon less
3284 * state and so involves less work.
3286 if (obj->bind_count) {
3287 /* Before we change the PTE, the GPU must not be accessing it.
3288 * If we wait upon the object, we know that all the bound
3289 * VMA are no longer active.
3291 ret = i915_gem_object_wait(obj,
3292 I915_WAIT_INTERRUPTIBLE |
3295 MAX_SCHEDULE_TIMEOUT,
3300 if (!HAS_LLC(to_i915(obj->base.dev)) &&
3301 cache_level != I915_CACHE_NONE) {
3302 /* Access to snoopable pages through the GTT is
3303 * incoherent and on some machines causes a hard
3304 * lockup. Relinquish the CPU mmaping to force
3305 * userspace to refault in the pages and we can
3306 * then double check if the GTT mapping is still
3307 * valid for that pointer access.
3309 i915_gem_release_mmap(obj);
3311 /* As we no longer need a fence for GTT access,
3312 * we can relinquish it now (and so prevent having
3313 * to steal a fence from someone else on the next
3314 * fence request). Note GPU activity would have
3315 * dropped the fence as all snoopable access is
3316 * supposed to be linear.
3318 list_for_each_entry(vma, &obj->vma_list, obj_link) {
3319 ret = i915_vma_put_fence(vma);
3324 /* We either have incoherent backing store and
3325 * so no GTT access or the architecture is fully
3326 * coherent. In such cases, existing GTT mmaps
3327 * ignore the cache bit in the PTE and we can
3328 * rewrite it without confusing the GPU or having
3329 * to force userspace to fault back in its mmaps.
3333 list_for_each_entry(vma, &obj->vma_list, obj_link) {
3334 if (!drm_mm_node_allocated(&vma->node))
3337 ret = i915_vma_bind(vma, cache_level, PIN_UPDATE);
3343 if (obj->base.write_domain == I915_GEM_DOMAIN_CPU &&
3344 cpu_cache_is_coherent(obj->base.dev, obj->cache_level))
3345 obj->cache_dirty = true;
3347 list_for_each_entry(vma, &obj->vma_list, obj_link)
3348 vma->node.color = cache_level;
3349 obj->cache_level = cache_level;
3354 int i915_gem_get_caching_ioctl(struct drm_device *dev, void *data,
3355 struct drm_file *file)
3357 struct drm_i915_gem_caching *args = data;
3358 struct drm_i915_gem_object *obj;
3362 obj = i915_gem_object_lookup_rcu(file, args->handle);
3368 switch (obj->cache_level) {
3369 case I915_CACHE_LLC:
3370 case I915_CACHE_L3_LLC:
3371 args->caching = I915_CACHING_CACHED;
3375 args->caching = I915_CACHING_DISPLAY;
3379 args->caching = I915_CACHING_NONE;
3387 int i915_gem_set_caching_ioctl(struct drm_device *dev, void *data,
3388 struct drm_file *file)
3390 struct drm_i915_private *i915 = to_i915(dev);
3391 struct drm_i915_gem_caching *args = data;
3392 struct drm_i915_gem_object *obj;
3393 enum i915_cache_level level;
3396 switch (args->caching) {
3397 case I915_CACHING_NONE:
3398 level = I915_CACHE_NONE;
3400 case I915_CACHING_CACHED:
3402 * Due to a HW issue on BXT A stepping, GPU stores via a
3403 * snooped mapping may leave stale data in a corresponding CPU
3404 * cacheline, whereas normally such cachelines would get
3407 if (!HAS_LLC(i915) && !HAS_SNOOP(i915))
3410 level = I915_CACHE_LLC;
3412 case I915_CACHING_DISPLAY:
3413 level = HAS_WT(i915) ? I915_CACHE_WT : I915_CACHE_NONE;
3419 ret = i915_mutex_lock_interruptible(dev);
3423 obj = i915_gem_object_lookup(file, args->handle);
3429 ret = i915_gem_object_set_cache_level(obj, level);
3430 i915_gem_object_put(obj);
3432 mutex_unlock(&dev->struct_mutex);
3437 * Prepare buffer for display plane (scanout, cursors, etc).
3438 * Can be called from an uninterruptible phase (modesetting) and allows
3439 * any flushes to be pipelined (for pageflips).
3442 i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj,
3444 const struct i915_ggtt_view *view)
3446 struct i915_vma *vma;
3447 u32 old_read_domains, old_write_domain;
3450 lockdep_assert_held(&obj->base.dev->struct_mutex);
3452 /* Mark the pin_display early so that we account for the
3453 * display coherency whilst setting up the cache domains.
3457 /* The display engine is not coherent with the LLC cache on gen6. As
3458 * a result, we make sure that the pinning that is about to occur is
3459 * done with uncached PTEs. This is lowest common denominator for all
3462 * However for gen6+, we could do better by using the GFDT bit instead
3463 * of uncaching, which would allow us to flush all the LLC-cached data
3464 * with that bit in the PTE to main memory with just one PIPE_CONTROL.
3466 ret = i915_gem_object_set_cache_level(obj,
3467 HAS_WT(to_i915(obj->base.dev)) ?
3468 I915_CACHE_WT : I915_CACHE_NONE);
3471 goto err_unpin_display;
3474 /* As the user may map the buffer once pinned in the display plane
3475 * (e.g. libkms for the bootup splash), we have to ensure that we
3476 * always use map_and_fenceable for all scanout buffers. However,
3477 * it may simply be too big to fit into mappable, in which case
3478 * put it anyway and hope that userspace can cope (but always first
3479 * try to preserve the existing ABI).
3481 vma = ERR_PTR(-ENOSPC);
3482 if (view->type == I915_GGTT_VIEW_NORMAL)
3483 vma = i915_gem_object_ggtt_pin(obj, view, 0, alignment,
3484 PIN_MAPPABLE | PIN_NONBLOCK);
3486 struct drm_i915_private *i915 = to_i915(obj->base.dev);
3489 /* Valleyview is definitely limited to scanning out the first
3490 * 512MiB. Lets presume this behaviour was inherited from the
3491 * g4x display engine and that all earlier gen are similarly
3492 * limited. Testing suggests that it is a little more
3493 * complicated than this. For example, Cherryview appears quite
3494 * happy to scanout from anywhere within its global aperture.
3497 if (HAS_GMCH_DISPLAY(i915))
3498 flags = PIN_MAPPABLE;
3499 vma = i915_gem_object_ggtt_pin(obj, view, 0, alignment, flags);
3502 goto err_unpin_display;
3504 vma->display_alignment = max_t(u64, vma->display_alignment, alignment);
3506 /* Treat this as an end-of-frame, like intel_user_framebuffer_dirty() */
3507 if (obj->cache_dirty) {
3508 i915_gem_clflush_object(obj, true);
3509 intel_fb_obj_flush(obj, false, ORIGIN_DIRTYFB);
3512 old_write_domain = obj->base.write_domain;
3513 old_read_domains = obj->base.read_domains;
3515 /* It should now be out of any other write domains, and we can update
3516 * the domain values for our changes.
3518 obj->base.write_domain = 0;
3519 obj->base.read_domains |= I915_GEM_DOMAIN_GTT;
3521 trace_i915_gem_object_change_domain(obj,
3533 i915_gem_object_unpin_from_display_plane(struct i915_vma *vma)
3535 lockdep_assert_held(&vma->vm->i915->drm.struct_mutex);
3537 if (WARN_ON(vma->obj->pin_display == 0))
3540 if (--vma->obj->pin_display == 0)
3541 vma->display_alignment = 0;
3543 /* Bump the LRU to try and avoid premature eviction whilst flipping */
3544 if (!i915_vma_is_active(vma))
3545 list_move_tail(&vma->vm_link, &vma->vm->inactive_list);
3547 i915_vma_unpin(vma);
3551 * Moves a single object to the CPU read, and possibly write domain.
3552 * @obj: object to act on
3553 * @write: requesting write or read-only access
3555 * This function returns when the move is complete, including waiting on
3559 i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write)
3561 uint32_t old_write_domain, old_read_domains;
3564 lockdep_assert_held(&obj->base.dev->struct_mutex);
3566 ret = i915_gem_object_wait(obj,
3567 I915_WAIT_INTERRUPTIBLE |
3569 (write ? I915_WAIT_ALL : 0),
3570 MAX_SCHEDULE_TIMEOUT,
3575 if (obj->base.write_domain == I915_GEM_DOMAIN_CPU)
3578 i915_gem_object_flush_gtt_write_domain(obj);
3580 old_write_domain = obj->base.write_domain;
3581 old_read_domains = obj->base.read_domains;
3583 /* Flush the CPU cache if it's still invalid. */
3584 if ((obj->base.read_domains & I915_GEM_DOMAIN_CPU) == 0) {
3585 i915_gem_clflush_object(obj, false);
3587 obj->base.read_domains |= I915_GEM_DOMAIN_CPU;
3590 /* It should now be out of any other write domains, and we can update
3591 * the domain values for our changes.
3593 GEM_BUG_ON((obj->base.write_domain & ~I915_GEM_DOMAIN_CPU) != 0);
3595 /* If we're writing through the CPU, then the GPU read domains will
3596 * need to be invalidated at next use.
3599 obj->base.read_domains = I915_GEM_DOMAIN_CPU;
3600 obj->base.write_domain = I915_GEM_DOMAIN_CPU;
3603 trace_i915_gem_object_change_domain(obj,
3610 /* Throttle our rendering by waiting until the ring has completed our requests
3611 * emitted over 20 msec ago.
3613 * Note that if we were to use the current jiffies each time around the loop,
3614 * we wouldn't escape the function with any frames outstanding if the time to
3615 * render a frame was over 20ms.
3617 * This should get us reasonable parallelism between CPU and GPU but also
3618 * relatively low latency when blocking on a particular request to finish.
3621 i915_gem_ring_throttle(struct drm_device *dev, struct drm_file *file)
3623 struct drm_i915_private *dev_priv = to_i915(dev);
3624 struct drm_i915_file_private *file_priv = file->driver_priv;
3625 unsigned long recent_enough = jiffies - DRM_I915_THROTTLE_JIFFIES;
3626 struct drm_i915_gem_request *request, *target = NULL;
3629 /* ABI: return -EIO if already wedged */
3630 if (i915_terminally_wedged(&dev_priv->gpu_error))
3633 spin_lock(&file_priv->mm.lock);
3634 list_for_each_entry(request, &file_priv->mm.request_list, client_list) {
3635 if (time_after_eq(request->emitted_jiffies, recent_enough))
3639 * Note that the request might not have been submitted yet.
3640 * In which case emitted_jiffies will be zero.
3642 if (!request->emitted_jiffies)
3648 i915_gem_request_get(target);
3649 spin_unlock(&file_priv->mm.lock);
3654 ret = i915_wait_request(target,
3655 I915_WAIT_INTERRUPTIBLE,
3656 MAX_SCHEDULE_TIMEOUT);
3657 i915_gem_request_put(target);
3659 return ret < 0 ? ret : 0;
3663 i915_gem_object_ggtt_pin(struct drm_i915_gem_object *obj,
3664 const struct i915_ggtt_view *view,
3669 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
3670 struct i915_address_space *vm = &dev_priv->ggtt.base;
3671 struct i915_vma *vma;
3674 lockdep_assert_held(&obj->base.dev->struct_mutex);
3676 vma = i915_gem_obj_lookup_or_create_vma(obj, vm, view);
3680 if (i915_vma_misplaced(vma, size, alignment, flags)) {
3681 if (flags & PIN_NONBLOCK &&
3682 (i915_vma_is_pinned(vma) || i915_vma_is_active(vma)))
3683 return ERR_PTR(-ENOSPC);
3685 if (flags & PIN_MAPPABLE) {
3688 fence_size = i915_gem_get_ggtt_size(dev_priv, vma->size,
3689 i915_gem_object_get_tiling(obj));
3690 /* If the required space is larger than the available
3691 * aperture, we will not able to find a slot for the
3692 * object and unbinding the object now will be in
3693 * vain. Worse, doing so may cause us to ping-pong
3694 * the object in and out of the Global GTT and
3695 * waste a lot of cycles under the mutex.
3697 if (fence_size > dev_priv->ggtt.mappable_end)
3698 return ERR_PTR(-E2BIG);
3700 /* If NONBLOCK is set the caller is optimistically
3701 * trying to cache the full object within the mappable
3702 * aperture, and *must* have a fallback in place for
3703 * situations where we cannot bind the object. We
3704 * can be a little more lax here and use the fallback
3705 * more often to avoid costly migrations of ourselves
3706 * and other objects within the aperture.
3708 * Half-the-aperture is used as a simple heuristic.
3709 * More interesting would to do search for a free
3710 * block prior to making the commitment to unbind.
3711 * That caters for the self-harm case, and with a
3712 * little more heuristics (e.g. NOFAULT, NOEVICT)
3713 * we could try to minimise harm to others.
3715 if (flags & PIN_NONBLOCK &&
3716 fence_size > dev_priv->ggtt.mappable_end / 2)
3717 return ERR_PTR(-ENOSPC);
3720 WARN(i915_vma_is_pinned(vma),
3721 "bo is already pinned in ggtt with incorrect alignment:"
3722 " offset=%08x, req.alignment=%llx,"
3723 " req.map_and_fenceable=%d, vma->map_and_fenceable=%d\n",
3724 i915_ggtt_offset(vma), alignment,
3725 !!(flags & PIN_MAPPABLE),
3726 i915_vma_is_map_and_fenceable(vma));
3727 ret = i915_vma_unbind(vma);
3729 return ERR_PTR(ret);
3732 ret = i915_vma_pin(vma, size, alignment, flags | PIN_GLOBAL);
3734 return ERR_PTR(ret);
3739 static __always_inline unsigned int __busy_read_flag(unsigned int id)
3741 /* Note that we could alias engines in the execbuf API, but
3742 * that would be very unwise as it prevents userspace from
3743 * fine control over engine selection. Ahem.
3745 * This should be something like EXEC_MAX_ENGINE instead of
3748 BUILD_BUG_ON(I915_NUM_ENGINES > 16);
3749 return 0x10000 << id;
3752 static __always_inline unsigned int __busy_write_id(unsigned int id)
3754 /* The uABI guarantees an active writer is also amongst the read
3755 * engines. This would be true if we accessed the activity tracking
3756 * under the lock, but as we perform the lookup of the object and
3757 * its activity locklessly we can not guarantee that the last_write
3758 * being active implies that we have set the same engine flag from
3759 * last_read - hence we always set both read and write busy for
3762 return id | __busy_read_flag(id);
3765 static __always_inline unsigned int
3766 __busy_set_if_active(const struct dma_fence *fence,
3767 unsigned int (*flag)(unsigned int id))
3769 struct drm_i915_gem_request *rq;
3771 /* We have to check the current hw status of the fence as the uABI
3772 * guarantees forward progress. We could rely on the idle worker
3773 * to eventually flush us, but to minimise latency just ask the
3776 * Note we only report on the status of native fences.
3778 if (!dma_fence_is_i915(fence))
3781 /* opencode to_request() in order to avoid const warnings */
3782 rq = container_of(fence, struct drm_i915_gem_request, fence);
3783 if (i915_gem_request_completed(rq))
3786 return flag(rq->engine->exec_id);
3789 static __always_inline unsigned int
3790 busy_check_reader(const struct dma_fence *fence)
3792 return __busy_set_if_active(fence, __busy_read_flag);
3795 static __always_inline unsigned int
3796 busy_check_writer(const struct dma_fence *fence)
3801 return __busy_set_if_active(fence, __busy_write_id);
3805 i915_gem_busy_ioctl(struct drm_device *dev, void *data,
3806 struct drm_file *file)
3808 struct drm_i915_gem_busy *args = data;
3809 struct drm_i915_gem_object *obj;
3810 struct reservation_object_list *list;
3816 obj = i915_gem_object_lookup_rcu(file, args->handle);
3820 /* A discrepancy here is that we do not report the status of
3821 * non-i915 fences, i.e. even though we may report the object as idle,
3822 * a call to set-domain may still stall waiting for foreign rendering.
3823 * This also means that wait-ioctl may report an object as busy,
3824 * where busy-ioctl considers it idle.
3826 * We trade the ability to warn of foreign fences to report on which
3827 * i915 engines are active for the object.
3829 * Alternatively, we can trade that extra information on read/write
3832 * !reservation_object_test_signaled_rcu(obj->resv, true);
3833 * to report the overall busyness. This is what the wait-ioctl does.
3837 seq = raw_read_seqcount(&obj->resv->seq);
3839 /* Translate the exclusive fence to the READ *and* WRITE engine */
3840 args->busy = busy_check_writer(rcu_dereference(obj->resv->fence_excl));
3842 /* Translate shared fences to READ set of engines */
3843 list = rcu_dereference(obj->resv->fence);
3845 unsigned int shared_count = list->shared_count, i;
3847 for (i = 0; i < shared_count; ++i) {
3848 struct dma_fence *fence =
3849 rcu_dereference(list->shared[i]);
3851 args->busy |= busy_check_reader(fence);
3855 if (args->busy && read_seqcount_retry(&obj->resv->seq, seq))
3865 i915_gem_throttle_ioctl(struct drm_device *dev, void *data,
3866 struct drm_file *file_priv)
3868 return i915_gem_ring_throttle(dev, file_priv);
3872 i915_gem_madvise_ioctl(struct drm_device *dev, void *data,
3873 struct drm_file *file_priv)
3875 struct drm_i915_private *dev_priv = to_i915(dev);
3876 struct drm_i915_gem_madvise *args = data;
3877 struct drm_i915_gem_object *obj;
3880 switch (args->madv) {
3881 case I915_MADV_DONTNEED:
3882 case I915_MADV_WILLNEED:
3888 obj = i915_gem_object_lookup(file_priv, args->handle);
3892 err = mutex_lock_interruptible(&obj->mm.lock);
3896 if (obj->mm.pages &&
3897 i915_gem_object_is_tiled(obj) &&
3898 dev_priv->quirks & QUIRK_PIN_SWIZZLED_PAGES) {
3899 if (obj->mm.madv == I915_MADV_WILLNEED) {
3900 GEM_BUG_ON(!obj->mm.quirked);
3901 __i915_gem_object_unpin_pages(obj);
3902 obj->mm.quirked = false;
3904 if (args->madv == I915_MADV_WILLNEED) {
3905 GEM_BUG_ON(obj->mm.quirked);
3906 __i915_gem_object_pin_pages(obj);
3907 obj->mm.quirked = true;
3911 if (obj->mm.madv != __I915_MADV_PURGED)
3912 obj->mm.madv = args->madv;
3914 /* if the object is no longer attached, discard its backing storage */
3915 if (obj->mm.madv == I915_MADV_DONTNEED && !obj->mm.pages)
3916 i915_gem_object_truncate(obj);
3918 args->retained = obj->mm.madv != __I915_MADV_PURGED;
3919 mutex_unlock(&obj->mm.lock);
3922 i915_gem_object_put(obj);
3927 frontbuffer_retire(struct i915_gem_active *active,
3928 struct drm_i915_gem_request *request)
3930 struct drm_i915_gem_object *obj =
3931 container_of(active, typeof(*obj), frontbuffer_write);
3933 intel_fb_obj_flush(obj, true, ORIGIN_CS);
3936 void i915_gem_object_init(struct drm_i915_gem_object *obj,
3937 const struct drm_i915_gem_object_ops *ops)
3939 mutex_init(&obj->mm.lock);
3941 INIT_LIST_HEAD(&obj->global_link);
3942 INIT_LIST_HEAD(&obj->userfault_link);
3943 INIT_LIST_HEAD(&obj->obj_exec_link);
3944 INIT_LIST_HEAD(&obj->vma_list);
3945 INIT_LIST_HEAD(&obj->batch_pool_link);
3949 reservation_object_init(&obj->__builtin_resv);
3950 obj->resv = &obj->__builtin_resv;
3952 obj->frontbuffer_ggtt_origin = ORIGIN_GTT;
3953 init_request_active(&obj->frontbuffer_write, frontbuffer_retire);
3955 obj->mm.madv = I915_MADV_WILLNEED;
3956 INIT_RADIX_TREE(&obj->mm.get_page.radix, GFP_KERNEL | __GFP_NOWARN);
3957 mutex_init(&obj->mm.get_page.lock);
3959 i915_gem_info_add_obj(to_i915(obj->base.dev), obj->base.size);
3962 static const struct drm_i915_gem_object_ops i915_gem_object_ops = {
3963 .flags = I915_GEM_OBJECT_HAS_STRUCT_PAGE |
3964 I915_GEM_OBJECT_IS_SHRINKABLE,
3965 .get_pages = i915_gem_object_get_pages_gtt,
3966 .put_pages = i915_gem_object_put_pages_gtt,
3969 /* Note we don't consider signbits :| */
3970 #define overflows_type(x, T) \
3971 (sizeof(x) > sizeof(T) && (x) >> (sizeof(T) * BITS_PER_BYTE))
3973 struct drm_i915_gem_object *
3974 i915_gem_object_create(struct drm_i915_private *dev_priv, u64 size)
3976 struct drm_i915_gem_object *obj;
3977 struct address_space *mapping;
3981 /* There is a prevalence of the assumption that we fit the object's
3982 * page count inside a 32bit _signed_ variable. Let's document this and
3983 * catch if we ever need to fix it. In the meantime, if you do spot
3984 * such a local variable, please consider fixing!
3986 if (WARN_ON(size >> PAGE_SHIFT > INT_MAX))
3987 return ERR_PTR(-E2BIG);
3989 if (overflows_type(size, obj->base.size))
3990 return ERR_PTR(-E2BIG);
3992 obj = i915_gem_object_alloc(dev_priv);
3994 return ERR_PTR(-ENOMEM);
3996 ret = drm_gem_object_init(&dev_priv->drm, &obj->base, size);
4000 mask = GFP_HIGHUSER | __GFP_RECLAIMABLE;
4001 if (IS_CRESTLINE(dev_priv) || IS_BROADWATER(dev_priv)) {
4002 /* 965gm cannot relocate objects above 4GiB. */
4003 mask &= ~__GFP_HIGHMEM;
4004 mask |= __GFP_DMA32;
4007 mapping = obj->base.filp->f_mapping;
4008 mapping_set_gfp_mask(mapping, mask);
4010 i915_gem_object_init(obj, &i915_gem_object_ops);
4012 obj->base.write_domain = I915_GEM_DOMAIN_CPU;
4013 obj->base.read_domains = I915_GEM_DOMAIN_CPU;
4015 if (HAS_LLC(dev_priv)) {
4016 /* On some devices, we can have the GPU use the LLC (the CPU
4017 * cache) for about a 10% performance improvement
4018 * compared to uncached. Graphics requests other than
4019 * display scanout are coherent with the CPU in
4020 * accessing this cache. This means in this mode we
4021 * don't need to clflush on the CPU side, and on the
4022 * GPU side we only need to flush internal caches to
4023 * get data visible to the CPU.
4025 * However, we maintain the display planes as UC, and so
4026 * need to rebind when first used as such.
4028 obj->cache_level = I915_CACHE_LLC;
4030 obj->cache_level = I915_CACHE_NONE;
4032 trace_i915_gem_object_create(obj);
4037 i915_gem_object_free(obj);
4038 return ERR_PTR(ret);
4041 static bool discard_backing_storage(struct drm_i915_gem_object *obj)
4043 /* If we are the last user of the backing storage (be it shmemfs
4044 * pages or stolen etc), we know that the pages are going to be
4045 * immediately released. In this case, we can then skip copying
4046 * back the contents from the GPU.
4049 if (obj->mm.madv != I915_MADV_WILLNEED)
4052 if (obj->base.filp == NULL)
4055 /* At first glance, this looks racy, but then again so would be
4056 * userspace racing mmap against close. However, the first external
4057 * reference to the filp can only be obtained through the
4058 * i915_gem_mmap_ioctl() which safeguards us against the user
4059 * acquiring such a reference whilst we are in the middle of
4060 * freeing the object.
4062 return atomic_long_read(&obj->base.filp->f_count) == 1;
4065 static void __i915_gem_free_objects(struct drm_i915_private *i915,
4066 struct llist_node *freed)
4068 struct drm_i915_gem_object *obj, *on;
4070 mutex_lock(&i915->drm.struct_mutex);
4071 intel_runtime_pm_get(i915);
4072 llist_for_each_entry(obj, freed, freed) {
4073 struct i915_vma *vma, *vn;
4075 trace_i915_gem_object_destroy(obj);
4077 GEM_BUG_ON(i915_gem_object_is_active(obj));
4078 list_for_each_entry_safe(vma, vn,
4079 &obj->vma_list, obj_link) {
4080 GEM_BUG_ON(!i915_vma_is_ggtt(vma));
4081 GEM_BUG_ON(i915_vma_is_active(vma));
4082 vma->flags &= ~I915_VMA_PIN_MASK;
4083 i915_vma_close(vma);
4085 GEM_BUG_ON(!list_empty(&obj->vma_list));
4086 GEM_BUG_ON(!RB_EMPTY_ROOT(&obj->vma_tree));
4088 list_del(&obj->global_link);
4090 intel_runtime_pm_put(i915);
4091 mutex_unlock(&i915->drm.struct_mutex);
4093 llist_for_each_entry_safe(obj, on, freed, freed) {
4094 GEM_BUG_ON(obj->bind_count);
4095 GEM_BUG_ON(atomic_read(&obj->frontbuffer_bits));
4097 if (obj->ops->release)
4098 obj->ops->release(obj);
4100 if (WARN_ON(i915_gem_object_has_pinned_pages(obj)))
4101 atomic_set(&obj->mm.pages_pin_count, 0);
4102 __i915_gem_object_put_pages(obj, I915_MM_NORMAL);
4103 GEM_BUG_ON(obj->mm.pages);
4105 if (obj->base.import_attach)
4106 drm_prime_gem_destroy(&obj->base, NULL);
4108 reservation_object_fini(&obj->__builtin_resv);
4109 drm_gem_object_release(&obj->base);
4110 i915_gem_info_remove_obj(i915, obj->base.size);
4113 i915_gem_object_free(obj);
4117 static void i915_gem_flush_free_objects(struct drm_i915_private *i915)
4119 struct llist_node *freed;
4121 freed = llist_del_all(&i915->mm.free_list);
4122 if (unlikely(freed))
4123 __i915_gem_free_objects(i915, freed);
4126 static void __i915_gem_free_work(struct work_struct *work)
4128 struct drm_i915_private *i915 =
4129 container_of(work, struct drm_i915_private, mm.free_work);
4130 struct llist_node *freed;
4132 /* All file-owned VMA should have been released by this point through
4133 * i915_gem_close_object(), or earlier by i915_gem_context_close().
4134 * However, the object may also be bound into the global GTT (e.g.
4135 * older GPUs without per-process support, or for direct access through
4136 * the GTT either for the user or for scanout). Those VMA still need to
4140 while ((freed = llist_del_all(&i915->mm.free_list)))
4141 __i915_gem_free_objects(i915, freed);
4144 static void __i915_gem_free_object_rcu(struct rcu_head *head)
4146 struct drm_i915_gem_object *obj =
4147 container_of(head, typeof(*obj), rcu);
4148 struct drm_i915_private *i915 = to_i915(obj->base.dev);
4150 /* We can't simply use call_rcu() from i915_gem_free_object()
4151 * as we need to block whilst unbinding, and the call_rcu
4152 * task may be called from softirq context. So we take a
4153 * detour through a worker.
4155 if (llist_add(&obj->freed, &i915->mm.free_list))
4156 schedule_work(&i915->mm.free_work);
4159 void i915_gem_free_object(struct drm_gem_object *gem_obj)
4161 struct drm_i915_gem_object *obj = to_intel_bo(gem_obj);
4163 if (obj->mm.quirked)
4164 __i915_gem_object_unpin_pages(obj);
4166 if (discard_backing_storage(obj))
4167 obj->mm.madv = I915_MADV_DONTNEED;
4169 /* Before we free the object, make sure any pure RCU-only
4170 * read-side critical sections are complete, e.g.
4171 * i915_gem_busy_ioctl(). For the corresponding synchronized
4172 * lookup see i915_gem_object_lookup_rcu().
4174 call_rcu(&obj->rcu, __i915_gem_free_object_rcu);
4177 void __i915_gem_object_release_unless_active(struct drm_i915_gem_object *obj)
4179 lockdep_assert_held(&obj->base.dev->struct_mutex);
4181 GEM_BUG_ON(i915_gem_object_has_active_reference(obj));
4182 if (i915_gem_object_is_active(obj))
4183 i915_gem_object_set_active_reference(obj);
4185 i915_gem_object_put(obj);
4188 static void assert_kernel_context_is_current(struct drm_i915_private *dev_priv)
4190 struct intel_engine_cs *engine;
4191 enum intel_engine_id id;
4193 for_each_engine(engine, dev_priv, id)
4194 GEM_BUG_ON(engine->last_context != dev_priv->kernel_context);
4197 int i915_gem_suspend(struct drm_i915_private *dev_priv)
4199 struct drm_device *dev = &dev_priv->drm;
4202 intel_suspend_gt_powersave(dev_priv);
4204 mutex_lock(&dev->struct_mutex);
4206 /* We have to flush all the executing contexts to main memory so
4207 * that they can saved in the hibernation image. To ensure the last
4208 * context image is coherent, we have to switch away from it. That
4209 * leaves the dev_priv->kernel_context still active when
4210 * we actually suspend, and its image in memory may not match the GPU
4211 * state. Fortunately, the kernel_context is disposable and we do
4212 * not rely on its state.
4214 ret = i915_gem_switch_to_kernel_context(dev_priv);
4218 ret = i915_gem_wait_for_idle(dev_priv,
4219 I915_WAIT_INTERRUPTIBLE |
4224 i915_gem_retire_requests(dev_priv);
4225 GEM_BUG_ON(dev_priv->gt.active_requests);
4227 assert_kernel_context_is_current(dev_priv);
4228 i915_gem_context_lost(dev_priv);
4229 mutex_unlock(&dev->struct_mutex);
4231 cancel_delayed_work_sync(&dev_priv->gpu_error.hangcheck_work);
4232 cancel_delayed_work_sync(&dev_priv->gt.retire_work);
4233 flush_delayed_work(&dev_priv->gt.idle_work);
4234 flush_work(&dev_priv->mm.free_work);
4236 /* Assert that we sucessfully flushed all the work and
4237 * reset the GPU back to its idle, low power state.
4239 WARN_ON(dev_priv->gt.awake);
4240 WARN_ON(!intel_execlists_idle(dev_priv));
4243 * Neither the BIOS, ourselves or any other kernel
4244 * expects the system to be in execlists mode on startup,
4245 * so we need to reset the GPU back to legacy mode. And the only
4246 * known way to disable logical contexts is through a GPU reset.
4248 * So in order to leave the system in a known default configuration,
4249 * always reset the GPU upon unload and suspend. Afterwards we then
4250 * clean up the GEM state tracking, flushing off the requests and
4251 * leaving the system in a known idle state.
4253 * Note that is of the upmost importance that the GPU is idle and
4254 * all stray writes are flushed *before* we dismantle the backing
4255 * storage for the pinned objects.
4257 * However, since we are uncertain that resetting the GPU on older
4258 * machines is a good idea, we don't - just in case it leaves the
4259 * machine in an unusable condition.
4261 if (HAS_HW_CONTEXTS(dev_priv)) {
4262 int reset = intel_gpu_reset(dev_priv, ALL_ENGINES);
4263 WARN_ON(reset && reset != -ENODEV);
4269 mutex_unlock(&dev->struct_mutex);
4273 void i915_gem_resume(struct drm_i915_private *dev_priv)
4275 struct drm_device *dev = &dev_priv->drm;
4277 WARN_ON(dev_priv->gt.awake);
4279 mutex_lock(&dev->struct_mutex);
4280 i915_gem_restore_gtt_mappings(dev_priv);
4282 /* As we didn't flush the kernel context before suspend, we cannot
4283 * guarantee that the context image is complete. So let's just reset
4284 * it and start again.
4286 dev_priv->gt.resume(dev_priv);
4288 mutex_unlock(&dev->struct_mutex);
4291 void i915_gem_init_swizzling(struct drm_i915_private *dev_priv)
4293 if (INTEL_GEN(dev_priv) < 5 ||
4294 dev_priv->mm.bit_6_swizzle_x == I915_BIT_6_SWIZZLE_NONE)
4297 I915_WRITE(DISP_ARB_CTL, I915_READ(DISP_ARB_CTL) |
4298 DISP_TILE_SURFACE_SWIZZLING);
4300 if (IS_GEN5(dev_priv))
4303 I915_WRITE(TILECTL, I915_READ(TILECTL) | TILECTL_SWZCTL);
4304 if (IS_GEN6(dev_priv))
4305 I915_WRITE(ARB_MODE, _MASKED_BIT_ENABLE(ARB_MODE_SWIZZLE_SNB));
4306 else if (IS_GEN7(dev_priv))
4307 I915_WRITE(ARB_MODE, _MASKED_BIT_ENABLE(ARB_MODE_SWIZZLE_IVB));
4308 else if (IS_GEN8(dev_priv))
4309 I915_WRITE(GAMTARBMODE, _MASKED_BIT_ENABLE(ARB_MODE_SWIZZLE_BDW));
4314 static void init_unused_ring(struct drm_i915_private *dev_priv, u32 base)
4316 I915_WRITE(RING_CTL(base), 0);
4317 I915_WRITE(RING_HEAD(base), 0);
4318 I915_WRITE(RING_TAIL(base), 0);
4319 I915_WRITE(RING_START(base), 0);
4322 static void init_unused_rings(struct drm_i915_private *dev_priv)
4324 if (IS_I830(dev_priv)) {
4325 init_unused_ring(dev_priv, PRB1_BASE);
4326 init_unused_ring(dev_priv, SRB0_BASE);
4327 init_unused_ring(dev_priv, SRB1_BASE);
4328 init_unused_ring(dev_priv, SRB2_BASE);
4329 init_unused_ring(dev_priv, SRB3_BASE);
4330 } else if (IS_GEN2(dev_priv)) {
4331 init_unused_ring(dev_priv, SRB0_BASE);
4332 init_unused_ring(dev_priv, SRB1_BASE);
4333 } else if (IS_GEN3(dev_priv)) {
4334 init_unused_ring(dev_priv, PRB1_BASE);
4335 init_unused_ring(dev_priv, PRB2_BASE);
4340 i915_gem_init_hw(struct drm_i915_private *dev_priv)
4342 struct intel_engine_cs *engine;
4343 enum intel_engine_id id;
4346 dev_priv->gt.last_init_time = ktime_get();
4348 /* Double layer security blanket, see i915_gem_init() */
4349 intel_uncore_forcewake_get(dev_priv, FORCEWAKE_ALL);
4351 if (HAS_EDRAM(dev_priv) && INTEL_GEN(dev_priv) < 9)
4352 I915_WRITE(HSW_IDICR, I915_READ(HSW_IDICR) | IDIHASHMSK(0xf));
4354 if (IS_HASWELL(dev_priv))
4355 I915_WRITE(MI_PREDICATE_RESULT_2, IS_HSW_GT3(dev_priv) ?
4356 LOWER_SLICE_ENABLED : LOWER_SLICE_DISABLED);
4358 if (HAS_PCH_NOP(dev_priv)) {
4359 if (IS_IVYBRIDGE(dev_priv)) {
4360 u32 temp = I915_READ(GEN7_MSG_CTL);
4361 temp &= ~(WAIT_FOR_PCH_FLR_ACK | WAIT_FOR_PCH_RESET_ACK);
4362 I915_WRITE(GEN7_MSG_CTL, temp);
4363 } else if (INTEL_GEN(dev_priv) >= 7) {
4364 u32 temp = I915_READ(HSW_NDE_RSTWRN_OPT);
4365 temp &= ~RESET_PCH_HANDSHAKE_ENABLE;
4366 I915_WRITE(HSW_NDE_RSTWRN_OPT, temp);
4370 i915_gem_init_swizzling(dev_priv);
4373 * At least 830 can leave some of the unused rings
4374 * "active" (ie. head != tail) after resume which
4375 * will prevent c3 entry. Makes sure all unused rings
4378 init_unused_rings(dev_priv);
4380 BUG_ON(!dev_priv->kernel_context);
4382 ret = i915_ppgtt_init_hw(dev_priv);
4384 DRM_ERROR("PPGTT enable HW failed %d\n", ret);
4388 /* Need to do basic initialisation of all rings first: */
4389 for_each_engine(engine, dev_priv, id) {
4390 ret = engine->init_hw(engine);
4395 intel_mocs_init_l3cc_table(dev_priv);
4397 /* We can't enable contexts until all firmware is loaded */
4398 ret = intel_guc_setup(dev_priv);
4403 intel_uncore_forcewake_put(dev_priv, FORCEWAKE_ALL);
4407 bool intel_sanitize_semaphores(struct drm_i915_private *dev_priv, int value)
4409 if (INTEL_INFO(dev_priv)->gen < 6)
4412 /* TODO: make semaphores and Execlists play nicely together */
4413 if (i915.enable_execlists)
4419 #ifdef CONFIG_INTEL_IOMMU
4420 /* Enable semaphores on SNB when IO remapping is off */
4421 if (INTEL_INFO(dev_priv)->gen == 6 && intel_iommu_gfx_mapped)
4428 int i915_gem_init(struct drm_i915_private *dev_priv)
4432 mutex_lock(&dev_priv->drm.struct_mutex);
4434 if (!i915.enable_execlists) {
4435 dev_priv->gt.resume = intel_legacy_submission_resume;
4436 dev_priv->gt.cleanup_engine = intel_engine_cleanup;
4438 dev_priv->gt.resume = intel_lr_context_resume;
4439 dev_priv->gt.cleanup_engine = intel_logical_ring_cleanup;
4442 /* This is just a security blanket to placate dragons.
4443 * On some systems, we very sporadically observe that the first TLBs
4444 * used by the CS may be stale, despite us poking the TLB reset. If
4445 * we hold the forcewake during initialisation these problems
4446 * just magically go away.
4448 intel_uncore_forcewake_get(dev_priv, FORCEWAKE_ALL);
4450 i915_gem_init_userptr(dev_priv);
4452 ret = i915_gem_init_ggtt(dev_priv);
4456 ret = i915_gem_context_init(dev_priv);
4460 ret = intel_engines_init(dev_priv);
4464 ret = i915_gem_init_hw(dev_priv);
4466 /* Allow engine initialisation to fail by marking the GPU as
4467 * wedged. But we only want to do this where the GPU is angry,
4468 * for all other failure, such as an allocation failure, bail.
4470 DRM_ERROR("Failed to initialize GPU, declaring it wedged\n");
4471 i915_gem_set_wedged(dev_priv);
4476 intel_uncore_forcewake_put(dev_priv, FORCEWAKE_ALL);
4477 mutex_unlock(&dev_priv->drm.struct_mutex);
4483 i915_gem_cleanup_engines(struct drm_i915_private *dev_priv)
4485 struct intel_engine_cs *engine;
4486 enum intel_engine_id id;
4488 for_each_engine(engine, dev_priv, id)
4489 dev_priv->gt.cleanup_engine(engine);
4493 i915_gem_load_init_fences(struct drm_i915_private *dev_priv)
4497 if (INTEL_INFO(dev_priv)->gen >= 7 && !IS_VALLEYVIEW(dev_priv) &&
4498 !IS_CHERRYVIEW(dev_priv))
4499 dev_priv->num_fence_regs = 32;
4500 else if (INTEL_INFO(dev_priv)->gen >= 4 || IS_I945G(dev_priv) ||
4501 IS_I945GM(dev_priv) || IS_G33(dev_priv))
4502 dev_priv->num_fence_regs = 16;
4504 dev_priv->num_fence_regs = 8;
4506 if (intel_vgpu_active(dev_priv))
4507 dev_priv->num_fence_regs =
4508 I915_READ(vgtif_reg(avail_rs.fence_num));
4510 /* Initialize fence registers to zero */
4511 for (i = 0; i < dev_priv->num_fence_regs; i++) {
4512 struct drm_i915_fence_reg *fence = &dev_priv->fence_regs[i];
4514 fence->i915 = dev_priv;
4516 list_add_tail(&fence->link, &dev_priv->mm.fence_list);
4518 i915_gem_restore_fences(dev_priv);
4520 i915_gem_detect_bit_6_swizzle(dev_priv);
4524 i915_gem_load_init(struct drm_i915_private *dev_priv)
4528 dev_priv->objects = KMEM_CACHE(drm_i915_gem_object, SLAB_HWCACHE_ALIGN);
4529 if (!dev_priv->objects)
4532 dev_priv->vmas = KMEM_CACHE(i915_vma, SLAB_HWCACHE_ALIGN);
4533 if (!dev_priv->vmas)
4536 dev_priv->requests = KMEM_CACHE(drm_i915_gem_request,
4537 SLAB_HWCACHE_ALIGN |
4538 SLAB_RECLAIM_ACCOUNT |
4539 SLAB_DESTROY_BY_RCU);
4540 if (!dev_priv->requests)
4543 dev_priv->dependencies = KMEM_CACHE(i915_dependency,
4544 SLAB_HWCACHE_ALIGN |
4545 SLAB_RECLAIM_ACCOUNT);
4546 if (!dev_priv->dependencies)
4549 mutex_lock(&dev_priv->drm.struct_mutex);
4550 INIT_LIST_HEAD(&dev_priv->gt.timelines);
4551 err = i915_gem_timeline_init__global(dev_priv);
4552 mutex_unlock(&dev_priv->drm.struct_mutex);
4554 goto err_dependencies;
4556 INIT_LIST_HEAD(&dev_priv->context_list);
4557 INIT_WORK(&dev_priv->mm.free_work, __i915_gem_free_work);
4558 init_llist_head(&dev_priv->mm.free_list);
4559 INIT_LIST_HEAD(&dev_priv->mm.unbound_list);
4560 INIT_LIST_HEAD(&dev_priv->mm.bound_list);
4561 INIT_LIST_HEAD(&dev_priv->mm.fence_list);
4562 INIT_LIST_HEAD(&dev_priv->mm.userfault_list);
4563 INIT_DELAYED_WORK(&dev_priv->gt.retire_work,
4564 i915_gem_retire_work_handler);
4565 INIT_DELAYED_WORK(&dev_priv->gt.idle_work,
4566 i915_gem_idle_work_handler);
4567 init_waitqueue_head(&dev_priv->gpu_error.wait_queue);
4568 init_waitqueue_head(&dev_priv->gpu_error.reset_queue);
4570 dev_priv->relative_constants_mode = I915_EXEC_CONSTANTS_REL_GENERAL;
4572 init_waitqueue_head(&dev_priv->pending_flip_queue);
4574 dev_priv->mm.interruptible = true;
4576 atomic_set(&dev_priv->mm.bsd_engine_dispatch_index, 0);
4578 spin_lock_init(&dev_priv->fb_tracking.lock);
4583 kmem_cache_destroy(dev_priv->dependencies);
4585 kmem_cache_destroy(dev_priv->requests);
4587 kmem_cache_destroy(dev_priv->vmas);
4589 kmem_cache_destroy(dev_priv->objects);
4594 void i915_gem_load_cleanup(struct drm_i915_private *dev_priv)
4596 WARN_ON(!llist_empty(&dev_priv->mm.free_list));
4598 mutex_lock(&dev_priv->drm.struct_mutex);
4599 i915_gem_timeline_fini(&dev_priv->gt.global_timeline);
4600 WARN_ON(!list_empty(&dev_priv->gt.timelines));
4601 mutex_unlock(&dev_priv->drm.struct_mutex);
4603 kmem_cache_destroy(dev_priv->dependencies);
4604 kmem_cache_destroy(dev_priv->requests);
4605 kmem_cache_destroy(dev_priv->vmas);
4606 kmem_cache_destroy(dev_priv->objects);
4608 /* And ensure that our DESTROY_BY_RCU slabs are truly destroyed */
4612 int i915_gem_freeze(struct drm_i915_private *dev_priv)
4614 intel_runtime_pm_get(dev_priv);
4616 mutex_lock(&dev_priv->drm.struct_mutex);
4617 i915_gem_shrink_all(dev_priv);
4618 mutex_unlock(&dev_priv->drm.struct_mutex);
4620 intel_runtime_pm_put(dev_priv);
4625 int i915_gem_freeze_late(struct drm_i915_private *dev_priv)
4627 struct drm_i915_gem_object *obj;
4628 struct list_head *phases[] = {
4629 &dev_priv->mm.unbound_list,
4630 &dev_priv->mm.bound_list,
4634 /* Called just before we write the hibernation image.
4636 * We need to update the domain tracking to reflect that the CPU
4637 * will be accessing all the pages to create and restore from the
4638 * hibernation, and so upon restoration those pages will be in the
4641 * To make sure the hibernation image contains the latest state,
4642 * we update that state just before writing out the image.
4644 * To try and reduce the hibernation image, we manually shrink
4645 * the objects as well.
4648 mutex_lock(&dev_priv->drm.struct_mutex);
4649 i915_gem_shrink(dev_priv, -1UL, I915_SHRINK_UNBOUND);
4651 for (p = phases; *p; p++) {
4652 list_for_each_entry(obj, *p, global_link) {
4653 obj->base.read_domains = I915_GEM_DOMAIN_CPU;
4654 obj->base.write_domain = I915_GEM_DOMAIN_CPU;
4657 mutex_unlock(&dev_priv->drm.struct_mutex);
4662 void i915_gem_release(struct drm_device *dev, struct drm_file *file)
4664 struct drm_i915_file_private *file_priv = file->driver_priv;
4665 struct drm_i915_gem_request *request;
4667 /* Clean up our request list when the client is going away, so that
4668 * later retire_requests won't dereference our soon-to-be-gone
4671 spin_lock(&file_priv->mm.lock);
4672 list_for_each_entry(request, &file_priv->mm.request_list, client_list)
4673 request->file_priv = NULL;
4674 spin_unlock(&file_priv->mm.lock);
4676 if (!list_empty(&file_priv->rps.link)) {
4677 spin_lock(&to_i915(dev)->rps.client_lock);
4678 list_del(&file_priv->rps.link);
4679 spin_unlock(&to_i915(dev)->rps.client_lock);
4683 int i915_gem_open(struct drm_device *dev, struct drm_file *file)
4685 struct drm_i915_file_private *file_priv;
4690 file_priv = kzalloc(sizeof(*file_priv), GFP_KERNEL);
4694 file->driver_priv = file_priv;
4695 file_priv->dev_priv = to_i915(dev);
4696 file_priv->file = file;
4697 INIT_LIST_HEAD(&file_priv->rps.link);
4699 spin_lock_init(&file_priv->mm.lock);
4700 INIT_LIST_HEAD(&file_priv->mm.request_list);
4702 file_priv->bsd_engine = -1;
4704 ret = i915_gem_context_open(dev, file);
4712 * i915_gem_track_fb - update frontbuffer tracking
4713 * @old: current GEM buffer for the frontbuffer slots
4714 * @new: new GEM buffer for the frontbuffer slots
4715 * @frontbuffer_bits: bitmask of frontbuffer slots
4717 * This updates the frontbuffer tracking bits @frontbuffer_bits by clearing them
4718 * from @old and setting them in @new. Both @old and @new can be NULL.
4720 void i915_gem_track_fb(struct drm_i915_gem_object *old,
4721 struct drm_i915_gem_object *new,
4722 unsigned frontbuffer_bits)
4724 /* Control of individual bits within the mask are guarded by
4725 * the owning plane->mutex, i.e. we can never see concurrent
4726 * manipulation of individual bits. But since the bitfield as a whole
4727 * is updated using RMW, we need to use atomics in order to update
4730 BUILD_BUG_ON(INTEL_FRONTBUFFER_BITS_PER_PIPE * I915_MAX_PIPES >
4731 sizeof(atomic_t) * BITS_PER_BYTE);
4734 WARN_ON(!(atomic_read(&old->frontbuffer_bits) & frontbuffer_bits));
4735 atomic_andnot(frontbuffer_bits, &old->frontbuffer_bits);
4739 WARN_ON(atomic_read(&new->frontbuffer_bits) & frontbuffer_bits);
4740 atomic_or(frontbuffer_bits, &new->frontbuffer_bits);
4744 /* Allocate a new GEM object and fill it with the supplied data */
4745 struct drm_i915_gem_object *
4746 i915_gem_object_create_from_data(struct drm_i915_private *dev_priv,
4747 const void *data, size_t size)
4749 struct drm_i915_gem_object *obj;
4750 struct sg_table *sg;
4754 obj = i915_gem_object_create(dev_priv, round_up(size, PAGE_SIZE));
4758 ret = i915_gem_object_set_to_cpu_domain(obj, true);
4762 ret = i915_gem_object_pin_pages(obj);
4767 bytes = sg_copy_from_buffer(sg->sgl, sg->nents, (void *)data, size);
4768 obj->mm.dirty = true; /* Backing store is now out of date */
4769 i915_gem_object_unpin_pages(obj);
4771 if (WARN_ON(bytes != size)) {
4772 DRM_ERROR("Incomplete copy, wrote %zu of %zu", bytes, size);
4780 i915_gem_object_put(obj);
4781 return ERR_PTR(ret);
4784 struct scatterlist *
4785 i915_gem_object_get_sg(struct drm_i915_gem_object *obj,
4787 unsigned int *offset)
4789 struct i915_gem_object_page_iter *iter = &obj->mm.get_page;
4790 struct scatterlist *sg;
4791 unsigned int idx, count;
4794 GEM_BUG_ON(n >= obj->base.size >> PAGE_SHIFT);
4795 GEM_BUG_ON(!i915_gem_object_has_pinned_pages(obj));
4797 /* As we iterate forward through the sg, we record each entry in a
4798 * radixtree for quick repeated (backwards) lookups. If we have seen
4799 * this index previously, we will have an entry for it.
4801 * Initial lookup is O(N), but this is amortized to O(1) for
4802 * sequential page access (where each new request is consecutive
4803 * to the previous one). Repeated lookups are O(lg(obj->base.size)),
4804 * i.e. O(1) with a large constant!
4806 if (n < READ_ONCE(iter->sg_idx))
4809 mutex_lock(&iter->lock);
4811 /* We prefer to reuse the last sg so that repeated lookup of this
4812 * (or the subsequent) sg are fast - comparing against the last
4813 * sg is faster than going through the radixtree.
4818 count = __sg_page_count(sg);
4820 while (idx + count <= n) {
4821 unsigned long exception, i;
4824 /* If we cannot allocate and insert this entry, or the
4825 * individual pages from this range, cancel updating the
4826 * sg_idx so that on this lookup we are forced to linearly
4827 * scan onwards, but on future lookups we will try the
4828 * insertion again (in which case we need to be careful of
4829 * the error return reporting that we have already inserted
4832 ret = radix_tree_insert(&iter->radix, idx, sg);
4833 if (ret && ret != -EEXIST)
4837 RADIX_TREE_EXCEPTIONAL_ENTRY |
4838 idx << RADIX_TREE_EXCEPTIONAL_SHIFT;
4839 for (i = 1; i < count; i++) {
4840 ret = radix_tree_insert(&iter->radix, idx + i,
4842 if (ret && ret != -EEXIST)
4847 sg = ____sg_next(sg);
4848 count = __sg_page_count(sg);
4855 mutex_unlock(&iter->lock);
4857 if (unlikely(n < idx)) /* insertion completed by another thread */
4860 /* In case we failed to insert the entry into the radixtree, we need
4861 * to look beyond the current sg.
4863 while (idx + count <= n) {
4865 sg = ____sg_next(sg);
4866 count = __sg_page_count(sg);
4875 sg = radix_tree_lookup(&iter->radix, n);
4878 /* If this index is in the middle of multi-page sg entry,
4879 * the radixtree will contain an exceptional entry that points
4880 * to the start of that range. We will return the pointer to
4881 * the base page and the offset of this page within the
4885 if (unlikely(radix_tree_exception(sg))) {
4886 unsigned long base =
4887 (unsigned long)sg >> RADIX_TREE_EXCEPTIONAL_SHIFT;
4889 sg = radix_tree_lookup(&iter->radix, base);
4901 i915_gem_object_get_page(struct drm_i915_gem_object *obj, unsigned int n)
4903 struct scatterlist *sg;
4904 unsigned int offset;
4906 GEM_BUG_ON(!i915_gem_object_has_struct_page(obj));
4908 sg = i915_gem_object_get_sg(obj, n, &offset);
4909 return nth_page(sg_page(sg), offset);
4912 /* Like i915_gem_object_get_page(), but mark the returned page dirty */
4914 i915_gem_object_get_dirty_page(struct drm_i915_gem_object *obj,
4919 page = i915_gem_object_get_page(obj, n);
4921 set_page_dirty(page);
4927 i915_gem_object_get_dma_address(struct drm_i915_gem_object *obj,
4930 struct scatterlist *sg;
4931 unsigned int offset;
4933 sg = i915_gem_object_get_sg(obj, n, &offset);
4934 return sg_dma_address(sg) + (offset << PAGE_SHIFT);