2 * SPDX-License-Identifier: MIT
4 * Copyright © 2019 Intel Corporation
7 #ifndef __I915_GEM_CONTEXT_TYPES_H__
8 #define __I915_GEM_CONTEXT_TYPES_H__
10 #include <linux/atomic.h>
11 #include <linux/list.h>
12 #include <linux/llist.h>
13 #include <linux/kref.h>
14 #include <linux/mutex.h>
15 #include <linux/radix-tree.h>
16 #include <linux/rbtree.h>
17 #include <linux/rcupdate.h>
18 #include <linux/types.h>
20 #include "gt/intel_context_types.h"
22 #include "i915_scheduler.h"
23 #include "i915_sw_fence.h"
27 struct drm_i915_private;
28 struct drm_i915_file_private;
29 struct i915_address_space;
30 struct intel_timeline;
33 struct i915_gem_engines {
35 struct list_head link;
38 struct i915_sw_fence fence;
39 struct i915_gem_context *ctx;
40 unsigned int num_engines;
41 struct intel_context *engines[];
44 struct i915_gem_engines_iter {
46 const struct i915_gem_engines *engines;
50 * struct i915_gem_context - client state
52 * The struct i915_gem_context represents the combined view of the driver and
53 * logical hardware state for a particular client.
55 struct i915_gem_context {
56 /** i915: i915 device backpointer */
57 struct drm_i915_private *i915;
59 /** file_priv: owning file descriptor */
60 struct drm_i915_file_private *file_priv;
63 * @engines: User defined engines for this context
65 * Various uAPI offer the ability to lookup up an
66 * index from this array to select an engine operate on.
68 * Multiple logically distinct instances of the same engine
69 * may be defined in the array, as well as composite virtual
72 * Execbuf uses the I915_EXEC_RING_MASK as an index into this
73 * array to select which HW context + engine to execute on. For
74 * the default array, the user_ring_map[] is used to translate
75 * the legacy uABI onto the approprate index (e.g. both
76 * I915_EXEC_DEFAULT and I915_EXEC_RENDER select the same
77 * context, and I915_EXEC_BSD is weird). For a use defined
78 * array, execbuf uses I915_EXEC_RING_MASK as a plain index.
80 * User defined by I915_CONTEXT_PARAM_ENGINE (when the
81 * CONTEXT_USER_ENGINES flag is set).
83 struct i915_gem_engines __rcu *engines;
84 struct mutex engines_mutex; /* guards writes to engines */
86 struct intel_timeline *timeline;
89 * @vm: unique address space (GTT)
91 * In full-ppgtt mode, each context has its own address space ensuring
92 * complete seperation of one client from all others.
94 * In other modes, this is a NULL pointer with the expectation that
95 * the caller uses the shared global GTT.
97 struct i915_address_space __rcu *vm;
100 * @pid: process id of creator
102 * Note that who created the context may not be the principle user,
103 * as the context may be shared across a local socket. However,
104 * that should only affect the default context, all contexts created
105 * explicitly by the client are expected to be isolated.
109 /** link: place with &drm_i915_private.context_list */
110 struct list_head link;
113 * @ref: reference count
115 * A reference to a context is held by both the client who created it
116 * and on each request submitted to the hardware using the request
117 * (to ensure the hardware has access to the state until it has
118 * finished all pending writes). See i915_gem_context_get() and
119 * i915_gem_context_put() for access.
124 * @rcu: rcu_head for deferred freeing.
129 * @user_flags: small set of booleans controlled by the user
131 unsigned long user_flags;
132 #define UCONTEXT_NO_ZEROMAP 0
133 #define UCONTEXT_NO_ERROR_CAPTURE 1
134 #define UCONTEXT_BANNABLE 2
135 #define UCONTEXT_RECOVERABLE 3
136 #define UCONTEXT_PERSISTENCE 4
139 * @flags: small set of booleans
142 #define CONTEXT_CLOSED 0
143 #define CONTEXT_USER_ENGINES 1
147 struct i915_sched_attr sched;
149 /** guilty_count: How many times this context has caused a GPU hang. */
150 atomic_t guilty_count;
152 * @active_count: How many times this context was active during a GPU
153 * hang, but did not cause it.
155 atomic_t active_count;
162 * @hang_timestamp: The last time(s) this context caused a GPU hang
164 unsigned long hang_timestamp[2];
165 #define CONTEXT_FAST_HANG_JIFFIES (120 * HZ) /* 3 hangs within 120s? Banned! */
167 /** remap_slice: Bitmask of cache lines that need remapping */
171 * handles_vma: rbtree to look up our context specific obj/vma for
172 * the user handle. (user handles are per fd, but the binding is
173 * per vm, which may be one per context or shared with the global GTT)
175 struct radix_tree_root handles_vma;
176 struct mutex lut_mutex;
179 * @name: arbitrary name, used for user debug
181 * A name is constructed for the context from the creator's process
182 * name, pid and user handle in order to uniquely identify the
183 * context in messages.
185 char name[TASK_COMM_LEN + 8];
189 struct list_head engines;
193 #endif /* __I915_GEM_CONTEXT_TYPES_H__ */