Commit | Line | Data |
---|---|---|
3a1bd924 TH |
1 | /************************************************************************** |
2 | * | |
3 | * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND., 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 | /* | |
30 | * Generic simple memory manager implementation. Intended to be used as a base | |
31 | * class implementation for more advanced memory managers. | |
32 | * | |
33 | * Note that the algorithm used is quite simple and there might be substantial | |
34 | * performance gains if a smarter free list is implemented. Currently it is just an | |
35 | * unordered stack of free regions. This could easily be improved if an RB-tree | |
36 | * is used instead. At least if we expect heavy fragmentation. | |
37 | * | |
38 | * Aligned allocations can also see improvement. | |
39 | * | |
40 | * Authors: | |
96de0e25 | 41 | * Thomas Hellström <thomas-at-tungstengraphics-dot-com> |
3a1bd924 TH |
42 | */ |
43 | ||
760285e7 DH |
44 | #include <drm/drmP.h> |
45 | #include <drm/drm_mm.h> | |
1d58420b | 46 | #include <linux/slab.h> |
fa8a1238 | 47 | #include <linux/seq_file.h> |
2d1a8a48 | 48 | #include <linux/export.h> |
1d58420b | 49 | |
93110be6 DV |
50 | /** |
51 | * DOC: Overview | |
52 | * | |
53 | * drm_mm provides a simple range allocator. The drivers are free to use the | |
54 | * resource allocator from the linux core if it suits them, the upside of drm_mm | |
55 | * is that it's in the DRM core. Which means that it's easier to extend for | |
56 | * some of the crazier special purpose needs of gpus. | |
57 | * | |
58 | * The main data struct is &drm_mm, allocations are tracked in &drm_mm_node. | |
59 | * Drivers are free to embed either of them into their own suitable | |
60 | * datastructures. drm_mm itself will not do any allocations of its own, so if | |
61 | * drivers choose not to embed nodes they need to still allocate them | |
62 | * themselves. | |
63 | * | |
64 | * The range allocator also supports reservation of preallocated blocks. This is | |
65 | * useful for taking over initial mode setting configurations from the firmware, | |
66 | * where an object needs to be created which exactly matches the firmware's | |
67 | * scanout target. As long as the range is still free it can be inserted anytime | |
68 | * after the allocator is initialized, which helps with avoiding looped | |
69 | * depencies in the driver load sequence. | |
70 | * | |
71 | * drm_mm maintains a stack of most recently freed holes, which of all | |
72 | * simplistic datastructures seems to be a fairly decent approach to clustering | |
73 | * allocations and avoiding too much fragmentation. This means free space | |
74 | * searches are O(num_holes). Given that all the fancy features drm_mm supports | |
75 | * something better would be fairly complex and since gfx thrashing is a fairly | |
76 | * steep cliff not a real concern. Removing a node again is O(1). | |
77 | * | |
78 | * drm_mm supports a few features: Alignment and range restrictions can be | |
79 | * supplied. Further more every &drm_mm_node has a color value (which is just an | |
80 | * opaqua unsigned long) which in conjunction with a driver callback can be used | |
81 | * to implement sophisticated placement restrictions. The i915 DRM driver uses | |
82 | * this to implement guard pages between incompatible caching domains in the | |
83 | * graphics TT. | |
84 | * | |
62347f9e LK |
85 | * Two behaviors are supported for searching and allocating: bottom-up and top-down. |
86 | * The default is bottom-up. Top-down allocation can be used if the memory area | |
87 | * has different restrictions, or just to reduce fragmentation. | |
88 | * | |
93110be6 DV |
89 | * Finally iteration helpers to walk all nodes and all holes are provided as are |
90 | * some basic allocator dumpers for debugging. | |
91 | */ | |
92 | ||
c700c67b DH |
93 | static struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm, |
94 | unsigned long size, | |
95 | unsigned alignment, | |
96 | unsigned long color, | |
97 | enum drm_mm_search_flags flags); | |
98 | static struct drm_mm_node *drm_mm_search_free_in_range_generic(const struct drm_mm *mm, | |
99 | unsigned long size, | |
100 | unsigned alignment, | |
101 | unsigned long color, | |
102 | unsigned long start, | |
103 | unsigned long end, | |
104 | enum drm_mm_search_flags flags); | |
1d58420b | 105 | |
9fc935de DV |
106 | static void drm_mm_insert_helper(struct drm_mm_node *hole_node, |
107 | struct drm_mm_node *node, | |
6b9d89b4 | 108 | unsigned long size, unsigned alignment, |
62347f9e LK |
109 | unsigned long color, |
110 | enum drm_mm_allocator_flags flags) | |
3a1bd924 | 111 | { |
ea7b1dd4 | 112 | struct drm_mm *mm = hole_node->mm; |
ea7b1dd4 DV |
113 | unsigned long hole_start = drm_mm_hole_node_start(hole_node); |
114 | unsigned long hole_end = drm_mm_hole_node_end(hole_node); | |
6b9d89b4 CW |
115 | unsigned long adj_start = hole_start; |
116 | unsigned long adj_end = hole_end; | |
ea7b1dd4 | 117 | |
9e8944ab | 118 | BUG_ON(node->allocated); |
b0b7af18 | 119 | |
6b9d89b4 CW |
120 | if (mm->color_adjust) |
121 | mm->color_adjust(hole_node, color, &adj_start, &adj_end); | |
1d58420b | 122 | |
62347f9e LK |
123 | if (flags & DRM_MM_CREATE_TOP) |
124 | adj_start = adj_end - size; | |
125 | ||
6b9d89b4 CW |
126 | if (alignment) { |
127 | unsigned tmp = adj_start % alignment; | |
62347f9e LK |
128 | if (tmp) { |
129 | if (flags & DRM_MM_CREATE_TOP) | |
130 | adj_start -= tmp; | |
131 | else | |
132 | adj_start += alignment - tmp; | |
133 | } | |
6b9d89b4 CW |
134 | } |
135 | ||
62347f9e LK |
136 | BUG_ON(adj_start < hole_start); |
137 | BUG_ON(adj_end > hole_end); | |
138 | ||
6b9d89b4 | 139 | if (adj_start == hole_start) { |
ea7b1dd4 | 140 | hole_node->hole_follows = 0; |
6b9d89b4 CW |
141 | list_del(&hole_node->hole_stack); |
142 | } | |
ea7b1dd4 | 143 | |
6b9d89b4 | 144 | node->start = adj_start; |
ea7b1dd4 DV |
145 | node->size = size; |
146 | node->mm = mm; | |
6b9d89b4 | 147 | node->color = color; |
b0b7af18 | 148 | node->allocated = 1; |
3a1bd924 | 149 | |
ea7b1dd4 DV |
150 | INIT_LIST_HEAD(&node->hole_stack); |
151 | list_add(&node->node_list, &hole_node->node_list); | |
152 | ||
6b9d89b4 | 153 | BUG_ON(node->start + node->size > adj_end); |
ea7b1dd4 | 154 | |
6b9d89b4 | 155 | node->hole_follows = 0; |
9e8944ab | 156 | if (__drm_mm_hole_node_start(node) < hole_end) { |
ea7b1dd4 DV |
157 | list_add(&node->hole_stack, &mm->hole_stack); |
158 | node->hole_follows = 1; | |
1d58420b | 159 | } |
9fc935de DV |
160 | } |
161 | ||
e18c0412 DV |
162 | /** |
163 | * drm_mm_reserve_node - insert an pre-initialized node | |
164 | * @mm: drm_mm allocator to insert @node into | |
165 | * @node: drm_mm_node to insert | |
166 | * | |
167 | * This functions inserts an already set-up drm_mm_node into the allocator, | |
168 | * meaning that start, size and color must be set by the caller. This is useful | |
169 | * to initialize the allocator with preallocated objects which must be set-up | |
170 | * before the range allocator can be set-up, e.g. when taking over a firmware | |
171 | * framebuffer. | |
172 | * | |
173 | * Returns: | |
174 | * 0 on success, -ENOSPC if there's no hole where @node is. | |
175 | */ | |
338710e7 | 176 | int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node) |
5973c7ee | 177 | { |
b3a070cc | 178 | struct drm_mm_node *hole; |
338710e7 | 179 | unsigned long end = node->start + node->size; |
9e8944ab CW |
180 | unsigned long hole_start; |
181 | unsigned long hole_end; | |
5973c7ee | 182 | |
338710e7 BW |
183 | BUG_ON(node == NULL); |
184 | ||
185 | /* Find the relevant hole to add our node to */ | |
9e8944ab | 186 | drm_mm_for_each_hole(hole, mm, hole_start, hole_end) { |
338710e7 | 187 | if (hole_start > node->start || hole_end < end) |
5973c7ee CW |
188 | continue; |
189 | ||
5973c7ee CW |
190 | node->mm = mm; |
191 | node->allocated = 1; | |
192 | ||
193 | INIT_LIST_HEAD(&node->hole_stack); | |
194 | list_add(&node->node_list, &hole->node_list); | |
195 | ||
338710e7 | 196 | if (node->start == hole_start) { |
5973c7ee CW |
197 | hole->hole_follows = 0; |
198 | list_del_init(&hole->hole_stack); | |
199 | } | |
200 | ||
201 | node->hole_follows = 0; | |
202 | if (end != hole_end) { | |
203 | list_add(&node->hole_stack, &mm->hole_stack); | |
204 | node->hole_follows = 1; | |
205 | } | |
206 | ||
b3a070cc | 207 | return 0; |
5973c7ee CW |
208 | } |
209 | ||
b3a070cc | 210 | return -ENOSPC; |
5973c7ee | 211 | } |
338710e7 | 212 | EXPORT_SYMBOL(drm_mm_reserve_node); |
5973c7ee | 213 | |
b0b7af18 | 214 | /** |
e18c0412 DV |
215 | * drm_mm_insert_node_generic - search for space and insert @node |
216 | * @mm: drm_mm to allocate from | |
217 | * @node: preallocate node to insert | |
218 | * @size: size of the allocation | |
219 | * @alignment: alignment of the allocation | |
220 | * @color: opaque tag value to use for this node | |
62347f9e LK |
221 | * @sflags: flags to fine-tune the allocation search |
222 | * @aflags: flags to fine-tune the allocation behavior | |
e18c0412 DV |
223 | * |
224 | * The preallocated node must be cleared to 0. | |
225 | * | |
226 | * Returns: | |
227 | * 0 on success, -ENOSPC if there's no suitable hole. | |
b0b7af18 | 228 | */ |
b8103450 CW |
229 | int drm_mm_insert_node_generic(struct drm_mm *mm, struct drm_mm_node *node, |
230 | unsigned long size, unsigned alignment, | |
31e5d7c6 | 231 | unsigned long color, |
62347f9e LK |
232 | enum drm_mm_search_flags sflags, |
233 | enum drm_mm_allocator_flags aflags) | |
b0b7af18 DV |
234 | { |
235 | struct drm_mm_node *hole_node; | |
236 | ||
b8103450 | 237 | hole_node = drm_mm_search_free_generic(mm, size, alignment, |
62347f9e | 238 | color, sflags); |
b0b7af18 DV |
239 | if (!hole_node) |
240 | return -ENOSPC; | |
241 | ||
62347f9e | 242 | drm_mm_insert_helper(hole_node, node, size, alignment, color, aflags); |
b0b7af18 DV |
243 | return 0; |
244 | } | |
b8103450 CW |
245 | EXPORT_SYMBOL(drm_mm_insert_node_generic); |
246 | ||
9fc935de DV |
247 | static void drm_mm_insert_helper_range(struct drm_mm_node *hole_node, |
248 | struct drm_mm_node *node, | |
249 | unsigned long size, unsigned alignment, | |
6b9d89b4 | 250 | unsigned long color, |
62347f9e LK |
251 | unsigned long start, unsigned long end, |
252 | enum drm_mm_allocator_flags flags) | |
a2e68e92 | 253 | { |
ea7b1dd4 | 254 | struct drm_mm *mm = hole_node->mm; |
ea7b1dd4 DV |
255 | unsigned long hole_start = drm_mm_hole_node_start(hole_node); |
256 | unsigned long hole_end = drm_mm_hole_node_end(hole_node); | |
6b9d89b4 CW |
257 | unsigned long adj_start = hole_start; |
258 | unsigned long adj_end = hole_end; | |
a2e68e92 | 259 | |
b0b7af18 DV |
260 | BUG_ON(!hole_node->hole_follows || node->allocated); |
261 | ||
6b9d89b4 CW |
262 | if (adj_start < start) |
263 | adj_start = start; | |
901593f2 CW |
264 | if (adj_end > end) |
265 | adj_end = end; | |
266 | ||
62347f9e LK |
267 | if (flags & DRM_MM_CREATE_TOP) |
268 | adj_start = adj_end - size; | |
269 | ||
901593f2 CW |
270 | if (mm->color_adjust) |
271 | mm->color_adjust(hole_node, color, &adj_start, &adj_end); | |
6b9d89b4 CW |
272 | |
273 | if (alignment) { | |
274 | unsigned tmp = adj_start % alignment; | |
62347f9e LK |
275 | if (tmp) { |
276 | if (flags & DRM_MM_CREATE_TOP) | |
277 | adj_start -= tmp; | |
278 | else | |
279 | adj_start += alignment - tmp; | |
280 | } | |
6b9d89b4 | 281 | } |
ea7b1dd4 | 282 | |
6b9d89b4 | 283 | if (adj_start == hole_start) { |
ea7b1dd4 | 284 | hole_node->hole_follows = 0; |
6b9d89b4 | 285 | list_del(&hole_node->hole_stack); |
a2e68e92 JG |
286 | } |
287 | ||
6b9d89b4 | 288 | node->start = adj_start; |
ea7b1dd4 DV |
289 | node->size = size; |
290 | node->mm = mm; | |
6b9d89b4 | 291 | node->color = color; |
b0b7af18 | 292 | node->allocated = 1; |
ea7b1dd4 DV |
293 | |
294 | INIT_LIST_HEAD(&node->hole_stack); | |
295 | list_add(&node->node_list, &hole_node->node_list); | |
296 | ||
62347f9e LK |
297 | BUG_ON(node->start < start); |
298 | BUG_ON(node->start < adj_start); | |
6b9d89b4 | 299 | BUG_ON(node->start + node->size > adj_end); |
ea7b1dd4 DV |
300 | BUG_ON(node->start + node->size > end); |
301 | ||
6b9d89b4 | 302 | node->hole_follows = 0; |
9e8944ab | 303 | if (__drm_mm_hole_node_start(node) < hole_end) { |
ea7b1dd4 DV |
304 | list_add(&node->hole_stack, &mm->hole_stack); |
305 | node->hole_follows = 1; | |
a2e68e92 | 306 | } |
9fc935de DV |
307 | } |
308 | ||
b0b7af18 | 309 | /** |
e18c0412 DV |
310 | * drm_mm_insert_node_in_range_generic - ranged search for space and insert @node |
311 | * @mm: drm_mm to allocate from | |
312 | * @node: preallocate node to insert | |
313 | * @size: size of the allocation | |
314 | * @alignment: alignment of the allocation | |
315 | * @color: opaque tag value to use for this node | |
316 | * @start: start of the allowed range for this node | |
317 | * @end: end of the allowed range for this node | |
62347f9e LK |
318 | * @sflags: flags to fine-tune the allocation search |
319 | * @aflags: flags to fine-tune the allocation behavior | |
e18c0412 DV |
320 | * |
321 | * The preallocated node must be cleared to 0. | |
322 | * | |
323 | * Returns: | |
324 | * 0 on success, -ENOSPC if there's no suitable hole. | |
3a1bd924 | 325 | */ |
b8103450 | 326 | int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, struct drm_mm_node *node, |
62347f9e LK |
327 | unsigned long size, unsigned alignment, |
328 | unsigned long color, | |
31e5d7c6 | 329 | unsigned long start, unsigned long end, |
62347f9e LK |
330 | enum drm_mm_search_flags sflags, |
331 | enum drm_mm_allocator_flags aflags) | |
3a1bd924 | 332 | { |
b0b7af18 DV |
333 | struct drm_mm_node *hole_node; |
334 | ||
b8103450 CW |
335 | hole_node = drm_mm_search_free_in_range_generic(mm, |
336 | size, alignment, color, | |
62347f9e | 337 | start, end, sflags); |
b0b7af18 DV |
338 | if (!hole_node) |
339 | return -ENOSPC; | |
340 | ||
b8103450 CW |
341 | drm_mm_insert_helper_range(hole_node, node, |
342 | size, alignment, color, | |
62347f9e | 343 | start, end, aflags); |
b0b7af18 DV |
344 | return 0; |
345 | } | |
b8103450 CW |
346 | EXPORT_SYMBOL(drm_mm_insert_node_in_range_generic); |
347 | ||
b0b7af18 | 348 | /** |
e18c0412 DV |
349 | * drm_mm_remove_node - Remove a memory node from the allocator. |
350 | * @node: drm_mm_node to remove | |
351 | * | |
352 | * This just removes a node from its drm_mm allocator. The node does not need to | |
353 | * be cleared again before it can be re-inserted into this or any other drm_mm | |
354 | * allocator. It is a bug to call this function on a un-allocated node. | |
b0b7af18 DV |
355 | */ |
356 | void drm_mm_remove_node(struct drm_mm_node *node) | |
357 | { | |
ea7b1dd4 DV |
358 | struct drm_mm *mm = node->mm; |
359 | struct drm_mm_node *prev_node; | |
3a1bd924 | 360 | |
3ef80a81 BW |
361 | if (WARN_ON(!node->allocated)) |
362 | return; | |
363 | ||
ea7b1dd4 DV |
364 | BUG_ON(node->scanned_block || node->scanned_prev_free |
365 | || node->scanned_next_free); | |
3a1bd924 | 366 | |
ea7b1dd4 DV |
367 | prev_node = |
368 | list_entry(node->node_list.prev, struct drm_mm_node, node_list); | |
709ea971 | 369 | |
ea7b1dd4 | 370 | if (node->hole_follows) { |
9e8944ab CW |
371 | BUG_ON(__drm_mm_hole_node_start(node) == |
372 | __drm_mm_hole_node_end(node)); | |
ea7b1dd4 DV |
373 | list_del(&node->hole_stack); |
374 | } else | |
9e8944ab CW |
375 | BUG_ON(__drm_mm_hole_node_start(node) != |
376 | __drm_mm_hole_node_end(node)); | |
377 | ||
249d6048 | 378 | |
ea7b1dd4 DV |
379 | if (!prev_node->hole_follows) { |
380 | prev_node->hole_follows = 1; | |
381 | list_add(&prev_node->hole_stack, &mm->hole_stack); | |
382 | } else | |
383 | list_move(&prev_node->hole_stack, &mm->hole_stack); | |
384 | ||
385 | list_del(&node->node_list); | |
b0b7af18 DV |
386 | node->allocated = 0; |
387 | } | |
388 | EXPORT_SYMBOL(drm_mm_remove_node); | |
389 | ||
75214733 DV |
390 | static int check_free_hole(unsigned long start, unsigned long end, |
391 | unsigned long size, unsigned alignment) | |
7a6b2896 | 392 | { |
75214733 | 393 | if (end - start < size) |
7a6b2896 DV |
394 | return 0; |
395 | ||
396 | if (alignment) { | |
75214733 | 397 | unsigned tmp = start % alignment; |
7a6b2896 | 398 | if (tmp) |
6b9d89b4 | 399 | start += alignment - tmp; |
7a6b2896 DV |
400 | } |
401 | ||
6b9d89b4 | 402 | return end >= start + size; |
7a6b2896 DV |
403 | } |
404 | ||
c700c67b DH |
405 | static struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm, |
406 | unsigned long size, | |
407 | unsigned alignment, | |
408 | unsigned long color, | |
409 | enum drm_mm_search_flags flags) | |
3a1bd924 | 410 | { |
55910517 DA |
411 | struct drm_mm_node *entry; |
412 | struct drm_mm_node *best; | |
9e8944ab CW |
413 | unsigned long adj_start; |
414 | unsigned long adj_end; | |
3a1bd924 TH |
415 | unsigned long best_size; |
416 | ||
709ea971 DV |
417 | BUG_ON(mm->scanned_blocks); |
418 | ||
3a1bd924 TH |
419 | best = NULL; |
420 | best_size = ~0UL; | |
421 | ||
62347f9e LK |
422 | __drm_mm_for_each_hole(entry, mm, adj_start, adj_end, |
423 | flags & DRM_MM_SEARCH_BELOW) { | |
145bccd2 MD |
424 | unsigned long hole_size = adj_end - adj_start; |
425 | ||
6b9d89b4 CW |
426 | if (mm->color_adjust) { |
427 | mm->color_adjust(entry, color, &adj_start, &adj_end); | |
428 | if (adj_end <= adj_start) | |
429 | continue; | |
430 | } | |
431 | ||
6b9d89b4 | 432 | if (!check_free_hole(adj_start, adj_end, size, alignment)) |
1d58420b TH |
433 | continue; |
434 | ||
31e5d7c6 | 435 | if (!(flags & DRM_MM_SEARCH_BEST)) |
7a6b2896 | 436 | return entry; |
1d58420b | 437 | |
145bccd2 | 438 | if (hole_size < best_size) { |
7a6b2896 | 439 | best = entry; |
145bccd2 | 440 | best_size = hole_size; |
3a1bd924 TH |
441 | } |
442 | } | |
443 | ||
444 | return best; | |
445 | } | |
6b9d89b4 | 446 | |
c700c67b | 447 | static struct drm_mm_node *drm_mm_search_free_in_range_generic(const struct drm_mm *mm, |
6b9d89b4 CW |
448 | unsigned long size, |
449 | unsigned alignment, | |
450 | unsigned long color, | |
451 | unsigned long start, | |
452 | unsigned long end, | |
31e5d7c6 | 453 | enum drm_mm_search_flags flags) |
a2e68e92 | 454 | { |
a2e68e92 JG |
455 | struct drm_mm_node *entry; |
456 | struct drm_mm_node *best; | |
9e8944ab CW |
457 | unsigned long adj_start; |
458 | unsigned long adj_end; | |
a2e68e92 | 459 | unsigned long best_size; |
a2e68e92 | 460 | |
709ea971 DV |
461 | BUG_ON(mm->scanned_blocks); |
462 | ||
a2e68e92 JG |
463 | best = NULL; |
464 | best_size = ~0UL; | |
465 | ||
62347f9e LK |
466 | __drm_mm_for_each_hole(entry, mm, adj_start, adj_end, |
467 | flags & DRM_MM_SEARCH_BELOW) { | |
145bccd2 MD |
468 | unsigned long hole_size = adj_end - adj_start; |
469 | ||
9e8944ab CW |
470 | if (adj_start < start) |
471 | adj_start = start; | |
472 | if (adj_end > end) | |
473 | adj_end = end; | |
6b9d89b4 CW |
474 | |
475 | if (mm->color_adjust) { | |
476 | mm->color_adjust(entry, color, &adj_start, &adj_end); | |
477 | if (adj_end <= adj_start) | |
478 | continue; | |
479 | } | |
480 | ||
75214733 | 481 | if (!check_free_hole(adj_start, adj_end, size, alignment)) |
a2e68e92 JG |
482 | continue; |
483 | ||
31e5d7c6 | 484 | if (!(flags & DRM_MM_SEARCH_BEST)) |
7a6b2896 | 485 | return entry; |
a2e68e92 | 486 | |
145bccd2 | 487 | if (hole_size < best_size) { |
7a6b2896 | 488 | best = entry; |
145bccd2 | 489 | best_size = hole_size; |
a2e68e92 JG |
490 | } |
491 | } | |
492 | ||
493 | return best; | |
494 | } | |
a2e68e92 | 495 | |
b0b7af18 | 496 | /** |
e18c0412 DV |
497 | * drm_mm_replace_node - move an allocation from @old to @new |
498 | * @old: drm_mm_node to remove from the allocator | |
499 | * @new: drm_mm_node which should inherit @old's allocation | |
500 | * | |
501 | * This is useful for when drivers embed the drm_mm_node structure and hence | |
502 | * can't move allocations by reassigning pointers. It's a combination of remove | |
503 | * and insert with the guarantee that the allocation start will match. | |
b0b7af18 DV |
504 | */ |
505 | void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new) | |
506 | { | |
507 | list_replace(&old->node_list, &new->node_list); | |
2bbd4492 | 508 | list_replace(&old->hole_stack, &new->hole_stack); |
b0b7af18 DV |
509 | new->hole_follows = old->hole_follows; |
510 | new->mm = old->mm; | |
511 | new->start = old->start; | |
512 | new->size = old->size; | |
6b9d89b4 | 513 | new->color = old->color; |
b0b7af18 DV |
514 | |
515 | old->allocated = 0; | |
516 | new->allocated = 1; | |
517 | } | |
518 | EXPORT_SYMBOL(drm_mm_replace_node); | |
519 | ||
93110be6 DV |
520 | /** |
521 | * DOC: lru scan roaster | |
522 | * | |
523 | * Very often GPUs need to have continuous allocations for a given object. When | |
524 | * evicting objects to make space for a new one it is therefore not most | |
525 | * efficient when we simply start to select all objects from the tail of an LRU | |
526 | * until there's a suitable hole: Especially for big objects or nodes that | |
527 | * otherwise have special allocation constraints there's a good chance we evict | |
528 | * lots of (smaller) objects unecessarily. | |
529 | * | |
530 | * The DRM range allocator supports this use-case through the scanning | |
531 | * interfaces. First a scan operation needs to be initialized with | |
532 | * drm_mm_init_scan() or drm_mm_init_scan_with_range(). The the driver adds | |
533 | * objects to the roaster (probably by walking an LRU list, but this can be | |
534 | * freely implemented) until a suitable hole is found or there's no further | |
535 | * evitable object. | |
536 | * | |
537 | * The the driver must walk through all objects again in exactly the reverse | |
538 | * order to restore the allocator state. Note that while the allocator is used | |
539 | * in the scan mode no other operation is allowed. | |
540 | * | |
541 | * Finally the driver evicts all objects selected in the scan. Adding and | |
542 | * removing an object is O(1), and since freeing a node is also O(1) the overall | |
543 | * complexity is O(scanned_objects). So like the free stack which needs to be | |
544 | * walked before a scan operation even begins this is linear in the number of | |
545 | * objects. It doesn't seem to hurt badly. | |
546 | */ | |
547 | ||
709ea971 | 548 | /** |
e18c0412 DV |
549 | * drm_mm_init_scan - initialize lru scanning |
550 | * @mm: drm_mm to scan | |
551 | * @size: size of the allocation | |
552 | * @alignment: alignment of the allocation | |
553 | * @color: opaque tag value to use for the allocation | |
709ea971 DV |
554 | * |
555 | * This simply sets up the scanning routines with the parameters for the desired | |
e18c0412 DV |
556 | * hole. Note that there's no need to specify allocation flags, since they only |
557 | * change the place a node is allocated from within a suitable hole. | |
709ea971 | 558 | * |
e18c0412 DV |
559 | * Warning: |
560 | * As long as the scan list is non-empty, no other operations than | |
709ea971 DV |
561 | * adding/removing nodes to/from the scan list are allowed. |
562 | */ | |
6b9d89b4 CW |
563 | void drm_mm_init_scan(struct drm_mm *mm, |
564 | unsigned long size, | |
565 | unsigned alignment, | |
566 | unsigned long color) | |
709ea971 | 567 | { |
6b9d89b4 | 568 | mm->scan_color = color; |
709ea971 DV |
569 | mm->scan_alignment = alignment; |
570 | mm->scan_size = size; | |
571 | mm->scanned_blocks = 0; | |
572 | mm->scan_hit_start = 0; | |
901593f2 | 573 | mm->scan_hit_end = 0; |
d935cc61 | 574 | mm->scan_check_range = 0; |
ae0cec28 | 575 | mm->prev_scanned_node = NULL; |
709ea971 DV |
576 | } |
577 | EXPORT_SYMBOL(drm_mm_init_scan); | |
578 | ||
d935cc61 | 579 | /** |
e18c0412 DV |
580 | * drm_mm_init_scan - initialize range-restricted lru scanning |
581 | * @mm: drm_mm to scan | |
582 | * @size: size of the allocation | |
583 | * @alignment: alignment of the allocation | |
584 | * @color: opaque tag value to use for the allocation | |
585 | * @start: start of the allowed range for the allocation | |
586 | * @end: end of the allowed range for the allocation | |
d935cc61 DV |
587 | * |
588 | * This simply sets up the scanning routines with the parameters for the desired | |
e18c0412 DV |
589 | * hole. Note that there's no need to specify allocation flags, since they only |
590 | * change the place a node is allocated from within a suitable hole. | |
d935cc61 | 591 | * |
e18c0412 DV |
592 | * Warning: |
593 | * As long as the scan list is non-empty, no other operations than | |
d935cc61 DV |
594 | * adding/removing nodes to/from the scan list are allowed. |
595 | */ | |
6b9d89b4 CW |
596 | void drm_mm_init_scan_with_range(struct drm_mm *mm, |
597 | unsigned long size, | |
d935cc61 | 598 | unsigned alignment, |
6b9d89b4 | 599 | unsigned long color, |
d935cc61 DV |
600 | unsigned long start, |
601 | unsigned long end) | |
602 | { | |
6b9d89b4 | 603 | mm->scan_color = color; |
d935cc61 DV |
604 | mm->scan_alignment = alignment; |
605 | mm->scan_size = size; | |
606 | mm->scanned_blocks = 0; | |
607 | mm->scan_hit_start = 0; | |
901593f2 | 608 | mm->scan_hit_end = 0; |
d935cc61 DV |
609 | mm->scan_start = start; |
610 | mm->scan_end = end; | |
611 | mm->scan_check_range = 1; | |
ae0cec28 | 612 | mm->prev_scanned_node = NULL; |
d935cc61 DV |
613 | } |
614 | EXPORT_SYMBOL(drm_mm_init_scan_with_range); | |
615 | ||
709ea971 | 616 | /** |
e18c0412 DV |
617 | * drm_mm_scan_add_block - add a node to the scan list |
618 | * @node: drm_mm_node to add | |
619 | * | |
709ea971 DV |
620 | * Add a node to the scan list that might be freed to make space for the desired |
621 | * hole. | |
622 | * | |
e18c0412 DV |
623 | * Returns: |
624 | * True if a hole has been found, false otherwise. | |
709ea971 | 625 | */ |
e18c0412 | 626 | bool drm_mm_scan_add_block(struct drm_mm_node *node) |
709ea971 DV |
627 | { |
628 | struct drm_mm *mm = node->mm; | |
ea7b1dd4 DV |
629 | struct drm_mm_node *prev_node; |
630 | unsigned long hole_start, hole_end; | |
901593f2 | 631 | unsigned long adj_start, adj_end; |
709ea971 DV |
632 | |
633 | mm->scanned_blocks++; | |
634 | ||
ea7b1dd4 | 635 | BUG_ON(node->scanned_block); |
709ea971 | 636 | node->scanned_block = 1; |
709ea971 | 637 | |
ea7b1dd4 DV |
638 | prev_node = list_entry(node->node_list.prev, struct drm_mm_node, |
639 | node_list); | |
709ea971 | 640 | |
ea7b1dd4 DV |
641 | node->scanned_preceeds_hole = prev_node->hole_follows; |
642 | prev_node->hole_follows = 1; | |
643 | list_del(&node->node_list); | |
644 | node->node_list.prev = &prev_node->node_list; | |
ae0cec28 DV |
645 | node->node_list.next = &mm->prev_scanned_node->node_list; |
646 | mm->prev_scanned_node = node; | |
709ea971 | 647 | |
901593f2 CW |
648 | adj_start = hole_start = drm_mm_hole_node_start(prev_node); |
649 | adj_end = hole_end = drm_mm_hole_node_end(prev_node); | |
6b9d89b4 | 650 | |
d935cc61 | 651 | if (mm->scan_check_range) { |
6b9d89b4 CW |
652 | if (adj_start < mm->scan_start) |
653 | adj_start = mm->scan_start; | |
654 | if (adj_end > mm->scan_end) | |
655 | adj_end = mm->scan_end; | |
d935cc61 DV |
656 | } |
657 | ||
901593f2 CW |
658 | if (mm->color_adjust) |
659 | mm->color_adjust(prev_node, mm->scan_color, | |
660 | &adj_start, &adj_end); | |
661 | ||
6b9d89b4 | 662 | if (check_free_hole(adj_start, adj_end, |
75214733 | 663 | mm->scan_size, mm->scan_alignment)) { |
ea7b1dd4 | 664 | mm->scan_hit_start = hole_start; |
901593f2 | 665 | mm->scan_hit_end = hole_end; |
e18c0412 | 666 | return true; |
709ea971 DV |
667 | } |
668 | ||
e18c0412 | 669 | return false; |
709ea971 DV |
670 | } |
671 | EXPORT_SYMBOL(drm_mm_scan_add_block); | |
672 | ||
673 | /** | |
e18c0412 DV |
674 | * drm_mm_scan_remove_block - remove a node from the scan list |
675 | * @node: drm_mm_node to remove | |
709ea971 DV |
676 | * |
677 | * Nodes _must_ be removed in the exact same order from the scan list as they | |
678 | * have been added, otherwise the internal state of the memory manager will be | |
679 | * corrupted. | |
680 | * | |
681 | * When the scan list is empty, the selected memory nodes can be freed. An | |
31e5d7c6 DH |
682 | * immediately following drm_mm_search_free with !DRM_MM_SEARCH_BEST will then |
683 | * return the just freed block (because its at the top of the free_stack list). | |
709ea971 | 684 | * |
e18c0412 DV |
685 | * Returns: |
686 | * True if this block should be evicted, false otherwise. Will always | |
687 | * return false when no hole has been found. | |
709ea971 | 688 | */ |
e18c0412 | 689 | bool drm_mm_scan_remove_block(struct drm_mm_node *node) |
709ea971 DV |
690 | { |
691 | struct drm_mm *mm = node->mm; | |
ea7b1dd4 | 692 | struct drm_mm_node *prev_node; |
709ea971 DV |
693 | |
694 | mm->scanned_blocks--; | |
695 | ||
696 | BUG_ON(!node->scanned_block); | |
697 | node->scanned_block = 0; | |
709ea971 | 698 | |
ea7b1dd4 DV |
699 | prev_node = list_entry(node->node_list.prev, struct drm_mm_node, |
700 | node_list); | |
709ea971 | 701 | |
ea7b1dd4 | 702 | prev_node->hole_follows = node->scanned_preceeds_hole; |
ea7b1dd4 | 703 | list_add(&node->node_list, &prev_node->node_list); |
709ea971 | 704 | |
901593f2 CW |
705 | return (drm_mm_hole_node_end(node) > mm->scan_hit_start && |
706 | node->start < mm->scan_hit_end); | |
709ea971 DV |
707 | } |
708 | EXPORT_SYMBOL(drm_mm_scan_remove_block); | |
709 | ||
e18c0412 DV |
710 | /** |
711 | * drm_mm_clean - checks whether an allocator is clean | |
712 | * @mm: drm_mm allocator to check | |
713 | * | |
714 | * Returns: | |
715 | * True if the allocator is completely free, false if there's still a node | |
716 | * allocated in it. | |
717 | */ | |
718 | bool drm_mm_clean(struct drm_mm * mm) | |
3a1bd924 | 719 | { |
ea7b1dd4 | 720 | struct list_head *head = &mm->head_node.node_list; |
3a1bd924 | 721 | |
1d58420b TH |
722 | return (head->next->next == head); |
723 | } | |
249d6048 | 724 | EXPORT_SYMBOL(drm_mm_clean); |
3a1bd924 | 725 | |
e18c0412 DV |
726 | /** |
727 | * drm_mm_init - initialize a drm-mm allocator | |
728 | * @mm: the drm_mm structure to initialize | |
729 | * @start: start of the range managed by @mm | |
730 | * @size: end of the range managed by @mm | |
731 | * | |
732 | * Note that @mm must be cleared to 0 before calling this function. | |
733 | */ | |
77ef8bbc | 734 | void drm_mm_init(struct drm_mm * mm, unsigned long start, unsigned long size) |
1d58420b | 735 | { |
ea7b1dd4 | 736 | INIT_LIST_HEAD(&mm->hole_stack); |
709ea971 | 737 | mm->scanned_blocks = 0; |
3a1bd924 | 738 | |
ea7b1dd4 DV |
739 | /* Clever trick to avoid a special case in the free hole tracking. */ |
740 | INIT_LIST_HEAD(&mm->head_node.node_list); | |
741 | INIT_LIST_HEAD(&mm->head_node.hole_stack); | |
742 | mm->head_node.hole_follows = 1; | |
743 | mm->head_node.scanned_block = 0; | |
744 | mm->head_node.scanned_prev_free = 0; | |
745 | mm->head_node.scanned_next_free = 0; | |
746 | mm->head_node.mm = mm; | |
747 | mm->head_node.start = start + size; | |
748 | mm->head_node.size = start - mm->head_node.start; | |
749 | list_add_tail(&mm->head_node.hole_stack, &mm->hole_stack); | |
750 | ||
6b9d89b4 | 751 | mm->color_adjust = NULL; |
3a1bd924 | 752 | } |
673a394b | 753 | EXPORT_SYMBOL(drm_mm_init); |
3a1bd924 | 754 | |
e18c0412 DV |
755 | /** |
756 | * drm_mm_takedown - clean up a drm_mm allocator | |
757 | * @mm: drm_mm allocator to clean up | |
758 | * | |
759 | * Note that it is a bug to call this function on an allocator which is not | |
760 | * clean. | |
761 | */ | |
55910517 | 762 | void drm_mm_takedown(struct drm_mm * mm) |
3a1bd924 | 763 | { |
c700c67b DH |
764 | WARN(!list_empty(&mm->head_node.node_list), |
765 | "Memory manager not clean during takedown.\n"); | |
3a1bd924 | 766 | } |
f453ba04 | 767 | EXPORT_SYMBOL(drm_mm_takedown); |
fa8a1238 | 768 | |
2c54b133 DV |
769 | static unsigned long drm_mm_debug_hole(struct drm_mm_node *entry, |
770 | const char *prefix) | |
99d7e48e | 771 | { |
ea7b1dd4 DV |
772 | unsigned long hole_start, hole_end, hole_size; |
773 | ||
2c54b133 DV |
774 | if (entry->hole_follows) { |
775 | hole_start = drm_mm_hole_node_start(entry); | |
776 | hole_end = drm_mm_hole_node_end(entry); | |
777 | hole_size = hole_end - hole_start; | |
ea7b1dd4 DV |
778 | printk(KERN_DEBUG "%s 0x%08lx-0x%08lx: %8lu: free\n", |
779 | prefix, hole_start, hole_end, | |
780 | hole_size); | |
2c54b133 DV |
781 | return hole_size; |
782 | } | |
783 | ||
784 | return 0; | |
785 | } | |
786 | ||
e18c0412 DV |
787 | /** |
788 | * drm_mm_debug_table - dump allocator state to dmesg | |
789 | * @mm: drm_mm allocator to dump | |
790 | * @prefix: prefix to use for dumping to dmesg | |
791 | */ | |
2c54b133 DV |
792 | void drm_mm_debug_table(struct drm_mm *mm, const char *prefix) |
793 | { | |
794 | struct drm_mm_node *entry; | |
795 | unsigned long total_used = 0, total_free = 0, total = 0; | |
796 | ||
797 | total_free += drm_mm_debug_hole(&mm->head_node, prefix); | |
ea7b1dd4 DV |
798 | |
799 | drm_mm_for_each_node(entry, mm) { | |
800 | printk(KERN_DEBUG "%s 0x%08lx-0x%08lx: %8lu: used\n", | |
99d7e48e | 801 | prefix, entry->start, entry->start + entry->size, |
ea7b1dd4 DV |
802 | entry->size); |
803 | total_used += entry->size; | |
2c54b133 | 804 | total_free += drm_mm_debug_hole(entry, prefix); |
99d7e48e | 805 | } |
ea7b1dd4 DV |
806 | total = total_free + total_used; |
807 | ||
808 | printk(KERN_DEBUG "%s total: %lu, used %lu free %lu\n", prefix, total, | |
99d7e48e JG |
809 | total_used, total_free); |
810 | } | |
811 | EXPORT_SYMBOL(drm_mm_debug_table); | |
812 | ||
fa8a1238 | 813 | #if defined(CONFIG_DEBUG_FS) |
3a359f0b | 814 | static unsigned long drm_mm_dump_hole(struct seq_file *m, struct drm_mm_node *entry) |
fa8a1238 | 815 | { |
ea7b1dd4 DV |
816 | unsigned long hole_start, hole_end, hole_size; |
817 | ||
3a359f0b DV |
818 | if (entry->hole_follows) { |
819 | hole_start = drm_mm_hole_node_start(entry); | |
820 | hole_end = drm_mm_hole_node_end(entry); | |
821 | hole_size = hole_end - hole_start; | |
ea7b1dd4 DV |
822 | seq_printf(m, "0x%08lx-0x%08lx: 0x%08lx: free\n", |
823 | hole_start, hole_end, hole_size); | |
3a359f0b DV |
824 | return hole_size; |
825 | } | |
826 | ||
827 | return 0; | |
828 | } | |
829 | ||
e18c0412 DV |
830 | /** |
831 | * drm_mm_dump_table - dump allocator state to a seq_file | |
832 | * @m: seq_file to dump to | |
833 | * @mm: drm_mm allocator to dump | |
834 | */ | |
3a359f0b DV |
835 | int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm) |
836 | { | |
837 | struct drm_mm_node *entry; | |
838 | unsigned long total_used = 0, total_free = 0, total = 0; | |
839 | ||
840 | total_free += drm_mm_dump_hole(m, &mm->head_node); | |
ea7b1dd4 DV |
841 | |
842 | drm_mm_for_each_node(entry, mm) { | |
843 | seq_printf(m, "0x%08lx-0x%08lx: 0x%08lx: used\n", | |
844 | entry->start, entry->start + entry->size, | |
845 | entry->size); | |
846 | total_used += entry->size; | |
3a359f0b | 847 | total_free += drm_mm_dump_hole(m, entry); |
fa8a1238 | 848 | } |
ea7b1dd4 DV |
849 | total = total_free + total_used; |
850 | ||
851 | seq_printf(m, "total: %lu, used %lu free %lu\n", total, total_used, total_free); | |
fa8a1238 DA |
852 | return 0; |
853 | } | |
854 | EXPORT_SYMBOL(drm_mm_dump_table); | |
855 | #endif |