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, 5062347f9eSLauri Kasanen DRM_MM_SEARCH_BELOW = 1 << 1, 5131e5d7c6SDavid Herrmann }; 5231e5d7c6SDavid Herrmann 5362347f9eSLauri Kasanen enum drm_mm_allocator_flags { 5462347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT = 0, 5562347f9eSLauri Kasanen DRM_MM_CREATE_TOP = 1 << 0, 5662347f9eSLauri Kasanen }; 5762347f9eSLauri Kasanen 5862347f9eSLauri Kasanen #define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT 5962347f9eSLauri Kasanen #define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP 6062347f9eSLauri Kasanen 61249d6048SJerome Glisse struct drm_mm_node { 62d1024ce9SDaniel Vetter struct list_head node_list; 63ea7b1dd4SDaniel Vetter struct list_head hole_stack; 64ea7b1dd4SDaniel Vetter unsigned hole_follows : 1; 65709ea971SDaniel Vetter unsigned scanned_block : 1; 66709ea971SDaniel Vetter unsigned scanned_prev_free : 1; 67709ea971SDaniel Vetter unsigned scanned_next_free : 1; 68ea7b1dd4SDaniel Vetter unsigned scanned_preceeds_hole : 1; 69b0b7af18SDaniel Vetter unsigned allocated : 1; 706b9d89b4SChris Wilson unsigned long color; 71440fd528SThierry Reding u64 start; 72440fd528SThierry Reding u64 size; 73249d6048SJerome Glisse struct drm_mm *mm; 74249d6048SJerome Glisse }; 75249d6048SJerome Glisse 76249d6048SJerome Glisse struct drm_mm { 7725985edcSLucas De Marchi /* List of all memory nodes that immediately precede a free hole. */ 78ea7b1dd4SDaniel Vetter struct list_head hole_stack; 79ea7b1dd4SDaniel Vetter /* head_node.node_list is the list of all memory nodes, ordered 80ea7b1dd4SDaniel Vetter * according to the (increasing) start address of the memory node. */ 81ea7b1dd4SDaniel Vetter struct drm_mm_node head_node; 82d935cc61SDaniel Vetter unsigned int scan_check_range : 1; 83709ea971SDaniel Vetter unsigned scan_alignment; 846b9d89b4SChris Wilson unsigned long scan_color; 85440fd528SThierry Reding u64 scan_size; 86440fd528SThierry Reding u64 scan_hit_start; 87440fd528SThierry Reding u64 scan_hit_end; 88709ea971SDaniel Vetter unsigned scanned_blocks; 89440fd528SThierry Reding u64 scan_start; 90440fd528SThierry Reding u64 scan_end; 91ae0cec28SDaniel Vetter struct drm_mm_node *prev_scanned_node; 926b9d89b4SChris Wilson 936b9d89b4SChris Wilson void (*color_adjust)(struct drm_mm_node *node, unsigned long color, 94440fd528SThierry Reding u64 *start, u64 *end); 95249d6048SJerome Glisse }; 96249d6048SJerome Glisse 97e18c0412SDaniel Vetter /** 98e18c0412SDaniel Vetter * drm_mm_node_allocated - checks whether a node is allocated 99e18c0412SDaniel Vetter * @node: drm_mm_node to check 100e18c0412SDaniel Vetter * 101e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 102e18c0412SDaniel Vetter * internals. 103e18c0412SDaniel Vetter * 104e18c0412SDaniel Vetter * Returns: 105e18c0412SDaniel Vetter * True if the @node is allocated. 106e18c0412SDaniel Vetter */ 107b0b7af18SDaniel Vetter static inline bool drm_mm_node_allocated(struct drm_mm_node *node) 108b0b7af18SDaniel Vetter { 109b0b7af18SDaniel Vetter return node->allocated; 110b0b7af18SDaniel Vetter } 111b0b7af18SDaniel Vetter 112e18c0412SDaniel Vetter /** 113e18c0412SDaniel Vetter * drm_mm_initialized - checks whether an allocator is initialized 114e18c0412SDaniel Vetter * @mm: drm_mm to check 115e18c0412SDaniel Vetter * 116e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 117e18c0412SDaniel Vetter * internals. 118e18c0412SDaniel Vetter * 119e18c0412SDaniel Vetter * Returns: 120e18c0412SDaniel Vetter * True if the @mm is initialized. 121e18c0412SDaniel Vetter */ 12231a5b8ceSDaniel Vetter static inline bool drm_mm_initialized(struct drm_mm *mm) 12331a5b8ceSDaniel Vetter { 124ea7b1dd4SDaniel Vetter return mm->hole_stack.next; 12531a5b8ceSDaniel Vetter } 1269e8944abSChris Wilson 127440fd528SThierry Reding static inline u64 __drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1289e8944abSChris Wilson { 1299e8944abSChris Wilson return hole_node->start + hole_node->size; 1309e8944abSChris Wilson } 1319e8944abSChris Wilson 132e18c0412SDaniel Vetter /** 133e18c0412SDaniel Vetter * drm_mm_hole_node_start - computes the start of the hole following @node 134e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 135e18c0412SDaniel Vetter * 136e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 137e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 138e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 139e18c0412SDaniel Vetter * 140e18c0412SDaniel Vetter * Returns: 141e18c0412SDaniel Vetter * Start of the subsequent hole. 142e18c0412SDaniel Vetter */ 143440fd528SThierry Reding static inline u64 drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1449e8944abSChris Wilson { 1459e8944abSChris Wilson BUG_ON(!hole_node->hole_follows); 1469e8944abSChris Wilson return __drm_mm_hole_node_start(hole_node); 1479e8944abSChris Wilson } 1489e8944abSChris Wilson 149440fd528SThierry Reding static inline u64 __drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1509e8944abSChris Wilson { 15187069f44SGeliang Tang return list_next_entry(hole_node, node_list)->start; 1529e8944abSChris Wilson } 1539e8944abSChris Wilson 154e18c0412SDaniel Vetter /** 155e18c0412SDaniel Vetter * drm_mm_hole_node_end - computes the end of the hole following @node 156e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 157e18c0412SDaniel Vetter * 158e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 159e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 160e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 161e18c0412SDaniel Vetter * 162e18c0412SDaniel Vetter * Returns: 163e18c0412SDaniel Vetter * End of the subsequent hole. 164e18c0412SDaniel Vetter */ 165440fd528SThierry Reding static inline u64 drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1669e8944abSChris Wilson { 1679e8944abSChris Wilson return __drm_mm_hole_node_end(hole_node); 1689e8944abSChris Wilson } 1699e8944abSChris Wilson 170e18c0412SDaniel Vetter /** 171e18c0412SDaniel Vetter * drm_mm_for_each_node - iterator to walk over all allocated nodes 172e18c0412SDaniel Vetter * @entry: drm_mm_node structure to assign to in each iteration step 173e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 174e18c0412SDaniel Vetter * 175e18c0412SDaniel Vetter * This iterator walks over all nodes in the range allocator. It is implemented 176e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. 177e18c0412SDaniel Vetter */ 178ea7b1dd4SDaniel Vetter #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \ 179ea7b1dd4SDaniel Vetter &(mm)->head_node.node_list, \ 1802bbd4492SDaniel Vetter node_list) 1819e8944abSChris Wilson 18218b40c58SGeliang Tang #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ 18318b40c58SGeliang Tang for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 18418b40c58SGeliang Tang &entry->hole_stack != &(mm)->hole_stack ? \ 18518b40c58SGeliang Tang hole_start = drm_mm_hole_node_start(entry), \ 18618b40c58SGeliang Tang hole_end = drm_mm_hole_node_end(entry), \ 18718b40c58SGeliang Tang 1 : 0; \ 18818b40c58SGeliang Tang entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) 18918b40c58SGeliang Tang 190e18c0412SDaniel Vetter /** 191e18c0412SDaniel Vetter * drm_mm_for_each_hole - iterator to walk over all holes 192e18c0412SDaniel Vetter * @entry: drm_mm_node used internally to track progress 193e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 194e18c0412SDaniel Vetter * @hole_start: ulong variable to assign the hole start to on each iteration 195e18c0412SDaniel Vetter * @hole_end: ulong variable to assign the hole end to on each iteration 196e18c0412SDaniel Vetter * 197e18c0412SDaniel Vetter * This iterator walks over all holes in the range allocator. It is implemented 198e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. @entry is used 199e18c0412SDaniel Vetter * internally and will not reflect a real drm_mm_node for the very first hole. 200e18c0412SDaniel Vetter * Hence users of this iterator may not access it. 201e18c0412SDaniel Vetter * 202e18c0412SDaniel Vetter * Implementation Note: 203e18c0412SDaniel Vetter * We need to inline list_for_each_entry in order to be able to set hole_start 204e18c0412SDaniel Vetter * and hole_end on each iteration while keeping the macro sane. 20562347f9eSLauri Kasanen * 20662347f9eSLauri Kasanen * The __drm_mm_for_each_hole version is similar, but with added support for 20762347f9eSLauri Kasanen * going backwards. 2089e8944abSChris Wilson */ 2099e8944abSChris Wilson #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 21018b40c58SGeliang Tang __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) 21162347f9eSLauri Kasanen 212249d6048SJerome Glisse /* 213249d6048SJerome Glisse * Basic range manager support (drm_mm.c) 214249d6048SJerome Glisse */ 215e18c0412SDaniel Vetter int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 216b8103450SChris Wilson 217e18c0412SDaniel Vetter int drm_mm_insert_node_generic(struct drm_mm *mm, 218b8103450SChris Wilson struct drm_mm_node *node, 219440fd528SThierry Reding u64 size, 220b8103450SChris Wilson unsigned alignment, 22131e5d7c6SDavid Herrmann unsigned long color, 22262347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 22362347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 224e18c0412SDaniel Vetter /** 225e18c0412SDaniel Vetter * drm_mm_insert_node - search for space and insert @node 226e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 227e18c0412SDaniel Vetter * @node: preallocate node to insert 228e18c0412SDaniel Vetter * @size: size of the allocation 229e18c0412SDaniel Vetter * @alignment: alignment of the allocation 230e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 231e18c0412SDaniel Vetter * 232e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_generic() with @color set 233e18c0412SDaniel Vetter * to 0. 234e18c0412SDaniel Vetter * 235e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 236e18c0412SDaniel Vetter * 237e18c0412SDaniel Vetter * Returns: 238e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 239e18c0412SDaniel Vetter */ 24031e5d7c6SDavid Herrmann static inline int drm_mm_insert_node(struct drm_mm *mm, 24131e5d7c6SDavid Herrmann struct drm_mm_node *node, 242440fd528SThierry Reding u64 size, 24331e5d7c6SDavid Herrmann unsigned alignment, 24431e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 24531e5d7c6SDavid Herrmann { 24662347f9eSLauri Kasanen return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, 24762347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 24831e5d7c6SDavid Herrmann } 24931e5d7c6SDavid Herrmann 250e18c0412SDaniel Vetter int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 251b8103450SChris Wilson struct drm_mm_node *node, 252440fd528SThierry Reding u64 size, 253b8103450SChris Wilson unsigned alignment, 254b8103450SChris Wilson unsigned long color, 255440fd528SThierry Reding u64 start, 256440fd528SThierry Reding u64 end, 25762347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 25862347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 259e18c0412SDaniel Vetter /** 260e18c0412SDaniel Vetter * drm_mm_insert_node_in_range - ranged search for space and insert @node 261e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 262e18c0412SDaniel Vetter * @node: preallocate node to insert 263e18c0412SDaniel Vetter * @size: size of the allocation 264e18c0412SDaniel Vetter * @alignment: alignment of the allocation 265e18c0412SDaniel Vetter * @start: start of the allowed range for this node 266e18c0412SDaniel Vetter * @end: end of the allowed range for this node 267e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 268e18c0412SDaniel Vetter * 269e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_in_range_generic() with 270e18c0412SDaniel Vetter * @color set to 0. 271e18c0412SDaniel Vetter * 272e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 273e18c0412SDaniel Vetter * 274e18c0412SDaniel Vetter * Returns: 275e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 276e18c0412SDaniel Vetter */ 27731e5d7c6SDavid Herrmann static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 27831e5d7c6SDavid Herrmann struct drm_mm_node *node, 279440fd528SThierry Reding u64 size, 28031e5d7c6SDavid Herrmann unsigned alignment, 281440fd528SThierry Reding u64 start, 282440fd528SThierry Reding u64 end, 28331e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 28431e5d7c6SDavid Herrmann { 28531e5d7c6SDavid Herrmann return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 28662347f9eSLauri Kasanen 0, start, end, flags, 28762347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 28831e5d7c6SDavid Herrmann } 28931e5d7c6SDavid Herrmann 290e18c0412SDaniel Vetter void drm_mm_remove_node(struct drm_mm_node *node); 291e18c0412SDaniel Vetter void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 292e18c0412SDaniel Vetter void drm_mm_init(struct drm_mm *mm, 293440fd528SThierry Reding u64 start, 294440fd528SThierry Reding u64 size); 295e18c0412SDaniel Vetter void drm_mm_takedown(struct drm_mm *mm); 296e18c0412SDaniel Vetter bool drm_mm_clean(struct drm_mm *mm); 297249d6048SJerome Glisse 2986b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 299440fd528SThierry Reding u64 size, 300d935cc61SDaniel Vetter unsigned alignment, 3016b9d89b4SChris Wilson unsigned long color); 3026b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 303440fd528SThierry Reding u64 size, 3046b9d89b4SChris Wilson unsigned alignment, 3056b9d89b4SChris Wilson unsigned long color, 306440fd528SThierry Reding u64 start, 307440fd528SThierry Reding u64 end); 308e18c0412SDaniel Vetter bool drm_mm_scan_add_block(struct drm_mm_node *node); 309e18c0412SDaniel Vetter bool drm_mm_scan_remove_block(struct drm_mm_node *node); 310709ea971SDaniel Vetter 311e18c0412SDaniel Vetter void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 312fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 313fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 314fa8a1238SDave Airlie #endif 315fa8a1238SDave Airlie 316249d6048SJerome Glisse #endif 317