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 | ||
0b6bc81d | 33 | #include "gt/intel_ggtt_fencing.h" |
2c86e55d MA |
34 | #include "gem/i915_gem_object.h" |
35 | ||
b42fe9ca | 36 | #include "i915_gem_gtt.h" |
b42fe9ca | 37 | |
64d6c500 | 38 | #include "i915_active.h" |
e61e0f51 | 39 | #include "i915_request.h" |
2c86e55d | 40 | #include "i915_vma_types.h" |
b42fe9ca | 41 | |
718659a6 CW |
42 | struct i915_vma * |
43 | i915_vma_instance(struct drm_i915_gem_object *obj, | |
44 | struct i915_address_space *vm, | |
45 | const struct i915_ggtt_view *view); | |
46 | ||
6a2f59e4 CW |
47 | void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags); |
48 | #define I915_VMA_RELEASE_MAP BIT(0) | |
b42fe9ca | 49 | |
64d6c500 | 50 | static inline bool i915_vma_is_active(const struct i915_vma *vma) |
5c3f8c22 | 51 | { |
64d6c500 | 52 | return !i915_active_is_idle(&vma->active); |
5c3f8c22 CW |
53 | } |
54 | ||
2850748e CW |
55 | int __must_check __i915_vma_move_to_active(struct i915_vma *vma, |
56 | struct i915_request *rq); | |
5c3f8c22 CW |
57 | int __must_check i915_vma_move_to_active(struct i915_vma *vma, |
58 | struct i915_request *rq, | |
59 | unsigned int flags); | |
60 | ||
4dd2fbbf CW |
61 | #define __i915_vma_flags(v) ((unsigned long *)&(v)->flags.counter) |
62 | ||
b42fe9ca JL |
63 | static inline bool i915_vma_is_ggtt(const struct i915_vma *vma) |
64 | { | |
4dd2fbbf | 65 | return test_bit(I915_VMA_GGTT_BIT, __i915_vma_flags(vma)); |
b42fe9ca JL |
66 | } |
67 | ||
7125397b CW |
68 | static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma) |
69 | { | |
4dd2fbbf | 70 | return test_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); |
7125397b CW |
71 | } |
72 | ||
73 | static inline void i915_vma_set_ggtt_write(struct i915_vma *vma) | |
74 | { | |
75 | GEM_BUG_ON(!i915_vma_is_ggtt(vma)); | |
4dd2fbbf | 76 | set_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); |
7125397b CW |
77 | } |
78 | ||
4dd2fbbf | 79 | static inline bool i915_vma_unset_ggtt_write(struct i915_vma *vma) |
7125397b | 80 | { |
4dd2fbbf CW |
81 | return test_and_clear_bit(I915_VMA_GGTT_WRITE_BIT, |
82 | __i915_vma_flags(vma)); | |
7125397b CW |
83 | } |
84 | ||
85 | void i915_vma_flush_writes(struct i915_vma *vma); | |
86 | ||
b42fe9ca JL |
87 | static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma) |
88 | { | |
4dd2fbbf | 89 | return test_bit(I915_VMA_CAN_FENCE_BIT, __i915_vma_flags(vma)); |
b42fe9ca JL |
90 | } |
91 | ||
a65adaf8 CW |
92 | static inline bool i915_vma_set_userfault(struct i915_vma *vma) |
93 | { | |
94 | GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma)); | |
4dd2fbbf | 95 | return test_and_set_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); |
a65adaf8 CW |
96 | } |
97 | ||
98 | static inline void i915_vma_unset_userfault(struct i915_vma *vma) | |
99 | { | |
4dd2fbbf | 100 | return clear_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); |
a65adaf8 CW |
101 | } |
102 | ||
103 | static inline bool i915_vma_has_userfault(const struct i915_vma *vma) | |
104 | { | |
4dd2fbbf | 105 | return test_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); |
a65adaf8 CW |
106 | } |
107 | ||
155ab883 CW |
108 | static inline bool i915_vma_is_closed(const struct i915_vma *vma) |
109 | { | |
110 | return !list_empty(&vma->closed_link); | |
111 | } | |
112 | ||
b42fe9ca JL |
113 | static inline u32 i915_ggtt_offset(const struct i915_vma *vma) |
114 | { | |
115 | GEM_BUG_ON(!i915_vma_is_ggtt(vma)); | |
b290a78b | 116 | GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); |
b42fe9ca JL |
117 | GEM_BUG_ON(upper_32_bits(vma->node.start)); |
118 | GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1)); | |
119 | return lower_32_bits(vma->node.start); | |
120 | } | |
121 | ||
dd18cedf JB |
122 | static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma) |
123 | { | |
124 | return i915_vm_to_ggtt(vma->vm)->pin_bias; | |
125 | } | |
126 | ||
b42fe9ca JL |
127 | static inline struct i915_vma *i915_vma_get(struct i915_vma *vma) |
128 | { | |
129 | i915_gem_object_get(vma->obj); | |
130 | return vma; | |
131 | } | |
132 | ||
2833ddcc CW |
133 | static inline struct i915_vma *i915_vma_tryget(struct i915_vma *vma) |
134 | { | |
135 | if (likely(kref_get_unless_zero(&vma->obj->base.refcount))) | |
136 | return vma; | |
137 | ||
138 | return NULL; | |
139 | } | |
140 | ||
b42fe9ca JL |
141 | static inline void i915_vma_put(struct i915_vma *vma) |
142 | { | |
143 | i915_gem_object_put(vma->obj); | |
144 | } | |
145 | ||
2bf0d267 TU |
146 | static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b) |
147 | { | |
148 | return a - b; | |
149 | } | |
150 | ||
b42fe9ca JL |
151 | static inline long |
152 | i915_vma_compare(struct i915_vma *vma, | |
153 | struct i915_address_space *vm, | |
154 | const struct i915_ggtt_view *view) | |
155 | { | |
2bf0d267 TU |
156 | ptrdiff_t cmp; |
157 | ||
4d1368f7 | 158 | GEM_BUG_ON(view && !i915_is_ggtt(vm)); |
b42fe9ca | 159 | |
2bf0d267 TU |
160 | cmp = ptrdiff(vma->vm, vm); |
161 | if (cmp) | |
162 | return cmp; | |
b42fe9ca | 163 | |
992e418d CW |
164 | BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0); |
165 | cmp = vma->ggtt_view.type; | |
b42fe9ca | 166 | if (!view) |
992e418d | 167 | return cmp; |
b42fe9ca | 168 | |
992e418d CW |
169 | cmp -= view->type; |
170 | if (cmp) | |
171 | return cmp; | |
b42fe9ca | 172 | |
ed11e415 VS |
173 | assert_i915_gem_gtt_types(); |
174 | ||
992e418d CW |
175 | /* ggtt_view.type also encodes its size so that we both distinguish |
176 | * different views using it as a "type" and also use a compact (no | |
177 | * accessing of uninitialised padding bytes) memcmp without storing | |
178 | * an extra parameter or adding more code. | |
8bab1193 CW |
179 | * |
180 | * To ensure that the memcmp is valid for all branches of the union, | |
181 | * even though the code looks like it is just comparing one branch, | |
182 | * we assert above that all branches have the same address, and that | |
183 | * each branch has a unique type/size. | |
992e418d CW |
184 | */ |
185 | BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL); | |
186 | BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED); | |
1a74fc0b | 187 | BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED); |
8bab1193 CW |
188 | BUILD_BUG_ON(offsetof(typeof(*view), rotated) != |
189 | offsetof(typeof(*view), partial)); | |
1a74fc0b VS |
190 | BUILD_BUG_ON(offsetof(typeof(*view), rotated) != |
191 | offsetof(typeof(*view), remapped)); | |
8bab1193 | 192 | return memcmp(&vma->ggtt_view.partial, &view->partial, view->type); |
b42fe9ca JL |
193 | } |
194 | ||
2850748e CW |
195 | struct i915_vma_work *i915_vma_work(void); |
196 | int i915_vma_bind(struct i915_vma *vma, | |
197 | enum i915_cache_level cache_level, | |
198 | u32 flags, | |
199 | struct i915_vma_work *work); | |
200 | ||
33dd8899 | 201 | bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color); |
782a3e9e CW |
202 | bool i915_vma_misplaced(const struct i915_vma *vma, |
203 | u64 size, u64 alignment, u64 flags); | |
b42fe9ca | 204 | void __i915_vma_set_map_and_fenceable(struct i915_vma *vma); |
a65adaf8 | 205 | void i915_vma_revoke_mmap(struct i915_vma *vma); |
bffa18dd | 206 | void __i915_vma_evict(struct i915_vma *vma); |
2850748e | 207 | int __i915_vma_unbind(struct i915_vma *vma); |
b42fe9ca | 208 | int __must_check i915_vma_unbind(struct i915_vma *vma); |
4ff4b44c | 209 | void i915_vma_unlink_ctx(struct i915_vma *vma); |
b42fe9ca | 210 | void i915_vma_close(struct i915_vma *vma); |
3365e226 | 211 | void i915_vma_reopen(struct i915_vma *vma); |
76f9764c CW |
212 | |
213 | static inline struct i915_vma *__i915_vma_get(struct i915_vma *vma) | |
214 | { | |
215 | if (kref_get_unless_zero(&vma->ref)) | |
216 | return vma; | |
217 | ||
218 | return NULL; | |
219 | } | |
220 | ||
221 | void i915_vma_release(struct kref *ref); | |
222 | static inline void __i915_vma_put(struct i915_vma *vma) | |
223 | { | |
224 | kref_put(&vma->ref, i915_vma_release); | |
225 | } | |
b42fe9ca | 226 | |
52791eee | 227 | #define assert_vma_held(vma) dma_resv_assert_held((vma)->resv) |
6951e589 CW |
228 | |
229 | static inline void i915_vma_lock(struct i915_vma *vma) | |
230 | { | |
52791eee | 231 | dma_resv_lock(vma->resv, NULL); |
6951e589 CW |
232 | } |
233 | ||
234 | static inline void i915_vma_unlock(struct i915_vma *vma) | |
235 | { | |
52791eee | 236 | dma_resv_unlock(vma->resv); |
6951e589 CW |
237 | } |
238 | ||
2850748e | 239 | int __must_check |
47b08693 ML |
240 | i915_vma_pin_ww(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, |
241 | u64 size, u64 alignment, u64 flags); | |
242 | ||
243 | static inline int __must_check | |
244 | i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags) | |
245 | { | |
246 | return i915_vma_pin_ww(vma, NULL, size, alignment, flags); | |
247 | } | |
248 | ||
249 | int i915_ggtt_pin(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, | |
250 | u32 align, unsigned int flags); | |
b42fe9ca JL |
251 | |
252 | static inline int i915_vma_pin_count(const struct i915_vma *vma) | |
253 | { | |
4dd2fbbf | 254 | return atomic_read(&vma->flags) & I915_VMA_PIN_MASK; |
b42fe9ca JL |
255 | } |
256 | ||
257 | static inline bool i915_vma_is_pinned(const struct i915_vma *vma) | |
258 | { | |
259 | return i915_vma_pin_count(vma); | |
260 | } | |
261 | ||
262 | static inline void __i915_vma_pin(struct i915_vma *vma) | |
263 | { | |
4dd2fbbf | 264 | atomic_inc(&vma->flags); |
2850748e | 265 | GEM_BUG_ON(!i915_vma_is_pinned(vma)); |
b42fe9ca JL |
266 | } |
267 | ||
268 | static inline void __i915_vma_unpin(struct i915_vma *vma) | |
269 | { | |
2850748e | 270 | GEM_BUG_ON(!i915_vma_is_pinned(vma)); |
4dd2fbbf | 271 | atomic_dec(&vma->flags); |
b42fe9ca JL |
272 | } |
273 | ||
274 | static inline void i915_vma_unpin(struct i915_vma *vma) | |
275 | { | |
276 | GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); | |
277 | __i915_vma_unpin(vma); | |
278 | } | |
279 | ||
e9e7dc41 CW |
280 | static inline bool i915_vma_is_bound(const struct i915_vma *vma, |
281 | unsigned int where) | |
282 | { | |
4dd2fbbf | 283 | return atomic_read(&vma->flags) & where; |
e9e7dc41 CW |
284 | } |
285 | ||
1e0a96e5 MA |
286 | static inline bool i915_node_color_differs(const struct drm_mm_node *node, |
287 | unsigned long color) | |
288 | { | |
b290a78b | 289 | return drm_mm_node_allocated(node) && node->color != color; |
1e0a96e5 MA |
290 | } |
291 | ||
b42fe9ca JL |
292 | /** |
293 | * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture | |
294 | * @vma: VMA to iomap | |
295 | * | |
296 | * The passed in VMA has to be pinned in the global GTT mappable region. | |
297 | * An extra pinning of the VMA is acquired for the return iomapping, | |
298 | * the caller must call i915_vma_unpin_iomap to relinquish the pinning | |
299 | * after the iomapping is no longer required. | |
300 | * | |
b42fe9ca JL |
301 | * Returns a valid iomapped pointer or ERR_PTR. |
302 | */ | |
303 | void __iomem *i915_vma_pin_iomap(struct i915_vma *vma); | |
304 | #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x)) | |
305 | ||
306 | /** | |
307 | * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap | |
308 | * @vma: VMA to unpin | |
309 | * | |
310 | * Unpins the previously iomapped VMA from i915_vma_pin_iomap(). | |
311 | * | |
2850748e CW |
312 | * This function is only valid to be called on a VMA previously |
313 | * iomapped by the caller with i915_vma_pin_iomap(). | |
b42fe9ca | 314 | */ |
b4563f59 | 315 | void i915_vma_unpin_iomap(struct i915_vma *vma); |
b42fe9ca JL |
316 | |
317 | static inline struct page *i915_vma_first_page(struct i915_vma *vma) | |
318 | { | |
319 | GEM_BUG_ON(!vma->pages); | |
320 | return sg_page(vma->pages->sgl); | |
321 | } | |
322 | ||
323 | /** | |
324 | * i915_vma_pin_fence - pin fencing state | |
325 | * @vma: vma to pin fencing for | |
326 | * | |
327 | * This pins the fencing state (whether tiled or untiled) to make sure the | |
328 | * vma (and its object) is ready to be used as a scanout target. Fencing | |
329 | * status must be synchronize first by calling i915_vma_get_fence(): | |
330 | * | |
331 | * The resulting fence pin reference must be released again with | |
332 | * i915_vma_unpin_fence(). | |
333 | * | |
334 | * Returns: | |
335 | * | |
336 | * True if the vma has a fence, false otherwise. | |
337 | */ | |
1f7fd484 | 338 | int __must_check i915_vma_pin_fence(struct i915_vma *vma); |
0d86ee35 | 339 | void i915_vma_revoke_fence(struct i915_vma *vma); |
3bd40735 | 340 | |
2850748e CW |
341 | int __i915_vma_pin_fence(struct i915_vma *vma); |
342 | ||
3bd40735 | 343 | static inline void __i915_vma_unpin_fence(struct i915_vma *vma) |
b42fe9ca | 344 | { |
e2ccc50a CW |
345 | GEM_BUG_ON(atomic_read(&vma->fence->pin_count) <= 0); |
346 | atomic_dec(&vma->fence->pin_count); | |
b42fe9ca JL |
347 | } |
348 | ||
349 | /** | |
350 | * i915_vma_unpin_fence - unpin fencing state | |
351 | * @vma: vma to unpin fencing for | |
352 | * | |
353 | * This releases the fence pin reference acquired through | |
354 | * i915_vma_pin_fence. It will handle both objects with and without an | |
355 | * attached fence correctly, callers do not need to distinguish this. | |
356 | */ | |
357 | static inline void | |
358 | i915_vma_unpin_fence(struct i915_vma *vma) | |
359 | { | |
3bd40735 CW |
360 | if (vma->fence) |
361 | __i915_vma_unpin_fence(vma); | |
b42fe9ca JL |
362 | } |
363 | ||
71e51ca8 | 364 | void i915_vma_parked(struct intel_gt *gt); |
3365e226 | 365 | |
e2189dd0 CW |
366 | #define for_each_until(cond) if (cond) break; else |
367 | ||
368 | /** | |
369 | * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object. | |
370 | * @V: the #i915_vma iterator | |
371 | * @OBJ: the #drm_i915_gem_object | |
372 | * | |
373 | * GGTT VMA are placed at the being of the object's vma_list, see | |
374 | * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA, | |
375 | * or the list is empty ofc. | |
376 | */ | |
377 | #define for_each_ggtt_vma(V, OBJ) \ | |
528cbd17 | 378 | list_for_each_entry(V, &(OBJ)->vma.list, obj_link) \ |
e2189dd0 | 379 | for_each_until(!i915_vma_is_ggtt(V)) |
b42fe9ca | 380 | |
13f1bfd3 CW |
381 | struct i915_vma *i915_vma_alloc(void); |
382 | void i915_vma_free(struct i915_vma *vma); | |
383 | ||
1aff1903 CW |
384 | struct i915_vma *i915_vma_make_unshrinkable(struct i915_vma *vma); |
385 | void i915_vma_make_shrinkable(struct i915_vma *vma); | |
386 | void i915_vma_make_purgeable(struct i915_vma *vma); | |
387 | ||
e3793468 CW |
388 | int i915_vma_wait_for_bind(struct i915_vma *vma); |
389 | ||
2850748e CW |
390 | static inline int i915_vma_sync(struct i915_vma *vma) |
391 | { | |
392 | /* Wait for the asynchronous bindings and pending GPU reads */ | |
393 | return i915_active_wait(&vma->active); | |
394 | } | |
395 | ||
e2189dd0 | 396 | #endif |