drivers/gpu/drm/drm_prime.c

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