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