drm: Add missing field copy in compat_drm_version
[muen/linux.git] / drivers / gpu / drm / i915 / i915_gem_execbuffer.c
1 /*
2  * Copyright © 2008,2010 Intel Corporation
3  *
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:
10  *
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
13  * Software.
14  *
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
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *    Chris Wilson <chris@chris-wilson.co.uk>
26  *
27  */
28
29 #include <linux/dma_remapping.h>
30 #include <linux/reservation.h>
31 #include <linux/sync_file.h>
32 #include <linux/uaccess.h>
33
34 #include <drm/drmP.h>
35 #include <drm/i915_drm.h>
36
37 #include "i915_drv.h"
38 #include "i915_gem_clflush.h"
39 #include "i915_trace.h"
40 #include "intel_drv.h"
41 #include "intel_frontbuffer.h"
42
43 enum {
44         FORCE_CPU_RELOC = 1,
45         FORCE_GTT_RELOC,
46         FORCE_GPU_RELOC,
47 #define DBG_FORCE_RELOC 0 /* choose one of the above! */
48 };
49
50 #define __EXEC_OBJECT_HAS_REF           BIT(31)
51 #define __EXEC_OBJECT_HAS_PIN           BIT(30)
52 #define __EXEC_OBJECT_HAS_FENCE         BIT(29)
53 #define __EXEC_OBJECT_NEEDS_MAP         BIT(28)
54 #define __EXEC_OBJECT_NEEDS_BIAS        BIT(27)
55 #define __EXEC_OBJECT_INTERNAL_FLAGS    (~0u << 27) /* all of the above */
56 #define __EXEC_OBJECT_RESERVED (__EXEC_OBJECT_HAS_PIN | __EXEC_OBJECT_HAS_FENCE)
57
58 #define __EXEC_HAS_RELOC        BIT(31)
59 #define __EXEC_VALIDATED        BIT(30)
60 #define UPDATE                  PIN_OFFSET_FIXED
61
62 #define BATCH_OFFSET_BIAS (256*1024)
63
64 #define __I915_EXEC_ILLEGAL_FLAGS \
65         (__I915_EXEC_UNKNOWN_FLAGS | I915_EXEC_CONSTANTS_MASK)
66
67 /**
68  * DOC: User command execution
69  *
70  * Userspace submits commands to be executed on the GPU as an instruction
71  * stream within a GEM object we call a batchbuffer. This instructions may
72  * refer to other GEM objects containing auxiliary state such as kernels,
73  * samplers, render targets and even secondary batchbuffers. Userspace does
74  * not know where in the GPU memory these objects reside and so before the
75  * batchbuffer is passed to the GPU for execution, those addresses in the
76  * batchbuffer and auxiliary objects are updated. This is known as relocation,
77  * or patching. To try and avoid having to relocate each object on the next
78  * execution, userspace is told the location of those objects in this pass,
79  * but this remains just a hint as the kernel may choose a new location for
80  * any object in the future.
81  *
82  * Processing an execbuf ioctl is conceptually split up into a few phases.
83  *
84  * 1. Validation - Ensure all the pointers, handles and flags are valid.
85  * 2. Reservation - Assign GPU address space for every object
86  * 3. Relocation - Update any addresses to point to the final locations
87  * 4. Serialisation - Order the request with respect to its dependencies
88  * 5. Construction - Construct a request to execute the batchbuffer
89  * 6. Submission (at some point in the future execution)
90  *
91  * Reserving resources for the execbuf is the most complicated phase. We
92  * neither want to have to migrate the object in the address space, nor do
93  * we want to have to update any relocations pointing to this object. Ideally,
94  * we want to leave the object where it is and for all the existing relocations
95  * to match. If the object is given a new address, or if userspace thinks the
96  * object is elsewhere, we have to parse all the relocation entries and update
97  * the addresses. Userspace can set the I915_EXEC_NORELOC flag to hint that
98  * all the target addresses in all of its objects match the value in the
99  * relocation entries and that they all match the presumed offsets given by the
100  * list of execbuffer objects. Using this knowledge, we know that if we haven't
101  * moved any buffers, all the relocation entries are valid and we can skip
102  * the update. (If userspace is wrong, the likely outcome is an impromptu GPU
103  * hang.) The requirement for using I915_EXEC_NO_RELOC are:
104  *
105  *      The addresses written in the objects must match the corresponding
106  *      reloc.presumed_offset which in turn must match the corresponding
107  *      execobject.offset.
108  *
109  *      Any render targets written to in the batch must be flagged with
110  *      EXEC_OBJECT_WRITE.
111  *
112  *      To avoid stalling, execobject.offset should match the current
113  *      address of that object within the active context.
114  *
115  * The reservation is done is multiple phases. First we try and keep any
116  * object already bound in its current location - so as long as meets the
117  * constraints imposed by the new execbuffer. Any object left unbound after the
118  * first pass is then fitted into any available idle space. If an object does
119  * not fit, all objects are removed from the reservation and the process rerun
120  * after sorting the objects into a priority order (more difficult to fit
121  * objects are tried first). Failing that, the entire VM is cleared and we try
122  * to fit the execbuf once last time before concluding that it simply will not
123  * fit.
124  *
125  * A small complication to all of this is that we allow userspace not only to
126  * specify an alignment and a size for the object in the address space, but
127  * we also allow userspace to specify the exact offset. This objects are
128  * simpler to place (the location is known a priori) all we have to do is make
129  * sure the space is available.
130  *
131  * Once all the objects are in place, patching up the buried pointers to point
132  * to the final locations is a fairly simple job of walking over the relocation
133  * entry arrays, looking up the right address and rewriting the value into
134  * the object. Simple! ... The relocation entries are stored in user memory
135  * and so to access them we have to copy them into a local buffer. That copy
136  * has to avoid taking any pagefaults as they may lead back to a GEM object
137  * requiring the struct_mutex (i.e. recursive deadlock). So once again we split
138  * the relocation into multiple passes. First we try to do everything within an
139  * atomic context (avoid the pagefaults) which requires that we never wait. If
140  * we detect that we may wait, or if we need to fault, then we have to fallback
141  * to a slower path. The slowpath has to drop the mutex. (Can you hear alarm
142  * bells yet?) Dropping the mutex means that we lose all the state we have
143  * built up so far for the execbuf and we must reset any global data. However,
144  * we do leave the objects pinned in their final locations - which is a
145  * potential issue for concurrent execbufs. Once we have left the mutex, we can
146  * allocate and copy all the relocation entries into a large array at our
147  * leisure, reacquire the mutex, reclaim all the objects and other state and
148  * then proceed to update any incorrect addresses with the objects.
149  *
150  * As we process the relocation entries, we maintain a record of whether the
151  * object is being written to. Using NORELOC, we expect userspace to provide
152  * this information instead. We also check whether we can skip the relocation
153  * by comparing the expected value inside the relocation entry with the target's
154  * final address. If they differ, we have to map the current object and rewrite
155  * the 4 or 8 byte pointer within.
156  *
157  * Serialising an execbuf is quite simple according to the rules of the GEM
158  * ABI. Execution within each context is ordered by the order of submission.
159  * Writes to any GEM object are in order of submission and are exclusive. Reads
160  * from a GEM object are unordered with respect to other reads, but ordered by
161  * writes. A write submitted after a read cannot occur before the read, and
162  * similarly any read submitted after a write cannot occur before the write.
163  * Writes are ordered between engines such that only one write occurs at any
164  * time (completing any reads beforehand) - using semaphores where available
165  * and CPU serialisation otherwise. Other GEM access obey the same rules, any
166  * write (either via mmaps using set-domain, or via pwrite) must flush all GPU
167  * reads before starting, and any read (either using set-domain or pread) must
168  * flush all GPU writes before starting. (Note we only employ a barrier before,
169  * we currently rely on userspace not concurrently starting a new execution
170  * whilst reading or writing to an object. This may be an advantage or not
171  * depending on how much you trust userspace not to shoot themselves in the
172  * foot.) Serialisation may just result in the request being inserted into
173  * a DAG awaiting its turn, but most simple is to wait on the CPU until
174  * all dependencies are resolved.
175  *
176  * After all of that, is just a matter of closing the request and handing it to
177  * the hardware (well, leaving it in a queue to be executed). However, we also
178  * offer the ability for batchbuffers to be run with elevated privileges so
179  * that they access otherwise hidden registers. (Used to adjust L3 cache etc.)
180  * Before any batch is given extra privileges we first must check that it
181  * contains no nefarious instructions, we check that each instruction is from
182  * our whitelist and all registers are also from an allowed list. We first
183  * copy the user's batchbuffer to a shadow (so that the user doesn't have
184  * access to it, either by the CPU or GPU as we scan it) and then parse each
185  * instruction. If everything is ok, we set a flag telling the hardware to run
186  * the batchbuffer in trusted mode, otherwise the ioctl is rejected.
187  */
188
189 struct i915_execbuffer {
190         struct drm_i915_private *i915; /** i915 backpointer */
191         struct drm_file *file; /** per-file lookup tables and limits */
192         struct drm_i915_gem_execbuffer2 *args; /** ioctl parameters */
193         struct drm_i915_gem_exec_object2 *exec; /** ioctl execobj[] */
194
195         struct intel_engine_cs *engine; /** engine to queue the request to */
196         struct i915_gem_context *ctx; /** context for building the request */
197         struct i915_address_space *vm; /** GTT and vma for the request */
198
199         struct drm_i915_gem_request *request; /** our request to build */
200         struct i915_vma *batch; /** identity of the batch obj/vma */
201
202         /** actual size of execobj[] as we may extend it for the cmdparser */
203         unsigned int buffer_count;
204
205         /** list of vma not yet bound during reservation phase */
206         struct list_head unbound;
207
208         /** list of vma that have execobj.relocation_count */
209         struct list_head relocs;
210
211         /**
212          * Track the most recently used object for relocations, as we
213          * frequently have to perform multiple relocations within the same
214          * obj/page
215          */
216         struct reloc_cache {
217                 struct drm_mm_node node; /** temporary GTT binding */
218                 unsigned long vaddr; /** Current kmap address */
219                 unsigned long page; /** Currently mapped page index */
220                 unsigned int gen; /** Cached value of INTEL_GEN */
221                 bool use_64bit_reloc : 1;
222                 bool has_llc : 1;
223                 bool has_fence : 1;
224                 bool needs_unfenced : 1;
225
226                 struct drm_i915_gem_request *rq;
227                 u32 *rq_cmd;
228                 unsigned int rq_size;
229         } reloc_cache;
230
231         u64 invalid_flags; /** Set of execobj.flags that are invalid */
232         u32 context_flags; /** Set of execobj.flags to insert from the ctx */
233
234         u32 batch_start_offset; /** Location within object of batch */
235         u32 batch_len; /** Length of batch within object */
236         u32 batch_flags; /** Flags composed for emit_bb_start() */
237
238         /**
239          * Indicate either the size of the hastable used to resolve
240          * relocation handles, or if negative that we are using a direct
241          * index into the execobj[].
242          */
243         int lut_size;
244         struct hlist_head *buckets; /** ht for relocation handles */
245 };
246
247 /*
248  * As an alternative to creating a hashtable of handle-to-vma for a batch,
249  * we used the last available reserved field in the execobject[] and stash
250  * a link from the execobj to its vma.
251  */
252 #define __exec_to_vma(ee) (ee)->rsvd2
253 #define exec_to_vma(ee) u64_to_ptr(struct i915_vma, __exec_to_vma(ee))
254
255 /*
256  * Used to convert any address to canonical form.
257  * Starting from gen8, some commands (e.g. STATE_BASE_ADDRESS,
258  * MI_LOAD_REGISTER_MEM and others, see Broadwell PRM Vol2a) require the
259  * addresses to be in a canonical form:
260  * "GraphicsAddress[63:48] are ignored by the HW and assumed to be in correct
261  * canonical form [63:48] == [47]."
262  */
263 #define GEN8_HIGH_ADDRESS_BIT 47
264 static inline u64 gen8_canonical_addr(u64 address)
265 {
266         return sign_extend64(address, GEN8_HIGH_ADDRESS_BIT);
267 }
268
269 static inline u64 gen8_noncanonical_addr(u64 address)
270 {
271         return address & GENMASK_ULL(GEN8_HIGH_ADDRESS_BIT, 0);
272 }
273
274 static int eb_create(struct i915_execbuffer *eb)
275 {
276         if (!(eb->args->flags & I915_EXEC_HANDLE_LUT)) {
277                 unsigned int size = 1 + ilog2(eb->buffer_count);
278
279                 /*
280                  * Without a 1:1 association between relocation handles and
281                  * the execobject[] index, we instead create a hashtable.
282                  * We size it dynamically based on available memory, starting
283                  * first with 1:1 assocative hash and scaling back until
284                  * the allocation succeeds.
285                  *
286                  * Later on we use a positive lut_size to indicate we are
287                  * using this hashtable, and a negative value to indicate a
288                  * direct lookup.
289                  */
290                 do {
291                         eb->buckets = kzalloc(sizeof(struct hlist_head) << size,
292                                               GFP_TEMPORARY |
293                                               __GFP_NORETRY |
294                                               __GFP_NOWARN);
295                         if (eb->buckets)
296                                 break;
297                 } while (--size);
298
299                 if (unlikely(!eb->buckets)) {
300                         eb->buckets = kzalloc(sizeof(struct hlist_head),
301                                               GFP_TEMPORARY);
302                         if (unlikely(!eb->buckets))
303                                 return -ENOMEM;
304                 }
305
306                 eb->lut_size = size;
307         } else {
308                 eb->lut_size = -eb->buffer_count;
309         }
310
311         return 0;
312 }
313
314 static bool
315 eb_vma_misplaced(const struct drm_i915_gem_exec_object2 *entry,
316                  const struct i915_vma *vma)
317 {
318         if (!(entry->flags & __EXEC_OBJECT_HAS_PIN))
319                 return true;
320
321         if (vma->node.size < entry->pad_to_size)
322                 return true;
323
324         if (entry->alignment && !IS_ALIGNED(vma->node.start, entry->alignment))
325                 return true;
326
327         if (entry->flags & EXEC_OBJECT_PINNED &&
328             vma->node.start != entry->offset)
329                 return true;
330
331         if (entry->flags & __EXEC_OBJECT_NEEDS_BIAS &&
332             vma->node.start < BATCH_OFFSET_BIAS)
333                 return true;
334
335         if (!(entry->flags & EXEC_OBJECT_SUPPORTS_48B_ADDRESS) &&
336             (vma->node.start + vma->node.size - 1) >> 32)
337                 return true;
338
339         return false;
340 }
341
342 static inline void
343 eb_pin_vma(struct i915_execbuffer *eb,
344            struct drm_i915_gem_exec_object2 *entry,
345            struct i915_vma *vma)
346 {
347         u64 flags;
348
349         if (vma->node.size)
350                 flags = vma->node.start;
351         else
352                 flags = entry->offset & PIN_OFFSET_MASK;
353
354         flags |= PIN_USER | PIN_NOEVICT | PIN_OFFSET_FIXED;
355         if (unlikely(entry->flags & EXEC_OBJECT_NEEDS_GTT))
356                 flags |= PIN_GLOBAL;
357
358         if (unlikely(i915_vma_pin(vma, 0, 0, flags)))
359                 return;
360
361         if (unlikely(entry->flags & EXEC_OBJECT_NEEDS_FENCE)) {
362                 if (unlikely(i915_vma_get_fence(vma))) {
363                         i915_vma_unpin(vma);
364                         return;
365                 }
366
367                 if (i915_vma_pin_fence(vma))
368                         entry->flags |= __EXEC_OBJECT_HAS_FENCE;
369         }
370
371         entry->flags |= __EXEC_OBJECT_HAS_PIN;
372 }
373
374 static inline void
375 __eb_unreserve_vma(struct i915_vma *vma,
376                    const struct drm_i915_gem_exec_object2 *entry)
377 {
378         GEM_BUG_ON(!(entry->flags & __EXEC_OBJECT_HAS_PIN));
379
380         if (unlikely(entry->flags & __EXEC_OBJECT_HAS_FENCE))
381                 i915_vma_unpin_fence(vma);
382
383         __i915_vma_unpin(vma);
384 }
385
386 static inline void
387 eb_unreserve_vma(struct i915_vma *vma,
388                  struct drm_i915_gem_exec_object2 *entry)
389 {
390         if (!(entry->flags & __EXEC_OBJECT_HAS_PIN))
391                 return;
392
393         __eb_unreserve_vma(vma, entry);
394         entry->flags &= ~__EXEC_OBJECT_RESERVED;
395 }
396
397 static int
398 eb_validate_vma(struct i915_execbuffer *eb,
399                 struct drm_i915_gem_exec_object2 *entry,
400                 struct i915_vma *vma)
401 {
402         if (unlikely(entry->flags & eb->invalid_flags))
403                 return -EINVAL;
404
405         if (unlikely(entry->alignment && !is_power_of_2(entry->alignment)))
406                 return -EINVAL;
407
408         /*
409          * Offset can be used as input (EXEC_OBJECT_PINNED), reject
410          * any non-page-aligned or non-canonical addresses.
411          */
412         if (unlikely(entry->flags & EXEC_OBJECT_PINNED &&
413                      entry->offset != gen8_canonical_addr(entry->offset & PAGE_MASK)))
414                 return -EINVAL;
415
416         /* pad_to_size was once a reserved field, so sanitize it */
417         if (entry->flags & EXEC_OBJECT_PAD_TO_SIZE) {
418                 if (unlikely(offset_in_page(entry->pad_to_size)))
419                         return -EINVAL;
420         } else {
421                 entry->pad_to_size = 0;
422         }
423
424         if (unlikely(vma->exec_entry)) {
425                 DRM_DEBUG("Object [handle %d, index %d] appears more than once in object list\n",
426                           entry->handle, (int)(entry - eb->exec));
427                 return -EINVAL;
428         }
429
430         /*
431          * From drm_mm perspective address space is continuous,
432          * so from this point we're always using non-canonical
433          * form internally.
434          */
435         entry->offset = gen8_noncanonical_addr(entry->offset);
436
437         return 0;
438 }
439
440 static int
441 eb_add_vma(struct i915_execbuffer *eb,
442            struct drm_i915_gem_exec_object2 *entry,
443            struct i915_vma *vma)
444 {
445         int err;
446
447         GEM_BUG_ON(i915_vma_is_closed(vma));
448
449         if (!(eb->args->flags & __EXEC_VALIDATED)) {
450                 err = eb_validate_vma(eb, entry, vma);
451                 if (unlikely(err))
452                         return err;
453         }
454
455         if (eb->lut_size >= 0) {
456                 vma->exec_handle = entry->handle;
457                 hlist_add_head(&vma->exec_node,
458                                &eb->buckets[hash_32(entry->handle,
459                                                     eb->lut_size)]);
460         }
461
462         if (entry->relocation_count)
463                 list_add_tail(&vma->reloc_link, &eb->relocs);
464
465         if (!eb->reloc_cache.has_fence) {
466                 entry->flags &= ~EXEC_OBJECT_NEEDS_FENCE;
467         } else {
468                 if ((entry->flags & EXEC_OBJECT_NEEDS_FENCE ||
469                      eb->reloc_cache.needs_unfenced) &&
470                     i915_gem_object_is_tiled(vma->obj))
471                         entry->flags |= EXEC_OBJECT_NEEDS_GTT | __EXEC_OBJECT_NEEDS_MAP;
472         }
473
474         if (!(entry->flags & EXEC_OBJECT_PINNED))
475                 entry->flags |= eb->context_flags;
476
477         /*
478          * Stash a pointer from the vma to execobj, so we can query its flags,
479          * size, alignment etc as provided by the user. Also we stash a pointer
480          * to the vma inside the execobj so that we can use a direct lookup
481          * to find the right target VMA when doing relocations.
482          */
483         vma->exec_entry = entry;
484         __exec_to_vma(entry) = (uintptr_t)vma;
485
486         err = 0;
487         eb_pin_vma(eb, entry, vma);
488         if (eb_vma_misplaced(entry, vma)) {
489                 eb_unreserve_vma(vma, entry);
490
491                 list_add_tail(&vma->exec_link, &eb->unbound);
492                 if (drm_mm_node_allocated(&vma->node))
493                         err = i915_vma_unbind(vma);
494         } else {
495                 if (entry->offset != vma->node.start) {
496                         entry->offset = vma->node.start | UPDATE;
497                         eb->args->flags |= __EXEC_HAS_RELOC;
498                 }
499         }
500         return err;
501 }
502
503 static inline int use_cpu_reloc(const struct reloc_cache *cache,
504                                 const struct drm_i915_gem_object *obj)
505 {
506         if (!i915_gem_object_has_struct_page(obj))
507                 return false;
508
509         if (DBG_FORCE_RELOC == FORCE_CPU_RELOC)
510                 return true;
511
512         if (DBG_FORCE_RELOC == FORCE_GTT_RELOC)
513                 return false;
514
515         return (cache->has_llc ||
516                 obj->cache_dirty ||
517                 obj->cache_level != I915_CACHE_NONE);
518 }
519
520 static int eb_reserve_vma(const struct i915_execbuffer *eb,
521                           struct i915_vma *vma)
522 {
523         struct drm_i915_gem_exec_object2 *entry = vma->exec_entry;
524         u64 flags;
525         int err;
526
527         flags = PIN_USER | PIN_NONBLOCK;
528         if (entry->flags & EXEC_OBJECT_NEEDS_GTT)
529                 flags |= PIN_GLOBAL;
530
531         /*
532          * Wa32bitGeneralStateOffset & Wa32bitInstructionBaseOffset,
533          * limit address to the first 4GBs for unflagged objects.
534          */
535         if (!(entry->flags & EXEC_OBJECT_SUPPORTS_48B_ADDRESS))
536                 flags |= PIN_ZONE_4G;
537
538         if (entry->flags & __EXEC_OBJECT_NEEDS_MAP)
539                 flags |= PIN_MAPPABLE;
540
541         if (entry->flags & EXEC_OBJECT_PINNED) {
542                 flags |= entry->offset | PIN_OFFSET_FIXED;
543                 flags &= ~PIN_NONBLOCK; /* force overlapping PINNED checks */
544         } else if (entry->flags & __EXEC_OBJECT_NEEDS_BIAS) {
545                 flags |= BATCH_OFFSET_BIAS | PIN_OFFSET_BIAS;
546         }
547
548         err = i915_vma_pin(vma, entry->pad_to_size, entry->alignment, flags);
549         if (err)
550                 return err;
551
552         if (entry->offset != vma->node.start) {
553                 entry->offset = vma->node.start | UPDATE;
554                 eb->args->flags |= __EXEC_HAS_RELOC;
555         }
556
557         entry->flags |= __EXEC_OBJECT_HAS_PIN;
558         GEM_BUG_ON(eb_vma_misplaced(entry, vma));
559
560         if (unlikely(entry->flags & EXEC_OBJECT_NEEDS_FENCE)) {
561                 err = i915_vma_get_fence(vma);
562                 if (unlikely(err)) {
563                         i915_vma_unpin(vma);
564                         return err;
565                 }
566
567                 if (i915_vma_pin_fence(vma))
568                         entry->flags |= __EXEC_OBJECT_HAS_FENCE;
569         }
570
571         return 0;
572 }
573
574 static int eb_reserve(struct i915_execbuffer *eb)
575 {
576         const unsigned int count = eb->buffer_count;
577         struct list_head last;
578         struct i915_vma *vma;
579         unsigned int i, pass;
580         int err;
581
582         /*
583          * Attempt to pin all of the buffers into the GTT.
584          * This is done in 3 phases:
585          *
586          * 1a. Unbind all objects that do not match the GTT constraints for
587          *     the execbuffer (fenceable, mappable, alignment etc).
588          * 1b. Increment pin count for already bound objects.
589          * 2.  Bind new objects.
590          * 3.  Decrement pin count.
591          *
592          * This avoid unnecessary unbinding of later objects in order to make
593          * room for the earlier objects *unless* we need to defragment.
594          */
595
596         pass = 0;
597         err = 0;
598         do {
599                 list_for_each_entry(vma, &eb->unbound, exec_link) {
600                         err = eb_reserve_vma(eb, vma);
601                         if (err)
602                                 break;
603                 }
604                 if (err != -ENOSPC)
605                         return err;
606
607                 /* Resort *all* the objects into priority order */
608                 INIT_LIST_HEAD(&eb->unbound);
609                 INIT_LIST_HEAD(&last);
610                 for (i = 0; i < count; i++) {
611                         struct drm_i915_gem_exec_object2 *entry = &eb->exec[i];
612
613                         if (entry->flags & EXEC_OBJECT_PINNED &&
614                             entry->flags & __EXEC_OBJECT_HAS_PIN)
615                                 continue;
616
617                         vma = exec_to_vma(entry);
618                         eb_unreserve_vma(vma, entry);
619
620                         if (entry->flags & EXEC_OBJECT_PINNED)
621                                 list_add(&vma->exec_link, &eb->unbound);
622                         else if (entry->flags & __EXEC_OBJECT_NEEDS_MAP)
623                                 list_add_tail(&vma->exec_link, &eb->unbound);
624                         else
625                                 list_add_tail(&vma->exec_link, &last);
626                 }
627                 list_splice_tail(&last, &eb->unbound);
628
629                 switch (pass++) {
630                 case 0:
631                         break;
632
633                 case 1:
634                         /* Too fragmented, unbind everything and retry */
635                         err = i915_gem_evict_vm(eb->vm);
636                         if (err)
637                                 return err;
638                         break;
639
640                 default:
641                         return -ENOSPC;
642                 }
643         } while (1);
644 }
645
646 static inline struct hlist_head *
647 ht_head(const  struct i915_gem_context_vma_lut *lut, u32 handle)
648 {
649         return &lut->ht[hash_32(handle, lut->ht_bits)];
650 }
651
652 static inline bool
653 ht_needs_resize(const struct i915_gem_context_vma_lut *lut)
654 {
655         return (4*lut->ht_count > 3*lut->ht_size ||
656                 4*lut->ht_count + 1 < lut->ht_size);
657 }
658
659 static unsigned int eb_batch_index(const struct i915_execbuffer *eb)
660 {
661         if (eb->args->flags & I915_EXEC_BATCH_FIRST)
662                 return 0;
663         else
664                 return eb->buffer_count - 1;
665 }
666
667 static int eb_select_context(struct i915_execbuffer *eb)
668 {
669         struct i915_gem_context *ctx;
670
671         ctx = i915_gem_context_lookup(eb->file->driver_priv, eb->args->rsvd1);
672         if (unlikely(IS_ERR(ctx)))
673                 return PTR_ERR(ctx);
674
675         if (unlikely(i915_gem_context_is_banned(ctx))) {
676                 DRM_DEBUG("Context %u tried to submit while banned\n",
677                           ctx->user_handle);
678                 return -EIO;
679         }
680
681         eb->ctx = i915_gem_context_get(ctx);
682         eb->vm = ctx->ppgtt ? &ctx->ppgtt->base : &eb->i915->ggtt.base;
683
684         eb->context_flags = 0;
685         if (ctx->flags & CONTEXT_NO_ZEROMAP)
686                 eb->context_flags |= __EXEC_OBJECT_NEEDS_BIAS;
687
688         return 0;
689 }
690
691 static int eb_lookup_vmas(struct i915_execbuffer *eb)
692 {
693 #define INTERMEDIATE BIT(0)
694         const unsigned int count = eb->buffer_count;
695         struct i915_gem_context_vma_lut *lut = &eb->ctx->vma_lut;
696         struct i915_vma *vma;
697         struct idr *idr;
698         unsigned int i;
699         int slow_pass = -1;
700         int err;
701
702         INIT_LIST_HEAD(&eb->relocs);
703         INIT_LIST_HEAD(&eb->unbound);
704
705         if (unlikely(lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS))
706                 flush_work(&lut->resize);
707         GEM_BUG_ON(lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS);
708
709         for (i = 0; i < count; i++) {
710                 __exec_to_vma(&eb->exec[i]) = 0;
711
712                 hlist_for_each_entry(vma,
713                                      ht_head(lut, eb->exec[i].handle),
714                                      ctx_node) {
715                         if (vma->ctx_handle != eb->exec[i].handle)
716                                 continue;
717
718                         err = eb_add_vma(eb, &eb->exec[i], vma);
719                         if (unlikely(err))
720                                 return err;
721
722                         goto next_vma;
723                 }
724
725                 if (slow_pass < 0)
726                         slow_pass = i;
727 next_vma: ;
728         }
729
730         if (slow_pass < 0)
731                 goto out;
732
733         spin_lock(&eb->file->table_lock);
734         /*
735          * Grab a reference to the object and release the lock so we can lookup
736          * or create the VMA without using GFP_ATOMIC
737          */
738         idr = &eb->file->object_idr;
739         for (i = slow_pass; i < count; i++) {
740                 struct drm_i915_gem_object *obj;
741
742                 if (__exec_to_vma(&eb->exec[i]))
743                         continue;
744
745                 obj = to_intel_bo(idr_find(idr, eb->exec[i].handle));
746                 if (unlikely(!obj)) {
747                         spin_unlock(&eb->file->table_lock);
748                         DRM_DEBUG("Invalid object handle %d at index %d\n",
749                                   eb->exec[i].handle, i);
750                         err = -ENOENT;
751                         goto err;
752                 }
753
754                 __exec_to_vma(&eb->exec[i]) = INTERMEDIATE | (uintptr_t)obj;
755         }
756         spin_unlock(&eb->file->table_lock);
757
758         for (i = slow_pass; i < count; i++) {
759                 struct drm_i915_gem_object *obj;
760
761                 if (!(__exec_to_vma(&eb->exec[i]) & INTERMEDIATE))
762                         continue;
763
764                 /*
765                  * NOTE: We can leak any vmas created here when something fails
766                  * later on. But that's no issue since vma_unbind can deal with
767                  * vmas which are not actually bound. And since only
768                  * lookup_or_create exists as an interface to get at the vma
769                  * from the (obj, vm) we don't run the risk of creating
770                  * duplicated vmas for the same vm.
771                  */
772                 obj = u64_to_ptr(typeof(*obj),
773                                  __exec_to_vma(&eb->exec[i]) & ~INTERMEDIATE);
774                 vma = i915_vma_instance(obj, eb->vm, NULL);
775                 if (unlikely(IS_ERR(vma))) {
776                         DRM_DEBUG("Failed to lookup VMA\n");
777                         err = PTR_ERR(vma);
778                         goto err;
779                 }
780
781                 /* First come, first served */
782                 if (!vma->ctx) {
783                         vma->ctx = eb->ctx;
784                         vma->ctx_handle = eb->exec[i].handle;
785                         hlist_add_head(&vma->ctx_node,
786                                        ht_head(lut, eb->exec[i].handle));
787                         lut->ht_count++;
788                         lut->ht_size |= I915_CTX_RESIZE_IN_PROGRESS;
789                         if (i915_vma_is_ggtt(vma)) {
790                                 GEM_BUG_ON(obj->vma_hashed);
791                                 obj->vma_hashed = vma;
792                         }
793
794                         i915_vma_get(vma);
795                 }
796
797                 err = eb_add_vma(eb, &eb->exec[i], vma);
798                 if (unlikely(err))
799                         goto err;
800
801                 /* Only after we validated the user didn't use our bits */
802                 if (vma->ctx != eb->ctx) {
803                         i915_vma_get(vma);
804                         eb->exec[i].flags |= __EXEC_OBJECT_HAS_REF;
805                 }
806         }
807
808         if (lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS) {
809                 if (ht_needs_resize(lut))
810                         queue_work(system_highpri_wq, &lut->resize);
811                 else
812                         lut->ht_size &= ~I915_CTX_RESIZE_IN_PROGRESS;
813         }
814
815 out:
816         /* take note of the batch buffer before we might reorder the lists */
817         i = eb_batch_index(eb);
818         eb->batch = exec_to_vma(&eb->exec[i]);
819
820         /*
821          * SNA is doing fancy tricks with compressing batch buffers, which leads
822          * to negative relocation deltas. Usually that works out ok since the
823          * relocate address is still positive, except when the batch is placed
824          * very low in the GTT. Ensure this doesn't happen.
825          *
826          * Note that actual hangs have only been observed on gen7, but for
827          * paranoia do it everywhere.
828          */
829         if (!(eb->exec[i].flags & EXEC_OBJECT_PINNED))
830                 eb->exec[i].flags |= __EXEC_OBJECT_NEEDS_BIAS;
831         if (eb->reloc_cache.has_fence)
832                 eb->exec[i].flags |= EXEC_OBJECT_NEEDS_FENCE;
833
834         eb->args->flags |= __EXEC_VALIDATED;
835         return eb_reserve(eb);
836
837 err:
838         for (i = slow_pass; i < count; i++) {
839                 if (__exec_to_vma(&eb->exec[i]) & INTERMEDIATE)
840                         __exec_to_vma(&eb->exec[i]) = 0;
841         }
842         lut->ht_size &= ~I915_CTX_RESIZE_IN_PROGRESS;
843         return err;
844 #undef INTERMEDIATE
845 }
846
847 static struct i915_vma *
848 eb_get_vma(const struct i915_execbuffer *eb, unsigned long handle)
849 {
850         if (eb->lut_size < 0) {
851                 if (handle >= -eb->lut_size)
852                         return NULL;
853                 return exec_to_vma(&eb->exec[handle]);
854         } else {
855                 struct hlist_head *head;
856                 struct i915_vma *vma;
857
858                 head = &eb->buckets[hash_32(handle, eb->lut_size)];
859                 hlist_for_each_entry(vma, head, exec_node) {
860                         if (vma->exec_handle == handle)
861                                 return vma;
862                 }
863                 return NULL;
864         }
865 }
866
867 static void eb_release_vmas(const struct i915_execbuffer *eb)
868 {
869         const unsigned int count = eb->buffer_count;
870         unsigned int i;
871
872         for (i = 0; i < count; i++) {
873                 struct drm_i915_gem_exec_object2 *entry = &eb->exec[i];
874                 struct i915_vma *vma = exec_to_vma(entry);
875
876                 if (!vma)
877                         continue;
878
879                 GEM_BUG_ON(vma->exec_entry != entry);
880                 vma->exec_entry = NULL;
881                 __exec_to_vma(entry) = 0;
882
883                 if (entry->flags & __EXEC_OBJECT_HAS_PIN)
884                         __eb_unreserve_vma(vma, entry);
885
886                 if (entry->flags & __EXEC_OBJECT_HAS_REF)
887                         i915_vma_put(vma);
888
889                 entry->flags &=
890                         ~(__EXEC_OBJECT_RESERVED | __EXEC_OBJECT_HAS_REF);
891         }
892 }
893
894 static void eb_reset_vmas(const struct i915_execbuffer *eb)
895 {
896         eb_release_vmas(eb);
897         if (eb->lut_size >= 0)
898                 memset(eb->buckets, 0,
899                        sizeof(struct hlist_head) << eb->lut_size);
900 }
901
902 static void eb_destroy(const struct i915_execbuffer *eb)
903 {
904         GEM_BUG_ON(eb->reloc_cache.rq);
905
906         if (eb->lut_size >= 0)
907                 kfree(eb->buckets);
908 }
909
910 static inline u64
911 relocation_target(const struct drm_i915_gem_relocation_entry *reloc,
912                   const struct i915_vma *target)
913 {
914         return gen8_canonical_addr((int)reloc->delta + target->node.start);
915 }
916
917 static void reloc_cache_init(struct reloc_cache *cache,
918                              struct drm_i915_private *i915)
919 {
920         cache->page = -1;
921         cache->vaddr = 0;
922         /* Must be a variable in the struct to allow GCC to unroll. */
923         cache->gen = INTEL_GEN(i915);
924         cache->has_llc = HAS_LLC(i915);
925         cache->use_64bit_reloc = HAS_64BIT_RELOC(i915);
926         cache->has_fence = cache->gen < 4;
927         cache->needs_unfenced = INTEL_INFO(i915)->unfenced_needs_alignment;
928         cache->node.allocated = false;
929         cache->rq = NULL;
930         cache->rq_size = 0;
931 }
932
933 static inline void *unmask_page(unsigned long p)
934 {
935         return (void *)(uintptr_t)(p & PAGE_MASK);
936 }
937
938 static inline unsigned int unmask_flags(unsigned long p)
939 {
940         return p & ~PAGE_MASK;
941 }
942
943 #define KMAP 0x4 /* after CLFLUSH_FLAGS */
944
945 static inline struct i915_ggtt *cache_to_ggtt(struct reloc_cache *cache)
946 {
947         struct drm_i915_private *i915 =
948                 container_of(cache, struct i915_execbuffer, reloc_cache)->i915;
949         return &i915->ggtt;
950 }
951
952 static void reloc_gpu_flush(struct reloc_cache *cache)
953 {
954         GEM_BUG_ON(cache->rq_size >= cache->rq->batch->obj->base.size / sizeof(u32));
955         cache->rq_cmd[cache->rq_size] = MI_BATCH_BUFFER_END;
956         i915_gem_object_unpin_map(cache->rq->batch->obj);
957         i915_gem_chipset_flush(cache->rq->i915);
958
959         __i915_add_request(cache->rq, true);
960         cache->rq = NULL;
961 }
962
963 static void reloc_cache_reset(struct reloc_cache *cache)
964 {
965         void *vaddr;
966
967         if (cache->rq)
968                 reloc_gpu_flush(cache);
969
970         if (!cache->vaddr)
971                 return;
972
973         vaddr = unmask_page(cache->vaddr);
974         if (cache->vaddr & KMAP) {
975                 if (cache->vaddr & CLFLUSH_AFTER)
976                         mb();
977
978                 kunmap_atomic(vaddr);
979                 i915_gem_obj_finish_shmem_access((struct drm_i915_gem_object *)cache->node.mm);
980         } else {
981                 wmb();
982                 io_mapping_unmap_atomic((void __iomem *)vaddr);
983                 if (cache->node.allocated) {
984                         struct i915_ggtt *ggtt = cache_to_ggtt(cache);
985
986                         ggtt->base.clear_range(&ggtt->base,
987                                                cache->node.start,
988                                                cache->node.size);
989                         drm_mm_remove_node(&cache->node);
990                 } else {
991                         i915_vma_unpin((struct i915_vma *)cache->node.mm);
992                 }
993         }
994
995         cache->vaddr = 0;
996         cache->page = -1;
997 }
998
999 static void *reloc_kmap(struct drm_i915_gem_object *obj,
1000                         struct reloc_cache *cache,
1001                         unsigned long page)
1002 {
1003         void *vaddr;
1004
1005         if (cache->vaddr) {
1006                 kunmap_atomic(unmask_page(cache->vaddr));
1007         } else {
1008                 unsigned int flushes;
1009                 int err;
1010
1011                 err = i915_gem_obj_prepare_shmem_write(obj, &flushes);
1012                 if (err)
1013                         return ERR_PTR(err);
1014
1015                 BUILD_BUG_ON(KMAP & CLFLUSH_FLAGS);
1016                 BUILD_BUG_ON((KMAP | CLFLUSH_FLAGS) & PAGE_MASK);
1017
1018                 cache->vaddr = flushes | KMAP;
1019                 cache->node.mm = (void *)obj;
1020                 if (flushes)
1021                         mb();
1022         }
1023
1024         vaddr = kmap_atomic(i915_gem_object_get_dirty_page(obj, page));
1025         cache->vaddr = unmask_flags(cache->vaddr) | (unsigned long)vaddr;
1026         cache->page = page;
1027
1028         return vaddr;
1029 }
1030
1031 static void *reloc_iomap(struct drm_i915_gem_object *obj,
1032                          struct reloc_cache *cache,
1033                          unsigned long page)
1034 {
1035         struct i915_ggtt *ggtt = cache_to_ggtt(cache);
1036         unsigned long offset;
1037         void *vaddr;
1038
1039         if (cache->vaddr) {
1040                 io_mapping_unmap_atomic((void __force __iomem *) unmask_page(cache->vaddr));
1041         } else {
1042                 struct i915_vma *vma;
1043                 int err;
1044
1045                 if (use_cpu_reloc(cache, obj))
1046                         return NULL;
1047
1048                 err = i915_gem_object_set_to_gtt_domain(obj, true);
1049                 if (err)
1050                         return ERR_PTR(err);
1051
1052                 vma = i915_gem_object_ggtt_pin(obj, NULL, 0, 0,
1053                                                PIN_MAPPABLE | PIN_NONBLOCK);
1054                 if (IS_ERR(vma)) {
1055                         memset(&cache->node, 0, sizeof(cache->node));
1056                         err = drm_mm_insert_node_in_range
1057                                 (&ggtt->base.mm, &cache->node,
1058                                  PAGE_SIZE, 0, I915_COLOR_UNEVICTABLE,
1059                                  0, ggtt->mappable_end,
1060                                  DRM_MM_INSERT_LOW);
1061                         if (err) /* no inactive aperture space, use cpu reloc */
1062                                 return NULL;
1063                 } else {
1064                         err = i915_vma_put_fence(vma);
1065                         if (err) {
1066                                 i915_vma_unpin(vma);
1067                                 return ERR_PTR(err);
1068                         }
1069
1070                         cache->node.start = vma->node.start;
1071                         cache->node.mm = (void *)vma;
1072                 }
1073         }
1074
1075         offset = cache->node.start;
1076         if (cache->node.allocated) {
1077                 wmb();
1078                 ggtt->base.insert_page(&ggtt->base,
1079                                        i915_gem_object_get_dma_address(obj, page),
1080                                        offset, I915_CACHE_NONE, 0);
1081         } else {
1082                 offset += page << PAGE_SHIFT;
1083         }
1084
1085         vaddr = (void __force *)io_mapping_map_atomic_wc(&ggtt->mappable,
1086                                                          offset);
1087         cache->page = page;
1088         cache->vaddr = (unsigned long)vaddr;
1089
1090         return vaddr;
1091 }
1092
1093 static void *reloc_vaddr(struct drm_i915_gem_object *obj,
1094                          struct reloc_cache *cache,
1095                          unsigned long page)
1096 {
1097         void *vaddr;
1098
1099         if (cache->page == page) {
1100                 vaddr = unmask_page(cache->vaddr);
1101         } else {
1102                 vaddr = NULL;
1103                 if ((cache->vaddr & KMAP) == 0)
1104                         vaddr = reloc_iomap(obj, cache, page);
1105                 if (!vaddr)
1106                         vaddr = reloc_kmap(obj, cache, page);
1107         }
1108
1109         return vaddr;
1110 }
1111
1112 static void clflush_write32(u32 *addr, u32 value, unsigned int flushes)
1113 {
1114         if (unlikely(flushes & (CLFLUSH_BEFORE | CLFLUSH_AFTER))) {
1115                 if (flushes & CLFLUSH_BEFORE) {
1116                         clflushopt(addr);
1117                         mb();
1118                 }
1119
1120                 *addr = value;
1121
1122                 /*
1123                  * Writes to the same cacheline are serialised by the CPU
1124                  * (including clflush). On the write path, we only require
1125                  * that it hits memory in an orderly fashion and place
1126                  * mb barriers at the start and end of the relocation phase
1127                  * to ensure ordering of clflush wrt to the system.
1128                  */
1129                 if (flushes & CLFLUSH_AFTER)
1130                         clflushopt(addr);
1131         } else
1132                 *addr = value;
1133 }
1134
1135 static int __reloc_gpu_alloc(struct i915_execbuffer *eb,
1136                              struct i915_vma *vma,
1137                              unsigned int len)
1138 {
1139         struct reloc_cache *cache = &eb->reloc_cache;
1140         struct drm_i915_gem_object *obj;
1141         struct drm_i915_gem_request *rq;
1142         struct i915_vma *batch;
1143         u32 *cmd;
1144         int err;
1145
1146         GEM_BUG_ON(vma->obj->base.write_domain & I915_GEM_DOMAIN_CPU);
1147
1148         obj = i915_gem_batch_pool_get(&eb->engine->batch_pool, PAGE_SIZE);
1149         if (IS_ERR(obj))
1150                 return PTR_ERR(obj);
1151
1152         cmd = i915_gem_object_pin_map(obj,
1153                                       cache->has_llc ? I915_MAP_WB : I915_MAP_WC);
1154         i915_gem_object_unpin_pages(obj);
1155         if (IS_ERR(cmd))
1156                 return PTR_ERR(cmd);
1157
1158         err = i915_gem_object_set_to_wc_domain(obj, false);
1159         if (err)
1160                 goto err_unmap;
1161
1162         batch = i915_vma_instance(obj, vma->vm, NULL);
1163         if (IS_ERR(batch)) {
1164                 err = PTR_ERR(batch);
1165                 goto err_unmap;
1166         }
1167
1168         err = i915_vma_pin(batch, 0, 0, PIN_USER | PIN_NONBLOCK);
1169         if (err)
1170                 goto err_unmap;
1171
1172         rq = i915_gem_request_alloc(eb->engine, eb->ctx);
1173         if (IS_ERR(rq)) {
1174                 err = PTR_ERR(rq);
1175                 goto err_unpin;
1176         }
1177
1178         err = i915_gem_request_await_object(rq, vma->obj, true);
1179         if (err)
1180                 goto err_request;
1181
1182         err = eb->engine->emit_flush(rq, EMIT_INVALIDATE);
1183         if (err)
1184                 goto err_request;
1185
1186         err = i915_switch_context(rq);
1187         if (err)
1188                 goto err_request;
1189
1190         err = eb->engine->emit_bb_start(rq,
1191                                         batch->node.start, PAGE_SIZE,
1192                                         cache->gen > 5 ? 0 : I915_DISPATCH_SECURE);
1193         if (err)
1194                 goto err_request;
1195
1196         GEM_BUG_ON(!reservation_object_test_signaled_rcu(batch->resv, true));
1197         i915_vma_move_to_active(batch, rq, 0);
1198         reservation_object_lock(batch->resv, NULL);
1199         reservation_object_add_excl_fence(batch->resv, &rq->fence);
1200         reservation_object_unlock(batch->resv);
1201         i915_vma_unpin(batch);
1202
1203         i915_vma_move_to_active(vma, rq, EXEC_OBJECT_WRITE);
1204         reservation_object_lock(vma->resv, NULL);
1205         reservation_object_add_excl_fence(vma->resv, &rq->fence);
1206         reservation_object_unlock(vma->resv);
1207
1208         rq->batch = batch;
1209
1210         cache->rq = rq;
1211         cache->rq_cmd = cmd;
1212         cache->rq_size = 0;
1213
1214         /* Return with batch mapping (cmd) still pinned */
1215         return 0;
1216
1217 err_request:
1218         i915_add_request(rq);
1219 err_unpin:
1220         i915_vma_unpin(batch);
1221 err_unmap:
1222         i915_gem_object_unpin_map(obj);
1223         return err;
1224 }
1225
1226 static u32 *reloc_gpu(struct i915_execbuffer *eb,
1227                       struct i915_vma *vma,
1228                       unsigned int len)
1229 {
1230         struct reloc_cache *cache = &eb->reloc_cache;
1231         u32 *cmd;
1232
1233         if (cache->rq_size > PAGE_SIZE/sizeof(u32) - (len + 1))
1234                 reloc_gpu_flush(cache);
1235
1236         if (unlikely(!cache->rq)) {
1237                 int err;
1238
1239                 err = __reloc_gpu_alloc(eb, vma, len);
1240                 if (unlikely(err))
1241                         return ERR_PTR(err);
1242         }
1243
1244         cmd = cache->rq_cmd + cache->rq_size;
1245         cache->rq_size += len;
1246
1247         return cmd;
1248 }
1249
1250 static u64
1251 relocate_entry(struct i915_vma *vma,
1252                const struct drm_i915_gem_relocation_entry *reloc,
1253                struct i915_execbuffer *eb,
1254                const struct i915_vma *target)
1255 {
1256         u64 offset = reloc->offset;
1257         u64 target_offset = relocation_target(reloc, target);
1258         bool wide = eb->reloc_cache.use_64bit_reloc;
1259         void *vaddr;
1260
1261         if (!eb->reloc_cache.vaddr &&
1262             (DBG_FORCE_RELOC == FORCE_GPU_RELOC ||
1263              !reservation_object_test_signaled_rcu(vma->resv, true))) {
1264                 const unsigned int gen = eb->reloc_cache.gen;
1265                 unsigned int len;
1266                 u32 *batch;
1267                 u64 addr;
1268
1269                 if (wide)
1270                         len = offset & 7 ? 8 : 5;
1271                 else if (gen >= 4)
1272                         len = 4;
1273                 else if (gen >= 3)
1274                         len = 3;
1275                 else /* On gen2 MI_STORE_DWORD_IMM uses a physical address */
1276                         goto repeat;
1277
1278                 batch = reloc_gpu(eb, vma, len);
1279                 if (IS_ERR(batch))
1280                         goto repeat;
1281
1282                 addr = gen8_canonical_addr(vma->node.start + offset);
1283                 if (wide) {
1284                         if (offset & 7) {
1285                                 *batch++ = MI_STORE_DWORD_IMM_GEN4;
1286                                 *batch++ = lower_32_bits(addr);
1287                                 *batch++ = upper_32_bits(addr);
1288                                 *batch++ = lower_32_bits(target_offset);
1289
1290                                 addr = gen8_canonical_addr(addr + 4);
1291
1292                                 *batch++ = MI_STORE_DWORD_IMM_GEN4;
1293                                 *batch++ = lower_32_bits(addr);
1294                                 *batch++ = upper_32_bits(addr);
1295                                 *batch++ = upper_32_bits(target_offset);
1296                         } else {
1297                                 *batch++ = (MI_STORE_DWORD_IMM_GEN4 | (1 << 21)) + 1;
1298                                 *batch++ = lower_32_bits(addr);
1299                                 *batch++ = upper_32_bits(addr);
1300                                 *batch++ = lower_32_bits(target_offset);
1301                                 *batch++ = upper_32_bits(target_offset);
1302                         }
1303                 } else if (gen >= 6) {
1304                         *batch++ = MI_STORE_DWORD_IMM_GEN4;
1305                         *batch++ = 0;
1306                         *batch++ = addr;
1307                         *batch++ = target_offset;
1308                 } else if (gen >= 4) {
1309                         *batch++ = MI_STORE_DWORD_IMM_GEN4 | MI_USE_GGTT;
1310                         *batch++ = 0;
1311                         *batch++ = addr;
1312                         *batch++ = target_offset;
1313                 } else {
1314                         *batch++ = MI_STORE_DWORD_IMM | MI_MEM_VIRTUAL;
1315                         *batch++ = addr;
1316                         *batch++ = target_offset;
1317                 }
1318
1319                 goto out;
1320         }
1321
1322 repeat:
1323         vaddr = reloc_vaddr(vma->obj, &eb->reloc_cache, offset >> PAGE_SHIFT);
1324         if (IS_ERR(vaddr))
1325                 return PTR_ERR(vaddr);
1326
1327         clflush_write32(vaddr + offset_in_page(offset),
1328                         lower_32_bits(target_offset),
1329                         eb->reloc_cache.vaddr);
1330
1331         if (wide) {
1332                 offset += sizeof(u32);
1333                 target_offset >>= 32;
1334                 wide = false;
1335                 goto repeat;
1336         }
1337
1338 out:
1339         return target->node.start | UPDATE;
1340 }
1341
1342 static u64
1343 eb_relocate_entry(struct i915_execbuffer *eb,
1344                   struct i915_vma *vma,
1345                   const struct drm_i915_gem_relocation_entry *reloc)
1346 {
1347         struct i915_vma *target;
1348         int err;
1349
1350         /* we've already hold a reference to all valid objects */
1351         target = eb_get_vma(eb, reloc->target_handle);
1352         if (unlikely(!target))
1353                 return -ENOENT;
1354
1355         /* Validate that the target is in a valid r/w GPU domain */
1356         if (unlikely(reloc->write_domain & (reloc->write_domain - 1))) {
1357                 DRM_DEBUG("reloc with multiple write domains: "
1358                           "target %d offset %d "
1359                           "read %08x write %08x",
1360                           reloc->target_handle,
1361                           (int) reloc->offset,
1362                           reloc->read_domains,
1363                           reloc->write_domain);
1364                 return -EINVAL;
1365         }
1366         if (unlikely((reloc->write_domain | reloc->read_domains)
1367                      & ~I915_GEM_GPU_DOMAINS)) {
1368                 DRM_DEBUG("reloc with read/write non-GPU domains: "
1369                           "target %d offset %d "
1370                           "read %08x write %08x",
1371                           reloc->target_handle,
1372                           (int) reloc->offset,
1373                           reloc->read_domains,
1374                           reloc->write_domain);
1375                 return -EINVAL;
1376         }
1377
1378         if (reloc->write_domain) {
1379                 target->exec_entry->flags |= EXEC_OBJECT_WRITE;
1380
1381                 /*
1382                  * Sandybridge PPGTT errata: We need a global gtt mapping
1383                  * for MI and pipe_control writes because the gpu doesn't
1384                  * properly redirect them through the ppgtt for non_secure
1385                  * batchbuffers.
1386                  */
1387                 if (reloc->write_domain == I915_GEM_DOMAIN_INSTRUCTION &&
1388                     IS_GEN6(eb->i915)) {
1389                         err = i915_vma_bind(target, target->obj->cache_level,
1390                                             PIN_GLOBAL);
1391                         if (WARN_ONCE(err,
1392                                       "Unexpected failure to bind target VMA!"))
1393                                 return err;
1394                 }
1395         }
1396
1397         /*
1398          * If the relocation already has the right value in it, no
1399          * more work needs to be done.
1400          */
1401         if (!DBG_FORCE_RELOC &&
1402             gen8_canonical_addr(target->node.start) == reloc->presumed_offset)
1403                 return 0;
1404
1405         /* Check that the relocation address is valid... */
1406         if (unlikely(reloc->offset >
1407                      vma->size - (eb->reloc_cache.use_64bit_reloc ? 8 : 4))) {
1408                 DRM_DEBUG("Relocation beyond object bounds: "
1409                           "target %d offset %d size %d.\n",
1410                           reloc->target_handle,
1411                           (int)reloc->offset,
1412                           (int)vma->size);
1413                 return -EINVAL;
1414         }
1415         if (unlikely(reloc->offset & 3)) {
1416                 DRM_DEBUG("Relocation not 4-byte aligned: "
1417                           "target %d offset %d.\n",
1418                           reloc->target_handle,
1419                           (int)reloc->offset);
1420                 return -EINVAL;
1421         }
1422
1423         /*
1424          * If we write into the object, we need to force the synchronisation
1425          * barrier, either with an asynchronous clflush or if we executed the
1426          * patching using the GPU (though that should be serialised by the
1427          * timeline). To be completely sure, and since we are required to
1428          * do relocations we are already stalling, disable the user's opt
1429          * of our synchronisation.
1430          */
1431         vma->exec_entry->flags &= ~EXEC_OBJECT_ASYNC;
1432
1433         /* and update the user's relocation entry */
1434         return relocate_entry(vma, reloc, eb, target);
1435 }
1436
1437 static int eb_relocate_vma(struct i915_execbuffer *eb, struct i915_vma *vma)
1438 {
1439 #define N_RELOC(x) ((x) / sizeof(struct drm_i915_gem_relocation_entry))
1440         struct drm_i915_gem_relocation_entry stack[N_RELOC(512)];
1441         struct drm_i915_gem_relocation_entry __user *urelocs;
1442         const struct drm_i915_gem_exec_object2 *entry = vma->exec_entry;
1443         unsigned int remain;
1444
1445         urelocs = u64_to_user_ptr(entry->relocs_ptr);
1446         remain = entry->relocation_count;
1447         if (unlikely(remain > N_RELOC(ULONG_MAX)))
1448                 return -EINVAL;
1449
1450         /*
1451          * We must check that the entire relocation array is safe
1452          * to read. However, if the array is not writable the user loses
1453          * the updated relocation values.
1454          */
1455         if (unlikely(!access_ok(VERIFY_READ, urelocs, remain*sizeof(urelocs))))
1456                 return -EFAULT;
1457
1458         do {
1459                 struct drm_i915_gem_relocation_entry *r = stack;
1460                 unsigned int count =
1461                         min_t(unsigned int, remain, ARRAY_SIZE(stack));
1462                 unsigned int copied;
1463
1464                 /*
1465                  * This is the fast path and we cannot handle a pagefault
1466                  * whilst holding the struct mutex lest the user pass in the
1467                  * relocations contained within a mmaped bo. For in such a case
1468                  * we, the page fault handler would call i915_gem_fault() and
1469                  * we would try to acquire the struct mutex again. Obviously
1470                  * this is bad and so lockdep complains vehemently.
1471                  */
1472                 pagefault_disable();
1473                 copied = __copy_from_user_inatomic(r, urelocs, count * sizeof(r[0]));
1474                 pagefault_enable();
1475                 if (unlikely(copied)) {
1476                         remain = -EFAULT;
1477                         goto out;
1478                 }
1479
1480                 remain -= count;
1481                 do {
1482                         u64 offset = eb_relocate_entry(eb, vma, r);
1483
1484                         if (likely(offset == 0)) {
1485                         } else if ((s64)offset < 0) {
1486                                 remain = (int)offset;
1487                                 goto out;
1488                         } else {
1489                                 /*
1490                                  * Note that reporting an error now
1491                                  * leaves everything in an inconsistent
1492                                  * state as we have *already* changed
1493                                  * the relocation value inside the
1494                                  * object. As we have not changed the
1495                                  * reloc.presumed_offset or will not
1496                                  * change the execobject.offset, on the
1497                                  * call we may not rewrite the value
1498                                  * inside the object, leaving it
1499                                  * dangling and causing a GPU hang. Unless
1500                                  * userspace dynamically rebuilds the
1501                                  * relocations on each execbuf rather than
1502                                  * presume a static tree.
1503                                  *
1504                                  * We did previously check if the relocations
1505                                  * were writable (access_ok), an error now
1506                                  * would be a strange race with mprotect,
1507                                  * having already demonstrated that we
1508                                  * can read from this userspace address.
1509                                  */
1510                                 offset = gen8_canonical_addr(offset & ~UPDATE);
1511                                 __put_user(offset,
1512                                            &urelocs[r-stack].presumed_offset);
1513                         }
1514                 } while (r++, --count);
1515                 urelocs += ARRAY_SIZE(stack);
1516         } while (remain);
1517 out:
1518         reloc_cache_reset(&eb->reloc_cache);
1519         return remain;
1520 }
1521
1522 static int
1523 eb_relocate_vma_slow(struct i915_execbuffer *eb, struct i915_vma *vma)
1524 {
1525         const struct drm_i915_gem_exec_object2 *entry = vma->exec_entry;
1526         struct drm_i915_gem_relocation_entry *relocs =
1527                 u64_to_ptr(typeof(*relocs), entry->relocs_ptr);
1528         unsigned int i;
1529         int err;
1530
1531         for (i = 0; i < entry->relocation_count; i++) {
1532                 u64 offset = eb_relocate_entry(eb, vma, &relocs[i]);
1533
1534                 if ((s64)offset < 0) {
1535                         err = (int)offset;
1536                         goto err;
1537                 }
1538         }
1539         err = 0;
1540 err:
1541         reloc_cache_reset(&eb->reloc_cache);
1542         return err;
1543 }
1544
1545 static int check_relocations(const struct drm_i915_gem_exec_object2 *entry)
1546 {
1547         const char __user *addr, *end;
1548         unsigned long size;
1549         char __maybe_unused c;
1550
1551         size = entry->relocation_count;
1552         if (size == 0)
1553                 return 0;
1554
1555         if (size > N_RELOC(ULONG_MAX))
1556                 return -EINVAL;
1557
1558         addr = u64_to_user_ptr(entry->relocs_ptr);
1559         size *= sizeof(struct drm_i915_gem_relocation_entry);
1560         if (!access_ok(VERIFY_READ, addr, size))
1561                 return -EFAULT;
1562
1563         end = addr + size;
1564         for (; addr < end; addr += PAGE_SIZE) {
1565                 int err = __get_user(c, addr);
1566                 if (err)
1567                         return err;
1568         }
1569         return __get_user(c, end - 1);
1570 }
1571
1572 static int eb_copy_relocations(const struct i915_execbuffer *eb)
1573 {
1574         const unsigned int count = eb->buffer_count;
1575         unsigned int i;
1576         int err;
1577
1578         for (i = 0; i < count; i++) {
1579                 const unsigned int nreloc = eb->exec[i].relocation_count;
1580                 struct drm_i915_gem_relocation_entry __user *urelocs;
1581                 struct drm_i915_gem_relocation_entry *relocs;
1582                 unsigned long size;
1583                 unsigned long copied;
1584
1585                 if (nreloc == 0)
1586                         continue;
1587
1588                 err = check_relocations(&eb->exec[i]);
1589                 if (err)
1590                         goto err;
1591
1592                 urelocs = u64_to_user_ptr(eb->exec[i].relocs_ptr);
1593                 size = nreloc * sizeof(*relocs);
1594
1595                 relocs = kvmalloc_array(size, 1, GFP_TEMPORARY);
1596                 if (!relocs) {
1597                         kvfree(relocs);
1598                         err = -ENOMEM;
1599                         goto err;
1600                 }
1601
1602                 /* copy_from_user is limited to < 4GiB */
1603                 copied = 0;
1604                 do {
1605                         unsigned int len =
1606                                 min_t(u64, BIT_ULL(31), size - copied);
1607
1608                         if (__copy_from_user((char *)relocs + copied,
1609                                              (char *)urelocs + copied,
1610                                              len)) {
1611                                 kvfree(relocs);
1612                                 err = -EFAULT;
1613                                 goto err;
1614                         }
1615
1616                         copied += len;
1617                 } while (copied < size);
1618
1619                 /*
1620                  * As we do not update the known relocation offsets after
1621                  * relocating (due to the complexities in lock handling),
1622                  * we need to mark them as invalid now so that we force the
1623                  * relocation processing next time. Just in case the target
1624                  * object is evicted and then rebound into its old
1625                  * presumed_offset before the next execbuffer - if that
1626                  * happened we would make the mistake of assuming that the
1627                  * relocations were valid.
1628                  */
1629                 user_access_begin();
1630                 for (copied = 0; copied < nreloc; copied++)
1631                         unsafe_put_user(-1,
1632                                         &urelocs[copied].presumed_offset,
1633                                         end_user);
1634 end_user:
1635                 user_access_end();
1636
1637                 eb->exec[i].relocs_ptr = (uintptr_t)relocs;
1638         }
1639
1640         return 0;
1641
1642 err:
1643         while (i--) {
1644                 struct drm_i915_gem_relocation_entry *relocs =
1645                         u64_to_ptr(typeof(*relocs), eb->exec[i].relocs_ptr);
1646                 if (eb->exec[i].relocation_count)
1647                         kvfree(relocs);
1648         }
1649         return err;
1650 }
1651
1652 static int eb_prefault_relocations(const struct i915_execbuffer *eb)
1653 {
1654         const unsigned int count = eb->buffer_count;
1655         unsigned int i;
1656
1657         if (unlikely(i915.prefault_disable))
1658                 return 0;
1659
1660         for (i = 0; i < count; i++) {
1661                 int err;
1662
1663                 err = check_relocations(&eb->exec[i]);
1664                 if (err)
1665                         return err;
1666         }
1667
1668         return 0;
1669 }
1670
1671 static noinline int eb_relocate_slow(struct i915_execbuffer *eb)
1672 {
1673         struct drm_device *dev = &eb->i915->drm;
1674         bool have_copy = false;
1675         struct i915_vma *vma;
1676         int err = 0;
1677
1678 repeat:
1679         if (signal_pending(current)) {
1680                 err = -ERESTARTSYS;
1681                 goto out;
1682         }
1683
1684         /* We may process another execbuffer during the unlock... */
1685         eb_reset_vmas(eb);
1686         mutex_unlock(&dev->struct_mutex);
1687
1688         /*
1689          * We take 3 passes through the slowpatch.
1690          *
1691          * 1 - we try to just prefault all the user relocation entries and
1692          * then attempt to reuse the atomic pagefault disabled fast path again.
1693          *
1694          * 2 - we copy the user entries to a local buffer here outside of the
1695          * local and allow ourselves to wait upon any rendering before
1696          * relocations
1697          *
1698          * 3 - we already have a local copy of the relocation entries, but
1699          * were interrupted (EAGAIN) whilst waiting for the objects, try again.
1700          */
1701         if (!err) {
1702                 err = eb_prefault_relocations(eb);
1703         } else if (!have_copy) {
1704                 err = eb_copy_relocations(eb);
1705                 have_copy = err == 0;
1706         } else {
1707                 cond_resched();
1708                 err = 0;
1709         }
1710         if (err) {
1711                 mutex_lock(&dev->struct_mutex);
1712                 goto out;
1713         }
1714
1715         /* A frequent cause for EAGAIN are currently unavailable client pages */
1716         flush_workqueue(eb->i915->mm.userptr_wq);
1717
1718         err = i915_mutex_lock_interruptible(dev);
1719         if (err) {
1720                 mutex_lock(&dev->struct_mutex);
1721                 goto out;
1722         }
1723
1724         /* reacquire the objects */
1725         err = eb_lookup_vmas(eb);
1726         if (err)
1727                 goto err;
1728
1729         list_for_each_entry(vma, &eb->relocs, reloc_link) {
1730                 if (!have_copy) {
1731                         pagefault_disable();
1732                         err = eb_relocate_vma(eb, vma);
1733                         pagefault_enable();
1734                         if (err)
1735                                 goto repeat;
1736                 } else {
1737                         err = eb_relocate_vma_slow(eb, vma);
1738                         if (err)
1739                                 goto err;
1740                 }
1741         }
1742
1743         /*
1744          * Leave the user relocations as are, this is the painfully slow path,
1745          * and we want to avoid the complication of dropping the lock whilst
1746          * having buffers reserved in the aperture and so causing spurious
1747          * ENOSPC for random operations.
1748          */
1749
1750 err:
1751         if (err == -EAGAIN)
1752                 goto repeat;
1753
1754 out:
1755         if (have_copy) {
1756                 const unsigned int count = eb->buffer_count;
1757                 unsigned int i;
1758
1759                 for (i = 0; i < count; i++) {
1760                         const struct drm_i915_gem_exec_object2 *entry =
1761                                 &eb->exec[i];
1762                         struct drm_i915_gem_relocation_entry *relocs;
1763
1764                         if (!entry->relocation_count)
1765                                 continue;
1766
1767                         relocs = u64_to_ptr(typeof(*relocs), entry->relocs_ptr);
1768                         kvfree(relocs);
1769                 }
1770         }
1771
1772         return err ?: have_copy;
1773 }
1774
1775 static int eb_relocate(struct i915_execbuffer *eb)
1776 {
1777         if (eb_lookup_vmas(eb))
1778                 goto slow;
1779
1780         /* The objects are in their final locations, apply the relocations. */
1781         if (eb->args->flags & __EXEC_HAS_RELOC) {
1782                 struct i915_vma *vma;
1783
1784                 list_for_each_entry(vma, &eb->relocs, reloc_link) {
1785                         if (eb_relocate_vma(eb, vma))
1786                                 goto slow;
1787                 }
1788         }
1789
1790         return 0;
1791
1792 slow:
1793         return eb_relocate_slow(eb);
1794 }
1795
1796 static void eb_export_fence(struct i915_vma *vma,
1797                             struct drm_i915_gem_request *req,
1798                             unsigned int flags)
1799 {
1800         struct reservation_object *resv = vma->resv;
1801
1802         /*
1803          * Ignore errors from failing to allocate the new fence, we can't
1804          * handle an error right now. Worst case should be missed
1805          * synchronisation leading to rendering corruption.
1806          */
1807         reservation_object_lock(resv, NULL);
1808         if (flags & EXEC_OBJECT_WRITE)
1809                 reservation_object_add_excl_fence(resv, &req->fence);
1810         else if (reservation_object_reserve_shared(resv) == 0)
1811                 reservation_object_add_shared_fence(resv, &req->fence);
1812         reservation_object_unlock(resv);
1813 }
1814
1815 static int eb_move_to_gpu(struct i915_execbuffer *eb)
1816 {
1817         const unsigned int count = eb->buffer_count;
1818         unsigned int i;
1819         int err;
1820
1821         for (i = 0; i < count; i++) {
1822                 const struct drm_i915_gem_exec_object2 *entry = &eb->exec[i];
1823                 struct i915_vma *vma = exec_to_vma(entry);
1824                 struct drm_i915_gem_object *obj = vma->obj;
1825
1826                 if (entry->flags & EXEC_OBJECT_CAPTURE) {
1827                         struct i915_gem_capture_list *capture;
1828
1829                         capture = kmalloc(sizeof(*capture), GFP_KERNEL);
1830                         if (unlikely(!capture))
1831                                 return -ENOMEM;
1832
1833                         capture->next = eb->request->capture_list;
1834                         capture->vma = vma;
1835                         eb->request->capture_list = capture;
1836                 }
1837
1838                 if (entry->flags & EXEC_OBJECT_ASYNC)
1839                         goto skip_flushes;
1840
1841                 if (unlikely(obj->cache_dirty && !obj->cache_coherent))
1842                         i915_gem_clflush_object(obj, 0);
1843
1844                 err = i915_gem_request_await_object
1845                         (eb->request, obj, entry->flags & EXEC_OBJECT_WRITE);
1846                 if (err)
1847                         return err;
1848
1849 skip_flushes:
1850                 i915_vma_move_to_active(vma, eb->request, entry->flags);
1851                 __eb_unreserve_vma(vma, entry);
1852                 vma->exec_entry = NULL;
1853         }
1854
1855         for (i = 0; i < count; i++) {
1856                 const struct drm_i915_gem_exec_object2 *entry = &eb->exec[i];
1857                 struct i915_vma *vma = exec_to_vma(entry);
1858
1859                 eb_export_fence(vma, eb->request, entry->flags);
1860                 if (unlikely(entry->flags & __EXEC_OBJECT_HAS_REF))
1861                         i915_vma_put(vma);
1862         }
1863         eb->exec = NULL;
1864
1865         /* Unconditionally flush any chipset caches (for streaming writes). */
1866         i915_gem_chipset_flush(eb->i915);
1867
1868         /* Unconditionally invalidate GPU caches and TLBs. */
1869         return eb->engine->emit_flush(eb->request, EMIT_INVALIDATE);
1870 }
1871
1872 static bool i915_gem_check_execbuffer(struct drm_i915_gem_execbuffer2 *exec)
1873 {
1874         if (exec->flags & __I915_EXEC_ILLEGAL_FLAGS)
1875                 return false;
1876
1877         /* Kernel clipping was a DRI1 misfeature */
1878         if (exec->num_cliprects || exec->cliprects_ptr)
1879                 return false;
1880
1881         if (exec->DR4 == 0xffffffff) {
1882                 DRM_DEBUG("UXA submitting garbage DR4, fixing up\n");
1883                 exec->DR4 = 0;
1884         }
1885         if (exec->DR1 || exec->DR4)
1886                 return false;
1887
1888         if ((exec->batch_start_offset | exec->batch_len) & 0x7)
1889                 return false;
1890
1891         return true;
1892 }
1893
1894 void i915_vma_move_to_active(struct i915_vma *vma,
1895                              struct drm_i915_gem_request *req,
1896                              unsigned int flags)
1897 {
1898         struct drm_i915_gem_object *obj = vma->obj;
1899         const unsigned int idx = req->engine->id;
1900
1901         lockdep_assert_held(&req->i915->drm.struct_mutex);
1902         GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
1903
1904         /*
1905          * Add a reference if we're newly entering the active list.
1906          * The order in which we add operations to the retirement queue is
1907          * vital here: mark_active adds to the start of the callback list,
1908          * such that subsequent callbacks are called first. Therefore we
1909          * add the active reference first and queue for it to be dropped
1910          * *last*.
1911          */
1912         if (!i915_vma_is_active(vma))
1913                 obj->active_count++;
1914         i915_vma_set_active(vma, idx);
1915         i915_gem_active_set(&vma->last_read[idx], req);
1916         list_move_tail(&vma->vm_link, &vma->vm->active_list);
1917
1918         obj->base.write_domain = 0;
1919         if (flags & EXEC_OBJECT_WRITE) {
1920                 obj->base.write_domain = I915_GEM_DOMAIN_RENDER;
1921
1922                 if (intel_fb_obj_invalidate(obj, ORIGIN_CS))
1923                         i915_gem_active_set(&obj->frontbuffer_write, req);
1924
1925                 obj->base.read_domains = 0;
1926         }
1927         obj->base.read_domains |= I915_GEM_GPU_DOMAINS;
1928
1929         if (flags & EXEC_OBJECT_NEEDS_FENCE)
1930                 i915_gem_active_set(&vma->last_fence, req);
1931 }
1932
1933 static int i915_reset_gen7_sol_offsets(struct drm_i915_gem_request *req)
1934 {
1935         u32 *cs;
1936         int i;
1937
1938         if (!IS_GEN7(req->i915) || req->engine->id != RCS) {
1939                 DRM_DEBUG("sol reset is gen7/rcs only\n");
1940                 return -EINVAL;
1941         }
1942
1943         cs = intel_ring_begin(req, 4 * 2 + 2);
1944         if (IS_ERR(cs))
1945                 return PTR_ERR(cs);
1946
1947         *cs++ = MI_LOAD_REGISTER_IMM(4);
1948         for (i = 0; i < 4; i++) {
1949                 *cs++ = i915_mmio_reg_offset(GEN7_SO_WRITE_OFFSET(i));
1950                 *cs++ = 0;
1951         }
1952         *cs++ = MI_NOOP;
1953         intel_ring_advance(req, cs);
1954
1955         return 0;
1956 }
1957
1958 static struct i915_vma *eb_parse(struct i915_execbuffer *eb, bool is_master)
1959 {
1960         struct drm_i915_gem_object *shadow_batch_obj;
1961         struct i915_vma *vma;
1962         int err;
1963
1964         shadow_batch_obj = i915_gem_batch_pool_get(&eb->engine->batch_pool,
1965                                                    PAGE_ALIGN(eb->batch_len));
1966         if (IS_ERR(shadow_batch_obj))
1967                 return ERR_CAST(shadow_batch_obj);
1968
1969         err = intel_engine_cmd_parser(eb->engine,
1970                                       eb->batch->obj,
1971                                       shadow_batch_obj,
1972                                       eb->batch_start_offset,
1973                                       eb->batch_len,
1974                                       is_master);
1975         if (err) {
1976                 if (err == -EACCES) /* unhandled chained batch */
1977                         vma = NULL;
1978                 else
1979                         vma = ERR_PTR(err);
1980                 goto out;
1981         }
1982
1983         vma = i915_gem_object_ggtt_pin(shadow_batch_obj, NULL, 0, 0, 0);
1984         if (IS_ERR(vma))
1985                 goto out;
1986
1987         vma->exec_entry =
1988                 memset(&eb->exec[eb->buffer_count++],
1989                        0, sizeof(*vma->exec_entry));
1990         vma->exec_entry->flags = __EXEC_OBJECT_HAS_PIN | __EXEC_OBJECT_HAS_REF;
1991         __exec_to_vma(vma->exec_entry) = (uintptr_t)i915_vma_get(vma);
1992
1993 out:
1994         i915_gem_object_unpin_pages(shadow_batch_obj);
1995         return vma;
1996 }
1997
1998 static void
1999 add_to_client(struct drm_i915_gem_request *req, struct drm_file *file)
2000 {
2001         req->file_priv = file->driver_priv;
2002         list_add_tail(&req->client_link, &req->file_priv->mm.request_list);
2003 }
2004
2005 static int eb_submit(struct i915_execbuffer *eb)
2006 {
2007         int err;
2008
2009         err = eb_move_to_gpu(eb);
2010         if (err)
2011                 return err;
2012
2013         err = i915_switch_context(eb->request);
2014         if (err)
2015                 return err;
2016
2017         if (eb->args->flags & I915_EXEC_GEN7_SOL_RESET) {
2018                 err = i915_reset_gen7_sol_offsets(eb->request);
2019                 if (err)
2020                         return err;
2021         }
2022
2023         err = eb->engine->emit_bb_start(eb->request,
2024                                         eb->batch->node.start +
2025                                         eb->batch_start_offset,
2026                                         eb->batch_len,
2027                                         eb->batch_flags);
2028         if (err)
2029                 return err;
2030
2031         return 0;
2032 }
2033
2034 /**
2035  * Find one BSD ring to dispatch the corresponding BSD command.
2036  * The engine index is returned.
2037  */
2038 static unsigned int
2039 gen8_dispatch_bsd_engine(struct drm_i915_private *dev_priv,
2040                          struct drm_file *file)
2041 {
2042         struct drm_i915_file_private *file_priv = file->driver_priv;
2043
2044         /* Check whether the file_priv has already selected one ring. */
2045         if ((int)file_priv->bsd_engine < 0)
2046                 file_priv->bsd_engine = atomic_fetch_xor(1,
2047                          &dev_priv->mm.bsd_engine_dispatch_index);
2048
2049         return file_priv->bsd_engine;
2050 }
2051
2052 #define I915_USER_RINGS (4)
2053
2054 static const enum intel_engine_id user_ring_map[I915_USER_RINGS + 1] = {
2055         [I915_EXEC_DEFAULT]     = RCS,
2056         [I915_EXEC_RENDER]      = RCS,
2057         [I915_EXEC_BLT]         = BCS,
2058         [I915_EXEC_BSD]         = VCS,
2059         [I915_EXEC_VEBOX]       = VECS
2060 };
2061
2062 static struct intel_engine_cs *
2063 eb_select_engine(struct drm_i915_private *dev_priv,
2064                  struct drm_file *file,
2065                  struct drm_i915_gem_execbuffer2 *args)
2066 {
2067         unsigned int user_ring_id = args->flags & I915_EXEC_RING_MASK;
2068         struct intel_engine_cs *engine;
2069
2070         if (user_ring_id > I915_USER_RINGS) {
2071                 DRM_DEBUG("execbuf with unknown ring: %u\n", user_ring_id);
2072                 return NULL;
2073         }
2074
2075         if ((user_ring_id != I915_EXEC_BSD) &&
2076             ((args->flags & I915_EXEC_BSD_MASK) != 0)) {
2077                 DRM_DEBUG("execbuf with non bsd ring but with invalid "
2078                           "bsd dispatch flags: %d\n", (int)(args->flags));
2079                 return NULL;
2080         }
2081
2082         if (user_ring_id == I915_EXEC_BSD && HAS_BSD2(dev_priv)) {
2083                 unsigned int bsd_idx = args->flags & I915_EXEC_BSD_MASK;
2084
2085                 if (bsd_idx == I915_EXEC_BSD_DEFAULT) {
2086                         bsd_idx = gen8_dispatch_bsd_engine(dev_priv, file);
2087                 } else if (bsd_idx >= I915_EXEC_BSD_RING1 &&
2088                            bsd_idx <= I915_EXEC_BSD_RING2) {
2089                         bsd_idx >>= I915_EXEC_BSD_SHIFT;
2090                         bsd_idx--;
2091                 } else {
2092                         DRM_DEBUG("execbuf with unknown bsd ring: %u\n",
2093                                   bsd_idx);
2094                         return NULL;
2095                 }
2096
2097                 engine = dev_priv->engine[_VCS(bsd_idx)];
2098         } else {
2099                 engine = dev_priv->engine[user_ring_map[user_ring_id]];
2100         }
2101
2102         if (!engine) {
2103                 DRM_DEBUG("execbuf with invalid ring: %u\n", user_ring_id);
2104                 return NULL;
2105         }
2106
2107         return engine;
2108 }
2109
2110 static int
2111 i915_gem_do_execbuffer(struct drm_device *dev,
2112                        struct drm_file *file,
2113                        struct drm_i915_gem_execbuffer2 *args,
2114                        struct drm_i915_gem_exec_object2 *exec)
2115 {
2116         struct i915_execbuffer eb;
2117         struct dma_fence *in_fence = NULL;
2118         struct sync_file *out_fence = NULL;
2119         int out_fence_fd = -1;
2120         int err;
2121
2122         BUILD_BUG_ON(__EXEC_OBJECT_INTERNAL_FLAGS &
2123                      ~__EXEC_OBJECT_UNKNOWN_FLAGS);
2124
2125         eb.i915 = to_i915(dev);
2126         eb.file = file;
2127         eb.args = args;
2128         if (DBG_FORCE_RELOC || !(args->flags & I915_EXEC_NO_RELOC))
2129                 args->flags |= __EXEC_HAS_RELOC;
2130         eb.exec = exec;
2131         eb.ctx = NULL;
2132         eb.invalid_flags = __EXEC_OBJECT_UNKNOWN_FLAGS;
2133         if (USES_FULL_PPGTT(eb.i915))
2134                 eb.invalid_flags |= EXEC_OBJECT_NEEDS_GTT;
2135         reloc_cache_init(&eb.reloc_cache, eb.i915);
2136
2137         eb.buffer_count = args->buffer_count;
2138         eb.batch_start_offset = args->batch_start_offset;
2139         eb.batch_len = args->batch_len;
2140
2141         eb.batch_flags = 0;
2142         if (args->flags & I915_EXEC_SECURE) {
2143                 if (!drm_is_current_master(file) || !capable(CAP_SYS_ADMIN))
2144                     return -EPERM;
2145
2146                 eb.batch_flags |= I915_DISPATCH_SECURE;
2147         }
2148         if (args->flags & I915_EXEC_IS_PINNED)
2149                 eb.batch_flags |= I915_DISPATCH_PINNED;
2150
2151         eb.engine = eb_select_engine(eb.i915, file, args);
2152         if (!eb.engine)
2153                 return -EINVAL;
2154
2155         if (args->flags & I915_EXEC_RESOURCE_STREAMER) {
2156                 if (!HAS_RESOURCE_STREAMER(eb.i915)) {
2157                         DRM_DEBUG("RS is only allowed for Haswell, Gen8 and above\n");
2158                         return -EINVAL;
2159                 }
2160                 if (eb.engine->id != RCS) {
2161                         DRM_DEBUG("RS is not available on %s\n",
2162                                  eb.engine->name);
2163                         return -EINVAL;
2164                 }
2165
2166                 eb.batch_flags |= I915_DISPATCH_RS;
2167         }
2168
2169         if (args->flags & I915_EXEC_FENCE_IN) {
2170                 in_fence = sync_file_get_fence(lower_32_bits(args->rsvd2));
2171                 if (!in_fence)
2172                         return -EINVAL;
2173         }
2174
2175         if (args->flags & I915_EXEC_FENCE_OUT) {
2176                 out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
2177                 if (out_fence_fd < 0) {
2178                         err = out_fence_fd;
2179                         goto err_in_fence;
2180                 }
2181         }
2182
2183         if (eb_create(&eb))
2184                 return -ENOMEM;
2185
2186         /*
2187          * Take a local wakeref for preparing to dispatch the execbuf as
2188          * we expect to access the hardware fairly frequently in the
2189          * process. Upon first dispatch, we acquire another prolonged
2190          * wakeref that we hold until the GPU has been idle for at least
2191          * 100ms.
2192          */
2193         intel_runtime_pm_get(eb.i915);
2194         err = i915_mutex_lock_interruptible(dev);
2195         if (err)
2196                 goto err_rpm;
2197
2198         err = eb_select_context(&eb);
2199         if (unlikely(err))
2200                 goto err_unlock;
2201
2202         err = eb_relocate(&eb);
2203         if (err)
2204                 /*
2205                  * If the user expects the execobject.offset and
2206                  * reloc.presumed_offset to be an exact match,
2207                  * as for using NO_RELOC, then we cannot update
2208                  * the execobject.offset until we have completed
2209                  * relocation.
2210                  */
2211                 args->flags &= ~__EXEC_HAS_RELOC;
2212         if (err < 0)
2213                 goto err_vma;
2214
2215         if (unlikely(eb.batch->exec_entry->flags & EXEC_OBJECT_WRITE)) {
2216                 DRM_DEBUG("Attempting to use self-modifying batch buffer\n");
2217                 err = -EINVAL;
2218                 goto err_vma;
2219         }
2220         if (eb.batch_start_offset > eb.batch->size ||
2221             eb.batch_len > eb.batch->size - eb.batch_start_offset) {
2222                 DRM_DEBUG("Attempting to use out-of-bounds batch\n");
2223                 err = -EINVAL;
2224                 goto err_vma;
2225         }
2226
2227         if (eb.engine->needs_cmd_parser && eb.batch_len) {
2228                 struct i915_vma *vma;
2229
2230                 vma = eb_parse(&eb, drm_is_current_master(file));
2231                 if (IS_ERR(vma)) {
2232                         err = PTR_ERR(vma);
2233                         goto err_vma;
2234                 }
2235
2236                 if (vma) {
2237                         /*
2238                          * Batch parsed and accepted:
2239                          *
2240                          * Set the DISPATCH_SECURE bit to remove the NON_SECURE
2241                          * bit from MI_BATCH_BUFFER_START commands issued in
2242                          * the dispatch_execbuffer implementations. We
2243                          * specifically don't want that set on batches the
2244                          * command parser has accepted.
2245                          */
2246                         eb.batch_flags |= I915_DISPATCH_SECURE;
2247                         eb.batch_start_offset = 0;
2248                         eb.batch = vma;
2249                 }
2250         }
2251
2252         if (eb.batch_len == 0)
2253                 eb.batch_len = eb.batch->size - eb.batch_start_offset;
2254
2255         /*
2256          * snb/ivb/vlv conflate the "batch in ppgtt" bit with the "non-secure
2257          * batch" bit. Hence we need to pin secure batches into the global gtt.
2258          * hsw should have this fixed, but bdw mucks it up again. */
2259         if (eb.batch_flags & I915_DISPATCH_SECURE) {
2260                 struct i915_vma *vma;
2261
2262                 /*
2263                  * So on first glance it looks freaky that we pin the batch here
2264                  * outside of the reservation loop. But:
2265                  * - The batch is already pinned into the relevant ppgtt, so we
2266                  *   already have the backing storage fully allocated.
2267                  * - No other BO uses the global gtt (well contexts, but meh),
2268                  *   so we don't really have issues with multiple objects not
2269                  *   fitting due to fragmentation.
2270                  * So this is actually safe.
2271                  */
2272                 vma = i915_gem_object_ggtt_pin(eb.batch->obj, NULL, 0, 0, 0);
2273                 if (IS_ERR(vma)) {
2274                         err = PTR_ERR(vma);
2275                         goto err_vma;
2276                 }
2277
2278                 eb.batch = vma;
2279         }
2280
2281         /* All GPU relocation batches must be submitted prior to the user rq */
2282         GEM_BUG_ON(eb.reloc_cache.rq);
2283
2284         /* Allocate a request for this batch buffer nice and early. */
2285         eb.request = i915_gem_request_alloc(eb.engine, eb.ctx);
2286         if (IS_ERR(eb.request)) {
2287                 err = PTR_ERR(eb.request);
2288                 goto err_batch_unpin;
2289         }
2290
2291         if (in_fence) {
2292                 err = i915_gem_request_await_dma_fence(eb.request, in_fence);
2293                 if (err < 0)
2294                         goto err_request;
2295         }
2296
2297         if (out_fence_fd != -1) {
2298                 out_fence = sync_file_create(&eb.request->fence);
2299                 if (!out_fence) {
2300                         err = -ENOMEM;
2301                         goto err_request;
2302                 }
2303         }
2304
2305         /*
2306          * Whilst this request exists, batch_obj will be on the
2307          * active_list, and so will hold the active reference. Only when this
2308          * request is retired will the the batch_obj be moved onto the
2309          * inactive_list and lose its active reference. Hence we do not need
2310          * to explicitly hold another reference here.
2311          */
2312         eb.request->batch = eb.batch;
2313
2314         trace_i915_gem_request_queue(eb.request, eb.batch_flags);
2315         err = eb_submit(&eb);
2316 err_request:
2317         __i915_add_request(eb.request, err == 0);
2318         add_to_client(eb.request, file);
2319
2320         if (out_fence) {
2321                 if (err == 0) {
2322                         fd_install(out_fence_fd, out_fence->file);
2323                         args->rsvd2 &= GENMASK_ULL(0, 31); /* keep in-fence */
2324                         args->rsvd2 |= (u64)out_fence_fd << 32;
2325                         out_fence_fd = -1;
2326                 } else {
2327                         fput(out_fence->file);
2328                 }
2329         }
2330
2331 err_batch_unpin:
2332         if (eb.batch_flags & I915_DISPATCH_SECURE)
2333                 i915_vma_unpin(eb.batch);
2334 err_vma:
2335         if (eb.exec)
2336                 eb_release_vmas(&eb);
2337         i915_gem_context_put(eb.ctx);
2338 err_unlock:
2339         mutex_unlock(&dev->struct_mutex);
2340 err_rpm:
2341         intel_runtime_pm_put(eb.i915);
2342         eb_destroy(&eb);
2343         if (out_fence_fd != -1)
2344                 put_unused_fd(out_fence_fd);
2345 err_in_fence:
2346         dma_fence_put(in_fence);
2347         return err;
2348 }
2349
2350 /*
2351  * Legacy execbuffer just creates an exec2 list from the original exec object
2352  * list array and passes it to the real function.
2353  */
2354 int
2355 i915_gem_execbuffer(struct drm_device *dev, void *data,
2356                     struct drm_file *file)
2357 {
2358         const size_t sz = sizeof(struct drm_i915_gem_exec_object2);
2359         struct drm_i915_gem_execbuffer *args = data;
2360         struct drm_i915_gem_execbuffer2 exec2;
2361         struct drm_i915_gem_exec_object *exec_list = NULL;
2362         struct drm_i915_gem_exec_object2 *exec2_list = NULL;
2363         unsigned int i;
2364         int err;
2365
2366         if (args->buffer_count < 1 || args->buffer_count > SIZE_MAX / sz - 1) {
2367                 DRM_DEBUG("execbuf2 with %d buffers\n", args->buffer_count);
2368                 return -EINVAL;
2369         }
2370
2371         exec2.buffers_ptr = args->buffers_ptr;
2372         exec2.buffer_count = args->buffer_count;
2373         exec2.batch_start_offset = args->batch_start_offset;
2374         exec2.batch_len = args->batch_len;
2375         exec2.DR1 = args->DR1;
2376         exec2.DR4 = args->DR4;
2377         exec2.num_cliprects = args->num_cliprects;
2378         exec2.cliprects_ptr = args->cliprects_ptr;
2379         exec2.flags = I915_EXEC_RENDER;
2380         i915_execbuffer2_set_context_id(exec2, 0);
2381
2382         if (!i915_gem_check_execbuffer(&exec2))
2383                 return -EINVAL;
2384
2385         /* Copy in the exec list from userland */
2386         exec_list = kvmalloc_array(args->buffer_count, sizeof(*exec_list),
2387                                    __GFP_NOWARN | GFP_TEMPORARY);
2388         exec2_list = kvmalloc_array(args->buffer_count + 1, sz,
2389                                     __GFP_NOWARN | GFP_TEMPORARY);
2390         if (exec_list == NULL || exec2_list == NULL) {
2391                 DRM_DEBUG("Failed to allocate exec list for %d buffers\n",
2392                           args->buffer_count);
2393                 kvfree(exec_list);
2394                 kvfree(exec2_list);
2395                 return -ENOMEM;
2396         }
2397         err = copy_from_user(exec_list,
2398                              u64_to_user_ptr(args->buffers_ptr),
2399                              sizeof(*exec_list) * args->buffer_count);
2400         if (err) {
2401                 DRM_DEBUG("copy %d exec entries failed %d\n",
2402                           args->buffer_count, err);
2403                 kvfree(exec_list);
2404                 kvfree(exec2_list);
2405                 return -EFAULT;
2406         }
2407
2408         for (i = 0; i < args->buffer_count; i++) {
2409                 exec2_list[i].handle = exec_list[i].handle;
2410                 exec2_list[i].relocation_count = exec_list[i].relocation_count;
2411                 exec2_list[i].relocs_ptr = exec_list[i].relocs_ptr;
2412                 exec2_list[i].alignment = exec_list[i].alignment;
2413                 exec2_list[i].offset = exec_list[i].offset;
2414                 if (INTEL_GEN(to_i915(dev)) < 4)
2415                         exec2_list[i].flags = EXEC_OBJECT_NEEDS_FENCE;
2416                 else
2417                         exec2_list[i].flags = 0;
2418         }
2419
2420         err = i915_gem_do_execbuffer(dev, file, &exec2, exec2_list);
2421         if (exec2.flags & __EXEC_HAS_RELOC) {
2422                 struct drm_i915_gem_exec_object __user *user_exec_list =
2423                         u64_to_user_ptr(args->buffers_ptr);
2424
2425                 /* Copy the new buffer offsets back to the user's exec list. */
2426                 for (i = 0; i < args->buffer_count; i++) {
2427                         if (!(exec2_list[i].offset & UPDATE))
2428                                 continue;
2429
2430                         exec2_list[i].offset =
2431                                 gen8_canonical_addr(exec2_list[i].offset & PIN_OFFSET_MASK);
2432                         exec2_list[i].offset &= PIN_OFFSET_MASK;
2433                         if (__copy_to_user(&user_exec_list[i].offset,
2434                                            &exec2_list[i].offset,
2435                                            sizeof(user_exec_list[i].offset)))
2436                                 break;
2437                 }
2438         }
2439
2440         kvfree(exec_list);
2441         kvfree(exec2_list);
2442         return err;
2443 }
2444
2445 int
2446 i915_gem_execbuffer2(struct drm_device *dev, void *data,
2447                      struct drm_file *file)
2448 {
2449         const size_t sz = sizeof(struct drm_i915_gem_exec_object2);
2450         struct drm_i915_gem_execbuffer2 *args = data;
2451         struct drm_i915_gem_exec_object2 *exec2_list;
2452         int err;
2453
2454         if (args->buffer_count < 1 || args->buffer_count > SIZE_MAX / sz - 1) {
2455                 DRM_DEBUG("execbuf2 with %d buffers\n", args->buffer_count);
2456                 return -EINVAL;
2457         }
2458
2459         if (!i915_gem_check_execbuffer(args))
2460                 return -EINVAL;
2461
2462         /* Allocate an extra slot for use by the command parser */
2463         exec2_list = kvmalloc_array(args->buffer_count + 1, sz,
2464                                     __GFP_NOWARN | GFP_TEMPORARY);
2465         if (exec2_list == NULL) {
2466                 DRM_DEBUG("Failed to allocate exec list for %d buffers\n",
2467                           args->buffer_count);
2468                 return -ENOMEM;
2469         }
2470         if (copy_from_user(exec2_list,
2471                            u64_to_user_ptr(args->buffers_ptr),
2472                            sizeof(*exec2_list) * args->buffer_count)) {
2473                 DRM_DEBUG("copy %d exec entries failed\n", args->buffer_count);
2474                 kvfree(exec2_list);
2475                 return -EFAULT;
2476         }
2477
2478         err = i915_gem_do_execbuffer(dev, file, args, exec2_list);
2479
2480         /*
2481          * Now that we have begun execution of the batchbuffer, we ignore
2482          * any new error after this point. Also given that we have already
2483          * updated the associated relocations, we try to write out the current
2484          * object locations irrespective of any error.
2485          */
2486         if (args->flags & __EXEC_HAS_RELOC) {
2487                 struct drm_i915_gem_exec_object2 __user *user_exec_list =
2488                         u64_to_user_ptr(args->buffers_ptr);
2489                 unsigned int i;
2490
2491                 /* Copy the new buffer offsets back to the user's exec list. */
2492                 user_access_begin();
2493                 for (i = 0; i < args->buffer_count; i++) {
2494                         if (!(exec2_list[i].offset & UPDATE))
2495                                 continue;
2496
2497                         exec2_list[i].offset =
2498                                 gen8_canonical_addr(exec2_list[i].offset & PIN_OFFSET_MASK);
2499                         unsafe_put_user(exec2_list[i].offset,
2500                                         &user_exec_list[i].offset,
2501                                         end_user);
2502                 }
2503 end_user:
2504                 user_access_end();
2505         }
2506
2507         args->flags &= ~__I915_EXEC_UNKNOWN_FLAGS;
2508         kvfree(exec2_list);
2509         return err;
2510 }