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