/**************************************************************************
 *
 * Copyright © 2009 - 2015 VMware, Inc., Palo Alto, CA., USA
 * All Rights Reserved.
 *
 * 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, sub license, 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 NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS 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 "vmwgfx_drv.h"
#include "vmwgfx_reg.h"
#include <drm/ttm/ttm_bo_api.h>
#include <drm/ttm/ttm_placement.h>
#include "vmwgfx_so.h"
#include "vmwgfx_binding.h"

#define VMW_RES_HT_ORDER 12

/**
 * struct vmw_resource_relocation - Relocation info for resources
 *
 * @head: List head for the software context's relocation list.
 * @res: Non-ref-counted pointer to the resource.
 * @offset: Offset of 4 byte entries into the command buffer where the
 * id that needs fixup is located.
 */
struct vmw_resource_relocation {
        struct list_head head;
        const struct vmw_resource *res;
        unsigned long offset;
};

/**
 * struct vmw_resource_val_node - Validation info for resources
 *
 * @head: List head for the software context's resource list.
 * @hash: Hash entry for quick resouce to val_node lookup.
 * @res: Ref-counted pointer to the resource.
 * @switch_backup: Boolean whether to switch backup buffer on unreserve.
 * @new_backup: Refcounted pointer to the new backup buffer.
 * @staged_bindings: If @res is a context, tracks bindings set up during
 * the command batch. Otherwise NULL.
 * @new_backup_offset: New backup buffer offset if @new_backup is non-NUll.
 * @first_usage: Set to true the first time the resource is referenced in
 * the command stream.
 * @switching_backup: The command stream provides a new backup buffer for a
 * resource.
 * @no_buffer_needed: This means @switching_backup is true on first buffer
 * reference. So resource reservation does not need to allocate a backup
 * buffer for the resource.
 */
struct vmw_resource_val_node {
        struct list_head head;
        struct drm_hash_item hash;
        struct vmw_resource *res;
        struct vmw_dma_buffer *new_backup;
        struct vmw_ctx_binding_state *staged_bindings;
        unsigned long new_backup_offset;
        u32 first_usage : 1;
        u32 switching_backup : 1;
        u32 no_buffer_needed : 1;
};

/**
 * struct vmw_cmd_entry - Describe a command for the verifier
 *
 * @user_allow: Whether allowed from the execbuf ioctl.
 * @gb_disable: Whether disabled if guest-backed objects are available.
 * @gb_enable: Whether enabled iff guest-backed objects are available.
 */
struct vmw_cmd_entry {
        int (*func) (struct vmw_private *, struct vmw_sw_context *,
                     SVGA3dCmdHeader *);
        bool user_allow;
        bool gb_disable;
        bool gb_enable;
};

#define VMW_CMD_DEF(_cmd, _func, _user_allow, _gb_disable, _gb_enable)  \
        [(_cmd) - SVGA_3D_CMD_BASE] = {(_func), (_user_allow),\
                                       (_gb_disable), (_gb_enable)}

static int vmw_resource_context_res_add(struct vmw_private *dev_priv,
                                        struct vmw_sw_context *sw_context,
                                        struct vmw_resource *ctx);
static int vmw_translate_mob_ptr(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGAMobId *id,
                                 struct vmw_dma_buffer **vmw_bo_p);
static int vmw_bo_to_validate_list(struct vmw_sw_context *sw_context,
                                   struct vmw_dma_buffer *vbo,
                                   bool validate_as_mob,
                                   uint32_t *p_val_node);


/**
 * vmw_resources_unreserve - unreserve resources previously reserved for
 * command submission.
 *
 * @sw_context: pointer to the software context
 * @backoff: Whether command submission failed.
 */
static void vmw_resources_unreserve(struct vmw_sw_context *sw_context,
                                    bool backoff)
{
        struct vmw_resource_val_node *val;
        struct list_head *list = &sw_context->resource_list;

        if (sw_context->dx_query_mob && !backoff)
                vmw_context_bind_dx_query(sw_context->dx_query_ctx,
                                          sw_context->dx_query_mob);

        list_for_each_entry(val, list, head) {
                struct vmw_resource *res = val->res;
                bool switch_backup =
                        (backoff) ? false : val->switching_backup;

                /*
                 * Transfer staged context bindings to the
                 * persistent context binding tracker.
                 */
                if (unlikely(val->staged_bindings)) {
                        if (!backoff) {
                                vmw_binding_state_commit
                                        (vmw_context_binding_state(val->res),
                                         val->staged_bindings);
                        }

                        if (val->staged_bindings != sw_context->staged_bindings)
                                vmw_binding_state_free(val->staged_bindings);
                        else
                                sw_context->staged_bindings_inuse = false;
                        val->staged_bindings = NULL;
                }
                vmw_resource_unreserve(res, switch_backup, val->new_backup,
                                       val->new_backup_offset);
                vmw_dmabuf_unreference(&val->new_backup);
        }
}

/**
 * vmw_cmd_ctx_first_setup - Perform the setup needed when a context is
 * added to the validate list.
 *
 * @dev_priv: Pointer to the device private:
 * @sw_context: The validation context:
 * @node: The validation node holding this context.
 */
static int vmw_cmd_ctx_first_setup(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   struct vmw_resource_val_node *node)
{
        int ret;

        ret = vmw_resource_context_res_add(dev_priv, sw_context, node->res);
        if (unlikely(ret != 0))
                goto out_err;

        if (!sw_context->staged_bindings) {
                sw_context->staged_bindings =
                        vmw_binding_state_alloc(dev_priv);
                if (IS_ERR(sw_context->staged_bindings)) {
                        DRM_ERROR("Failed to allocate context binding "
                                  "information.\n");
                        ret = PTR_ERR(sw_context->staged_bindings);
                        sw_context->staged_bindings = NULL;
                        goto out_err;
                }
        }

        if (sw_context->staged_bindings_inuse) {
                node->staged_bindings = vmw_binding_state_alloc(dev_priv);
                if (IS_ERR(node->staged_bindings)) {
                        DRM_ERROR("Failed to allocate context binding "
                                  "information.\n");
                        ret = PTR_ERR(node->staged_bindings);
                        node->staged_bindings = NULL;
                        goto out_err;
                }
        } else {
                node->staged_bindings = sw_context->staged_bindings;
                sw_context->staged_bindings_inuse = true;
        }

        return 0;
out_err:
        return ret;
}

/**
 * vmw_resource_val_add - Add a resource to the software context's
 * resource list if it's not already on it.
 *
 * @sw_context: Pointer to the software context.
 * @res: Pointer to the resource.
 * @p_node On successful return points to a valid pointer to a
 * struct vmw_resource_val_node, if non-NULL on entry.
 */
static int vmw_resource_val_add(struct vmw_sw_context *sw_context,
                                struct vmw_resource *res,
                                struct vmw_resource_val_node **p_node)
{
        struct vmw_private *dev_priv = res->dev_priv;
        struct vmw_resource_val_node *node;
        struct drm_hash_item *hash;
        int ret;

        if (likely(drm_ht_find_item(&sw_context->res_ht, (unsigned long) res,
                                    &hash) == 0)) {
                node = container_of(hash, struct vmw_resource_val_node, hash);
                node->first_usage = false;
                if (unlikely(p_node != NULL))
                        *p_node = node;
                return 0;
        }

        node = kzalloc(sizeof(*node), GFP_KERNEL);
        if (unlikely(node == NULL)) {
                DRM_ERROR("Failed to allocate a resource validation "
                          "entry.\n");
                return -ENOMEM;
        }

        node->hash.key = (unsigned long) res;
        ret = drm_ht_insert_item(&sw_context->res_ht, &node->hash);
        if (unlikely(ret != 0)) {
                DRM_ERROR("Failed to initialize a resource validation "
                          "entry.\n");
                kfree(node);
                return ret;
        }
        node->res = vmw_resource_reference(res);
        node->first_usage = true;
        if (unlikely(p_node != NULL))
                *p_node = node;

        if (!dev_priv->has_mob) {
                list_add_tail(&node->head, &sw_context->resource_list);
                return 0;
        }

        switch (vmw_res_type(res)) {
        case vmw_res_context:
        case vmw_res_dx_context:
                list_add(&node->head, &sw_context->ctx_resource_list);
                ret = vmw_cmd_ctx_first_setup(dev_priv, sw_context, node);
                break;
        case vmw_res_cotable:
                list_add_tail(&node->head, &sw_context->ctx_resource_list);
                break;
        default:
                list_add_tail(&node->head, &sw_context->resource_list);
                break;
        }

        return ret;
}

/**
 * vmw_view_res_val_add - Add a view and the surface it's pointing to
 * to the validation list
 *
 * @sw_context: The software context holding the validation list.
 * @view: Pointer to the view resource.
 *
 * Returns 0 if success, negative error code otherwise.
 */
static int vmw_view_res_val_add(struct vmw_sw_context *sw_context,
                                struct vmw_resource *view)
{
        int ret;

        /*
         * First add the resource the view is pointing to, otherwise
         * it may be swapped out when the view is validated.
         */
        ret = vmw_resource_val_add(sw_context, vmw_view_srf(view), NULL);
        if (ret)
                return ret;

        return vmw_resource_val_add(sw_context, view, NULL);
}

/**
 * vmw_view_id_val_add - Look up a view and add it and the surface it's
 * pointing to to the validation list.
 *
 * @sw_context: The software context holding the validation list.
 * @view_type: The view type to look up.
 * @id: view id of the view.
 *
 * The view is represented by a view id and the DX context it's created on,
 * or scheduled for creation on. If there is no DX context set, the function
 * will return -EINVAL. Otherwise returns 0 on success and -EINVAL on failure.
 */
static int vmw_view_id_val_add(struct vmw_sw_context *sw_context,
                               enum vmw_view_type view_type, u32 id)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_resource *view;
        int ret;

        if (!ctx_node) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        view = vmw_view_lookup(sw_context->man, view_type, id);
        if (IS_ERR(view))
                return PTR_ERR(view);

        ret = vmw_view_res_val_add(sw_context, view);
        vmw_resource_unreference(&view);

        return ret;
}

/**
 * vmw_resource_context_res_add - Put resources previously bound to a context on
 * the validation list
 *
 * @dev_priv: Pointer to a device private structure
 * @sw_context: Pointer to a software context used for this command submission
 * @ctx: Pointer to the context resource
 *
 * This function puts all resources that were previously bound to @ctx on
 * the resource validation list. This is part of the context state reemission
 */
static int vmw_resource_context_res_add(struct vmw_private *dev_priv,
                                        struct vmw_sw_context *sw_context,
                                        struct vmw_resource *ctx)
{
        struct list_head *binding_list;
        struct vmw_ctx_bindinfo *entry;
        int ret = 0;
        struct vmw_resource *res;
        u32 i;

        /* Add all cotables to the validation list. */
        if (dev_priv->has_dx && vmw_res_type(ctx) == vmw_res_dx_context) {
                for (i = 0; i < SVGA_COTABLE_DX10_MAX; ++i) {
                        res = vmw_context_cotable(ctx, i);
                        if (IS_ERR(res))
                                continue;

                        ret = vmw_resource_val_add(sw_context, res, NULL);
                        vmw_resource_unreference(&res);
                        if (unlikely(ret != 0))
                                return ret;
                }
        }


        /* Add all resources bound to the context to the validation list */
        mutex_lock(&dev_priv->binding_mutex);
        binding_list = vmw_context_binding_list(ctx);

        list_for_each_entry(entry, binding_list, ctx_list) {
                /* entry->res is not refcounted */
                res = vmw_resource_reference_unless_doomed(entry->res);
                if (unlikely(res == NULL))
                        continue;

                if (vmw_res_type(entry->res) == vmw_res_view)
                        ret = vmw_view_res_val_add(sw_context, entry->res);
                else
                        ret = vmw_resource_val_add(sw_context, entry->res,
                                                   NULL);
                vmw_resource_unreference(&res);
                if (unlikely(ret != 0))
                        break;
        }

        if (dev_priv->has_dx && vmw_res_type(ctx) == vmw_res_dx_context) {
                struct vmw_dma_buffer *dx_query_mob;

                dx_query_mob = vmw_context_get_dx_query_mob(ctx);
                if (dx_query_mob)
                        ret = vmw_bo_to_validate_list(sw_context,
                                                      dx_query_mob,
                                                      true, NULL);
        }

        mutex_unlock(&dev_priv->binding_mutex);
        return ret;
}

/**
 * vmw_resource_relocation_add - Add a relocation to the relocation list
 *
 * @list: Pointer to head of relocation list.
 * @res: The resource.
 * @offset: Offset into the command buffer currently being parsed where the
 * id that needs fixup is located. Granularity is 4 bytes.
 */
static int vmw_resource_relocation_add(struct list_head *list,
                                       const struct vmw_resource *res,
                                       unsigned long offset)
{
        struct vmw_resource_relocation *rel;

        rel = kmalloc(sizeof(*rel), GFP_KERNEL);
        if (unlikely(rel == NULL)) {
                DRM_ERROR("Failed to allocate a resource relocation.\n");
                return -ENOMEM;
        }

        rel->res = res;
        rel->offset = offset;
        list_add_tail(&rel->head, list);

        return 0;
}

/**
 * vmw_resource_relocations_free - Free all relocations on a list
 *
 * @list: Pointer to the head of the relocation list.
 */
static void vmw_resource_relocations_free(struct list_head *list)
{
        struct vmw_resource_relocation *rel, *n;

        list_for_each_entry_safe(rel, n, list, head) {
                list_del(&rel->head);
                kfree(rel);
        }
}

/**
 * vmw_resource_relocations_apply - Apply all relocations on a list
 *
 * @cb: Pointer to the start of the command buffer bein patch. This need
 * not be the same buffer as the one being parsed when the relocation
 * list was built, but the contents must be the same modulo the
 * resource ids.
 * @list: Pointer to the head of the relocation list.
 */
static void vmw_resource_relocations_apply(uint32_t *cb,
                                           struct list_head *list)
{
        struct vmw_resource_relocation *rel;

        list_for_each_entry(rel, list, head) {
                if (likely(rel->res != NULL))
                        cb[rel->offset] = rel->res->id;
                else
                        cb[rel->offset] = SVGA_3D_CMD_NOP;
        }
}

static int vmw_cmd_invalid(struct vmw_private *dev_priv,
                           struct vmw_sw_context *sw_context,
                           SVGA3dCmdHeader *header)
{
        return capable(CAP_SYS_ADMIN) ? : -EINVAL;
}

static int vmw_cmd_ok(struct vmw_private *dev_priv,
                      struct vmw_sw_context *sw_context,
                      SVGA3dCmdHeader *header)
{
        return 0;
}

/**
 * vmw_bo_to_validate_list - add a bo to a validate list
 *
 * @sw_context: The software context used for this command submission batch.
 * @bo: The buffer object to add.
 * @validate_as_mob: Validate this buffer as a MOB.
 * @p_val_node: If non-NULL Will be updated with the validate node number
 * on return.
 *
 * Returns -EINVAL if the limit of number of buffer objects per command
 * submission is reached.
 */
static int vmw_bo_to_validate_list(struct vmw_sw_context *sw_context,
                                   struct vmw_dma_buffer *vbo,
                                   bool validate_as_mob,
                                   uint32_t *p_val_node)
{
        uint32_t val_node;
        struct vmw_validate_buffer *vval_buf;
        struct ttm_validate_buffer *val_buf;
        struct drm_hash_item *hash;
        int ret;

        if (likely(drm_ht_find_item(&sw_context->res_ht, (unsigned long) vbo,
                                    &hash) == 0)) {
                vval_buf = container_of(hash, struct vmw_validate_buffer,
                                        hash);
                if (unlikely(vval_buf->validate_as_mob != validate_as_mob)) {
                        DRM_ERROR("Inconsistent buffer usage.\n");
                        return -EINVAL;
                }
                val_buf = &vval_buf->base;
                val_node = vval_buf - sw_context->val_bufs;
        } else {
                val_node = sw_context->cur_val_buf;
                if (unlikely(val_node >= VMWGFX_MAX_VALIDATIONS)) {
                        DRM_ERROR("Max number of DMA buffers per submission "
                                  "exceeded.\n");
                        return -EINVAL;
                }
                vval_buf = &sw_context->val_bufs[val_node];
                vval_buf->hash.key = (unsigned long) vbo;
                ret = drm_ht_insert_item(&sw_context->res_ht, &vval_buf->hash);
                if (unlikely(ret != 0)) {
                        DRM_ERROR("Failed to initialize a buffer validation "
                                  "entry.\n");
                        return ret;
                }
                ++sw_context->cur_val_buf;
                val_buf = &vval_buf->base;
                val_buf->bo = ttm_bo_reference(&vbo->base);
                val_buf->shared = false;
                list_add_tail(&val_buf->head, &sw_context->validate_nodes);
                vval_buf->validate_as_mob = validate_as_mob;
        }

        if (p_val_node)
                *p_val_node = val_node;

        return 0;
}

/**
 * vmw_resources_reserve - Reserve all resources on the sw_context's
 * resource list.
 *
 * @sw_context: Pointer to the software context.
 *
 * Note that since vmware's command submission currently is protected by
 * the cmdbuf mutex, no fancy deadlock avoidance is required for resources,
 * since only a single thread at once will attempt this.
 */
static int vmw_resources_reserve(struct vmw_sw_context *sw_context)
{
        struct vmw_resource_val_node *val;
        int ret = 0;

        list_for_each_entry(val, &sw_context->resource_list, head) {
                struct vmw_resource *res = val->res;

                ret = vmw_resource_reserve(res, true, val->no_buffer_needed);
                if (unlikely(ret != 0))
                        return ret;

                if (res->backup) {
                        struct vmw_dma_buffer *vbo = res->backup;

                        ret = vmw_bo_to_validate_list
                                (sw_context, vbo,
                                 vmw_resource_needs_backup(res), NULL);

                        if (unlikely(ret != 0))
                                return ret;
                }
        }

        if (sw_context->dx_query_mob) {
                struct vmw_dma_buffer *expected_dx_query_mob;

                expected_dx_query_mob =
                        vmw_context_get_dx_query_mob(sw_context->dx_query_ctx);
                if (expected_dx_query_mob &&
                    expected_dx_query_mob != sw_context->dx_query_mob) {
                        ret = -EINVAL;
                }
        }

        return ret;
}

/**
 * vmw_resources_validate - Validate all resources on the sw_context's
 * resource list.
 *
 * @sw_context: Pointer to the software context.
 *
 * Before this function is called, all resource backup buffers must have
 * been validated.
 */
static int vmw_resources_validate(struct vmw_sw_context *sw_context)
{
        struct vmw_resource_val_node *val;
        int ret;

        list_for_each_entry(val, &sw_context->resource_list, head) {
                struct vmw_resource *res = val->res;
                struct vmw_dma_buffer *backup = res->backup;

                ret = vmw_resource_validate(res);
                if (unlikely(ret != 0)) {
                        if (ret != -ERESTARTSYS)
                                DRM_ERROR("Failed to validate resource.\n");
                        return ret;
                }

                /* Check if the resource switched backup buffer */
                if (backup && res->backup && (backup != res->backup)) {
                        struct vmw_dma_buffer *vbo = res->backup;

                        ret = vmw_bo_to_validate_list
                                (sw_context, vbo,
                                 vmw_resource_needs_backup(res), NULL);
                        if (ret) {
                                ttm_bo_unreserve(&vbo->base);
                                return ret;
                        }
                }
        }
        return 0;
}

/**
 * vmw_cmd_res_reloc_add - Add a resource to a software context's
 * relocation- and validation lists.
 *
 * @dev_priv: Pointer to a struct vmw_private identifying the device.
 * @sw_context: Pointer to the software context.
 * @id_loc: Pointer to where the id that needs translation is located.
 * @res: Valid pointer to a struct vmw_resource.
 * @p_val: If non null, a pointer to the struct vmw_resource_validate_node
 * used for this resource is returned here.
 */
static int vmw_cmd_res_reloc_add(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 uint32_t *id_loc,
                                 struct vmw_resource *res,
                                 struct vmw_resource_val_node **p_val)
{
        int ret;
        struct vmw_resource_val_node *node;

        *p_val = NULL;
        ret = vmw_resource_relocation_add(&sw_context->res_relocations,
                                          res,
                                          id_loc - sw_context->buf_start);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_resource_val_add(sw_context, res, &node);
        if (unlikely(ret != 0))
                return ret;

        if (p_val)
                *p_val = node;

        return 0;
}


/**
 * vmw_cmd_res_check - Check that a resource is present and if so, put it
 * on the resource validate list unless it's already there.
 *
 * @dev_priv: Pointer to a device private structure.
 * @sw_context: Pointer to the software context.
 * @res_type: Resource type.
 * @converter: User-space visisble type specific information.
 * @id_loc: Pointer to the location in the command buffer currently being
 * parsed from where the user-space resource id handle is located.
 * @p_val: Pointer to pointer to resource validalidation node. Populated
 * on exit.
 */
static int
vmw_cmd_res_check(struct vmw_private *dev_priv,
                  struct vmw_sw_context *sw_context,
                  enum vmw_res_type res_type,
                  const struct vmw_user_resource_conv *converter,
                  uint32_t *id_loc,
                  struct vmw_resource_val_node **p_val)
{
        struct vmw_res_cache_entry *rcache =
                &sw_context->res_cache[res_type];
        struct vmw_resource *res;
        struct vmw_resource_val_node *node;
        int ret;

        if (*id_loc == SVGA3D_INVALID_ID) {
                if (p_val)
                        *p_val = NULL;
                if (res_type == vmw_res_context) {
                        DRM_ERROR("Illegal context invalid id.\n");
                        return -EINVAL;
                }
                return 0;
        }

        /*
         * Fastpath in case of repeated commands referencing the same
         * resource
         */

        if (likely(rcache->valid && *id_loc == rcache->handle)) {
                const struct vmw_resource *res = rcache->res;

                rcache->node->first_usage = false;
                if (p_val)
                        *p_val = rcache->node;

                return vmw_resource_relocation_add
                        (&sw_context->res_relocations, res,
                         id_loc - sw_context->buf_start);
        }

        ret = vmw_user_resource_lookup_handle(dev_priv,
                                              sw_context->fp->tfile,
                                              *id_loc,
                                              converter,
                                              &res);
        if (unlikely(ret != 0)) {
                DRM_ERROR("Could not find or use resource 0x%08x.\n",
                          (unsigned) *id_loc);
                dump_stack();
                return ret;
        }

        rcache->valid = true;
        rcache->res = res;
        rcache->handle = *id_loc;

        ret = vmw_cmd_res_reloc_add(dev_priv, sw_context, id_loc,
                                    res, &node);
        if (unlikely(ret != 0))
                goto out_no_reloc;

        rcache->node = node;
        if (p_val)
                *p_val = node;
        vmw_resource_unreference(&res);
        return 0;

out_no_reloc:
        BUG_ON(sw_context->error_resource != NULL);
        sw_context->error_resource = res;

        return ret;
}

/**
 * vmw_rebind_dx_query - Rebind DX query associated with the context
 *
 * @ctx_res: context the query belongs to
 *
 * This function assumes binding_mutex is held.
 */
static int vmw_rebind_all_dx_query(struct vmw_resource *ctx_res)
{
        struct vmw_private *dev_priv = ctx_res->dev_priv;
        struct vmw_dma_buffer *dx_query_mob;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXBindAllQuery body;
        } *cmd;


        dx_query_mob = vmw_context_get_dx_query_mob(ctx_res);

        if (!dx_query_mob || dx_query_mob->dx_query_ctx)
                return 0;

        cmd = vmw_fifo_reserve_dx(dev_priv, sizeof(*cmd), ctx_res->id);

        if (cmd == NULL) {
                DRM_ERROR("Failed to rebind queries.\n");
                return -ENOMEM;
        }

        cmd->header.id = SVGA_3D_CMD_DX_BIND_ALL_QUERY;
        cmd->header.size = sizeof(cmd->body);
        cmd->body.cid = ctx_res->id;
        cmd->body.mobid = dx_query_mob->base.mem.start;
        vmw_fifo_commit(dev_priv, sizeof(*cmd));

        vmw_context_bind_dx_query(ctx_res, dx_query_mob);

        return 0;
}

/**
 * vmw_rebind_contexts - Rebind all resources previously bound to
 * referenced contexts.
 *
 * @sw_context: Pointer to the software context.
 *
 * Rebind context binding points that have been scrubbed because of eviction.
 */
static int vmw_rebind_contexts(struct vmw_sw_context *sw_context)
{
        struct vmw_resource_val_node *val;
        int ret;

        list_for_each_entry(val, &sw_context->resource_list, head) {
                if (unlikely(!val->staged_bindings))
                        break;

                ret = vmw_binding_rebind_all
                        (vmw_context_binding_state(val->res));
                if (unlikely(ret != 0)) {
                        if (ret != -ERESTARTSYS)
                                DRM_ERROR("Failed to rebind context.\n");
                        return ret;
                }

                ret = vmw_rebind_all_dx_query(val->res);
                if (ret != 0)
                        return ret;
        }

        return 0;
}

/**
 * vmw_view_bindings_add - Add an array of view bindings to a context
 * binding state tracker.
 *
 * @sw_context: The execbuf state used for this command.
 * @view_type: View type for the bindings.
 * @binding_type: Binding type for the bindings.
 * @shader_slot: The shader slot to user for the bindings.
 * @view_ids: Array of view ids to be bound.
 * @num_views: Number of view ids in @view_ids.
 * @first_slot: The binding slot to be used for the first view id in @view_ids.
 */
static int vmw_view_bindings_add(struct vmw_sw_context *sw_context,
                                 enum vmw_view_type view_type,
                                 enum vmw_ctx_binding_type binding_type,
                                 uint32 shader_slot,
                                 uint32 view_ids[], u32 num_views,
                                 u32 first_slot)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_cmdbuf_res_manager *man;
        u32 i;
        int ret;

        if (!ctx_node) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        man = sw_context->man;
        for (i = 0; i < num_views; ++i) {
                struct vmw_ctx_bindinfo_view binding;
                struct vmw_resource *view = NULL;

                if (view_ids[i] != SVGA3D_INVALID_ID) {
                        view = vmw_view_lookup(man, view_type, view_ids[i]);
                        if (IS_ERR(view)) {
                                DRM_ERROR("View not found.\n");
                                return PTR_ERR(view);
                        }

                        ret = vmw_view_res_val_add(sw_context, view);
                        if (ret) {
                                DRM_ERROR("Could not add view to "
                                          "validation list.\n");
                                vmw_resource_unreference(&view);
                                return ret;
                        }
                }
                binding.bi.ctx = ctx_node->res;
                binding.bi.res = view;
                binding.bi.bt = binding_type;
                binding.shader_slot = shader_slot;
                binding.slot = first_slot + i;
                vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                                shader_slot, binding.slot);
                if (view)
                        vmw_resource_unreference(&view);
        }

        return 0;
}

/**
 * vmw_cmd_cid_check - Check a command header for valid context information.
 *
 * @dev_priv: Pointer to a device private structure.
 * @sw_context: Pointer to the software context.
 * @header: A command header with an embedded user-space context handle.
 *
 * Convenience function: Call vmw_cmd_res_check with the user-space context
 * handle embedded in @header.
 */
static int vmw_cmd_cid_check(struct vmw_private *dev_priv,
                             struct vmw_sw_context *sw_context,
                             SVGA3dCmdHeader *header)
{
        struct vmw_cid_cmd {
                SVGA3dCmdHeader header;
                uint32_t cid;
        } *cmd;

        cmd = container_of(header, struct vmw_cid_cmd, header);
        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                 user_context_converter, &cmd->cid, NULL);
}

static int vmw_cmd_set_render_target_check(struct vmw_private *dev_priv,
                                           struct vmw_sw_context *sw_context,
                                           SVGA3dCmdHeader *header)
{
        struct vmw_sid_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSetRenderTarget body;
        } *cmd;
        struct vmw_resource_val_node *ctx_node;
        struct vmw_resource_val_node *res_node;
        int ret;

        cmd = container_of(header, struct vmw_sid_cmd, header);

        if (cmd->body.type >= SVGA3D_RT_MAX) {
                DRM_ERROR("Illegal render target type %u.\n",
                          (unsigned) cmd->body.type);
                return -EINVAL;
        }

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->body.cid,
                                &ctx_node);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.target.sid, &res_node);
        if (unlikely(ret != 0))
                return ret;

        if (dev_priv->has_mob) {
                struct vmw_ctx_bindinfo_view binding;

                binding.bi.ctx = ctx_node->res;
                binding.bi.res = res_node ? res_node->res : NULL;
                binding.bi.bt = vmw_ctx_binding_rt;
                binding.slot = cmd->body.type;
                vmw_binding_add(ctx_node->staged_bindings,
                                &binding.bi, 0, binding.slot);
        }

        return 0;
}

static int vmw_cmd_surface_copy_check(struct vmw_private *dev_priv,
                                      struct vmw_sw_context *sw_context,
                                      SVGA3dCmdHeader *header)
{
        struct vmw_sid_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSurfaceCopy body;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_sid_cmd, header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.src.sid, NULL);
        if (ret)
                return ret;

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.dest.sid, NULL);
}

static int vmw_cmd_buffer_copy_check(struct vmw_private *dev_priv,
                                      struct vmw_sw_context *sw_context,
                                      SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXBufferCopy body;
        } *cmd;
        int ret;

        cmd = container_of(header, typeof(*cmd), header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.src, NULL);
        if (ret != 0)
                return ret;

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.dest, NULL);
}

static int vmw_cmd_pred_copy_check(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXPredCopyRegion body;
        } *cmd;
        int ret;

        cmd = container_of(header, typeof(*cmd), header);
        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.srcSid, NULL);
        if (ret != 0)
                return ret;

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.dstSid, NULL);
}

static int vmw_cmd_stretch_blt_check(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct vmw_sid_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSurfaceStretchBlt body;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_sid_cmd, header);
        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.src.sid, NULL);
        if (unlikely(ret != 0))
                return ret;
        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.dest.sid, NULL);
}

static int vmw_cmd_blt_surf_screen_check(struct vmw_private *dev_priv,
                                         struct vmw_sw_context *sw_context,
                                         SVGA3dCmdHeader *header)
{
        struct vmw_sid_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdBlitSurfaceToScreen body;
        } *cmd;

        cmd = container_of(header, struct vmw_sid_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.srcImage.sid, NULL);
}

static int vmw_cmd_present_check(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGA3dCmdHeader *header)
{
        struct vmw_sid_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdPresent body;
        } *cmd;


        cmd = container_of(header, struct vmw_sid_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter, &cmd->body.sid,
                                 NULL);
}

/**
 * vmw_query_bo_switch_prepare - Prepare to switch pinned buffer for queries.
 *
 * @dev_priv: The device private structure.
 * @new_query_bo: The new buffer holding query results.
 * @sw_context: The software context used for this command submission.
 *
 * This function checks whether @new_query_bo is suitable for holding
 * query results, and if another buffer currently is pinned for query
 * results. If so, the function prepares the state of @sw_context for
 * switching pinned buffers after successful submission of the current
 * command batch.
 */
static int vmw_query_bo_switch_prepare(struct vmw_private *dev_priv,
                                       struct vmw_dma_buffer *new_query_bo,
                                       struct vmw_sw_context *sw_context)
{
        struct vmw_res_cache_entry *ctx_entry =
                &sw_context->res_cache[vmw_res_context];
        int ret;

        BUG_ON(!ctx_entry->valid);
        sw_context->last_query_ctx = ctx_entry->res;

        if (unlikely(new_query_bo != sw_context->cur_query_bo)) {

                if (unlikely(new_query_bo->base.num_pages > 4)) {
                        DRM_ERROR("Query buffer too large.\n");
                        return -EINVAL;
                }

                if (unlikely(sw_context->cur_query_bo != NULL)) {
                        sw_context->needs_post_query_barrier = true;
                        ret = vmw_bo_to_validate_list(sw_context,
                                                      sw_context->cur_query_bo,
                                                      dev_priv->has_mob, NULL);
                        if (unlikely(ret != 0))
                                return ret;
                }
                sw_context->cur_query_bo = new_query_bo;

                ret = vmw_bo_to_validate_list(sw_context,
                                              dev_priv->dummy_query_bo,
                                              dev_priv->has_mob, NULL);
                if (unlikely(ret != 0))
                        return ret;

        }

        return 0;
}


/**
 * vmw_query_bo_switch_commit - Finalize switching pinned query buffer
 *
 * @dev_priv: The device private structure.
 * @sw_context: The software context used for this command submission batch.
 *
 * This function will check if we're switching query buffers, and will then,
 * issue a dummy occlusion query wait used as a query barrier. When the fence
 * object following that query wait has signaled, we are sure that all
 * preceding queries have finished, and the old query buffer can be unpinned.
 * However, since both the new query buffer and the old one are fenced with
 * that fence, we can do an asynchronus unpin now, and be sure that the
 * old query buffer won't be moved until the fence has signaled.
 *
 * As mentioned above, both the new - and old query buffers need to be fenced
 * using a sequence emitted *after* calling this function.
 */
static void vmw_query_bo_switch_commit(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context)
{
        /*
         * The validate list should still hold references to all
         * contexts here.
         */

        if (sw_context->needs_post_query_barrier) {
                struct vmw_res_cache_entry *ctx_entry =
                        &sw_context->res_cache[vmw_res_context];
                struct vmw_resource *ctx;
                int ret;

                BUG_ON(!ctx_entry->valid);
                ctx = ctx_entry->res;

                ret = vmw_fifo_emit_dummy_query(dev_priv, ctx->id);

                if (unlikely(ret != 0))
                        DRM_ERROR("Out of fifo space for dummy query.\n");
        }

        if (dev_priv->pinned_bo != sw_context->cur_query_bo) {
                if (dev_priv->pinned_bo) {
                        vmw_bo_pin_reserved(dev_priv->pinned_bo, false);
                        vmw_dmabuf_unreference(&dev_priv->pinned_bo);
                }

                if (!sw_context->needs_post_query_barrier) {
                        vmw_bo_pin_reserved(sw_context->cur_query_bo, true);

                        /*
                         * We pin also the dummy_query_bo buffer so that we
                         * don't need to validate it when emitting
                         * dummy queries in context destroy paths.
                         */

                        if (!dev_priv->dummy_query_bo_pinned) {
                                vmw_bo_pin_reserved(dev_priv->dummy_query_bo,
                                                    true);
                                dev_priv->dummy_query_bo_pinned = true;
                        }

                        BUG_ON(sw_context->last_query_ctx == NULL);
                        dev_priv->query_cid = sw_context->last_query_ctx->id;
                        dev_priv->query_cid_valid = true;
                        dev_priv->pinned_bo =
                                vmw_dmabuf_reference(sw_context->cur_query_bo);
                }
        }
}

/**
 * vmw_translate_mob_pointer - Prepare to translate a user-space buffer
 * handle to a MOB id.
 *
 * @dev_priv: Pointer to a device private structure.
 * @sw_context: The software context used for this command batch validation.
 * @id: Pointer to the user-space handle to be translated.
 * @vmw_bo_p: Points to a location that, on successful return will carry
 * a reference-counted pointer to the DMA buffer identified by the
 * user-space handle in @id.
 *
 * This function saves information needed to translate a user-space buffer
 * handle to a MOB id. The translation does not take place immediately, but
 * during a call to vmw_apply_relocations(). This function builds a relocation
 * list and a list of buffers to validate. The former needs to be freed using
 * either vmw_apply_relocations() or vmw_free_relocations(). The latter
 * needs to be freed using vmw_clear_validations.
 */
static int vmw_translate_mob_ptr(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGAMobId *id,
                                 struct vmw_dma_buffer **vmw_bo_p)
{
        struct vmw_dma_buffer *vmw_bo = NULL;
        uint32_t handle = *id;
        struct vmw_relocation *reloc;
        int ret;

        ret = vmw_user_dmabuf_lookup(sw_context->fp->tfile, handle, &vmw_bo,
                                     NULL);
        if (unlikely(ret != 0)) {
                DRM_ERROR("Could not find or use MOB buffer.\n");
                ret = -EINVAL;
                goto out_no_reloc;
        }

        if (unlikely(sw_context->cur_reloc >= VMWGFX_MAX_RELOCATIONS)) {
                DRM_ERROR("Max number relocations per submission"
                          " exceeded\n");
                ret = -EINVAL;
                goto out_no_reloc;
        }

        reloc = &sw_context->relocs[sw_context->cur_reloc++];
        reloc->mob_loc = id;
        reloc->location = NULL;

        ret = vmw_bo_to_validate_list(sw_context, vmw_bo, true, &reloc->index);
        if (unlikely(ret != 0))
                goto out_no_reloc;

        *vmw_bo_p = vmw_bo;
        return 0;

out_no_reloc:
        vmw_dmabuf_unreference(&vmw_bo);
        *vmw_bo_p = NULL;
        return ret;
}

/**
 * vmw_translate_guest_pointer - Prepare to translate a user-space buffer
 * handle to a valid SVGAGuestPtr
 *
 * @dev_priv: Pointer to a device private structure.
 * @sw_context: The software context used for this command batch validation.
 * @ptr: Pointer to the user-space handle to be translated.
 * @vmw_bo_p: Points to a location that, on successful return will carry
 * a reference-counted pointer to the DMA buffer identified by the
 * user-space handle in @id.
 *
 * This function saves information needed to translate a user-space buffer
 * handle to a valid SVGAGuestPtr. The translation does not take place
 * immediately, but during a call to vmw_apply_relocations().
 * This function builds a relocation list and a list of buffers to validate.
 * The former needs to be freed using either vmw_apply_relocations() or
 * vmw_free_relocations(). The latter needs to be freed using
 * vmw_clear_validations.
 */
static int vmw_translate_guest_ptr(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   SVGAGuestPtr *ptr,
                                   struct vmw_dma_buffer **vmw_bo_p)
{
        struct vmw_dma_buffer *vmw_bo = NULL;
        uint32_t handle = ptr->gmrId;
        struct vmw_relocation *reloc;
        int ret;

        ret = vmw_user_dmabuf_lookup(sw_context->fp->tfile, handle, &vmw_bo,
                                     NULL);
        if (unlikely(ret != 0)) {
                DRM_ERROR("Could not find or use GMR region.\n");
                ret = -EINVAL;
                goto out_no_reloc;
        }

        if (unlikely(sw_context->cur_reloc >= VMWGFX_MAX_RELOCATIONS)) {
                DRM_ERROR("Max number relocations per submission"
                          " exceeded\n");
                ret = -EINVAL;
                goto out_no_reloc;
        }

        reloc = &sw_context->relocs[sw_context->cur_reloc++];
        reloc->location = ptr;

        ret = vmw_bo_to_validate_list(sw_context, vmw_bo, false, &reloc->index);
        if (unlikely(ret != 0))
                goto out_no_reloc;

        *vmw_bo_p = vmw_bo;
        return 0;

out_no_reloc:
        vmw_dmabuf_unreference(&vmw_bo);
        *vmw_bo_p = NULL;
        return ret;
}



/**
 * vmw_cmd_dx_define_query - validate a SVGA_3D_CMD_DX_DEFINE_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 *
 * This function adds the new query into the query COTABLE
 */
static int vmw_cmd_dx_define_query(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   SVGA3dCmdHeader *header)
{
        struct vmw_dx_define_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXDefineQuery q;
        } *cmd;

        int    ret;
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_resource *cotable_res;


        if (ctx_node == NULL) {
                DRM_ERROR("DX Context not set for query.\n");
                return -EINVAL;
        }

        cmd = container_of(header, struct vmw_dx_define_query_cmd, header);

        if (cmd->q.type <  SVGA3D_QUERYTYPE_MIN ||
            cmd->q.type >= SVGA3D_QUERYTYPE_MAX)
                return -EINVAL;

        cotable_res = vmw_context_cotable(ctx_node->res, SVGA_COTABLE_DXQUERY);
        ret = vmw_cotable_notify(cotable_res, cmd->q.queryId);
        vmw_resource_unreference(&cotable_res);

        return ret;
}



/**
 * vmw_cmd_dx_bind_query - validate a SVGA_3D_CMD_DX_BIND_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 *
 * The query bind operation will eventually associate the query ID
 * with its backing MOB.  In this function, we take the user mode
 * MOB ID and use vmw_translate_mob_ptr() to translate it to its
 * kernel mode equivalent.
 */
static int vmw_cmd_dx_bind_query(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGA3dCmdHeader *header)
{
        struct vmw_dx_bind_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXBindQuery q;
        } *cmd;

        struct vmw_dma_buffer *vmw_bo;
        int    ret;


        cmd = container_of(header, struct vmw_dx_bind_query_cmd, header);

        /*
         * Look up the buffer pointed to by q.mobid, put it on the relocation
         * list so its kernel mode MOB ID can be filled in later
         */
        ret = vmw_translate_mob_ptr(dev_priv, sw_context, &cmd->q.mobid,
                                    &vmw_bo);

        if (ret != 0)
                return ret;

        sw_context->dx_query_mob = vmw_bo;
        sw_context->dx_query_ctx = sw_context->dx_ctx_node->res;

        vmw_dmabuf_unreference(&vmw_bo);

        return ret;
}



/**
 * vmw_cmd_begin_gb_query - validate a  SVGA_3D_CMD_BEGIN_GB_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_begin_gb_query(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_begin_gb_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdBeginGBQuery q;
        } *cmd;

        cmd = container_of(header, struct vmw_begin_gb_query_cmd,
                           header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                 user_context_converter, &cmd->q.cid,
                                 NULL);
}

/**
 * vmw_cmd_begin_query - validate a  SVGA_3D_CMD_BEGIN_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_begin_query(struct vmw_private *dev_priv,
                               struct vmw_sw_context *sw_context,
                               SVGA3dCmdHeader *header)
{
        struct vmw_begin_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdBeginQuery q;
        } *cmd;

        cmd = container_of(header, struct vmw_begin_query_cmd,
                           header);

        if (unlikely(dev_priv->has_mob)) {
                struct {
                        SVGA3dCmdHeader header;
                        SVGA3dCmdBeginGBQuery q;
                } gb_cmd;

                BUG_ON(sizeof(gb_cmd) != sizeof(*cmd));

                gb_cmd.header.id = SVGA_3D_CMD_BEGIN_GB_QUERY;
                gb_cmd.header.size = cmd->header.size;
                gb_cmd.q.cid = cmd->q.cid;
                gb_cmd.q.type = cmd->q.type;

                memcpy(cmd, &gb_cmd, sizeof(*cmd));
                return vmw_cmd_begin_gb_query(dev_priv, sw_context, header);
        }

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                 user_context_converter, &cmd->q.cid,
                                 NULL);
}

/**
 * vmw_cmd_end_gb_query - validate a  SVGA_3D_CMD_END_GB_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_end_gb_query(struct vmw_private *dev_priv,
                                struct vmw_sw_context *sw_context,
                                SVGA3dCmdHeader *header)
{
        struct vmw_dma_buffer *vmw_bo;
        struct vmw_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdEndGBQuery q;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_query_cmd, header);
        ret = vmw_cmd_cid_check(dev_priv, sw_context, header);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_translate_mob_ptr(dev_priv, sw_context,
                                    &cmd->q.mobid,
                                    &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_query_bo_switch_prepare(dev_priv, vmw_bo, sw_context);

        vmw_dmabuf_unreference(&vmw_bo);
        return ret;
}

/**
 * vmw_cmd_end_query - validate a  SVGA_3D_CMD_END_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_end_query(struct vmw_private *dev_priv,
                             struct vmw_sw_context *sw_context,
                             SVGA3dCmdHeader *header)
{
        struct vmw_dma_buffer *vmw_bo;
        struct vmw_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdEndQuery q;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_query_cmd, header);
        if (dev_priv->has_mob) {
                struct {
                        SVGA3dCmdHeader header;
                        SVGA3dCmdEndGBQuery q;
                } gb_cmd;

                BUG_ON(sizeof(gb_cmd) != sizeof(*cmd));

                gb_cmd.header.id = SVGA_3D_CMD_END_GB_QUERY;
                gb_cmd.header.size = cmd->header.size;
                gb_cmd.q.cid = cmd->q.cid;
                gb_cmd.q.type = cmd->q.type;
                gb_cmd.q.mobid = cmd->q.guestResult.gmrId;
                gb_cmd.q.offset = cmd->q.guestResult.offset;

                memcpy(cmd, &gb_cmd, sizeof(*cmd));
                return vmw_cmd_end_gb_query(dev_priv, sw_context, header);
        }

        ret = vmw_cmd_cid_check(dev_priv, sw_context, header);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_translate_guest_ptr(dev_priv, sw_context,
                                      &cmd->q.guestResult,
                                      &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_query_bo_switch_prepare(dev_priv, vmw_bo, sw_context);

        vmw_dmabuf_unreference(&vmw_bo);
        return ret;
}

/**
 * vmw_cmd_wait_gb_query - validate a  SVGA_3D_CMD_WAIT_GB_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_wait_gb_query(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGA3dCmdHeader *header)
{
        struct vmw_dma_buffer *vmw_bo;
        struct vmw_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdWaitForGBQuery q;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_query_cmd, header);
        ret = vmw_cmd_cid_check(dev_priv, sw_context, header);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_translate_mob_ptr(dev_priv, sw_context,
                                    &cmd->q.mobid,
                                    &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        vmw_dmabuf_unreference(&vmw_bo);
        return 0;
}

/**
 * vmw_cmd_wait_query - validate a  SVGA_3D_CMD_WAIT_QUERY command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context used for this command submission.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_wait_query(struct vmw_private *dev_priv,
                              struct vmw_sw_context *sw_context,
                              SVGA3dCmdHeader *header)
{
        struct vmw_dma_buffer *vmw_bo;
        struct vmw_query_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdWaitForQuery q;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_query_cmd, header);
        if (dev_priv->has_mob) {
                struct {
                        SVGA3dCmdHeader header;
                        SVGA3dCmdWaitForGBQuery q;
                } gb_cmd;

                BUG_ON(sizeof(gb_cmd) != sizeof(*cmd));

                gb_cmd.header.id = SVGA_3D_CMD_WAIT_FOR_GB_QUERY;
                gb_cmd.header.size = cmd->header.size;
                gb_cmd.q.cid = cmd->q.cid;
                gb_cmd.q.type = cmd->q.type;
                gb_cmd.q.mobid = cmd->q.guestResult.gmrId;
                gb_cmd.q.offset = cmd->q.guestResult.offset;

                memcpy(cmd, &gb_cmd, sizeof(*cmd));
                return vmw_cmd_wait_gb_query(dev_priv, sw_context, header);
        }

        ret = vmw_cmd_cid_check(dev_priv, sw_context, header);
        if (unlikely(ret != 0))
                return ret;

        ret = vmw_translate_guest_ptr(dev_priv, sw_context,
                                      &cmd->q.guestResult,
                                      &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        vmw_dmabuf_unreference(&vmw_bo);
        return 0;
}

static int vmw_cmd_dma(struct vmw_private *dev_priv,
                       struct vmw_sw_context *sw_context,
                       SVGA3dCmdHeader *header)
{
        struct vmw_dma_buffer *vmw_bo = NULL;
        struct vmw_surface *srf = NULL;
        struct vmw_dma_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSurfaceDMA dma;
        } *cmd;
        int ret;
        SVGA3dCmdSurfaceDMASuffix *suffix;
        uint32_t bo_size;

        cmd = container_of(header, struct vmw_dma_cmd, header);
        suffix = (SVGA3dCmdSurfaceDMASuffix *)((unsigned long) &cmd->dma +
                                               header->size - sizeof(*suffix));

        /* Make sure device and verifier stays in sync. */
        if (unlikely(suffix->suffixSize != sizeof(*suffix))) {
                DRM_ERROR("Invalid DMA suffix size.\n");
                return -EINVAL;
        }

        ret = vmw_translate_guest_ptr(dev_priv, sw_context,
                                      &cmd->dma.guest.ptr,
                                      &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        /* Make sure DMA doesn't cross BO boundaries. */
        bo_size = vmw_bo->base.num_pages * PAGE_SIZE;
        if (unlikely(cmd->dma.guest.ptr.offset > bo_size)) {
                DRM_ERROR("Invalid DMA offset.\n");
                return -EINVAL;
        }

        bo_size -= cmd->dma.guest.ptr.offset;
        if (unlikely(suffix->maximumOffset > bo_size))
                suffix->maximumOffset = bo_size;

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter, &cmd->dma.host.sid,
                                NULL);
        if (unlikely(ret != 0)) {
                if (unlikely(ret != -ERESTARTSYS))
                        DRM_ERROR("could not find surface for DMA.\n");
                goto out_no_surface;
        }

        srf = vmw_res_to_srf(sw_context->res_cache[vmw_res_surface].res);

        vmw_kms_cursor_snoop(srf, sw_context->fp->tfile, &vmw_bo->base,
                             header);

out_no_surface:
        vmw_dmabuf_unreference(&vmw_bo);
        return ret;
}

static int vmw_cmd_draw(struct vmw_private *dev_priv,
                        struct vmw_sw_context *sw_context,
                        SVGA3dCmdHeader *header)
{
        struct vmw_draw_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdDrawPrimitives body;
        } *cmd;
        SVGA3dVertexDecl *decl = (SVGA3dVertexDecl *)(
                (unsigned long)header + sizeof(*cmd));
        SVGA3dPrimitiveRange *range;
        uint32_t i;
        uint32_t maxnum;
        int ret;

        ret = vmw_cmd_cid_check(dev_priv, sw_context, header);
        if (unlikely(ret != 0))
                return ret;

        cmd = container_of(header, struct vmw_draw_cmd, header);
        maxnum = (header->size - sizeof(cmd->body)) / sizeof(*decl);

        if (unlikely(cmd->body.numVertexDecls > maxnum)) {
                DRM_ERROR("Illegal number of vertex declarations.\n");
                return -EINVAL;
        }

        for (i = 0; i < cmd->body.numVertexDecls; ++i, ++decl) {
                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                        user_surface_converter,
                                        &decl->array.surfaceId, NULL);
                if (unlikely(ret != 0))
                        return ret;
        }

        maxnum = (header->size - sizeof(cmd->body) -
                  cmd->body.numVertexDecls * sizeof(*decl)) / sizeof(*range);
        if (unlikely(cmd->body.numRanges > maxnum)) {
                DRM_ERROR("Illegal number of index ranges.\n");
                return -EINVAL;
        }

        range = (SVGA3dPrimitiveRange *) decl;
        for (i = 0; i < cmd->body.numRanges; ++i, ++range) {
                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                        user_surface_converter,
                                        &range->indexArray.surfaceId, NULL);
                if (unlikely(ret != 0))
                        return ret;
        }
        return 0;
}


static int vmw_cmd_tex_state(struct vmw_private *dev_priv,
                             struct vmw_sw_context *sw_context,
                             SVGA3dCmdHeader *header)
{
        struct vmw_tex_state_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSetTextureState state;
        } *cmd;

        SVGA3dTextureState *last_state = (SVGA3dTextureState *)
          ((unsigned long) header + header->size + sizeof(header));
        SVGA3dTextureState *cur_state = (SVGA3dTextureState *)
                ((unsigned long) header + sizeof(struct vmw_tex_state_cmd));
        struct vmw_resource_val_node *ctx_node;
        struct vmw_resource_val_node *res_node;
        int ret;

        cmd = container_of(header, struct vmw_tex_state_cmd,
                           header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->state.cid,
                                &ctx_node);
        if (unlikely(ret != 0))
                return ret;

        for (; cur_state < last_state; ++cur_state) {
                if (likely(cur_state->name != SVGA3D_TS_BIND_TEXTURE))
                        continue;

                if (cur_state->stage >= SVGA3D_NUM_TEXTURE_UNITS) {
                        DRM_ERROR("Illegal texture/sampler unit %u.\n",
                                  (unsigned) cur_state->stage);
                        return -EINVAL;
                }

                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                        user_surface_converter,
                                        &cur_state->value, &res_node);
                if (unlikely(ret != 0))
                        return ret;

                if (dev_priv->has_mob) {
                        struct vmw_ctx_bindinfo_tex binding;

                        binding.bi.ctx = ctx_node->res;
                        binding.bi.res = res_node ? res_node->res : NULL;
                        binding.bi.bt = vmw_ctx_binding_tex;
                        binding.texture_stage = cur_state->stage;
                        vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                                        0, binding.texture_stage);
                }
        }

        return 0;
}

static int vmw_cmd_check_define_gmrfb(struct vmw_private *dev_priv,
                                      struct vmw_sw_context *sw_context,
                                      void *buf)
{
        struct vmw_dma_buffer *vmw_bo;
        int ret;

        struct {
                uint32_t header;
                SVGAFifoCmdDefineGMRFB body;
        } *cmd = buf;

        ret = vmw_translate_guest_ptr(dev_priv, sw_context,
                                      &cmd->body.ptr,
                                      &vmw_bo);
        if (unlikely(ret != 0))
                return ret;

        vmw_dmabuf_unreference(&vmw_bo);

        return ret;
}


/**
 * vmw_cmd_res_switch_backup - Utility function to handle backup buffer
 * switching
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @val_node: The validation node representing the resource.
 * @buf_id: Pointer to the user-space backup buffer handle in the command
 * stream.
 * @backup_offset: Offset of backup into MOB.
 *
 * This function prepares for registering a switch of backup buffers
 * in the resource metadata just prior to unreserving. It's basically a wrapper
 * around vmw_cmd_res_switch_backup with a different interface.
 */
static int vmw_cmd_res_switch_backup(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     struct vmw_resource_val_node *val_node,
                                     uint32_t *buf_id,
                                     unsigned long backup_offset)
{
        struct vmw_dma_buffer *dma_buf;
        int ret;

        ret = vmw_translate_mob_ptr(dev_priv, sw_context, buf_id, &dma_buf);
        if (ret)
                return ret;

        val_node->switching_backup = true;
        if (val_node->first_usage)
                val_node->no_buffer_needed = true;

        vmw_dmabuf_unreference(&val_node->new_backup);
        val_node->new_backup = dma_buf;
        val_node->new_backup_offset = backup_offset;

        return 0;
}


/**
 * vmw_cmd_switch_backup - Utility function to handle backup buffer switching
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @res_type: The resource type.
 * @converter: Information about user-space binding for this resource type.
 * @res_id: Pointer to the user-space resource handle in the command stream.
 * @buf_id: Pointer to the user-space backup buffer handle in the command
 * stream.
 * @backup_offset: Offset of backup into MOB.
 *
 * This function prepares for registering a switch of backup buffers
 * in the resource metadata just prior to unreserving. It's basically a wrapper
 * around vmw_cmd_res_switch_backup with a different interface.
 */
static int vmw_cmd_switch_backup(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 enum vmw_res_type res_type,
                                 const struct vmw_user_resource_conv
                                 *converter,
                                 uint32_t *res_id,
                                 uint32_t *buf_id,
                                 unsigned long backup_offset)
{
        struct vmw_resource_val_node *val_node;
        int ret;

        ret = vmw_cmd_res_check(dev_priv, sw_context, res_type,
                                converter, res_id, &val_node);
        if (ret)
                return ret;

        return vmw_cmd_res_switch_backup(dev_priv, sw_context, val_node,
                                         buf_id, backup_offset);
}

/**
 * vmw_cmd_bind_gb_surface - Validate an SVGA_3D_CMD_BIND_GB_SURFACE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_bind_gb_surface(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   SVGA3dCmdHeader *header)
{
        struct vmw_bind_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdBindGBSurface body;
        } *cmd;

        cmd = container_of(header, struct vmw_bind_gb_surface_cmd, header);

        return vmw_cmd_switch_backup(dev_priv, sw_context, vmw_res_surface,
                                     user_surface_converter,
                                     &cmd->body.sid, &cmd->body.mobid,
                                     0);
}

/**
 * vmw_cmd_update_gb_image - Validate an SVGA_3D_CMD_UPDATE_GB_IMAGE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_update_gb_image(struct vmw_private *dev_priv,
                                   struct vmw_sw_context *sw_context,
                                   SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdUpdateGBImage body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.image.sid, NULL);
}

/**
 * vmw_cmd_update_gb_surface - Validate an SVGA_3D_CMD_UPDATE_GB_SURFACE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_update_gb_surface(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdUpdateGBSurface body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.sid, NULL);
}

/**
 * vmw_cmd_readback_gb_image - Validate an SVGA_3D_CMD_READBACK_GB_IMAGE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_readback_gb_image(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdReadbackGBImage body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.image.sid, NULL);
}

/**
 * vmw_cmd_readback_gb_surface - Validate an SVGA_3D_CMD_READBACK_GB_SURFACE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_readback_gb_surface(struct vmw_private *dev_priv,
                                       struct vmw_sw_context *sw_context,
                                       SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdReadbackGBSurface body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.sid, NULL);
}

/**
 * vmw_cmd_invalidate_gb_image - Validate an SVGA_3D_CMD_INVALIDATE_GB_IMAGE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_invalidate_gb_image(struct vmw_private *dev_priv,
                                       struct vmw_sw_context *sw_context,
                                       SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdInvalidateGBImage body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.image.sid, NULL);
}

/**
 * vmw_cmd_invalidate_gb_surface - Validate an
 * SVGA_3D_CMD_INVALIDATE_GB_SURFACE command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_invalidate_gb_surface(struct vmw_private *dev_priv,
                                         struct vmw_sw_context *sw_context,
                                         SVGA3dCmdHeader *header)
{
        struct vmw_gb_surface_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdInvalidateGBSurface body;
        } *cmd;

        cmd = container_of(header, struct vmw_gb_surface_cmd, header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->body.sid, NULL);
}


/**
 * vmw_cmd_shader_define - Validate an SVGA_3D_CMD_SHADER_DEFINE
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_shader_define(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGA3dCmdHeader *header)
{
        struct vmw_shader_define_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdDefineShader body;
        } *cmd;
        int ret;
        size_t size;
        struct vmw_resource_val_node *val;

        cmd = container_of(header, struct vmw_shader_define_cmd,
                           header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->body.cid,
                                &val);
        if (unlikely(ret != 0))
                return ret;

        if (unlikely(!dev_priv->has_mob))
                return 0;

        size = cmd->header.size - sizeof(cmd->body);
        ret = vmw_compat_shader_add(dev_priv,
                                    vmw_context_res_man(val->res),
                                    cmd->body.shid, cmd + 1,
                                    cmd->body.type, size,
                                    &sw_context->staged_cmd_res);
        if (unlikely(ret != 0))
                return ret;

        return vmw_resource_relocation_add(&sw_context->res_relocations,
                                           NULL, &cmd->header.id -
                                           sw_context->buf_start);

        return 0;
}

/**
 * vmw_cmd_shader_destroy - Validate an SVGA_3D_CMD_SHADER_DESTROY
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_shader_destroy(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_shader_destroy_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdDestroyShader body;
        } *cmd;
        int ret;
        struct vmw_resource_val_node *val;

        cmd = container_of(header, struct vmw_shader_destroy_cmd,
                           header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->body.cid,
                                &val);
        if (unlikely(ret != 0))
                return ret;

        if (unlikely(!dev_priv->has_mob))
                return 0;

        ret = vmw_shader_remove(vmw_context_res_man(val->res),
                                cmd->body.shid,
                                cmd->body.type,
                                &sw_context->staged_cmd_res);
        if (unlikely(ret != 0))
                return ret;

        return vmw_resource_relocation_add(&sw_context->res_relocations,
                                           NULL, &cmd->header.id -
                                           sw_context->buf_start);

        return 0;
}

/**
 * vmw_cmd_set_shader - Validate an SVGA_3D_CMD_SET_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_set_shader(struct vmw_private *dev_priv,
                              struct vmw_sw_context *sw_context,
                              SVGA3dCmdHeader *header)
{
        struct vmw_set_shader_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSetShader body;
        } *cmd;
        struct vmw_resource_val_node *ctx_node, *res_node = NULL;
        struct vmw_ctx_bindinfo_shader binding;
        struct vmw_resource *res = NULL;
        int ret;

        cmd = container_of(header, struct vmw_set_shader_cmd,
                           header);

        if (cmd->body.type >= SVGA3D_SHADERTYPE_PREDX_MAX) {
                DRM_ERROR("Illegal shader type %u.\n",
                          (unsigned) cmd->body.type);
                return -EINVAL;
        }

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->body.cid,
                                &ctx_node);
        if (unlikely(ret != 0))
                return ret;

        if (!dev_priv->has_mob)
                return 0;

        if (cmd->body.shid != SVGA3D_INVALID_ID) {
                res = vmw_shader_lookup(vmw_context_res_man(ctx_node->res),
                                        cmd->body.shid,
                                        cmd->body.type);

                if (!IS_ERR(res)) {
                        ret = vmw_cmd_res_reloc_add(dev_priv, sw_context,
                                                    &cmd->body.shid, res,
                                                    &res_node);
                        vmw_resource_unreference(&res);
                        if (unlikely(ret != 0))
                                return ret;
                }
        }

        if (!res_node) {
                ret = vmw_cmd_res_check(dev_priv, sw_context,
                                        vmw_res_shader,
                                        user_shader_converter,
                                        &cmd->body.shid, &res_node);
                if (unlikely(ret != 0))
                        return ret;
        }

        binding.bi.ctx = ctx_node->res;
        binding.bi.res = res_node ? res_node->res : NULL;
        binding.bi.bt = vmw_ctx_binding_shader;
        binding.shader_slot = cmd->body.type - SVGA3D_SHADERTYPE_MIN;
        vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                        binding.shader_slot, 0);
        return 0;
}

/**
 * vmw_cmd_set_shader_const - Validate an SVGA_3D_CMD_SET_SHADER_CONST
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_set_shader_const(struct vmw_private *dev_priv,
                                    struct vmw_sw_context *sw_context,
                                    SVGA3dCmdHeader *header)
{
        struct vmw_set_shader_const_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdSetShaderConst body;
        } *cmd;
        int ret;

        cmd = container_of(header, struct vmw_set_shader_const_cmd,
                           header);

        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                user_context_converter, &cmd->body.cid,
                                NULL);
        if (unlikely(ret != 0))
                return ret;

        if (dev_priv->has_mob)
                header->id = SVGA_3D_CMD_SET_GB_SHADERCONSTS_INLINE;

        return 0;
}

/**
 * vmw_cmd_bind_gb_shader - Validate an SVGA_3D_CMD_BIND_GB_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_bind_gb_shader(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_bind_gb_shader_cmd {
                SVGA3dCmdHeader header;
                SVGA3dCmdBindGBShader body;
        } *cmd;

        cmd = container_of(header, struct vmw_bind_gb_shader_cmd,
                           header);

        return vmw_cmd_switch_backup(dev_priv, sw_context, vmw_res_shader,
                                     user_shader_converter,
                                     &cmd->body.shid, &cmd->body.mobid,
                                     cmd->body.offsetInBytes);
}

/**
 * vmw_cmd_dx_set_single_constant_buffer - Validate an
 * SVGA_3D_CMD_DX_SET_SINGLE_CONSTANT_BUFFER command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int
vmw_cmd_dx_set_single_constant_buffer(struct vmw_private *dev_priv,
                                      struct vmw_sw_context *sw_context,
                                      SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetSingleConstantBuffer body;
        } *cmd;
        struct vmw_resource_val_node *res_node = NULL;
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_ctx_bindinfo_cb binding;
        int ret;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        cmd = container_of(header, typeof(*cmd), header);
        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.sid, &res_node);
        if (unlikely(ret != 0))
                return ret;

        binding.bi.ctx = ctx_node->res;
        binding.bi.res = res_node ? res_node->res : NULL;
        binding.bi.bt = vmw_ctx_binding_cb;
        binding.shader_slot = cmd->body.type - SVGA3D_SHADERTYPE_MIN;
        binding.offset = cmd->body.offsetInBytes;
        binding.size = cmd->body.sizeInBytes;
        binding.slot = cmd->body.slot;

        if (binding.shader_slot >= SVGA3D_NUM_SHADERTYPE_DX10 ||
            binding.slot >= SVGA3D_DX_MAX_CONSTBUFFERS) {
                DRM_ERROR("Illegal const buffer shader %u slot %u.\n",
                          (unsigned) cmd->body.type,
                          (unsigned) binding.slot);
                return -EINVAL;
        }

        vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                        binding.shader_slot, binding.slot);

        return 0;
}

/**
 * vmw_cmd_dx_set_shader_res - Validate an
 * SVGA_3D_CMD_DX_SET_SHADER_RESOURCES command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_shader_res(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetShaderResources body;
        } *cmd = container_of(header, typeof(*cmd), header);
        u32 num_sr_view = (cmd->header.size - sizeof(cmd->body)) /
                sizeof(SVGA3dShaderResourceViewId);

        if ((u64) cmd->body.startView + (u64) num_sr_view >
            (u64) SVGA3D_DX_MAX_SRVIEWS ||
            cmd->body.type >= SVGA3D_SHADERTYPE_DX10_MAX) {
                DRM_ERROR("Invalid shader binding.\n");
                return -EINVAL;
        }

        return vmw_view_bindings_add(sw_context, vmw_view_sr,
                                     vmw_ctx_binding_sr,
                                     cmd->body.type - SVGA3D_SHADERTYPE_MIN,
                                     (void *) &cmd[1], num_sr_view,
                                     cmd->body.startView);
}

/**
 * vmw_cmd_dx_set_shader - Validate an SVGA_3D_CMD_DX_SET_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_shader(struct vmw_private *dev_priv,
                                 struct vmw_sw_context *sw_context,
                                 SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetShader body;
        } *cmd;
        struct vmw_resource *res = NULL;
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_ctx_bindinfo_shader binding;
        int ret = 0;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        cmd = container_of(header, typeof(*cmd), header);

        if (cmd->body.type >= SVGA3D_SHADERTYPE_DX10_MAX) {
                DRM_ERROR("Illegal shader type %u.\n",
                          (unsigned) cmd->body.type);
                return -EINVAL;
        }

        if (cmd->body.shaderId != SVGA3D_INVALID_ID) {
                res = vmw_shader_lookup(sw_context->man, cmd->body.shaderId, 0);
                if (IS_ERR(res)) {
                        DRM_ERROR("Could not find shader for binding.\n");
                        return PTR_ERR(res);
                }

                ret = vmw_resource_val_add(sw_context, res, NULL);
                if (ret)
                        goto out_unref;
        }

        binding.bi.ctx = ctx_node->res;
        binding.bi.res = res;
        binding.bi.bt = vmw_ctx_binding_dx_shader;
        binding.shader_slot = cmd->body.type - SVGA3D_SHADERTYPE_MIN;

        vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                        binding.shader_slot, 0);
out_unref:
        if (res)
                vmw_resource_unreference(&res);

        return ret;
}

/**
 * vmw_cmd_dx_set_vertex_buffers - Validates an
 * SVGA_3D_CMD_DX_SET_VERTEX_BUFFERS command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_vertex_buffers(struct vmw_private *dev_priv,
                                         struct vmw_sw_context *sw_context,
                                         SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_ctx_bindinfo_vb binding;
        struct vmw_resource_val_node *res_node;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetVertexBuffers body;
                SVGA3dVertexBuffer buf[];
        } *cmd;
        int i, ret, num;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        cmd = container_of(header, typeof(*cmd), header);
        num = (cmd->header.size - sizeof(cmd->body)) /
                sizeof(SVGA3dVertexBuffer);
        if ((u64)num + (u64)cmd->body.startBuffer >
            (u64)SVGA3D_DX_MAX_VERTEXBUFFERS) {
                DRM_ERROR("Invalid number of vertex buffers.\n");
                return -EINVAL;
        }

        for (i = 0; i < num; i++) {
                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                        user_surface_converter,
                                        &cmd->buf[i].sid, &res_node);
                if (unlikely(ret != 0))
                        return ret;

                binding.bi.ctx = ctx_node->res;
                binding.bi.bt = vmw_ctx_binding_vb;
                binding.bi.res = ((res_node) ? res_node->res : NULL);
                binding.offset = cmd->buf[i].offset;
                binding.stride = cmd->buf[i].stride;
                binding.slot = i + cmd->body.startBuffer;

                vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                                0, binding.slot);
        }

        return 0;
}

/**
 * vmw_cmd_dx_ia_set_vertex_buffers - Validate an
 * SVGA_3D_CMD_DX_IA_SET_VERTEX_BUFFERS command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_index_buffer(struct vmw_private *dev_priv,
                                       struct vmw_sw_context *sw_context,
                                       SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_ctx_bindinfo_ib binding;
        struct vmw_resource_val_node *res_node;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetIndexBuffer body;
        } *cmd;
        int ret;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        cmd = container_of(header, typeof(*cmd), header);
        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->body.sid, &res_node);
        if (unlikely(ret != 0))
                return ret;

        binding.bi.ctx = ctx_node->res;
        binding.bi.res = ((res_node) ? res_node->res : NULL);
        binding.bi.bt = vmw_ctx_binding_ib;
        binding.offset = cmd->body.offset;
        binding.format = cmd->body.format;

        vmw_binding_add(ctx_node->staged_bindings, &binding.bi, 0, 0);

        return 0;
}

/**
 * vmw_cmd_dx_set_rendertarget - Validate an
 * SVGA_3D_CMD_DX_SET_RENDERTARGETS command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_rendertargets(struct vmw_private *dev_priv,
                                        struct vmw_sw_context *sw_context,
                                        SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetRenderTargets body;
        } *cmd = container_of(header, typeof(*cmd), header);
        int ret;
        u32 num_rt_view = (cmd->header.size - sizeof(cmd->body)) /
                sizeof(SVGA3dRenderTargetViewId);

        if (num_rt_view > SVGA3D_MAX_SIMULTANEOUS_RENDER_TARGETS) {
                DRM_ERROR("Invalid DX Rendertarget binding.\n");
                return -EINVAL;
        }

        ret = vmw_view_bindings_add(sw_context, vmw_view_ds,
                                    vmw_ctx_binding_ds, 0,
                                    &cmd->body.depthStencilViewId, 1, 0);
        if (ret)
                return ret;

        return vmw_view_bindings_add(sw_context, vmw_view_rt,
                                     vmw_ctx_binding_dx_rt, 0,
                                     (void *)&cmd[1], num_rt_view, 0);
}

/**
 * vmw_cmd_dx_clear_rendertarget_view - Validate an
 * SVGA_3D_CMD_DX_CLEAR_RENDERTARGET_VIEW command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_clear_rendertarget_view(struct vmw_private *dev_priv,
                                              struct vmw_sw_context *sw_context,
                                              SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXClearRenderTargetView body;
        } *cmd = container_of(header, typeof(*cmd), header);

        return vmw_view_id_val_add(sw_context, vmw_view_rt,
                                   cmd->body.renderTargetViewId);
}

/**
 * vmw_cmd_dx_clear_rendertarget_view - Validate an
 * SVGA_3D_CMD_DX_CLEAR_DEPTHSTENCIL_VIEW command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_clear_depthstencil_view(struct vmw_private *dev_priv,
                                              struct vmw_sw_context *sw_context,
                                              SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXClearDepthStencilView body;
        } *cmd = container_of(header, typeof(*cmd), header);

        return vmw_view_id_val_add(sw_context, vmw_view_ds,
                                   cmd->body.depthStencilViewId);
}

static int vmw_cmd_dx_view_define(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_resource_val_node *srf_node;
        struct vmw_resource *res;
        enum vmw_view_type view_type;
        int ret;
        /*
         * This is based on the fact that all affected define commands have
         * the same initial command body layout.
         */
        struct {
                SVGA3dCmdHeader header;
                uint32 defined_id;
                uint32 sid;
        } *cmd;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        view_type = vmw_view_cmd_to_type(header->id);
        cmd = container_of(header, typeof(*cmd), header);
        ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                user_surface_converter,
                                &cmd->sid, &srf_node);
        if (unlikely(ret != 0))
                return ret;

        res = vmw_context_cotable(ctx_node->res, vmw_view_cotables[view_type]);
        ret = vmw_cotable_notify(res, cmd->defined_id);
        vmw_resource_unreference(&res);
        if (unlikely(ret != 0))
                return ret;

        return vmw_view_add(sw_context->man,
                            ctx_node->res,
                            srf_node->res,
                            view_type,
                            cmd->defined_id,
                            header,
                            header->size + sizeof(*header),
                            &sw_context->staged_cmd_res);
}

/**
 * vmw_cmd_dx_set_so_targets - Validate an
 * SVGA_3D_CMD_DX_SET_SOTARGETS command.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_set_so_targets(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_ctx_bindinfo_so binding;
        struct vmw_resource_val_node *res_node;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXSetSOTargets body;
                SVGA3dSoTarget targets[];
        } *cmd;
        int i, ret, num;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        cmd = container_of(header, typeof(*cmd), header);
        num = (cmd->header.size - sizeof(cmd->body)) /
                sizeof(SVGA3dSoTarget);

        if (num > SVGA3D_DX_MAX_SOTARGETS) {
                DRM_ERROR("Invalid DX SO binding.\n");
                return -EINVAL;
        }

        for (i = 0; i < num; i++) {
                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                        user_surface_converter,
                                        &cmd->targets[i].sid, &res_node);
                if (unlikely(ret != 0))
                        return ret;

                binding.bi.ctx = ctx_node->res;
                binding.bi.res = ((res_node) ? res_node->res : NULL);
                binding.bi.bt = vmw_ctx_binding_so,
                binding.offset = cmd->targets[i].offset;
                binding.size = cmd->targets[i].sizeInBytes;
                binding.slot = i;

                vmw_binding_add(ctx_node->staged_bindings, &binding.bi,
                                0, binding.slot);
        }

        return 0;
}

static int vmw_cmd_dx_so_define(struct vmw_private *dev_priv,
                                struct vmw_sw_context *sw_context,
                                SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_resource *res;
        /*
         * This is based on the fact that all affected define commands have
         * the same initial command body layout.
         */
        struct {
                SVGA3dCmdHeader header;
                uint32 defined_id;
        } *cmd;
        enum vmw_so_type so_type;
        int ret;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        so_type = vmw_so_cmd_to_type(header->id);
        res = vmw_context_cotable(ctx_node->res, vmw_so_cotables[so_type]);
        cmd = container_of(header, typeof(*cmd), header);
        ret = vmw_cotable_notify(res, cmd->defined_id);
        vmw_resource_unreference(&res);

        return ret;
}

/**
 * vmw_cmd_dx_check_subresource - Validate an
 * SVGA_3D_CMD_DX_[X]_SUBRESOURCE command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_check_subresource(struct vmw_private *dev_priv,
                                        struct vmw_sw_context *sw_context,
                                        SVGA3dCmdHeader *header)
{
        struct {
                SVGA3dCmdHeader header;
                union {
                        SVGA3dCmdDXReadbackSubResource r_body;
                        SVGA3dCmdDXInvalidateSubResource i_body;
                        SVGA3dCmdDXUpdateSubResource u_body;
                        SVGA3dSurfaceId sid;
                };
        } *cmd;

        BUILD_BUG_ON(offsetof(typeof(*cmd), r_body.sid) !=
                     offsetof(typeof(*cmd), sid));
        BUILD_BUG_ON(offsetof(typeof(*cmd), i_body.sid) !=
                     offsetof(typeof(*cmd), sid));
        BUILD_BUG_ON(offsetof(typeof(*cmd), u_body.sid) !=
                     offsetof(typeof(*cmd), sid));

        cmd = container_of(header, typeof(*cmd), header);

        return vmw_cmd_res_check(dev_priv, sw_context, vmw_res_surface,
                                 user_surface_converter,
                                 &cmd->sid, NULL);
}

static int vmw_cmd_dx_cid_check(struct vmw_private *dev_priv,
                                struct vmw_sw_context *sw_context,
                                SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;

        if (unlikely(ctx_node == NULL)) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        return 0;
}

/**
 * vmw_cmd_dx_view_remove - validate a view remove command and
 * schedule the view resource for removal.
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 *
 * Check that the view exists, and if it was not created using this
 * command batch, make sure it's validated (present in the device) so that
 * the remove command will not confuse the device.
 */
static int vmw_cmd_dx_view_remove(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct {
                SVGA3dCmdHeader header;
                union vmw_view_destroy body;
        } *cmd = container_of(header, typeof(*cmd), header);
        enum vmw_view_type view_type = vmw_view_cmd_to_type(header->id);
        struct vmw_resource *view;
        int ret;

        if (!ctx_node) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        ret = vmw_view_remove(sw_context->man,
                              cmd->body.view_id, view_type,
                              &sw_context->staged_cmd_res,
                              &view);
        if (ret || !view)
                return ret;

        /*
         * Add view to the validate list iff it was not created using this
         * command batch.
         */
        return vmw_view_res_val_add(sw_context, view);
}

/**
 * vmw_cmd_dx_define_shader - Validate an SVGA_3D_CMD_DX_DEFINE_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_define_shader(struct vmw_private *dev_priv,
                                    struct vmw_sw_context *sw_context,
                                    SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct vmw_resource *res;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXDefineShader body;
        } *cmd = container_of(header, typeof(*cmd), header);
        int ret;

        if (!ctx_node) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        res = vmw_context_cotable(ctx_node->res, SVGA_COTABLE_DXSHADER);
        ret = vmw_cotable_notify(res, cmd->body.shaderId);
        vmw_resource_unreference(&res);
        if (ret)
                return ret;

        return vmw_dx_shader_add(sw_context->man, ctx_node->res,
                                 cmd->body.shaderId, cmd->body.type,
                                 &sw_context->staged_cmd_res);
}

/**
 * vmw_cmd_dx_destroy_shader - Validate an SVGA_3D_CMD_DX_DESTROY_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_destroy_shader(struct vmw_private *dev_priv,
                                     struct vmw_sw_context *sw_context,
                                     SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node = sw_context->dx_ctx_node;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXDestroyShader body;
        } *cmd = container_of(header, typeof(*cmd), header);
        int ret;

        if (!ctx_node) {
                DRM_ERROR("DX Context not set.\n");
                return -EINVAL;
        }

        ret = vmw_shader_remove(sw_context->man, cmd->body.shaderId, 0,
                                &sw_context->staged_cmd_res);
        if (ret)
                DRM_ERROR("Could not find shader to remove.\n");

        return ret;
}

/**
 * vmw_cmd_dx_bind_shader - Validate an SVGA_3D_CMD_DX_BIND_SHADER
 * command
 *
 * @dev_priv: Pointer to a device private struct.
 * @sw_context: The software context being used for this batch.
 * @header: Pointer to the command header in the command stream.
 */
static int vmw_cmd_dx_bind_shader(struct vmw_private *dev_priv,
                                  struct vmw_sw_context *sw_context,
                                  SVGA3dCmdHeader *header)
{
        struct vmw_resource_val_node *ctx_node;
        struct vmw_resource_val_node *res_node;
        struct vmw_resource *res;
        struct {
                SVGA3dCmdHeader header;
                SVGA3dCmdDXBindShader body;
        } *cmd = container_of(header, typeof(*cmd), header);
        int ret;

        if (cmd->body.cid != SVGA3D_INVALID_ID) {
                ret = vmw_cmd_res_check(dev_priv, sw_context, vmw_res_context,
                                        user_context_converter,
                                        &cmd->body.cid, &ctx_node);
                if (ret)
                        return ret;
        } else {
                ctx_node = sw_context->dx_ctx_node;
                if (!ctx_node) {
                        DRM_ERROR("DX Context not set.\n");
                        return -EINVAL;
                }
        }

        res = vmw_shader_lookup(vmw_context_res_man(ctx_node->res),
                                cmd->body.shid, 0);
        if (IS_ERR(res)) {
                DRM_ERROR("Could not find shader to bind.\n");
                return PTR_ERR(res);
        }

        ret = vmw_resource_val_add(sw_context, res, &res_node);
        if (ret) {
                DRM_ERROR("Error creating resource validation node.\n");
                goto out_unref;
        }