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/drmP.h>
  33 #include <drm/drm_gem.h>
  34
  35 #include "drm_internal.h"
  36
  37 /*
  38  * DMA-BUF/GEM Object references and lifetime overview:
  39  *
  40  * On the export the dma_buf holds a reference to the exporting GEM
  41  * object. It takes this reference in handle_to_fd_ioctl, when it
  42  * first calls .prime_export and stores the exporting GEM object in
  43  * the dma_buf priv. This reference is released when the dma_buf
  44  * object goes away in the driver .release function.
  45  *
  46  * On the import the importing GEM object holds a reference to the
  47  * dma_buf (which in turn holds a ref to the exporting GEM object).
  48  * It takes that reference in the fd_to_handle ioctl.
  49  * It calls dma_buf_get, creates an attachment to it and stores the
  50  * attachment in the GEM object. When this attachment is destroyed
  51  * when the imported object is destroyed, we remove the attachment
  52  * and drop the reference to the dma_buf.
  53  *
  54  * Thus the chain of references always flows in one direction
  55  * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
  56  *
  57  * Self-importing: if userspace is using PRIME as a replacement for flink
  58  * then it will get a fd->handle request for a GEM object that it created.
  59  * Drivers should detect this situation and return back the gem object
  60  * from the dma-buf private.  Prime will do this automatically for drivers that
  61  * use the drm_gem_prime_{import,export} helpers.
  62  */
  63
  64 struct drm_prime_member {
  65         struct dma_buf *dma_buf;
  66         uint32_t handle;
  67
  68         struct rb_node dmabuf_rb;
  69         struct rb_node handle_rb;
  70 };
  71
  72 struct drm_prime_attachment {
  73         struct sg_table *sgt;
  74         enum dma_data_direction dir;
  75 };
  76
  77 static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
  78                                     struct dma_buf *dma_buf, uint32_t handle)
  79 {
  80         struct drm_prime_member *member;
  81         struct rb_node **p, *rb;
  82
  83         member = kmalloc(sizeof(*member), GFP_KERNEL);
  84         if (!member)
  85                 return -ENOMEM;
  86
  87         get_dma_buf(dma_buf);
  88         member->dma_buf = dma_buf;
  89         member->handle = handle;
  90
  91         rb = NULL;
  92         p = &prime_fpriv->dmabufs.rb_node;
  93         while (*p) {
  94                 struct drm_prime_member *pos;
  95
  96                 rb = *p;
  97                 pos = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
  98                 if (dma_buf > pos->dma_buf)
  99                         p = &rb->rb_right;
 100                 else
 101                         p = &rb->rb_left;
 102         }
 103         rb_link_node(&member->dmabuf_rb, rb, p);
 104         rb_insert_color(&member->dmabuf_rb, &prime_fpriv->dmabufs);
 105
 106         rb = NULL;
 107         p = &prime_fpriv->handles.rb_node;
 108         while (*p) {
 109                 struct drm_prime_member *pos;
 110
 111                 rb = *p;
 112                 pos = rb_entry(rb, struct drm_prime_member, handle_rb);
 113                 if (handle > pos->handle)
 114                         p = &rb->rb_right;
 115                 else
 116                         p = &rb->rb_left;
 117         }
 118         rb_link_node(&member->handle_rb, rb, p);
 119         rb_insert_color(&member->handle_rb, &prime_fpriv->handles);
 120
 121         return 0;
 122 }
 123
 124 static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv,
 125                                                       uint32_t handle)
 126 {
 127         struct rb_node *rb;
 128
 129         rb = prime_fpriv->handles.rb_node;
 130         while (rb) {
 131                 struct drm_prime_member *member;
 132
 133                 member = rb_entry(rb, struct drm_prime_member, handle_rb);
 134                 if (member->handle == handle)
 135                         return member->dma_buf;
 136                 else if (member->handle < handle)
 137                         rb = rb->rb_right;
 138                 else
 139                         rb = rb->rb_left;
 140         }
 141
 142         return NULL;
 143 }
 144
 145 static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv,
 146                                        struct dma_buf *dma_buf,
 147                                        uint32_t *handle)
 148 {
 149         struct rb_node *rb;
 150
 151         rb = prime_fpriv->dmabufs.rb_node;
 152         while (rb) {
 153                 struct drm_prime_member *member;
 154
 155                 member = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
 156                 if (member->dma_buf == dma_buf) {
 157                         *handle = member->handle;
 158                         return 0;
 159                 } else if (member->dma_buf < dma_buf) {
 160                         rb = rb->rb_right;
 161                 } else {
 162                         rb = rb->rb_left;
 163                 }
 164         }
 165
 166         return -ENOENT;
 167 }
 168
 169 static int drm_gem_map_attach(struct dma_buf *dma_buf,
 170                               struct device *target_dev,
 171                               struct dma_buf_attachment *attach)
 172 {
 173         struct drm_prime_attachment *prime_attach;
 174         struct drm_gem_object *obj = dma_buf->priv;
 175         struct drm_device *dev = obj->dev;
 176
 177         prime_attach = kzalloc(sizeof(*prime_attach), GFP_KERNEL);
 178         if (!prime_attach)
 179                 return -ENOMEM;
 180
 181         prime_attach->dir = DMA_NONE;
 182         attach->priv = prime_attach;
 183
 184         if (!dev->driver->gem_prime_pin)
 185                 return 0;
 186
 187         return dev->driver->gem_prime_pin(obj);
 188 }
 189
 190 static void drm_gem_map_detach(struct dma_buf *dma_buf,
 191                                struct dma_buf_attachment *attach)
 192 {
 193         struct drm_prime_attachment *prime_attach = attach->priv;
 194         struct drm_gem_object *obj = dma_buf->priv;
 195         struct drm_device *dev = obj->dev;
 196         struct sg_table *sgt;
 197
 198         if (dev->driver->gem_prime_unpin)
 199                 dev->driver->gem_prime_unpin(obj);
 200
 201         if (!prime_attach)
 202                 return;
 203
 204         sgt = prime_attach->sgt;
 205         if (sgt) {
 206                 if (prime_attach->dir != DMA_NONE)
 207                         dma_unmap_sg(attach->dev, sgt->sgl, sgt->nents,
 208                                         prime_attach->dir);
 209                 sg_free_table(sgt);
 210         }
 211
 212         kfree(sgt);
 213         kfree(prime_attach);
 214         attach->priv = NULL;
 215 }
 216
 217 void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
 218                                         struct dma_buf *dma_buf)
 219 {
 220         struct rb_node *rb;
 221
 222         rb = prime_fpriv->dmabufs.rb_node;
 223         while (rb) {
 224                 struct drm_prime_member *member;
 225
 226                 member = rb_entry(rb, struct drm_prime_member, dmabuf_rb);
 227                 if (member->dma_buf == dma_buf) {
 228                         rb_erase(&member->handle_rb, &prime_fpriv->handles);
 229                         rb_erase(&member->dmabuf_rb, &prime_fpriv->dmabufs);
 230
 231                         dma_buf_put(dma_buf);
 232                         kfree(member);
 233                         return;
 234                 } else if (member->dma_buf < dma_buf) {
 235                         rb = rb->rb_right;
 236                 } else {
 237                         rb = rb->rb_left;
 238                 }
 239         }
 240 }
 241
 242 static struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
 243                                             enum dma_data_direction dir)
 244 {
 245         struct drm_prime_attachment *prime_attach = attach->priv;
 246         struct drm_gem_object *obj = attach->dmabuf->priv;
 247         struct sg_table *sgt;
 248
 249         if (WARN_ON(dir == DMA_NONE || !prime_attach))
 250                 return ERR_PTR(-EINVAL);
 251
 252         /* return the cached mapping when possible */
 253         if (prime_attach->dir == dir)
 254                 return prime_attach->sgt;
 255
 256         /*
 257          * two mappings with different directions for the same attachment are
 258          * not allowed
 259          */
 260         if (WARN_ON(prime_attach->dir != DMA_NONE))
 261                 return ERR_PTR(-EBUSY);
 262
 263         sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
 264
 265         if (!IS_ERR(sgt)) {
 266                 if (!dma_map_sg(attach->dev, sgt->sgl, sgt->nents, dir)) {
 267                         sg_free_table(sgt);
 268                         kfree(sgt);
 269                         sgt = ERR_PTR(-ENOMEM);
 270                 } else {
 271                         prime_attach->sgt = sgt;
 272                         prime_attach->dir = dir;
 273                 }
 274         }
 275
 276         return sgt;
 277 }
 278
 279 static void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
 280                                   struct sg_table *sgt,
 281                                   enum dma_data_direction dir)
 282 {
 283         /* nothing to be done here */
 284 }
 285
 286 /**
 287  * drm_gem_dmabuf_release - dma_buf release implementation for GEM
 288  * @dma_buf: buffer to be released
 289  *
 290  * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers
 291  * must use this in their dma_buf ops structure as the release callback.
 292  */
 293 void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
 294 {
 295         struct drm_gem_object *obj = dma_buf->priv;
 296
 297         /* drop the reference on the export fd holds */
 298         drm_gem_object_unreference_unlocked(obj);
 299 }
 300 EXPORT_SYMBOL(drm_gem_dmabuf_release);
 301
 302 static void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
 303 {
 304         struct drm_gem_object *obj = dma_buf->priv;
 305         struct drm_device *dev = obj->dev;
 306
 307         return dev->driver->gem_prime_vmap(obj);
 308 }
 309
 310 static void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
 311 {
 312         struct drm_gem_object *obj = dma_buf->priv;
 313         struct drm_device *dev = obj->dev;
 314
 315         dev->driver->gem_prime_vunmap(obj, vaddr);
 316 }
 317
 318 static void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
 319                                         unsigned long page_num)
 320 {
 321         return NULL;
 322 }
 323
 324 static void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
 325                                          unsigned long page_num, void *addr)
 326 {
 327
 328 }
 329 static void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf,
 330                                  unsigned long page_num)
 331 {
 332         return NULL;
 333 }
 334
 335 static void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf,
 336                                   unsigned long page_num, void *addr)
 337 {
 338
 339 }
 340
 341 static int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf,
 342                                struct vm_area_struct *vma)
 343 {
 344         struct drm_gem_object *obj = dma_buf->priv;
 345         struct drm_device *dev = obj->dev;
 346
 347         if (!dev->driver->gem_prime_mmap)
 348                 return -ENOSYS;
 349
 350         return dev->driver->gem_prime_mmap(obj, vma);
 351 }
 352
 353 static const struct dma_buf_ops drm_gem_prime_dmabuf_ops =  {
 354         .attach = drm_gem_map_attach,
 355         .detach = drm_gem_map_detach,
 356         .map_dma_buf = drm_gem_map_dma_buf,
 357         .unmap_dma_buf = drm_gem_unmap_dma_buf,
 358         .release = drm_gem_dmabuf_release,
 359         .kmap = drm_gem_dmabuf_kmap,
 360         .kmap_atomic = drm_gem_dmabuf_kmap_atomic,
 361         .kunmap = drm_gem_dmabuf_kunmap,
 362         .kunmap_atomic = drm_gem_dmabuf_kunmap_atomic,
 363         .mmap = drm_gem_dmabuf_mmap,
 364         .vmap = drm_gem_dmabuf_vmap,
 365         .vunmap = drm_gem_dmabuf_vunmap,
 366 };
 367
 368 /**
 369  * DOC: PRIME Helpers
 370  *
 371  * Drivers can implement @gem_prime_export and @gem_prime_import in terms of
 372  * simpler APIs by using the helper functions @drm_gem_prime_export and
 373  * @drm_gem_prime_import.  These functions implement dma-buf support in terms of
 374  * six lower-level driver callbacks:
 375  *
 376  * Export callbacks:
 377  *
 378  *  * @gem_prime_pin (optional): prepare a GEM object for exporting
 379  *  * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
 380  *  * @gem_prime_vmap: vmap a buffer exported by your driver
 381  *  * @gem_prime_vunmap: vunmap a buffer exported by your driver
 382  *  * @gem_prime_mmap (optional): mmap a buffer exported by your driver
 383  *
 384  * Import callback:
 385  *
 386  *  * @gem_prime_import_sg_table (import): produce a GEM object from another
 387  *    driver's scatter/gather table
 388  */
 389
 390 /**
 391  * drm_gem_prime_export - helper library implementation of the export callback
 392  * @dev: drm_device to export from
 393  * @obj: GEM object to export
 394  * @flags: flags like DRM_CLOEXEC and DRM_RDWR
 395  *
 396  * This is the implementation of the gem_prime_export functions for GEM drivers
 397  * using the PRIME helpers.
 398  */
 399 struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
 400                                      struct drm_gem_object *obj, int flags)
 401 {
 402         DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
 403
 404         exp_info.ops = &drm_gem_prime_dmabuf_ops;
 405         exp_info.size = obj->size;
 406         exp_info.flags = flags;
 407         exp_info.priv = obj;
 408
 409         if (dev->driver->gem_prime_res_obj)
 410                 exp_info.resv = dev->driver->gem_prime_res_obj(obj);
 411
 412         return dma_buf_export(&exp_info);
 413 }
 414 EXPORT_SYMBOL(drm_gem_prime_export);
 415
 416 static struct dma_buf *export_and_register_object(struct drm_device *dev,
 417                                                   struct drm_gem_object *obj,
 418                                                   uint32_t flags)
 419 {
 420         struct dma_buf *dmabuf;
 421
 422         /* prevent races with concurrent gem_close. */
 423         if (obj->handle_count == 0) {
 424                 dmabuf = ERR_PTR(-ENOENT);
 425                 return dmabuf;
 426         }
 427
 428         dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
 429         if (IS_ERR(dmabuf)) {
 430                 /* normally the created dma-buf takes ownership of the ref,
 431                  * but if that fails then drop the ref
 432                  */
 433                 return dmabuf;
 434         }
 435
 436         /*
 437          * Note that callers do not need to clean up the export cache
 438          * since the check for obj->handle_count guarantees that someone
 439          * will clean it up.
 440          */
 441         obj->dma_buf = dmabuf;
 442         get_dma_buf(obj->dma_buf);
 443         /* Grab a new ref since the callers is now used by the dma-buf */
 444         drm_gem_object_reference(obj);
 445
 446         return dmabuf;
 447 }
 448
 449 /**
 450  * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
 451  * @dev: dev to export the buffer from
 452  * @file_priv: drm file-private structure
 453  * @handle: buffer handle to export
 454  * @flags: flags like DRM_CLOEXEC
 455  * @prime_fd: pointer to storage for the fd id of the create dma-buf
 456  *
 457  * This is the PRIME export function which must be used mandatorily by GEM
 458  * drivers to ensure correct lifetime management of the underlying GEM object.
 459  * The actual exporting from GEM object to a dma-buf is done through the
 460  * gem_prime_export driver callback.
 461  */
 462 int drm_gem_prime_handle_to_fd(struct drm_device *dev,
 463                                struct drm_file *file_priv, uint32_t handle,
 464                                uint32_t flags,
 465                                int *prime_fd)
 466 {
 467         struct drm_gem_object *obj;
 468         int ret = 0;
 469         struct dma_buf *dmabuf;
 470
 471         mutex_lock(&file_priv->prime.lock);
 472         obj = drm_gem_object_lookup(file_priv, handle);
 473         if (!obj)  {
 474                 ret = -ENOENT;
 475                 goto out_unlock;
 476         }
 477
 478         dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
 479         if (dmabuf) {
 480                 get_dma_buf(dmabuf);
 481                 goto out_have_handle;
 482         }
 483
 484         mutex_lock(&dev->object_name_lock);
 485         /* re-export the original imported object */
 486         if (obj->import_attach) {
 487                 dmabuf = obj->import_attach->dmabuf;
 488                 get_dma_buf(dmabuf);
 489                 goto out_have_obj;
 490         }
 491
 492         if (obj->dma_buf) {
 493                 get_dma_buf(obj->dma_buf);
 494                 dmabuf = obj->dma_buf;
 495                 goto out_have_obj;
 496         }
 497
 498         dmabuf = export_and_register_object(dev, obj, flags);
 499         if (IS_ERR(dmabuf)) {
 500                 /* normally the created dma-buf takes ownership of the ref,
 501                  * but if that fails then drop the ref
 502                  */
 503                 ret = PTR_ERR(dmabuf);
 504                 mutex_unlock(&dev->object_name_lock);
 505                 goto out;
 506         }
 507
 508 out_have_obj:
 509         /*
 510          * If we've exported this buffer then cheat and add it to the import list
 511          * so we get the correct handle back. We must do this under the
 512          * protection of dev->object_name_lock to ensure that a racing gem close
 513          * ioctl doesn't miss to remove this buffer handle from the cache.
 514          */
 515         ret = drm_prime_add_buf_handle(&file_priv->prime,
 516                                        dmabuf, handle);
 517         mutex_unlock(&dev->object_name_lock);
 518         if (ret)
 519                 goto fail_put_dmabuf;
 520
 521 out_have_handle:
 522         ret = dma_buf_fd(dmabuf, flags);
 523         /*
 524          * We must _not_ remove the buffer from the handle cache since the newly
 525          * created dma buf is already linked in the global obj->dma_buf pointer,
 526          * and that is invariant as long as a userspace gem handle exists.
 527          * Closing the handle will clean out the cache anyway, so we don't leak.
 528          */
 529         if (ret < 0) {
 530                 goto fail_put_dmabuf;
 531         } else {
 532                 *prime_fd = ret;
 533                 ret = 0;
 534         }
 535
 536         goto out;
 537
 538 fail_put_dmabuf:
 539         dma_buf_put(dmabuf);
 540 out:
 541         drm_gem_object_unreference_unlocked(obj);
 542 out_unlock:
 543         mutex_unlock(&file_priv->prime.lock);
 544
 545         return ret;
 546 }
 547 EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
 548
 549 /**
 550  * drm_gem_prime_import - helper library implementation of the import callback
 551  * @dev: drm_device to import into
 552  * @dma_buf: dma-buf object to import
 553  *
 554  * This is the implementation of the gem_prime_import functions for GEM drivers
 555  * using the PRIME helpers.
 556  */
 557 struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
 558                                             struct dma_buf *dma_buf)
 559 {
 560         struct dma_buf_attachment *attach;
 561         struct sg_table *sgt;
 562         struct drm_gem_object *obj;
 563         int ret;
 564
 565         if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
 566                 obj = dma_buf->priv;
 567                 if (obj->dev == dev) {
 568                         /*
 569                          * Importing dmabuf exported from out own gem increases
 570                          * refcount on gem itself instead of f_count of dmabuf.
 571                          */
 572                         drm_gem_object_reference(obj);
 573                         return obj;
 574                 }
 575         }
 576
 577         if (!dev->driver->gem_prime_import_sg_table)
 578                 return ERR_PTR(-EINVAL);
 579
 580         attach = dma_buf_attach(dma_buf, dev->dev);
 581         if (IS_ERR(attach))
 582                 return ERR_CAST(attach);
 583
 584         get_dma_buf(dma_buf);
 585
 586         sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
 587         if (IS_ERR(sgt)) {
 588                 ret = PTR_ERR(sgt);
 589                 goto fail_detach;
 590         }
 591
 592         obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt);
 593         if (IS_ERR(obj)) {
 594                 ret = PTR_ERR(obj);
 595                 goto fail_unmap;
 596         }
 597
 598         obj->import_attach = attach;
 599
 600         return obj;
 601
 602 fail_unmap:
 603         dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
 604 fail_detach:
 605         dma_buf_detach(dma_buf, attach);
 606         dma_buf_put(dma_buf);
 607
 608         return ERR_PTR(ret);
 609 }
 610 EXPORT_SYMBOL(drm_gem_prime_import);
 611
 612 /**
 613  * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
 614  * @dev: dev to export the buffer from
 615  * @file_priv: drm file-private structure
 616  * @prime_fd: fd id of the dma-buf which should be imported
 617  * @handle: pointer to storage for the handle of the imported buffer object
 618  *
 619  * This is the PRIME import function which must be used mandatorily by GEM
 620  * drivers to ensure correct lifetime management of the underlying GEM object.
 621  * The actual importing of GEM object from the dma-buf is done through the
 622  * gem_import_export driver callback.
 623  */
 624 int drm_gem_prime_fd_to_handle(struct drm_device *dev,
 625                                struct drm_file *file_priv, int prime_fd,
 626                                uint32_t *handle)
 627 {
 628         struct dma_buf *dma_buf;
 629         struct drm_gem_object *obj;
 630         int ret;
 631
 632         dma_buf = dma_buf_get(prime_fd);
 633         if (IS_ERR(dma_buf))
 634                 return PTR_ERR(dma_buf);
 635
 636         mutex_lock(&file_priv->prime.lock);
 637
 638         ret = drm_prime_lookup_buf_handle(&file_priv->prime,
 639                         dma_buf, handle);
 640         if (ret == 0)
 641                 goto out_put;
 642
 643         /* never seen this one, need to import */
 644         mutex_lock(&dev->object_name_lock);
 645         obj = dev->driver->gem_prime_import(dev, dma_buf);
 646         if (IS_ERR(obj)) {
 647                 ret = PTR_ERR(obj);
 648                 goto out_unlock;
 649         }
 650
 651         if (obj->dma_buf) {
 652                 WARN_ON(obj->dma_buf != dma_buf);
 653         } else {
 654                 obj->dma_buf = dma_buf;
 655                 get_dma_buf(dma_buf);
 656         }
 657
 658         /* _handle_create_tail unconditionally unlocks dev->object_name_lock. */
 659         ret = drm_gem_handle_create_tail(file_priv, obj, handle);
 660         drm_gem_object_unreference_unlocked(obj);
 661         if (ret)
 662                 goto out_put;
 663
 664         ret = drm_prime_add_buf_handle(&file_priv->prime,
 665                         dma_buf, *handle);
 666         mutex_unlock(&file_priv->prime.lock);
 667         if (ret)
 668                 goto fail;
 669
 670         dma_buf_put(dma_buf);
 671
 672         return 0;
 673
 674 fail:
 675         /* hmm, if driver attached, we are relying on the free-object path
 676          * to detach.. which seems ok..
 677          */
 678         drm_gem_handle_delete(file_priv, *handle);
 679         dma_buf_put(dma_buf);
 680         return ret;
 681
 682 out_unlock:
 683         mutex_unlock(&dev->object_name_lock);
 684 out_put:
 685         mutex_unlock(&file_priv->prime.lock);
 686         dma_buf_put(dma_buf);
 687         return ret;
 688 }
 689 EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);
 690
 691 int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
 692                                  struct drm_file *file_priv)
 693 {
 694         struct drm_prime_handle *args = data;
 695
 696         if (!drm_core_check_feature(dev, DRIVER_PRIME))
 697                 return -EINVAL;
 698
 699         if (!dev->driver->prime_handle_to_fd)
 700                 return -ENOSYS;
 701
 702         /* check flags are valid */
 703         if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
 704                 return -EINVAL;
 705
 706         return dev->driver->prime_handle_to_fd(dev, file_priv,
 707                         args->handle, args->flags, &args->fd);
 708 }
 709
 710 int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
 711                                  struct drm_file *file_priv)
 712 {
 713         struct drm_prime_handle *args = data;
 714
 715         if (!drm_core_check_feature(dev, DRIVER_PRIME))
 716                 return -EINVAL;
 717
 718         if (!dev->driver->prime_fd_to_handle)
 719                 return -ENOSYS;
 720
 721         return dev->driver->prime_fd_to_handle(dev, file_priv,
 722                         args->fd, &args->handle);
 723 }
 724
 725 /**
 726  * drm_prime_pages_to_sg - converts a page array into an sg list
 727  * @pages: pointer to the array of page pointers to convert
 728  * @nr_pages: length of the page vector
 729  *
 730  * This helper creates an sg table object from a set of pages
 731  * the driver is responsible for mapping the pages into the
 732  * importers address space for use with dma_buf itself.
 733  */
 734 struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages)
 735 {
 736         struct sg_table *sg = NULL;
 737         int ret;
 738
 739         sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
 740         if (!sg) {
 741                 ret = -ENOMEM;
 742                 goto out;
 743         }
 744
 745         ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
 746                                 nr_pages << PAGE_SHIFT, GFP_KERNEL);
 747         if (ret)
 748                 goto out;
 749
 750         return sg;
 751 out:
 752         kfree(sg);
 753         return ERR_PTR(ret);
 754 }
 755 EXPORT_SYMBOL(drm_prime_pages_to_sg);
 756
 757 /**
 758  * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
 759  * @sgt: scatter-gather table to convert
 760  * @pages: array of page pointers to store the page array in
 761  * @addrs: optional array to store the dma bus address of each page
 762  * @max_pages: size of both the passed-in arrays
 763  *
 764  * Exports an sg table into an array of pages and addresses. This is currently
 765  * required by the TTM driver in order to do correct fault handling.
 766  */
 767 int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
 768                                      dma_addr_t *addrs, int max_pages)
 769 {
 770         unsigned count;
 771         struct scatterlist *sg;
 772         struct page *page;
 773         u32 len;
 774         int pg_index;
 775         dma_addr_t addr;
 776
 777         pg_index = 0;
 778         for_each_sg(sgt->sgl, sg, sgt->nents, count) {
 779                 len = sg->length;
 780                 page = sg_page(sg);
 781                 addr = sg_dma_address(sg);
 782
 783                 while (len > 0) {
 784                         if (WARN_ON(pg_index >= max_pages))
 785                                 return -1;
 786                         pages[pg_index] = page;
 787                         if (addrs)
 788                                 addrs[pg_index] = addr;
 789
 790                         page++;
 791                         addr += PAGE_SIZE;
 792                         len -= PAGE_SIZE;
 793                         pg_index++;
 794                 }
 795         }
 796         return 0;
 797 }
 798 EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
 799
 800 /**
 801  * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
 802  * @obj: GEM object which was created from a dma-buf
 803  * @sg: the sg-table which was pinned at import time
 804  *
 805  * This is the cleanup functions which GEM drivers need to call when they use
 806  * @drm_gem_prime_import to import dma-bufs.
 807  */
 808 void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
 809 {
 810         struct dma_buf_attachment *attach;
 811         struct dma_buf *dma_buf;
 812         attach = obj->import_attach;
 813         if (sg)
 814                 dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
 815         dma_buf = attach->dmabuf;
 816         dma_buf_detach(attach->dmabuf, attach);
 817         /* remove the reference */
 818         dma_buf_put(dma_buf);
 819 }
 820 EXPORT_SYMBOL(drm_prime_gem_destroy);
 821
 822 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
 823 {
 824         mutex_init(&prime_fpriv->lock);
 825         prime_fpriv->dmabufs = RB_ROOT;
 826         prime_fpriv->handles = RB_ROOT;
 827 }
 828
 829 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
 830 {
 831         /* by now drm_gem_release should've made sure the list is empty */
 832         WARN_ON(!RB_EMPTY_ROOT(&prime_fpriv->dmabufs));
 833 }