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