]>
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 | }; |
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; |
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 | ||
d935cc61 | 101 | unsigned int scan_check_range : 1; |
71733207 | 102 | unsigned int scanned_blocks; |
6b9d89b4 | 103 | unsigned long scan_color; |
71733207 | 104 | u64 scan_alignment; |
440fd528 TR |
105 | u64 scan_size; |
106 | u64 scan_hit_start; | |
107 | u64 scan_hit_end; | |
440fd528 TR |
108 | u64 scan_start; |
109 | u64 scan_end; | |
ae0cec28 | 110 | struct drm_mm_node *prev_scanned_node; |
6b9d89b4 | 111 | |
45b186f1 CW |
112 | void (*color_adjust)(const struct drm_mm_node *node, |
113 | unsigned long color, | |
440fd528 | 114 | u64 *start, u64 *end); |
249d6048 JG |
115 | }; |
116 | ||
e18c0412 DV |
117 | /** |
118 | * drm_mm_node_allocated - checks whether a node is allocated | |
119 | * @node: drm_mm_node to check | |
120 | * | |
ba004e39 CW |
121 | * Drivers are required to clear a node prior to using it with the |
122 | * drm_mm range manager. | |
123 | * | |
124 | * Drivers should use this helper for proper encapsulation of drm_mm | |
e18c0412 DV |
125 | * internals. |
126 | * | |
127 | * Returns: | |
128 | * True if the @node is allocated. | |
129 | */ | |
45b186f1 | 130 | static inline bool drm_mm_node_allocated(const struct drm_mm_node *node) |
b0b7af18 DV |
131 | { |
132 | return node->allocated; | |
133 | } | |
134 | ||
e18c0412 DV |
135 | /** |
136 | * drm_mm_initialized - checks whether an allocator is initialized | |
137 | * @mm: drm_mm to check | |
138 | * | |
ba004e39 CW |
139 | * Drivers should clear the struct drm_mm prior to initialisation if they |
140 | * want to use this function. | |
141 | * | |
142 | * Drivers should use this helper for proper encapsulation of drm_mm | |
e18c0412 DV |
143 | * internals. |
144 | * | |
145 | * Returns: | |
146 | * True if the @mm is initialized. | |
147 | */ | |
45b186f1 | 148 | static inline bool drm_mm_initialized(const struct drm_mm *mm) |
31a5b8ce | 149 | { |
ea7b1dd4 | 150 | return mm->hole_stack.next; |
31a5b8ce | 151 | } |
9e8944ab | 152 | |
45b186f1 | 153 | static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node) |
9e8944ab CW |
154 | { |
155 | return hole_node->start + hole_node->size; | |
156 | } | |
157 | ||
e18c0412 DV |
158 | /** |
159 | * drm_mm_hole_node_start - computes the start of the hole following @node | |
160 | * @hole_node: drm_mm_node which implicitly tracks the following hole | |
161 | * | |
ba004e39 CW |
162 | * This is useful for driver-specific debug dumpers. Otherwise drivers should |
163 | * not inspect holes themselves. Drivers must check first whether a hole indeed | |
e18c0412 DV |
164 | * follows by looking at node->hole_follows. |
165 | * | |
166 | * Returns: | |
167 | * Start of the subsequent hole. | |
168 | */ | |
45b186f1 | 169 | static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node) |
9e8944ab | 170 | { |
b3ee963f | 171 | DRM_MM_BUG_ON(!hole_node->hole_follows); |
9e8944ab CW |
172 | return __drm_mm_hole_node_start(hole_node); |
173 | } | |
174 | ||
45b186f1 | 175 | static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node) |
9e8944ab | 176 | { |
87069f44 | 177 | return list_next_entry(hole_node, node_list)->start; |
9e8944ab CW |
178 | } |
179 | ||
e18c0412 DV |
180 | /** |
181 | * drm_mm_hole_node_end - computes the end of the hole following @node | |
182 | * @hole_node: drm_mm_node which implicitly tracks the following hole | |
183 | * | |
ba004e39 CW |
184 | * This is useful for driver-specific debug dumpers. Otherwise drivers should |
185 | * not inspect holes themselves. Drivers must check first whether a hole indeed | |
e18c0412 DV |
186 | * follows by looking at node->hole_follows. |
187 | * | |
188 | * Returns: | |
189 | * End of the subsequent hole. | |
190 | */ | |
45b186f1 | 191 | static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node) |
9e8944ab CW |
192 | { |
193 | return __drm_mm_hole_node_end(hole_node); | |
194 | } | |
195 | ||
2bc98c86 CW |
196 | /** |
197 | * drm_mm_nodes - list of nodes under the drm_mm range manager | |
198 | * @mm: the struct drm_mm range manger | |
199 | * | |
200 | * As the drm_mm range manager hides its node_list deep with its | |
201 | * structure, extracting it looks painful and repetitive. This is | |
202 | * not expected to be used outside of the drm_mm_for_each_node() | |
203 | * macros and similar internal functions. | |
204 | * | |
205 | * Returns: | |
206 | * The node list, may be empty. | |
207 | */ | |
208 | #define drm_mm_nodes(mm) (&(mm)->head_node.node_list) | |
ad579002 | 209 | |
e18c0412 DV |
210 | /** |
211 | * drm_mm_for_each_node - iterator to walk over all allocated nodes | |
212 | * @entry: drm_mm_node structure to assign to in each iteration step | |
213 | * @mm: drm_mm allocator to walk | |
214 | * | |
215 | * This iterator walks over all nodes in the range allocator. It is implemented | |
216 | * with list_for_each, so not save against removal of elements. | |
217 | */ | |
ad579002 | 218 | #define drm_mm_for_each_node(entry, mm) \ |
2bc98c86 | 219 | list_for_each_entry(entry, drm_mm_nodes(mm), node_list) |
ad579002 CW |
220 | |
221 | /** | |
222 | * drm_mm_for_each_node_safe - iterator to walk over all allocated nodes | |
223 | * @entry: drm_mm_node structure to assign to in each iteration step | |
224 | * @next: drm_mm_node structure to store the next step | |
225 | * @mm: drm_mm allocator to walk | |
226 | * | |
227 | * This iterator walks over all nodes in the range allocator. It is implemented | |
228 | * with list_for_each_safe, so save against removal of elements. | |
229 | */ | |
230 | #define drm_mm_for_each_node_safe(entry, next, mm) \ | |
2bc98c86 | 231 | list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list) |
9e8944ab | 232 | |
18b40c58 GT |
233 | #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ |
234 | for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ | |
235 | &entry->hole_stack != &(mm)->hole_stack ? \ | |
236 | hole_start = drm_mm_hole_node_start(entry), \ | |
237 | hole_end = drm_mm_hole_node_end(entry), \ | |
238 | 1 : 0; \ | |
239 | entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) | |
240 | ||
e18c0412 DV |
241 | /** |
242 | * drm_mm_for_each_hole - iterator to walk over all holes | |
243 | * @entry: drm_mm_node used internally to track progress | |
244 | * @mm: drm_mm allocator to walk | |
245 | * @hole_start: ulong variable to assign the hole start to on each iteration | |
246 | * @hole_end: ulong variable to assign the hole end to on each iteration | |
247 | * | |
248 | * This iterator walks over all holes in the range allocator. It is implemented | |
249 | * with list_for_each, so not save against removal of elements. @entry is used | |
250 | * internally and will not reflect a real drm_mm_node for the very first hole. | |
251 | * Hence users of this iterator may not access it. | |
252 | * | |
253 | * Implementation Note: | |
254 | * We need to inline list_for_each_entry in order to be able to set hole_start | |
255 | * and hole_end on each iteration while keeping the macro sane. | |
62347f9e LK |
256 | * |
257 | * The __drm_mm_for_each_hole version is similar, but with added support for | |
258 | * going backwards. | |
9e8944ab CW |
259 | */ |
260 | #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ | |
18b40c58 | 261 | __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) |
62347f9e | 262 | |
249d6048 JG |
263 | /* |
264 | * Basic range manager support (drm_mm.c) | |
265 | */ | |
e18c0412 DV |
266 | int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); |
267 | ||
268 | int drm_mm_insert_node_generic(struct drm_mm *mm, | |
269 | struct drm_mm_node *node, | |
440fd528 | 270 | u64 size, |
71733207 | 271 | u64 alignment, |
e18c0412 | 272 | unsigned long color, |
62347f9e LK |
273 | enum drm_mm_search_flags sflags, |
274 | enum drm_mm_allocator_flags aflags); | |
e18c0412 DV |
275 | /** |
276 | * drm_mm_insert_node - search for space and insert @node | |
277 | * @mm: drm_mm to allocate from | |
278 | * @node: preallocate node to insert | |
279 | * @size: size of the allocation | |
280 | * @alignment: alignment of the allocation | |
281 | * @flags: flags to fine-tune the allocation | |
282 | * | |
283 | * This is a simplified version of drm_mm_insert_node_generic() with @color set | |
284 | * to 0. | |
285 | * | |
286 | * The preallocated node must be cleared to 0. | |
287 | * | |
288 | * Returns: | |
289 | * 0 on success, -ENOSPC if there's no suitable hole. | |
290 | */ | |
31e5d7c6 DH |
291 | static inline int drm_mm_insert_node(struct drm_mm *mm, |
292 | struct drm_mm_node *node, | |
440fd528 | 293 | u64 size, |
71733207 | 294 | u64 alignment, |
31e5d7c6 DH |
295 | enum drm_mm_search_flags flags) |
296 | { | |
62347f9e LK |
297 | return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, |
298 | DRM_MM_CREATE_DEFAULT); | |
31e5d7c6 DH |
299 | } |
300 | ||
e18c0412 DV |
301 | int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, |
302 | struct drm_mm_node *node, | |
440fd528 | 303 | u64 size, |
71733207 | 304 | u64 alignment, |
e18c0412 | 305 | unsigned long color, |
440fd528 TR |
306 | u64 start, |
307 | u64 end, | |
62347f9e LK |
308 | enum drm_mm_search_flags sflags, |
309 | enum drm_mm_allocator_flags aflags); | |
e18c0412 DV |
310 | /** |
311 | * drm_mm_insert_node_in_range - ranged search for space and insert @node | |
312 | * @mm: drm_mm to allocate from | |
313 | * @node: preallocate node to insert | |
314 | * @size: size of the allocation | |
315 | * @alignment: alignment of the allocation | |
316 | * @start: start of the allowed range for this node | |
317 | * @end: end of the allowed range for this node | |
318 | * @flags: flags to fine-tune the allocation | |
319 | * | |
320 | * This is a simplified version of drm_mm_insert_node_in_range_generic() with | |
321 | * @color set to 0. | |
322 | * | |
323 | * The preallocated node must be cleared to 0. | |
324 | * | |
325 | * Returns: | |
326 | * 0 on success, -ENOSPC if there's no suitable hole. | |
327 | */ | |
31e5d7c6 DH |
328 | static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, |
329 | struct drm_mm_node *node, | |
440fd528 | 330 | u64 size, |
71733207 | 331 | u64 alignment, |
440fd528 TR |
332 | u64 start, |
333 | u64 end, | |
31e5d7c6 DH |
334 | enum drm_mm_search_flags flags) |
335 | { | |
336 | return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, | |
62347f9e LK |
337 | 0, start, end, flags, |
338 | DRM_MM_CREATE_DEFAULT); | |
31e5d7c6 DH |
339 | } |
340 | ||
e18c0412 DV |
341 | void drm_mm_remove_node(struct drm_mm_node *node); |
342 | void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); | |
45b186f1 | 343 | void drm_mm_init(struct drm_mm *mm, u64 start, u64 size); |
e18c0412 | 344 | void drm_mm_takedown(struct drm_mm *mm); |
ac9bb7b7 CW |
345 | |
346 | /** | |
347 | * drm_mm_clean - checks whether an allocator is clean | |
348 | * @mm: drm_mm allocator to check | |
349 | * | |
350 | * Returns: | |
351 | * True if the allocator is completely free, false if there's still a node | |
352 | * allocated in it. | |
353 | */ | |
354 | static inline bool drm_mm_clean(const struct drm_mm *mm) | |
355 | { | |
356 | return list_empty(drm_mm_nodes(mm)); | |
357 | } | |
249d6048 | 358 | |
202b52b7 | 359 | struct drm_mm_node * |
45b186f1 | 360 | __drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last); |
202b52b7 | 361 | |
522e85dd CW |
362 | /** |
363 | * drm_mm_for_each_node_in_range - iterator to walk over a range of | |
364 | * allocated nodes | |
8b2fb7b6 CW |
365 | * @node__: drm_mm_node structure to assign to in each iteration step |
366 | * @mm__: drm_mm allocator to walk | |
367 | * @start__: starting offset, the first node will overlap this | |
368 | * @end__: ending offset, the last node will start before this (but may overlap) | |
522e85dd CW |
369 | * |
370 | * This iterator walks over all nodes in the range allocator that lie | |
371 | * between @start and @end. It is implemented similarly to list_for_each(), | |
372 | * but using the internal interval tree to accelerate the search for the | |
373 | * starting node, and so not safe against removal of elements. It assumes | |
374 | * that @end is within (or is the upper limit of) the drm_mm allocator. | |
375 | */ | |
8b2fb7b6 CW |
376 | #define drm_mm_for_each_node_in_range(node__, mm__, start__, end__) \ |
377 | for (node__ = __drm_mm_interval_first((mm__), (start__), (end__)-1); \ | |
378 | node__ && node__->start < (end__); \ | |
379 | node__ = list_next_entry(node__, node_list)) | |
202b52b7 | 380 | |
6b9d89b4 | 381 | void drm_mm_init_scan(struct drm_mm *mm, |
440fd528 | 382 | u64 size, |
71733207 | 383 | u64 alignment, |
6b9d89b4 CW |
384 | unsigned long color); |
385 | void drm_mm_init_scan_with_range(struct drm_mm *mm, | |
440fd528 | 386 | u64 size, |
71733207 | 387 | u64 alignment, |
6b9d89b4 | 388 | unsigned long color, |
440fd528 TR |
389 | u64 start, |
390 | u64 end); | |
e18c0412 DV |
391 | bool drm_mm_scan_add_block(struct drm_mm_node *node); |
392 | bool drm_mm_scan_remove_block(struct drm_mm_node *node); | |
709ea971 | 393 | |
45b186f1 | 394 | void drm_mm_debug_table(const struct drm_mm *mm, const char *prefix); |
fa8a1238 | 395 | #ifdef CONFIG_DEBUG_FS |
45b186f1 | 396 | int drm_mm_dump_table(struct seq_file *m, const struct drm_mm *mm); |
fa8a1238 DA |
397 | #endif |
398 | ||
249d6048 | 399 | #endif |