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