drivers/gpu/drm/msm/msm_gem.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2013 Red Hat
   4  * Author: Rob Clark <[email protected]>
   5  */
   6
   7 #ifndef __MSM_GEM_H__
   8 #define __MSM_GEM_H__
   9
  10 #include <linux/kref.h>
  11 #include <linux/dma-resv.h>
  12 #include "drm/gpu_scheduler.h"
  13 #include "msm_drv.h"
  14
  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.
  17  */
  18 #define GEM_WARN_ON(x)  WARN_RATELIMIT(x, "%s", __stringify(x))
  19
  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 */
  23
  24 struct msm_gem_address_space {
  25         const char *name;
  26         /* NOTE: mm managed at the page level, size is in # of pages
  27          * and position mm_node->start is in # of pages:
  28          */
  29         struct drm_mm mm;
  30         spinlock_t lock; /* Protects drm_mm node allocation/removal */
  31         struct msm_mmu *mmu;
  32         struct kref kref;
  33
  34         /* For address spaces associated with a specific process, this
  35          * will be non-NULL:
  36          */
  37         struct pid *pid;
  38
  39         /* @faults: the number of GPU hangs associated with this address space */
  40         int faults;
  41
  42         /** @va_start: lowest possible address to allocate */
  43         uint64_t va_start;
  44
  45         /** @va_size: the size of the address space (in bytes) */
  46         uint64_t va_size;
  47 };
  48
  49 struct msm_gem_address_space *
  50 msm_gem_address_space_get(struct msm_gem_address_space *aspace);
  51
  52 void msm_gem_address_space_put(struct msm_gem_address_space *aspace);
  53
  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);
  57
  58 struct msm_fence_context;
  59
  60 struct msm_gem_vma {
  61         struct drm_mm_node node;
  62         spinlock_t lock;
  63         uint64_t iova;
  64         struct msm_gem_address_space *aspace;
  65         struct list_head list;    /* node in msm_gem_object::vmas */
  66         bool mapped;
  67         int inuse;
  68         uint32_t fence_mask;
  69         uint32_t fence[MSM_GPU_MAX_RINGS];
  70         struct msm_fence_context *fctx[MSM_GPU_MAX_RINGS];
  71 };
  72
  73 struct msm_gem_vma *msm_gem_vma_new(struct msm_gem_address_space *aspace);
  74 int msm_gem_vma_init(struct msm_gem_vma *vma, int size,
  75                 u64 range_start, u64 range_end);
  76 bool msm_gem_vma_inuse(struct msm_gem_vma *vma);
  77 void msm_gem_vma_purge(struct msm_gem_vma *vma);
  78 void msm_gem_vma_unpin(struct msm_gem_vma *vma);
  79 void msm_gem_vma_unpin_fenced(struct msm_gem_vma *vma, struct msm_fence_context *fctx);
  80 int msm_gem_vma_map(struct msm_gem_vma *vma, int prot, struct sg_table *sgt, int size);
  81 void msm_gem_vma_close(struct msm_gem_vma *vma);
  82
  83 struct msm_gem_object {
  84         struct drm_gem_object base;
  85
  86         uint32_t flags;
  87
  88         /**
  89          * madv: are the backing pages purgeable?
  90          *
  91          * Protected by obj lock and LRU lock
  92          */
  93         uint8_t madv;
  94
  95         /**
  96          * count of active vmap'ing
  97          */
  98         uint8_t vmap_count;
  99
 100         /**
 101          * Node in list of all objects (mainly for debugfs, protected by
 102          * priv->obj_lock
 103          */
 104         struct list_head node;
 105
 106         struct page **pages;
 107         struct sg_table *sgt;
 108         void *vaddr;
 109
 110         struct list_head vmas;    /* list of msm_gem_vma */
 111
 112         /* For physically contiguous buffers.  Used when we don't have
 113          * an IOMMU.  Also used for stolen/splashscreen buffer.
 114          */
 115         struct drm_mm_node *vram_node;
 116
 117         char name[32]; /* Identifier to print for the debugfs files */
 118
 119         /**
 120          * pin_count: Number of times the pages are pinned
 121          *
 122          * Protected by LRU lock.
 123          */
 124         int pin_count;
 125 };
 126 #define to_msm_bo(x) container_of(x, struct msm_gem_object, base)
 127
 128 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj);
 129 int msm_gem_pin_vma_locked(struct drm_gem_object *obj, struct msm_gem_vma *vma);
 130 void msm_gem_unpin_locked(struct drm_gem_object *obj);
 131 void msm_gem_unpin_active(struct drm_gem_object *obj);
 132 struct msm_gem_vma *msm_gem_get_vma_locked(struct drm_gem_object *obj,
 133                                            struct msm_gem_address_space *aspace);
 134 int msm_gem_get_iova(struct drm_gem_object *obj,
 135                 struct msm_gem_address_space *aspace, uint64_t *iova);
 136 int msm_gem_set_iova(struct drm_gem_object *obj,
 137                 struct msm_gem_address_space *aspace, uint64_t iova);
 138 int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj,
 139                 struct msm_gem_address_space *aspace, uint64_t *iova,
 140                 u64 range_start, u64 range_end);
 141 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj,
 142                 struct msm_gem_address_space *aspace, uint64_t *iova);
 143 void msm_gem_unpin_iova(struct drm_gem_object *obj,
 144                 struct msm_gem_address_space *aspace);
 145 struct page **msm_gem_pin_pages(struct drm_gem_object *obj);
 146 void msm_gem_unpin_pages(struct drm_gem_object *obj);
 147 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
 148                 struct drm_mode_create_dumb *args);
 149 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
 150                 uint32_t handle, uint64_t *offset);
 151 void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj);
 152 void *msm_gem_get_vaddr(struct drm_gem_object *obj);
 153 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj);
 154 void msm_gem_put_vaddr_locked(struct drm_gem_object *obj);
 155 void msm_gem_put_vaddr(struct drm_gem_object *obj);
 156 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv);
 157 bool msm_gem_active(struct drm_gem_object *obj);
 158 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout);
 159 int msm_gem_cpu_fini(struct drm_gem_object *obj);
 160 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
 161                 uint32_t size, uint32_t flags, uint32_t *handle, char *name);
 162 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
 163                 uint32_t size, uint32_t flags);
 164 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
 165                 uint32_t flags, struct msm_gem_address_space *aspace,
 166                 struct drm_gem_object **bo, uint64_t *iova);
 167 void msm_gem_kernel_put(struct drm_gem_object *bo,
 168                 struct msm_gem_address_space *aspace);
 169 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
 170                 struct dma_buf *dmabuf, struct sg_table *sgt);
 171 __printf(2, 3)
 172 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...);
 173
 174 #ifdef CONFIG_DEBUG_FS
 175 struct msm_gem_stats {
 176         struct {
 177                 unsigned count;
 178                 size_t size;
 179         } all, active, resident, purgeable, purged;
 180 };
 181
 182 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m,
 183                 struct msm_gem_stats *stats);
 184 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m);
 185 #endif
 186
 187 static inline void
 188 msm_gem_lock(struct drm_gem_object *obj)
 189 {
 190         dma_resv_lock(obj->resv, NULL);
 191 }
 192
 193 static inline int
 194 msm_gem_lock_interruptible(struct drm_gem_object *obj)
 195 {
 196         return dma_resv_lock_interruptible(obj->resv, NULL);
 197 }
 198
 199 static inline void
 200 msm_gem_unlock(struct drm_gem_object *obj)
 201 {
 202         dma_resv_unlock(obj->resv);
 203 }
 204
 205 static inline void
 206 msm_gem_assert_locked(struct drm_gem_object *obj)
 207 {
 208         /*
 209          * Destroying the object is a special case.. msm_gem_free_object()
 210          * calls many things that WARN_ON if the obj lock is not held.  But
 211          * acquiring the obj lock in msm_gem_free_object() can cause a
 212          * locking order inversion between reservation_ww_class_mutex and
 213          * fs_reclaim.
 214          *
 215          * This deadlock is not actually possible, because no one should
 216          * be already holding the lock when msm_gem_free_object() is called.
 217          * Unfortunately lockdep is not aware of this detail.  So when the
 218          * refcount drops to zero, we pretend it is already locked.
 219          */
 220         lockdep_assert_once(
 221                 (kref_read(&obj->refcount) == 0) ||
 222                 (lockdep_is_held(&obj->resv->lock.base) != LOCK_STATE_NOT_HELD)
 223         );
 224 }
 225
 226 /* imported/exported objects are not purgeable: */
 227 static inline bool is_unpurgeable(struct msm_gem_object *msm_obj)
 228 {
 229         return msm_obj->base.import_attach || msm_obj->pin_count;
 230 }
 231
 232 static inline bool is_purgeable(struct msm_gem_object *msm_obj)
 233 {
 234         return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt &&
 235                         !is_unpurgeable(msm_obj);
 236 }
 237
 238 static inline bool is_vunmapable(struct msm_gem_object *msm_obj)
 239 {
 240         msm_gem_assert_locked(&msm_obj->base);
 241         return (msm_obj->vmap_count == 0) && msm_obj->vaddr;
 242 }
 243
 244 static inline bool is_unevictable(struct msm_gem_object *msm_obj)
 245 {
 246         return is_unpurgeable(msm_obj) || msm_obj->vaddr;
 247 }
 248
 249 void msm_gem_purge(struct drm_gem_object *obj);
 250 void msm_gem_evict(struct drm_gem_object *obj);
 251 void msm_gem_vunmap(struct drm_gem_object *obj);
 252
 253 /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc,
 254  * associated with the cmdstream submission for synchronization (and
 255  * make it easier to unwind when things go wrong, etc).
 256  */
 257 struct msm_gem_submit {
 258         struct drm_sched_job base;
 259         struct kref ref;
 260         struct drm_device *dev;
 261         struct msm_gpu *gpu;
 262         struct msm_gem_address_space *aspace;
 263         struct list_head node;   /* node in ring submit list */
 264         struct ww_acquire_ctx ticket;
 265         uint32_t seqno;         /* Sequence number of the submit on the ring */
 266
 267         /* Hw fence, which is created when the scheduler executes the job, and
 268          * is signaled when the hw finishes (via seqno write from cmdstream)
 269          */
 270         struct dma_fence *hw_fence;
 271
 272         /* Userspace visible fence, which is signaled by the scheduler after
 273          * the hw_fence is signaled.
 274          */
 275         struct dma_fence *user_fence;
 276
 277         int fence_id;       /* key into queue->fence_idr */
 278         struct msm_gpu_submitqueue *queue;
 279         struct pid *pid;    /* submitting process */
 280         bool fault_dumped;  /* Limit devcoredump dumping to one per submit */
 281         bool valid;         /* true if no cmdstream patching needed */
 282         bool in_rb;         /* "sudo" mode, copy cmds into RB */
 283         struct msm_ringbuffer *ring;
 284         unsigned int nr_cmds;
 285         unsigned int nr_bos;
 286         u32 ident;         /* A "identifier" for the submit for logging */
 287         struct {
 288                 uint32_t type;
 289                 uint32_t size;  /* in dwords */
 290                 uint64_t iova;
 291                 uint32_t offset;/* in dwords */
 292                 uint32_t idx;   /* cmdstream buffer idx in bos[] */
 293                 uint32_t nr_relocs;
 294                 struct drm_msm_gem_submit_reloc *relocs;
 295         } *cmd;  /* array of size nr_cmds */
 296         struct {
 297 /* make sure these don't conflict w/ MSM_SUBMIT_BO_x */
 298 #define BO_VALID        0x8000  /* is current addr in cmdstream correct/valid? */
 299 #define BO_LOCKED       0x4000  /* obj lock is held */
 300 #define BO_OBJ_PINNED   0x2000  /* obj (pages) is pinned and on active list */
 301 #define BO_VMA_PINNED   0x1000  /* vma (virtual address) is pinned */
 302                 uint32_t flags;
 303                 union {
 304                         struct msm_gem_object *obj;
 305                         uint32_t handle;
 306                 };
 307                 uint64_t iova;
 308                 struct msm_gem_vma *vma;
 309         } bos[];
 310 };
 311
 312 static inline struct msm_gem_submit *to_msm_submit(struct drm_sched_job *job)
 313 {
 314         return container_of(job, struct msm_gem_submit, base);
 315 }
 316
 317 void __msm_gem_submit_destroy(struct kref *kref);
 318
 319 static inline void msm_gem_submit_get(struct msm_gem_submit *submit)
 320 {
 321         kref_get(&submit->ref);
 322 }
 323
 324 static inline void msm_gem_submit_put(struct msm_gem_submit *submit)
 325 {
 326         kref_put(&submit->ref, __msm_gem_submit_destroy);
 327 }
 328
 329 void msm_submit_retire(struct msm_gem_submit *submit);
 330
 331 /* helper to determine of a buffer in submit should be dumped, used for both
 332  * devcoredump and debugfs cmdstream dumping:
 333  */
 334 static inline bool
 335 should_dump(struct msm_gem_submit *submit, int idx)
 336 {
 337         extern bool rd_full;
 338         return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP);
 339 }
 340
 341 #endif /* __MSM_GEM_H__ */