1 #ifndef __DRM_GEM_H__
2 #define __DRM_GEM_H__
3
4 /*
5 * GEM Graphics Execution Manager Driver Interfaces
6 *
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>
13 *
14 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
15 * Author: Gareth Hughes <gareth@valinux.com>
16 *
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:
23 *
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
26 * Software.
27 *
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.
35 */
36
37 #include <drm/drm_hashtab.h>
38
39 /* BSD specific gem helpers. */
40 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
41 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
42 #define DRM_GEM_MAX_IDX 0x3fffff
43 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
44 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
45 #define DRM_GEM_MAPPING_MAPOFF(o) \
46 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
47
48 #include <linux/kref.h>
49
50 #include <drm/drm_vma_manager.h>
51
52 /**
53 * struct drm_gem_object - GEM buffer object
54 *
55 * This structure defines the generic parts for GEM buffer objects, which are
56 * mostly around handling mmap and userspace handles.
57 *
58 * Buffer objects are often abbreviated to BO.
59 */
60 struct drm_gem_object {
61 /**
62 * @refcount:
63 *
64 * Reference count of this object
65 *
66 * Please use drm_gem_object_get() to acquire and drm_gem_object_put()
67 * or drm_gem_object_put_unlocked() to release a reference to a GEM
68 * buffer object.
69 */
70 struct kref refcount;
71
72 /**
73 * @handle_count:
74 *
75 * This is the GEM file_priv handle count of this object.
76 *
77 * Each handle also holds a reference. Note that when the handle_count
78 * drops to 0 any global names (e.g. the id in the flink namespace) will
79 * be cleared.
80 *
81 * Protected by &drm_device.object_name_lock.
82 */
83 unsigned handle_count;
84
85 /**
86 * @dev: DRM dev this object belongs to.
87 */
88 struct drm_device *dev;
89
90 /**
91 * @filp:
92 *
93 * SHMEM file node used as backing storage for swappable buffer objects.
94 * GEM also supports driver private objects with driver-specific backing
95 * storage (contiguous CMA memory, special reserved blocks). In this
96 * case @filp is NULL.
97 */
98 #ifdef __DragonFly__
99 struct vm_object *filp;
100 #else
101 struct file *filp;
102 #endif
103
104 /**
105 * @vma_node:
106 *
107 * Mapping info for this object to support mmap. Drivers are supposed to
108 * allocate the mmap offset using drm_gem_create_mmap_offset(). The
109 * offset itself can be retrieved using drm_vma_node_offset_addr().
110 *
111 * Memory mapping itself is handled by drm_gem_mmap(), which also checks
112 * that userspace is allowed to access the object.
113 */
114 struct drm_vma_offset_node vma_node;
115 #ifdef __DragonFly__
116 bool on_map;
117 struct drm_hash_item map_list;
118 #endif
119
120 /**
121 * @size:
122 *
123 * Size of the object, in bytes. Immutable over the object's
124 * lifetime.
125 */
126 size_t size;
127
128 /**
129 * @name:
130 *
131 * Global name for this object, starts at 1. 0 means unnamed.
132 * Access is covered by &drm_device.object_name_lock. This is used by
133 * the GEM_FLINK and GEM_OPEN ioctls.
134 */
135 int name;
136
137 /**
138 * @read_domains:
139 *
140 * Read memory domains. These monitor which caches contain read/write data
141 * related to the object. When transitioning from one set of domains
142 * to another, the driver is called to ensure that caches are suitably
143 * flushed and invalidated.
144 */
145 uint32_t read_domains;
146
147 /**
148 * @write_domain: Corresponding unique write memory domain.
149 */
150 uint32_t write_domain;
151
152 /**
153 * @dma_buf:
154 *
155 * dma-buf associated with this GEM object.
156 *
157 * Pointer to the dma-buf associated with this gem object (either
158 * through importing or exporting). We break the resulting reference
159 * loop when the last gem handle for this object is released.
160 *
161 * Protected by &drm_device.object_name_lock.
162 */
163 struct dma_buf *dma_buf;
164
165 /**
166 * @import_attach:
167 *
168 * dma-buf attachment backing this object.
169 *
170 * Any foreign dma_buf imported as a gem object has this set to the
171 * attachment point for the device. This is invariant over the lifetime
172 * of a gem object.
173 *
174 * The &drm_driver.gem_free_object callback is responsible for cleaning
175 * up the dma_buf attachment and references acquired at import time.
176 *
177 * Note that the drm gem/prime core does not depend upon drivers setting
178 * this field any more. So for drivers where this doesn't make sense
179 * (e.g. virtual devices or a displaylink behind an usb bus) they can
180 * simply leave it as NULL.
181 */
182 struct dma_buf_attachment *import_attach;
183 };
184
185 /**
186 * DEFINE_DRM_GEM_FOPS() - macro to generate file operations for GEM drivers
187 * @name: name for the generated structure
188 *
189 * This macro autogenerates a suitable &struct file_operations for GEM based
190 * drivers, which can be assigned to &drm_driver.fops. Note that this structure
191 * cannot be shared between drivers, because it contains a reference to the
192 * current module using THIS_MODULE.
193 *
194 * Note that the declaration is already marked as static - if you need a
195 * non-static version of this you're probably doing it wrong and will break the
196 * THIS_MODULE reference by accident.
197 */
198 #define DEFINE_DRM_GEM_FOPS(name) \
199 static const struct file_operations name = {\
200 .owner = THIS_MODULE,\
201 .open = drm_open,\
202 .release = drm_release,\
203 .unlocked_ioctl = drm_ioctl,\
204 .compat_ioctl = drm_compat_ioctl,\
205 .poll = drm_poll,\
206 .read = drm_read,\
207 .llseek = noop_llseek,\
208 .mmap = drm_gem_mmap,\
209 }
210
211 void drm_gem_object_release(struct drm_gem_object *obj);
212 void drm_gem_object_free(struct kref *kref);
213 int drm_gem_object_init(struct drm_device *dev,
214 struct drm_gem_object *obj, size_t size);
215 void drm_gem_private_object_init(struct drm_device *dev,
216 struct drm_gem_object *obj, size_t size);
217 void drm_gem_vm_open(struct vm_area_struct *vma);
218 void drm_gem_vm_close(struct vm_area_struct *vma);
219 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
220 struct vm_area_struct *vma);
221 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
222
223 int i915_gem_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
224 vm_ooffset_t foff, struct ucred *cred, u_short *color);
225 void i915_gem_pager_dtor(void * handle);
226
227 /**
228 * drm_gem_object_get - acquire a GEM buffer object reference
229 * @obj: GEM buffer object
230 *
231 * This function acquires an additional reference to @obj. It is illegal to
232 * call this without already holding a reference. No locks required.
233 */
drm_gem_object_get(struct drm_gem_object * obj)234 static inline void drm_gem_object_get(struct drm_gem_object *obj)
235 {
236 kref_get(&obj->refcount);
237 }
238
239 /**
240 * __drm_gem_object_put - raw function to release a GEM buffer object reference
241 * @obj: GEM buffer object
242 *
243 * This function is meant to be used by drivers which are not encumbered with
244 * &drm_device.struct_mutex legacy locking and which are using the
245 * gem_free_object_unlocked callback. It avoids all the locking checks and
246 * locking overhead of drm_gem_object_put() and drm_gem_object_put_unlocked().
247 *
248 * Drivers should never call this directly in their code. Instead they should
249 * wrap it up into a ``driver_gem_object_put(struct driver_gem_object *obj)``
250 * wrapper function, and use that. Shared code should never call this, to
251 * avoid breaking drivers by accident which still depend upon
252 * &drm_device.struct_mutex locking.
253 */
254 static inline void
__drm_gem_object_put(struct drm_gem_object * obj)255 __drm_gem_object_put(struct drm_gem_object *obj)
256 {
257 kref_put(&obj->refcount, drm_gem_object_free);
258 }
259
260 void drm_gem_object_put_unlocked(struct drm_gem_object *obj);
261 void drm_gem_object_put(struct drm_gem_object *obj);
262
263 /**
264 * drm_gem_object_reference - acquire a GEM buffer object reference
265 * @obj: GEM buffer object
266 *
267 * This is a compatibility alias for drm_gem_object_get() and should not be
268 * used by new code.
269 */
drm_gem_object_reference(struct drm_gem_object * obj)270 static inline void drm_gem_object_reference(struct drm_gem_object *obj)
271 {
272 drm_gem_object_get(obj);
273 }
274
275 /**
276 * __drm_gem_object_unreference - raw function to release a GEM buffer object
277 * reference
278 * @obj: GEM buffer object
279 *
280 * This is a compatibility alias for __drm_gem_object_put() and should not be
281 * used by new code.
282 */
__drm_gem_object_unreference(struct drm_gem_object * obj)283 static inline void __drm_gem_object_unreference(struct drm_gem_object *obj)
284 {
285 __drm_gem_object_put(obj);
286 }
287
288 /**
289 * drm_gem_object_unreference_unlocked - release a GEM buffer object reference
290 * @obj: GEM buffer object
291 *
292 * This is a compatibility alias for drm_gem_object_put_unlocked() and should
293 * not be used by new code.
294 */
295 static inline void
drm_gem_object_unreference_unlocked(struct drm_gem_object * obj)296 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
297 {
298 drm_gem_object_put_unlocked(obj);
299 }
300
301 /**
302 * drm_gem_object_unreference - release a GEM buffer object reference
303 * @obj: GEM buffer object
304 *
305 * This is a compatibility alias for drm_gem_object_put() and should not be
306 * used by new code.
307 */
drm_gem_object_unreference(struct drm_gem_object * obj)308 static inline void drm_gem_object_unreference(struct drm_gem_object *obj)
309 {
310 drm_gem_object_put(obj);
311 }
312
313 int drm_gem_handle_create(struct drm_file *file_priv,
314 struct drm_gem_object *obj,
315 u32 *handlep);
316 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
317
318
319 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
320 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
321 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
322
323 struct page **drm_gem_get_pages(struct drm_gem_object *obj);
324 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
325 bool dirty, bool accessed);
326
327 struct drm_gem_object *drm_gem_object_lookup(struct drm_file *filp, u32 handle);
328 int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
329 u32 handle, u64 *offset);
330 int drm_gem_dumb_destroy(struct drm_file *file,
331 struct drm_device *dev,
332 uint32_t handle);
333
334 #endif /* __DRM_GEM_H__ */
335