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)) {
 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)) {
 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);
 450         submit_size = vmw_surface_dma_size(srf);
 451         cmd = vmw_fifo_reserve(dev_priv, submit_size);
 452         if (unlikely(!cmd)) {
 453                 DRM_ERROR("Failed reserving FIFO space for surface "
 454                           "DMA.\n");
 455                 return -ENOMEM;
 456         }
 457         vmw_bo_get_guest_ptr(val_buf->bo, &ptr);
 458         vmw_surface_dma_encode(srf, cmd, &ptr, bind);
 459
 460         vmw_fifo_commit(dev_priv, submit_size);
 461
 462         /*
 463          * Create a fence object and fence the backup buffer.
 464          */
 465
 466         (void) vmw_execbuf_fence_commands(NULL, dev_priv,
 467                                           &fence, NULL);
 468
 469         vmw_fence_single_bo(val_buf->bo, fence);
 470
 471         if (likely(fence != NULL))
 472                 vmw_fence_obj_unreference(&fence);
 473
 474         return 0;
 475 }
 476
 477 /**
 478  * vmw_legacy_srf_bind - Perform a legacy surface bind as part of the
 479  *                       surface validation process.
 480  *
 481  * @res:            Pointer to a struct vmw_res embedded in a struct
 482  *                  vmw_surface.
 483  * @val_buf:        Pointer to a struct ttm_validate_buffer containing
 484  *                  information about the backup buffer.
 485  *
 486  * This function will copy backup data to the surface if the
 487  * backup buffer is dirty.
 488  */
 489 static int vmw_legacy_srf_bind(struct vmw_resource *res,
 490                                struct ttm_validate_buffer *val_buf)
 491 {
 492         if (!res->backup_dirty)
 493                 return 0;
 494
 495         return vmw_legacy_srf_dma(res, val_buf, true);
 496 }
 497
 498
 499 /**
 500  * vmw_legacy_srf_unbind - Perform a legacy surface unbind as part of the
 501  *                         surface eviction process.
 502  *
 503  * @res:            Pointer to a struct vmw_res embedded in a struct
 504  *                  vmw_surface.
 505  * @val_buf:        Pointer to a struct ttm_validate_buffer containing
 506  *                  information about the backup buffer.
 507  *
 508  * This function will copy backup data from the surface.
 509  */
 510 static int vmw_legacy_srf_unbind(struct vmw_resource *res,
 511                                  bool readback,
 512                                  struct ttm_validate_buffer *val_buf)
 513 {
 514         if (unlikely(readback))
 515                 return vmw_legacy_srf_dma(res, val_buf, false);
 516         return 0;
 517 }
 518
 519 /**
 520  * vmw_legacy_srf_destroy - Destroy a device surface as part of a
 521  *                          resource eviction process.
 522  *
 523  * @res:            Pointer to a struct vmw_res embedded in a struct
 524  *                  vmw_surface.
 525  */
 526 static int vmw_legacy_srf_destroy(struct vmw_resource *res)
 527 {
 528         struct vmw_private *dev_priv = res->dev_priv;
 529         uint32_t submit_size;
 530         uint8_t *cmd;
 531
 532         BUG_ON(res->id == -1);
 533
 534         /*
 535          * Encode the dma- and surface destroy commands.
 536          */
 537
 538         submit_size = vmw_surface_destroy_size();
 539         cmd = vmw_fifo_reserve(dev_priv, submit_size);
 540         if (unlikely(!cmd)) {
 541                 DRM_ERROR("Failed reserving FIFO space for surface "
 542                           "eviction.\n");
 543                 return -ENOMEM;
 544         }
 545
 546         vmw_surface_destroy_encode(res->id, cmd);
 547         vmw_fifo_commit(dev_priv, submit_size);
 548
 549         /*
 550          * Surface memory usage accounting.
 551          */
 552
 553         dev_priv->used_memory_size -= res->backup_size;
 554
 555         /*
 556          * Release the surface ID.
 557          */
 558
 559         vmw_resource_release_id(res);
 560
 561         return 0;
 562 }
 563
 564
 565 /**
 566  * vmw_surface_init - initialize a struct vmw_surface
 567  *
 568  * @dev_priv:       Pointer to a device private struct.
 569  * @srf:            Pointer to the struct vmw_surface to initialize.
 570  * @res_free:       Pointer to a resource destructor used to free
 571  *                  the object.
 572  */
 573 static int vmw_surface_init(struct vmw_private *dev_priv,
 574                             struct vmw_surface *srf,
 575                             void (*res_free) (struct vmw_resource *res))
 576 {
 577         int ret;
 578         struct vmw_resource *res = &srf->res;
 579
 580         BUG_ON(!res_free);
 581         if (!dev_priv->has_mob)
 582                 vmw_fifo_resource_inc(dev_priv);
 583         ret = vmw_resource_init(dev_priv, res, true, res_free,
 584                                 (dev_priv->has_mob) ? &vmw_gb_surface_func :
 585                                 &vmw_legacy_surface_func);
 586
 587         if (unlikely(ret != 0)) {
 588                 if (!dev_priv->has_mob)
 589                         vmw_fifo_resource_dec(dev_priv);
 590                 res_free(res);
 591                 return ret;
 592         }
 593
 594         /*
 595          * The surface won't be visible to hardware until a
 596          * surface validate.
 597          */
 598
 599         INIT_LIST_HEAD(&srf->view_list);
 600         vmw_resource_activate(res, vmw_hw_surface_destroy);
 601         return ret;
 602 }
 603
 604 /**
 605  * vmw_user_surface_base_to_res - TTM base object to resource converter for
 606  *                                user visible surfaces
 607  *
 608  * @base:           Pointer to a TTM base object
 609  *
 610  * Returns the struct vmw_resource embedded in a struct vmw_surface
 611  * for the user-visible object identified by the TTM base object @base.
 612  */
 613 static struct vmw_resource *
 614 vmw_user_surface_base_to_res(struct ttm_base_object *base)
 615 {
 616         return &(container_of(base, struct vmw_user_surface,
 617                               prime.base)->srf.res);
 618 }
 619
 620 /**
 621  * vmw_user_surface_free - User visible surface resource destructor
 622  *
 623  * @res:            A struct vmw_resource embedded in a struct vmw_surface.
 624  */
 625 static void vmw_user_surface_free(struct vmw_resource *res)
 626 {
 627         struct vmw_surface *srf = vmw_res_to_srf(res);
 628         struct vmw_user_surface *user_srf =
 629             container_of(srf, struct vmw_user_surface, srf);
 630         struct vmw_private *dev_priv = srf->res.dev_priv;
 631         uint32_t size = user_srf->size;
 632
 633         if (user_srf->master)
 634                 drm_master_put(&user_srf->master);
 635         kfree(srf->offsets);
 636         kfree(srf->sizes);
 637         kfree(srf->snooper.image);
 638         ttm_prime_object_kfree(user_srf, prime);
 639         ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
 640 }
 641
 642 /**
 643  * vmw_user_surface_free - User visible surface TTM base object destructor
 644  *
 645  * @p_base:         Pointer to a pointer to a TTM base object
 646  *                  embedded in a struct vmw_user_surface.
 647  *
 648  * Drops the base object's reference on its resource, and the
 649  * pointer pointed to by *p_base is set to NULL.
 650  */
 651 static void vmw_user_surface_base_release(struct ttm_base_object **p_base)
 652 {
 653         struct ttm_base_object *base = *p_base;
 654         struct vmw_user_surface *user_srf =
 655             container_of(base, struct vmw_user_surface, prime.base);
 656         struct vmw_resource *res = &user_srf->srf.res;
 657
 658         *p_base = NULL;
 659         if (user_srf->backup_base)
 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         int ret;
 703         int i, j;
 704         uint32_t cur_bo_offset;
 705         struct drm_vmw_size *cur_size;
 706         struct vmw_surface_offset *cur_offset;
 707         uint32_t num_sizes;
 708         uint32_t size;
 709         const struct svga3d_surface_desc *desc;
 710
 711         if (unlikely(vmw_user_surface_size == 0))
 712                 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
 713                         128;
 714
 715         num_sizes = 0;
 716         for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i)
 717                 num_sizes += req->mip_levels[i];
 718
 719         if (num_sizes > DRM_VMW_MAX_SURFACE_FACES *
 720             DRM_VMW_MAX_MIP_LEVELS)
 721                 return -EINVAL;
 722
 723         size = vmw_user_surface_size + 128 +
 724                 ttm_round_pot(num_sizes * sizeof(struct drm_vmw_size)) +
 725                 ttm_round_pot(num_sizes * sizeof(struct vmw_surface_offset));
 726
 727
 728         desc = svga3dsurface_get_desc(req->format);
 729         if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
 730                 DRM_ERROR("Invalid surface format for surface creation.\n");
 731                 DRM_ERROR("Format requested is: %d\n", req->format);
 732                 return -EINVAL;
 733         }
 734
 735         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
 736         if (unlikely(ret != 0))
 737                 return ret;
 738
 739         ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
 740                                    size, false, true);
 741         if (unlikely(ret != 0)) {
 742                 if (ret != -ERESTARTSYS)
 743                         DRM_ERROR("Out of graphics memory for surface"
 744                                   " creation.\n");
 745                 goto out_unlock;
 746         }
 747
 748         user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
 749         if (unlikely(!user_srf)) {
 750                 ret = -ENOMEM;
 751                 goto out_no_user_srf;
 752         }
 753
 754         srf = &user_srf->srf;
 755         res = &srf->res;
 756
 757         srf->flags = req->flags;
 758         srf->format = req->format;
 759         srf->scanout = req->scanout;
 760
 761         memcpy(srf->mip_levels, req->mip_levels, sizeof(srf->mip_levels));
 762         srf->num_sizes = num_sizes;
 763         user_srf->size = size;
 764         srf->sizes = memdup_user((struct drm_vmw_size __user *)(unsigned long)
 765                                  req->size_addr,
 766                                  sizeof(*srf->sizes) * srf->num_sizes);
 767         if (IS_ERR(srf->sizes)) {
 768                 ret = PTR_ERR(srf->sizes);
 769                 goto out_no_sizes;
 770         }
 771         srf->offsets = kmalloc_array(srf->num_sizes,
 772                                      sizeof(*srf->offsets),
 773                                      GFP_KERNEL);
 774         if (unlikely(!srf->offsets)) {
 775                 ret = -ENOMEM;
 776                 goto out_no_offsets;
 777         }
 778
 779         srf->base_size = *srf->sizes;
 780         srf->autogen_filter = SVGA3D_TEX_FILTER_NONE;
 781         srf->multisample_count = 0;
 782
 783         cur_bo_offset = 0;
 784         cur_offset = srf->offsets;
 785         cur_size = srf->sizes;
 786
 787         for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i) {
 788                 for (j = 0; j < srf->mip_levels[i]; ++j) {
 789                         uint32_t stride = svga3dsurface_calculate_pitch
 790                                 (desc, cur_size);
 791
 792                         cur_offset->face = i;
 793                         cur_offset->mip = j;
 794                         cur_offset->bo_offset = cur_bo_offset;
 795                         cur_bo_offset += svga3dsurface_get_image_buffer_size
 796                                 (desc, cur_size, stride);
 797                         ++cur_offset;
 798                         ++cur_size;
 799                 }
 800         }
 801         res->backup_size = cur_bo_offset;
 802         if (srf->scanout &&
 803             srf->num_sizes == 1 &&
 804             srf->sizes[0].width == 64 &&
 805             srf->sizes[0].height == 64 &&
 806             srf->format == SVGA3D_A8R8G8B8) {
 807
 808                 srf->snooper.image = kzalloc(64 * 64 * 4, GFP_KERNEL);
 809                 if (!srf->snooper.image) {
 810                         DRM_ERROR("Failed to allocate cursor_image\n");
 811                         ret = -ENOMEM;
 812                         goto out_no_copy;
 813                 }
 814         } else {
 815                 srf->snooper.image = NULL;
 816         }
 817         srf->snooper.crtc = NULL;
 818
 819         user_srf->prime.base.shareable = false;
 820         user_srf->prime.base.tfile = NULL;
 821         if (drm_is_primary_client(file_priv))
 822                 user_srf->master = drm_master_get(file_priv->master);
 823
 824         /**
 825          * From this point, the generic resource management functions
 826          * destroy the object on failure.
 827          */
 828
 829         ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
 830         if (unlikely(ret != 0))
 831                 goto out_unlock;
 832
 833         /*
 834          * A gb-aware client referencing a shared surface will
 835          * expect a backup buffer to be present.
 836          */
 837         if (dev_priv->has_mob && req->shareable) {
 838                 uint32_t backup_handle;
 839
 840                 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
 841                                             res->backup_size,
 842                                             true,
 843                                             &backup_handle,
 844                                             &res->backup,
 845                                             &user_srf->backup_base);
 846                 if (unlikely(ret != 0)) {
 847                         vmw_resource_unreference(&res);
 848                         goto out_unlock;
 849                 }
 850         }
 851
 852         tmp = vmw_resource_reference(&srf->res);
 853         ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
 854                                     req->shareable, VMW_RES_SURFACE,
 855                                     &vmw_user_surface_base_release, NULL);
 856
 857         if (unlikely(ret != 0)) {
 858                 vmw_resource_unreference(&tmp);
 859                 vmw_resource_unreference(&res);
 860                 goto out_unlock;
 861         }
 862
 863         rep->sid = user_srf->prime.base.hash.key;
 864         vmw_resource_unreference(&res);
 865
 866         ttm_read_unlock(&dev_priv->reservation_sem);
 867         return 0;
 868 out_no_copy:
 869         kfree(srf->offsets);
 870 out_no_offsets:
 871         kfree(srf->sizes);
 872 out_no_sizes:
 873         ttm_prime_object_kfree(user_srf, prime);
 874 out_no_user_srf:
 875         ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
 876 out_unlock:
 877         ttm_read_unlock(&dev_priv->reservation_sem);
 878         return ret;
 879 }
 880
 881
 882 static int
 883 vmw_surface_handle_reference(struct vmw_private *dev_priv,
 884                              struct drm_file *file_priv,
 885                              uint32_t u_handle,
 886                              enum drm_vmw_handle_type handle_type,
 887                              struct ttm_base_object **base_p)
 888 {
 889         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 890         struct vmw_user_surface *user_srf;
 891         uint32_t handle;
 892         struct ttm_base_object *base;
 893         int ret;
 894
 895         if (handle_type == DRM_VMW_HANDLE_PRIME) {
 896                 ret = ttm_prime_fd_to_handle(tfile, u_handle, &handle);
 897                 if (unlikely(ret != 0))
 898                         return ret;
 899         } else {
 900                 if (unlikely(drm_is_render_client(file_priv))) {
 901                         DRM_ERROR("Render client refused legacy "
 902                                   "surface reference.\n");
 903                         return -EACCES;
 904                 }
 905                 if (ACCESS_ONCE(vmw_fpriv(file_priv)->locked_master)) {
 906                         DRM_ERROR("Locked master refused legacy "
 907                                   "surface reference.\n");
 908                         return -EACCES;
 909                 }
 910
 911                 handle = u_handle;
 912         }
 913
 914         ret = -EINVAL;
 915         base = ttm_base_object_lookup_for_ref(dev_priv->tdev, handle);
 916         if (unlikely(!base)) {
 917                 DRM_ERROR("Could not find surface to reference.\n");
 918                 goto out_no_lookup;
 919         }
 920
 921         if (unlikely(ttm_base_object_type(base) != VMW_RES_SURFACE)) {
 922                 DRM_ERROR("Referenced object is not a surface.\n");
 923                 goto out_bad_resource;
 924         }
 925
 926         if (handle_type != DRM_VMW_HANDLE_PRIME) {
 927                 user_srf = container_of(base, struct vmw_user_surface,
 928                                         prime.base);
 929
 930                 /*
 931                  * Make sure the surface creator has the same
 932                  * authenticating master.
 933                  */
 934                 if (drm_is_primary_client(file_priv) &&
 935                     user_srf->master != file_priv->master) {
 936                         DRM_ERROR("Trying to reference surface outside of"
 937                                   " master domain.\n");
 938                         ret = -EACCES;
 939                         goto out_bad_resource;
 940                 }
 941
 942                 ret = ttm_ref_object_add(tfile, base, TTM_REF_USAGE, NULL);
 943                 if (unlikely(ret != 0)) {
 944                         DRM_ERROR("Could not add a reference to a surface.\n");
 945                         goto out_bad_resource;
 946                 }
 947         }
 948
 949         *base_p = base;
 950         return 0;
 951
 952 out_bad_resource:
 953         ttm_base_object_unref(&base);
 954 out_no_lookup:
 955         if (handle_type == DRM_VMW_HANDLE_PRIME)
 956                 (void) ttm_ref_object_base_unref(tfile, handle, TTM_REF_USAGE);
 957
 958         return ret;
 959 }
 960
 961 /**
 962  * vmw_user_surface_define_ioctl - Ioctl function implementing
 963  *                                  the user surface reference functionality.
 964  *
 965  * @dev:            Pointer to a struct drm_device.
 966  * @data:           Pointer to data copied from / to user-space.
 967  * @file_priv:      Pointer to a drm file private structure.
 968  */
 969 int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
 970                                 struct drm_file *file_priv)
 971 {
 972         struct vmw_private *dev_priv = vmw_priv(dev);
 973         union drm_vmw_surface_reference_arg *arg =
 974             (union drm_vmw_surface_reference_arg *)data;
 975         struct drm_vmw_surface_arg *req = &arg->req;
 976         struct drm_vmw_surface_create_req *rep = &arg->rep;
 977         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 978         struct vmw_surface *srf;
 979         struct vmw_user_surface *user_srf;
 980         struct drm_vmw_size __user *user_sizes;
 981         struct ttm_base_object *base;
 982         int ret;
 983
 984         ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
 985                                            req->handle_type, &base);
 986         if (unlikely(ret != 0))
 987                 return ret;
 988
 989         user_srf = container_of(base, struct vmw_user_surface, prime.base);
 990         srf = &user_srf->srf;
 991
 992         rep->flags = srf->flags;
 993         rep->format = srf->format;
 994         memcpy(rep->mip_levels, srf->mip_levels, sizeof(srf->mip_levels));
 995         user_sizes = (struct drm_vmw_size __user *)(unsigned long)
 996             rep->size_addr;
 997
 998         if (user_sizes)
 999                 ret = copy_to_user(user_sizes, &srf->base_size,
1000                                    sizeof(srf->base_size));
1001         if (unlikely(ret != 0)) {
1002                 DRM_ERROR("copy_to_user failed %p %u\n",
1003                           user_sizes, srf->num_sizes);
1004                 ttm_ref_object_base_unref(tfile, base->hash.key, TTM_REF_USAGE);
1005                 ret = -EFAULT;
1006         }
1007
1008         ttm_base_object_unref(&base);
1009
1010         return ret;
1011 }
1012
1013 /**
1014  * vmw_surface_define_encode - Encode a surface_define command.
1015  *
1016  * @srf: Pointer to a struct vmw_surface object.
1017  * @cmd_space: Pointer to memory area in which the commands should be encoded.
1018  */
1019 static int vmw_gb_surface_create(struct vmw_resource *res)
1020 {
1021         struct vmw_private *dev_priv = res->dev_priv;
1022         struct vmw_surface *srf = vmw_res_to_srf(res);
1023         uint32_t cmd_len, cmd_id, submit_len;
1024         int ret;
1025         struct {
1026                 SVGA3dCmdHeader header;
1027                 SVGA3dCmdDefineGBSurface body;
1028         } *cmd;
1029         struct {
1030                 SVGA3dCmdHeader header;
1031                 SVGA3dCmdDefineGBSurface_v2 body;
1032         } *cmd2;
1033
1034         if (likely(res->id != -1))
1035                 return 0;
1036
1037         vmw_fifo_resource_inc(dev_priv);
1038         ret = vmw_resource_alloc_id(res);
1039         if (unlikely(ret != 0)) {
1040                 DRM_ERROR("Failed to allocate a surface id.\n");
1041                 goto out_no_id;
1042         }
1043
1044         if (unlikely(res->id >= VMWGFX_NUM_GB_SURFACE)) {
1045                 ret = -EBUSY;
1046                 goto out_no_fifo;
1047         }
1048
1049         if (srf->array_size > 0) {
1050                 /* has_dx checked on creation time. */
1051                 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE_V2;
1052                 cmd_len = sizeof(cmd2->body);
1053                 submit_len = sizeof(*cmd2);
1054         } else {
1055                 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE;
1056                 cmd_len = sizeof(cmd->body);
1057                 submit_len = sizeof(*cmd);
1058         }
1059
1060         cmd = vmw_fifo_reserve(dev_priv, submit_len);
1061         cmd2 = (typeof(cmd2))cmd;
1062         if (unlikely(!cmd)) {
1063                 DRM_ERROR("Failed reserving FIFO space for surface "
1064                           "creation.\n");
1065                 ret = -ENOMEM;
1066                 goto out_no_fifo;
1067         }
1068
1069         if (srf->array_size > 0) {
1070                 cmd2->header.id = cmd_id;
1071                 cmd2->header.size = cmd_len;
1072                 cmd2->body.sid = srf->res.id;
1073                 cmd2->body.surfaceFlags = srf->flags;
1074                 cmd2->body.format = cpu_to_le32(srf->format);
1075                 cmd2->body.numMipLevels = srf->mip_levels[0];
1076                 cmd2->body.multisampleCount = srf->multisample_count;
1077                 cmd2->body.autogenFilter = srf->autogen_filter;
1078                 cmd2->body.size.width = srf->base_size.width;
1079                 cmd2->body.size.height = srf->base_size.height;
1080                 cmd2->body.size.depth = srf->base_size.depth;
1081                 cmd2->body.arraySize = srf->array_size;
1082         } else {
1083                 cmd->header.id = cmd_id;
1084                 cmd->header.size = cmd_len;
1085                 cmd->body.sid = srf->res.id;
1086                 cmd->body.surfaceFlags = srf->flags;
1087                 cmd->body.format = cpu_to_le32(srf->format);
1088                 cmd->body.numMipLevels = srf->mip_levels[0];
1089                 cmd->body.multisampleCount = srf->multisample_count;
1090                 cmd->body.autogenFilter = srf->autogen_filter;
1091                 cmd->body.size.width = srf->base_size.width;
1092                 cmd->body.size.height = srf->base_size.height;
1093                 cmd->body.size.depth = srf->base_size.depth;
1094         }
1095
1096         vmw_fifo_commit(dev_priv, submit_len);
1097
1098         return 0;
1099
1100 out_no_fifo:
1101         vmw_resource_release_id(res);
1102 out_no_id:
1103         vmw_fifo_resource_dec(dev_priv);
1104         return ret;
1105 }
1106
1107
1108 static int vmw_gb_surface_bind(struct vmw_resource *res,
1109                                struct ttm_validate_buffer *val_buf)
1110 {
1111         struct vmw_private *dev_priv = res->dev_priv;
1112         struct {
1113                 SVGA3dCmdHeader header;
1114                 SVGA3dCmdBindGBSurface body;
1115         } *cmd1;
1116         struct {
1117                 SVGA3dCmdHeader header;
1118                 SVGA3dCmdUpdateGBSurface body;
1119         } *cmd2;
1120         uint32_t submit_size;
1121         struct ttm_buffer_object *bo = val_buf->bo;
1122
1123         BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1124
1125         submit_size = sizeof(*cmd1) + (res->backup_dirty ? sizeof(*cmd2) : 0);
1126
1127         cmd1 = vmw_fifo_reserve(dev_priv, submit_size);
1128         if (unlikely(!cmd1)) {
1129                 DRM_ERROR("Failed reserving FIFO space for surface "
1130                           "binding.\n");
1131                 return -ENOMEM;
1132         }
1133
1134         cmd1->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1135         cmd1->header.size = sizeof(cmd1->body);
1136         cmd1->body.sid = res->id;
1137         cmd1->body.mobid = bo->mem.start;
1138         if (res->backup_dirty) {
1139                 cmd2 = (void *) &cmd1[1];
1140                 cmd2->header.id = SVGA_3D_CMD_UPDATE_GB_SURFACE;
1141                 cmd2->header.size = sizeof(cmd2->body);
1142                 cmd2->body.sid = res->id;
1143                 res->backup_dirty = false;
1144         }
1145         vmw_fifo_commit(dev_priv, submit_size);
1146
1147         return 0;
1148 }
1149
1150 static int vmw_gb_surface_unbind(struct vmw_resource *res,
1151                                  bool readback,
1152                                  struct ttm_validate_buffer *val_buf)
1153 {
1154         struct vmw_private *dev_priv = res->dev_priv;
1155         struct ttm_buffer_object *bo = val_buf->bo;
1156         struct vmw_fence_obj *fence;
1157
1158         struct {
1159                 SVGA3dCmdHeader header;
1160                 SVGA3dCmdReadbackGBSurface body;
1161         } *cmd1;
1162         struct {
1163                 SVGA3dCmdHeader header;
1164                 SVGA3dCmdInvalidateGBSurface body;
1165         } *cmd2;
1166         struct {
1167                 SVGA3dCmdHeader header;
1168                 SVGA3dCmdBindGBSurface body;
1169         } *cmd3;
1170         uint32_t submit_size;
1171         uint8_t *cmd;
1172
1173
1174         BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1175
1176         submit_size = sizeof(*cmd3) + (readback ? sizeof(*cmd1) : sizeof(*cmd2));
1177         cmd = vmw_fifo_reserve(dev_priv, submit_size);
1178         if (unlikely(!cmd)) {
1179                 DRM_ERROR("Failed reserving FIFO space for surface "
1180                           "unbinding.\n");
1181                 return -ENOMEM;
1182         }
1183
1184         if (readback) {
1185                 cmd1 = (void *) cmd;
1186                 cmd1->header.id = SVGA_3D_CMD_READBACK_GB_SURFACE;
1187                 cmd1->header.size = sizeof(cmd1->body);
1188                 cmd1->body.sid = res->id;
1189                 cmd3 = (void *) &cmd1[1];
1190         } else {
1191                 cmd2 = (void *) cmd;
1192                 cmd2->header.id = SVGA_3D_CMD_INVALIDATE_GB_SURFACE;
1193                 cmd2->header.size = sizeof(cmd2->body);
1194                 cmd2->body.sid = res->id;
1195                 cmd3 = (void *) &cmd2[1];
1196         }
1197
1198         cmd3->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1199         cmd3->header.size = sizeof(cmd3->body);
1200         cmd3->body.sid = res->id;
1201         cmd3->body.mobid = SVGA3D_INVALID_ID;
1202
1203         vmw_fifo_commit(dev_priv, submit_size);
1204
1205         /*
1206          * Create a fence object and fence the backup buffer.
1207          */
1208
1209         (void) vmw_execbuf_fence_commands(NULL, dev_priv,
1210                                           &fence, NULL);
1211
1212         vmw_fence_single_bo(val_buf->bo, fence);
1213
1214         if (likely(fence != NULL))
1215                 vmw_fence_obj_unreference(&fence);
1216
1217         return 0;
1218 }
1219
1220 static int vmw_gb_surface_destroy(struct vmw_resource *res)
1221 {
1222         struct vmw_private *dev_priv = res->dev_priv;
1223         struct vmw_surface *srf = vmw_res_to_srf(res);
1224         struct {
1225                 SVGA3dCmdHeader header;
1226                 SVGA3dCmdDestroyGBSurface body;
1227         } *cmd;
1228
1229         if (likely(res->id == -1))
1230                 return 0;
1231
1232         mutex_lock(&dev_priv->binding_mutex);
1233         vmw_view_surface_list_destroy(dev_priv, &srf->view_list);
1234         vmw_binding_res_list_scrub(&res->binding_head);
1235
1236         cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
1237         if (unlikely(!cmd)) {
1238                 DRM_ERROR("Failed reserving FIFO space for surface "
1239                           "destruction.\n");
1240                 mutex_unlock(&dev_priv->binding_mutex);
1241                 return -ENOMEM;
1242         }
1243
1244         cmd->header.id = SVGA_3D_CMD_DESTROY_GB_SURFACE;
1245         cmd->header.size = sizeof(cmd->body);
1246         cmd->body.sid = res->id;
1247         vmw_fifo_commit(dev_priv, sizeof(*cmd));
1248         mutex_unlock(&dev_priv->binding_mutex);
1249         vmw_resource_release_id(res);
1250         vmw_fifo_resource_dec(dev_priv);
1251
1252         return 0;
1253 }
1254
1255
1256 /**
1257  * vmw_gb_surface_define_ioctl - Ioctl function implementing
1258  *                               the user surface define functionality.
1259  *
1260  * @dev:            Pointer to a struct drm_device.
1261  * @data:           Pointer to data copied from / to user-space.
1262  * @file_priv:      Pointer to a drm file private structure.
1263  */
1264 int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1265                                 struct drm_file *file_priv)
1266 {
1267         struct vmw_private *dev_priv = vmw_priv(dev);
1268         struct vmw_user_surface *user_srf;
1269         struct vmw_surface *srf;
1270         struct vmw_resource *res;
1271         struct vmw_resource *tmp;
1272         union drm_vmw_gb_surface_create_arg *arg =
1273             (union drm_vmw_gb_surface_create_arg *)data;
1274         struct drm_vmw_gb_surface_create_req *req = &arg->req;
1275         struct drm_vmw_gb_surface_create_rep *rep = &arg->rep;
1276         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1277         int ret;
1278         uint32_t size;
1279         uint32_t backup_handle;
1280
1281         if (req->multisample_count != 0)
1282                 return -EINVAL;
1283
1284         if (unlikely(vmw_user_surface_size == 0))
1285                 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
1286                         128;
1287
1288         size = vmw_user_surface_size + 128;
1289
1290         /* Define a surface based on the parameters. */
1291         ret = vmw_surface_gb_priv_define(dev,
1292                         size,
1293                         req->svga3d_flags,
1294                         req->format,
1295                         req->drm_surface_flags & drm_vmw_surface_flag_scanout,
1296                         req->mip_levels,
1297                         req->multisample_count,
1298                         req->array_size,
1299                         req->base_size,
1300                         &srf);
1301         if (unlikely(ret != 0))
1302                 return ret;
1303
1304         user_srf = container_of(srf, struct vmw_user_surface, srf);
1305         if (drm_is_primary_client(file_priv))
1306                 user_srf->master = drm_master_get(file_priv->master);
1307
1308         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1309         if (unlikely(ret != 0))
1310                 return ret;
1311
1312         res = &user_srf->srf.res;
1313
1314
1315         if (req->buffer_handle != SVGA3D_INVALID_ID) {
1316                 ret = vmw_user_dmabuf_lookup(tfile, req->buffer_handle,
1317                                              &res->backup,
1318                                              &user_srf->backup_base);
1319                 if (ret == 0 && res->backup->base.num_pages * PAGE_SIZE <
1320                     res->backup_size) {
1321                         DRM_ERROR("Surface backup buffer is too small.\n");
1322                         vmw_dmabuf_unreference(&res->backup);
1323                         ret = -EINVAL;
1324                         goto out_unlock;
1325                 }
1326         } else if (req->drm_surface_flags & drm_vmw_surface_flag_create_buffer)
1327                 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
1328                                             res->backup_size,
1329                                             req->drm_surface_flags &
1330                                             drm_vmw_surface_flag_shareable,
1331                                             &backup_handle,
1332                                             &res->backup,
1333                                             &user_srf->backup_base);
1334
1335         if (unlikely(ret != 0)) {
1336                 vmw_resource_unreference(&res);
1337                 goto out_unlock;
1338         }
1339
1340         tmp = vmw_resource_reference(res);
1341         ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
1342                                     req->drm_surface_flags &
1343                                     drm_vmw_surface_flag_shareable,
1344                                     VMW_RES_SURFACE,
1345                                     &vmw_user_surface_base_release, NULL);
1346
1347         if (unlikely(ret != 0)) {
1348                 vmw_resource_unreference(&tmp);
1349                 vmw_resource_unreference(&res);
1350                 goto out_unlock;
1351         }
1352
1353         rep->handle      = user_srf->prime.base.hash.key;
1354         rep->backup_size = res->backup_size;
1355         if (res->backup) {
1356                 rep->buffer_map_handle =
1357                         drm_vma_node_offset_addr(&res->backup->base.vma_node);
1358                 rep->buffer_size = res->backup->base.num_pages * PAGE_SIZE;
1359                 rep->buffer_handle = backup_handle;
1360         } else {
1361                 rep->buffer_map_handle = 0;
1362                 rep->buffer_size = 0;
1363                 rep->buffer_handle = SVGA3D_INVALID_ID;
1364         }
1365
1366         vmw_resource_unreference(&res);
1367
1368 out_unlock:
1369         ttm_read_unlock(&dev_priv->reservation_sem);
1370         return ret;
1371 }
1372
1373 /**
1374  * vmw_gb_surface_reference_ioctl - Ioctl function implementing
1375  *                                  the user surface reference functionality.
1376  *
1377  * @dev:            Pointer to a struct drm_device.
1378  * @data:           Pointer to data copied from / to user-space.
1379  * @file_priv:      Pointer to a drm file private structure.
1380  */
1381 int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1382                                    struct drm_file *file_priv)
1383 {
1384         struct vmw_private *dev_priv = vmw_priv(dev);
1385         union drm_vmw_gb_surface_reference_arg *arg =
1386             (union drm_vmw_gb_surface_reference_arg *)data;
1387         struct drm_vmw_surface_arg *req = &arg->req;
1388         struct drm_vmw_gb_surface_ref_rep *rep = &arg->rep;
1389         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1390         struct vmw_surface *srf;
1391         struct vmw_user_surface *user_srf;
1392         struct ttm_base_object *base;
1393         uint32_t backup_handle;
1394         int ret = -EINVAL;
1395
1396         ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
1397                                            req->handle_type, &base);
1398         if (unlikely(ret != 0))
1399                 return ret;
1400
1401         user_srf = container_of(base, struct vmw_user_surface, prime.base);
1402         srf = &user_srf->srf;
1403         if (!srf->res.backup) {
1404                 DRM_ERROR("Shared GB surface is missing a backup buffer.\n");
1405                 goto out_bad_resource;
1406         }
1407
1408         mutex_lock(&dev_priv->cmdbuf_mutex); /* Protect res->backup */
1409         ret = vmw_user_dmabuf_reference(tfile, srf->res.backup,
1410                                         &backup_handle);
1411         mutex_unlock(&dev_priv->cmdbuf_mutex);
1412
1413         if (unlikely(ret != 0)) {
1414                 DRM_ERROR("Could not add a reference to a GB surface "
1415                           "backup buffer.\n");
1416                 (void) ttm_ref_object_base_unref(tfile, base->hash.key,
1417                                                  TTM_REF_USAGE);
1418                 goto out_bad_resource;
1419         }
1420
1421         rep->creq.svga3d_flags = srf->flags;
1422         rep->creq.format = srf->format;
1423         rep->creq.mip_levels = srf->mip_levels[0];
1424         rep->creq.drm_surface_flags = 0;
1425         rep->creq.multisample_count = srf->multisample_count;
1426         rep->creq.autogen_filter = srf->autogen_filter;
1427         rep->creq.array_size = srf->array_size;
1428         rep->creq.buffer_handle = backup_handle;
1429         rep->creq.base_size = srf->base_size;
1430         rep->crep.handle = user_srf->prime.base.hash.key;
1431         rep->crep.backup_size = srf->res.backup_size;
1432         rep->crep.buffer_handle = backup_handle;
1433         rep->crep.buffer_map_handle =
1434                 drm_vma_node_offset_addr(&srf->res.backup->base.vma_node);
1435         rep->crep.buffer_size = srf->res.backup->base.num_pages * PAGE_SIZE;
1436
1437 out_bad_resource:
1438         ttm_base_object_unref(&base);
1439
1440         return ret;
1441 }
1442
1443 /**
1444  * vmw_surface_gb_priv_define - Define a private GB surface
1445  *
1446  * @dev:  Pointer to a struct drm_device
1447  * @user_accounting_size:  Used to track user-space memory usage, set
1448  *                         to 0 for kernel mode only memory
1449  * @svga3d_flags: SVGA3d surface flags for the device
1450  * @format: requested surface format
1451  * @for_scanout: true if inteded to be used for scanout buffer
1452  * @num_mip_levels:  number of MIP levels
1453  * @multisample_count:
1454  * @array_size: Surface array size.
1455  * @size: width, heigh, depth of the surface requested
1456  * @user_srf_out: allocated user_srf.  Set to NULL on failure.
1457  *
1458  * GB surfaces allocated by this function will not have a user mode handle, and
1459  * thus will only be visible to vmwgfx.  For optimization reasons the
1460  * surface may later be given a user mode handle by another function to make
1461  * it available to user mode drivers.
1462  */
1463 int vmw_surface_gb_priv_define(struct drm_device *dev,
1464                                uint32_t user_accounting_size,
1465                                uint32_t svga3d_flags,
1466                                SVGA3dSurfaceFormat format,
1467                                bool for_scanout,
1468                                uint32_t num_mip_levels,
1469                                uint32_t multisample_count,
1470                                uint32_t array_size,
1471                                struct drm_vmw_size size,
1472                                struct vmw_surface **srf_out)
1473 {
1474         struct vmw_private *dev_priv = vmw_priv(dev);
1475         struct vmw_user_surface *user_srf;
1476         struct vmw_surface *srf;
1477         int ret;
1478         u32 num_layers;
1479
1480         *srf_out = NULL;
1481
1482         if (for_scanout) {
1483                 if (!svga3dsurface_is_screen_target_format(format)) {
1484                         DRM_ERROR("Invalid Screen Target surface format.");
1485                         return -EINVAL;
1486                 }
1487         } else {
1488                 const struct svga3d_surface_desc *desc;
1489
1490                 desc = svga3dsurface_get_desc(format);
1491                 if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
1492                         DRM_ERROR("Invalid surface format.\n");
1493                         return -EINVAL;
1494                 }
1495         }
1496
1497         /* array_size must be null for non-GL3 host. */
1498         if (array_size > 0 && !dev_priv->has_dx) {
1499                 DRM_ERROR("Tried to create DX surface on non-DX host.\n");
1500                 return -EINVAL;
1501         }
1502
1503         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1504         if (unlikely(ret != 0))
1505                 return ret;
1506
1507         ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
1508                                    user_accounting_size, false, true);
1509         if (unlikely(ret != 0)) {
1510                 if (ret != -ERESTARTSYS)
1511                         DRM_ERROR("Out of graphics memory for surface"
1512                                   " creation.\n");
1513                 goto out_unlock;
1514         }
1515
1516         user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
1517         if (unlikely(!user_srf)) {
1518                 ret = -ENOMEM;
1519                 goto out_no_user_srf;
1520         }
1521
1522         *srf_out  = &user_srf->srf;
1523         user_srf->size = user_accounting_size;
1524         user_srf->prime.base.shareable = false;
1525         user_srf->prime.base.tfile     = NULL;
1526
1527         srf = &user_srf->srf;
1528         srf->flags             = svga3d_flags;
1529         srf->format            = format;
1530         srf->scanout           = for_scanout;
1531         srf->mip_levels[0]     = num_mip_levels;
1532         srf->num_sizes         = 1;
1533         srf->sizes             = NULL;
1534         srf->offsets           = NULL;
1535         srf->base_size         = size;
1536         srf->autogen_filter    = SVGA3D_TEX_FILTER_NONE;
1537         srf->array_size        = array_size;
1538         srf->multisample_count = multisample_count;
1539
1540         if (array_size)
1541                 num_layers = array_size;
1542         else if (svga3d_flags & SVGA3D_SURFACE_CUBEMAP)
1543                 num_layers = SVGA3D_MAX_SURFACE_FACES;
1544         else
1545                 num_layers = 1;
1546
1547         srf->res.backup_size   =
1548                 svga3dsurface_get_serialized_size(srf->format,
1549                                                   srf->base_size,
1550                                                   srf->mip_levels[0],
1551                                                   num_layers);
1552
1553         if (srf->flags & SVGA3D_SURFACE_BIND_STREAM_OUTPUT)
1554                 srf->res.backup_size += sizeof(SVGA3dDXSOState);
1555
1556         if (dev_priv->active_display_unit == vmw_du_screen_target &&
1557             for_scanout)
1558                 srf->flags |= SVGA3D_SURFACE_SCREENTARGET;
1559
1560         /*
1561          * From this point, the generic resource management functions
1562          * destroy the object on failure.
1563          */
1564         ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
1565
1566         ttm_read_unlock(&dev_priv->reservation_sem);
1567         return ret;
1568
1569 out_no_user_srf:
1570         ttm_mem_global_free(vmw_mem_glob(dev_priv), user_accounting_size);
1571
1572 out_unlock:
1573         ttm_read_unlock(&dev_priv->reservation_sem);
1574         return ret;
1575 }