5 * GEM Graphics Execution Manager Driver Interfaces
7 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
8 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
9 * Copyright (c) 2009-2010, Code Aurora Forum.
10 * All rights reserved.
11 * Copyright © 2014 Intel Corporation
12 * Daniel Vetter <daniel.vetter@ffwll.ch>
14 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
15 * Author: Gareth Hughes <gareth@valinux.com>
17 * Permission is hereby granted, free of charge, to any person obtaining a
18 * copy of this software and associated documentation files (the "Software"),
19 * to deal in the Software without restriction, including without limitation
20 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21 * and/or sell copies of the Software, and to permit persons to whom the
22 * Software is furnished to do so, subject to the following conditions:
24 * The above copyright notice and this permission notice (including the next
25 * paragraph) shall be included in all copies or substantial portions of the
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
31 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
32 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
33 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34 * OTHER DEALINGS IN THE SOFTWARE.
37 #include <linux/kref.h>
39 #include <drm/drm_vma_manager.h>
42 * struct drm_gem_object - GEM buffer object
44 * This structure defines the generic parts for GEM buffer objects, which are
45 * mostly around handling mmap and userspace handles.
47 * Buffer objects are often abbreviated to BO.
49 struct drm_gem_object {
53 * Reference count of this object
55 * Please use drm_gem_object_get() to acquire and drm_gem_object_put()
56 * or drm_gem_object_put_unlocked() to release a reference to a GEM
64 * This is the GEM file_priv handle count of this object.
66 * Each handle also holds a reference. Note that when the handle_count
67 * drops to 0 any global names (e.g. the id in the flink namespace) will
70 * Protected by &drm_device.object_name_lock.
72 unsigned handle_count;
75 * @dev: DRM dev this object belongs to.
77 struct drm_device *dev;
82 * SHMEM file node used as backing storage for swappable buffer objects.
83 * GEM also supports driver private objects with driver-specific backing
84 * storage (contiguous CMA memory, special reserved blocks). In this
92 * Mapping info for this object to support mmap. Drivers are supposed to
93 * allocate the mmap offset using drm_gem_create_mmap_offset(). The
94 * offset itself can be retrieved using drm_vma_node_offset_addr().
96 * Memory mapping itself is handled by drm_gem_mmap(), which also checks
97 * that userspace is allowed to access the object.
99 struct drm_vma_offset_node vma_node;
104 * Size of the object, in bytes. Immutable over the object's
112 * Global name for this object, starts at 1. 0 means unnamed.
113 * Access is covered by &drm_device.object_name_lock. This is used by
114 * the GEM_FLINK and GEM_OPEN ioctls.
121 * Read memory domains. These monitor which caches contain read/write data
122 * related to the object. When transitioning from one set of domains
123 * to another, the driver is called to ensure that caches are suitably
124 * flushed and invalidated.
126 uint32_t read_domains;
129 * @write_domain: Corresponding unique write memory domain.
131 uint32_t write_domain;
134 * @pending_read_domains:
136 * While validating an exec operation, the
137 * new read/write domain values are computed here.
138 * They will be transferred to the above values
139 * at the point that any cache flushing occurs
141 uint32_t pending_read_domains;
144 * @pending_write_domain: Write domain similar to @pending_read_domains.
146 uint32_t pending_write_domain;
151 * dma-buf associated with this GEM object.
153 * Pointer to the dma-buf associated with this gem object (either
154 * through importing or exporting). We break the resulting reference
155 * loop when the last gem handle for this object is released.
157 * Protected by &drm_device.object_name_lock.
159 struct dma_buf *dma_buf;
164 * dma-buf attachment backing this object.
166 * Any foreign dma_buf imported as a gem object has this set to the
167 * attachment point for the device. This is invariant over the lifetime
170 * The &drm_driver.gem_free_object callback is responsible for cleaning
171 * up the dma_buf attachment and references acquired at import time.
173 * Note that the drm gem/prime core does not depend upon drivers setting
174 * this field any more. So for drivers where this doesn't make sense
175 * (e.g. virtual devices or a displaylink behind an usb bus) they can
176 * simply leave it as NULL.
178 struct dma_buf_attachment *import_attach;
181 void drm_gem_object_release(struct drm_gem_object *obj);
182 void drm_gem_object_free(struct kref *kref);
183 int drm_gem_object_init(struct drm_device *dev,
184 struct drm_gem_object *obj, size_t size);
185 void drm_gem_private_object_init(struct drm_device *dev,
186 struct drm_gem_object *obj, size_t size);
187 void drm_gem_vm_open(struct vm_area_struct *vma);
188 void drm_gem_vm_close(struct vm_area_struct *vma);
189 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
190 struct vm_area_struct *vma);
191 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
194 * drm_gem_object_get - acquire a GEM buffer object reference
195 * @obj: GEM buffer object
197 * This function acquires an additional reference to @obj. It is illegal to
198 * call this without already holding a reference. No locks required.
200 static inline void drm_gem_object_get(struct drm_gem_object *obj)
202 kref_get(&obj->refcount);
206 * __drm_gem_object_put - raw function to release a GEM buffer object reference
207 * @obj: GEM buffer object
209 * This function is meant to be used by drivers which are not encumbered with
210 * &drm_device.struct_mutex legacy locking and which are using the
211 * gem_free_object_unlocked callback. It avoids all the locking checks and
212 * locking overhead of drm_gem_object_put() and drm_gem_object_put_unlocked().
214 * Drivers should never call this directly in their code. Instead they should
215 * wrap it up into a ``driver_gem_object_put(struct driver_gem_object *obj)``
216 * wrapper function, and use that. Shared code should never call this, to
217 * avoid breaking drivers by accident which still depend upon
218 * &drm_device.struct_mutex locking.
221 __drm_gem_object_put(struct drm_gem_object *obj)
223 kref_put(&obj->refcount, drm_gem_object_free);
226 void drm_gem_object_put_unlocked(struct drm_gem_object *obj);
227 void drm_gem_object_put(struct drm_gem_object *obj);
230 * drm_gem_object_reference - acquire a GEM buffer object reference
231 * @obj: GEM buffer object
233 * This is a compatibility alias for drm_gem_object_get() and should not be
236 static inline void drm_gem_object_reference(struct drm_gem_object *obj)
238 drm_gem_object_get(obj);
242 * __drm_gem_object_unreference - raw function to release a GEM buffer object
244 * @obj: GEM buffer object
246 * This is a compatibility alias for __drm_gem_object_put() and should not be
249 static inline void __drm_gem_object_unreference(struct drm_gem_object *obj)
251 __drm_gem_object_put(obj);
255 * drm_gem_object_unreference_unlocked - release a GEM buffer object reference
256 * @obj: GEM buffer object
258 * This is a compatibility alias for drm_gem_object_put_unlocked() and should
259 * not be used by new code.
262 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
264 drm_gem_object_put_unlocked(obj);
268 * drm_gem_object_unreference - release a GEM buffer object reference
269 * @obj: GEM buffer object
271 * This is a compatibility alias for drm_gem_object_put() and should not be
274 static inline void drm_gem_object_unreference(struct drm_gem_object *obj)
276 drm_gem_object_put(obj);
279 int drm_gem_handle_create(struct drm_file *file_priv,
280 struct drm_gem_object *obj,
282 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
285 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
286 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
287 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
289 struct page **drm_gem_get_pages(struct drm_gem_object *obj);
290 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
291 bool dirty, bool accessed);
293 struct drm_gem_object *drm_gem_object_lookup(struct drm_file *filp, u32 handle);
294 int drm_gem_dumb_destroy(struct drm_file *file,
295 struct drm_device *dev,
298 #endif /* __DRM_GEM_H__ */