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