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 /* xcp partition number plus 1, 0 means any partition */ 60 int8_t xcp_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 * protected by vm reservation lock 96 * if non-zero, cannot unmap from GPU because user queues may still access it 97 */ 98 unsigned int queue_refcount; 99 }; 100 101 struct amdgpu_bo { 102 /* Protected by tbo.reserved */ 103 u32 preferred_domains; 104 u32 allowed_domains; 105 struct ttm_place placements[AMDGPU_BO_MAX_PLACEMENTS]; 106 struct ttm_placement placement; 107 struct ttm_buffer_object tbo; 108 struct ttm_bo_kmap_obj kmap; 109 u64 flags; 110 /* per VM structure for page tables and with virtual addresses */ 111 struct amdgpu_vm_bo_base *vm_bo; 112 /* Constant after initialization */ 113 struct amdgpu_bo *parent; 114 115 #ifdef CONFIG_MMU_NOTIFIER 116 struct mmu_interval_notifier notifier; 117 #endif 118 struct kgd_mem *kfd_bo; 119 120 /* 121 * For GPUs with spatial partitioning, xcp partition number, -1 means 122 * any partition. For other ASICs without spatial partition, always 0 123 * for memory accounting. 124 */ 125 int8_t xcp_id; 126 }; 127 128 struct amdgpu_bo_user { 129 struct amdgpu_bo bo; 130 u64 tiling_flags; 131 u64 metadata_flags; 132 void *metadata; 133 u32 metadata_size; 134 135 }; 136 137 struct amdgpu_bo_vm { 138 struct amdgpu_bo bo; 139 struct amdgpu_vm_bo_base entries[]; 140 }; 141 142 struct amdgpu_mem_stats { 143 struct drm_memory_stats drm; 144 145 uint64_t visible; 146 uint64_t evicted; 147 uint64_t evicted_visible; 148 uint64_t requested; 149 uint64_t requested_visible; 150 }; 151 152 static inline struct amdgpu_bo *ttm_to_amdgpu_bo(struct ttm_buffer_object *tbo) 153 { 154 return container_of(tbo, struct amdgpu_bo, tbo); 155 } 156 157 /** 158 * amdgpu_mem_type_to_domain - return domain corresponding to mem_type 159 * @mem_type: ttm memory type 160 * 161 * Returns corresponding domain of the ttm mem_type 162 */ 163 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type) 164 { 165 switch (mem_type) { 166 case TTM_PL_VRAM: 167 return AMDGPU_GEM_DOMAIN_VRAM; 168 case TTM_PL_TT: 169 return AMDGPU_GEM_DOMAIN_GTT; 170 case TTM_PL_SYSTEM: 171 return AMDGPU_GEM_DOMAIN_CPU; 172 case AMDGPU_PL_GDS: 173 return AMDGPU_GEM_DOMAIN_GDS; 174 case AMDGPU_PL_GWS: 175 return AMDGPU_GEM_DOMAIN_GWS; 176 case AMDGPU_PL_OA: 177 return AMDGPU_GEM_DOMAIN_OA; 178 case AMDGPU_PL_DOORBELL: 179 return AMDGPU_GEM_DOMAIN_DOORBELL; 180 default: 181 break; 182 } 183 return 0; 184 } 185 186 /** 187 * amdgpu_bo_reserve - reserve bo 188 * @bo: bo structure 189 * @no_intr: don't return -ERESTARTSYS on pending signal 190 * 191 * Returns: 192 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 193 * a signal. Release all buffer reservations and return to user-space. 194 */ 195 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr) 196 { 197 struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev); 198 int r; 199 200 r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL); 201 if (unlikely(r != 0)) { 202 if (r != -ERESTARTSYS) 203 dev_err(adev->dev, "%p reserve failed\n", bo); 204 return r; 205 } 206 return 0; 207 } 208 209 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo) 210 { 211 ttm_bo_unreserve(&bo->tbo); 212 } 213 214 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo) 215 { 216 return bo->tbo.base.size; 217 } 218 219 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo) 220 { 221 return bo->tbo.base.size / AMDGPU_GPU_PAGE_SIZE; 222 } 223 224 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo) 225 { 226 return (bo->tbo.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE; 227 } 228 229 /** 230 * amdgpu_bo_mmap_offset - return mmap offset of bo 231 * @bo: amdgpu object for which we query the offset 232 * 233 * Returns mmap offset of the object. 234 */ 235 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo) 236 { 237 return drm_vma_node_offset_addr(&bo->tbo.base.vma_node); 238 } 239 240 /** 241 * amdgpu_bo_explicit_sync - return whether the bo is explicitly synced 242 */ 243 static inline bool amdgpu_bo_explicit_sync(struct amdgpu_bo *bo) 244 { 245 return bo->flags & AMDGPU_GEM_CREATE_EXPLICIT_SYNC; 246 } 247 248 /** 249 * amdgpu_bo_encrypted - test if the BO is encrypted 250 * @bo: pointer to a buffer object 251 * 252 * Return true if the buffer object is encrypted, false otherwise. 253 */ 254 static inline bool amdgpu_bo_encrypted(struct amdgpu_bo *bo) 255 { 256 return bo->flags & AMDGPU_GEM_CREATE_ENCRYPTED; 257 } 258 259 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo); 260 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain); 261 262 int amdgpu_bo_create(struct amdgpu_device *adev, 263 struct amdgpu_bo_param *bp, 264 struct amdgpu_bo **bo_ptr); 265 int amdgpu_bo_create_reserved(struct amdgpu_device *adev, 266 unsigned long size, int align, 267 u32 domain, struct amdgpu_bo **bo_ptr, 268 u64 *gpu_addr, void **cpu_addr); 269 int amdgpu_bo_create_kernel(struct amdgpu_device *adev, 270 unsigned long size, int align, 271 u32 domain, struct amdgpu_bo **bo_ptr, 272 u64 *gpu_addr, void **cpu_addr); 273 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev, 274 uint64_t offset, uint64_t size, 275 struct amdgpu_bo **bo_ptr, void **cpu_addr); 276 int amdgpu_bo_create_user(struct amdgpu_device *adev, 277 struct amdgpu_bo_param *bp, 278 struct amdgpu_bo_user **ubo_ptr); 279 int amdgpu_bo_create_vm(struct amdgpu_device *adev, 280 struct amdgpu_bo_param *bp, 281 struct amdgpu_bo_vm **ubo_ptr); 282 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr, 283 void **cpu_addr); 284 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr); 285 void *amdgpu_bo_kptr(struct amdgpu_bo *bo); 286 void amdgpu_bo_kunmap(struct amdgpu_bo *bo); 287 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo); 288 void amdgpu_bo_unref(struct amdgpu_bo **bo); 289 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain); 290 void amdgpu_bo_unpin(struct amdgpu_bo *bo); 291 int amdgpu_bo_init(struct amdgpu_device *adev); 292 void amdgpu_bo_fini(struct amdgpu_device *adev); 293 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags); 294 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags); 295 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata, 296 uint32_t metadata_size, uint64_t flags); 297 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer, 298 size_t buffer_size, uint32_t *metadata_size, 299 uint64_t *flags); 300 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo, 301 bool evict, 302 struct ttm_resource *new_mem); 303 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo); 304 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo); 305 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence, 306 bool shared); 307 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv, 308 enum amdgpu_sync_mode sync_mode, void *owner, 309 bool intr); 310 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr); 311 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo); 312 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo); 313 void amdgpu_bo_get_memory(struct amdgpu_bo *bo, 314 struct amdgpu_mem_stats *stats, 315 unsigned int size); 316 uint32_t amdgpu_bo_get_preferred_domain(struct amdgpu_device *adev, 317 uint32_t domain); 318 319 /* 320 * sub allocation 321 */ 322 static inline struct amdgpu_sa_manager * 323 to_amdgpu_sa_manager(struct drm_suballoc_manager *manager) 324 { 325 return container_of(manager, struct amdgpu_sa_manager, base); 326 } 327 328 static inline uint64_t amdgpu_sa_bo_gpu_addr(struct drm_suballoc *sa_bo) 329 { 330 return to_amdgpu_sa_manager(sa_bo->manager)->gpu_addr + 331 drm_suballoc_soffset(sa_bo); 332 } 333 334 static inline void *amdgpu_sa_bo_cpu_addr(struct drm_suballoc *sa_bo) 335 { 336 return to_amdgpu_sa_manager(sa_bo->manager)->cpu_ptr + 337 drm_suballoc_soffset(sa_bo); 338 } 339 340 int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev, 341 struct amdgpu_sa_manager *sa_manager, 342 unsigned size, u32 align, u32 domain); 343 void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev, 344 struct amdgpu_sa_manager *sa_manager); 345 int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev, 346 struct amdgpu_sa_manager *sa_manager); 347 int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager, 348 struct drm_suballoc **sa_bo, 349 unsigned int size); 350 void amdgpu_sa_bo_free(struct amdgpu_device *adev, 351 struct drm_suballoc **sa_bo, 352 struct dma_fence *fence); 353 #if defined(CONFIG_DEBUG_FS) 354 void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager, 355 struct seq_file *m); 356 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m); 357 #endif 358 void amdgpu_debugfs_sa_init(struct amdgpu_device *adev); 359 360 bool amdgpu_bo_support_uswc(u64 bo_flags); 361 362 363 #endif 364