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 #include "i915_trace.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 GEN6_CONTEXT_ALIGN (64<<10)
  98 #define GEN7_CONTEXT_ALIGN 4096
  99
 100 static size_t get_context_alignment(struct drm_device *dev)
 101 {
 102         if (IS_GEN6(dev))
 103                 return GEN6_CONTEXT_ALIGN;
 104
 105         return GEN7_CONTEXT_ALIGN;
 106 }
 107
 108 static int get_context_size(struct drm_device *dev)
 109 {
 110         struct drm_i915_private *dev_priv = dev->dev_private;
 111         int ret;
 112         u32 reg;
 113
 114         switch (INTEL_INFO(dev)->gen) {
 115         case 6:
 116                 reg = I915_READ(CXT_SIZE);
 117                 ret = GEN6_CXT_TOTAL_SIZE(reg) * 64;
 118                 break;
 119         case 7:
 120                 reg = I915_READ(GEN7_CXT_SIZE);
 121                 if (IS_HASWELL(dev))
 122                         ret = HSW_CXT_TOTAL_SIZE;
 123                 else
 124                         ret = GEN7_CXT_TOTAL_SIZE(reg) * 64;
 125                 break;
 126         case 8:
 127                 ret = GEN8_CXT_TOTAL_SIZE;
 128                 break;
 129         default:
 130                 BUG();
 131         }
 132
 133         return ret;
 134 }
 135
 136 void i915_gem_context_free(struct kref *ctx_ref)
 137 {
 138         struct intel_context *ctx = container_of(ctx_ref, typeof(*ctx), ref);
 139
 140         trace_i915_context_free(ctx);
 141
 142         if (i915.enable_execlists)
 143                 intel_lr_context_free(ctx);
 144
 145         i915_ppgtt_put(ctx->ppgtt);
 146
 147         if (ctx->legacy_hw_ctx.rcs_state)
 148                 drm_gem_object_unreference(&ctx->legacy_hw_ctx.rcs_state->base);
 149         list_del(&ctx->link);
 150         kfree(ctx);
 151 }
 152
 153 struct drm_i915_gem_object *
 154 i915_gem_alloc_context_obj(struct drm_device *dev, size_t size)
 155 {
 156         struct drm_i915_gem_object *obj;
 157         int ret;
 158
 159         obj = i915_gem_alloc_object(dev, size);
 160         if (obj == NULL)
 161                 return ERR_PTR(-ENOMEM);
 162
 163         /*
 164          * Try to make the context utilize L3 as well as LLC.
 165          *
 166          * On VLV we don't have L3 controls in the PTEs so we
 167          * shouldn't touch the cache level, especially as that
 168          * would make the object snooped which might have a
 169          * negative performance impact.
 170          */
 171         if (INTEL_INFO(dev)->gen >= 7 && !IS_VALLEYVIEW(dev)) {
 172                 ret = i915_gem_object_set_cache_level(obj, I915_CACHE_L3_LLC);
 173                 /* Failure shouldn't ever happen this early */
 174                 if (WARN_ON(ret)) {
 175                         drm_gem_object_unreference(&obj->base);
 176                         return ERR_PTR(ret);
 177                 }
 178         }
 179
 180         return obj;
 181 }
 182
 183 static struct intel_context *
 184 __create_hw_context(struct drm_device *dev,
 185                     struct drm_i915_file_private *file_priv)
 186 {
 187         struct drm_i915_private *dev_priv = dev->dev_private;
 188         struct intel_context *ctx;
 189         int ret;
 190
 191         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 192         if (ctx == NULL)
 193                 return ERR_PTR(-ENOMEM);
 194
 195         kref_init(&ctx->ref);
 196         list_add_tail(&ctx->link, &dev_priv->context_list);
 197         ctx->i915 = dev_priv;
 198
 199         if (dev_priv->hw_context_size) {
 200                 struct drm_i915_gem_object *obj =
 201                                 i915_gem_alloc_context_obj(dev, dev_priv->hw_context_size);
 202                 if (IS_ERR(obj)) {
 203                         ret = PTR_ERR(obj);
 204                         goto err_out;
 205                 }
 206                 ctx->legacy_hw_ctx.rcs_state = obj;
 207         }
 208
 209         /* Default context will never have a file_priv */
 210         if (file_priv != NULL) {
 211                 ret = idr_alloc(&file_priv->context_idr, ctx,
 212                                 DEFAULT_CONTEXT_HANDLE, 0, GFP_KERNEL);
 213                 if (ret < 0)
 214                         goto err_out;
 215         } else
 216                 ret = DEFAULT_CONTEXT_HANDLE;
 217
 218         ctx->file_priv = file_priv;
 219         ctx->user_handle = ret;
 220         /* NB: Mark all slices as needing a remap so that when the context first
 221          * loads it will restore whatever remap state already exists. If there
 222          * is no remap info, it will be a NOP. */
 223         ctx->remap_slice = (1 << NUM_L3_SLICES(dev)) - 1;
 224
 225         ctx->hang_stats.ban_period_seconds = DRM_I915_CTX_BAN_PERIOD;
 226
 227         return ctx;
 228
 229 err_out:
 230         i915_gem_context_unreference(ctx);
 231         return ERR_PTR(ret);
 232 }
 233
 234 /**
 235  * The default context needs to exist per ring that uses contexts. It stores the
 236  * context state of the GPU for applications that don't utilize HW contexts, as
 237  * well as an idle case.
 238  */
 239 static struct intel_context *
 240 i915_gem_create_context(struct drm_device *dev,
 241                         struct drm_i915_file_private *file_priv)
 242 {
 243         const bool is_global_default_ctx = file_priv == NULL;
 244         struct intel_context *ctx;
 245         int ret = 0;
 246
 247         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
 248
 249         ctx = __create_hw_context(dev, file_priv);
 250         if (IS_ERR(ctx))
 251                 return ctx;
 252
 253         if (is_global_default_ctx && ctx->legacy_hw_ctx.rcs_state) {
 254                 /* We may need to do things with the shrinker which
 255                  * require us to immediately switch back to the default
 256                  * context. This can cause a problem as pinning the
 257                  * default context also requires GTT space which may not
 258                  * be available. To avoid this we always pin the default
 259                  * context.
 260                  */
 261                 ret = i915_gem_obj_ggtt_pin(ctx->legacy_hw_ctx.rcs_state,
 262                                             get_context_alignment(dev), 0);
 263                 if (ret) {
 264                         DRM_DEBUG_DRIVER("Couldn't pin %d\n", ret);
 265                         goto err_destroy;
 266                 }
 267         }
 268
 269         if (USES_FULL_PPGTT(dev)) {
 270                 struct i915_hw_ppgtt *ppgtt = i915_ppgtt_create(dev, file_priv);
 271
 272                 if (IS_ERR_OR_NULL(ppgtt)) {
 273                         DRM_DEBUG_DRIVER("PPGTT setup failed (%ld)\n",
 274                                          PTR_ERR(ppgtt));
 275                         ret = PTR_ERR(ppgtt);
 276                         goto err_unpin;
 277                 }
 278
 279                 ctx->ppgtt = ppgtt;
 280         }
 281
 282         trace_i915_context_create(ctx);
 283
 284         return ctx;
 285
 286 err_unpin:
 287         if (is_global_default_ctx && ctx->legacy_hw_ctx.rcs_state)
 288                 i915_gem_object_ggtt_unpin(ctx->legacy_hw_ctx.rcs_state);
 289 err_destroy:
 290         i915_gem_context_unreference(ctx);
 291         return ERR_PTR(ret);
 292 }
 293
 294 void i915_gem_context_reset(struct drm_device *dev)
 295 {
 296         struct drm_i915_private *dev_priv = dev->dev_private;
 297         int i;
 298
 299         if (i915.enable_execlists) {
 300                 struct intel_context *ctx;
 301
 302                 list_for_each_entry(ctx, &dev_priv->context_list, link) {
 303                         intel_lr_context_reset(dev, ctx);
 304                 }
 305
 306                 return;
 307         }
 308
 309         for (i = 0; i < I915_NUM_RINGS; i++) {
 310                 struct intel_engine_cs *ring = &dev_priv->ring[i];
 311                 struct intel_context *lctx = ring->last_context;
 312
 313                 if (lctx) {
 314                         if (lctx->legacy_hw_ctx.rcs_state && i == RCS)
 315                                 i915_gem_object_ggtt_unpin(lctx->legacy_hw_ctx.rcs_state);
 316
 317                         i915_gem_context_unreference(lctx);
 318                         ring->last_context = NULL;
 319                 }
 320         }
 321 }
 322
 323 int i915_gem_context_init(struct drm_device *dev)
 324 {
 325         struct drm_i915_private *dev_priv = dev->dev_private;
 326         struct intel_context *ctx;
 327         int i;
 328
 329         /* Init should only be called once per module load. Eventually the
 330          * restriction on the context_disabled check can be loosened. */
 331         if (WARN_ON(dev_priv->ring[RCS].default_context))
 332                 return 0;
 333
 334         if (i915.enable_execlists) {
 335                 /* NB: intentionally left blank. We will allocate our own
 336                  * backing objects as we need them, thank you very much */
 337                 dev_priv->hw_context_size = 0;
 338         } else if (HAS_HW_CONTEXTS(dev)) {
 339                 dev_priv->hw_context_size = round_up(get_context_size(dev), 4096);
 340                 if (dev_priv->hw_context_size > (1<<20)) {
 341                         DRM_DEBUG_DRIVER("Disabling HW Contexts; invalid size %d\n",
 342                                          dev_priv->hw_context_size);
 343                         dev_priv->hw_context_size = 0;
 344                 }
 345         }
 346
 347         ctx = i915_gem_create_context(dev, NULL);
 348         if (IS_ERR(ctx)) {
 349                 DRM_ERROR("Failed to create default global context (error %ld)\n",
 350                           PTR_ERR(ctx));
 351                 return PTR_ERR(ctx);
 352         }
 353
 354         for (i = 0; i < I915_NUM_RINGS; i++) {
 355                 struct intel_engine_cs *ring = &dev_priv->ring[i];
 356
 357                 /* NB: RCS will hold a ref for all rings */
 358                 ring->default_context = ctx;
 359         }
 360
 361         DRM_DEBUG_DRIVER("%s context support initialized\n",
 362                         i915.enable_execlists ? "LR" :
 363                         dev_priv->hw_context_size ? "HW" : "fake");
 364         return 0;
 365 }
 366
 367 void i915_gem_context_fini(struct drm_device *dev)
 368 {
 369         struct drm_i915_private *dev_priv = dev->dev_private;
 370         struct intel_context *dctx = dev_priv->ring[RCS].default_context;
 371         int i;
 372
 373         if (dctx->legacy_hw_ctx.rcs_state) {
 374                 /* The only known way to stop the gpu from accessing the hw context is
 375                  * to reset it. Do this as the very last operation to avoid confusing
 376                  * other code, leading to spurious errors. */
 377                 intel_gpu_reset(dev);
 378
 379                 /* When default context is created and switched to, base object refcount
 380                  * will be 2 (+1 from object creation and +1 from do_switch()).
 381                  * i915_gem_context_fini() will be called after gpu_idle() has switched
 382                  * to default context. So we need to unreference the base object once
 383                  * to offset the do_switch part, so that i915_gem_context_unreference()
 384                  * can then free the base object correctly. */
 385                 WARN_ON(!dev_priv->ring[RCS].last_context);
 386                 if (dev_priv->ring[RCS].last_context == dctx) {
 387                         /* Fake switch to NULL context */
 388                         WARN_ON(dctx->legacy_hw_ctx.rcs_state->active);
 389                         i915_gem_object_ggtt_unpin(dctx->legacy_hw_ctx.rcs_state);
 390                         i915_gem_context_unreference(dctx);
 391                         dev_priv->ring[RCS].last_context = NULL;
 392                 }
 393
 394                 i915_gem_object_ggtt_unpin(dctx->legacy_hw_ctx.rcs_state);
 395         }
 396
 397         for (i = 0; i < I915_NUM_RINGS; i++) {
 398                 struct intel_engine_cs *ring = &dev_priv->ring[i];
 399
 400                 if (ring->last_context)
 401                         i915_gem_context_unreference(ring->last_context);
 402
 403                 ring->default_context = NULL;
 404                 ring->last_context = NULL;
 405         }
 406
 407         i915_gem_context_unreference(dctx);
 408 }
 409
 410 int i915_gem_context_enable(struct drm_i915_gem_request *req)
 411 {
 412         struct intel_engine_cs *ring = req->ring;
 413         int ret;
 414
 415         if (i915.enable_execlists) {
 416                 if (ring->init_context == NULL)
 417                         return 0;
 418
 419                 ret = ring->init_context(req);
 420         } else
 421                 ret = i915_switch_context(req);
 422
 423         if (ret) {
 424                 DRM_ERROR("ring init context: %d\n", ret);
 425                 return ret;
 426         }
 427
 428         return 0;
 429 }
 430
 431 static int context_idr_cleanup(int id, void *p, void *data)
 432 {
 433         struct intel_context *ctx = p;
 434
 435         i915_gem_context_unreference(ctx);
 436         return 0;
 437 }
 438
 439 int i915_gem_context_open(struct drm_device *dev, struct drm_file *file)
 440 {
 441         struct drm_i915_file_private *file_priv = file->driver_priv;
 442         struct intel_context *ctx;
 443
 444         idr_init(&file_priv->context_idr);
 445
 446         mutex_lock(&dev->struct_mutex);
 447         ctx = i915_gem_create_context(dev, file_priv);
 448         mutex_unlock(&dev->struct_mutex);
 449
 450         if (IS_ERR(ctx)) {
 451                 idr_destroy(&file_priv->context_idr);
 452                 return PTR_ERR(ctx);
 453         }
 454
 455         return 0;
 456 }
 457
 458 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file)
 459 {
 460         struct drm_i915_file_private *file_priv = file->driver_priv;
 461
 462         idr_for_each(&file_priv->context_idr, context_idr_cleanup, NULL);
 463         idr_destroy(&file_priv->context_idr);
 464 }
 465
 466 struct intel_context *
 467 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id)
 468 {
 469         struct intel_context *ctx;
 470
 471         ctx = (struct intel_context *)idr_find(&file_priv->context_idr, id);
 472         if (!ctx)
 473                 return ERR_PTR(-ENOENT);
 474
 475         return ctx;
 476 }
 477
 478 static inline int
 479 mi_set_context(struct drm_i915_gem_request *req, u32 hw_flags)
 480 {
 481         struct intel_engine_cs *ring = req->ring;
 482         u32 flags = hw_flags | MI_MM_SPACE_GTT;
 483         const int num_rings =
 484                 /* Use an extended w/a on ivb+ if signalling from other rings */
 485                 i915_semaphore_is_enabled(ring->dev) ?
 486                 hweight32(INTEL_INFO(ring->dev)->ring_mask) - 1 :
 487                 0;
 488         int len, i, ret;
 489
 490         /* w/a: If Flush TLB Invalidation Mode is enabled, driver must do a TLB
 491          * invalidation prior to MI_SET_CONTEXT. On GEN6 we don't set the value
 492          * explicitly, so we rely on the value at ring init, stored in
 493          * itlb_before_ctx_switch.
 494          */
 495         if (IS_GEN6(ring->dev)) {
 496                 ret = ring->flush(req, I915_GEM_GPU_DOMAINS, 0);
 497                 if (ret)
 498                         return ret;
 499         }
 500
 501         /* These flags are for resource streamer on HSW+ */
 502         if (IS_HASWELL(ring->dev) || INTEL_INFO(ring->dev)->gen >= 8)
 503                 flags |= (HSW_MI_RS_SAVE_STATE_EN | HSW_MI_RS_RESTORE_STATE_EN);
 504         else if (INTEL_INFO(ring->dev)->gen < 8)
 505                 flags |= (MI_SAVE_EXT_STATE_EN | MI_RESTORE_EXT_STATE_EN);
 506
 507
 508         len = 4;
 509         if (INTEL_INFO(ring->dev)->gen >= 7)
 510                 len += 2 + (num_rings ? 4*num_rings + 2 : 0);
 511
 512         ret = intel_ring_begin(req, len);
 513         if (ret)
 514                 return ret;
 515
 516         /* WaProgramMiArbOnOffAroundMiSetContext:ivb,vlv,hsw,bdw,chv */
 517         if (INTEL_INFO(ring->dev)->gen >= 7) {
 518                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_DISABLE);
 519                 if (num_rings) {
 520                         struct intel_engine_cs *signaller;
 521
 522                         intel_ring_emit(ring, MI_LOAD_REGISTER_IMM(num_rings));
 523                         for_each_ring(signaller, to_i915(ring->dev), i) {
 524                                 if (signaller == ring)
 525                                         continue;
 526
 527                                 intel_ring_emit(ring, RING_PSMI_CTL(signaller->mmio_base));
 528                                 intel_ring_emit(ring, _MASKED_BIT_ENABLE(GEN6_PSMI_SLEEP_MSG_DISABLE));
 529                         }
 530                 }
 531         }
 532
 533         intel_ring_emit(ring, MI_NOOP);
 534         intel_ring_emit(ring, MI_SET_CONTEXT);
 535         intel_ring_emit(ring, i915_gem_obj_ggtt_offset(req->ctx->legacy_hw_ctx.rcs_state) |
 536                         flags);
 537         /*
 538          * w/a: MI_SET_CONTEXT must always be followed by MI_NOOP
 539          * WaMiSetContext_Hang:snb,ivb,vlv
 540          */
 541         intel_ring_emit(ring, MI_NOOP);
 542
 543         if (INTEL_INFO(ring->dev)->gen >= 7) {
 544                 if (num_rings) {
 545                         struct intel_engine_cs *signaller;
 546
 547                         intel_ring_emit(ring, MI_LOAD_REGISTER_IMM(num_rings));
 548                         for_each_ring(signaller, to_i915(ring->dev), i) {
 549                                 if (signaller == ring)
 550                                         continue;
 551
 552                                 intel_ring_emit(ring, RING_PSMI_CTL(signaller->mmio_base));
 553                                 intel_ring_emit(ring, _MASKED_BIT_DISABLE(GEN6_PSMI_SLEEP_MSG_DISABLE));
 554                         }
 555                 }
 556                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_ENABLE);
 557         }
 558
 559         intel_ring_advance(ring);
 560
 561         return ret;
 562 }
 563
 564 static inline bool should_skip_switch(struct intel_engine_cs *ring,
 565                                       struct intel_context *from,
 566                                       struct intel_context *to)
 567 {
 568         if (to->remap_slice)
 569                 return false;
 570
 571         if (to->ppgtt && from == to &&
 572             !(intel_ring_flag(ring) & to->ppgtt->pd_dirty_rings))
 573                 return true;
 574
 575         return false;
 576 }
 577
 578 static bool
 579 needs_pd_load_pre(struct intel_engine_cs *ring, struct intel_context *to)
 580 {
 581         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 582
 583         if (!to->ppgtt)
 584                 return false;
 585
 586         if (INTEL_INFO(ring->dev)->gen < 8)
 587                 return true;
 588
 589         if (ring != &dev_priv->ring[RCS])
 590                 return true;
 591
 592         return false;
 593 }
 594
 595 static bool
 596 needs_pd_load_post(struct intel_engine_cs *ring, struct intel_context *to,
 597                 u32 hw_flags)
 598 {
 599         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 600
 601         if (!to->ppgtt)
 602                 return false;
 603
 604         if (!IS_GEN8(ring->dev))
 605                 return false;
 606
 607         if (ring != &dev_priv->ring[RCS])
 608                 return false;
 609
 610         if (hw_flags & MI_RESTORE_INHIBIT)
 611                 return true;
 612
 613         return false;
 614 }
 615
 616 static int do_switch(struct drm_i915_gem_request *req)
 617 {
 618         struct intel_context *to = req->ctx;
 619         struct intel_engine_cs *ring = req->ring;
 620         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 621         struct intel_context *from = ring->last_context;
 622         u32 hw_flags = 0;
 623         bool uninitialized = false;
 624         int ret, i;
 625
 626         if (from != NULL && ring == &dev_priv->ring[RCS]) {
 627                 BUG_ON(from->legacy_hw_ctx.rcs_state == NULL);
 628                 BUG_ON(!i915_gem_obj_is_pinned(from->legacy_hw_ctx.rcs_state));
 629         }
 630
 631         if (should_skip_switch(ring, from, to))
 632                 return 0;
 633
 634         /* Trying to pin first makes error handling easier. */
 635         if (ring == &dev_priv->ring[RCS]) {
 636                 ret = i915_gem_obj_ggtt_pin(to->legacy_hw_ctx.rcs_state,
 637                                             get_context_alignment(ring->dev), 0);
 638                 if (ret)
 639                         return ret;
 640         }
 641
 642         /*
 643          * Pin can switch back to the default context if we end up calling into
 644          * evict_everything - as a last ditch gtt defrag effort that also
 645          * switches to the default context. Hence we need to reload from here.
 646          */
 647         from = ring->last_context;
 648
 649         if (needs_pd_load_pre(ring, to)) {
 650                 /* Older GENs and non render rings still want the load first,
 651                  * "PP_DCLV followed by PP_DIR_BASE register through Load
 652                  * Register Immediate commands in Ring Buffer before submitting
 653                  * a context."*/
 654                 trace_switch_mm(ring, to);
 655                 ret = to->ppgtt->switch_mm(to->ppgtt, req);
 656                 if (ret)
 657                         goto unpin_out;
 658
 659                 /* Doing a PD load always reloads the page dirs */
 660                 to->ppgtt->pd_dirty_rings &= ~intel_ring_flag(ring);
 661         }
 662
 663         if (ring != &dev_priv->ring[RCS]) {
 664                 if (from)
 665                         i915_gem_context_unreference(from);
 666                 goto done;
 667         }
 668
 669         /*
 670          * Clear this page out of any CPU caches for coherent swap-in/out. Note
 671          * that thanks to write = false in this call and us not setting any gpu
 672          * write domains when putting a context object onto the active list
 673          * (when switching away from it), this won't block.
 674          *
 675          * XXX: We need a real interface to do this instead of trickery.
 676          */
 677         ret = i915_gem_object_set_to_gtt_domain(to->legacy_hw_ctx.rcs_state, false);
 678         if (ret)
 679                 goto unpin_out;
 680
 681         if (!to->legacy_hw_ctx.initialized) {
 682                 hw_flags |= MI_RESTORE_INHIBIT;
 683                 /* NB: If we inhibit the restore, the context is not allowed to
 684                  * die because future work may end up depending on valid address
 685                  * space. This means we must enforce that a page table load
 686                  * occur when this occurs. */
 687         } else if (to->ppgtt &&
 688                    (intel_ring_flag(ring) & to->ppgtt->pd_dirty_rings)) {
 689                 hw_flags |= MI_FORCE_RESTORE;
 690                 to->ppgtt->pd_dirty_rings &= ~intel_ring_flag(ring);
 691         }
 692
 693         /* We should never emit switch_mm more than once */
 694         WARN_ON(needs_pd_load_pre(ring, to) &&
 695                 needs_pd_load_post(ring, to, hw_flags));
 696
 697         ret = mi_set_context(req, hw_flags);
 698         if (ret)
 699                 goto unpin_out;
 700
 701         /* GEN8 does *not* require an explicit reload if the PDPs have been
 702          * setup, and we do not wish to move them.
 703          */
 704         if (needs_pd_load_post(ring, to, hw_flags)) {
 705                 trace_switch_mm(ring, to);
 706                 ret = to->ppgtt->switch_mm(to->ppgtt, req);
 707                 /* The hardware context switch is emitted, but we haven't
 708                  * actually changed the state - so it's probably safe to bail
 709                  * here. Still, let the user know something dangerous has
 710                  * happened.
 711                  */
 712                 if (ret) {
 713                         DRM_ERROR("Failed to change address space on context switch\n");
 714                         goto unpin_out;
 715                 }
 716         }
 717
 718         for (i = 0; i < MAX_L3_SLICES; i++) {
 719                 if (!(to->remap_slice & (1<<i)))
 720                         continue;
 721
 722                 ret = i915_gem_l3_remap(req, i);
 723                 /* If it failed, try again next round */
 724                 if (ret)
 725                         DRM_DEBUG_DRIVER("L3 remapping failed\n");
 726                 else
 727                         to->remap_slice &= ~(1<<i);
 728         }
 729
 730         /* The backing object for the context is done after switching to the
 731          * *next* context. Therefore we cannot retire the previous context until
 732          * the next context has already started running. In fact, the below code
 733          * is a bit suboptimal because the retiring can occur simply after the
 734          * MI_SET_CONTEXT instead of when the next seqno has completed.
 735          */
 736         if (from != NULL) {
 737                 from->legacy_hw_ctx.rcs_state->base.read_domains = I915_GEM_DOMAIN_INSTRUCTION;
 738                 i915_vma_move_to_active(i915_gem_obj_to_ggtt(from->legacy_hw_ctx.rcs_state), req);
 739                 /* As long as MI_SET_CONTEXT is serializing, ie. it flushes the
 740                  * whole damn pipeline, we don't need to explicitly mark the
 741                  * object dirty. The only exception is that the context must be
 742                  * correct in case the object gets swapped out. Ideally we'd be
 743                  * able to defer doing this until we know the object would be
 744                  * swapped, but there is no way to do that yet.
 745                  */
 746                 from->legacy_hw_ctx.rcs_state->dirty = 1;
 747
 748                 /* obj is kept alive until the next request by its active ref */
 749                 i915_gem_object_ggtt_unpin(from->legacy_hw_ctx.rcs_state);
 750                 i915_gem_context_unreference(from);
 751         }
 752
 753         uninitialized = !to->legacy_hw_ctx.initialized;
 754         to->legacy_hw_ctx.initialized = true;
 755
 756 done:
 757         i915_gem_context_reference(to);
 758         ring->last_context = to;
 759
 760         if (uninitialized) {
 761                 if (ring->init_context) {
 762                         ret = ring->init_context(req);
 763                         if (ret)
 764                                 DRM_ERROR("ring init context: %d\n", ret);
 765                 }
 766         }
 767
 768         return 0;
 769
 770 unpin_out:
 771         if (ring->id == RCS)
 772                 i915_gem_object_ggtt_unpin(to->legacy_hw_ctx.rcs_state);
 773         return ret;
 774 }
 775
 776 /**
 777  * i915_switch_context() - perform a GPU context switch.
 778  * @req: request for which we'll execute the context switch
 779  *
 780  * The context life cycle is simple. The context refcount is incremented and
 781  * decremented by 1 and create and destroy. If the context is in use by the GPU,
 782  * it will have a refcount > 1. This allows us to destroy the context abstract
 783  * object while letting the normal object tracking destroy the backing BO.
 784  *
 785  * This function should not be used in execlists mode.  Instead the context is
 786  * switched by writing to the ELSP and requests keep a reference to their
 787  * context.
 788  */
 789 int i915_switch_context(struct drm_i915_gem_request *req)
 790 {
 791         struct intel_engine_cs *ring = req->ring;
 792         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 793
 794         WARN_ON(i915.enable_execlists);
 795         WARN_ON(!mutex_is_locked(&dev_priv->dev->struct_mutex));
 796
 797         if (req->ctx->legacy_hw_ctx.rcs_state == NULL) { /* We have the fake context */
 798                 if (req->ctx != ring->last_context) {
 799                         i915_gem_context_reference(req->ctx);
 800                         if (ring->last_context)
 801                                 i915_gem_context_unreference(ring->last_context);
 802                         ring->last_context = req->ctx;
 803                 }
 804                 return 0;
 805         }
 806
 807         return do_switch(req);
 808 }
 809
 810 static bool contexts_enabled(struct drm_device *dev)
 811 {
 812         return i915.enable_execlists || to_i915(dev)->hw_context_size;
 813 }
 814
 815 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
 816                                   struct drm_file *file)
 817 {
 818         struct drm_i915_gem_context_create *args = data;
 819         struct drm_i915_file_private *file_priv = file->driver_priv;
 820         struct intel_context *ctx;
 821         int ret;
 822
 823         if (!contexts_enabled(dev))
 824                 return -ENODEV;
 825
 826         ret = i915_mutex_lock_interruptible(dev);
 827         if (ret)
 828                 return ret;
 829
 830         ctx = i915_gem_create_context(dev, file_priv);
 831         mutex_unlock(&dev->struct_mutex);
 832         if (IS_ERR(ctx))
 833                 return PTR_ERR(ctx);
 834
 835         args->ctx_id = ctx->user_handle;
 836         DRM_DEBUG_DRIVER("HW context %d created\n", args->ctx_id);
 837
 838         return 0;
 839 }
 840
 841 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
 842                                    struct drm_file *file)
 843 {
 844         struct drm_i915_gem_context_destroy *args = data;
 845         struct drm_i915_file_private *file_priv = file->driver_priv;
 846         struct intel_context *ctx;
 847         int ret;
 848
 849         if (args->ctx_id == DEFAULT_CONTEXT_HANDLE)
 850                 return -ENOENT;
 851
 852         ret = i915_mutex_lock_interruptible(dev);
 853         if (ret)
 854                 return ret;
 855
 856         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 857         if (IS_ERR(ctx)) {
 858                 mutex_unlock(&dev->struct_mutex);
 859                 return PTR_ERR(ctx);
 860         }
 861
 862         idr_remove(&ctx->file_priv->context_idr, ctx->user_handle);
 863         i915_gem_context_unreference(ctx);
 864         mutex_unlock(&dev->struct_mutex);
 865
 866         DRM_DEBUG_DRIVER("HW context %d destroyed\n", args->ctx_id);
 867         return 0;
 868 }
 869
 870 int i915_gem_context_getparam_ioctl(struct drm_device *dev, void *data,
 871                                     struct drm_file *file)
 872 {
 873         struct drm_i915_file_private *file_priv = file->driver_priv;
 874         struct drm_i915_gem_context_param *args = data;
 875         struct intel_context *ctx;
 876         int ret;
 877
 878         ret = i915_mutex_lock_interruptible(dev);
 879         if (ret)
 880                 return ret;
 881
 882         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 883         if (IS_ERR(ctx)) {
 884                 mutex_unlock(&dev->struct_mutex);
 885                 return PTR_ERR(ctx);
 886         }
 887
 888         args->size = 0;
 889         switch (args->param) {
 890         case I915_CONTEXT_PARAM_BAN_PERIOD:
 891                 args->value = ctx->hang_stats.ban_period_seconds;
 892                 break;
 893         case I915_CONTEXT_PARAM_NO_ZEROMAP:
 894                 args->value = ctx->flags & CONTEXT_NO_ZEROMAP;
 895                 break;
 896         default:
 897                 ret = -EINVAL;
 898                 break;
 899         }
 900         mutex_unlock(&dev->struct_mutex);
 901
 902         return ret;
 903 }
 904
 905 int i915_gem_context_setparam_ioctl(struct drm_device *dev, void *data,
 906                                     struct drm_file *file)
 907 {
 908         struct drm_i915_file_private *file_priv = file->driver_priv;
 909         struct drm_i915_gem_context_param *args = data;
 910         struct intel_context *ctx;
 911         int ret;
 912
 913         ret = i915_mutex_lock_interruptible(dev);
 914         if (ret)
 915                 return ret;
 916
 917         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 918         if (IS_ERR(ctx)) {
 919                 mutex_unlock(&dev->struct_mutex);
 920                 return PTR_ERR(ctx);
 921         }
 922
 923         switch (args->param) {
 924         case I915_CONTEXT_PARAM_BAN_PERIOD:
 925                 if (args->size)
 926                         ret = -EINVAL;
 927                 else if (args->value < ctx->hang_stats.ban_period_seconds &&
 928                          !capable(CAP_SYS_ADMIN))
 929                         ret = -EPERM;
 930                 else
 931                         ctx->hang_stats.ban_period_seconds = args->value;
 932                 break;
 933         case I915_CONTEXT_PARAM_NO_ZEROMAP:
 934                 if (args->size) {
 935                         ret = -EINVAL;
 936                 } else {
 937                         ctx->flags &= ~CONTEXT_NO_ZEROMAP;
 938                         ctx->flags |= args->value ? CONTEXT_NO_ZEROMAP : 0;
 939                 }
 940                 break;
 941         default:
 942                 ret = -EINVAL;
 943                 break;
 944         }
 945         mutex_unlock(&dev->struct_mutex);
 946
 947         return ret;
 948 }