drivers/gpu/drm/drm_prime.c

   1 /*
   2  * Copyright © 2012 Red Hat
   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  *      Dave Airlie <[email protected]>
  25  *      Rob Clark <[email protected]>
  26  *
  27  */
  28
  29 #include <linux/export.h>
  30 #include <linux/dma-buf.h>
  31 #include <linux/rbtree.h>
  32 #include <drm/drm_prime.h>
  33 #include <drm/drm_gem.h>
  34 #include <drm/drmP.h>
  35
  36 #include "drm_internal.h"
  37
  38 /*
  39  * DMA-BUF/GEM Object references and lifetime overview:
  40  *
  41  * On the export the dma_buf holds a reference to the exporting GEM
  42  * object. It takes this reference in handle_to_fd_ioctl, when it
  43  * first calls .prime_export and stores the exporting GEM object in
  44  * the dma_buf priv. This reference needs to be released when the
  45  * final reference to the &dma_buf itself is dropped and its
  46  * &dma_buf_ops.release function is called. For GEM-based drivers,
  47  * the dma_buf should be exported using drm_gem_dmabuf_export() and
  48  * then released by drm_gem_dmabuf_release().
  49  *
  50  * On the import the importing GEM object holds a reference to the
  51  * dma_buf (which in turn holds a ref to the exporting GEM object).
  52  * It takes that reference in the fd_to_handle ioctl.
  53  * It calls dma_buf_get, creates an attachment to it and stores the
  54  * attachment in the GEM object. When this attachment is destroyed
  55  * when the imported object is destroyed, we remove the attachment
  56  * and drop the reference to the dma_buf.
  57  *
  58  * When all the references to the &dma_buf are dropped, i.e. when
  59  * userspace has closed both handles to the imported GEM object (through the
  60  * FD_TO_HANDLE IOCTL) and closed the file descriptor of the exported
  61  * (through the HANDLE_TO_FD IOCTL) dma_buf, and all kernel-internal references
  62  * are also gone, then the dma_buf gets destroyed.  This can also happen as a
  63  * part of the clean up procedure in the drm_release() function if userspace
  64  * fails to properly clean up.  Note that both the kernel and userspace (by
  65  * keeeping the PRIME file descriptors open) can hold references onto a
  66  * &dma_buf.
  67  *
  68  * Thus the chain of references always flows in one direction
  69  * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
  70  *
  71  * Self-importing: if userspace is using PRIME as a replacement for flink
  72  * then it will get a fd->handle request for a GEM object that it created.
  73  * Drivers should detect this situation and return back the gem object
  74  * from the dma-buf private.  Prime will do this automatically for drivers that
  75  * use the drm_gem_prime_{import,export} helpers.
  76  *
  77  * GEM struct &dma_buf_ops symbols are now exported. They can be resued by
  78  * drivers which implement GEM interface.
  79  */
  80
  81 struct drm_prime_member {
  82         struct dma_buf *dma_buf;
  83         uint32_t handle;
  84
  85         struct rb_node dmabuf_rb;
  86         struct rb_node handle_rb;
  87 };
  88
  89 struct drm_prime_attachment {
  90         struct sg_table *sgt;
  91         enum dma_data_direction dir;
  92 };
  93
  94 static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
  95                                     struct dma_buf *dma_buf, uint32_t handle)
  96 {
  97         struct drm_prime_member *member;
  98         struct rb_node **p, *rb;
  99
 100         member = kmalloc(sizeof(*member), GFP_KERNEL);
 101         if (!member)
 102                 return -ENOMEM;
 103
 104         get_dma_buf(dma_buf);
 105         member->dma_buf = dma_buf;
 106         member->handle = handle;
 107
 108         rb = NULL;
 109         p = &prime_fpriv->dmabufs.rb_node;
 110         while (*p) {
 111                 struct drm_prime_member *pos;
 112
 113                 rb = *p;
 114                 pos = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
 115                 if (dma_buf > pos->dma_buf)
 116                         p = &rb->rb_right;
 117                 else
 118                         p = &rb->rb_left;
 119         }
 120         rb_link_node(&member->dmabuf_rb, rb, p);
 121         rb_insert_color(&member->dmabuf_rb, &prime_fpriv->dmabufs);
 122
 123         rb = NULL;
 124         p = &prime_fpriv->handles.rb_node;
 125         while (*p) {
 126                 struct drm_prime_member *pos;
 127
 128                 rb = *p;
 129                 pos = rb_entry(rb, struct drm_prime_member, handle_rb);
 130                 if (handle > pos->handle)
 131                         p = &rb->rb_right;
 132                 else
 133                         p = &rb->rb_left;
 134         }
 135         rb_link_node(&member->handle_rb, rb, p);
 136         rb_insert_color(&member->handle_rb, &prime_fpriv->handles);
 137
 138         return 0;
 139 }
 140
 141 static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv,
 142                                                       uint32_t handle)
 143 {
 144         struct rb_node *rb;
 145
 146         rb = prime_fpriv->handles.rb_node;
 147         while (rb) {
 148                 struct drm_prime_member *member;
 149
 150                 member = rb_entry(rb, struct drm_prime_member, handle_rb);
 151                 if (member->handle == handle)
 152                         return member->dma_buf;
 153                 else if (member->handle < handle)
 154                         rb = rb->rb_right;
 155                 else
 156                         rb = rb->rb_left;
 157         }
 158
 159         return NULL;
 160 }
 161
 162 static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv,
 163                                        struct dma_buf *dma_buf,
 164                                        uint32_t *handle)
 165 {
 166         struct rb_node *rb;
 167
 168         rb = prime_fpriv->dmabufs.rb_node;
 169         while (rb) {
 170                 struct drm_prime_member *member;
 171
 172                 member = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
 173                 if (member->dma_buf == dma_buf) {
 174                         *handle = member->handle;
 175                         return 0;
 176                 } else if (member->dma_buf < dma_buf) {
 177                         rb = rb->rb_right;
 178                 } else {
 179                         rb = rb->rb_left;
 180                 }
 181         }
 182
 183         return -ENOENT;
 184 }
 185
 186 /**
 187  * drm_gem_map_attach - dma_buf attach implementation for GEM
 188  * @dma_buf: buffer to attach device to
 189  * @attach: buffer attachment data
 190  *
 191  * Allocates &drm_prime_attachment and calls &drm_driver.gem_prime_pin for
 192  * device specific attachment. This can be used as the &dma_buf_ops.attach
 193  * callback.
 194  *
 195  * Returns 0 on success, negative error code on failure.
 196  */
 197 int drm_gem_map_attach(struct dma_buf *dma_buf,
 198                        struct dma_buf_attachment *attach)
 199 {
 200         struct drm_prime_attachment *prime_attach;
 201         struct drm_gem_object *obj = dma_buf->priv;
 202         struct drm_device *dev = obj->dev;
 203
 204         prime_attach = kzalloc(sizeof(*prime_attach), GFP_KERNEL);
 205         if (!prime_attach)
 206                 return -ENOMEM;
 207
 208         prime_attach->dir = DMA_NONE;
 209         attach->priv = prime_attach;
 210
 211         if (!dev->driver->gem_prime_pin)
 212                 return 0;
 213
 214         return dev->driver->gem_prime_pin(obj);
 215 }
 216 EXPORT_SYMBOL(drm_gem_map_attach);
 217
 218 /**
 219  * drm_gem_map_detach - dma_buf detach implementation for GEM
 220  * @dma_buf: buffer to detach from
 221  * @attach: attachment to be detached
 222  *
 223  * Cleans up &dma_buf_attachment. This can be used as the &dma_buf_ops.detach
 224  * callback.
 225  */
 226 void drm_gem_map_detach(struct dma_buf *dma_buf,
 227                         struct dma_buf_attachment *attach)
 228 {
 229         struct drm_prime_attachment *prime_attach = attach->priv;
 230         struct drm_gem_object *obj = dma_buf->priv;
 231         struct drm_device *dev = obj->dev;
 232
 233         if (prime_attach) {
 234                 struct sg_table *sgt = prime_attach->sgt;
 235
 236                 if (sgt) {
 237                         if (prime_attach->dir != DMA_NONE)
 238                                 dma_unmap_sg_attrs(attach->dev, sgt->sgl,
 239                                                    sgt->nents,
 240                                                    prime_attach->dir,
 241                                                    DMA_ATTR_SKIP_CPU_SYNC);
 242                         sg_free_table(sgt);
 243                 }
 244
 245                 kfree(sgt);
 246                 kfree(prime_attach);
 247                 attach->priv = NULL;
 248         }
 249
 250         if (dev->driver->gem_prime_unpin)
 251                 dev->driver->gem_prime_unpin(obj);
 252 }
 253 EXPORT_SYMBOL(drm_gem_map_detach);
 254
 255 void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
 256                                         struct dma_buf *dma_buf)
 257 {
 258         struct rb_node *rb;
 259
 260         rb = prime_fpriv->dmabufs.rb_node;
 261         while (rb) {
 262                 struct drm_prime_member *member;
 263
 264                 member = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
 265                 if (member->dma_buf == dma_buf) {
 266                         rb_erase(&member->handle_rb, &prime_fpriv->handles);
 267                         rb_erase(&member->dmabuf_rb, &prime_fpriv->dmabufs);
 268
 269                         dma_buf_put(dma_buf);
 270                         kfree(member);
 271                         return;
 272                 } else if (member->dma_buf < dma_buf) {
 273                         rb = rb->rb_right;
 274                 } else {
 275                         rb = rb->rb_left;
 276                 }
 277         }
 278 }
 279
 280 /**
 281  * drm_gem_map_dma_buf - map_dma_buf implementation for GEM
 282  * @attach: attachment whose scatterlist is to be returned
 283  * @dir: direction of DMA transfer
 284  *
 285  * Calls &drm_driver.gem_prime_get_sg_table and then maps the scatterlist. This
 286  * can be used as the &dma_buf_ops.map_dma_buf callback.
 287  *
 288  * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR
 289  * on error. May return -EINTR if it is interrupted by a signal.
 290  */
 291
 292 struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
 293                                      enum dma_data_direction dir)
 294 {
 295         struct drm_prime_attachment *prime_attach = attach->priv;
 296         struct drm_gem_object *obj = attach->dmabuf->priv;
 297         struct sg_table *sgt;
 298
 299         if (WARN_ON(dir == DMA_NONE || !prime_attach))
 300                 return ERR_PTR(-EINVAL);
 301
 302         /* return the cached mapping when possible */
 303         if (prime_attach->dir == dir)
 304                 return prime_attach->sgt;
 305
 306         /*
 307          * two mappings with different directions for the same attachment are
 308          * not allowed
 309          */
 310         if (WARN_ON(prime_attach->dir != DMA_NONE))
 311                 return ERR_PTR(-EBUSY);
 312
 313         sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
 314
 315         if (!IS_ERR(sgt)) {
 316                 if (!dma_map_sg_attrs(attach->dev, sgt->sgl, sgt->nents, dir,
 317                                       DMA_ATTR_SKIP_CPU_SYNC)) {
 318                         sg_free_table(sgt);
 319                         kfree(sgt);
 320                         sgt = ERR_PTR(-ENOMEM);
 321                 } else {
 322                         prime_attach->sgt = sgt;
 323                         prime_attach->dir = dir;
 324                 }
 325         }
 326
 327         return sgt;
 328 }
 329 EXPORT_SYMBOL(drm_gem_map_dma_buf);
 330
 331 /**
 332  * drm_gem_unmap_dma_buf - unmap_dma_buf implementation for GEM
 333  * @attach: attachment to unmap buffer from
 334  * @sgt: scatterlist info of the buffer to unmap
 335  * @dir: direction of DMA transfer
 336  *
 337  * Not implemented. The unmap is done at drm_gem_map_detach().  This can be
 338  * used as the &dma_buf_ops.unmap_dma_buf callback.
 339  */
 340 void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
 341                            struct sg_table *sgt,
 342                            enum dma_data_direction dir)
 343 {
 344         /* nothing to be done here */
 345 }
 346 EXPORT_SYMBOL(drm_gem_unmap_dma_buf);
 347
 348 /**
 349  * drm_gem_dmabuf_export - dma_buf export implementation for GEM
 350  * @dev: parent device for the exported dmabuf
 351  * @exp_info: the export information used by dma_buf_export()
 352  *
 353  * This wraps dma_buf_export() for use by generic GEM drivers that are using
 354  * drm_gem_dmabuf_release(). In addition to calling dma_buf_export(), we take
 355  * a reference to the &drm_device and the exported &drm_gem_object (stored in
 356  * &dma_buf_export_info.priv) which is released by drm_gem_dmabuf_release().
 357  *
 358  * Returns the new dmabuf.
 359  */
 360 struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
 361                                       struct dma_buf_export_info *exp_info)
 362 {
 363         struct dma_buf *dma_buf;
 364
 365         dma_buf = dma_buf_export(exp_info);
 366         if (IS_ERR(dma_buf))
 367                 return dma_buf;
 368
 369         drm_dev_get(dev);
 370         drm_gem_object_get(exp_info->priv);
 371
 372         return dma_buf;
 373 }
 374 EXPORT_SYMBOL(drm_gem_dmabuf_export);
 375
 376 /**
 377  * drm_gem_dmabuf_release - dma_buf release implementation for GEM
 378  * @dma_buf: buffer to be released
 379  *
 380  * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers
 381  * must use this in their dma_buf ops structure as the release callback.
 382  * drm_gem_dmabuf_release() should be used in conjunction with
 383  * drm_gem_dmabuf_export().
 384  */
 385 void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
 386 {
 387         struct drm_gem_object *obj = dma_buf->priv;
 388         struct drm_device *dev = obj->dev;
 389
 390         /* drop the reference on the export fd holds */
 391         drm_gem_object_put_unlocked(obj);
 392
 393         drm_dev_put(dev);
 394 }
 395 EXPORT_SYMBOL(drm_gem_dmabuf_release);
 396
 397 /**
 398  * drm_gem_dmabuf_vmap - dma_buf vmap implementation for GEM
 399  * @dma_buf: buffer to be mapped
 400  *
 401  * Sets up a kernel virtual mapping. This can be used as the &dma_buf_ops.vmap
 402  * callback.
 403  *
 404  * Returns the kernel virtual address.
 405  */
 406 void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
 407 {
 408         struct drm_gem_object *obj = dma_buf->priv;
 409         struct drm_device *dev = obj->dev;
 410
 411         if (dev->driver->gem_prime_vmap)
 412                 return dev->driver->gem_prime_vmap(obj);
 413         else
 414                 return NULL;
 415 }
 416 EXPORT_SYMBOL(drm_gem_dmabuf_vmap);
 417
 418 /**
 419  * drm_gem_dmabuf_vunmap - dma_buf vunmap implementation for GEM
 420  * @dma_buf: buffer to be unmapped
 421  * @vaddr: the virtual address of the buffer
 422  *
 423  * Releases a kernel virtual mapping. This can be used as the
 424  * &dma_buf_ops.vunmap callback.
 425  */
 426 void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
 427 {
 428         struct drm_gem_object *obj = dma_buf->priv;
 429         struct drm_device *dev = obj->dev;
 430
 431         if (dev->driver->gem_prime_vunmap)
 432                 dev->driver->gem_prime_vunmap(obj, vaddr);
 433 }
 434 EXPORT_SYMBOL(drm_gem_dmabuf_vunmap);
 435
 436 /**
 437  * drm_gem_dmabuf_kmap_atomic - map_atomic implementation for GEM
 438  * @dma_buf: buffer to be mapped
 439  * @page_num: page number within the buffer
 440  *
 441  * Not implemented. This can be used as the &dma_buf_ops.map_atomic callback.
 442  */
 443 void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
 444                                  unsigned long page_num)
 445 {
 446         return NULL;
 447 }
 448 EXPORT_SYMBOL(drm_gem_dmabuf_kmap_atomic);
 449
 450 /**
 451  * drm_gem_dmabuf_kunmap_atomic - unmap_atomic implementation for GEM
 452  * @dma_buf: buffer to be unmapped
 453  * @page_num: page number within the buffer
 454  * @addr: virtual address of the buffer
 455  *
 456  * Not implemented. This can be used as the &dma_buf_ops.unmap_atomic callback.
 457  */
 458 void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
 459                                   unsigned long page_num, void *addr)
 460 {
 461
 462 }
 463 EXPORT_SYMBOL(drm_gem_dmabuf_kunmap_atomic);
 464
 465 /**
 466  * drm_gem_dmabuf_kmap - map implementation for GEM
 467  * @dma_buf: buffer to be mapped
 468  * @page_num: page number within the buffer
 469  *
 470  * Not implemented. This can be used as the &dma_buf_ops.map callback.
 471  */
 472 void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf, unsigned long page_num)
 473 {
 474         return NULL;
 475 }
 476 EXPORT_SYMBOL(drm_gem_dmabuf_kmap);
 477
 478 /**
 479  * drm_gem_dmabuf_kunmap - unmap implementation for GEM
 480  * @dma_buf: buffer to be unmapped
 481  * @page_num: page number within the buffer
 482  * @addr: virtual address of the buffer
 483  *
 484  * Not implemented. This can be used as the &dma_buf_ops.unmap callback.
 485  */
 486 void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf, unsigned long page_num,
 487                            void *addr)
 488 {
 489
 490 }
 491 EXPORT_SYMBOL(drm_gem_dmabuf_kunmap);
 492
 493 /**
 494  * drm_gem_dmabuf_mmap - dma_buf mmap implementation for GEM
 495  * @dma_buf: buffer to be mapped
 496  * @vma: virtual address range
 497  *
 498  * Provides memory mapping for the buffer. This can be used as the
 499  * &dma_buf_ops.mmap callback.
 500  *
 501  * Returns 0 on success or a negative error code on failure.
 502  */
 503 int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf, struct vm_area_struct *vma)
 504 {
 505         struct drm_gem_object *obj = dma_buf->priv;
 506         struct drm_device *dev = obj->dev;
 507
 508         if (!dev->driver->gem_prime_mmap)
 509                 return -ENOSYS;
 510
 511         return dev->driver->gem_prime_mmap(obj, vma);
 512 }
 513 EXPORT_SYMBOL(drm_gem_dmabuf_mmap);
 514
 515 static const struct dma_buf_ops drm_gem_prime_dmabuf_ops =  {
 516         .attach = drm_gem_map_attach,
 517         .detach = drm_gem_map_detach,
 518         .map_dma_buf = drm_gem_map_dma_buf,
 519         .unmap_dma_buf = drm_gem_unmap_dma_buf,
 520         .release = drm_gem_dmabuf_release,
 521         .map = drm_gem_dmabuf_kmap,
 522         .map_atomic = drm_gem_dmabuf_kmap_atomic,
 523         .unmap = drm_gem_dmabuf_kunmap,
 524         .unmap_atomic = drm_gem_dmabuf_kunmap_atomic,
 525         .mmap = drm_gem_dmabuf_mmap,
 526         .vmap = drm_gem_dmabuf_vmap,
 527         .vunmap = drm_gem_dmabuf_vunmap,
 528 };
 529
 530 /**
 531  * DOC: PRIME Helpers
 532  *
 533  * Drivers can implement @gem_prime_export and @gem_prime_import in terms of
 534  * simpler APIs by using the helper functions @drm_gem_prime_export and
 535  * @drm_gem_prime_import.  These functions implement dma-buf support in terms of
 536  * six lower-level driver callbacks:
 537  *
 538  * Export callbacks:
 539  *
 540  *  * @gem_prime_pin (optional): prepare a GEM object for exporting
 541  *  * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
 542  *  * @gem_prime_vmap: vmap a buffer exported by your driver
 543  *  * @gem_prime_vunmap: vunmap a buffer exported by your driver
 544  *  * @gem_prime_mmap (optional): mmap a buffer exported by your driver
 545  *
 546  * Import callback:
 547  *
 548  *  * @gem_prime_import_sg_table (import): produce a GEM object from another
 549  *    driver's scatter/gather table
 550  */
 551
 552 /**
 553  * drm_gem_prime_export - helper library implementation of the export callback
 554  * @dev: drm_device to export from
 555  * @obj: GEM object to export
 556  * @flags: flags like DRM_CLOEXEC and DRM_RDWR
 557  *
 558  * This is the implementation of the gem_prime_export functions for GEM drivers
 559  * using the PRIME helpers.
 560  */
 561 struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
 562                                      struct drm_gem_object *obj,
 563                                      int flags)
 564 {
 565         struct dma_buf_export_info exp_info = {
 566                 .exp_name = KBUILD_MODNAME, /* white lie for debug */
 567                 .owner = dev->driver->fops->owner,
 568                 .ops = &drm_gem_prime_dmabuf_ops,
 569                 .size = obj->size,
 570                 .flags = flags,
 571                 .priv = obj,
 572         };
 573
 574         if (dev->driver->gem_prime_res_obj)
 575                 exp_info.resv = dev->driver->gem_prime_res_obj(obj);
 576
 577         return drm_gem_dmabuf_export(dev, &exp_info);
 578 }
 579 EXPORT_SYMBOL(drm_gem_prime_export);
 580
 581 static struct dma_buf *export_and_register_object(struct drm_device *dev,
 582                                                   struct drm_gem_object *obj,
 583                                                   uint32_t flags)
 584 {
 585         struct dma_buf *dmabuf;
 586
 587         /* prevent races with concurrent gem_close. */
 588         if (obj->handle_count == 0) {
 589                 dmabuf = ERR_PTR(-ENOENT);
 590                 return dmabuf;
 591         }
 592
 593         dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
 594         if (IS_ERR(dmabuf)) {
 595                 /* normally the created dma-buf takes ownership of the ref,
 596                  * but if that fails then drop the ref
 597                  */
 598                 return dmabuf;
 599         }
 600
 601         /*
 602          * Note that callers do not need to clean up the export cache
 603          * since the check for obj->handle_count guarantees that someone
 604          * will clean it up.
 605          */
 606         obj->dma_buf = dmabuf;
 607         get_dma_buf(obj->dma_buf);
 608
 609         return dmabuf;
 610 }
 611
 612 /**
 613  * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
 614  * @dev: dev to export the buffer from
 615  * @file_priv: drm file-private structure
 616  * @handle: buffer handle to export
 617  * @flags: flags like DRM_CLOEXEC
 618  * @prime_fd: pointer to storage for the fd id of the create dma-buf
 619  *
 620  * This is the PRIME export function which must be used mandatorily by GEM
 621  * drivers to ensure correct lifetime management of the underlying GEM object.
 622  * The actual exporting from GEM object to a dma-buf is done through the
 623  * gem_prime_export driver callback.
 624  */
 625 int drm_gem_prime_handle_to_fd(struct drm_device *dev,
 626                                struct drm_file *file_priv, uint32_t handle,
 627                                uint32_t flags,
 628                                int *prime_fd)
 629 {
 630         struct drm_gem_object *obj;
 631         int ret = 0;
 632         struct dma_buf *dmabuf;
 633
 634         mutex_lock(&file_priv->prime.lock);
 635         obj = drm_gem_object_lookup(file_priv, handle);
 636         if (!obj)  {
 637                 ret = -ENOENT;
 638                 goto out_unlock;
 639         }
 640
 641         dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
 642         if (dmabuf) {
 643                 get_dma_buf(dmabuf);
 644                 goto out_have_handle;
 645         }
 646
 647         mutex_lock(&dev->object_name_lock);
 648         /* re-export the original imported object */
 649         if (obj->import_attach) {
 650                 dmabuf = obj->import_attach->dmabuf;
 651                 get_dma_buf(dmabuf);
 652                 goto out_have_obj;
 653         }
 654
 655         if (obj->dma_buf) {
 656                 get_dma_buf(obj->dma_buf);
 657                 dmabuf = obj->dma_buf;
 658                 goto out_have_obj;
 659         }
 660
 661         dmabuf = export_and_register_object(dev, obj, flags);
 662         if (IS_ERR(dmabuf)) {
 663                 /* normally the created dma-buf takes ownership of the ref,
 664                  * but if that fails then drop the ref
 665                  */
 666                 ret = PTR_ERR(dmabuf);
 667                 mutex_unlock(&dev->object_name_lock);
 668                 goto out;
 669         }
 670
 671 out_have_obj:
 672         /*
 673          * If we've exported this buffer then cheat and add it to the import list
 674          * so we get the correct handle back. We must do this under the
 675          * protection of dev->object_name_lock to ensure that a racing gem close
 676          * ioctl doesn't miss to remove this buffer handle from the cache.
 677          */
 678         ret = drm_prime_add_buf_handle(&file_priv->prime,
 679                                        dmabuf, handle);
 680         mutex_unlock(&dev->object_name_lock);
 681         if (ret)
 682                 goto fail_put_dmabuf;
 683
 684 out_have_handle:
 685         ret = dma_buf_fd(dmabuf, flags);
 686         /*
 687          * We must _not_ remove the buffer from the handle cache since the newly
 688          * created dma buf is already linked in the global obj->dma_buf pointer,
 689          * and that is invariant as long as a userspace gem handle exists.
 690          * Closing the handle will clean out the cache anyway, so we don't leak.
 691          */
 692         if (ret < 0) {
 693                 goto fail_put_dmabuf;
 694         } else {
 695                 *prime_fd = ret;
 696                 ret = 0;
 697         }
 698
 699         goto out;
 700
 701 fail_put_dmabuf:
 702         dma_buf_put(dmabuf);
 703 out:
 704         drm_gem_object_put_unlocked(obj);
 705 out_unlock:
 706         mutex_unlock(&file_priv->prime.lock);
 707
 708         return ret;
 709 }
 710 EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
 711
 712 /**
 713  * drm_gem_prime_import_dev - core implementation of the import callback
 714  * @dev: drm_device to import into
 715  * @dma_buf: dma-buf object to import
 716  * @attach_dev: struct device to dma_buf attach
 717  *
 718  * This is the core of drm_gem_prime_import. It's designed to be called by
 719  * drivers who want to use a different device structure than dev->dev for
 720  * attaching via dma_buf.
 721  */
 722 struct drm_gem_object *drm_gem_prime_import_dev(struct drm_device *dev,
 723                                             struct dma_buf *dma_buf,
 724                                             struct device *attach_dev)
 725 {
 726         struct dma_buf_attachment *attach;
 727         struct sg_table *sgt;
 728         struct drm_gem_object *obj;
 729         int ret;
 730
 731         if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
 732                 obj = dma_buf->priv;
 733                 if (obj->dev == dev) {
 734                         /*
 735                          * Importing dmabuf exported from out own gem increases
 736                          * refcount on gem itself instead of f_count of dmabuf.
 737                          */
 738                         drm_gem_object_get(obj);
 739                         return obj;
 740                 }
 741         }
 742
 743         if (!dev->driver->gem_prime_import_sg_table)
 744                 return ERR_PTR(-EINVAL);
 745
 746         attach = dma_buf_attach(dma_buf, attach_dev);
 747         if (IS_ERR(attach))
 748                 return ERR_CAST(attach);
 749
 750         get_dma_buf(dma_buf);
 751
 752         sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
 753         if (IS_ERR(sgt)) {
 754                 ret = PTR_ERR(sgt);
 755                 goto fail_detach;
 756         }
 757
 758         obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt);
 759         if (IS_ERR(obj)) {
 760                 ret = PTR_ERR(obj);
 761                 goto fail_unmap;
 762         }
 763
 764         obj->import_attach = attach;
 765
 766         return obj;
 767
 768 fail_unmap:
 769         dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
 770 fail_detach:
 771         dma_buf_detach(dma_buf, attach);
 772         dma_buf_put(dma_buf);
 773
 774         return ERR_PTR(ret);
 775 }
 776 EXPORT_SYMBOL(drm_gem_prime_import_dev);
 777
 778 /**
 779  * drm_gem_prime_import - helper library implementation of the import callback
 780  * @dev: drm_device to import into
 781  * @dma_buf: dma-buf object to import
 782  *
 783  * This is the implementation of the gem_prime_import functions for GEM drivers
 784  * using the PRIME helpers.
 785  */
 786 struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
 787                                             struct dma_buf *dma_buf)
 788 {
 789         return drm_gem_prime_import_dev(dev, dma_buf, dev->dev);
 790 }
 791 EXPORT_SYMBOL(drm_gem_prime_import);
 792
 793 /**
 794  * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
 795  * @dev: dev to export the buffer from
 796  * @file_priv: drm file-private structure
 797  * @prime_fd: fd id of the dma-buf which should be imported
 798  * @handle: pointer to storage for the handle of the imported buffer object
 799  *
 800  * This is the PRIME import function which must be used mandatorily by GEM
 801  * drivers to ensure correct lifetime management of the underlying GEM object.
 802  * The actual importing of GEM object from the dma-buf is done through the
 803  * gem_import_export driver callback.
 804  */
 805 int drm_gem_prime_fd_to_handle(struct drm_device *dev,
 806                                struct drm_file *file_priv, int prime_fd,
 807                                uint32_t *handle)
 808 {
 809         struct dma_buf *dma_buf;
 810         struct drm_gem_object *obj;
 811         int ret;
 812
 813         dma_buf = dma_buf_get(prime_fd);
 814         if (IS_ERR(dma_buf))
 815                 return PTR_ERR(dma_buf);
 816
 817         mutex_lock(&file_priv->prime.lock);
 818
 819         ret = drm_prime_lookup_buf_handle(&file_priv->prime,
 820                         dma_buf, handle);
 821         if (ret == 0)
 822                 goto out_put;
 823
 824         /* never seen this one, need to import */
 825         mutex_lock(&dev->object_name_lock);
 826         obj = dev->driver->gem_prime_import(dev, dma_buf);
 827         if (IS_ERR(obj)) {
 828                 ret = PTR_ERR(obj);
 829                 goto out_unlock;
 830         }
 831
 832         if (obj->dma_buf) {
 833                 WARN_ON(obj->dma_buf != dma_buf);
 834         } else {
 835                 obj->dma_buf = dma_buf;
 836                 get_dma_buf(dma_buf);
 837         }
 838
 839         /* _handle_create_tail unconditionally unlocks dev->object_name_lock. */
 840         ret = drm_gem_handle_create_tail(file_priv, obj, handle);
 841         drm_gem_object_put_unlocked(obj);
 842         if (ret)
 843                 goto out_put;
 844
 845         ret = drm_prime_add_buf_handle(&file_priv->prime,
 846                         dma_buf, *handle);
 847         mutex_unlock(&file_priv->prime.lock);
 848         if (ret)
 849                 goto fail;
 850
 851         dma_buf_put(dma_buf);
 852
 853         return 0;
 854
 855 fail:
 856         /* hmm, if driver attached, we are relying on the free-object path
 857          * to detach.. which seems ok..
 858          */
 859         drm_gem_handle_delete(file_priv, *handle);
 860         dma_buf_put(dma_buf);
 861         return ret;
 862
 863 out_unlock:
 864         mutex_unlock(&dev->object_name_lock);
 865 out_put:
 866         mutex_unlock(&file_priv->prime.lock);
 867         dma_buf_put(dma_buf);
 868         return ret;
 869 }
 870 EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);
 871
 872 int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
 873                                  struct drm_file *file_priv)
 874 {
 875         struct drm_prime_handle *args = data;
 876
 877         if (!drm_core_check_feature(dev, DRIVER_PRIME))
 878                 return -EINVAL;
 879
 880         if (!dev->driver->prime_handle_to_fd)
 881                 return -ENOSYS;
 882
 883         /* check flags are valid */
 884         if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
 885                 return -EINVAL;
 886
 887         return dev->driver->prime_handle_to_fd(dev, file_priv,
 888                         args->handle, args->flags, &args->fd);
 889 }
 890
 891 int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
 892                                  struct drm_file *file_priv)
 893 {
 894         struct drm_prime_handle *args = data;
 895
 896         if (!drm_core_check_feature(dev, DRIVER_PRIME))
 897                 return -EINVAL;
 898
 899         if (!dev->driver->prime_fd_to_handle)
 900                 return -ENOSYS;
 901
 902         return dev->driver->prime_fd_to_handle(dev, file_priv,
 903                         args->fd, &args->handle);
 904 }
 905
 906 /**
 907  * drm_prime_pages_to_sg - converts a page array into an sg list
 908  * @pages: pointer to the array of page pointers to convert
 909  * @nr_pages: length of the page vector
 910  *
 911  * This helper creates an sg table object from a set of pages
 912  * the driver is responsible for mapping the pages into the
 913  * importers address space for use with dma_buf itself.
 914  */
 915 struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages)
 916 {
 917         struct sg_table *sg = NULL;
 918         int ret;
 919
 920         sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
 921         if (!sg) {
 922                 ret = -ENOMEM;
 923                 goto out;
 924         }
 925
 926         ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
 927                                 nr_pages << PAGE_SHIFT, GFP_KERNEL);
 928         if (ret)
 929                 goto out;
 930
 931         return sg;
 932 out:
 933         kfree(sg);
 934         return ERR_PTR(ret);
 935 }
 936 EXPORT_SYMBOL(drm_prime_pages_to_sg);
 937
 938 /**
 939  * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
 940  * @sgt: scatter-gather table to convert
 941  * @pages: optional array of page pointers to store the page array in
 942  * @addrs: optional array to store the dma bus address of each page
 943  * @max_entries: size of both the passed-in arrays
 944  *
 945  * Exports an sg table into an array of pages and addresses. This is currently
 946  * required by the TTM driver in order to do correct fault handling.
 947  */
 948 int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
 949                                      dma_addr_t *addrs, int max_entries)
 950 {
 951         unsigned count;
 952         struct scatterlist *sg;
 953         struct page *page;
 954         u32 len, index;
 955         dma_addr_t addr;
 956
 957         index = 0;
 958         for_each_sg(sgt->sgl, sg, sgt->nents, count) {
 959                 len = sg->length;
 960                 page = sg_page(sg);
 961                 addr = sg_dma_address(sg);
 962
 963                 while (len > 0) {
 964                         if (WARN_ON(index >= max_entries))
 965                                 return -1;
 966                         if (pages)
 967                                 pages[index] = page;
 968                         if (addrs)
 969                                 addrs[index] = addr;
 970
 971                         page++;
 972                         addr += PAGE_SIZE;
 973                         len -= PAGE_SIZE;
 974                         index++;
 975                 }
 976         }
 977         return 0;
 978 }
 979 EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
 980
 981 /**
 982  * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
 983  * @obj: GEM object which was created from a dma-buf
 984  * @sg: the sg-table which was pinned at import time
 985  *
 986  * This is the cleanup functions which GEM drivers need to call when they use
 987  * @drm_gem_prime_import to import dma-bufs.
 988  */
 989 void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
 990 {
 991         struct dma_buf_attachment *attach;
 992         struct dma_buf *dma_buf;
 993         attach = obj->import_attach;
 994         if (sg)
 995                 dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
 996         dma_buf = attach->dmabuf;
 997         dma_buf_detach(attach->dmabuf, attach);
 998         /* remove the reference */
 999         dma_buf_put(dma_buf);
1000 }
1001 EXPORT_SYMBOL(drm_prime_gem_destroy);
1002
1003 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
1004 {
1005         mutex_init(&prime_fpriv->lock);
1006         prime_fpriv->dmabufs = RB_ROOT;
1007         prime_fpriv->handles = RB_ROOT;
1008 }
1009
1010 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
1011 {
1012         /* by now drm_gem_release should've made sure the list is empty */
1013         WARN_ON(!RB_EMPTY_ROOT(&prime_fpriv->dmabufs));
1014 }