drm_gem_shmem_helper.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef __DRM_GEM_SHMEM_HELPER_H__
  3. #define __DRM_GEM_SHMEM_HELPER_H__
  4. #include <linux/fs.h>
  5. #include <linux/mm.h>
  6. #include <linux/mutex.h>
  7. #include <drm/drm_file.h>
  8. #include <drm/drm_gem.h>
  9. #include <drm/drm_ioctl.h>
  10. #include <drm/drm_prime.h>
  11. struct dma_buf_attachment;
  12. struct drm_mode_create_dumb;
  13. struct drm_printer;
  14. struct sg_table;
  15. /**
  16. * struct drm_gem_shmem_object - GEM object backed by shmem
  17. */
  18. struct drm_gem_shmem_object {
  19. /**
  20. * @base: Base GEM object
  21. */
  22. struct drm_gem_object base;
  23. /**
  24. * @pages_lock: Protects the page table and use count
  25. */
  26. struct mutex pages_lock;
  27. /**
  28. * @pages: Page table
  29. */
  30. struct page **pages;
  31. /**
  32. * @pages_use_count:
  33. *
  34. * Reference count on the pages table.
  35. * The pages are put when the count reaches zero.
  36. */
  37. unsigned int pages_use_count;
  38. /**
  39. * @madv: State for madvise
  40. *
  41. * 0 is active/inuse.
  42. * A negative value is the object is purged.
  43. * Positive values are driver specific and not used by the helpers.
  44. */
  45. int madv;
  46. /**
  47. * @madv_list: List entry for madvise tracking
  48. *
  49. * Typically used by drivers to track purgeable objects
  50. */
  51. struct list_head madv_list;
  52. /**
  53. * @pages_mark_dirty_on_put:
  54. *
  55. * Mark pages as dirty when they are put.
  56. */
  57. unsigned int pages_mark_dirty_on_put : 1;
  58. /**
  59. * @pages_mark_accessed_on_put:
  60. *
  61. * Mark pages as accessed when they are put.
  62. */
  63. unsigned int pages_mark_accessed_on_put : 1;
  64. /**
  65. * @sgt: Scatter/gather table for imported PRIME buffers
  66. */
  67. struct sg_table *sgt;
  68. /**
  69. * @vmap_lock: Protects the vmap address and use count
  70. */
  71. struct mutex vmap_lock;
  72. /**
  73. * @vaddr: Kernel virtual address of the backing memory
  74. */
  75. void *vaddr;
  76. /**
  77. * @vmap_use_count:
  78. *
  79. * Reference count on the virtual address.
  80. * The address are un-mapped when the count reaches zero.
  81. */
  82. unsigned int vmap_use_count;
  83. /**
  84. * @map_cached: map object cached (instead of using writecombine).
  85. */
  86. bool map_cached;
  87. };
  88. #define to_drm_gem_shmem_obj(obj) \
  89. container_of(obj, struct drm_gem_shmem_object, base)
  90. struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size);
  91. void drm_gem_shmem_free_object(struct drm_gem_object *obj);
  92. int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem);
  93. void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem);
  94. int drm_gem_shmem_pin(struct drm_gem_object *obj);
  95. void drm_gem_shmem_unpin(struct drm_gem_object *obj);
  96. void *drm_gem_shmem_vmap(struct drm_gem_object *obj);
  97. void drm_gem_shmem_vunmap(struct drm_gem_object *obj, void *vaddr);
  98. int drm_gem_shmem_madvise(struct drm_gem_object *obj, int madv);
  99. static inline bool drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object *shmem)
  100. {
  101. return (shmem->madv > 0) &&
  102. !shmem->vmap_use_count && shmem->sgt &&
  103. !shmem->base.dma_buf && !shmem->base.import_attach;
  104. }
  105. void drm_gem_shmem_purge_locked(struct drm_gem_object *obj);
  106. bool drm_gem_shmem_purge(struct drm_gem_object *obj);
  107. struct drm_gem_shmem_object *
  108. drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
  109. struct drm_device *dev, size_t size,
  110. uint32_t *handle);
  111. struct drm_gem_object *
  112. drm_gem_shmem_create_object_cached(struct drm_device *dev, size_t size);
  113. int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
  114. struct drm_mode_create_dumb *args);
  115. int drm_gem_shmem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
  116. void drm_gem_shmem_print_info(struct drm_printer *p, unsigned int indent,
  117. const struct drm_gem_object *obj);
  118. struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_object *obj);
  119. struct drm_gem_object *
  120. drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
  121. struct dma_buf_attachment *attach,
  122. struct sg_table *sgt);
  123. struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_object *obj);
  124. /**
  125. * DRM_GEM_SHMEM_DRIVER_OPS - Default shmem GEM operations
  126. *
  127. * This macro provides a shortcut for setting the shmem GEM operations in
  128. * the &drm_driver structure.
  129. */
  130. #define DRM_GEM_SHMEM_DRIVER_OPS \
  131. .prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
  132. .prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
  133. .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table, \
  134. .gem_prime_mmap = drm_gem_prime_mmap, \
  135. .dumb_create = drm_gem_shmem_dumb_create
  136. #endif /* __DRM_GEM_SHMEM_HELPER_H__ */