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