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 <linux/log2.h>
  89 #include <drm/drmP.h>
  90 #include <drm/i915_drm.h>
  91 #include "i915_drv.h"
  92 #include "i915_trace.h"
  93
  94 #define ALL_L3_SLICES(dev) (1 << NUM_L3_SLICES(dev)) - 1
  95
  96 /* Initial size (as log2) to preallocate the handle->object hashtable */
  97 #define VMA_HT_BITS 2u /* 4 x 2 pointers, 64 bytes minimum */
  98
  99 static void resize_vma_ht(struct work_struct *work)
 100 {
 101         struct i915_gem_context_vma_lut *lut =
 102                 container_of(work, typeof(*lut), resize);
 103         unsigned int bits, new_bits, size, i;
 104         struct hlist_head *new_ht;
 105
 106         GEM_BUG_ON(!(lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS));
 107
 108         bits = 1 + ilog2(4*lut->ht_count/3 + 1);
 109         new_bits = min_t(unsigned int,
 110                          max(bits, VMA_HT_BITS),
 111                          sizeof(unsigned int) * BITS_PER_BYTE - 1);
 112         if (new_bits == lut->ht_bits)
 113                 goto out;
 114
 115         new_ht = kzalloc(sizeof(*new_ht)<<new_bits, GFP_KERNEL | __GFP_NOWARN);
 116         if (!new_ht)
 117                 new_ht = vzalloc(sizeof(*new_ht)<<new_bits);
 118         if (!new_ht)
 119                 /* Pretend resize succeeded and stop calling us for a bit! */
 120                 goto out;
 121
 122         size = BIT(lut->ht_bits);
 123         for (i = 0; i < size; i++) {
 124                 struct i915_vma *vma;
 125                 struct hlist_node *tmp;
 126
 127                 hlist_for_each_entry_safe(vma, tmp, &lut->ht[i], ctx_node)
 128                         hlist_add_head(&vma->ctx_node,
 129                                        &new_ht[hash_32(vma->ctx_handle,
 130                                                        new_bits)]);
 131         }
 132         kvfree(lut->ht);
 133         lut->ht = new_ht;
 134         lut->ht_bits = new_bits;
 135 out:
 136         smp_store_release(&lut->ht_size, BIT(bits));
 137         GEM_BUG_ON(lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS);
 138 }
 139
 140 static void vma_lut_free(struct i915_gem_context *ctx)
 141 {
 142         struct i915_gem_context_vma_lut *lut = &ctx->vma_lut;
 143         unsigned int i, size;
 144
 145         if (lut->ht_size & I915_CTX_RESIZE_IN_PROGRESS)
 146                 cancel_work_sync(&lut->resize);
 147
 148         size = BIT(lut->ht_bits);
 149         for (i = 0; i < size; i++) {
 150                 struct i915_vma *vma;
 151
 152                 hlist_for_each_entry(vma, &lut->ht[i], ctx_node) {
 153                         vma->obj->vma_hashed = NULL;
 154                         vma->ctx = NULL;
 155                 }
 156         }
 157         kvfree(lut->ht);
 158 }
 159
 160 void i915_gem_context_free(struct kref *ctx_ref)
 161 {
 162         struct i915_gem_context *ctx = container_of(ctx_ref, typeof(*ctx), ref);
 163         int i;
 164
 165         lockdep_assert_held(&ctx->i915->drm.struct_mutex);
 166         trace_i915_context_free(ctx);
 167         GEM_BUG_ON(!i915_gem_context_is_closed(ctx));
 168
 169         vma_lut_free(ctx);
 170         i915_ppgtt_put(ctx->ppgtt);
 171
 172         for (i = 0; i < I915_NUM_ENGINES; i++) {
 173                 struct intel_context *ce = &ctx->engine[i];
 174
 175                 if (!ce->state)
 176                         continue;
 177
 178                 WARN_ON(ce->pin_count);
 179                 if (ce->ring)
 180                         intel_ring_free(ce->ring);
 181
 182                 __i915_gem_object_release_unless_active(ce->state->obj);
 183         }
 184
 185         kfree(ctx->name);
 186         put_pid(ctx->pid);
 187
 188         list_del(&ctx->link);
 189
 190         ida_simple_remove(&ctx->i915->context_hw_ida, ctx->hw_id);
 191         kfree(ctx);
 192 }
 193
 194 static void context_close(struct i915_gem_context *ctx)
 195 {
 196         i915_gem_context_set_closed(ctx);
 197         if (ctx->ppgtt)
 198                 i915_ppgtt_close(&ctx->ppgtt->base);
 199         ctx->file_priv = ERR_PTR(-EBADF);
 200         i915_gem_context_put(ctx);
 201 }
 202
 203 static int assign_hw_id(struct drm_i915_private *dev_priv, unsigned *out)
 204 {
 205         int ret;
 206
 207         ret = ida_simple_get(&dev_priv->context_hw_ida,
 208                              0, MAX_CONTEXT_HW_ID, GFP_KERNEL);
 209         if (ret < 0) {
 210                 /* Contexts are only released when no longer active.
 211                  * Flush any pending retires to hopefully release some
 212                  * stale contexts and try again.
 213                  */
 214                 i915_gem_retire_requests(dev_priv);
 215                 ret = ida_simple_get(&dev_priv->context_hw_ida,
 216                                      0, MAX_CONTEXT_HW_ID, GFP_KERNEL);
 217                 if (ret < 0)
 218                         return ret;
 219         }
 220
 221         *out = ret;
 222         return 0;
 223 }
 224
 225 static u32 default_desc_template(const struct drm_i915_private *i915,
 226                                  const struct i915_hw_ppgtt *ppgtt)
 227 {
 228         u32 address_mode;
 229         u32 desc;
 230
 231         desc = GEN8_CTX_VALID | GEN8_CTX_PRIVILEGE;
 232
 233         address_mode = INTEL_LEGACY_32B_CONTEXT;
 234         if (ppgtt && i915_vm_is_48bit(&ppgtt->base))
 235                 address_mode = INTEL_LEGACY_64B_CONTEXT;
 236         desc |= address_mode << GEN8_CTX_ADDRESSING_MODE_SHIFT;
 237
 238         if (IS_GEN8(i915))
 239                 desc |= GEN8_CTX_L3LLC_COHERENT;
 240
 241         /* TODO: WaDisableLiteRestore when we start using semaphore
 242          * signalling between Command Streamers
 243          * ring->ctx_desc_template |= GEN8_CTX_FORCE_RESTORE;
 244          */
 245
 246         return desc;
 247 }
 248
 249 static struct i915_gem_context *
 250 __create_hw_context(struct drm_i915_private *dev_priv,
 251                     struct drm_i915_file_private *file_priv)
 252 {
 253         struct i915_gem_context *ctx;
 254         int ret;
 255
 256         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 257         if (ctx == NULL)
 258                 return ERR_PTR(-ENOMEM);
 259
 260         ret = assign_hw_id(dev_priv, &ctx->hw_id);
 261         if (ret) {
 262                 kfree(ctx);
 263                 return ERR_PTR(ret);
 264         }
 265
 266         kref_init(&ctx->ref);
 267         list_add_tail(&ctx->link, &dev_priv->context_list);
 268         ctx->i915 = dev_priv;
 269         ctx->priority = I915_PRIORITY_NORMAL;
 270
 271         ctx->vma_lut.ht_bits = VMA_HT_BITS;
 272         ctx->vma_lut.ht_size = BIT(VMA_HT_BITS);
 273         BUILD_BUG_ON(BIT(VMA_HT_BITS) == I915_CTX_RESIZE_IN_PROGRESS);
 274         ctx->vma_lut.ht = kcalloc(ctx->vma_lut.ht_size,
 275                                   sizeof(*ctx->vma_lut.ht),
 276                                   GFP_KERNEL);
 277         if (!ctx->vma_lut.ht)
 278                 goto err_out;
 279
 280         INIT_WORK(&ctx->vma_lut.resize, resize_vma_ht);
 281
 282         /* Default context will never have a file_priv */
 283         ret = DEFAULT_CONTEXT_HANDLE;
 284         if (file_priv) {
 285                 ret = idr_alloc(&file_priv->context_idr, ctx,
 286                                 DEFAULT_CONTEXT_HANDLE, 0, GFP_KERNEL);
 287                 if (ret < 0)
 288                         goto err_lut;
 289         }
 290         ctx->user_handle = ret;
 291
 292         ctx->file_priv = file_priv;
 293         if (file_priv) {
 294                 ctx->pid = get_task_pid(current, PIDTYPE_PID);
 295                 ctx->name = kasprintf(GFP_KERNEL, "%s[%d]/%x",
 296                                       current->comm,
 297                                       pid_nr(ctx->pid),
 298                                       ctx->user_handle);
 299                 if (!ctx->name) {
 300                         ret = -ENOMEM;
 301                         goto err_pid;
 302                 }
 303         }
 304
 305         /* NB: Mark all slices as needing a remap so that when the context first
 306          * loads it will restore whatever remap state already exists. If there
 307          * is no remap info, it will be a NOP. */
 308         ctx->remap_slice = ALL_L3_SLICES(dev_priv);
 309
 310         i915_gem_context_set_bannable(ctx);
 311         ctx->ring_size = 4 * PAGE_SIZE;
 312         ctx->desc_template =
 313                 default_desc_template(dev_priv, dev_priv->mm.aliasing_ppgtt);
 314
 315         /* GuC requires the ring to be placed above GUC_WOPCM_TOP. If GuC is not
 316          * present or not in use we still need a small bias as ring wraparound
 317          * at offset 0 sometimes hangs. No idea why.
 318          */
 319         if (HAS_GUC(dev_priv) && i915.enable_guc_loading)
 320                 ctx->ggtt_offset_bias = GUC_WOPCM_TOP;
 321         else
 322                 ctx->ggtt_offset_bias = I915_GTT_PAGE_SIZE;
 323
 324         return ctx;
 325
 326 err_pid:
 327         put_pid(ctx->pid);
 328         idr_remove(&file_priv->context_idr, ctx->user_handle);
 329 err_lut:
 330         kvfree(ctx->vma_lut.ht);
 331 err_out:
 332         context_close(ctx);
 333         return ERR_PTR(ret);
 334 }
 335
 336 static void __destroy_hw_context(struct i915_gem_context *ctx,
 337                                  struct drm_i915_file_private *file_priv)
 338 {
 339         idr_remove(&file_priv->context_idr, ctx->user_handle);
 340         context_close(ctx);
 341 }
 342
 343 /**
 344  * The default context needs to exist per ring that uses contexts. It stores the
 345  * context state of the GPU for applications that don't utilize HW contexts, as
 346  * well as an idle case.
 347  */
 348 static struct i915_gem_context *
 349 i915_gem_create_context(struct drm_i915_private *dev_priv,
 350                         struct drm_i915_file_private *file_priv)
 351 {
 352         struct i915_gem_context *ctx;
 353
 354         lockdep_assert_held(&dev_priv->drm.struct_mutex);
 355
 356         ctx = __create_hw_context(dev_priv, file_priv);
 357         if (IS_ERR(ctx))
 358                 return ctx;
 359
 360         if (USES_FULL_PPGTT(dev_priv)) {
 361                 struct i915_hw_ppgtt *ppgtt;
 362
 363                 ppgtt = i915_ppgtt_create(dev_priv, file_priv, ctx->name);
 364                 if (IS_ERR(ppgtt)) {
 365                         DRM_DEBUG_DRIVER("PPGTT setup failed (%ld)\n",
 366                                          PTR_ERR(ppgtt));
 367                         __destroy_hw_context(ctx, file_priv);
 368                         return ERR_CAST(ppgtt);
 369                 }
 370
 371                 ctx->ppgtt = ppgtt;
 372                 ctx->desc_template = default_desc_template(dev_priv, ppgtt);
 373         }
 374
 375         trace_i915_context_create(ctx);
 376
 377         return ctx;
 378 }
 379
 380 /**
 381  * i915_gem_context_create_gvt - create a GVT GEM context
 382  * @dev: drm device *
 383  *
 384  * This function is used to create a GVT specific GEM context.
 385  *
 386  * Returns:
 387  * pointer to i915_gem_context on success, error pointer if failed
 388  *
 389  */
 390 struct i915_gem_context *
 391 i915_gem_context_create_gvt(struct drm_device *dev)
 392 {
 393         struct i915_gem_context *ctx;
 394         int ret;
 395
 396         if (!IS_ENABLED(CONFIG_DRM_I915_GVT))
 397                 return ERR_PTR(-ENODEV);
 398
 399         ret = i915_mutex_lock_interruptible(dev);
 400         if (ret)
 401                 return ERR_PTR(ret);
 402
 403         ctx = __create_hw_context(to_i915(dev), NULL);
 404         if (IS_ERR(ctx))
 405                 goto out;
 406
 407         ctx->file_priv = ERR_PTR(-EBADF);
 408         i915_gem_context_set_closed(ctx); /* not user accessible */
 409         i915_gem_context_clear_bannable(ctx);
 410         i915_gem_context_set_force_single_submission(ctx);
 411         if (!i915.enable_guc_submission)
 412                 ctx->ring_size = 512 * PAGE_SIZE; /* Max ring buffer size */
 413
 414         GEM_BUG_ON(i915_gem_context_is_kernel(ctx));
 415 out:
 416         mutex_unlock(&dev->struct_mutex);
 417         return ctx;
 418 }
 419
 420 int i915_gem_context_init(struct drm_i915_private *dev_priv)
 421 {
 422         struct i915_gem_context *ctx;
 423
 424         /* Init should only be called once per module load. Eventually the
 425          * restriction on the context_disabled check can be loosened. */
 426         if (WARN_ON(dev_priv->kernel_context))
 427                 return 0;
 428
 429         if (intel_vgpu_active(dev_priv) &&
 430             HAS_LOGICAL_RING_CONTEXTS(dev_priv)) {
 431                 if (!i915.enable_execlists) {
 432                         DRM_INFO("Only EXECLIST mode is supported in vgpu.\n");
 433                         return -EINVAL;
 434                 }
 435         }
 436
 437         /* Using the simple ida interface, the max is limited by sizeof(int) */
 438         BUILD_BUG_ON(MAX_CONTEXT_HW_ID > INT_MAX);
 439         ida_init(&dev_priv->context_hw_ida);
 440
 441         ctx = i915_gem_create_context(dev_priv, NULL);
 442         if (IS_ERR(ctx)) {
 443                 DRM_ERROR("Failed to create default global context (error %ld)\n",
 444                           PTR_ERR(ctx));
 445                 return PTR_ERR(ctx);
 446         }
 447
 448         /* For easy recognisablity, we want the kernel context to be 0 and then
 449          * all user contexts will have non-zero hw_id.
 450          */
 451         GEM_BUG_ON(ctx->hw_id);
 452
 453         i915_gem_context_clear_bannable(ctx);
 454         ctx->priority = I915_PRIORITY_MIN; /* lowest priority; idle task */
 455         dev_priv->kernel_context = ctx;
 456
 457         GEM_BUG_ON(!i915_gem_context_is_kernel(ctx));
 458
 459         DRM_DEBUG_DRIVER("%s context support initialized\n",
 460                          dev_priv->engine[RCS]->context_size ? "logical" :
 461                          "fake");
 462         return 0;
 463 }
 464
 465 void i915_gem_context_lost(struct drm_i915_private *dev_priv)
 466 {
 467         struct intel_engine_cs *engine;
 468         enum intel_engine_id id;
 469
 470         lockdep_assert_held(&dev_priv->drm.struct_mutex);
 471
 472         for_each_engine(engine, dev_priv, id) {
 473                 engine->legacy_active_context = NULL;
 474
 475                 if (!engine->last_retired_context)
 476                         continue;
 477
 478                 engine->context_unpin(engine, engine->last_retired_context);
 479                 engine->last_retired_context = NULL;
 480         }
 481
 482         /* Force the GPU state to be restored on enabling */
 483         if (!i915.enable_execlists) {
 484                 struct i915_gem_context *ctx;
 485
 486                 list_for_each_entry(ctx, &dev_priv->context_list, link) {
 487                         if (!i915_gem_context_is_default(ctx))
 488                                 continue;
 489
 490                         for_each_engine(engine, dev_priv, id)
 491                                 ctx->engine[engine->id].initialised = false;
 492
 493                         ctx->remap_slice = ALL_L3_SLICES(dev_priv);
 494                 }
 495
 496                 for_each_engine(engine, dev_priv, id) {
 497                         struct intel_context *kce =
 498                                 &dev_priv->kernel_context->engine[engine->id];
 499
 500                         kce->initialised = true;
 501                 }
 502         }
 503 }
 504
 505 void i915_gem_context_fini(struct drm_i915_private *dev_priv)
 506 {
 507         struct i915_gem_context *dctx = dev_priv->kernel_context;
 508
 509         lockdep_assert_held(&dev_priv->drm.struct_mutex);
 510
 511         GEM_BUG_ON(!i915_gem_context_is_kernel(dctx));
 512
 513         context_close(dctx);
 514         dev_priv->kernel_context = NULL;
 515
 516         ida_destroy(&dev_priv->context_hw_ida);
 517 }
 518
 519 static int context_idr_cleanup(int id, void *p, void *data)
 520 {
 521         struct i915_gem_context *ctx = p;
 522
 523         context_close(ctx);
 524         return 0;
 525 }
 526
 527 int i915_gem_context_open(struct drm_device *dev, struct drm_file *file)
 528 {
 529         struct drm_i915_file_private *file_priv = file->driver_priv;
 530         struct i915_gem_context *ctx;
 531
 532         idr_init(&file_priv->context_idr);
 533
 534         mutex_lock(&dev->struct_mutex);
 535         ctx = i915_gem_create_context(to_i915(dev), file_priv);
 536         mutex_unlock(&dev->struct_mutex);
 537
 538         GEM_BUG_ON(i915_gem_context_is_kernel(ctx));
 539
 540         if (IS_ERR(ctx)) {
 541                 idr_destroy(&file_priv->context_idr);
 542                 return PTR_ERR(ctx);
 543         }
 544
 545         return 0;
 546 }
 547
 548 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file)
 549 {
 550         struct drm_i915_file_private *file_priv = file->driver_priv;
 551
 552         lockdep_assert_held(&dev->struct_mutex);
 553
 554         idr_for_each(&file_priv->context_idr, context_idr_cleanup, NULL);
 555         idr_destroy(&file_priv->context_idr);
 556 }
 557
 558 static inline int
 559 mi_set_context(struct drm_i915_gem_request *req, u32 flags)
 560 {
 561         struct drm_i915_private *dev_priv = req->i915;
 562         struct intel_engine_cs *engine = req->engine;
 563         enum intel_engine_id id;
 564         const int num_rings =
 565                 /* Use an extended w/a on gen7 if signalling from other rings */
 566                 (i915.semaphores && INTEL_GEN(dev_priv) == 7) ?
 567                 INTEL_INFO(dev_priv)->num_rings - 1 :
 568                 0;
 569         int len;
 570         u32 *cs;
 571
 572         flags |= MI_MM_SPACE_GTT;
 573         if (IS_HASWELL(dev_priv) || INTEL_GEN(dev_priv) >= 8)
 574                 /* These flags are for resource streamer on HSW+ */
 575                 flags |= HSW_MI_RS_SAVE_STATE_EN | HSW_MI_RS_RESTORE_STATE_EN;
 576         else
 577                 flags |= MI_SAVE_EXT_STATE_EN | MI_RESTORE_EXT_STATE_EN;
 578
 579         len = 4;
 580         if (INTEL_GEN(dev_priv) >= 7)
 581                 len += 2 + (num_rings ? 4*num_rings + 6 : 0);
 582
 583         cs = intel_ring_begin(req, len);
 584         if (IS_ERR(cs))
 585                 return PTR_ERR(cs);
 586
 587         /* WaProgramMiArbOnOffAroundMiSetContext:ivb,vlv,hsw,bdw,chv */
 588         if (INTEL_GEN(dev_priv) >= 7) {
 589                 *cs++ = MI_ARB_ON_OFF | MI_ARB_DISABLE;
 590                 if (num_rings) {
 591                         struct intel_engine_cs *signaller;
 592
 593                         *cs++ = MI_LOAD_REGISTER_IMM(num_rings);
 594                         for_each_engine(signaller, dev_priv, id) {
 595                                 if (signaller == engine)
 596                                         continue;
 597
 598                                 *cs++ = i915_mmio_reg_offset(
 599                                            RING_PSMI_CTL(signaller->mmio_base));
 600                                 *cs++ = _MASKED_BIT_ENABLE(
 601                                                 GEN6_PSMI_SLEEP_MSG_DISABLE);
 602                         }
 603                 }
 604         }
 605
 606         *cs++ = MI_NOOP;
 607         *cs++ = MI_SET_CONTEXT;
 608         *cs++ = i915_ggtt_offset(req->ctx->engine[RCS].state) | flags;
 609         /*
 610          * w/a: MI_SET_CONTEXT must always be followed by MI_NOOP
 611          * WaMiSetContext_Hang:snb,ivb,vlv
 612          */
 613         *cs++ = MI_NOOP;
 614
 615         if (INTEL_GEN(dev_priv) >= 7) {
 616                 if (num_rings) {
 617                         struct intel_engine_cs *signaller;
 618                         i915_reg_t last_reg = {}; /* keep gcc quiet */
 619
 620                         *cs++ = MI_LOAD_REGISTER_IMM(num_rings);
 621                         for_each_engine(signaller, dev_priv, id) {
 622                                 if (signaller == engine)
 623                                         continue;
 624
 625                                 last_reg = RING_PSMI_CTL(signaller->mmio_base);
 626                                 *cs++ = i915_mmio_reg_offset(last_reg);
 627                                 *cs++ = _MASKED_BIT_DISABLE(
 628                                                 GEN6_PSMI_SLEEP_MSG_DISABLE);
 629                         }
 630
 631                         /* Insert a delay before the next switch! */
 632                         *cs++ = MI_STORE_REGISTER_MEM | MI_SRM_LRM_GLOBAL_GTT;
 633                         *cs++ = i915_mmio_reg_offset(last_reg);
 634                         *cs++ = i915_ggtt_offset(engine->scratch);
 635                         *cs++ = MI_NOOP;
 636                 }
 637                 *cs++ = MI_ARB_ON_OFF | MI_ARB_ENABLE;
 638         }
 639
 640         intel_ring_advance(req, cs);
 641
 642         return 0;
 643 }
 644
 645 static int remap_l3(struct drm_i915_gem_request *req, int slice)
 646 {
 647         u32 *cs, *remap_info = req->i915->l3_parity.remap_info[slice];
 648         int i;
 649
 650         if (!remap_info)
 651                 return 0;
 652
 653         cs = intel_ring_begin(req, GEN7_L3LOG_SIZE/4 * 2 + 2);
 654         if (IS_ERR(cs))
 655                 return PTR_ERR(cs);
 656
 657         /*
 658          * Note: We do not worry about the concurrent register cacheline hang
 659          * here because no other code should access these registers other than
 660          * at initialization time.
 661          */
 662         *cs++ = MI_LOAD_REGISTER_IMM(GEN7_L3LOG_SIZE/4);
 663         for (i = 0; i < GEN7_L3LOG_SIZE/4; i++) {
 664                 *cs++ = i915_mmio_reg_offset(GEN7_L3LOG(slice, i));
 665                 *cs++ = remap_info[i];
 666         }
 667         *cs++ = MI_NOOP;
 668         intel_ring_advance(req, cs);
 669
 670         return 0;
 671 }
 672
 673 static inline bool skip_rcs_switch(struct i915_hw_ppgtt *ppgtt,
 674                                    struct intel_engine_cs *engine,
 675                                    struct i915_gem_context *to)
 676 {
 677         if (to->remap_slice)
 678                 return false;
 679
 680         if (!to->engine[RCS].initialised)
 681                 return false;
 682
 683         if (ppgtt && (intel_engine_flag(engine) & ppgtt->pd_dirty_rings))
 684                 return false;
 685
 686         return to == engine->legacy_active_context;
 687 }
 688
 689 static bool
 690 needs_pd_load_pre(struct i915_hw_ppgtt *ppgtt,
 691                   struct intel_engine_cs *engine,
 692                   struct i915_gem_context *to)
 693 {
 694         if (!ppgtt)
 695                 return false;
 696
 697         /* Always load the ppgtt on first use */
 698         if (!engine->legacy_active_context)
 699                 return true;
 700
 701         /* Same context without new entries, skip */
 702         if (engine->legacy_active_context == to &&
 703             !(intel_engine_flag(engine) & ppgtt->pd_dirty_rings))
 704                 return false;
 705
 706         if (engine->id != RCS)
 707                 return true;
 708
 709         if (INTEL_GEN(engine->i915) < 8)
 710                 return true;
 711
 712         return false;
 713 }
 714
 715 static bool
 716 needs_pd_load_post(struct i915_hw_ppgtt *ppgtt,
 717                    struct i915_gem_context *to,
 718                    u32 hw_flags)
 719 {
 720         if (!ppgtt)
 721                 return false;
 722
 723         if (!IS_GEN8(to->i915))
 724                 return false;
 725
 726         if (hw_flags & MI_RESTORE_INHIBIT)
 727                 return true;
 728
 729         return false;
 730 }
 731
 732 static int do_rcs_switch(struct drm_i915_gem_request *req)
 733 {
 734         struct i915_gem_context *to = req->ctx;
 735         struct intel_engine_cs *engine = req->engine;
 736         struct i915_hw_ppgtt *ppgtt = to->ppgtt ?: req->i915->mm.aliasing_ppgtt;
 737         struct i915_gem_context *from = engine->legacy_active_context;
 738         u32 hw_flags;
 739         int ret, i;
 740
 741         GEM_BUG_ON(engine->id != RCS);
 742
 743         if (skip_rcs_switch(ppgtt, engine, to))
 744                 return 0;
 745
 746         if (needs_pd_load_pre(ppgtt, engine, to)) {
 747                 /* Older GENs and non render rings still want the load first,
 748                  * "PP_DCLV followed by PP_DIR_BASE register through Load
 749                  * Register Immediate commands in Ring Buffer before submitting
 750                  * a context."*/
 751                 trace_switch_mm(engine, to);
 752                 ret = ppgtt->switch_mm(ppgtt, req);
 753                 if (ret)
 754                         return ret;
 755         }
 756
 757         if (!to->engine[RCS].initialised || i915_gem_context_is_default(to))
 758                 /* NB: If we inhibit the restore, the context is not allowed to
 759                  * die because future work may end up depending on valid address
 760                  * space. This means we must enforce that a page table load
 761                  * occur when this occurs. */
 762                 hw_flags = MI_RESTORE_INHIBIT;
 763         else if (ppgtt && intel_engine_flag(engine) & ppgtt->pd_dirty_rings)
 764                 hw_flags = MI_FORCE_RESTORE;
 765         else
 766                 hw_flags = 0;
 767
 768         if (to != from || (hw_flags & MI_FORCE_RESTORE)) {
 769                 ret = mi_set_context(req, hw_flags);
 770                 if (ret)
 771                         return ret;
 772
 773                 engine->legacy_active_context = to;
 774         }
 775
 776         /* GEN8 does *not* require an explicit reload if the PDPs have been
 777          * setup, and we do not wish to move them.
 778          */
 779         if (needs_pd_load_post(ppgtt, to, hw_flags)) {
 780                 trace_switch_mm(engine, to);
 781                 ret = ppgtt->switch_mm(ppgtt, req);
 782                 /* The hardware context switch is emitted, but we haven't
 783                  * actually changed the state - so it's probably safe to bail
 784                  * here. Still, let the user know something dangerous has
 785                  * happened.
 786                  */
 787                 if (ret)
 788                         return ret;
 789         }
 790
 791         if (ppgtt)
 792                 ppgtt->pd_dirty_rings &= ~intel_engine_flag(engine);
 793
 794         for (i = 0; i < MAX_L3_SLICES; i++) {
 795                 if (!(to->remap_slice & (1<<i)))
 796                         continue;
 797
 798                 ret = remap_l3(req, i);
 799                 if (ret)
 800                         return ret;
 801
 802                 to->remap_slice &= ~(1<<i);
 803         }
 804
 805         if (!to->engine[RCS].initialised) {
 806                 if (engine->init_context) {
 807                         ret = engine->init_context(req);
 808                         if (ret)
 809                                 return ret;
 810                 }
 811                 to->engine[RCS].initialised = true;
 812         }
 813
 814         return 0;
 815 }
 816
 817 /**
 818  * i915_switch_context() - perform a GPU context switch.
 819  * @req: request for which we'll execute the context switch
 820  *
 821  * The context life cycle is simple. The context refcount is incremented and
 822  * decremented by 1 and create and destroy. If the context is in use by the GPU,
 823  * it will have a refcount > 1. This allows us to destroy the context abstract
 824  * object while letting the normal object tracking destroy the backing BO.
 825  *
 826  * This function should not be used in execlists mode.  Instead the context is
 827  * switched by writing to the ELSP and requests keep a reference to their
 828  * context.
 829  */
 830 int i915_switch_context(struct drm_i915_gem_request *req)
 831 {
 832         struct intel_engine_cs *engine = req->engine;
 833
 834         lockdep_assert_held(&req->i915->drm.struct_mutex);
 835         if (i915.enable_execlists)
 836                 return 0;
 837
 838         if (!req->ctx->engine[engine->id].state) {
 839                 struct i915_gem_context *to = req->ctx;
 840                 struct i915_hw_ppgtt *ppgtt =
 841                         to->ppgtt ?: req->i915->mm.aliasing_ppgtt;
 842
 843                 if (needs_pd_load_pre(ppgtt, engine, to)) {
 844                         int ret;
 845
 846                         trace_switch_mm(engine, to);
 847                         ret = ppgtt->switch_mm(ppgtt, req);
 848                         if (ret)
 849                                 return ret;
 850
 851                         ppgtt->pd_dirty_rings &= ~intel_engine_flag(engine);
 852                 }
 853
 854                 return 0;
 855         }
 856
 857         return do_rcs_switch(req);
 858 }
 859
 860 static bool engine_has_kernel_context(struct intel_engine_cs *engine)
 861 {
 862         struct i915_gem_timeline *timeline;
 863
 864         list_for_each_entry(timeline, &engine->i915->gt.timelines, link) {
 865                 struct intel_timeline *tl;
 866
 867                 if (timeline == &engine->i915->gt.global_timeline)
 868                         continue;
 869
 870                 tl = &timeline->engine[engine->id];
 871                 if (i915_gem_active_peek(&tl->last_request,
 872                                          &engine->i915->drm.struct_mutex))
 873                         return false;
 874         }
 875
 876         return (!engine->last_retired_context ||
 877                 i915_gem_context_is_kernel(engine->last_retired_context));
 878 }
 879
 880 int i915_gem_switch_to_kernel_context(struct drm_i915_private *dev_priv)
 881 {
 882         struct intel_engine_cs *engine;
 883         struct i915_gem_timeline *timeline;
 884         enum intel_engine_id id;
 885
 886         lockdep_assert_held(&dev_priv->drm.struct_mutex);
 887
 888         i915_gem_retire_requests(dev_priv);
 889
 890         for_each_engine(engine, dev_priv, id) {
 891                 struct drm_i915_gem_request *req;
 892                 int ret;
 893
 894                 if (engine_has_kernel_context(engine))
 895                         continue;
 896
 897                 req = i915_gem_request_alloc(engine, dev_priv->kernel_context);
 898                 if (IS_ERR(req))
 899                         return PTR_ERR(req);
 900
 901                 /* Queue this switch after all other activity */
 902                 list_for_each_entry(timeline, &dev_priv->gt.timelines, link) {
 903                         struct drm_i915_gem_request *prev;
 904                         struct intel_timeline *tl;
 905
 906                         tl = &timeline->engine[engine->id];
 907                         prev = i915_gem_active_raw(&tl->last_request,
 908                                                    &dev_priv->drm.struct_mutex);
 909                         if (prev)
 910                                 i915_sw_fence_await_sw_fence_gfp(&req->submit,
 911                                                                  &prev->submit,
 912                                                                  GFP_KERNEL);
 913                 }
 914
 915                 ret = i915_switch_context(req);
 916                 i915_add_request(req);
 917                 if (ret)
 918                         return ret;
 919         }
 920
 921         return 0;
 922 }
 923
 924 static bool client_is_banned(struct drm_i915_file_private *file_priv)
 925 {
 926         return file_priv->context_bans > I915_MAX_CLIENT_CONTEXT_BANS;
 927 }
 928
 929 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
 930                                   struct drm_file *file)
 931 {
 932         struct drm_i915_private *dev_priv = to_i915(dev);
 933         struct drm_i915_gem_context_create *args = data;
 934         struct drm_i915_file_private *file_priv = file->driver_priv;
 935         struct i915_gem_context *ctx;
 936         int ret;
 937
 938         if (!dev_priv->engine[RCS]->context_size)
 939                 return -ENODEV;
 940
 941         if (args->pad != 0)
 942                 return -EINVAL;
 943
 944         if (client_is_banned(file_priv)) {
 945                 DRM_DEBUG("client %s[%d] banned from creating ctx\n",
 946                           current->comm,
 947                           pid_nr(get_task_pid(current, PIDTYPE_PID)));
 948
 949                 return -EIO;
 950         }
 951
 952         ret = i915_mutex_lock_interruptible(dev);
 953         if (ret)
 954                 return ret;
 955
 956         ctx = i915_gem_create_context(dev_priv, file_priv);
 957         mutex_unlock(&dev->struct_mutex);
 958         if (IS_ERR(ctx))
 959                 return PTR_ERR(ctx);
 960
 961         GEM_BUG_ON(i915_gem_context_is_kernel(ctx));
 962
 963         args->ctx_id = ctx->user_handle;
 964         DRM_DEBUG("HW context %d created\n", args->ctx_id);
 965
 966         return 0;
 967 }
 968
 969 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
 970                                    struct drm_file *file)
 971 {
 972         struct drm_i915_gem_context_destroy *args = data;
 973         struct drm_i915_file_private *file_priv = file->driver_priv;
 974         struct i915_gem_context *ctx;
 975         int ret;
 976
 977         if (args->pad != 0)
 978                 return -EINVAL;
 979
 980         if (args->ctx_id == DEFAULT_CONTEXT_HANDLE)
 981                 return -ENOENT;
 982
 983         ret = i915_mutex_lock_interruptible(dev);
 984         if (ret)
 985                 return ret;
 986
 987         ctx = i915_gem_context_lookup(file_priv, args->ctx_id);
 988         if (IS_ERR(ctx)) {
 989                 mutex_unlock(&dev->struct_mutex);
 990                 return PTR_ERR(ctx);
 991         }
 992
 993         __destroy_hw_context(ctx, file_priv);
 994         mutex_unlock(&dev->struct_mutex);
 995
 996         DRM_DEBUG("HW context %d destroyed\n", args->ctx_id);
 997         return 0;
 998 }
 999
1000 int i915_gem_context_getparam_ioctl(struct drm_device *dev, void *data,
1001                                     struct drm_file *file)
1002 {
1003         struct drm_i915_file_private *file_priv = file->driver_priv;
1004         struct drm_i915_gem_context_param *args = data;
1005         struct i915_gem_context *ctx;
1006         int ret;
1007
1008         ret = i915_mutex_lock_interruptible(dev);
1009         if (ret)
1010                 return ret;
1011
1012         ctx = i915_gem_context_lookup(file_priv, args->ctx_id);
1013         if (IS_ERR(ctx)) {
1014                 mutex_unlock(&dev->struct_mutex);
1015                 return PTR_ERR(ctx);
1016         }
1017
1018         args->size = 0;
1019         switch (args->param) {
1020         case I915_CONTEXT_PARAM_BAN_PERIOD:
1021                 ret = -EINVAL;
1022                 break;
1023         case I915_CONTEXT_PARAM_NO_ZEROMAP:
1024                 args->value = ctx->flags & CONTEXT_NO_ZEROMAP;
1025                 break;
1026         case I915_CONTEXT_PARAM_GTT_SIZE:
1027                 if (ctx->ppgtt)
1028                         args->value = ctx->ppgtt->base.total;
1029                 else if (to_i915(dev)->mm.aliasing_ppgtt)
1030                         args->value = to_i915(dev)->mm.aliasing_ppgtt->base.total;
1031                 else
1032                         args->value = to_i915(dev)->ggtt.base.total;
1033                 break;
1034         case I915_CONTEXT_PARAM_NO_ERROR_CAPTURE:
1035                 args->value = i915_gem_context_no_error_capture(ctx);
1036                 break;
1037         case I915_CONTEXT_PARAM_BANNABLE:
1038                 args->value = i915_gem_context_is_bannable(ctx);
1039                 break;
1040         default:
1041                 ret = -EINVAL;
1042                 break;
1043         }
1044         mutex_unlock(&dev->struct_mutex);
1045
1046         return ret;
1047 }
1048
1049 int i915_gem_context_setparam_ioctl(struct drm_device *dev, void *data,
1050                                     struct drm_file *file)
1051 {
1052         struct drm_i915_file_private *file_priv = file->driver_priv;
1053         struct drm_i915_gem_context_param *args = data;
1054         struct i915_gem_context *ctx;
1055         int ret;
1056
1057         ret = i915_mutex_lock_interruptible(dev);
1058         if (ret)
1059                 return ret;
1060
1061         ctx = i915_gem_context_lookup(file_priv, args->ctx_id);
1062         if (IS_ERR(ctx)) {
1063                 mutex_unlock(&dev->struct_mutex);
1064                 return PTR_ERR(ctx);
1065         }
1066
1067         switch (args->param) {
1068         case I915_CONTEXT_PARAM_BAN_PERIOD:
1069                 ret = -EINVAL;
1070                 break;
1071         case I915_CONTEXT_PARAM_NO_ZEROMAP:
1072                 if (args->size) {
1073                         ret = -EINVAL;
1074                 } else {
1075                         ctx->flags &= ~CONTEXT_NO_ZEROMAP;
1076                         ctx->flags |= args->value ? CONTEXT_NO_ZEROMAP : 0;
1077                 }
1078                 break;
1079         case I915_CONTEXT_PARAM_NO_ERROR_CAPTURE:
1080                 if (args->size)
1081                         ret = -EINVAL;
1082                 else if (args->value)
1083                         i915_gem_context_set_no_error_capture(ctx);
1084                 else
1085                         i915_gem_context_clear_no_error_capture(ctx);
1086                 break;
1087         case I915_CONTEXT_PARAM_BANNABLE:
1088                 if (args->size)
1089                         ret = -EINVAL;
1090                 else if (!capable(CAP_SYS_ADMIN) && !args->value)
1091                         ret = -EPERM;
1092                 else if (args->value)
1093                         i915_gem_context_set_bannable(ctx);
1094                 else
1095                         i915_gem_context_clear_bannable(ctx);
1096                 break;
1097         default:
1098                 ret = -EINVAL;
1099                 break;
1100         }
1101         mutex_unlock(&dev->struct_mutex);
1102
1103         return ret;
1104 }
1105
1106 int i915_gem_context_reset_stats_ioctl(struct drm_device *dev,
1107                                        void *data, struct drm_file *file)
1108 {
1109         struct drm_i915_private *dev_priv = to_i915(dev);
1110         struct drm_i915_reset_stats *args = data;
1111         struct i915_gem_context *ctx;
1112         int ret;
1113
1114         if (args->flags || args->pad)
1115                 return -EINVAL;
1116
1117         ret = i915_mutex_lock_interruptible(dev);
1118         if (ret)
1119                 return ret;
1120
1121         ctx = i915_gem_context_lookup(file->driver_priv, args->ctx_id);
1122         if (IS_ERR(ctx)) {
1123                 mutex_unlock(&dev->struct_mutex);
1124                 return PTR_ERR(ctx);
1125         }
1126
1127         if (capable(CAP_SYS_ADMIN))
1128                 args->reset_count = i915_reset_count(&dev_priv->gpu_error);
1129         else
1130                 args->reset_count = 0;
1131
1132         args->batch_active = ctx->guilty_count;
1133         args->batch_pending = ctx->active_count;
1134
1135         mutex_unlock(&dev->struct_mutex);
1136
1137         return 0;
1138 }
1139
1140 #if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
1141 #include "selftests/mock_context.c"
1142 #include "selftests/i915_gem_context.c"
1143 #endif