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 it's state already and has stored away the gtt
  77  *  offset of the BO. The GPU is not actively referencing the data at this
  78  *  offset, but it will on the next context switch. The only way to avoid this
  79  *  is to do a GPU reset.
  80  *
  81  *  An "active context' is one which was previously the "current context" and is
  82  *  on the active list waiting for the next context switch to occur. Until this
  83  *  happens, the object must remain at the same gtt offset. It is therefore
  84  *  possible to destroy a context, but it is still active.
  85  *
  86  */
  87
  88 #include <drm/drmP.h>
  89 #include <drm/i915_drm.h>
  90 #include "i915_drv.h"
  91
  92 /* This is a HW constraint. The value below is the largest known requirement
  93  * I've seen in a spec to date, and that was a workaround for a non-shipping
  94  * part. It should be safe to decrease this, but it's more future proof as is.
  95  */
  96 #define CONTEXT_ALIGN (64<<10)
  97
  98 static struct i915_hw_context *
  99 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id);
 100 static int do_switch(struct i915_hw_context *to);
 101
 102 static int get_context_size(struct drm_device *dev)
 103 {
 104         struct drm_i915_private *dev_priv = dev->dev_private;
 105         int ret;
 106         u32 reg;
 107
 108         switch (INTEL_INFO(dev)->gen) {
 109         case 6:
 110                 reg = I915_READ(CXT_SIZE);
 111                 ret = GEN6_CXT_TOTAL_SIZE(reg) * 64;
 112                 break;
 113         case 7:
 114                 reg = I915_READ(GEN7_CXT_SIZE);
 115                 if (IS_HASWELL(dev))
 116                         ret = HSW_CXT_TOTAL_SIZE(reg) * 64;
 117                 else
 118                         ret = GEN7_CXT_TOTAL_SIZE(reg) * 64;
 119                 break;
 120         default:
 121                 BUG();
 122         }
 123
 124         return ret;
 125 }
 126
 127 void i915_gem_context_free(struct kref *ctx_ref)
 128 {
 129         struct i915_hw_context *ctx = container_of(ctx_ref,
 130                                                    typeof(*ctx), ref);
 131
 132         drm_gem_object_unreference(&ctx->obj->base);
 133         kfree(ctx);
 134 }
 135
 136 static struct i915_hw_context *
 137 create_hw_context(struct drm_device *dev,
 138                   struct drm_i915_file_private *file_priv)
 139 {
 140         struct drm_i915_private *dev_priv = dev->dev_private;
 141         struct i915_hw_context *ctx;
 142         int ret;
 143
 144         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 145         if (ctx == NULL)
 146                 return ERR_PTR(-ENOMEM);
 147
 148         kref_init(&ctx->ref);
 149         ctx->obj = i915_gem_alloc_object(dev, dev_priv->hw_context_size);
 150         if (ctx->obj == NULL) {
 151                 kfree(ctx);
 152                 DRM_DEBUG_DRIVER("Context object allocated failed\n");
 153                 return ERR_PTR(-ENOMEM);
 154         }
 155
 156         if (INTEL_INFO(dev)->gen >= 7) {
 157                 ret = i915_gem_object_set_cache_level(ctx->obj,
 158                                                       I915_CACHE_LLC_MLC);
 159                 if (ret)
 160                         goto err_out;
 161         }
 162
 163         /* The ring associated with the context object is handled by the normal
 164          * object tracking code. We give an initial ring value simple to pass an
 165          * assertion in the context switch code.
 166          */
 167         ctx->ring = &dev_priv->ring[RCS];
 168
 169         /* Default context will never have a file_priv */
 170         if (file_priv == NULL)
 171                 return ctx;
 172
 173         ret = idr_alloc(&file_priv->context_idr, ctx, DEFAULT_CONTEXT_ID + 1, 0,
 174                         GFP_KERNEL);
 175         if (ret < 0)
 176                 goto err_out;
 177
 178         ctx->file_priv = file_priv;
 179         ctx->id = ret;
 180
 181         return ctx;
 182
 183 err_out:
 184         i915_gem_context_unreference(ctx);
 185         return ERR_PTR(ret);
 186 }
 187
 188 static inline bool is_default_context(struct i915_hw_context *ctx)
 189 {
 190         return (ctx == ctx->ring->default_context);
 191 }
 192
 193 /**
 194  * The default context needs to exist per ring that uses contexts. It stores the
 195  * context state of the GPU for applications that don't utilize HW contexts, as
 196  * well as an idle case.
 197  */
 198 static int create_default_context(struct drm_i915_private *dev_priv)
 199 {
 200         struct i915_hw_context *ctx;
 201         int ret;
 202
 203         BUG_ON(!mutex_is_locked(&dev_priv->dev->struct_mutex));
 204
 205         ctx = create_hw_context(dev_priv->dev, NULL);
 206         if (IS_ERR(ctx))
 207                 return PTR_ERR(ctx);
 208
 209         /* We may need to do things with the shrinker which require us to
 210          * immediately switch back to the default context. This can cause a
 211          * problem as pinning the default context also requires GTT space which
 212          * may not be available. To avoid this we always pin the
 213          * default context.
 214          */
 215         dev_priv->ring[RCS].default_context = ctx;
 216         ret = i915_gem_object_pin(ctx->obj, CONTEXT_ALIGN, false, false);
 217         if (ret)
 218                 goto err_destroy;
 219
 220         ret = do_switch(ctx);
 221         if (ret)
 222                 goto err_unpin;
 223
 224         DRM_DEBUG_DRIVER("Default HW context loaded\n");
 225         return 0;
 226
 227 err_unpin:
 228         i915_gem_object_unpin(ctx->obj);
 229 err_destroy:
 230         i915_gem_context_unreference(ctx);
 231         return ret;
 232 }
 233
 234 void i915_gem_context_init(struct drm_device *dev)
 235 {
 236         struct drm_i915_private *dev_priv = dev->dev_private;
 237
 238         if (!HAS_HW_CONTEXTS(dev)) {
 239                 dev_priv->hw_contexts_disabled = true;
 240                 return;
 241         }
 242
 243         /* If called from reset, or thaw... we've been here already */
 244         if (dev_priv->hw_contexts_disabled ||
 245             dev_priv->ring[RCS].default_context)
 246                 return;
 247
 248         dev_priv->hw_context_size = round_up(get_context_size(dev), 4096);
 249
 250         if (dev_priv->hw_context_size > (1<<20)) {
 251                 dev_priv->hw_contexts_disabled = true;
 252                 return;
 253         }
 254
 255         if (create_default_context(dev_priv)) {
 256                 dev_priv->hw_contexts_disabled = true;
 257                 return;
 258         }
 259
 260         DRM_DEBUG_DRIVER("HW context support initialized\n");
 261 }
 262
 263 void i915_gem_context_fini(struct drm_device *dev)
 264 {
 265         struct drm_i915_private *dev_priv = dev->dev_private;
 266         struct i915_hw_context *dctx = dev_priv->ring[RCS].default_context;
 267
 268         if (dev_priv->hw_contexts_disabled)
 269                 return;
 270
 271         /* The only known way to stop the gpu from accessing the hw context is
 272          * to reset it. Do this as the very last operation to avoid confusing
 273          * other code, leading to spurious errors. */
 274         intel_gpu_reset(dev);
 275
 276         i915_gem_object_unpin(dctx->obj);
 277
 278         /* When default context is created and switched to, base object refcount
 279          * will be 2 (+1 from object creation and +1 from do_switch()).
 280          * i915_gem_context_fini() will be called after gpu_idle() has switched
 281          * to default context. So we need to unreference the base object once
 282          * to offset the do_switch part, so that i915_gem_context_unreference()
 283          * can then free the base object correctly. */
 284         drm_gem_object_unreference(&dctx->obj->base);
 285         i915_gem_context_unreference(dctx);
 286 }
 287
 288 static int context_idr_cleanup(int id, void *p, void *data)
 289 {
 290         struct i915_hw_context *ctx = p;
 291
 292         BUG_ON(id == DEFAULT_CONTEXT_ID);
 293
 294         i915_gem_context_unreference(ctx);
 295         return 0;
 296 }
 297
 298 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file)
 299 {
 300         struct drm_i915_file_private *file_priv = file->driver_priv;
 301
 302         mutex_lock(&dev->struct_mutex);
 303         idr_for_each(&file_priv->context_idr, context_idr_cleanup, NULL);
 304         idr_destroy(&file_priv->context_idr);
 305         mutex_unlock(&dev->struct_mutex);
 306 }
 307
 308 static struct i915_hw_context *
 309 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id)
 310 {
 311         return (struct i915_hw_context *)idr_find(&file_priv->context_idr, id);
 312 }
 313
 314 static inline int
 315 mi_set_context(struct intel_ring_buffer *ring,
 316                struct i915_hw_context *new_context,
 317                u32 hw_flags)
 318 {
 319         int ret;
 320
 321         /* w/a: If Flush TLB Invalidation Mode is enabled, driver must do a TLB
 322          * invalidation prior to MI_SET_CONTEXT. On GEN6 we don't set the value
 323          * explicitly, so we rely on the value at ring init, stored in
 324          * itlb_before_ctx_switch.
 325          */
 326         if (IS_GEN6(ring->dev) && ring->itlb_before_ctx_switch) {
 327                 ret = ring->flush(ring, I915_GEM_GPU_DOMAINS, 0);
 328                 if (ret)
 329                         return ret;
 330         }
 331
 332         ret = intel_ring_begin(ring, 6);
 333         if (ret)
 334                 return ret;
 335
 336         /* WaProgramMiArbOnOffAroundMiSetContext:ivb,vlv,hsw */
 337         if (IS_GEN7(ring->dev))
 338                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_DISABLE);
 339         else
 340                 intel_ring_emit(ring, MI_NOOP);
 341
 342         intel_ring_emit(ring, MI_NOOP);
 343         intel_ring_emit(ring, MI_SET_CONTEXT);
 344         intel_ring_emit(ring, new_context->obj->gtt_offset |
 345                         MI_MM_SPACE_GTT |
 346                         MI_SAVE_EXT_STATE_EN |
 347                         MI_RESTORE_EXT_STATE_EN |
 348                         hw_flags);
 349         /* w/a: MI_SET_CONTEXT must always be followed by MI_NOOP */
 350         intel_ring_emit(ring, MI_NOOP);
 351
 352         if (IS_GEN7(ring->dev))
 353                 intel_ring_emit(ring, MI_ARB_ON_OFF | MI_ARB_ENABLE);
 354         else
 355                 intel_ring_emit(ring, MI_NOOP);
 356
 357         intel_ring_advance(ring);
 358
 359         return ret;
 360 }
 361
 362 static int do_switch(struct i915_hw_context *to)
 363 {
 364         struct intel_ring_buffer *ring = to->ring;
 365         struct i915_hw_context *from = ring->last_context;
 366         u32 hw_flags = 0;
 367         int ret;
 368
 369         BUG_ON(from != NULL && from->obj != NULL && from->obj->pin_count == 0);
 370
 371         if (from == to)
 372                 return 0;
 373
 374         ret = i915_gem_object_pin(to->obj, CONTEXT_ALIGN, false, false);
 375         if (ret)
 376                 return ret;
 377
 378         /* Clear this page out of any CPU caches for coherent swap-in/out. Note
 379          * that thanks to write = false in this call and us not setting any gpu
 380          * write domains when putting a context object onto the active list
 381          * (when switching away from it), this won't block.
 382          * XXX: We need a real interface to do this instead of trickery. */
 383         ret = i915_gem_object_set_to_gtt_domain(to->obj, false);
 384         if (ret) {
 385                 i915_gem_object_unpin(to->obj);
 386                 return ret;
 387         }
 388
 389         if (!to->obj->has_global_gtt_mapping)
 390                 i915_gem_gtt_bind_object(to->obj, to->obj->cache_level);
 391
 392         if (!to->is_initialized || is_default_context(to))
 393                 hw_flags |= MI_RESTORE_INHIBIT;
 394         else if (WARN_ON_ONCE(from == to)) /* not yet expected */
 395                 hw_flags |= MI_FORCE_RESTORE;
 396
 397         ret = mi_set_context(ring, to, hw_flags);
 398         if (ret) {
 399                 i915_gem_object_unpin(to->obj);
 400                 return ret;
 401         }
 402
 403         /* The backing object for the context is done after switching to the
 404          * *next* context. Therefore we cannot retire the previous context until
 405          * the next context has already started running. In fact, the below code
 406          * is a bit suboptimal because the retiring can occur simply after the
 407          * MI_SET_CONTEXT instead of when the next seqno has completed.
 408          */
 409         if (from != NULL) {
 410                 from->obj->base.read_domains = I915_GEM_DOMAIN_INSTRUCTION;
 411                 i915_gem_object_move_to_active(from->obj, ring);
 412                 /* As long as MI_SET_CONTEXT is serializing, ie. it flushes the
 413                  * whole damn pipeline, we don't need to explicitly mark the
 414                  * object dirty. The only exception is that the context must be
 415                  * correct in case the object gets swapped out. Ideally we'd be
 416                  * able to defer doing this until we know the object would be
 417                  * swapped, but there is no way to do that yet.
 418                  */
 419                 from->obj->dirty = 1;
 420                 BUG_ON(from->obj->ring != ring);
 421
 422                 ret = i915_add_request(ring, NULL, NULL);
 423                 if (ret) {
 424                         /* Too late, we've already scheduled a context switch.
 425                          * Try to undo the change so that the hw state is
 426                          * consistent with out tracking. In case of emergency,
 427                          * scream.
 428                          */
 429                         WARN_ON(mi_set_context(ring, from, MI_RESTORE_INHIBIT));
 430                         return ret;
 431                 }
 432
 433                 i915_gem_object_unpin(from->obj);
 434                 i915_gem_context_unreference(from);
 435         }
 436
 437         i915_gem_context_reference(to);
 438         ring->last_context = to;
 439         to->is_initialized = true;
 440
 441         return 0;
 442 }
 443
 444 /**
 445  * i915_switch_context() - perform a GPU context switch.
 446  * @ring: ring for which we'll execute the context switch
 447  * @file_priv: file_priv associated with the context, may be NULL
 448  * @id: context id number
 449  * @seqno: sequence number by which the new context will be switched to
 450  * @flags:
 451  *
 452  * The context life cycle is simple. The context refcount is incremented and
 453  * decremented by 1 and create and destroy. If the context is in use by the GPU,
 454  * it will have a refoucnt > 1. This allows us to destroy the context abstract
 455  * object while letting the normal object tracking destroy the backing BO.
 456  */
 457 int i915_switch_context(struct intel_ring_buffer *ring,
 458                         struct drm_file *file,
 459                         int to_id)
 460 {
 461         struct drm_i915_private *dev_priv = ring->dev->dev_private;
 462         struct i915_hw_context *to;
 463
 464         if (dev_priv->hw_contexts_disabled)
 465                 return 0;
 466
 467         WARN_ON(!mutex_is_locked(&dev_priv->dev->struct_mutex));
 468
 469         if (ring != &dev_priv->ring[RCS])
 470                 return 0;
 471
 472         if (to_id == DEFAULT_CONTEXT_ID) {
 473                 to = ring->default_context;
 474         } else {
 475                 if (file == NULL)
 476                         return -EINVAL;
 477
 478                 to = i915_gem_context_get(file->driver_priv, to_id);
 479                 if (to == NULL)
 480                         return -ENOENT;
 481         }
 482
 483         return do_switch(to);
 484 }
 485
 486 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
 487                                   struct drm_file *file)
 488 {
 489         struct drm_i915_private *dev_priv = dev->dev_private;
 490         struct drm_i915_gem_context_create *args = data;
 491         struct drm_i915_file_private *file_priv = file->driver_priv;
 492         struct i915_hw_context *ctx;
 493         int ret;
 494
 495         if (!(dev->driver->driver_features & DRIVER_GEM))
 496                 return -ENODEV;
 497
 498         if (dev_priv->hw_contexts_disabled)
 499                 return -ENODEV;
 500
 501         ret = i915_mutex_lock_interruptible(dev);
 502         if (ret)
 503                 return ret;
 504
 505         ctx = create_hw_context(dev, file_priv);
 506         mutex_unlock(&dev->struct_mutex);
 507         if (IS_ERR(ctx))
 508                 return PTR_ERR(ctx);
 509
 510         args->ctx_id = ctx->id;
 511         DRM_DEBUG_DRIVER("HW context %d created\n", args->ctx_id);
 512
 513         return 0;
 514 }
 515
 516 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
 517                                    struct drm_file *file)
 518 {
 519         struct drm_i915_gem_context_destroy *args = data;
 520         struct drm_i915_file_private *file_priv = file->driver_priv;
 521         struct i915_hw_context *ctx;
 522         int ret;
 523
 524         if (!(dev->driver->driver_features & DRIVER_GEM))
 525                 return -ENODEV;
 526
 527         ret = i915_mutex_lock_interruptible(dev);
 528         if (ret)
 529                 return ret;
 530
 531         ctx = i915_gem_context_get(file_priv, args->ctx_id);
 532         if (!ctx) {
 533                 mutex_unlock(&dev->struct_mutex);
 534                 return -ENOENT;
 535         }
 536
 537         idr_remove(&ctx->file_priv->context_idr, ctx->id);
 538         i915_gem_context_unreference(ctx);
 539         mutex_unlock(&dev->struct_mutex);
 540
 541         DRM_DEBUG_DRIVER("HW context %d destroyed\n", args->ctx_id);
 542         return 0;
 543 }