sys/dev/drm/i915/i915_gem_context.c

   1 /*
   2  * Copyright © 2011-2012 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  * Authors:
  24  *    Ben Widawsky <ben@bwidawsk.net>
  25  *
  26  */
  27
  28 /*
  29  * This file implements HW context support. On gen5+ a HW context consists of an
  30  * opaque GPU object which is referenced at times of context saves and restores.
  31  * With RC6 enabled, the context is also referenced as the GPU enters and exists
  32  * from RC6 (GPU has it's own internal power context, except on gen5). Though
  33  * something like a context does exist for the media ring, the code only
  34  * supports contexts for the render ring.
  35  *
  36  * In software, there is a distinction between contexts created by the user,
  37  * and the default HW context. The default HW context is used by GPU clients
  38  * that do not request setup of their own hardware context. The default
  39  * context's state is never restored to help prevent programming errors. This
  40  * would happen if a client ran and piggy-backed off another clients GPU state.
  41  * The default context only exists to give the GPU some offset to load as the
  42  * current to invoke a save of the context we actually care about. In fact, the
  43  * code could likely be constructed, albeit in a more complicated fashion, to
  44  * never use the default context, though that limits the driver's ability to
  45  * swap out, and/or destroy other contexts.
  46  *
  47  * All other contexts are created as a request by the GPU client. These contexts
  48  * store GPU state, and thus allow GPU clients to not re-emit state (and
  49  * potentially query certain state) at any time. The kernel driver makes
  50  * certain that the appropriate commands are inserted.
  51  *
  52  * The context life cycle is semi-complicated in that context BOs may live
  53  * longer than the context itself because of the way the hardware, and object
  54  * tracking works. Below is a very crude representation of the state machine
  55  * describing the context life.
  56  *                                         refcount     pincount     active
  57  * S0: initial state                          0            0           0
  58  * S1: context created                        1            0           0
  59  * S2: context is currently running           2            1           X
  60  * S3: GPU referenced, but not current        2            0           1
  61  * S4: context is current, but destroyed      1            1           0
  62  * S5: like S3, but destroyed                 1            0           1
  63  *
  64  * The most common (but not all) transitions:
  65  * S0->S1: client creates a context
  66  * S1->S2: client submits execbuf with context
  67  * S2->S3: other clients submits execbuf with context
  68  * S3->S1: context object was retired
  69  * S3->S2: clients submits another execbuf
  70  * S2->S4: context destroy called with current context
  71  * S3->S5->S0: destroy path
  72  * S4->S5->S0: destroy path on current context
  73  *
  74  * There are two confusing terms used above:
  75  *  The "current context" means the context which is currently running on the
  76  *  GPU. The GPU has loaded it's state already and has stored away the gtt
  77  *  offset of the BO. The GPU is not actively referencing the data at this
  78  *  offset, but it will on the next context switch. The only way to avoid this
  79  *  is to do a GPU reset.
  80  *
  81  *  An "active context' is one which was previously the "current context" and is
  82  *  on the active list waiting for the next context switch to occur. Until this
  83  *  happens, the object must remain at the same gtt offset. It is therefore
  84  *  possible to destroy a context, but it is still active.
  85  *
  86  */
  87
  88 #include <drm/drmP.h>
  89 #include <drm/i915_drm.h>
  90 #include "i915_drv.h"
  91 #include <linux/err.h>
  92
  93 /* This is a HW constraint. The value below is the largest known requirement
  94  * I've seen in a spec to date, and that was a workaround for a non-shipping
  95  * part. It should be safe to decrease this, but it's more future proof as is.
  96  */
  97 #define CONTEXT_ALIGN (64<<10)
  98
  99 static struct i915_hw_context *
 100 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id);
 101 static int do_switch(struct i915_hw_context *to);
 102
 103 static int get_context_size(struct drm_device *dev)
 104 {
 105         struct drm_i915_private *dev_priv = dev->dev_private;
 106         int ret;
 107         u32 reg;
 108
 109         switch (INTEL_INFO(dev)->gen) {
 110         case 6:
 111                 reg = I915_READ(CXT_SIZE);
 112                 ret = GEN6_CXT_TOTAL_SIZE(reg) * 64;
 113                 break;
 114         case 7:
 115                 reg = I915_READ(GEN7_CXT_SIZE);
 116                 if (IS_HASWELL(dev))
 117                         ret = HSW_CXT_TOTAL_SIZE(reg) * 64;
 118                 else
 119                         ret = GEN7_CXT_TOTAL_SIZE(reg) * 64;
 120                 break;
 121         default:
 122                 BUG();
 123         }
 124
 125         return ret;
 126 }
 127
 128 static void do_destroy(struct i915_hw_context *ctx)
 129 {
 130         struct drm_device *dev = ctx->obj->base.dev;
 131         struct drm_i915_private *dev_priv = dev->dev_private;
 132
 133         if (ctx->file_priv)
 134                 idr_remove(&ctx->file_priv->context_idr, ctx->id);
 135         else
 136                 BUG_ON(ctx != dev_priv->ring[RCS].default_context);
 137
 138         drm_gem_object_unreference(&ctx->obj->base);
 139         kfree(ctx, DRM_I915_GEM);
 140 }
 141
 142 static struct i915_hw_context *
 143 create_hw_context(struct drm_device *dev,
 144                   struct drm_i915_file_private *file_priv)
 145 {
 146         struct drm_i915_private *dev_priv = dev->dev_private;
 147         struct i915_hw_context *ctx;
 148         int ret, id;
 149
 150         ctx = kmalloc(sizeof(*ctx), DRM_I915_GEM, M_WAITOK | M_ZERO);
 151         if (ctx == NULL)
 152                 return ERR_PTR(-ENOMEM);
 153
 154         ctx->obj = i915_gem_alloc_object(dev, dev_priv->hw_context_size);
 155         if (ctx->obj == NULL) {
 156                 kfree(ctx, DRM_I915_GEM);
 157                 DRM_DEBUG_DRIVER("Context object allocated failed\n");
 158                 return ERR_PTR(-ENOMEM);
 159         }
 160
 161         if (INTEL_INFO(dev)->gen >= 7) {
 162                 ret = i915_gem_object_set_cache_level(ctx->obj,
 163                                                       I915_CACHE_LLC_MLC);
 164                 if (ret)
 165                         goto err_out;
 166         }
 167
 168         /* The ring associated with the context object is handled by the normal
 169          * object tracking code. We give an initial ring value simple to pass an
 170          * assertion in the context switch code.
 171          */
 172         ctx->ring = &dev_priv->ring[RCS];
 173
 174         /* Default context will never have a file_priv */
 175         if (file_priv == NULL)
 176                 return ctx;
 177
 178         ctx->file_priv = file_priv;
 179
 180 again:
 181         if (idr_pre_get(&file_priv->context_idr, GFP_KERNEL) == 0) {
 182                 ret = -ENOMEM;
 183                 DRM_DEBUG_DRIVER("idr allocation failed\n");
 184                 goto err_out;
 185         }
 186
 187         ret = idr_get_new_above(&file_priv->context_idr, ctx,
 188                                 DEFAULT_CONTEXT_ID + 1, &id);
 189         if (ret == 0)
 190                 ctx->id = id;
 191
 192         if (ret == -EAGAIN)
 193                 goto again;
 194         else if (ret)
 195                 goto err_out;
 196
 197         return ctx;
 198
 199 err_out:
 200         do_destroy(ctx);
 201         return ERR_PTR(ret);
 202 }
 203
 204 static inline bool is_default_context(struct i915_hw_context *ctx)
 205 {
 206         return (ctx == ctx->ring->default_context);
 207 }
 208
 209 /**
 210  * The default context needs to exist per ring that uses contexts. It stores the
 211  * context state of the GPU for applications that don't utilize HW contexts, as
 212  * well as an idle case.
 213  */
 214 static int create_default_context(struct drm_i915_private *dev_priv)
 215 {
 216         struct i915_hw_context *ctx;
 217         int ret;
 218
 219         DRM_LOCK_ASSERT(dev_priv->dev);
 220
 221         ctx = create_hw_context(dev_priv->dev, NULL);
 222         if (IS_ERR(ctx))
 223                 return PTR_ERR(ctx);
 224
 225         /* We may need to do things with the shrinker which require us to
 226          * immediately switch back to the default context. This can cause a
 227          * problem as pinning the default context also requires GTT space which
 228          * may not be available. To avoid this we always pin the
 229          * default context.
 230          */
 231         dev_priv->ring[RCS].default_context = ctx;
 232         ret = i915_gem_object_pin(ctx->obj, CONTEXT_ALIGN, false, false);
 233         if (ret)
 234                 goto err_destroy;
 235
 236         ret = do_switch(ctx);
 237         if (ret)
 238                 goto err_unpin;
 239
 240         DRM_DEBUG_DRIVER("Default HW context loaded\n");
 241         return 0;
 242
 243 err_unpin:
 244         i915_gem_object_unpin(ctx->obj);
 245 err_destroy:
 246         do_destroy(ctx);
 247         return ret;
 248 }
 249
 250 void i915_gem_context_init(struct drm_device *dev)
 251 {
 252         struct drm_i915_private *dev_priv = dev->dev_private;
 253         uint32_t ctx_size;
 254
 255         if (!HAS_HW_CONTEXTS(dev)) {
 256                 dev_priv->hw_contexts_disabled = true;
 257                 return;
 258         }
 259
 260         /* If called from reset, or thaw... we've been here already */
 261         if (dev_priv->hw_contexts_disabled ||
 262             dev_priv->ring[RCS].default_context)
 263                 return;
 264
 265         ctx_size = get_context_size(dev);
 266         dev_priv->hw_context_size = get_context_size(dev);
 267         dev_priv->hw_context_size = round_up(dev_priv->hw_context_size, 4096);
 268
 269         if (ctx_size <= 0 || ctx_size > (1<<20)) {
 270                 dev_priv->hw_contexts_disabled = true;
 271                 return;
 272         }
 273
 274         if (create_default_context(dev_priv)) {
 275                 dev_priv->hw_contexts_disabled = true;
 276                 return;
 277         }
 278
 279         DRM_DEBUG_DRIVER("HW context support initialized\n");
 280 }
 281
 282 void i915_gem_context_fini(struct drm_device *dev)
 283 {
 284         struct drm_i915_private *dev_priv = dev->dev_private;
 285
 286         if (dev_priv->hw_contexts_disabled)
 287                 return;
 288
 289         /* The only known way to stop the gpu from accessing the hw context is
 290          * to reset it. Do this as the very last operation to avoid confusing
 291          * other code, leading to spurious errors. */
 292         intel_gpu_reset(dev);
 293
 294         i915_gem_object_unpin(dev_priv->ring[RCS].default_context->obj);
 295
 296         do_destroy(dev_priv->ring[RCS].default_context);
 297 }
 298
 299 static int context_idr_cleanup(int id, void *p, void *data)
 300 {
 301         struct i915_hw_context *ctx = p;
 302
 303         BUG_ON(id == DEFAULT_CONTEXT_ID);
 304
 305         do_destroy(ctx);
 306
 307         return 0;
 308 }
 309
 310 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file)
 311 {
 312         struct drm_i915_file_private *file_priv = file->driver_priv;
 313
 314         DRM_LOCK(dev);
 315         idr_for_each(&file_priv->context_idr, context_idr_cleanup, NULL);
 316         idr_destroy(&file_priv->context_idr);
 317         DRM_UNLOCK(dev);
 318 }
 319
 320 static struct i915_hw_context *
 321 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id)
 322 {
 323         return (struct i915_hw_context *)idr_find(&file_priv->context_idr, id);
 324 }
 325
 326 static inline int
 327 mi_set_context(struct intel_ring_buffer *ring,
 328                struct i915_hw_context *new_context,
 329                u32 hw_flags)
 330 {
 331         int ret;
 332
 333         /* w/a: If Flush TLB Invalidation Mode is enabled, driver must do a TLB
 334          * invalidation prior to MI_SET_CONTEXT. On GEN6 we don't set the value
 335          * explicitly, so we rely on the value at ring init, stored in
 336          * itlb_before_ctx_switch.
 337          */
 338         if (IS_GEN6(ring->dev) && ring->itlb_before_ctx_switch) {
 339                 ret = ring->flush(ring, I915_GEM_GPU_DOMAINS, 0);
 340                 if (ret)
 341                         return ret;
 342         }
 343
 344         ret = intel_ring_begin(ring, 6);
 345         if (ret)
 346                 return ret;
 347
 348         if (IS_GEN7(ring->dev))
 349                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_DISABLE);
 350         else
 351                 intel_ring_emit(ring, MI_NOOP);
 352
 353         intel_ring_emit(ring, MI_NOOP);
 354         intel_ring_emit(ring, MI_SET_CONTEXT);
 355         intel_ring_emit(ring, new_context->obj->gtt_offset |
 356                         MI_MM_SPACE_GTT |
 357                         MI_SAVE_EXT_STATE_EN |
 358                         MI_RESTORE_EXT_STATE_EN |
 359                         hw_flags);
 360         /* w/a: MI_SET_CONTEXT must always be followed by MI_NOOP */
 361         intel_ring_emit(ring, MI_NOOP);
 362
 363         if (IS_GEN7(ring->dev))
 364                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_ENABLE);
 365         else
 366                 intel_ring_emit(ring, MI_NOOP);
 367
 368         intel_ring_advance(ring);
 369
 370         return ret;
 371 }
 372
 373 static int do_switch(struct i915_hw_context *to)
 374 {
 375         struct intel_ring_buffer *ring = to->ring;
 376         struct drm_i915_gem_object *from_obj = ring->last_context_obj;
 377         u32 hw_flags = 0;
 378         int ret;
 379
 380         BUG_ON(from_obj != NULL && from_obj->pin_count == 0);
 381
 382         if (from_obj == to->obj)
 383                 return 0;
 384
 385         ret = i915_gem_object_pin(to->obj, CONTEXT_ALIGN, false, false);
 386         if (ret)
 387                 return ret;
 388
 389         /* Clear this page out of any CPU caches for coherent swap-in/out. Note
 390          * that thanks to write = false in this call and us not setting any gpu
 391          * write domains when putting a context object onto the active list
 392          * (when switching away from it), this won't block.
 393          * XXX: We need a real interface to do this instead of trickery. */
 394         ret = i915_gem_object_set_to_gtt_domain(to->obj, false);
 395         if (ret) {
 396                 i915_gem_object_unpin(to->obj);
 397                 return ret;
 398         }
 399
 400         if (!to->obj->has_global_gtt_mapping)
 401                 i915_gem_gtt_bind_object(to->obj, to->obj->cache_level);
 402
 403         if (!to->is_initialized || is_default_context(to))
 404                 hw_flags |= MI_RESTORE_INHIBIT;
 405         else if (WARN_ON_ONCE(from_obj == to->obj)) /* not yet expected */
 406                 hw_flags |= MI_FORCE_RESTORE;
 407
 408         ret = mi_set_context(ring, to, hw_flags);
 409         if (ret) {
 410                 i915_gem_object_unpin(to->obj);
 411                 return ret;
 412         }
 413
 414         /* The backing object for the context is done after switching to the
 415          * *next* context. Therefore we cannot retire the previous context until
 416          * the next context has already started running. In fact, the below code
 417          * is a bit suboptimal because the retiring can occur simply after the
 418          * MI_SET_CONTEXT instead of when the next seqno has completed.
 419          */
 420         if (from_obj != NULL) {
 421                 from_obj->base.read_domains = I915_GEM_DOMAIN_INSTRUCTION;
 422                 i915_gem_object_move_to_active(from_obj, ring);
 423                 /* As long as MI_SET_CONTEXT is serializing, ie. it flushes the
 424                  * whole damn pipeline, we don't need to explicitly mark the
 425                  * object dirty. The only exception is that the context must be
 426                  * correct in case the object gets swapped out. Ideally we'd be
 427                  * able to defer doing this until we know the object would be
 428                  * swapped, but there is no way to do that yet.
 429                  */
 430                 from_obj->dirty = 1;
 431                 BUG_ON(from_obj->ring != ring);
 432                 i915_gem_object_unpin(from_obj);
 433
 434                 drm_gem_object_unreference(&from_obj->base);
 435         }
 436
 437         drm_gem_object_reference(&to->obj->base);
 438         ring->last_context_obj = to->obj;
 439         to->is_initialized = true;
 440
 441         return 0;
 442 }
 443
 444 /**
 445  * i915_switch_context() - perform a GPU context switch.
 446  * @ring: ring for which we'll execute the context switch
 447  * @file_priv: file_priv associated with the context, may be NULL
 448  * @id: context id number
 449  * @seqno: sequence number by which the new context will be switched to
 450  * @flags:
 451  *
 452  * The context life cycle is simple. The context refcount is incremented and
 453  * decremented by 1 and create and destroy. If the context is in use by the GPU,
 454  * it will have a refoucnt > 1. This allows us to destroy the context abstract
 455  * object while letting the normal object tracking destroy the backing BO.
 456  */
 457 int i915_switch_context(struct intel_ring_buffer *ring,
 458                         struct drm_file *file,
 459                         int to_id)
 460 {
 461         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 462         struct i915_hw_context *to;
 463
 464         if (dev_priv->hw_contexts_disabled)
 465                 return 0;
 466
 467         if (ring != &dev_priv->ring[RCS])
 468                 return 0;
 469
 470         if (to_id == DEFAULT_CONTEXT_ID) {
 471                 to = ring->default_context;
 472         } else {
 473                 if (file == NULL)
 474                         return -EINVAL;
 475
 476                 to = i915_gem_context_get(file->driver_priv, to_id);
 477                 if (to == NULL)
 478                         return -ENOENT;
 479         }
 480
 481         return do_switch(to);
 482 }
 483
 484 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
 485                                   struct drm_file *file)
 486 {
 487         struct drm_i915_private *dev_priv = dev->dev_private;
 488         struct drm_i915_gem_context_create *args = data;
 489         struct drm_i915_file_private *file_priv = file->driver_priv;
 490         struct i915_hw_context *ctx;
 491         int ret;
 492
 493         if (!(dev->driver->driver_features & DRIVER_GEM))
 494                 return -ENODEV;
 495
 496         if (dev_priv->hw_contexts_disabled)
 497                 return -ENODEV;
 498
 499         ret = i915_mutex_lock_interruptible(dev);
 500         if (ret)
 501                 return ret;
 502
 503         ctx = create_hw_context(dev, file_priv);
 504         DRM_UNLOCK(dev);
 505         if (IS_ERR(ctx))
 506                 return PTR_ERR(ctx);
 507
 508         args->ctx_id = ctx->id;
 509         DRM_DEBUG_DRIVER("HW context %d created\n", args->ctx_id);
 510
 511         return 0;
 512 }
 513
 514 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
 515                                    struct drm_file *file)
 516 {
 517         struct drm_i915_gem_context_destroy *args = data;
 518         struct drm_i915_file_private *file_priv = file->driver_priv;
 519         struct i915_hw_context *ctx;
 520         int ret;
 521
 522         if (!(dev->driver->driver_features & DRIVER_GEM))
 523                 return -ENODEV;
 524
 525         ret = i915_mutex_lock_interruptible(dev);
 526         if (ret)
 527                 return ret;
 528
 529         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 530         if (!ctx) {
 531                 DRM_UNLOCK(dev);
 532                 return -ENOENT;
 533         }
 534
 535         do_destroy(ctx);
 536
 537         DRM_UNLOCK(dev);
 538
 539         DRM_DEBUG_DRIVER("HW context %d destroyed\n", args->ctx_id);
 540         return 0;
 541 }