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/drm_drv.h>
  37 #include <drm/amdgpu_drm.h>
  38 #include <drm/drm_cache.h>
  39 #include "amdgpu.h"
  40 #include "amdgpu_trace.h"
  41 #include "amdgpu_amdkfd.h"
  42
  43 /**
  44  * DOC: amdgpu_object
  45  *
  46  * This defines the interfaces to operate on an &amdgpu_bo buffer object which
  47  * represents memory used by driver (VRAM, system memory, etc.). The driver
  48  * provides DRM/GEM APIs to userspace. DRM/GEM APIs then use these interfaces
  49  * to create/destroy/set buffer object which are then managed by the kernel TTM
  50  * memory manager.
  51  * The interfaces are also used internally by kernel clients, including gfx,
  52  * uvd, etc. for kernel managed allocations used by the GPU.
  53  *
  54  */
  55
  56 static void amdgpu_bo_destroy(struct ttm_buffer_object *tbo)
  57 {
  58         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  59
  60         amdgpu_bo_kunmap(bo);
  61
  62         if (bo->tbo.base.import_attach)
  63                 drm_prime_gem_destroy(&bo->tbo.base, bo->tbo.sg);
  64         drm_gem_object_release(&bo->tbo.base);
  65         amdgpu_bo_unref(&bo->parent);
  66         kvfree(bo);
  67 }
  68
  69 static void amdgpu_bo_user_destroy(struct ttm_buffer_object *tbo)
  70 {
  71         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  72         struct amdgpu_bo_user *ubo;
  73
  74         ubo = to_amdgpu_bo_user(bo);
  75         kfree(ubo->metadata);
  76         amdgpu_bo_destroy(tbo);
  77 }
  78
  79 static void amdgpu_bo_vm_destroy(struct ttm_buffer_object *tbo)
  80 {
  81         struct amdgpu_device *adev = amdgpu_ttm_adev(tbo->bdev);
  82         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  83         struct amdgpu_bo_vm *vmbo;
  84
  85         vmbo = to_amdgpu_bo_vm(bo);
  86         /* in case amdgpu_device_recover_vram got NULL of bo->parent */
  87         if (!list_empty(&vmbo->shadow_list)) {
  88                 mutex_lock(&adev->shadow_list_lock);
  89                 list_del_init(&vmbo->shadow_list);
  90                 mutex_unlock(&adev->shadow_list_lock);
  91         }
  92
  93         amdgpu_bo_destroy(tbo);
  94 }
  95
  96 /**
  97  * amdgpu_bo_is_amdgpu_bo - check if the buffer object is an &amdgpu_bo
  98  * @bo: buffer object to be checked
  99  *
 100  * Uses destroy function associated with the object to determine if this is
 101  * an &amdgpu_bo.
 102  *
 103  * Returns:
 104  * true if the object belongs to &amdgpu_bo, false if not.
 105  */
 106 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo)
 107 {
 108         if (bo->destroy == &amdgpu_bo_destroy ||
 109             bo->destroy == &amdgpu_bo_user_destroy ||
 110             bo->destroy == &amdgpu_bo_vm_destroy)
 111                 return true;
 112
 113         return false;
 114 }
 115
 116 /**
 117  * amdgpu_bo_placement_from_domain - set buffer's placement
 118  * @abo: &amdgpu_bo buffer object whose placement is to be set
 119  * @domain: requested domain
 120  *
 121  * Sets buffer's placement according to requested domain and the buffer's
 122  * flags.
 123  */
 124 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain)
 125 {
 126         struct amdgpu_device *adev = amdgpu_ttm_adev(abo->tbo.bdev);
 127         struct ttm_placement *placement = &abo->placement;
 128         struct ttm_place *places = abo->placements;
 129         u64 flags = abo->flags;
 130         u32 c = 0;
 131
 132         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 133                 unsigned int visible_pfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
 134
 135                 places[c].fpfn = 0;
 136                 places[c].lpfn = 0;
 137                 places[c].mem_type = TTM_PL_VRAM;
 138                 places[c].flags = 0;
 139
 140                 if (flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
 141                         places[c].lpfn = visible_pfn;
 142                 else if (adev->gmc.real_vram_size != adev->gmc.visible_vram_size)
 143                         places[c].flags |= TTM_PL_FLAG_TOPDOWN;
 144
 145                 if (flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS)
 146                         places[c].flags |= TTM_PL_FLAG_CONTIGUOUS;
 147                 c++;
 148         }
 149
 150         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 151                 places[c].fpfn = 0;
 152                 places[c].lpfn = 0;
 153                 places[c].mem_type =
 154                         abo->flags & AMDGPU_GEM_CREATE_PREEMPTIBLE ?
 155                         AMDGPU_PL_PREEMPT : 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  * @bo_ptr:  used to initialize BOs in structures
 350  * @cpu_addr: optional CPU address mapping
 351  *
 352  * Creates a kernel BO at a specific offset in VRAM.
 353  *
 354  * Returns:
 355  * 0 on success, negative error code otherwise.
 356  */
 357 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
 358                                uint64_t offset, uint64_t size,
 359                                struct amdgpu_bo **bo_ptr, void **cpu_addr)
 360 {
 361         struct ttm_operation_ctx ctx = { false, false };
 362         unsigned int i;
 363         int r;
 364
 365         offset &= PAGE_MASK;
 366         size = ALIGN(size, PAGE_SIZE);
 367
 368         r = amdgpu_bo_create_reserved(adev, size, PAGE_SIZE,
 369                                       AMDGPU_GEM_DOMAIN_VRAM, bo_ptr, NULL,
 370                                       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.resource);
 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.resource, &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         WARN_ON(amdgpu_ttm_adev((*bo)->tbo.bdev)->in_suspend);
 426
 427         if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
 428                 if (cpu_addr)
 429                         amdgpu_bo_kunmap(*bo);
 430
 431                 amdgpu_bo_unpin(*bo);
 432                 amdgpu_bo_unreserve(*bo);
 433         }
 434         amdgpu_bo_unref(bo);
 435
 436         if (gpu_addr)
 437                 *gpu_addr = 0;
 438
 439         if (cpu_addr)
 440                 *cpu_addr = NULL;
 441 }
 442
 443 /* Validate bo size is bit bigger then the request domain */
 444 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
 445                                           unsigned long size, u32 domain)
 446 {
 447         struct ttm_resource_manager *man = NULL;
 448
 449         /*
 450          * If GTT is part of requested domains the check must succeed to
 451          * allow fall back to GTT.
 452          */
 453         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 454                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_TT);
 455
 456                 if (man && size < man->size)
 457                         return true;
 458                 else if (!man)
 459                         WARN_ON_ONCE("GTT domain requested but GTT mem manager uninitialized");
 460                 goto fail;
 461         } else if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 462                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
 463
 464                 if (man && size < man->size)
 465                         return true;
 466                 goto fail;
 467         }
 468
 469         /* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
 470         return true;
 471
 472 fail:
 473         if (man)
 474                 DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
 475                           man->size);
 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 /**
 514  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 515  * @adev: amdgpu device object
 516  * @bp: parameters to be used for the buffer object
 517  * @bo_ptr: pointer to the buffer object pointer
 518  *
 519  * Creates an &amdgpu_bo buffer object.
 520  *
 521  * Returns:
 522  * 0 for success or a negative error code on failure.
 523  */
 524 int amdgpu_bo_create(struct amdgpu_device *adev,
 525                                struct amdgpu_bo_param *bp,
 526                                struct amdgpu_bo **bo_ptr)
 527 {
 528         struct ttm_operation_ctx ctx = {
 529                 .interruptible = (bp->type != ttm_bo_type_kernel),
 530                 .no_wait_gpu = bp->no_wait_gpu,
 531                 /* We opt to avoid OOM on system pages allocations */
 532                 .gfp_retry_mayfail = true,
 533                 .allow_res_evict = bp->type != ttm_bo_type_kernel,
 534                 .resv = bp->resv
 535         };
 536         struct amdgpu_bo *bo;
 537         unsigned long page_align, size = bp->size;
 538         int r;
 539
 540         /* Note that GDS/GWS/OA allocates 1 page per byte/resource. */
 541         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA)) {
 542                 /* GWS and OA don't need any alignment. */
 543                 page_align = bp->byte_align;
 544                 size <<= PAGE_SHIFT;
 545
 546         } else if (bp->domain & AMDGPU_GEM_DOMAIN_GDS) {
 547                 /* Both size and alignment must be a multiple of 4. */
 548                 page_align = ALIGN(bp->byte_align, 4);
 549                 size = ALIGN(size, 4) << PAGE_SHIFT;
 550         } else {
 551                 /* Memory should be aligned at least to a page size. */
 552                 page_align = ALIGN(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 553                 size = ALIGN(size, PAGE_SIZE);
 554         }
 555
 556         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 557                 return -ENOMEM;
 558
 559         BUG_ON(bp->bo_ptr_size < sizeof(struct amdgpu_bo));
 560
 561         *bo_ptr = NULL;
 562         bo = kvzalloc(bp->bo_ptr_size, GFP_KERNEL);
 563         if (bo == NULL)
 564                 return -ENOMEM;
 565         drm_gem_private_object_init(adev_to_drm(adev), &bo->tbo.base, size);
 566         bo->vm_bo = NULL;
 567         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 568                 bp->domain;
 569         bo->allowed_domains = bo->preferred_domains;
 570         if (bp->type != ttm_bo_type_kernel &&
 571             !(bp->flags & AMDGPU_GEM_CREATE_DISCARDABLE) &&
 572             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 573                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 574
 575         bo->flags = bp->flags;
 576
 577         /* bo->mem_id -1 means any partition */
 578         bo->mem_id = bp->mem_id_plus1 - 1;
 579
 580         if (!amdgpu_bo_support_uswc(bo->flags))
 581                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 582
 583         if (adev->ras_enabled)
 584                 bo->flags |= AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE;
 585
 586         bo->tbo.bdev = &adev->mman.bdev;
 587         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA |
 588                           AMDGPU_GEM_DOMAIN_GDS))
 589                 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
 590         else
 591                 amdgpu_bo_placement_from_domain(bo, bp->domain);
 592         if (bp->type == ttm_bo_type_kernel)
 593                 bo->tbo.priority = 1;
 594
 595         if (!bp->destroy)
 596                 bp->destroy = &amdgpu_bo_destroy;
 597
 598         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, bp->type,
 599                                  &bo->placement, page_align, &ctx,  NULL,
 600                                  bp->resv, bp->destroy);
 601         if (unlikely(r != 0))
 602                 return r;
 603
 604         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 605             bo->tbo.resource->mem_type == TTM_PL_VRAM &&
 606             amdgpu_bo_in_cpu_visible_vram(bo))
 607                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 608                                              ctx.bytes_moved);
 609         else
 610                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 611
 612         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 613             bo->tbo.resource->mem_type == TTM_PL_VRAM) {
 614                 struct dma_fence *fence;
 615
 616                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.base.resv, &fence);
 617                 if (unlikely(r))
 618                         goto fail_unreserve;
 619
 620                 dma_resv_add_fence(bo->tbo.base.resv, fence,
 621                                    DMA_RESV_USAGE_KERNEL);
 622                 dma_fence_put(fence);
 623         }
 624         if (!bp->resv)
 625                 amdgpu_bo_unreserve(bo);
 626         *bo_ptr = bo;
 627
 628         trace_amdgpu_bo_create(bo);
 629
 630         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 631         if (bp->type == ttm_bo_type_device)
 632                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 633
 634         return 0;
 635
 636 fail_unreserve:
 637         if (!bp->resv)
 638                 dma_resv_unlock(bo->tbo.base.resv);
 639         amdgpu_bo_unref(&bo);
 640         return r;
 641 }
 642
 643 /**
 644  * amdgpu_bo_create_user - create an &amdgpu_bo_user buffer object
 645  * @adev: amdgpu device object
 646  * @bp: parameters to be used for the buffer object
 647  * @ubo_ptr: pointer to the buffer object pointer
 648  *
 649  * Create a BO to be used by user application;
 650  *
 651  * Returns:
 652  * 0 for success or a negative error code on failure.
 653  */
 654
 655 int amdgpu_bo_create_user(struct amdgpu_device *adev,
 656                           struct amdgpu_bo_param *bp,
 657                           struct amdgpu_bo_user **ubo_ptr)
 658 {
 659         struct amdgpu_bo *bo_ptr;
 660         int r;
 661
 662         bp->bo_ptr_size = sizeof(struct amdgpu_bo_user);
 663         bp->destroy = &amdgpu_bo_user_destroy;
 664         r = amdgpu_bo_create(adev, bp, &bo_ptr);
 665         if (r)
 666                 return r;
 667
 668         *ubo_ptr = to_amdgpu_bo_user(bo_ptr);
 669         return r;
 670 }
 671
 672 /**
 673  * amdgpu_bo_create_vm - create an &amdgpu_bo_vm buffer object
 674  * @adev: amdgpu device object
 675  * @bp: parameters to be used for the buffer object
 676  * @vmbo_ptr: pointer to the buffer object pointer
 677  *
 678  * Create a BO to be for GPUVM.
 679  *
 680  * Returns:
 681  * 0 for success or a negative error code on failure.
 682  */
 683
 684 int amdgpu_bo_create_vm(struct amdgpu_device *adev,
 685                         struct amdgpu_bo_param *bp,
 686                         struct amdgpu_bo_vm **vmbo_ptr)
 687 {
 688         struct amdgpu_bo *bo_ptr;
 689         int r;
 690
 691         /* bo_ptr_size will be determined by the caller and it depends on
 692          * num of amdgpu_vm_pt entries.
 693          */
 694         BUG_ON(bp->bo_ptr_size < sizeof(struct amdgpu_bo_vm));
 695         r = amdgpu_bo_create(adev, bp, &bo_ptr);
 696         if (r)
 697                 return r;
 698
 699         *vmbo_ptr = to_amdgpu_bo_vm(bo_ptr);
 700         INIT_LIST_HEAD(&(*vmbo_ptr)->shadow_list);
 701         /* Set destroy callback to amdgpu_bo_vm_destroy after vmbo->shadow_list
 702          * is initialized.
 703          */
 704         bo_ptr->tbo.destroy = &amdgpu_bo_vm_destroy;
 705         return r;
 706 }
 707
 708 /**
 709  * amdgpu_bo_add_to_shadow_list - add a BO to the shadow list
 710  *
 711  * @vmbo: BO that will be inserted into the shadow list
 712  *
 713  * Insert a BO to the shadow list.
 714  */
 715 void amdgpu_bo_add_to_shadow_list(struct amdgpu_bo_vm *vmbo)
 716 {
 717         struct amdgpu_device *adev = amdgpu_ttm_adev(vmbo->bo.tbo.bdev);
 718
 719         mutex_lock(&adev->shadow_list_lock);
 720         list_add_tail(&vmbo->shadow_list, &adev->shadow_list);
 721         mutex_unlock(&adev->shadow_list_lock);
 722 }
 723
 724 /**
 725  * amdgpu_bo_restore_shadow - restore an &amdgpu_bo shadow
 726  *
 727  * @shadow: &amdgpu_bo shadow to be restored
 728  * @fence: dma_fence associated with the operation
 729  *
 730  * Copies a buffer object's shadow content back to the object.
 731  * This is used for recovering a buffer from its shadow in case of a gpu
 732  * reset where vram context may be lost.
 733  *
 734  * Returns:
 735  * 0 for success or a negative error code on failure.
 736  */
 737 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow, struct dma_fence **fence)
 738
 739 {
 740         struct amdgpu_device *adev = amdgpu_ttm_adev(shadow->tbo.bdev);
 741         struct amdgpu_ring *ring = adev->mman.buffer_funcs_ring;
 742         uint64_t shadow_addr, parent_addr;
 743
 744         shadow_addr = amdgpu_bo_gpu_offset(shadow);
 745         parent_addr = amdgpu_bo_gpu_offset(shadow->parent);
 746
 747         return amdgpu_copy_buffer(ring, shadow_addr, parent_addr,
 748                                   amdgpu_bo_size(shadow), NULL, fence,
 749                                   true, false, false);
 750 }
 751
 752 /**
 753  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 754  * @bo: &amdgpu_bo buffer object to be mapped
 755  * @ptr: kernel virtual address to be returned
 756  *
 757  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 758  * amdgpu_bo_kptr() to get the kernel virtual address.
 759  *
 760  * Returns:
 761  * 0 for success or a negative error code on failure.
 762  */
 763 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 764 {
 765         void *kptr;
 766         long r;
 767
 768         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 769                 return -EPERM;
 770
 771         r = dma_resv_wait_timeout(bo->tbo.base.resv, DMA_RESV_USAGE_KERNEL,
 772                                   false, MAX_SCHEDULE_TIMEOUT);
 773         if (r < 0)
 774                 return r;
 775
 776         kptr = amdgpu_bo_kptr(bo);
 777         if (kptr) {
 778                 if (ptr)
 779                         *ptr = kptr;
 780                 return 0;
 781         }
 782
 783         r = ttm_bo_kmap(&bo->tbo, 0, PFN_UP(bo->tbo.base.size), &bo->kmap);
 784         if (r)
 785                 return r;
 786
 787         if (ptr)
 788                 *ptr = amdgpu_bo_kptr(bo);
 789
 790         return 0;
 791 }
 792
 793 /**
 794  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 795  * @bo: &amdgpu_bo buffer object
 796  *
 797  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 798  *
 799  * Returns:
 800  * the virtual address of a buffer object area.
 801  */
 802 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 803 {
 804         bool is_iomem;
 805
 806         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 807 }
 808
 809 /**
 810  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 811  * @bo: &amdgpu_bo buffer object to be unmapped
 812  *
 813  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 814  */
 815 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 816 {
 817         if (bo->kmap.bo)
 818                 ttm_bo_kunmap(&bo->kmap);
 819 }
 820
 821 /**
 822  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 823  * @bo: &amdgpu_bo buffer object
 824  *
 825  * References the contained &ttm_buffer_object.
 826  *
 827  * Returns:
 828  * a refcounted pointer to the &amdgpu_bo buffer object.
 829  */
 830 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 831 {
 832         if (bo == NULL)
 833                 return NULL;
 834
 835         ttm_bo_get(&bo->tbo);
 836         return bo;
 837 }
 838
 839 /**
 840  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 841  * @bo: &amdgpu_bo buffer object
 842  *
 843  * Unreferences the contained &ttm_buffer_object and clear the pointer
 844  */
 845 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 846 {
 847         struct ttm_buffer_object *tbo;
 848
 849         if ((*bo) == NULL)
 850                 return;
 851
 852         tbo = &((*bo)->tbo);
 853         ttm_bo_put(tbo);
 854         *bo = NULL;
 855 }
 856
 857 /**
 858  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 859  * @bo: &amdgpu_bo buffer object to be pinned
 860  * @domain: domain to be pinned to
 861  * @min_offset: the start of requested address range
 862  * @max_offset: the end of requested address range
 863  *
 864  * Pins the buffer object according to requested domain and address range. If
 865  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 866  * pin_count and pin_size accordingly.
 867  *
 868  * Pinning means to lock pages in memory along with keeping them at a fixed
 869  * offset. It is required when a buffer can not be moved, for example, when
 870  * a display buffer is being scanned out.
 871  *
 872  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 873  * where to pin a buffer if there are specific restrictions on where a buffer
 874  * must be located.
 875  *
 876  * Returns:
 877  * 0 for success or a negative error code on failure.
 878  */
 879 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 880                              u64 min_offset, u64 max_offset)
 881 {
 882         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 883         struct ttm_operation_ctx ctx = { false, false };
 884         int r, i;
 885
 886         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 887                 return -EPERM;
 888
 889         if (WARN_ON_ONCE(min_offset > max_offset))
 890                 return -EINVAL;
 891
 892         /* Check domain to be pinned to against preferred domains */
 893         if (bo->preferred_domains & domain)
 894                 domain = bo->preferred_domains & domain;
 895
 896         /* A shared bo cannot be migrated to VRAM */
 897         if (bo->tbo.base.import_attach) {
 898                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 899                         domain = AMDGPU_GEM_DOMAIN_GTT;
 900                 else
 901                         return -EINVAL;
 902         }
 903
 904         if (bo->tbo.pin_count) {
 905                 uint32_t mem_type = bo->tbo.resource->mem_type;
 906                 uint32_t mem_flags = bo->tbo.resource->placement;
 907
 908                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 909                         return -EINVAL;
 910
 911                 if ((mem_type == TTM_PL_VRAM) &&
 912                     (bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS) &&
 913                     !(mem_flags & TTM_PL_FLAG_CONTIGUOUS))
 914                         return -EINVAL;
 915
 916                 ttm_bo_pin(&bo->tbo);
 917
 918                 if (max_offset != 0) {
 919                         u64 domain_start = amdgpu_ttm_domain_start(adev,
 920                                                                    mem_type);
 921                         WARN_ON_ONCE(max_offset <
 922                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 923                 }
 924
 925                 return 0;
 926         }
 927
 928         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 929          * See function amdgpu_display_supported_domains()
 930          */
 931         domain = amdgpu_bo_get_preferred_domain(adev, domain);
 932
 933         if (bo->tbo.base.import_attach)
 934                 dma_buf_pin(bo->tbo.base.import_attach);
 935
 936         /* force to pin into visible video ram */
 937         if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
 938                 bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 939         amdgpu_bo_placement_from_domain(bo, domain);
 940         for (i = 0; i < bo->placement.num_placement; i++) {
 941                 unsigned int fpfn, lpfn;
 942
 943                 fpfn = min_offset >> PAGE_SHIFT;
 944                 lpfn = max_offset >> PAGE_SHIFT;
 945
 946                 if (fpfn > bo->placements[i].fpfn)
 947                         bo->placements[i].fpfn = fpfn;
 948                 if (!bo->placements[i].lpfn ||
 949                     (lpfn && lpfn < bo->placements[i].lpfn))
 950                         bo->placements[i].lpfn = lpfn;
 951         }
 952
 953         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 954         if (unlikely(r)) {
 955                 dev_err(adev->dev, "%p pin failed\n", bo);
 956                 goto error;
 957         }
 958
 959         ttm_bo_pin(&bo->tbo);
 960
 961         domain = amdgpu_mem_type_to_domain(bo->tbo.resource->mem_type);
 962         if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
 963                 atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
 964                 atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
 965                              &adev->visible_pin_size);
 966         } else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
 967                 atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
 968         }
 969
 970 error:
 971         return r;
 972 }
 973
 974 /**
 975  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
 976  * @bo: &amdgpu_bo buffer object to be pinned
 977  * @domain: domain to be pinned to
 978  *
 979  * A simple wrapper to amdgpu_bo_pin_restricted().
 980  * Provides a simpler API for buffers that do not have any strict restrictions
 981  * on where a buffer must be located.
 982  *
 983  * Returns:
 984  * 0 for success or a negative error code on failure.
 985  */
 986 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
 987 {
 988         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 989         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 990 }
 991
 992 /**
 993  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 994  * @bo: &amdgpu_bo buffer object to be unpinned
 995  *
 996  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 997  * Changes placement and pin size accordingly.
 998  *
 999  * Returns:
1000  * 0 for success or a negative error code on failure.
1001  */
1002 void amdgpu_bo_unpin(struct amdgpu_bo *bo)
1003 {
1004         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1005
1006         ttm_bo_unpin(&bo->tbo);
1007         if (bo->tbo.pin_count)
1008                 return;
1009
1010         if (bo->tbo.base.import_attach)
1011                 dma_buf_unpin(bo->tbo.base.import_attach);
1012
1013         if (bo->tbo.resource->mem_type == TTM_PL_VRAM) {
1014                 atomic64_sub(amdgpu_bo_size(bo), &adev->vram_pin_size);
1015                 atomic64_sub(amdgpu_vram_mgr_bo_visible_size(bo),
1016                              &adev->visible_pin_size);
1017         } else if (bo->tbo.resource->mem_type == TTM_PL_TT) {
1018                 atomic64_sub(amdgpu_bo_size(bo), &adev->gart_pin_size);
1019         }
1020 }
1021
1022 static const char * const amdgpu_vram_names[] = {
1023         "UNKNOWN",
1024         "GDDR1",
1025         "DDR2",
1026         "GDDR3",
1027         "GDDR4",
1028         "GDDR5",
1029         "HBM",
1030         "DDR3",
1031         "DDR4",
1032         "GDDR6",
1033         "DDR5",
1034         "LPDDR4",
1035         "LPDDR5"
1036 };
1037
1038 /**
1039  * amdgpu_bo_init - initialize memory manager
1040  * @adev: amdgpu device object
1041  *
1042  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1043  *
1044  * Returns:
1045  * 0 for success or a negative error code on failure.
1046  */
1047 int amdgpu_bo_init(struct amdgpu_device *adev)
1048 {
1049         /* On A+A platform, VRAM can be mapped as WB */
1050         if (!adev->gmc.xgmi.connected_to_cpu && !adev->gmc.is_app_apu) {
1051                 /* reserve PAT memory space to WC for VRAM */
1052                 int r = arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1053                                 adev->gmc.aper_size);
1054
1055                 if (r) {
1056                         DRM_ERROR("Unable to set WC memtype for the aperture base\n");
1057                         return r;
1058                 }
1059
1060                 /* Add an MTRR for the VRAM */
1061                 adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1062                                 adev->gmc.aper_size);
1063         }
1064
1065         DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1066                  adev->gmc.mc_vram_size >> 20,
1067                  (unsigned long long)adev->gmc.aper_size >> 20);
1068         DRM_INFO("RAM width %dbits %s\n",
1069                  adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1070         return amdgpu_ttm_init(adev);
1071 }
1072
1073 /**
1074  * amdgpu_bo_fini - tear down memory manager
1075  * @adev: amdgpu device object
1076  *
1077  * Reverses amdgpu_bo_init() to tear down memory manager.
1078  */
1079 void amdgpu_bo_fini(struct amdgpu_device *adev)
1080 {
1081         int idx;
1082
1083         amdgpu_ttm_fini(adev);
1084
1085         if (drm_dev_enter(adev_to_drm(adev), &idx)) {
1086                 if (!adev->gmc.xgmi.connected_to_cpu && !adev->gmc.is_app_apu) {
1087                         arch_phys_wc_del(adev->gmc.vram_mtrr);
1088                         arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1089                 }
1090                 drm_dev_exit(idx);
1091         }
1092 }
1093
1094 /**
1095  * amdgpu_bo_set_tiling_flags - set tiling flags
1096  * @bo: &amdgpu_bo buffer object
1097  * @tiling_flags: new flags
1098  *
1099  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1100  * kernel driver to set the tiling flags on a buffer.
1101  *
1102  * Returns:
1103  * 0 for success or a negative error code on failure.
1104  */
1105 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1106 {
1107         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1108         struct amdgpu_bo_user *ubo;
1109
1110         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1111         if (adev->family <= AMDGPU_FAMILY_CZ &&
1112             AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1113                 return -EINVAL;
1114
1115         ubo = to_amdgpu_bo_user(bo);
1116         ubo->tiling_flags = tiling_flags;
1117         return 0;
1118 }
1119
1120 /**
1121  * amdgpu_bo_get_tiling_flags - get tiling flags
1122  * @bo: &amdgpu_bo buffer object
1123  * @tiling_flags: returned flags
1124  *
1125  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1126  * set the tiling flags on a buffer.
1127  */
1128 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1129 {
1130         struct amdgpu_bo_user *ubo;
1131
1132         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1133         dma_resv_assert_held(bo->tbo.base.resv);
1134         ubo = to_amdgpu_bo_user(bo);
1135
1136         if (tiling_flags)
1137                 *tiling_flags = ubo->tiling_flags;
1138 }
1139
1140 /**
1141  * amdgpu_bo_set_metadata - set metadata
1142  * @bo: &amdgpu_bo buffer object
1143  * @metadata: new metadata
1144  * @metadata_size: size of the new metadata
1145  * @flags: flags of the new metadata
1146  *
1147  * Sets buffer object's metadata, its size and flags.
1148  * Used via GEM ioctl.
1149  *
1150  * Returns:
1151  * 0 for success or a negative error code on failure.
1152  */
1153 int amdgpu_bo_set_metadata(struct amdgpu_bo *bo, void *metadata,
1154                            u32 metadata_size, uint64_t flags)
1155 {
1156         struct amdgpu_bo_user *ubo;
1157         void *buffer;
1158
1159         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1160         ubo = to_amdgpu_bo_user(bo);
1161         if (!metadata_size) {
1162                 if (ubo->metadata_size) {
1163                         kfree(ubo->metadata);
1164                         ubo->metadata = NULL;
1165                         ubo->metadata_size = 0;
1166                 }
1167                 return 0;
1168         }
1169
1170         if (metadata == NULL)
1171                 return -EINVAL;
1172
1173         buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1174         if (buffer == NULL)
1175                 return -ENOMEM;
1176
1177         kfree(ubo->metadata);
1178         ubo->metadata_flags = flags;
1179         ubo->metadata = buffer;
1180         ubo->metadata_size = metadata_size;
1181
1182         return 0;
1183 }
1184
1185 /**
1186  * amdgpu_bo_get_metadata - get metadata
1187  * @bo: &amdgpu_bo buffer object
1188  * @buffer: returned metadata
1189  * @buffer_size: size of the buffer
1190  * @metadata_size: size of the returned metadata
1191  * @flags: flags of the returned metadata
1192  *
1193  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1194  * less than metadata_size.
1195  * Used via GEM ioctl.
1196  *
1197  * Returns:
1198  * 0 for success or a negative error code on failure.
1199  */
1200 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1201                            size_t buffer_size, uint32_t *metadata_size,
1202                            uint64_t *flags)
1203 {
1204         struct amdgpu_bo_user *ubo;
1205
1206         if (!buffer && !metadata_size)
1207                 return -EINVAL;
1208
1209         BUG_ON(bo->tbo.type == ttm_bo_type_kernel);
1210         ubo = to_amdgpu_bo_user(bo);
1211         if (metadata_size)
1212                 *metadata_size = ubo->metadata_size;
1213
1214         if (buffer) {
1215                 if (buffer_size < ubo->metadata_size)
1216                         return -EINVAL;
1217
1218                 if (ubo->metadata_size)
1219                         memcpy(buffer, ubo->metadata, ubo->metadata_size);
1220         }
1221
1222         if (flags)
1223                 *flags = ubo->metadata_flags;
1224
1225         return 0;
1226 }
1227
1228 /**
1229  * amdgpu_bo_move_notify - notification about a memory move
1230  * @bo: pointer to a buffer object
1231  * @evict: if this move is evicting the buffer from the graphics address space
1232  * @new_mem: new information of the bufer object
1233  *
1234  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1235  * bookkeeping.
1236  * TTM driver callback which is called when ttm moves a buffer.
1237  */
1238 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1239                            bool evict,
1240                            struct ttm_resource *new_mem)
1241 {
1242         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1243         struct amdgpu_bo *abo;
1244         struct ttm_resource *old_mem = bo->resource;
1245
1246         if (!amdgpu_bo_is_amdgpu_bo(bo))
1247                 return;
1248
1249         abo = ttm_to_amdgpu_bo(bo);
1250         amdgpu_vm_bo_invalidate(adev, abo, evict);
1251
1252         amdgpu_bo_kunmap(abo);
1253
1254         if (abo->tbo.base.dma_buf && !abo->tbo.base.import_attach &&
1255             bo->resource->mem_type != TTM_PL_SYSTEM)
1256                 dma_buf_move_notify(abo->tbo.base.dma_buf);
1257
1258         /* remember the eviction */
1259         if (evict)
1260                 atomic64_inc(&adev->num_evictions);
1261
1262         /* update statistics */
1263         if (!new_mem)
1264                 return;
1265
1266         /* move_notify is called before move happens */
1267         trace_amdgpu_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1268 }
1269
1270 void amdgpu_bo_get_memory(struct amdgpu_bo *bo,
1271                           struct amdgpu_mem_stats *stats)
1272 {
1273         unsigned int domain;
1274         uint64_t size = amdgpu_bo_size(bo);
1275
1276         domain = amdgpu_mem_type_to_domain(bo->tbo.resource->mem_type);
1277         switch (domain) {
1278         case AMDGPU_GEM_DOMAIN_VRAM:
1279                 stats->vram += size;
1280                 if (amdgpu_bo_in_cpu_visible_vram(bo))
1281                         stats->visible_vram += size;
1282                 break;
1283         case AMDGPU_GEM_DOMAIN_GTT:
1284                 stats->gtt += size;
1285                 break;
1286         case AMDGPU_GEM_DOMAIN_CPU:
1287         default:
1288                 stats->cpu += size;
1289                 break;
1290         }
1291
1292         if (bo->preferred_domains & AMDGPU_GEM_DOMAIN_VRAM) {
1293                 stats->requested_vram += size;
1294                 if (bo->flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
1295                         stats->requested_visible_vram += size;
1296
1297                 if (domain != AMDGPU_GEM_DOMAIN_VRAM) {
1298                         stats->evicted_vram += size;
1299                         if (bo->flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
1300                                 stats->evicted_visible_vram += size;
1301                 }
1302         } else if (bo->preferred_domains & AMDGPU_GEM_DOMAIN_GTT) {
1303                 stats->requested_gtt += size;
1304         }
1305 }
1306
1307 /**
1308  * amdgpu_bo_release_notify - notification about a BO being released
1309  * @bo: pointer to a buffer object
1310  *
1311  * Wipes VRAM buffers whose contents should not be leaked before the
1312  * memory is released.
1313  */
1314 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo)
1315 {
1316         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1317         struct dma_fence *fence = NULL;
1318         struct amdgpu_bo *abo;
1319         int r;
1320
1321         if (!amdgpu_bo_is_amdgpu_bo(bo))
1322                 return;
1323
1324         abo = ttm_to_amdgpu_bo(bo);
1325
1326         if (abo->kfd_bo)
1327                 amdgpu_amdkfd_release_notify(abo);
1328
1329         /* We only remove the fence if the resv has individualized. */
1330         WARN_ON_ONCE(bo->type == ttm_bo_type_kernel
1331                         && bo->base.resv != &bo->base._resv);
1332         if (bo->base.resv == &bo->base._resv)
1333                 amdgpu_amdkfd_remove_fence_on_pt_pd_bos(abo);
1334
1335         if (!bo->resource || bo->resource->mem_type != TTM_PL_VRAM ||
1336             !(abo->flags & AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE) ||
1337             adev->in_suspend || drm_dev_is_unplugged(adev_to_drm(adev)))
1338                 return;
1339
1340         if (WARN_ON_ONCE(!dma_resv_trylock(bo->base.resv)))
1341                 return;
1342
1343         r = amdgpu_fill_buffer(abo, AMDGPU_POISON, bo->base.resv, &fence);
1344         if (!WARN_ON(r)) {
1345                 amdgpu_bo_fence(abo, fence, false);
1346                 dma_fence_put(fence);
1347         }
1348
1349         dma_resv_unlock(bo->base.resv);
1350 }
1351
1352 /**
1353  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1354  * @bo: pointer to a buffer object
1355  *
1356  * Notifies the driver we are taking a fault on this BO and have reserved it,
1357  * also performs bookkeeping.
1358  * TTM driver callback for dealing with vm faults.
1359  *
1360  * Returns:
1361  * 0 for success or a negative error code on failure.
1362  */
1363 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1364 {
1365         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1366         struct ttm_operation_ctx ctx = { false, false };
1367         struct amdgpu_bo *abo = ttm_to_amdgpu_bo(bo);
1368         int r;
1369
1370         /* Remember that this BO was accessed by the CPU */
1371         abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1372
1373         if (bo->resource->mem_type != TTM_PL_VRAM)
1374                 return 0;
1375
1376         if (amdgpu_bo_in_cpu_visible_vram(abo))
1377                 return 0;
1378
1379         /* Can't move a pinned BO to visible VRAM */
1380         if (abo->tbo.pin_count > 0)
1381                 return VM_FAULT_SIGBUS;
1382
1383         /* hurrah the memory is not visible ! */
1384         atomic64_inc(&adev->num_vram_cpu_page_faults);
1385         amdgpu_bo_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1386                                         AMDGPU_GEM_DOMAIN_GTT);
1387
1388         /* Avoid costly evictions; only set GTT as a busy placement */
1389         abo->placement.num_busy_placement = 1;
1390         abo->placement.busy_placement = &abo->placements[1];
1391
1392         r = ttm_bo_validate(bo, &abo->placement, &ctx);
1393         if (unlikely(r == -EBUSY || r == -ERESTARTSYS))
1394                 return VM_FAULT_NOPAGE;
1395         else if (unlikely(r))
1396                 return VM_FAULT_SIGBUS;
1397
1398         /* this should never happen */
1399         if (bo->resource->mem_type == TTM_PL_VRAM &&
1400             !amdgpu_bo_in_cpu_visible_vram(abo))
1401                 return VM_FAULT_SIGBUS;
1402
1403         ttm_bo_move_to_lru_tail_unlocked(bo);
1404         return 0;
1405 }
1406
1407 /**
1408  * amdgpu_bo_fence - add fence to buffer object
1409  *
1410  * @bo: buffer object in question
1411  * @fence: fence to add
1412  * @shared: true if fence should be added shared
1413  *
1414  */
1415 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1416                      bool shared)
1417 {
1418         struct dma_resv *resv = bo->tbo.base.resv;
1419         int r;
1420
1421         r = dma_resv_reserve_fences(resv, 1);
1422         if (r) {
1423                 /* As last resort on OOM we block for the fence */
1424                 dma_fence_wait(fence, false);
1425                 return;
1426         }
1427
1428         dma_resv_add_fence(resv, fence, shared ? DMA_RESV_USAGE_READ :
1429                            DMA_RESV_USAGE_WRITE);
1430 }
1431
1432 /**
1433  * amdgpu_bo_sync_wait_resv - Wait for BO reservation fences
1434  *
1435  * @adev: amdgpu device pointer
1436  * @resv: reservation object to sync to
1437  * @sync_mode: synchronization mode
1438  * @owner: fence owner
1439  * @intr: Whether the wait is interruptible
1440  *
1441  * Extract the fences from the reservation object and waits for them to finish.
1442  *
1443  * Returns:
1444  * 0 on success, errno otherwise.
1445  */
1446 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
1447                              enum amdgpu_sync_mode sync_mode, void *owner,
1448                              bool intr)
1449 {
1450         struct amdgpu_sync sync;
1451         int r;
1452
1453         amdgpu_sync_create(&sync);
1454         amdgpu_sync_resv(adev, &sync, resv, sync_mode, owner);
1455         r = amdgpu_sync_wait(&sync, intr);
1456         amdgpu_sync_free(&sync);
1457         return r;
1458 }
1459
1460 /**
1461  * amdgpu_bo_sync_wait - Wrapper for amdgpu_bo_sync_wait_resv
1462  * @bo: buffer object to wait for
1463  * @owner: fence owner
1464  * @intr: Whether the wait is interruptible
1465  *
1466  * Wrapper to wait for fences in a BO.
1467  * Returns:
1468  * 0 on success, errno otherwise.
1469  */
1470 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr)
1471 {
1472         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1473
1474         return amdgpu_bo_sync_wait_resv(adev, bo->tbo.base.resv,
1475                                         AMDGPU_SYNC_NE_OWNER, owner, intr);
1476 }
1477
1478 /**
1479  * amdgpu_bo_gpu_offset - return GPU offset of bo
1480  * @bo: amdgpu object for which we query the offset
1481  *
1482  * Note: object should either be pinned or reserved when calling this
1483  * function, it might be useful to add check for this for debugging.
1484  *
1485  * Returns:
1486  * current GPU offset of the object.
1487  */
1488 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1489 {
1490         WARN_ON_ONCE(bo->tbo.resource->mem_type == TTM_PL_SYSTEM);
1491         WARN_ON_ONCE(!dma_resv_is_locked(bo->tbo.base.resv) &&
1492                      !bo->tbo.pin_count && bo->tbo.type != ttm_bo_type_kernel);
1493         WARN_ON_ONCE(bo->tbo.resource->start == AMDGPU_BO_INVALID_OFFSET);
1494         WARN_ON_ONCE(bo->tbo.resource->mem_type == TTM_PL_VRAM &&
1495                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1496
1497         return amdgpu_bo_gpu_offset_no_check(bo);
1498 }
1499
1500 /**
1501  * amdgpu_bo_gpu_offset_no_check - return GPU offset of bo
1502  * @bo: amdgpu object for which we query the offset
1503  *
1504  * Returns:
1505  * current GPU offset of the object without raising warnings.
1506  */
1507 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo)
1508 {
1509         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1510         uint64_t offset;
1511
1512         offset = (bo->tbo.resource->start << PAGE_SHIFT) +
1513                  amdgpu_ttm_domain_start(adev, bo->tbo.resource->mem_type);
1514
1515         return amdgpu_gmc_sign_extend(offset);
1516 }
1517
1518 /**
1519  * amdgpu_bo_get_preferred_domain - get preferred domain
1520  * @adev: amdgpu device object
1521  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1522  *
1523  * Returns:
1524  * Which of the allowed domains is preferred for allocating the BO.
1525  */
1526 uint32_t amdgpu_bo_get_preferred_domain(struct amdgpu_device *adev,
1527                                             uint32_t domain)
1528 {
1529         if ((domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) &&
1530             ((adev->asic_type == CHIP_CARRIZO) || (adev->asic_type == CHIP_STONEY))) {
1531                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1532                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1533                         domain = AMDGPU_GEM_DOMAIN_GTT;
1534         }
1535         return domain;
1536 }
1537
1538 #if defined(CONFIG_DEBUG_FS)
1539 #define amdgpu_bo_print_flag(m, bo, flag)                       \
1540         do {                                                    \
1541                 if (bo->flags & (AMDGPU_GEM_CREATE_ ## flag)) { \
1542                         seq_printf((m), " " #flag);             \
1543                 }                                               \
1544         } while (0)
1545
1546 /**
1547  * amdgpu_bo_print_info - print BO info in debugfs file
1548  *
1549  * @id: Index or Id of the BO
1550  * @bo: Requested BO for printing info
1551  * @m: debugfs file
1552  *
1553  * Print BO information in debugfs file
1554  *
1555  * Returns:
1556  * Size of the BO in bytes.
1557  */
1558 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m)
1559 {
1560         struct dma_buf_attachment *attachment;
1561         struct dma_buf *dma_buf;
1562         unsigned int domain;
1563         const char *placement;
1564         unsigned int pin_count;
1565         u64 size;
1566
1567         domain = amdgpu_mem_type_to_domain(bo->tbo.resource->mem_type);
1568         switch (domain) {
1569         case AMDGPU_GEM_DOMAIN_VRAM:
1570                 placement = "VRAM";
1571                 break;
1572         case AMDGPU_GEM_DOMAIN_GTT:
1573                 placement = " GTT";
1574                 break;
1575         case AMDGPU_GEM_DOMAIN_CPU:
1576         default:
1577                 placement = " CPU";
1578                 break;
1579         }
1580
1581         size = amdgpu_bo_size(bo);
1582         seq_printf(m, "\t\t0x%08x: %12lld byte %s",
1583                         id, size, placement);
1584
1585         pin_count = READ_ONCE(bo->tbo.pin_count);
1586         if (pin_count)
1587                 seq_printf(m, " pin count %d", pin_count);
1588
1589         dma_buf = READ_ONCE(bo->tbo.base.dma_buf);
1590         attachment = READ_ONCE(bo->tbo.base.import_attach);
1591
1592         if (attachment)
1593                 seq_printf(m, " imported from ino:%lu", file_inode(dma_buf->file)->i_ino);
1594         else if (dma_buf)
1595                 seq_printf(m, " exported as ino:%lu", file_inode(dma_buf->file)->i_ino);
1596
1597         amdgpu_bo_print_flag(m, bo, CPU_ACCESS_REQUIRED);
1598         amdgpu_bo_print_flag(m, bo, NO_CPU_ACCESS);
1599         amdgpu_bo_print_flag(m, bo, CPU_GTT_USWC);
1600         amdgpu_bo_print_flag(m, bo, VRAM_CLEARED);
1601         amdgpu_bo_print_flag(m, bo, VRAM_CONTIGUOUS);
1602         amdgpu_bo_print_flag(m, bo, VM_ALWAYS_VALID);
1603         amdgpu_bo_print_flag(m, bo, EXPLICIT_SYNC);
1604
1605         seq_puts(m, "\n");
1606
1607         return size;
1608 }
1609 #endif