drivers/gpu/drm/vmwgfx/vmwgfx_surface.c

   1 /**************************************************************************
   2  *
   3  * Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #include "vmwgfx_drv.h"
  29 #include "vmwgfx_resource_priv.h"
  30 #include "vmwgfx_so.h"
  31 #include "vmwgfx_binding.h"
  32 #include <ttm/ttm_placement.h>
  33 #include "device_include/svga3d_surfacedefs.h"
  34
  35
  36 /**
  37  * struct vmw_user_surface - User-space visible surface resource
  38  *
  39  * @base:           The TTM base object handling user-space visibility.
  40  * @srf:            The surface metadata.
  41  * @size:           TTM accounting size for the surface.
  42  * @master: master of the creating client. Used for security check.
  43  */
  44 struct vmw_user_surface {
  45         struct ttm_prime_object prime;
  46         struct vmw_surface srf;
  47         uint32_t size;
  48         struct drm_master *master;
  49         struct ttm_base_object *backup_base;
  50 };
  51
  52 /**
  53  * struct vmw_surface_offset - Backing store mip level offset info
  54  *
  55  * @face:           Surface face.
  56  * @mip:            Mip level.
  57  * @bo_offset:      Offset into backing store of this mip level.
  58  *
  59  */
  60 struct vmw_surface_offset {
  61         uint32_t face;
  62         uint32_t mip;
  63         uint32_t bo_offset;
  64 };
  65
  66 static void vmw_user_surface_free(struct vmw_resource *res);
  67 static struct vmw_resource *
  68 vmw_user_surface_base_to_res(struct ttm_base_object *base);
  69 static int vmw_legacy_srf_bind(struct vmw_resource *res,
  70                                struct ttm_validate_buffer *val_buf);
  71 static int vmw_legacy_srf_unbind(struct vmw_resource *res,
  72                                  bool readback,
  73                                  struct ttm_validate_buffer *val_buf);
  74 static int vmw_legacy_srf_create(struct vmw_resource *res);
  75 static int vmw_legacy_srf_destroy(struct vmw_resource *res);
  76 static int vmw_gb_surface_create(struct vmw_resource *res);
  77 static int vmw_gb_surface_bind(struct vmw_resource *res,
  78                                struct ttm_validate_buffer *val_buf);
  79 static int vmw_gb_surface_unbind(struct vmw_resource *res,
  80                                  bool readback,
  81                                  struct ttm_validate_buffer *val_buf);
  82 static int vmw_gb_surface_destroy(struct vmw_resource *res);
  83
  84
  85 static const struct vmw_user_resource_conv user_surface_conv = {
  86         .object_type = VMW_RES_SURFACE,
  87         .base_obj_to_res = vmw_user_surface_base_to_res,
  88         .res_free = vmw_user_surface_free
  89 };
  90
  91 const struct vmw_user_resource_conv *user_surface_converter =
  92         &user_surface_conv;
  93
  94
  95 static uint64_t vmw_user_surface_size;
  96
  97 static const struct vmw_res_func vmw_legacy_surface_func = {
  98         .res_type = vmw_res_surface,
  99         .needs_backup = false,
 100         .may_evict = true,
 101         .type_name = "legacy surfaces",
 102         .backup_placement = &vmw_srf_placement,
 103         .create = &vmw_legacy_srf_create,
 104         .destroy = &vmw_legacy_srf_destroy,
 105         .bind = &vmw_legacy_srf_bind,
 106         .unbind = &vmw_legacy_srf_unbind
 107 };
 108
 109 static const struct vmw_res_func vmw_gb_surface_func = {
 110         .res_type = vmw_res_surface,
 111         .needs_backup = true,
 112         .may_evict = true,
 113         .type_name = "guest backed surfaces",
 114         .backup_placement = &vmw_mob_placement,
 115         .create = vmw_gb_surface_create,
 116         .destroy = vmw_gb_surface_destroy,
 117         .bind = vmw_gb_surface_bind,
 118         .unbind = vmw_gb_surface_unbind
 119 };
 120
 121 /**
 122  * struct vmw_surface_dma - SVGA3D DMA command
 123  */
 124 struct vmw_surface_dma {
 125         SVGA3dCmdHeader header;
 126         SVGA3dCmdSurfaceDMA body;
 127         SVGA3dCopyBox cb;
 128         SVGA3dCmdSurfaceDMASuffix suffix;
 129 };
 130
 131 /**
 132  * struct vmw_surface_define - SVGA3D Surface Define command
 133  */
 134 struct vmw_surface_define {
 135         SVGA3dCmdHeader header;
 136         SVGA3dCmdDefineSurface body;
 137 };
 138
 139 /**
 140  * struct vmw_surface_destroy - SVGA3D Surface Destroy command
 141  */
 142 struct vmw_surface_destroy {
 143         SVGA3dCmdHeader header;
 144         SVGA3dCmdDestroySurface body;
 145 };
 146
 147
 148 /**
 149  * vmw_surface_dma_size - Compute fifo size for a dma command.
 150  *
 151  * @srf: Pointer to a struct vmw_surface
 152  *
 153  * Computes the required size for a surface dma command for backup or
 154  * restoration of the surface represented by @srf.
 155  */
 156 static inline uint32_t vmw_surface_dma_size(const struct vmw_surface *srf)
 157 {
 158         return srf->num_sizes * sizeof(struct vmw_surface_dma);
 159 }
 160
 161
 162 /**
 163  * vmw_surface_define_size - Compute fifo size for a surface define command.
 164  *
 165  * @srf: Pointer to a struct vmw_surface
 166  *
 167  * Computes the required size for a surface define command for the definition
 168  * of the surface represented by @srf.
 169  */
 170 static inline uint32_t vmw_surface_define_size(const struct vmw_surface *srf)
 171 {
 172         return sizeof(struct vmw_surface_define) + srf->num_sizes *
 173                 sizeof(SVGA3dSize);
 174 }
 175
 176
 177 /**
 178  * vmw_surface_destroy_size - Compute fifo size for a surface destroy command.
 179  *
 180  * Computes the required size for a surface destroy command for the destruction
 181  * of a hw surface.
 182  */
 183 static inline uint32_t vmw_surface_destroy_size(void)
 184 {
 185         return sizeof(struct vmw_surface_destroy);
 186 }
 187
 188 /**
 189  * vmw_surface_destroy_encode - Encode a surface_destroy command.
 190  *
 191  * @id: The surface id
 192  * @cmd_space: Pointer to memory area in which the commands should be encoded.
 193  */
 194 static void vmw_surface_destroy_encode(uint32_t id,
 195                                        void *cmd_space)
 196 {
 197         struct vmw_surface_destroy *cmd = (struct vmw_surface_destroy *)
 198                 cmd_space;
 199
 200         cmd->header.id = SVGA_3D_CMD_SURFACE_DESTROY;
 201         cmd->header.size = sizeof(cmd->body);
 202         cmd->body.sid = id;
 203 }
 204
 205 /**
 206  * vmw_surface_define_encode - Encode a surface_define command.
 207  *
 208  * @srf: Pointer to a struct vmw_surface object.
 209  * @cmd_space: Pointer to memory area in which the commands should be encoded.
 210  */
 211 static void vmw_surface_define_encode(const struct vmw_surface *srf,
 212                                       void *cmd_space)
 213 {
 214         struct vmw_surface_define *cmd = (struct vmw_surface_define *)
 215                 cmd_space;
 216         struct drm_vmw_size *src_size;
 217         SVGA3dSize *cmd_size;
 218         uint32_t cmd_len;
 219         int i;
 220
 221         cmd_len = sizeof(cmd->body) + srf->num_sizes * sizeof(SVGA3dSize);
 222
 223         cmd->header.id = SVGA_3D_CMD_SURFACE_DEFINE;
 224         cmd->header.size = cmd_len;
 225         cmd->body.sid = srf->res.id;
 226         cmd->body.surfaceFlags = srf->flags;
 227         cmd->body.format = srf->format;
 228         for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i)
 229                 cmd->body.face[i].numMipLevels = srf->mip_levels[i];
 230
 231         cmd += 1;
 232         cmd_size = (SVGA3dSize *) cmd;
 233         src_size = srf->sizes;
 234
 235         for (i = 0; i < srf->num_sizes; ++i, cmd_size++, src_size++) {
 236                 cmd_size->width = src_size->width;
 237                 cmd_size->height = src_size->height;
 238                 cmd_size->depth = src_size->depth;
 239         }
 240 }
 241
 242 /**
 243  * vmw_surface_dma_encode - Encode a surface_dma command.
 244  *
 245  * @srf: Pointer to a struct vmw_surface object.
 246  * @cmd_space: Pointer to memory area in which the commands should be encoded.
 247  * @ptr: Pointer to an SVGAGuestPtr indicating where the surface contents
 248  * should be placed or read from.
 249  * @to_surface: Boolean whether to DMA to the surface or from the surface.
 250  */
 251 static void vmw_surface_dma_encode(struct vmw_surface *srf,
 252                                    void *cmd_space,
 253                                    const SVGAGuestPtr *ptr,
 254                                    bool to_surface)
 255 {
 256         uint32_t i;
 257         struct vmw_surface_dma *cmd = (struct vmw_surface_dma *)cmd_space;
 258         const struct svga3d_surface_desc *desc =
 259                 svga3dsurface_get_desc(srf->format);
 260
 261         for (i = 0; i < srf->num_sizes; ++i) {
 262                 SVGA3dCmdHeader *header = &cmd->header;
 263                 SVGA3dCmdSurfaceDMA *body = &cmd->body;
 264                 SVGA3dCopyBox *cb = &cmd->cb;
 265                 SVGA3dCmdSurfaceDMASuffix *suffix = &cmd->suffix;
 266                 const struct vmw_surface_offset *cur_offset = &srf->offsets[i];
 267                 const struct drm_vmw_size *cur_size = &srf->sizes[i];
 268
 269                 header->id = SVGA_3D_CMD_SURFACE_DMA;
 270                 header->size = sizeof(*body) + sizeof(*cb) + sizeof(*suffix);
 271
 272                 body->guest.ptr = *ptr;
 273                 body->guest.ptr.offset += cur_offset->bo_offset;
 274                 body->guest.pitch = svga3dsurface_calculate_pitch(desc,
 275                                                                   cur_size);
 276                 body->host.sid = srf->res.id;
 277                 body->host.face = cur_offset->face;
 278                 body->host.mipmap = cur_offset->mip;
 279                 body->transfer = ((to_surface) ?  SVGA3D_WRITE_HOST_VRAM :
 280                                   SVGA3D_READ_HOST_VRAM);
 281                 cb->x = 0;
 282                 cb->y = 0;
 283                 cb->z = 0;
 284                 cb->srcx = 0;
 285                 cb->srcy = 0;
 286                 cb->srcz = 0;
 287                 cb->w = cur_size->width;
 288                 cb->h = cur_size->height;
 289                 cb->d = cur_size->depth;
 290
 291                 suffix->suffixSize = sizeof(*suffix);
 292                 suffix->maximumOffset =
 293                         svga3dsurface_get_image_buffer_size(desc, cur_size,
 294                                                             body->guest.pitch);
 295                 suffix->flags.discard = 0;
 296                 suffix->flags.unsynchronized = 0;
 297                 suffix->flags.reserved = 0;
 298                 ++cmd;
 299         }
 300 };
 301
 302
 303 /**
 304  * vmw_hw_surface_destroy - destroy a Device surface
 305  *
 306  * @res:        Pointer to a struct vmw_resource embedded in a struct
 307  *              vmw_surface.
 308  *
 309  * Destroys a the device surface associated with a struct vmw_surface if
 310  * any, and adjusts accounting and resource count accordingly.
 311  */
 312 static void vmw_hw_surface_destroy(struct vmw_resource *res)
 313 {
 314
 315         struct vmw_private *dev_priv = res->dev_priv;
 316         struct vmw_surface *srf;
 317         void *cmd;
 318
 319         if (res->func->destroy == vmw_gb_surface_destroy) {
 320                 (void) vmw_gb_surface_destroy(res);
 321                 return;
 322         }
 323
 324         if (res->id != -1) {
 325
 326                 cmd = vmw_fifo_reserve(dev_priv, vmw_surface_destroy_size());
 327                 if (unlikely(cmd == NULL)) {
 328                         DRM_ERROR("Failed reserving FIFO space for surface "
 329                                   "destruction.\n");
 330                         return;
 331                 }
 332
 333                 vmw_surface_destroy_encode(res->id, cmd);
 334                 vmw_fifo_commit(dev_priv, vmw_surface_destroy_size());
 335
 336                 /*
 337                  * used_memory_size_atomic, or separate lock
 338                  * to avoid taking dev_priv::cmdbuf_mutex in
 339                  * the destroy path.
 340                  */
 341
 342                 mutex_lock(&dev_priv->cmdbuf_mutex);
 343                 srf = vmw_res_to_srf(res);
 344                 dev_priv->used_memory_size -= res->backup_size;
 345                 mutex_unlock(&dev_priv->cmdbuf_mutex);
 346         }
 347         vmw_fifo_resource_dec(dev_priv);
 348 }
 349
 350 /**
 351  * vmw_legacy_srf_create - Create a device surface as part of the
 352  * resource validation process.
 353  *
 354  * @res: Pointer to a struct vmw_surface.
 355  *
 356  * If the surface doesn't have a hw id.
 357  *
 358  * Returns -EBUSY if there wasn't sufficient device resources to
 359  * complete the validation. Retry after freeing up resources.
 360  *
 361  * May return other errors if the kernel is out of guest resources.
 362  */
 363 static int vmw_legacy_srf_create(struct vmw_resource *res)
 364 {
 365         struct vmw_private *dev_priv = res->dev_priv;
 366         struct vmw_surface *srf;
 367         uint32_t submit_size;
 368         uint8_t *cmd;
 369         int ret;
 370
 371         if (likely(res->id != -1))
 372                 return 0;
 373
 374         srf = vmw_res_to_srf(res);
 375         if (unlikely(dev_priv->used_memory_size + res->backup_size >=
 376                      dev_priv->memory_size))
 377                 return -EBUSY;
 378
 379         /*
 380          * Alloc id for the resource.
 381          */
 382
 383         ret = vmw_resource_alloc_id(res);
 384         if (unlikely(ret != 0)) {
 385                 DRM_ERROR("Failed to allocate a surface id.\n");
 386                 goto out_no_id;
 387         }
 388
 389         if (unlikely(res->id >= SVGA3D_MAX_SURFACE_IDS)) {
 390                 ret = -EBUSY;
 391                 goto out_no_fifo;
 392         }
 393
 394         /*
 395          * Encode surface define- commands.
 396          */
 397
 398         submit_size = vmw_surface_define_size(srf);
 399         cmd = vmw_fifo_reserve(dev_priv, submit_size);
 400         if (unlikely(cmd == NULL)) {
 401                 DRM_ERROR("Failed reserving FIFO space for surface "
 402                           "creation.\n");
 403                 ret = -ENOMEM;
 404                 goto out_no_fifo;
 405         }
 406
 407         vmw_surface_define_encode(srf, cmd);
 408         vmw_fifo_commit(dev_priv, submit_size);
 409         /*
 410          * Surface memory usage accounting.
 411          */
 412
 413         dev_priv->used_memory_size += res->backup_size;
 414         return 0;
 415
 416 out_no_fifo:
 417         vmw_resource_release_id(res);
 418 out_no_id:
 419         return ret;
 420 }
 421
 422 /**
 423  * vmw_legacy_srf_dma - Copy backup data to or from a legacy surface.
 424  *
 425  * @res:            Pointer to a struct vmw_res embedded in a struct
 426  *                  vmw_surface.
 427  * @val_buf:        Pointer to a struct ttm_validate_buffer containing
 428  *                  information about the backup buffer.
 429  * @bind:           Boolean wether to DMA to the surface.
 430  *
 431  * Transfer backup data to or from a legacy surface as part of the
 432  * validation process.
 433  * May return other errors if the kernel is out of guest resources.
 434  * The backup buffer will be fenced or idle upon successful completion,
 435  * and if the surface needs persistent backup storage, the backup buffer
 436  * will also be returned reserved iff @bind is true.
 437  */
 438 static int vmw_legacy_srf_dma(struct vmw_resource *res,
 439                               struct ttm_validate_buffer *val_buf,
 440                               bool bind)
 441 {
 442         SVGAGuestPtr ptr;
 443         struct vmw_fence_obj *fence;
 444         uint32_t submit_size;
 445         struct vmw_surface *srf = vmw_res_to_srf(res);
 446         uint8_t *cmd;
 447         struct vmw_private *dev_priv = res->dev_priv;
 448
 449         BUG_ON(val_buf->bo == NULL);
 450
 451         submit_size = vmw_surface_dma_size(srf);
 452         cmd = vmw_fifo_reserve(dev_priv, submit_size);
 453         if (unlikely(cmd == NULL)) {
 454                 DRM_ERROR("Failed reserving FIFO space for surface "
 455                           "DMA.\n");
 456                 return -ENOMEM;
 457         }
 458         vmw_bo_get_guest_ptr(val_buf->bo, &ptr);
 459         vmw_surface_dma_encode(srf, cmd, &ptr, bind);
 460
 461         vmw_fifo_commit(dev_priv, submit_size);
 462
 463         /*
 464          * Create a fence object and fence the backup buffer.
 465          */
 466
 467         (void) vmw_execbuf_fence_commands(NULL, dev_priv,
 468                                           &fence, NULL);
 469
 470         vmw_fence_single_bo(val_buf->bo, fence);
 471
 472         if (likely(fence != NULL))
 473                 vmw_fence_obj_unreference(&fence);
 474
 475         return 0;
 476 }
 477
 478 /**
 479  * vmw_legacy_srf_bind - Perform a legacy surface bind as part of the
 480  *                       surface validation process.
 481  *
 482  * @res:            Pointer to a struct vmw_res embedded in a struct
 483  *                  vmw_surface.
 484  * @val_buf:        Pointer to a struct ttm_validate_buffer containing
 485  *                  information about the backup buffer.
 486  *
 487  * This function will copy backup data to the surface if the
 488  * backup buffer is dirty.
 489  */
 490 static int vmw_legacy_srf_bind(struct vmw_resource *res,
 491                                struct ttm_validate_buffer *val_buf)
 492 {
 493         if (!res->backup_dirty)
 494                 return 0;
 495
 496         return vmw_legacy_srf_dma(res, val_buf, true);
 497 }
 498
 499
 500 /**
 501  * vmw_legacy_srf_unbind - Perform a legacy surface unbind as part of the
 502  *                         surface eviction process.
 503  *
 504  * @res:            Pointer to a struct vmw_res embedded in a struct
 505  *                  vmw_surface.
 506  * @val_buf:        Pointer to a struct ttm_validate_buffer containing
 507  *                  information about the backup buffer.
 508  *
 509  * This function will copy backup data from the surface.
 510  */
 511 static int vmw_legacy_srf_unbind(struct vmw_resource *res,
 512                                  bool readback,
 513                                  struct ttm_validate_buffer *val_buf)
 514 {
 515         if (unlikely(readback))
 516                 return vmw_legacy_srf_dma(res, val_buf, false);
 517         return 0;
 518 }
 519
 520 /**
 521  * vmw_legacy_srf_destroy - Destroy a device surface as part of a
 522  *                          resource eviction process.
 523  *
 524  * @res:            Pointer to a struct vmw_res embedded in a struct
 525  *                  vmw_surface.
 526  */
 527 static int vmw_legacy_srf_destroy(struct vmw_resource *res)
 528 {
 529         struct vmw_private *dev_priv = res->dev_priv;
 530         uint32_t submit_size;
 531         uint8_t *cmd;
 532
 533         BUG_ON(res->id == -1);
 534
 535         /*
 536          * Encode the dma- and surface destroy commands.
 537          */
 538
 539         submit_size = vmw_surface_destroy_size();
 540         cmd = vmw_fifo_reserve(dev_priv, submit_size);
 541         if (unlikely(cmd == NULL)) {
 542                 DRM_ERROR("Failed reserving FIFO space for surface "
 543                           "eviction.\n");
 544                 return -ENOMEM;
 545         }
 546
 547         vmw_surface_destroy_encode(res->id, cmd);
 548         vmw_fifo_commit(dev_priv, submit_size);
 549
 550         /*
 551          * Surface memory usage accounting.
 552          */
 553
 554         dev_priv->used_memory_size -= res->backup_size;
 555
 556         /*
 557          * Release the surface ID.
 558          */
 559
 560         vmw_resource_release_id(res);
 561
 562         return 0;
 563 }
 564
 565
 566 /**
 567  * vmw_surface_init - initialize a struct vmw_surface
 568  *
 569  * @dev_priv:       Pointer to a device private struct.
 570  * @srf:            Pointer to the struct vmw_surface to initialize.
 571  * @res_free:       Pointer to a resource destructor used to free
 572  *                  the object.
 573  */
 574 static int vmw_surface_init(struct vmw_private *dev_priv,
 575                             struct vmw_surface *srf,
 576                             void (*res_free) (struct vmw_resource *res))
 577 {
 578         int ret;
 579         struct vmw_resource *res = &srf->res;
 580
 581         BUG_ON(res_free == NULL);
 582         if (!dev_priv->has_mob)
 583                 vmw_fifo_resource_inc(dev_priv);
 584         ret = vmw_resource_init(dev_priv, res, true, res_free,
 585                                 (dev_priv->has_mob) ? &vmw_gb_surface_func :
 586                                 &vmw_legacy_surface_func);
 587
 588         if (unlikely(ret != 0)) {
 589                 if (!dev_priv->has_mob)
 590                         vmw_fifo_resource_dec(dev_priv);
 591                 res_free(res);
 592                 return ret;
 593         }
 594
 595         /*
 596          * The surface won't be visible to hardware until a
 597          * surface validate.
 598          */
 599
 600         INIT_LIST_HEAD(&srf->view_list);
 601         vmw_resource_activate(res, vmw_hw_surface_destroy);
 602         return ret;
 603 }
 604
 605 /**
 606  * vmw_user_surface_base_to_res - TTM base object to resource converter for
 607  *                                user visible surfaces
 608  *
 609  * @base:           Pointer to a TTM base object
 610  *
 611  * Returns the struct vmw_resource embedded in a struct vmw_surface
 612  * for the user-visible object identified by the TTM base object @base.
 613  */
 614 static struct vmw_resource *
 615 vmw_user_surface_base_to_res(struct ttm_base_object *base)
 616 {
 617         return &(container_of(base, struct vmw_user_surface,
 618                               prime.base)->srf.res);
 619 }
 620
 621 /**
 622  * vmw_user_surface_free - User visible surface resource destructor
 623  *
 624  * @res:            A struct vmw_resource embedded in a struct vmw_surface.
 625  */
 626 static void vmw_user_surface_free(struct vmw_resource *res)
 627 {
 628         struct vmw_surface *srf = vmw_res_to_srf(res);
 629         struct vmw_user_surface *user_srf =
 630             container_of(srf, struct vmw_user_surface, srf);
 631         struct vmw_private *dev_priv = srf->res.dev_priv;
 632         uint32_t size = user_srf->size;
 633
 634         if (user_srf->master)
 635                 drm_master_put(&user_srf->master);
 636         kfree(srf->offsets);
 637         kfree(srf->sizes);
 638         kfree(srf->snooper.image);
 639         ttm_prime_object_kfree(user_srf, prime);
 640         ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
 641 }
 642
 643 /**
 644  * vmw_user_surface_free - User visible surface TTM base object destructor
 645  *
 646  * @p_base:         Pointer to a pointer to a TTM base object
 647  *                  embedded in a struct vmw_user_surface.
 648  *
 649  * Drops the base object's reference on its resource, and the
 650  * pointer pointed to by *p_base is set to NULL.
 651  */
 652 static void vmw_user_surface_base_release(struct ttm_base_object **p_base)
 653 {
 654         struct ttm_base_object *base = *p_base;
 655         struct vmw_user_surface *user_srf =
 656             container_of(base, struct vmw_user_surface, prime.base);
 657         struct vmw_resource *res = &user_srf->srf.res;
 658
 659         *p_base = NULL;
 660         ttm_base_object_unref(&user_srf->backup_base);
 661         vmw_resource_unreference(&res);
 662 }
 663
 664 /**
 665  * vmw_user_surface_destroy_ioctl - Ioctl function implementing
 666  *                                  the user surface destroy functionality.
 667  *
 668  * @dev:            Pointer to a struct drm_device.
 669  * @data:           Pointer to data copied from / to user-space.
 670  * @file_priv:      Pointer to a drm file private structure.
 671  */
 672 int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
 673                               struct drm_file *file_priv)
 674 {
 675         struct drm_vmw_surface_arg *arg = (struct drm_vmw_surface_arg *)data;
 676         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 677
 678         return ttm_ref_object_base_unref(tfile, arg->sid, TTM_REF_USAGE);
 679 }
 680
 681 /**
 682  * vmw_user_surface_define_ioctl - Ioctl function implementing
 683  *                                  the user surface define functionality.
 684  *
 685  * @dev:            Pointer to a struct drm_device.
 686  * @data:           Pointer to data copied from / to user-space.
 687  * @file_priv:      Pointer to a drm file private structure.
 688  */
 689 int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
 690                              struct drm_file *file_priv)
 691 {
 692         struct vmw_private *dev_priv = vmw_priv(dev);
 693         struct vmw_user_surface *user_srf;
 694         struct vmw_surface *srf;
 695         struct vmw_resource *res;
 696         struct vmw_resource *tmp;
 697         union drm_vmw_surface_create_arg *arg =
 698             (union drm_vmw_surface_create_arg *)data;
 699         struct drm_vmw_surface_create_req *req = &arg->req;
 700         struct drm_vmw_surface_arg *rep = &arg->rep;
 701         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 702         struct drm_vmw_size __user *user_sizes;
 703         int ret;
 704         int i, j;
 705         uint32_t cur_bo_offset;
 706         struct drm_vmw_size *cur_size;
 707         struct vmw_surface_offset *cur_offset;
 708         uint32_t num_sizes;
 709         uint32_t size;
 710         const struct svga3d_surface_desc *desc;
 711
 712         if (unlikely(vmw_user_surface_size == 0))
 713                 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
 714                         128;
 715
 716         num_sizes = 0;
 717         for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i)
 718                 num_sizes += req->mip_levels[i];
 719
 720         if (num_sizes > DRM_VMW_MAX_SURFACE_FACES *
 721             DRM_VMW_MAX_MIP_LEVELS)
 722                 return -EINVAL;
 723
 724         size = vmw_user_surface_size + 128 +
 725                 ttm_round_pot(num_sizes * sizeof(struct drm_vmw_size)) +
 726                 ttm_round_pot(num_sizes * sizeof(struct vmw_surface_offset));
 727
 728
 729         desc = svga3dsurface_get_desc(req->format);
 730         if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
 731                 DRM_ERROR("Invalid surface format for surface creation.\n");
 732                 DRM_ERROR("Format requested is: %d\n", req->format);
 733                 return -EINVAL;
 734         }
 735
 736         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
 737         if (unlikely(ret != 0))
 738                 return ret;
 739
 740         ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
 741                                    size, false, true);
 742         if (unlikely(ret != 0)) {
 743                 if (ret != -ERESTARTSYS)
 744                         DRM_ERROR("Out of graphics memory for surface"
 745                                   " creation.\n");
 746                 goto out_unlock;
 747         }
 748
 749         user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
 750         if (unlikely(user_srf == NULL)) {
 751                 ret = -ENOMEM;
 752                 goto out_no_user_srf;
 753         }
 754
 755         srf = &user_srf->srf;
 756         res = &srf->res;
 757
 758         srf->flags = req->flags;
 759         srf->format = req->format;
 760         srf->scanout = req->scanout;
 761
 762         memcpy(srf->mip_levels, req->mip_levels, sizeof(srf->mip_levels));
 763         srf->num_sizes = num_sizes;
 764         user_srf->size = size;
 765
 766         srf->sizes = kmalloc(srf->num_sizes * sizeof(*srf->sizes), GFP_KERNEL);
 767         if (unlikely(srf->sizes == NULL)) {
 768                 ret = -ENOMEM;
 769                 goto out_no_sizes;
 770         }
 771         srf->offsets = kmalloc(srf->num_sizes * sizeof(*srf->offsets),
 772                                GFP_KERNEL);
 773         if (unlikely(srf->sizes == NULL)) {
 774                 ret = -ENOMEM;
 775                 goto out_no_offsets;
 776         }
 777
 778         user_sizes = (struct drm_vmw_size __user *)(unsigned long)
 779             req->size_addr;
 780
 781         ret = copy_from_user(srf->sizes, user_sizes,
 782                              srf->num_sizes * sizeof(*srf->sizes));
 783         if (unlikely(ret != 0)) {
 784                 ret = -EFAULT;
 785                 goto out_no_copy;
 786         }
 787
 788         srf->base_size = *srf->sizes;
 789         srf->autogen_filter = SVGA3D_TEX_FILTER_NONE;
 790         srf->multisample_count = 0;
 791
 792         cur_bo_offset = 0;
 793         cur_offset = srf->offsets;
 794         cur_size = srf->sizes;
 795
 796         for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i) {
 797                 for (j = 0; j < srf->mip_levels[i]; ++j) {
 798                         uint32_t stride = svga3dsurface_calculate_pitch
 799                                 (desc, cur_size);
 800
 801                         cur_offset->face = i;
 802                         cur_offset->mip = j;
 803                         cur_offset->bo_offset = cur_bo_offset;
 804                         cur_bo_offset += svga3dsurface_get_image_buffer_size
 805                                 (desc, cur_size, stride);
 806                         ++cur_offset;
 807                         ++cur_size;
 808                 }
 809         }
 810         res->backup_size = cur_bo_offset;
 811         if (srf->scanout &&
 812             srf->num_sizes == 1 &&
 813             srf->sizes[0].width == 64 &&
 814             srf->sizes[0].height == 64 &&
 815             srf->format == SVGA3D_A8R8G8B8) {
 816
 817                 srf->snooper.image = kmalloc(64 * 64 * 4, GFP_KERNEL);
 818                 /* clear the image */
 819                 if (srf->snooper.image) {
 820                         memset(srf->snooper.image, 0x00, 64 * 64 * 4);
 821                 } else {
 822                         DRM_ERROR("Failed to allocate cursor_image\n");
 823                         ret = -ENOMEM;
 824                         goto out_no_copy;
 825                 }
 826         } else {
 827                 srf->snooper.image = NULL;
 828         }
 829         srf->snooper.crtc = NULL;
 830
 831         user_srf->prime.base.shareable = false;
 832         user_srf->prime.base.tfile = NULL;
 833         if (drm_is_primary_client(file_priv))
 834                 user_srf->master = drm_master_get(file_priv->master);
 835
 836         /**
 837          * From this point, the generic resource management functions
 838          * destroy the object on failure.
 839          */
 840
 841         ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
 842         if (unlikely(ret != 0))
 843                 goto out_unlock;
 844
 845         /*
 846          * A gb-aware client referencing a shared surface will
 847          * expect a backup buffer to be present.
 848          */
 849         if (dev_priv->has_mob && req->shareable) {
 850                 uint32_t backup_handle;
 851
 852                 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
 853                                             res->backup_size,
 854                                             true,
 855                                             &backup_handle,
 856                                             &res->backup,
 857                                             &user_srf->backup_base);
 858                 if (unlikely(ret != 0)) {
 859                         vmw_resource_unreference(&res);
 860                         goto out_unlock;
 861                 }
 862         }
 863
 864         tmp = vmw_resource_reference(&srf->res);
 865         ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
 866                                     req->shareable, VMW_RES_SURFACE,
 867                                     &vmw_user_surface_base_release, NULL);
 868
 869         if (unlikely(ret != 0)) {
 870                 vmw_resource_unreference(&tmp);
 871                 vmw_resource_unreference(&res);
 872                 goto out_unlock;
 873         }
 874
 875         rep->sid = user_srf->prime.base.hash.key;
 876         vmw_resource_unreference(&res);
 877
 878         ttm_read_unlock(&dev_priv->reservation_sem);
 879         return 0;
 880 out_no_copy:
 881         kfree(srf->offsets);
 882 out_no_offsets:
 883         kfree(srf->sizes);
 884 out_no_sizes:
 885         ttm_prime_object_kfree(user_srf, prime);
 886 out_no_user_srf:
 887         ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
 888 out_unlock:
 889         ttm_read_unlock(&dev_priv->reservation_sem);
 890         return ret;
 891 }
 892
 893
 894 static int
 895 vmw_surface_handle_reference(struct vmw_private *dev_priv,
 896                              struct drm_file *file_priv,
 897                              uint32_t u_handle,
 898                              enum drm_vmw_handle_type handle_type,
 899                              struct ttm_base_object **base_p)
 900 {
 901         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 902         struct vmw_user_surface *user_srf;
 903         uint32_t handle;
 904         struct ttm_base_object *base;
 905         int ret;
 906
 907         if (handle_type == DRM_VMW_HANDLE_PRIME) {
 908                 ret = ttm_prime_fd_to_handle(tfile, u_handle, &handle);
 909                 if (unlikely(ret != 0))
 910                         return ret;
 911         } else {
 912                 if (unlikely(drm_is_render_client(file_priv))) {
 913                         DRM_ERROR("Render client refused legacy "
 914                                   "surface reference.\n");
 915                         return -EACCES;
 916                 }
 917                 if (ACCESS_ONCE(vmw_fpriv(file_priv)->locked_master)) {
 918                         DRM_ERROR("Locked master refused legacy "
 919                                   "surface reference.\n");
 920                         return -EACCES;
 921                 }
 922
 923                 handle = u_handle;
 924         }
 925
 926         ret = -EINVAL;
 927         base = ttm_base_object_lookup_for_ref(dev_priv->tdev, handle);
 928         if (unlikely(base == NULL)) {
 929                 DRM_ERROR("Could not find surface to reference.\n");
 930                 goto out_no_lookup;
 931         }
 932
 933         if (unlikely(ttm_base_object_type(base) != VMW_RES_SURFACE)) {
 934                 DRM_ERROR("Referenced object is not a surface.\n");
 935                 goto out_bad_resource;
 936         }
 937
 938         if (handle_type != DRM_VMW_HANDLE_PRIME) {
 939                 user_srf = container_of(base, struct vmw_user_surface,
 940                                         prime.base);
 941
 942                 /*
 943                  * Make sure the surface creator has the same
 944                  * authenticating master.
 945                  */
 946                 if (drm_is_primary_client(file_priv) &&
 947                     user_srf->master != file_priv->master) {
 948                         DRM_ERROR("Trying to reference surface outside of"
 949                                   " master domain.\n");
 950                         ret = -EACCES;
 951                         goto out_bad_resource;
 952                 }
 953
 954                 ret = ttm_ref_object_add(tfile, base, TTM_REF_USAGE, NULL);
 955                 if (unlikely(ret != 0)) {
 956                         DRM_ERROR("Could not add a reference to a surface.\n");
 957                         goto out_bad_resource;
 958                 }
 959         }
 960
 961         *base_p = base;
 962         return 0;
 963
 964 out_bad_resource:
 965         ttm_base_object_unref(&base);
 966 out_no_lookup:
 967         if (handle_type == DRM_VMW_HANDLE_PRIME)
 968                 (void) ttm_ref_object_base_unref(tfile, handle, TTM_REF_USAGE);
 969
 970         return ret;
 971 }
 972
 973 /**
 974  * vmw_user_surface_define_ioctl - Ioctl function implementing
 975  *                                  the user surface reference functionality.
 976  *
 977  * @dev:            Pointer to a struct drm_device.
 978  * @data:           Pointer to data copied from / to user-space.
 979  * @file_priv:      Pointer to a drm file private structure.
 980  */
 981 int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
 982                                 struct drm_file *file_priv)
 983 {
 984         struct vmw_private *dev_priv = vmw_priv(dev);
 985         union drm_vmw_surface_reference_arg *arg =
 986             (union drm_vmw_surface_reference_arg *)data;
 987         struct drm_vmw_surface_arg *req = &arg->req;
 988         struct drm_vmw_surface_create_req *rep = &arg->rep;
 989         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 990         struct vmw_surface *srf;
 991         struct vmw_user_surface *user_srf;
 992         struct drm_vmw_size __user *user_sizes;
 993         struct ttm_base_object *base;
 994         int ret;
 995
 996         ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
 997                                            req->handle_type, &base);
 998         if (unlikely(ret != 0))
 999                 return ret;
1000
1001         user_srf = container_of(base, struct vmw_user_surface, prime.base);
1002         srf = &user_srf->srf;
1003
1004         rep->flags = srf->flags;
1005         rep->format = srf->format;
1006         memcpy(rep->mip_levels, srf->mip_levels, sizeof(srf->mip_levels));
1007         user_sizes = (struct drm_vmw_size __user *)(unsigned long)
1008             rep->size_addr;
1009
1010         if (user_sizes)
1011                 ret = copy_to_user(user_sizes, &srf->base_size,
1012                                    sizeof(srf->base_size));
1013         if (unlikely(ret != 0)) {
1014                 DRM_ERROR("copy_to_user failed %p %u\n",
1015                           user_sizes, srf->num_sizes);
1016                 ttm_ref_object_base_unref(tfile, base->hash.key, TTM_REF_USAGE);
1017                 ret = -EFAULT;
1018         }
1019
1020         ttm_base_object_unref(&base);
1021
1022         return ret;
1023 }
1024
1025 /**
1026  * vmw_surface_define_encode - Encode a surface_define command.
1027  *
1028  * @srf: Pointer to a struct vmw_surface object.
1029  * @cmd_space: Pointer to memory area in which the commands should be encoded.
1030  */
1031 static int vmw_gb_surface_create(struct vmw_resource *res)
1032 {
1033         struct vmw_private *dev_priv = res->dev_priv;
1034         struct vmw_surface *srf = vmw_res_to_srf(res);
1035         uint32_t cmd_len, cmd_id, submit_len;
1036         int ret;
1037         struct {
1038                 SVGA3dCmdHeader header;
1039                 SVGA3dCmdDefineGBSurface body;
1040         } *cmd;
1041         struct {
1042                 SVGA3dCmdHeader header;
1043                 SVGA3dCmdDefineGBSurface_v2 body;
1044         } *cmd2;
1045
1046         if (likely(res->id != -1))
1047                 return 0;
1048
1049         vmw_fifo_resource_inc(dev_priv);
1050         ret = vmw_resource_alloc_id(res);
1051         if (unlikely(ret != 0)) {
1052                 DRM_ERROR("Failed to allocate a surface id.\n");
1053                 goto out_no_id;
1054         }
1055
1056         if (unlikely(res->id >= VMWGFX_NUM_GB_SURFACE)) {
1057                 ret = -EBUSY;
1058                 goto out_no_fifo;
1059         }
1060
1061         if (srf->array_size > 0) {
1062                 /* has_dx checked on creation time. */
1063                 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE_V2;
1064                 cmd_len = sizeof(cmd2->body);
1065                 submit_len = sizeof(*cmd2);
1066         } else {
1067                 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE;
1068                 cmd_len = sizeof(cmd->body);
1069                 submit_len = sizeof(*cmd);
1070         }
1071
1072         cmd = vmw_fifo_reserve(dev_priv, submit_len);
1073         cmd2 = (typeof(cmd2))cmd;
1074         if (unlikely(cmd == NULL)) {
1075                 DRM_ERROR("Failed reserving FIFO space for surface "
1076                           "creation.\n");
1077                 ret = -ENOMEM;
1078                 goto out_no_fifo;
1079         }
1080
1081         if (srf->array_size > 0) {
1082                 cmd2->header.id = cmd_id;
1083                 cmd2->header.size = cmd_len;
1084                 cmd2->body.sid = srf->res.id;
1085                 cmd2->body.surfaceFlags = srf->flags;
1086                 cmd2->body.format = cpu_to_le32(srf->format);
1087                 cmd2->body.numMipLevels = srf->mip_levels[0];
1088                 cmd2->body.multisampleCount = srf->multisample_count;
1089                 cmd2->body.autogenFilter = srf->autogen_filter;
1090                 cmd2->body.size.width = srf->base_size.width;
1091                 cmd2->body.size.height = srf->base_size.height;
1092                 cmd2->body.size.depth = srf->base_size.depth;
1093                 cmd2->body.arraySize = srf->array_size;
1094         } else {
1095                 cmd->header.id = cmd_id;
1096                 cmd->header.size = cmd_len;
1097                 cmd->body.sid = srf->res.id;
1098                 cmd->body.surfaceFlags = srf->flags;
1099                 cmd->body.format = cpu_to_le32(srf->format);
1100                 cmd->body.numMipLevels = srf->mip_levels[0];
1101                 cmd->body.multisampleCount = srf->multisample_count;
1102                 cmd->body.autogenFilter = srf->autogen_filter;
1103                 cmd->body.size.width = srf->base_size.width;
1104                 cmd->body.size.height = srf->base_size.height;
1105                 cmd->body.size.depth = srf->base_size.depth;
1106         }
1107
1108         vmw_fifo_commit(dev_priv, submit_len);
1109
1110         return 0;
1111
1112 out_no_fifo:
1113         vmw_resource_release_id(res);
1114 out_no_id:
1115         vmw_fifo_resource_dec(dev_priv);
1116         return ret;
1117 }
1118
1119
1120 static int vmw_gb_surface_bind(struct vmw_resource *res,
1121                                struct ttm_validate_buffer *val_buf)
1122 {
1123         struct vmw_private *dev_priv = res->dev_priv;
1124         struct {
1125                 SVGA3dCmdHeader header;
1126                 SVGA3dCmdBindGBSurface body;
1127         } *cmd1;
1128         struct {
1129                 SVGA3dCmdHeader header;
1130                 SVGA3dCmdUpdateGBSurface body;
1131         } *cmd2;
1132         uint32_t submit_size;
1133         struct ttm_buffer_object *bo = val_buf->bo;
1134
1135         BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1136
1137         submit_size = sizeof(*cmd1) + (res->backup_dirty ? sizeof(*cmd2) : 0);
1138
1139         cmd1 = vmw_fifo_reserve(dev_priv, submit_size);
1140         if (unlikely(cmd1 == NULL)) {
1141                 DRM_ERROR("Failed reserving FIFO space for surface "
1142                           "binding.\n");
1143                 return -ENOMEM;
1144         }
1145
1146         cmd1->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1147         cmd1->header.size = sizeof(cmd1->body);
1148         cmd1->body.sid = res->id;
1149         cmd1->body.mobid = bo->mem.start;
1150         if (res->backup_dirty) {
1151                 cmd2 = (void *) &cmd1[1];
1152                 cmd2->header.id = SVGA_3D_CMD_UPDATE_GB_SURFACE;
1153                 cmd2->header.size = sizeof(cmd2->body);
1154                 cmd2->body.sid = res->id;
1155                 res->backup_dirty = false;
1156         }
1157         vmw_fifo_commit(dev_priv, submit_size);
1158
1159         return 0;
1160 }
1161
1162 static int vmw_gb_surface_unbind(struct vmw_resource *res,
1163                                  bool readback,
1164                                  struct ttm_validate_buffer *val_buf)
1165 {
1166         struct vmw_private *dev_priv = res->dev_priv;
1167         struct ttm_buffer_object *bo = val_buf->bo;
1168         struct vmw_fence_obj *fence;
1169
1170         struct {
1171                 SVGA3dCmdHeader header;
1172                 SVGA3dCmdReadbackGBSurface body;
1173         } *cmd1;
1174         struct {
1175                 SVGA3dCmdHeader header;
1176                 SVGA3dCmdInvalidateGBSurface body;
1177         } *cmd2;
1178         struct {
1179                 SVGA3dCmdHeader header;
1180                 SVGA3dCmdBindGBSurface body;
1181         } *cmd3;
1182         uint32_t submit_size;
1183         uint8_t *cmd;
1184
1185
1186         BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1187
1188         submit_size = sizeof(*cmd3) + (readback ? sizeof(*cmd1) : sizeof(*cmd2));
1189         cmd = vmw_fifo_reserve(dev_priv, submit_size);
1190         if (unlikely(cmd == NULL)) {
1191                 DRM_ERROR("Failed reserving FIFO space for surface "
1192                           "unbinding.\n");
1193                 return -ENOMEM;
1194         }
1195
1196         if (readback) {
1197                 cmd1 = (void *) cmd;
1198                 cmd1->header.id = SVGA_3D_CMD_READBACK_GB_SURFACE;
1199                 cmd1->header.size = sizeof(cmd1->body);
1200                 cmd1->body.sid = res->id;
1201                 cmd3 = (void *) &cmd1[1];
1202         } else {
1203                 cmd2 = (void *) cmd;
1204                 cmd2->header.id = SVGA_3D_CMD_INVALIDATE_GB_SURFACE;
1205                 cmd2->header.size = sizeof(cmd2->body);
1206                 cmd2->body.sid = res->id;
1207                 cmd3 = (void *) &cmd2[1];
1208         }
1209
1210         cmd3->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1211         cmd3->header.size = sizeof(cmd3->body);
1212         cmd3->body.sid = res->id;
1213         cmd3->body.mobid = SVGA3D_INVALID_ID;
1214
1215         vmw_fifo_commit(dev_priv, submit_size);
1216
1217         /*
1218          * Create a fence object and fence the backup buffer.
1219          */
1220
1221         (void) vmw_execbuf_fence_commands(NULL, dev_priv,
1222                                           &fence, NULL);
1223
1224         vmw_fence_single_bo(val_buf->bo, fence);
1225
1226         if (likely(fence != NULL))
1227                 vmw_fence_obj_unreference(&fence);
1228
1229         return 0;
1230 }
1231
1232 static int vmw_gb_surface_destroy(struct vmw_resource *res)
1233 {
1234         struct vmw_private *dev_priv = res->dev_priv;
1235         struct vmw_surface *srf = vmw_res_to_srf(res);
1236         struct {
1237                 SVGA3dCmdHeader header;
1238                 SVGA3dCmdDestroyGBSurface body;
1239         } *cmd;
1240
1241         if (likely(res->id == -1))
1242                 return 0;
1243
1244         mutex_lock(&dev_priv->binding_mutex);
1245         vmw_view_surface_list_destroy(dev_priv, &srf->view_list);
1246         vmw_binding_res_list_scrub(&res->binding_head);
1247
1248         cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
1249         if (unlikely(cmd == NULL)) {
1250                 DRM_ERROR("Failed reserving FIFO space for surface "
1251                           "destruction.\n");
1252                 mutex_unlock(&dev_priv->binding_mutex);
1253                 return -ENOMEM;
1254         }
1255
1256         cmd->header.id = SVGA_3D_CMD_DESTROY_GB_SURFACE;
1257         cmd->header.size = sizeof(cmd->body);
1258         cmd->body.sid = res->id;
1259         vmw_fifo_commit(dev_priv, sizeof(*cmd));
1260         mutex_unlock(&dev_priv->binding_mutex);
1261         vmw_resource_release_id(res);
1262         vmw_fifo_resource_dec(dev_priv);
1263
1264         return 0;
1265 }
1266
1267
1268 /**
1269  * vmw_gb_surface_define_ioctl - Ioctl function implementing
1270  *                               the user surface define functionality.
1271  *
1272  * @dev:            Pointer to a struct drm_device.
1273  * @data:           Pointer to data copied from / to user-space.
1274  * @file_priv:      Pointer to a drm file private structure.
1275  */
1276 int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1277                                 struct drm_file *file_priv)
1278 {
1279         struct vmw_private *dev_priv = vmw_priv(dev);
1280         struct vmw_user_surface *user_srf;
1281         struct vmw_surface *srf;
1282         struct vmw_resource *res;
1283         struct vmw_resource *tmp;
1284         union drm_vmw_gb_surface_create_arg *arg =
1285             (union drm_vmw_gb_surface_create_arg *)data;
1286         struct drm_vmw_gb_surface_create_req *req = &arg->req;
1287         struct drm_vmw_gb_surface_create_rep *rep = &arg->rep;
1288         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1289         int ret;
1290         uint32_t size;
1291         uint32_t backup_handle;
1292
1293
1294         if (unlikely(vmw_user_surface_size == 0))
1295                 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
1296                         128;
1297
1298         size = vmw_user_surface_size + 128;
1299
1300         /* Define a surface based on the parameters. */
1301         ret = vmw_surface_gb_priv_define(dev,
1302                         size,
1303                         req->svga3d_flags,
1304                         req->format,
1305                         req->drm_surface_flags & drm_vmw_surface_flag_scanout,
1306                         req->mip_levels,
1307                         req->multisample_count,
1308                         req->array_size,
1309                         req->base_size,
1310                         &srf);
1311         if (unlikely(ret != 0))
1312                 return ret;
1313
1314         user_srf = container_of(srf, struct vmw_user_surface, srf);
1315         if (drm_is_primary_client(file_priv))
1316                 user_srf->master = drm_master_get(file_priv->master);
1317
1318         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1319         if (unlikely(ret != 0))
1320                 return ret;
1321
1322         res = &user_srf->srf.res;
1323
1324
1325         if (req->buffer_handle != SVGA3D_INVALID_ID) {
1326                 ret = vmw_user_dmabuf_lookup(tfile, req->buffer_handle,
1327                                              &res->backup,
1328                                              &user_srf->backup_base);
1329                 if (ret == 0 && res->backup->base.num_pages * PAGE_SIZE <
1330                     res->backup_size) {
1331                         DRM_ERROR("Surface backup buffer is too small.\n");
1332                         vmw_dmabuf_unreference(&res->backup);
1333                         ret = -EINVAL;
1334                         goto out_unlock;
1335                 }
1336         } else if (req->drm_surface_flags & drm_vmw_surface_flag_create_buffer)
1337                 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
1338                                             res->backup_size,
1339                                             req->drm_surface_flags &
1340                                             drm_vmw_surface_flag_shareable,
1341                                             &backup_handle,
1342                                             &res->backup,
1343                                             &user_srf->backup_base);
1344
1345         if (unlikely(ret != 0)) {
1346                 vmw_resource_unreference(&res);
1347                 goto out_unlock;
1348         }
1349
1350         tmp = vmw_resource_reference(res);
1351         ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
1352                                     req->drm_surface_flags &
1353                                     drm_vmw_surface_flag_shareable,
1354                                     VMW_RES_SURFACE,
1355                                     &vmw_user_surface_base_release, NULL);
1356
1357         if (unlikely(ret != 0)) {
1358                 vmw_resource_unreference(&tmp);
1359                 vmw_resource_unreference(&res);
1360                 goto out_unlock;
1361         }
1362
1363         rep->handle      = user_srf->prime.base.hash.key;
1364         rep->backup_size = res->backup_size;
1365         if (res->backup) {
1366                 rep->buffer_map_handle =
1367                         drm_vma_node_offset_addr(&res->backup->base.vma_node);
1368                 rep->buffer_size = res->backup->base.num_pages * PAGE_SIZE;
1369                 rep->buffer_handle = backup_handle;
1370         } else {
1371                 rep->buffer_map_handle = 0;
1372                 rep->buffer_size = 0;
1373                 rep->buffer_handle = SVGA3D_INVALID_ID;
1374         }
1375
1376         vmw_resource_unreference(&res);
1377
1378 out_unlock:
1379         ttm_read_unlock(&dev_priv->reservation_sem);
1380         return ret;
1381 }
1382
1383 /**
1384  * vmw_gb_surface_reference_ioctl - Ioctl function implementing
1385  *                                  the user surface reference functionality.
1386  *
1387  * @dev:            Pointer to a struct drm_device.
1388  * @data:           Pointer to data copied from / to user-space.
1389  * @file_priv:      Pointer to a drm file private structure.
1390  */
1391 int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1392                                    struct drm_file *file_priv)
1393 {
1394         struct vmw_private *dev_priv = vmw_priv(dev);
1395         union drm_vmw_gb_surface_reference_arg *arg =
1396             (union drm_vmw_gb_surface_reference_arg *)data;
1397         struct drm_vmw_surface_arg *req = &arg->req;
1398         struct drm_vmw_gb_surface_ref_rep *rep = &arg->rep;
1399         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1400         struct vmw_surface *srf;
1401         struct vmw_user_surface *user_srf;
1402         struct ttm_base_object *base;
1403         uint32_t backup_handle;
1404         int ret = -EINVAL;
1405
1406         ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
1407                                            req->handle_type, &base);
1408         if (unlikely(ret != 0))
1409                 return ret;
1410
1411         user_srf = container_of(base, struct vmw_user_surface, prime.base);
1412         srf = &user_srf->srf;
1413         if (srf->res.backup == NULL) {
1414                 DRM_ERROR("Shared GB surface is missing a backup buffer.\n");
1415                 goto out_bad_resource;
1416         }
1417
1418         mutex_lock(&dev_priv->cmdbuf_mutex); /* Protect res->backup */
1419         ret = vmw_user_dmabuf_reference(tfile, srf->res.backup,
1420                                         &backup_handle);
1421         mutex_unlock(&dev_priv->cmdbuf_mutex);
1422
1423         if (unlikely(ret != 0)) {
1424                 DRM_ERROR("Could not add a reference to a GB surface "
1425                           "backup buffer.\n");
1426                 (void) ttm_ref_object_base_unref(tfile, base->hash.key,
1427                                                  TTM_REF_USAGE);
1428                 goto out_bad_resource;
1429         }
1430
1431         rep->creq.svga3d_flags = srf->flags;
1432         rep->creq.format = srf->format;
1433         rep->creq.mip_levels = srf->mip_levels[0];
1434         rep->creq.drm_surface_flags = 0;
1435         rep->creq.multisample_count = srf->multisample_count;
1436         rep->creq.autogen_filter = srf->autogen_filter;
1437         rep->creq.array_size = srf->array_size;
1438         rep->creq.buffer_handle = backup_handle;
1439         rep->creq.base_size = srf->base_size;
1440         rep->crep.handle = user_srf->prime.base.hash.key;
1441         rep->crep.backup_size = srf->res.backup_size;
1442         rep->crep.buffer_handle = backup_handle;
1443         rep->crep.buffer_map_handle =
1444                 drm_vma_node_offset_addr(&srf->res.backup->base.vma_node);
1445         rep->crep.buffer_size = srf->res.backup->base.num_pages * PAGE_SIZE;
1446
1447 out_bad_resource:
1448         ttm_base_object_unref(&base);
1449
1450         return ret;
1451 }
1452
1453 /**
1454  * vmw_surface_gb_priv_define - Define a private GB surface
1455  *
1456  * @dev:  Pointer to a struct drm_device
1457  * @user_accounting_size:  Used to track user-space memory usage, set
1458  *                         to 0 for kernel mode only memory
1459  * @svga3d_flags: SVGA3d surface flags for the device
1460  * @format: requested surface format
1461  * @for_scanout: true if inteded to be used for scanout buffer
1462  * @num_mip_levels:  number of MIP levels
1463  * @multisample_count:
1464  * @array_size: Surface array size.
1465  * @size: width, heigh, depth of the surface requested
1466  * @user_srf_out: allocated user_srf.  Set to NULL on failure.
1467  *
1468  * GB surfaces allocated by this function will not have a user mode handle, and
1469  * thus will only be visible to vmwgfx.  For optimization reasons the
1470  * surface may later be given a user mode handle by another function to make
1471  * it available to user mode drivers.
1472  */
1473 int vmw_surface_gb_priv_define(struct drm_device *dev,
1474                                uint32_t user_accounting_size,
1475                                uint32_t svga3d_flags,
1476                                SVGA3dSurfaceFormat format,
1477                                bool for_scanout,
1478                                uint32_t num_mip_levels,
1479                                uint32_t multisample_count,
1480                                uint32_t array_size,
1481                                struct drm_vmw_size size,
1482                                struct vmw_surface **srf_out)
1483 {
1484         struct vmw_private *dev_priv = vmw_priv(dev);
1485         struct vmw_user_surface *user_srf;
1486         struct vmw_surface *srf;
1487         int ret;
1488         u32 num_layers;
1489
1490         *srf_out = NULL;
1491
1492         if (for_scanout) {
1493                 if (!svga3dsurface_is_screen_target_format(format)) {
1494                         DRM_ERROR("Invalid Screen Target surface format.");
1495                         return -EINVAL;
1496                 }
1497         } else {
1498                 const struct svga3d_surface_desc *desc;
1499
1500                 desc = svga3dsurface_get_desc(format);
1501                 if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
1502                         DRM_ERROR("Invalid surface format.\n");
1503                         return -EINVAL;
1504                 }
1505         }
1506
1507         /* array_size must be null for non-GL3 host. */
1508         if (array_size > 0 && !dev_priv->has_dx) {
1509                 DRM_ERROR("Tried to create DX surface on non-DX host.\n");
1510                 return -EINVAL;
1511         }
1512
1513         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1514         if (unlikely(ret != 0))
1515                 return ret;
1516
1517         ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
1518                                    user_accounting_size, false, true);
1519         if (unlikely(ret != 0)) {
1520                 if (ret != -ERESTARTSYS)
1521                         DRM_ERROR("Out of graphics memory for surface"
1522                                   " creation.\n");
1523                 goto out_unlock;
1524         }
1525
1526         user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
1527         if (unlikely(user_srf == NULL)) {
1528                 ret = -ENOMEM;
1529                 goto out_no_user_srf;
1530         }
1531
1532         *srf_out  = &user_srf->srf;
1533         user_srf->size = user_accounting_size;
1534         user_srf->prime.base.shareable = false;
1535         user_srf->prime.base.tfile     = NULL;
1536
1537         srf = &user_srf->srf;
1538         srf->flags             = svga3d_flags;
1539         srf->format            = format;
1540         srf->scanout           = for_scanout;
1541         srf->mip_levels[0]     = num_mip_levels;
1542         srf->num_sizes         = 1;
1543         srf->sizes             = NULL;
1544         srf->offsets           = NULL;
1545         srf->base_size         = size;
1546         srf->autogen_filter    = SVGA3D_TEX_FILTER_NONE;
1547         srf->array_size        = array_size;
1548         srf->multisample_count = multisample_count;
1549
1550         if (array_size)
1551                 num_layers = array_size;
1552         else if (svga3d_flags & SVGA3D_SURFACE_CUBEMAP)
1553                 num_layers = SVGA3D_MAX_SURFACE_FACES;
1554         else
1555                 num_layers = 1;
1556
1557         srf->res.backup_size   =
1558                 svga3dsurface_get_serialized_size(srf->format,
1559                                                   srf->base_size,
1560                                                   srf->mip_levels[0],
1561                                                   num_layers);
1562
1563         if (srf->flags & SVGA3D_SURFACE_BIND_STREAM_OUTPUT)
1564                 srf->res.backup_size += sizeof(SVGA3dDXSOState);
1565
1566         if (dev_priv->active_display_unit == vmw_du_screen_target &&
1567             for_scanout)
1568                 srf->flags |= SVGA3D_SURFACE_SCREENTARGET;
1569
1570         /*
1571          * From this point, the generic resource management functions
1572          * destroy the object on failure.
1573          */
1574         ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
1575
1576         ttm_read_unlock(&dev_priv->reservation_sem);
1577         return ret;
1578
1579 out_no_user_srf:
1580         ttm_mem_global_free(vmw_mem_glob(dev_priv), user_accounting_size);
1581
1582 out_unlock:
1583         ttm_read_unlock(&dev_priv->reservation_sem);
1584         return ret;
1585 }