drivers/gpu/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 its 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
  92 /* This is a HW constraint. The value below is the largest known requirement
  93  * I've seen in a spec to date, and that was a workaround for a non-shipping
  94  * part. It should be safe to decrease this, but it's more future proof as is.
  95  */
  96 #define GEN6_CONTEXT_ALIGN (64<<10)
  97 #define GEN7_CONTEXT_ALIGN 4096
  98
  99 static int do_switch(struct intel_ring_buffer *ring,
 100                      struct i915_hw_context *to);
 101
 102 static void do_ppgtt_cleanup(struct i915_hw_ppgtt *ppgtt)
 103 {
 104         struct drm_device *dev = ppgtt->base.dev;
 105         struct drm_i915_private *dev_priv = dev->dev_private;
 106         struct i915_address_space *vm = &ppgtt->base;
 107
 108         if (ppgtt == dev_priv->mm.aliasing_ppgtt ||
 109             (list_empty(&vm->active_list) && list_empty(&vm->inactive_list))) {
 110                 ppgtt->base.cleanup(&ppgtt->base);
 111                 return;
 112         }
 113
 114         /*
 115          * Make sure vmas are unbound before we take down the drm_mm
 116          *
 117          * FIXME: Proper refcounting should take care of this, this shouldn't be
 118          * needed at all.
 119          */
 120         if (!list_empty(&vm->active_list)) {
 121                 struct i915_vma *vma;
 122
 123                 list_for_each_entry(vma, &vm->active_list, mm_list)
 124                         if (WARN_ON(list_empty(&vma->vma_link) ||
 125                                     list_is_singular(&vma->vma_link)))
 126                                 break;
 127
 128                 i915_gem_evict_vm(&ppgtt->base, true);
 129         } else {
 130                 i915_gem_retire_requests(dev);
 131                 i915_gem_evict_vm(&ppgtt->base, false);
 132         }
 133
 134         ppgtt->base.cleanup(&ppgtt->base);
 135 }
 136
 137 static void ppgtt_release(struct kref *kref)
 138 {
 139         struct i915_hw_ppgtt *ppgtt =
 140                 container_of(kref, struct i915_hw_ppgtt, ref);
 141
 142         do_ppgtt_cleanup(ppgtt);
 143         kfree(ppgtt);
 144 }
 145
 146 static size_t get_context_alignment(struct drm_device *dev)
 147 {
 148         if (IS_GEN6(dev))
 149                 return GEN6_CONTEXT_ALIGN;
 150
 151         return GEN7_CONTEXT_ALIGN;
 152 }
 153
 154 static int get_context_size(struct drm_device *dev)
 155 {
 156         struct drm_i915_private *dev_priv = dev->dev_private;
 157         int ret;
 158         u32 reg;
 159
 160         switch (INTEL_INFO(dev)->gen) {
 161         case 6:
 162                 reg = I915_READ(CXT_SIZE);
 163                 ret = GEN6_CXT_TOTAL_SIZE(reg) * 64;
 164                 break;
 165         case 7:
 166                 reg = I915_READ(GEN7_CXT_SIZE);
 167                 if (IS_HASWELL(dev))
 168                         ret = HSW_CXT_TOTAL_SIZE;
 169                 else
 170                         ret = GEN7_CXT_TOTAL_SIZE(reg) * 64;
 171                 break;
 172         case 8:
 173                 ret = GEN8_CXT_TOTAL_SIZE;
 174                 break;
 175         default:
 176                 BUG();
 177         }
 178
 179         return ret;
 180 }
 181
 182 void i915_gem_context_free(struct kref *ctx_ref)
 183 {
 184         struct i915_hw_context *ctx = container_of(ctx_ref,
 185                                                    typeof(*ctx), ref);
 186         struct i915_hw_ppgtt *ppgtt = NULL;
 187
 188         /* We refcount even the aliasing PPGTT to keep the code symmetric */
 189         if (USES_PPGTT(ctx->obj->base.dev))
 190                 ppgtt = ctx_to_ppgtt(ctx);
 191
 192         /* XXX: Free up the object before tearing down the address space, in
 193          * case we're bound in the PPGTT */
 194         drm_gem_object_unreference(&ctx->obj->base);
 195
 196         if (ppgtt)
 197                 kref_put(&ppgtt->ref, ppgtt_release);
 198         list_del(&ctx->link);
 199         kfree(ctx);
 200 }
 201
 202 static struct i915_hw_ppgtt *
 203 create_vm_for_ctx(struct drm_device *dev, struct i915_hw_context *ctx)
 204 {
 205         struct i915_hw_ppgtt *ppgtt;
 206         int ret;
 207
 208         ppgtt = kzalloc(sizeof(*ppgtt), GFP_KERNEL);
 209         if (!ppgtt)
 210                 return ERR_PTR(-ENOMEM);
 211
 212         ret = i915_gem_init_ppgtt(dev, ppgtt);
 213         if (ret) {
 214                 kfree(ppgtt);
 215                 return ERR_PTR(ret);
 216         }
 217
 218         return ppgtt;
 219 }
 220
 221 static struct i915_hw_context *
 222 __create_hw_context(struct drm_device *dev,
 223                   struct drm_i915_file_private *file_priv)
 224 {
 225         struct drm_i915_private *dev_priv = dev->dev_private;
 226         struct i915_hw_context *ctx;
 227         int ret;
 228
 229         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 230         if (ctx == NULL)
 231                 return ERR_PTR(-ENOMEM);
 232
 233         kref_init(&ctx->ref);
 234         ctx->obj = i915_gem_alloc_object(dev, dev_priv->hw_context_size);
 235         INIT_LIST_HEAD(&ctx->link);
 236         if (ctx->obj == NULL) {
 237                 kfree(ctx);
 238                 DRM_DEBUG_DRIVER("Context object allocated failed\n");
 239                 return ERR_PTR(-ENOMEM);
 240         }
 241
 242         if (INTEL_INFO(dev)->gen >= 7) {
 243                 ret = i915_gem_object_set_cache_level(ctx->obj,
 244                                                       I915_CACHE_L3_LLC);
 245                 /* Failure shouldn't ever happen this early */
 246                 if (WARN_ON(ret))
 247                         goto err_out;
 248         }
 249
 250         list_add_tail(&ctx->link, &dev_priv->context_list);
 251
 252         /* Default context will never have a file_priv */
 253         if (file_priv == NULL)
 254                 return ctx;
 255
 256         ret = idr_alloc(&file_priv->context_idr, ctx, DEFAULT_CONTEXT_ID, 0,
 257                         GFP_KERNEL);
 258         if (ret < 0)
 259                 goto err_out;
 260
 261         ctx->file_priv = file_priv;
 262         ctx->id = ret;
 263         /* NB: Mark all slices as needing a remap so that when the context first
 264          * loads it will restore whatever remap state already exists. If there
 265          * is no remap info, it will be a NOP. */
 266         ctx->remap_slice = (1 << NUM_L3_SLICES(dev)) - 1;
 267
 268         return ctx;
 269
 270 err_out:
 271         i915_gem_context_unreference(ctx);
 272         return ERR_PTR(ret);
 273 }
 274
 275 /**
 276  * The default context needs to exist per ring that uses contexts. It stores the
 277  * context state of the GPU for applications that don't utilize HW contexts, as
 278  * well as an idle case.
 279  */
 280 static struct i915_hw_context *
 281 i915_gem_create_context(struct drm_device *dev,
 282                         struct drm_i915_file_private *file_priv,
 283                         bool create_vm)
 284 {
 285         const bool is_global_default_ctx = file_priv == NULL;
 286         struct drm_i915_private *dev_priv = dev->dev_private;
 287         struct i915_hw_context *ctx;
 288         int ret = 0;
 289
 290         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
 291
 292         ctx = __create_hw_context(dev, file_priv);
 293         if (IS_ERR(ctx))
 294                 return ctx;
 295
 296         if (is_global_default_ctx) {
 297                 /* We may need to do things with the shrinker which
 298                  * require us to immediately switch back to the default
 299                  * context. This can cause a problem as pinning the
 300                  * default context also requires GTT space which may not
 301                  * be available. To avoid this we always pin the default
 302                  * context.
 303                  */
 304                 ret = i915_gem_obj_ggtt_pin(ctx->obj,
 305                                             get_context_alignment(dev), 0);
 306                 if (ret) {
 307                         DRM_DEBUG_DRIVER("Couldn't pin %d\n", ret);
 308                         goto err_destroy;
 309                 }
 310         }
 311
 312         if (create_vm) {
 313                 struct i915_hw_ppgtt *ppgtt = create_vm_for_ctx(dev, ctx);
 314
 315                 if (IS_ERR_OR_NULL(ppgtt)) {
 316                         DRM_DEBUG_DRIVER("PPGTT setup failed (%ld)\n",
 317                                          PTR_ERR(ppgtt));
 318                         ret = PTR_ERR(ppgtt);
 319                         goto err_unpin;
 320                 } else
 321                         ctx->vm = &ppgtt->base;
 322
 323                 /* This case is reserved for the global default context and
 324                  * should only happen once. */
 325                 if (is_global_default_ctx) {
 326                         if (WARN_ON(dev_priv->mm.aliasing_ppgtt)) {
 327                                 ret = -EEXIST;
 328                                 goto err_unpin;
 329                         }
 330
 331                         dev_priv->mm.aliasing_ppgtt = ppgtt;
 332                 }
 333         } else if (USES_PPGTT(dev)) {
 334                 /* For platforms which only have aliasing PPGTT, we fake the
 335                  * address space and refcounting. */
 336                 ctx->vm = &dev_priv->mm.aliasing_ppgtt->base;
 337                 kref_get(&dev_priv->mm.aliasing_ppgtt->ref);
 338         } else
 339                 ctx->vm = &dev_priv->gtt.base;
 340
 341         return ctx;
 342
 343 err_unpin:
 344         if (is_global_default_ctx)
 345                 i915_gem_object_ggtt_unpin(ctx->obj);
 346 err_destroy:
 347         i915_gem_context_unreference(ctx);
 348         return ERR_PTR(ret);
 349 }
 350
 351 void i915_gem_context_reset(struct drm_device *dev)
 352 {
 353         struct drm_i915_private *dev_priv = dev->dev_private;
 354         struct intel_ring_buffer *ring;
 355         int i;
 356
 357         if (!HAS_HW_CONTEXTS(dev))
 358                 return;
 359
 360         /* Prevent the hardware from restoring the last context (which hung) on
 361          * the next switch */
 362         for (i = 0; i < I915_NUM_RINGS; i++) {
 363                 struct i915_hw_context *dctx;
 364                 if (!(INTEL_INFO(dev)->ring_mask & (1<<i)))
 365                         continue;
 366
 367                 /* Do a fake switch to the default context */
 368                 ring = &dev_priv->ring[i];
 369                 dctx = ring->default_context;
 370                 if (WARN_ON(!dctx))
 371                         continue;
 372
 373                 if (!ring->last_context)
 374                         continue;
 375
 376                 if (ring->last_context == dctx)
 377                         continue;
 378
 379                 if (i == RCS) {
 380                         WARN_ON(i915_gem_obj_ggtt_pin(dctx->obj,
 381                                                       get_context_alignment(dev), 0));
 382                         /* Fake a finish/inactive */
 383                         dctx->obj->base.write_domain = 0;
 384                         dctx->obj->active = 0;
 385                 }
 386
 387                 i915_gem_context_unreference(ring->last_context);
 388                 i915_gem_context_reference(dctx);
 389                 ring->last_context = dctx;
 390         }
 391 }
 392
 393 int i915_gem_context_init(struct drm_device *dev)
 394 {
 395         struct drm_i915_private *dev_priv = dev->dev_private;
 396         struct intel_ring_buffer *ring;
 397         int i;
 398
 399         if (!HAS_HW_CONTEXTS(dev))
 400                 return 0;
 401
 402         /* Init should only be called once per module load. Eventually the
 403          * restriction on the context_disabled check can be loosened. */
 404         if (WARN_ON(dev_priv->ring[RCS].default_context))
 405                 return 0;
 406
 407         dev_priv->hw_context_size = round_up(get_context_size(dev), 4096);
 408
 409         if (dev_priv->hw_context_size > (1<<20)) {
 410                 DRM_DEBUG_DRIVER("Disabling HW Contexts; invalid size\n");
 411                 return -E2BIG;
 412         }
 413
 414         dev_priv->ring[RCS].default_context =
 415                 i915_gem_create_context(dev, NULL, USES_PPGTT(dev));
 416
 417         if (IS_ERR_OR_NULL(dev_priv->ring[RCS].default_context)) {
 418                 DRM_DEBUG_DRIVER("Disabling HW Contexts; create failed %ld\n",
 419                                  PTR_ERR(dev_priv->ring[RCS].default_context));
 420                 return PTR_ERR(dev_priv->ring[RCS].default_context);
 421         }
 422
 423         for (i = RCS + 1; i < I915_NUM_RINGS; i++) {
 424                 if (!(INTEL_INFO(dev)->ring_mask & (1<<i)))
 425                         continue;
 426
 427                 ring = &dev_priv->ring[i];
 428
 429                 /* NB: RCS will hold a ref for all rings */
 430                 ring->default_context = dev_priv->ring[RCS].default_context;
 431         }
 432
 433         DRM_DEBUG_DRIVER("HW context support initialized\n");
 434         return 0;
 435 }
 436
 437 void i915_gem_context_fini(struct drm_device *dev)
 438 {
 439         struct drm_i915_private *dev_priv = dev->dev_private;
 440         struct i915_hw_context *dctx = dev_priv->ring[RCS].default_context;
 441         int i;
 442
 443         if (!HAS_HW_CONTEXTS(dev))
 444                 return;
 445
 446         /* The only known way to stop the gpu from accessing the hw context is
 447          * to reset it. Do this as the very last operation to avoid confusing
 448          * other code, leading to spurious errors. */
 449         intel_gpu_reset(dev);
 450
 451         /* When default context is created and switched to, base object refcount
 452          * will be 2 (+1 from object creation and +1 from do_switch()).
 453          * i915_gem_context_fini() will be called after gpu_idle() has switched
 454          * to default context. So we need to unreference the base object once
 455          * to offset the do_switch part, so that i915_gem_context_unreference()
 456          * can then free the base object correctly. */
 457         WARN_ON(!dev_priv->ring[RCS].last_context);
 458         if (dev_priv->ring[RCS].last_context == dctx) {
 459                 /* Fake switch to NULL context */
 460                 WARN_ON(dctx->obj->active);
 461                 i915_gem_object_ggtt_unpin(dctx->obj);
 462                 i915_gem_context_unreference(dctx);
 463                 dev_priv->ring[RCS].last_context = NULL;
 464         }
 465
 466         for (i = 0; i < I915_NUM_RINGS; i++) {
 467                 struct intel_ring_buffer *ring = &dev_priv->ring[i];
 468                 if (!(INTEL_INFO(dev)->ring_mask & (1<<i)))
 469                         continue;
 470
 471                 if (ring->last_context)
 472                         i915_gem_context_unreference(ring->last_context);
 473
 474                 ring->default_context = NULL;
 475                 ring->last_context = NULL;
 476         }
 477
 478         i915_gem_object_ggtt_unpin(dctx->obj);
 479         i915_gem_context_unreference(dctx);
 480         dev_priv->mm.aliasing_ppgtt = NULL;
 481 }
 482
 483 int i915_gem_context_enable(struct drm_i915_private *dev_priv)
 484 {
 485         struct intel_ring_buffer *ring;
 486         int ret, i;
 487
 488         if (!HAS_HW_CONTEXTS(dev_priv->dev))
 489                 return 0;
 490
 491         /* This is the only place the aliasing PPGTT gets enabled, which means
 492          * it has to happen before we bail on reset */
 493         if (dev_priv->mm.aliasing_ppgtt) {
 494                 struct i915_hw_ppgtt *ppgtt = dev_priv->mm.aliasing_ppgtt;
 495                 ppgtt->enable(ppgtt);
 496         }
 497
 498         /* FIXME: We should make this work, even in reset */
 499         if (i915_reset_in_progress(&dev_priv->gpu_error))
 500                 return 0;
 501
 502         BUG_ON(!dev_priv->ring[RCS].default_context);
 503
 504         for_each_ring(ring, dev_priv, i) {
 505                 ret = do_switch(ring, ring->default_context);
 506                 if (ret)
 507                         return ret;
 508         }
 509
 510         return 0;
 511 }
 512
 513 static int context_idr_cleanup(int id, void *p, void *data)
 514 {
 515         struct i915_hw_context *ctx = p;
 516
 517         /* Ignore the default context because close will handle it */
 518         if (i915_gem_context_is_default(ctx))
 519                 return 0;
 520
 521         i915_gem_context_unreference(ctx);
 522         return 0;
 523 }
 524
 525 int i915_gem_context_open(struct drm_device *dev, struct drm_file *file)
 526 {
 527         struct drm_i915_file_private *file_priv = file->driver_priv;
 528         struct drm_i915_private *dev_priv = dev->dev_private;
 529
 530         if (!HAS_HW_CONTEXTS(dev)) {
 531                 /* Cheat for hang stats */
 532                 file_priv->private_default_ctx =
 533                         kzalloc(sizeof(struct i915_hw_context), GFP_KERNEL);
 534
 535                 if (file_priv->private_default_ctx == NULL)
 536                         return -ENOMEM;
 537
 538                 file_priv->private_default_ctx->vm = &dev_priv->gtt.base;
 539                 return 0;
 540         }
 541
 542         idr_init(&file_priv->context_idr);
 543
 544         mutex_lock(&dev->struct_mutex);
 545         file_priv->private_default_ctx =
 546                 i915_gem_create_context(dev, file_priv, USES_FULL_PPGTT(dev));
 547         mutex_unlock(&dev->struct_mutex);
 548
 549         if (IS_ERR(file_priv->private_default_ctx)) {
 550                 idr_destroy(&file_priv->context_idr);
 551                 return PTR_ERR(file_priv->private_default_ctx);
 552         }
 553
 554         return 0;
 555 }
 556
 557 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file)
 558 {
 559         struct drm_i915_file_private *file_priv = file->driver_priv;
 560
 561         if (!HAS_HW_CONTEXTS(dev)) {
 562                 kfree(file_priv->private_default_ctx);
 563                 return;
 564         }
 565
 566         idr_for_each(&file_priv->context_idr, context_idr_cleanup, NULL);
 567         i915_gem_context_unreference(file_priv->private_default_ctx);
 568         idr_destroy(&file_priv->context_idr);
 569 }
 570
 571 struct i915_hw_context *
 572 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id)
 573 {
 574         struct i915_hw_context *ctx;
 575
 576         if (!HAS_HW_CONTEXTS(file_priv->dev_priv->dev))
 577                 return file_priv->private_default_ctx;
 578
 579         ctx = (struct i915_hw_context *)idr_find(&file_priv->context_idr, id);
 580         if (!ctx)
 581                 return ERR_PTR(-ENOENT);
 582
 583         return ctx;
 584 }
 585
 586 static inline int
 587 mi_set_context(struct intel_ring_buffer *ring,
 588                struct i915_hw_context *new_context,
 589                u32 hw_flags)
 590 {
 591         int ret;
 592
 593         /* w/a: If Flush TLB Invalidation Mode is enabled, driver must do a TLB
 594          * invalidation prior to MI_SET_CONTEXT. On GEN6 we don't set the value
 595          * explicitly, so we rely on the value at ring init, stored in
 596          * itlb_before_ctx_switch.
 597          */
 598         if (IS_GEN6(ring->dev) && ring->itlb_before_ctx_switch) {
 599                 ret = ring->flush(ring, I915_GEM_GPU_DOMAINS, 0);
 600                 if (ret)
 601                         return ret;
 602         }
 603
 604         ret = intel_ring_begin(ring, 6);
 605         if (ret)
 606                 return ret;
 607
 608         /* WaProgramMiArbOnOffAroundMiSetContext:ivb,vlv,hsw */
 609         if (IS_GEN7(ring->dev))
 610                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_DISABLE);
 611         else
 612                 intel_ring_emit(ring, MI_NOOP);
 613
 614         intel_ring_emit(ring, MI_NOOP);
 615         intel_ring_emit(ring, MI_SET_CONTEXT);
 616         intel_ring_emit(ring, i915_gem_obj_ggtt_offset(new_context->obj) |
 617                         MI_MM_SPACE_GTT |
 618                         MI_SAVE_EXT_STATE_EN |
 619                         MI_RESTORE_EXT_STATE_EN |
 620                         hw_flags);
 621         /*
 622          * w/a: MI_SET_CONTEXT must always be followed by MI_NOOP
 623          * WaMiSetContext_Hang:snb,ivb,vlv
 624          */
 625         intel_ring_emit(ring, MI_NOOP);
 626
 627         if (IS_GEN7(ring->dev))
 628                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_ENABLE);
 629         else
 630                 intel_ring_emit(ring, MI_NOOP);
 631
 632         intel_ring_advance(ring);
 633
 634         return ret;
 635 }
 636
 637 static int do_switch(struct intel_ring_buffer *ring,
 638                      struct i915_hw_context *to)
 639 {
 640         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 641         struct i915_hw_context *from = ring->last_context;
 642         struct i915_hw_ppgtt *ppgtt = ctx_to_ppgtt(to);
 643         u32 hw_flags = 0;
 644         int ret, i;
 645
 646         if (from != NULL && ring == &dev_priv->ring[RCS]) {
 647                 BUG_ON(from->obj == NULL);
 648                 BUG_ON(!i915_gem_obj_is_pinned(from->obj));
 649         }
 650
 651         if (from == to && from->last_ring == ring && !to->remap_slice)
 652                 return 0;
 653
 654         /* Trying to pin first makes error handling easier. */
 655         if (ring == &dev_priv->ring[RCS]) {
 656                 ret = i915_gem_obj_ggtt_pin(to->obj,
 657                                             get_context_alignment(ring->dev), 0);
 658                 if (ret)
 659                         return ret;
 660         }
 661
 662         /*
 663          * Pin can switch back to the default context if we end up calling into
 664          * evict_everything - as a last ditch gtt defrag effort that also
 665          * switches to the default context. Hence we need to reload from here.
 666          */
 667         from = ring->last_context;
 668
 669         if (USES_FULL_PPGTT(ring->dev)) {
 670                 ret = ppgtt->switch_mm(ppgtt, ring, false);
 671                 if (ret)
 672                         goto unpin_out;
 673         }
 674
 675         if (ring != &dev_priv->ring[RCS]) {
 676                 if (from)
 677                         i915_gem_context_unreference(from);
 678                 goto done;
 679         }
 680
 681         /*
 682          * Clear this page out of any CPU caches for coherent swap-in/out. Note
 683          * that thanks to write = false in this call and us not setting any gpu
 684          * write domains when putting a context object onto the active list
 685          * (when switching away from it), this won't block.
 686          *
 687          * XXX: We need a real interface to do this instead of trickery.
 688          */
 689         ret = i915_gem_object_set_to_gtt_domain(to->obj, false);
 690         if (ret)
 691                 goto unpin_out;
 692
 693         if (!to->obj->has_global_gtt_mapping) {
 694                 struct i915_vma *vma = i915_gem_obj_to_vma(to->obj,
 695                                                            &dev_priv->gtt.base);
 696                 vma->bind_vma(vma, to->obj->cache_level, GLOBAL_BIND);
 697         }
 698
 699         if (!to->is_initialized || i915_gem_context_is_default(to))
 700                 hw_flags |= MI_RESTORE_INHIBIT;
 701
 702         ret = mi_set_context(ring, to, hw_flags);
 703         if (ret)
 704                 goto unpin_out;
 705
 706         for (i = 0; i < MAX_L3_SLICES; i++) {
 707                 if (!(to->remap_slice & (1<<i)))
 708                         continue;
 709
 710                 ret = i915_gem_l3_remap(ring, i);
 711                 /* If it failed, try again next round */
 712                 if (ret)
 713                         DRM_DEBUG_DRIVER("L3 remapping failed\n");
 714                 else
 715                         to->remap_slice &= ~(1<<i);
 716         }
 717
 718         /* The backing object for the context is done after switching to the
 719          * *next* context. Therefore we cannot retire the previous context until
 720          * the next context has already started running. In fact, the below code
 721          * is a bit suboptimal because the retiring can occur simply after the
 722          * MI_SET_CONTEXT instead of when the next seqno has completed.
 723          */
 724         if (from != NULL) {
 725                 from->obj->base.read_domains = I915_GEM_DOMAIN_INSTRUCTION;
 726                 i915_vma_move_to_active(i915_gem_obj_to_ggtt(from->obj), ring);
 727                 /* As long as MI_SET_CONTEXT is serializing, ie. it flushes the
 728                  * whole damn pipeline, we don't need to explicitly mark the
 729                  * object dirty. The only exception is that the context must be
 730                  * correct in case the object gets swapped out. Ideally we'd be
 731                  * able to defer doing this until we know the object would be
 732                  * swapped, but there is no way to do that yet.
 733                  */
 734                 from->obj->dirty = 1;
 735                 BUG_ON(from->obj->ring != ring);
 736
 737                 /* obj is kept alive until the next request by its active ref */
 738                 i915_gem_object_ggtt_unpin(from->obj);
 739                 i915_gem_context_unreference(from);
 740         }
 741
 742         to->is_initialized = true;
 743
 744 done:
 745         i915_gem_context_reference(to);
 746         ring->last_context = to;
 747         to->last_ring = ring;
 748
 749         return 0;
 750
 751 unpin_out:
 752         if (ring->id == RCS)
 753                 i915_gem_object_ggtt_unpin(to->obj);
 754         return ret;
 755 }
 756
 757 /**
 758  * i915_switch_context() - perform a GPU context switch.
 759  * @ring: ring for which we'll execute the context switch
 760  * @file_priv: file_priv associated with the context, may be NULL
 761  * @to: the context to switch to
 762  *
 763  * The context life cycle is simple. The context refcount is incremented and
 764  * decremented by 1 and create and destroy. If the context is in use by the GPU,
 765  * it will have a refoucnt > 1. This allows us to destroy the context abstract
 766  * object while letting the normal object tracking destroy the backing BO.
 767  */
 768 int i915_switch_context(struct intel_ring_buffer *ring,
 769                         struct drm_file *file,
 770                         struct i915_hw_context *to)
 771 {
 772         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 773
 774         WARN_ON(!mutex_is_locked(&dev_priv->dev->struct_mutex));
 775
 776         BUG_ON(file && to == NULL);
 777
 778         /* We have the fake context */
 779         if (!HAS_HW_CONTEXTS(ring->dev)) {
 780                 ring->last_context = to;
 781                 return 0;
 782         }
 783
 784         return do_switch(ring, to);
 785 }
 786
 787 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
 788                                   struct drm_file *file)
 789 {
 790         struct drm_i915_gem_context_create *args = data;
 791         struct drm_i915_file_private *file_priv = file->driver_priv;
 792         struct i915_hw_context *ctx;
 793         int ret;
 794
 795         if (!HAS_HW_CONTEXTS(dev))
 796                 return -ENODEV;
 797
 798         ret = i915_mutex_lock_interruptible(dev);
 799         if (ret)
 800                 return ret;
 801
 802         ctx = i915_gem_create_context(dev, file_priv, USES_FULL_PPGTT(dev));
 803         mutex_unlock(&dev->struct_mutex);
 804         if (IS_ERR(ctx))
 805                 return PTR_ERR(ctx);
 806
 807         args->ctx_id = ctx->id;
 808         DRM_DEBUG_DRIVER("HW context %d created\n", args->ctx_id);
 809
 810         return 0;
 811 }
 812
 813 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
 814                                    struct drm_file *file)
 815 {
 816         struct drm_i915_gem_context_destroy *args = data;
 817         struct drm_i915_file_private *file_priv = file->driver_priv;
 818         struct i915_hw_context *ctx;
 819         int ret;
 820
 821         if (args->ctx_id == DEFAULT_CONTEXT_ID)
 822                 return -ENOENT;
 823
 824         ret = i915_mutex_lock_interruptible(dev);
 825         if (ret)
 826                 return ret;
 827
 828         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 829         if (IS_ERR(ctx)) {
 830                 mutex_unlock(&dev->struct_mutex);
 831                 return PTR_ERR(ctx);
 832         }
 833
 834         idr_remove(&ctx->file_priv->context_idr, ctx->id);
 835         i915_gem_context_unreference(ctx);
 836         mutex_unlock(&dev->struct_mutex);
 837
 838         DRM_DEBUG_DRIVER("HW context %d destroyed\n", args->ctx_id);
 839         return 0;
 840 }