drm_gem.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812
  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. #include <linux/types.h>
  28. #include <linux/slab.h>
  29. #include <linux/mm.h>
  30. #include <linux/uaccess.h>
  31. #include <linux/fs.h>
  32. #include <linux/file.h>
  33. #include <linux/module.h>
  34. #include <linux/mman.h>
  35. #include <linux/pagemap.h>
  36. #include <linux/shmem_fs.h>
  37. #include <linux/dma-buf.h>
  38. #include <drm/drmP.h>
  39. #include <drm/drm_vma_manager.h>
  40. /** @file drm_gem.c
  41. *
  42. * This file provides some of the base ioctls and library routines for
  43. * the graphics memory manager implemented by each device driver.
  44. *
  45. * Because various devices have different requirements in terms of
  46. * synchronization and migration strategies, implementing that is left up to
  47. * the driver, and all that the general API provides should be generic --
  48. * allocating objects, reading/writing data with the cpu, freeing objects.
  49. * Even there, platform-dependent optimizations for reading/writing data with
  50. * the CPU mean we'll likely hook those out to driver-specific calls. However,
  51. * the DRI2 implementation wants to have at least allocate/mmap be generic.
  52. *
  53. * The goal was to have swap-backed object allocation managed through
  54. * struct file. However, file descriptors as handles to a struct file have
  55. * two major failings:
  56. * - Process limits prevent more than 1024 or so being used at a time by
  57. * default.
  58. * - Inability to allocate high fds will aggravate the X Server's select()
  59. * handling, and likely that of many GL client applications as well.
  60. *
  61. * This led to a plan of using our own integer IDs (called handles, following
  62. * DRM terminology) to mimic fds, and implement the fd syscalls we need as
  63. * ioctls. The objects themselves will still include the struct file so
  64. * that we can transition to fds if the required kernel infrastructure shows
  65. * up at a later date, and as our interface with shmfs for memory allocation.
  66. */
  67. /*
  68. * We make up offsets for buffer objects so we can recognize them at
  69. * mmap time.
  70. */
  71. /* pgoff in mmap is an unsigned long, so we need to make sure that
  72. * the faked up offset will fit
  73. */
  74. #if BITS_PER_LONG == 64
  75. #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
  76. #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
  77. #else
  78. #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
  79. #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
  80. #endif
  81. /**
  82. * Initialize the GEM device fields
  83. */
  84. int
  85. drm_gem_init(struct drm_device *dev)
  86. {
  87. struct drm_gem_mm *mm;
  88. spin_lock_init(&dev->object_name_lock);
  89. idr_init(&dev->object_name_idr);
  90. mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
  91. if (!mm) {
  92. DRM_ERROR("out of memory\n");
  93. return -ENOMEM;
  94. }
  95. dev->mm_private = mm;
  96. drm_vma_offset_manager_init(&mm->vma_manager,
  97. DRM_FILE_PAGE_OFFSET_START,
  98. DRM_FILE_PAGE_OFFSET_SIZE);
  99. return 0;
  100. }
  101. void
  102. drm_gem_destroy(struct drm_device *dev)
  103. {
  104. struct drm_gem_mm *mm = dev->mm_private;
  105. drm_vma_offset_manager_destroy(&mm->vma_manager);
  106. kfree(mm);
  107. dev->mm_private = NULL;
  108. }
  109. /**
  110. * Initialize an already allocated GEM object of the specified size with
  111. * shmfs backing store.
  112. */
  113. int drm_gem_object_init(struct drm_device *dev,
  114. struct drm_gem_object *obj, size_t size)
  115. {
  116. struct file *filp;
  117. filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
  118. if (IS_ERR(filp))
  119. return PTR_ERR(filp);
  120. drm_gem_private_object_init(dev, obj, size);
  121. obj->filp = filp;
  122. return 0;
  123. }
  124. EXPORT_SYMBOL(drm_gem_object_init);
  125. /**
  126. * Initialize an already allocated GEM object of the specified size with
  127. * no GEM provided backing store. Instead the caller is responsible for
  128. * backing the object and handling it.
  129. */
  130. void drm_gem_private_object_init(struct drm_device *dev,
  131. struct drm_gem_object *obj, size_t size)
  132. {
  133. BUG_ON((size & (PAGE_SIZE - 1)) != 0);
  134. obj->dev = dev;
  135. obj->filp = NULL;
  136. kref_init(&obj->refcount);
  137. atomic_set(&obj->handle_count, 0);
  138. obj->size = size;
  139. }
  140. EXPORT_SYMBOL(drm_gem_private_object_init);
  141. /**
  142. * Allocate a GEM object of the specified size with shmfs backing store
  143. */
  144. struct drm_gem_object *
  145. drm_gem_object_alloc(struct drm_device *dev, size_t size)
  146. {
  147. struct drm_gem_object *obj;
  148. obj = kzalloc(sizeof(*obj), GFP_KERNEL);
  149. if (!obj)
  150. goto free;
  151. if (drm_gem_object_init(dev, obj, size) != 0)
  152. goto free;
  153. if (dev->driver->gem_init_object != NULL &&
  154. dev->driver->gem_init_object(obj) != 0) {
  155. goto fput;
  156. }
  157. return obj;
  158. fput:
  159. /* Object_init mangles the global counters - readjust them. */
  160. fput(obj->filp);
  161. free:
  162. kfree(obj);
  163. return NULL;
  164. }
  165. EXPORT_SYMBOL(drm_gem_object_alloc);
  166. static void
  167. drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
  168. {
  169. if (obj->import_attach) {
  170. drm_prime_remove_buf_handle(&filp->prime,
  171. obj->import_attach->dmabuf);
  172. }
  173. if (obj->export_dma_buf) {
  174. drm_prime_remove_buf_handle(&filp->prime,
  175. obj->export_dma_buf);
  176. }
  177. }
  178. /**
  179. * Removes the mapping from handle to filp for this object.
  180. */
  181. int
  182. drm_gem_handle_delete(struct drm_file *filp, u32 handle)
  183. {
  184. struct drm_device *dev;
  185. struct drm_gem_object *obj;
  186. /* This is gross. The idr system doesn't let us try a delete and
  187. * return an error code. It just spews if you fail at deleting.
  188. * So, we have to grab a lock around finding the object and then
  189. * doing the delete on it and dropping the refcount, or the user
  190. * could race us to double-decrement the refcount and cause a
  191. * use-after-free later. Given the frequency of our handle lookups,
  192. * we may want to use ida for number allocation and a hash table
  193. * for the pointers, anyway.
  194. */
  195. spin_lock(&filp->table_lock);
  196. /* Check if we currently have a reference on the object */
  197. obj = idr_find(&filp->object_idr, handle);
  198. if (obj == NULL) {
  199. spin_unlock(&filp->table_lock);
  200. return -EINVAL;
  201. }
  202. dev = obj->dev;
  203. /* Release reference and decrement refcount. */
  204. idr_remove(&filp->object_idr, handle);
  205. spin_unlock(&filp->table_lock);
  206. drm_gem_remove_prime_handles(obj, filp);
  207. if (dev->driver->gem_close_object)
  208. dev->driver->gem_close_object(obj, filp);
  209. drm_gem_object_handle_unreference_unlocked(obj);
  210. return 0;
  211. }
  212. EXPORT_SYMBOL(drm_gem_handle_delete);
  213. /**
  214. * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
  215. *
  216. * This implements the ->dumb_destroy kms driver callback for drivers which use
  217. * gem to manage their backing storage.
  218. */
  219. int drm_gem_dumb_destroy(struct drm_file *file,
  220. struct drm_device *dev,
  221. uint32_t handle)
  222. {
  223. return drm_gem_handle_delete(file, handle);
  224. }
  225. EXPORT_SYMBOL(drm_gem_dumb_destroy);
  226. /**
  227. * Create a handle for this object. This adds a handle reference
  228. * to the object, which includes a regular reference count. Callers
  229. * will likely want to dereference the object afterwards.
  230. */
  231. int
  232. drm_gem_handle_create(struct drm_file *file_priv,
  233. struct drm_gem_object *obj,
  234. u32 *handlep)
  235. {
  236. struct drm_device *dev = obj->dev;
  237. int ret;
  238. /*
  239. * Get the user-visible handle using idr. Preload and perform
  240. * allocation under our spinlock.
  241. */
  242. idr_preload(GFP_KERNEL);
  243. spin_lock(&file_priv->table_lock);
  244. ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
  245. spin_unlock(&file_priv->table_lock);
  246. idr_preload_end();
  247. if (ret < 0)
  248. return ret;
  249. *handlep = ret;
  250. drm_gem_object_handle_reference(obj);
  251. if (dev->driver->gem_open_object) {
  252. ret = dev->driver->gem_open_object(obj, file_priv);
  253. if (ret) {
  254. drm_gem_handle_delete(file_priv, *handlep);
  255. return ret;
  256. }
  257. }
  258. return 0;
  259. }
  260. EXPORT_SYMBOL(drm_gem_handle_create);
  261. /**
  262. * drm_gem_free_mmap_offset - release a fake mmap offset for an object
  263. * @obj: obj in question
  264. *
  265. * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
  266. */
  267. void
  268. drm_gem_free_mmap_offset(struct drm_gem_object *obj)
  269. {
  270. struct drm_device *dev = obj->dev;
  271. struct drm_gem_mm *mm = dev->mm_private;
  272. drm_vma_offset_remove(&mm->vma_manager, &obj->vma_node);
  273. }
  274. EXPORT_SYMBOL(drm_gem_free_mmap_offset);
  275. /**
  276. * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
  277. * @obj: obj in question
  278. * @size: the virtual size
  279. *
  280. * GEM memory mapping works by handing back to userspace a fake mmap offset
  281. * it can use in a subsequent mmap(2) call. The DRM core code then looks
  282. * up the object based on the offset and sets up the various memory mapping
  283. * structures.
  284. *
  285. * This routine allocates and attaches a fake offset for @obj, in cases where
  286. * the virtual size differs from the physical size (ie. obj->size). Otherwise
  287. * just use drm_gem_create_mmap_offset().
  288. */
  289. int
  290. drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
  291. {
  292. struct drm_device *dev = obj->dev;
  293. struct drm_gem_mm *mm = dev->mm_private;
  294. return drm_vma_offset_add(&mm->vma_manager, &obj->vma_node,
  295. size / PAGE_SIZE);
  296. }
  297. EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
  298. /**
  299. * drm_gem_create_mmap_offset - create a fake mmap offset for an object
  300. * @obj: obj in question
  301. *
  302. * GEM memory mapping works by handing back to userspace a fake mmap offset
  303. * it can use in a subsequent mmap(2) call. The DRM core code then looks
  304. * up the object based on the offset and sets up the various memory mapping
  305. * structures.
  306. *
  307. * This routine allocates and attaches a fake offset for @obj.
  308. */
  309. int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
  310. {
  311. return drm_gem_create_mmap_offset_size(obj, obj->size);
  312. }
  313. EXPORT_SYMBOL(drm_gem_create_mmap_offset);
  314. /**
  315. * drm_gem_get_pages - helper to allocate backing pages for a GEM object
  316. * from shmem
  317. * @obj: obj in question
  318. * @gfpmask: gfp mask of requested pages
  319. */
  320. struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask)
  321. {
  322. struct inode *inode;
  323. struct address_space *mapping;
  324. struct page *p, **pages;
  325. int i, npages;
  326. /* This is the shared memory object that backs the GEM resource */
  327. inode = file_inode(obj->filp);
  328. mapping = inode->i_mapping;
  329. /* We already BUG_ON() for non-page-aligned sizes in
  330. * drm_gem_object_init(), so we should never hit this unless
  331. * driver author is doing something really wrong:
  332. */
  333. WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
  334. npages = obj->size >> PAGE_SHIFT;
  335. pages = drm_malloc_ab(npages, sizeof(struct page *));
  336. if (pages == NULL)
  337. return ERR_PTR(-ENOMEM);
  338. gfpmask |= mapping_gfp_mask(mapping);
  339. for (i = 0; i < npages; i++) {
  340. p = shmem_read_mapping_page_gfp(mapping, i, gfpmask);
  341. if (IS_ERR(p))
  342. goto fail;
  343. pages[i] = p;
  344. /* There is a hypothetical issue w/ drivers that require
  345. * buffer memory in the low 4GB.. if the pages are un-
  346. * pinned, and swapped out, they can end up swapped back
  347. * in above 4GB. If pages are already in memory, then
  348. * shmem_read_mapping_page_gfp will ignore the gfpmask,
  349. * even if the already in-memory page disobeys the mask.
  350. *
  351. * It is only a theoretical issue today, because none of
  352. * the devices with this limitation can be populated with
  353. * enough memory to trigger the issue. But this BUG_ON()
  354. * is here as a reminder in case the problem with
  355. * shmem_read_mapping_page_gfp() isn't solved by the time
  356. * it does become a real issue.
  357. *
  358. * See this thread: http://lkml.org/lkml/2011/7/11/238
  359. */
  360. BUG_ON((gfpmask & __GFP_DMA32) &&
  361. (page_to_pfn(p) >= 0x00100000UL));
  362. }
  363. return pages;
  364. fail:
  365. while (i--)
  366. page_cache_release(pages[i]);
  367. drm_free_large(pages);
  368. return ERR_CAST(p);
  369. }
  370. EXPORT_SYMBOL(drm_gem_get_pages);
  371. /**
  372. * drm_gem_put_pages - helper to free backing pages for a GEM object
  373. * @obj: obj in question
  374. * @pages: pages to free
  375. * @dirty: if true, pages will be marked as dirty
  376. * @accessed: if true, the pages will be marked as accessed
  377. */
  378. void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
  379. bool dirty, bool accessed)
  380. {
  381. int i, npages;
  382. /* We already BUG_ON() for non-page-aligned sizes in
  383. * drm_gem_object_init(), so we should never hit this unless
  384. * driver author is doing something really wrong:
  385. */
  386. WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
  387. npages = obj->size >> PAGE_SHIFT;
  388. for (i = 0; i < npages; i++) {
  389. if (dirty)
  390. set_page_dirty(pages[i]);
  391. if (accessed)
  392. mark_page_accessed(pages[i]);
  393. /* Undo the reference we took when populating the table */
  394. page_cache_release(pages[i]);
  395. }
  396. drm_free_large(pages);
  397. }
  398. EXPORT_SYMBOL(drm_gem_put_pages);
  399. /** Returns a reference to the object named by the handle. */
  400. struct drm_gem_object *
  401. drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
  402. u32 handle)
  403. {
  404. struct drm_gem_object *obj;
  405. spin_lock(&filp->table_lock);
  406. /* Check if we currently have a reference on the object */
  407. obj = idr_find(&filp->object_idr, handle);
  408. if (obj == NULL) {
  409. spin_unlock(&filp->table_lock);
  410. return NULL;
  411. }
  412. drm_gem_object_reference(obj);
  413. spin_unlock(&filp->table_lock);
  414. return obj;
  415. }
  416. EXPORT_SYMBOL(drm_gem_object_lookup);
  417. /**
  418. * Releases the handle to an mm object.
  419. */
  420. int
  421. drm_gem_close_ioctl(struct drm_device *dev, void *data,
  422. struct drm_file *file_priv)
  423. {
  424. struct drm_gem_close *args = data;
  425. int ret;
  426. if (!(dev->driver->driver_features & DRIVER_GEM))
  427. return -ENODEV;
  428. ret = drm_gem_handle_delete(file_priv, args->handle);
  429. return ret;
  430. }
  431. /**
  432. * Create a global name for an object, returning the name.
  433. *
  434. * Note that the name does not hold a reference; when the object
  435. * is freed, the name goes away.
  436. */
  437. int
  438. drm_gem_flink_ioctl(struct drm_device *dev, void *data,
  439. struct drm_file *file_priv)
  440. {
  441. struct drm_gem_flink *args = data;
  442. struct drm_gem_object *obj;
  443. int ret;
  444. if (!(dev->driver->driver_features & DRIVER_GEM))
  445. return -ENODEV;
  446. obj = drm_gem_object_lookup(dev, file_priv, args->handle);
  447. if (obj == NULL)
  448. return -ENOENT;
  449. idr_preload(GFP_KERNEL);
  450. spin_lock(&dev->object_name_lock);
  451. if (!obj->name) {
  452. ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
  453. if (ret < 0)
  454. goto err;
  455. obj->name = ret;
  456. /* Allocate a reference for the name table. */
  457. drm_gem_object_reference(obj);
  458. }
  459. args->name = (uint64_t) obj->name;
  460. ret = 0;
  461. err:
  462. spin_unlock(&dev->object_name_lock);
  463. idr_preload_end();
  464. drm_gem_object_unreference_unlocked(obj);
  465. return ret;
  466. }
  467. /**
  468. * Open an object using the global name, returning a handle and the size.
  469. *
  470. * This handle (of course) holds a reference to the object, so the object
  471. * will not go away until the handle is deleted.
  472. */
  473. int
  474. drm_gem_open_ioctl(struct drm_device *dev, void *data,
  475. struct drm_file *file_priv)
  476. {
  477. struct drm_gem_open *args = data;
  478. struct drm_gem_object *obj;
  479. int ret;
  480. u32 handle;
  481. if (!(dev->driver->driver_features & DRIVER_GEM))
  482. return -ENODEV;
  483. spin_lock(&dev->object_name_lock);
  484. obj = idr_find(&dev->object_name_idr, (int) args->name);
  485. if (obj)
  486. drm_gem_object_reference(obj);
  487. spin_unlock(&dev->object_name_lock);
  488. if (!obj)
  489. return -ENOENT;
  490. ret = drm_gem_handle_create(file_priv, obj, &handle);
  491. drm_gem_object_unreference_unlocked(obj);
  492. if (ret)
  493. return ret;
  494. args->handle = handle;
  495. args->size = obj->size;
  496. return 0;
  497. }
  498. /**
  499. * Called at device open time, sets up the structure for handling refcounting
  500. * of mm objects.
  501. */
  502. void
  503. drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
  504. {
  505. idr_init(&file_private->object_idr);
  506. spin_lock_init(&file_private->table_lock);
  507. }
  508. /**
  509. * Called at device close to release the file's
  510. * handle references on objects.
  511. */
  512. static int
  513. drm_gem_object_release_handle(int id, void *ptr, void *data)
  514. {
  515. struct drm_file *file_priv = data;
  516. struct drm_gem_object *obj = ptr;
  517. struct drm_device *dev = obj->dev;
  518. drm_gem_remove_prime_handles(obj, file_priv);
  519. if (dev->driver->gem_close_object)
  520. dev->driver->gem_close_object(obj, file_priv);
  521. drm_gem_object_handle_unreference_unlocked(obj);
  522. return 0;
  523. }
  524. /**
  525. * Called at close time when the filp is going away.
  526. *
  527. * Releases any remaining references on objects by this filp.
  528. */
  529. void
  530. drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
  531. {
  532. idr_for_each(&file_private->object_idr,
  533. &drm_gem_object_release_handle, file_private);
  534. idr_destroy(&file_private->object_idr);
  535. }
  536. void
  537. drm_gem_object_release(struct drm_gem_object *obj)
  538. {
  539. if (obj->filp)
  540. fput(obj->filp);
  541. }
  542. EXPORT_SYMBOL(drm_gem_object_release);
  543. /**
  544. * Called after the last reference to the object has been lost.
  545. * Must be called holding struct_ mutex
  546. *
  547. * Frees the object
  548. */
  549. void
  550. drm_gem_object_free(struct kref *kref)
  551. {
  552. struct drm_gem_object *obj = (struct drm_gem_object *) kref;
  553. struct drm_device *dev = obj->dev;
  554. BUG_ON(!mutex_is_locked(&dev->struct_mutex));
  555. if (dev->driver->gem_free_object != NULL)
  556. dev->driver->gem_free_object(obj);
  557. }
  558. EXPORT_SYMBOL(drm_gem_object_free);
  559. static void drm_gem_object_ref_bug(struct kref *list_kref)
  560. {
  561. BUG();
  562. }
  563. /**
  564. * Called after the last handle to the object has been closed
  565. *
  566. * Removes any name for the object. Note that this must be
  567. * called before drm_gem_object_free or we'll be touching
  568. * freed memory
  569. */
  570. void drm_gem_object_handle_free(struct drm_gem_object *obj)
  571. {
  572. struct drm_device *dev = obj->dev;
  573. /* Remove any name for this object */
  574. spin_lock(&dev->object_name_lock);
  575. if (obj->name) {
  576. idr_remove(&dev->object_name_idr, obj->name);
  577. obj->name = 0;
  578. spin_unlock(&dev->object_name_lock);
  579. /*
  580. * The object name held a reference to this object, drop
  581. * that now.
  582. *
  583. * This cannot be the last reference, since the handle holds one too.
  584. */
  585. kref_put(&obj->refcount, drm_gem_object_ref_bug);
  586. } else
  587. spin_unlock(&dev->object_name_lock);
  588. }
  589. EXPORT_SYMBOL(drm_gem_object_handle_free);
  590. void drm_gem_vm_open(struct vm_area_struct *vma)
  591. {
  592. struct drm_gem_object *obj = vma->vm_private_data;
  593. drm_gem_object_reference(obj);
  594. mutex_lock(&obj->dev->struct_mutex);
  595. drm_vm_open_locked(obj->dev, vma);
  596. mutex_unlock(&obj->dev->struct_mutex);
  597. }
  598. EXPORT_SYMBOL(drm_gem_vm_open);
  599. void drm_gem_vm_close(struct vm_area_struct *vma)
  600. {
  601. struct drm_gem_object *obj = vma->vm_private_data;
  602. struct drm_device *dev = obj->dev;
  603. mutex_lock(&dev->struct_mutex);
  604. drm_vm_close_locked(obj->dev, vma);
  605. drm_gem_object_unreference(obj);
  606. mutex_unlock(&dev->struct_mutex);
  607. }
  608. EXPORT_SYMBOL(drm_gem_vm_close);
  609. /**
  610. * drm_gem_mmap_obj - memory map a GEM object
  611. * @obj: the GEM object to map
  612. * @obj_size: the object size to be mapped, in bytes
  613. * @vma: VMA for the area to be mapped
  614. *
  615. * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
  616. * provided by the driver. Depending on their requirements, drivers can either
  617. * provide a fault handler in their gem_vm_ops (in which case any accesses to
  618. * the object will be trapped, to perform migration, GTT binding, surface
  619. * register allocation, or performance monitoring), or mmap the buffer memory
  620. * synchronously after calling drm_gem_mmap_obj.
  621. *
  622. * This function is mainly intended to implement the DMABUF mmap operation, when
  623. * the GEM object is not looked up based on its fake offset. To implement the
  624. * DRM mmap operation, drivers should use the drm_gem_mmap() function.
  625. *
  626. * NOTE: This function has to be protected with dev->struct_mutex
  627. *
  628. * Return 0 or success or -EINVAL if the object size is smaller than the VMA
  629. * size, or if no gem_vm_ops are provided.
  630. */
  631. int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
  632. struct vm_area_struct *vma)
  633. {
  634. struct drm_device *dev = obj->dev;
  635. lockdep_assert_held(&dev->struct_mutex);
  636. /* Check for valid size. */
  637. if (obj_size < vma->vm_end - vma->vm_start)
  638. return -EINVAL;
  639. if (!dev->driver->gem_vm_ops)
  640. return -EINVAL;
  641. vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
  642. vma->vm_ops = dev->driver->gem_vm_ops;
  643. vma->vm_private_data = obj;
  644. vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
  645. /* Take a ref for this mapping of the object, so that the fault
  646. * handler can dereference the mmap offset's pointer to the object.
  647. * This reference is cleaned up by the corresponding vm_close
  648. * (which should happen whether the vma was created by this call, or
  649. * by a vm_open due to mremap or partial unmap or whatever).
  650. */
  651. drm_gem_object_reference(obj);
  652. drm_vm_open_locked(dev, vma);
  653. return 0;
  654. }
  655. EXPORT_SYMBOL(drm_gem_mmap_obj);
  656. /**
  657. * drm_gem_mmap - memory map routine for GEM objects
  658. * @filp: DRM file pointer
  659. * @vma: VMA for the area to be mapped
  660. *
  661. * If a driver supports GEM object mapping, mmap calls on the DRM file
  662. * descriptor will end up here.
  663. *
  664. * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
  665. * contain the fake offset we created when the GTT map ioctl was called on
  666. * the object) and map it with a call to drm_gem_mmap_obj().
  667. */
  668. int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
  669. {
  670. struct drm_file *priv = filp->private_data;
  671. struct drm_device *dev = priv->minor->dev;
  672. struct drm_gem_mm *mm = dev->mm_private;
  673. struct drm_gem_object *obj;
  674. struct drm_vma_offset_node *node;
  675. int ret = 0;
  676. if (drm_device_is_unplugged(dev))
  677. return -ENODEV;
  678. mutex_lock(&dev->struct_mutex);
  679. node = drm_vma_offset_exact_lookup(&mm->vma_manager, vma->vm_pgoff,
  680. vma_pages(vma));
  681. if (!node) {
  682. mutex_unlock(&dev->struct_mutex);
  683. return drm_mmap(filp, vma);
  684. }
  685. obj = container_of(node, struct drm_gem_object, vma_node);
  686. ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, vma);
  687. mutex_unlock(&dev->struct_mutex);
  688. return ret;
  689. }
  690. EXPORT_SYMBOL(drm_gem_mmap);