drivers/gpu/drm/i915/i915_gem_userptr.c

   1 /*
   2  * Copyright © 2012-2014 Intel Corporation
   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  */
  24
  25 #include <drm/drmP.h>
  26 #include <drm/i915_drm.h>
  27 #include "i915_drv.h"
  28 #include "i915_trace.h"
  29 #include "intel_drv.h"
  30 #include <linux/mmu_context.h>
  31 #include <linux/mmu_notifier.h>
  32 #include <linux/mempolicy.h>
  33 #include <linux/swap.h>
  34 #include <linux/sched/mm.h>
  35
  36 struct i915_mm_struct {
  37         struct mm_struct *mm;
  38         struct drm_i915_private *i915;
  39         struct i915_mmu_notifier *mn;
  40         struct hlist_node node;
  41         struct kref kref;
  42         struct work_struct work;
  43 };
  44
  45 #if defined(CONFIG_MMU_NOTIFIER)
  46 #include <linux/interval_tree.h>
  47
  48 struct i915_mmu_notifier {
  49         spinlock_t lock;
  50         struct hlist_node node;
  51         struct mmu_notifier mn;
  52         struct rb_root_cached objects;
  53         struct workqueue_struct *wq;
  54 };
  55
  56 struct i915_mmu_object {
  57         struct i915_mmu_notifier *mn;
  58         struct drm_i915_gem_object *obj;
  59         struct interval_tree_node it;
  60         struct list_head link;
  61         struct work_struct work;
  62         bool attached;
  63 };
  64
  65 static void cancel_userptr(struct work_struct *work)
  66 {
  67         struct i915_mmu_object *mo = container_of(work, typeof(*mo), work);
  68         struct drm_i915_gem_object *obj = mo->obj;
  69         struct work_struct *active;
  70
  71         /* Cancel any active worker and force us to re-evaluate gup */
  72         mutex_lock(&obj->mm.lock);
  73         active = fetch_and_zero(&obj->userptr.work);
  74         mutex_unlock(&obj->mm.lock);
  75         if (active)
  76                 goto out;
  77
  78         i915_gem_object_wait(obj, I915_WAIT_ALL, MAX_SCHEDULE_TIMEOUT, NULL);
  79
  80         mutex_lock(&obj->base.dev->struct_mutex);
  81
  82         /* We are inside a kthread context and can't be interrupted */
  83         if (i915_gem_object_unbind(obj) == 0)
  84                 __i915_gem_object_put_pages(obj, I915_MM_NORMAL);
  85         WARN_ONCE(obj->mm.pages,
  86                   "Failed to release pages: bind_count=%d, pages_pin_count=%d, pin_display=%d\n",
  87                   obj->bind_count,
  88                   atomic_read(&obj->mm.pages_pin_count),
  89                   obj->pin_display);
  90
  91         mutex_unlock(&obj->base.dev->struct_mutex);
  92
  93 out:
  94         i915_gem_object_put(obj);
  95 }
  96
  97 static void add_object(struct i915_mmu_object *mo)
  98 {
  99         if (mo->attached)
 100                 return;
 101
 102         interval_tree_insert(&mo->it, &mo->mn->objects);
 103         mo->attached = true;
 104 }
 105
 106 static void del_object(struct i915_mmu_object *mo)
 107 {
 108         if (!mo->attached)
 109                 return;
 110
 111         interval_tree_remove(&mo->it, &mo->mn->objects);
 112         mo->attached = false;
 113 }
 114
 115 static void i915_gem_userptr_mn_invalidate_range_start(struct mmu_notifier *_mn,
 116                                                        struct mm_struct *mm,
 117                                                        unsigned long start,
 118                                                        unsigned long end)
 119 {
 120         struct i915_mmu_notifier *mn =
 121                 container_of(_mn, struct i915_mmu_notifier, mn);
 122         struct i915_mmu_object *mo;
 123         struct interval_tree_node *it;
 124         LIST_HEAD(cancelled);
 125
 126         if (RB_EMPTY_ROOT(&mn->objects.rb_root))
 127                 return;
 128
 129         /* interval ranges are inclusive, but invalidate range is exclusive */
 130         end--;
 131
 132         spin_lock(&mn->lock);
 133         it = interval_tree_iter_first(&mn->objects, start, end);
 134         while (it) {
 135                 /* The mmu_object is released late when destroying the
 136                  * GEM object so it is entirely possible to gain a
 137                  * reference on an object in the process of being freed
 138                  * since our serialisation is via the spinlock and not
 139                  * the struct_mutex - and consequently use it after it
 140                  * is freed and then double free it. To prevent that
 141                  * use-after-free we only acquire a reference on the
 142                  * object if it is not in the process of being destroyed.
 143                  */
 144                 mo = container_of(it, struct i915_mmu_object, it);
 145                 if (kref_get_unless_zero(&mo->obj->base.refcount))
 146                         queue_work(mn->wq, &mo->work);
 147
 148                 list_add(&mo->link, &cancelled);
 149                 it = interval_tree_iter_next(it, start, end);
 150         }
 151         list_for_each_entry(mo, &cancelled, link)
 152                 del_object(mo);
 153         spin_unlock(&mn->lock);
 154
 155         if (!list_empty(&cancelled))
 156                 flush_workqueue(mn->wq);
 157 }
 158
 159 static const struct mmu_notifier_ops i915_gem_userptr_notifier = {
 160         .invalidate_range_start = i915_gem_userptr_mn_invalidate_range_start,
 161 };
 162
 163 static struct i915_mmu_notifier *
 164 i915_mmu_notifier_create(struct mm_struct *mm)
 165 {
 166         struct i915_mmu_notifier *mn;
 167
 168         mn = kmalloc(sizeof(*mn), GFP_KERNEL);
 169         if (mn == NULL)
 170                 return ERR_PTR(-ENOMEM);
 171
 172         spin_lock_init(&mn->lock);
 173         mn->mn.ops = &i915_gem_userptr_notifier;
 174         mn->objects = RB_ROOT_CACHED;
 175         mn->wq = alloc_workqueue("i915-userptr-release", WQ_UNBOUND, 0);
 176         if (mn->wq == NULL) {
 177                 kfree(mn);
 178                 return ERR_PTR(-ENOMEM);
 179         }
 180
 181         return mn;
 182 }
 183
 184 static void
 185 i915_gem_userptr_release__mmu_notifier(struct drm_i915_gem_object *obj)
 186 {
 187         struct i915_mmu_object *mo;
 188
 189         mo = obj->userptr.mmu_object;
 190         if (mo == NULL)
 191                 return;
 192
 193         spin_lock(&mo->mn->lock);
 194         del_object(mo);
 195         spin_unlock(&mo->mn->lock);
 196         kfree(mo);
 197
 198         obj->userptr.mmu_object = NULL;
 199 }
 200
 201 static struct i915_mmu_notifier *
 202 i915_mmu_notifier_find(struct i915_mm_struct *mm)
 203 {
 204         struct i915_mmu_notifier *mn;
 205         int err = 0;
 206
 207         mn = mm->mn;
 208         if (mn)
 209                 return mn;
 210
 211         mn = i915_mmu_notifier_create(mm->mm);
 212         if (IS_ERR(mn))
 213                 err = PTR_ERR(mn);
 214
 215         down_write(&mm->mm->mmap_sem);
 216         mutex_lock(&mm->i915->mm_lock);
 217         if (mm->mn == NULL && !err) {
 218                 /* Protected by mmap_sem (write-lock) */
 219                 err = __mmu_notifier_register(&mn->mn, mm->mm);
 220                 if (!err) {
 221                         /* Protected by mm_lock */
 222                         mm->mn = fetch_and_zero(&mn);
 223                 }
 224         } else {
 225                 /* someone else raced and successfully installed the mmu
 226                  * notifier, we can cancel our own errors */
 227                 err = 0;
 228         }
 229         mutex_unlock(&mm->i915->mm_lock);
 230         up_write(&mm->mm->mmap_sem);
 231
 232         if (mn) {
 233                 destroy_workqueue(mn->wq);
 234                 kfree(mn);
 235         }
 236
 237         return err ? ERR_PTR(err) : mm->mn;
 238 }
 239
 240 static int
 241 i915_gem_userptr_init__mmu_notifier(struct drm_i915_gem_object *obj,
 242                                     unsigned flags)
 243 {
 244         struct i915_mmu_notifier *mn;
 245         struct i915_mmu_object *mo;
 246
 247         if (flags & I915_USERPTR_UNSYNCHRONIZED)
 248                 return capable(CAP_SYS_ADMIN) ? 0 : -EPERM;
 249
 250         if (WARN_ON(obj->userptr.mm == NULL))
 251                 return -EINVAL;
 252
 253         mn = i915_mmu_notifier_find(obj->userptr.mm);
 254         if (IS_ERR(mn))
 255                 return PTR_ERR(mn);
 256
 257         mo = kzalloc(sizeof(*mo), GFP_KERNEL);
 258         if (mo == NULL)
 259                 return -ENOMEM;
 260
 261         mo->mn = mn;
 262         mo->obj = obj;
 263         mo->it.start = obj->userptr.ptr;
 264         mo->it.last = obj->userptr.ptr + obj->base.size - 1;
 265         INIT_WORK(&mo->work, cancel_userptr);
 266
 267         obj->userptr.mmu_object = mo;
 268         return 0;
 269 }
 270
 271 static void
 272 i915_mmu_notifier_free(struct i915_mmu_notifier *mn,
 273                        struct mm_struct *mm)
 274 {
 275         if (mn == NULL)
 276                 return;
 277
 278         mmu_notifier_unregister(&mn->mn, mm);
 279         destroy_workqueue(mn->wq);
 280         kfree(mn);
 281 }
 282
 283 #else
 284
 285 static void
 286 i915_gem_userptr_release__mmu_notifier(struct drm_i915_gem_object *obj)
 287 {
 288 }
 289
 290 static int
 291 i915_gem_userptr_init__mmu_notifier(struct drm_i915_gem_object *obj,
 292                                     unsigned flags)
 293 {
 294         if ((flags & I915_USERPTR_UNSYNCHRONIZED) == 0)
 295                 return -ENODEV;
 296
 297         if (!capable(CAP_SYS_ADMIN))
 298                 return -EPERM;
 299
 300         return 0;
 301 }
 302
 303 static void
 304 i915_mmu_notifier_free(struct i915_mmu_notifier *mn,
 305                        struct mm_struct *mm)
 306 {
 307 }
 308
 309 #endif
 310
 311 static struct i915_mm_struct *
 312 __i915_mm_struct_find(struct drm_i915_private *dev_priv, struct mm_struct *real)
 313 {
 314         struct i915_mm_struct *mm;
 315
 316         /* Protected by dev_priv->mm_lock */
 317         hash_for_each_possible(dev_priv->mm_structs, mm, node, (unsigned long)real)
 318                 if (mm->mm == real)
 319                         return mm;
 320
 321         return NULL;
 322 }
 323
 324 static int
 325 i915_gem_userptr_init__mm_struct(struct drm_i915_gem_object *obj)
 326 {
 327         struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
 328         struct i915_mm_struct *mm;
 329         int ret = 0;
 330
 331         /* During release of the GEM object we hold the struct_mutex. This
 332          * precludes us from calling mmput() at that time as that may be
 333          * the last reference and so call exit_mmap(). exit_mmap() will
 334          * attempt to reap the vma, and if we were holding a GTT mmap
 335          * would then call drm_gem_vm_close() and attempt to reacquire
 336          * the struct mutex. So in order to avoid that recursion, we have
 337          * to defer releasing the mm reference until after we drop the
 338          * struct_mutex, i.e. we need to schedule a worker to do the clean
 339          * up.
 340          */
 341         mutex_lock(&dev_priv->mm_lock);
 342         mm = __i915_mm_struct_find(dev_priv, current->mm);
 343         if (mm == NULL) {
 344                 mm = kmalloc(sizeof(*mm), GFP_KERNEL);
 345                 if (mm == NULL) {
 346                         ret = -ENOMEM;
 347                         goto out;
 348                 }
 349
 350                 kref_init(&mm->kref);
 351                 mm->i915 = to_i915(obj->base.dev);
 352
 353                 mm->mm = current->mm;
 354                 mmgrab(current->mm);
 355
 356                 mm->mn = NULL;
 357
 358                 /* Protected by dev_priv->mm_lock */
 359                 hash_add(dev_priv->mm_structs,
 360                          &mm->node, (unsigned long)mm->mm);
 361         } else
 362                 kref_get(&mm->kref);
 363
 364         obj->userptr.mm = mm;
 365 out:
 366         mutex_unlock(&dev_priv->mm_lock);
 367         return ret;
 368 }
 369
 370 static void
 371 __i915_mm_struct_free__worker(struct work_struct *work)
 372 {
 373         struct i915_mm_struct *mm = container_of(work, typeof(*mm), work);
 374         i915_mmu_notifier_free(mm->mn, mm->mm);
 375         mmdrop(mm->mm);
 376         kfree(mm);
 377 }
 378
 379 static void
 380 __i915_mm_struct_free(struct kref *kref)
 381 {
 382         struct i915_mm_struct *mm = container_of(kref, typeof(*mm), kref);
 383
 384         /* Protected by dev_priv->mm_lock */
 385         hash_del(&mm->node);
 386         mutex_unlock(&mm->i915->mm_lock);
 387
 388         INIT_WORK(&mm->work, __i915_mm_struct_free__worker);
 389         queue_work(mm->i915->mm.userptr_wq, &mm->work);
 390 }
 391
 392 static void
 393 i915_gem_userptr_release__mm_struct(struct drm_i915_gem_object *obj)
 394 {
 395         if (obj->userptr.mm == NULL)
 396                 return;
 397
 398         kref_put_mutex(&obj->userptr.mm->kref,
 399                        __i915_mm_struct_free,
 400                        &to_i915(obj->base.dev)->mm_lock);
 401         obj->userptr.mm = NULL;
 402 }
 403
 404 struct get_pages_work {
 405         struct work_struct work;
 406         struct drm_i915_gem_object *obj;
 407         struct task_struct *task;
 408 };
 409
 410 static struct sg_table *
 411 __i915_gem_userptr_alloc_pages(struct drm_i915_gem_object *obj,
 412                                struct page **pvec, int num_pages)
 413 {
 414         unsigned int max_segment = i915_sg_segment_size();
 415         struct sg_table *st;
 416         unsigned int sg_page_sizes;
 417         int ret;
 418
 419         st = kmalloc(sizeof(*st), GFP_KERNEL);
 420         if (!st)
 421                 return ERR_PTR(-ENOMEM);
 422
 423 alloc_table:
 424         ret = __sg_alloc_table_from_pages(st, pvec, num_pages,
 425                                           0, num_pages << PAGE_SHIFT,
 426                                           max_segment,
 427                                           GFP_KERNEL);
 428         if (ret) {
 429                 kfree(st);
 430                 return ERR_PTR(ret);
 431         }
 432
 433         ret = i915_gem_gtt_prepare_pages(obj, st);
 434         if (ret) {
 435                 sg_free_table(st);
 436
 437                 if (max_segment > PAGE_SIZE) {
 438                         max_segment = PAGE_SIZE;
 439                         goto alloc_table;
 440                 }
 441
 442                 kfree(st);
 443                 return ERR_PTR(ret);
 444         }
 445
 446         sg_page_sizes = i915_sg_page_sizes(st->sgl);
 447
 448         __i915_gem_object_set_pages(obj, st, sg_page_sizes);
 449
 450         return st;
 451 }
 452
 453 static int
 454 __i915_gem_userptr_set_active(struct drm_i915_gem_object *obj,
 455                               bool value)
 456 {
 457         int ret = 0;
 458
 459         /* During mm_invalidate_range we need to cancel any userptr that
 460          * overlaps the range being invalidated. Doing so requires the
 461          * struct_mutex, and that risks recursion. In order to cause
 462          * recursion, the user must alias the userptr address space with
 463          * a GTT mmapping (possible with a MAP_FIXED) - then when we have
 464          * to invalidate that mmaping, mm_invalidate_range is called with
 465          * the userptr address *and* the struct_mutex held.  To prevent that
 466          * we set a flag under the i915_mmu_notifier spinlock to indicate
 467          * whether this object is valid.
 468          */
 469 #if defined(CONFIG_MMU_NOTIFIER)
 470         if (obj->userptr.mmu_object == NULL)
 471                 return 0;
 472
 473         spin_lock(&obj->userptr.mmu_object->mn->lock);
 474         /* In order to serialise get_pages with an outstanding
 475          * cancel_userptr, we must drop the struct_mutex and try again.
 476          */
 477         if (!value)
 478                 del_object(obj->userptr.mmu_object);
 479         else if (!work_pending(&obj->userptr.mmu_object->work))
 480                 add_object(obj->userptr.mmu_object);
 481         else
 482                 ret = -EAGAIN;
 483         spin_unlock(&obj->userptr.mmu_object->mn->lock);
 484 #endif
 485
 486         return ret;
 487 }
 488
 489 static void
 490 __i915_gem_userptr_get_pages_worker(struct work_struct *_work)
 491 {
 492         struct get_pages_work *work = container_of(_work, typeof(*work), work);
 493         struct drm_i915_gem_object *obj = work->obj;
 494         const int npages = obj->base.size >> PAGE_SHIFT;
 495         struct page **pvec;
 496         int pinned, ret;
 497
 498         ret = -ENOMEM;
 499         pinned = 0;
 500
 501         pvec = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
 502         if (pvec != NULL) {
 503                 struct mm_struct *mm = obj->userptr.mm->mm;
 504                 unsigned int flags = 0;
 505
 506                 if (!obj->userptr.read_only)
 507                         flags |= FOLL_WRITE;
 508
 509                 ret = -EFAULT;
 510                 if (mmget_not_zero(mm)) {
 511                         down_read(&mm->mmap_sem);
 512                         while (pinned < npages) {
 513                                 ret = get_user_pages_remote
 514                                         (work->task, mm,
 515                                          obj->userptr.ptr + pinned * PAGE_SIZE,
 516                                          npages - pinned,
 517                                          flags,
 518                                          pvec + pinned, NULL, NULL);
 519                                 if (ret < 0)
 520                                         break;
 521
 522                                 pinned += ret;
 523                         }
 524                         up_read(&mm->mmap_sem);
 525                         mmput(mm);
 526                 }
 527         }
 528
 529         mutex_lock(&obj->mm.lock);
 530         if (obj->userptr.work == &work->work) {
 531                 struct sg_table *pages = ERR_PTR(ret);
 532
 533                 if (pinned == npages) {
 534                         pages = __i915_gem_userptr_alloc_pages(obj, pvec,
 535                                                                npages);
 536                         if (!IS_ERR(pages)) {
 537                                 pinned = 0;
 538                                 pages = NULL;
 539                         }
 540                 }
 541
 542                 obj->userptr.work = ERR_CAST(pages);
 543                 if (IS_ERR(pages))
 544                         __i915_gem_userptr_set_active(obj, false);
 545         }
 546         mutex_unlock(&obj->mm.lock);
 547
 548         release_pages(pvec, pinned, 0);
 549         kvfree(pvec);
 550
 551         i915_gem_object_put(obj);
 552         put_task_struct(work->task);
 553         kfree(work);
 554 }
 555
 556 static struct sg_table *
 557 __i915_gem_userptr_get_pages_schedule(struct drm_i915_gem_object *obj)
 558 {
 559         struct get_pages_work *work;
 560
 561         /* Spawn a worker so that we can acquire the
 562          * user pages without holding our mutex. Access
 563          * to the user pages requires mmap_sem, and we have
 564          * a strict lock ordering of mmap_sem, struct_mutex -
 565          * we already hold struct_mutex here and so cannot
 566          * call gup without encountering a lock inversion.
 567          *
 568          * Userspace will keep on repeating the operation
 569          * (thanks to EAGAIN) until either we hit the fast
 570          * path or the worker completes. If the worker is
 571          * cancelled or superseded, the task is still run
 572          * but the results ignored. (This leads to
 573          * complications that we may have a stray object
 574          * refcount that we need to be wary of when
 575          * checking for existing objects during creation.)
 576          * If the worker encounters an error, it reports
 577          * that error back to this function through
 578          * obj->userptr.work = ERR_PTR.
 579          */
 580         work = kmalloc(sizeof(*work), GFP_KERNEL);
 581         if (work == NULL)
 582                 return ERR_PTR(-ENOMEM);
 583
 584         obj->userptr.work = &work->work;
 585
 586         work->obj = i915_gem_object_get(obj);
 587
 588         work->task = current;
 589         get_task_struct(work->task);
 590
 591         INIT_WORK(&work->work, __i915_gem_userptr_get_pages_worker);
 592         queue_work(to_i915(obj->base.dev)->mm.userptr_wq, &work->work);
 593
 594         return ERR_PTR(-EAGAIN);
 595 }
 596
 597 static int i915_gem_userptr_get_pages(struct drm_i915_gem_object *obj)
 598 {
 599         const int num_pages = obj->base.size >> PAGE_SHIFT;
 600         struct mm_struct *mm = obj->userptr.mm->mm;
 601         struct page **pvec;
 602         struct sg_table *pages;
 603         bool active;
 604         int pinned;
 605
 606         /* If userspace should engineer that these pages are replaced in
 607          * the vma between us binding this page into the GTT and completion
 608          * of rendering... Their loss. If they change the mapping of their
 609          * pages they need to create a new bo to point to the new vma.
 610          *
 611          * However, that still leaves open the possibility of the vma
 612          * being copied upon fork. Which falls under the same userspace
 613          * synchronisation issue as a regular bo, except that this time
 614          * the process may not be expecting that a particular piece of
 615          * memory is tied to the GPU.
 616          *
 617          * Fortunately, we can hook into the mmu_notifier in order to
 618          * discard the page references prior to anything nasty happening
 619          * to the vma (discard or cloning) which should prevent the more
 620          * egregious cases from causing harm.
 621          */
 622
 623         if (obj->userptr.work) {
 624                 /* active flag should still be held for the pending work */
 625                 if (IS_ERR(obj->userptr.work))
 626                         return PTR_ERR(obj->userptr.work);
 627                 else
 628                         return -EAGAIN;
 629         }
 630
 631         pvec = NULL;
 632         pinned = 0;
 633
 634         if (mm == current->mm) {
 635                 pvec = kvmalloc_array(num_pages, sizeof(struct page *),
 636                                       GFP_KERNEL |
 637                                       __GFP_NORETRY |
 638                                       __GFP_NOWARN);
 639                 if (pvec) /* defer to worker if malloc fails */
 640                         pinned = __get_user_pages_fast(obj->userptr.ptr,
 641                                                        num_pages,
 642                                                        !obj->userptr.read_only,
 643                                                        pvec);
 644         }
 645
 646         active = false;
 647         if (pinned < 0) {
 648                 pages = ERR_PTR(pinned);
 649                 pinned = 0;
 650         } else if (pinned < num_pages) {
 651                 pages = __i915_gem_userptr_get_pages_schedule(obj);
 652                 active = pages == ERR_PTR(-EAGAIN);
 653         } else {
 654                 pages = __i915_gem_userptr_alloc_pages(obj, pvec, num_pages);
 655                 active = !IS_ERR(pages);
 656         }
 657         if (active)
 658                 __i915_gem_userptr_set_active(obj, true);
 659
 660         if (IS_ERR(pages))
 661                 release_pages(pvec, pinned, 0);
 662         kvfree(pvec);
 663
 664         return PTR_ERR_OR_ZERO(pages);
 665 }
 666
 667 static void
 668 i915_gem_userptr_put_pages(struct drm_i915_gem_object *obj,
 669                            struct sg_table *pages)
 670 {
 671         struct sgt_iter sgt_iter;
 672         struct page *page;
 673
 674         BUG_ON(obj->userptr.work != NULL);
 675         __i915_gem_userptr_set_active(obj, false);
 676
 677         if (obj->mm.madv != I915_MADV_WILLNEED)
 678                 obj->mm.dirty = false;
 679
 680         i915_gem_gtt_finish_pages(obj, pages);
 681
 682         for_each_sgt_page(page, sgt_iter, pages) {
 683                 if (obj->mm.dirty)
 684                         set_page_dirty(page);
 685
 686                 mark_page_accessed(page);
 687                 put_page(page);
 688         }
 689         obj->mm.dirty = false;
 690
 691         sg_free_table(pages);
 692         kfree(pages);
 693 }
 694
 695 static void
 696 i915_gem_userptr_release(struct drm_i915_gem_object *obj)
 697 {
 698         i915_gem_userptr_release__mmu_notifier(obj);
 699         i915_gem_userptr_release__mm_struct(obj);
 700 }
 701
 702 static int
 703 i915_gem_userptr_dmabuf_export(struct drm_i915_gem_object *obj)
 704 {
 705         if (obj->userptr.mmu_object)
 706                 return 0;
 707
 708         return i915_gem_userptr_init__mmu_notifier(obj, 0);
 709 }
 710
 711 static const struct drm_i915_gem_object_ops i915_gem_userptr_ops = {
 712         .flags = I915_GEM_OBJECT_HAS_STRUCT_PAGE |
 713                  I915_GEM_OBJECT_IS_SHRINKABLE,
 714         .get_pages = i915_gem_userptr_get_pages,
 715         .put_pages = i915_gem_userptr_put_pages,
 716         .dmabuf_export = i915_gem_userptr_dmabuf_export,
 717         .release = i915_gem_userptr_release,
 718 };
 719
 720 /**
 721  * Creates a new mm object that wraps some normal memory from the process
 722  * context - user memory.
 723  *
 724  * We impose several restrictions upon the memory being mapped
 725  * into the GPU.
 726  * 1. It must be page aligned (both start/end addresses, i.e ptr and size).
 727  * 2. It must be normal system memory, not a pointer into another map of IO
 728  *    space (e.g. it must not be a GTT mmapping of another object).
 729  * 3. We only allow a bo as large as we could in theory map into the GTT,
 730  *    that is we limit the size to the total size of the GTT.
 731  * 4. The bo is marked as being snoopable. The backing pages are left
 732  *    accessible directly by the CPU, but reads and writes by the GPU may
 733  *    incur the cost of a snoop (unless you have an LLC architecture).
 734  *
 735  * Synchronisation between multiple users and the GPU is left to userspace
 736  * through the normal set-domain-ioctl. The kernel will enforce that the
 737  * GPU relinquishes the VMA before it is returned back to the system
 738  * i.e. upon free(), munmap() or process termination. However, the userspace
 739  * malloc() library may not immediately relinquish the VMA after free() and
 740  * instead reuse it whilst the GPU is still reading and writing to the VMA.
 741  * Caveat emptor.
 742  *
 743  * Also note, that the object created here is not currently a "first class"
 744  * object, in that several ioctls are banned. These are the CPU access
 745  * ioctls: mmap(), pwrite and pread. In practice, you are expected to use
 746  * direct access via your pointer rather than use those ioctls. Another
 747  * restriction is that we do not allow userptr surfaces to be pinned to the
 748  * hardware and so we reject any attempt to create a framebuffer out of a
 749  * userptr.
 750  *
 751  * If you think this is a good interface to use to pass GPU memory between
 752  * drivers, please use dma-buf instead. In fact, wherever possible use
 753  * dma-buf instead.
 754  */
 755 int
 756 i915_gem_userptr_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
 757 {
 758         struct drm_i915_private *dev_priv = to_i915(dev);
 759         struct drm_i915_gem_userptr *args = data;
 760         struct drm_i915_gem_object *obj;
 761         int ret;
 762         u32 handle;
 763
 764         if (!HAS_LLC(dev_priv) && !HAS_SNOOP(dev_priv)) {
 765                 /* We cannot support coherent userptr objects on hw without
 766                  * LLC and broken snooping.
 767                  */
 768                 return -ENODEV;
 769         }
 770
 771         if (args->flags & ~(I915_USERPTR_READ_ONLY |
 772                             I915_USERPTR_UNSYNCHRONIZED))
 773                 return -EINVAL;
 774
 775         if (offset_in_page(args->user_ptr | args->user_size))
 776                 return -EINVAL;
 777
 778         if (!access_ok(args->flags & I915_USERPTR_READ_ONLY ? VERIFY_READ : VERIFY_WRITE,
 779                        (char __user *)(unsigned long)args->user_ptr, args->user_size))
 780                 return -EFAULT;
 781
 782         if (args->flags & I915_USERPTR_READ_ONLY) {
 783                 /* On almost all of the current hw, we cannot tell the GPU that a
 784                  * page is readonly, so this is just a placeholder in the uAPI.
 785                  */
 786                 return -ENODEV;
 787         }
 788
 789         obj = i915_gem_object_alloc(dev_priv);
 790         if (obj == NULL)
 791                 return -ENOMEM;
 792
 793         drm_gem_private_object_init(dev, &obj->base, args->user_size);
 794         i915_gem_object_init(obj, &i915_gem_userptr_ops);
 795         obj->base.read_domains = I915_GEM_DOMAIN_CPU;
 796         obj->base.write_domain = I915_GEM_DOMAIN_CPU;
 797         i915_gem_object_set_cache_coherency(obj, I915_CACHE_LLC);
 798
 799         obj->userptr.ptr = args->user_ptr;
 800         obj->userptr.read_only = !!(args->flags & I915_USERPTR_READ_ONLY);
 801
 802         /* And keep a pointer to the current->mm for resolving the user pages
 803          * at binding. This means that we need to hook into the mmu_notifier
 804          * in order to detect if the mmu is destroyed.
 805          */
 806         ret = i915_gem_userptr_init__mm_struct(obj);
 807         if (ret == 0)
 808                 ret = i915_gem_userptr_init__mmu_notifier(obj, args->flags);
 809         if (ret == 0)
 810                 ret = drm_gem_handle_create(file, &obj->base, &handle);
 811
 812         /* drop reference from allocate - handle holds it now */
 813         i915_gem_object_put(obj);
 814         if (ret)
 815                 return ret;
 816
 817         args->handle = handle;
 818         return 0;
 819 }
 820
 821 int i915_gem_init_userptr(struct drm_i915_private *dev_priv)
 822 {
 823         mutex_init(&dev_priv->mm_lock);
 824         hash_init(dev_priv->mm_structs);
 825
 826         dev_priv->mm.userptr_wq =
 827                 alloc_workqueue("i915-userptr-acquire",
 828                                 WQ_HIGHPRI | WQ_MEM_RECLAIM,
 829                                 0);
 830         if (!dev_priv->mm.userptr_wq)
 831                 return -ENOMEM;
 832
 833         return 0;
 834 }
 835
 836 void i915_gem_cleanup_userptr(struct drm_i915_private *dev_priv)
 837 {
 838         destroy_workqueue(dev_priv->mm.userptr_wq);
 839 }