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 uniqe 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 if (dev->driver->gem_prime_export)
 394                 dmabuf = dev->driver->gem_prime_export(obj, flags);
 395         else
 396                 dmabuf = drm_gem_prime_export(obj, flags);
 397         if (IS_ERR(dmabuf)) {
 398                 /* normally the created dma-buf takes ownership of the ref,
 399                  * but if that fails then drop the ref
 400                  */
 401                 return dmabuf;
 402         }
 403
 404         /*
 405          * Note that callers do not need to clean up the export cache
 406          * since the check for obj->handle_count guarantees that someone
 407          * will clean it up.
 408          */
 409         obj->dma_buf = dmabuf;
 410         get_dma_buf(obj->dma_buf);
 411
 412         return dmabuf;
 413 }
 414
 415 /**
 416  * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
 417  * @dev: dev to export the buffer from
 418  * @file_priv: drm file-private structure
 419  * @handle: buffer handle to export
 420  * @flags: flags like DRM_CLOEXEC
 421  * @prime_fd: pointer to storage for the fd id of the create dma-buf
 422  *
 423  * This is the PRIME export function which must be used mandatorily by GEM
 424  * drivers to ensure correct lifetime management of the underlying GEM object.
 425  * The actual exporting from GEM object to a dma-buf is done through the
 426  * &drm_driver.gem_prime_export driver callback.
 427  */
 428 int drm_gem_prime_handle_to_fd(struct drm_device *dev,
 429                                struct drm_file *file_priv, uint32_t handle,
 430                                uint32_t flags,
 431                                int *prime_fd)
 432 {
 433         struct drm_gem_object *obj;
 434         int ret = 0;
 435         struct dma_buf *dmabuf;
 436
 437         mutex_lock(&file_priv->prime.lock);
 438         obj = drm_gem_object_lookup(file_priv, handle);
 439         if (!obj)  {
 440                 ret = -ENOENT;
 441                 goto out_unlock;
 442         }
 443
 444         dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
 445         if (dmabuf) {
 446                 get_dma_buf(dmabuf);
 447                 goto out_have_handle;
 448         }
 449
 450         mutex_lock(&dev->object_name_lock);
 451         /* re-export the original imported object */
 452         if (obj->import_attach) {
 453                 dmabuf = obj->import_attach->dmabuf;
 454                 get_dma_buf(dmabuf);
 455                 goto out_have_obj;
 456         }
 457
 458         if (obj->dma_buf) {
 459                 get_dma_buf(obj->dma_buf);
 460                 dmabuf = obj->dma_buf;
 461                 goto out_have_obj;
 462         }
 463
 464         dmabuf = export_and_register_object(dev, obj, flags);
 465         if (IS_ERR(dmabuf)) {
 466                 /* normally the created dma-buf takes ownership of the ref,
 467                  * but if that fails then drop the ref
 468                  */
 469                 ret = PTR_ERR(dmabuf);
 470                 mutex_unlock(&dev->object_name_lock);
 471                 goto out;
 472         }
 473
 474 out_have_obj:
 475         /*
 476          * If we've exported this buffer then cheat and add it to the import list
 477          * so we get the correct handle back. We must do this under the
 478          * protection of dev->object_name_lock to ensure that a racing gem close
 479          * ioctl doesn't miss to remove this buffer handle from the cache.
 480          */
 481         ret = drm_prime_add_buf_handle(&file_priv->prime,
 482                                        dmabuf, handle);
 483         mutex_unlock(&dev->object_name_lock);
 484         if (ret)
 485                 goto fail_put_dmabuf;
 486
 487 out_have_handle:
 488         ret = dma_buf_fd(dmabuf, flags);
 489         /*
 490          * We must _not_ remove the buffer from the handle cache since the newly
 491          * created dma buf is already linked in the global obj->dma_buf pointer,
 492          * and that is invariant as long as a userspace gem handle exists.
 493          * Closing the handle will clean out the cache anyway, so we don't leak.
 494          */
 495         if (ret < 0) {
 496                 goto fail_put_dmabuf;
 497         } else {
 498                 *prime_fd = ret;
 499                 ret = 0;
 500         }
 501
 502         goto out;
 503
 504 fail_put_dmabuf:
 505         dma_buf_put(dmabuf);
 506 out:
 507         drm_gem_object_put(obj);
 508 out_unlock:
 509         mutex_unlock(&file_priv->prime.lock);
 510
 511         return ret;
 512 }
 513 EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
 514
 515 int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
 516                                  struct drm_file *file_priv)
 517 {
 518         struct drm_prime_handle *args = data;
 519
 520         if (!dev->driver->prime_handle_to_fd)
 521                 return -ENOSYS;
 522
 523         /* check flags are valid */
 524         if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
 525                 return -EINVAL;
 526
 527         return dev->driver->prime_handle_to_fd(dev, file_priv,
 528                         args->handle, args->flags, &args->fd);
 529 }
 530
 531 /**
 532  * DOC: PRIME Helpers
 533  *
 534  * Drivers can implement &drm_gem_object_funcs.export and
 535  * &drm_driver.gem_prime_import in terms of simpler APIs by using the helper
 536  * functions drm_gem_prime_export() and drm_gem_prime_import(). These functions
 537  * implement dma-buf support in terms of some lower-level helpers, which are
 538  * again exported for drivers to use individually:
 539  *
 540  * Exporting buffers
 541  * ~~~~~~~~~~~~~~~~~
 542  *
 543  * Optional pinning of buffers is handled at dma-buf attach and detach time in
 544  * drm_gem_map_attach() and drm_gem_map_detach(). Backing storage itself is
 545  * handled by drm_gem_map_dma_buf() and drm_gem_unmap_dma_buf(), which relies on
 546  * &drm_gem_object_funcs.get_sg_table.
 547  *
 548  * For kernel-internal access there's drm_gem_dmabuf_vmap() and
 549  * drm_gem_dmabuf_vunmap(). Userspace mmap support is provided by
 550  * drm_gem_dmabuf_mmap().
 551  *
 552  * Note that these export helpers can only be used if the underlying backing
 553  * storage is fully coherent and either permanently pinned, or it is safe to pin
 554  * it indefinitely.
 555  *
 556  * FIXME: The underlying helper functions are named rather inconsistently.
 557  *
 558  * Exporting buffers
 559  * ~~~~~~~~~~~~~~~~~
 560  *
 561  * Importing dma-bufs using drm_gem_prime_import() relies on
 562  * &drm_driver.gem_prime_import_sg_table.
 563  *
 564  * Note that similarly to the export helpers this permanently pins the
 565  * underlying backing storage. Which is ok for scanout, but is not the best
 566  * option for sharing lots of buffers for rendering.
 567  */
 568
 569 /**
 570  * drm_gem_map_attach - dma_buf attach implementation for GEM
 571  * @dma_buf: buffer to attach device to
 572  * @attach: buffer attachment data
 573  *
 574  * Calls &drm_gem_object_funcs.pin for device specific handling. This can be
 575  * used as the &dma_buf_ops.attach callback. Must be used together with
 576  * drm_gem_map_detach().
 577  *
 578  * Returns 0 on success, negative error code on failure.
 579  */
 580 int drm_gem_map_attach(struct dma_buf *dma_buf,
 581                        struct dma_buf_attachment *attach)
 582 {
 583         struct drm_gem_object *obj = dma_buf->priv;
 584
 585         return drm_gem_pin(obj);
 586 }
 587 EXPORT_SYMBOL(drm_gem_map_attach);
 588
 589 /**
 590  * drm_gem_map_detach - dma_buf detach implementation for GEM
 591  * @dma_buf: buffer to detach from
 592  * @attach: attachment to be detached
 593  *
 594  * Calls &drm_gem_object_funcs.pin for device specific handling.  Cleans up
 595  * &dma_buf_attachment from drm_gem_map_attach(). This can be used as the
 596  * &dma_buf_ops.detach callback.
 597  */
 598 void drm_gem_map_detach(struct dma_buf *dma_buf,
 599                         struct dma_buf_attachment *attach)
 600 {
 601         struct drm_gem_object *obj = dma_buf->priv;
 602
 603         drm_gem_unpin(obj);
 604 }
 605 EXPORT_SYMBOL(drm_gem_map_detach);
 606
 607 /**
 608  * drm_gem_map_dma_buf - map_dma_buf implementation for GEM
 609  * @attach: attachment whose scatterlist is to be returned
 610  * @dir: direction of DMA transfer
 611  *
 612  * Calls &drm_gem_object_funcs.get_sg_table and then maps the scatterlist. This
 613  * can be used as the &dma_buf_ops.map_dma_buf callback. Should be used together
 614  * with drm_gem_unmap_dma_buf().
 615  *
 616  * Returns:sg_table containing the scatterlist to be returned; returns ERR_PTR
 617  * on error. May return -EINTR if it is interrupted by a signal.
 618  */
 619 struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
 620                                      enum dma_data_direction dir)
 621 {
 622         struct drm_gem_object *obj = attach->dmabuf->priv;
 623         struct sg_table *sgt;
 624         int ret;
 625
 626         if (WARN_ON(dir == DMA_NONE))
 627                 return ERR_PTR(-EINVAL);
 628
 629         if (obj->funcs)
 630                 sgt = obj->funcs->get_sg_table(obj);
 631         else
 632                 sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
 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  *
 671  * Sets up a kernel virtual mapping. This can be used as the &dma_buf_ops.vmap
 672  * callback. Calls into &drm_gem_object_funcs.vmap for device specific handling.
 673  *
 674  * Returns the kernel virtual address or NULL on failure.
 675  */
 676 void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
 677 {
 678         struct drm_gem_object *obj = dma_buf->priv;
 679         void *vaddr;
 680
 681         vaddr = drm_gem_vmap(obj);
 682         if (IS_ERR(vaddr))
 683                 vaddr = NULL;
 684
 685         return vaddr;
 686 }
 687 EXPORT_SYMBOL(drm_gem_dmabuf_vmap);
 688
 689 /**
 690  * drm_gem_dmabuf_vunmap - dma_buf vunmap implementation for GEM
 691  * @dma_buf: buffer to be unmapped
 692  * @vaddr: the virtual address of the buffer
 693  *
 694  * Releases a kernel virtual mapping. This can be used as the
 695  * &dma_buf_ops.vunmap callback. Calls into &drm_gem_object_funcs.vunmap for device specific handling.
 696  */
 697 void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
 698 {
 699         struct drm_gem_object *obj = dma_buf->priv;
 700
 701         drm_gem_vunmap(obj, vaddr);
 702 }
 703 EXPORT_SYMBOL(drm_gem_dmabuf_vunmap);
 704
 705 /**
 706  * drm_gem_prime_mmap - PRIME mmap function for GEM drivers
 707  * @obj: GEM object
 708  * @vma: Virtual address range
 709  *
 710  * This function sets up a userspace mapping for PRIME exported buffers using
 711  * the same codepath that is used for regular GEM buffer mapping on the DRM fd.
 712  * The fake GEM offset is added to vma->vm_pgoff and &drm_driver->fops->mmap is
 713  * called to set up the mapping.
 714  *
 715  * Drivers can use this as their &drm_driver.gem_prime_mmap callback.
 716  */
 717 int drm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
 718 {
 719         struct drm_file *priv;
 720         struct file *fil;
 721         int ret;
 722
 723         /* Add the fake offset */
 724         vma->vm_pgoff += drm_vma_node_start(&obj->vma_node);
 725
 726         if (obj->funcs && obj->funcs->mmap) {
 727                 ret = obj->funcs->mmap(obj, vma);
 728                 if (ret)
 729                         return ret;
 730                 vma->vm_private_data = obj;
 731                 drm_gem_object_get(obj);
 732                 return 0;
 733         }
 734
 735         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 736         fil = kzalloc(sizeof(*fil), GFP_KERNEL);
 737         if (!priv || !fil) {
 738                 ret = -ENOMEM;
 739                 goto out;
 740         }
 741
 742         /* Used by drm_gem_mmap() to lookup the GEM object */
 743         priv->minor = obj->dev->primary;
 744         fil->private_data = priv;
 745
 746         ret = drm_vma_node_allow(&obj->vma_node, priv);
 747         if (ret)
 748                 goto out;
 749
 750         ret = obj->dev->driver->fops->mmap(fil, vma);
 751
 752         drm_vma_node_revoke(&obj->vma_node, priv);
 753 out:
 754         kfree(priv);
 755         kfree(fil);
 756
 757         return ret;
 758 }
 759 EXPORT_SYMBOL(drm_gem_prime_mmap);
 760
 761 /**
 762  * drm_gem_dmabuf_mmap - dma_buf mmap implementation for GEM
 763  * @dma_buf: buffer to be mapped
 764  * @vma: virtual address range
 765  *
 766  * Provides memory mapping for the buffer. This can be used as the
 767  * &dma_buf_ops.mmap callback. It just forwards to &drm_driver.gem_prime_mmap,
 768  * which should be set to drm_gem_prime_mmap().
 769  *
 770  * FIXME: There's really no point to this wrapper, drivers which need anything
 771  * else but drm_gem_prime_mmap can roll their own &dma_buf_ops.mmap callback.
 772  *
 773  * Returns 0 on success or a negative error code on failure.
 774  */
 775 int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf, struct vm_area_struct *vma)
 776 {
 777         struct drm_gem_object *obj = dma_buf->priv;
 778         struct drm_device *dev = obj->dev;
 779
 780         if (!dev->driver->gem_prime_mmap)
 781                 return -ENOSYS;
 782
 783         return dev->driver->gem_prime_mmap(obj, vma);
 784 }
 785 EXPORT_SYMBOL(drm_gem_dmabuf_mmap);
 786
 787 static const struct dma_buf_ops drm_gem_prime_dmabuf_ops =  {
 788         .cache_sgt_mapping = true,
 789         .attach = drm_gem_map_attach,
 790         .detach = drm_gem_map_detach,
 791         .map_dma_buf = drm_gem_map_dma_buf,
 792         .unmap_dma_buf = drm_gem_unmap_dma_buf,
 793         .release = drm_gem_dmabuf_release,
 794         .mmap = drm_gem_dmabuf_mmap,
 795         .vmap = drm_gem_dmabuf_vmap,
 796         .vunmap = drm_gem_dmabuf_vunmap,
 797 };
 798
 799 /**
 800  * drm_prime_pages_to_sg - converts a page array into an sg list
 801  * @dev: DRM device
 802  * @pages: pointer to the array of page pointers to convert
 803  * @nr_pages: length of the page vector
 804  *
 805  * This helper creates an sg table object from a set of pages
 806  * the driver is responsible for mapping the pages into the
 807  * importers address space for use with dma_buf itself.
 808  *
 809  * This is useful for implementing &drm_gem_object_funcs.get_sg_table.
 810  */
 811 struct sg_table *drm_prime_pages_to_sg(struct drm_device *dev,
 812                                        struct page **pages, unsigned int nr_pages)
 813 {
 814         struct sg_table *sg;
 815         struct scatterlist *sge;
 816         size_t max_segment = 0;
 817
 818         sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
 819         if (!sg)
 820                 return ERR_PTR(-ENOMEM);
 821
 822         if (dev)
 823                 max_segment = dma_max_mapping_size(dev->dev);
 824         if (max_segment == 0 || max_segment > SCATTERLIST_MAX_SEGMENT)
 825                 max_segment = SCATTERLIST_MAX_SEGMENT;
 826         sge = __sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
 827                                           nr_pages << PAGE_SHIFT,
 828                                           max_segment,
 829                                           NULL, 0, GFP_KERNEL);
 830         if (IS_ERR(sge)) {
 831                 kfree(sg);
 832                 sg = ERR_CAST(sge);
 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_addr_arrays - convert an sg table into a page array
 989  * @sgt: scatter-gather table to convert
 990  * @pages: optional array of page pointers to store the page array in
 991  * @addrs: optional array to store the dma bus address of each page
 992  * @max_entries: size of both the passed-in arrays
 993  *
 994  * Exports an sg table into an array of pages and addresses. This is currently
 995  * required by the TTM driver in order to do correct fault handling.
 996  *
 997  * Drivers can use this in their &drm_driver.gem_prime_import_sg_table
 998  * implementation.
 999  */
1000 int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1001                                      dma_addr_t *addrs, int max_entries)
1002 {
1003         struct sg_dma_page_iter dma_iter;
1004         struct sg_page_iter page_iter;
1005         struct page **p = pages;
1006         dma_addr_t *a = addrs;
1007
1008         if (pages) {
1009                 for_each_sgtable_page(sgt, &page_iter, 0) {
1010                         if (WARN_ON(p - pages >= max_entries))
1011                                 return -1;
1012                         *p++ = sg_page_iter_page(&page_iter);
1013                 }
1014         }
1015         if (addrs) {
1016                 for_each_sgtable_dma_page(sgt, &dma_iter, 0) {
1017                         if (WARN_ON(a - addrs >= max_entries))
1018                                 return -1;
1019                         *a++ = sg_page_iter_dma_address(&dma_iter);
1020                 }
1021         }
1022
1023         return 0;
1024 }
1025 EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
1026
1027 /**
1028  * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
1029  * @obj: GEM object which was created from a dma-buf
1030  * @sg: the sg-table which was pinned at import time
1031  *
1032  * This is the cleanup functions which GEM drivers need to call when they use
1033  * drm_gem_prime_import() or drm_gem_prime_import_dev() to import dma-bufs.
1034  */
1035 void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
1036 {
1037         struct dma_buf_attachment *attach;
1038         struct dma_buf *dma_buf;
1039
1040         attach = obj->import_attach;
1041         if (sg)
1042                 dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
1043         dma_buf = attach->dmabuf;
1044         dma_buf_detach(attach->dmabuf, attach);
1045         /* remove the reference */
1046         dma_buf_put(dma_buf);
1047 }
1048 EXPORT_SYMBOL(drm_prime_gem_destroy);