root/sys/dev/pci/drm/amd/amdgpu/amdgpu_userq.c
// SPDX-License-Identifier: MIT
/*
 * Copyright 2023 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 <drm/drm_auth.h>
#include <drm/drm_exec.h>
#include <linux/pm_runtime.h>

#include "amdgpu.h"
#include "amdgpu_vm.h"
#include "amdgpu_userq.h"
#include "amdgpu_userq_fence.h"

u32 amdgpu_userq_get_supported_ip_mask(struct amdgpu_device *adev)
{
        int i;
        u32 userq_ip_mask = 0;

        for (i = 0; i < AMDGPU_HW_IP_NUM; i++) {
                if (adev->userq_funcs[i])
                        userq_ip_mask |= (1 << i);
        }

        return userq_ip_mask;
}

static int amdgpu_userq_buffer_va_list_add(struct amdgpu_usermode_queue *queue,
                                           struct amdgpu_bo_va_mapping *va_map, u64 addr)
{
        struct amdgpu_userq_va_cursor *va_cursor;
        struct userq_va_list;

        va_cursor = kzalloc(sizeof(*va_cursor), GFP_KERNEL);
        if (!va_cursor)
                return -ENOMEM;

        INIT_LIST_HEAD(&va_cursor->list);
        va_cursor->gpu_addr = addr;
        atomic_set(&va_map->bo_va->userq_va_mapped, 1);
        list_add(&va_cursor->list, &queue->userq_va_list);

        return 0;
}

int amdgpu_userq_input_va_validate(struct amdgpu_usermode_queue *queue,
                                   u64 addr, u64 expected_size)
{
        struct amdgpu_bo_va_mapping *va_map;
        struct amdgpu_vm *vm = queue->vm;
        u64 user_addr;
        u64 size;
        int r = 0;

        user_addr = (addr & AMDGPU_GMC_HOLE_MASK) >> AMDGPU_GPU_PAGE_SHIFT;
        size = expected_size >> AMDGPU_GPU_PAGE_SHIFT;

        r = amdgpu_bo_reserve(vm->root.bo, false);
        if (r)
                return r;

        va_map = amdgpu_vm_bo_lookup_mapping(vm, user_addr);
        if (!va_map) {
                r = -EINVAL;
                goto out_err;
        }
        /* Only validate the userq whether resident in the VM mapping range */
        if (user_addr >= va_map->start  &&
            va_map->last - user_addr + 1 >= size) {
                amdgpu_userq_buffer_va_list_add(queue, va_map, user_addr);
                amdgpu_bo_unreserve(vm->root.bo);
                return 0;
        }

        r = -EINVAL;
out_err:
        amdgpu_bo_unreserve(vm->root.bo);
        return r;
}

static int
amdgpu_userq_preempt_helper(struct amdgpu_userq_mgr *uq_mgr,
                          struct amdgpu_usermode_queue *queue)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *userq_funcs =
                adev->userq_funcs[queue->queue_type];
        int r = 0;

        if (queue->state == AMDGPU_USERQ_STATE_MAPPED) {
                r = userq_funcs->preempt(uq_mgr, queue);
                if (r) {
                        queue->state = AMDGPU_USERQ_STATE_HUNG;
                } else {
                        queue->state = AMDGPU_USERQ_STATE_PREEMPTED;
                }
        }

        return r;
}

static int
amdgpu_userq_restore_helper(struct amdgpu_userq_mgr *uq_mgr,
                        struct amdgpu_usermode_queue *queue)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *userq_funcs =
                adev->userq_funcs[queue->queue_type];
        int r = 0;

        if (queue->state == AMDGPU_USERQ_STATE_PREEMPTED) {
                r = userq_funcs->restore(uq_mgr, queue);
                if (r) {
                        queue->state = AMDGPU_USERQ_STATE_HUNG;
                } else {
                        queue->state = AMDGPU_USERQ_STATE_MAPPED;
                }
        }

        return r;
}

static int
amdgpu_userq_unmap_helper(struct amdgpu_userq_mgr *uq_mgr,
                          struct amdgpu_usermode_queue *queue)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *userq_funcs =
                adev->userq_funcs[queue->queue_type];
        int r = 0;

        if ((queue->state == AMDGPU_USERQ_STATE_MAPPED) ||
                (queue->state == AMDGPU_USERQ_STATE_PREEMPTED)) {
                r = userq_funcs->unmap(uq_mgr, queue);
                if (r)
                        queue->state = AMDGPU_USERQ_STATE_HUNG;
                else
                        queue->state = AMDGPU_USERQ_STATE_UNMAPPED;
        }
        return r;
}

static int
amdgpu_userq_map_helper(struct amdgpu_userq_mgr *uq_mgr,
                        struct amdgpu_usermode_queue *queue)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *userq_funcs =
                adev->userq_funcs[queue->queue_type];
        int r = 0;

        if (queue->state == AMDGPU_USERQ_STATE_UNMAPPED) {
                r = userq_funcs->map(uq_mgr, queue);
                if (r) {
                        queue->state = AMDGPU_USERQ_STATE_HUNG;
                } else {
                        queue->state = AMDGPU_USERQ_STATE_MAPPED;
                }
        }
        return r;
}

static void
amdgpu_userq_wait_for_last_fence(struct amdgpu_userq_mgr *uq_mgr,
                                 struct amdgpu_usermode_queue *queue)
{
        struct dma_fence *f = queue->last_fence;
        int ret;

        if (f && !dma_fence_is_signaled(f)) {
                ret = dma_fence_wait_timeout(f, true, msecs_to_jiffies(100));
                if (ret <= 0)
                        drm_file_err(uq_mgr->file, "Timed out waiting for fence=%llu:%llu\n",
                                     f->context, f->seqno);
        }
}

static void
amdgpu_userq_cleanup(struct amdgpu_userq_mgr *uq_mgr,
                     struct amdgpu_usermode_queue *queue,
                     int queue_id)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *uq_funcs = adev->userq_funcs[queue->queue_type];

        uq_funcs->mqd_destroy(uq_mgr, queue);
        amdgpu_userq_fence_driver_free(queue);
        idr_remove(&uq_mgr->userq_idr, queue_id);
        list_del(&queue->userq_va_list);
        kfree(queue);
}

static struct amdgpu_usermode_queue *
amdgpu_userq_find(struct amdgpu_userq_mgr *uq_mgr, int qid)
{
        return idr_find(&uq_mgr->userq_idr, qid);
}

void
amdgpu_userq_ensure_ev_fence(struct amdgpu_userq_mgr *uq_mgr,
                             struct amdgpu_eviction_fence_mgr *evf_mgr)
{
        struct amdgpu_eviction_fence *ev_fence;

retry:
        /* Flush any pending resume work to create ev_fence */
        flush_delayed_work(&uq_mgr->resume_work);

        mutex_lock(&uq_mgr->userq_mutex);
        spin_lock(&evf_mgr->ev_fence_lock);
        ev_fence = evf_mgr->ev_fence;
        spin_unlock(&evf_mgr->ev_fence_lock);
        if (!ev_fence || dma_fence_is_signaled(&ev_fence->base)) {
                mutex_unlock(&uq_mgr->userq_mutex);
                /*
                 * Looks like there was no pending resume work,
                 * add one now to create a valid eviction fence
                 */
                schedule_delayed_work(&uq_mgr->resume_work, 0);
                goto retry;
        }
}

int amdgpu_userq_create_object(struct amdgpu_userq_mgr *uq_mgr,
                               struct amdgpu_userq_obj *userq_obj,
                               int size)
{
        struct amdgpu_device *adev = uq_mgr->adev;
        struct amdgpu_bo_param bp;
        int r;

        memset(&bp, 0, sizeof(bp));
        bp.byte_align = PAGE_SIZE;
        bp.domain = AMDGPU_GEM_DOMAIN_GTT;
        bp.flags = AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS |
                   AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
        bp.type = ttm_bo_type_kernel;
        bp.size = size;
        bp.resv = NULL;
        bp.bo_ptr_size = sizeof(struct amdgpu_bo);

        r = amdgpu_bo_create(adev, &bp, &userq_obj->obj);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to allocate BO for userqueue (%d)", r);
                return r;
        }

        r = amdgpu_bo_reserve(userq_obj->obj, true);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to reserve BO to map (%d)", r);
                goto free_obj;
        }

        r = amdgpu_ttm_alloc_gart(&(userq_obj->obj)->tbo);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to alloc GART for userqueue object (%d)", r);
                goto unresv;
        }

        r = amdgpu_bo_kmap(userq_obj->obj, &userq_obj->cpu_ptr);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to map BO for userqueue (%d)", r);
                goto unresv;
        }

        userq_obj->gpu_addr = amdgpu_bo_gpu_offset(userq_obj->obj);
        amdgpu_bo_unreserve(userq_obj->obj);
        memset(userq_obj->cpu_ptr, 0, size);
        return 0;

unresv:
        amdgpu_bo_unreserve(userq_obj->obj);

free_obj:
        amdgpu_bo_unref(&userq_obj->obj);
        return r;
}

void amdgpu_userq_destroy_object(struct amdgpu_userq_mgr *uq_mgr,
                                 struct amdgpu_userq_obj *userq_obj)
{
        amdgpu_bo_kunmap(userq_obj->obj);
        amdgpu_bo_unref(&userq_obj->obj);
}

uint64_t
amdgpu_userq_get_doorbell_index(struct amdgpu_userq_mgr *uq_mgr,
                                struct amdgpu_db_info *db_info,
                                struct drm_file *filp)
{
        uint64_t index;
        struct drm_gem_object *gobj;
        struct amdgpu_userq_obj *db_obj = db_info->db_obj;
        int r, db_size;

        gobj = drm_gem_object_lookup(filp, db_info->doorbell_handle);
        if (gobj == NULL) {
                drm_file_err(uq_mgr->file, "Can't find GEM object for doorbell\n");
                return -EINVAL;
        }

        db_obj->obj = amdgpu_bo_ref(gem_to_amdgpu_bo(gobj));
        drm_gem_object_put(gobj);

        r = amdgpu_bo_reserve(db_obj->obj, true);
        if (r) {
                drm_file_err(uq_mgr->file, "[Usermode queues] Failed to pin doorbell object\n");
                goto unref_bo;
        }

        /* Pin the BO before generating the index, unpin in queue destroy */
        r = amdgpu_bo_pin(db_obj->obj, AMDGPU_GEM_DOMAIN_DOORBELL);
        if (r) {
                drm_file_err(uq_mgr->file, "[Usermode queues] Failed to pin doorbell object\n");
                goto unresv_bo;
        }

        switch (db_info->queue_type) {
        case AMDGPU_HW_IP_GFX:
        case AMDGPU_HW_IP_COMPUTE:
        case AMDGPU_HW_IP_DMA:
                db_size = sizeof(u64);
                break;

        case AMDGPU_HW_IP_VCN_ENC:
                db_size = sizeof(u32);
                db_info->doorbell_offset += AMDGPU_NAVI10_DOORBELL64_VCN0_1 << 1;
                break;

        case AMDGPU_HW_IP_VPE:
                db_size = sizeof(u32);
                db_info->doorbell_offset += AMDGPU_NAVI10_DOORBELL64_VPE << 1;
                break;

        default:
                drm_file_err(uq_mgr->file, "[Usermode queues] IP %d not support\n",
                             db_info->queue_type);
                r = -EINVAL;
                goto unpin_bo;
        }

        index = amdgpu_doorbell_index_on_bar(uq_mgr->adev, db_obj->obj,
                                             db_info->doorbell_offset, db_size);
        drm_dbg_driver(adev_to_drm(uq_mgr->adev),
                       "[Usermode queues] doorbell index=%lld\n", index);
        amdgpu_bo_unreserve(db_obj->obj);
        return index;

unpin_bo:
        amdgpu_bo_unpin(db_obj->obj);
unresv_bo:
        amdgpu_bo_unreserve(db_obj->obj);
unref_bo:
        amdgpu_bo_unref(&db_obj->obj);
        return r;
}

static int
amdgpu_userq_destroy(struct drm_file *filp, int queue_id)
{
        struct amdgpu_fpriv *fpriv = filp->driver_priv;
        struct amdgpu_userq_mgr *uq_mgr = &fpriv->userq_mgr;
        struct amdgpu_device *adev = uq_mgr->adev;
        struct amdgpu_usermode_queue *queue;
        int r = 0;

        cancel_delayed_work_sync(&uq_mgr->resume_work);
        mutex_lock(&uq_mgr->userq_mutex);

        queue = amdgpu_userq_find(uq_mgr, queue_id);
        if (!queue) {
                drm_dbg_driver(adev_to_drm(uq_mgr->adev), "Invalid queue id to destroy\n");
                mutex_unlock(&uq_mgr->userq_mutex);
                return -EINVAL;
        }
        amdgpu_userq_wait_for_last_fence(uq_mgr, queue);
        r = amdgpu_bo_reserve(queue->db_obj.obj, true);
        if (!r) {
                amdgpu_bo_unpin(queue->db_obj.obj);
                amdgpu_bo_unreserve(queue->db_obj.obj);
        }
        amdgpu_bo_unref(&queue->db_obj.obj);

#if defined(CONFIG_DEBUG_FS)
        debugfs_remove_recursive(queue->debugfs_queue);
#endif
        r = amdgpu_userq_unmap_helper(uq_mgr, queue);
        /*TODO: It requires a reset for userq hw unmap error*/
        if (unlikely(r != AMDGPU_USERQ_STATE_UNMAPPED)) {
                drm_warn(adev_to_drm(uq_mgr->adev), "trying to destroy a HW mapping userq\n");
                queue->state = AMDGPU_USERQ_STATE_HUNG;
        }
        amdgpu_userq_cleanup(uq_mgr, queue, queue_id);
        mutex_unlock(&uq_mgr->userq_mutex);

        pm_runtime_mark_last_busy(adev_to_drm(adev)->dev);
        pm_runtime_put_autosuspend(adev_to_drm(adev)->dev);

        return r;
}

static int amdgpu_userq_priority_permit(struct drm_file *filp,
                                        int priority)
{
        if (priority < AMDGPU_USERQ_CREATE_FLAGS_QUEUE_PRIORITY_HIGH)
                return 0;

        if (capable(CAP_SYS_NICE))
                return 0;

        if (drm_is_current_master(filp))
                return 0;

        return -EACCES;
}

#if defined(CONFIG_DEBUG_FS)
static int amdgpu_mqd_info_read(struct seq_file *m, void *unused)
{
        struct amdgpu_usermode_queue *queue = m->private;
        struct amdgpu_bo *bo;
        int r;

        if (!queue || !queue->mqd.obj)
                return -EINVAL;

        bo = amdgpu_bo_ref(queue->mqd.obj);
        r = amdgpu_bo_reserve(bo, true);
        if (r) {
                amdgpu_bo_unref(&bo);
                return -EINVAL;
        }

        seq_printf(m, "queue_type: %d\n", queue->queue_type);
        seq_printf(m, "mqd_gpu_address: 0x%llx\n", amdgpu_bo_gpu_offset(queue->mqd.obj));

        amdgpu_bo_unreserve(bo);
        amdgpu_bo_unref(&bo);

        return 0;
}

static int amdgpu_mqd_info_open(struct inode *inode, struct file *file)
{
        return single_open(file, amdgpu_mqd_info_read, inode->i_private);
}

static const struct file_operations amdgpu_mqd_info_fops = {
        .owner = THIS_MODULE,
        .open = amdgpu_mqd_info_open,
        .read = seq_read,
        .llseek = seq_lseek,
        .release = single_release,
};
#endif

static int
amdgpu_userq_create(struct drm_file *filp, union drm_amdgpu_userq *args)
{
        struct amdgpu_fpriv *fpriv = filp->driver_priv;
        struct amdgpu_userq_mgr *uq_mgr = &fpriv->userq_mgr;
        struct amdgpu_device *adev = uq_mgr->adev;
        const struct amdgpu_userq_funcs *uq_funcs;
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_db_info db_info;
        char *queue_name;
        bool skip_map_queue;
        uint64_t index;
        int qid, r = 0;
        int priority =
                (args->in.flags & AMDGPU_USERQ_CREATE_FLAGS_QUEUE_PRIORITY_MASK) >>
                AMDGPU_USERQ_CREATE_FLAGS_QUEUE_PRIORITY_SHIFT;

        r = amdgpu_userq_priority_permit(filp, priority);
        if (r)
                return r;

        r = pm_runtime_get_sync(adev_to_drm(adev)->dev);
        if (r < 0) {
                drm_file_err(uq_mgr->file, "pm_runtime_get_sync() failed for userqueue create\n");
                pm_runtime_put_autosuspend(adev_to_drm(adev)->dev);
                return r;
        }

        /*
         * There could be a situation that we are creating a new queue while
         * the other queues under this UQ_mgr are suspended. So if there is any
         * resume work pending, wait for it to get done.
         *
         * This will also make sure we have a valid eviction fence ready to be used.
         */
        mutex_lock(&adev->userq_mutex);
        amdgpu_userq_ensure_ev_fence(&fpriv->userq_mgr, &fpriv->evf_mgr);

        uq_funcs = adev->userq_funcs[args->in.ip_type];
        if (!uq_funcs) {
                drm_file_err(uq_mgr->file, "Usermode queue is not supported for this IP (%u)\n",
                             args->in.ip_type);
                r = -EINVAL;
                goto unlock;
        }

        queue = kzalloc(sizeof(struct amdgpu_usermode_queue), GFP_KERNEL);
        if (!queue) {
                drm_file_err(uq_mgr->file, "Failed to allocate memory for queue\n");
                r = -ENOMEM;
                goto unlock;
        }

        INIT_LIST_HEAD(&queue->userq_va_list);
        queue->doorbell_handle = args->in.doorbell_handle;
        queue->queue_type = args->in.ip_type;
        queue->vm = &fpriv->vm;
        queue->priority = priority;

        db_info.queue_type = queue->queue_type;
        db_info.doorbell_handle = queue->doorbell_handle;
        db_info.db_obj = &queue->db_obj;
        db_info.doorbell_offset = args->in.doorbell_offset;

        /* Validate the userq virtual address.*/
        if (amdgpu_userq_input_va_validate(queue, args->in.queue_va, args->in.queue_size) ||
            amdgpu_userq_input_va_validate(queue, args->in.rptr_va, AMDGPU_GPU_PAGE_SIZE) ||
            amdgpu_userq_input_va_validate(queue, args->in.wptr_va, AMDGPU_GPU_PAGE_SIZE)) {
                r = -EINVAL;
                kfree(queue);
                goto unlock;
        }

        /* Convert relative doorbell offset into absolute doorbell index */
        index = amdgpu_userq_get_doorbell_index(uq_mgr, &db_info, filp);
        if (index == (uint64_t)-EINVAL) {
                drm_file_err(uq_mgr->file, "Failed to get doorbell for queue\n");
                kfree(queue);
                r = -EINVAL;
                goto unlock;
        }

        queue->doorbell_index = index;
        xa_init_flags(&queue->fence_drv_xa, XA_FLAGS_ALLOC);
        r = amdgpu_userq_fence_driver_alloc(adev, queue);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to alloc fence driver\n");
                goto unlock;
        }

        r = uq_funcs->mqd_create(uq_mgr, &args->in, queue);
        if (r) {
                drm_file_err(uq_mgr->file, "Failed to create Queue\n");
                amdgpu_userq_fence_driver_free(queue);
                kfree(queue);
                goto unlock;
        }

        qid = idr_alloc(&uq_mgr->userq_idr, queue, 1, AMDGPU_MAX_USERQ_COUNT, GFP_KERNEL);
        if (qid < 0) {
                drm_file_err(uq_mgr->file, "Failed to allocate a queue id\n");
                amdgpu_userq_fence_driver_free(queue);
                uq_funcs->mqd_destroy(uq_mgr, queue);
                kfree(queue);
                r = -ENOMEM;
                goto unlock;
        }

        /* don't map the queue if scheduling is halted */
        if (adev->userq_halt_for_enforce_isolation &&
            ((queue->queue_type == AMDGPU_HW_IP_GFX) ||
             (queue->queue_type == AMDGPU_HW_IP_COMPUTE)))
                skip_map_queue = true;
        else
                skip_map_queue = false;
        if (!skip_map_queue) {
                r = amdgpu_userq_map_helper(uq_mgr, queue);
                if (r) {
                        drm_file_err(uq_mgr->file, "Failed to map Queue\n");
                        idr_remove(&uq_mgr->userq_idr, qid);
                        amdgpu_userq_fence_driver_free(queue);
                        uq_funcs->mqd_destroy(uq_mgr, queue);
                        kfree(queue);
                        goto unlock;
                }
        }

        queue_name = kasprintf(GFP_KERNEL, "queue-%d", qid);
        if (!queue_name) {
                r = -ENOMEM;
                goto unlock;
        }

#if defined(CONFIG_DEBUG_FS)
        /* Queue dentry per client to hold MQD information   */
        queue->debugfs_queue = debugfs_create_dir(queue_name, filp->debugfs_client);
        debugfs_create_file("mqd_info", 0444, queue->debugfs_queue, queue, &amdgpu_mqd_info_fops);
#endif
        kfree(queue_name);

        args->out.queue_id = qid;

unlock:
        mutex_unlock(&uq_mgr->userq_mutex);
        mutex_unlock(&adev->userq_mutex);

        return r;
}

static int amdgpu_userq_input_args_validate(struct drm_device *dev,
                                        union drm_amdgpu_userq *args,
                                        struct drm_file *filp)
{
        struct amdgpu_device *adev = drm_to_adev(dev);

        switch (args->in.op) {
        case AMDGPU_USERQ_OP_CREATE:
                if (args->in.flags & ~(AMDGPU_USERQ_CREATE_FLAGS_QUEUE_PRIORITY_MASK |
                                       AMDGPU_USERQ_CREATE_FLAGS_QUEUE_SECURE))
                        return -EINVAL;
                /* Usermode queues are only supported for GFX IP as of now */
                if (args->in.ip_type != AMDGPU_HW_IP_GFX &&
                    args->in.ip_type != AMDGPU_HW_IP_DMA &&
                    args->in.ip_type != AMDGPU_HW_IP_COMPUTE) {
                        drm_file_err(filp, "Usermode queue doesn't support IP type %u\n",
                                     args->in.ip_type);
                        return -EINVAL;
                }

                if ((args->in.flags & AMDGPU_USERQ_CREATE_FLAGS_QUEUE_SECURE) &&
                    (args->in.ip_type != AMDGPU_HW_IP_GFX) &&
                    (args->in.ip_type != AMDGPU_HW_IP_COMPUTE) &&
                    !amdgpu_is_tmz(adev)) {
                        drm_file_err(filp, "Secure only supported on GFX/Compute queues\n");
                        return -EINVAL;
                }

                if (args->in.queue_va == AMDGPU_BO_INVALID_OFFSET ||
                    args->in.queue_va == 0 ||
                    args->in.queue_size == 0) {
                        drm_file_err(filp, "invalidate userq queue va or size\n");
                        return -EINVAL;
                }

                if (!is_power_of_2(args->in.queue_size)) {
                        drm_file_err(filp, "Queue size must be a power of 2\n");
                        return -EINVAL;
                }

                if (args->in.queue_size < AMDGPU_GPU_PAGE_SIZE) {
                        drm_file_err(filp, "Queue size smaller than AMDGPU_GPU_PAGE_SIZE\n");
                        return -EINVAL;
                }

                if (!args->in.wptr_va || !args->in.rptr_va) {
                        drm_file_err(filp, "invalidate userq queue rptr or wptr\n");
                        return -EINVAL;
                }
                break;
        case AMDGPU_USERQ_OP_FREE:
                if (args->in.ip_type ||
                    args->in.doorbell_handle ||
                    args->in.doorbell_offset ||
                    args->in.flags ||
                    args->in.queue_va ||
                    args->in.queue_size ||
                    args->in.rptr_va ||
                    args->in.wptr_va ||
                    args->in.mqd ||
                    args->in.mqd_size)
                        return -EINVAL;
                break;
        default:
                return -EINVAL;
        }

        return 0;
}

bool amdgpu_userq_enabled(struct drm_device *dev)
{
        struct amdgpu_device *adev = drm_to_adev(dev);
        int i;

        for (i = 0; i < AMDGPU_HW_IP_NUM; i++) {
                if (adev->userq_funcs[i])
                        return true;
        }

        return false;
}

int amdgpu_userq_ioctl(struct drm_device *dev, void *data,
                       struct drm_file *filp)
{
        union drm_amdgpu_userq *args = data;
        int r;

        if (!amdgpu_userq_enabled(dev))
                return -ENOTSUPP;

        if (amdgpu_userq_input_args_validate(dev, args, filp) < 0)
                return -EINVAL;

        switch (args->in.op) {
        case AMDGPU_USERQ_OP_CREATE:
                r = amdgpu_userq_create(filp, args);
                if (r)
                        drm_file_err(filp, "Failed to create usermode queue\n");
                break;

        case AMDGPU_USERQ_OP_FREE:
                r = amdgpu_userq_destroy(filp, args->in.queue_id);
                if (r)
                        drm_file_err(filp, "Failed to destroy usermode queue\n");
                break;

        default:
                drm_dbg_driver(dev, "Invalid user queue op specified: %d\n", args->in.op);
                return -EINVAL;
        }

        return r;
}

static int
amdgpu_userq_restore_all(struct amdgpu_userq_mgr *uq_mgr)
{
        struct amdgpu_usermode_queue *queue;
        int queue_id;
        int ret = 0, r;

        /* Resume all the queues for this process */
        idr_for_each_entry(&uq_mgr->userq_idr, queue, queue_id) {
                r = amdgpu_userq_restore_helper(uq_mgr, queue);
                if (r)
                        ret = r;
        }

        if (ret)
                drm_file_err(uq_mgr->file, "Failed to map all the queues\n");
        return ret;
}

static int amdgpu_userq_validate_vm(void *param, struct amdgpu_bo *bo)
{
        struct ttm_operation_ctx ctx = { false, false };

        amdgpu_bo_placement_from_domain(bo, bo->allowed_domains);
        return ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
}

/* Handle all BOs on the invalidated list, validate them and update the PTs */
static int
amdgpu_userq_bo_validate(struct amdgpu_device *adev, struct drm_exec *exec,
                         struct amdgpu_vm *vm)
{
        struct ttm_operation_ctx ctx = { false, false };
        struct amdgpu_bo_va *bo_va;
        struct amdgpu_bo *bo;
        int ret;

        spin_lock(&vm->status_lock);
        while (!list_empty(&vm->invalidated)) {
                bo_va = list_first_entry(&vm->invalidated,
                                         struct amdgpu_bo_va,
                                         base.vm_status);
                spin_unlock(&vm->status_lock);

                bo = bo_va->base.bo;
                ret = drm_exec_prepare_obj(exec, &bo->tbo.base, 2);
                if (unlikely(ret))
                        return ret;

                amdgpu_bo_placement_from_domain(bo, bo->allowed_domains);
                ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
                if (ret)
                        return ret;

                /* This moves the bo_va to the done list */
                ret = amdgpu_vm_bo_update(adev, bo_va, false);
                if (ret)
                        return ret;

                spin_lock(&vm->status_lock);
        }
        spin_unlock(&vm->status_lock);

        return 0;
}

/* Make sure the whole VM is ready to be used */
static int
amdgpu_userq_vm_validate(struct amdgpu_userq_mgr *uq_mgr)
{
        struct amdgpu_fpriv *fpriv = uq_mgr_to_fpriv(uq_mgr);
        struct amdgpu_device *adev = uq_mgr->adev;
        struct amdgpu_vm *vm = &fpriv->vm;
        struct amdgpu_bo_va *bo_va;
        struct drm_exec exec;
        int ret;

        drm_exec_init(&exec, DRM_EXEC_IGNORE_DUPLICATES, 0);
        drm_exec_until_all_locked(&exec) {
                ret = amdgpu_vm_lock_pd(vm, &exec, 1);
                drm_exec_retry_on_contention(&exec);
                if (unlikely(ret))
                        goto unlock_all;

                ret = amdgpu_vm_lock_done_list(vm, &exec, 1);
                drm_exec_retry_on_contention(&exec);
                if (unlikely(ret))
                        goto unlock_all;

                /* This validates PDs, PTs and per VM BOs */
                ret = amdgpu_vm_validate(adev, vm, NULL,
                                         amdgpu_userq_validate_vm,
                                         NULL);
                if (unlikely(ret))
                        goto unlock_all;

                /* This locks and validates the remaining evicted BOs */
                ret = amdgpu_userq_bo_validate(adev, &exec, vm);
                drm_exec_retry_on_contention(&exec);
                if (unlikely(ret))
                        goto unlock_all;
        }

        ret = amdgpu_vm_handle_moved(adev, vm, NULL);
        if (ret)
                goto unlock_all;

        ret = amdgpu_vm_update_pdes(adev, vm, false);
        if (ret)
                goto unlock_all;

        /*
         * We need to wait for all VM updates to finish before restarting the
         * queues. Using the done list like that is now ok since everything is
         * locked in place.
         */
        list_for_each_entry(bo_va, &vm->done, base.vm_status)
                dma_fence_wait(bo_va->last_pt_update, false);
        dma_fence_wait(vm->last_update, false);

        ret = amdgpu_eviction_fence_replace_fence(&fpriv->evf_mgr, &exec);
        if (ret)
                drm_file_err(uq_mgr->file, "Failed to replace eviction fence\n");

unlock_all:
        drm_exec_fini(&exec);
        return ret;
}

static void amdgpu_userq_restore_worker(struct work_struct *work)
{
        struct amdgpu_userq_mgr *uq_mgr = work_to_uq_mgr(work, resume_work.work);
        struct amdgpu_fpriv *fpriv = uq_mgr_to_fpriv(uq_mgr);
        int ret;

        flush_delayed_work(&fpriv->evf_mgr.suspend_work);

        mutex_lock(&uq_mgr->userq_mutex);

        ret = amdgpu_userq_vm_validate(uq_mgr);
        if (ret) {
                drm_file_err(uq_mgr->file, "Failed to validate BOs to restore\n");
                goto unlock;
        }

        ret = amdgpu_userq_restore_all(uq_mgr);
        if (ret) {
                drm_file_err(uq_mgr->file, "Failed to restore all queues\n");
                goto unlock;
        }

unlock:
        mutex_unlock(&uq_mgr->userq_mutex);
}

static int
amdgpu_userq_evict_all(struct amdgpu_userq_mgr *uq_mgr)
{
        struct amdgpu_usermode_queue *queue;
        int queue_id;
        int ret = 0, r;

        /* Try to unmap all the queues in this process ctx */
        idr_for_each_entry(&uq_mgr->userq_idr, queue, queue_id) {
                r = amdgpu_userq_preempt_helper(uq_mgr, queue);
                if (r)
                        ret = r;
        }

        if (ret)
                drm_file_err(uq_mgr->file, "Couldn't unmap all the queues\n");
        return ret;
}

static int
amdgpu_userq_wait_for_signal(struct amdgpu_userq_mgr *uq_mgr)
{
        struct amdgpu_usermode_queue *queue;
        int queue_id, ret;

        idr_for_each_entry(&uq_mgr->userq_idr, queue, queue_id) {
                struct dma_fence *f = queue->last_fence;

                if (!f || dma_fence_is_signaled(f))
                        continue;
                ret = dma_fence_wait_timeout(f, true, msecs_to_jiffies(100));
                if (ret <= 0) {
                        drm_file_err(uq_mgr->file, "Timed out waiting for fence=%llu:%llu\n",
                                     f->context, f->seqno);
                        return -ETIMEDOUT;
                }
        }

        return 0;
}

void
amdgpu_userq_evict(struct amdgpu_userq_mgr *uq_mgr,
                   struct amdgpu_eviction_fence *ev_fence)
{
        int ret;
        struct amdgpu_fpriv *fpriv = uq_mgr_to_fpriv(uq_mgr);
        struct amdgpu_eviction_fence_mgr *evf_mgr = &fpriv->evf_mgr;

        /* Wait for any pending userqueue fence work to finish */
        ret = amdgpu_userq_wait_for_signal(uq_mgr);
        if (ret) {
                drm_file_err(uq_mgr->file, "Not evicting userqueue, timeout waiting for work\n");
                return;
        }

        ret = amdgpu_userq_evict_all(uq_mgr);
        if (ret) {
                drm_file_err(uq_mgr->file, "Failed to evict userqueue\n");
                return;
        }

        /* Signal current eviction fence */
        amdgpu_eviction_fence_signal(evf_mgr, ev_fence);

        if (evf_mgr->fd_closing) {
                cancel_delayed_work_sync(&uq_mgr->resume_work);
                return;
        }

        /* Schedule a resume work */
        schedule_delayed_work(&uq_mgr->resume_work, 0);
}

int amdgpu_userq_mgr_init(struct amdgpu_userq_mgr *userq_mgr, struct drm_file *file_priv,
                          struct amdgpu_device *adev)
{
        rw_init(&userq_mgr->userq_mutex, "userqmgr");
        idr_init_base(&userq_mgr->userq_idr, 1);
        userq_mgr->adev = adev;
        userq_mgr->file = file_priv;

        mutex_lock(&adev->userq_mutex);
        list_add(&userq_mgr->list, &adev->userq_mgr_list);
        mutex_unlock(&adev->userq_mutex);

        INIT_DELAYED_WORK(&userq_mgr->resume_work, amdgpu_userq_restore_worker);
        return 0;
}

void amdgpu_userq_mgr_fini(struct amdgpu_userq_mgr *userq_mgr)
{
        struct amdgpu_device *adev = userq_mgr->adev;
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_userq_mgr *uqm, *tmp;
        uint32_t queue_id;

        cancel_delayed_work_sync(&userq_mgr->resume_work);

        mutex_lock(&adev->userq_mutex);
        mutex_lock(&userq_mgr->userq_mutex);
        idr_for_each_entry(&userq_mgr->userq_idr, queue, queue_id) {
                amdgpu_userq_wait_for_last_fence(userq_mgr, queue);
                amdgpu_userq_unmap_helper(userq_mgr, queue);
                amdgpu_userq_cleanup(userq_mgr, queue, queue_id);
        }

        list_for_each_entry_safe(uqm, tmp, &adev->userq_mgr_list, list) {
                if (uqm == userq_mgr) {
                        list_del(&uqm->list);
                        break;
                }
        }
        idr_destroy(&userq_mgr->userq_idr);
        mutex_unlock(&userq_mgr->userq_mutex);
        mutex_unlock(&adev->userq_mutex);
        mutex_destroy(&userq_mgr->userq_mutex);
}

int amdgpu_userq_suspend(struct amdgpu_device *adev)
{
        u32 ip_mask = amdgpu_userq_get_supported_ip_mask(adev);
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_userq_mgr *uqm, *tmp;
        int queue_id;
        int ret = 0, r;

        if (!ip_mask)
                return 0;

        mutex_lock(&adev->userq_mutex);
        list_for_each_entry_safe(uqm, tmp, &adev->userq_mgr_list, list) {
                cancel_delayed_work_sync(&uqm->resume_work);
                mutex_lock(&uqm->userq_mutex);
                idr_for_each_entry(&uqm->userq_idr, queue, queue_id) {
                        if (adev->in_s0ix)
                                r = amdgpu_userq_preempt_helper(uqm, queue);
                        else
                                r = amdgpu_userq_unmap_helper(uqm, queue);
                        if (r)
                                ret = r;
                }
                mutex_unlock(&uqm->userq_mutex);
        }
        mutex_unlock(&adev->userq_mutex);
        return ret;
}

int amdgpu_userq_resume(struct amdgpu_device *adev)
{
        u32 ip_mask = amdgpu_userq_get_supported_ip_mask(adev);
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_userq_mgr *uqm, *tmp;
        int queue_id;
        int ret = 0, r;

        if (!ip_mask)
                return 0;

        mutex_lock(&adev->userq_mutex);
        list_for_each_entry_safe(uqm, tmp, &adev->userq_mgr_list, list) {
                mutex_lock(&uqm->userq_mutex);
                idr_for_each_entry(&uqm->userq_idr, queue, queue_id) {
                        if (adev->in_s0ix)
                                r = amdgpu_userq_restore_helper(uqm, queue);
                        else
                                r = amdgpu_userq_map_helper(uqm, queue);
                        if (r)
                                ret = r;
                }
                mutex_unlock(&uqm->userq_mutex);
        }
        mutex_unlock(&adev->userq_mutex);
        return ret;
}

int amdgpu_userq_stop_sched_for_enforce_isolation(struct amdgpu_device *adev,
                                                  u32 idx)
{
        u32 ip_mask = amdgpu_userq_get_supported_ip_mask(adev);
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_userq_mgr *uqm, *tmp;
        int queue_id;
        int ret = 0, r;

        /* only need to stop gfx/compute */
        if (!(ip_mask & ((1 << AMDGPU_HW_IP_GFX) | (1 << AMDGPU_HW_IP_COMPUTE))))
                return 0;

        mutex_lock(&adev->userq_mutex);
        if (adev->userq_halt_for_enforce_isolation)
                dev_warn(adev->dev, "userq scheduling already stopped!\n");
        adev->userq_halt_for_enforce_isolation = true;
        list_for_each_entry_safe(uqm, tmp, &adev->userq_mgr_list, list) {
                cancel_delayed_work_sync(&uqm->resume_work);
                mutex_lock(&uqm->userq_mutex);
                idr_for_each_entry(&uqm->userq_idr, queue, queue_id) {
                        if (((queue->queue_type == AMDGPU_HW_IP_GFX) ||
                             (queue->queue_type == AMDGPU_HW_IP_COMPUTE)) &&
                            (queue->xcp_id == idx)) {
                                r = amdgpu_userq_preempt_helper(uqm, queue);
                                if (r)
                                        ret = r;
                        }
                }
                mutex_unlock(&uqm->userq_mutex);
        }
        mutex_unlock(&adev->userq_mutex);
        return ret;
}

int amdgpu_userq_start_sched_for_enforce_isolation(struct amdgpu_device *adev,
                                                   u32 idx)
{
        u32 ip_mask = amdgpu_userq_get_supported_ip_mask(adev);
        struct amdgpu_usermode_queue *queue;
        struct amdgpu_userq_mgr *uqm, *tmp;
        int queue_id;
        int ret = 0, r;

        /* only need to stop gfx/compute */
        if (!(ip_mask & ((1 << AMDGPU_HW_IP_GFX) | (1 << AMDGPU_HW_IP_COMPUTE))))
                return 0;

        mutex_lock(&adev->userq_mutex);
        if (!adev->userq_halt_for_enforce_isolation)
                dev_warn(adev->dev, "userq scheduling already started!\n");
        adev->userq_halt_for_enforce_isolation = false;
        list_for_each_entry_safe(uqm, tmp, &adev->userq_mgr_list, list) {
                mutex_lock(&uqm->userq_mutex);
                idr_for_each_entry(&uqm->userq_idr, queue, queue_id) {
                        if (((queue->queue_type == AMDGPU_HW_IP_GFX) ||
                             (queue->queue_type == AMDGPU_HW_IP_COMPUTE)) &&
                            (queue->xcp_id == idx)) {
                                r = amdgpu_userq_restore_helper(uqm, queue);
                                if (r)
                                        ret = r;
                        }
                }
                mutex_unlock(&uqm->userq_mutex);
        }
        mutex_unlock(&adev->userq_mutex);
        return ret;
}