[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / i915 / i915_gem_shrinker.c

/*
 * Copyright © 2008-2015 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 */

#include <linux/oom.h>
#include <linux/shmem_fs.h>
#include <linux/slab.h>
#include <linux/swap.h>
#include <linux/pci.h>
#include <linux/dma-buf.h>
#include <linux/vmalloc.h>
#include <drm/drmP.h>
#include <drm/i915_drm.h>

#include "i915_drv.h"
#include "i915_trace.h"

static bool mutex_is_locked_by(struct mutex *mutex, struct task_struct *task)
{
	if (!mutex_is_locked(mutex))
		return false;

#if defined(CONFIG_DEBUG_MUTEXES) || defined(CONFIG_MUTEX_SPIN_ON_OWNER)
	return mutex->owner == task;
#else
	/* Since UP may be pre-empted, we cannot assume that we own the lock */
	return false;
#endif
}

static bool any_vma_pinned(struct drm_i915_gem_object *obj)
{
	struct i915_vma *vma;

	list_for_each_entry(vma, &obj->vma_list, obj_link)
		if (i915_vma_is_pinned(vma))
			return true;

	return false;
}

static bool swap_available(void)
{
	return get_nr_swap_pages() > 0;
}

static bool can_release_pages(struct drm_i915_gem_object *obj)
{
	/* Only shmemfs objects are backed by swap */
	if (!obj->base.filp)
		return false;

	/* Only report true if by unbinding the object and putting its pages
	 * we can actually make forward progress towards freeing physical
	 * pages.
	 *
	 * If the pages are pinned for any other reason than being bound
	 * to the GPU, simply unbinding from the GPU is not going to succeed
	 * in releasing our pin count on the pages themselves.
	 */
	if (obj->pages_pin_count > obj->bind_count)
		return false;

	if (any_vma_pinned(obj))
		return false;

	/* We can only return physical pages to the system if we can either
	 * discard the contents (because the user has marked them as being
	 * purgeable) or if we can move their contents out to swap.
	 */
	return swap_available() || obj->madv == I915_MADV_DONTNEED;
}

/**
 * i915_gem_shrink - Shrink buffer object caches
 * @dev_priv: i915 device
 * @target: amount of memory to make available, in pages
 * @flags: control flags for selecting cache types
 *
 * This function is the main interface to the shrinker. It will try to release
 * up to @target pages of main memory backing storage from buffer objects.
 * Selection of the specific caches can be done with @flags. This is e.g. useful
 * when purgeable objects should be removed from caches preferentially.
 *
 * Note that it's not guaranteed that released amount is actually available as
 * free system memory - the pages might still be in-used to due to other reasons
 * (like cpu mmaps) or the mm core has reused them before we could grab them.
 * Therefore code that needs to explicitly shrink buffer objects caches (e.g. to
 * avoid deadlocks in memory reclaim) must fall back to i915_gem_shrink_all().
 *
 * Also note that any kind of pinning (both per-vma address space pins and
 * backing storage pins at the buffer object level) result in the shrinker code
 * having to skip the object.
 *
 * Returns:
 * The number of pages of backing storage actually released.
 */
unsigned long
i915_gem_shrink(struct drm_i915_private *dev_priv,
		unsigned long target, unsigned flags)
{
	const struct {
		struct list_head *list;
		unsigned int bit;
	} phases[] = {
		{ &dev_priv->mm.unbound_list, I915_SHRINK_UNBOUND },
		{ &dev_priv->mm.bound_list, I915_SHRINK_BOUND },
		{ NULL, 0 },
	}, *phase;
	unsigned long count = 0;

	trace_i915_gem_shrink(dev_priv, target, flags);
	i915_gem_retire_requests(dev_priv);

	/*
	 * Unbinding of objects will require HW access; Let us not wake the
	 * device just to recover a little memory. If absolutely necessary,
	 * we will force the wake during oom-notifier.
	 */
	if ((flags & I915_SHRINK_BOUND) &&
	    !intel_runtime_pm_get_if_in_use(dev_priv))
		flags &= ~I915_SHRINK_BOUND;

	/*
	 * As we may completely rewrite the (un)bound list whilst unbinding
	 * (due to retiring requests) we have to strictly process only
	 * one element of the list at the time, and recheck the list
	 * on every iteration.
	 *
	 * In particular, we must hold a reference whilst removing the
	 * object as we may end up waiting for and/or retiring the objects.
	 * This might release the final reference (held by the active list)
	 * and result in the object being freed from under us. This is
	 * similar to the precautions the eviction code must take whilst
	 * removing objects.
	 *
	 * Also note that although these lists do not hold a reference to
	 * the object we can safely grab one here: The final object
	 * unreferencing and the bound_list are both protected by the
	 * dev->struct_mutex and so we won't ever be able to observe an
	 * object on the bound_list with a reference count equals 0.
	 */
	for (phase = phases; phase->list; phase++) {
		struct list_head still_in_list;
		struct drm_i915_gem_object *obj;

		if ((flags & phase->bit) == 0)
			continue;

		INIT_LIST_HEAD(&still_in_list);
		while (count < target &&
		       (obj = list_first_entry_or_null(phase->list,
						       typeof(*obj),
						       global_list))) {
			list_move_tail(&obj->global_list, &still_in_list);

			if (flags & I915_SHRINK_PURGEABLE &&
			    obj->madv != I915_MADV_DONTNEED)
				continue;

			if (flags & I915_SHRINK_VMAPS &&
			    !is_vmalloc_addr(obj->mapping))
				continue;

			if ((flags & I915_SHRINK_ACTIVE) == 0 && obj->active)
				continue;

			if (!can_release_pages(obj))
				continue;

			i915_gem_object_get(obj);

			/* For the unbound phase, this should be a no-op! */
			i915_gem_object_unbind(obj);
			if (i915_gem_object_put_pages(obj) == 0)
				count += obj->base.size >> PAGE_SHIFT;

			i915_gem_object_put(obj);
		}
		list_splice(&still_in_list, phase->list);
	}

	if (flags & I915_SHRINK_BOUND)
		intel_runtime_pm_put(dev_priv);

	i915_gem_retire_requests(dev_priv);

	return count;
}

/**
 * i915_gem_shrink_all - Shrink buffer object caches completely
 * @dev_priv: i915 device
 *
 * This is a simple wraper around i915_gem_shrink() to aggressively shrink all
 * caches completely. It also first waits for and retires all outstanding
 * requests to also be able to release backing storage for active objects.
 *
 * This should only be used in code to intentionally quiescent the gpu or as a
 * last-ditch effort when memory seems to have run out.
 *
 * Returns:
 * The number of pages of backing storage actually released.
 */
unsigned long i915_gem_shrink_all(struct drm_i915_private *dev_priv)
{
	return i915_gem_shrink(dev_priv, -1UL,
			       I915_SHRINK_BOUND |
			       I915_SHRINK_UNBOUND |
			       I915_SHRINK_ACTIVE);
}

static bool i915_gem_shrinker_lock(struct drm_device *dev, bool *unlock)
{
	if (!mutex_trylock(&dev->struct_mutex)) {
		if (!mutex_is_locked_by(&dev->struct_mutex, current))
			return false;

		if (to_i915(dev)->mm.shrinker_no_lock_stealing)
			return false;

		*unlock = false;
	} else
		*unlock = true;

	return true;
}

static unsigned long
i915_gem_shrinker_count(struct shrinker *shrinker, struct shrink_control *sc)
{
	struct drm_i915_private *dev_priv =
		container_of(shrinker, struct drm_i915_private, mm.shrinker);
	struct drm_device *dev = &dev_priv->drm;
	struct drm_i915_gem_object *obj;
	unsigned long count;
	bool unlock;

	if (!i915_gem_shrinker_lock(dev, &unlock))
		return 0;

	i915_gem_retire_requests(dev_priv);

	count = 0;
	list_for_each_entry(obj, &dev_priv->mm.unbound_list, global_list)
		if (can_release_pages(obj))
			count += obj->base.size >> PAGE_SHIFT;

	list_for_each_entry(obj, &dev_priv->mm.bound_list, global_list) {
		if (!obj->active && can_release_pages(obj))
			count += obj->base.size >> PAGE_SHIFT;
	}

	if (unlock)
		mutex_unlock(&dev->struct_mutex);

	return count;
}

static unsigned long
i915_gem_shrinker_scan(struct shrinker *shrinker, struct shrink_control *sc)
{
	struct drm_i915_private *dev_priv =
		container_of(shrinker, struct drm_i915_private, mm.shrinker);
	struct drm_device *dev = &dev_priv->drm;
	unsigned long freed;
	bool unlock;

	if (!i915_gem_shrinker_lock(dev, &unlock))
		return SHRINK_STOP;

	freed = i915_gem_shrink(dev_priv,
				sc->nr_to_scan,
				I915_SHRINK_BOUND |
				I915_SHRINK_UNBOUND |
				I915_SHRINK_PURGEABLE);
	if (freed < sc->nr_to_scan)
		freed += i915_gem_shrink(dev_priv,
					 sc->nr_to_scan - freed,
					 I915_SHRINK_BOUND |
					 I915_SHRINK_UNBOUND);
	if (unlock)
		mutex_unlock(&dev->struct_mutex);

	return freed;
}

struct shrinker_lock_uninterruptible {
	bool was_interruptible;
	bool unlock;
};

static bool
i915_gem_shrinker_lock_uninterruptible(struct drm_i915_private *dev_priv,
				       struct shrinker_lock_uninterruptible *slu,
				       int timeout_ms)
{
	unsigned long timeout = msecs_to_jiffies(timeout_ms) + 1;

	while (!i915_gem_shrinker_lock(&dev_priv->drm, &slu->unlock)) {
		schedule_timeout_killable(1);
		if (fatal_signal_pending(current))
			return false;
		if (--timeout == 0) {
			pr_err("Unable to lock GPU to purge memory.\n");
			return false;
		}
	}

	slu->was_interruptible = dev_priv->mm.interruptible;
	dev_priv->mm.interruptible = false;
	return true;
}

static void
i915_gem_shrinker_unlock_uninterruptible(struct drm_i915_private *dev_priv,
					 struct shrinker_lock_uninterruptible *slu)
{
	dev_priv->mm.interruptible = slu->was_interruptible;
	if (slu->unlock)
		mutex_unlock(&dev_priv->drm.struct_mutex);
}

static int
i915_gem_shrinker_oom(struct notifier_block *nb, unsigned long event, void *ptr)
{
	struct drm_i915_private *dev_priv =
		container_of(nb, struct drm_i915_private, mm.oom_notifier);
	struct shrinker_lock_uninterruptible slu;
	struct drm_i915_gem_object *obj;
	unsigned long unevictable, bound, unbound, freed_pages;

	if (!i915_gem_shrinker_lock_uninterruptible(dev_priv, &slu, 5000))
		return NOTIFY_DONE;

	intel_runtime_pm_get(dev_priv);
	freed_pages = i915_gem_shrink_all(dev_priv);
	intel_runtime_pm_put(dev_priv);

	/* Because we may be allocating inside our own driver, we cannot
	 * assert that there are no objects with pinned pages that are not
	 * being pointed to by hardware.
	 */
	unbound = bound = unevictable = 0;
	list_for_each_entry(obj, &dev_priv->mm.unbound_list, global_list) {
		if (!can_release_pages(obj))
			unevictable += obj->base.size >> PAGE_SHIFT;
		else
			unbound += obj->base.size >> PAGE_SHIFT;
	}
	list_for_each_entry(obj, &dev_priv->mm.bound_list, global_list) {
		if (!can_release_pages(obj))
			unevictable += obj->base.size >> PAGE_SHIFT;
		else
			bound += obj->base.size >> PAGE_SHIFT;
	}

	i915_gem_shrinker_unlock_uninterruptible(dev_priv, &slu);

	if (freed_pages || unbound || bound)
		pr_info("Purging GPU memory, %lu pages freed, "
			"%lu pages still pinned.\n",
			freed_pages, unevictable);
	if (unbound || bound)
		pr_err("%lu and %lu pages still available in the "
		       "bound and unbound GPU page lists.\n",
		       bound, unbound);

	*(unsigned long *)ptr += freed_pages;
	return NOTIFY_DONE;
}

static int
i915_gem_shrinker_vmap(struct notifier_block *nb, unsigned long event, void *ptr)
{
	struct drm_i915_private *dev_priv =
		container_of(nb, struct drm_i915_private, mm.vmap_notifier);
	struct shrinker_lock_uninterruptible slu;
	struct i915_vma *vma, *next;
	unsigned long freed_pages = 0;
	int ret;

	if (!i915_gem_shrinker_lock_uninterruptible(dev_priv, &slu, 5000))
		return NOTIFY_DONE;

	/* Force everything onto the inactive lists */
	ret = i915_gem_wait_for_idle(dev_priv);
	if (ret)
		goto out;

	intel_runtime_pm_get(dev_priv);
	freed_pages += i915_gem_shrink(dev_priv, -1UL,
				       I915_SHRINK_BOUND |
				       I915_SHRINK_UNBOUND |
				       I915_SHRINK_ACTIVE |
				       I915_SHRINK_VMAPS);
	intel_runtime_pm_put(dev_priv);

	/* We also want to clear any cached iomaps as they wrap vmap */
	list_for_each_entry_safe(vma, next,
				 &dev_priv->ggtt.base.inactive_list, vm_link) {
		unsigned long count = vma->node.size >> PAGE_SHIFT;
		if (vma->iomap && i915_vma_unbind(vma) == 0)
			freed_pages += count;
	}

out:
	i915_gem_shrinker_unlock_uninterruptible(dev_priv, &slu);

	*(unsigned long *)ptr += freed_pages;
	return NOTIFY_DONE;
}

/**
 * i915_gem_shrinker_init - Initialize i915 shrinker
 * @dev_priv: i915 device
 *
 * This function registers and sets up the i915 shrinker and OOM handler.
 */
void i915_gem_shrinker_init(struct drm_i915_private *dev_priv)
{
	dev_priv->mm.shrinker.scan_objects = i915_gem_shrinker_scan;
	dev_priv->mm.shrinker.count_objects = i915_gem_shrinker_count;
	dev_priv->mm.shrinker.seeks = DEFAULT_SEEKS;
	WARN_ON(register_shrinker(&dev_priv->mm.shrinker));

	dev_priv->mm.oom_notifier.notifier_call = i915_gem_shrinker_oom;
	WARN_ON(register_oom_notifier(&dev_priv->mm.oom_notifier));

	dev_priv->mm.vmap_notifier.notifier_call = i915_gem_shrinker_vmap;
	WARN_ON(register_vmap_purge_notifier(&dev_priv->mm.vmap_notifier));
}

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