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