OSDN Git Service

Use headers copied from kernel instead of shared-core
[android-x86/external-libdrm.git] / linux-core / drm_gem.c
1 /*
2  * Copyright © 2008 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *
26  */
27
28 #include <linux/version.h>
29
30 #include "drmP.h"
31
32 #if OS_HAS_GEM
33
34 #include <linux/types.h>
35 #include <linux/slab.h>
36 #include <linux/mm.h>
37 #include <linux/uaccess.h>
38 #include <linux/fs.h>
39 #include <linux/file.h>
40 #include <linux/module.h>
41 #include <linux/mman.h>
42 #include <linux/pagemap.h>
43
44 /** @file drm_gem.c
45  *
46  * This file provides some of the base ioctls and library routines for
47  * the graphics memory manager implemented by each device driver.
48  *
49  * Because various devices have different requirements in terms of
50  * synchronization and migration strategies, implementing that is left up to
51  * the driver, and all that the general API provides should be generic --
52  * allocating objects, reading/writing data with the cpu, freeing objects.
53  * Even there, platform-dependent optimizations for reading/writing data with
54  * the CPU mean we'll likely hook those out to driver-specific calls.  However,
55  * the DRI2 implementation wants to have at least allocate/mmap be generic.
56  *
57  * The goal was to have swap-backed object allocation managed through
58  * struct file.  However, file descriptors as handles to a struct file have
59  * two major failings:
60  * - Process limits prevent more than 1024 or so being used at a time by
61  *   default.
62  * - Inability to allocate high fds will aggravate the X Server's select()
63  *   handling, and likely that of many GL client applications as well.
64  *
65  * This led to a plan of using our own integer IDs (called handles, following
66  * DRM terminology) to mimic fds, and implement the fd syscalls we need as
67  * ioctls.  The objects themselves will still include the struct file so
68  * that we can transition to fds if the required kernel infrastructure shows
69  * up at a later date, and as our interface with shmfs for memory allocation.
70  */
71
72 /**
73  * Initialize the GEM device fields
74  */
75
76 int
77 drm_gem_init(struct drm_device *dev)
78 {
79         spin_lock_init(&dev->object_name_lock);
80         idr_init(&dev->object_name_idr);
81         atomic_set(&dev->object_count, 0);
82         atomic_set(&dev->object_memory, 0);
83         atomic_set(&dev->pin_count, 0);
84         atomic_set(&dev->pin_memory, 0);
85         atomic_set(&dev->gtt_count, 0);
86         atomic_set(&dev->gtt_memory, 0);
87         return 0;
88 }
89
90 /**
91  * Allocate a GEM object of the specified size with shmfs backing store
92  */
93 struct drm_gem_object *
94 drm_gem_object_alloc(struct drm_device *dev, size_t size)
95 {
96         struct drm_gem_object *obj;
97
98         BUG_ON((size & (PAGE_SIZE - 1)) != 0);
99
100         obj = kcalloc(1, sizeof(*obj), GFP_KERNEL);
101
102         obj->dev = dev;
103         obj->filp = shmem_file_setup("drm mm object", size, 0);
104         if (IS_ERR(obj->filp)) {
105                 kfree(obj);
106                 return NULL;
107         }
108
109         kref_init(&obj->refcount);
110         kref_init(&obj->handlecount);
111         obj->size = size;
112         if (dev->driver->gem_init_object != NULL &&
113             dev->driver->gem_init_object(obj) != 0) {
114                 fput(obj->filp);
115                 kfree(obj);
116                 return NULL;
117         }
118         atomic_inc(&dev->object_count);
119         atomic_add(obj->size, &dev->object_memory);
120         return obj;
121 }
122 EXPORT_SYMBOL(drm_gem_object_alloc);
123
124 /**
125  * Removes the mapping from handle to filp for this object.
126  */
127 static int
128 drm_gem_handle_delete(struct drm_file *filp, int handle)
129 {
130         struct drm_device *dev;
131         struct drm_gem_object *obj;
132
133         /* This is gross. The idr system doesn't let us try a delete and
134          * return an error code.  It just spews if you fail at deleting.
135          * So, we have to grab a lock around finding the object and then
136          * doing the delete on it and dropping the refcount, or the user
137          * could race us to double-decrement the refcount and cause a
138          * use-after-free later.  Given the frequency of our handle lookups,
139          * we may want to use ida for number allocation and a hash table
140          * for the pointers, anyway.
141          */
142         spin_lock(&filp->table_lock);
143
144         /* Check if we currently have a reference on the object */
145         obj = idr_find(&filp->object_idr, handle);
146         if (obj == NULL) {
147                 spin_unlock(&filp->table_lock);
148                 return -EINVAL;
149         }
150         dev = obj->dev;
151
152         /* Release reference and decrement refcount. */
153         idr_remove(&filp->object_idr, handle);
154         spin_unlock(&filp->table_lock);
155
156         mutex_lock(&dev->struct_mutex);
157         drm_gem_object_handle_unreference(obj);
158         mutex_unlock(&dev->struct_mutex);
159
160         return 0;
161 }
162
163 /**
164  * Create a handle for this object. This adds a handle reference
165  * to the object, which includes a regular reference count. Callers
166  * will likely want to dereference the object afterwards.
167  */
168 int
169 drm_gem_handle_create(struct drm_file *file_priv,
170                        struct drm_gem_object *obj,
171                        int *handlep)
172 {
173         int     ret;
174
175         /*
176          * Get the user-visible handle using idr.
177          */
178 again:
179         /* ensure there is space available to allocate a handle */
180         if (idr_pre_get(&file_priv->object_idr, GFP_KERNEL) == 0)
181                 return -ENOMEM;
182
183         /* do the allocation under our spinlock */
184         spin_lock(&file_priv->table_lock);
185         ret = idr_get_new_above(&file_priv->object_idr, obj, 1, handlep);
186         spin_unlock(&file_priv->table_lock);
187         if (ret == -EAGAIN)
188                 goto again;
189
190         if (ret != 0)
191                 return ret;
192
193         drm_gem_object_handle_reference(obj);
194         return 0;
195 }
196 EXPORT_SYMBOL(drm_gem_handle_create);
197
198 /** Returns a reference to the object named by the handle. */
199 struct drm_gem_object *
200 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
201                       int handle)
202 {
203         struct drm_gem_object *obj;
204
205         spin_lock(&filp->table_lock);
206
207         /* Check if we currently have a reference on the object */
208         obj = idr_find(&filp->object_idr, handle);
209         if (obj == NULL) {
210                 spin_unlock(&filp->table_lock);
211                 return NULL;
212         }
213
214         drm_gem_object_reference(obj);
215
216         spin_unlock(&filp->table_lock);
217
218         return obj;
219 }
220 EXPORT_SYMBOL(drm_gem_object_lookup);
221
222 /**
223  * Releases the handle to an mm object.
224  */
225 int
226 drm_gem_close_ioctl(struct drm_device *dev, void *data,
227                     struct drm_file *file_priv)
228 {
229         struct drm_gem_close *args = data;
230         int ret;
231
232         if (!(dev->driver->driver_features & DRIVER_GEM))
233                 return -ENODEV;
234
235         ret = drm_gem_handle_delete(file_priv, args->handle);
236
237         return ret;
238 }
239
240 /**
241  * Create a global name for an object, returning the name.
242  *
243  * Note that the name does not hold a reference; when the object
244  * is freed, the name goes away.
245  */
246 int
247 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
248                     struct drm_file *file_priv)
249 {
250         struct drm_gem_flink *args = data;
251         struct drm_gem_object *obj;
252         int ret;
253
254         if (!(dev->driver->driver_features & DRIVER_GEM))
255                 return -ENODEV;
256
257         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
258         if (obj == NULL)
259                 return -EINVAL;
260
261 again:
262         if (idr_pre_get(&dev->object_name_idr, GFP_KERNEL) == 0)
263                 return -ENOMEM;
264
265         spin_lock(&dev->object_name_lock);
266         if (obj->name) {
267                 spin_unlock(&dev->object_name_lock);
268                 return -EEXIST;
269         }
270         ret = idr_get_new_above(&dev->object_name_idr, obj, 1,
271                                  &obj->name);
272         spin_unlock(&dev->object_name_lock);
273         if (ret == -EAGAIN)
274                 goto again;
275
276         if (ret != 0) {
277                 mutex_lock(&dev->struct_mutex);
278                 drm_gem_object_unreference(obj);
279                 mutex_unlock(&dev->struct_mutex);
280                 return ret;
281         }
282
283         /*
284          * Leave the reference from the lookup around as the
285          * name table now holds one
286          */
287         args->name = (uint64_t) obj->name;
288
289         return 0;
290 }
291
292 /**
293  * Open an object using the global name, returning a handle and the size.
294  *
295  * This handle (of course) holds a reference to the object, so the object
296  * will not go away until the handle is deleted.
297  */
298 int
299 drm_gem_open_ioctl(struct drm_device *dev, void *data,
300                    struct drm_file *file_priv)
301 {
302         struct drm_gem_open *args = data;
303         struct drm_gem_object *obj;
304         int ret;
305         int handle;
306
307         if (!(dev->driver->driver_features & DRIVER_GEM))
308                 return -ENODEV;
309
310         spin_lock(&dev->object_name_lock);
311         obj = idr_find(&dev->object_name_idr, (int) args->name);
312         if (obj)
313                 drm_gem_object_reference(obj);
314         spin_unlock(&dev->object_name_lock);
315         if (!obj)
316                 return -ENOENT;
317
318         ret = drm_gem_handle_create(file_priv, obj, &handle);
319         mutex_lock(&dev->struct_mutex);
320         drm_gem_object_unreference(obj);
321         mutex_unlock(&dev->struct_mutex);
322         if (ret)
323                 return ret;
324
325         args->handle = handle;
326         args->size = obj->size;
327
328         return 0;
329 }
330
331 /**
332  * Called at device open time, sets up the structure for handling refcounting
333  * of mm objects.
334  */
335 void
336 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
337 {
338         idr_init(&file_private->object_idr);
339         spin_lock_init(&file_private->table_lock);
340 }
341
342 /**
343  * Called at device close to release the file's
344  * handle references on objects.
345  */
346 static int
347 drm_gem_object_release_handle(int id, void *ptr, void *data)
348 {
349         struct drm_gem_object *obj = ptr;
350
351         drm_gem_object_handle_unreference(obj);
352
353         return 0;
354 }
355
356 /**
357  * Called at close time when the filp is going away.
358  *
359  * Releases any remaining references on objects by this filp.
360  */
361 void
362 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
363 {
364         mutex_lock(&dev->struct_mutex);
365         idr_for_each(&file_private->object_idr,
366                      &drm_gem_object_release_handle, NULL);
367
368         idr_destroy(&file_private->object_idr);
369         mutex_unlock(&dev->struct_mutex);
370 }
371
372 /**
373  * Called after the last reference to the object has been lost.
374  *
375  * Frees the object
376  */
377 void
378 drm_gem_object_free(struct kref *kref)
379 {
380         struct drm_gem_object *obj = (struct drm_gem_object *) kref;
381         struct drm_device *dev = obj->dev;
382
383         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
384
385         if (dev->driver->gem_free_object != NULL)
386                 dev->driver->gem_free_object(obj);
387
388         fput(obj->filp);
389         atomic_dec(&dev->object_count);
390         atomic_sub(obj->size, &dev->object_memory);
391         kfree(obj);
392 }
393 EXPORT_SYMBOL(drm_gem_object_free);
394
395 /**
396  * Called after the last handle to the object has been closed
397  *
398  * Removes any name for the object. Note that this must be
399  * called before drm_gem_object_free or we'll be touching
400  * freed memory
401  */
402 void
403 drm_gem_object_handle_free(struct kref *kref)
404 {
405         struct drm_gem_object *obj = container_of(kref,
406                                                   struct drm_gem_object,
407                                                   handlecount);
408         struct drm_device *dev = obj->dev;
409
410         /* Remove any name for this object */
411         spin_lock(&dev->object_name_lock);
412         if (obj->name) {
413                 idr_remove(&dev->object_name_idr, obj->name);
414                 spin_unlock(&dev->object_name_lock);
415                 /*
416                  * The object name held a reference to this object, drop
417                  * that now.
418                  */
419                 drm_gem_object_unreference(obj);
420         } else
421                 spin_unlock(&dev->object_name_lock);
422
423 }
424 EXPORT_SYMBOL(drm_gem_object_handle_free);
425
426 #else
427
428 int drm_gem_init(struct drm_device *dev)
429 {
430         return 0;
431 }
432
433 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
434 {
435
436 }
437
438 void
439 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
440 {
441
442 }
443
444 #endif