drivers/gpu/drm/i915/i915_gem_context.h

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