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

/**************************************************************************
 *
 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
 * Copyright 2016 Intel Corporation
 * 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;

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

	unsigned long scan_active;
};

struct drm_mm_scan {
	struct drm_mm *mm;

	u64 size;
	u64 alignment;

	u64 range_start;
	u64 range_end;

	u64 hit_start;
	u64 hit_end;

	struct drm_mm_node *prev_scanned_node;

	unsigned long color;
};

/**
 * drm_mm_node_allocated - checks whether a node is allocated
 * @node: drm_mm_node to check
 *
 * Drivers are required to clear a node prior to using it with the
 * drm_mm range manager.
 *
 * Drivers should use this helper for proper encapsulation 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 clear the struct drm_mm prior to initialisation if they
 * want to use this function.
 *
 * Drivers should use this helper for proper encapsulation 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-specific 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-specific 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);

/**
 * drm_mm_clean - checks whether an allocator is clean
 * @mm: drm_mm allocator to check
 *
 * Returns:
 * True if the allocator is completely free, false if there's still a node
 * allocated in it.
 */
static inline bool drm_mm_clean(const struct drm_mm *mm)
{
	return list_empty(drm_mm_nodes(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_scan_init_with_range(struct drm_mm_scan *scan,
				 struct drm_mm *mm,
				 u64 size,
				 u64 alignment,
				 unsigned long color,
				 u64 start,
				 u64 end);

/**
 * drm_mm_scan_init - initialize lru scanning
 * @scan: scan state
 * @mm: drm_mm to scan
 * @size: size of the allocation
 * @alignment: alignment of the allocation
 * @color: opaque tag value to use for the allocation
 *
 * This simply sets up the scanning routines with the parameters for the desired
 * hole. Note that there's no need to specify allocation flags, since they only
 * change the place a node is allocated from within a suitable hole.
 *
 * Warning:
 * As long as the scan list is non-empty, no other operations than
 * adding/removing nodes to/from the scan list are allowed.
 */
static inline void drm_mm_scan_init(struct drm_mm_scan *scan,
				    struct drm_mm *mm,
				    u64 size,
				    u64 alignment,
				    unsigned long color)
{
	drm_mm_scan_init_with_range(scan, mm, size, alignment, color,
				    0, U64_MAX);
}

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