[linux-2.6-block.git] / drivers / gpu / drm / i915 / i915_vma.h

/*
 * Copyright © 2016 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 */

#ifndef __I915_VMA_H__
#define __I915_VMA_H__

#include <linux/io-mapping.h>
#include <linux/rbtree.h>

#include <drm/drm_mm.h>

#include "i915_gem_gtt.h"
#include "i915_gem_fence_reg.h"
#include "i915_gem_object.h"

#include "i915_request.h"

enum i915_cache_level;

/**
 * A VMA represents a GEM BO that is bound into an address space. Therefore, a
 * VMA's presence cannot be guaranteed before binding, or after unbinding the
 * object into/from the address space.
 *
 * To make things as simple as possible (ie. no refcounting), a VMA's lifetime
 * will always be <= an objects lifetime. So object refcounting should cover us.
 */
struct i915_vma {
	struct drm_mm_node node;
	struct drm_i915_gem_object *obj;
	struct i915_address_space *vm;
	const struct i915_vma_ops *ops;
	struct drm_i915_fence_reg *fence;
	struct reservation_object *resv; /** Alias of obj->resv */
	struct sg_table *pages;
	void __iomem *iomap;
	void *private; /* owned by creator */
	u64 size;
	u64 display_alignment;
	struct i915_page_sizes page_sizes;

	u32 fence_size;
	u32 fence_alignment;

	/**
	 * Count of the number of times this vma has been opened by different
	 * handles (but same file) for execbuf, i.e. the number of aliases
	 * that exist in the ctx->handle_vmas LUT for this vma.
	 */
	unsigned int open_count;
	unsigned long flags;
	/**
	 * How many users have pinned this object in GTT space. The following
	 * users can each hold at most one reference: pwrite/pread, execbuffer
	 * (objects are not allowed multiple times for the same batchbuffer),
	 * and the framebuffer code. When switching/pageflipping, the
	 * framebuffer code has at most two buffers pinned per crtc.
	 *
	 * In the worst case this is 1 + 1 + 1 + 2*2 = 7. That would fit into 3
	 * bits with absolutely no headroom. So use 4 bits.
	 */
#define I915_VMA_PIN_MASK 0xf
#define I915_VMA_PIN_OVERFLOW	BIT(5)

	/** Flags and address space this VMA is bound to */
#define I915_VMA_GLOBAL_BIND	BIT(6)
#define I915_VMA_LOCAL_BIND	BIT(7)
#define I915_VMA_BIND_MASK (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND | I915_VMA_PIN_OVERFLOW)

#define I915_VMA_GGTT		BIT(8)
#define I915_VMA_CAN_FENCE	BIT(9)
#define I915_VMA_CLOSED		BIT(10)
#define I915_VMA_USERFAULT_BIT	11
#define I915_VMA_USERFAULT	BIT(I915_VMA_USERFAULT_BIT)
#define I915_VMA_GGTT_WRITE	BIT(12)

	unsigned int active_count;
	struct rb_root active;
	struct i915_gem_active last_active;
	struct i915_gem_active last_fence;

	/**
	 * Support different GGTT views into the same object.
	 * This means there can be multiple VMA mappings per object and per VM.
	 * i915_ggtt_view_type is used to distinguish between those entries.
	 * The default one of zero (I915_GGTT_VIEW_NORMAL) is default and also
	 * assumed in GEM functions which take no ggtt view parameter.
	 */
	struct i915_ggtt_view ggtt_view;

	/** This object's place on the active/inactive lists */
	struct list_head vm_link;

	struct list_head obj_link; /* Link in the object's VMA list */
	struct rb_node obj_node;
	struct hlist_node obj_hash;

	/** This vma's place in the execbuf reservation list */
	struct list_head exec_link;
	struct list_head reloc_link;

	/** This vma's place in the eviction list */
	struct list_head evict_link;

	struct list_head closed_link;

	/**
	 * Used for performing relocations during execbuffer insertion.
	 */
	unsigned int *exec_flags;
	struct hlist_node exec_node;
	u32 exec_handle;
};

struct i915_vma *
i915_vma_instance(struct drm_i915_gem_object *obj,
		  struct i915_address_space *vm,
		  const struct i915_ggtt_view *view);

void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags);
#define I915_VMA_RELEASE_MAP BIT(0)

static inline bool i915_vma_is_active(struct i915_vma *vma)
{
	return vma->active_count;
}

int __must_check i915_vma_move_to_active(struct i915_vma *vma,
					 struct i915_request *rq,
					 unsigned int flags);

static inline bool i915_vma_is_ggtt(const struct i915_vma *vma)
{
	return vma->flags & I915_VMA_GGTT;
}

static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma)
{
	return vma->flags & I915_VMA_GGTT_WRITE;
}

static inline void i915_vma_set_ggtt_write(struct i915_vma *vma)
{
	GEM_BUG_ON(!i915_vma_is_ggtt(vma));
	vma->flags |= I915_VMA_GGTT_WRITE;
}

static inline void i915_vma_unset_ggtt_write(struct i915_vma *vma)
{
	vma->flags &= ~I915_VMA_GGTT_WRITE;
}

void i915_vma_flush_writes(struct i915_vma *vma);

static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma)
{
	return vma->flags & I915_VMA_CAN_FENCE;
}

static inline bool i915_vma_is_closed(const struct i915_vma *vma)
{
	return vma->flags & I915_VMA_CLOSED;
}

static inline bool i915_vma_set_userfault(struct i915_vma *vma)
{
	GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma));
	return __test_and_set_bit(I915_VMA_USERFAULT_BIT, &vma->flags);
}

static inline void i915_vma_unset_userfault(struct i915_vma *vma)
{
	return __clear_bit(I915_VMA_USERFAULT_BIT, &vma->flags);
}

static inline bool i915_vma_has_userfault(const struct i915_vma *vma)
{
	return test_bit(I915_VMA_USERFAULT_BIT, &vma->flags);
}

static inline u32 i915_ggtt_offset(const struct i915_vma *vma)
{
	GEM_BUG_ON(!i915_vma_is_ggtt(vma));
	GEM_BUG_ON(!vma->node.allocated);
	GEM_BUG_ON(upper_32_bits(vma->node.start));
	GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1));
	return lower_32_bits(vma->node.start);
}

static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma)
{
	return i915_vm_to_ggtt(vma->vm)->pin_bias;
}

static inline struct i915_vma *i915_vma_get(struct i915_vma *vma)
{
	i915_gem_object_get(vma->obj);
	return vma;
}

static inline void i915_vma_put(struct i915_vma *vma)
{
	i915_gem_object_put(vma->obj);
}

static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b)
{
	return a - b;
}

static inline long
i915_vma_compare(struct i915_vma *vma,
		 struct i915_address_space *vm,
		 const struct i915_ggtt_view *view)
{
	ptrdiff_t cmp;

	GEM_BUG_ON(view && !i915_is_ggtt(vm));

	cmp = ptrdiff(vma->vm, vm);
	if (cmp)
		return cmp;

	BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0);
	cmp = vma->ggtt_view.type;
	if (!view)
		return cmp;

	cmp -= view->type;
	if (cmp)
		return cmp;

	assert_i915_gem_gtt_types();

	/* ggtt_view.type also encodes its size so that we both distinguish
	 * different views using it as a "type" and also use a compact (no
	 * accessing of uninitialised padding bytes) memcmp without storing
	 * an extra parameter or adding more code.
	 *
	 * To ensure that the memcmp is valid for all branches of the union,
	 * even though the code looks like it is just comparing one branch,
	 * we assert above that all branches have the same address, and that
	 * each branch has a unique type/size.
	 */
	BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL);
	BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED);
	BUILD_BUG_ON(offsetof(typeof(*view), rotated) !=
		     offsetof(typeof(*view), partial));
	return memcmp(&vma->ggtt_view.partial, &view->partial, view->type);
}

int i915_vma_bind(struct i915_vma *vma, enum i915_cache_level cache_level,
		  u32 flags);
bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long cache_level);
bool i915_vma_misplaced(const struct i915_vma *vma,
			u64 size, u64 alignment, u64 flags);
void __i915_vma_set_map_and_fenceable(struct i915_vma *vma);
void i915_vma_revoke_mmap(struct i915_vma *vma);
int __must_check i915_vma_unbind(struct i915_vma *vma);
void i915_vma_unlink_ctx(struct i915_vma *vma);
void i915_vma_close(struct i915_vma *vma);
void i915_vma_reopen(struct i915_vma *vma);
void i915_vma_destroy(struct i915_vma *vma);

int __i915_vma_do_pin(struct i915_vma *vma,
		      u64 size, u64 alignment, u64 flags);
static inline int __must_check
i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags)
{
	BUILD_BUG_ON(PIN_MBZ != I915_VMA_PIN_OVERFLOW);
	BUILD_BUG_ON(PIN_GLOBAL != I915_VMA_GLOBAL_BIND);
	BUILD_BUG_ON(PIN_USER != I915_VMA_LOCAL_BIND);

	/* Pin early to prevent the shrinker/eviction logic from destroying
	 * our vma as we insert and bind.
	 */
	if (likely(((++vma->flags ^ flags) & I915_VMA_BIND_MASK) == 0)) {
		GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
		GEM_BUG_ON(i915_vma_misplaced(vma, size, alignment, flags));
		return 0;
	}

	return __i915_vma_do_pin(vma, size, alignment, flags);
}

static inline int i915_vma_pin_count(const struct i915_vma *vma)
{
	return vma->flags & I915_VMA_PIN_MASK;
}

static inline bool i915_vma_is_pinned(const struct i915_vma *vma)
{
	return i915_vma_pin_count(vma);
}

static inline void __i915_vma_pin(struct i915_vma *vma)
{
	vma->flags++;
	GEM_BUG_ON(vma->flags & I915_VMA_PIN_OVERFLOW);
}

static inline void __i915_vma_unpin(struct i915_vma *vma)
{
	vma->flags--;
}

static inline void i915_vma_unpin(struct i915_vma *vma)
{
	GEM_BUG_ON(!i915_vma_is_pinned(vma));
	GEM_BUG_ON(!drm_mm_node_allocated(&vma->node));
	__i915_vma_unpin(vma);
}

static inline bool i915_vma_is_bound(const struct i915_vma *vma,
				     unsigned int where)
{
	return vma->flags & where;
}

/**
 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture
 * @vma: VMA to iomap
 *
 * The passed in VMA has to be pinned in the global GTT mappable region.
 * An extra pinning of the VMA is acquired for the return iomapping,
 * the caller must call i915_vma_unpin_iomap to relinquish the pinning
 * after the iomapping is no longer required.
 *
 * Callers must hold the struct_mutex.
 *
 * Returns a valid iomapped pointer or ERR_PTR.
 */
void __iomem *i915_vma_pin_iomap(struct i915_vma *vma);
#define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x))

/**
 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap
 * @vma: VMA to unpin
 *
 * Unpins the previously iomapped VMA from i915_vma_pin_iomap().
 *
 * Callers must hold the struct_mutex. This function is only valid to be
 * called on a VMA previously iomapped by the caller with i915_vma_pin_iomap().
 */
void i915_vma_unpin_iomap(struct i915_vma *vma);

static inline struct page *i915_vma_first_page(struct i915_vma *vma)
{
	GEM_BUG_ON(!vma->pages);
	return sg_page(vma->pages->sgl);
}

/**
 * i915_vma_pin_fence - pin fencing state
 * @vma: vma to pin fencing for
 *
 * This pins the fencing state (whether tiled or untiled) to make sure the
 * vma (and its object) is ready to be used as a scanout target. Fencing
 * status must be synchronize first by calling i915_vma_get_fence():
 *
 * The resulting fence pin reference must be released again with
 * i915_vma_unpin_fence().
 *
 * Returns:
 *
 * True if the vma has a fence, false otherwise.
 */
int i915_vma_pin_fence(struct i915_vma *vma);
int __must_check i915_vma_put_fence(struct i915_vma *vma);

static inline void __i915_vma_unpin_fence(struct i915_vma *vma)
{
	GEM_BUG_ON(vma->fence->pin_count <= 0);
	vma->fence->pin_count--;
}

/**
 * i915_vma_unpin_fence - unpin fencing state
 * @vma: vma to unpin fencing for
 *
 * This releases the fence pin reference acquired through
 * i915_vma_pin_fence. It will handle both objects with and without an
 * attached fence correctly, callers do not need to distinguish this.
 */
static inline void
i915_vma_unpin_fence(struct i915_vma *vma)
{
	/* lockdep_assert_held(&vma->vm->i915->drm.struct_mutex); */
	if (vma->fence)
		__i915_vma_unpin_fence(vma);
}

void i915_vma_parked(struct drm_i915_private *i915);

#define for_each_until(cond) if (cond) break; else

/**
 * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object.
 * @V: the #i915_vma iterator
 * @OBJ: the #drm_i915_gem_object
 *
 * GGTT VMA are placed at the being of the object's vma_list, see
 * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA,
 * or the list is empty ofc.
 */
#define for_each_ggtt_vma(V, OBJ) \
	list_for_each_entry(V, &(OBJ)->vma_list, obj_link)		\
		for_each_until(!i915_vma_is_ggtt(V))

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