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