1 /************************************************************************** 2 * 3 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA. 4 * Copyright 2016 Intel Corporation 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 */ 40 #include <linux/bug.h> 41 #include <linux/rbtree.h> 42 #include <linux/kernel.h> 43 #include <linux/list.h> 44 #include <linux/spinlock.h> 45 #ifdef CONFIG_DEBUG_FS 46 #include <linux/seq_file.h> 47 #endif 48 #ifdef CONFIG_DRM_DEBUG_MM 49 #include <linux/stackdepot.h> 50 #endif 51 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 58 enum drm_mm_search_flags { 59 DRM_MM_SEARCH_DEFAULT = 0, 60 DRM_MM_SEARCH_BEST = 1 << 0, 61 DRM_MM_SEARCH_BELOW = 1 << 1, 62 }; 63 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 72 struct drm_mm_node { 73 struct list_head node_list; 74 struct list_head hole_stack; 75 struct rb_node rb; 76 unsigned hole_follows : 1; 77 unsigned scanned_block : 1; 78 unsigned scanned_prev_free : 1; 79 unsigned scanned_next_free : 1; 80 unsigned scanned_preceeds_hole : 1; 81 unsigned allocated : 1; 82 unsigned long color; 83 u64 start; 84 u64 size; 85 u64 __subtree_last; 86 struct drm_mm *mm; 87 #ifdef CONFIG_DRM_DEBUG_MM 88 depot_stack_handle_t stack; 89 #endif 90 }; 91 92 struct drm_mm { 93 /* List of all memory nodes that immediately precede a free hole. */ 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; 98 /* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */ 99 struct rb_root interval_tree; 100 101 void (*color_adjust)(const struct drm_mm_node *node, 102 unsigned long color, 103 u64 *start, u64 *end); 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; 123 }; 124 125 /** 126 * drm_mm_node_allocated - checks whether a node is allocated 127 * @node: drm_mm_node to check 128 * 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 133 * internals. 134 * 135 * Returns: 136 * True if the @node is allocated. 137 */ 138 static inline bool drm_mm_node_allocated(const struct drm_mm_node *node) 139 { 140 return node->allocated; 141 } 142 143 /** 144 * drm_mm_initialized - checks whether an allocator is initialized 145 * @mm: drm_mm to check 146 * 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 151 * internals. 152 * 153 * Returns: 154 * True if the @mm is initialized. 155 */ 156 static inline bool drm_mm_initialized(const struct drm_mm *mm) 157 { 158 return mm->hole_stack.next; 159 } 160 161 static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 162 { 163 return hole_node->start + hole_node->size; 164 } 165 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 * 170 * This is useful for driver-specific debug dumpers. Otherwise drivers should 171 * not inspect holes themselves. Drivers must check first whether a hole indeed 172 * follows by looking at node->hole_follows. 173 * 174 * Returns: 175 * Start of the subsequent hole. 176 */ 177 static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 178 { 179 DRM_MM_BUG_ON(!hole_node->hole_follows); 180 return __drm_mm_hole_node_start(hole_node); 181 } 182 183 static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 184 { 185 return list_next_entry(hole_node, node_list)->start; 186 } 187 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 * 192 * This is useful for driver-specific debug dumpers. Otherwise drivers should 193 * not inspect holes themselves. Drivers must check first whether a hole indeed 194 * follows by looking at node->hole_follows. 195 * 196 * Returns: 197 * End of the subsequent hole. 198 */ 199 static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 200 { 201 return __drm_mm_hole_node_end(hole_node); 202 } 203 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) 217 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 */ 226 #define drm_mm_for_each_node(entry, mm) \ 227 list_for_each_entry(entry, drm_mm_nodes(mm), node_list) 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) \ 239 list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list) 240 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 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. 264 * 265 * The __drm_mm_for_each_hole version is similar, but with added support for 266 * going backwards. 267 */ 268 #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 269 __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) 270 271 /* 272 * Basic range manager support (drm_mm.c) 273 */ 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, 278 u64 size, 279 u64 alignment, 280 unsigned long color, 281 enum drm_mm_search_flags sflags, 282 enum drm_mm_allocator_flags aflags); 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 */ 299 static inline int drm_mm_insert_node(struct drm_mm *mm, 300 struct drm_mm_node *node, 301 u64 size, 302 u64 alignment, 303 enum drm_mm_search_flags flags) 304 { 305 return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, 306 DRM_MM_CREATE_DEFAULT); 307 } 308 309 int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 310 struct drm_mm_node *node, 311 u64 size, 312 u64 alignment, 313 unsigned long color, 314 u64 start, 315 u64 end, 316 enum drm_mm_search_flags sflags, 317 enum drm_mm_allocator_flags aflags); 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 */ 336 static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 337 struct drm_mm_node *node, 338 u64 size, 339 u64 alignment, 340 u64 start, 341 u64 end, 342 enum drm_mm_search_flags flags) 343 { 344 return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 345 0, start, end, flags, 346 DRM_MM_CREATE_DEFAULT); 347 } 348 349 void drm_mm_remove_node(struct drm_mm_node *node); 350 void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 351 void drm_mm_init(struct drm_mm *mm, u64 start, u64 size); 352 void drm_mm_takedown(struct drm_mm *mm); 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 } 366 367 struct drm_mm_node * 368 __drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last); 369 370 /** 371 * drm_mm_for_each_node_in_range - iterator to walk over a range of 372 * allocated nodes 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) 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 */ 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)) 388 389 void drm_mm_scan_init_with_range(struct drm_mm_scan *scan, 390 struct drm_mm *mm, 391 u64 size, 392 u64 alignment, 393 unsigned long color, 394 u64 start, 395 u64 end); 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 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); 427 428 void drm_mm_debug_table(const struct drm_mm *mm, const char *prefix); 429 #ifdef CONFIG_DEBUG_FS 430 int drm_mm_dump_table(struct seq_file *m, const struct drm_mm *mm); 431 #endif 432 433 #endif 434