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

   1 /*
   2  * Copyright 2008 Advanced Micro Devices, Inc.
   3  * Copyright 2008 Red Hat Inc.
   4  * Copyright 2009 Jerome Glisse.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors: Dave Airlie
  25  *          Alex Deucher
  26  *          Jerome Glisse
  27  */
  28 #ifndef __AMDGPU_OBJECT_H__
  29 #define __AMDGPU_OBJECT_H__
  30
  31 #include <drm/amdgpu_drm.h>
  32 #include "amdgpu.h"
  33 #include "amdgpu_res_cursor.h"
  34
  35 #ifdef CONFIG_MMU_NOTIFIER
  36 #include <linux/mmu_notifier.h>
  37 #endif
  38
  39 #define AMDGPU_BO_INVALID_OFFSET        LONG_MAX
  40 #define AMDGPU_BO_MAX_PLACEMENTS        3
  41
  42 /* BO flag to indicate a KFD userptr BO */
  43 #define AMDGPU_AMDKFD_CREATE_USERPTR_BO (1ULL << 63)
  44
  45 #define to_amdgpu_bo_user(abo) container_of((abo), struct amdgpu_bo_user, bo)
  46 #define to_amdgpu_bo_vm(abo) container_of((abo), struct amdgpu_bo_vm, bo)
  47
  48 struct amdgpu_bo_param {
  49         unsigned long                   size;
  50         int                             byte_align;
  51         u32                             bo_ptr_size;
  52         u32                             domain;
  53         u32                             preferred_domain;
  54         u64                             flags;
  55         enum ttm_bo_type                type;
  56         bool                            no_wait_gpu;
  57         struct dma_resv                 *resv;
  58         void                            (*destroy)(struct ttm_buffer_object *bo);
  59         /* memory partition number plus 1, 0 means any partition */
  60         int8_t                          mem_id_plus1;
  61 };
  62
  63 /* bo virtual addresses in a vm */
  64 struct amdgpu_bo_va_mapping {
  65         struct amdgpu_bo_va             *bo_va;
  66         struct list_head                list;
  67         struct rb_node                  rb;
  68         uint64_t                        start;
  69         uint64_t                        last;
  70         uint64_t                        __subtree_last;
  71         uint64_t                        offset;
  72         uint64_t                        flags;
  73 };
  74
  75 /* User space allocated BO in a VM */
  76 struct amdgpu_bo_va {
  77         struct amdgpu_vm_bo_base        base;
  78
  79         /* protected by bo being reserved */
  80         unsigned                        ref_count;
  81
  82         /* all other members protected by the VM PD being reserved */
  83         struct dma_fence                *last_pt_update;
  84
  85         /* mappings for this bo_va */
  86         struct list_head                invalids;
  87         struct list_head                valids;
  88
  89         /* If the mappings are cleared or filled */
  90         bool                            cleared;
  91
  92         bool                            is_xgmi;
  93 };
  94
  95 struct amdgpu_bo {
  96         /* Protected by tbo.reserved */
  97         u32                             preferred_domains;
  98         u32                             allowed_domains;
  99         struct ttm_place                placements[AMDGPU_BO_MAX_PLACEMENTS];
 100         struct ttm_placement            placement;
 101         struct ttm_buffer_object        tbo;
 102         struct ttm_bo_kmap_obj          kmap;
 103         u64                             flags;
 104         /* per VM structure for page tables and with virtual addresses */
 105         struct amdgpu_vm_bo_base        *vm_bo;
 106         /* Constant after initialization */
 107         struct amdgpu_bo                *parent;
 108
 109 #ifdef CONFIG_MMU_NOTIFIER
 110         struct mmu_interval_notifier    notifier;
 111 #endif
 112         struct kgd_mem                  *kfd_bo;
 113
 114         /* memory partition number, -1 means any partition */
 115         int8_t                          mem_id;
 116 };
 117
 118 struct amdgpu_bo_user {
 119         struct amdgpu_bo                bo;
 120         u64                             tiling_flags;
 121         u64                             metadata_flags;
 122         void                            *metadata;
 123         u32                             metadata_size;
 124
 125 };
 126
 127 struct amdgpu_bo_vm {
 128         struct amdgpu_bo                bo;
 129         struct amdgpu_bo                *shadow;
 130         struct list_head                shadow_list;
 131         struct amdgpu_vm_bo_base        entries[];
 132 };
 133
 134 struct amdgpu_mem_stats {
 135         /* current VRAM usage, includes visible VRAM */
 136         uint64_t vram;
 137         /* current visible VRAM usage */
 138         uint64_t visible_vram;
 139         /* current GTT usage */
 140         uint64_t gtt;
 141         /* current system memory usage */
 142         uint64_t cpu;
 143         /* sum of evicted buffers, includes visible VRAM */
 144         uint64_t evicted_vram;
 145         /* sum of evicted buffers due to CPU access */
 146         uint64_t evicted_visible_vram;
 147         /* how much userspace asked for, includes vis.VRAM */
 148         uint64_t requested_vram;
 149         /* how much userspace asked for */
 150         uint64_t requested_visible_vram;
 151         /* how much userspace asked for */
 152         uint64_t requested_gtt;
 153 };
 154
 155 static inline struct amdgpu_bo *ttm_to_amdgpu_bo(struct ttm_buffer_object *tbo)
 156 {
 157         return container_of(tbo, struct amdgpu_bo, tbo);
 158 }
 159
 160 /**
 161  * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
 162  * @mem_type:   ttm memory type
 163  *
 164  * Returns corresponding domain of the ttm mem_type
 165  */
 166 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
 167 {
 168         switch (mem_type) {
 169         case TTM_PL_VRAM:
 170                 return AMDGPU_GEM_DOMAIN_VRAM;
 171         case TTM_PL_TT:
 172                 return AMDGPU_GEM_DOMAIN_GTT;
 173         case TTM_PL_SYSTEM:
 174                 return AMDGPU_GEM_DOMAIN_CPU;
 175         case AMDGPU_PL_GDS:
 176                 return AMDGPU_GEM_DOMAIN_GDS;
 177         case AMDGPU_PL_GWS:
 178                 return AMDGPU_GEM_DOMAIN_GWS;
 179         case AMDGPU_PL_OA:
 180                 return AMDGPU_GEM_DOMAIN_OA;
 181         default:
 182                 break;
 183         }
 184         return 0;
 185 }
 186
 187 /**
 188  * amdgpu_bo_reserve - reserve bo
 189  * @bo:         bo structure
 190  * @no_intr:    don't return -ERESTARTSYS on pending signal
 191  *
 192  * Returns:
 193  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
 194  * a signal. Release all buffer reservations and return to user-space.
 195  */
 196 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
 197 {
 198         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 199         int r;
 200
 201         r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
 202         if (unlikely(r != 0)) {
 203                 if (r != -ERESTARTSYS)
 204                         dev_err(adev->dev, "%p reserve failed\n", bo);
 205                 return r;
 206         }
 207         return 0;
 208 }
 209
 210 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
 211 {
 212         ttm_bo_unreserve(&bo->tbo);
 213 }
 214
 215 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
 216 {
 217         return bo->tbo.base.size;
 218 }
 219
 220 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
 221 {
 222         return bo->tbo.base.size / AMDGPU_GPU_PAGE_SIZE;
 223 }
 224
 225 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
 226 {
 227         return (bo->tbo.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
 228 }
 229
 230 /**
 231  * amdgpu_bo_mmap_offset - return mmap offset of bo
 232  * @bo: amdgpu object for which we query the offset
 233  *
 234  * Returns mmap offset of the object.
 235  */
 236 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
 237 {
 238         return drm_vma_node_offset_addr(&bo->tbo.base.vma_node);
 239 }
 240
 241 /**
 242  * amdgpu_bo_in_cpu_visible_vram - check if BO is (partly) in visible VRAM
 243  */
 244 static inline bool amdgpu_bo_in_cpu_visible_vram(struct amdgpu_bo *bo)
 245 {
 246         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 247         struct amdgpu_res_cursor cursor;
 248
 249         if (bo->tbo.resource->mem_type != TTM_PL_VRAM)
 250                 return false;
 251
 252         amdgpu_res_first(bo->tbo.resource, 0, amdgpu_bo_size(bo), &cursor);
 253         while (cursor.remaining) {
 254                 if (cursor.start < adev->gmc.visible_vram_size)
 255                         return true;
 256
 257                 amdgpu_res_next(&cursor, cursor.size);
 258         }
 259
 260         return false;
 261 }
 262
 263 /**
 264  * amdgpu_bo_explicit_sync - return whether the bo is explicitly synced
 265  */
 266 static inline bool amdgpu_bo_explicit_sync(struct amdgpu_bo *bo)
 267 {
 268         return bo->flags & AMDGPU_GEM_CREATE_EXPLICIT_SYNC;
 269 }
 270
 271 /**
 272  * amdgpu_bo_encrypted - test if the BO is encrypted
 273  * @bo: pointer to a buffer object
 274  *
 275  * Return true if the buffer object is encrypted, false otherwise.
 276  */
 277 static inline bool amdgpu_bo_encrypted(struct amdgpu_bo *bo)
 278 {
 279         return bo->flags & AMDGPU_GEM_CREATE_ENCRYPTED;
 280 }
 281
 282 /**
 283  * amdgpu_bo_shadowed - check if the BO is shadowed
 284  *
 285  * @bo: BO to be tested.
 286  *
 287  * Returns:
 288  * NULL if not shadowed or else return a BO pointer.
 289  */
 290 static inline struct amdgpu_bo *amdgpu_bo_shadowed(struct amdgpu_bo *bo)
 291 {
 292         if (bo->tbo.type == ttm_bo_type_kernel)
 293                 return to_amdgpu_bo_vm(bo)->shadow;
 294
 295         return NULL;
 296 }
 297
 298 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo);
 299 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain);
 300
 301 int amdgpu_bo_create(struct amdgpu_device *adev,
 302                      struct amdgpu_bo_param *bp,
 303                      struct amdgpu_bo **bo_ptr);
 304 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 305                               unsigned long size, int align,
 306                               u32 domain, struct amdgpu_bo **bo_ptr,
 307                               u64 *gpu_addr, void **cpu_addr);
 308 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 309                             unsigned long size, int align,
 310                             u32 domain, struct amdgpu_bo **bo_ptr,
 311                             u64 *gpu_addr, void **cpu_addr);
 312 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
 313                                uint64_t offset, uint64_t size,
 314                                struct amdgpu_bo **bo_ptr, void **cpu_addr);
 315 int amdgpu_bo_create_user(struct amdgpu_device *adev,
 316                           struct amdgpu_bo_param *bp,
 317                           struct amdgpu_bo_user **ubo_ptr);
 318 int amdgpu_bo_create_vm(struct amdgpu_device *adev,
 319                         struct amdgpu_bo_param *bp,
 320                         struct amdgpu_bo_vm **ubo_ptr);
 321 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 322                            void **cpu_addr);
 323 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
 324 void *amdgpu_bo_kptr(struct amdgpu_bo *bo);
 325 void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
 326 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
 327 void amdgpu_bo_unref(struct amdgpu_bo **bo);
 328 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain);
 329 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 330                              u64 min_offset, u64 max_offset);
 331 void amdgpu_bo_unpin(struct amdgpu_bo *bo);
 332 int amdgpu_bo_init(struct amdgpu_device *adev);
 333 void amdgpu_bo_fini(struct amdgpu_device *adev);
 334 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
 335 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
 336 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
 337                             uint32_t metadata_size, uint64_t flags);
 338 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
 339                            size_t buffer_size, uint32_t *metadata_size,
 340                            uint64_t *flags);
 341 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
 342                            bool evict,
 343                            struct ttm_resource *new_mem);
 344 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo);
 345 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
 346 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
 347                      bool shared);
 348 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
 349                              enum amdgpu_sync_mode sync_mode, void *owner,
 350                              bool intr);
 351 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr);
 352 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
 353 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo);
 354 void amdgpu_bo_get_memory(struct amdgpu_bo *bo,
 355                           struct amdgpu_mem_stats *stats);
 356 void amdgpu_bo_add_to_shadow_list(struct amdgpu_bo_vm *vmbo);
 357 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow,
 358                              struct dma_fence **fence);
 359 uint32_t amdgpu_bo_get_preferred_domain(struct amdgpu_device *adev,
 360                                             uint32_t domain);
 361
 362 /*
 363  * sub allocation
 364  */
 365 static inline struct amdgpu_sa_manager *
 366 to_amdgpu_sa_manager(struct drm_suballoc_manager *manager)
 367 {
 368         return container_of(manager, struct amdgpu_sa_manager, base);
 369 }
 370
 371 static inline uint64_t amdgpu_sa_bo_gpu_addr(struct drm_suballoc *sa_bo)
 372 {
 373         return to_amdgpu_sa_manager(sa_bo->manager)->gpu_addr +
 374                 drm_suballoc_soffset(sa_bo);
 375 }
 376
 377 static inline void *amdgpu_sa_bo_cpu_addr(struct drm_suballoc *sa_bo)
 378 {
 379         return to_amdgpu_sa_manager(sa_bo->manager)->cpu_ptr +
 380                 drm_suballoc_soffset(sa_bo);
 381 }
 382
 383 int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev,
 384                                      struct amdgpu_sa_manager *sa_manager,
 385                                      unsigned size, u32 align, u32 domain);
 386 void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev,
 387                                       struct amdgpu_sa_manager *sa_manager);
 388 int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev,
 389                                       struct amdgpu_sa_manager *sa_manager);
 390 int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager,
 391                      struct drm_suballoc **sa_bo,
 392                      unsigned int size);
 393 void amdgpu_sa_bo_free(struct amdgpu_device *adev,
 394                        struct drm_suballoc **sa_bo,
 395                        struct dma_fence *fence);
 396 #if defined(CONFIG_DEBUG_FS)
 397 void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager,
 398                                          struct seq_file *m);
 399 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m);
 400 #endif
 401 void amdgpu_debugfs_sa_init(struct amdgpu_device *adev);
 402
 403 bool amdgpu_bo_support_uswc(u64 bo_flags);
 404
 405
 406 #endif