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