1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (C) 2013 Red Hat 4 * Author: Rob Clark <robdclark@gmail.com> 5 */ 6 7 #ifndef __MSM_GEM_H__ 8 #define __MSM_GEM_H__ 9 10 #include <linux/kref.h> 11 #include <linux/dma-resv.h> 12 #include "drm/gpu_scheduler.h" 13 #include "msm_drv.h" 14 15 /* Make all GEM related WARN_ON()s ratelimited.. when things go wrong they 16 * tend to go wrong 1000s of times in a short timespan. 17 */ 18 #define GEM_WARN_ON(x) WARN_RATELIMIT(x, "%s", __stringify(x)) 19 20 /* Additional internal-use only BO flags: */ 21 #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 22 #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 23 24 struct msm_gem_address_space { 25 const char *name; 26 /* NOTE: mm managed at the page level, size is in # of pages 27 * and position mm_node->start is in # of pages: 28 */ 29 struct drm_mm mm; 30 spinlock_t lock; /* Protects drm_mm node allocation/removal */ 31 struct msm_mmu *mmu; 32 struct kref kref; 33 34 /* For address spaces associated with a specific process, this 35 * will be non-NULL: 36 */ 37 struct pid *pid; 38 39 /* @faults: the number of GPU hangs associated with this address space */ 40 int faults; 41 42 /** @va_start: lowest possible address to allocate */ 43 uint64_t va_start; 44 45 /** @va_size: the size of the address space (in bytes) */ 46 uint64_t va_size; 47 }; 48 49 struct msm_gem_address_space * 50 msm_gem_address_space_get(struct msm_gem_address_space *aspace); 51 52 void msm_gem_address_space_put(struct msm_gem_address_space *aspace); 53 54 struct msm_gem_address_space * 55 msm_gem_address_space_create(struct msm_mmu *mmu, const char *name, 56 u64 va_start, u64 size); 57 58 struct msm_fence_context; 59 60 struct msm_gem_vma { 61 struct drm_mm_node node; 62 spinlock_t lock; 63 uint64_t iova; 64 struct msm_gem_address_space *aspace; 65 struct list_head list; /* node in msm_gem_object::vmas */ 66 bool mapped; 67 int inuse; 68 uint32_t fence_mask; 69 uint32_t fence[MSM_GPU_MAX_RINGS]; 70 struct msm_fence_context *fctx[MSM_GPU_MAX_RINGS]; 71 }; 72 73 struct msm_gem_vma *msm_gem_vma_new(struct msm_gem_address_space *aspace); 74 int msm_gem_vma_init(struct msm_gem_vma *vma, int size, 75 u64 range_start, u64 range_end); 76 bool msm_gem_vma_inuse(struct msm_gem_vma *vma); 77 void msm_gem_vma_purge(struct msm_gem_vma *vma); 78 void msm_gem_vma_unpin(struct msm_gem_vma *vma); 79 void msm_gem_vma_unpin_fenced(struct msm_gem_vma *vma, struct msm_fence_context *fctx); 80 int msm_gem_vma_map(struct msm_gem_vma *vma, int prot, struct sg_table *sgt, int size); 81 void msm_gem_vma_close(struct msm_gem_vma *vma); 82 83 struct msm_gem_object { 84 struct drm_gem_object base; 85 86 uint32_t flags; 87 88 /** 89 * Advice: are the backing pages purgeable? 90 */ 91 uint8_t madv; 92 93 /** 94 * count of active vmap'ing 95 */ 96 uint8_t vmap_count; 97 98 /** 99 * Node in list of all objects (mainly for debugfs, protected by 100 * priv->obj_lock 101 */ 102 struct list_head node; 103 104 struct page **pages; 105 struct sg_table *sgt; 106 void *vaddr; 107 108 struct list_head vmas; /* list of msm_gem_vma */ 109 110 /* For physically contiguous buffers. Used when we don't have 111 * an IOMMU. Also used for stolen/splashscreen buffer. 112 */ 113 struct drm_mm_node *vram_node; 114 115 char name[32]; /* Identifier to print for the debugfs files */ 116 117 int pin_count; 118 }; 119 #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 120 121 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 122 int msm_gem_pin_vma_locked(struct drm_gem_object *obj, struct msm_gem_vma *vma); 123 void msm_gem_unpin_locked(struct drm_gem_object *obj); 124 struct msm_gem_vma *msm_gem_get_vma_locked(struct drm_gem_object *obj, 125 struct msm_gem_address_space *aspace); 126 int msm_gem_get_iova(struct drm_gem_object *obj, 127 struct msm_gem_address_space *aspace, uint64_t *iova); 128 int msm_gem_set_iova(struct drm_gem_object *obj, 129 struct msm_gem_address_space *aspace, uint64_t iova); 130 int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 131 struct msm_gem_address_space *aspace, uint64_t *iova, 132 u64 range_start, u64 range_end); 133 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 134 struct msm_gem_address_space *aspace, uint64_t *iova); 135 void msm_gem_unpin_iova(struct drm_gem_object *obj, 136 struct msm_gem_address_space *aspace); 137 struct page **msm_gem_pin_pages(struct drm_gem_object *obj); 138 void msm_gem_unpin_pages(struct drm_gem_object *obj); 139 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 140 struct drm_mode_create_dumb *args); 141 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 142 uint32_t handle, uint64_t *offset); 143 void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 144 void *msm_gem_get_vaddr(struct drm_gem_object *obj); 145 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 146 void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 147 void msm_gem_put_vaddr(struct drm_gem_object *obj); 148 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 149 bool msm_gem_active(struct drm_gem_object *obj); 150 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 151 int msm_gem_cpu_fini(struct drm_gem_object *obj); 152 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 153 uint32_t size, uint32_t flags, uint32_t *handle, char *name); 154 struct drm_gem_object *msm_gem_new(struct drm_device *dev, 155 uint32_t size, uint32_t flags); 156 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 157 uint32_t flags, struct msm_gem_address_space *aspace, 158 struct drm_gem_object **bo, uint64_t *iova); 159 void msm_gem_kernel_put(struct drm_gem_object *bo, 160 struct msm_gem_address_space *aspace); 161 struct drm_gem_object *msm_gem_import(struct drm_device *dev, 162 struct dma_buf *dmabuf, struct sg_table *sgt); 163 __printf(2, 3) 164 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 165 166 #ifdef CONFIG_DEBUG_FS 167 struct msm_gem_stats { 168 struct { 169 unsigned count; 170 size_t size; 171 } all, active, resident, purgeable, purged; 172 }; 173 174 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m, 175 struct msm_gem_stats *stats); 176 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 177 #endif 178 179 static inline void 180 msm_gem_lock(struct drm_gem_object *obj) 181 { 182 dma_resv_lock(obj->resv, NULL); 183 } 184 185 static inline int 186 msm_gem_lock_interruptible(struct drm_gem_object *obj) 187 { 188 return dma_resv_lock_interruptible(obj->resv, NULL); 189 } 190 191 static inline void 192 msm_gem_unlock(struct drm_gem_object *obj) 193 { 194 dma_resv_unlock(obj->resv); 195 } 196 197 static inline void 198 msm_gem_assert_locked(struct drm_gem_object *obj) 199 { 200 /* 201 * Destroying the object is a special case.. msm_gem_free_object() 202 * calls many things that WARN_ON if the obj lock is not held. But 203 * acquiring the obj lock in msm_gem_free_object() can cause a 204 * locking order inversion between reservation_ww_class_mutex and 205 * fs_reclaim. 206 * 207 * This deadlock is not actually possible, because no one should 208 * be already holding the lock when msm_gem_free_object() is called. 209 * Unfortunately lockdep is not aware of this detail. So when the 210 * refcount drops to zero, we pretend it is already locked. 211 */ 212 lockdep_assert_once( 213 (kref_read(&obj->refcount) == 0) || 214 (lockdep_is_held(&obj->resv->lock.base) != LOCK_STATE_NOT_HELD) 215 ); 216 } 217 218 /* imported/exported objects are not purgeable: */ 219 static inline bool is_unpurgeable(struct msm_gem_object *msm_obj) 220 { 221 return msm_obj->base.import_attach || msm_obj->pin_count; 222 } 223 224 static inline bool is_purgeable(struct msm_gem_object *msm_obj) 225 { 226 return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 227 !is_unpurgeable(msm_obj); 228 } 229 230 static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 231 { 232 msm_gem_assert_locked(&msm_obj->base); 233 return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 234 } 235 236 static inline bool is_unevictable(struct msm_gem_object *msm_obj) 237 { 238 return is_unpurgeable(msm_obj) || msm_obj->vaddr; 239 } 240 241 void msm_gem_purge(struct drm_gem_object *obj); 242 void msm_gem_evict(struct drm_gem_object *obj); 243 void msm_gem_vunmap(struct drm_gem_object *obj); 244 245 /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 246 * associated with the cmdstream submission for synchronization (and 247 * make it easier to unwind when things go wrong, etc). 248 */ 249 struct msm_gem_submit { 250 struct drm_sched_job base; 251 struct kref ref; 252 struct drm_device *dev; 253 struct msm_gpu *gpu; 254 struct msm_gem_address_space *aspace; 255 struct list_head node; /* node in ring submit list */ 256 struct ww_acquire_ctx ticket; 257 uint32_t seqno; /* Sequence number of the submit on the ring */ 258 259 /* Hw fence, which is created when the scheduler executes the job, and 260 * is signaled when the hw finishes (via seqno write from cmdstream) 261 */ 262 struct dma_fence *hw_fence; 263 264 /* Userspace visible fence, which is signaled by the scheduler after 265 * the hw_fence is signaled. 266 */ 267 struct dma_fence *user_fence; 268 269 int fence_id; /* key into queue->fence_idr */ 270 struct msm_gpu_submitqueue *queue; 271 struct pid *pid; /* submitting process */ 272 bool fault_dumped; /* Limit devcoredump dumping to one per submit */ 273 bool valid; /* true if no cmdstream patching needed */ 274 bool in_rb; /* "sudo" mode, copy cmds into RB */ 275 struct msm_ringbuffer *ring; 276 unsigned int nr_cmds; 277 unsigned int nr_bos; 278 u32 ident; /* A "identifier" for the submit for logging */ 279 struct { 280 uint32_t type; 281 uint32_t size; /* in dwords */ 282 uint64_t iova; 283 uint32_t offset;/* in dwords */ 284 uint32_t idx; /* cmdstream buffer idx in bos[] */ 285 uint32_t nr_relocs; 286 struct drm_msm_gem_submit_reloc *relocs; 287 } *cmd; /* array of size nr_cmds */ 288 struct { 289 /* make sure these don't conflict w/ MSM_SUBMIT_BO_x */ 290 #define BO_VALID 0x8000 /* is current addr in cmdstream correct/valid? */ 291 #define BO_LOCKED 0x4000 /* obj lock is held */ 292 #define BO_OBJ_PINNED 0x2000 /* obj (pages) is pinned and on active list */ 293 #define BO_VMA_PINNED 0x1000 /* vma (virtual address) is pinned */ 294 uint32_t flags; 295 union { 296 struct msm_gem_object *obj; 297 uint32_t handle; 298 }; 299 uint64_t iova; 300 struct msm_gem_vma *vma; 301 } bos[]; 302 }; 303 304 static inline struct msm_gem_submit *to_msm_submit(struct drm_sched_job *job) 305 { 306 return container_of(job, struct msm_gem_submit, base); 307 } 308 309 void __msm_gem_submit_destroy(struct kref *kref); 310 311 static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 312 { 313 kref_get(&submit->ref); 314 } 315 316 static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 317 { 318 kref_put(&submit->ref, __msm_gem_submit_destroy); 319 } 320 321 void msm_submit_retire(struct msm_gem_submit *submit); 322 323 /* helper to determine of a buffer in submit should be dumped, used for both 324 * devcoredump and debugfs cmdstream dumping: 325 */ 326 static inline bool 327 should_dump(struct msm_gem_submit *submit, int idx) 328 { 329 extern bool rd_full; 330 return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 331 } 332 333 #endif /* __MSM_GEM_H__ */ 334