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; 62b14b8c5fSRob Clark spinlock_t lock; 63667ce33eSRob Clark uint64_t iova; 644b85f7f5SRob Clark struct msm_gem_address_space *aspace; 654b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 66c0ee9794SJordan Crouse bool mapped; 677ad0e8cfSJordan Crouse int inuse; 6895d1deb0SRob Clark uint32_t fence_mask; 6995d1deb0SRob Clark uint32_t fence[MSM_GPU_MAX_RINGS]; 7095d1deb0SRob Clark struct msm_fence_context *fctx[MSM_GPU_MAX_RINGS]; 71667ce33eSRob Clark }; 72667ce33eSRob Clark 73fc2f0756SRob Clark struct msm_gem_vma *msm_gem_vma_new(struct msm_gem_address_space *aspace); 74fc2f0756SRob Clark int msm_gem_vma_init(struct msm_gem_vma *vma, int size, 75695383a1SRob Clark u64 range_start, u64 range_end); 76ca35ab2aSRob Clark bool msm_gem_vma_inuse(struct msm_gem_vma *vma); 77fc2f0756SRob Clark void msm_gem_vma_purge(struct msm_gem_vma *vma); 78fc2f0756SRob Clark void msm_gem_vma_unpin(struct msm_gem_vma *vma); 79fc2f0756SRob Clark void msm_gem_vma_unpin_fenced(struct msm_gem_vma *vma, struct msm_fence_context *fctx); 80fc2f0756SRob Clark int msm_gem_vma_map(struct msm_gem_vma *vma, int prot, struct sg_table *sgt, int size); 81fc2f0756SRob Clark void msm_gem_vma_close(struct msm_gem_vma *vma); 82695383a1SRob Clark 83c8afe684SRob Clark struct msm_gem_object { 84c8afe684SRob Clark struct drm_gem_object base; 85c8afe684SRob Clark 86c8afe684SRob Clark uint32_t flags; 87c8afe684SRob Clark 884cd33c48SRob Clark /** 896c7c8fb8SRob Clark * madv: are the backing pages purgeable? 906c7c8fb8SRob Clark * 916c7c8fb8SRob Clark * Protected by obj lock and LRU lock 924cd33c48SRob Clark */ 934cd33c48SRob Clark uint8_t madv; 944cd33c48SRob Clark 95e1e9db2cSRob Clark /** 96e1e9db2cSRob Clark * count of active vmap'ing 97e1e9db2cSRob Clark */ 98e1e9db2cSRob Clark uint8_t vmap_count; 99e1e9db2cSRob Clark 100cc8a4d5aSRob Clark /** 1016ed0897cSRob Clark * Node in list of all objects (mainly for debugfs, protected by 1026ed0897cSRob Clark * priv->obj_lock 1036ed0897cSRob Clark */ 1046ed0897cSRob Clark struct list_head node; 1056ed0897cSRob Clark 106c8afe684SRob Clark struct page **pages; 107c8afe684SRob Clark struct sg_table *sgt; 108c8afe684SRob Clark void *vaddr; 109c8afe684SRob Clark 1104b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 1117198e6b0SRob Clark 112871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 113072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 114871d812aSRob Clark */ 115871d812aSRob Clark struct drm_mm_node *vram_node; 1160815d774SJordan Crouse 1170815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 1189d8baa2bSAkhil P Oommen 1196c7c8fb8SRob Clark /** 1206c7c8fb8SRob Clark * pin_count: Number of times the pages are pinned 1216c7c8fb8SRob Clark * 1226c7c8fb8SRob Clark * Protected by LRU lock. 1236c7c8fb8SRob Clark */ 12464fcbde7SRob Clark int pin_count; 125c8afe684SRob Clark }; 126c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 127c8afe684SRob Clark 1288f642378SRob Clark uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 12927674c66SRob Clark int msm_gem_pin_vma_locked(struct drm_gem_object *obj, struct msm_gem_vma *vma); 130311e03c2SRob Clark void msm_gem_unpin_locked(struct drm_gem_object *obj); 13117b704f1SRob Clark void msm_gem_unpin_active(struct drm_gem_object *obj); 13227674c66SRob Clark struct msm_gem_vma *msm_gem_get_vma_locked(struct drm_gem_object *obj, 13327674c66SRob Clark struct msm_gem_address_space *aspace); 1348f642378SRob Clark int msm_gem_get_iova(struct drm_gem_object *obj, 1358f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 136a636a0ffSRob Clark int msm_gem_set_iova(struct drm_gem_object *obj, 137a636a0ffSRob Clark struct msm_gem_address_space *aspace, uint64_t iova); 1388f642378SRob Clark int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 1398f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova, 1408f642378SRob Clark u64 range_start, u64 range_end); 1418f642378SRob Clark int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 1428f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1438f642378SRob Clark void msm_gem_unpin_iova(struct drm_gem_object *obj, 1448f642378SRob Clark struct msm_gem_address_space *aspace); 145*fc896cf3SRob Clark void msm_gem_pin_obj_locked(struct drm_gem_object *obj); 146e7cd5ee9SRob Clark struct page **msm_gem_pin_pages(struct drm_gem_object *obj); 147e7cd5ee9SRob Clark void msm_gem_unpin_pages(struct drm_gem_object *obj); 1488f642378SRob Clark int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 1498f642378SRob Clark struct drm_mode_create_dumb *args); 1508f642378SRob Clark int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 1518f642378SRob Clark uint32_t handle, uint64_t *offset); 152e4b87d22SRob Clark void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 1538f642378SRob Clark void *msm_gem_get_vaddr(struct drm_gem_object *obj); 1548f642378SRob Clark void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 155e4b87d22SRob Clark void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 1568f642378SRob Clark void msm_gem_put_vaddr(struct drm_gem_object *obj); 1578f642378SRob Clark int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 15801780d02SRob Clark bool msm_gem_active(struct drm_gem_object *obj); 1598f642378SRob Clark int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 1608f642378SRob Clark int msm_gem_cpu_fini(struct drm_gem_object *obj); 1618f642378SRob Clark int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 1628f642378SRob Clark uint32_t size, uint32_t flags, uint32_t *handle, char *name); 1638f642378SRob Clark struct drm_gem_object *msm_gem_new(struct drm_device *dev, 1648f642378SRob Clark uint32_t size, uint32_t flags); 1658f642378SRob Clark void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 1668f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1678f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1688f642378SRob Clark void msm_gem_kernel_put(struct drm_gem_object *bo, 169030af2b0SRob Clark struct msm_gem_address_space *aspace); 1708f642378SRob Clark struct drm_gem_object *msm_gem_import(struct drm_device *dev, 1718f642378SRob Clark struct dma_buf *dmabuf, struct sg_table *sgt); 1728f642378SRob Clark __printf(2, 3) 1738f642378SRob Clark void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 174528107c8SRob Clark 175f48f3563SRob Clark #ifdef CONFIG_DEBUG_FS 176528107c8SRob Clark struct msm_gem_stats { 177528107c8SRob Clark struct { 178528107c8SRob Clark unsigned count; 179528107c8SRob Clark size_t size; 180f48f3563SRob Clark } all, active, resident, purgeable, purged; 181528107c8SRob Clark }; 182528107c8SRob Clark 183528107c8SRob Clark void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m, 184528107c8SRob Clark struct msm_gem_stats *stats); 1858f642378SRob Clark void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 1868f642378SRob Clark #endif 1878f642378SRob Clark 188a6ae74c9SRob Clark static inline void 189a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 190a6ae74c9SRob Clark { 1916c0e3ea2SRob Clark dma_resv_lock(obj->resv, NULL); 192a6ae74c9SRob Clark } 193a6ae74c9SRob Clark 194a6ae74c9SRob Clark static inline int 195a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 196a6ae74c9SRob Clark { 1976c0e3ea2SRob Clark return dma_resv_lock_interruptible(obj->resv, NULL); 198a6ae74c9SRob Clark } 199a6ae74c9SRob Clark 200a6ae74c9SRob Clark static inline void 201a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 202a6ae74c9SRob Clark { 2036c0e3ea2SRob Clark dma_resv_unlock(obj->resv); 204a6ae74c9SRob Clark } 205a6ae74c9SRob Clark 206d95c196dSRob Clark static inline void 207d95c196dSRob Clark msm_gem_assert_locked(struct drm_gem_object *obj) 208a6ae74c9SRob Clark { 209a414fe3aSRob Clark /* 210a414fe3aSRob Clark * Destroying the object is a special case.. msm_gem_free_object() 211a414fe3aSRob Clark * calls many things that WARN_ON if the obj lock is not held. But 212a414fe3aSRob Clark * acquiring the obj lock in msm_gem_free_object() can cause a 213a414fe3aSRob Clark * locking order inversion between reservation_ww_class_mutex and 214a414fe3aSRob Clark * fs_reclaim. 215a414fe3aSRob Clark * 216a414fe3aSRob Clark * This deadlock is not actually possible, because no one should 217a414fe3aSRob Clark * be already holding the lock when msm_gem_free_object() is called. 218a414fe3aSRob Clark * Unfortunately lockdep is not aware of this detail. So when the 219a414fe3aSRob Clark * refcount drops to zero, we pretend it is already locked. 220a414fe3aSRob Clark */ 221d95c196dSRob Clark lockdep_assert_once( 222d95c196dSRob Clark (kref_read(&obj->refcount) == 0) || 223d95c196dSRob Clark (lockdep_is_held(&obj->resv->lock.base) != LOCK_STATE_NOT_HELD) 224d95c196dSRob Clark ); 225d4d7d363SRob Clark } 226d4d7d363SRob Clark 2270054eeb7SRob Clark /* imported/exported objects are not purgeable: */ 2280054eeb7SRob Clark static inline bool is_unpurgeable(struct msm_gem_object *msm_obj) 229cc8a4d5aSRob Clark { 23010f76165SRob Clark return msm_obj->base.import_attach || msm_obj->pin_count; 231cc8a4d5aSRob Clark } 232cc8a4d5aSRob Clark 23368209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 23468209390SRob Clark { 23568209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 2360054eeb7SRob Clark !is_unpurgeable(msm_obj); 23768209390SRob Clark } 23868209390SRob Clark 239e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 240e1e9db2cSRob Clark { 241d4d7d363SRob Clark msm_gem_assert_locked(&msm_obj->base); 242e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 243e1e9db2cSRob Clark } 244e1e9db2cSRob Clark 24564fcbde7SRob Clark static inline bool is_unevictable(struct msm_gem_object *msm_obj) 24664fcbde7SRob Clark { 24710f76165SRob Clark return is_unpurgeable(msm_obj) || msm_obj->vaddr; 24864fcbde7SRob Clark } 24964fcbde7SRob Clark 250599089c6SRob Clark void msm_gem_purge(struct drm_gem_object *obj); 25164fcbde7SRob Clark void msm_gem_evict(struct drm_gem_object *obj); 252599089c6SRob Clark void msm_gem_vunmap(struct drm_gem_object *obj); 2530e08270aSSushmita Susheelendra 2547198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 2557198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 256375f9a63SRob Clark * make it easier to unwind when things go wrong, etc). 2577198e6b0SRob Clark */ 2587198e6b0SRob Clark struct msm_gem_submit { 2591d8a5ca4SRob Clark struct drm_sched_job base; 260964d2f97SRob Clark struct kref ref; 2617198e6b0SRob Clark struct drm_device *dev; 2627198e6b0SRob Clark struct msm_gpu *gpu; 263295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 264f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 2657198e6b0SRob Clark struct ww_acquire_ctx ticket; 266f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 2671d8a5ca4SRob Clark 2681d8a5ca4SRob Clark /* Hw fence, which is created when the scheduler executes the job, and 2691d8a5ca4SRob Clark * is signaled when the hw finishes (via seqno write from cmdstream) 2701d8a5ca4SRob Clark */ 2711d8a5ca4SRob Clark struct dma_fence *hw_fence; 2721d8a5ca4SRob Clark 2731d8a5ca4SRob Clark /* Userspace visible fence, which is signaled by the scheduler after 2741d8a5ca4SRob Clark * the hw_fence is signaled. 2751d8a5ca4SRob Clark */ 2761d8a5ca4SRob Clark struct dma_fence *user_fence; 2771d8a5ca4SRob Clark 278a61acbbeSRob Clark int fence_id; /* key into queue->fence_idr */ 279f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 2804816b626SRob Clark struct pid *pid; /* submitting process */ 281e25e92e0SRob Clark bool fault_dumped; /* Limit devcoredump dumping to one per submit */ 282340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 2836a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 284f97decacSJordan Crouse struct msm_ringbuffer *ring; 2857198e6b0SRob Clark unsigned int nr_cmds; 2867198e6b0SRob Clark unsigned int nr_bos; 2874241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 2887198e6b0SRob Clark struct { 2897198e6b0SRob Clark uint32_t type; 2907198e6b0SRob Clark uint32_t size; /* in dwords */ 29178babc16SRob Clark uint64_t iova; 29220224d71SRob Clark uint32_t offset;/* in dwords */ 293a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 29420224d71SRob Clark uint32_t nr_relocs; 29520224d71SRob Clark struct drm_msm_gem_submit_reloc *relocs; 2966b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 2977198e6b0SRob Clark struct { 29895d1deb0SRob Clark /* make sure these don't conflict w/ MSM_SUBMIT_BO_x */ 29995d1deb0SRob Clark #define BO_VALID 0x8000 /* is current addr in cmdstream correct/valid? */ 30095d1deb0SRob Clark #define BO_LOCKED 0x4000 /* obj lock is held */ 301da53d8b5SRob Clark #define BO_OBJ_PINNED 0x2000 /* obj (pages) is pinned and on active list */ 302da53d8b5SRob Clark #define BO_VMA_PINNED 0x1000 /* vma (virtual address) is pinned */ 3037198e6b0SRob Clark uint32_t flags; 304b673499aSKristian H. Kristensen union { 3056ba5daa5SRob Clark struct drm_gem_object *obj; 306b673499aSKristian H. Kristensen uint32_t handle; 307b673499aSKristian H. Kristensen }; 30878babc16SRob Clark uint64_t iova; 30927674c66SRob Clark struct msm_gem_vma *vma; 3104c145df1SGustavo A. R. Silva } bos[]; 3117198e6b0SRob Clark }; 3127198e6b0SRob Clark 3131d8a5ca4SRob Clark static inline struct msm_gem_submit *to_msm_submit(struct drm_sched_job *job) 3141d8a5ca4SRob Clark { 3151d8a5ca4SRob Clark return container_of(job, struct msm_gem_submit, base); 3161d8a5ca4SRob Clark } 3171d8a5ca4SRob Clark 318964d2f97SRob Clark void __msm_gem_submit_destroy(struct kref *kref); 319964d2f97SRob Clark 320964d2f97SRob Clark static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 321964d2f97SRob Clark { 322964d2f97SRob Clark kref_get(&submit->ref); 323964d2f97SRob Clark } 324964d2f97SRob Clark 325964d2f97SRob Clark static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 326964d2f97SRob Clark { 327964d2f97SRob Clark kref_put(&submit->ref, __msm_gem_submit_destroy); 328964d2f97SRob Clark } 329964d2f97SRob Clark 330be40596bSRob Clark void msm_submit_retire(struct msm_gem_submit *submit); 331be40596bSRob Clark 332e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 333e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 334e515af8dSRob Clark */ 335e515af8dSRob Clark static inline bool 336e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 337e515af8dSRob Clark { 338e515af8dSRob Clark extern bool rd_full; 339e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 340e515af8dSRob Clark } 341e515af8dSRob Clark 342c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 343