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