drm/i915: Rename intel_context[engine].ringbuf
[deliverable/linux.git] / drivers / gpu / drm / i915 / i915_gem_shrinker.c
CommitLineData
be6a0376
DV
1/*
2 * Copyright © 2008-2015 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 <linux/oom.h>
26#include <linux/shmem_fs.h>
27#include <linux/slab.h>
28#include <linux/swap.h>
29#include <linux/pci.h>
30#include <linux/dma-buf.h>
e87666b5 31#include <linux/vmalloc.h>
be6a0376
DV
32#include <drm/drmP.h>
33#include <drm/i915_drm.h>
34
35#include "i915_drv.h"
36#include "i915_trace.h"
37
38static bool mutex_is_locked_by(struct mutex *mutex, struct task_struct *task)
39{
40 if (!mutex_is_locked(mutex))
41 return false;
42
4f074a53 43#if defined(CONFIG_DEBUG_MUTEXES) || defined(CONFIG_MUTEX_SPIN_ON_OWNER)
be6a0376
DV
44 return mutex->owner == task;
45#else
46 /* Since UP may be pre-empted, we cannot assume that we own the lock */
47 return false;
48#endif
49}
50
c1a415e2
CW
51static int num_vma_bound(struct drm_i915_gem_object *obj)
52{
53 struct i915_vma *vma;
54 int count = 0;
55
1c7f4bca 56 list_for_each_entry(vma, &obj->vma_list, obj_link) {
c1a415e2
CW
57 if (drm_mm_node_allocated(&vma->node))
58 count++;
59 if (vma->pin_count)
60 count++;
61 }
62
63 return count;
64}
65
66static bool swap_available(void)
67{
68 return get_nr_swap_pages() > 0;
69}
70
71static bool can_release_pages(struct drm_i915_gem_object *obj)
72{
1bec9b0b
CW
73 /* Only shmemfs objects are backed by swap */
74 if (!obj->base.filp)
75 return false;
76
c1a415e2
CW
77 /* Only report true if by unbinding the object and putting its pages
78 * we can actually make forward progress towards freeing physical
79 * pages.
80 *
81 * If the pages are pinned for any other reason than being bound
82 * to the GPU, simply unbinding from the GPU is not going to succeed
83 * in releasing our pin count on the pages themselves.
84 */
85 if (obj->pages_pin_count != num_vma_bound(obj))
86 return false;
87
88 /* We can only return physical pages to the system if we can either
89 * discard the contents (because the user has marked them as being
90 * purgeable) or if we can move their contents out to swap.
91 */
92 return swap_available() || obj->madv == I915_MADV_DONTNEED;
93}
94
eb0b44ad
DV
95/**
96 * i915_gem_shrink - Shrink buffer object caches
97 * @dev_priv: i915 device
98 * @target: amount of memory to make available, in pages
99 * @flags: control flags for selecting cache types
100 *
101 * This function is the main interface to the shrinker. It will try to release
102 * up to @target pages of main memory backing storage from buffer objects.
103 * Selection of the specific caches can be done with @flags. This is e.g. useful
104 * when purgeable objects should be removed from caches preferentially.
105 *
106 * Note that it's not guaranteed that released amount is actually available as
107 * free system memory - the pages might still be in-used to due to other reasons
108 * (like cpu mmaps) or the mm core has reused them before we could grab them.
109 * Therefore code that needs to explicitly shrink buffer objects caches (e.g. to
110 * avoid deadlocks in memory reclaim) must fall back to i915_gem_shrink_all().
111 *
112 * Also note that any kind of pinning (both per-vma address space pins and
113 * backing storage pins at the buffer object level) result in the shrinker code
114 * having to skip the object.
115 *
116 * Returns:
117 * The number of pages of backing storage actually released.
118 */
be6a0376
DV
119unsigned long
120i915_gem_shrink(struct drm_i915_private *dev_priv,
14387540 121 unsigned long target, unsigned flags)
be6a0376
DV
122{
123 const struct {
124 struct list_head *list;
125 unsigned int bit;
126 } phases[] = {
127 { &dev_priv->mm.unbound_list, I915_SHRINK_UNBOUND },
128 { &dev_priv->mm.bound_list, I915_SHRINK_BOUND },
129 { NULL, 0 },
130 }, *phase;
131 unsigned long count = 0;
132
3abafa53 133 trace_i915_gem_shrink(dev_priv, target, flags);
c033666a 134 i915_gem_retire_requests(dev_priv);
3abafa53 135
178a30c9
PP
136 /*
137 * Unbinding of objects will require HW access; Let us not wake the
138 * device just to recover a little memory. If absolutely necessary,
139 * we will force the wake during oom-notifier.
140 */
141 if ((flags & I915_SHRINK_BOUND) &&
142 !intel_runtime_pm_get_if_in_use(dev_priv))
143 flags &= ~I915_SHRINK_BOUND;
144
be6a0376
DV
145 /*
146 * As we may completely rewrite the (un)bound list whilst unbinding
147 * (due to retiring requests) we have to strictly process only
148 * one element of the list at the time, and recheck the list
149 * on every iteration.
150 *
151 * In particular, we must hold a reference whilst removing the
152 * object as we may end up waiting for and/or retiring the objects.
153 * This might release the final reference (held by the active list)
154 * and result in the object being freed from under us. This is
155 * similar to the precautions the eviction code must take whilst
156 * removing objects.
157 *
158 * Also note that although these lists do not hold a reference to
159 * the object we can safely grab one here: The final object
160 * unreferencing and the bound_list are both protected by the
161 * dev->struct_mutex and so we won't ever be able to observe an
162 * object on the bound_list with a reference count equals 0.
163 */
164 for (phase = phases; phase->list; phase++) {
165 struct list_head still_in_list;
2a1d7752 166 struct drm_i915_gem_object *obj;
be6a0376
DV
167
168 if ((flags & phase->bit) == 0)
169 continue;
170
171 INIT_LIST_HEAD(&still_in_list);
2a1d7752
CW
172 while (count < target &&
173 (obj = list_first_entry_or_null(phase->list,
174 typeof(*obj),
175 global_list))) {
be6a0376
DV
176 struct i915_vma *vma, *v;
177
be6a0376
DV
178 list_move_tail(&obj->global_list, &still_in_list);
179
180 if (flags & I915_SHRINK_PURGEABLE &&
181 obj->madv != I915_MADV_DONTNEED)
182 continue;
183
eae2c43b
CW
184 if (flags & I915_SHRINK_VMAPS &&
185 !is_vmalloc_addr(obj->mapping))
186 continue;
187
5763ff04
CW
188 if ((flags & I915_SHRINK_ACTIVE) == 0 && obj->active)
189 continue;
190
c1a415e2
CW
191 if (!can_release_pages(obj))
192 continue;
193
25dc556a 194 i915_gem_object_get(obj);
be6a0376
DV
195
196 /* For the unbound phase, this should be a no-op! */
197 list_for_each_entry_safe(vma, v,
1c7f4bca 198 &obj->vma_list, obj_link)
be6a0376
DV
199 if (i915_vma_unbind(vma))
200 break;
201
202 if (i915_gem_object_put_pages(obj) == 0)
203 count += obj->base.size >> PAGE_SHIFT;
204
f8c417cd 205 i915_gem_object_put(obj);
be6a0376
DV
206 }
207 list_splice(&still_in_list, phase->list);
208 }
209
178a30c9
PP
210 if (flags & I915_SHRINK_BOUND)
211 intel_runtime_pm_put(dev_priv);
212
c033666a 213 i915_gem_retire_requests(dev_priv);
c9c0f5ea 214
be6a0376
DV
215 return count;
216}
217
eb0b44ad 218/**
1f2449cd 219 * i915_gem_shrink_all - Shrink buffer object caches completely
eb0b44ad
DV
220 * @dev_priv: i915 device
221 *
222 * This is a simple wraper around i915_gem_shrink() to aggressively shrink all
223 * caches completely. It also first waits for and retires all outstanding
224 * requests to also be able to release backing storage for active objects.
225 *
226 * This should only be used in code to intentionally quiescent the gpu or as a
227 * last-ditch effort when memory seems to have run out.
228 *
229 * Returns:
230 * The number of pages of backing storage actually released.
231 */
be6a0376
DV
232unsigned long i915_gem_shrink_all(struct drm_i915_private *dev_priv)
233{
14387540 234 return i915_gem_shrink(dev_priv, -1UL,
5763ff04
CW
235 I915_SHRINK_BOUND |
236 I915_SHRINK_UNBOUND |
237 I915_SHRINK_ACTIVE);
be6a0376
DV
238}
239
240static bool i915_gem_shrinker_lock(struct drm_device *dev, bool *unlock)
241{
242 if (!mutex_trylock(&dev->struct_mutex)) {
243 if (!mutex_is_locked_by(&dev->struct_mutex, current))
244 return false;
245
246 if (to_i915(dev)->mm.shrinker_no_lock_stealing)
247 return false;
248
249 *unlock = false;
250 } else
251 *unlock = true;
252
253 return true;
254}
255
be6a0376
DV
256static unsigned long
257i915_gem_shrinker_count(struct shrinker *shrinker, struct shrink_control *sc)
258{
259 struct drm_i915_private *dev_priv =
260 container_of(shrinker, struct drm_i915_private, mm.shrinker);
91c8a326 261 struct drm_device *dev = &dev_priv->drm;
be6a0376
DV
262 struct drm_i915_gem_object *obj;
263 unsigned long count;
264 bool unlock;
265
266 if (!i915_gem_shrinker_lock(dev, &unlock))
267 return 0;
268
bed50aea
CW
269 i915_gem_retire_requests(dev_priv);
270
be6a0376
DV
271 count = 0;
272 list_for_each_entry(obj, &dev_priv->mm.unbound_list, global_list)
6f0ac204 273 if (can_release_pages(obj))
be6a0376
DV
274 count += obj->base.size >> PAGE_SHIFT;
275
276 list_for_each_entry(obj, &dev_priv->mm.bound_list, global_list) {
c1a415e2 277 if (!obj->active && can_release_pages(obj))
be6a0376
DV
278 count += obj->base.size >> PAGE_SHIFT;
279 }
280
281 if (unlock)
282 mutex_unlock(&dev->struct_mutex);
283
284 return count;
285}
286
287static unsigned long
288i915_gem_shrinker_scan(struct shrinker *shrinker, struct shrink_control *sc)
289{
290 struct drm_i915_private *dev_priv =
291 container_of(shrinker, struct drm_i915_private, mm.shrinker);
91c8a326 292 struct drm_device *dev = &dev_priv->drm;
be6a0376
DV
293 unsigned long freed;
294 bool unlock;
295
296 if (!i915_gem_shrinker_lock(dev, &unlock))
297 return SHRINK_STOP;
298
299 freed = i915_gem_shrink(dev_priv,
300 sc->nr_to_scan,
301 I915_SHRINK_BOUND |
302 I915_SHRINK_UNBOUND |
303 I915_SHRINK_PURGEABLE);
304 if (freed < sc->nr_to_scan)
305 freed += i915_gem_shrink(dev_priv,
306 sc->nr_to_scan - freed,
307 I915_SHRINK_BOUND |
308 I915_SHRINK_UNBOUND);
309 if (unlock)
310 mutex_unlock(&dev->struct_mutex);
311
312 return freed;
313}
314
168cf367
CW
315struct shrinker_lock_uninterruptible {
316 bool was_interruptible;
317 bool unlock;
318};
319
320static bool
321i915_gem_shrinker_lock_uninterruptible(struct drm_i915_private *dev_priv,
322 struct shrinker_lock_uninterruptible *slu,
323 int timeout_ms)
324{
325 unsigned long timeout = msecs_to_jiffies(timeout_ms) + 1;
326
91c8a326 327 while (!i915_gem_shrinker_lock(&dev_priv->drm, &slu->unlock)) {
168cf367
CW
328 schedule_timeout_killable(1);
329 if (fatal_signal_pending(current))
330 return false;
331 if (--timeout == 0) {
332 pr_err("Unable to lock GPU to purge memory.\n");
333 return false;
334 }
335 }
336
337 slu->was_interruptible = dev_priv->mm.interruptible;
338 dev_priv->mm.interruptible = false;
339 return true;
340}
341
342static void
343i915_gem_shrinker_unlock_uninterruptible(struct drm_i915_private *dev_priv,
344 struct shrinker_lock_uninterruptible *slu)
345{
346 dev_priv->mm.interruptible = slu->was_interruptible;
347 if (slu->unlock)
91c8a326 348 mutex_unlock(&dev_priv->drm.struct_mutex);
168cf367
CW
349}
350
be6a0376
DV
351static int
352i915_gem_shrinker_oom(struct notifier_block *nb, unsigned long event, void *ptr)
353{
354 struct drm_i915_private *dev_priv =
355 container_of(nb, struct drm_i915_private, mm.oom_notifier);
168cf367 356 struct shrinker_lock_uninterruptible slu;
be6a0376 357 struct drm_i915_gem_object *obj;
1768d455 358 unsigned long unevictable, bound, unbound, freed_pages;
be6a0376 359
168cf367 360 if (!i915_gem_shrinker_lock_uninterruptible(dev_priv, &slu, 5000))
be6a0376 361 return NOTIFY_DONE;
be6a0376 362
ea9d9768 363 intel_runtime_pm_get(dev_priv);
be6a0376 364 freed_pages = i915_gem_shrink_all(dev_priv);
ea9d9768 365 intel_runtime_pm_put(dev_priv);
be6a0376 366
be6a0376
DV
367 /* Because we may be allocating inside our own driver, we cannot
368 * assert that there are no objects with pinned pages that are not
369 * being pointed to by hardware.
370 */
1768d455 371 unbound = bound = unevictable = 0;
be6a0376 372 list_for_each_entry(obj, &dev_priv->mm.unbound_list, global_list) {
1768d455
CW
373 if (!can_release_pages(obj))
374 unevictable += obj->base.size >> PAGE_SHIFT;
be6a0376 375 else
1768d455 376 unbound += obj->base.size >> PAGE_SHIFT;
be6a0376
DV
377 }
378 list_for_each_entry(obj, &dev_priv->mm.bound_list, global_list) {
1768d455
CW
379 if (!can_release_pages(obj))
380 unevictable += obj->base.size >> PAGE_SHIFT;
be6a0376 381 else
1768d455 382 bound += obj->base.size >> PAGE_SHIFT;
be6a0376
DV
383 }
384
168cf367 385 i915_gem_shrinker_unlock_uninterruptible(dev_priv, &slu);
be6a0376
DV
386
387 if (freed_pages || unbound || bound)
1768d455
CW
388 pr_info("Purging GPU memory, %lu pages freed, "
389 "%lu pages still pinned.\n",
390 freed_pages, unevictable);
be6a0376 391 if (unbound || bound)
1768d455 392 pr_err("%lu and %lu pages still available in the "
be6a0376
DV
393 "bound and unbound GPU page lists.\n",
394 bound, unbound);
395
396 *(unsigned long *)ptr += freed_pages;
397 return NOTIFY_DONE;
398}
399
e87666b5
CW
400static int
401i915_gem_shrinker_vmap(struct notifier_block *nb, unsigned long event, void *ptr)
402{
403 struct drm_i915_private *dev_priv =
404 container_of(nb, struct drm_i915_private, mm.vmap_notifier);
168cf367 405 struct shrinker_lock_uninterruptible slu;
8ef8561f
CW
406 struct i915_vma *vma, *next;
407 unsigned long freed_pages = 0;
408 int ret;
e87666b5 409
168cf367 410 if (!i915_gem_shrinker_lock_uninterruptible(dev_priv, &slu, 5000))
e87666b5 411 return NOTIFY_DONE;
e87666b5 412
8ef8561f 413 /* Force everything onto the inactive lists */
6e5a5beb 414 ret = i915_gem_wait_for_idle(dev_priv);
8ef8561f
CW
415 if (ret)
416 goto out;
417
ea9d9768 418 intel_runtime_pm_get(dev_priv);
8ef8561f
CW
419 freed_pages += i915_gem_shrink(dev_priv, -1UL,
420 I915_SHRINK_BOUND |
421 I915_SHRINK_UNBOUND |
422 I915_SHRINK_ACTIVE |
423 I915_SHRINK_VMAPS);
ea9d9768 424 intel_runtime_pm_put(dev_priv);
8ef8561f
CW
425
426 /* We also want to clear any cached iomaps as they wrap vmap */
427 list_for_each_entry_safe(vma, next,
428 &dev_priv->ggtt.base.inactive_list, vm_link) {
429 unsigned long count = vma->node.size >> PAGE_SHIFT;
430 if (vma->iomap && i915_vma_unbind(vma) == 0)
431 freed_pages += count;
432 }
e87666b5 433
8ef8561f 434out:
168cf367 435 i915_gem_shrinker_unlock_uninterruptible(dev_priv, &slu);
e87666b5
CW
436
437 *(unsigned long *)ptr += freed_pages;
438 return NOTIFY_DONE;
439}
440
eb0b44ad
DV
441/**
442 * i915_gem_shrinker_init - Initialize i915 shrinker
443 * @dev_priv: i915 device
444 *
445 * This function registers and sets up the i915 shrinker and OOM handler.
446 */
be6a0376
DV
447void i915_gem_shrinker_init(struct drm_i915_private *dev_priv)
448{
449 dev_priv->mm.shrinker.scan_objects = i915_gem_shrinker_scan;
450 dev_priv->mm.shrinker.count_objects = i915_gem_shrinker_count;
451 dev_priv->mm.shrinker.seeks = DEFAULT_SEEKS;
a8a40589 452 WARN_ON(register_shrinker(&dev_priv->mm.shrinker));
be6a0376
DV
453
454 dev_priv->mm.oom_notifier.notifier_call = i915_gem_shrinker_oom;
a8a40589 455 WARN_ON(register_oom_notifier(&dev_priv->mm.oom_notifier));
e87666b5
CW
456
457 dev_priv->mm.vmap_notifier.notifier_call = i915_gem_shrinker_vmap;
458 WARN_ON(register_vmap_purge_notifier(&dev_priv->mm.vmap_notifier));
a8a40589
ID
459}
460
461/**
462 * i915_gem_shrinker_cleanup - Clean up i915 shrinker
463 * @dev_priv: i915 device
464 *
465 * This function unregisters the i915 shrinker and OOM handler.
466 */
467void i915_gem_shrinker_cleanup(struct drm_i915_private *dev_priv)
468{
e87666b5 469 WARN_ON(unregister_vmap_purge_notifier(&dev_priv->mm.vmap_notifier));
a8a40589
ID
470 WARN_ON(unregister_oom_notifier(&dev_priv->mm.oom_notifier));
471 unregister_shrinker(&dev_priv->mm.shrinker);
be6a0376 472}
This page took 0.138347 seconds and 5 git commands to generate.