[mirror_ubuntu-bionic-kernel.git] / include / drm / drm_mm.h

/**************************************************************************
 *
 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
 * All Rights Reserved.
 *
 * 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, sub license, 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 NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS 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:
 * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
 */

#ifndef _DRM_MM_H_
#define _DRM_MM_H_

/*
 * Generic range manager structs
 */
#include <linux/bug.h>
#include <linux/rbtree.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#ifdef CONFIG_DEBUG_FS
#include <linux/seq_file.h>
#endif
#ifdef CONFIG_DRM_DEBUG_MM
#include <linux/stackdepot.h>
#endif

#ifdef CONFIG_DRM_DEBUG_MM
#define DRM_MM_BUG_ON(expr) BUG_ON(expr)
#else
#define DRM_MM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr)
#endif

enum drm_mm_search_flags {
	DRM_MM_SEARCH_DEFAULT =		0,
	DRM_MM_SEARCH_BEST =		1 << 0,
	DRM_MM_SEARCH_BELOW =		1 << 1,
};

enum drm_mm_allocator_flags {
	DRM_MM_CREATE_DEFAULT =		0,
	DRM_MM_CREATE_TOP =		1 << 0,
};

#define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT
#define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP

struct drm_mm_node {
	struct list_head node_list;
	struct list_head hole_stack;
	struct rb_node rb;
	unsigned hole_follows : 1;
	unsigned scanned_block : 1;
	unsigned scanned_prev_free : 1;
	unsigned scanned_next_free : 1;
	unsigned scanned_preceeds_hole : 1;
	unsigned allocated : 1;
	unsigned long color;
	u64 start;
	u64 size;
	u64 __subtree_last;
	struct drm_mm *mm;
#ifdef CONFIG_DRM_DEBUG_MM
	depot_stack_handle_t stack;
#endif
};

struct drm_mm {
	/* List of all memory nodes that immediately precede a free hole. */
	struct list_head hole_stack;
	/* head_node.node_list is the list of all memory nodes, ordered
	 * according to the (increasing) start address of the memory node. */
	struct drm_mm_node head_node;
	/* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */
	struct rb_root interval_tree;

	unsigned int scan_check_range : 1;
	unsigned int scanned_blocks;
	unsigned long scan_color;
	u64 scan_alignment;
	u64 scan_size;
	u64 scan_hit_start;
	u64 scan_hit_end;
	u64 scan_start;
	u64 scan_end;
	struct drm_mm_node *prev_scanned_node;

	void (*color_adjust)(const struct drm_mm_node *node,
			     unsigned long color,
			     u64 *start, u64 *end);
};

/**
 * drm_mm_node_allocated - checks whether a node is allocated
 * @node: drm_mm_node to check
 *
 * Drivers should use this helpers for proper encapusulation of drm_mm
 * internals.
 *
 * Returns:
 * True if the @node is allocated.
 */
static inline bool drm_mm_node_allocated(const struct drm_mm_node *node)
{
	return node->allocated;
}

/**
 * drm_mm_initialized - checks whether an allocator is initialized
 * @mm: drm_mm to check
 *
 * Drivers should use this helpers for proper encapusulation of drm_mm
 * internals.
 *
 * Returns:
 * True if the @mm is initialized.
 */
static inline bool drm_mm_initialized(const struct drm_mm *mm)
{
	return mm->hole_stack.next;
}

static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node)
{
	return hole_node->start + hole_node->size;
}

/**
 * drm_mm_hole_node_start - computes the start of the hole following @node
 * @hole_node: drm_mm_node which implicitly tracks the following hole
 *
 * This is useful for driver-sepific debug dumpers. Otherwise drivers should not
 * inspect holes themselves. Drivers must check first whether a hole indeed
 * follows by looking at node->hole_follows.
 *
 * Returns:
 * Start of the subsequent hole.
 */
static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node)
{
	DRM_MM_BUG_ON(!hole_node->hole_follows);
	return __drm_mm_hole_node_start(hole_node);
}

static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node)
{
	return list_next_entry(hole_node, node_list)->start;
}

/**
 * drm_mm_hole_node_end - computes the end of the hole following @node
 * @hole_node: drm_mm_node which implicitly tracks the following hole
 *
 * This is useful for driver-sepific debug dumpers. Otherwise drivers should not
 * inspect holes themselves. Drivers must check first whether a hole indeed
 * follows by looking at node->hole_follows.
 *
 * Returns:
 * End of the subsequent hole.
 */
static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node)
{
	return __drm_mm_hole_node_end(hole_node);
}

/**
 * drm_mm_nodes - list of nodes under the drm_mm range manager
 * @mm: the struct drm_mm range manger
 *
 * As the drm_mm range manager hides its node_list deep with its
 * structure, extracting it looks painful and repetitive. This is
 * not expected to be used outside of the drm_mm_for_each_node()
 * macros and similar internal functions.
 *
 * Returns:
 * The node list, may be empty.
 */
#define drm_mm_nodes(mm) (&(mm)->head_node.node_list)

/**
 * drm_mm_for_each_node - iterator to walk over all allocated nodes
 * @entry: drm_mm_node structure to assign to in each iteration step
 * @mm: drm_mm allocator to walk
 *
 * This iterator walks over all nodes in the range allocator. It is implemented
 * with list_for_each, so not save against removal of elements.
 */
#define drm_mm_for_each_node(entry, mm) \
	list_for_each_entry(entry, drm_mm_nodes(mm), node_list)

/**
 * drm_mm_for_each_node_safe - iterator to walk over all allocated nodes
 * @entry: drm_mm_node structure to assign to in each iteration step
 * @next: drm_mm_node structure to store the next step
 * @mm: drm_mm allocator to walk
 *
 * This iterator walks over all nodes in the range allocator. It is implemented
 * with list_for_each_safe, so save against removal of elements.
 */
#define drm_mm_for_each_node_safe(entry, next, mm) \
	list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list)

#define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \
	for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
	     &entry->hole_stack != &(mm)->hole_stack ? \
	     hole_start = drm_mm_hole_node_start(entry), \
	     hole_end = drm_mm_hole_node_end(entry), \
	     1 : 0; \
	     entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack))

/**
 * drm_mm_for_each_hole - iterator to walk over all holes
 * @entry: drm_mm_node used internally to track progress
 * @mm: drm_mm allocator to walk
 * @hole_start: ulong variable to assign the hole start to on each iteration
 * @hole_end: ulong variable to assign the hole end to on each iteration
 *
 * This iterator walks over all holes in the range allocator. It is implemented
 * with list_for_each, so not save against removal of elements. @entry is used
 * internally and will not reflect a real drm_mm_node for the very first hole.
 * Hence users of this iterator may not access it.
 *
 * Implementation Note:
 * We need to inline list_for_each_entry in order to be able to set hole_start
 * and hole_end on each iteration while keeping the macro sane.
 *
 * The __drm_mm_for_each_hole version is similar, but with added support for
 * going backwards.
 */
#define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
	__drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0)

/*
 * Basic range manager support (drm_mm.c)
 */
int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node);

int drm_mm_insert_node_generic(struct drm_mm *mm,
			       struct drm_mm_node *node,
			       u64 size,
			       u64 alignment,
			       unsigned long color,
			       enum drm_mm_search_flags sflags,
			       enum drm_mm_allocator_flags aflags);
/**
 * drm_mm_insert_node - search for space and insert @node
 * @mm: drm_mm to allocate from
 * @node: preallocate node to insert
 * @size: size of the allocation
 * @alignment: alignment of the allocation
 * @flags: flags to fine-tune the allocation
 *
 * This is a simplified version of drm_mm_insert_node_generic() with @color set
 * to 0.
 *
 * The preallocated node must be cleared to 0.
 *
 * Returns:
 * 0 on success, -ENOSPC if there's no suitable hole.
 */
static inline int drm_mm_insert_node(struct drm_mm *mm,
				     struct drm_mm_node *node,
				     u64 size,
				     u64 alignment,
				     enum drm_mm_search_flags flags)
{
	return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags,
					  DRM_MM_CREATE_DEFAULT);
}

int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
					struct drm_mm_node *node,
					u64 size,
					u64 alignment,
					unsigned long color,
					u64 start,
					u64 end,
					enum drm_mm_search_flags sflags,
					enum drm_mm_allocator_flags aflags);
/**
 * drm_mm_insert_node_in_range - ranged search for space and insert @node
 * @mm: drm_mm to allocate from
 * @node: preallocate node to insert
 * @size: size of the allocation
 * @alignment: alignment of the allocation
 * @start: start of the allowed range for this node
 * @end: end of the allowed range for this node
 * @flags: flags to fine-tune the allocation
 *
 * This is a simplified version of drm_mm_insert_node_in_range_generic() with
 * @color set to 0.
 *
 * The preallocated node must be cleared to 0.
 *
 * Returns:
 * 0 on success, -ENOSPC if there's no suitable hole.
 */
static inline int drm_mm_insert_node_in_range(struct drm_mm *mm,
					      struct drm_mm_node *node,
					      u64 size,
					      u64 alignment,
					      u64 start,
					      u64 end,
					      enum drm_mm_search_flags flags)
{
	return drm_mm_insert_node_in_range_generic(mm, node, size, alignment,
						   0, start, end, flags,
						   DRM_MM_CREATE_DEFAULT);
}

void drm_mm_remove_node(struct drm_mm_node *node);
void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
void drm_mm_init(struct drm_mm *mm, u64 start, u64 size);
void drm_mm_takedown(struct drm_mm *mm);
bool drm_mm_clean(const struct drm_mm *mm);

struct drm_mm_node *
__drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last);

/**
 * drm_mm_for_each_node_in_range - iterator to walk over a range of
 * allocated nodes
 * @node__: drm_mm_node structure to assign to in each iteration step
 * @mm__: drm_mm allocator to walk
 * @start__: starting offset, the first node will overlap this
 * @end__: ending offset, the last node will start before this (but may overlap)
 *
 * This iterator walks over all nodes in the range allocator that lie
 * between @start and @end. It is implemented similarly to list_for_each(),
 * but using the internal interval tree to accelerate the search for the
 * starting node, and so not safe against removal of elements. It assumes
 * that @end is within (or is the upper limit of) the drm_mm allocator.
 */
#define drm_mm_for_each_node_in_range(node__, mm__, start__, end__)	\
	for (node__ = __drm_mm_interval_first((mm__), (start__), (end__)-1); \
	     node__ && node__->start < (end__);				\
	     node__ = list_next_entry(node__, node_list))

void drm_mm_init_scan(struct drm_mm *mm,
		      u64 size,
		      u64 alignment,
		      unsigned long color);
void drm_mm_init_scan_with_range(struct drm_mm *mm,
				 u64 size,
				 u64 alignment,
				 unsigned long color,
				 u64 start,
				 u64 end);
bool drm_mm_scan_add_block(struct drm_mm_node *node);
bool drm_mm_scan_remove_block(struct drm_mm_node *node);

void drm_mm_debug_table(const struct drm_mm *mm, const char *prefix);
#ifdef CONFIG_DEBUG_FS
int drm_mm_dump_table(struct seq_file *m, const struct drm_mm *mm);
#endif

#endif
Commit	Line	Data
249d6048 JG	1	/**************************************************************************
	2	*
	3	* Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
	4	* All Rights Reserved.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a
	7	* copy of this software and associated documentation files (the
	8	* "Software"), to deal in the Software without restriction, including
	9	* without limitation the rights to use, copy, modify, merge, publish,
	10	* distribute, sub license, and/or sell copies of the Software, and to
	11	* permit persons to whom the Software is furnished to do so, subject to
	12	* the following conditions:
	13	*
	14	* The above copyright notice and this permission notice (including the
	15	* next paragraph) shall be included in all copies or substantial portions
	16	* of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	21	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	22	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	23	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	24	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	25	*
	26	*
	27	**************************************************************************/
	28	/*
	29	* Authors:
	30	* Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
	31	*/
	32
	33	#ifndef _DRM_MM_H_
	34	#define _DRM_MM_H_
	35
	36	/*
	37	* Generic range manager structs
	38	*/
86e81f0e	39	#include <linux/bug.h>
202b52b7	40	#include <linux/rbtree.h>
86e81f0e	41	#include <linux/kernel.h>
249d6048	42	#include <linux/list.h>
86e81f0e	43	#include <linux/spinlock.h>
f1938cd6 DA	44	#ifdef CONFIG_DEBUG_FS
	45	#include <linux/seq_file.h>
	46	#endif
5705670d CW	47	#ifdef CONFIG_DRM_DEBUG_MM
	48	#include <linux/stackdepot.h>
	49	#endif
249d6048	50
b3ee963f CW	51	#ifdef CONFIG_DRM_DEBUG_MM
	52	#define DRM_MM_BUG_ON(expr) BUG_ON(expr)
	53	#else
	54	#define DRM_MM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr)
	55	#endif
	56
31e5d7c6 DH	57	enum drm_mm_search_flags {
	58	DRM_MM_SEARCH_DEFAULT = 0,
	59	DRM_MM_SEARCH_BEST = 1 << 0,
62347f9e	60	DRM_MM_SEARCH_BELOW = 1 << 1,
31e5d7c6 DH	61	};
31e5d7c6 DH	62
62347f9e LK	63	enum drm_mm_allocator_flags {
	64	DRM_MM_CREATE_DEFAULT = 0,
	65	DRM_MM_CREATE_TOP = 1 << 0,
	66	};
	67
	68	#define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT
	69	#define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP
	70
249d6048	71	struct drm_mm_node {
d1024ce9	72	struct list_head node_list;
ea7b1dd4	73	struct list_head hole_stack;
202b52b7	74	struct rb_node rb;
ea7b1dd4	75	unsigned hole_follows : 1;
709ea971 DV	76	unsigned scanned_block : 1;
	77	unsigned scanned_prev_free : 1;
	78	unsigned scanned_next_free : 1;
ea7b1dd4	79	unsigned scanned_preceeds_hole : 1;
b0b7af18	80	unsigned allocated : 1;
6b9d89b4	81	unsigned long color;
440fd528 TR	82	u64 start;
440fd528 TR	83	u64 size;
202b52b7	84	u64 __subtree_last;
249d6048	85	struct drm_mm *mm;
5705670d CW	86	#ifdef CONFIG_DRM_DEBUG_MM
	87	depot_stack_handle_t stack;
	88	#endif
249d6048 JG	89	};
	90
	91	struct drm_mm {
25985edc	92	/* List of all memory nodes that immediately precede a free hole. */
ea7b1dd4 DV	93	struct list_head hole_stack;
	94	/* head_node.node_list is the list of all memory nodes, ordered
	95	* according to the (increasing) start address of the memory node. */
	96	struct drm_mm_node head_node;
202b52b7 CW	97	/* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */
	98	struct rb_root interval_tree;
	99
d935cc61	100	unsigned int scan_check_range : 1;
71733207	101	unsigned int scanned_blocks;
6b9d89b4	102	unsigned long scan_color;
71733207	103	u64 scan_alignment;
440fd528 TR	104	u64 scan_size;
	105	u64 scan_hit_start;
	106	u64 scan_hit_end;
440fd528 TR	107	u64 scan_start;
440fd528 TR	108	u64 scan_end;
ae0cec28	109	struct drm_mm_node *prev_scanned_node;
6b9d89b4	110
45b186f1 CW	111	void (color_adjust)(const struct drm_mm_node node,
45b186f1 CW	112	unsigned long color,
440fd528	113	u64 start, u64 end);
249d6048 JG	114	};
249d6048 JG	115
e18c0412 DV	116	/**
	117	* drm_mm_node_allocated - checks whether a node is allocated
	118	* @node: drm_mm_node to check
	119	*
	120	* Drivers should use this helpers for proper encapusulation of drm_mm
	121	* internals.
	122	*
	123	* Returns:
	124	* True if the @node is allocated.
	125	*/
45b186f1	126	static inline bool drm_mm_node_allocated(const struct drm_mm_node *node)
b0b7af18 DV	127	{
	128	return node->allocated;
	129	}
	130
e18c0412 DV	131	/**
	132	* drm_mm_initialized - checks whether an allocator is initialized
	133	* @mm: drm_mm to check
	134	*
	135	* Drivers should use this helpers for proper encapusulation of drm_mm
	136	* internals.
	137	*
	138	* Returns:
	139	* True if the @mm is initialized.
	140	*/
45b186f1	141	static inline bool drm_mm_initialized(const struct drm_mm *mm)
31a5b8ce	142	{
ea7b1dd4	143	return mm->hole_stack.next;
31a5b8ce	144	}
9e8944ab	145
45b186f1	146	static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node)
9e8944ab CW	147	{
	148	return hole_node->start + hole_node->size;
	149	}
	150
e18c0412 DV	151	/**
	152	* drm_mm_hole_node_start - computes the start of the hole following @node
	153	* @hole_node: drm_mm_node which implicitly tracks the following hole
	154	*
	155	* This is useful for driver-sepific debug dumpers. Otherwise drivers should not
	156	* inspect holes themselves. Drivers must check first whether a hole indeed
	157	* follows by looking at node->hole_follows.
	158	*
	159	* Returns:
	160	* Start of the subsequent hole.
	161	*/
45b186f1	162	static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node)
9e8944ab	163	{
b3ee963f	164	DRM_MM_BUG_ON(!hole_node->hole_follows);
9e8944ab CW	165	return __drm_mm_hole_node_start(hole_node);
	166	}
	167
45b186f1	168	static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node)
9e8944ab	169	{
87069f44	170	return list_next_entry(hole_node, node_list)->start;
9e8944ab CW	171	}
9e8944ab CW	172
e18c0412 DV	173	/**
	174	* drm_mm_hole_node_end - computes the end of the hole following @node
	175	* @hole_node: drm_mm_node which implicitly tracks the following hole
	176	*
	177	* This is useful for driver-sepific debug dumpers. Otherwise drivers should not
	178	* inspect holes themselves. Drivers must check first whether a hole indeed
	179	* follows by looking at node->hole_follows.
	180	*
	181	* Returns:
	182	* End of the subsequent hole.
	183	*/
45b186f1	184	static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node)
9e8944ab CW	185	{
	186	return __drm_mm_hole_node_end(hole_node);
	187	}
	188
2bc98c86 CW	189	/**
	190	* drm_mm_nodes - list of nodes under the drm_mm range manager
	191	* @mm: the struct drm_mm range manger
	192	*
	193	* As the drm_mm range manager hides its node_list deep with its
	194	* structure, extracting it looks painful and repetitive. This is
	195	* not expected to be used outside of the drm_mm_for_each_node()
	196	* macros and similar internal functions.
	197	*
	198	* Returns:
	199	* The node list, may be empty.
	200	*/
	201	#define drm_mm_nodes(mm) (&(mm)->head_node.node_list)
ad579002	202
e18c0412 DV	203	/**
	204	* drm_mm_for_each_node - iterator to walk over all allocated nodes
	205	* @entry: drm_mm_node structure to assign to in each iteration step
	206	* @mm: drm_mm allocator to walk
	207	*
	208	* This iterator walks over all nodes in the range allocator. It is implemented
	209	* with list_for_each, so not save against removal of elements.
	210	*/
ad579002	211	#define drm_mm_for_each_node(entry, mm) \
2bc98c86	212	list_for_each_entry(entry, drm_mm_nodes(mm), node_list)
ad579002 CW	213
	214	/**
	215	* drm_mm_for_each_node_safe - iterator to walk over all allocated nodes
	216	* @entry: drm_mm_node structure to assign to in each iteration step
	217	* @next: drm_mm_node structure to store the next step
	218	* @mm: drm_mm allocator to walk
	219	*
	220	* This iterator walks over all nodes in the range allocator. It is implemented
	221	* with list_for_each_safe, so save against removal of elements.
	222	*/
	223	#define drm_mm_for_each_node_safe(entry, next, mm) \
2bc98c86	224	list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list)
9e8944ab	225
18b40c58 GT	226	#define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \
	227	for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
	228	&entry->hole_stack != &(mm)->hole_stack ? \
	229	hole_start = drm_mm_hole_node_start(entry), \
	230	hole_end = drm_mm_hole_node_end(entry), \
	231	1 : 0; \
	232	entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack))
	233
e18c0412 DV	234	/**
	235	* drm_mm_for_each_hole - iterator to walk over all holes
	236	* @entry: drm_mm_node used internally to track progress
	237	* @mm: drm_mm allocator to walk
	238	* @hole_start: ulong variable to assign the hole start to on each iteration
	239	* @hole_end: ulong variable to assign the hole end to on each iteration
	240	*
	241	* This iterator walks over all holes in the range allocator. It is implemented
	242	* with list_for_each, so not save against removal of elements. @entry is used
	243	* internally and will not reflect a real drm_mm_node for the very first hole.
	244	* Hence users of this iterator may not access it.
	245	*
	246	* Implementation Note:
	247	* We need to inline list_for_each_entry in order to be able to set hole_start
	248	* and hole_end on each iteration while keeping the macro sane.
62347f9e LK	249	*
	250	* The __drm_mm_for_each_hole version is similar, but with added support for
	251	* going backwards.
9e8944ab CW	252	*/
9e8944ab CW	253	#define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
18b40c58	254	__drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0)
62347f9e	255
249d6048 JG	256	/*
	257	* Basic range manager support (drm_mm.c)
	258	*/
e18c0412 DV	259	int drm_mm_reserve_node(struct drm_mm mm, struct drm_mm_node node);
	260
	261	int drm_mm_insert_node_generic(struct drm_mm *mm,
	262	struct drm_mm_node *node,
440fd528	263	u64 size,
71733207	264	u64 alignment,
e18c0412	265	unsigned long color,
62347f9e LK	266	enum drm_mm_search_flags sflags,
62347f9e LK	267	enum drm_mm_allocator_flags aflags);
e18c0412 DV	268	/**
	269	* drm_mm_insert_node - search for space and insert @node
	270	* @mm: drm_mm to allocate from
	271	* @node: preallocate node to insert
	272	* @size: size of the allocation
	273	* @alignment: alignment of the allocation
	274	* @flags: flags to fine-tune the allocation
	275	*
	276	* This is a simplified version of drm_mm_insert_node_generic() with @color set
	277	* to 0.
	278	*
	279	* The preallocated node must be cleared to 0.
	280	*
	281	* Returns:
	282	* 0 on success, -ENOSPC if there's no suitable hole.
	283	*/
31e5d7c6 DH	284	static inline int drm_mm_insert_node(struct drm_mm *mm,
31e5d7c6 DH	285	struct drm_mm_node *node,
440fd528	286	u64 size,
71733207	287	u64 alignment,
31e5d7c6 DH	288	enum drm_mm_search_flags flags)
31e5d7c6 DH	289	{
62347f9e LK	290	return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags,
62347f9e LK	291	DRM_MM_CREATE_DEFAULT);
31e5d7c6 DH	292	}
31e5d7c6 DH	293
e18c0412 DV	294	int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
e18c0412 DV	295	struct drm_mm_node *node,
440fd528	296	u64 size,
71733207	297	u64 alignment,
e18c0412	298	unsigned long color,
440fd528 TR	299	u64 start,
440fd528 TR	300	u64 end,
62347f9e LK	301	enum drm_mm_search_flags sflags,
62347f9e LK	302	enum drm_mm_allocator_flags aflags);
e18c0412 DV	303	/**
	304	* drm_mm_insert_node_in_range - ranged search for space and insert @node
	305	* @mm: drm_mm to allocate from
	306	* @node: preallocate node to insert
	307	* @size: size of the allocation
	308	* @alignment: alignment of the allocation
	309	* @start: start of the allowed range for this node
	310	* @end: end of the allowed range for this node
	311	* @flags: flags to fine-tune the allocation
	312	*
	313	* This is a simplified version of drm_mm_insert_node_in_range_generic() with
	314	* @color set to 0.
	315	*
	316	* The preallocated node must be cleared to 0.
	317	*
	318	* Returns:
	319	* 0 on success, -ENOSPC if there's no suitable hole.
	320	*/
31e5d7c6 DH	321	static inline int drm_mm_insert_node_in_range(struct drm_mm *mm,
31e5d7c6 DH	322	struct drm_mm_node *node,
440fd528	323	u64 size,
71733207	324	u64 alignment,
440fd528 TR	325	u64 start,
440fd528 TR	326	u64 end,
31e5d7c6 DH	327	enum drm_mm_search_flags flags)
	328	{
	329	return drm_mm_insert_node_in_range_generic(mm, node, size, alignment,
62347f9e LK	330	0, start, end, flags,
62347f9e LK	331	DRM_MM_CREATE_DEFAULT);
31e5d7c6 DH	332	}
31e5d7c6 DH	333
e18c0412 DV	334	void drm_mm_remove_node(struct drm_mm_node *node);
e18c0412 DV	335	void drm_mm_replace_node(struct drm_mm_node old, struct drm_mm_node new);
45b186f1	336	void drm_mm_init(struct drm_mm *mm, u64 start, u64 size);
e18c0412	337	void drm_mm_takedown(struct drm_mm *mm);
45b186f1	338	bool drm_mm_clean(const struct drm_mm *mm);
249d6048	339
202b52b7	340	struct drm_mm_node *
45b186f1	341	__drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last);
202b52b7	342
522e85dd CW	343	/**
	344	* drm_mm_for_each_node_in_range - iterator to walk over a range of
	345	* allocated nodes
8b2fb7b6 CW	346	* @node__: drm_mm_node structure to assign to in each iteration step
	347	* @mm__: drm_mm allocator to walk
	348	* @start__: starting offset, the first node will overlap this
	349	* @end__: ending offset, the last node will start before this (but may overlap)
522e85dd CW	350	*
	351	* This iterator walks over all nodes in the range allocator that lie
	352	* between @start and @end. It is implemented similarly to list_for_each(),
	353	* but using the internal interval tree to accelerate the search for the
	354	* starting node, and so not safe against removal of elements. It assumes
	355	* that @end is within (or is the upper limit of) the drm_mm allocator.
	356	*/
8b2fb7b6 CW	357	#define drm_mm_for_each_node_in_range(node__, mm__, start__, end__) \
	358	for (node__ = __drm_mm_interval_first((mm__), (start__), (end__)-1); \
	359	node__ && node__->start < (end__); \
	360	node__ = list_next_entry(node__, node_list))
202b52b7	361
6b9d89b4	362	void drm_mm_init_scan(struct drm_mm *mm,
440fd528	363	u64 size,
71733207	364	u64 alignment,
6b9d89b4 CW	365	unsigned long color);
6b9d89b4 CW	366	void drm_mm_init_scan_with_range(struct drm_mm *mm,
440fd528	367	u64 size,
71733207	368	u64 alignment,
6b9d89b4	369	unsigned long color,
440fd528 TR	370	u64 start,
440fd528 TR	371	u64 end);
e18c0412 DV	372	bool drm_mm_scan_add_block(struct drm_mm_node *node);
e18c0412 DV	373	bool drm_mm_scan_remove_block(struct drm_mm_node *node);
709ea971	374
45b186f1	375	void drm_mm_debug_table(const struct drm_mm mm, const char prefix);
fa8a1238	376	#ifdef CONFIG_DEBUG_FS
45b186f1	377	int drm_mm_dump_table(struct seq_file m, const struct drm_mm mm);
fa8a1238 DA	378	#endif
fa8a1238 DA	379
249d6048	380	#endif