drm_mm.c 24.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/**************************************************************************
 *
 * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND., 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.
 *
 *
 **************************************************************************/

/*
 * Generic simple memory manager implementation. Intended to be used as a base
 * class implementation for more advanced memory managers.
 *
 * Note that the algorithm used is quite simple and there might be substantial
 * performance gains if a smarter free list is implemented. Currently it is just an
 * unordered stack of free regions. This could easily be improved if an RB-tree
 * is used instead. At least if we expect heavy fragmentation.
 *
 * Aligned allocations can also see improvement.
 *
 * Authors:
41
 * Thomas Hellström <thomas-at-tungstengraphics-dot-com>
42 43
 */

44 45
#include <drm/drmP.h>
#include <drm/drm_mm.h>
46
#include <linux/slab.h>
47
#include <linux/seq_file.h>
48
#include <linux/export.h>
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
/**
 * DOC: Overview
 *
 * drm_mm provides a simple range allocator. The drivers are free to use the
 * resource allocator from the linux core if it suits them, the upside of drm_mm
 * is that it's in the DRM core. Which means that it's easier to extend for
 * some of the crazier special purpose needs of gpus.
 *
 * The main data struct is &drm_mm, allocations are tracked in &drm_mm_node.
 * Drivers are free to embed either of them into their own suitable
 * datastructures. drm_mm itself will not do any allocations of its own, so if
 * drivers choose not to embed nodes they need to still allocate them
 * themselves.
 *
 * The range allocator also supports reservation of preallocated blocks. This is
 * useful for taking over initial mode setting configurations from the firmware,
 * where an object needs to be created which exactly matches the firmware's
 * scanout target. As long as the range is still free it can be inserted anytime
 * after the allocator is initialized, which helps with avoiding looped
 * depencies in the driver load sequence.
 *
 * drm_mm maintains a stack of most recently freed holes, which of all
 * simplistic datastructures seems to be a fairly decent approach to clustering
 * allocations and avoiding too much fragmentation. This means free space
 * searches are O(num_holes). Given that all the fancy features drm_mm supports
 * something better would be fairly complex and since gfx thrashing is a fairly
 * steep cliff not a real concern. Removing a node again is O(1).
 *
 * drm_mm supports a few features: Alignment and range restrictions can be
 * supplied. Further more every &drm_mm_node has a color value (which is just an
 * opaqua unsigned long) which in conjunction with a driver callback can be used
 * to implement sophisticated placement restrictions. The i915 DRM driver uses
 * this to implement guard pages between incompatible caching domains in the
 * graphics TT.
 *
85 86 87 88
 * Two behaviors are supported for searching and allocating: bottom-up and top-down.
 * The default is bottom-up. Top-down allocation can be used if the memory area
 * has different restrictions, or just to reduce fragmentation.
 *
89 90 91 92
 * Finally iteration helpers to walk all nodes and all holes are provided as are
 * some basic allocator dumpers for debugging.
 */

David Herrmann's avatar
David Herrmann committed
93
static struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
94
						u64 size,
David Herrmann's avatar
David Herrmann committed
95 96 97 98
						unsigned alignment,
						unsigned long color,
						enum drm_mm_search_flags flags);
static struct drm_mm_node *drm_mm_search_free_in_range_generic(const struct drm_mm *mm,
99
						u64 size,
David Herrmann's avatar
David Herrmann committed
100 101
						unsigned alignment,
						unsigned long color,
102 103
						u64 start,
						u64 end,
David Herrmann's avatar
David Herrmann committed
104
						enum drm_mm_search_flags flags);
105

106 107
static void drm_mm_insert_helper(struct drm_mm_node *hole_node,
				 struct drm_mm_node *node,
108
				 u64 size, unsigned alignment,
109 110
				 unsigned long color,
				 enum drm_mm_allocator_flags flags)
111
{
112
	struct drm_mm *mm = hole_node->mm;
113 114 115 116
	u64 hole_start = drm_mm_hole_node_start(hole_node);
	u64 hole_end = drm_mm_hole_node_end(hole_node);
	u64 adj_start = hole_start;
	u64 adj_end = hole_end;
117

118
	BUG_ON(node->allocated);
119

120 121
	if (mm->color_adjust)
		mm->color_adjust(hole_node, color, &adj_start, &adj_end);
122

123 124 125
	if (flags & DRM_MM_CREATE_TOP)
		adj_start = adj_end - size;

126
	if (alignment) {
127 128 129 130 131
		u64 tmp = adj_start;
		unsigned rem;

		rem = do_div(tmp, alignment);
		if (rem) {
132
			if (flags & DRM_MM_CREATE_TOP)
133
				adj_start -= rem;
134
			else
135
				adj_start += alignment - rem;
136
		}
137 138
	}

139 140 141
	BUG_ON(adj_start < hole_start);
	BUG_ON(adj_end > hole_end);

142
	if (adj_start == hole_start) {
143
		hole_node->hole_follows = 0;
144 145
		list_del(&hole_node->hole_stack);
	}
146

147
	node->start = adj_start;
148 149
	node->size = size;
	node->mm = mm;
150
	node->color = color;
151
	node->allocated = 1;
152

153 154 155
	INIT_LIST_HEAD(&node->hole_stack);
	list_add(&node->node_list, &hole_node->node_list);

156
	BUG_ON(node->start + node->size > adj_end);
157

158
	node->hole_follows = 0;
159
	if (__drm_mm_hole_node_start(node) < hole_end) {
160 161
		list_add(&node->hole_stack, &mm->hole_stack);
		node->hole_follows = 1;
162
	}
163 164
}

165 166 167 168 169 170 171 172 173 174 175 176 177 178
/**
 * drm_mm_reserve_node - insert an pre-initialized node
 * @mm: drm_mm allocator to insert @node into
 * @node: drm_mm_node to insert
 *
 * This functions inserts an already set-up drm_mm_node into the allocator,
 * meaning that start, size and color must be set by the caller. This is useful
 * to initialize the allocator with preallocated objects which must be set-up
 * before the range allocator can be set-up, e.g. when taking over a firmware
 * framebuffer.
 *
 * Returns:
 * 0 on success, -ENOSPC if there's no hole where @node is.
 */
179
int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node)
180
{
181
	struct drm_mm_node *hole;
182 183 184
	u64 end = node->start + node->size;
	u64 hole_start;
	u64 hole_end;
185

186 187 188
	BUG_ON(node == NULL);

	/* Find the relevant hole to add our node to */
189
	drm_mm_for_each_hole(hole, mm, hole_start, hole_end) {
190
		if (hole_start > node->start || hole_end < end)
191 192 193 194 195 196 197 198
			continue;

		node->mm = mm;
		node->allocated = 1;

		INIT_LIST_HEAD(&node->hole_stack);
		list_add(&node->node_list, &hole->node_list);

199
		if (node->start == hole_start) {
200 201 202 203 204 205 206 207 208 209
			hole->hole_follows = 0;
			list_del_init(&hole->hole_stack);
		}

		node->hole_follows = 0;
		if (end != hole_end) {
			list_add(&node->hole_stack, &mm->hole_stack);
			node->hole_follows = 1;
		}

210
		return 0;
211 212
	}

213
	return -ENOSPC;
214
}
215
EXPORT_SYMBOL(drm_mm_reserve_node);
216

217
/**
218 219 220 221 222 223
 * drm_mm_insert_node_generic - 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
 * @color: opaque tag value to use for this node
224 225
 * @sflags: flags to fine-tune the allocation search
 * @aflags: flags to fine-tune the allocation behavior
226 227 228 229 230
 *
 * The preallocated node must be cleared to 0.
 *
 * Returns:
 * 0 on success, -ENOSPC if there's no suitable hole.
231
 */
232
int drm_mm_insert_node_generic(struct drm_mm *mm, struct drm_mm_node *node,
233
			       u64 size, unsigned alignment,
234
			       unsigned long color,
235 236
			       enum drm_mm_search_flags sflags,
			       enum drm_mm_allocator_flags aflags)
237 238 239
{
	struct drm_mm_node *hole_node;

240
	hole_node = drm_mm_search_free_generic(mm, size, alignment,
241
					       color, sflags);
242 243 244
	if (!hole_node)
		return -ENOSPC;

245
	drm_mm_insert_helper(hole_node, node, size, alignment, color, aflags);
246 247
	return 0;
}
248 249
EXPORT_SYMBOL(drm_mm_insert_node_generic);

250 251
static void drm_mm_insert_helper_range(struct drm_mm_node *hole_node,
				       struct drm_mm_node *node,
252
				       u64 size, unsigned alignment,
253
				       unsigned long color,
254
				       u64 start, u64 end,
255
				       enum drm_mm_allocator_flags flags)
256
{
257
	struct drm_mm *mm = hole_node->mm;
258 259 260 261
	u64 hole_start = drm_mm_hole_node_start(hole_node);
	u64 hole_end = drm_mm_hole_node_end(hole_node);
	u64 adj_start = hole_start;
	u64 adj_end = hole_end;
262

263 264
	BUG_ON(!hole_node->hole_follows || node->allocated);

265 266
	if (adj_start < start)
		adj_start = start;
267 268 269
	if (adj_end > end)
		adj_end = end;

270 271 272
	if (flags & DRM_MM_CREATE_TOP)
		adj_start = adj_end - size;

273 274
	if (mm->color_adjust)
		mm->color_adjust(hole_node, color, &adj_start, &adj_end);
275 276

	if (alignment) {
277 278 279 280 281
		u64 tmp = adj_start;
		unsigned rem;

		rem = do_div(tmp, alignment);
		if (rem) {
282
			if (flags & DRM_MM_CREATE_TOP)
283
				adj_start -= rem;
284
			else
285
				adj_start += alignment - rem;
286
		}
287
	}
288

289
	if (adj_start == hole_start) {
290
		hole_node->hole_follows = 0;
291
		list_del(&hole_node->hole_stack);
292 293
	}

294
	node->start = adj_start;
295 296
	node->size = size;
	node->mm = mm;
297
	node->color = color;
298
	node->allocated = 1;
299 300 301 302

	INIT_LIST_HEAD(&node->hole_stack);
	list_add(&node->node_list, &hole_node->node_list);

303 304
	BUG_ON(node->start < start);
	BUG_ON(node->start < adj_start);
305
	BUG_ON(node->start + node->size > adj_end);
306 307
	BUG_ON(node->start + node->size > end);

308
	node->hole_follows = 0;
309
	if (__drm_mm_hole_node_start(node) < hole_end) {
310 311
		list_add(&node->hole_stack, &mm->hole_stack);
		node->hole_follows = 1;
312
	}
313 314
}

315
/**
316 317 318 319 320 321 322 323
 * drm_mm_insert_node_in_range_generic - 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
 * @color: opaque tag value to use for this node
 * @start: start of the allowed range for this node
 * @end: end of the allowed range for this node
324 325
 * @sflags: flags to fine-tune the allocation search
 * @aflags: flags to fine-tune the allocation behavior
326 327 328 329 330
 *
 * The preallocated node must be cleared to 0.
 *
 * Returns:
 * 0 on success, -ENOSPC if there's no suitable hole.
331
 */
332
int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, struct drm_mm_node *node,
333
					u64 size, unsigned alignment,
334
					unsigned long color,
335
					u64 start, u64 end,
336 337
					enum drm_mm_search_flags sflags,
					enum drm_mm_allocator_flags aflags)
338
{
339 340
	struct drm_mm_node *hole_node;

341 342
	hole_node = drm_mm_search_free_in_range_generic(mm,
							size, alignment, color,
343
							start, end, sflags);
344 345 346
	if (!hole_node)
		return -ENOSPC;

347 348
	drm_mm_insert_helper_range(hole_node, node,
				   size, alignment, color,
349
				   start, end, aflags);
350 351
	return 0;
}
352 353
EXPORT_SYMBOL(drm_mm_insert_node_in_range_generic);

354
/**
355 356 357 358 359 360
 * drm_mm_remove_node - Remove a memory node from the allocator.
 * @node: drm_mm_node to remove
 *
 * This just removes a node from its drm_mm allocator. The node does not need to
 * be cleared again before it can be re-inserted into this or any other drm_mm
 * allocator. It is a bug to call this function on a un-allocated node.
361 362 363
 */
void drm_mm_remove_node(struct drm_mm_node *node)
{
364 365
	struct drm_mm *mm = node->mm;
	struct drm_mm_node *prev_node;
366

367 368 369
	if (WARN_ON(!node->allocated))
		return;

370 371
	BUG_ON(node->scanned_block || node->scanned_prev_free
				   || node->scanned_next_free);
372

373 374
	prev_node =
	    list_entry(node->node_list.prev, struct drm_mm_node, node_list);
375

376
	if (node->hole_follows) {
377 378
		BUG_ON(__drm_mm_hole_node_start(node) ==
		       __drm_mm_hole_node_end(node));
379 380
		list_del(&node->hole_stack);
	} else
381 382 383
		BUG_ON(__drm_mm_hole_node_start(node) !=
		       __drm_mm_hole_node_end(node));

384

385 386 387 388 389 390 391
	if (!prev_node->hole_follows) {
		prev_node->hole_follows = 1;
		list_add(&prev_node->hole_stack, &mm->hole_stack);
	} else
		list_move(&prev_node->hole_stack, &mm->hole_stack);

	list_del(&node->node_list);
392 393 394 395
	node->allocated = 0;
}
EXPORT_SYMBOL(drm_mm_remove_node);

396
static int check_free_hole(u64 start, u64 end, u64 size, unsigned alignment)
397
{
398
	if (end - start < size)
399 400 401
		return 0;

	if (alignment) {
402 403 404 405
		u64 tmp = start;
		unsigned rem;

		rem = do_div(tmp, alignment);
406
		if (rem)
407
			start += alignment - rem;
408 409
	}

410
	return end >= start + size;
411 412
}

David Herrmann's avatar
David Herrmann committed
413
static struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
414
						      u64 size,
David Herrmann's avatar
David Herrmann committed
415 416 417
						      unsigned alignment,
						      unsigned long color,
						      enum drm_mm_search_flags flags)
418
{
Dave Airlie's avatar
Dave Airlie committed
419 420
	struct drm_mm_node *entry;
	struct drm_mm_node *best;
421 422 423
	u64 adj_start;
	u64 adj_end;
	u64 best_size;
424

425 426
	BUG_ON(mm->scanned_blocks);

427 428 429
	best = NULL;
	best_size = ~0UL;

430 431
	__drm_mm_for_each_hole(entry, mm, adj_start, adj_end,
			       flags & DRM_MM_SEARCH_BELOW) {
432
		u64 hole_size = adj_end - adj_start;
433

434 435 436 437 438 439 440
		if (mm->color_adjust) {
			mm->color_adjust(entry, color, &adj_start, &adj_end);
			if (adj_end <= adj_start)
				continue;
		}

		if (!check_free_hole(adj_start, adj_end, size, alignment))
441 442
			continue;

443
		if (!(flags & DRM_MM_SEARCH_BEST))
444
			return entry;
445

446
		if (hole_size < best_size) {
447
			best = entry;
448
			best_size = hole_size;
449 450 451 452 453
		}
	}

	return best;
}
454

David Herrmann's avatar
David Herrmann committed
455
static struct drm_mm_node *drm_mm_search_free_in_range_generic(const struct drm_mm *mm,
456
							u64 size,
457 458
							unsigned alignment,
							unsigned long color,
459 460
							u64 start,
							u64 end,
461
							enum drm_mm_search_flags flags)
462 463 464
{
	struct drm_mm_node *entry;
	struct drm_mm_node *best;
465 466 467
	u64 adj_start;
	u64 adj_end;
	u64 best_size;
468

469 470
	BUG_ON(mm->scanned_blocks);

471 472 473
	best = NULL;
	best_size = ~0UL;

474 475
	__drm_mm_for_each_hole(entry, mm, adj_start, adj_end,
			       flags & DRM_MM_SEARCH_BELOW) {
476
		u64 hole_size = adj_end - adj_start;
477

478 479 480 481
		if (adj_start < start)
			adj_start = start;
		if (adj_end > end)
			adj_end = end;
482 483 484 485 486 487 488

		if (mm->color_adjust) {
			mm->color_adjust(entry, color, &adj_start, &adj_end);
			if (adj_end <= adj_start)
				continue;
		}

489
		if (!check_free_hole(adj_start, adj_end, size, alignment))
490 491
			continue;

492
		if (!(flags & DRM_MM_SEARCH_BEST))
493
			return entry;
494

495
		if (hole_size < best_size) {
496
			best = entry;
497
			best_size = hole_size;
498 499 500 501 502 503
		}
	}

	return best;
}

504
/**
505 506 507 508 509 510 511
 * drm_mm_replace_node - move an allocation from @old to @new
 * @old: drm_mm_node to remove from the allocator
 * @new: drm_mm_node which should inherit @old's allocation
 *
 * This is useful for when drivers embed the drm_mm_node structure and hence
 * can't move allocations by reassigning pointers. It's a combination of remove
 * and insert with the guarantee that the allocation start will match.
512 513 514 515
 */
void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new)
{
	list_replace(&old->node_list, &new->node_list);
Daniel Vetter's avatar
Daniel Vetter committed
516
	list_replace(&old->hole_stack, &new->hole_stack);
517 518 519 520
	new->hole_follows = old->hole_follows;
	new->mm = old->mm;
	new->start = old->start;
	new->size = old->size;
521
	new->color = old->color;
522 523 524 525 526 527

	old->allocated = 0;
	new->allocated = 1;
}
EXPORT_SYMBOL(drm_mm_replace_node);

528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
/**
 * DOC: lru scan roaster
 *
 * Very often GPUs need to have continuous allocations for a given object. When
 * evicting objects to make space for a new one it is therefore not most
 * efficient when we simply start to select all objects from the tail of an LRU
 * until there's a suitable hole: Especially for big objects or nodes that
 * otherwise have special allocation constraints there's a good chance we evict
 * lots of (smaller) objects unecessarily.
 *
 * The DRM range allocator supports this use-case through the scanning
 * interfaces. First a scan operation needs to be initialized with
 * drm_mm_init_scan() or drm_mm_init_scan_with_range(). The the driver adds
 * objects to the roaster (probably by walking an LRU list, but this can be
 * freely implemented) until a suitable hole is found or there's no further
 * evitable object.
 *
 * The the driver must walk through all objects again in exactly the reverse
 * order to restore the allocator state. Note that while the allocator is used
 * in the scan mode no other operation is allowed.
 *
 * Finally the driver evicts all objects selected in the scan. Adding and
 * removing an object is O(1), and since freeing a node is also O(1) the overall
 * complexity is O(scanned_objects). So like the free stack which needs to be
 * walked before a scan operation even begins this is linear in the number of
 * objects. It doesn't seem to hurt badly.
 */

556
/**
557 558 559 560 561
 * drm_mm_init_scan - initialize lru scanning
 * @mm: drm_mm to scan
 * @size: size of the allocation
 * @alignment: alignment of the allocation
 * @color: opaque tag value to use for the allocation
562 563
 *
 * This simply sets up the scanning routines with the parameters for the desired
564 565
 * 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.
566
 *
567 568
 * Warning:
 * As long as the scan list is non-empty, no other operations than
569 570
 * adding/removing nodes to/from the scan list are allowed.
 */
571
void drm_mm_init_scan(struct drm_mm *mm,
572
		      u64 size,
573 574
		      unsigned alignment,
		      unsigned long color)
575
{
576
	mm->scan_color = color;
577 578 579 580
	mm->scan_alignment = alignment;
	mm->scan_size = size;
	mm->scanned_blocks = 0;
	mm->scan_hit_start = 0;
581
	mm->scan_hit_end = 0;
582
	mm->scan_check_range = 0;
583
	mm->prev_scanned_node = NULL;
584 585 586
}
EXPORT_SYMBOL(drm_mm_init_scan);

587
/**
588 589 590 591 592 593 594
 * drm_mm_init_scan - initialize range-restricted lru scanning
 * @mm: drm_mm to scan
 * @size: size of the allocation
 * @alignment: alignment of the allocation
 * @color: opaque tag value to use for the allocation
 * @start: start of the allowed range for the allocation
 * @end: end of the allowed range for the allocation
595 596
 *
 * This simply sets up the scanning routines with the parameters for the desired
597 598
 * 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.
599
 *
600 601
 * Warning:
 * As long as the scan list is non-empty, no other operations than
602 603
 * adding/removing nodes to/from the scan list are allowed.
 */
604
void drm_mm_init_scan_with_range(struct drm_mm *mm,
605
				 u64 size,
606
				 unsigned alignment,
607
				 unsigned long color,
608 609
				 u64 start,
				 u64 end)
610
{
611
	mm->scan_color = color;
612 613 614 615
	mm->scan_alignment = alignment;
	mm->scan_size = size;
	mm->scanned_blocks = 0;
	mm->scan_hit_start = 0;
616
	mm->scan_hit_end = 0;
617 618 619
	mm->scan_start = start;
	mm->scan_end = end;
	mm->scan_check_range = 1;
620
	mm->prev_scanned_node = NULL;
621 622 623
}
EXPORT_SYMBOL(drm_mm_init_scan_with_range);

624
/**
625 626 627
 * drm_mm_scan_add_block - add a node to the scan list
 * @node: drm_mm_node to add
 *
628 629 630
 * Add a node to the scan list that might be freed to make space for the desired
 * hole.
 *
631 632
 * Returns:
 * True if a hole has been found, false otherwise.
633
 */
634
bool drm_mm_scan_add_block(struct drm_mm_node *node)
635 636
{
	struct drm_mm *mm = node->mm;
637
	struct drm_mm_node *prev_node;
638 639
	u64 hole_start, hole_end;
	u64 adj_start, adj_end;
640 641 642

	mm->scanned_blocks++;

643
	BUG_ON(node->scanned_block);
644 645
	node->scanned_block = 1;

646 647
	prev_node = list_entry(node->node_list.prev, struct drm_mm_node,
			       node_list);
648

649 650 651 652
	node->scanned_preceeds_hole = prev_node->hole_follows;
	prev_node->hole_follows = 1;
	list_del(&node->node_list);
	node->node_list.prev = &prev_node->node_list;
653 654
	node->node_list.next = &mm->prev_scanned_node->node_list;
	mm->prev_scanned_node = node;
655

656 657
	adj_start = hole_start = drm_mm_hole_node_start(prev_node);
	adj_end = hole_end = drm_mm_hole_node_end(prev_node);
658

659
	if (mm->scan_check_range) {
660 661 662 663
		if (adj_start < mm->scan_start)
			adj_start = mm->scan_start;
		if (adj_end > mm->scan_end)
			adj_end = mm->scan_end;
664 665
	}

666 667 668 669
	if (mm->color_adjust)
		mm->color_adjust(prev_node, mm->scan_color,
				 &adj_start, &adj_end);

670
	if (check_free_hole(adj_start, adj_end,
671
			    mm->scan_size, mm->scan_alignment)) {
672
		mm->scan_hit_start = hole_start;
673
		mm->scan_hit_end = hole_end;
674
		return true;
675 676
	}

677
	return false;
678 679 680 681
}
EXPORT_SYMBOL(drm_mm_scan_add_block);

/**
682 683
 * drm_mm_scan_remove_block - remove a node from the scan list
 * @node: drm_mm_node to remove
684 685 686 687 688 689
 *
 * Nodes _must_ be removed in the exact same order from the scan list as they
 * have been added, otherwise the internal state of the memory manager will be
 * corrupted.
 *
 * When the scan list is empty, the selected memory nodes can be freed. An
690 691
 * immediately following drm_mm_search_free with !DRM_MM_SEARCH_BEST will then
 * return the just freed block (because its at the top of the free_stack list).
692
 *
693 694 695
 * Returns:
 * True if this block should be evicted, false otherwise. Will always
 * return false when no hole has been found.
696
 */
697
bool drm_mm_scan_remove_block(struct drm_mm_node *node)
698 699
{
	struct drm_mm *mm = node->mm;
700
	struct drm_mm_node *prev_node;
701 702 703 704 705 706

	mm->scanned_blocks--;

	BUG_ON(!node->scanned_block);
	node->scanned_block = 0;

707 708
	prev_node = list_entry(node->node_list.prev, struct drm_mm_node,
			       node_list);
709

710 711
	prev_node->hole_follows = node->scanned_preceeds_hole;
	list_add(&node->node_list, &prev_node->node_list);
712

713 714
	 return (drm_mm_hole_node_end(node) > mm->scan_hit_start &&
		 node->start < mm->scan_hit_end);
715 716 717
}
EXPORT_SYMBOL(drm_mm_scan_remove_block);

718 719 720 721 722 723 724 725 726
/**
 * 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.
 */
bool drm_mm_clean(struct drm_mm * mm)
727
{
728
	struct list_head *head = &mm->head_node.node_list;
729

730 731
	return (head->next->next == head);
}
732
EXPORT_SYMBOL(drm_mm_clean);
733

734 735 736 737 738 739 740 741
/**
 * drm_mm_init - initialize a drm-mm allocator
 * @mm: the drm_mm structure to initialize
 * @start: start of the range managed by @mm
 * @size: end of the range managed by @mm
 *
 * Note that @mm must be cleared to 0 before calling this function.
 */
742
void drm_mm_init(struct drm_mm * mm, u64 start, u64 size)
743
{
744
	INIT_LIST_HEAD(&mm->hole_stack);
745
	mm->scanned_blocks = 0;
746

747 748 749 750 751 752 753 754 755 756 757 758
	/* Clever trick to avoid a special case in the free hole tracking. */
	INIT_LIST_HEAD(&mm->head_node.node_list);
	INIT_LIST_HEAD(&mm->head_node.hole_stack);
	mm->head_node.hole_follows = 1;
	mm->head_node.scanned_block = 0;
	mm->head_node.scanned_prev_free = 0;
	mm->head_node.scanned_next_free = 0;
	mm->head_node.mm = mm;
	mm->head_node.start = start + size;
	mm->head_node.size = start - mm->head_node.start;
	list_add_tail(&mm->head_node.hole_stack, &mm->hole_stack);

759
	mm->color_adjust = NULL;
760
}
761
EXPORT_SYMBOL(drm_mm_init);
762

763 764 765 766 767 768 769
/**
 * drm_mm_takedown - clean up a drm_mm allocator
 * @mm: drm_mm allocator to clean up
 *
 * Note that it is a bug to call this function on an allocator which is not
 * clean.
 */
Dave Airlie's avatar
Dave Airlie committed
770
void drm_mm_takedown(struct drm_mm * mm)
771
{
David Herrmann's avatar
David Herrmann committed
772 773
	WARN(!list_empty(&mm->head_node.node_list),
	     "Memory manager not clean during takedown.\n");
774
}
Dave Airlie's avatar
Dave Airlie committed
775
EXPORT_SYMBOL(drm_mm_takedown);
776

777 778
static u64 drm_mm_debug_hole(struct drm_mm_node *entry,
				     const char *prefix)
779
{
780
	u64 hole_start, hole_end, hole_size;
781

Daniel Vetter's avatar
Daniel Vetter committed
782 783 784 785
	if (entry->hole_follows) {
		hole_start = drm_mm_hole_node_start(entry);
		hole_end = drm_mm_hole_node_end(entry);
		hole_size = hole_end - hole_start;
786 787
		pr_debug("%s %#llx-%#llx: %llu: free\n", prefix, hole_start,
			 hole_end, hole_size);
Daniel Vetter's avatar
Daniel Vetter committed
788 789 790 791 792 793
		return hole_size;
	}

	return 0;
}

794 795 796 797 798
/**
 * drm_mm_debug_table - dump allocator state to dmesg
 * @mm: drm_mm allocator to dump
 * @prefix: prefix to use for dumping to dmesg
 */
Daniel Vetter's avatar
Daniel Vetter committed
799 800 801
void drm_mm_debug_table(struct drm_mm *mm, const char *prefix)
{
	struct drm_mm_node *entry;
802
	u64 total_used = 0, total_free = 0, total = 0;
Daniel Vetter's avatar
Daniel Vetter committed
803 804

	total_free += drm_mm_debug_hole(&mm->head_node, prefix);
805 806

	drm_mm_for_each_node(entry, mm) {
807 808
		pr_debug("%s %#llx-%#llx: %llu: used\n", prefix, entry->start,
			 entry->start + entry->size, entry->size);
809
		total_used += entry->size;
Daniel Vetter's avatar
Daniel Vetter committed
810
		total_free += drm_mm_debug_hole(entry, prefix);
811
	}
812 813
	total = total_free + total_used;

814 815
	pr_debug("%s total: %llu, used %llu free %llu\n", prefix, total,
		 total_used, total_free);
816 817 818
}
EXPORT_SYMBOL(drm_mm_debug_table);

819
#if defined(CONFIG_DEBUG_FS)
820
static u64 drm_mm_dump_hole(struct seq_file *m, struct drm_mm_node *entry)
821
{
822
	u64 hole_start, hole_end, hole_size;
823

Daniel Vetter's avatar
Daniel Vetter committed
824 825 826 827
	if (entry->hole_follows) {
		hole_start = drm_mm_hole_node_start(entry);
		hole_end = drm_mm_hole_node_end(entry);
		hole_size = hole_end - hole_start;
828 829
		seq_printf(m, "%#llx-%#llx: %llu: free\n", hole_start,
			   hole_end, hole_size);
Daniel Vetter's avatar
Daniel Vetter committed
830 831 832 833 834 835
		return hole_size;
	}

	return 0;
}

836 837 838 839 840
/**
 * drm_mm_dump_table - dump allocator state to a seq_file
 * @m: seq_file to dump to
 * @mm: drm_mm allocator to dump
 */
Daniel Vetter's avatar
Daniel Vetter committed
841 842 843
int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm)
{
	struct drm_mm_node *entry;
844
	u64 total_used = 0, total_free = 0, total = 0;
Daniel Vetter's avatar
Daniel Vetter committed
845 846

	total_free += drm_mm_dump_hole(m, &mm->head_node);
847 848

	drm_mm_for_each_node(entry, mm) {
849 850
		seq_printf(m, "%#016llx-%#016llx: %llu: used\n", entry->start,
			   entry->start + entry->size, entry->size);
851
		total_used += entry->size;
Daniel Vetter's avatar
Daniel Vetter committed
852
		total_free += drm_mm_dump_hole(m, entry);
853
	}
854 855
	total = total_free + total_used;

856 857
	seq_printf(m, "total: %llu, used %llu free %llu\n", total,
		   total_used, total_free);
858 859 860 861
	return 0;
}
EXPORT_SYMBOL(drm_mm_dump_table);
#endif