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> 12c8afe684SRob Clark #include "msm_drv.h" 13c8afe684SRob Clark 1490643a24SRob Clark /* Make all GEM related WARN_ON()s ratelimited.. when things go wrong they 1590643a24SRob Clark * tend to go wrong 1000s of times in a short timespan. 1690643a24SRob Clark */ 1790643a24SRob Clark #define GEM_WARN_ON(x) WARN_RATELIMIT(x, "%s", __stringify(x)) 1890643a24SRob Clark 19072f1f91SRob Clark /* Additional internal-use only BO flags: */ 20072f1f91SRob Clark #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 210b462d7aSJonathan Marek #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 22072f1f91SRob Clark 23667ce33eSRob Clark struct msm_gem_address_space { 24667ce33eSRob Clark const char *name; 25667ce33eSRob Clark /* NOTE: mm managed at the page level, size is in # of pages 26667ce33eSRob Clark * and position mm_node->start is in # of pages: 27667ce33eSRob Clark */ 28667ce33eSRob Clark struct drm_mm mm; 290e08270aSSushmita Susheelendra spinlock_t lock; /* Protects drm_mm node allocation/removal */ 30667ce33eSRob Clark struct msm_mmu *mmu; 31ee546cd3SJordan Crouse struct kref kref; 3225faf2f2SRob Clark 3325faf2f2SRob Clark /* For address spaces associated with a specific process, this 3425faf2f2SRob Clark * will be non-NULL: 3525faf2f2SRob Clark */ 3625faf2f2SRob Clark struct pid *pid; 37667ce33eSRob Clark }; 38667ce33eSRob Clark 39667ce33eSRob Clark struct msm_gem_vma { 40667ce33eSRob Clark struct drm_mm_node node; 41667ce33eSRob Clark uint64_t iova; 424b85f7f5SRob Clark struct msm_gem_address_space *aspace; 434b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 44c0ee9794SJordan Crouse bool mapped; 457ad0e8cfSJordan Crouse int inuse; 46667ce33eSRob Clark }; 47667ce33eSRob Clark 48c8afe684SRob Clark struct msm_gem_object { 49c8afe684SRob Clark struct drm_gem_object base; 50c8afe684SRob Clark 51c8afe684SRob Clark uint32_t flags; 52c8afe684SRob Clark 534cd33c48SRob Clark /** 544cd33c48SRob Clark * Advice: are the backing pages purgeable? 554cd33c48SRob Clark */ 564cd33c48SRob Clark uint8_t madv; 574cd33c48SRob Clark 58e1e9db2cSRob Clark /** 59cc8a4d5aSRob Clark * Is object on inactive_dontneed list (ie. counted in priv->shrinkable_count)? 60cc8a4d5aSRob Clark */ 61cc8a4d5aSRob Clark bool dontneed : 1; 62cc8a4d5aSRob Clark 63cc8a4d5aSRob Clark /** 6464fcbde7SRob Clark * Is object evictable (ie. counted in priv->evictable_count)? 6564fcbde7SRob Clark */ 6664fcbde7SRob Clark bool evictable : 1; 6764fcbde7SRob Clark 6864fcbde7SRob Clark /** 69e1e9db2cSRob Clark * count of active vmap'ing 70e1e9db2cSRob Clark */ 71e1e9db2cSRob Clark uint8_t vmap_count; 72e1e9db2cSRob Clark 73cc8a4d5aSRob Clark /** 746ed0897cSRob Clark * Node in list of all objects (mainly for debugfs, protected by 756ed0897cSRob Clark * priv->obj_lock 766ed0897cSRob Clark */ 776ed0897cSRob Clark struct list_head node; 786ed0897cSRob Clark 796ed0897cSRob Clark /** 80cc8a4d5aSRob Clark * An object is either: 816ed0897cSRob Clark * inactive - on priv->inactive_dontneed or priv->inactive_willneed 8264fcbde7SRob Clark * (depending on purgeability status) 837198e6b0SRob Clark * active - on one one of the gpu's active_list.. well, at 847198e6b0SRob Clark * least for now we don't have (I don't think) hw sync between 857198e6b0SRob Clark * 2d and 3d one devices which have both, meaning we need to 867198e6b0SRob Clark * block on submit if a bo is already on other ring 877198e6b0SRob Clark */ 88c8afe684SRob Clark struct list_head mm_list; 897198e6b0SRob Clark 907198e6b0SRob Clark /* Transiently in the process of submit ioctl, objects associated 917198e6b0SRob Clark * with the submit are on submit->bo_list.. this only lasts for 927198e6b0SRob Clark * the duration of the ioctl, so one bo can never be on multiple 937198e6b0SRob Clark * submit lists. 947198e6b0SRob Clark */ 957198e6b0SRob Clark struct list_head submit_entry; 967198e6b0SRob Clark 97c8afe684SRob Clark struct page **pages; 98c8afe684SRob Clark struct sg_table *sgt; 99c8afe684SRob Clark void *vaddr; 100c8afe684SRob Clark 1014b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 1027198e6b0SRob Clark 103871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 104072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 105871d812aSRob Clark */ 106871d812aSRob Clark struct drm_mm_node *vram_node; 1070815d774SJordan Crouse 1080815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 1099d8baa2bSAkhil P Oommen 110ab5c54cbSRob Clark int active_count; 11164fcbde7SRob Clark int pin_count; 112c8afe684SRob Clark }; 113c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 114c8afe684SRob Clark 1158f642378SRob Clark int msm_gem_mmap_obj(struct drm_gem_object *obj, 1168f642378SRob Clark struct vm_area_struct *vma); 1178f642378SRob Clark int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma); 1188f642378SRob Clark uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 1198f642378SRob Clark int msm_gem_get_iova(struct drm_gem_object *obj, 1208f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1218f642378SRob Clark int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 1228f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova, 1238f642378SRob Clark u64 range_start, u64 range_end); 124e4b87d22SRob Clark int msm_gem_get_and_pin_iova_locked(struct drm_gem_object *obj, 125e4b87d22SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1268f642378SRob Clark int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 1278f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1288f642378SRob Clark uint64_t msm_gem_iova(struct drm_gem_object *obj, 1298f642378SRob Clark struct msm_gem_address_space *aspace); 130e4b87d22SRob Clark void msm_gem_unpin_iova_locked(struct drm_gem_object *obj, 131e4b87d22SRob Clark struct msm_gem_address_space *aspace); 1328f642378SRob Clark void msm_gem_unpin_iova(struct drm_gem_object *obj, 1338f642378SRob Clark struct msm_gem_address_space *aspace); 1348f642378SRob Clark struct page **msm_gem_get_pages(struct drm_gem_object *obj); 1358f642378SRob Clark void msm_gem_put_pages(struct drm_gem_object *obj); 1368f642378SRob Clark int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 1378f642378SRob Clark struct drm_mode_create_dumb *args); 1388f642378SRob Clark int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 1398f642378SRob Clark uint32_t handle, uint64_t *offset); 140e4b87d22SRob Clark void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 1418f642378SRob Clark void *msm_gem_get_vaddr(struct drm_gem_object *obj); 1428f642378SRob Clark void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 143e4b87d22SRob Clark void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 1448f642378SRob Clark void msm_gem_put_vaddr(struct drm_gem_object *obj); 1458f642378SRob Clark int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 1468f642378SRob Clark int msm_gem_sync_object(struct drm_gem_object *obj, 1478f642378SRob Clark struct msm_fence_context *fctx, bool exclusive); 1488f642378SRob Clark void msm_gem_active_get(struct drm_gem_object *obj, struct msm_gpu *gpu); 1498f642378SRob Clark void msm_gem_active_put(struct drm_gem_object *obj); 1508f642378SRob Clark int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 1518f642378SRob Clark int msm_gem_cpu_fini(struct drm_gem_object *obj); 1528f642378SRob Clark void msm_gem_free_object(struct drm_gem_object *obj); 1538f642378SRob Clark int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 1548f642378SRob Clark uint32_t size, uint32_t flags, uint32_t *handle, char *name); 1558f642378SRob Clark struct drm_gem_object *msm_gem_new(struct drm_device *dev, 1568f642378SRob Clark uint32_t size, uint32_t flags); 1578f642378SRob Clark void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 1588f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1598f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1608f642378SRob Clark void msm_gem_kernel_put(struct drm_gem_object *bo, 161*030af2b0SRob Clark struct msm_gem_address_space *aspace); 1628f642378SRob Clark struct drm_gem_object *msm_gem_import(struct drm_device *dev, 1638f642378SRob Clark struct dma_buf *dmabuf, struct sg_table *sgt); 1648f642378SRob Clark __printf(2, 3) 1658f642378SRob Clark void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 166528107c8SRob Clark 167f48f3563SRob Clark #ifdef CONFIG_DEBUG_FS 168528107c8SRob Clark struct msm_gem_stats { 169528107c8SRob Clark struct { 170528107c8SRob Clark unsigned count; 171528107c8SRob Clark size_t size; 172f48f3563SRob Clark } all, active, resident, purgeable, purged; 173528107c8SRob Clark }; 174528107c8SRob Clark 175528107c8SRob Clark void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m, 176528107c8SRob Clark struct msm_gem_stats *stats); 1778f642378SRob Clark void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 1788f642378SRob Clark #endif 1798f642378SRob Clark 180a6ae74c9SRob Clark static inline void 181a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 182a6ae74c9SRob Clark { 1836c0e3ea2SRob Clark dma_resv_lock(obj->resv, NULL); 184a6ae74c9SRob Clark } 185a6ae74c9SRob Clark 186599089c6SRob Clark static inline bool __must_check 187599089c6SRob Clark msm_gem_trylock(struct drm_gem_object *obj) 188599089c6SRob Clark { 1896c0e3ea2SRob Clark return dma_resv_trylock(obj->resv); 190599089c6SRob Clark } 191599089c6SRob Clark 192a6ae74c9SRob Clark static inline int 193a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 194a6ae74c9SRob Clark { 1956c0e3ea2SRob Clark return dma_resv_lock_interruptible(obj->resv, NULL); 196a6ae74c9SRob Clark } 197a6ae74c9SRob Clark 198a6ae74c9SRob Clark static inline void 199a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 200a6ae74c9SRob Clark { 2016c0e3ea2SRob Clark dma_resv_unlock(obj->resv); 202a6ae74c9SRob Clark } 203a6ae74c9SRob Clark 204a6ae74c9SRob Clark static inline bool 205a6ae74c9SRob Clark msm_gem_is_locked(struct drm_gem_object *obj) 206a6ae74c9SRob Clark { 2076c0e3ea2SRob Clark return dma_resv_is_locked(obj->resv); 208a6ae74c9SRob Clark } 209a6ae74c9SRob Clark 2107198e6b0SRob Clark static inline bool is_active(struct msm_gem_object *msm_obj) 2117198e6b0SRob Clark { 21290643a24SRob Clark GEM_WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 213ab5c54cbSRob Clark return msm_obj->active_count; 2147198e6b0SRob Clark } 2157198e6b0SRob Clark 2160054eeb7SRob Clark /* imported/exported objects are not purgeable: */ 2170054eeb7SRob Clark static inline bool is_unpurgeable(struct msm_gem_object *msm_obj) 218cc8a4d5aSRob Clark { 21910f76165SRob Clark return msm_obj->base.import_attach || msm_obj->pin_count; 220cc8a4d5aSRob Clark } 221cc8a4d5aSRob Clark 22268209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 22368209390SRob Clark { 22468209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 2250054eeb7SRob Clark !is_unpurgeable(msm_obj); 22668209390SRob Clark } 22768209390SRob Clark 228e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 229e1e9db2cSRob Clark { 23090643a24SRob Clark GEM_WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 231e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 232e1e9db2cSRob Clark } 233e1e9db2cSRob Clark 2340054eeb7SRob Clark static inline void mark_purgeable(struct msm_gem_object *msm_obj) 235cc8a4d5aSRob Clark { 236cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 237cc8a4d5aSRob Clark 23890643a24SRob Clark GEM_WARN_ON(!mutex_is_locked(&priv->mm_lock)); 239cc8a4d5aSRob Clark 2400054eeb7SRob Clark if (is_unpurgeable(msm_obj)) 241cc8a4d5aSRob Clark return; 242cc8a4d5aSRob Clark 24390643a24SRob Clark if (GEM_WARN_ON(msm_obj->dontneed)) 244cc8a4d5aSRob Clark return; 245cc8a4d5aSRob Clark 246cc8a4d5aSRob Clark priv->shrinkable_count += msm_obj->base.size >> PAGE_SHIFT; 247cc8a4d5aSRob Clark msm_obj->dontneed = true; 248cc8a4d5aSRob Clark } 249cc8a4d5aSRob Clark 2500054eeb7SRob Clark static inline void mark_unpurgeable(struct msm_gem_object *msm_obj) 251cc8a4d5aSRob Clark { 252cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 253cc8a4d5aSRob Clark 25490643a24SRob Clark GEM_WARN_ON(!mutex_is_locked(&priv->mm_lock)); 255cc8a4d5aSRob Clark 2560054eeb7SRob Clark if (is_unpurgeable(msm_obj)) 257cc8a4d5aSRob Clark return; 258cc8a4d5aSRob Clark 25990643a24SRob Clark if (GEM_WARN_ON(!msm_obj->dontneed)) 260cc8a4d5aSRob Clark return; 261cc8a4d5aSRob Clark 262cc8a4d5aSRob Clark priv->shrinkable_count -= msm_obj->base.size >> PAGE_SHIFT; 26390643a24SRob Clark GEM_WARN_ON(priv->shrinkable_count < 0); 264cc8a4d5aSRob Clark msm_obj->dontneed = false; 265cc8a4d5aSRob Clark } 266cc8a4d5aSRob Clark 26764fcbde7SRob Clark static inline bool is_unevictable(struct msm_gem_object *msm_obj) 26864fcbde7SRob Clark { 26910f76165SRob Clark return is_unpurgeable(msm_obj) || msm_obj->vaddr; 27064fcbde7SRob Clark } 27164fcbde7SRob Clark 27264fcbde7SRob Clark static inline void mark_evictable(struct msm_gem_object *msm_obj) 27364fcbde7SRob Clark { 27464fcbde7SRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 27564fcbde7SRob Clark 27664fcbde7SRob Clark WARN_ON(!mutex_is_locked(&priv->mm_lock)); 27764fcbde7SRob Clark 27864fcbde7SRob Clark if (is_unevictable(msm_obj)) 27964fcbde7SRob Clark return; 28064fcbde7SRob Clark 28164fcbde7SRob Clark if (WARN_ON(msm_obj->evictable)) 28264fcbde7SRob Clark return; 28364fcbde7SRob Clark 28464fcbde7SRob Clark priv->evictable_count += msm_obj->base.size >> PAGE_SHIFT; 28564fcbde7SRob Clark msm_obj->evictable = true; 28664fcbde7SRob Clark } 28764fcbde7SRob Clark 28864fcbde7SRob Clark static inline void mark_unevictable(struct msm_gem_object *msm_obj) 28964fcbde7SRob Clark { 29064fcbde7SRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 29164fcbde7SRob Clark 29264fcbde7SRob Clark WARN_ON(!mutex_is_locked(&priv->mm_lock)); 29364fcbde7SRob Clark 29464fcbde7SRob Clark if (is_unevictable(msm_obj)) 29564fcbde7SRob Clark return; 29664fcbde7SRob Clark 29764fcbde7SRob Clark if (WARN_ON(!msm_obj->evictable)) 29864fcbde7SRob Clark return; 29964fcbde7SRob Clark 30064fcbde7SRob Clark priv->evictable_count -= msm_obj->base.size >> PAGE_SHIFT; 30164fcbde7SRob Clark WARN_ON(priv->evictable_count < 0); 30264fcbde7SRob Clark msm_obj->evictable = false; 30364fcbde7SRob Clark } 30464fcbde7SRob Clark 305599089c6SRob Clark void msm_gem_purge(struct drm_gem_object *obj); 30664fcbde7SRob Clark void msm_gem_evict(struct drm_gem_object *obj); 307599089c6SRob Clark void msm_gem_vunmap(struct drm_gem_object *obj); 3080e08270aSSushmita Susheelendra 3097198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 3107198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 311375f9a63SRob Clark * make it easier to unwind when things go wrong, etc). 3127198e6b0SRob Clark */ 3137198e6b0SRob Clark struct msm_gem_submit { 314964d2f97SRob Clark struct kref ref; 3157198e6b0SRob Clark struct drm_device *dev; 3167198e6b0SRob Clark struct msm_gpu *gpu; 317295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 318f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 3197198e6b0SRob Clark struct list_head bo_list; 3207198e6b0SRob Clark struct ww_acquire_ctx ticket; 321f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 322f54d1867SChris Wilson struct dma_fence *fence; 323f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 3244816b626SRob Clark struct pid *pid; /* submitting process */ 325e25e92e0SRob Clark bool fault_dumped; /* Limit devcoredump dumping to one per submit */ 326340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 3276a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 328f97decacSJordan Crouse struct msm_ringbuffer *ring; 329cf655d61SJordan Crouse struct msm_file_private *ctx; 3307198e6b0SRob Clark unsigned int nr_cmds; 3317198e6b0SRob Clark unsigned int nr_bos; 3324241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 3337198e6b0SRob Clark struct { 3347198e6b0SRob Clark uint32_t type; 3357198e6b0SRob Clark uint32_t size; /* in dwords */ 33678babc16SRob Clark uint64_t iova; 33720224d71SRob Clark uint32_t offset;/* in dwords */ 338a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 33920224d71SRob Clark uint32_t nr_relocs; 34020224d71SRob Clark struct drm_msm_gem_submit_reloc *relocs; 3416b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 3427198e6b0SRob Clark struct { 3437198e6b0SRob Clark uint32_t flags; 344b673499aSKristian H. Kristensen union { 3457198e6b0SRob Clark struct msm_gem_object *obj; 346b673499aSKristian H. Kristensen uint32_t handle; 347b673499aSKristian H. Kristensen }; 34878babc16SRob Clark uint64_t iova; 3494c145df1SGustavo A. R. Silva } bos[]; 3507198e6b0SRob Clark }; 3517198e6b0SRob Clark 352964d2f97SRob Clark void __msm_gem_submit_destroy(struct kref *kref); 353964d2f97SRob Clark 354964d2f97SRob Clark static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 355964d2f97SRob Clark { 356964d2f97SRob Clark kref_get(&submit->ref); 357964d2f97SRob Clark } 358964d2f97SRob Clark 359964d2f97SRob Clark static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 360964d2f97SRob Clark { 361964d2f97SRob Clark kref_put(&submit->ref, __msm_gem_submit_destroy); 362964d2f97SRob Clark } 363964d2f97SRob Clark 364e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 365e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 366e515af8dSRob Clark */ 367e515af8dSRob Clark static inline bool 368e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 369e515af8dSRob Clark { 370e515af8dSRob Clark extern bool rd_full; 371e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 372e515af8dSRob Clark } 373e515af8dSRob Clark 374c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 375