1249d6048SJerome Glisse /************************************************************************** 2249d6048SJerome Glisse * 3249d6048SJerome Glisse * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA. 4249d6048SJerome Glisse * All Rights Reserved. 5249d6048SJerome Glisse * 6249d6048SJerome Glisse * Permission is hereby granted, free of charge, to any person obtaining a 7249d6048SJerome Glisse * copy of this software and associated documentation files (the 8249d6048SJerome Glisse * "Software"), to deal in the Software without restriction, including 9249d6048SJerome Glisse * without limitation the rights to use, copy, modify, merge, publish, 10249d6048SJerome Glisse * distribute, sub license, and/or sell copies of the Software, and to 11249d6048SJerome Glisse * permit persons to whom the Software is furnished to do so, subject to 12249d6048SJerome Glisse * the following conditions: 13249d6048SJerome Glisse * 14249d6048SJerome Glisse * The above copyright notice and this permission notice (including the 15249d6048SJerome Glisse * next paragraph) shall be included in all copies or substantial portions 16249d6048SJerome Glisse * of the Software. 17249d6048SJerome Glisse * 18249d6048SJerome Glisse * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19249d6048SJerome Glisse * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20249d6048SJerome Glisse * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 21249d6048SJerome Glisse * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, 22249d6048SJerome Glisse * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 23249d6048SJerome Glisse * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 24249d6048SJerome Glisse * USE OR OTHER DEALINGS IN THE SOFTWARE. 25249d6048SJerome Glisse * 26249d6048SJerome Glisse * 27249d6048SJerome Glisse **************************************************************************/ 28249d6048SJerome Glisse /* 29249d6048SJerome Glisse * Authors: 30249d6048SJerome Glisse * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com> 31249d6048SJerome Glisse */ 32249d6048SJerome Glisse 33249d6048SJerome Glisse #ifndef _DRM_MM_H_ 34249d6048SJerome Glisse #define _DRM_MM_H_ 35249d6048SJerome Glisse 36249d6048SJerome Glisse /* 37249d6048SJerome Glisse * Generic range manager structs 38249d6048SJerome Glisse */ 3986e81f0eSDavid Herrmann #include <linux/bug.h> 4086e81f0eSDavid Herrmann #include <linux/kernel.h> 41249d6048SJerome Glisse #include <linux/list.h> 4286e81f0eSDavid Herrmann #include <linux/spinlock.h> 43f1938cd6SDave Airlie #ifdef CONFIG_DEBUG_FS 44f1938cd6SDave Airlie #include <linux/seq_file.h> 45f1938cd6SDave Airlie #endif 46249d6048SJerome Glisse 4731e5d7c6SDavid Herrmann enum drm_mm_search_flags { 4831e5d7c6SDavid Herrmann DRM_MM_SEARCH_DEFAULT = 0, 4931e5d7c6SDavid Herrmann DRM_MM_SEARCH_BEST = 1 << 0, 5031e5d7c6SDavid Herrmann }; 5131e5d7c6SDavid Herrmann 52249d6048SJerome Glisse struct drm_mm_node { 53d1024ce9SDaniel Vetter struct list_head node_list; 54ea7b1dd4SDaniel Vetter struct list_head hole_stack; 55ea7b1dd4SDaniel Vetter unsigned hole_follows : 1; 56709ea971SDaniel Vetter unsigned scanned_block : 1; 57709ea971SDaniel Vetter unsigned scanned_prev_free : 1; 58709ea971SDaniel Vetter unsigned scanned_next_free : 1; 59ea7b1dd4SDaniel Vetter unsigned scanned_preceeds_hole : 1; 60b0b7af18SDaniel Vetter unsigned allocated : 1; 616b9d89b4SChris Wilson unsigned long color; 62249d6048SJerome Glisse unsigned long start; 63249d6048SJerome Glisse unsigned long size; 64249d6048SJerome Glisse struct drm_mm *mm; 65249d6048SJerome Glisse }; 66249d6048SJerome Glisse 67249d6048SJerome Glisse struct drm_mm { 6825985edcSLucas De Marchi /* List of all memory nodes that immediately precede a free hole. */ 69ea7b1dd4SDaniel Vetter struct list_head hole_stack; 70ea7b1dd4SDaniel Vetter /* head_node.node_list is the list of all memory nodes, ordered 71ea7b1dd4SDaniel Vetter * according to the (increasing) start address of the memory node. */ 72ea7b1dd4SDaniel Vetter struct drm_mm_node head_node; 73d935cc61SDaniel Vetter unsigned int scan_check_range : 1; 74709ea971SDaniel Vetter unsigned scan_alignment; 756b9d89b4SChris Wilson unsigned long scan_color; 76709ea971SDaniel Vetter unsigned long scan_size; 77709ea971SDaniel Vetter unsigned long scan_hit_start; 78901593f2SChris Wilson unsigned long scan_hit_end; 79709ea971SDaniel Vetter unsigned scanned_blocks; 80d935cc61SDaniel Vetter unsigned long scan_start; 81d935cc61SDaniel Vetter unsigned long scan_end; 82ae0cec28SDaniel Vetter struct drm_mm_node *prev_scanned_node; 836b9d89b4SChris Wilson 846b9d89b4SChris Wilson void (*color_adjust)(struct drm_mm_node *node, unsigned long color, 856b9d89b4SChris Wilson unsigned long *start, unsigned long *end); 86249d6048SJerome Glisse }; 87249d6048SJerome Glisse 88e18c0412SDaniel Vetter /** 89e18c0412SDaniel Vetter * drm_mm_node_allocated - checks whether a node is allocated 90e18c0412SDaniel Vetter * @node: drm_mm_node to check 91e18c0412SDaniel Vetter * 92e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 93e18c0412SDaniel Vetter * internals. 94e18c0412SDaniel Vetter * 95e18c0412SDaniel Vetter * Returns: 96e18c0412SDaniel Vetter * True if the @node is allocated. 97e18c0412SDaniel Vetter */ 98b0b7af18SDaniel Vetter static inline bool drm_mm_node_allocated(struct drm_mm_node *node) 99b0b7af18SDaniel Vetter { 100b0b7af18SDaniel Vetter return node->allocated; 101b0b7af18SDaniel Vetter } 102b0b7af18SDaniel Vetter 103e18c0412SDaniel Vetter /** 104e18c0412SDaniel Vetter * drm_mm_initialized - checks whether an allocator is initialized 105e18c0412SDaniel Vetter * @mm: drm_mm to check 106e18c0412SDaniel Vetter * 107e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 108e18c0412SDaniel Vetter * internals. 109e18c0412SDaniel Vetter * 110e18c0412SDaniel Vetter * Returns: 111e18c0412SDaniel Vetter * True if the @mm is initialized. 112e18c0412SDaniel Vetter */ 11331a5b8ceSDaniel Vetter static inline bool drm_mm_initialized(struct drm_mm *mm) 11431a5b8ceSDaniel Vetter { 115ea7b1dd4SDaniel Vetter return mm->hole_stack.next; 11631a5b8ceSDaniel Vetter } 1179e8944abSChris Wilson 1189e8944abSChris Wilson static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1199e8944abSChris Wilson { 1209e8944abSChris Wilson return hole_node->start + hole_node->size; 1219e8944abSChris Wilson } 1229e8944abSChris Wilson 123e18c0412SDaniel Vetter /** 124e18c0412SDaniel Vetter * drm_mm_hole_node_start - computes the start of the hole following @node 125e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 126e18c0412SDaniel Vetter * 127e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 128e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 129e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 130e18c0412SDaniel Vetter * 131e18c0412SDaniel Vetter * Returns: 132e18c0412SDaniel Vetter * Start of the subsequent hole. 133e18c0412SDaniel Vetter */ 1349e8944abSChris Wilson static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1359e8944abSChris Wilson { 1369e8944abSChris Wilson BUG_ON(!hole_node->hole_follows); 1379e8944abSChris Wilson return __drm_mm_hole_node_start(hole_node); 1389e8944abSChris Wilson } 1399e8944abSChris Wilson 1409e8944abSChris Wilson static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1419e8944abSChris Wilson { 1429e8944abSChris Wilson return list_entry(hole_node->node_list.next, 1439e8944abSChris Wilson struct drm_mm_node, node_list)->start; 1449e8944abSChris Wilson } 1459e8944abSChris Wilson 146e18c0412SDaniel Vetter /** 147e18c0412SDaniel Vetter * drm_mm_hole_node_end - computes the end of the hole following @node 148e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 149e18c0412SDaniel Vetter * 150e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 151e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 152e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 153e18c0412SDaniel Vetter * 154e18c0412SDaniel Vetter * Returns: 155e18c0412SDaniel Vetter * End of the subsequent hole. 156e18c0412SDaniel Vetter */ 1579e8944abSChris Wilson static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1589e8944abSChris Wilson { 1599e8944abSChris Wilson return __drm_mm_hole_node_end(hole_node); 1609e8944abSChris Wilson } 1619e8944abSChris Wilson 162e18c0412SDaniel Vetter /** 163e18c0412SDaniel Vetter * drm_mm_for_each_node - iterator to walk over all allocated nodes 164e18c0412SDaniel Vetter * @entry: drm_mm_node structure to assign to in each iteration step 165e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 166e18c0412SDaniel Vetter * 167e18c0412SDaniel Vetter * This iterator walks over all nodes in the range allocator. It is implemented 168e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. 169e18c0412SDaniel Vetter */ 170ea7b1dd4SDaniel Vetter #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \ 171ea7b1dd4SDaniel Vetter &(mm)->head_node.node_list, \ 1722bbd4492SDaniel Vetter node_list) 1739e8944abSChris Wilson 174e18c0412SDaniel Vetter /** 175e18c0412SDaniel Vetter * drm_mm_for_each_hole - iterator to walk over all holes 176e18c0412SDaniel Vetter * @entry: drm_mm_node used internally to track progress 177e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 178e18c0412SDaniel Vetter * @hole_start: ulong variable to assign the hole start to on each iteration 179e18c0412SDaniel Vetter * @hole_end: ulong variable to assign the hole end to on each iteration 180e18c0412SDaniel Vetter * 181e18c0412SDaniel Vetter * This iterator walks over all holes in the range allocator. It is implemented 182e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. @entry is used 183e18c0412SDaniel Vetter * internally and will not reflect a real drm_mm_node for the very first hole. 184e18c0412SDaniel Vetter * Hence users of this iterator may not access it. 185e18c0412SDaniel Vetter * 186e18c0412SDaniel Vetter * Implementation Note: 187e18c0412SDaniel Vetter * We need to inline list_for_each_entry in order to be able to set hole_start 188e18c0412SDaniel Vetter * and hole_end on each iteration while keeping the macro sane. 1899e8944abSChris Wilson */ 1909e8944abSChris Wilson #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 1919e8944abSChris Wilson for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 1929e8944abSChris Wilson &entry->hole_stack != &(mm)->hole_stack ? \ 1939e8944abSChris Wilson hole_start = drm_mm_hole_node_start(entry), \ 1949e8944abSChris Wilson hole_end = drm_mm_hole_node_end(entry), \ 1959e8944abSChris Wilson 1 : 0; \ 1969e8944abSChris Wilson entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack)) 1979e8944abSChris Wilson 198249d6048SJerome Glisse /* 199249d6048SJerome Glisse * Basic range manager support (drm_mm.c) 200249d6048SJerome Glisse */ 201e18c0412SDaniel Vetter int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 202b8103450SChris Wilson 203e18c0412SDaniel Vetter int drm_mm_insert_node_generic(struct drm_mm *mm, 204b8103450SChris Wilson struct drm_mm_node *node, 205b8103450SChris Wilson unsigned long size, 206b8103450SChris Wilson unsigned alignment, 20731e5d7c6SDavid Herrmann unsigned long color, 20831e5d7c6SDavid Herrmann enum drm_mm_search_flags flags); 209e18c0412SDaniel Vetter /** 210e18c0412SDaniel Vetter * drm_mm_insert_node - search for space and insert @node 211e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 212e18c0412SDaniel Vetter * @node: preallocate node to insert 213e18c0412SDaniel Vetter * @size: size of the allocation 214e18c0412SDaniel Vetter * @alignment: alignment of the allocation 215e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 216e18c0412SDaniel Vetter * 217e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_generic() with @color set 218e18c0412SDaniel Vetter * to 0. 219e18c0412SDaniel Vetter * 220e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 221e18c0412SDaniel Vetter * 222e18c0412SDaniel Vetter * Returns: 223e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 224e18c0412SDaniel Vetter */ 22531e5d7c6SDavid Herrmann static inline int drm_mm_insert_node(struct drm_mm *mm, 22631e5d7c6SDavid Herrmann struct drm_mm_node *node, 22731e5d7c6SDavid Herrmann unsigned long size, 22831e5d7c6SDavid Herrmann unsigned alignment, 22931e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 23031e5d7c6SDavid Herrmann { 23131e5d7c6SDavid Herrmann return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags); 23231e5d7c6SDavid Herrmann } 23331e5d7c6SDavid Herrmann 234e18c0412SDaniel Vetter int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 235b8103450SChris Wilson struct drm_mm_node *node, 236b8103450SChris Wilson unsigned long size, 237b8103450SChris Wilson unsigned alignment, 238b8103450SChris Wilson unsigned long color, 239b8103450SChris Wilson unsigned long start, 24031e5d7c6SDavid Herrmann unsigned long end, 24131e5d7c6SDavid Herrmann enum drm_mm_search_flags flags); 242e18c0412SDaniel Vetter /** 243e18c0412SDaniel Vetter * drm_mm_insert_node_in_range - ranged search for space and insert @node 244e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 245e18c0412SDaniel Vetter * @node: preallocate node to insert 246e18c0412SDaniel Vetter * @size: size of the allocation 247e18c0412SDaniel Vetter * @alignment: alignment of the allocation 248e18c0412SDaniel Vetter * @start: start of the allowed range for this node 249e18c0412SDaniel Vetter * @end: end of the allowed range for this node 250e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 251e18c0412SDaniel Vetter * 252e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_in_range_generic() with 253e18c0412SDaniel Vetter * @color set to 0. 254e18c0412SDaniel Vetter * 255e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 256e18c0412SDaniel Vetter * 257e18c0412SDaniel Vetter * Returns: 258e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 259e18c0412SDaniel Vetter */ 26031e5d7c6SDavid Herrmann static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 26131e5d7c6SDavid Herrmann struct drm_mm_node *node, 26231e5d7c6SDavid Herrmann unsigned long size, 26331e5d7c6SDavid Herrmann unsigned alignment, 26431e5d7c6SDavid Herrmann unsigned long start, 26531e5d7c6SDavid Herrmann unsigned long end, 26631e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 26731e5d7c6SDavid Herrmann { 26831e5d7c6SDavid Herrmann return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 26931e5d7c6SDavid Herrmann 0, start, end, flags); 27031e5d7c6SDavid Herrmann } 27131e5d7c6SDavid Herrmann 272e18c0412SDaniel Vetter void drm_mm_remove_node(struct drm_mm_node *node); 273e18c0412SDaniel Vetter void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 274e18c0412SDaniel Vetter void drm_mm_init(struct drm_mm *mm, 2756b9d89b4SChris Wilson unsigned long start, 276249d6048SJerome Glisse unsigned long size); 277e18c0412SDaniel Vetter void drm_mm_takedown(struct drm_mm *mm); 278e18c0412SDaniel Vetter bool drm_mm_clean(struct drm_mm *mm); 279249d6048SJerome Glisse 2806b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 2816b9d89b4SChris Wilson unsigned long size, 282d935cc61SDaniel Vetter unsigned alignment, 2836b9d89b4SChris Wilson unsigned long color); 2846b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 2856b9d89b4SChris Wilson unsigned long size, 2866b9d89b4SChris Wilson unsigned alignment, 2876b9d89b4SChris Wilson unsigned long color, 288d935cc61SDaniel Vetter unsigned long start, 289d935cc61SDaniel Vetter unsigned long end); 290e18c0412SDaniel Vetter bool drm_mm_scan_add_block(struct drm_mm_node *node); 291e18c0412SDaniel Vetter bool drm_mm_scan_remove_block(struct drm_mm_node *node); 292709ea971SDaniel Vetter 293e18c0412SDaniel Vetter void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 294fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 295fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 296fa8a1238SDave Airlie #endif 297fa8a1238SDave Airlie 298249d6048SJerome Glisse #endif 299