[deliverable/linux.git] / drivers / gpu / drm / i915 / i915_gem_evict.c

/*
 * Copyright © 2008-2010 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.
 *
 * Authors:
 *    Eric Anholt <eric@anholt.net>
 *    Chris Wilson <chris@chris-wilson.co.uuk>
 *
 */

#include <drm/drmP.h>
#include <drm/i915_drm.h>

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

static bool
gpu_is_idle(struct drm_i915_private *dev_priv)
{
	struct intel_engine_cs *engine;

	for_each_engine(engine, dev_priv) {
		if (intel_engine_is_active(engine))
			return false;
	}

	return true;
}

static bool
mark_free(struct i915_vma *vma, unsigned int flags, struct list_head *unwind)
{
	if (i915_vma_is_pinned(vma))
		return false;

	if (WARN_ON(!list_empty(&vma->exec_list)))
		return false;

	if (flags & PIN_NONFAULT && vma->obj->fault_mappable)
		return false;

	list_add(&vma->exec_list, unwind);
	return drm_mm_scan_add_block(&vma->node);
}

/**
 * i915_gem_evict_something - Evict vmas to make room for binding a new one
 * @vm: address space to evict from
 * @min_size: size of the desired free space
 * @alignment: alignment constraint of the desired free space
 * @cache_level: cache_level for the desired space
 * @start: start (inclusive) of the range from which to evict objects
 * @end: end (exclusive) of the range from which to evict objects
 * @flags: additional flags to control the eviction algorithm
 *
 * This function will try to evict vmas until a free space satisfying the
 * requirements is found. Callers must check first whether any such hole exists
 * already before calling this function.
 *
 * This function is used by the object/vma binding code.
 *
 * Since this function is only used to free up virtual address space it only
 * ignores pinned vmas, and not object where the backing storage itself is
 * pinned. Hence obj->pages_pin_count does not protect against eviction.
 *
 * To clarify: This is for freeing up virtual address space, not for freeing
 * memory in e.g. the shrinker.
 */
int
i915_gem_evict_something(struct i915_address_space *vm,
			 u64 min_size, u64 alignment,
			 unsigned cache_level,
			 u64 start, u64 end,
			 unsigned flags)
{
	struct drm_i915_private *dev_priv = to_i915(vm->dev);
	struct list_head eviction_list;
	struct list_head *phases[] = {
		&vm->inactive_list,
		&vm->active_list,
		NULL,
	}, **phase;
	struct i915_vma *vma, *next;
	int ret;

	trace_i915_gem_evict(vm, min_size, alignment, flags);

	/*
	 * The goal is to evict objects and amalgamate space in LRU order.
	 * The oldest idle objects reside on the inactive list, which is in
	 * retirement order. The next objects to retire are those in flight,
	 * on the active list, again in retirement order.
	 *
	 * The retirement sequence is thus:
	 *   1. Inactive objects (already retired)
	 *   2. Active objects (will stall on unbinding)
	 *
	 * On each list, the oldest objects lie at the HEAD with the freshest
	 * object on the TAIL.
	 */
	if (start != 0 || end != vm->total) {
		drm_mm_init_scan_with_range(&vm->mm, min_size,
					    alignment, cache_level,
					    start, end);
	} else
		drm_mm_init_scan(&vm->mm, min_size, alignment, cache_level);

	if (flags & PIN_NONBLOCK)
		phases[1] = NULL;

search_again:
	INIT_LIST_HEAD(&eviction_list);
	phase = phases;
	do {
		list_for_each_entry(vma, *phase, vm_link)
			if (mark_free(vma, flags, &eviction_list))
				goto found;
	} while (*++phase);

	/* Nothing found, clean up and bail out! */
	list_for_each_entry_safe(vma, next, &eviction_list, exec_list) {
		ret = drm_mm_scan_remove_block(&vma->node);
		BUG_ON(ret);

		INIT_LIST_HEAD(&vma->exec_list);
	}

	/* Can we unpin some objects such as idle hw contents,
	 * or pending flips? But since only the GGTT has global entries
	 * such as scanouts, rinbuffers and contexts, we can skip the
	 * purge when inspecting per-process local address spaces.
	 */
	if (!i915_is_ggtt(vm) || flags & PIN_NONBLOCK)
		return -ENOSPC;

	if (gpu_is_idle(dev_priv)) {
		/* If we still have pending pageflip completions, drop
		 * back to userspace to give our workqueues time to
		 * acquire our locks and unpin the old scanouts.
		 */
		return intel_has_pending_fb_unpin(vm->dev) ? -EAGAIN : -ENOSPC;
	}

	/* Not everything in the GGTT is tracked via vma (otherwise we
	 * could evict as required with minimal stalling) so we are forced
	 * to idle the GPU and explicitly retire outstanding requests in
	 * the hopes that we can then remove contexts and the like only
	 * bound by their active reference.
	 */
	ret = i915_gem_switch_to_kernel_context(dev_priv);
	if (ret)
		return ret;

	ret = i915_gem_wait_for_idle(dev_priv, true);
	if (ret)
		return ret;

	i915_gem_retire_requests(dev_priv);
	goto search_again;

found:
	/* drm_mm doesn't allow any other other operations while
	 * scanning, therefore store to-be-evicted objects on a
	 * temporary list and take a reference for all before
	 * calling unbind (which may remove the active reference
	 * of any of our objects, thus corrupting the list).
	 */
	list_for_each_entry_safe(vma, next, &eviction_list, exec_list) {
		if (drm_mm_scan_remove_block(&vma->node))
			__i915_vma_pin(vma);
		else
			list_del_init(&vma->exec_list);
	}

	/* Unbinding will emit any required flushes */
	while (!list_empty(&eviction_list)) {
		vma = list_first_entry(&eviction_list,
				       struct i915_vma,
				       exec_list);

		list_del_init(&vma->exec_list);
		__i915_vma_unpin(vma);
		if (ret == 0)
			ret = i915_vma_unbind(vma);
	}
	return ret;
}

int
i915_gem_evict_for_vma(struct i915_vma *target)
{
	struct drm_mm_node *node, *next;

	list_for_each_entry_safe(node, next,
			&target->vm->mm.head_node.node_list,
			node_list) {
		struct i915_vma *vma;
		int ret;

		if (node->start + node->size <= target->node.start)
			continue;
		if (node->start >= target->node.start + target->node.size)
			break;

		vma = container_of(node, typeof(*vma), node);

		if (i915_vma_is_pinned(vma)) {
			if (!vma->exec_entry || i915_vma_pin_count(vma) > 1)
				/* Object is pinned for some other use */
				return -EBUSY;

			/* We need to evict a buffer in the same batch */
			if (vma->exec_entry->flags & EXEC_OBJECT_PINNED)
				/* Overlapping fixed objects in the same batch */
				return -EINVAL;

			return -ENOSPC;
		}

		ret = i915_vma_unbind(vma);
		if (ret)
			return ret;
	}

	return 0;
}

/**
 * i915_gem_evict_vm - Evict all idle vmas from a vm
 * @vm: Address space to cleanse
 * @do_idle: Boolean directing whether to idle first.
 *
 * This function evicts all idles vmas from a vm. If all unpinned vmas should be
 * evicted the @do_idle needs to be set to true.
 *
 * This is used by the execbuf code as a last-ditch effort to defragment the
 * address space.
 *
 * To clarify: This is for freeing up virtual address space, not for freeing
 * memory in e.g. the shrinker.
 */
int i915_gem_evict_vm(struct i915_address_space *vm, bool do_idle)
{
	struct i915_vma *vma, *next;
	int ret;

	WARN_ON(!mutex_is_locked(&vm->dev->struct_mutex));
	trace_i915_gem_evict_vm(vm);

	if (do_idle) {
		struct drm_i915_private *dev_priv = to_i915(vm->dev);

		if (i915_is_ggtt(vm)) {
			ret = i915_gem_switch_to_kernel_context(dev_priv);
			if (ret)
				return ret;
		}

		ret = i915_gem_wait_for_idle(dev_priv, true);
		if (ret)
			return ret;

		i915_gem_retire_requests(dev_priv);
		WARN_ON(!list_empty(&vm->active_list));
	}

	list_for_each_entry_safe(vma, next, &vm->inactive_list, vm_link)
		if (!i915_vma_is_pinned(vma))
			WARN_ON(i915_vma_unbind(vma));

	return 0;
}
Commit	Line	Data
b47eb4a2 CW	1	/*
	2	* Copyright © 2008-2010 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	* Authors:
	24	* Eric Anholt <eric@anholt.net>
	25	* Chris Wilson <chris@chris-wilson.co.uuk>
	26	*
	27	*/
	28
760285e7	29	#include <drm/drmP.h>
760285e7	30	#include <drm/i915_drm.h>
74e21ac2 CW	31
	32	#include "i915_drv.h"
	33	#include "intel_drv.h"
db53a302	34	#include "i915_trace.h"
b47eb4a2	35
9332f3b1 CW	36	static bool
	37	gpu_is_idle(struct drm_i915_private *dev_priv)
	38	{
	39	struct intel_engine_cs *engine;
	40
	41	for_each_engine(engine, dev_priv) {
dcff85c8	42	if (intel_engine_is_active(engine))
9332f3b1 CW	43	return false;
	44	}
	45
	46	return true;
	47	}
	48
cd377ea9	49	static bool
82118877	50	mark_free(struct i915_vma vma, unsigned int flags, struct list_head unwind)
b47eb4a2	51	{
20dfbde4	52	if (i915_vma_is_pinned(vma))
1b50247a CW	53	return false;
1b50247a CW	54
b93dab6e DV	55	if (WARN_ON(!list_empty(&vma->exec_list)))
	56	return false;
	57
82118877 CW	58	if (flags & PIN_NONFAULT && vma->obj->fault_mappable)
	59	return false;
	60
82a55ad1	61	list_add(&vma->exec_list, unwind);
2f633156	62	return drm_mm_scan_add_block(&vma->node);
b47eb4a2 CW	63	}
b47eb4a2 CW	64
c2c1d491 DV	65	/**
c2c1d491 DV	66	* i915_gem_evict_something - Evict vmas to make room for binding a new one
c2c1d491	67	* @vm: address space to evict from
7838a63a	68	* @min_size: size of the desired free space
c2c1d491 DV	69	* @alignment: alignment constraint of the desired free space
c2c1d491 DV	70	* @cache_level: cache_level for the desired space
7838a63a DV	71	* @start: start (inclusive) of the range from which to evict objects
	72	* @end: end (exclusive) of the range from which to evict objects
	73	* @flags: additional flags to control the eviction algorithm
c2c1d491 DV	74	*
	75	* This function will try to evict vmas until a free space satisfying the
	76	* requirements is found. Callers must check first whether any such hole exists
	77	* already before calling this function.
	78	*
	79	* This function is used by the object/vma binding code.
	80	*
eb0b44ad DV	81	* Since this function is only used to free up virtual address space it only
	82	* ignores pinned vmas, and not object where the backing storage itself is
	83	* pinned. Hence obj->pages_pin_count does not protect against eviction.
	84	*
c2c1d491 DV	85	* To clarify: This is for freeing up virtual address space, not for freeing
	86	* memory in e.g. the shrinker.
	87	*/
b47eb4a2	88	int
e522ac23	89	i915_gem_evict_something(struct i915_address_space *vm,
2ffffd0f CW	90	u64 min_size, u64 alignment,
	91	unsigned cache_level,
	92	u64 start, u64 end,
1ec9e26d	93	unsigned flags)
b47eb4a2	94	{
e522ac23	95	struct drm_i915_private *dev_priv = to_i915(vm->dev);
9332f3b1 CW	96	struct list_head eviction_list;
	97	struct list_head *phases[] = {
	98	&vm->inactive_list,
	99	&vm->active_list,
	100	NULL,
	101	}, **phase;
	102	struct i915_vma vma, next;
	103	int ret;
b47eb4a2	104
e522ac23	105	trace_i915_gem_evict(vm, min_size, alignment, flags);
db53a302	106
cd377ea9 CW	107	/*
	108	* The goal is to evict objects and amalgamate space in LRU order.
	109	* The oldest idle objects reside on the inactive list, which is in
9332f3b1 CW	110	* retirement order. The next objects to retire are those in flight,
9332f3b1 CW	111	* on the active list, again in retirement order.
cd377ea9 CW	112	*
	113	* The retirement sequence is thus:
	114	* 1. Inactive objects (already retired)
9332f3b1	115	* 2. Active objects (will stall on unbinding)
cd377ea9 CW	116	*
	117	* On each list, the oldest objects lie at the HEAD with the freshest
	118	* object on the TAIL.
	119	*/
d23db88c	120	if (start != 0 \|\| end != vm->total) {
5cef07e1	121	drm_mm_init_scan_with_range(&vm->mm, min_size,
d23db88c CW	122	alignment, cache_level,
d23db88c CW	123	start, end);
f6cd1f15	124	} else
5cef07e1	125	drm_mm_init_scan(&vm->mm, min_size, alignment, cache_level);
cd377ea9	126
1ec9e26d	127	if (flags & PIN_NONBLOCK)
9332f3b1	128	phases[1] = NULL;
b47eb4a2	129
9332f3b1 CW	130	search_again:
	131	INIT_LIST_HEAD(&eviction_list);
	132	phase = phases;
	133	do {
	134	list_for_each_entry(vma, *phase, vm_link)
82118877	135	if (mark_free(vma, flags, &eviction_list))
9332f3b1 CW	136	goto found;
9332f3b1 CW	137	} while (*++phase);
cd377ea9 CW	138
cd377ea9 CW	139	/* Nothing found, clean up and bail out! */
9332f3b1	140	list_for_each_entry_safe(vma, next, &eviction_list, exec_list) {
2f633156	141	ret = drm_mm_scan_remove_block(&vma->node);
cd377ea9	142	BUG_ON(ret);
092de6f2	143
9332f3b1	144	INIT_LIST_HEAD(&vma->exec_list);
cd377ea9 CW	145	}
cd377ea9 CW	146
ad071acb	147	/* Can we unpin some objects such as idle hw contents,
9332f3b1 CW	148	* or pending flips? But since only the GGTT has global entries
	149	* such as scanouts, rinbuffers and contexts, we can skip the
	150	* purge when inspecting per-process local address spaces.
cd377ea9	151	*/
9332f3b1	152	if (!i915_is_ggtt(vm) \|\| flags & PIN_NONBLOCK)
74e21ac2	153	return -ENOSPC;
ad071acb	154
9332f3b1 CW	155	if (gpu_is_idle(dev_priv)) {
	156	/* If we still have pending pageflip completions, drop
	157	* back to userspace to give our workqueues time to
	158	* acquire our locks and unpin the old scanouts.
	159	*/
e522ac23	160	return intel_has_pending_fb_unpin(vm->dev) ? -EAGAIN : -ENOSPC;
74e21ac2 CW	161	}
74e21ac2 CW	162
9332f3b1 CW	163	/* Not everything in the GGTT is tracked via vma (otherwise we
	164	* could evict as required with minimal stalling) so we are forced
	165	* to idle the GPU and explicitly retire outstanding requests in
	166	* the hopes that we can then remove contexts and the like only
	167	* bound by their active reference.
74e21ac2	168	*/
9332f3b1 CW	169	ret = i915_gem_switch_to_kernel_context(dev_priv);
	170	if (ret)
	171	return ret;
	172
dcff85c8	173	ret = i915_gem_wait_for_idle(dev_priv, true);
9332f3b1 CW	174	if (ret)
	175	return ret;
	176
	177	i915_gem_retire_requests(dev_priv);
	178	goto search_again;
cd377ea9 CW	179
cd377ea9 CW	180	found:
e39a0150	181	/* drm_mm doesn't allow any other other operations while
9332f3b1 CW	182	* scanning, therefore store to-be-evicted objects on a
	183	* temporary list and take a reference for all before
	184	* calling unbind (which may remove the active reference
	185	* of any of our objects, thus corrupting the list).
	186	*/
	187	list_for_each_entry_safe(vma, next, &eviction_list, exec_list) {
	188	if (drm_mm_scan_remove_block(&vma->node))
20dfbde4	189	__i915_vma_pin(vma);
9332f3b1 CW	190	else
9332f3b1 CW	191	list_del_init(&vma->exec_list);
cd377ea9	192	}
b47eb4a2	193
cd377ea9	194	/* Unbinding will emit any required flushes */
e39a0150	195	while (!list_empty(&eviction_list)) {
82a55ad1 BW	196	vma = list_first_entry(&eviction_list,
82a55ad1 BW	197	struct i915_vma,
432e58ed	198	exec_list);
8637b407	199
8637b407	200	list_del_init(&vma->exec_list);
20dfbde4	201	__i915_vma_unpin(vma);
e39a0150	202	if (ret == 0)
82a55ad1	203	ret = i915_vma_unbind(vma);
b47eb4a2	204	}
e39a0150	205	return ret;
b47eb4a2 CW	206	}
b47eb4a2 CW	207
506a8e87 CW	208	int
	209	i915_gem_evict_for_vma(struct i915_vma *target)
	210	{
	211	struct drm_mm_node node, next;
	212
	213	list_for_each_entry_safe(node, next,
	214	&target->vm->mm.head_node.node_list,
	215	node_list) {
	216	struct i915_vma *vma;
	217	int ret;
	218
	219	if (node->start + node->size <= target->node.start)
	220	continue;
	221	if (node->start >= target->node.start + target->node.size)
	222	break;
	223
	224	vma = container_of(node, typeof(*vma), node);
	225
20dfbde4 CW	226	if (i915_vma_is_pinned(vma)) {
20dfbde4 CW	227	if (!vma->exec_entry \|\| i915_vma_pin_count(vma) > 1)
506a8e87 CW	228	/* Object is pinned for some other use */
	229	return -EBUSY;
	230
	231	/* We need to evict a buffer in the same batch */
	232	if (vma->exec_entry->flags & EXEC_OBJECT_PINNED)
	233	/* Overlapping fixed objects in the same batch */
	234	return -EINVAL;
	235
	236	return -ENOSPC;
	237	}
	238
	239	ret = i915_vma_unbind(vma);
	240	if (ret)
	241	return ret;
	242	}
	243
	244	return 0;
	245	}
	246
68c8c17f	247	/**
c2c1d491	248	* i915_gem_evict_vm - Evict all idle vmas from a vm
c2c1d491	249	* @vm: Address space to cleanse
68c8c17f BW	250	* @do_idle: Boolean directing whether to idle first.
68c8c17f BW	251	*
c2c1d491 DV	252	* This function evicts all idles vmas from a vm. If all unpinned vmas should be
c2c1d491 DV	253	* evicted the @do_idle needs to be set to true.
68c8c17f	254	*
c2c1d491 DV	255	* This is used by the execbuf code as a last-ditch effort to defragment the
	256	* address space.
	257	*
	258	* To clarify: This is for freeing up virtual address space, not for freeing
	259	* memory in e.g. the shrinker.
68c8c17f BW	260	*/
68c8c17f BW	261	int i915_gem_evict_vm(struct i915_address_space *vm, bool do_idle)
7b796122 BW	262	{
	263	struct i915_vma vma, next;
	264	int ret;
	265
b9b5dce5	266	WARN_ON(!mutex_is_locked(&vm->dev->struct_mutex));
bcccff84 BW	267	trace_i915_gem_evict_vm(vm);
bcccff84 BW	268
7b796122	269	if (do_idle) {
6e5a5beb CW	270	struct drm_i915_private *dev_priv = to_i915(vm->dev);
6e5a5beb CW	271
883445d4	272	if (i915_is_ggtt(vm)) {
945657b4	273	ret = i915_gem_switch_to_kernel_context(dev_priv);
883445d4 CW	274	if (ret)
	275	return ret;
	276	}
6e5a5beb	277
dcff85c8	278	ret = i915_gem_wait_for_idle(dev_priv, true);
7b796122 BW	279	if (ret)
	280	return ret;
	281
6e5a5beb	282	i915_gem_retire_requests(dev_priv);
b9b5dce5	283	WARN_ON(!list_empty(&vm->active_list));
7b796122 BW	284	}
7b796122 BW	285
1c7f4bca	286	list_for_each_entry_safe(vma, next, &vm->inactive_list, vm_link)
20dfbde4	287	if (!i915_vma_is_pinned(vma))
7b796122 BW	288	WARN_ON(i915_vma_unbind(vma));
	289
	290	return 0;
	291	}