blob: dc9bf5282071360a62fc25539ff8f0a1ebff1bc7 [file] [log] [blame]
Chris Wilson5cc9ed42014-05-16 14:22:37 +01001/*
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
Maarten Lankhorstb588c922015-05-13 09:56:00 +020025#include <drm/drmP.h>
26#include <drm/i915_drm.h>
Chris Wilson5cc9ed42014-05-16 14:22:37 +010027#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>
Ingo Molnar6e84f312017-02-08 18:51:29 +010034#include <linux/sched/mm.h>
Chris Wilson5cc9ed42014-05-16 14:22:37 +010035
Chris Wilsonad46cb52014-08-07 14:20:40 +010036struct i915_mm_struct {
37 struct mm_struct *mm;
Chris Wilsonf470b192016-04-05 15:00:01 +010038 struct drm_i915_private *i915;
Chris Wilsonad46cb52014-08-07 14:20:40 +010039 struct i915_mmu_notifier *mn;
40 struct hlist_node node;
41 struct kref kref;
42 struct work_struct work;
43};
44
Chris Wilson5cc9ed42014-05-16 14:22:37 +010045#if defined(CONFIG_MMU_NOTIFIER)
46#include <linux/interval_tree.h>
47
48struct i915_mmu_notifier {
49 spinlock_t lock;
50 struct hlist_node node;
51 struct mmu_notifier mn;
52 struct rb_root objects;
Chris Wilson393afc22016-04-05 14:59:59 +010053 struct workqueue_struct *wq;
Chris Wilson5cc9ed42014-05-16 14:22:37 +010054};
55
56struct i915_mmu_object {
Chris Wilsonad46cb52014-08-07 14:20:40 +010057 struct i915_mmu_notifier *mn;
Chris Wilson768e1592016-01-21 17:32:43 +000058 struct drm_i915_gem_object *obj;
Chris Wilson5cc9ed42014-05-16 14:22:37 +010059 struct interval_tree_node it;
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010060 struct list_head link;
Chris Wilson380996a2015-10-01 12:34:47 +010061 struct work_struct work;
Chris Wilson768e1592016-01-21 17:32:43 +000062 bool attached;
Chris Wilson5cc9ed42014-05-16 14:22:37 +010063};
64
Chris Wilson768e1592016-01-21 17:32:43 +000065static void cancel_userptr(struct work_struct *work)
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010066{
Chris Wilson380996a2015-10-01 12:34:47 +010067 struct i915_mmu_object *mo = container_of(work, typeof(*mo), work);
68 struct drm_i915_gem_object *obj = mo->obj;
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010069 struct drm_device *dev = obj->base.dev;
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010070
Chris Wilsone95433c2016-10-28 13:58:27 +010071 i915_gem_object_wait(obj, I915_WAIT_ALL, MAX_SCHEDULE_TIMEOUT, NULL);
Chris Wilson8a3b3d52016-08-05 10:14:08 +010072
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010073 mutex_lock(&dev->struct_mutex);
74 /* Cancel any active worker and force us to re-evaluate gup */
75 obj->userptr.work = NULL;
76
Chris Wilson03ac84f2016-10-28 13:58:36 +010077 /* We are inside a kthread context and can't be interrupted */
78 if (i915_gem_object_unbind(obj) == 0)
Chris Wilson548625e2016-11-01 12:11:34 +000079 __i915_gem_object_put_pages(obj, I915_MM_NORMAL);
Chris Wilson03ac84f2016-10-28 13:58:36 +010080 WARN_ONCE(obj->mm.pages,
81 "Failed to release pages: bind_count=%d, pages_pin_count=%d, pin_display=%d\n",
82 obj->bind_count,
Chris Wilson1233e2d2016-10-28 13:58:37 +010083 atomic_read(&obj->mm.pages_pin_count),
Chris Wilson03ac84f2016-10-28 13:58:36 +010084 obj->pin_display);
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010085
Chris Wilsonf8c417c2016-07-20 13:31:53 +010086 i915_gem_object_put(obj);
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010087 mutex_unlock(&dev->struct_mutex);
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010088}
89
Chris Wilson768e1592016-01-21 17:32:43 +000090static void add_object(struct i915_mmu_object *mo)
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010091{
Chris Wilson768e1592016-01-21 17:32:43 +000092 if (mo->attached)
93 return;
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010094
Chris Wilson768e1592016-01-21 17:32:43 +000095 interval_tree_insert(&mo->it, &mo->mn->objects);
96 mo->attached = true;
97}
Chris Wilsonec8b0dd2014-07-21 13:21:23 +010098
Chris Wilson768e1592016-01-21 17:32:43 +000099static void del_object(struct i915_mmu_object *mo)
100{
101 if (!mo->attached)
102 return;
103
104 interval_tree_remove(&mo->it, &mo->mn->objects);
105 mo->attached = false;
Chris Wilsonec8b0dd2014-07-21 13:21:23 +0100106}
107
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100108static void i915_gem_userptr_mn_invalidate_range_start(struct mmu_notifier *_mn,
109 struct mm_struct *mm,
110 unsigned long start,
111 unsigned long end)
112{
Chris Wilson380996a2015-10-01 12:34:47 +0100113 struct i915_mmu_notifier *mn =
114 container_of(_mn, struct i915_mmu_notifier, mn);
115 struct i915_mmu_object *mo;
Chris Wilson768e1592016-01-21 17:32:43 +0000116 struct interval_tree_node *it;
117 LIST_HEAD(cancelled);
118
119 if (RB_EMPTY_ROOT(&mn->objects))
120 return;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100121
Chris Wilson380996a2015-10-01 12:34:47 +0100122 /* interval ranges are inclusive, but invalidate range is exclusive */
123 end--;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100124
Chris Wilson380996a2015-10-01 12:34:47 +0100125 spin_lock(&mn->lock);
Chris Wilson768e1592016-01-21 17:32:43 +0000126 it = interval_tree_iter_first(&mn->objects, start, end);
127 while (it) {
128 /* The mmu_object is released late when destroying the
129 * GEM object so it is entirely possible to gain a
130 * reference on an object in the process of being freed
131 * since our serialisation is via the spinlock and not
132 * the struct_mutex - and consequently use it after it
133 * is freed and then double free it. To prevent that
134 * use-after-free we only acquire a reference on the
135 * object if it is not in the process of being destroyed.
136 */
137 mo = container_of(it, struct i915_mmu_object, it);
138 if (kref_get_unless_zero(&mo->obj->base.refcount))
Chris Wilson393afc22016-04-05 14:59:59 +0100139 queue_work(mn->wq, &mo->work);
Michał Winiarski460822b2015-02-03 15:48:17 +0100140
Chris Wilson768e1592016-01-21 17:32:43 +0000141 list_add(&mo->link, &cancelled);
142 it = interval_tree_iter_next(it, start, end);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100143 }
Chris Wilson768e1592016-01-21 17:32:43 +0000144 list_for_each_entry(mo, &cancelled, link)
145 del_object(mo);
Chris Wilson380996a2015-10-01 12:34:47 +0100146 spin_unlock(&mn->lock);
Chris Wilson393afc22016-04-05 14:59:59 +0100147
Chris Wilsond151e9c2017-03-07 20:58:50 +0000148 if (!list_empty(&cancelled))
149 flush_workqueue(mn->wq);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100150}
151
152static const struct mmu_notifier_ops i915_gem_userptr_notifier = {
153 .invalidate_range_start = i915_gem_userptr_mn_invalidate_range_start,
154};
155
156static struct i915_mmu_notifier *
Chris Wilsonad46cb52014-08-07 14:20:40 +0100157i915_mmu_notifier_create(struct mm_struct *mm)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100158{
Chris Wilsonad46cb52014-08-07 14:20:40 +0100159 struct i915_mmu_notifier *mn;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100160 int ret;
161
Chris Wilsonad46cb52014-08-07 14:20:40 +0100162 mn = kmalloc(sizeof(*mn), GFP_KERNEL);
163 if (mn == NULL)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100164 return ERR_PTR(-ENOMEM);
165
Chris Wilsonad46cb52014-08-07 14:20:40 +0100166 spin_lock_init(&mn->lock);
167 mn->mn.ops = &i915_gem_userptr_notifier;
168 mn->objects = RB_ROOT;
Chris Wilson393afc22016-04-05 14:59:59 +0100169 mn->wq = alloc_workqueue("i915-userptr-release", WQ_UNBOUND, 0);
170 if (mn->wq == NULL) {
171 kfree(mn);
172 return ERR_PTR(-ENOMEM);
173 }
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100174
Chris Wilsonad46cb52014-08-07 14:20:40 +0100175 /* Protected by mmap_sem (write-lock) */
176 ret = __mmu_notifier_register(&mn->mn, mm);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100177 if (ret) {
Chris Wilson393afc22016-04-05 14:59:59 +0100178 destroy_workqueue(mn->wq);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100179 kfree(mn);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100180 return ERR_PTR(ret);
181 }
182
Chris Wilsonad46cb52014-08-07 14:20:40 +0100183 return mn;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100184}
185
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100186static void
187i915_gem_userptr_release__mmu_notifier(struct drm_i915_gem_object *obj)
188{
Chris Wilsonad46cb52014-08-07 14:20:40 +0100189 struct i915_mmu_object *mo;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100190
Chris Wilsonad46cb52014-08-07 14:20:40 +0100191 mo = obj->userptr.mmu_object;
192 if (mo == NULL)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100193 return;
194
Chris Wilson768e1592016-01-21 17:32:43 +0000195 spin_lock(&mo->mn->lock);
196 del_object(mo);
197 spin_unlock(&mo->mn->lock);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100198 kfree(mo);
199
200 obj->userptr.mmu_object = NULL;
201}
202
203static struct i915_mmu_notifier *
204i915_mmu_notifier_find(struct i915_mm_struct *mm)
205{
Chris Wilsone9681362014-09-26 10:31:02 +0100206 struct i915_mmu_notifier *mn = mm->mn;
207
208 mn = mm->mn;
209 if (mn)
210 return mn;
211
212 down_write(&mm->mm->mmap_sem);
Chris Wilsonf470b192016-04-05 15:00:01 +0100213 mutex_lock(&mm->i915->mm_lock);
Chris Wilsone9681362014-09-26 10:31:02 +0100214 if ((mn = mm->mn) == NULL) {
215 mn = i915_mmu_notifier_create(mm->mm);
216 if (!IS_ERR(mn))
217 mm->mn = mn;
Chris Wilsonad46cb52014-08-07 14:20:40 +0100218 }
Chris Wilsonf470b192016-04-05 15:00:01 +0100219 mutex_unlock(&mm->i915->mm_lock);
Chris Wilsone9681362014-09-26 10:31:02 +0100220 up_write(&mm->mm->mmap_sem);
221
222 return mn;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100223}
224
225static int
226i915_gem_userptr_init__mmu_notifier(struct drm_i915_gem_object *obj,
227 unsigned flags)
228{
Chris Wilsonad46cb52014-08-07 14:20:40 +0100229 struct i915_mmu_notifier *mn;
230 struct i915_mmu_object *mo;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100231
232 if (flags & I915_USERPTR_UNSYNCHRONIZED)
233 return capable(CAP_SYS_ADMIN) ? 0 : -EPERM;
234
Chris Wilsonad46cb52014-08-07 14:20:40 +0100235 if (WARN_ON(obj->userptr.mm == NULL))
236 return -EINVAL;
237
238 mn = i915_mmu_notifier_find(obj->userptr.mm);
239 if (IS_ERR(mn))
240 return PTR_ERR(mn);
241
242 mo = kzalloc(sizeof(*mo), GFP_KERNEL);
243 if (mo == NULL)
244 return -ENOMEM;
245
246 mo->mn = mn;
Chris Wilsonad46cb52014-08-07 14:20:40 +0100247 mo->obj = obj;
Chris Wilson768e1592016-01-21 17:32:43 +0000248 mo->it.start = obj->userptr.ptr;
249 mo->it.last = obj->userptr.ptr + obj->base.size - 1;
250 INIT_WORK(&mo->work, cancel_userptr);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100251
Chris Wilsonad46cb52014-08-07 14:20:40 +0100252 obj->userptr.mmu_object = mo;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100253 return 0;
Chris Wilsonad46cb52014-08-07 14:20:40 +0100254}
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100255
Chris Wilsonad46cb52014-08-07 14:20:40 +0100256static void
257i915_mmu_notifier_free(struct i915_mmu_notifier *mn,
258 struct mm_struct *mm)
259{
260 if (mn == NULL)
261 return;
262
263 mmu_notifier_unregister(&mn->mn, mm);
Chris Wilson393afc22016-04-05 14:59:59 +0100264 destroy_workqueue(mn->wq);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100265 kfree(mn);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100266}
267
268#else
269
270static void
271i915_gem_userptr_release__mmu_notifier(struct drm_i915_gem_object *obj)
272{
273}
274
275static int
276i915_gem_userptr_init__mmu_notifier(struct drm_i915_gem_object *obj,
277 unsigned flags)
278{
279 if ((flags & I915_USERPTR_UNSYNCHRONIZED) == 0)
280 return -ENODEV;
281
282 if (!capable(CAP_SYS_ADMIN))
283 return -EPERM;
284
285 return 0;
286}
Chris Wilsonad46cb52014-08-07 14:20:40 +0100287
288static void
289i915_mmu_notifier_free(struct i915_mmu_notifier *mn,
290 struct mm_struct *mm)
291{
292}
293
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100294#endif
295
Chris Wilsonad46cb52014-08-07 14:20:40 +0100296static struct i915_mm_struct *
297__i915_mm_struct_find(struct drm_i915_private *dev_priv, struct mm_struct *real)
298{
299 struct i915_mm_struct *mm;
300
301 /* Protected by dev_priv->mm_lock */
302 hash_for_each_possible(dev_priv->mm_structs, mm, node, (unsigned long)real)
303 if (mm->mm == real)
304 return mm;
305
306 return NULL;
307}
308
309static int
310i915_gem_userptr_init__mm_struct(struct drm_i915_gem_object *obj)
311{
312 struct drm_i915_private *dev_priv = to_i915(obj->base.dev);
313 struct i915_mm_struct *mm;
314 int ret = 0;
315
316 /* During release of the GEM object we hold the struct_mutex. This
317 * precludes us from calling mmput() at that time as that may be
318 * the last reference and so call exit_mmap(). exit_mmap() will
319 * attempt to reap the vma, and if we were holding a GTT mmap
320 * would then call drm_gem_vm_close() and attempt to reacquire
321 * the struct mutex. So in order to avoid that recursion, we have
322 * to defer releasing the mm reference until after we drop the
323 * struct_mutex, i.e. we need to schedule a worker to do the clean
324 * up.
325 */
326 mutex_lock(&dev_priv->mm_lock);
327 mm = __i915_mm_struct_find(dev_priv, current->mm);
328 if (mm == NULL) {
329 mm = kmalloc(sizeof(*mm), GFP_KERNEL);
330 if (mm == NULL) {
331 ret = -ENOMEM;
332 goto out;
333 }
334
335 kref_init(&mm->kref);
Chris Wilsonf470b192016-04-05 15:00:01 +0100336 mm->i915 = to_i915(obj->base.dev);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100337
338 mm->mm = current->mm;
Vegard Nossumf1f10072017-02-27 14:30:07 -0800339 mmgrab(current->mm);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100340
341 mm->mn = NULL;
342
343 /* Protected by dev_priv->mm_lock */
344 hash_add(dev_priv->mm_structs,
345 &mm->node, (unsigned long)mm->mm);
346 } else
347 kref_get(&mm->kref);
348
349 obj->userptr.mm = mm;
350out:
351 mutex_unlock(&dev_priv->mm_lock);
352 return ret;
353}
354
355static void
356__i915_mm_struct_free__worker(struct work_struct *work)
357{
358 struct i915_mm_struct *mm = container_of(work, typeof(*mm), work);
359 i915_mmu_notifier_free(mm->mn, mm->mm);
360 mmdrop(mm->mm);
361 kfree(mm);
362}
363
364static void
365__i915_mm_struct_free(struct kref *kref)
366{
367 struct i915_mm_struct *mm = container_of(kref, typeof(*mm), kref);
368
369 /* Protected by dev_priv->mm_lock */
370 hash_del(&mm->node);
Chris Wilsonf470b192016-04-05 15:00:01 +0100371 mutex_unlock(&mm->i915->mm_lock);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100372
373 INIT_WORK(&mm->work, __i915_mm_struct_free__worker);
374 schedule_work(&mm->work);
375}
376
377static void
378i915_gem_userptr_release__mm_struct(struct drm_i915_gem_object *obj)
379{
380 if (obj->userptr.mm == NULL)
381 return;
382
383 kref_put_mutex(&obj->userptr.mm->kref,
384 __i915_mm_struct_free,
385 &to_i915(obj->base.dev)->mm_lock);
386 obj->userptr.mm = NULL;
387}
388
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100389struct get_pages_work {
390 struct work_struct work;
391 struct drm_i915_gem_object *obj;
392 struct task_struct *task;
393};
394
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100395#if IS_ENABLED(CONFIG_SWIOTLB)
396#define swiotlb_active() swiotlb_nr_tbl()
397#else
398#define swiotlb_active() 0
399#endif
400
401static int
402st_set_pages(struct sg_table **st, struct page **pvec, int num_pages)
403{
404 struct scatterlist *sg;
405 int ret, n;
406
407 *st = kmalloc(sizeof(**st), GFP_KERNEL);
408 if (*st == NULL)
409 return -ENOMEM;
410
411 if (swiotlb_active()) {
412 ret = sg_alloc_table(*st, num_pages, GFP_KERNEL);
413 if (ret)
414 goto err;
415
416 for_each_sg((*st)->sgl, sg, num_pages, n)
417 sg_set_page(sg, pvec[n], PAGE_SIZE, 0);
418 } else {
419 ret = sg_alloc_table_from_pages(*st, pvec, num_pages,
420 0, num_pages << PAGE_SHIFT,
421 GFP_KERNEL);
422 if (ret)
423 goto err;
424 }
425
426 return 0;
427
428err:
429 kfree(*st);
430 *st = NULL;
431 return ret;
432}
433
Chris Wilson03ac84f2016-10-28 13:58:36 +0100434static struct sg_table *
Imre Deake2273302015-07-09 12:59:05 +0300435__i915_gem_userptr_set_pages(struct drm_i915_gem_object *obj,
436 struct page **pvec, int num_pages)
437{
Chris Wilson03ac84f2016-10-28 13:58:36 +0100438 struct sg_table *pages;
Imre Deake2273302015-07-09 12:59:05 +0300439 int ret;
440
Chris Wilson03ac84f2016-10-28 13:58:36 +0100441 ret = st_set_pages(&pages, pvec, num_pages);
Imre Deake2273302015-07-09 12:59:05 +0300442 if (ret)
Chris Wilson03ac84f2016-10-28 13:58:36 +0100443 return ERR_PTR(ret);
Imre Deake2273302015-07-09 12:59:05 +0300444
Chris Wilson03ac84f2016-10-28 13:58:36 +0100445 ret = i915_gem_gtt_prepare_pages(obj, pages);
Imre Deake2273302015-07-09 12:59:05 +0300446 if (ret) {
Chris Wilson03ac84f2016-10-28 13:58:36 +0100447 sg_free_table(pages);
448 kfree(pages);
449 return ERR_PTR(ret);
Imre Deake2273302015-07-09 12:59:05 +0300450 }
451
Chris Wilson03ac84f2016-10-28 13:58:36 +0100452 return pages;
Imre Deake2273302015-07-09 12:59:05 +0300453}
454
Chris Wilson380996a2015-10-01 12:34:47 +0100455static int
Chris Wilsone4b946b2015-10-01 12:34:46 +0100456__i915_gem_userptr_set_active(struct drm_i915_gem_object *obj,
457 bool value)
458{
Chris Wilson380996a2015-10-01 12:34:47 +0100459 int ret = 0;
460
Chris Wilsone4b946b2015-10-01 12:34:46 +0100461 /* During mm_invalidate_range we need to cancel any userptr that
462 * overlaps the range being invalidated. Doing so requires the
463 * struct_mutex, and that risks recursion. In order to cause
464 * recursion, the user must alias the userptr address space with
465 * a GTT mmapping (possible with a MAP_FIXED) - then when we have
466 * to invalidate that mmaping, mm_invalidate_range is called with
467 * the userptr address *and* the struct_mutex held. To prevent that
468 * we set a flag under the i915_mmu_notifier spinlock to indicate
469 * whether this object is valid.
470 */
471#if defined(CONFIG_MMU_NOTIFIER)
472 if (obj->userptr.mmu_object == NULL)
Chris Wilson380996a2015-10-01 12:34:47 +0100473 return 0;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100474
475 spin_lock(&obj->userptr.mmu_object->mn->lock);
Chris Wilson380996a2015-10-01 12:34:47 +0100476 /* In order to serialise get_pages with an outstanding
477 * cancel_userptr, we must drop the struct_mutex and try again.
478 */
Chris Wilson768e1592016-01-21 17:32:43 +0000479 if (!value)
480 del_object(obj->userptr.mmu_object);
481 else if (!work_pending(&obj->userptr.mmu_object->work))
482 add_object(obj->userptr.mmu_object);
Chris Wilson380996a2015-10-01 12:34:47 +0100483 else
484 ret = -EAGAIN;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100485 spin_unlock(&obj->userptr.mmu_object->mn->lock);
486#endif
Chris Wilson380996a2015-10-01 12:34:47 +0100487
488 return ret;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100489}
490
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100491static void
492__i915_gem_userptr_get_pages_worker(struct work_struct *_work)
493{
494 struct get_pages_work *work = container_of(_work, typeof(*work), work);
495 struct drm_i915_gem_object *obj = work->obj;
Chris Wilson68d6c842015-10-01 12:34:45 +0100496 const int npages = obj->base.size >> PAGE_SHIFT;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100497 struct page **pvec;
498 int pinned, ret;
499
500 ret = -ENOMEM;
501 pinned = 0;
502
Chris Wilsonf2a85e12016-04-08 12:11:13 +0100503 pvec = drm_malloc_gfp(npages, sizeof(struct page *), GFP_TEMPORARY);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100504 if (pvec != NULL) {
Chris Wilsonad46cb52014-08-07 14:20:40 +0100505 struct mm_struct *mm = obj->userptr.mm->mm;
Lorenzo Stoakes9beae1e2016-10-13 01:20:17 +0100506 unsigned int flags = 0;
507
508 if (!obj->userptr.read_only)
509 flags |= FOLL_WRITE;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100510
Chris Wilson40313f02016-04-05 15:00:00 +0100511 ret = -EFAULT;
Vegard Nossum388f7932017-02-27 14:30:13 -0800512 if (mmget_not_zero(mm)) {
Chris Wilson40313f02016-04-05 15:00:00 +0100513 down_read(&mm->mmap_sem);
514 while (pinned < npages) {
515 ret = get_user_pages_remote
516 (work->task, mm,
517 obj->userptr.ptr + pinned * PAGE_SIZE,
518 npages - pinned,
Lorenzo Stoakes9beae1e2016-10-13 01:20:17 +0100519 flags,
Lorenzo Stoakes5b56d492016-12-14 15:06:52 -0800520 pvec + pinned, NULL, NULL);
Chris Wilson40313f02016-04-05 15:00:00 +0100521 if (ret < 0)
522 break;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100523
Chris Wilson40313f02016-04-05 15:00:00 +0100524 pinned += ret;
525 }
526 up_read(&mm->mmap_sem);
527 mmput(mm);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100528 }
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100529 }
530
Chris Wilson1233e2d2016-10-28 13:58:37 +0100531 mutex_lock(&obj->mm.lock);
Chris Wilson68d6c842015-10-01 12:34:45 +0100532 if (obj->userptr.work == &work->work) {
Chris Wilson03ac84f2016-10-28 13:58:36 +0100533 struct sg_table *pages = ERR_PTR(ret);
534
Chris Wilson68d6c842015-10-01 12:34:45 +0100535 if (pinned == npages) {
Chris Wilson03ac84f2016-10-28 13:58:36 +0100536 pages = __i915_gem_userptr_set_pages(obj, pvec, npages);
537 if (!IS_ERR(pages)) {
538 __i915_gem_object_set_pages(obj, pages);
Chris Wilson68d6c842015-10-01 12:34:45 +0100539 pinned = 0;
Chris Wilson03ac84f2016-10-28 13:58:36 +0100540 pages = NULL;
Chris Wilson68d6c842015-10-01 12:34:45 +0100541 }
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100542 }
Chris Wilson03ac84f2016-10-28 13:58:36 +0100543
544 obj->userptr.work = ERR_CAST(pages);
Chris Wilson42953b32017-03-07 20:58:49 +0000545 if (IS_ERR(pages))
546 __i915_gem_userptr_set_active(obj, false);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100547 }
Chris Wilson1233e2d2016-10-28 13:58:37 +0100548 mutex_unlock(&obj->mm.lock);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100549
550 release_pages(pvec, pinned, 0);
551 drm_free_large(pvec);
552
Chris Wilsonf0cd5182016-10-28 13:58:43 +0100553 i915_gem_object_put(obj);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100554 put_task_struct(work->task);
555 kfree(work);
556}
557
Chris Wilson03ac84f2016-10-28 13:58:36 +0100558static struct sg_table *
Chris Wilsone4b946b2015-10-01 12:34:46 +0100559__i915_gem_userptr_get_pages_schedule(struct drm_i915_gem_object *obj,
560 bool *active)
561{
562 struct get_pages_work *work;
563
564 /* Spawn a worker so that we can acquire the
565 * user pages without holding our mutex. Access
566 * to the user pages requires mmap_sem, and we have
567 * a strict lock ordering of mmap_sem, struct_mutex -
568 * we already hold struct_mutex here and so cannot
569 * call gup without encountering a lock inversion.
570 *
571 * Userspace will keep on repeating the operation
572 * (thanks to EAGAIN) until either we hit the fast
573 * path or the worker completes. If the worker is
574 * cancelled or superseded, the task is still run
575 * but the results ignored. (This leads to
576 * complications that we may have a stray object
577 * refcount that we need to be wary of when
578 * checking for existing objects during creation.)
579 * If the worker encounters an error, it reports
580 * that error back to this function through
581 * obj->userptr.work = ERR_PTR.
582 */
Chris Wilsone4b946b2015-10-01 12:34:46 +0100583 work = kmalloc(sizeof(*work), GFP_KERNEL);
584 if (work == NULL)
Chris Wilson03ac84f2016-10-28 13:58:36 +0100585 return ERR_PTR(-ENOMEM);
Chris Wilsone4b946b2015-10-01 12:34:46 +0100586
587 obj->userptr.work = &work->work;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100588
Chris Wilson25dc5562016-07-20 13:31:52 +0100589 work->obj = i915_gem_object_get(obj);
Chris Wilsone4b946b2015-10-01 12:34:46 +0100590
591 work->task = current;
592 get_task_struct(work->task);
593
594 INIT_WORK(&work->work, __i915_gem_userptr_get_pages_worker);
595 schedule_work(&work->work);
596
597 *active = true;
Chris Wilson03ac84f2016-10-28 13:58:36 +0100598 return ERR_PTR(-EAGAIN);
Chris Wilsone4b946b2015-10-01 12:34:46 +0100599}
600
Chris Wilson03ac84f2016-10-28 13:58:36 +0100601static struct sg_table *
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100602i915_gem_userptr_get_pages(struct drm_i915_gem_object *obj)
603{
604 const int num_pages = obj->base.size >> PAGE_SHIFT;
605 struct page **pvec;
Chris Wilson03ac84f2016-10-28 13:58:36 +0100606 struct sg_table *pages;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100607 int pinned, ret;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100608 bool active;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100609
610 /* If userspace should engineer that these pages are replaced in
611 * the vma between us binding this page into the GTT and completion
612 * of rendering... Their loss. If they change the mapping of their
613 * pages they need to create a new bo to point to the new vma.
614 *
615 * However, that still leaves open the possibility of the vma
616 * being copied upon fork. Which falls under the same userspace
617 * synchronisation issue as a regular bo, except that this time
618 * the process may not be expecting that a particular piece of
619 * memory is tied to the GPU.
620 *
621 * Fortunately, we can hook into the mmu_notifier in order to
622 * discard the page references prior to anything nasty happening
623 * to the vma (discard or cloning) which should prevent the more
624 * egregious cases from causing harm.
625 */
Chris Wilson364c8172016-08-18 17:16:58 +0100626
627 if (obj->userptr.work) {
Chris Wilsone4b946b2015-10-01 12:34:46 +0100628 /* active flag should still be held for the pending work */
Chris Wilson364c8172016-08-18 17:16:58 +0100629 if (IS_ERR(obj->userptr.work))
Chris Wilson03ac84f2016-10-28 13:58:36 +0100630 return ERR_CAST(obj->userptr.work);
Chris Wilson364c8172016-08-18 17:16:58 +0100631 else
Chris Wilson03ac84f2016-10-28 13:58:36 +0100632 return ERR_PTR(-EAGAIN);
Chris Wilson364c8172016-08-18 17:16:58 +0100633 }
Chris Wilsone4b946b2015-10-01 12:34:46 +0100634
635 /* Let the mmu-notifier know that we have begun and need cancellation */
Chris Wilson380996a2015-10-01 12:34:47 +0100636 ret = __i915_gem_userptr_set_active(obj, true);
637 if (ret)
Chris Wilson03ac84f2016-10-28 13:58:36 +0100638 return ERR_PTR(ret);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100639
640 pvec = NULL;
641 pinned = 0;
Chris Wilsonad46cb52014-08-07 14:20:40 +0100642 if (obj->userptr.mm->mm == current->mm) {
Chris Wilsonf2a85e12016-04-08 12:11:13 +0100643 pvec = drm_malloc_gfp(num_pages, sizeof(struct page *),
644 GFP_TEMPORARY);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100645 if (pvec == NULL) {
Chris Wilsonf2a85e12016-04-08 12:11:13 +0100646 __i915_gem_userptr_set_active(obj, false);
Chris Wilson03ac84f2016-10-28 13:58:36 +0100647 return ERR_PTR(-ENOMEM);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100648 }
649
650 pinned = __get_user_pages_fast(obj->userptr.ptr, num_pages,
651 !obj->userptr.read_only, pvec);
652 }
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100653
Chris Wilsone4b946b2015-10-01 12:34:46 +0100654 active = false;
655 if (pinned < 0)
Chris Wilson03ac84f2016-10-28 13:58:36 +0100656 pages = ERR_PTR(pinned), pinned = 0;
Chris Wilsone4b946b2015-10-01 12:34:46 +0100657 else if (pinned < num_pages)
Chris Wilson03ac84f2016-10-28 13:58:36 +0100658 pages = __i915_gem_userptr_get_pages_schedule(obj, &active);
Chris Wilsone4b946b2015-10-01 12:34:46 +0100659 else
Chris Wilson03ac84f2016-10-28 13:58:36 +0100660 pages = __i915_gem_userptr_set_pages(obj, pvec, num_pages);
661 if (IS_ERR(pages)) {
Chris Wilsone4b946b2015-10-01 12:34:46 +0100662 __i915_gem_userptr_set_active(obj, active);
663 release_pages(pvec, pinned, 0);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100664 }
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100665 drm_free_large(pvec);
Chris Wilson03ac84f2016-10-28 13:58:36 +0100666 return pages;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100667}
668
669static void
Chris Wilson03ac84f2016-10-28 13:58:36 +0100670i915_gem_userptr_put_pages(struct drm_i915_gem_object *obj,
671 struct sg_table *pages)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100672{
Dave Gordon85d12252016-05-20 11:54:06 +0100673 struct sgt_iter sgt_iter;
674 struct page *page;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100675
676 BUG_ON(obj->userptr.work != NULL);
Chris Wilsone4b946b2015-10-01 12:34:46 +0100677 __i915_gem_userptr_set_active(obj, false);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100678
Chris Wilsona4f5ea62016-10-28 13:58:35 +0100679 if (obj->mm.madv != I915_MADV_WILLNEED)
680 obj->mm.dirty = false;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100681
Chris Wilson03ac84f2016-10-28 13:58:36 +0100682 i915_gem_gtt_finish_pages(obj, pages);
Imre Deake2273302015-07-09 12:59:05 +0300683
Chris Wilson03ac84f2016-10-28 13:58:36 +0100684 for_each_sgt_page(page, sgt_iter, pages) {
Chris Wilsona4f5ea62016-10-28 13:58:35 +0100685 if (obj->mm.dirty)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100686 set_page_dirty(page);
687
688 mark_page_accessed(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300689 put_page(page);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100690 }
Chris Wilsona4f5ea62016-10-28 13:58:35 +0100691 obj->mm.dirty = false;
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100692
Chris Wilson03ac84f2016-10-28 13:58:36 +0100693 sg_free_table(pages);
694 kfree(pages);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100695}
696
697static void
698i915_gem_userptr_release(struct drm_i915_gem_object *obj)
699{
700 i915_gem_userptr_release__mmu_notifier(obj);
Chris Wilsonad46cb52014-08-07 14:20:40 +0100701 i915_gem_userptr_release__mm_struct(obj);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100702}
703
704static int
705i915_gem_userptr_dmabuf_export(struct drm_i915_gem_object *obj)
706{
Chris Wilsonad46cb52014-08-07 14:20:40 +0100707 if (obj->userptr.mmu_object)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100708 return 0;
709
710 return i915_gem_userptr_init__mmu_notifier(obj, 0);
711}
712
713static const struct drm_i915_gem_object_ops i915_gem_userptr_ops = {
Tvrtko Ursulin3599a912016-11-01 14:44:10 +0000714 .flags = I915_GEM_OBJECT_HAS_STRUCT_PAGE |
715 I915_GEM_OBJECT_IS_SHRINKABLE,
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100716 .get_pages = i915_gem_userptr_get_pages,
717 .put_pages = i915_gem_userptr_put_pages,
Chris Wilsonde472662016-01-22 18:32:31 +0000718 .dmabuf_export = i915_gem_userptr_dmabuf_export,
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100719 .release = i915_gem_userptr_release,
720};
721
722/**
723 * Creates a new mm object that wraps some normal memory from the process
724 * context - user memory.
725 *
726 * We impose several restrictions upon the memory being mapped
727 * into the GPU.
728 * 1. It must be page aligned (both start/end addresses, i.e ptr and size).
Chris Wilsonec8b0dd2014-07-21 13:21:23 +0100729 * 2. It must be normal system memory, not a pointer into another map of IO
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100730 * space (e.g. it must not be a GTT mmapping of another object).
Chris Wilsonec8b0dd2014-07-21 13:21:23 +0100731 * 3. We only allow a bo as large as we could in theory map into the GTT,
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100732 * that is we limit the size to the total size of the GTT.
Chris Wilsonec8b0dd2014-07-21 13:21:23 +0100733 * 4. The bo is marked as being snoopable. The backing pages are left
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100734 * accessible directly by the CPU, but reads and writes by the GPU may
735 * incur the cost of a snoop (unless you have an LLC architecture).
736 *
737 * Synchronisation between multiple users and the GPU is left to userspace
738 * through the normal set-domain-ioctl. The kernel will enforce that the
739 * GPU relinquishes the VMA before it is returned back to the system
740 * i.e. upon free(), munmap() or process termination. However, the userspace
741 * malloc() library may not immediately relinquish the VMA after free() and
742 * instead reuse it whilst the GPU is still reading and writing to the VMA.
743 * Caveat emptor.
744 *
745 * Also note, that the object created here is not currently a "first class"
746 * object, in that several ioctls are banned. These are the CPU access
747 * ioctls: mmap(), pwrite and pread. In practice, you are expected to use
Chris Wilsoncc917ab2015-10-13 14:22:26 +0100748 * direct access via your pointer rather than use those ioctls. Another
749 * restriction is that we do not allow userptr surfaces to be pinned to the
750 * hardware and so we reject any attempt to create a framebuffer out of a
751 * userptr.
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100752 *
753 * If you think this is a good interface to use to pass GPU memory between
754 * drivers, please use dma-buf instead. In fact, wherever possible use
755 * dma-buf instead.
756 */
757int
758i915_gem_userptr_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
759{
Tvrtko Ursulin0031fb92016-11-04 14:42:44 +0000760 struct drm_i915_private *dev_priv = to_i915(dev);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100761 struct drm_i915_gem_userptr *args = data;
762 struct drm_i915_gem_object *obj;
763 int ret;
764 u32 handle;
765
Tvrtko Ursulin0031fb92016-11-04 14:42:44 +0000766 if (!HAS_LLC(dev_priv) && !HAS_SNOOP(dev_priv)) {
Tvrtko Ursulinca377802016-03-02 12:10:31 +0000767 /* We cannot support coherent userptr objects on hw without
768 * LLC and broken snooping.
769 */
770 return -ENODEV;
771 }
772
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100773 if (args->flags & ~(I915_USERPTR_READ_ONLY |
774 I915_USERPTR_UNSYNCHRONIZED))
775 return -EINVAL;
776
777 if (offset_in_page(args->user_ptr | args->user_size))
778 return -EINVAL;
779
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100780 if (!access_ok(args->flags & I915_USERPTR_READ_ONLY ? VERIFY_READ : VERIFY_WRITE,
781 (char __user *)(unsigned long)args->user_ptr, args->user_size))
782 return -EFAULT;
783
784 if (args->flags & I915_USERPTR_READ_ONLY) {
785 /* On almost all of the current hw, we cannot tell the GPU that a
786 * page is readonly, so this is just a placeholder in the uAPI.
787 */
788 return -ENODEV;
789 }
790
Tvrtko Ursulin187685c2016-12-01 14:16:36 +0000791 obj = i915_gem_object_alloc(dev_priv);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100792 if (obj == NULL)
793 return -ENOMEM;
794
795 drm_gem_private_object_init(dev, &obj->base, args->user_size);
796 i915_gem_object_init(obj, &i915_gem_userptr_ops);
797 obj->cache_level = I915_CACHE_LLC;
798 obj->base.write_domain = I915_GEM_DOMAIN_CPU;
799 obj->base.read_domains = I915_GEM_DOMAIN_CPU;
800
801 obj->userptr.ptr = args->user_ptr;
802 obj->userptr.read_only = !!(args->flags & I915_USERPTR_READ_ONLY);
803
804 /* And keep a pointer to the current->mm for resolving the user pages
805 * at binding. This means that we need to hook into the mmu_notifier
806 * in order to detect if the mmu is destroyed.
807 */
Chris Wilsonad46cb52014-08-07 14:20:40 +0100808 ret = i915_gem_userptr_init__mm_struct(obj);
809 if (ret == 0)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100810 ret = i915_gem_userptr_init__mmu_notifier(obj, args->flags);
811 if (ret == 0)
812 ret = drm_gem_handle_create(file, &obj->base, &handle);
813
814 /* drop reference from allocate - handle holds it now */
Chris Wilsonf0cd5182016-10-28 13:58:43 +0100815 i915_gem_object_put(obj);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100816 if (ret)
817 return ret;
818
819 args->handle = handle;
820 return 0;
821}
822
Chris Wilson72778cb2016-05-19 16:17:16 +0100823void i915_gem_init_userptr(struct drm_i915_private *dev_priv)
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100824{
Chris Wilsonad46cb52014-08-07 14:20:40 +0100825 mutex_init(&dev_priv->mm_lock);
826 hash_init(dev_priv->mm_structs);
Chris Wilson5cc9ed42014-05-16 14:22:37 +0100827}