/*
 * Copyright 2017 Advanced Micro Devices, Inc.
 *
 * 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 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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 "amdgpu_ids.h"

#include <linux/idr.h>
#include <linux/dma-fence-array.h>
#include <drm/drmP.h>

#include "amdgpu.h"
#include "amdgpu_trace.h"

/*
 * PASID manager
 *
 * PASIDs are global address space identifiers that can be shared
 * between the GPU, an IOMMU and the driver. VMs on different devices
 * may use the same PASID if they share the same address
 * space. Therefore PASIDs are allocated using a global IDA. VMs are
 * looked up from the PASID per amdgpu_device.
 */
static DEFINE_IDA(amdgpu_pasid_ida);

/* Helper to free pasid from a fence callback */
struct amdgpu_pasid_cb {
        struct dma_fence_cb cb;
        unsigned int pasid;
};

/**
 * amdgpu_pasid_alloc - Allocate a PASID
 * @bits: Maximum width of the PASID in bits, must be at least 1
 *
 * Allocates a PASID of the given width while keeping smaller PASIDs
 * available if possible.
 *
 * Returns a positive integer on success. Returns %-EINVAL if bits==0.
 * Returns %-ENOSPC if no PASID was available. Returns %-ENOMEM on
 * memory allocation failure.
 */
int amdgpu_pasid_alloc(unsigned int bits)
{
        int pasid = -EINVAL;

        for (bits = min(bits, 31U); bits > 0; bits--) {
                pasid = ida_simple_get(&amdgpu_pasid_ida,
                                       1U << (bits - 1), 1U << bits,
                                       GFP_KERNEL);
                if (pasid != -ENOSPC)
                        break;
        }

#if 0
        if (pasid >= 0)
                trace_amdgpu_pasid_allocated(pasid);
#endif

        return pasid;
}

/**
 * amdgpu_pasid_free - Free a PASID
 * @pasid: PASID to free
 */
void amdgpu_pasid_free(unsigned int pasid)
{
#if 0
        trace_amdgpu_pasid_freed(pasid);
#endif
        ida_simple_remove(&amdgpu_pasid_ida, pasid);
}

static void amdgpu_pasid_free_cb(struct dma_fence *fence,
                                 struct dma_fence_cb *_cb)
{
        struct amdgpu_pasid_cb *cb =
                container_of(_cb, struct amdgpu_pasid_cb, cb);

        amdgpu_pasid_free(cb->pasid);
        dma_fence_put(fence);
        kfree(cb);
}

/**
 * amdgpu_pasid_free_delayed - free pasid when fences signal
 *
 * @resv: reservation object with the fences to wait for
 * @pasid: pasid to free
 *
 * Free the pasid only after all the fences in resv are signaled.
 */
void amdgpu_pasid_free_delayed(struct reservation_object *resv,
                               unsigned int pasid)
{
        struct dma_fence *fence, **fences;
        struct amdgpu_pasid_cb *cb;
        unsigned count;
        int r;

        r = reservation_object_get_fences_rcu(resv, NULL, &count, &fences);
        if (r)
                goto fallback;

        if (count == 0) {
                amdgpu_pasid_free(pasid);
                return;
        }

        if (count == 1) {
                fence = fences[0];
                kfree(fences);
        } else {
                uint64_t context = dma_fence_context_alloc(1);
                struct dma_fence_array *array;

                array = dma_fence_array_create(count, fences, context,
                                               1, false);
                if (!array) {
                        kfree(fences);
                        goto fallback;
                }
                fence = &array->base;
        }

        cb = kmalloc(sizeof(*cb), M_DRM, GFP_KERNEL);
        if (!cb) {
                /* Last resort when we are OOM */
                dma_fence_wait(fence, false);
                dma_fence_put(fence);
                amdgpu_pasid_free(pasid);
        } else {
                cb->pasid = pasid;
                if (dma_fence_add_callback(fence, &cb->cb,
                                           amdgpu_pasid_free_cb))
                        amdgpu_pasid_free_cb(fence, &cb->cb);
        }

        return;

fallback:
        /* Not enough memory for the delayed delete, as last resort
         * block for all the fences to complete.
         */
        reservation_object_wait_timeout_rcu(resv, true, false,
                                            MAX_SCHEDULE_TIMEOUT);
        amdgpu_pasid_free(pasid);
}

/*
 * VMID manager
 *
 * VMIDs are a per VMHUB identifier for page tables handling.
 */

/**
 * amdgpu_vmid_had_gpu_reset - check if reset occured since last use
 *
 * @adev: amdgpu_device pointer
 * @id: VMID structure
 *
 * Check if GPU reset occured since last use of the VMID.
 */
bool amdgpu_vmid_had_gpu_reset(struct amdgpu_device *adev,
                               struct amdgpu_vmid *id)
{
        return id->current_gpu_reset_count !=
                atomic_read(&adev->gpu_reset_counter);
}

/**
 * amdgpu_vm_grab_idle - grab idle VMID
 *
 * @vm: vm to allocate id for
 * @ring: ring we want to submit job to
 * @sync: sync object where we add dependencies
 * @idle: resulting idle VMID
 *
 * Try to find an idle VMID, if none is idle add a fence to wait to the sync
 * object. Returns -ENOMEM when we are out of memory.
 */
static int amdgpu_vmid_grab_idle(struct amdgpu_vm *vm,
                                 struct amdgpu_ring *ring,
                                 struct amdgpu_sync *sync,
                                 struct amdgpu_vmid **idle)
{
        struct amdgpu_device *adev = ring->adev;
        unsigned vmhub = ring->funcs->vmhub;
        struct amdgpu_vmid_mgr *id_mgr = &adev->vm_manager.id_mgr[vmhub];
        struct dma_fence **fences;
        unsigned i;
        int r;

        if (ring->vmid_wait && !dma_fence_is_signaled(ring->vmid_wait))
                return amdgpu_sync_fence(adev, sync, ring->vmid_wait, false);

        fences = kmalloc_array(sizeof(void *), id_mgr->num_ids, GFP_KERNEL);
        if (!fences)
                return -ENOMEM;

        /* Check if we have an idle VMID */
        i = 0;
        list_for_each_entry((*idle), &id_mgr->ids_lru, list) {
                fences[i] = amdgpu_sync_peek_fence(&(*idle)->active, ring);
                if (!fences[i])
                        break;
                ++i;
        }

        /* If we can't find a idle VMID to use, wait till one becomes available */
        if (&(*idle)->list == &id_mgr->ids_lru) {
                u64 fence_context = adev->vm_manager.fence_context + ring->idx;
                unsigned seqno = ++adev->vm_manager.seqno[ring->idx];
                struct dma_fence_array *array;
                unsigned j;

                *idle = NULL;
                for (j = 0; j < i; ++j)
                        dma_fence_get(fences[j]);

                array = dma_fence_array_create(i, fences, fence_context,
                                               seqno, true);
                if (!array) {
                        for (j = 0; j < i; ++j)
                                dma_fence_put(fences[j]);
                        kfree(fences);
                        return -ENOMEM;
                }

                r = amdgpu_sync_fence(adev, sync, &array->base, false);
                dma_fence_put(ring->vmid_wait);
                ring->vmid_wait = &array->base;
                return r;
        }
        kfree(fences);

        return 0;
}

/**
 * amdgpu_vm_grab_reserved - try to assign reserved VMID
 *
 * @vm: vm to allocate id for
 * @ring: ring we want to submit job to
 * @sync: sync object where we add dependencies
 * @fence: fence protecting ID from reuse
 * @job: job who wants to use the VMID
 *
 * Try to assign a reserved VMID.
 */
static int amdgpu_vmid_grab_reserved(struct amdgpu_vm *vm,
                                     struct amdgpu_ring *ring,
                                     struct amdgpu_sync *sync,
                                     struct dma_fence *fence,
                                     struct amdgpu_job *job,
                                     struct amdgpu_vmid **id)
{
        struct amdgpu_device *adev = ring->adev;
        unsigned vmhub = ring->funcs->vmhub;
        uint64_t fence_context = adev->fence_context + ring->idx;
        struct dma_fence *updates = sync->last_vm_update;
        bool needs_flush = vm->use_cpu_for_update;
        int r = 0;

        *id = vm->reserved_vmid[vmhub];
        if (updates && (*id)->flushed_updates &&
            updates->context == (*id)->flushed_updates->context &&
            !dma_fence_is_later(updates, (*id)->flushed_updates))
            updates = NULL;

        if ((*id)->owner != vm->entity.fence_context ||
            job->vm_pd_addr != (*id)->pd_gpu_addr ||
            updates || !(*id)->last_flush ||
            ((*id)->last_flush->context != fence_context &&
             !dma_fence_is_signaled((*id)->last_flush))) {
                struct dma_fence *tmp;

                /* to prevent one context starved by another context */
                (*id)->pd_gpu_addr = 0;
                tmp = amdgpu_sync_peek_fence(&(*id)->active, ring);
                if (tmp) {
                        *id = NULL;
                        r = amdgpu_sync_fence(adev, sync, tmp, false);
                        return r;
                }
                needs_flush = true;
        }

        /* Good we can use this VMID. Remember this submission as
        * user of the VMID.
        */
        r = amdgpu_sync_fence(ring->adev, &(*id)->active, fence, false);
        if (r)
                return r;

        if (updates) {
                dma_fence_put((*id)->flushed_updates);
                (*id)->flushed_updates = dma_fence_get(updates);
        }
        job->vm_needs_flush = needs_flush;
        return 0;
}

/**
 * amdgpu_vm_grab_used - try to reuse a VMID
 *
 * @vm: vm to allocate id for
 * @ring: ring we want to submit job to
 * @sync: sync object where we add dependencies
 * @fence: fence protecting ID from reuse
 * @job: job who wants to use the VMID
 * @id: resulting VMID
 *
 * Try to reuse a VMID for this submission.
 */
static int amdgpu_vmid_grab_used(struct amdgpu_vm *vm,
                                 struct amdgpu_ring *ring,
                                 struct amdgpu_sync *sync,
                                 struct dma_fence *fence,
                                 struct amdgpu_job *job,
                                 struct amdgpu_vmid **id)
{
        struct amdgpu_device *adev = ring->adev;
        unsigned vmhub = ring->funcs->vmhub;
        struct amdgpu_vmid_mgr *id_mgr = &adev->vm_manager.id_mgr[vmhub];
        uint64_t fence_context = adev->fence_context + ring->idx;
        struct dma_fence *updates = sync->last_vm_update;
        int r;

        job->vm_needs_flush = vm->use_cpu_for_update;

        /* Check if we can use a VMID already assigned to this VM */
        list_for_each_entry_reverse((*id), &id_mgr->ids_lru, list) {
                bool needs_flush = vm->use_cpu_for_update;
                struct dma_fence *flushed;

                /* Check all the prerequisites to using this VMID */
                if ((*id)->owner != vm->entity.fence_context)
                        continue;

                if ((*id)->pd_gpu_addr != job->vm_pd_addr)
                        continue;

                if (!(*id)->last_flush ||
                    ((*id)->last_flush->context != fence_context &&
                     !dma_fence_is_signaled((*id)->last_flush)))
                        needs_flush = true;

                flushed  = (*id)->flushed_updates;
                if (updates && (!flushed || dma_fence_is_later(updates, flushed)))
                        needs_flush = true;

                /* Concurrent flushes are only possible starting with Vega10 */
                if (adev->asic_type < CHIP_VEGA10 && needs_flush)
                        continue;

                /* Good, we can use this VMID. Remember this submission as
                 * user of the VMID.
                 */
                r = amdgpu_sync_fence(ring->adev, &(*id)->active, fence, false);
                if (r)
                        return r;

                if (updates && (!flushed || dma_fence_is_later(updates, flushed))) {
                        dma_fence_put((*id)->flushed_updates);
                        (*id)->flushed_updates = dma_fence_get(updates);
                }

                job->vm_needs_flush |= needs_flush;
                return 0;
        }

        *id = NULL;
        return 0;
}

/**
 * amdgpu_vm_grab_id - allocate the next free VMID
 *
 * @vm: vm to allocate id for
 * @ring: ring we want to submit job to
 * @sync: sync object where we add dependencies
 * @fence: fence protecting ID from reuse
 * @job: job who wants to use the VMID
 *
 * Allocate an id for the vm, adding fences to the sync obj as necessary.
 */
int amdgpu_vmid_grab(struct amdgpu_vm *vm, struct amdgpu_ring *ring,
                     struct amdgpu_sync *sync, struct dma_fence *fence,
                     struct amdgpu_job *job)
{
        struct amdgpu_device *adev = ring->adev;
        unsigned vmhub = ring->funcs->vmhub;
        struct amdgpu_vmid_mgr *id_mgr = &adev->vm_manager.id_mgr[vmhub];
        struct amdgpu_vmid *idle = NULL;
        struct amdgpu_vmid *id = NULL;
        int r = 0;

        mutex_lock(&id_mgr->lock);
        r = amdgpu_vmid_grab_idle(vm, ring, sync, &idle);
        if (r || !idle)
                goto error;

        if (vm->reserved_vmid[vmhub]) {
                r = amdgpu_vmid_grab_reserved(vm, ring, sync, fence, job, &id);
                if (r || !id)
                        goto error;
        } else {
                r = amdgpu_vmid_grab_used(vm, ring, sync, fence, job, &id);
                if (r)
                        goto error;

                if (!id) {
                        struct dma_fence *updates = sync->last_vm_update;

                        /* Still no ID to use? Then use the idle one found earlier */
                        id = idle;

                        /* Remember this submission as user of the VMID */
                        r = amdgpu_sync_fence(ring->adev, &id->active,
                                              fence, false);
                        if (r)
                                goto error;

                        dma_fence_put(id->flushed_updates);
                        id->flushed_updates = dma_fence_get(updates);
                        job->vm_needs_flush = true;
                }

                list_move_tail(&id->list, &id_mgr->ids_lru);
        }

        id->pd_gpu_addr = job->vm_pd_addr;
        id->owner = vm->entity.fence_context;

        if (job->vm_needs_flush) {
                dma_fence_put(id->last_flush);
                id->last_flush = NULL;
        }
        job->vmid = id - id_mgr->ids;
        job->pasid = vm->pasid;
        trace_amdgpu_vm_grab_id(vm, ring, job);

error:
        mutex_unlock(&id_mgr->lock);
        return r;
}

int amdgpu_vmid_alloc_reserved(struct amdgpu_device *adev,
                               struct amdgpu_vm *vm,
                               unsigned vmhub)
{
        struct amdgpu_vmid_mgr *id_mgr;
        struct amdgpu_vmid *idle;
        int r = 0;

        id_mgr = &adev->vm_manager.id_mgr[vmhub];
        mutex_lock(&id_mgr->lock);
        if (vm->reserved_vmid[vmhub])
                goto unlock;
        if (atomic_inc_return(&id_mgr->reserved_vmid_num) >
            AMDGPU_VM_MAX_RESERVED_VMID) {
                DRM_ERROR("Over limitation of reserved vmid\n");
                atomic_dec(&id_mgr->reserved_vmid_num);
                r = -EINVAL;
                goto unlock;
        }
        /* Select the first entry VMID */
        idle = list_first_entry(&id_mgr->ids_lru, struct amdgpu_vmid, list);
        list_del_init(&idle->list);
        vm->reserved_vmid[vmhub] = idle;
        mutex_unlock(&id_mgr->lock);

        return 0;
unlock:
        mutex_unlock(&id_mgr->lock);
        return r;
}

void amdgpu_vmid_free_reserved(struct amdgpu_device *adev,
                               struct amdgpu_vm *vm,
                               unsigned vmhub)
{
        struct amdgpu_vmid_mgr *id_mgr = &adev->vm_manager.id_mgr[vmhub];

        mutex_lock(&id_mgr->lock);
        if (vm->reserved_vmid[vmhub]) {
                list_add(&vm->reserved_vmid[vmhub]->list,
                        &id_mgr->ids_lru);
                vm->reserved_vmid[vmhub] = NULL;
                atomic_dec(&id_mgr->reserved_vmid_num);
        }
        mutex_unlock(&id_mgr->lock);
}

/**
 * amdgpu_vmid_reset - reset VMID to zero
 *
 * @adev: amdgpu device structure
 * @vmid: vmid number to use
 *
 * Reset saved GDW, GWS and OA to force switch on next flush.
 */
void amdgpu_vmid_reset(struct amdgpu_device *adev, unsigned vmhub,
                       unsigned vmid)
{
        struct amdgpu_vmid_mgr *id_mgr = &adev->vm_manager.id_mgr[vmhub];
        struct amdgpu_vmid *id = &id_mgr->ids[vmid];

        mutex_lock(&id_mgr->lock);
        id->owner = 0;
        id->gds_base = 0;
        id->gds_size = 0;
        id->gws_base = 0;
        id->gws_size = 0;
        id->oa_base = 0;
        id->oa_size = 0;
        mutex_unlock(&id_mgr->lock);
}

/**
 * amdgpu_vmid_reset_all - reset VMID to zero
 *
 * @adev: amdgpu device structure
 *
 * Reset VMID to force flush on next use
 */
void amdgpu_vmid_reset_all(struct amdgpu_device *adev)
{
        unsigned i, j;

        for (i = 0; i < AMDGPU_MAX_VMHUBS; ++i) {
                struct amdgpu_vmid_mgr *id_mgr =
                        &adev->vm_manager.id_mgr[i];

                for (j = 1; j < id_mgr->num_ids; ++j)
                        amdgpu_vmid_reset(adev, i, j);
        }
}

/**
 * amdgpu_vmid_mgr_init - init the VMID manager
 *
 * @adev: amdgpu_device pointer
 *
 * Initialize the VM manager structures
 */
void amdgpu_vmid_mgr_init(struct amdgpu_device *adev)
{
        unsigned i, j;

        for (i = 0; i < AMDGPU_MAX_VMHUBS; ++i) {
                struct amdgpu_vmid_mgr *id_mgr =
                        &adev->vm_manager.id_mgr[i];

                lockinit(&id_mgr->lock, "agdimgrl", 0, LK_CANRECURSE);
                INIT_LIST_HEAD(&id_mgr->ids_lru);
                atomic_set(&id_mgr->reserved_vmid_num, 0);

                /* skip over VMID 0, since it is the system VM */
                for (j = 1; j < id_mgr->num_ids; ++j) {
                        amdgpu_vmid_reset(adev, i, j);
                        amdgpu_sync_create(&id_mgr->ids[j].active);
                        list_add_tail(&id_mgr->ids[j].list, &id_mgr->ids_lru);
                }
        }
}

/**
 * amdgpu_vmid_mgr_fini - cleanup VM manager
 *
 * @adev: amdgpu_device pointer
 *
 * Cleanup the VM manager and free resources.
 */
void amdgpu_vmid_mgr_fini(struct amdgpu_device *adev)
{
        unsigned i, j;

        for (i = 0; i < AMDGPU_MAX_VMHUBS; ++i) {
                struct amdgpu_vmid_mgr *id_mgr =
                        &adev->vm_manager.id_mgr[i];

                mutex_destroy(&id_mgr->lock);
                for (j = 0; j < AMDGPU_NUM_VMID; ++j) {
                        struct amdgpu_vmid *id = &id_mgr->ids[j];

                        amdgpu_sync_free(&id->active);
                        dma_fence_put(id->flushed_updates);
                        dma_fence_put(id->last_flush);
                        dma_fence_put(id->pasid_mapping);
                }
        }
}