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