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