Loading...
Note: File does not exist in v3.1.
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>
29#include <linux/rbtree.h>
30
31#include <drm/drm_mm.h>
32
33#include "gt/intel_ggtt_fencing.h"
34#include "gem/i915_gem_object.h"
35
36#include "i915_gem_gtt.h"
37
38#include "i915_active.h"
39#include "i915_request.h"
40#include "i915_vma_types.h"
41
42struct i915_vma *
43i915_vma_instance(struct drm_i915_gem_object *obj,
44 struct i915_address_space *vm,
45 const struct i915_ggtt_view *view);
46
47void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags);
48#define I915_VMA_RELEASE_MAP BIT(0)
49
50static inline bool i915_vma_is_active(const struct i915_vma *vma)
51{
52 return !i915_active_is_idle(&vma->active);
53}
54
55int __must_check __i915_vma_move_to_active(struct i915_vma *vma,
56 struct i915_request *rq);
57int __must_check i915_vma_move_to_active(struct i915_vma *vma,
58 struct i915_request *rq,
59 unsigned int flags);
60
61#define __i915_vma_flags(v) ((unsigned long *)&(v)->flags.counter)
62
63static inline bool i915_vma_is_ggtt(const struct i915_vma *vma)
64{
65 return test_bit(I915_VMA_GGTT_BIT, __i915_vma_flags(vma));
66}
67
68static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma)
69{
70 return test_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma));
71}
72
73static inline void i915_vma_set_ggtt_write(struct i915_vma *vma)
74{
75 GEM_BUG_ON(!i915_vma_is_ggtt(vma));
76 set_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma));
77}
78
79static inline bool i915_vma_unset_ggtt_write(struct i915_vma *vma)
80{
81 return test_and_clear_bit(I915_VMA_GGTT_WRITE_BIT,
82 __i915_vma_flags(vma));
83}
84
85void i915_vma_flush_writes(struct i915_vma *vma);
86
87static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma)
88{
89 return test_bit(I915_VMA_CAN_FENCE_BIT, __i915_vma_flags(vma));
90}
91
92static inline bool i915_vma_set_userfault(struct i915_vma *vma)
93{
94 GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma));
95 return test_and_set_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
96}
97
98static inline void i915_vma_unset_userfault(struct i915_vma *vma)
99{
100 return clear_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
101}
102
103static inline bool i915_vma_has_userfault(const struct i915_vma *vma)
104{
105 return test_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
106}
107
108static inline bool i915_vma_is_closed(const struct i915_vma *vma)
109{
110 return !list_empty(&vma->closed_link);
111}
112
113static inline u32 i915_ggtt_offset(const struct i915_vma *vma)
114{
115 GEM_BUG_ON(!i915_vma_is_ggtt(vma));
116 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
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
122static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma)
123{
124 return i915_vm_to_ggtt(vma->vm)->pin_bias;
125}
126
127static inline struct i915_vma *i915_vma_get(struct i915_vma *vma)
128{
129 i915_gem_object_get(vma->obj);
130 return vma;
131}
132
133static 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
141static inline void i915_vma_put(struct i915_vma *vma)
142{
143 i915_gem_object_put(vma->obj);
144}
145
146static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b)
147{
148 return a - b;
149}
150
151static inline long
152i915_vma_compare(struct i915_vma *vma,
153 struct i915_address_space *vm,
154 const struct i915_ggtt_view *view)
155{
156 ptrdiff_t cmp;
157
158 GEM_BUG_ON(view && !i915_is_ggtt(vm));
159
160 cmp = ptrdiff(vma->vm, vm);
161 if (cmp)
162 return cmp;
163
164 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0);
165 cmp = vma->ggtt_view.type;
166 if (!view)
167 return cmp;
168
169 cmp -= view->type;
170 if (cmp)
171 return cmp;
172
173 assert_i915_gem_gtt_types();
174
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.
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.
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);
187 BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED);
188 BUILD_BUG_ON(offsetof(typeof(*view), rotated) !=
189 offsetof(typeof(*view), partial));
190 BUILD_BUG_ON(offsetof(typeof(*view), rotated) !=
191 offsetof(typeof(*view), remapped));
192 return memcmp(&vma->ggtt_view.partial, &view->partial, view->type);
193}
194
195struct i915_vma_work *i915_vma_work(void);
196int i915_vma_bind(struct i915_vma *vma,
197 enum i915_cache_level cache_level,
198 u32 flags,
199 struct i915_vma_work *work);
200
201bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color);
202bool i915_vma_misplaced(const struct i915_vma *vma,
203 u64 size, u64 alignment, u64 flags);
204void __i915_vma_set_map_and_fenceable(struct i915_vma *vma);
205void i915_vma_revoke_mmap(struct i915_vma *vma);
206void __i915_vma_evict(struct i915_vma *vma);
207int __i915_vma_unbind(struct i915_vma *vma);
208int __must_check i915_vma_unbind(struct i915_vma *vma);
209void i915_vma_unlink_ctx(struct i915_vma *vma);
210void i915_vma_close(struct i915_vma *vma);
211void i915_vma_reopen(struct i915_vma *vma);
212
213static 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
221void i915_vma_release(struct kref *ref);
222static inline void __i915_vma_put(struct i915_vma *vma)
223{
224 kref_put(&vma->ref, i915_vma_release);
225}
226
227#define assert_vma_held(vma) dma_resv_assert_held((vma)->resv)
228
229static inline void i915_vma_lock(struct i915_vma *vma)
230{
231 dma_resv_lock(vma->resv, NULL);
232}
233
234static inline void i915_vma_unlock(struct i915_vma *vma)
235{
236 dma_resv_unlock(vma->resv);
237}
238
239int __must_check
240i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags);
241int i915_ggtt_pin(struct i915_vma *vma, u32 align, unsigned int flags);
242
243static inline int i915_vma_pin_count(const struct i915_vma *vma)
244{
245 return atomic_read(&vma->flags) & I915_VMA_PIN_MASK;
246}
247
248static inline bool i915_vma_is_pinned(const struct i915_vma *vma)
249{
250 return i915_vma_pin_count(vma);
251}
252
253static inline void __i915_vma_pin(struct i915_vma *vma)
254{
255 atomic_inc(&vma->flags);
256 GEM_BUG_ON(!i915_vma_is_pinned(vma));
257}
258
259static inline void __i915_vma_unpin(struct i915_vma *vma)
260{
261 GEM_BUG_ON(!i915_vma_is_pinned(vma));
262 atomic_dec(&vma->flags);
263}
264
265static inline void i915_vma_unpin(struct i915_vma *vma)
266{
267 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
268 __i915_vma_unpin(vma);
269}
270
271static inline bool i915_vma_is_bound(const struct i915_vma *vma,
272 unsigned int where)
273{
274 return atomic_read(&vma->flags) & where;
275}
276
277static inline bool i915_node_color_differs(const struct drm_mm_node *node,
278 unsigned long color)
279{
280 return drm_mm_node_allocated(node) && node->color != color;
281}
282
283/**
284 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture
285 * @vma: VMA to iomap
286 *
287 * The passed in VMA has to be pinned in the global GTT mappable region.
288 * An extra pinning of the VMA is acquired for the return iomapping,
289 * the caller must call i915_vma_unpin_iomap to relinquish the pinning
290 * after the iomapping is no longer required.
291 *
292 * Returns a valid iomapped pointer or ERR_PTR.
293 */
294void __iomem *i915_vma_pin_iomap(struct i915_vma *vma);
295#define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x))
296
297/**
298 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap
299 * @vma: VMA to unpin
300 *
301 * Unpins the previously iomapped VMA from i915_vma_pin_iomap().
302 *
303 * This function is only valid to be called on a VMA previously
304 * iomapped by the caller with i915_vma_pin_iomap().
305 */
306void i915_vma_unpin_iomap(struct i915_vma *vma);
307
308static inline struct page *i915_vma_first_page(struct i915_vma *vma)
309{
310 GEM_BUG_ON(!vma->pages);
311 return sg_page(vma->pages->sgl);
312}
313
314/**
315 * i915_vma_pin_fence - pin fencing state
316 * @vma: vma to pin fencing for
317 *
318 * This pins the fencing state (whether tiled or untiled) to make sure the
319 * vma (and its object) is ready to be used as a scanout target. Fencing
320 * status must be synchronize first by calling i915_vma_get_fence():
321 *
322 * The resulting fence pin reference must be released again with
323 * i915_vma_unpin_fence().
324 *
325 * Returns:
326 *
327 * True if the vma has a fence, false otherwise.
328 */
329int __must_check i915_vma_pin_fence(struct i915_vma *vma);
330void i915_vma_revoke_fence(struct i915_vma *vma);
331
332int __i915_vma_pin_fence(struct i915_vma *vma);
333
334static inline void __i915_vma_unpin_fence(struct i915_vma *vma)
335{
336 GEM_BUG_ON(atomic_read(&vma->fence->pin_count) <= 0);
337 atomic_dec(&vma->fence->pin_count);
338}
339
340/**
341 * i915_vma_unpin_fence - unpin fencing state
342 * @vma: vma to unpin fencing for
343 *
344 * This releases the fence pin reference acquired through
345 * i915_vma_pin_fence. It will handle both objects with and without an
346 * attached fence correctly, callers do not need to distinguish this.
347 */
348static inline void
349i915_vma_unpin_fence(struct i915_vma *vma)
350{
351 if (vma->fence)
352 __i915_vma_unpin_fence(vma);
353}
354
355void i915_vma_parked(struct intel_gt *gt);
356
357#define for_each_until(cond) if (cond) break; else
358
359/**
360 * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object.
361 * @V: the #i915_vma iterator
362 * @OBJ: the #drm_i915_gem_object
363 *
364 * GGTT VMA are placed at the being of the object's vma_list, see
365 * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA,
366 * or the list is empty ofc.
367 */
368#define for_each_ggtt_vma(V, OBJ) \
369 list_for_each_entry(V, &(OBJ)->vma.list, obj_link) \
370 for_each_until(!i915_vma_is_ggtt(V))
371
372struct i915_vma *i915_vma_alloc(void);
373void i915_vma_free(struct i915_vma *vma);
374
375struct i915_vma *i915_vma_make_unshrinkable(struct i915_vma *vma);
376void i915_vma_make_shrinkable(struct i915_vma *vma);
377void i915_vma_make_purgeable(struct i915_vma *vma);
378
379int i915_vma_wait_for_bind(struct i915_vma *vma);
380
381static inline int i915_vma_sync(struct i915_vma *vma)
382{
383 /* Wait for the asynchronous bindings and pending GPU reads */
384 return i915_active_wait(&vma->active);
385}
386
387#endif