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_resource.h"
41 #include "i915_vma_types.h"
42 
43 struct i915_vma *
44 i915_vma_instance(struct drm_i915_gem_object *obj,
45 		  struct i915_address_space *vm,
46 		  const struct i915_ggtt_view *view);
47 
48 void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags);
49 #define I915_VMA_RELEASE_MAP BIT(0)
50 
i915_vma_is_active(const struct i915_vma * vma)51 static inline bool i915_vma_is_active(const struct i915_vma *vma)
52 {
53 	return !i915_active_is_idle(&vma->active);
54 }
55 
56 /* do not reserve memory to prevent deadlocks */
57 #define __EXEC_OBJECT_NO_RESERVE BIT(31)
58 
59 int __must_check _i915_vma_move_to_active(struct i915_vma *vma,
60 					  struct i915_request *rq,
61 					  struct dma_fence *fence,
62 					  unsigned int flags);
63 static inline int __must_check
i915_vma_move_to_active(struct i915_vma * vma,struct i915_request * rq,unsigned int flags)64 i915_vma_move_to_active(struct i915_vma *vma, struct i915_request *rq,
65 			unsigned int flags)
66 {
67 	return _i915_vma_move_to_active(vma, rq, &rq->fence, flags);
68 }
69 
70 #define __i915_vma_flags(v) ((unsigned long *)&(v)->flags.counter)
71 
i915_vma_is_ggtt(const struct i915_vma * vma)72 static inline bool i915_vma_is_ggtt(const struct i915_vma *vma)
73 {
74 	return test_bit(I915_VMA_GGTT_BIT, __i915_vma_flags(vma));
75 }
76 
i915_vma_is_dpt(const struct i915_vma * vma)77 static inline bool i915_vma_is_dpt(const struct i915_vma *vma)
78 {
79 	return i915_is_dpt(vma->vm);
80 }
81 
i915_vma_has_ggtt_write(const struct i915_vma * vma)82 static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma)
83 {
84 	return test_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma));
85 }
86 
i915_vma_set_ggtt_write(struct i915_vma * vma)87 static inline void i915_vma_set_ggtt_write(struct i915_vma *vma)
88 {
89 	GEM_BUG_ON(!i915_vma_is_ggtt(vma));
90 	set_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma));
91 }
92 
i915_vma_unset_ggtt_write(struct i915_vma * vma)93 static inline bool i915_vma_unset_ggtt_write(struct i915_vma *vma)
94 {
95 	return test_and_clear_bit(I915_VMA_GGTT_WRITE_BIT,
96 				  __i915_vma_flags(vma));
97 }
98 
99 void i915_vma_flush_writes(struct i915_vma *vma);
100 
i915_vma_is_map_and_fenceable(const struct i915_vma * vma)101 static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma)
102 {
103 	return test_bit(I915_VMA_CAN_FENCE_BIT, __i915_vma_flags(vma));
104 }
105 
i915_vma_set_userfault(struct i915_vma * vma)106 static inline bool i915_vma_set_userfault(struct i915_vma *vma)
107 {
108 	GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma));
109 	return test_and_set_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
110 }
111 
i915_vma_unset_userfault(struct i915_vma * vma)112 static inline void i915_vma_unset_userfault(struct i915_vma *vma)
113 {
114 	return clear_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
115 }
116 
i915_vma_has_userfault(const struct i915_vma * vma)117 static inline bool i915_vma_has_userfault(const struct i915_vma *vma)
118 {
119 	return test_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma));
120 }
121 
i915_vma_is_closed(const struct i915_vma * vma)122 static inline bool i915_vma_is_closed(const struct i915_vma *vma)
123 {
124 	return !list_empty(&vma->closed_link);
125 }
126 
i915_ggtt_offset(const struct i915_vma * vma)127 static inline u32 i915_ggtt_offset(const struct i915_vma *vma)
128 {
129 	GEM_BUG_ON(!i915_vma_is_ggtt(vma));
130 	GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
131 	GEM_BUG_ON(upper_32_bits(vma->node.start));
132 	GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1));
133 	return lower_32_bits(vma->node.start);
134 }
135 
i915_ggtt_pin_bias(struct i915_vma * vma)136 static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma)
137 {
138 	return i915_vm_to_ggtt(vma->vm)->pin_bias;
139 }
140 
i915_vma_get(struct i915_vma * vma)141 static inline struct i915_vma *i915_vma_get(struct i915_vma *vma)
142 {
143 	i915_gem_object_get(vma->obj);
144 	return vma;
145 }
146 
i915_vma_tryget(struct i915_vma * vma)147 static inline struct i915_vma *i915_vma_tryget(struct i915_vma *vma)
148 {
149 	if (likely(kref_get_unless_zero(&vma->obj->base.refcount)))
150 		return vma;
151 
152 	return NULL;
153 }
154 
i915_vma_put(struct i915_vma * vma)155 static inline void i915_vma_put(struct i915_vma *vma)
156 {
157 	i915_gem_object_put(vma->obj);
158 }
159 
160 static inline long
i915_vma_compare(struct i915_vma * vma,struct i915_address_space * vm,const struct i915_ggtt_view * view)161 i915_vma_compare(struct i915_vma *vma,
162 		 struct i915_address_space *vm,
163 		 const struct i915_ggtt_view *view)
164 {
165 	ptrdiff_t cmp;
166 
167 	GEM_BUG_ON(view && !i915_is_ggtt_or_dpt(vm));
168 
169 	cmp = ptrdiff(vma->vm, vm);
170 	if (cmp)
171 		return cmp;
172 
173 	BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0);
174 	cmp = vma->ggtt_view.type;
175 	if (!view)
176 		return cmp;
177 
178 	cmp -= view->type;
179 	if (cmp)
180 		return cmp;
181 
182 	assert_i915_gem_gtt_types();
183 
184 	/* ggtt_view.type also encodes its size so that we both distinguish
185 	 * different views using it as a "type" and also use a compact (no
186 	 * accessing of uninitialised padding bytes) memcmp without storing
187 	 * an extra parameter or adding more code.
188 	 *
189 	 * To ensure that the memcmp is valid for all branches of the union,
190 	 * even though the code looks like it is just comparing one branch,
191 	 * we assert above that all branches have the same address, and that
192 	 * each branch has a unique type/size.
193 	 */
194 	BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL);
195 	BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED);
196 	BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED);
197 	BUILD_BUG_ON(offsetof(typeof(*view), rotated) !=
198 		     offsetof(typeof(*view), partial));
199 	BUILD_BUG_ON(offsetof(typeof(*view), rotated) !=
200 		     offsetof(typeof(*view), remapped));
201 	return memcmp(&vma->ggtt_view.partial, &view->partial, view->type);
202 }
203 
204 struct i915_vma_work *i915_vma_work(void);
205 int i915_vma_bind(struct i915_vma *vma,
206 		  enum i915_cache_level cache_level,
207 		  u32 flags,
208 		  struct i915_vma_work *work,
209 		  struct i915_vma_resource *vma_res);
210 
211 bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color);
212 bool i915_vma_misplaced(const struct i915_vma *vma,
213 			u64 size, u64 alignment, u64 flags);
214 void __i915_vma_set_map_and_fenceable(struct i915_vma *vma);
215 void i915_vma_revoke_mmap(struct i915_vma *vma);
216 void vma_invalidate_tlb(struct i915_address_space *vm, u32 *tlb);
217 struct dma_fence *__i915_vma_evict(struct i915_vma *vma, bool async);
218 int __i915_vma_unbind(struct i915_vma *vma);
219 int __must_check i915_vma_unbind(struct i915_vma *vma);
220 int __must_check i915_vma_unbind_async(struct i915_vma *vma, bool trylock_vm);
221 int __must_check i915_vma_unbind_unlocked(struct i915_vma *vma);
222 void i915_vma_unlink_ctx(struct i915_vma *vma);
223 void i915_vma_close(struct i915_vma *vma);
224 void i915_vma_reopen(struct i915_vma *vma);
225 
226 void i915_vma_destroy_locked(struct i915_vma *vma);
227 void i915_vma_destroy(struct i915_vma *vma);
228 
229 #define assert_vma_held(vma) dma_resv_assert_held((vma)->obj->base.resv)
230 
i915_vma_lock(struct i915_vma * vma)231 static inline void i915_vma_lock(struct i915_vma *vma)
232 {
233 	dma_resv_lock(vma->obj->base.resv, NULL);
234 }
235 
i915_vma_unlock(struct i915_vma * vma)236 static inline void i915_vma_unlock(struct i915_vma *vma)
237 {
238 	dma_resv_unlock(vma->obj->base.resv);
239 }
240 
241 int __must_check
242 i915_vma_pin_ww(struct i915_vma *vma, struct i915_gem_ww_ctx *ww,
243 		u64 size, u64 alignment, u64 flags);
244 
245 static inline int __must_check
i915_vma_pin(struct i915_vma * vma,u64 size,u64 alignment,u64 flags)246 i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags)
247 {
248 	struct i915_gem_ww_ctx ww;
249 	int err;
250 
251 	i915_gem_ww_ctx_init(&ww, true);
252 retry:
253 	err = i915_gem_object_lock(vma->obj, &ww);
254 	if (!err)
255 		err = i915_vma_pin_ww(vma, &ww, size, alignment, flags);
256 	if (err == -EDEADLK) {
257 		err = i915_gem_ww_ctx_backoff(&ww);
258 		if (!err)
259 			goto retry;
260 	}
261 	i915_gem_ww_ctx_fini(&ww);
262 
263 	return err;
264 }
265 
266 int i915_ggtt_pin(struct i915_vma *vma, struct i915_gem_ww_ctx *ww,
267 		  u32 align, unsigned int flags);
268 
i915_vma_pin_count(const struct i915_vma * vma)269 static inline int i915_vma_pin_count(const struct i915_vma *vma)
270 {
271 	return atomic_read(&vma->flags) & I915_VMA_PIN_MASK;
272 }
273 
i915_vma_is_pinned(const struct i915_vma * vma)274 static inline bool i915_vma_is_pinned(const struct i915_vma *vma)
275 {
276 	return i915_vma_pin_count(vma);
277 }
278 
__i915_vma_pin(struct i915_vma * vma)279 static inline void __i915_vma_pin(struct i915_vma *vma)
280 {
281 	atomic_inc(&vma->flags);
282 	GEM_BUG_ON(!i915_vma_is_pinned(vma));
283 }
284 
__i915_vma_unpin(struct i915_vma * vma)285 static inline void __i915_vma_unpin(struct i915_vma *vma)
286 {
287 	GEM_BUG_ON(!i915_vma_is_pinned(vma));
288 	atomic_dec(&vma->flags);
289 }
290 
i915_vma_unpin(struct i915_vma * vma)291 static inline void i915_vma_unpin(struct i915_vma *vma)
292 {
293 	GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
294 	__i915_vma_unpin(vma);
295 }
296 
i915_vma_is_bound(const struct i915_vma * vma,unsigned int where)297 static inline bool i915_vma_is_bound(const struct i915_vma *vma,
298 				     unsigned int where)
299 {
300 	return atomic_read(&vma->flags) & where;
301 }
302 
i915_node_color_differs(const struct drm_mm_node * node,unsigned long color)303 static inline bool i915_node_color_differs(const struct drm_mm_node *node,
304 					   unsigned long color)
305 {
306 	return drm_mm_node_allocated(node) && node->color != color;
307 }
308 
309 /**
310  * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture
311  * @vma: VMA to iomap
312  *
313  * The passed in VMA has to be pinned in the global GTT mappable region.
314  * An extra pinning of the VMA is acquired for the return iomapping,
315  * the caller must call i915_vma_unpin_iomap to relinquish the pinning
316  * after the iomapping is no longer required.
317  *
318  * Returns a valid iomapped pointer or ERR_PTR.
319  */
320 void __iomem *i915_vma_pin_iomap(struct i915_vma *vma);
321 
322 /**
323  * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap
324  * @vma: VMA to unpin
325  *
326  * Unpins the previously iomapped VMA from i915_vma_pin_iomap().
327  *
328  * This function is only valid to be called on a VMA previously
329  * iomapped by the caller with i915_vma_pin_iomap().
330  */
331 void i915_vma_unpin_iomap(struct i915_vma *vma);
332 
333 /**
334  * i915_vma_pin_fence - pin fencing state
335  * @vma: vma to pin fencing for
336  *
337  * This pins the fencing state (whether tiled or untiled) to make sure the
338  * vma (and its object) is ready to be used as a scanout target. Fencing
339  * status must be synchronize first by calling i915_vma_get_fence():
340  *
341  * The resulting fence pin reference must be released again with
342  * i915_vma_unpin_fence().
343  *
344  * Returns:
345  *
346  * True if the vma has a fence, false otherwise.
347  */
348 int __must_check i915_vma_pin_fence(struct i915_vma *vma);
349 void i915_vma_revoke_fence(struct i915_vma *vma);
350 
351 int __i915_vma_pin_fence(struct i915_vma *vma);
352 
__i915_vma_unpin_fence(struct i915_vma * vma)353 static inline void __i915_vma_unpin_fence(struct i915_vma *vma)
354 {
355 	GEM_BUG_ON(atomic_read(&vma->fence->pin_count) <= 0);
356 	atomic_dec(&vma->fence->pin_count);
357 }
358 
359 /**
360  * i915_vma_unpin_fence - unpin fencing state
361  * @vma: vma to unpin fencing for
362  *
363  * This releases the fence pin reference acquired through
364  * i915_vma_pin_fence. It will handle both objects with and without an
365  * attached fence correctly, callers do not need to distinguish this.
366  */
367 static inline void
i915_vma_unpin_fence(struct i915_vma * vma)368 i915_vma_unpin_fence(struct i915_vma *vma)
369 {
370 	if (vma->fence)
371 		__i915_vma_unpin_fence(vma);
372 }
373 
374 void i915_vma_parked(struct intel_gt *gt);
375 
i915_vma_is_scanout(const struct i915_vma * vma)376 static inline bool i915_vma_is_scanout(const struct i915_vma *vma)
377 {
378 	return test_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma));
379 }
380 
i915_vma_mark_scanout(struct i915_vma * vma)381 static inline void i915_vma_mark_scanout(struct i915_vma *vma)
382 {
383 	set_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma));
384 }
385 
i915_vma_clear_scanout(struct i915_vma * vma)386 static inline void i915_vma_clear_scanout(struct i915_vma *vma)
387 {
388 	clear_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma));
389 }
390 
391 #define for_each_until(cond) if (cond) break; else
392 
393 /**
394  * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object.
395  * @V: the #i915_vma iterator
396  * @OBJ: the #drm_i915_gem_object
397  *
398  * GGTT VMA are placed at the being of the object's vma_list, see
399  * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA,
400  * or the list is empty ofc.
401  */
402 #define for_each_ggtt_vma(V, OBJ) \
403 	list_for_each_entry(V, &(OBJ)->vma.list, obj_link)		\
404 		for_each_until(!i915_vma_is_ggtt(V))
405 
406 struct i915_vma *i915_vma_make_unshrinkable(struct i915_vma *vma);
407 void i915_vma_make_shrinkable(struct i915_vma *vma);
408 void i915_vma_make_purgeable(struct i915_vma *vma);
409 
410 int i915_vma_wait_for_bind(struct i915_vma *vma);
411 
i915_vma_sync(struct i915_vma * vma)412 static inline int i915_vma_sync(struct i915_vma *vma)
413 {
414 	/* Wait for the asynchronous bindings and pending GPU reads */
415 	return i915_active_wait(&vma->active);
416 }
417 
418 /**
419  * i915_vma_get_current_resource - Get the current resource of the vma
420  * @vma: The vma to get the current resource from.
421  *
422  * It's illegal to call this function if the vma is not bound.
423  *
424  * Return: A refcounted pointer to the current vma resource
425  * of the vma, assuming the vma is bound.
426  */
427 static inline struct i915_vma_resource *
i915_vma_get_current_resource(struct i915_vma * vma)428 i915_vma_get_current_resource(struct i915_vma *vma)
429 {
430 	return i915_vma_resource_get(vma->resource);
431 }
432 
433 #if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
434 void i915_vma_resource_init_from_vma(struct i915_vma_resource *vma_res,
435 				     struct i915_vma *vma);
436 #endif
437 
438 void i915_vma_module_exit(void);
439 int i915_vma_module_init(void);
440 
441 I915_SELFTEST_DECLARE(int i915_vma_get_pages(struct i915_vma *vma));
442 I915_SELFTEST_DECLARE(void i915_vma_put_pages(struct i915_vma *vma));
443 
444 #endif
445