drivers/gpu/drm/vmwgfx/vmwgfx_bo.c

   1 // SPDX-License-Identifier: GPL-2.0 OR MIT
   2 /**************************************************************************
   3  *
   4  * Copyright © 2011-2018 VMware, Inc., Palo Alto, CA., USA
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  22  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  23  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  24  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  25  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29 #include <drm/ttm/ttm_placement.h>
  30
  31 #include <drm/drmP.h>
  32 #include "vmwgfx_drv.h"
  33 #include "drm/ttm/ttm_object.h"
  34
  35
  36 /**
  37  * struct vmw_user_buffer_object - User-space-visible buffer object
  38  *
  39  * @prime: The prime object providing user visibility.
  40  * @vbo: The struct vmw_buffer_object
  41  */
  42 struct vmw_user_buffer_object {
  43         struct ttm_prime_object prime;
  44         struct vmw_buffer_object vbo;
  45 };
  46
  47
  48 /**
  49  * vmw_buffer_object - Convert a struct ttm_buffer_object to a struct
  50  * vmw_buffer_object.
  51  *
  52  * @bo: Pointer to the TTM buffer object.
  53  * Return: Pointer to the struct vmw_buffer_object embedding the
  54  * TTM buffer object.
  55  */
  56 static struct vmw_buffer_object *
  57 vmw_buffer_object(struct ttm_buffer_object *bo)
  58 {
  59         return container_of(bo, struct vmw_buffer_object, base);
  60 }
  61
  62
  63 /**
  64  * vmw_user_buffer_object - Convert a struct ttm_buffer_object to a struct
  65  * vmw_user_buffer_object.
  66  *
  67  * @bo: Pointer to the TTM buffer object.
  68  * Return: Pointer to the struct vmw_buffer_object embedding the TTM buffer
  69  * object.
  70  */
  71 static struct vmw_user_buffer_object *
  72 vmw_user_buffer_object(struct ttm_buffer_object *bo)
  73 {
  74         struct vmw_buffer_object *vmw_bo = vmw_buffer_object(bo);
  75
  76         return container_of(vmw_bo, struct vmw_user_buffer_object, vbo);
  77 }
  78
  79
  80 /**
  81  * vmw_bo_pin_in_placement - Validate a buffer to placement.
  82  *
  83  * @dev_priv:  Driver private.
  84  * @buf:  DMA buffer to move.
  85  * @placement:  The placement to pin it.
  86  * @interruptible:  Use interruptible wait.
  87  * Return: Zero on success, Negative error code on failure. In particular
  88  * -ERESTARTSYS if interrupted by a signal
  89  */
  90 int vmw_bo_pin_in_placement(struct vmw_private *dev_priv,
  91                             struct vmw_buffer_object *buf,
  92                             struct ttm_placement *placement,
  93                             bool interruptible)
  94 {
  95         struct ttm_operation_ctx ctx = {interruptible, false };
  96         struct ttm_buffer_object *bo = &buf->base;
  97         int ret;
  98         uint32_t new_flags;
  99
 100         ret = ttm_write_lock(&dev_priv->reservation_sem, interruptible);
 101         if (unlikely(ret != 0))
 102                 return ret;
 103
 104         vmw_execbuf_release_pinned_bo(dev_priv);
 105
 106         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 107         if (unlikely(ret != 0))
 108                 goto err;
 109
 110         if (buf->pin_count > 0)
 111                 ret = ttm_bo_mem_compat(placement, &bo->mem,
 112                                         &new_flags) == true ? 0 : -EINVAL;
 113         else
 114                 ret = ttm_bo_validate(bo, placement, &ctx);
 115
 116         if (!ret)
 117                 vmw_bo_pin_reserved(buf, true);
 118
 119         ttm_bo_unreserve(bo);
 120
 121 err:
 122         ttm_write_unlock(&dev_priv->reservation_sem);
 123         return ret;
 124 }
 125
 126
 127 /**
 128  * vmw_bo_pin_in_vram_or_gmr - Move a buffer to vram or gmr.
 129  *
 130  * This function takes the reservation_sem in write mode.
 131  * Flushes and unpins the query bo to avoid failures.
 132  *
 133  * @dev_priv:  Driver private.
 134  * @buf:  DMA buffer to move.
 135  * @pin:  Pin buffer if true.
 136  * @interruptible:  Use interruptible wait.
 137  * Return: Zero on success, Negative error code on failure. In particular
 138  * -ERESTARTSYS if interrupted by a signal
 139  */
 140 int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
 141                               struct vmw_buffer_object *buf,
 142                               bool interruptible)
 143 {
 144         struct ttm_operation_ctx ctx = {interruptible, false };
 145         struct ttm_buffer_object *bo = &buf->base;
 146         int ret;
 147         uint32_t new_flags;
 148
 149         ret = ttm_write_lock(&dev_priv->reservation_sem, interruptible);
 150         if (unlikely(ret != 0))
 151                 return ret;
 152
 153         vmw_execbuf_release_pinned_bo(dev_priv);
 154
 155         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 156         if (unlikely(ret != 0))
 157                 goto err;
 158
 159         if (buf->pin_count > 0) {
 160                 ret = ttm_bo_mem_compat(&vmw_vram_gmr_placement, &bo->mem,
 161                                         &new_flags) == true ? 0 : -EINVAL;
 162                 goto out_unreserve;
 163         }
 164
 165         ret = ttm_bo_validate(bo, &vmw_vram_gmr_placement, &ctx);
 166         if (likely(ret == 0) || ret == -ERESTARTSYS)
 167                 goto out_unreserve;
 168
 169         ret = ttm_bo_validate(bo, &vmw_vram_placement, &ctx);
 170
 171 out_unreserve:
 172         if (!ret)
 173                 vmw_bo_pin_reserved(buf, true);
 174
 175         ttm_bo_unreserve(bo);
 176 err:
 177         ttm_write_unlock(&dev_priv->reservation_sem);
 178         return ret;
 179 }
 180
 181
 182 /**
 183  * vmw_bo_pin_in_vram - Move a buffer to vram.
 184  *
 185  * This function takes the reservation_sem in write mode.
 186  * Flushes and unpins the query bo to avoid failures.
 187  *
 188  * @dev_priv:  Driver private.
 189  * @buf:  DMA buffer to move.
 190  * @interruptible:  Use interruptible wait.
 191  * Return: Zero on success, Negative error code on failure. In particular
 192  * -ERESTARTSYS if interrupted by a signal
 193  */
 194 int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
 195                        struct vmw_buffer_object *buf,
 196                        bool interruptible)
 197 {
 198         return vmw_bo_pin_in_placement(dev_priv, buf, &vmw_vram_placement,
 199                                        interruptible);
 200 }
 201
 202
 203 /**
 204  * vmw_bo_pin_in_start_of_vram - Move a buffer to start of vram.
 205  *
 206  * This function takes the reservation_sem in write mode.
 207  * Flushes and unpins the query bo to avoid failures.
 208  *
 209  * @dev_priv:  Driver private.
 210  * @buf:  DMA buffer to pin.
 211  * @interruptible:  Use interruptible wait.
 212  * Return: Zero on success, Negative error code on failure. In particular
 213  * -ERESTARTSYS if interrupted by a signal
 214  */
 215 int vmw_bo_pin_in_start_of_vram(struct vmw_private *dev_priv,
 216                                 struct vmw_buffer_object *buf,
 217                                 bool interruptible)
 218 {
 219         struct ttm_operation_ctx ctx = {interruptible, false };
 220         struct ttm_buffer_object *bo = &buf->base;
 221         struct ttm_placement placement;
 222         struct ttm_place place;
 223         int ret = 0;
 224         uint32_t new_flags;
 225
 226         place = vmw_vram_placement.placement[0];
 227         place.lpfn = bo->num_pages;
 228         placement.num_placement = 1;
 229         placement.placement = &place;
 230         placement.num_busy_placement = 1;
 231         placement.busy_placement = &place;
 232
 233         ret = ttm_write_lock(&dev_priv->reservation_sem, interruptible);
 234         if (unlikely(ret != 0))
 235                 return ret;
 236
 237         vmw_execbuf_release_pinned_bo(dev_priv);
 238         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 239         if (unlikely(ret != 0))
 240                 goto err_unlock;
 241
 242         /*
 243          * Is this buffer already in vram but not at the start of it?
 244          * In that case, evict it first because TTM isn't good at handling
 245          * that situation.
 246          */
 247         if (bo->mem.mem_type == TTM_PL_VRAM &&
 248             bo->mem.start < bo->num_pages &&
 249             bo->mem.start > 0 &&
 250             buf->pin_count == 0) {
 251                 ctx.interruptible = false;
 252                 (void) ttm_bo_validate(bo, &vmw_sys_placement, &ctx);
 253         }
 254
 255         if (buf->pin_count > 0)
 256                 ret = ttm_bo_mem_compat(&placement, &bo->mem,
 257                                         &new_flags) == true ? 0 : -EINVAL;
 258         else
 259                 ret = ttm_bo_validate(bo, &placement, &ctx);
 260
 261         /* For some reason we didn't end up at the start of vram */
 262         WARN_ON(ret == 0 && bo->offset != 0);
 263         if (!ret)
 264                 vmw_bo_pin_reserved(buf, true);
 265
 266         ttm_bo_unreserve(bo);
 267 err_unlock:
 268         ttm_write_unlock(&dev_priv->reservation_sem);
 269
 270         return ret;
 271 }
 272
 273
 274 /**
 275  * vmw_bo_unpin - Unpin the buffer given buffer, does not move the buffer.
 276  *
 277  * This function takes the reservation_sem in write mode.
 278  *
 279  * @dev_priv:  Driver private.
 280  * @buf:  DMA buffer to unpin.
 281  * @interruptible:  Use interruptible wait.
 282  * Return: Zero on success, Negative error code on failure. In particular
 283  * -ERESTARTSYS if interrupted by a signal
 284  */
 285 int vmw_bo_unpin(struct vmw_private *dev_priv,
 286                  struct vmw_buffer_object *buf,
 287                  bool interruptible)
 288 {
 289         struct ttm_buffer_object *bo = &buf->base;
 290         int ret;
 291
 292         ret = ttm_read_lock(&dev_priv->reservation_sem, interruptible);
 293         if (unlikely(ret != 0))
 294                 return ret;
 295
 296         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 297         if (unlikely(ret != 0))
 298                 goto err;
 299
 300         vmw_bo_pin_reserved(buf, false);
 301
 302         ttm_bo_unreserve(bo);
 303
 304 err:
 305         ttm_read_unlock(&dev_priv->reservation_sem);
 306         return ret;
 307 }
 308
 309 /**
 310  * vmw_bo_get_guest_ptr - Get the guest ptr representing the current placement
 311  * of a buffer.
 312  *
 313  * @bo: Pointer to a struct ttm_buffer_object. Must be pinned or reserved.
 314  * @ptr: SVGAGuestPtr returning the result.
 315  */
 316 void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *bo,
 317                           SVGAGuestPtr *ptr)
 318 {
 319         if (bo->mem.mem_type == TTM_PL_VRAM) {
 320                 ptr->gmrId = SVGA_GMR_FRAMEBUFFER;
 321                 ptr->offset = bo->offset;
 322         } else {
 323                 ptr->gmrId = bo->mem.start;
 324                 ptr->offset = 0;
 325         }
 326 }
 327
 328
 329 /**
 330  * vmw_bo_pin_reserved - Pin or unpin a buffer object without moving it.
 331  *
 332  * @vbo: The buffer object. Must be reserved.
 333  * @pin: Whether to pin or unpin.
 334  *
 335  */
 336 void vmw_bo_pin_reserved(struct vmw_buffer_object *vbo, bool pin)
 337 {
 338         struct ttm_operation_ctx ctx = { false, true };
 339         struct ttm_place pl;
 340         struct ttm_placement placement;
 341         struct ttm_buffer_object *bo = &vbo->base;
 342         uint32_t old_mem_type = bo->mem.mem_type;
 343         int ret;
 344
 345         lockdep_assert_held(&bo->resv->lock.base);
 346
 347         if (pin) {
 348                 if (vbo->pin_count++ > 0)
 349                         return;
 350         } else {
 351                 WARN_ON(vbo->pin_count <= 0);
 352                 if (--vbo->pin_count > 0)
 353                         return;
 354         }
 355
 356         pl.fpfn = 0;
 357         pl.lpfn = 0;
 358         pl.flags = TTM_PL_FLAG_VRAM | VMW_PL_FLAG_GMR | VMW_PL_FLAG_MOB
 359                 | TTM_PL_FLAG_SYSTEM | TTM_PL_FLAG_CACHED;
 360         if (pin)
 361                 pl.flags |= TTM_PL_FLAG_NO_EVICT;
 362
 363         memset(&placement, 0, sizeof(placement));
 364         placement.num_placement = 1;
 365         placement.placement = &pl;
 366
 367         ret = ttm_bo_validate(bo, &placement, &ctx);
 368
 369         BUG_ON(ret != 0 || bo->mem.mem_type != old_mem_type);
 370 }
 371
 372
 373 /**
 374  * vmw_bo_map_and_cache - Map a buffer object and cache the map
 375  *
 376  * @vbo: The buffer object to map
 377  * Return: A kernel virtual address or NULL if mapping failed.
 378  *
 379  * This function maps a buffer object into the kernel address space, or
 380  * returns the virtual kernel address of an already existing map. The virtual
 381  * address remains valid as long as the buffer object is pinned or reserved.
 382  * The cached map is torn down on either
 383  * 1) Buffer object move
 384  * 2) Buffer object swapout
 385  * 3) Buffer object destruction
 386  *
 387  */
 388 void *vmw_bo_map_and_cache(struct vmw_buffer_object *vbo)
 389 {
 390         struct ttm_buffer_object *bo = &vbo->base;
 391         bool not_used;
 392         void *virtual;
 393         int ret;
 394
 395         virtual = ttm_kmap_obj_virtual(&vbo->map, &not_used);
 396         if (virtual)
 397                 return virtual;
 398
 399         ret = ttm_bo_kmap(bo, 0, bo->num_pages, &vbo->map);
 400         if (ret)
 401                 DRM_ERROR("Buffer object map failed: %d.\n", ret);
 402
 403         return ttm_kmap_obj_virtual(&vbo->map, &not_used);
 404 }
 405
 406
 407 /**
 408  * vmw_bo_unmap - Tear down a cached buffer object map.
 409  *
 410  * @vbo: The buffer object whose map we are tearing down.
 411  *
 412  * This function tears down a cached map set up using
 413  * vmw_buffer_object_map_and_cache().
 414  */
 415 void vmw_bo_unmap(struct vmw_buffer_object *vbo)
 416 {
 417         if (vbo->map.bo == NULL)
 418                 return;
 419
 420         ttm_bo_kunmap(&vbo->map);
 421 }
 422
 423
 424 /**
 425  * vmw_bo_acc_size - Calculate the pinned memory usage of buffers
 426  *
 427  * @dev_priv: Pointer to a struct vmw_private identifying the device.
 428  * @size: The requested buffer size.
 429  * @user: Whether this is an ordinary dma buffer or a user dma buffer.
 430  */
 431 static size_t vmw_bo_acc_size(struct vmw_private *dev_priv, size_t size,
 432                               bool user)
 433 {
 434         static size_t struct_size, user_struct_size;
 435         size_t num_pages = PAGE_ALIGN(size) >> PAGE_SHIFT;
 436         size_t page_array_size = ttm_round_pot(num_pages * sizeof(void *));
 437
 438         if (unlikely(struct_size == 0)) {
 439                 size_t backend_size = ttm_round_pot(vmw_tt_size);
 440
 441                 struct_size = backend_size +
 442                         ttm_round_pot(sizeof(struct vmw_buffer_object));
 443                 user_struct_size = backend_size +
 444                         ttm_round_pot(sizeof(struct vmw_user_buffer_object));
 445         }
 446
 447         if (dev_priv->map_mode == vmw_dma_alloc_coherent)
 448                 page_array_size +=
 449                         ttm_round_pot(num_pages * sizeof(dma_addr_t));
 450
 451         return ((user) ? user_struct_size : struct_size) +
 452                 page_array_size;
 453 }
 454
 455
 456 /**
 457  * vmw_bo_bo_free - vmw buffer object destructor
 458  *
 459  * @bo: Pointer to the embedded struct ttm_buffer_object
 460  */
 461 void vmw_bo_bo_free(struct ttm_buffer_object *bo)
 462 {
 463         struct vmw_buffer_object *vmw_bo = vmw_buffer_object(bo);
 464
 465         vmw_bo_unmap(vmw_bo);
 466         kfree(vmw_bo);
 467 }
 468
 469
 470 /**
 471  * vmw_user_bo_destroy - vmw buffer object destructor
 472  *
 473  * @bo: Pointer to the embedded struct ttm_buffer_object
 474  */
 475 static void vmw_user_bo_destroy(struct ttm_buffer_object *bo)
 476 {
 477         struct vmw_user_buffer_object *vmw_user_bo = vmw_user_buffer_object(bo);
 478
 479         vmw_bo_unmap(&vmw_user_bo->vbo);
 480         ttm_prime_object_kfree(vmw_user_bo, prime);
 481 }
 482
 483
 484 /**
 485  * vmw_bo_init - Initialize a vmw buffer object
 486  *
 487  * @dev_priv: Pointer to the device private struct
 488  * @vmw_bo: Pointer to the struct vmw_buffer_object to initialize.
 489  * @size: Buffer object size in bytes.
 490  * @placement: Initial placement.
 491  * @interruptible: Whether waits should be performed interruptible.
 492  * @bo_free: The buffer object destructor.
 493  * Returns: Zero on success, negative error code on error.
 494  *
 495  * Note that on error, the code will free the buffer object.
 496  */
 497 int vmw_bo_init(struct vmw_private *dev_priv,
 498                 struct vmw_buffer_object *vmw_bo,
 499                 size_t size, struct ttm_placement *placement,
 500                 bool interruptible,
 501                 void (*bo_free)(struct ttm_buffer_object *bo))
 502 {
 503         struct ttm_bo_device *bdev = &dev_priv->bdev;
 504         size_t acc_size;
 505         int ret;
 506         bool user = (bo_free == &vmw_user_bo_destroy);
 507
 508         WARN_ON_ONCE(!bo_free && (!user && (bo_free != vmw_bo_bo_free)));
 509
 510         acc_size = vmw_bo_acc_size(dev_priv, size, user);
 511         memset(vmw_bo, 0, sizeof(*vmw_bo));
 512
 513         INIT_LIST_HEAD(&vmw_bo->res_list);
 514
 515         ret = ttm_bo_init(bdev, &vmw_bo->base, size,
 516                           ttm_bo_type_device, placement,
 517                           0, interruptible, acc_size,
 518                           NULL, NULL, bo_free);
 519         return ret;
 520 }
 521
 522
 523 /**
 524  * vmw_user_bo_release - TTM reference base object release callback for
 525  * vmw user buffer objects
 526  *
 527  * @p_base: The TTM base object pointer about to be unreferenced.
 528  *
 529  * Clears the TTM base object pointer and drops the reference the
 530  * base object has on the underlying struct vmw_buffer_object.
 531  */
 532 static void vmw_user_bo_release(struct ttm_base_object **p_base)
 533 {
 534         struct vmw_user_buffer_object *vmw_user_bo;
 535         struct ttm_base_object *base = *p_base;
 536         struct ttm_buffer_object *bo;
 537
 538         *p_base = NULL;
 539
 540         if (unlikely(base == NULL))
 541                 return;
 542
 543         vmw_user_bo = container_of(base, struct vmw_user_buffer_object,
 544                                    prime.base);
 545         bo = &vmw_user_bo->vbo.base;
 546         ttm_bo_unref(&bo);
 547 }
 548
 549
 550 /**
 551  * vmw_user_bo_ref_obj-release - TTM synccpu reference object release callback
 552  * for vmw user buffer objects
 553  *
 554  * @base: Pointer to the TTM base object
 555  * @ref_type: Reference type of the reference reaching zero.
 556  *
 557  * Called when user-space drops its last synccpu reference on the buffer
 558  * object, Either explicitly or as part of a cleanup file close.
 559  */
 560 static void vmw_user_bo_ref_obj_release(struct ttm_base_object *base,
 561                                         enum ttm_ref_type ref_type)
 562 {
 563         struct vmw_user_buffer_object *user_bo;
 564
 565         user_bo = container_of(base, struct vmw_user_buffer_object, prime.base);
 566
 567         switch (ref_type) {
 568         case TTM_REF_SYNCCPU_WRITE:
 569                 ttm_bo_synccpu_write_release(&user_bo->vbo.base);
 570                 break;
 571         default:
 572                 WARN_ONCE(true, "Undefined buffer object reference release.\n");
 573         }
 574 }
 575
 576
 577 /**
 578  * vmw_user_bo_alloc - Allocate a user buffer object
 579  *
 580  * @dev_priv: Pointer to a struct device private.
 581  * @tfile: Pointer to a struct ttm_object_file on which to register the user
 582  * object.
 583  * @size: Size of the buffer object.
 584  * @shareable: Boolean whether the buffer is shareable with other open files.
 585  * @handle: Pointer to where the handle value should be assigned.
 586  * @p_vbo: Pointer to where the refcounted struct vmw_buffer_object pointer
 587  * should be assigned.
 588  * Return: Zero on success, negative error code on error.
 589  */
 590 int vmw_user_bo_alloc(struct vmw_private *dev_priv,
 591                       struct ttm_object_file *tfile,
 592                       uint32_t size,
 593                       bool shareable,
 594                       uint32_t *handle,
 595                       struct vmw_buffer_object **p_vbo,
 596                       struct ttm_base_object **p_base)
 597 {
 598         struct vmw_user_buffer_object *user_bo;
 599         struct ttm_buffer_object *tmp;
 600         int ret;
 601
 602         user_bo = kzalloc(sizeof(*user_bo), GFP_KERNEL);
 603         if (unlikely(!user_bo)) {
 604                 DRM_ERROR("Failed to allocate a buffer.\n");
 605                 return -ENOMEM;
 606         }
 607
 608         ret = vmw_bo_init(dev_priv, &user_bo->vbo, size,
 609                           (dev_priv->has_mob) ?
 610                           &vmw_sys_placement :
 611                           &vmw_vram_sys_placement, true,
 612                           &vmw_user_bo_destroy);
 613         if (unlikely(ret != 0))
 614                 return ret;
 615
 616         tmp = ttm_bo_reference(&user_bo->vbo.base);
 617         ret = ttm_prime_object_init(tfile,
 618                                     size,
 619                                     &user_bo->prime,
 620                                     shareable,
 621                                     ttm_buffer_type,
 622                                     &vmw_user_bo_release,
 623                                     &vmw_user_bo_ref_obj_release);
 624         if (unlikely(ret != 0)) {
 625                 ttm_bo_unref(&tmp);
 626                 goto out_no_base_object;
 627         }
 628
 629         *p_vbo = &user_bo->vbo;
 630         if (p_base) {
 631                 *p_base = &user_bo->prime.base;
 632                 kref_get(&(*p_base)->refcount);
 633         }
 634         *handle = user_bo->prime.base.hash.key;
 635
 636 out_no_base_object:
 637         return ret;
 638 }
 639
 640
 641 /**
 642  * vmw_user_bo_verify_access - verify access permissions on this
 643  * buffer object.
 644  *
 645  * @bo: Pointer to the buffer object being accessed
 646  * @tfile: Identifying the caller.
 647  */
 648 int vmw_user_bo_verify_access(struct ttm_buffer_object *bo,
 649                               struct ttm_object_file *tfile)
 650 {
 651         struct vmw_user_buffer_object *vmw_user_bo;
 652
 653         if (unlikely(bo->destroy != vmw_user_bo_destroy))
 654                 return -EPERM;
 655
 656         vmw_user_bo = vmw_user_buffer_object(bo);
 657
 658         /* Check that the caller has opened the object. */
 659         if (likely(ttm_ref_object_exists(tfile, &vmw_user_bo->prime.base)))
 660                 return 0;
 661
 662         DRM_ERROR("Could not grant buffer access.\n");
 663         return -EPERM;
 664 }
 665
 666
 667 /**
 668  * vmw_user_bo_synccpu_grab - Grab a struct vmw_user_buffer_object for cpu
 669  * access, idling previous GPU operations on the buffer and optionally
 670  * blocking it for further command submissions.
 671  *
 672  * @user_bo: Pointer to the buffer object being grabbed for CPU access
 673  * @tfile: Identifying the caller.
 674  * @flags: Flags indicating how the grab should be performed.
 675  * Return: Zero on success, Negative error code on error. In particular,
 676  * -EBUSY will be returned if a dontblock operation is requested and the
 677  * buffer object is busy, and -ERESTARTSYS will be returned if a wait is
 678  * interrupted by a signal.
 679  *
 680  * A blocking grab will be automatically released when @tfile is closed.
 681  */
 682 static int vmw_user_bo_synccpu_grab(struct vmw_user_buffer_object *user_bo,
 683                                     struct ttm_object_file *tfile,
 684                                     uint32_t flags)
 685 {
 686         struct ttm_buffer_object *bo = &user_bo->vbo.base;
 687         bool existed;
 688         int ret;
 689
 690         if (flags & drm_vmw_synccpu_allow_cs) {
 691                 bool nonblock = !!(flags & drm_vmw_synccpu_dontblock);
 692                 long lret;
 693
 694                 lret = reservation_object_wait_timeout_rcu
 695                         (bo->resv, true, true,
 696                          nonblock ? 0 : MAX_SCHEDULE_TIMEOUT);
 697                 if (!lret)
 698                         return -EBUSY;
 699                 else if (lret < 0)
 700                         return lret;
 701                 return 0;
 702         }
 703
 704         ret = ttm_bo_synccpu_write_grab
 705                 (bo, !!(flags & drm_vmw_synccpu_dontblock));
 706         if (unlikely(ret != 0))
 707                 return ret;
 708
 709         ret = ttm_ref_object_add(tfile, &user_bo->prime.base,
 710                                  TTM_REF_SYNCCPU_WRITE, &existed, false);
 711         if (ret != 0 || existed)
 712                 ttm_bo_synccpu_write_release(&user_bo->vbo.base);
 713
 714         return ret;
 715 }
 716
 717 /**
 718  * vmw_user_bo_synccpu_release - Release a previous grab for CPU access,
 719  * and unblock command submission on the buffer if blocked.
 720  *
 721  * @handle: Handle identifying the buffer object.
 722  * @tfile: Identifying the caller.
 723  * @flags: Flags indicating the type of release.
 724  */
 725 static int vmw_user_bo_synccpu_release(uint32_t handle,
 726                                            struct ttm_object_file *tfile,
 727                                            uint32_t flags)
 728 {
 729         if (!(flags & drm_vmw_synccpu_allow_cs))
 730                 return ttm_ref_object_base_unref(tfile, handle,
 731                                                  TTM_REF_SYNCCPU_WRITE);
 732
 733         return 0;
 734 }
 735
 736
 737 /**
 738  * vmw_user_bo_synccpu_ioctl - ioctl function implementing the synccpu
 739  * functionality.
 740  *
 741  * @dev: Identifies the drm device.
 742  * @data: Pointer to the ioctl argument.
 743  * @file_priv: Identifies the caller.
 744  * Return: Zero on success, negative error code on error.
 745  *
 746  * This function checks the ioctl arguments for validity and calls the
 747  * relevant synccpu functions.
 748  */
 749 int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
 750                               struct drm_file *file_priv)
 751 {
 752         struct drm_vmw_synccpu_arg *arg =
 753                 (struct drm_vmw_synccpu_arg *) data;
 754         struct vmw_buffer_object *vbo;
 755         struct vmw_user_buffer_object *user_bo;
 756         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
 757         struct ttm_base_object *buffer_base;
 758         int ret;
 759
 760         if ((arg->flags & (drm_vmw_synccpu_read | drm_vmw_synccpu_write)) == 0
 761             || (arg->flags & ~(drm_vmw_synccpu_read | drm_vmw_synccpu_write |
 762                                drm_vmw_synccpu_dontblock |
 763                                drm_vmw_synccpu_allow_cs)) != 0) {
 764                 DRM_ERROR("Illegal synccpu flags.\n");
 765                 return -EINVAL;
 766         }
 767
 768         switch (arg->op) {
 769         case drm_vmw_synccpu_grab:
 770                 ret = vmw_user_bo_lookup(tfile, arg->handle, &vbo,
 771                                              &buffer_base);
 772                 if (unlikely(ret != 0))
 773                         return ret;
 774
 775                 user_bo = container_of(vbo, struct vmw_user_buffer_object,
 776                                        vbo);
 777                 ret = vmw_user_bo_synccpu_grab(user_bo, tfile, arg->flags);
 778                 vmw_bo_unreference(&vbo);
 779                 ttm_base_object_unref(&buffer_base);
 780                 if (unlikely(ret != 0 && ret != -ERESTARTSYS &&
 781                              ret != -EBUSY)) {
 782                         DRM_ERROR("Failed synccpu grab on handle 0x%08x.\n",
 783                                   (unsigned int) arg->handle);
 784                         return ret;
 785                 }
 786                 break;
 787         case drm_vmw_synccpu_release:
 788                 ret = vmw_user_bo_synccpu_release(arg->handle, tfile,
 789                                                   arg->flags);
 790                 if (unlikely(ret != 0)) {
 791                         DRM_ERROR("Failed synccpu release on handle 0x%08x.\n",
 792                                   (unsigned int) arg->handle);
 793                         return ret;
 794                 }
 795                 break;
 796         default:
 797                 DRM_ERROR("Invalid synccpu operation.\n");
 798                 return -EINVAL;
 799         }
 800
 801         return 0;
 802 }
 803
 804
 805 /**
 806  * vmw_bo_alloc_ioctl - ioctl function implementing the buffer object
 807  * allocation functionality.
 808  *
 809  * @dev: Identifies the drm device.
 810  * @data: Pointer to the ioctl argument.
 811  * @file_priv: Identifies the caller.
 812  * Return: Zero on success, negative error code on error.
 813  *
 814  * This function checks the ioctl arguments for validity and allocates a
 815  * struct vmw_user_buffer_object bo.
 816  */
 817 int vmw_bo_alloc_ioctl(struct drm_device *dev, void *data,
 818                        struct drm_file *file_priv)
 819 {
 820         struct vmw_private *dev_priv = vmw_priv(dev);
 821         union drm_vmw_alloc_dmabuf_arg *arg =
 822             (union drm_vmw_alloc_dmabuf_arg *)data;
 823         struct drm_vmw_alloc_dmabuf_req *req = &arg->req;
 824         struct drm_vmw_dmabuf_rep *rep = &arg->rep;
 825         struct vmw_buffer_object *vbo;
 826         uint32_t handle;
 827         int ret;
 828
 829         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
 830         if (unlikely(ret != 0))
 831                 return ret;
 832
 833         ret = vmw_user_bo_alloc(dev_priv, vmw_fpriv(file_priv)->tfile,
 834                                 req->size, false, &handle, &vbo,
 835                                 NULL);
 836         if (unlikely(ret != 0))
 837                 goto out_no_bo;
 838
 839         rep->handle = handle;
 840         rep->map_handle = drm_vma_node_offset_addr(&vbo->base.vma_node);
 841         rep->cur_gmr_id = handle;
 842         rep->cur_gmr_offset = 0;
 843
 844         vmw_bo_unreference(&vbo);
 845
 846 out_no_bo:
 847         ttm_read_unlock(&dev_priv->reservation_sem);
 848
 849         return ret;
 850 }
 851
 852
 853 /**
 854  * vmw_bo_unref_ioctl - Generic handle close ioctl.
 855  *
 856  * @dev: Identifies the drm device.
 857  * @data: Pointer to the ioctl argument.
 858  * @file_priv: Identifies the caller.
 859  * Return: Zero on success, negative error code on error.
 860  *
 861  * This function checks the ioctl arguments for validity and closes a
 862  * handle to a TTM base object, optionally freeing the object.
 863  */
 864 int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
 865                        struct drm_file *file_priv)
 866 {
 867         struct drm_vmw_unref_dmabuf_arg *arg =
 868             (struct drm_vmw_unref_dmabuf_arg *)data;
 869
 870         return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
 871                                          arg->handle,
 872                                          TTM_REF_USAGE);
 873 }
 874
 875
 876 /**
 877  * vmw_user_bo_lookup - Look up a vmw user buffer object from a handle.
 878  *
 879  * @tfile: The TTM object file the handle is registered with.
 880  * @handle: The user buffer object handle
 881  * @out: Pointer to a where a pointer to the embedded
 882  * struct vmw_buffer_object should be placed.
 883  * @p_base: Pointer to where a pointer to the TTM base object should be
 884  * placed, or NULL if no such pointer is required.
 885  * Return: Zero on success, Negative error code on error.
 886  *
 887  * Both the output base object pointer and the vmw buffer object pointer
 888  * will be refcounted.
 889  */
 890 int vmw_user_bo_lookup(struct ttm_object_file *tfile,
 891                        uint32_t handle, struct vmw_buffer_object **out,
 892                        struct ttm_base_object **p_base)
 893 {
 894         struct vmw_user_buffer_object *vmw_user_bo;
 895         struct ttm_base_object *base;
 896
 897         base = ttm_base_object_lookup(tfile, handle);
 898         if (unlikely(base == NULL)) {
 899                 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
 900                           (unsigned long)handle);
 901                 return -ESRCH;
 902         }
 903
 904         if (unlikely(ttm_base_object_type(base) != ttm_buffer_type)) {
 905                 ttm_base_object_unref(&base);
 906                 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
 907                           (unsigned long)handle);
 908                 return -EINVAL;
 909         }
 910
 911         vmw_user_bo = container_of(base, struct vmw_user_buffer_object,
 912                                    prime.base);
 913         (void)ttm_bo_reference(&vmw_user_bo->vbo.base);
 914         if (p_base)
 915                 *p_base = base;
 916         else
 917                 ttm_base_object_unref(&base);
 918         *out = &vmw_user_bo->vbo;
 919
 920         return 0;
 921 }
 922
 923
 924 /**
 925  * vmw_user_bo_reference - Open a handle to a vmw user buffer object.
 926  *
 927  * @tfile: The TTM object file to register the handle with.
 928  * @vbo: The embedded vmw buffer object.
 929  * @handle: Pointer to where the new handle should be placed.
 930  * Return: Zero on success, Negative error code on error.
 931  */
 932 int vmw_user_bo_reference(struct ttm_object_file *tfile,
 933                           struct vmw_buffer_object *vbo,
 934                           uint32_t *handle)
 935 {
 936         struct vmw_user_buffer_object *user_bo;
 937
 938         if (vbo->base.destroy != vmw_user_bo_destroy)
 939                 return -EINVAL;
 940
 941         user_bo = container_of(vbo, struct vmw_user_buffer_object, vbo);
 942
 943         *handle = user_bo->prime.base.hash.key;
 944         return ttm_ref_object_add(tfile, &user_bo->prime.base,
 945                                   TTM_REF_USAGE, NULL, false);
 946 }
 947
 948
 949 /**
 950  * vmw_bo_fence_single - Utility function to fence a single TTM buffer
 951  *                       object without unreserving it.
 952  *
 953  * @bo:             Pointer to the struct ttm_buffer_object to fence.
 954  * @fence:          Pointer to the fence. If NULL, this function will
 955  *                  insert a fence into the command stream..
 956  *
 957  * Contrary to the ttm_eu version of this function, it takes only
 958  * a single buffer object instead of a list, and it also doesn't
 959  * unreserve the buffer object, which needs to be done separately.
 960  */
 961 void vmw_bo_fence_single(struct ttm_buffer_object *bo,
 962                          struct vmw_fence_obj *fence)
 963 {
 964         struct ttm_bo_device *bdev = bo->bdev;
 965
 966         struct vmw_private *dev_priv =
 967                 container_of(bdev, struct vmw_private, bdev);
 968
 969         if (fence == NULL) {
 970                 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
 971                 reservation_object_add_excl_fence(bo->resv, &fence->base);
 972                 dma_fence_put(&fence->base);
 973         } else
 974                 reservation_object_add_excl_fence(bo->resv, &fence->base);
 975 }
 976
 977
 978 /**
 979  * vmw_dumb_create - Create a dumb kms buffer
 980  *
 981  * @file_priv: Pointer to a struct drm_file identifying the caller.
 982  * @dev: Pointer to the drm device.
 983  * @args: Pointer to a struct drm_mode_create_dumb structure
 984  * Return: Zero on success, negative error code on failure.
 985  *
 986  * This is a driver callback for the core drm create_dumb functionality.
 987  * Note that this is very similar to the vmw_bo_alloc ioctl, except
 988  * that the arguments have a different format.
 989  */
 990 int vmw_dumb_create(struct drm_file *file_priv,
 991                     struct drm_device *dev,
 992                     struct drm_mode_create_dumb *args)
 993 {
 994         struct vmw_private *dev_priv = vmw_priv(dev);
 995         struct vmw_buffer_object *vbo;
 996         int ret;
 997
 998         args->pitch = args->width * ((args->bpp + 7) / 8);
 999         args->size = args->pitch * args->height;
1000
1001         ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1002         if (unlikely(ret != 0))
1003                 return ret;
1004
1005         ret = vmw_user_bo_alloc(dev_priv, vmw_fpriv(file_priv)->tfile,
1006                                     args->size, false, &args->handle,
1007                                     &vbo, NULL);
1008         if (unlikely(ret != 0))
1009                 goto out_no_bo;
1010
1011         vmw_bo_unreference(&vbo);
1012 out_no_bo:
1013         ttm_read_unlock(&dev_priv->reservation_sem);
1014         return ret;
1015 }
1016
1017
1018 /**
1019  * vmw_dumb_map_offset - Return the address space offset of a dumb buffer
1020  *
1021  * @file_priv: Pointer to a struct drm_file identifying the caller.
1022  * @dev: Pointer to the drm device.
1023  * @handle: Handle identifying the dumb buffer.
1024  * @offset: The address space offset returned.
1025  * Return: Zero on success, negative error code on failure.
1026  *
1027  * This is a driver callback for the core drm dumb_map_offset functionality.
1028  */
1029 int vmw_dumb_map_offset(struct drm_file *file_priv,
1030                         struct drm_device *dev, uint32_t handle,
1031                         uint64_t *offset)
1032 {
1033         struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1034         struct vmw_buffer_object *out_buf;
1035         int ret;
1036
1037         ret = vmw_user_bo_lookup(tfile, handle, &out_buf, NULL);
1038         if (ret != 0)
1039                 return -EINVAL;
1040
1041         *offset = drm_vma_node_offset_addr(&out_buf->base.vma_node);
1042         vmw_bo_unreference(&out_buf);
1043         return 0;
1044 }
1045
1046
1047 /**
1048  * vmw_dumb_destroy - Destroy a dumb boffer
1049  *
1050  * @file_priv: Pointer to a struct drm_file identifying the caller.
1051  * @dev: Pointer to the drm device.
1052  * @handle: Handle identifying the dumb buffer.
1053  * Return: Zero on success, negative error code on failure.
1054  *
1055  * This is a driver callback for the core drm dumb_destroy functionality.
1056  */
1057 int vmw_dumb_destroy(struct drm_file *file_priv,
1058                      struct drm_device *dev,
1059                      uint32_t handle)
1060 {
1061         return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
1062                                          handle, TTM_REF_USAGE);
1063 }
1064
1065
1066 /**
1067  * vmw_bo_swap_notify - swapout notify callback.
1068  *
1069  * @bo: The buffer object to be swapped out.
1070  */
1071 void vmw_bo_swap_notify(struct ttm_buffer_object *bo)
1072 {
1073         /* Is @bo embedded in a struct vmw_buffer_object? */
1074         if (bo->destroy != vmw_bo_bo_free &&
1075             bo->destroy != vmw_user_bo_destroy)
1076                 return;
1077
1078         /* Kill any cached kernel maps before swapout */
1079         vmw_bo_unmap(vmw_buffer_object(bo));
1080 }
1081
1082
1083 /**
1084  * vmw_bo_move_notify - TTM move_notify_callback
1085  *
1086  * @bo: The TTM buffer object about to move.
1087  * @mem: The struct ttm_mem_reg indicating to what memory
1088  *       region the move is taking place.
1089  *
1090  * Detaches cached maps and device bindings that require that the
1091  * buffer doesn't move.
1092  */
1093 void vmw_bo_move_notify(struct ttm_buffer_object *bo,
1094                         struct ttm_mem_reg *mem)
1095 {
1096         struct vmw_buffer_object *vbo;
1097
1098         if (mem == NULL)
1099                 return;
1100
1101         /* Make sure @bo is embedded in a struct vmw_buffer_object? */
1102         if (bo->destroy != vmw_bo_bo_free &&
1103             bo->destroy != vmw_user_bo_destroy)
1104                 return;
1105
1106         vbo = container_of(bo, struct vmw_buffer_object, base);
1107
1108         /*
1109          * Kill any cached kernel maps before move to or from VRAM.
1110          * With other types of moves, the underlying pages stay the same,
1111          * and the map can be kept.
1112          */
1113         if (mem->mem_type == TTM_PL_VRAM || bo->mem.mem_type == TTM_PL_VRAM)
1114                 vmw_bo_unmap(vbo);
1115
1116         /*
1117          * If we're moving a backup MOB out of MOB placement, then make sure we
1118          * read back all resource content first, and unbind the MOB from
1119          * the resource.
1120          */
1121         if (mem->mem_type != VMW_PL_MOB && bo->mem.mem_type == VMW_PL_MOB)
1122                 vmw_resource_unbind_list(vbo);
1123 }