Merge remote-tracking branch 'regulator/fix/max77802' into regulator-linus

[mirror_ubuntu-artful-kernel.git] / drivers / gpu / drm / i915 / i915_gem_request.c

/*
 * Copyright © 2008-2015 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 */

#include <linux/prefetch.h>
#include <linux/dma-fence-array.h>
#include <linux/sched.h>
#include <linux/sched/clock.h>
#include <linux/sched/signal.h>

#include "i915_drv.h"

static const char *i915_fence_get_driver_name(struct dma_fence *fence)
{
        return "i915";
}

static const char *i915_fence_get_timeline_name(struct dma_fence *fence)
{
        /* The timeline struct (as part of the ppgtt underneath a context)
         * may be freed when the request is no longer in use by the GPU.
         * We could extend the life of a context to beyond that of all
         * fences, possibly keeping the hw resource around indefinitely,
         * or we just give them a false name. Since
         * dma_fence_ops.get_timeline_name is a debug feature, the occasional
         * lie seems justifiable.
         */
        if (test_bit(DMA_FENCE_FLAG_SIGNALED_BIT, &fence->flags))
                return "signaled";

        return to_request(fence)->timeline->common->name;
}

static bool i915_fence_signaled(struct dma_fence *fence)
{
        return i915_gem_request_completed(to_request(fence));
}

static bool i915_fence_enable_signaling(struct dma_fence *fence)
{
        if (i915_fence_signaled(fence))
                return false;

        intel_engine_enable_signaling(to_request(fence));
        return true;
}

static signed long i915_fence_wait(struct dma_fence *fence,
                                   bool interruptible,
                                   signed long timeout)
{
        return i915_wait_request(to_request(fence), interruptible, timeout);
}

static void i915_fence_release(struct dma_fence *fence)
{
        struct drm_i915_gem_request *req = to_request(fence);

        /* The request is put onto a RCU freelist (i.e. the address
         * is immediately reused), mark the fences as being freed now.
         * Otherwise the debugobjects for the fences are only marked as
         * freed when the slab cache itself is freed, and so we would get
         * caught trying to reuse dead objects.
         */
        i915_sw_fence_fini(&req->submit);

        kmem_cache_free(req->i915->requests, req);
}

const struct dma_fence_ops i915_fence_ops = {
        .get_driver_name = i915_fence_get_driver_name,
        .get_timeline_name = i915_fence_get_timeline_name,
        .enable_signaling = i915_fence_enable_signaling,
        .signaled = i915_fence_signaled,
        .wait = i915_fence_wait,
        .release = i915_fence_release,
};

static inline void
i915_gem_request_remove_from_client(struct drm_i915_gem_request *request)
{
        struct drm_i915_file_private *file_priv;

        file_priv = request->file_priv;
        if (!file_priv)
                return;

        spin_lock(&file_priv->mm.lock);
        if (request->file_priv) {
                list_del(&request->client_link);
                request->file_priv = NULL;
        }
        spin_unlock(&file_priv->mm.lock);
}

static struct i915_dependency *
i915_dependency_alloc(struct drm_i915_private *i915)
{
        return kmem_cache_alloc(i915->dependencies, GFP_KERNEL);
}

static void
i915_dependency_free(struct drm_i915_private *i915,
                     struct i915_dependency *dep)
{
        kmem_cache_free(i915->dependencies, dep);
}

static void
__i915_priotree_add_dependency(struct i915_priotree *pt,
                               struct i915_priotree *signal,
                               struct i915_dependency *dep,
                               unsigned long flags)
{
        INIT_LIST_HEAD(&dep->dfs_link);
        list_add(&dep->wait_link, &signal->waiters_list);
        list_add(&dep->signal_link, &pt->signalers_list);
        dep->signaler = signal;
        dep->flags = flags;
}

static int
i915_priotree_add_dependency(struct drm_i915_private *i915,
                             struct i915_priotree *pt,
                             struct i915_priotree *signal)
{
        struct i915_dependency *dep;

        dep = i915_dependency_alloc(i915);
        if (!dep)
                return -ENOMEM;

        __i915_priotree_add_dependency(pt, signal, dep, I915_DEPENDENCY_ALLOC);
        return 0;
}

static void
i915_priotree_fini(struct drm_i915_private *i915, struct i915_priotree *pt)
{
        struct i915_dependency *dep, *next;

        GEM_BUG_ON(!RB_EMPTY_NODE(&pt->node));

        /* Everyone we depended upon (the fences we wait to be signaled)
         * should retire before us and remove themselves from our list.
         * However, retirement is run independently on each timeline and
         * so we may be called out-of-order.
         */
        list_for_each_entry_safe(dep, next, &pt->signalers_list, signal_link) {
                list_del(&dep->wait_link);
                if (dep->flags & I915_DEPENDENCY_ALLOC)
                        i915_dependency_free(i915, dep);
        }

        /* Remove ourselves from everyone who depends upon us */
        list_for_each_entry_safe(dep, next, &pt->waiters_list, wait_link) {
                list_del(&dep->signal_link);
                if (dep->flags & I915_DEPENDENCY_ALLOC)
                        i915_dependency_free(i915, dep);
        }
}

static void
i915_priotree_init(struct i915_priotree *pt)
{
        INIT_LIST_HEAD(&pt->signalers_list);
        INIT_LIST_HEAD(&pt->waiters_list);
        RB_CLEAR_NODE(&pt->node);
        pt->priority = INT_MIN;
}

static int reset_all_global_seqno(struct drm_i915_private *i915, u32 seqno)
{
        struct intel_engine_cs *engine;
        enum intel_engine_id id;
        int ret;

        /* Carefully retire all requests without writing to the rings */
        ret = i915_gem_wait_for_idle(i915,
                                     I915_WAIT_INTERRUPTIBLE |
                                     I915_WAIT_LOCKED);
        if (ret)
                return ret;

        /* If the seqno wraps around, we need to clear the breadcrumb rbtree */
        for_each_engine(engine, i915, id) {
                struct i915_gem_timeline *timeline;
                struct intel_timeline *tl = engine->timeline;

                if (!i915_seqno_passed(seqno, tl->seqno)) {
                        /* spin until threads are complete */
                        while (intel_breadcrumbs_busy(engine))
                                cond_resched();
                }

                /* Finally reset hw state */
                tl->seqno = seqno;
                intel_engine_init_global_seqno(engine, seqno);

                list_for_each_entry(timeline, &i915->gt.timelines, link)
                        memset(timeline->engine[id].sync_seqno, 0,
                               sizeof(timeline->engine[id].sync_seqno));
        }

        return 0;
}

int i915_gem_set_global_seqno(struct drm_device *dev, u32 seqno)
{
        struct drm_i915_private *dev_priv = to_i915(dev);

        lockdep_assert_held(&dev_priv->drm.struct_mutex);

        if (seqno == 0)
                return -EINVAL;

        /* HWS page needs to be set less than what we
         * will inject to ring
         */
        return reset_all_global_seqno(dev_priv, seqno - 1);
}

static int reserve_seqno(struct intel_engine_cs *engine)
{
        u32 active = ++engine->timeline->inflight_seqnos;
        u32 seqno = engine->timeline->seqno;
        int ret;

        /* Reservation is fine until we need to wrap around */
        if (likely(!add_overflows(seqno, active)))
                return 0;

        ret = reset_all_global_seqno(engine->i915, 0);
        if (ret) {
                engine->timeline->inflight_seqnos--;
                return ret;
        }

        return 0;
}

static void unreserve_seqno(struct intel_engine_cs *engine)
{
        GEM_BUG_ON(!engine->timeline->inflight_seqnos);
        engine->timeline->inflight_seqnos--;
}

void i915_gem_retire_noop(struct i915_gem_active *active,
                          struct drm_i915_gem_request *request)
{
        /* Space left intentionally blank */
}

static void i915_gem_request_retire(struct drm_i915_gem_request *request)
{
        struct intel_engine_cs *engine = request->engine;
        struct i915_gem_active *active, *next;

        lockdep_assert_held(&request->i915->drm.struct_mutex);
        GEM_BUG_ON(!i915_sw_fence_signaled(&request->submit));
        GEM_BUG_ON(!i915_gem_request_completed(request));
        GEM_BUG_ON(!request->i915->gt.active_requests);

        trace_i915_gem_request_retire(request);

        spin_lock_irq(&engine->timeline->lock);
        list_del_init(&request->link);
        spin_unlock_irq(&engine->timeline->lock);

        /* We know the GPU must have read the request to have
         * sent us the seqno + interrupt, so use the position
         * of tail of the request to update the last known position
         * of the GPU head.
         *
         * Note this requires that we are always called in request
         * completion order.
         */
        list_del(&request->ring_link);
        request->ring->head = request->postfix;
        if (!--request->i915->gt.active_requests) {
                GEM_BUG_ON(!request->i915->gt.awake);
                mod_delayed_work(request->i915->wq,
                                 &request->i915->gt.idle_work,
                                 msecs_to_jiffies(100));
        }
        unreserve_seqno(request->engine);

        /* Walk through the active list, calling retire on each. This allows
         * objects to track their GPU activity and mark themselves as idle
         * when their *last* active request is completed (updating state
         * tracking lists for eviction, active references for GEM, etc).
         *
         * As the ->retire() may free the node, we decouple it first and
         * pass along the auxiliary information (to avoid dereferencing
         * the node after the callback).
         */
        list_for_each_entry_safe(active, next, &request->active_list, link) {
                /* In microbenchmarks or focusing upon time inside the kernel,
                 * we may spend an inordinate amount of time simply handling
                 * the retirement of requests and processing their callbacks.
                 * Of which, this loop itself is particularly hot due to the
                 * cache misses when jumping around the list of i915_gem_active.
                 * So we try to keep this loop as streamlined as possible and
                 * also prefetch the next i915_gem_active to try and hide
                 * the likely cache miss.
                 */
                prefetchw(next);

                INIT_LIST_HEAD(&active->link);
                RCU_INIT_POINTER(active->request, NULL);

                active->retire(active, request);
        }

        i915_gem_request_remove_from_client(request);

        /* Retirement decays the ban score as it is a sign of ctx progress */
        if (request->ctx->ban_score > 0)
                request->ctx->ban_score--;

        /* The backing object for the context is done after switching to the
         * *next* context. Therefore we cannot retire the previous context until
         * the next context has already started running. However, since we
         * cannot take the required locks at i915_gem_request_submit() we
         * defer the unpinning of the active context to now, retirement of
         * the subsequent request.
         */
        if (engine->last_retired_context)
                engine->context_unpin(engine, engine->last_retired_context);
        engine->last_retired_context = request->ctx;

        dma_fence_signal(&request->fence);

        i915_priotree_fini(request->i915, &request->priotree);
        i915_gem_request_put(request);
}

void i915_gem_request_retire_upto(struct drm_i915_gem_request *req)
{
        struct intel_engine_cs *engine = req->engine;
        struct drm_i915_gem_request *tmp;

        lockdep_assert_held(&req->i915->drm.struct_mutex);
        GEM_BUG_ON(!i915_gem_request_completed(req));

        if (list_empty(&req->link))
                return;

        do {
                tmp = list_first_entry(&engine->timeline->requests,
                                       typeof(*tmp), link);

                i915_gem_request_retire(tmp);
        } while (tmp != req);
}

static u32 timeline_get_seqno(struct intel_timeline *tl)
{
        return ++tl->seqno;
}

void __i915_gem_request_submit(struct drm_i915_gem_request *request)
{
        struct intel_engine_cs *engine = request->engine;
        struct intel_timeline *timeline;
        u32 seqno;

        GEM_BUG_ON(!irqs_disabled());
        lockdep_assert_held(&engine->timeline->lock);

        trace_i915_gem_request_execute(request);

        /* Transfer from per-context onto the global per-engine timeline */
        timeline = engine->timeline;
        GEM_BUG_ON(timeline == request->timeline);

        seqno = timeline_get_seqno(timeline);
        GEM_BUG_ON(!seqno);
        GEM_BUG_ON(i915_seqno_passed(intel_engine_get_seqno(engine), seqno));

        /* We may be recursing from the signal callback of another i915 fence */
        spin_lock_nested(&request->lock, SINGLE_DEPTH_NESTING);
        request->global_seqno = seqno;
        if (test_bit(DMA_FENCE_FLAG_ENABLE_SIGNAL_BIT, &request->fence.flags))
                intel_engine_enable_signaling(request);
        spin_unlock(&request->lock);

        engine->emit_breadcrumb(request,
                                request->ring->vaddr + request->postfix);

        spin_lock(&request->timeline->lock);
        list_move_tail(&request->link, &timeline->requests);
        spin_unlock(&request->timeline->lock);

        wake_up_all(&request->execute);
}

void i915_gem_request_submit(struct drm_i915_gem_request *request)
{
        struct intel_engine_cs *engine = request->engine;
        unsigned long flags;

        /* Will be called from irq-context when using foreign fences. */
        spin_lock_irqsave(&engine->timeline->lock, flags);

        __i915_gem_request_submit(request);

        spin_unlock_irqrestore(&engine->timeline->lock, flags);
}

void __i915_gem_request_unsubmit(struct drm_i915_gem_request *request)
{
        struct intel_engine_cs *engine = request->engine;
        struct intel_timeline *timeline;

        GEM_BUG_ON(!irqs_disabled());
        lockdep_assert_held(&engine->timeline->lock);

        /* Only unwind in reverse order, required so that the per-context list
         * is kept in seqno/ring order.
         */
        GEM_BUG_ON(request->global_seqno != engine->timeline->seqno);
        engine->timeline->seqno--;

        /* We may be recursing from the signal callback of another i915 fence */
        spin_lock_nested(&request->lock, SINGLE_DEPTH_NESTING);
        request->global_seqno = 0;
        if (test_bit(DMA_FENCE_FLAG_ENABLE_SIGNAL_BIT, &request->fence.flags))
                intel_engine_cancel_signaling(request);
        spin_unlock(&request->lock);

        /* Transfer back from the global per-engine timeline to per-context */
        timeline = request->timeline;
        GEM_BUG_ON(timeline == engine->timeline);

        spin_lock(&timeline->lock);
        list_move(&request->link, &timeline->requests);
        spin_unlock(&timeline->lock);

        /* We don't need to wake_up any waiters on request->execute, they
         * will get woken by any other event or us re-adding this request
         * to the engine timeline (__i915_gem_request_submit()). The waiters
         * should be quite adapt at finding that the request now has a new
         * global_seqno to the one they went to sleep on.
         */
}

void i915_gem_request_unsubmit(struct drm_i915_gem_request *request)
{
        struct intel_engine_cs *engine = request->engine;
        unsigned long flags;

        /* Will be called from irq-context when using foreign fences. */
        spin_lock_irqsave(&engine->timeline->lock, flags);

        __i915_gem_request_unsubmit(request);

        spin_unlock_irqrestore(&engine->timeline->lock, flags);
}

static int __i915_sw_fence_call
submit_notify(struct i915_sw_fence *fence, enum i915_sw_fence_notify state)
{
        struct drm_i915_gem_request *request =
                container_of(fence, typeof(*request), submit);

        switch (state) {
        case FENCE_COMPLETE:
                trace_i915_gem_request_submit(request);
                request->engine->submit_request(request);
                break;

        case FENCE_FREE:
                i915_gem_request_put(request);
                break;
        }

        return NOTIFY_DONE;
}

/**
 * i915_gem_request_alloc - allocate a request structure
 *
 * @engine: engine that we wish to issue the request on.
 * @ctx: context that the request will be associated with.
 *       This can be NULL if the request is not directly related to
 *       any specific user context, in which case this function will
 *       choose an appropriate context to use.
 *
 * Returns a pointer to the allocated request if successful,
 * or an error code if not.
 */
struct drm_i915_gem_request *
i915_gem_request_alloc(struct intel_engine_cs *engine,
                       struct i915_gem_context *ctx)
{
        struct drm_i915_private *dev_priv = engine->i915;
        struct drm_i915_gem_request *req;
        int ret;

        lockdep_assert_held(&dev_priv->drm.struct_mutex);

        /* ABI: Before userspace accesses the GPU (e.g. execbuffer), report
         * EIO if the GPU is already wedged.
         */
        if (i915_terminally_wedged(&dev_priv->gpu_error))
                return ERR_PTR(-EIO);

        /* Pinning the contexts may generate requests in order to acquire
         * GGTT space, so do this first before we reserve a seqno for
         * ourselves.
         */
        ret = engine->context_pin(engine, ctx);
        if (ret)
                return ERR_PTR(ret);

        ret = reserve_seqno(engine);
        if (ret)
                goto err_unpin;

        /* Move the oldest request to the slab-cache (if not in use!) */
        req = list_first_entry_or_null(&engine->timeline->requests,
                                       typeof(*req), link);
        if (req && i915_gem_request_completed(req))
                i915_gem_request_retire(req);

        /* Beware: Dragons be flying overhead.
         *
         * We use RCU to look up requests in flight. The lookups may
         * race with the request being allocated from the slab freelist.
         * That is the request we are writing to here, may be in the process
         * of being read by __i915_gem_active_get_rcu(). As such,
         * we have to be very careful when overwriting the contents. During
         * the RCU lookup, we change chase the request->engine pointer,
         * read the request->global_seqno and increment the reference count.
         *
         * The reference count is incremented atomically. If it is zero,
         * the lookup knows the request is unallocated and complete. Otherwise,
         * it is either still in use, or has been reallocated and reset
         * with dma_fence_init(). This increment is safe for release as we
         * check that the request we have a reference to and matches the active
         * request.
         *
         * Before we increment the refcount, we chase the request->engine
         * pointer. We must not call kmem_cache_zalloc() or else we set
         * that pointer to NULL and cause a crash during the lookup. If
         * we see the request is completed (based on the value of the
         * old engine and seqno), the lookup is complete and reports NULL.
         * If we decide the request is not completed (new engine or seqno),
         * then we grab a reference and double check that it is still the
         * active request - which it won't be and restart the lookup.
         *
         * Do not use kmem_cache_zalloc() here!
         */
        req = kmem_cache_alloc(dev_priv->requests, GFP_KERNEL);
        if (!req) {
                ret = -ENOMEM;
                goto err_unreserve;
        }

        req->timeline = i915_gem_context_lookup_timeline(ctx, engine);
        GEM_BUG_ON(req->timeline == engine->timeline);

        spin_lock_init(&req->lock);
        dma_fence_init(&req->fence,
                       &i915_fence_ops,
                       &req->lock,
                       req->timeline->fence_context,
                       timeline_get_seqno(req->timeline));

        /* We bump the ref for the fence chain */
        i915_sw_fence_init(&i915_gem_request_get(req)->submit, submit_notify);
        init_waitqueue_head(&req->execute);

        i915_priotree_init(&req->priotree);

        INIT_LIST_HEAD(&req->active_list);
        req->i915 = dev_priv;
        req->engine = engine;
        req->ctx = ctx;

        /* No zalloc, must clear what we need by hand */
        req->global_seqno = 0;
        req->file_priv = NULL;
        req->batch = NULL;

        /*
         * Reserve space in the ring buffer for all the commands required to
         * eventually emit this request. This is to guarantee that the
         * i915_add_request() call can't fail. Note that the reserve may need
         * to be redone if the request is not actually submitted straight
         * away, e.g. because a GPU scheduler has deferred it.
         */
        req->reserved_space = MIN_SPACE_FOR_ADD_REQUEST;
        GEM_BUG_ON(req->reserved_space < engine->emit_breadcrumb_sz);

        ret = engine->request_alloc(req);
        if (ret)
                goto err_ctx;

        /* Record the position of the start of the request so that
         * should we detect the updated seqno part-way through the
         * GPU processing the request, we never over-estimate the
         * position of the head.
         */
        req->head = req->ring->emit;

        /* Check that we didn't interrupt ourselves with a new request */
        GEM_BUG_ON(req->timeline->seqno != req->fence.seqno);
        return req;

err_ctx:
        /* Make sure we didn't add ourselves to external state before freeing */
        GEM_BUG_ON(!list_empty(&req->active_list));
        GEM_BUG_ON(!list_empty(&req->priotree.signalers_list));
        GEM_BUG_ON(!list_empty(&req->priotree.waiters_list));

        kmem_cache_free(dev_priv->requests, req);
err_unreserve:
        unreserve_seqno(engine);
err_unpin:
        engine->context_unpin(engine, ctx);
        return ERR_PTR(ret);
}

static int
i915_gem_request_await_request(struct drm_i915_gem_request *to,
                               struct drm_i915_gem_request *from)
{
        u32 seqno;
        int ret;

        GEM_BUG_ON(to == from);

        if (i915_gem_request_completed(from))
                return 0;

        if (to->engine->schedule) {
                ret = i915_priotree_add_dependency(to->i915,
                                                   &to->priotree,
                                                   &from->priotree);
                if (ret < 0)
                        return ret;
        }

        if (to->timeline == from->timeline)
                return 0;

        if (to->engine == from->engine) {
                ret = i915_sw_fence_await_sw_fence_gfp(&to->submit,
                                                       &from->submit,
                                                       GFP_KERNEL);
                return ret < 0 ? ret : 0;
        }

        seqno = i915_gem_request_global_seqno(from);
        if (!seqno) {
                ret = i915_sw_fence_await_dma_fence(&to->submit,
                                                    &from->fence, 0,
                                                    GFP_KERNEL);
                return ret < 0 ? ret : 0;
        }

        if (seqno <= to->timeline->sync_seqno[from->engine->id])
                return 0;

        trace_i915_gem_ring_sync_to(to, from);
        if (!i915.semaphores) {
                if (!i915_spin_request(from, TASK_INTERRUPTIBLE, 2)) {
                        ret = i915_sw_fence_await_dma_fence(&to->submit,
                                                            &from->fence, 0,
                                                            GFP_KERNEL);
                        if (ret < 0)
                                return ret;
                }
        } else {
                ret = to->engine->semaphore.sync_to(to, from);
                if (ret)
                        return ret;
        }

        to->timeline->sync_seqno[from->engine->id] = seqno;
        return 0;
}

int
i915_gem_request_await_dma_fence(struct drm_i915_gem_request *req,
                                 struct dma_fence *fence)
{
        struct dma_fence_array *array;
        int ret;
        int i;

        if (test_bit(DMA_FENCE_FLAG_SIGNALED_BIT, &fence->flags))
                return 0;

        if (dma_fence_is_i915(fence))
                return i915_gem_request_await_request(req, to_request(fence));

        if (!dma_fence_is_array(fence)) {
                ret = i915_sw_fence_await_dma_fence(&req->submit,
                                                    fence, I915_FENCE_TIMEOUT,
                                                    GFP_KERNEL);
                return ret < 0 ? ret : 0;
        }

        /* Note that if the fence-array was created in signal-on-any mode,
         * we should *not* decompose it into its individual fences. However,
         * we don't currently store which mode the fence-array is operating
         * in. Fortunately, the only user of signal-on-any is private to
         * amdgpu and we should not see any incoming fence-array from
         * sync-file being in signal-on-any mode.
         */

        array = to_dma_fence_array(fence);
        for (i = 0; i < array->num_fences; i++) {
                struct dma_fence *child = array->fences[i];

                if (dma_fence_is_i915(child))
                        ret = i915_gem_request_await_request(req,
                                                             to_request(child));
                else
                        ret = i915_sw_fence_await_dma_fence(&req->submit,
                                                            child, I915_FENCE_TIMEOUT,
                                                            GFP_KERNEL);
                if (ret < 0)
                        return ret;
        }

        return 0;
}

/**
 * i915_gem_request_await_object - set this request to (async) wait upon a bo
 *
 * @to: request we are wishing to use
 * @obj: object which may be in use on another ring.
 *
 * This code is meant to abstract object synchronization with the GPU.
 * Conceptually we serialise writes between engines inside the GPU.
 * We only allow one engine to write into a buffer at any time, but
 * multiple readers. To ensure each has a coherent view of memory, we must:
 *
 * - If there is an outstanding write request to the object, the new
 *   request must wait for it to complete (either CPU or in hw, requests
 *   on the same ring will be naturally ordered).
 *
 * - If we are a write request (pending_write_domain is set), the new
 *   request must wait for outstanding read requests to complete.
 *
 * Returns 0 if successful, else propagates up the lower layer error.
 */
int
i915_gem_request_await_object(struct drm_i915_gem_request *to,
                              struct drm_i915_gem_object *obj,
                              bool write)
{
        struct dma_fence *excl;
        int ret = 0;

        if (write) {
                struct dma_fence **shared;
                unsigned int count, i;

                ret = reservation_object_get_fences_rcu(obj->resv,
                                                        &excl, &count, &shared);
                if (ret)
                        return ret;

                for (i = 0; i < count; i++) {
                        ret = i915_gem_request_await_dma_fence(to, shared[i]);
                        if (ret)
                                break;

                        dma_fence_put(shared[i]);
                }

                for (; i < count; i++)
                        dma_fence_put(shared[i]);
                kfree(shared);
        } else {
                excl = reservation_object_get_excl_rcu(obj->resv);
        }

        if (excl) {
                if (ret == 0)
                        ret = i915_gem_request_await_dma_fence(to, excl);

                dma_fence_put(excl);
        }

        return ret;
}

static void i915_gem_mark_busy(const struct intel_engine_cs *engine)
{
        struct drm_i915_private *dev_priv = engine->i915;

        if (dev_priv->gt.awake)
                return;

        GEM_BUG_ON(!dev_priv->gt.active_requests);

        intel_runtime_pm_get_noresume(dev_priv);
        dev_priv->gt.awake = true;

        intel_enable_gt_powersave(dev_priv);
        i915_update_gfx_val(dev_priv);
        if (INTEL_GEN(dev_priv) >= 6)
                gen6_rps_busy(dev_priv);

        queue_delayed_work(dev_priv->wq,
                           &dev_priv->gt.retire_work,
                           round_jiffies_up_relative(HZ));
}

/*
 * NB: This function is not allowed to fail. Doing so would mean the the
 * request is not being tracked for completion but the work itself is
 * going to happen on the hardware. This would be a Bad Thing(tm).
 */
void __i915_add_request(struct drm_i915_gem_request *request, bool flush_caches)
{
        struct intel_engine_cs *engine = request->engine;
        struct intel_ring *ring = request->ring;
        struct intel_timeline *timeline = request->timeline;
        struct drm_i915_gem_request *prev;
        u32 *cs;
        int err;

        lockdep_assert_held(&request->i915->drm.struct_mutex);
        trace_i915_gem_request_add(request);

        /* Make sure that no request gazumped us - if it was allocated after
         * our i915_gem_request_alloc() and called __i915_add_request() before
         * us, the timeline will hold its seqno which is later than ours.
         */
        GEM_BUG_ON(timeline->seqno != request->fence.seqno);

        /*
         * To ensure that this call will not fail, space for its emissions
         * should already have been reserved in the ring buffer. Let the ring
         * know that it is time to use that space up.
         */
        request->reserved_space = 0;

        /*
         * Emit any outstanding flushes - execbuf can fail to emit the flush
         * after having emitted the batchbuffer command. Hence we need to fix
         * things up similar to emitting the lazy request. The difference here
         * is that the flush _must_ happen before the next request, no matter
         * what.
         */
        if (flush_caches) {
                err = engine->emit_flush(request, EMIT_FLUSH);

                /* Not allowed to fail! */
                WARN(err, "engine->emit_flush() failed: %d!\n", err);
        }

        /* Record the position of the start of the breadcrumb so that
         * should we detect the updated seqno part-way through the
         * GPU processing the request, we never over-estimate the
         * position of the ring's HEAD.
         */
        cs = intel_ring_begin(request, engine->emit_breadcrumb_sz);
        GEM_BUG_ON(IS_ERR(cs));
        request->postfix = intel_ring_offset(request, cs);

        /* Seal the request and mark it as pending execution. Note that
         * we may inspect this state, without holding any locks, during
         * hangcheck. Hence we apply the barrier to ensure that we do not
         * see a more recent value in the hws than we are tracking.
         */

        prev = i915_gem_active_raw(&timeline->last_request,
                                   &request->i915->drm.struct_mutex);
        if (prev) {
                i915_sw_fence_await_sw_fence(&request->submit, &prev->submit,
                                             &request->submitq);
                if (engine->schedule)
                        __i915_priotree_add_dependency(&request->priotree,
                                                       &prev->priotree,
                                                       &request->dep,
                                                       0);
        }

        spin_lock_irq(&timeline->lock);
        list_add_tail(&request->link, &timeline->requests);
        spin_unlock_irq(&timeline->lock);

        GEM_BUG_ON(timeline->seqno != request->fence.seqno);
        i915_gem_active_set(&timeline->last_request, request);

        list_add_tail(&request->ring_link, &ring->request_list);
        request->emitted_jiffies = jiffies;

        if (!request->i915->gt.active_requests++)
                i915_gem_mark_busy(engine);

        /* Let the backend know a new request has arrived that may need
         * to adjust the existing execution schedule due to a high priority
         * request - i.e. we may want to preempt the current request in order
         * to run a high priority dependency chain *before* we can execute this
         * request.
         *
         * This is called before the request is ready to run so that we can
         * decide whether to preempt the entire chain so that it is ready to
         * run at the earliest possible convenience.
         */
        if (engine->schedule)
                engine->schedule(request, request->ctx->priority);

        local_bh_disable();
        i915_sw_fence_commit(&request->submit);
        local_bh_enable(); /* Kick the execlists tasklet if just scheduled */
}

static unsigned long local_clock_us(unsigned int *cpu)
{
        unsigned long t;

        /* Cheaply and approximately convert from nanoseconds to microseconds.
         * The result and subsequent calculations are also defined in the same
         * approximate microseconds units. The principal source of timing
         * error here is from the simple truncation.
         *
         * Note that local_clock() is only defined wrt to the current CPU;
         * the comparisons are no longer valid if we switch CPUs. Instead of
         * blocking preemption for the entire busywait, we can detect the CPU
         * switch and use that as indicator of system load and a reason to
         * stop busywaiting, see busywait_stop().
         */
        *cpu = get_cpu();
        t = local_clock() >> 10;
        put_cpu();

        return t;
}

static bool busywait_stop(unsigned long timeout, unsigned int cpu)
{
        unsigned int this_cpu;

        if (time_after(local_clock_us(&this_cpu), timeout))
                return true;

        return this_cpu != cpu;
}

bool __i915_spin_request(const struct drm_i915_gem_request *req,
                         u32 seqno, int state, unsigned long timeout_us)
{
        struct intel_engine_cs *engine = req->engine;
        unsigned int irq, cpu;

        /* When waiting for high frequency requests, e.g. during synchronous
         * rendering split between the CPU and GPU, the finite amount of time
         * required to set up the irq and wait upon it limits the response
         * rate. By busywaiting on the request completion for a short while we
         * can service the high frequency waits as quick as possible. However,
         * if it is a slow request, we want to sleep as quickly as possible.
         * The tradeoff between waiting and sleeping is roughly the time it
         * takes to sleep on a request, on the order of a microsecond.
         */

        irq = atomic_read(&engine->irq_count);
        timeout_us += local_clock_us(&cpu);
        do {
                if (seqno != i915_gem_request_global_seqno(req))
                        break;

                if (i915_seqno_passed(intel_engine_get_seqno(req->engine),
                                      seqno))
                        return true;

                /* Seqno are meant to be ordered *before* the interrupt. If
                 * we see an interrupt without a corresponding seqno advance,
                 * assume we won't see one in the near future but require
                 * the engine->seqno_barrier() to fixup coherency.
                 */
                if (atomic_read(&engine->irq_count) != irq)
                        break;

                if (signal_pending_state(state, current))
                        break;

                if (busywait_stop(timeout_us, cpu))
                        break;

                cpu_relax();
        } while (!need_resched());

        return false;
}

static bool __i915_wait_request_check_and_reset(struct drm_i915_gem_request *request)
{
        if (likely(!i915_reset_handoff(&request->i915->gpu_error)))
                return false;

        __set_current_state(TASK_RUNNING);
        i915_reset(request->i915);
        return true;
}

/**
 * i915_wait_request - wait until execution of request has finished
 * @req: the request to wait upon
 * @flags: how to wait
 * @timeout: how long to wait in jiffies
 *
 * i915_wait_request() waits for the request to be completed, for a
 * maximum of @timeout jiffies (with MAX_SCHEDULE_TIMEOUT implying an
 * unbounded wait).
 *
 * If the caller holds the struct_mutex, the caller must pass I915_WAIT_LOCKED
 * in via the flags, and vice versa if the struct_mutex is not held, the caller
 * must not specify that the wait is locked.
 *
 * Returns the remaining time (in jiffies) if the request completed, which may
 * be zero or -ETIME if the request is unfinished after the timeout expires.
 * May return -EINTR is called with I915_WAIT_INTERRUPTIBLE and a signal is
 * pending before the request completes.
 */
long i915_wait_request(struct drm_i915_gem_request *req,
                       unsigned int flags,
                       long timeout)
{
        const int state = flags & I915_WAIT_INTERRUPTIBLE ?
                TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE;
        wait_queue_head_t *errq = &req->i915->gpu_error.wait_queue;
        DEFINE_WAIT_FUNC(reset, default_wake_function);
        DEFINE_WAIT_FUNC(exec, default_wake_function);
        struct intel_wait wait;

        might_sleep();
#if IS_ENABLED(CONFIG_LOCKDEP)
        GEM_BUG_ON(debug_locks &&
                   !!lockdep_is_held(&req->i915->drm.struct_mutex) !=
                   !!(flags & I915_WAIT_LOCKED));
#endif
        GEM_BUG_ON(timeout < 0);

        if (i915_gem_request_completed(req))
                return timeout;

        if (!timeout)
                return -ETIME;

        trace_i915_gem_request_wait_begin(req, flags);

        add_wait_queue(&req->execute, &exec);
        if (flags & I915_WAIT_LOCKED)
                add_wait_queue(errq, &reset);

        intel_wait_init(&wait, req);

restart:
        do {
                set_current_state(state);
                if (intel_wait_update_request(&wait, req))
                        break;

                if (flags & I915_WAIT_LOCKED &&
                    __i915_wait_request_check_and_reset(req))
                        continue;

                if (signal_pending_state(state, current)) {
                        timeout = -ERESTARTSYS;
                        goto complete;
                }

                if (!timeout) {
                        timeout = -ETIME;
                        goto complete;
                }

                timeout = io_schedule_timeout(timeout);
        } while (1);

        GEM_BUG_ON(!intel_wait_has_seqno(&wait));
        GEM_BUG_ON(!i915_sw_fence_signaled(&req->submit));

        /* Optimistic short spin before touching IRQs */
        if (i915_spin_request(req, state, 5))
                goto complete;

        set_current_state(state);
        if (intel_engine_add_wait(req->engine, &wait))
                /* In order to check that we haven't missed the interrupt
                 * as we enabled it, we need to kick ourselves to do a
                 * coherent check on the seqno before we sleep.
                 */
                goto wakeup;

        if (flags & I915_WAIT_LOCKED)
                __i915_wait_request_check_and_reset(req);

        for (;;) {
                if (signal_pending_state(state, current)) {
                        timeout = -ERESTARTSYS;
                        break;
                }

                if (!timeout) {
                        timeout = -ETIME;
                        break;
                }

                timeout = io_schedule_timeout(timeout);

                if (intel_wait_complete(&wait) &&
                    intel_wait_check_request(&wait, req))
                        break;

                set_current_state(state);

wakeup:
                /* Carefully check if the request is complete, giving time
                 * for the seqno to be visible following the interrupt.
                 * We also have to check in case we are kicked by the GPU
                 * reset in order to drop the struct_mutex.
                 */
                if (__i915_request_irq_complete(req))
                        break;

                /* If the GPU is hung, and we hold the lock, reset the GPU
                 * and then check for completion. On a full reset, the engine's
                 * HW seqno will be advanced passed us and we are complete.
                 * If we do a partial reset, we have to wait for the GPU to
                 * resume and update the breadcrumb.
                 *
                 * If we don't hold the mutex, we can just wait for the worker
                 * to come along and update the breadcrumb (either directly
                 * itself, or indirectly by recovering the GPU).
                 */
                if (flags & I915_WAIT_LOCKED &&
                    __i915_wait_request_check_and_reset(req))
                        continue;

                /* Only spin if we know the GPU is processing this request */
                if (i915_spin_request(req, state, 2))
                        break;

                if (!intel_wait_check_request(&wait, req)) {
                        intel_engine_remove_wait(req->engine, &wait);
                        goto restart;
                }
        }

        intel_engine_remove_wait(req->engine, &wait);
complete:
        __set_current_state(TASK_RUNNING);
        if (flags & I915_WAIT_LOCKED)
                remove_wait_queue(errq, &reset);
        remove_wait_queue(&req->execute, &exec);
        trace_i915_gem_request_wait_end(req);

        return timeout;
}

static void engine_retire_requests(struct intel_engine_cs *engine)
{
        struct drm_i915_gem_request *request, *next;
        u32 seqno = intel_engine_get_seqno(engine);
        LIST_HEAD(retire);

        spin_lock_irq(&engine->timeline->lock);
        list_for_each_entry_safe(request, next,
                                 &engine->timeline->requests, link) {
                if (!i915_seqno_passed(seqno, request->global_seqno))
                        break;

                list_move_tail(&request->link, &retire);
        }
        spin_unlock_irq(&engine->timeline->lock);

        list_for_each_entry_safe(request, next, &retire, link)
                i915_gem_request_retire(request);
}

void i915_gem_retire_requests(struct drm_i915_private *dev_priv)
{
        struct intel_engine_cs *engine;
        enum intel_engine_id id;

        lockdep_assert_held(&dev_priv->drm.struct_mutex);

        if (!dev_priv->gt.active_requests)
                return;

        for_each_engine(engine, dev_priv, id)
                engine_retire_requests(engine);
}

#if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
#include "selftests/mock_request.c"
#include "selftests/i915_gem_request.c"
#endif