Commit | Line | Data |
---|---|---|
b42fe9ca JL |
1 | /* |
2 | * Copyright © 2016 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 | */ | |
24 | ||
25 | #ifndef __I915_VMA_H__ | |
26 | #define __I915_VMA_H__ | |
27 | ||
28 | #include <linux/io-mapping.h> | |
5c3f8c22 | 29 | #include <linux/rbtree.h> |
b42fe9ca JL |
30 | |
31 | #include <drm/drm_mm.h> | |
32 | ||
33 | #include "i915_gem_gtt.h" | |
34 | #include "i915_gem_fence_reg.h" | |
98932149 | 35 | #include "gem/i915_gem_object.h" |
b42fe9ca | 36 | |
64d6c500 | 37 | #include "i915_active.h" |
e61e0f51 | 38 | #include "i915_request.h" |
b42fe9ca JL |
39 | |
40 | enum i915_cache_level; | |
41 | ||
42 | /** | |
affa22b5 JN |
43 | * DOC: Virtual Memory Address |
44 | * | |
b42fe9ca JL |
45 | * A VMA represents a GEM BO that is bound into an address space. Therefore, a |
46 | * VMA's presence cannot be guaranteed before binding, or after unbinding the | |
47 | * object into/from the address space. | |
48 | * | |
49 | * To make things as simple as possible (ie. no refcounting), a VMA's lifetime | |
50 | * will always be <= an objects lifetime. So object refcounting should cover us. | |
51 | */ | |
52 | struct i915_vma { | |
53 | struct drm_mm_node node; | |
54 | struct drm_i915_gem_object *obj; | |
55 | struct i915_address_space *vm; | |
93f2cde2 | 56 | const struct i915_vma_ops *ops; |
0cf289bd | 57 | struct i915_fence_reg *fence; |
95ff7c7d | 58 | struct reservation_object *resv; /** Alias of obj->resv */ |
b42fe9ca JL |
59 | struct sg_table *pages; |
60 | void __iomem *iomap; | |
e9e7dc41 | 61 | void *private; /* owned by creator */ |
b42fe9ca JL |
62 | u64 size; |
63 | u64 display_alignment; | |
7464284b | 64 | struct i915_page_sizes page_sizes; |
b42fe9ca | 65 | |
944397f0 CW |
66 | u32 fence_size; |
67 | u32 fence_alignment; | |
68 | ||
3ffff017 CW |
69 | /** |
70 | * Count of the number of times this vma has been opened by different | |
71 | * handles (but same file) for execbuf, i.e. the number of aliases | |
72 | * that exist in the ctx->handle_vmas LUT for this vma. | |
73 | */ | |
155ab883 | 74 | atomic_t open_count; |
a65adaf8 | 75 | unsigned long flags; |
b42fe9ca | 76 | /** |
b18fe4be | 77 | * How many users have pinned this object in GTT space. |
b42fe9ca | 78 | * |
b18fe4be CW |
79 | * This is a tightly bound, fairly small number of users, so we |
80 | * stuff inside the flags field so that we can both check for overflow | |
81 | * and detect a no-op i915_vma_pin() in a single check, while also | |
82 | * pinning the vma. | |
83 | * | |
84 | * The worst case display setup would have the same vma pinned for | |
85 | * use on each plane on each crtc, while also building the next atomic | |
86 | * state and holding a pin for the length of the cleanup queue. In the | |
87 | * future, the flip queue may be increased from 1. | |
88 | * Estimated worst case: 3 [qlen] * 4 [max crtcs] * 7 [max planes] = 84 | |
89 | * | |
90 | * For GEM, the number of concurrent users for pwrite/pread is | |
91 | * unbounded. For execbuffer, it is currently one but will in future | |
92 | * be extended to allow multiple clients to pin vma concurrently. | |
93 | * | |
94 | * We also use suballocated pages, with each suballocation claiming | |
95 | * its own pin on the shared vma. At present, this is limited to | |
96 | * exclusive cachelines of a single page, so a maximum of 64 possible | |
97 | * users. | |
b42fe9ca | 98 | */ |
b18fe4be CW |
99 | #define I915_VMA_PIN_MASK 0xff |
100 | #define I915_VMA_PIN_OVERFLOW BIT(8) | |
b42fe9ca JL |
101 | |
102 | /** Flags and address space this VMA is bound to */ | |
b18fe4be CW |
103 | #define I915_VMA_GLOBAL_BIND BIT(9) |
104 | #define I915_VMA_LOCAL_BIND BIT(10) | |
b42fe9ca JL |
105 | #define I915_VMA_BIND_MASK (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND | I915_VMA_PIN_OVERFLOW) |
106 | ||
b18fe4be CW |
107 | #define I915_VMA_GGTT BIT(11) |
108 | #define I915_VMA_CAN_FENCE BIT(12) | |
155ab883 | 109 | #define I915_VMA_USERFAULT_BIT 13 |
a65adaf8 | 110 | #define I915_VMA_USERFAULT BIT(I915_VMA_USERFAULT_BIT) |
155ab883 | 111 | #define I915_VMA_GGTT_WRITE BIT(14) |
b42fe9ca | 112 | |
64d6c500 | 113 | struct i915_active active; |
21950ee7 | 114 | struct i915_active_request last_fence; |
b42fe9ca JL |
115 | |
116 | /** | |
117 | * Support different GGTT views into the same object. | |
118 | * This means there can be multiple VMA mappings per object and per VM. | |
119 | * i915_ggtt_view_type is used to distinguish between those entries. | |
120 | * The default one of zero (I915_GGTT_VIEW_NORMAL) is default and also | |
121 | * assumed in GEM functions which take no ggtt view parameter. | |
122 | */ | |
123 | struct i915_ggtt_view ggtt_view; | |
124 | ||
125 | /** This object's place on the active/inactive lists */ | |
126 | struct list_head vm_link; | |
127 | ||
128 | struct list_head obj_link; /* Link in the object's VMA list */ | |
129 | struct rb_node obj_node; | |
4ff4b44c | 130 | struct hlist_node obj_hash; |
b42fe9ca | 131 | |
8c45cec4 CW |
132 | /** This vma's place in the execbuf reservation list */ |
133 | struct list_head exec_link; | |
2889caa9 | 134 | struct list_head reloc_link; |
8c45cec4 CW |
135 | |
136 | /** This vma's place in the eviction list */ | |
137 | struct list_head evict_link; | |
b42fe9ca | 138 | |
3365e226 CW |
139 | struct list_head closed_link; |
140 | ||
b42fe9ca JL |
141 | /** |
142 | * Used for performing relocations during execbuffer insertion. | |
143 | */ | |
c7c6e46f | 144 | unsigned int *exec_flags; |
95ff7c7d | 145 | struct hlist_node exec_node; |
4ff4b44c | 146 | u32 exec_handle; |
b42fe9ca JL |
147 | }; |
148 | ||
718659a6 CW |
149 | struct i915_vma * |
150 | i915_vma_instance(struct drm_i915_gem_object *obj, | |
151 | struct i915_address_space *vm, | |
152 | const struct i915_ggtt_view *view); | |
153 | ||
6a2f59e4 CW |
154 | void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags); |
155 | #define I915_VMA_RELEASE_MAP BIT(0) | |
b42fe9ca | 156 | |
64d6c500 | 157 | static inline bool i915_vma_is_active(const struct i915_vma *vma) |
5c3f8c22 | 158 | { |
64d6c500 | 159 | return !i915_active_is_idle(&vma->active); |
5c3f8c22 CW |
160 | } |
161 | ||
162 | int __must_check i915_vma_move_to_active(struct i915_vma *vma, | |
163 | struct i915_request *rq, | |
164 | unsigned int flags); | |
165 | ||
b42fe9ca JL |
166 | static inline bool i915_vma_is_ggtt(const struct i915_vma *vma) |
167 | { | |
168 | return vma->flags & I915_VMA_GGTT; | |
169 | } | |
170 | ||
7125397b CW |
171 | static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma) |
172 | { | |
173 | return vma->flags & I915_VMA_GGTT_WRITE; | |
174 | } | |
175 | ||
176 | static inline void i915_vma_set_ggtt_write(struct i915_vma *vma) | |
177 | { | |
178 | GEM_BUG_ON(!i915_vma_is_ggtt(vma)); | |
179 | vma->flags |= I915_VMA_GGTT_WRITE; | |
180 | } | |
181 | ||
182 | static inline void i915_vma_unset_ggtt_write(struct i915_vma *vma) | |
183 | { | |
184 | vma->flags &= ~I915_VMA_GGTT_WRITE; | |
185 | } | |
186 | ||
187 | void i915_vma_flush_writes(struct i915_vma *vma); | |
188 | ||
b42fe9ca JL |
189 | static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma) |
190 | { | |
191 | return vma->flags & I915_VMA_CAN_FENCE; | |
192 | } | |
193 | ||
a65adaf8 CW |
194 | static inline bool i915_vma_set_userfault(struct i915_vma *vma) |
195 | { | |
196 | GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma)); | |
197 | return __test_and_set_bit(I915_VMA_USERFAULT_BIT, &vma->flags); | |
198 | } | |
199 | ||
200 | static inline void i915_vma_unset_userfault(struct i915_vma *vma) | |
201 | { | |
202 | return __clear_bit(I915_VMA_USERFAULT_BIT, &vma->flags); | |
203 | } | |
204 | ||
205 | static inline bool i915_vma_has_userfault(const struct i915_vma *vma) | |
206 | { | |
207 | return test_bit(I915_VMA_USERFAULT_BIT, &vma->flags); | |
208 | } | |
209 | ||
155ab883 CW |
210 | static inline bool i915_vma_is_closed(const struct i915_vma *vma) |
211 | { | |
212 | return !list_empty(&vma->closed_link); | |
213 | } | |
214 | ||
b42fe9ca JL |
215 | static inline u32 i915_ggtt_offset(const struct i915_vma *vma) |
216 | { | |
217 | GEM_BUG_ON(!i915_vma_is_ggtt(vma)); | |
218 | GEM_BUG_ON(!vma->node.allocated); | |
219 | GEM_BUG_ON(upper_32_bits(vma->node.start)); | |
220 | GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1)); | |
221 | return lower_32_bits(vma->node.start); | |
222 | } | |
223 | ||
dd18cedf JB |
224 | static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma) |
225 | { | |
226 | return i915_vm_to_ggtt(vma->vm)->pin_bias; | |
227 | } | |
228 | ||
b42fe9ca JL |
229 | static inline struct i915_vma *i915_vma_get(struct i915_vma *vma) |
230 | { | |
231 | i915_gem_object_get(vma->obj); | |
232 | return vma; | |
233 | } | |
234 | ||
235 | static inline void i915_vma_put(struct i915_vma *vma) | |
236 | { | |
237 | i915_gem_object_put(vma->obj); | |
238 | } | |
239 | ||
2bf0d267 TU |
240 | static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b) |
241 | { | |
242 | return a - b; | |
243 | } | |
244 | ||
b42fe9ca JL |
245 | static inline long |
246 | i915_vma_compare(struct i915_vma *vma, | |
247 | struct i915_address_space *vm, | |
248 | const struct i915_ggtt_view *view) | |
249 | { | |
2bf0d267 TU |
250 | ptrdiff_t cmp; |
251 | ||
4d1368f7 | 252 | GEM_BUG_ON(view && !i915_is_ggtt(vm)); |
b42fe9ca | 253 | |
2bf0d267 TU |
254 | cmp = ptrdiff(vma->vm, vm); |
255 | if (cmp) | |
256 | return cmp; | |
b42fe9ca | 257 | |
992e418d CW |
258 | BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0); |
259 | cmp = vma->ggtt_view.type; | |
b42fe9ca | 260 | if (!view) |
992e418d | 261 | return cmp; |
b42fe9ca | 262 | |
992e418d CW |
263 | cmp -= view->type; |
264 | if (cmp) | |
265 | return cmp; | |
b42fe9ca | 266 | |
ed11e415 VS |
267 | assert_i915_gem_gtt_types(); |
268 | ||
992e418d CW |
269 | /* ggtt_view.type also encodes its size so that we both distinguish |
270 | * different views using it as a "type" and also use a compact (no | |
271 | * accessing of uninitialised padding bytes) memcmp without storing | |
272 | * an extra parameter or adding more code. | |
8bab1193 CW |
273 | * |
274 | * To ensure that the memcmp is valid for all branches of the union, | |
275 | * even though the code looks like it is just comparing one branch, | |
276 | * we assert above that all branches have the same address, and that | |
277 | * each branch has a unique type/size. | |
992e418d CW |
278 | */ |
279 | BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL); | |
280 | BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED); | |
1a74fc0b | 281 | BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED); |
8bab1193 CW |
282 | BUILD_BUG_ON(offsetof(typeof(*view), rotated) != |
283 | offsetof(typeof(*view), partial)); | |
1a74fc0b VS |
284 | BUILD_BUG_ON(offsetof(typeof(*view), rotated) != |
285 | offsetof(typeof(*view), remapped)); | |
8bab1193 | 286 | return memcmp(&vma->ggtt_view.partial, &view->partial, view->type); |
b42fe9ca JL |
287 | } |
288 | ||
289 | int i915_vma_bind(struct i915_vma *vma, enum i915_cache_level cache_level, | |
290 | u32 flags); | |
291 | bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long cache_level); | |
782a3e9e CW |
292 | bool i915_vma_misplaced(const struct i915_vma *vma, |
293 | u64 size, u64 alignment, u64 flags); | |
b42fe9ca | 294 | void __i915_vma_set_map_and_fenceable(struct i915_vma *vma); |
a65adaf8 | 295 | void i915_vma_revoke_mmap(struct i915_vma *vma); |
b42fe9ca | 296 | int __must_check i915_vma_unbind(struct i915_vma *vma); |
4ff4b44c | 297 | void i915_vma_unlink_ctx(struct i915_vma *vma); |
b42fe9ca | 298 | void i915_vma_close(struct i915_vma *vma); |
3365e226 CW |
299 | void i915_vma_reopen(struct i915_vma *vma); |
300 | void i915_vma_destroy(struct i915_vma *vma); | |
b42fe9ca | 301 | |
6951e589 CW |
302 | #define assert_vma_held(vma) reservation_object_assert_held((vma)->resv) |
303 | ||
304 | static inline void i915_vma_lock(struct i915_vma *vma) | |
305 | { | |
306 | reservation_object_lock(vma->resv, NULL); | |
307 | } | |
308 | ||
309 | static inline void i915_vma_unlock(struct i915_vma *vma) | |
310 | { | |
311 | reservation_object_unlock(vma->resv); | |
312 | } | |
313 | ||
b42fe9ca JL |
314 | int __i915_vma_do_pin(struct i915_vma *vma, |
315 | u64 size, u64 alignment, u64 flags); | |
316 | static inline int __must_check | |
317 | i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags) | |
318 | { | |
319 | BUILD_BUG_ON(PIN_MBZ != I915_VMA_PIN_OVERFLOW); | |
320 | BUILD_BUG_ON(PIN_GLOBAL != I915_VMA_GLOBAL_BIND); | |
321 | BUILD_BUG_ON(PIN_USER != I915_VMA_LOCAL_BIND); | |
322 | ||
323 | /* Pin early to prevent the shrinker/eviction logic from destroying | |
324 | * our vma as we insert and bind. | |
325 | */ | |
0325701a CW |
326 | if (likely(((++vma->flags ^ flags) & I915_VMA_BIND_MASK) == 0)) { |
327 | GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); | |
328 | GEM_BUG_ON(i915_vma_misplaced(vma, size, alignment, flags)); | |
b42fe9ca | 329 | return 0; |
0325701a | 330 | } |
b42fe9ca JL |
331 | |
332 | return __i915_vma_do_pin(vma, size, alignment, flags); | |
333 | } | |
334 | ||
335 | static inline int i915_vma_pin_count(const struct i915_vma *vma) | |
336 | { | |
337 | return vma->flags & I915_VMA_PIN_MASK; | |
338 | } | |
339 | ||
340 | static inline bool i915_vma_is_pinned(const struct i915_vma *vma) | |
341 | { | |
342 | return i915_vma_pin_count(vma); | |
343 | } | |
344 | ||
345 | static inline void __i915_vma_pin(struct i915_vma *vma) | |
346 | { | |
347 | vma->flags++; | |
348 | GEM_BUG_ON(vma->flags & I915_VMA_PIN_OVERFLOW); | |
349 | } | |
350 | ||
351 | static inline void __i915_vma_unpin(struct i915_vma *vma) | |
352 | { | |
b42fe9ca JL |
353 | vma->flags--; |
354 | } | |
355 | ||
356 | static inline void i915_vma_unpin(struct i915_vma *vma) | |
357 | { | |
67fddd90 | 358 | GEM_BUG_ON(!i915_vma_is_pinned(vma)); |
b42fe9ca JL |
359 | GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); |
360 | __i915_vma_unpin(vma); | |
361 | } | |
362 | ||
e9e7dc41 CW |
363 | static inline bool i915_vma_is_bound(const struct i915_vma *vma, |
364 | unsigned int where) | |
365 | { | |
366 | return vma->flags & where; | |
367 | } | |
368 | ||
b42fe9ca JL |
369 | /** |
370 | * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture | |
371 | * @vma: VMA to iomap | |
372 | * | |
373 | * The passed in VMA has to be pinned in the global GTT mappable region. | |
374 | * An extra pinning of the VMA is acquired for the return iomapping, | |
375 | * the caller must call i915_vma_unpin_iomap to relinquish the pinning | |
376 | * after the iomapping is no longer required. | |
377 | * | |
378 | * Callers must hold the struct_mutex. | |
379 | * | |
380 | * Returns a valid iomapped pointer or ERR_PTR. | |
381 | */ | |
382 | void __iomem *i915_vma_pin_iomap(struct i915_vma *vma); | |
383 | #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x)) | |
384 | ||
385 | /** | |
386 | * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap | |
387 | * @vma: VMA to unpin | |
388 | * | |
389 | * Unpins the previously iomapped VMA from i915_vma_pin_iomap(). | |
390 | * | |
391 | * Callers must hold the struct_mutex. This function is only valid to be | |
392 | * called on a VMA previously iomapped by the caller with i915_vma_pin_iomap(). | |
393 | */ | |
b4563f59 | 394 | void i915_vma_unpin_iomap(struct i915_vma *vma); |
b42fe9ca JL |
395 | |
396 | static inline struct page *i915_vma_first_page(struct i915_vma *vma) | |
397 | { | |
398 | GEM_BUG_ON(!vma->pages); | |
399 | return sg_page(vma->pages->sgl); | |
400 | } | |
401 | ||
402 | /** | |
403 | * i915_vma_pin_fence - pin fencing state | |
404 | * @vma: vma to pin fencing for | |
405 | * | |
406 | * This pins the fencing state (whether tiled or untiled) to make sure the | |
407 | * vma (and its object) is ready to be used as a scanout target. Fencing | |
408 | * status must be synchronize first by calling i915_vma_get_fence(): | |
409 | * | |
410 | * The resulting fence pin reference must be released again with | |
411 | * i915_vma_unpin_fence(). | |
412 | * | |
413 | * Returns: | |
414 | * | |
415 | * True if the vma has a fence, false otherwise. | |
416 | */ | |
3bd40735 CW |
417 | int i915_vma_pin_fence(struct i915_vma *vma); |
418 | int __must_check i915_vma_put_fence(struct i915_vma *vma); | |
419 | ||
420 | static inline void __i915_vma_unpin_fence(struct i915_vma *vma) | |
b42fe9ca | 421 | { |
3bd40735 CW |
422 | GEM_BUG_ON(vma->fence->pin_count <= 0); |
423 | vma->fence->pin_count--; | |
b42fe9ca JL |
424 | } |
425 | ||
426 | /** | |
427 | * i915_vma_unpin_fence - unpin fencing state | |
428 | * @vma: vma to unpin fencing for | |
429 | * | |
430 | * This releases the fence pin reference acquired through | |
431 | * i915_vma_pin_fence. It will handle both objects with and without an | |
432 | * attached fence correctly, callers do not need to distinguish this. | |
433 | */ | |
434 | static inline void | |
435 | i915_vma_unpin_fence(struct i915_vma *vma) | |
436 | { | |
520ea7c5 | 437 | /* lockdep_assert_held(&vma->vm->i915->drm.struct_mutex); */ |
3bd40735 CW |
438 | if (vma->fence) |
439 | __i915_vma_unpin_fence(vma); | |
b42fe9ca JL |
440 | } |
441 | ||
3365e226 CW |
442 | void i915_vma_parked(struct drm_i915_private *i915); |
443 | ||
e2189dd0 CW |
444 | #define for_each_until(cond) if (cond) break; else |
445 | ||
446 | /** | |
447 | * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object. | |
448 | * @V: the #i915_vma iterator | |
449 | * @OBJ: the #drm_i915_gem_object | |
450 | * | |
451 | * GGTT VMA are placed at the being of the object's vma_list, see | |
452 | * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA, | |
453 | * or the list is empty ofc. | |
454 | */ | |
455 | #define for_each_ggtt_vma(V, OBJ) \ | |
528cbd17 | 456 | list_for_each_entry(V, &(OBJ)->vma.list, obj_link) \ |
e2189dd0 | 457 | for_each_until(!i915_vma_is_ggtt(V)) |
b42fe9ca | 458 | |
13f1bfd3 CW |
459 | struct i915_vma *i915_vma_alloc(void); |
460 | void i915_vma_free(struct i915_vma *vma); | |
461 | ||
e2189dd0 | 462 | #endif |