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_DRM_DEBUG_MM 46 #include <linux/stackdepot.h> 47 #endif 48 #include <drm/drm_print.h> 49 50 #ifdef CONFIG_DRM_DEBUG_MM 51 #define DRM_MM_BUG_ON(expr) BUG_ON(expr) 52 #else 53 #define DRM_MM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr) 54 #endif 55 56 enum drm_mm_search_flags { 57 DRM_MM_SEARCH_DEFAULT = 0, 58 DRM_MM_SEARCH_BEST = 1 << 0, 59 DRM_MM_SEARCH_BELOW = 1 << 1, 60 }; 61 62 enum drm_mm_allocator_flags { 63 DRM_MM_CREATE_DEFAULT = 0, 64 DRM_MM_CREATE_TOP = 1 << 0, 65 }; 66 67 #define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT 68 #define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP 69 70 struct drm_mm_node { 71 struct list_head node_list; 72 struct list_head hole_stack; 73 struct rb_node rb; 74 unsigned hole_follows : 1; 75 unsigned allocated : 1; 76 bool scanned_block : 1; 77 unsigned long color; 78 u64 start; 79 u64 size; 80 u64 __subtree_last; 81 struct drm_mm *mm; 82 #ifdef CONFIG_DRM_DEBUG_MM 83 depot_stack_handle_t stack; 84 #endif 85 }; 86 87 struct drm_mm { 88 /* List of all memory nodes that immediately precede a free hole. */ 89 struct list_head hole_stack; 90 /* head_node.node_list is the list of all memory nodes, ordered 91 * according to the (increasing) start address of the memory node. */ 92 struct drm_mm_node head_node; 93 /* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */ 94 struct rb_root interval_tree; 95 96 void (*color_adjust)(const struct drm_mm_node *node, 97 unsigned long color, 98 u64 *start, u64 *end); 99 100 unsigned long scan_active; 101 }; 102 103 struct drm_mm_scan { 104 struct drm_mm *mm; 105 106 u64 size; 107 u64 alignment; 108 u64 remainder_mask; 109 110 u64 range_start; 111 u64 range_end; 112 113 u64 hit_start; 114 u64 hit_end; 115 116 unsigned long color; 117 unsigned int flags; 118 }; 119 120 /** 121 * drm_mm_node_allocated - checks whether a node is allocated 122 * @node: drm_mm_node to check 123 * 124 * Drivers are required to clear a node prior to using it with the 125 * drm_mm range manager. 126 * 127 * Drivers should use this helper for proper encapsulation of drm_mm 128 * internals. 129 * 130 * Returns: 131 * True if the @node is allocated. 132 */ 133 static inline bool drm_mm_node_allocated(const struct drm_mm_node *node) 134 { 135 return node->allocated; 136 } 137 138 /** 139 * drm_mm_initialized - checks whether an allocator is initialized 140 * @mm: drm_mm to check 141 * 142 * Drivers should clear the struct drm_mm prior to initialisation if they 143 * want to use this function. 144 * 145 * Drivers should use this helper for proper encapsulation of drm_mm 146 * internals. 147 * 148 * Returns: 149 * True if the @mm is initialized. 150 */ 151 static inline bool drm_mm_initialized(const struct drm_mm *mm) 152 { 153 return mm->hole_stack.next; 154 } 155 156 /** 157 * drm_mm_hole_follows - checks whether a hole follows this node 158 * @node: drm_mm_node to check 159 * 160 * Holes are embedded into the drm_mm using the tail of a drm_mm_node. 161 * If you wish to know whether a hole follows this particular node, 162 * query this function. 163 * 164 * Returns: 165 * True if a hole follows the @node. 166 */ 167 static inline bool drm_mm_hole_follows(const struct drm_mm_node *node) 168 { 169 return node->hole_follows; 170 } 171 172 static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 173 { 174 return hole_node->start + hole_node->size; 175 } 176 177 /** 178 * drm_mm_hole_node_start - computes the start of the hole following @node 179 * @hole_node: drm_mm_node which implicitly tracks the following hole 180 * 181 * This is useful for driver-specific debug dumpers. Otherwise drivers should 182 * not inspect holes themselves. Drivers must check first whether a hole indeed 183 * follows by looking at drm_mm_hole_follows() 184 * 185 * Returns: 186 * Start of the subsequent hole. 187 */ 188 static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 189 { 190 DRM_MM_BUG_ON(!drm_mm_hole_follows(hole_node)); 191 return __drm_mm_hole_node_start(hole_node); 192 } 193 194 static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 195 { 196 return list_next_entry(hole_node, node_list)->start; 197 } 198 199 /** 200 * drm_mm_hole_node_end - computes the end of the hole following @node 201 * @hole_node: drm_mm_node which implicitly tracks the following hole 202 * 203 * This is useful for driver-specific debug dumpers. Otherwise drivers should 204 * not inspect holes themselves. Drivers must check first whether a hole indeed 205 * follows by looking at drm_mm_hole_follows(). 206 * 207 * Returns: 208 * End of the subsequent hole. 209 */ 210 static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 211 { 212 return __drm_mm_hole_node_end(hole_node); 213 } 214 215 /** 216 * drm_mm_nodes - list of nodes under the drm_mm range manager 217 * @mm: the struct drm_mm range manger 218 * 219 * As the drm_mm range manager hides its node_list deep with its 220 * structure, extracting it looks painful and repetitive. This is 221 * not expected to be used outside of the drm_mm_for_each_node() 222 * macros and similar internal functions. 223 * 224 * Returns: 225 * The node list, may be empty. 226 */ 227 #define drm_mm_nodes(mm) (&(mm)->head_node.node_list) 228 229 /** 230 * drm_mm_for_each_node - iterator to walk over all allocated nodes 231 * @entry: drm_mm_node structure to assign to in each iteration step 232 * @mm: drm_mm allocator to walk 233 * 234 * This iterator walks over all nodes in the range allocator. It is implemented 235 * with list_for_each, so not save against removal of elements. 236 */ 237 #define drm_mm_for_each_node(entry, mm) \ 238 list_for_each_entry(entry, drm_mm_nodes(mm), node_list) 239 240 /** 241 * drm_mm_for_each_node_safe - iterator to walk over all allocated nodes 242 * @entry: drm_mm_node structure to assign to in each iteration step 243 * @next: drm_mm_node structure to store the next step 244 * @mm: drm_mm allocator to walk 245 * 246 * This iterator walks over all nodes in the range allocator. It is implemented 247 * with list_for_each_safe, so save against removal of elements. 248 */ 249 #define drm_mm_for_each_node_safe(entry, next, mm) \ 250 list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list) 251 252 #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ 253 for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 254 &entry->hole_stack != &(mm)->hole_stack ? \ 255 hole_start = drm_mm_hole_node_start(entry), \ 256 hole_end = drm_mm_hole_node_end(entry), \ 257 1 : 0; \ 258 entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) 259 260 /** 261 * drm_mm_for_each_hole - iterator to walk over all holes 262 * @entry: drm_mm_node used internally to track progress 263 * @mm: drm_mm allocator to walk 264 * @hole_start: ulong variable to assign the hole start to on each iteration 265 * @hole_end: ulong variable to assign the hole end to on each iteration 266 * 267 * This iterator walks over all holes in the range allocator. It is implemented 268 * with list_for_each, so not save against removal of elements. @entry is used 269 * internally and will not reflect a real drm_mm_node for the very first hole. 270 * Hence users of this iterator may not access it. 271 * 272 * Implementation Note: 273 * We need to inline list_for_each_entry in order to be able to set hole_start 274 * and hole_end on each iteration while keeping the macro sane. 275 * 276 * The __drm_mm_for_each_hole version is similar, but with added support for 277 * going backwards. 278 */ 279 #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 280 __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) 281 282 /* 283 * Basic range manager support (drm_mm.c) 284 */ 285 int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 286 int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 287 struct drm_mm_node *node, 288 u64 size, 289 u64 alignment, 290 unsigned long color, 291 u64 start, 292 u64 end, 293 enum drm_mm_search_flags sflags, 294 enum drm_mm_allocator_flags aflags); 295 296 /** 297 * drm_mm_insert_node_in_range - ranged search for space and insert @node 298 * @mm: drm_mm to allocate from 299 * @node: preallocate node to insert 300 * @size: size of the allocation 301 * @alignment: alignment of the allocation 302 * @start: start of the allowed range for this node 303 * @end: end of the allowed range for this node 304 * @flags: flags to fine-tune the allocation 305 * 306 * This is a simplified version of drm_mm_insert_node_in_range_generic() with 307 * @color set to 0. 308 * 309 * The preallocated node must be cleared to 0. 310 * 311 * Returns: 312 * 0 on success, -ENOSPC if there's no suitable hole. 313 */ 314 static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 315 struct drm_mm_node *node, 316 u64 size, 317 u64 alignment, 318 u64 start, 319 u64 end, 320 enum drm_mm_search_flags flags) 321 { 322 return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 323 0, start, end, flags, 324 DRM_MM_CREATE_DEFAULT); 325 } 326 327 /** 328 * drm_mm_insert_node_generic - search for space and insert @node 329 * @mm: drm_mm to allocate from 330 * @node: preallocate node to insert 331 * @size: size of the allocation 332 * @alignment: alignment of the allocation 333 * @color: opaque tag value to use for this node 334 * @sflags: flags to fine-tune the allocation search 335 * @aflags: flags to fine-tune the allocation behavior 336 * 337 * The preallocated node must be cleared to 0. 338 * 339 * Returns: 340 * 0 on success, -ENOSPC if there's no suitable hole. 341 */ 342 static inline int 343 drm_mm_insert_node_generic(struct drm_mm *mm, struct drm_mm_node *node, 344 u64 size, u64 alignment, 345 unsigned long color, 346 enum drm_mm_search_flags sflags, 347 enum drm_mm_allocator_flags aflags) 348 { 349 return drm_mm_insert_node_in_range_generic(mm, node, 350 size, alignment, 0, 351 0, U64_MAX, 352 sflags, aflags); 353 } 354 355 /** 356 * drm_mm_insert_node - search for space and insert @node 357 * @mm: drm_mm to allocate from 358 * @node: preallocate node to insert 359 * @size: size of the allocation 360 * @alignment: alignment of the allocation 361 * @flags: flags to fine-tune the allocation 362 * 363 * This is a simplified version of drm_mm_insert_node_generic() with @color set 364 * to 0. 365 * 366 * The preallocated node must be cleared to 0. 367 * 368 * Returns: 369 * 0 on success, -ENOSPC if there's no suitable hole. 370 */ 371 static inline int drm_mm_insert_node(struct drm_mm *mm, 372 struct drm_mm_node *node, 373 u64 size, 374 u64 alignment, 375 enum drm_mm_search_flags flags) 376 { 377 return drm_mm_insert_node_generic(mm, node, 378 size, alignment, 0, 379 flags, DRM_MM_CREATE_DEFAULT); 380 } 381 382 void drm_mm_remove_node(struct drm_mm_node *node); 383 void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 384 void drm_mm_init(struct drm_mm *mm, u64 start, u64 size); 385 void drm_mm_takedown(struct drm_mm *mm); 386 387 /** 388 * drm_mm_clean - checks whether an allocator is clean 389 * @mm: drm_mm allocator to check 390 * 391 * Returns: 392 * True if the allocator is completely free, false if there's still a node 393 * allocated in it. 394 */ 395 static inline bool drm_mm_clean(const struct drm_mm *mm) 396 { 397 return list_empty(drm_mm_nodes(mm)); 398 } 399 400 struct drm_mm_node * 401 __drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last); 402 403 /** 404 * drm_mm_for_each_node_in_range - iterator to walk over a range of 405 * allocated nodes 406 * @node__: drm_mm_node structure to assign to in each iteration step 407 * @mm__: drm_mm allocator to walk 408 * @start__: starting offset, the first node will overlap this 409 * @end__: ending offset, the last node will start before this (but may overlap) 410 * 411 * This iterator walks over all nodes in the range allocator that lie 412 * between @start and @end. It is implemented similarly to list_for_each(), 413 * but using the internal interval tree to accelerate the search for the 414 * starting node, and so not safe against removal of elements. It assumes 415 * that @end is within (or is the upper limit of) the drm_mm allocator. 416 */ 417 #define drm_mm_for_each_node_in_range(node__, mm__, start__, end__) \ 418 for (node__ = __drm_mm_interval_first((mm__), (start__), (end__)-1); \ 419 node__ && node__->start < (end__); \ 420 node__ = list_next_entry(node__, node_list)) 421 422 void drm_mm_scan_init_with_range(struct drm_mm_scan *scan, 423 struct drm_mm *mm, 424 u64 size, u64 alignment, unsigned long color, 425 u64 start, u64 end, 426 unsigned int flags); 427 428 /** 429 * drm_mm_scan_init - initialize lru scanning 430 * @scan: scan state 431 * @mm: drm_mm to scan 432 * @size: size of the allocation 433 * @alignment: alignment of the allocation 434 * @color: opaque tag value to use for the allocation 435 * @flags: flags to specify how the allocation will be performed afterwards 436 * 437 * This simply sets up the scanning routines with the parameters for the desired 438 * hole. 439 * 440 * Warning: 441 * As long as the scan list is non-empty, no other operations than 442 * adding/removing nodes to/from the scan list are allowed. 443 */ 444 static inline void drm_mm_scan_init(struct drm_mm_scan *scan, 445 struct drm_mm *mm, 446 u64 size, 447 u64 alignment, 448 unsigned long color, 449 unsigned int flags) 450 { 451 drm_mm_scan_init_with_range(scan, mm, 452 size, alignment, color, 453 0, U64_MAX, 454 flags); 455 } 456 457 bool drm_mm_scan_add_block(struct drm_mm_scan *scan, 458 struct drm_mm_node *node); 459 bool drm_mm_scan_remove_block(struct drm_mm_scan *scan, 460 struct drm_mm_node *node); 461 struct drm_mm_node *drm_mm_scan_color_evict(struct drm_mm_scan *scan); 462 463 void drm_mm_print(const struct drm_mm *mm, struct drm_printer *p); 464 465 #endif 466