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