[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / i915 / i915_gem_context.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_GEM_CONTEXT_H__
#define __I915_GEM_CONTEXT_H__

#include <linux/bitops.h>
#include <linux/list.h>

struct pid;

struct drm_device;
struct drm_file;

struct drm_i915_private;
struct drm_i915_file_private;
struct i915_hw_ppgtt;
struct i915_vma;
struct intel_ring;

#define DEFAULT_CONTEXT_HANDLE 0

/**
 * struct i915_gem_context - client state
 *
 * The struct i915_gem_context represents the combined view of the driver and
 * logical hardware state for a particular client.
 */
struct i915_gem_context {
	/** i915: i915 device backpointer */
	struct drm_i915_private *i915;

	/** file_priv: owning file descriptor */
	struct drm_i915_file_private *file_priv;

	/**
	 * @ppgtt: unique address space (GTT)
	 *
	 * In full-ppgtt mode, each context has its own address space ensuring
	 * complete seperation of one client from all others.
	 *
	 * In other modes, this is a NULL pointer with the expectation that
	 * the caller uses the shared global GTT.
	 */
	struct i915_hw_ppgtt *ppgtt;

	/**
	 * @pid: process id of creator
	 *
	 * Note that who created the context may not be the principle user,
	 * as the context may be shared across a local socket. However,
	 * that should only affect the default context, all contexts created
	 * explicitly by the client are expected to be isolated.
	 */
	struct pid *pid;

	/**
	 * @name: arbitrary name
	 *
	 * A name is constructed for the context from the creator's process
	 * name, pid and user handle in order to uniquely identify the
	 * context in messages.
	 */
	const char *name;

	/** link: place with &drm_i915_private.context_list */
	struct list_head link;

	/**
	 * @ref: reference count
	 *
	 * A reference to a context is held by both the client who created it
	 * and on each request submitted to the hardware using the request
	 * (to ensure the hardware has access to the state until it has
	 * finished all pending writes). See i915_gem_context_get() and
	 * i915_gem_context_put() for access.
	 */
	struct kref ref;

	/**
	 * @flags: small set of booleans
	 */
	unsigned long flags;
#define CONTEXT_NO_ZEROMAP		BIT(0)
#define CONTEXT_NO_ERROR_CAPTURE	1
#define CONTEXT_CLOSED			2
#define CONTEXT_BANNABLE		3
#define CONTEXT_BANNED			4
#define CONTEXT_FORCE_SINGLE_SUBMISSION	5

	/**
	 * @hw_id: - unique identifier for the context
	 *
	 * The hardware needs to uniquely identify the context for a few
	 * functions like fault reporting, PASID, scheduling. The
	 * &drm_i915_private.context_hw_ida is used to assign a unqiue
	 * id for the lifetime of the context.
	 */
	unsigned int hw_id;

	/**
	 * @user_handle: userspace identifier
	 *
	 * A unique per-file identifier is generated from
	 * &drm_i915_file_private.contexts.
	 */
	u32 user_handle;

	/**
	 * @priority: execution and service priority
	 *
	 * All clients are equal, but some are more equal than others!
	 *
	 * Requests from a context with a greater (more positive) value of
	 * @priority will be executed before those with a lower @priority
	 * value, forming a simple QoS.
	 *
	 * The &drm_i915_private.kernel_context is assigned the lowest priority.
	 */
	int priority;

	/** ggtt_alignment: alignment restriction for context objects */
	u32 ggtt_alignment;
	/** ggtt_offset_bias: placement restriction for context objects */
	u32 ggtt_offset_bias;

	/** engine: per-engine logical HW state */
	struct intel_context {
		struct i915_vma *state;
		struct intel_ring *ring;
		u32 *lrc_reg_state;
		u64 lrc_desc;
		int pin_count;
		bool initialised;
	} engine[I915_NUM_ENGINES];

	/** ring_size: size for allocating the per-engine ring buffer */
	u32 ring_size;
	/** desc_template: invariant fields for the HW context descriptor */
	u32 desc_template;

	/** guilty_count: How many times this context has caused a GPU hang. */
	unsigned int guilty_count;
	/**
	 * @active_count: How many times this context was active during a GPU
	 * hang, but did not cause it.
	 */
	unsigned int active_count;

#define CONTEXT_SCORE_GUILTY		10
#define CONTEXT_SCORE_BAN_THRESHOLD	40
	/** ban_score: Accumulated score of all hangs caused by this context. */
	int ban_score;

	/** remap_slice: Bitmask of cache lines that need remapping */
	u8 remap_slice;
};

static inline bool i915_gem_context_is_closed(const struct i915_gem_context *ctx)
{
	return test_bit(CONTEXT_CLOSED, &ctx->flags);
}

static inline void i915_gem_context_set_closed(struct i915_gem_context *ctx)
{
	GEM_BUG_ON(i915_gem_context_is_closed(ctx));
	__set_bit(CONTEXT_CLOSED, &ctx->flags);
}

static inline bool i915_gem_context_no_error_capture(const struct i915_gem_context *ctx)
{
	return test_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
}

static inline void i915_gem_context_set_no_error_capture(struct i915_gem_context *ctx)
{
	__set_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
}

static inline void i915_gem_context_clear_no_error_capture(struct i915_gem_context *ctx)
{
	__clear_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
}

static inline bool i915_gem_context_is_bannable(const struct i915_gem_context *ctx)
{
	return test_bit(CONTEXT_BANNABLE, &ctx->flags);
}

static inline void i915_gem_context_set_bannable(struct i915_gem_context *ctx)
{
	__set_bit(CONTEXT_BANNABLE, &ctx->flags);
}

static inline void i915_gem_context_clear_bannable(struct i915_gem_context *ctx)
{
	__clear_bit(CONTEXT_BANNABLE, &ctx->flags);
}

static inline bool i915_gem_context_is_banned(const struct i915_gem_context *ctx)
{
	return test_bit(CONTEXT_BANNED, &ctx->flags);
}

static inline void i915_gem_context_set_banned(struct i915_gem_context *ctx)
{
	__set_bit(CONTEXT_BANNED, &ctx->flags);
}

static inline bool i915_gem_context_force_single_submission(const struct i915_gem_context *ctx)
{
	return test_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ctx->flags);
}

static inline void i915_gem_context_set_force_single_submission(struct i915_gem_context *ctx)
{
	__set_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ctx->flags);
}

static inline bool i915_gem_context_is_default(const struct i915_gem_context *c)
{
	return c->user_handle == DEFAULT_CONTEXT_HANDLE;
}

static inline bool i915_gem_context_is_kernel(struct i915_gem_context *ctx)
{
	return !ctx->file_priv;
}

/* i915_gem_context.c */
int __must_check i915_gem_context_init(struct drm_i915_private *dev_priv);
void i915_gem_context_lost(struct drm_i915_private *dev_priv);
void i915_gem_context_fini(struct drm_i915_private *dev_priv);
int i915_gem_context_open(struct drm_device *dev, struct drm_file *file);
void i915_gem_context_close(struct drm_device *dev, struct drm_file *file);
int i915_switch_context(struct drm_i915_gem_request *req);
int i915_gem_switch_to_kernel_context(struct drm_i915_private *dev_priv);
void i915_gem_context_free(struct kref *ctx_ref);
struct i915_gem_context *
i915_gem_context_create_gvt(struct drm_device *dev);

int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
				  struct drm_file *file);
int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
				   struct drm_file *file);
int i915_gem_context_getparam_ioctl(struct drm_device *dev, void *data,
				    struct drm_file *file_priv);
int i915_gem_context_setparam_ioctl(struct drm_device *dev, void *data,
				    struct drm_file *file_priv);
int i915_gem_context_reset_stats_ioctl(struct drm_device *dev, void *data,
				       struct drm_file *file);

#endif /* !__I915_GEM_CONTEXT_H__ */
Commit	Line	Data
6095868a CW	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_GEM_CONTEXT_H__
	26	#define __I915_GEM_CONTEXT_H__
	27
	28	#include <linux/bitops.h>
	29	#include <linux/list.h>
	30
	31	struct pid;
	32
	33	struct drm_device;
	34	struct drm_file;
	35
	36	struct drm_i915_private;
	37	struct drm_i915_file_private;
	38	struct i915_hw_ppgtt;
	39	struct i915_vma;
	40	struct intel_ring;
	41
	42	#define DEFAULT_CONTEXT_HANDLE 0
	43
	44	/**
	45	* struct i915_gem_context - client state
	46	*
	47	* The struct i915_gem_context represents the combined view of the driver and
	48	* logical hardware state for a particular client.
	49	*/
	50	struct i915_gem_context {
	51	/** i915: i915 device backpointer */
	52	struct drm_i915_private *i915;
	53
	54	/** file_priv: owning file descriptor */
	55	struct drm_i915_file_private *file_priv;
	56
	57	/**
	58	* @ppgtt: unique address space (GTT)
	59	*
	60	* In full-ppgtt mode, each context has its own address space ensuring
	61	* complete seperation of one client from all others.
	62	*
	63	* In other modes, this is a NULL pointer with the expectation that
	64	* the caller uses the shared global GTT.
65	*/
66	struct i915_hw_ppgtt *ppgtt;
67
68	/**
69	* @pid: process id of creator
70	*
71	* Note that who created the context may not be the principle user,
72	* as the context may be shared across a local socket. However,
73	* that should only affect the default context, all contexts created
74	* explicitly by the client are expected to be isolated.
75	*/
76	struct pid *pid;
77
78	/**
79	* @name: arbitrary name
80	*
81	* A name is constructed for the context from the creator's process
82	* name, pid and user handle in order to uniquely identify the
83	* context in messages.
84	*/
85	const char *name;
86
87	/** link: place with &drm_i915_private.context_list */
88	struct list_head link;
89
90	/**
91	* @ref: reference count
92	*
93	* A reference to a context is held by both the client who created it
94	* and on each request submitted to the hardware using the request
95	* (to ensure the hardware has access to the state until it has
96	* finished all pending writes). See i915_gem_context_get() and
97	* i915_gem_context_put() for access.
98	*/
99	struct kref ref;
100
101	/**
102	* @flags: small set of booleans
103	*/
104	unsigned long flags;
105	#define CONTEXT_NO_ZEROMAP BIT(0)
106	#define CONTEXT_NO_ERROR_CAPTURE 1
107	#define CONTEXT_CLOSED 2
108	#define CONTEXT_BANNABLE 3
109	#define CONTEXT_BANNED 4
110	#define CONTEXT_FORCE_SINGLE_SUBMISSION 5
111
112	/**
113	* @hw_id: - unique identifier for the context
114	*
115	* The hardware needs to uniquely identify the context for a few
116	* functions like fault reporting, PASID, scheduling. The
117	* &drm_i915_private.context_hw_ida is used to assign a unqiue
118	* id for the lifetime of the context.
119	*/
120	unsigned int hw_id;
121
122	/**
123	* @user_handle: userspace identifier
124	*
125	* A unique per-file identifier is generated from
126	* &drm_i915_file_private.contexts.
127	*/
128	u32 user_handle;
129
130	/**
131	* @priority: execution and service priority
132	*
133	* All clients are equal, but some are more equal than others!
134	*
135	* Requests from a context with a greater (more positive) value of
136	* @priority will be executed before those with a lower @priority
137	* value, forming a simple QoS.
138	*
139	* The &drm_i915_private.kernel_context is assigned the lowest priority.
140	*/
141	int priority;
142
143	/** ggtt_alignment: alignment restriction for context objects */
144	u32 ggtt_alignment;
145	/** ggtt_offset_bias: placement restriction for context objects */
146	u32 ggtt_offset_bias;
147
148	/** engine: per-engine logical HW state */
149	struct intel_context {
150	struct i915_vma *state;
151	struct intel_ring *ring;
152	u32 *lrc_reg_state;
153	u64 lrc_desc;
154	int pin_count;
155	bool initialised;
156	} engine[I915_NUM_ENGINES];
157
158	/** ring_size: size for allocating the per-engine ring buffer */
159	u32 ring_size;
160	/** desc_template: invariant fields for the HW context descriptor */
161	u32 desc_template;
162
6095868a CW	163	/** guilty_count: How many times this context has caused a GPU hang. */
	164	unsigned int guilty_count;
	165	/**
	166	* @active_count: How many times this context was active during a GPU
	167	* hang, but did not cause it.
	168	*/
	169	unsigned int active_count;
	170
	171	#define CONTEXT_SCORE_GUILTY 10
	172	#define CONTEXT_SCORE_BAN_THRESHOLD 40
	173	/** ban_score: Accumulated score of all hangs caused by this context. */
	174	int ban_score;
	175
	176	/** remap_slice: Bitmask of cache lines that need remapping */
	177	u8 remap_slice;
	178	};
	179
	180	static inline bool i915_gem_context_is_closed(const struct i915_gem_context *ctx)
	181	{
	182	return test_bit(CONTEXT_CLOSED, &ctx->flags);
	183	}
	184
	185	static inline void i915_gem_context_set_closed(struct i915_gem_context *ctx)
	186	{
	187	GEM_BUG_ON(i915_gem_context_is_closed(ctx));
	188	__set_bit(CONTEXT_CLOSED, &ctx->flags);
	189	}
	190
	191	static inline bool i915_gem_context_no_error_capture(const struct i915_gem_context *ctx)
	192	{
	193	return test_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
	194	}
	195
	196	static inline void i915_gem_context_set_no_error_capture(struct i915_gem_context *ctx)
	197	{
	198	__set_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
	199	}
	200
	201	static inline void i915_gem_context_clear_no_error_capture(struct i915_gem_context *ctx)
	202	{
	203	__clear_bit(CONTEXT_NO_ERROR_CAPTURE, &ctx->flags);
	204	}
	205
	206	static inline bool i915_gem_context_is_bannable(const struct i915_gem_context *ctx)
	207	{
	208	return test_bit(CONTEXT_BANNABLE, &ctx->flags);
	209	}
	210
	211	static inline void i915_gem_context_set_bannable(struct i915_gem_context *ctx)
	212	{
	213	__set_bit(CONTEXT_BANNABLE, &ctx->flags);
	214	}
	215
	216	static inline void i915_gem_context_clear_bannable(struct i915_gem_context *ctx)
	217	{
	218	__clear_bit(CONTEXT_BANNABLE, &ctx->flags);
	219	}
	220
	221	static inline bool i915_gem_context_is_banned(const struct i915_gem_context *ctx)
	222	{
	223	return test_bit(CONTEXT_BANNED, &ctx->flags);
	224	}
	225
	226	static inline void i915_gem_context_set_banned(struct i915_gem_context *ctx)
227	{
228	__set_bit(CONTEXT_BANNED, &ctx->flags);
229	}
230
231	static inline bool i915_gem_context_force_single_submission(const struct i915_gem_context *ctx)
232	{
233	return test_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ctx->flags);
234	}
235
236	static inline void i915_gem_context_set_force_single_submission(struct i915_gem_context *ctx)
237	{
238	__set_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ctx->flags);
239	}
240
241	static inline bool i915_gem_context_is_default(const struct i915_gem_context *c)
242	{
243	return c->user_handle == DEFAULT_CONTEXT_HANDLE;
244	}
245
984ff29f CW	246	static inline bool i915_gem_context_is_kernel(struct i915_gem_context *ctx)
	247	{
	248	return !ctx->file_priv;
	249	}
	250
6095868a CW	251	/* i915_gem_context.c */
	252	int __must_check i915_gem_context_init(struct drm_i915_private *dev_priv);
	253	void i915_gem_context_lost(struct drm_i915_private *dev_priv);
	254	void i915_gem_context_fini(struct drm_i915_private *dev_priv);
	255	int i915_gem_context_open(struct drm_device dev, struct drm_file file);
	256	void i915_gem_context_close(struct drm_device dev, struct drm_file file);
	257	int i915_switch_context(struct drm_i915_gem_request *req);
	258	int i915_gem_switch_to_kernel_context(struct drm_i915_private *dev_priv);
	259	void i915_gem_context_free(struct kref *ctx_ref);
	260	struct i915_gem_context *
	261	i915_gem_context_create_gvt(struct drm_device *dev);
	262
	263	int i915_gem_context_create_ioctl(struct drm_device dev, void data,
	264	struct drm_file *file);
	265	int i915_gem_context_destroy_ioctl(struct drm_device dev, void data,
	266	struct drm_file *file);
	267	int i915_gem_context_getparam_ioctl(struct drm_device dev, void data,
	268	struct drm_file *file_priv);
	269	int i915_gem_context_setparam_ioctl(struct drm_device dev, void data,
	270	struct drm_file *file_priv);
	271	int i915_gem_context_reset_stats_ioctl(struct drm_device dev, void data,
	272	struct drm_file *file);
	273
	274	#endif /* !__I915_GEM_CONTEXT_H__ */