1caab277bSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 2c8afe684SRob Clark /* 3c8afe684SRob Clark * Copyright (C) 2013 Red Hat 4c8afe684SRob Clark * Author: Rob Clark <robdclark@gmail.com> 5c8afe684SRob Clark */ 6c8afe684SRob Clark 7c8afe684SRob Clark #ifndef __MSM_GEM_H__ 8c8afe684SRob Clark #define __MSM_GEM_H__ 9c8afe684SRob Clark 10ee546cd3SJordan Crouse #include <linux/kref.h> 1152791eeeSChristian König #include <linux/dma-resv.h> 121d8a5ca4SRob Clark #include "drm/gpu_scheduler.h" 13c8afe684SRob Clark #include "msm_drv.h" 14c8afe684SRob Clark 1590643a24SRob Clark /* Make all GEM related WARN_ON()s ratelimited.. when things go wrong they 1690643a24SRob Clark * tend to go wrong 1000s of times in a short timespan. 1790643a24SRob Clark */ 1890643a24SRob Clark #define GEM_WARN_ON(x) WARN_RATELIMIT(x, "%s", __stringify(x)) 1990643a24SRob Clark 20072f1f91SRob Clark /* Additional internal-use only BO flags: */ 21072f1f91SRob Clark #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 220b462d7aSJonathan Marek #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 23072f1f91SRob Clark 24667ce33eSRob Clark struct msm_gem_address_space { 25667ce33eSRob Clark const char *name; 26667ce33eSRob Clark /* NOTE: mm managed at the page level, size is in # of pages 27667ce33eSRob Clark * and position mm_node->start is in # of pages: 28667ce33eSRob Clark */ 29667ce33eSRob Clark struct drm_mm mm; 300e08270aSSushmita Susheelendra spinlock_t lock; /* Protects drm_mm node allocation/removal */ 31667ce33eSRob Clark struct msm_mmu *mmu; 32ee546cd3SJordan Crouse struct kref kref; 3325faf2f2SRob Clark 3425faf2f2SRob Clark /* For address spaces associated with a specific process, this 3525faf2f2SRob Clark * will be non-NULL: 3625faf2f2SRob Clark */ 3725faf2f2SRob Clark struct pid *pid; 38bc211258SRob Clark 39bc211258SRob Clark /* @faults: the number of GPU hangs associated with this address space */ 40bc211258SRob Clark int faults; 41a636a0ffSRob Clark 42a636a0ffSRob Clark /** @va_start: lowest possible address to allocate */ 43a636a0ffSRob Clark uint64_t va_start; 44a636a0ffSRob Clark 45a636a0ffSRob Clark /** @va_size: the size of the address space (in bytes) */ 46a636a0ffSRob Clark uint64_t va_size; 47667ce33eSRob Clark }; 48667ce33eSRob Clark 49695383a1SRob Clark struct msm_gem_address_space * 50695383a1SRob Clark msm_gem_address_space_get(struct msm_gem_address_space *aspace); 51695383a1SRob Clark 52695383a1SRob Clark void msm_gem_address_space_put(struct msm_gem_address_space *aspace); 53695383a1SRob Clark 54695383a1SRob Clark struct msm_gem_address_space * 55695383a1SRob Clark msm_gem_address_space_create(struct msm_mmu *mmu, const char *name, 56695383a1SRob Clark u64 va_start, u64 size); 57695383a1SRob Clark 5895d1deb0SRob Clark struct msm_fence_context; 5995d1deb0SRob Clark 60667ce33eSRob Clark struct msm_gem_vma { 61667ce33eSRob Clark struct drm_mm_node node; 62667ce33eSRob Clark uint64_t iova; 634b85f7f5SRob Clark struct msm_gem_address_space *aspace; 644b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 65c0ee9794SJordan Crouse bool mapped; 667ad0e8cfSJordan Crouse int inuse; 6795d1deb0SRob Clark uint32_t fence_mask; 6895d1deb0SRob Clark uint32_t fence[MSM_GPU_MAX_RINGS]; 6995d1deb0SRob Clark struct msm_fence_context *fctx[MSM_GPU_MAX_RINGS]; 70667ce33eSRob Clark }; 71667ce33eSRob Clark 72*fc2f0756SRob Clark struct msm_gem_vma *msm_gem_vma_new(struct msm_gem_address_space *aspace); 73*fc2f0756SRob Clark int msm_gem_vma_init(struct msm_gem_vma *vma, int size, 74695383a1SRob Clark u64 range_start, u64 range_end); 75ca35ab2aSRob Clark bool msm_gem_vma_inuse(struct msm_gem_vma *vma); 76*fc2f0756SRob Clark void msm_gem_vma_purge(struct msm_gem_vma *vma); 77*fc2f0756SRob Clark void msm_gem_vma_unpin(struct msm_gem_vma *vma); 78*fc2f0756SRob Clark void msm_gem_vma_unpin_fenced(struct msm_gem_vma *vma, struct msm_fence_context *fctx); 79*fc2f0756SRob Clark int msm_gem_vma_map(struct msm_gem_vma *vma, int prot, struct sg_table *sgt, int size); 80*fc2f0756SRob Clark void msm_gem_vma_close(struct msm_gem_vma *vma); 81695383a1SRob Clark 82c8afe684SRob Clark struct msm_gem_object { 83c8afe684SRob Clark struct drm_gem_object base; 84c8afe684SRob Clark 85c8afe684SRob Clark uint32_t flags; 86c8afe684SRob Clark 874cd33c48SRob Clark /** 884cd33c48SRob Clark * Advice: are the backing pages purgeable? 894cd33c48SRob Clark */ 904cd33c48SRob Clark uint8_t madv; 914cd33c48SRob Clark 92e1e9db2cSRob Clark /** 93e1e9db2cSRob Clark * count of active vmap'ing 94e1e9db2cSRob Clark */ 95e1e9db2cSRob Clark uint8_t vmap_count; 96e1e9db2cSRob Clark 97cc8a4d5aSRob Clark /** 986ed0897cSRob Clark * Node in list of all objects (mainly for debugfs, protected by 996ed0897cSRob Clark * priv->obj_lock 1006ed0897cSRob Clark */ 1016ed0897cSRob Clark struct list_head node; 1026ed0897cSRob Clark 103c8afe684SRob Clark struct page **pages; 104c8afe684SRob Clark struct sg_table *sgt; 105c8afe684SRob Clark void *vaddr; 106c8afe684SRob Clark 1074b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 1087198e6b0SRob Clark 109871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 110072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 111871d812aSRob Clark */ 112871d812aSRob Clark struct drm_mm_node *vram_node; 1130815d774SJordan Crouse 1140815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 1159d8baa2bSAkhil P Oommen 11664fcbde7SRob Clark int pin_count; 117c8afe684SRob Clark }; 118c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 119c8afe684SRob Clark 1208f642378SRob Clark uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 12127674c66SRob Clark int msm_gem_pin_vma_locked(struct drm_gem_object *obj, struct msm_gem_vma *vma); 122311e03c2SRob Clark void msm_gem_unpin_locked(struct drm_gem_object *obj); 12327674c66SRob Clark struct msm_gem_vma *msm_gem_get_vma_locked(struct drm_gem_object *obj, 12427674c66SRob Clark struct msm_gem_address_space *aspace); 1258f642378SRob Clark int msm_gem_get_iova(struct drm_gem_object *obj, 1268f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 127a636a0ffSRob Clark int msm_gem_set_iova(struct drm_gem_object *obj, 128a636a0ffSRob Clark struct msm_gem_address_space *aspace, uint64_t iova); 1298f642378SRob Clark int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 1308f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova, 1318f642378SRob Clark u64 range_start, u64 range_end); 1328f642378SRob Clark int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 1338f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1348f642378SRob Clark void msm_gem_unpin_iova(struct drm_gem_object *obj, 1358f642378SRob Clark struct msm_gem_address_space *aspace); 136e7cd5ee9SRob Clark struct page **msm_gem_pin_pages(struct drm_gem_object *obj); 137e7cd5ee9SRob Clark void msm_gem_unpin_pages(struct drm_gem_object *obj); 1388f642378SRob Clark int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 1398f642378SRob Clark struct drm_mode_create_dumb *args); 1408f642378SRob Clark int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 1418f642378SRob Clark uint32_t handle, uint64_t *offset); 142e4b87d22SRob Clark void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 1438f642378SRob Clark void *msm_gem_get_vaddr(struct drm_gem_object *obj); 1448f642378SRob Clark void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 145e4b87d22SRob Clark void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 1468f642378SRob Clark void msm_gem_put_vaddr(struct drm_gem_object *obj); 1478f642378SRob Clark int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 14801780d02SRob Clark bool msm_gem_active(struct drm_gem_object *obj); 1498f642378SRob Clark int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 1508f642378SRob Clark int msm_gem_cpu_fini(struct drm_gem_object *obj); 1518f642378SRob Clark int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 1528f642378SRob Clark uint32_t size, uint32_t flags, uint32_t *handle, char *name); 1538f642378SRob Clark struct drm_gem_object *msm_gem_new(struct drm_device *dev, 1548f642378SRob Clark uint32_t size, uint32_t flags); 1558f642378SRob Clark void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 1568f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1578f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1588f642378SRob Clark void msm_gem_kernel_put(struct drm_gem_object *bo, 159030af2b0SRob Clark struct msm_gem_address_space *aspace); 1608f642378SRob Clark struct drm_gem_object *msm_gem_import(struct drm_device *dev, 1618f642378SRob Clark struct dma_buf *dmabuf, struct sg_table *sgt); 1628f642378SRob Clark __printf(2, 3) 1638f642378SRob Clark void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 164528107c8SRob Clark 165f48f3563SRob Clark #ifdef CONFIG_DEBUG_FS 166528107c8SRob Clark struct msm_gem_stats { 167528107c8SRob Clark struct { 168528107c8SRob Clark unsigned count; 169528107c8SRob Clark size_t size; 170f48f3563SRob Clark } all, active, resident, purgeable, purged; 171528107c8SRob Clark }; 172528107c8SRob Clark 173528107c8SRob Clark void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m, 174528107c8SRob Clark struct msm_gem_stats *stats); 1758f642378SRob Clark void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 1768f642378SRob Clark #endif 1778f642378SRob Clark 178a6ae74c9SRob Clark static inline void 179a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 180a6ae74c9SRob Clark { 1816c0e3ea2SRob Clark dma_resv_lock(obj->resv, NULL); 182a6ae74c9SRob Clark } 183a6ae74c9SRob Clark 184a6ae74c9SRob Clark static inline int 185a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 186a6ae74c9SRob Clark { 1876c0e3ea2SRob Clark return dma_resv_lock_interruptible(obj->resv, NULL); 188a6ae74c9SRob Clark } 189a6ae74c9SRob Clark 190a6ae74c9SRob Clark static inline void 191a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 192a6ae74c9SRob Clark { 1936c0e3ea2SRob Clark dma_resv_unlock(obj->resv); 194a6ae74c9SRob Clark } 195a6ae74c9SRob Clark 196d95c196dSRob Clark static inline void 197d95c196dSRob Clark msm_gem_assert_locked(struct drm_gem_object *obj) 198a6ae74c9SRob Clark { 199a414fe3aSRob Clark /* 200a414fe3aSRob Clark * Destroying the object is a special case.. msm_gem_free_object() 201a414fe3aSRob Clark * calls many things that WARN_ON if the obj lock is not held. But 202a414fe3aSRob Clark * acquiring the obj lock in msm_gem_free_object() can cause a 203a414fe3aSRob Clark * locking order inversion between reservation_ww_class_mutex and 204a414fe3aSRob Clark * fs_reclaim. 205a414fe3aSRob Clark * 206a414fe3aSRob Clark * This deadlock is not actually possible, because no one should 207a414fe3aSRob Clark * be already holding the lock when msm_gem_free_object() is called. 208a414fe3aSRob Clark * Unfortunately lockdep is not aware of this detail. So when the 209a414fe3aSRob Clark * refcount drops to zero, we pretend it is already locked. 210a414fe3aSRob Clark */ 211d95c196dSRob Clark lockdep_assert_once( 212d95c196dSRob Clark (kref_read(&obj->refcount) == 0) || 213d95c196dSRob Clark (lockdep_is_held(&obj->resv->lock.base) != LOCK_STATE_NOT_HELD) 214d95c196dSRob Clark ); 215d4d7d363SRob Clark } 216d4d7d363SRob Clark 2170054eeb7SRob Clark /* imported/exported objects are not purgeable: */ 2180054eeb7SRob Clark static inline bool is_unpurgeable(struct msm_gem_object *msm_obj) 219cc8a4d5aSRob Clark { 22010f76165SRob Clark return msm_obj->base.import_attach || msm_obj->pin_count; 221cc8a4d5aSRob Clark } 222cc8a4d5aSRob Clark 22368209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 22468209390SRob Clark { 22568209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 2260054eeb7SRob Clark !is_unpurgeable(msm_obj); 22768209390SRob Clark } 22868209390SRob Clark 229e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 230e1e9db2cSRob Clark { 231d4d7d363SRob Clark msm_gem_assert_locked(&msm_obj->base); 232e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 233e1e9db2cSRob Clark } 234e1e9db2cSRob Clark 23564fcbde7SRob Clark static inline bool is_unevictable(struct msm_gem_object *msm_obj) 23664fcbde7SRob Clark { 23710f76165SRob Clark return is_unpurgeable(msm_obj) || msm_obj->vaddr; 23864fcbde7SRob Clark } 23964fcbde7SRob Clark 240599089c6SRob Clark void msm_gem_purge(struct drm_gem_object *obj); 24164fcbde7SRob Clark void msm_gem_evict(struct drm_gem_object *obj); 242599089c6SRob Clark void msm_gem_vunmap(struct drm_gem_object *obj); 2430e08270aSSushmita Susheelendra 2447198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 2457198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 246375f9a63SRob Clark * make it easier to unwind when things go wrong, etc). 2477198e6b0SRob Clark */ 2487198e6b0SRob Clark struct msm_gem_submit { 2491d8a5ca4SRob Clark struct drm_sched_job base; 250964d2f97SRob Clark struct kref ref; 2517198e6b0SRob Clark struct drm_device *dev; 2527198e6b0SRob Clark struct msm_gpu *gpu; 253295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 254f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 2557198e6b0SRob Clark struct ww_acquire_ctx ticket; 256f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 2571d8a5ca4SRob Clark 2581d8a5ca4SRob Clark /* Hw fence, which is created when the scheduler executes the job, and 2591d8a5ca4SRob Clark * is signaled when the hw finishes (via seqno write from cmdstream) 2601d8a5ca4SRob Clark */ 2611d8a5ca4SRob Clark struct dma_fence *hw_fence; 2621d8a5ca4SRob Clark 2631d8a5ca4SRob Clark /* Userspace visible fence, which is signaled by the scheduler after 2641d8a5ca4SRob Clark * the hw_fence is signaled. 2651d8a5ca4SRob Clark */ 2661d8a5ca4SRob Clark struct dma_fence *user_fence; 2671d8a5ca4SRob Clark 268a61acbbeSRob Clark int fence_id; /* key into queue->fence_idr */ 269f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 2704816b626SRob Clark struct pid *pid; /* submitting process */ 271e25e92e0SRob Clark bool fault_dumped; /* Limit devcoredump dumping to one per submit */ 272340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 2736a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 274f97decacSJordan Crouse struct msm_ringbuffer *ring; 2757198e6b0SRob Clark unsigned int nr_cmds; 2767198e6b0SRob Clark unsigned int nr_bos; 2774241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 2787198e6b0SRob Clark struct { 2797198e6b0SRob Clark uint32_t type; 2807198e6b0SRob Clark uint32_t size; /* in dwords */ 28178babc16SRob Clark uint64_t iova; 28220224d71SRob Clark uint32_t offset;/* in dwords */ 283a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 28420224d71SRob Clark uint32_t nr_relocs; 28520224d71SRob Clark struct drm_msm_gem_submit_reloc *relocs; 2866b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 2877198e6b0SRob Clark struct { 28895d1deb0SRob Clark /* make sure these don't conflict w/ MSM_SUBMIT_BO_x */ 28995d1deb0SRob Clark #define BO_VALID 0x8000 /* is current addr in cmdstream correct/valid? */ 29095d1deb0SRob Clark #define BO_LOCKED 0x4000 /* obj lock is held */ 291da53d8b5SRob Clark #define BO_OBJ_PINNED 0x2000 /* obj (pages) is pinned and on active list */ 292da53d8b5SRob Clark #define BO_VMA_PINNED 0x1000 /* vma (virtual address) is pinned */ 2937198e6b0SRob Clark uint32_t flags; 294b673499aSKristian H. Kristensen union { 2957198e6b0SRob Clark struct msm_gem_object *obj; 296b673499aSKristian H. Kristensen uint32_t handle; 297b673499aSKristian H. Kristensen }; 29878babc16SRob Clark uint64_t iova; 29927674c66SRob Clark struct msm_gem_vma *vma; 3004c145df1SGustavo A. R. Silva } bos[]; 3017198e6b0SRob Clark }; 3027198e6b0SRob Clark 3031d8a5ca4SRob Clark static inline struct msm_gem_submit *to_msm_submit(struct drm_sched_job *job) 3041d8a5ca4SRob Clark { 3051d8a5ca4SRob Clark return container_of(job, struct msm_gem_submit, base); 3061d8a5ca4SRob Clark } 3071d8a5ca4SRob Clark 308964d2f97SRob Clark void __msm_gem_submit_destroy(struct kref *kref); 309964d2f97SRob Clark 310964d2f97SRob Clark static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 311964d2f97SRob Clark { 312964d2f97SRob Clark kref_get(&submit->ref); 313964d2f97SRob Clark } 314964d2f97SRob Clark 315964d2f97SRob Clark static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 316964d2f97SRob Clark { 317964d2f97SRob Clark kref_put(&submit->ref, __msm_gem_submit_destroy); 318964d2f97SRob Clark } 319964d2f97SRob Clark 320be40596bSRob Clark void msm_submit_retire(struct msm_gem_submit *submit); 321be40596bSRob Clark 322e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 323e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 324e515af8dSRob Clark */ 325e515af8dSRob Clark static inline bool 326e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 327e515af8dSRob Clark { 328e515af8dSRob Clark extern bool rd_full; 329e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 330e515af8dSRob Clark } 331e515af8dSRob Clark 332c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 333