1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2013 Red Hat
4 * Author: Rob Clark <robdclark@gmail.com>
10 #include <linux/kref.h>
11 #include <linux/dma-resv.h>
12 #include "drm/gpu_scheduler.h"
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.
18 #define GEM_WARN_ON(x) WARN_RATELIMIT(x, "%s", __stringify(x))
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 */
24 struct msm_gem_address_space {
26 /* NOTE: mm managed at the page level, size is in # of pages
27 * and position mm_node->start is in # of pages:
30 spinlock_t lock; /* Protects drm_mm node allocation/removal */
34 /* For address spaces associated with a specific process, this
39 /* @faults: the number of GPU hangs associated with this address space */
42 /** @va_start: lowest possible address to allocate */
45 /** @va_size: the size of the address space (in bytes) */
49 struct msm_gem_address_space *
50 msm_gem_address_space_get(struct msm_gem_address_space *aspace);
52 void msm_gem_address_space_put(struct msm_gem_address_space *aspace);
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);
58 struct msm_fence_context;
61 struct drm_mm_node node;
63 struct msm_gem_address_space *aspace;
64 struct list_head list; /* node in msm_gem_object::vmas */
68 uint32_t fence[MSM_GPU_MAX_RINGS];
69 struct msm_fence_context *fctx[MSM_GPU_MAX_RINGS];
72 int msm_gem_init_vma(struct msm_gem_address_space *aspace,
73 struct msm_gem_vma *vma, int size,
74 u64 range_start, u64 range_end);
75 bool msm_gem_vma_inuse(struct msm_gem_vma *vma);
76 void msm_gem_purge_vma(struct msm_gem_address_space *aspace,
77 struct msm_gem_vma *vma);
78 void msm_gem_unpin_vma(struct msm_gem_vma *vma);
79 void msm_gem_unpin_vma_fenced(struct msm_gem_vma *vma, struct msm_fence_context *fctx);
80 int msm_gem_map_vma(struct msm_gem_address_space *aspace,
81 struct msm_gem_vma *vma, int prot,
82 struct sg_table *sgt, int size);
83 void msm_gem_close_vma(struct msm_gem_address_space *aspace,
84 struct msm_gem_vma *vma);
86 struct msm_gem_object {
87 struct drm_gem_object base;
92 * Advice: are the backing pages purgeable?
97 * count of active vmap'ing
102 * Node in list of all objects (mainly for debugfs, protected by
105 struct list_head node;
108 struct sg_table *sgt;
111 struct list_head vmas; /* list of msm_gem_vma */
113 /* For physically contiguous buffers. Used when we don't have
114 * an IOMMU. Also used for stolen/splashscreen buffer.
116 struct drm_mm_node *vram_node;
118 char name[32]; /* Identifier to print for the debugfs files */
122 #define to_msm_bo(x) container_of(x, struct msm_gem_object, base)
124 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj);
125 int msm_gem_pin_vma_locked(struct drm_gem_object *obj, struct msm_gem_vma *vma);
126 void msm_gem_unpin_locked(struct drm_gem_object *obj);
127 struct msm_gem_vma *msm_gem_get_vma_locked(struct drm_gem_object *obj,
128 struct msm_gem_address_space *aspace);
129 int msm_gem_get_iova(struct drm_gem_object *obj,
130 struct msm_gem_address_space *aspace, uint64_t *iova);
131 int msm_gem_set_iova(struct drm_gem_object *obj,
132 struct msm_gem_address_space *aspace, uint64_t iova);
133 int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj,
134 struct msm_gem_address_space *aspace, uint64_t *iova,
135 u64 range_start, u64 range_end);
136 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj,
137 struct msm_gem_address_space *aspace, uint64_t *iova);
138 void msm_gem_unpin_iova(struct drm_gem_object *obj,
139 struct msm_gem_address_space *aspace);
140 struct page **msm_gem_pin_pages(struct drm_gem_object *obj);
141 void msm_gem_unpin_pages(struct drm_gem_object *obj);
142 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
143 struct drm_mode_create_dumb *args);
144 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
145 uint32_t handle, uint64_t *offset);
146 void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj);
147 void *msm_gem_get_vaddr(struct drm_gem_object *obj);
148 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj);
149 void msm_gem_put_vaddr_locked(struct drm_gem_object *obj);
150 void msm_gem_put_vaddr(struct drm_gem_object *obj);
151 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv);
152 bool msm_gem_active(struct drm_gem_object *obj);
153 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout);
154 int msm_gem_cpu_fini(struct drm_gem_object *obj);
155 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
156 uint32_t size, uint32_t flags, uint32_t *handle, char *name);
157 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
158 uint32_t size, uint32_t flags);
159 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
160 uint32_t flags, struct msm_gem_address_space *aspace,
161 struct drm_gem_object **bo, uint64_t *iova);
162 void msm_gem_kernel_put(struct drm_gem_object *bo,
163 struct msm_gem_address_space *aspace);
164 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
165 struct dma_buf *dmabuf, struct sg_table *sgt);
167 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...);
169 #ifdef CONFIG_DEBUG_FS
170 struct msm_gem_stats {
174 } all, active, resident, purgeable, purged;
177 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m,
178 struct msm_gem_stats *stats);
179 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m);
183 msm_gem_lock(struct drm_gem_object *obj)
185 dma_resv_lock(obj->resv, NULL);
189 msm_gem_lock_interruptible(struct drm_gem_object *obj)
191 return dma_resv_lock_interruptible(obj->resv, NULL);
195 msm_gem_unlock(struct drm_gem_object *obj)
197 dma_resv_unlock(obj->resv);
201 msm_gem_is_locked(struct drm_gem_object *obj)
204 * Destroying the object is a special case.. msm_gem_free_object()
205 * calls many things that WARN_ON if the obj lock is not held. But
206 * acquiring the obj lock in msm_gem_free_object() can cause a
207 * locking order inversion between reservation_ww_class_mutex and
210 * This deadlock is not actually possible, because no one should
211 * be already holding the lock when msm_gem_free_object() is called.
212 * Unfortunately lockdep is not aware of this detail. So when the
213 * refcount drops to zero, we pretend it is already locked.
215 return dma_resv_is_locked(obj->resv) || (kref_read(&obj->refcount) == 0);
218 /* imported/exported objects are not purgeable: */
219 static inline bool is_unpurgeable(struct msm_gem_object *msm_obj)
221 return msm_obj->base.import_attach || msm_obj->pin_count;
224 static inline bool is_purgeable(struct msm_gem_object *msm_obj)
226 return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt &&
227 !is_unpurgeable(msm_obj);
230 static inline bool is_vunmapable(struct msm_gem_object *msm_obj)
232 GEM_WARN_ON(!msm_gem_is_locked(&msm_obj->base));
233 return (msm_obj->vmap_count == 0) && msm_obj->vaddr;
236 static inline bool is_unevictable(struct msm_gem_object *msm_obj)
238 return is_unpurgeable(msm_obj) || msm_obj->vaddr;
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);
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).
249 struct msm_gem_submit {
250 struct drm_sched_job base;
252 struct drm_device *dev;
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 */
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)
262 struct dma_fence *hw_fence;
264 /* Userspace visible fence, which is signaled by the scheduler after
265 * the hw_fence is signaled.
267 struct dma_fence *user_fence;
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;
278 u32 ident; /* A "identifier" for the submit for logging */
281 uint32_t size; /* in dwords */
283 uint32_t offset;/* in dwords */
284 uint32_t idx; /* cmdstream buffer idx in bos[] */
286 struct drm_msm_gem_submit_reloc *relocs;
287 } *cmd; /* array of size nr_cmds */
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 */
296 struct msm_gem_object *obj;
300 struct msm_gem_vma *vma;
304 static inline struct msm_gem_submit *to_msm_submit(struct drm_sched_job *job)
306 return container_of(job, struct msm_gem_submit, base);
309 void __msm_gem_submit_destroy(struct kref *kref);
311 static inline void msm_gem_submit_get(struct msm_gem_submit *submit)
313 kref_get(&submit->ref);
316 static inline void msm_gem_submit_put(struct msm_gem_submit *submit)
318 kref_put(&submit->ref, __msm_gem_submit_destroy);
321 void msm_submit_retire(struct msm_gem_submit *submit);
323 /* helper to determine of a buffer in submit should be dumped, used for both
324 * devcoredump and debugfs cmdstream dumping:
327 should_dump(struct msm_gem_submit *submit, int idx)
330 return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP);
333 #endif /* __MSM_GEM_H__ */