drivers/gpu/drm/amd/amdgpu/amdgpu_object.c

   1 /*
   2  * Copyright 2009 Jerome Glisse.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * The above copyright notice and this permission notice (including the
  22  * next paragraph) shall be included in all copies or substantial portions
  23  * of the Software.
  24  *
  25  */
  26 /*
  27  * Authors:
  28  *    Jerome Glisse <[email protected]>
  29  *    Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
  30  *    Dave Airlie
  31  */
  32 #include <linux/list.h>
  33 #include <linux/slab.h>
  34 #include <linux/dma-buf.h>
  35
  36 #include <drm/amdgpu_drm.h>
  37 #include <drm/drm_cache.h>
  38 #include "amdgpu.h"
  39 #include "amdgpu_trace.h"
  40 #include "amdgpu_amdkfd.h"
  41
  42 /**
  43  * DOC: amdgpu_object
  44  *
  45  * This defines the interfaces to operate on an &amdgpu_bo buffer object which
  46  * represents memory used by driver (VRAM, system memory, etc.). The driver
  47  * provides DRM/GEM APIs to userspace. DRM/GEM APIs then use these interfaces
  48  * to create/destroy/set buffer object which are then managed by the kernel TTM
  49  * memory manager.
  50  * The interfaces are also used internally by kernel clients, including gfx,
  51  * uvd, etc. for kernel managed allocations used by the GPU.
  52  *
  53  */
  54
  55 /**
  56  * amdgpu_bo_subtract_pin_size - Remove BO from pin_size accounting
  57  *
  58  * @bo: &amdgpu_bo buffer object
  59  *
  60  * This function is called when a BO stops being pinned, and updates the
  61  * &amdgpu_device pin_size values accordingly.
  62  */
  63 static void amdgpu_bo_subtract_pin_size(struct amdgpu_bo *bo)
  64 {
  65         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
  66
  67         if (bo->tbo.mem.mem_type == TTM_PL_VRAM) {
  68                 atomic64_sub(amdgpu_bo_size(bo), &adev->vram_pin_size);
  69                 atomic64_sub(amdgpu_vram_mgr_bo_visible_size(bo),
  70                              &adev->visible_pin_size);
  71         } else if (bo->tbo.mem.mem_type == TTM_PL_TT) {
  72                 atomic64_sub(amdgpu_bo_size(bo), &adev->gart_pin_size);
  73         }
  74 }
  75
  76 static void amdgpu_bo_destroy(struct ttm_buffer_object *tbo)
  77 {
  78         struct amdgpu_device *adev = amdgpu_ttm_adev(tbo->bdev);
  79         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  80         struct amdgpu_bo_user *ubo;
  81
  82         if (bo->tbo.pin_count > 0)
  83                 amdgpu_bo_subtract_pin_size(bo);
  84
  85         amdgpu_bo_kunmap(bo);
  86
  87         if (bo->tbo.base.import_attach)
  88                 drm_prime_gem_destroy(&bo->tbo.base, bo->tbo.sg);
  89         drm_gem_object_release(&bo->tbo.base);
  90         /* in case amdgpu_device_recover_vram got NULL of bo->parent */
  91         if (!list_empty(&bo->shadow_list)) {
  92                 mutex_lock(&adev->shadow_list_lock);
  93                 list_del_init(&bo->shadow_list);
  94                 mutex_unlock(&adev->shadow_list_lock);
  95         }
  96         amdgpu_bo_unref(&bo->parent);
  97
  98         if (bo->tbo.type == ttm_bo_type_device) {
  99                 ubo = to_amdgpu_bo_user(bo);
 100                 kfree(ubo->metadata);
 101         }
 102
 103         kfree(bo);
 104 }
 105
 106 /**
 107  * amdgpu_bo_is_amdgpu_bo - check if the buffer object is an &amdgpu_bo
 108  * @bo: buffer object to be checked
 109  *
 110  * Uses destroy function associated with the object to determine if this is
 111  * an &amdgpu_bo.
 112  *
 113  * Returns:
 114  * true if the object belongs to &amdgpu_bo, false if not.
 115  */
 116 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo)
 117 {
 118         if (bo->destroy == &amdgpu_bo_destroy)
 119                 return true;
 120         return false;
 121 }
 122
 123 /**
 124  * amdgpu_bo_placement_from_domain - set buffer's placement
 125  * @abo: &amdgpu_bo buffer object whose placement is to be set
 126  * @domain: requested domain
 127  *
 128  * Sets buffer's placement according to requested domain and the buffer's
 129  * flags.
 130  */
 131 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain)
 132 {
 133         struct amdgpu_device *adev = amdgpu_ttm_adev(abo->tbo.bdev);
 134         struct ttm_placement *placement = &abo->placement;
 135         struct ttm_place *places = abo->placements;
 136         u64 flags = abo->flags;
 137         u32 c = 0;
 138
 139         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 140                 unsigned visible_pfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
 141
 142                 places[c].fpfn = 0;
 143                 places[c].lpfn = 0;
 144                 places[c].mem_type = TTM_PL_VRAM;
 145                 places[c].flags = 0;
 146
 147                 if (flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
 148                         places[c].lpfn = visible_pfn;
 149                 else
 150                         places[c].flags |= TTM_PL_FLAG_TOPDOWN;
 151
 152                 if (flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS)
 153                         places[c].flags |= TTM_PL_FLAG_CONTIGUOUS;
 154                 c++;
 155         }
 156
 157         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 158                 places[c].fpfn = 0;
 159                 places[c].lpfn = 0;
 160                 places[c].mem_type = TTM_PL_TT;
 161                 places[c].flags = 0;
 162                 c++;
 163         }
 164
 165         if (domain & AMDGPU_GEM_DOMAIN_CPU) {
 166                 places[c].fpfn = 0;
 167                 places[c].lpfn = 0;
 168                 places[c].mem_type = TTM_PL_SYSTEM;
 169                 places[c].flags = 0;
 170                 c++;
 171         }
 172
 173         if (domain & AMDGPU_GEM_DOMAIN_GDS) {
 174                 places[c].fpfn = 0;
 175                 places[c].lpfn = 0;
 176                 places[c].mem_type = AMDGPU_PL_GDS;
 177                 places[c].flags = 0;
 178                 c++;
 179         }
 180
 181         if (domain & AMDGPU_GEM_DOMAIN_GWS) {
 182                 places[c].fpfn = 0;
 183                 places[c].lpfn = 0;
 184                 places[c].mem_type = AMDGPU_PL_GWS;
 185                 places[c].flags = 0;
 186                 c++;
 187         }
 188
 189         if (domain & AMDGPU_GEM_DOMAIN_OA) {
 190                 places[c].fpfn = 0;
 191                 places[c].lpfn = 0;
 192                 places[c].mem_type = AMDGPU_PL_OA;
 193                 places[c].flags = 0;
 194                 c++;
 195         }
 196
 197         if (!c) {
 198                 places[c].fpfn = 0;
 199                 places[c].lpfn = 0;
 200                 places[c].mem_type = TTM_PL_SYSTEM;
 201                 places[c].flags = 0;
 202                 c++;
 203         }
 204
 205         BUG_ON(c >= AMDGPU_BO_MAX_PLACEMENTS);
 206
 207         placement->num_placement = c;
 208         placement->placement = places;
 209
 210         placement->num_busy_placement = c;
 211         placement->busy_placement = places;
 212 }
 213
 214 /**
 215  * amdgpu_bo_create_reserved - create reserved BO for kernel use
 216  *
 217  * @adev: amdgpu device object
 218  * @size: size for the new BO
 219  * @align: alignment for the new BO
 220  * @domain: where to place it
 221  * @bo_ptr: used to initialize BOs in structures
 222  * @gpu_addr: GPU addr of the pinned BO
 223  * @cpu_addr: optional CPU address mapping
 224  *
 225  * Allocates and pins a BO for kernel internal use, and returns it still
 226  * reserved.
 227  *
 228  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 229  *
 230  * Returns:
 231  * 0 on success, negative error code otherwise.
 232  */
 233 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 234                               unsigned long size, int align,
 235                               u32 domain, struct amdgpu_bo **bo_ptr,
 236                               u64 *gpu_addr, void **cpu_addr)
 237 {
 238         struct amdgpu_bo_param bp;
 239         bool free = false;
 240         int r;
 241
 242         if (!size) {
 243                 amdgpu_bo_unref(bo_ptr);
 244                 return 0;
 245         }
 246
 247         memset(&bp, 0, sizeof(bp));
 248         bp.size = size;
 249         bp.byte_align = align;
 250         bp.domain = domain;
 251         bp.flags = cpu_addr ? AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED
 252                 : AMDGPU_GEM_CREATE_NO_CPU_ACCESS;
 253         bp.flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 254         bp.type = ttm_bo_type_kernel;
 255         bp.resv = NULL;
 256         bp.bo_ptr_size = sizeof(struct amdgpu_bo);
 257
 258         if (!*bo_ptr) {
 259                 r = amdgpu_bo_create(adev, &bp, bo_ptr);
 260                 if (r) {
 261                         dev_err(adev->dev, "(%d) failed to allocate kernel bo\n",
 262                                 r);
 263                         return r;
 264                 }
 265                 free = true;
 266         }
 267
 268         r = amdgpu_bo_reserve(*bo_ptr, false);
 269         if (r) {
 270                 dev_err(adev->dev, "(%d) failed to reserve kernel bo\n", r);
 271                 goto error_free;
 272         }
 273
 274         r = amdgpu_bo_pin(*bo_ptr, domain);
 275         if (r) {
 276                 dev_err(adev->dev, "(%d) kernel bo pin failed\n", r);
 277                 goto error_unreserve;
 278         }
 279
 280         r = amdgpu_ttm_alloc_gart(&(*bo_ptr)->tbo);
 281         if (r) {
 282                 dev_err(adev->dev, "%p bind failed\n", *bo_ptr);
 283                 goto error_unpin;
 284         }
 285
 286         if (gpu_addr)
 287                 *gpu_addr = amdgpu_bo_gpu_offset(*bo_ptr);
 288
 289         if (cpu_addr) {
 290                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 291                 if (r) {
 292                         dev_err(adev->dev, "(%d) kernel bo map failed\n", r);
 293                         goto error_unpin;
 294                 }
 295         }
 296
 297         return 0;
 298
 299 error_unpin:
 300         amdgpu_bo_unpin(*bo_ptr);
 301 error_unreserve:
 302         amdgpu_bo_unreserve(*bo_ptr);
 303
 304 error_free:
 305         if (free)
 306                 amdgpu_bo_unref(bo_ptr);
 307
 308         return r;
 309 }
 310
 311 /**
 312  * amdgpu_bo_create_kernel - create BO for kernel use
 313  *
 314  * @adev: amdgpu device object
 315  * @size: size for the new BO
 316  * @align: alignment for the new BO
 317  * @domain: where to place it
 318  * @bo_ptr:  used to initialize BOs in structures
 319  * @gpu_addr: GPU addr of the pinned BO
 320  * @cpu_addr: optional CPU address mapping
 321  *
 322  * Allocates and pins a BO for kernel internal use.
 323  *
 324  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 325  *
 326  * Returns:
 327  * 0 on success, negative error code otherwise.
 328  */
 329 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 330                             unsigned long size, int align,
 331                             u32 domain, struct amdgpu_bo **bo_ptr,
 332                             u64 *gpu_addr, void **cpu_addr)
 333 {
 334         int r;
 335
 336         r = amdgpu_bo_create_reserved(adev, size, align, domain, bo_ptr,
 337                                       gpu_addr, cpu_addr);
 338
 339         if (r)
 340                 return r;
 341
 342         if (*bo_ptr)
 343                 amdgpu_bo_unreserve(*bo_ptr);
 344
 345         return 0;
 346 }
 347
 348 /**
 349  * amdgpu_bo_create_kernel_at - create BO for kernel use at specific location
 350  *
 351  * @adev: amdgpu device object
 352  * @offset: offset of the BO
 353  * @size: size of the BO
 354  * @domain: where to place it
 355  * @bo_ptr:  used to initialize BOs in structures
 356  * @cpu_addr: optional CPU address mapping
 357  *
 358  * Creates a kernel BO at a specific offset in the address space of the domain.
 359  *
 360  * Returns:
 361  * 0 on success, negative error code otherwise.
 362  */
 363 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
 364                                uint64_t offset, uint64_t size, uint32_t domain,
 365                                struct amdgpu_bo **bo_ptr, void **cpu_addr)
 366 {
 367         struct ttm_operation_ctx ctx = { false, false };
 368         unsigned int i;
 369         int r;
 370
 371         offset &= PAGE_MASK;
 372         size = ALIGN(size, PAGE_SIZE);
 373
 374         r = amdgpu_bo_create_reserved(adev, size, PAGE_SIZE, domain, bo_ptr,
 375                                       NULL, cpu_addr);
 376         if (r)
 377                 return r;
 378
 379         if ((*bo_ptr) == NULL)
 380                 return 0;
 381
 382         /*
 383          * Remove the original mem node and create a new one at the request
 384          * position.
 385          */
 386         if (cpu_addr)
 387                 amdgpu_bo_kunmap(*bo_ptr);
 388
 389         ttm_resource_free(&(*bo_ptr)->tbo, &(*bo_ptr)->tbo.mem);
 390
 391         for (i = 0; i < (*bo_ptr)->placement.num_placement; ++i) {
 392                 (*bo_ptr)->placements[i].fpfn = offset >> PAGE_SHIFT;
 393                 (*bo_ptr)->placements[i].lpfn = (offset + size) >> PAGE_SHIFT;
 394         }
 395         r = ttm_bo_mem_space(&(*bo_ptr)->tbo, &(*bo_ptr)->placement,
 396                              &(*bo_ptr)->tbo.mem, &ctx);
 397         if (r)
 398                 goto error;
 399
 400         if (cpu_addr) {
 401                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 402                 if (r)
 403                         goto error;
 404         }
 405
 406         amdgpu_bo_unreserve(*bo_ptr);
 407         return 0;
 408
 409 error:
 410         amdgpu_bo_unreserve(*bo_ptr);
 411         amdgpu_bo_unref(bo_ptr);
 412         return r;
 413 }
 414
 415 /**
 416  * amdgpu_bo_free_kernel - free BO for kernel use
 417  *
 418  * @bo: amdgpu BO to free
 419  * @gpu_addr: pointer to where the BO's GPU memory space address was stored
 420  * @cpu_addr: pointer to where the BO's CPU memory space address was stored
 421  *
 422  * unmaps and unpin a BO for kernel internal use.
 423  */
 424 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 425                            void **cpu_addr)
 426 {
 427         if (*bo == NULL)
 428                 return;
 429
 430         if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
 431                 if (cpu_addr)
 432                         amdgpu_bo_kunmap(*bo);
 433
 434                 amdgpu_bo_unpin(*bo);
 435                 amdgpu_bo_unreserve(*bo);
 436         }
 437         amdgpu_bo_unref(bo);
 438
 439         if (gpu_addr)
 440                 *gpu_addr = 0;
 441
 442         if (cpu_addr)
 443                 *cpu_addr = NULL;
 444 }
 445
 446 /* Validate bo size is bit bigger then the request domain */
 447 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
 448                                           unsigned long size, u32 domain)
 449 {
 450         struct ttm_resource_manager *man = NULL;
 451
 452         /*
 453          * If GTT is part of requested domains the check must succeed to
 454          * allow fall back to GTT
 455          */
 456         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 457                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_TT);
 458
 459                 if (size < (man->size << PAGE_SHIFT))
 460                         return true;
 461                 else
 462                         goto fail;
 463         }
 464
 465         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 466                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
 467
 468                 if (size < (man->size << PAGE_SHIFT))
 469                         return true;
 470                 else
 471                         goto fail;
 472         }
 473
 474
 475         /* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
 476         return true;
 477
 478 fail:
 479         DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
 480                   man->size << PAGE_SHIFT);
 481         return false;
 482 }
 483
 484 bool amdgpu_bo_support_uswc(u64 bo_flags)
 485 {
 486
 487 #ifdef CONFIG_X86_32
 488         /* XXX: Write-combined CPU mappings of GTT seem broken on 32-bit
 489          * See https://bugs.freedesktop.org/show_bug.cgi?id=84627
 490          */
 491         return false;
 492 #elif defined(CONFIG_X86) && !defined(CONFIG_X86_PAT)
 493         /* Don't try to enable write-combining when it can't work, or things
 494          * may be slow
 495          * See https://bugs.freedesktop.org/show_bug.cgi?id=88758
 496          */
 497
 498 #ifndef CONFIG_COMPILE_TEST
 499 #warning Please enable CONFIG_MTRR and CONFIG_X86_PAT for better performance \
 500          thanks to write-combining
 501 #endif
 502
 503         if (bo_flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 504                 DRM_INFO_ONCE("Please enable CONFIG_MTRR and CONFIG_X86_PAT for "
 505                               "better performance thanks to write-combining\n");
 506         return false;
 507 #else
 508         /* For architectures that don't support WC memory,
 509          * mask out the WC flag from the BO
 510          */
 511         if (!drm_arch_can_wc_memory())
 512                 return false;
 513
 514         return true;
 515 #endif
 516 }
 517
 518 /**
 519  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 520  * @adev: amdgpu device object
 521  * @bp: parameters to be used for the buffer object
 522  * @bo_ptr: pointer to the buffer object pointer
 523  *
 524  * Creates an &amdgpu_bo buffer object.
 525  *
 526  * Returns:
 527  * 0 for success or a negative error code on failure.
 528  */
 529 int amdgpu_bo_create(struct amdgpu_device *adev,
 530                                struct amdgpu_bo_param *bp,
 531                                struct amdgpu_bo **bo_ptr)
 532 {
 533         struct ttm_operation_ctx ctx = {
 534                 .interruptible = (bp->type != ttm_bo_type_kernel),
 535                 .no_wait_gpu = bp->no_wait_gpu,
 536                 /* We opt to avoid OOM on system pages allocations */
 537                 .gfp_retry_mayfail = true,
 538                 .allow_res_evict = bp->type != ttm_bo_type_kernel,
 539                 .resv = bp->resv
 540         };
 541         struct amdgpu_bo *bo;
 542         unsigned long page_align, size = bp->size;
 543         int r;
 544
 545         /* Note that GDS/GWS/OA allocates 1 page per byte/resource. */
 546         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA)) {
 547                 /* GWS and OA don't need any alignment. */
 548                 page_align = bp->byte_align;
 549                 size <<= PAGE_SHIFT;
 550         } else if (bp->domain & AMDGPU_GEM_DOMAIN_GDS) {
 551                 /* Both size and alignment must be a multiple of 4. */
 552                 page_align = ALIGN(bp->byte_align, 4);
 553                 size = ALIGN(size, 4) << PAGE_SHIFT;
 554         } else {
 555                 /* Memory should be aligned at least to a page size. */
 556                 page_align = ALIGN(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 557                 size = ALIGN(size, PAGE_SIZE);
 558         }
 559
 560         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 561                 return -ENOMEM;
 562
 563         BUG_ON(bp->bo_ptr_size < sizeof(struct amdgpu_bo));
 564
 565         *bo_ptr = NULL;
 566         bo = kzalloc(bp->bo_ptr_size, GFP_KERNEL);
 567         if (bo == NULL)
 568                 return -ENOMEM;
 569         drm_gem_private_object_init(adev_to_drm(adev), &bo->tbo.base, size);
 570         INIT_LIST_HEAD(&bo->shadow_list);
 571         bo->vm_bo = NULL;
 572         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 573                 bp->domain;
 574         bo->allowed_domains = bo->preferred_domains;
 575         if (bp->type != ttm_bo_type_kernel &&
 576             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 577                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 578
 579         bo->flags = bp->flags;
 580
 581         if (!amdgpu_bo_support_uswc(bo->flags))
 582                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 583
 584         bo->tbo.bdev = &adev->mman.bdev;
 585         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA |
 586                           AMDGPU_GEM_DOMAIN_GDS))
 587                 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
 588         else
 589                 amdgpu_bo_placement_from_domain(bo, bp->domain);
 590         if (bp->type == ttm_bo_type_kernel)
 591                 bo->tbo.priority = 1;
 592
 593         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
 594                                  &bo->placement, page_align, &ctx,  NULL,
 595                                  bp->resv, &amdgpu_bo_destroy);
 596         if (unlikely(r != 0))
 597                 return r;
 598
 599         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 600             bo->tbo.mem.mem_type == TTM_PL_VRAM &&
 601             bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
 602                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 603                                              ctx.bytes_moved);
 604         else
 605                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 606
 607         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 608             bo->tbo.mem.mem_type == TTM_PL_VRAM) {
 609                 struct dma_fence *fence;
 610
 611                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.base.resv, &fence);
 612                 if (unlikely(r))
 613                         goto fail_unreserve;
 614
 615                 amdgpu_bo_fence(bo, fence, false);
 616                 dma_fence_put(bo->tbo.moving);
 617                 bo->tbo.moving = dma_fence_get(fence);
 618                 dma_fence_put(fence);
 619         }
 620         if (!bp->resv)
 621                 amdgpu_bo_unreserve(bo);
 622         *bo_ptr = bo;
 623
 624         trace_amdgpu_bo_create(bo);
 625
 626         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 627         if (bp->type == ttm_bo_type_device)
 628                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 629
 630         return 0;
 631
 632 fail_unreserve:
 633         if (!bp->resv)
 634                 dma_resv_unlock(bo->tbo.base.resv);
 635         amdgpu_bo_unref(&bo);
 636         return r;
 637 }
 638
 639 int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
 640                             unsigned long size,
 641                             struct amdgpu_bo *bo)
 642 {
 643         struct amdgpu_bo_param bp;
 644         int r;
 645
 646         if (bo->shadow)
 647                 return 0;
 648
 649         memset(&bp, 0, sizeof(bp));
 650         bp.size = size;
 651         bp.domain = AMDGPU_GEM_DOMAIN_GTT;
 652         bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 653         bp.type = ttm_bo_type_kernel;
 654         bp.resv = bo->tbo.base.resv;
 655         bp.bo_ptr_size = sizeof(struct amdgpu_bo);
 656
 657         r = amdgpu_bo_create(adev, &bp, &bo->shadow);
 658         if (!r) {
 659                 bo->shadow->parent = amdgpu_bo_ref(bo);
 660                 mutex_lock(&adev->shadow_list_lock);
 661                 list_add_tail(&bo->shadow->shadow_list, &adev->shadow_list);
 662                 mutex_unlock(&adev->shadow_list_lock);
 663         }
 664
 665         return r;
 666 }
 667
 668 /**
 669  * amdgpu_bo_create_user - create an &amdgpu_bo_user buffer object
 670  * @adev: amdgpu device object
 671  * @bp: parameters to be used for the buffer object
 672  * @ubo_ptr: pointer to the buffer object pointer
 673  *
 674  * Create a BO to be used by user application;
 675  *
 676  * Returns:
 677  * 0 for success or a negative error code on failure.
 678  */
 679
 680 int amdgpu_bo_create_user(struct amdgpu_device *adev,
 681                           struct amdgpu_bo_param *bp,
 682                           struct amdgpu_bo_user **ubo_ptr)
 683 {
 684         struct amdgpu_bo *bo_ptr;
 685         int r;
 686
 687         bp->bo_ptr_size = sizeof(struct amdgpu_bo_user);
 688         r = amdgpu_bo_create(adev, bp, &bo_ptr);
 689         if (r)
 690                 return r;
 691
 692         *ubo_ptr = to_amdgpu_bo_user(bo_ptr);
 693         return r;
 694 }
 695 /**
 696  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
 697  * @bo: pointer to the buffer object
 698  *
 699  * Sets placement according to domain; and changes placement and caching
 700  * policy of the buffer object according to the placement.
 701  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
 702  * make sure the buffer is resident where it needs to be.
 703  *
 704  * Returns:
 705  * 0 for success or a negative error code on failure.
 706  */
 707 int amdgpu_bo_validate(struct amdgpu_bo *bo)
 708 {
 709         struct ttm_operation_ctx ctx = { false, false };
 710         uint32_t domain;
 711         int r;
 712
 713         if (bo->tbo.pin_count)
 714                 return 0;
 715
 716         domain = bo->preferred_domains;
 717
 718 retry:
 719         amdgpu_bo_placement_from_domain(bo, domain);
 720         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 721         if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
 722                 domain = bo->allowed_domains;
 723                 goto retry;
 724         }
 725
 726         return r;
 727 }
 728
 729 /**
 730  * amdgpu_bo_restore_shadow - restore an &amdgpu_bo shadow
 731  *
 732  * @shadow: &amdgpu_bo shadow to be restored
 733  * @fence: dma_fence associated with the operation
 734  *
 735  * Copies a buffer object's shadow content back to the object.
 736  * This is used for recovering a buffer from its shadow in case of a gpu
 737  * reset where vram context may be lost.
 738  *
 739  * Returns:
 740  * 0 for success or a negative error code on failure.
 741  */
 742 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow, struct dma_fence **fence)
 743
 744 {
 745         struct amdgpu_device *adev = amdgpu_ttm_adev(shadow->tbo.bdev);
 746         struct amdgpu_ring *ring = adev->mman.buffer_funcs_ring;
 747         uint64_t shadow_addr, parent_addr;
 748
 749         shadow_addr = amdgpu_bo_gpu_offset(shadow);
 750         parent_addr = amdgpu_bo_gpu_offset(shadow->parent);
 751
 752         return amdgpu_copy_buffer(ring, shadow_addr, parent_addr,
 753                                   amdgpu_bo_size(shadow), NULL, fence,
 754                                   true, false, false);
 755 }
 756
 757 /**
 758  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 759  * @bo: &amdgpu_bo buffer object to be mapped
 760  * @ptr: kernel virtual address to be returned
 761  *
 762  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 763  * amdgpu_bo_kptr() to get the kernel virtual address.
 764  *
 765  * Returns:
 766  * 0 for success or a negative error code on failure.
 767  */
 768 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 769 {
 770         void *kptr;
 771         long r;
 772
 773         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 774                 return -EPERM;
 775
 776         kptr = amdgpu_bo_kptr(bo);
 777         if (kptr) {
 778                 if (ptr)
 779                         *ptr = kptr;
 780                 return 0;
 781         }
 782
 783         r = dma_resv_wait_timeout_rcu(bo->tbo.base.resv, false, false,
 784                                                 MAX_SCHEDULE_TIMEOUT);
 785         if (r < 0)
 786                 return r;
 787
 788         r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.mem.num_pages, &bo->kmap);
 789         if (r)
 790                 return r;
 791
 792         if (ptr)
 793                 *ptr = amdgpu_bo_kptr(bo);
 794
 795         return 0;
 796 }
 797
 798 /**
 799  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 800  * @bo: &amdgpu_bo buffer object
 801  *
 802  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 803  *
 804  * Returns:
 805  * the virtual address of a buffer object area.
 806  */
 807 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 808 {
 809         bool is_iomem;
 810
 811         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 812 }
 813
 814 /**
 815  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 816  * @bo: &amdgpu_bo buffer object to be unmapped
 817  *
 818  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 819  */
 820 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 821 {
 822         if (bo->kmap.bo)
 823                 ttm_bo_kunmap(&bo->kmap);
 824 }
 825
 826 /**
 827  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 828  * @bo: &amdgpu_bo buffer object
 829  *
 830  * References the contained &ttm_buffer_object.
 831  *
 832  * Returns:
 833  * a refcounted pointer to the &amdgpu_bo buffer object.
 834  */
 835 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 836 {
 837         if (bo == NULL)
 838                 return NULL;
 839
 840         ttm_bo_get(&bo->tbo);
 841         return bo;
 842 }
 843
 844 /**
 845  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 846  * @bo: &amdgpu_bo buffer object
 847  *
 848  * Unreferences the contained &ttm_buffer_object and clear the pointer
 849  */
 850 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 851 {
 852         struct ttm_buffer_object *tbo;
 853
 854         if ((*bo) == NULL)
 855                 return;
 856
 857         tbo = &((*bo)->tbo);
 858         ttm_bo_put(tbo);
 859         *bo = NULL;
 860 }
 861
 862 /**
 863  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 864  * @bo: &amdgpu_bo buffer object to be pinned
 865  * @domain: domain to be pinned to
 866  * @min_offset: the start of requested address range
 867  * @max_offset: the end of requested address range
 868  *
 869  * Pins the buffer object according to requested domain and address range. If
 870  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 871  * pin_count and pin_size accordingly.
 872  *
 873  * Pinning means to lock pages in memory along with keeping them at a fixed
 874  * offset. It is required when a buffer can not be moved, for example, when
 875  * a display buffer is being scanned out.
 876  *
 877  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 878  * where to pin a buffer if there are specific restrictions on where a buffer
 879  * must be located.
 880  *
 881  * Returns:
 882  * 0 for success or a negative error code on failure.
 883  */
 884 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 885                              u64 min_offset, u64 max_offset)
 886 {
 887         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 888         struct ttm_operation_ctx ctx = { false, false };
 889         int r, i;
 890
 891         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 892                 return -EPERM;
 893
 894         if (WARN_ON_ONCE(min_offset > max_offset))
 895                 return -EINVAL;
 896
 897         /* A shared bo cannot be migrated to VRAM */
 898         if (bo->prime_shared_count || bo->tbo.base.import_attach) {
 899                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 900                         domain = AMDGPU_GEM_DOMAIN_GTT;
 901                 else
 902                         return -EINVAL;
 903         }
 904
 905         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 906          * See function amdgpu_display_supported_domains()
 907          */
 908         domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
 909
 910         if (bo->tbo.pin_count) {
 911                 uint32_t mem_type = bo->tbo.mem.mem_type;
 912                 uint32_t mem_flags = bo->tbo.mem.placement;
 913
 914                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 915                         return -EINVAL;
 916
 917                 if ((mem_type == TTM_PL_VRAM) &&
 918                     (bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS) &&
 919                     !(mem_flags & TTM_PL_FLAG_CONTIGUOUS))
 920                         return -EINVAL;
 921
 922                 ttm_bo_pin(&bo->tbo);
 923
 924                 if (max_offset != 0) {
 925                         u64 domain_start = amdgpu_ttm_domain_start(adev,
 926                                                                    mem_type);
 927                         WARN_ON_ONCE(max_offset <
 928                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 929                 }
 930
 931                 return 0;
 932         }
 933
 934         if (bo->tbo.base.import_attach)
 935                 dma_buf_pin(bo->tbo.base.import_attach);
 936
 937         /* force to pin into visible video ram */
 938         if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
 939                 bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 940         amdgpu_bo_placement_from_domain(bo, domain);
 941         for (i = 0; i < bo->placement.num_placement; i++) {
 942                 unsigned fpfn, lpfn;
 943
 944                 fpfn = min_offset >> PAGE_SHIFT;
 945                 lpfn = max_offset >> PAGE_SHIFT;
 946
 947                 if (fpfn > bo->placements[i].fpfn)
 948                         bo->placements[i].fpfn = fpfn;
 949                 if (!bo->placements[i].lpfn ||
 950                     (lpfn && lpfn < bo->placements[i].lpfn))
 951                         bo->placements[i].lpfn = lpfn;
 952         }
 953
 954         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 955         if (unlikely(r)) {
 956                 dev_err(adev->dev, "%p pin failed\n", bo);
 957                 goto error;
 958         }
 959
 960         ttm_bo_pin(&bo->tbo);
 961
 962         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
 963         if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
 964                 atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
 965                 atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
 966                              &adev->visible_pin_size);
 967         } else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
 968                 atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
 969         }
 970
 971 error:
 972         return r;
 973 }
 974
 975 /**
 976  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
 977  * @bo: &amdgpu_bo buffer object to be pinned
 978  * @domain: domain to be pinned to
 979  *
 980  * A simple wrapper to amdgpu_bo_pin_restricted().
 981  * Provides a simpler API for buffers that do not have any strict restrictions
 982  * on where a buffer must be located.
 983  *
 984  * Returns:
 985  * 0 for success or a negative error code on failure.
 986  */
 987 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
 988 {
 989         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 990         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 991 }
 992
 993 /**
 994  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 995  * @bo: &amdgpu_bo buffer object to be unpinned
 996  *
 997  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 998  * Changes placement and pin size accordingly.
 999  *
1000  * Returns:
1001  * 0 for success or a negative error code on failure.
1002  */
1003 void amdgpu_bo_unpin(struct amdgpu_bo *bo)
1004 {
1005         ttm_bo_unpin(&bo->tbo);
1006         if (bo->tbo.pin_count)
1007                 return;
1008
1009         amdgpu_bo_subtract_pin_size(bo);
1010
1011         if (bo->tbo.base.import_attach)
1012                 dma_buf_unpin(bo->tbo.base.import_attach);
1013 }
1014
1015 /**
1016  * amdgpu_bo_evict_vram - evict VRAM buffers
1017  * @adev: amdgpu device object
1018  *
1019  * Evicts all VRAM buffers on the lru list of the memory type.
1020  * Mainly used for evicting vram at suspend time.
1021  *
1022  * Returns:
1023  * 0 for success or a negative error code on failure.
1024  */
1025 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1026 {
1027         struct ttm_resource_manager *man;
1028
1029         if (adev->in_s3 && (adev->flags & AMD_IS_APU)) {
1030                 /* No need to evict vram on APUs for suspend to ram */
1031                 return 0;
1032         }
1033
1034         man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
1035         return ttm_resource_manager_evict_all(&adev->mman.bdev, man);
1036 }
1037
1038 static const char *amdgpu_vram_names[] = {
1039         "UNKNOWN",
1040         "GDDR1",
1041         "DDR2",
1042         "GDDR3",
1043         "GDDR4",
1044         "GDDR5",
1045         "HBM",
1046         "DDR3",
1047         "DDR4",
1048         "GDDR6",
1049         "DDR5"
1050 };
1051
1052 /**
1053  * amdgpu_bo_init - initialize memory manager
1054  * @adev: amdgpu device object
1055  *
1056  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1057  *
1058  * Returns:
1059  * 0 for success or a negative error code on failure.
1060  */
1061 int amdgpu_bo_init(struct amdgpu_device *adev)
1062 {
1063         /* On A+A platform, VRAM can be mapped as WB */
1064         if (!adev->gmc.xgmi.connected_to_cpu) {
1065                 /* reserve PAT memory space to WC for VRAM */
1066                 arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1067                                 adev->gmc.aper_size);
1068
1069                 /* Add an MTRR for the VRAM */
1070                 adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1071                                 adev->gmc.aper_size);
1072         }
1073
1074         DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1075                  adev->gmc.mc_vram_size >> 20,
1076                  (unsigned long long)adev->gmc.aper_size >> 20);
1077         DRM_INFO("RAM width %dbits %s\n",
1078                  adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1079         return amdgpu_ttm_init(adev);
1080 }
1081
1082 /**
1083  * amdgpu_bo_fini - tear down memory manager
1084  * @adev: amdgpu device object
1085  *
1086  * Reverses amdgpu_bo_init() to tear down memory manager.
1087  */
1088 void amdgpu_bo_fini(struct amdgpu_device *adev)
1089 {
1090         amdgpu_ttm_fini(adev);
1091         if (!adev->gmc.xgmi.connected_to_cpu) {
1092                 arch_phys_wc_del(adev->gmc.vram_mtrr);
1093                 arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1094         }
1095 }
1096
1097 /**
1098  * amdgpu_bo_set_tiling_flags - set tiling flags
1099  * @bo: &amdgpu_bo buffer object
1100  * @tiling_flags: new flags
1101  *
1102  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1103  * kernel driver to set the tiling flags on a buffer.
1104  *
1105  * Returns:
1106  * 0 for success or a negative error code on failure.
1107  */
1108 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1109 {
1110         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1111         struct amdgpu_bo_user *ubo;
1112
1113         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1114         if (adev->family <= AMDGPU_FAMILY_CZ &&
1115             AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1116                 return -EINVAL;
1117
1118         ubo = to_amdgpu_bo_user(bo);
1119         ubo->tiling_flags = tiling_flags;
1120         return 0;
1121 }
1122
1123 /**
1124  * amdgpu_bo_get_tiling_flags - get tiling flags
1125  * @bo: &amdgpu_bo buffer object
1126  * @tiling_flags: returned flags
1127  *
1128  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1129  * set the tiling flags on a buffer.
1130  */
1131 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1132 {
1133         struct amdgpu_bo_user *ubo;
1134
1135         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1136         dma_resv_assert_held(bo->tbo.base.resv);
1137         ubo = to_amdgpu_bo_user(bo);
1138
1139         if (tiling_flags)
1140                 *tiling_flags = ubo->tiling_flags;
1141 }
1142
1143 /**
1144  * amdgpu_bo_set_metadata - set metadata
1145  * @bo: &amdgpu_bo buffer object
1146  * @metadata: new metadata
1147  * @metadata_size: size of the new metadata
1148  * @flags: flags of the new metadata
1149  *
1150  * Sets buffer object's metadata, its size and flags.
1151  * Used via GEM ioctl.
1152  *
1153  * Returns:
1154  * 0 for success or a negative error code on failure.
1155  */
1156 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
1157                             uint32_t metadata_size, uint64_t flags)
1158 {
1159         struct amdgpu_bo_user *ubo;
1160         void *buffer;
1161
1162         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1163         ubo = to_amdgpu_bo_user(bo);
1164         if (!metadata_size) {
1165                 if (ubo->metadata_size) {
1166                         kfree(ubo->metadata);
1167                         ubo->metadata = NULL;
1168                         ubo->metadata_size = 0;
1169                 }
1170                 return 0;
1171         }
1172
1173         if (metadata == NULL)
1174                 return -EINVAL;
1175
1176         buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1177         if (buffer == NULL)
1178                 return -ENOMEM;
1179
1180         kfree(ubo->metadata);
1181         ubo->metadata_flags = flags;
1182         ubo->metadata = buffer;
1183         ubo->metadata_size = metadata_size;
1184
1185         return 0;
1186 }
1187
1188 /**
1189  * amdgpu_bo_get_metadata - get metadata
1190  * @bo: &amdgpu_bo buffer object
1191  * @buffer: returned metadata
1192  * @buffer_size: size of the buffer
1193  * @metadata_size: size of the returned metadata
1194  * @flags: flags of the returned metadata
1195  *
1196  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1197  * less than metadata_size.
1198  * Used via GEM ioctl.
1199  *
1200  * Returns:
1201  * 0 for success or a negative error code on failure.
1202  */
1203 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1204                            size_t buffer_size, uint32_t *metadata_size,
1205                            uint64_t *flags)
1206 {
1207         struct amdgpu_bo_user *ubo;
1208
1209         if (!buffer && !metadata_size)
1210                 return -EINVAL;
1211
1212         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1213         ubo = to_amdgpu_bo_user(bo);
1214         if (buffer) {
1215                 if (buffer_size < ubo->metadata_size)
1216                         return -EINVAL;
1217
1218                 if (ubo->metadata_size)
1219                         memcpy(buffer, ubo->metadata, ubo->metadata_size);
1220         }
1221
1222         if (metadata_size)
1223                 *metadata_size = ubo->metadata_size;
1224         if (flags)
1225                 *flags = ubo->metadata_flags;
1226
1227         return 0;
1228 }
1229
1230 /**
1231  * amdgpu_bo_move_notify - notification about a memory move
1232  * @bo: pointer to a buffer object
1233  * @evict: if this move is evicting the buffer from the graphics address space
1234  * @new_mem: new information of the bufer object
1235  *
1236  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1237  * bookkeeping.
1238  * TTM driver callback which is called when ttm moves a buffer.
1239  */
1240 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1241                            bool evict,
1242                            struct ttm_resource *new_mem)
1243 {
1244         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1245         struct amdgpu_bo *abo;
1246         struct ttm_resource *old_mem = &bo->mem;
1247
1248         if (!amdgpu_bo_is_amdgpu_bo(bo))
1249                 return;
1250
1251         abo = ttm_to_amdgpu_bo(bo);
1252         amdgpu_vm_bo_invalidate(adev, abo, evict);
1253
1254         amdgpu_bo_kunmap(abo);
1255
1256         if (abo->tbo.base.dma_buf && !abo->tbo.base.import_attach &&
1257             bo->mem.mem_type != TTM_PL_SYSTEM)
1258                 dma_buf_move_notify(abo->tbo.base.dma_buf);
1259
1260         /* remember the eviction */
1261         if (evict)
1262                 atomic64_inc(&adev->num_evictions);
1263
1264         /* update statistics */
1265         if (!new_mem)
1266                 return;
1267
1268         /* move_notify is called before move happens */
1269         trace_amdgpu_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1270 }
1271
1272 /**
1273  * amdgpu_bo_release_notify - notification about a BO being released
1274  * @bo: pointer to a buffer object
1275  *
1276  * Wipes VRAM buffers whose contents should not be leaked before the
1277  * memory is released.
1278  */
1279 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo)
1280 {
1281         struct dma_fence *fence = NULL;
1282         struct amdgpu_bo *abo;
1283         int r;
1284
1285         if (!amdgpu_bo_is_amdgpu_bo(bo))
1286                 return;
1287
1288         abo = ttm_to_amdgpu_bo(bo);
1289
1290         if (abo->kfd_bo)
1291                 amdgpu_amdkfd_unreserve_memory_limit(abo);
1292
1293         /* We only remove the fence if the resv has individualized. */
1294         WARN_ON_ONCE(bo->type == ttm_bo_type_kernel
1295                         && bo->base.resv != &bo->base._resv);
1296         if (bo->base.resv == &bo->base._resv)
1297                 amdgpu_amdkfd_remove_fence_on_pt_pd_bos(abo);
1298
1299         if (bo->mem.mem_type != TTM_PL_VRAM || !bo->mem.mm_node ||
1300             !(abo->flags & AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE))
1301                 return;
1302
1303         dma_resv_lock(bo->base.resv, NULL);
1304
1305         r = amdgpu_fill_buffer(abo, AMDGPU_POISON, bo->base.resv, &fence);
1306         if (!WARN_ON(r)) {
1307                 amdgpu_bo_fence(abo, fence, false);
1308                 dma_fence_put(fence);
1309         }
1310
1311         dma_resv_unlock(bo->base.resv);
1312 }
1313
1314 /**
1315  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1316  * @bo: pointer to a buffer object
1317  *
1318  * Notifies the driver we are taking a fault on this BO and have reserved it,
1319  * also performs bookkeeping.
1320  * TTM driver callback for dealing with vm faults.
1321  *
1322  * Returns:
1323  * 0 for success or a negative error code on failure.
1324  */
1325 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1326 {
1327         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1328         struct ttm_operation_ctx ctx = { false, false };
1329         struct amdgpu_bo *abo = ttm_to_amdgpu_bo(bo);
1330         unsigned long offset, size;
1331         int r;
1332
1333         /* Remember that this BO was accessed by the CPU */
1334         abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1335
1336         if (bo->mem.mem_type != TTM_PL_VRAM)
1337                 return 0;
1338
1339         size = bo->mem.num_pages << PAGE_SHIFT;
1340         offset = bo->mem.start << PAGE_SHIFT;
1341         if ((offset + size) <= adev->gmc.visible_vram_size)
1342                 return 0;
1343
1344         /* Can't move a pinned BO to visible VRAM */
1345         if (abo->tbo.pin_count > 0)
1346                 return VM_FAULT_SIGBUS;
1347
1348         /* hurrah the memory is not visible ! */
1349         atomic64_inc(&adev->num_vram_cpu_page_faults);
1350         amdgpu_bo_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1351                                         AMDGPU_GEM_DOMAIN_GTT);
1352
1353         /* Avoid costly evictions; only set GTT as a busy placement */
1354         abo->placement.num_busy_placement = 1;
1355         abo->placement.busy_placement = &abo->placements[1];
1356
1357         r = ttm_bo_validate(bo, &abo->placement, &ctx);
1358         if (unlikely(r == -EBUSY || r == -ERESTARTSYS))
1359                 return VM_FAULT_NOPAGE;
1360         else if (unlikely(r))
1361                 return VM_FAULT_SIGBUS;
1362
1363         offset = bo->mem.start << PAGE_SHIFT;
1364         /* this should never happen */
1365         if (bo->mem.mem_type == TTM_PL_VRAM &&
1366             (offset + size) > adev->gmc.visible_vram_size)
1367                 return VM_FAULT_SIGBUS;
1368
1369         ttm_bo_move_to_lru_tail_unlocked(bo);
1370         return 0;
1371 }
1372
1373 /**
1374  * amdgpu_bo_fence - add fence to buffer object
1375  *
1376  * @bo: buffer object in question
1377  * @fence: fence to add
1378  * @shared: true if fence should be added shared
1379  *
1380  */
1381 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1382                      bool shared)
1383 {
1384         struct dma_resv *resv = bo->tbo.base.resv;
1385
1386         if (shared)
1387                 dma_resv_add_shared_fence(resv, fence);
1388         else
1389                 dma_resv_add_excl_fence(resv, fence);
1390 }
1391
1392 /**
1393  * amdgpu_bo_sync_wait_resv - Wait for BO reservation fences
1394  *
1395  * @adev: amdgpu device pointer
1396  * @resv: reservation object to sync to
1397  * @sync_mode: synchronization mode
1398  * @owner: fence owner
1399  * @intr: Whether the wait is interruptible
1400  *
1401  * Extract the fences from the reservation object and waits for them to finish.
1402  *
1403  * Returns:
1404  * 0 on success, errno otherwise.
1405  */
1406 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
1407                              enum amdgpu_sync_mode sync_mode, void *owner,
1408                              bool intr)
1409 {
1410         struct amdgpu_sync sync;
1411         int r;
1412
1413         amdgpu_sync_create(&sync);
1414         amdgpu_sync_resv(adev, &sync, resv, sync_mode, owner);
1415         r = amdgpu_sync_wait(&sync, intr);
1416         amdgpu_sync_free(&sync);
1417         return r;
1418 }
1419
1420 /**
1421  * amdgpu_bo_sync_wait - Wrapper for amdgpu_bo_sync_wait_resv
1422  * @bo: buffer object to wait for
1423  * @owner: fence owner
1424  * @intr: Whether the wait is interruptible
1425  *
1426  * Wrapper to wait for fences in a BO.
1427  * Returns:
1428  * 0 on success, errno otherwise.
1429  */
1430 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr)
1431 {
1432         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1433
1434         return amdgpu_bo_sync_wait_resv(adev, bo->tbo.base.resv,
1435                                         AMDGPU_SYNC_NE_OWNER, owner, intr);
1436 }
1437
1438 /**
1439  * amdgpu_bo_gpu_offset - return GPU offset of bo
1440  * @bo: amdgpu object for which we query the offset
1441  *
1442  * Note: object should either be pinned or reserved when calling this
1443  * function, it might be useful to add check for this for debugging.
1444  *
1445  * Returns:
1446  * current GPU offset of the object.
1447  */
1448 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1449 {
1450         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_SYSTEM);
1451         WARN_ON_ONCE(!dma_resv_is_locked(bo->tbo.base.resv) &&
1452                      !bo->tbo.pin_count && bo->tbo.type != ttm_bo_type_kernel);
1453         WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1454         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1455                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1456
1457         return amdgpu_bo_gpu_offset_no_check(bo);
1458 }
1459
1460 /**
1461  * amdgpu_bo_gpu_offset_no_check - return GPU offset of bo
1462  * @bo: amdgpu object for which we query the offset
1463  *
1464  * Returns:
1465  * current GPU offset of the object without raising warnings.
1466  */
1467 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo)
1468 {
1469         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1470         uint64_t offset;
1471
1472         offset = (bo->tbo.mem.start << PAGE_SHIFT) +
1473                  amdgpu_ttm_domain_start(adev, bo->tbo.mem.mem_type);
1474
1475         return amdgpu_gmc_sign_extend(offset);
1476 }
1477
1478 /**
1479  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1480  * @adev: amdgpu device object
1481  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1482  *
1483  * Returns:
1484  * Which of the allowed domains is preferred for pinning the BO for scanout.
1485  */
1486 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1487                                             uint32_t domain)
1488 {
1489         if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1490                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1491                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1492                         domain = AMDGPU_GEM_DOMAIN_GTT;
1493         }
1494         return domain;
1495 }
1496
1497 #if defined(CONFIG_DEBUG_FS)
1498 #define amdgpu_bo_print_flag(m, bo, flag)                       \
1499         do {                                                    \
1500                 if (bo->flags & (AMDGPU_GEM_CREATE_ ## flag)) { \
1501                         seq_printf((m), " " #flag);             \
1502                 }                                               \
1503         } while (0)
1504
1505 /**
1506  * amdgpu_bo_print_info - print BO info in debugfs file
1507  *
1508  * @id: Index or Id of the BO
1509  * @bo: Requested BO for printing info
1510  * @m: debugfs file
1511  *
1512  * Print BO information in debugfs file
1513  *
1514  * Returns:
1515  * Size of the BO in bytes.
1516  */
1517 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m)
1518 {
1519         struct dma_buf_attachment *attachment;
1520         struct dma_buf *dma_buf;
1521         unsigned int domain;
1522         const char *placement;
1523         unsigned int pin_count;
1524         u64 size;
1525
1526         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
1527         switch (domain) {
1528         case AMDGPU_GEM_DOMAIN_VRAM:
1529                 placement = "VRAM";
1530                 break;
1531         case AMDGPU_GEM_DOMAIN_GTT:
1532                 placement = " GTT";
1533                 break;
1534         case AMDGPU_GEM_DOMAIN_CPU:
1535         default:
1536                 placement = " CPU";
1537                 break;
1538         }
1539
1540         size = amdgpu_bo_size(bo);
1541         seq_printf(m, "\t\t0x%08x: %12lld byte %s",
1542                         id, size, placement);
1543
1544         pin_count = READ_ONCE(bo->tbo.pin_count);
1545         if (pin_count)
1546                 seq_printf(m, " pin count %d", pin_count);
1547
1548         dma_buf = READ_ONCE(bo->tbo.base.dma_buf);
1549         attachment = READ_ONCE(bo->tbo.base.import_attach);
1550
1551         if (attachment)
1552                 seq_printf(m, " imported from %p", dma_buf);
1553         else if (dma_buf)
1554                 seq_printf(m, " exported as %p", dma_buf);
1555
1556         amdgpu_bo_print_flag(m, bo, CPU_ACCESS_REQUIRED);
1557         amdgpu_bo_print_flag(m, bo, NO_CPU_ACCESS);
1558         amdgpu_bo_print_flag(m, bo, CPU_GTT_USWC);
1559         amdgpu_bo_print_flag(m, bo, VRAM_CLEARED);
1560         amdgpu_bo_print_flag(m, bo, VRAM_CONTIGUOUS);
1561         amdgpu_bo_print_flag(m, bo, VM_ALWAYS_VALID);
1562         amdgpu_bo_print_flag(m, bo, EXPLICIT_SYNC);
1563
1564         seq_puts(m, "\n");
1565
1566         return size;
1567 }
1568 #endif