1 /************************************************************************** 2 * 3 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. 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 * Authors: 30 * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com> 31 */ 32 33 #ifndef _DRM_MM_H_ 34 #define _DRM_MM_H_ 35 36 /* 37 * Generic range manager structs 38 */ 39 #include <linux/bug.h> 40 #include <linux/rbtree.h> 41 #include <linux/kernel.h> 42 #include <linux/list.h> 43 #include <linux/spinlock.h> 44 #ifdef CONFIG_DEBUG_FS 45 #include <linux/seq_file.h> 46 #endif 47 #ifdef CONFIG_DRM_DEBUG_MM 48 #include <linux/stackdepot.h> 49 #endif 50 51 #ifdef CONFIG_DRM_DEBUG_MM 52 #define DRM_MM_BUG_ON(expr) BUG_ON(expr) 53 #else 54 #define DRM_MM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr) 55 #endif 56 57 enum drm_mm_search_flags { 58 DRM_MM_SEARCH_DEFAULT = 0, 59 DRM_MM_SEARCH_BEST = 1 << 0, 60 DRM_MM_SEARCH_BELOW = 1 << 1, 61 }; 62 63 enum drm_mm_allocator_flags { 64 DRM_MM_CREATE_DEFAULT = 0, 65 DRM_MM_CREATE_TOP = 1 << 0, 66 }; 67 68 #define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT 69 #define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP 70 71 struct drm_mm_node { 72 struct list_head node_list; 73 struct list_head hole_stack; 74 struct rb_node rb; 75 unsigned hole_follows : 1; 76 unsigned scanned_block : 1; 77 unsigned scanned_prev_free : 1; 78 unsigned scanned_next_free : 1; 79 unsigned scanned_preceeds_hole : 1; 80 unsigned allocated : 1; 81 unsigned long color; 82 u64 start; 83 u64 size; 84 u64 __subtree_last; 85 struct drm_mm *mm; 86 #ifdef CONFIG_DRM_DEBUG_MM 87 depot_stack_handle_t stack; 88 #endif 89 }; 90 91 struct drm_mm { 92 /* List of all memory nodes that immediately precede a free hole. */ 93 struct list_head hole_stack; 94 /* head_node.node_list is the list of all memory nodes, ordered 95 * according to the (increasing) start address of the memory node. */ 96 struct drm_mm_node head_node; 97 /* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */ 98 struct rb_root interval_tree; 99 100 unsigned int scan_check_range : 1; 101 unsigned int scanned_blocks; 102 unsigned long scan_color; 103 u64 scan_alignment; 104 u64 scan_size; 105 u64 scan_hit_start; 106 u64 scan_hit_end; 107 u64 scan_start; 108 u64 scan_end; 109 struct drm_mm_node *prev_scanned_node; 110 111 void (*color_adjust)(const struct drm_mm_node *node, 112 unsigned long color, 113 u64 *start, u64 *end); 114 }; 115 116 /** 117 * drm_mm_node_allocated - checks whether a node is allocated 118 * @node: drm_mm_node to check 119 * 120 * Drivers should use this helpers for proper encapusulation of drm_mm 121 * internals. 122 * 123 * Returns: 124 * True if the @node is allocated. 125 */ 126 static inline bool drm_mm_node_allocated(const struct drm_mm_node *node) 127 { 128 return node->allocated; 129 } 130 131 /** 132 * drm_mm_initialized - checks whether an allocator is initialized 133 * @mm: drm_mm to check 134 * 135 * Drivers should use this helpers for proper encapusulation of drm_mm 136 * internals. 137 * 138 * Returns: 139 * True if the @mm is initialized. 140 */ 141 static inline bool drm_mm_initialized(const struct drm_mm *mm) 142 { 143 return mm->hole_stack.next; 144 } 145 146 static inline u64 __drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 147 { 148 return hole_node->start + hole_node->size; 149 } 150 151 /** 152 * drm_mm_hole_node_start - computes the start of the hole following @node 153 * @hole_node: drm_mm_node which implicitly tracks the following hole 154 * 155 * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 156 * inspect holes themselves. Drivers must check first whether a hole indeed 157 * follows by looking at node->hole_follows. 158 * 159 * Returns: 160 * Start of the subsequent hole. 161 */ 162 static inline u64 drm_mm_hole_node_start(const struct drm_mm_node *hole_node) 163 { 164 DRM_MM_BUG_ON(!hole_node->hole_follows); 165 return __drm_mm_hole_node_start(hole_node); 166 } 167 168 static inline u64 __drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 169 { 170 return list_next_entry(hole_node, node_list)->start; 171 } 172 173 /** 174 * drm_mm_hole_node_end - computes the end of the hole following @node 175 * @hole_node: drm_mm_node which implicitly tracks the following hole 176 * 177 * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 178 * inspect holes themselves. Drivers must check first whether a hole indeed 179 * follows by looking at node->hole_follows. 180 * 181 * Returns: 182 * End of the subsequent hole. 183 */ 184 static inline u64 drm_mm_hole_node_end(const struct drm_mm_node *hole_node) 185 { 186 return __drm_mm_hole_node_end(hole_node); 187 } 188 189 /** 190 * drm_mm_nodes - list of nodes under the drm_mm range manager 191 * @mm: the struct drm_mm range manger 192 * 193 * As the drm_mm range manager hides its node_list deep with its 194 * structure, extracting it looks painful and repetitive. This is 195 * not expected to be used outside of the drm_mm_for_each_node() 196 * macros and similar internal functions. 197 * 198 * Returns: 199 * The node list, may be empty. 200 */ 201 #define drm_mm_nodes(mm) (&(mm)->head_node.node_list) 202 203 /** 204 * drm_mm_for_each_node - iterator to walk over all allocated nodes 205 * @entry: drm_mm_node structure to assign to in each iteration step 206 * @mm: drm_mm allocator to walk 207 * 208 * This iterator walks over all nodes in the range allocator. It is implemented 209 * with list_for_each, so not save against removal of elements. 210 */ 211 #define drm_mm_for_each_node(entry, mm) \ 212 list_for_each_entry(entry, drm_mm_nodes(mm), node_list) 213 214 /** 215 * drm_mm_for_each_node_safe - iterator to walk over all allocated nodes 216 * @entry: drm_mm_node structure to assign to in each iteration step 217 * @next: drm_mm_node structure to store the next step 218 * @mm: drm_mm allocator to walk 219 * 220 * This iterator walks over all nodes in the range allocator. It is implemented 221 * with list_for_each_safe, so save against removal of elements. 222 */ 223 #define drm_mm_for_each_node_safe(entry, next, mm) \ 224 list_for_each_entry_safe(entry, next, drm_mm_nodes(mm), node_list) 225 226 #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ 227 for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 228 &entry->hole_stack != &(mm)->hole_stack ? \ 229 hole_start = drm_mm_hole_node_start(entry), \ 230 hole_end = drm_mm_hole_node_end(entry), \ 231 1 : 0; \ 232 entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) 233 234 /** 235 * drm_mm_for_each_hole - iterator to walk over all holes 236 * @entry: drm_mm_node used internally to track progress 237 * @mm: drm_mm allocator to walk 238 * @hole_start: ulong variable to assign the hole start to on each iteration 239 * @hole_end: ulong variable to assign the hole end to on each iteration 240 * 241 * This iterator walks over all holes in the range allocator. It is implemented 242 * with list_for_each, so not save against removal of elements. @entry is used 243 * internally and will not reflect a real drm_mm_node for the very first hole. 244 * Hence users of this iterator may not access it. 245 * 246 * Implementation Note: 247 * We need to inline list_for_each_entry in order to be able to set hole_start 248 * and hole_end on each iteration while keeping the macro sane. 249 * 250 * The __drm_mm_for_each_hole version is similar, but with added support for 251 * going backwards. 252 */ 253 #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 254 __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) 255 256 /* 257 * Basic range manager support (drm_mm.c) 258 */ 259 int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 260 261 int drm_mm_insert_node_generic(struct drm_mm *mm, 262 struct drm_mm_node *node, 263 u64 size, 264 u64 alignment, 265 unsigned long color, 266 enum drm_mm_search_flags sflags, 267 enum drm_mm_allocator_flags aflags); 268 /** 269 * drm_mm_insert_node - search for space and insert @node 270 * @mm: drm_mm to allocate from 271 * @node: preallocate node to insert 272 * @size: size of the allocation 273 * @alignment: alignment of the allocation 274 * @flags: flags to fine-tune the allocation 275 * 276 * This is a simplified version of drm_mm_insert_node_generic() with @color set 277 * to 0. 278 * 279 * The preallocated node must be cleared to 0. 280 * 281 * Returns: 282 * 0 on success, -ENOSPC if there's no suitable hole. 283 */ 284 static inline int drm_mm_insert_node(struct drm_mm *mm, 285 struct drm_mm_node *node, 286 u64 size, 287 u64 alignment, 288 enum drm_mm_search_flags flags) 289 { 290 return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, 291 DRM_MM_CREATE_DEFAULT); 292 } 293 294 int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 295 struct drm_mm_node *node, 296 u64 size, 297 u64 alignment, 298 unsigned long color, 299 u64 start, 300 u64 end, 301 enum drm_mm_search_flags sflags, 302 enum drm_mm_allocator_flags aflags); 303 /** 304 * drm_mm_insert_node_in_range - ranged search for space and insert @node 305 * @mm: drm_mm to allocate from 306 * @node: preallocate node to insert 307 * @size: size of the allocation 308 * @alignment: alignment of the allocation 309 * @start: start of the allowed range for this node 310 * @end: end of the allowed range for this node 311 * @flags: flags to fine-tune the allocation 312 * 313 * This is a simplified version of drm_mm_insert_node_in_range_generic() with 314 * @color set to 0. 315 * 316 * The preallocated node must be cleared to 0. 317 * 318 * Returns: 319 * 0 on success, -ENOSPC if there's no suitable hole. 320 */ 321 static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 322 struct drm_mm_node *node, 323 u64 size, 324 u64 alignment, 325 u64 start, 326 u64 end, 327 enum drm_mm_search_flags flags) 328 { 329 return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 330 0, start, end, flags, 331 DRM_MM_CREATE_DEFAULT); 332 } 333 334 void drm_mm_remove_node(struct drm_mm_node *node); 335 void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 336 void drm_mm_init(struct drm_mm *mm, u64 start, u64 size); 337 void drm_mm_takedown(struct drm_mm *mm); 338 bool drm_mm_clean(const struct drm_mm *mm); 339 340 struct drm_mm_node * 341 __drm_mm_interval_first(const struct drm_mm *mm, u64 start, u64 last); 342 343 /** 344 * drm_mm_for_each_node_in_range - iterator to walk over a range of 345 * allocated nodes 346 * @node__: drm_mm_node structure to assign to in each iteration step 347 * @mm__: drm_mm allocator to walk 348 * @start__: starting offset, the first node will overlap this 349 * @end__: ending offset, the last node will start before this (but may overlap) 350 * 351 * This iterator walks over all nodes in the range allocator that lie 352 * between @start and @end. It is implemented similarly to list_for_each(), 353 * but using the internal interval tree to accelerate the search for the 354 * starting node, and so not safe against removal of elements. It assumes 355 * that @end is within (or is the upper limit of) the drm_mm allocator. 356 */ 357 #define drm_mm_for_each_node_in_range(node__, mm__, start__, end__) \ 358 for (node__ = __drm_mm_interval_first((mm__), (start__), (end__)-1); \ 359 node__ && node__->start < (end__); \ 360 node__ = list_next_entry(node__, node_list)) 361 362 void drm_mm_init_scan(struct drm_mm *mm, 363 u64 size, 364 u64 alignment, 365 unsigned long color); 366 void drm_mm_init_scan_with_range(struct drm_mm *mm, 367 u64 size, 368 u64 alignment, 369 unsigned long color, 370 u64 start, 371 u64 end); 372 bool drm_mm_scan_add_block(struct drm_mm_node *node); 373 bool drm_mm_scan_remove_block(struct drm_mm_node *node); 374 375 void drm_mm_debug_table(const struct drm_mm *mm, const char *prefix); 376 #ifdef CONFIG_DEBUG_FS 377 int drm_mm_dump_table(struct seq_file *m, const struct drm_mm *mm); 378 #endif 379 380 #endif 381