i915/gt/mock_engine.c

0001 // SPDX-License-Identifier: MIT
0002 /*
0003  * Copyright © 2016 Intel Corporation
0004  */
0005
0006 #include "gem/i915_gem_context.h"
0007 #include "gt/intel_ring.h"
0008
0009 #include "i915_drv.h"
0010 #include "intel_context.h"
0011 #include "intel_engine_pm.h"
0012
0013 #include "mock_engine.h"
0014 #include "selftests/mock_request.h"
0015
0016 static int mock_timeline_pin(struct intel_timeline *tl)
0017 {
0018     int err;
0019
0020     if (WARN_ON(!i915_gem_object_trylock(tl->hwsp_ggtt->obj, NULL)))
0021         return -EBUSY;
0022
0023     err = intel_timeline_pin_map(tl);
0024     i915_gem_object_unlock(tl->hwsp_ggtt->obj);
0025     if (err)
0026         return err;
0027
0028     atomic_inc(&tl->pin_count);
0029     return 0;
0030 }
0031
0032 static void mock_timeline_unpin(struct intel_timeline *tl)
0033 {
0034     GEM_BUG_ON(!atomic_read(&tl->pin_count));
0035     atomic_dec(&tl->pin_count);
0036 }
0037
0038 static struct i915_vma *create_ring_vma(struct i915_ggtt *ggtt, int size)
0039 {
0040     struct i915_address_space *vm = &ggtt->vm;
0041     struct drm_i915_private *i915 = vm->i915;
0042     struct drm_i915_gem_object *obj;
0043     struct i915_vma *vma;
0044
0045     obj = i915_gem_object_create_internal(i915, size);
0046     if (IS_ERR(obj))
0047         return ERR_CAST(obj);
0048
0049     vma = i915_vma_instance(obj, vm, NULL);
0050     if (IS_ERR(vma))
0051         goto err;
0052
0053     return vma;
0054
0055 err:
0056     i915_gem_object_put(obj);
0057     return vma;
0058 }
0059
0060 static struct intel_ring *mock_ring(struct intel_engine_cs *engine)
0061 {
0062     const unsigned long sz = PAGE_SIZE;
0063     struct intel_ring *ring;
0064
0065     ring = kzalloc(sizeof(*ring) + sz, GFP_KERNEL);
0066     if (!ring)
0067         return NULL;
0068
0069     kref_init(&ring->ref);
0070     ring->size = sz;
0071     ring->effective_size = sz;
0072     ring->vaddr = (void *)(ring + 1);
0073     atomic_set(&ring->pin_count, 1);
0074
0075     ring->vma = create_ring_vma(engine->gt->ggtt, PAGE_SIZE);
0076     if (IS_ERR(ring->vma)) {
0077         kfree(ring);
0078         return NULL;
0079     }
0080
0081     intel_ring_update_space(ring);
0082
0083     return ring;
0084 }
0085
0086 static void mock_ring_free(struct intel_ring *ring)
0087 {
0088     i915_vma_put(ring->vma);
0089
0090     kfree(ring);
0091 }
0092
0093 static struct i915_request *first_request(struct mock_engine *engine)
0094 {
0095     return list_first_entry_or_null(&engine->hw_queue,
0096                     struct i915_request,
0097                     mock.link);
0098 }
0099
0100 static void advance(struct i915_request *request)
0101 {
0102     list_del_init(&request->mock.link);
0103     i915_request_mark_complete(request);
0104     GEM_BUG_ON(!i915_request_completed(request));
0105
0106     intel_engine_signal_breadcrumbs(request->engine);
0107 }
0108
0109 static void hw_delay_complete(struct timer_list *t)
0110 {
0111     struct mock_engine *engine = from_timer(engine, t, hw_delay);
0112     struct i915_request *request;
0113     unsigned long flags;
0114
0115     spin_lock_irqsave(&engine->hw_lock, flags);
0116
0117     /* Timer fired, first request is complete */
0118     request = first_request(engine);
0119     if (request)
0120         advance(request);
0121
0122     /*
0123      * Also immediately signal any subsequent 0-delay requests, but
0124      * requeue the timer for the next delayed request.
0125      */
0126     while ((request = first_request(engine))) {
0127         if (request->mock.delay) {
0128             mod_timer(&engine->hw_delay,
0129                   jiffies + request->mock.delay);
0130             break;
0131         }
0132
0133         advance(request);
0134     }
0135
0136     spin_unlock_irqrestore(&engine->hw_lock, flags);
0137 }
0138
0139 static void mock_context_unpin(struct intel_context *ce)
0140 {
0141 }
0142
0143 static void mock_context_post_unpin(struct intel_context *ce)
0144 {
0145     i915_vma_unpin(ce->ring->vma);
0146 }
0147
0148 static void mock_context_destroy(struct kref *ref)
0149 {
0150     struct intel_context *ce = container_of(ref, typeof(*ce), ref);
0151
0152     GEM_BUG_ON(intel_context_is_pinned(ce));
0153
0154     if (test_bit(CONTEXT_ALLOC_BIT, &ce->flags)) {
0155         mock_ring_free(ce->ring);
0156         mock_timeline_unpin(ce->timeline);
0157     }
0158
0159     intel_context_fini(ce);
0160     intel_context_free(ce);
0161 }
0162
0163 static int mock_context_alloc(struct intel_context *ce)
0164 {
0165     int err;
0166
0167     ce->ring = mock_ring(ce->engine);
0168     if (!ce->ring)
0169         return -ENOMEM;
0170
0171     ce->timeline = intel_timeline_create(ce->engine->gt);
0172     if (IS_ERR(ce->timeline)) {
0173         kfree(ce->engine);
0174         return PTR_ERR(ce->timeline);
0175     }
0176
0177     err = mock_timeline_pin(ce->timeline);
0178     if (err) {
0179         intel_timeline_put(ce->timeline);
0180         ce->timeline = NULL;
0181         return err;
0182     }
0183
0184     return 0;
0185 }
0186
0187 static int mock_context_pre_pin(struct intel_context *ce,
0188                 struct i915_gem_ww_ctx *ww, void **unused)
0189 {
0190     return i915_vma_pin_ww(ce->ring->vma, ww, 0, 0, PIN_GLOBAL | PIN_HIGH);
0191 }
0192
0193 static int mock_context_pin(struct intel_context *ce, void *unused)
0194 {
0195     return 0;
0196 }
0197
0198 static void mock_context_reset(struct intel_context *ce)
0199 {
0200 }
0201
0202 static const struct intel_context_ops mock_context_ops = {
0203     .alloc = mock_context_alloc,
0204
0205     .pre_pin = mock_context_pre_pin,
0206     .pin = mock_context_pin,
0207     .unpin = mock_context_unpin,
0208     .post_unpin = mock_context_post_unpin,
0209
0210     .enter = intel_context_enter_engine,
0211     .exit = intel_context_exit_engine,
0212
0213     .reset = mock_context_reset,
0214     .destroy = mock_context_destroy,
0215 };
0216
0217 static int mock_request_alloc(struct i915_request *request)
0218 {
0219     INIT_LIST_HEAD(&request->mock.link);
0220     request->mock.delay = 0;
0221
0222     return 0;
0223 }
0224
0225 static int mock_emit_flush(struct i915_request *request,
0226                unsigned int flags)
0227 {
0228     return 0;
0229 }
0230
0231 static u32 *mock_emit_breadcrumb(struct i915_request *request, u32 *cs)
0232 {
0233     return cs;
0234 }
0235
0236 static void mock_submit_request(struct i915_request *request)
0237 {
0238     struct mock_engine *engine =
0239         container_of(request->engine, typeof(*engine), base);
0240     unsigned long flags;
0241
0242     i915_request_submit(request);
0243
0244     spin_lock_irqsave(&engine->hw_lock, flags);
0245     list_add_tail(&request->mock.link, &engine->hw_queue);
0246     if (list_is_first(&request->mock.link, &engine->hw_queue)) {
0247         if (request->mock.delay)
0248             mod_timer(&engine->hw_delay,
0249                   jiffies + request->mock.delay);
0250         else
0251             advance(request);
0252     }
0253     spin_unlock_irqrestore(&engine->hw_lock, flags);
0254 }
0255
0256 static void mock_add_to_engine(struct i915_request *rq)
0257 {
0258     lockdep_assert_held(&rq->engine->sched_engine->lock);
0259     list_move_tail(&rq->sched.link, &rq->engine->sched_engine->requests);
0260 }
0261
0262 static void mock_remove_from_engine(struct i915_request *rq)
0263 {
0264     struct intel_engine_cs *engine, *locked;
0265
0266     /*
0267      * Virtual engines complicate acquiring the engine timeline lock,
0268      * as their rq->engine pointer is not stable until under that
0269      * engine lock. The simple ploy we use is to take the lock then
0270      * check that the rq still belongs to the newly locked engine.
0271      */
0272
0273     locked = READ_ONCE(rq->engine);
0274     spin_lock_irq(&locked->sched_engine->lock);
0275     while (unlikely(locked != (engine = READ_ONCE(rq->engine)))) {
0276         spin_unlock(&locked->sched_engine->lock);
0277         spin_lock(&engine->sched_engine->lock);
0278         locked = engine;
0279     }
0280     list_del_init(&rq->sched.link);
0281     spin_unlock_irq(&locked->sched_engine->lock);
0282 }
0283
0284 static void mock_reset_prepare(struct intel_engine_cs *engine)
0285 {
0286 }
0287
0288 static void mock_reset_rewind(struct intel_engine_cs *engine, bool stalled)
0289 {
0290     GEM_BUG_ON(stalled);
0291 }
0292
0293 static void mock_reset_cancel(struct intel_engine_cs *engine)
0294 {
0295     struct mock_engine *mock =
0296         container_of(engine, typeof(*mock), base);
0297     struct i915_request *rq;
0298     unsigned long flags;
0299
0300     del_timer_sync(&mock->hw_delay);
0301
0302     spin_lock_irqsave(&engine->sched_engine->lock, flags);
0303
0304     /* Mark all submitted requests as skipped. */
0305     list_for_each_entry(rq, &engine->sched_engine->requests, sched.link)
0306         i915_request_put(i915_request_mark_eio(rq));
0307     intel_engine_signal_breadcrumbs(engine);
0308
0309     /* Cancel and submit all pending requests. */
0310     list_for_each_entry(rq, &mock->hw_queue, mock.link) {
0311         if (i915_request_mark_eio(rq)) {
0312             __i915_request_submit(rq);
0313             i915_request_put(rq);
0314         }
0315     }
0316     INIT_LIST_HEAD(&mock->hw_queue);
0317
0318     spin_unlock_irqrestore(&engine->sched_engine->lock, flags);
0319 }
0320
0321 static void mock_reset_finish(struct intel_engine_cs *engine)
0322 {
0323 }
0324
0325 static void mock_engine_release(struct intel_engine_cs *engine)
0326 {
0327     struct mock_engine *mock =
0328         container_of(engine, typeof(*mock), base);
0329
0330     GEM_BUG_ON(timer_pending(&mock->hw_delay));
0331
0332     i915_sched_engine_put(engine->sched_engine);
0333     intel_breadcrumbs_put(engine->breadcrumbs);
0334
0335     intel_context_unpin(engine->kernel_context);
0336     intel_context_put(engine->kernel_context);
0337
0338     intel_engine_fini_retire(engine);
0339 }
0340
0341 struct intel_engine_cs *mock_engine(struct drm_i915_private *i915,
0342                     const char *name,
0343                     int id)
0344 {
0345     struct mock_engine *engine;
0346
0347     GEM_BUG_ON(id >= I915_NUM_ENGINES);
0348     GEM_BUG_ON(!to_gt(i915)->uncore);
0349
0350     engine = kzalloc(sizeof(*engine) + PAGE_SIZE, GFP_KERNEL);
0351     if (!engine)
0352         return NULL;
0353
0354     /* minimal engine setup for requests */
0355     engine->base.i915 = i915;
0356     engine->base.gt = to_gt(i915);
0357     engine->base.uncore = to_gt(i915)->uncore;
0358     snprintf(engine->base.name, sizeof(engine->base.name), "%s", name);
0359     engine->base.id = id;
0360     engine->base.mask = BIT(id);
0361     engine->base.legacy_idx = INVALID_ENGINE;
0362     engine->base.instance = id;
0363     engine->base.status_page.addr = (void *)(engine + 1);
0364
0365     engine->base.cops = &mock_context_ops;
0366     engine->base.request_alloc = mock_request_alloc;
0367     engine->base.emit_flush = mock_emit_flush;
0368     engine->base.emit_fini_breadcrumb = mock_emit_breadcrumb;
0369     engine->base.submit_request = mock_submit_request;
0370     engine->base.add_active_request = mock_add_to_engine;
0371     engine->base.remove_active_request = mock_remove_from_engine;
0372
0373     engine->base.reset.prepare = mock_reset_prepare;
0374     engine->base.reset.rewind = mock_reset_rewind;
0375     engine->base.reset.cancel = mock_reset_cancel;
0376     engine->base.reset.finish = mock_reset_finish;
0377
0378     engine->base.release = mock_engine_release;
0379
0380     to_gt(i915)->engine[id] = &engine->base;
0381     to_gt(i915)->engine_class[0][id] = &engine->base;
0382
0383     /* fake hw queue */
0384     spin_lock_init(&engine->hw_lock);
0385     timer_setup(&engine->hw_delay, hw_delay_complete, 0);
0386     INIT_LIST_HEAD(&engine->hw_queue);
0387
0388     intel_engine_add_user(&engine->base);
0389
0390     return &engine->base;
0391 }
0392
0393 int mock_engine_init(struct intel_engine_cs *engine)
0394 {
0395     struct intel_context *ce;
0396
0397     INIT_LIST_HEAD(&engine->pinned_contexts_list);
0398
0399     engine->sched_engine = i915_sched_engine_create(ENGINE_MOCK);
0400     if (!engine->sched_engine)
0401         return -ENOMEM;
0402     engine->sched_engine->private_data = engine;
0403
0404     intel_engine_init_execlists(engine);
0405     intel_engine_init__pm(engine);
0406     intel_engine_init_retire(engine);
0407
0408     engine->breadcrumbs = intel_breadcrumbs_create(NULL);
0409     if (!engine->breadcrumbs)
0410         goto err_schedule;
0411
0412     ce = create_kernel_context(engine);
0413     if (IS_ERR(ce))
0414         goto err_breadcrumbs;
0415
0416     /* We insist the kernel context is using the status_page */
0417     engine->status_page.vma = ce->timeline->hwsp_ggtt;
0418
0419     engine->kernel_context = ce;
0420     return 0;
0421
0422 err_breadcrumbs:
0423     intel_breadcrumbs_put(engine->breadcrumbs);
0424 err_schedule:
0425     i915_sched_engine_put(engine->sched_engine);
0426     return -ENOMEM;
0427 }
0428
0429 void mock_engine_flush(struct intel_engine_cs *engine)
0430 {
0431     struct mock_engine *mock =
0432         container_of(engine, typeof(*mock), base);
0433     struct i915_request *request, *rn;
0434
0435     del_timer_sync(&mock->hw_delay);
0436
0437     spin_lock_irq(&mock->hw_lock);
0438     list_for_each_entry_safe(request, rn, &mock->hw_queue, mock.link)
0439         advance(request);
0440     spin_unlock_irq(&mock->hw_lock);
0441 }
0442
0443 void mock_engine_reset(struct intel_engine_cs *engine)
0444 {
0445 }