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 14072f1f91SRob Clark /* Additional internal-use only BO flags: */ 15072f1f91SRob Clark #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 160b462d7aSJonathan Marek #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 17072f1f91SRob Clark 18667ce33eSRob Clark struct msm_gem_address_space { 19667ce33eSRob Clark const char *name; 20667ce33eSRob Clark /* NOTE: mm managed at the page level, size is in # of pages 21667ce33eSRob Clark * and position mm_node->start is in # of pages: 22667ce33eSRob Clark */ 23667ce33eSRob Clark struct drm_mm mm; 240e08270aSSushmita Susheelendra spinlock_t lock; /* Protects drm_mm node allocation/removal */ 25667ce33eSRob Clark struct msm_mmu *mmu; 26ee546cd3SJordan Crouse struct kref kref; 2725faf2f2SRob Clark 2825faf2f2SRob Clark /* For address spaces associated with a specific process, this 2925faf2f2SRob Clark * will be non-NULL: 3025faf2f2SRob Clark */ 3125faf2f2SRob Clark struct pid *pid; 32667ce33eSRob Clark }; 33667ce33eSRob Clark 34667ce33eSRob Clark struct msm_gem_vma { 35667ce33eSRob Clark struct drm_mm_node node; 36667ce33eSRob Clark uint64_t iova; 374b85f7f5SRob Clark struct msm_gem_address_space *aspace; 384b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 39c0ee9794SJordan Crouse bool mapped; 407ad0e8cfSJordan Crouse int inuse; 41667ce33eSRob Clark }; 42667ce33eSRob Clark 43c8afe684SRob Clark struct msm_gem_object { 44c8afe684SRob Clark struct drm_gem_object base; 45c8afe684SRob Clark 46c8afe684SRob Clark uint32_t flags; 47c8afe684SRob Clark 484cd33c48SRob Clark /** 494cd33c48SRob Clark * Advice: are the backing pages purgeable? 504cd33c48SRob Clark */ 514cd33c48SRob Clark uint8_t madv; 524cd33c48SRob Clark 53e1e9db2cSRob Clark /** 54e1e9db2cSRob Clark * count of active vmap'ing 55e1e9db2cSRob Clark */ 56e1e9db2cSRob Clark uint8_t vmap_count; 57e1e9db2cSRob Clark 587198e6b0SRob Clark /* And object is either: 597198e6b0SRob Clark * inactive - on priv->inactive_list 607198e6b0SRob Clark * active - on one one of the gpu's active_list.. well, at 617198e6b0SRob Clark * least for now we don't have (I don't think) hw sync between 627198e6b0SRob Clark * 2d and 3d one devices which have both, meaning we need to 637198e6b0SRob Clark * block on submit if a bo is already on other ring 647198e6b0SRob Clark * 657198e6b0SRob Clark */ 66c8afe684SRob Clark struct list_head mm_list; 677198e6b0SRob Clark struct msm_gpu *gpu; /* non-null if active */ 687198e6b0SRob Clark 697198e6b0SRob Clark /* Transiently in the process of submit ioctl, objects associated 707198e6b0SRob Clark * with the submit are on submit->bo_list.. this only lasts for 717198e6b0SRob Clark * the duration of the ioctl, so one bo can never be on multiple 727198e6b0SRob Clark * submit lists. 737198e6b0SRob Clark */ 747198e6b0SRob Clark struct list_head submit_entry; 757198e6b0SRob Clark 76c8afe684SRob Clark struct page **pages; 77c8afe684SRob Clark struct sg_table *sgt; 78c8afe684SRob Clark void *vaddr; 79c8afe684SRob Clark 804b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 817198e6b0SRob Clark 8248e7f183SKristian H. Kristensen struct llist_node freed; 8348e7f183SKristian H. Kristensen 84871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 85072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 86871d812aSRob Clark */ 87871d812aSRob Clark struct drm_mm_node *vram_node; 880e08270aSSushmita Susheelendra struct mutex lock; /* Protects resources associated with bo */ 890815d774SJordan Crouse 900815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 919d8baa2bSAkhil P Oommen 929d8baa2bSAkhil P Oommen atomic_t active_count; 93c8afe684SRob Clark }; 94c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 95c8afe684SRob Clark 96*a6ae74c9SRob Clark static inline void 97*a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 98*a6ae74c9SRob Clark { 99*a6ae74c9SRob Clark struct msm_gem_object *msm_obj = to_msm_bo(obj); 100*a6ae74c9SRob Clark mutex_lock(&msm_obj->lock); 101*a6ae74c9SRob Clark } 102*a6ae74c9SRob Clark 103*a6ae74c9SRob Clark static inline int 104*a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 105*a6ae74c9SRob Clark { 106*a6ae74c9SRob Clark struct msm_gem_object *msm_obj = to_msm_bo(obj); 107*a6ae74c9SRob Clark return mutex_lock_interruptible(&msm_obj->lock); 108*a6ae74c9SRob Clark } 109*a6ae74c9SRob Clark 110*a6ae74c9SRob Clark static inline void 111*a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 112*a6ae74c9SRob Clark { 113*a6ae74c9SRob Clark struct msm_gem_object *msm_obj = to_msm_bo(obj); 114*a6ae74c9SRob Clark mutex_unlock(&msm_obj->lock); 115*a6ae74c9SRob Clark } 116*a6ae74c9SRob Clark 117*a6ae74c9SRob Clark static inline bool 118*a6ae74c9SRob Clark msm_gem_is_locked(struct drm_gem_object *obj) 119*a6ae74c9SRob Clark { 120*a6ae74c9SRob Clark struct msm_gem_object *msm_obj = to_msm_bo(obj); 121*a6ae74c9SRob Clark return mutex_is_locked(&msm_obj->lock); 122*a6ae74c9SRob Clark } 123*a6ae74c9SRob Clark 1247198e6b0SRob Clark static inline bool is_active(struct msm_gem_object *msm_obj) 1257198e6b0SRob Clark { 1269d8baa2bSAkhil P Oommen return atomic_read(&msm_obj->active_count); 1277198e6b0SRob Clark } 1287198e6b0SRob Clark 12968209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 13068209390SRob Clark { 1310e08270aSSushmita Susheelendra WARN_ON(!mutex_is_locked(&msm_obj->base.dev->struct_mutex)); 13268209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 13368209390SRob Clark !msm_obj->base.dma_buf && !msm_obj->base.import_attach; 13468209390SRob Clark } 13568209390SRob Clark 136e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 137e1e9db2cSRob Clark { 138e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 139e1e9db2cSRob Clark } 140e1e9db2cSRob Clark 1410e08270aSSushmita Susheelendra /* The shrinker can be triggered while we hold objA->lock, and need 1420e08270aSSushmita Susheelendra * to grab objB->lock to purge it. Lockdep just sees these as a single 1430e08270aSSushmita Susheelendra * class of lock, so we use subclasses to teach it the difference. 1440e08270aSSushmita Susheelendra * 1450e08270aSSushmita Susheelendra * OBJ_LOCK_NORMAL is implicit (ie. normal mutex_lock() call), and 1460e08270aSSushmita Susheelendra * OBJ_LOCK_SHRINKER is used by shrinker. 1470e08270aSSushmita Susheelendra * 1480e08270aSSushmita Susheelendra * It is *essential* that we never go down paths that could trigger the 1490e08270aSSushmita Susheelendra * shrinker for a purgable object. This is ensured by checking that 1500e08270aSSushmita Susheelendra * msm_obj->madv == MSM_MADV_WILLNEED. 1510e08270aSSushmita Susheelendra */ 1520e08270aSSushmita Susheelendra enum msm_gem_lock { 1530e08270aSSushmita Susheelendra OBJ_LOCK_NORMAL, 1540e08270aSSushmita Susheelendra OBJ_LOCK_SHRINKER, 1550e08270aSSushmita Susheelendra }; 1560e08270aSSushmita Susheelendra 1570e08270aSSushmita Susheelendra void msm_gem_purge(struct drm_gem_object *obj, enum msm_gem_lock subclass); 1580e08270aSSushmita Susheelendra void msm_gem_vunmap(struct drm_gem_object *obj, enum msm_gem_lock subclass); 15948e7f183SKristian H. Kristensen void msm_gem_free_work(struct work_struct *work); 1600e08270aSSushmita Susheelendra 1617198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 1627198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 1637198e6b0SRob Clark * make it easier to unwind when things go wrong, etc). This only 1647198e6b0SRob Clark * lasts for the duration of the submit-ioctl. 1657198e6b0SRob Clark */ 1667198e6b0SRob Clark struct msm_gem_submit { 1677198e6b0SRob Clark struct drm_device *dev; 1687198e6b0SRob Clark struct msm_gpu *gpu; 169295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 170f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 1717198e6b0SRob Clark struct list_head bo_list; 1727198e6b0SRob Clark struct ww_acquire_ctx ticket; 173f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 174f54d1867SChris Wilson struct dma_fence *fence; 175f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 1764816b626SRob Clark struct pid *pid; /* submitting process */ 177340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 1786a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 179f97decacSJordan Crouse struct msm_ringbuffer *ring; 180cf655d61SJordan Crouse struct msm_file_private *ctx; 1817198e6b0SRob Clark unsigned int nr_cmds; 1827198e6b0SRob Clark unsigned int nr_bos; 1834241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 1847198e6b0SRob Clark struct { 1857198e6b0SRob Clark uint32_t type; 1867198e6b0SRob Clark uint32_t size; /* in dwords */ 18778babc16SRob Clark uint64_t iova; 188a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 1896b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 1907198e6b0SRob Clark struct { 1917198e6b0SRob Clark uint32_t flags; 192b673499aSKristian H. Kristensen union { 1937198e6b0SRob Clark struct msm_gem_object *obj; 194b673499aSKristian H. Kristensen uint32_t handle; 195b673499aSKristian H. Kristensen }; 19678babc16SRob Clark uint64_t iova; 1974c145df1SGustavo A. R. Silva } bos[]; 1987198e6b0SRob Clark }; 1997198e6b0SRob Clark 200e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 201e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 202e515af8dSRob Clark */ 203e515af8dSRob Clark static inline bool 204e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 205e515af8dSRob Clark { 206e515af8dSRob Clark extern bool rd_full; 207e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 208e515af8dSRob Clark } 209e515af8dSRob Clark 210c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 211