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; 71249d6048SJerome Glisse unsigned long start; 72249d6048SJerome Glisse unsigned long 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; 85709ea971SDaniel Vetter unsigned long scan_size; 86709ea971SDaniel Vetter unsigned long scan_hit_start; 87901593f2SChris Wilson unsigned long scan_hit_end; 88709ea971SDaniel Vetter unsigned scanned_blocks; 89d935cc61SDaniel Vetter unsigned long scan_start; 90d935cc61SDaniel Vetter unsigned long 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, 946b9d89b4SChris Wilson unsigned long *start, unsigned long *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 1279e8944abSChris Wilson static inline unsigned long __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 */ 1439e8944abSChris Wilson static inline unsigned long 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 1499e8944abSChris Wilson static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1509e8944abSChris Wilson { 1519e8944abSChris Wilson return list_entry(hole_node->node_list.next, 1529e8944abSChris Wilson struct drm_mm_node, node_list)->start; 1539e8944abSChris Wilson } 1549e8944abSChris Wilson 155e18c0412SDaniel Vetter /** 156e18c0412SDaniel Vetter * drm_mm_hole_node_end - computes the end of the hole following @node 157e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 158e18c0412SDaniel Vetter * 159e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 160e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 161e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 162e18c0412SDaniel Vetter * 163e18c0412SDaniel Vetter * Returns: 164e18c0412SDaniel Vetter * End of the subsequent hole. 165e18c0412SDaniel Vetter */ 1669e8944abSChris Wilson static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1679e8944abSChris Wilson { 1689e8944abSChris Wilson return __drm_mm_hole_node_end(hole_node); 1699e8944abSChris Wilson } 1709e8944abSChris Wilson 171e18c0412SDaniel Vetter /** 172e18c0412SDaniel Vetter * drm_mm_for_each_node - iterator to walk over all allocated nodes 173e18c0412SDaniel Vetter * @entry: drm_mm_node structure to assign to in each iteration step 174e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 175e18c0412SDaniel Vetter * 176e18c0412SDaniel Vetter * This iterator walks over all nodes in the range allocator. It is implemented 177e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. 178e18c0412SDaniel Vetter */ 179ea7b1dd4SDaniel Vetter #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \ 180ea7b1dd4SDaniel Vetter &(mm)->head_node.node_list, \ 1812bbd4492SDaniel Vetter node_list) 1829e8944abSChris Wilson 183e18c0412SDaniel Vetter /** 184e18c0412SDaniel Vetter * drm_mm_for_each_hole - iterator to walk over all holes 185e18c0412SDaniel Vetter * @entry: drm_mm_node used internally to track progress 186e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 187e18c0412SDaniel Vetter * @hole_start: ulong variable to assign the hole start to on each iteration 188e18c0412SDaniel Vetter * @hole_end: ulong variable to assign the hole end to on each iteration 189e18c0412SDaniel Vetter * 190e18c0412SDaniel Vetter * This iterator walks over all holes in the range allocator. It is implemented 191e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. @entry is used 192e18c0412SDaniel Vetter * internally and will not reflect a real drm_mm_node for the very first hole. 193e18c0412SDaniel Vetter * Hence users of this iterator may not access it. 194e18c0412SDaniel Vetter * 195e18c0412SDaniel Vetter * Implementation Note: 196e18c0412SDaniel Vetter * We need to inline list_for_each_entry in order to be able to set hole_start 197e18c0412SDaniel Vetter * and hole_end on each iteration while keeping the macro sane. 19862347f9eSLauri Kasanen * 19962347f9eSLauri Kasanen * The __drm_mm_for_each_hole version is similar, but with added support for 20062347f9eSLauri Kasanen * going backwards. 2019e8944abSChris Wilson */ 2029e8944abSChris Wilson #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 2039e8944abSChris Wilson for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 2049e8944abSChris Wilson &entry->hole_stack != &(mm)->hole_stack ? \ 2059e8944abSChris Wilson hole_start = drm_mm_hole_node_start(entry), \ 2069e8944abSChris Wilson hole_end = drm_mm_hole_node_end(entry), \ 2079e8944abSChris Wilson 1 : 0; \ 2089e8944abSChris Wilson entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack)) 2099e8944abSChris Wilson 21062347f9eSLauri Kasanen #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ 21162347f9eSLauri Kasanen for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 21262347f9eSLauri Kasanen &entry->hole_stack != &(mm)->hole_stack ? \ 21362347f9eSLauri Kasanen hole_start = drm_mm_hole_node_start(entry), \ 21462347f9eSLauri Kasanen hole_end = drm_mm_hole_node_end(entry), \ 21562347f9eSLauri Kasanen 1 : 0; \ 21662347f9eSLauri Kasanen entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) 21762347f9eSLauri Kasanen 218249d6048SJerome Glisse /* 219249d6048SJerome Glisse * Basic range manager support (drm_mm.c) 220249d6048SJerome Glisse */ 221e18c0412SDaniel Vetter int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 222b8103450SChris Wilson 223e18c0412SDaniel Vetter int drm_mm_insert_node_generic(struct drm_mm *mm, 224b8103450SChris Wilson struct drm_mm_node *node, 225b8103450SChris Wilson unsigned long size, 226b8103450SChris Wilson unsigned alignment, 22731e5d7c6SDavid Herrmann unsigned long color, 22862347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 22962347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 230e18c0412SDaniel Vetter /** 231e18c0412SDaniel Vetter * drm_mm_insert_node - search for space and insert @node 232e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 233e18c0412SDaniel Vetter * @node: preallocate node to insert 234e18c0412SDaniel Vetter * @size: size of the allocation 235e18c0412SDaniel Vetter * @alignment: alignment of the allocation 236e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 237e18c0412SDaniel Vetter * 238e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_generic() with @color set 239e18c0412SDaniel Vetter * to 0. 240e18c0412SDaniel Vetter * 241e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 242e18c0412SDaniel Vetter * 243e18c0412SDaniel Vetter * Returns: 244e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 245e18c0412SDaniel Vetter */ 24631e5d7c6SDavid Herrmann static inline int drm_mm_insert_node(struct drm_mm *mm, 24731e5d7c6SDavid Herrmann struct drm_mm_node *node, 24831e5d7c6SDavid Herrmann unsigned long size, 24931e5d7c6SDavid Herrmann unsigned alignment, 25031e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 25131e5d7c6SDavid Herrmann { 25262347f9eSLauri Kasanen return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, 25362347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 25431e5d7c6SDavid Herrmann } 25531e5d7c6SDavid Herrmann 256e18c0412SDaniel Vetter int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 257b8103450SChris Wilson struct drm_mm_node *node, 258b8103450SChris Wilson unsigned long size, 259b8103450SChris Wilson unsigned alignment, 260b8103450SChris Wilson unsigned long color, 261b8103450SChris Wilson unsigned long start, 26231e5d7c6SDavid Herrmann unsigned long end, 26362347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 26462347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 265e18c0412SDaniel Vetter /** 266e18c0412SDaniel Vetter * drm_mm_insert_node_in_range - ranged search for space and insert @node 267e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 268e18c0412SDaniel Vetter * @node: preallocate node to insert 269e18c0412SDaniel Vetter * @size: size of the allocation 270e18c0412SDaniel Vetter * @alignment: alignment of the allocation 271e18c0412SDaniel Vetter * @start: start of the allowed range for this node 272e18c0412SDaniel Vetter * @end: end of the allowed range for this node 273e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 274e18c0412SDaniel Vetter * 275e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_in_range_generic() with 276e18c0412SDaniel Vetter * @color set to 0. 277e18c0412SDaniel Vetter * 278e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 279e18c0412SDaniel Vetter * 280e18c0412SDaniel Vetter * Returns: 281e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 282e18c0412SDaniel Vetter */ 28331e5d7c6SDavid Herrmann static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 28431e5d7c6SDavid Herrmann struct drm_mm_node *node, 28531e5d7c6SDavid Herrmann unsigned long size, 28631e5d7c6SDavid Herrmann unsigned alignment, 28731e5d7c6SDavid Herrmann unsigned long start, 28831e5d7c6SDavid Herrmann unsigned long end, 28931e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 29031e5d7c6SDavid Herrmann { 29131e5d7c6SDavid Herrmann return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 29262347f9eSLauri Kasanen 0, start, end, flags, 29362347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 29431e5d7c6SDavid Herrmann } 29531e5d7c6SDavid Herrmann 296e18c0412SDaniel Vetter void drm_mm_remove_node(struct drm_mm_node *node); 297e18c0412SDaniel Vetter void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 298e18c0412SDaniel Vetter void drm_mm_init(struct drm_mm *mm, 2996b9d89b4SChris Wilson unsigned long start, 300249d6048SJerome Glisse unsigned long size); 301e18c0412SDaniel Vetter void drm_mm_takedown(struct drm_mm *mm); 302e18c0412SDaniel Vetter bool drm_mm_clean(struct drm_mm *mm); 303249d6048SJerome Glisse 3046b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 3056b9d89b4SChris Wilson unsigned long size, 306d935cc61SDaniel Vetter unsigned alignment, 3076b9d89b4SChris Wilson unsigned long color); 3086b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 3096b9d89b4SChris Wilson unsigned long size, 3106b9d89b4SChris Wilson unsigned alignment, 3116b9d89b4SChris Wilson unsigned long color, 312d935cc61SDaniel Vetter unsigned long start, 313d935cc61SDaniel Vetter unsigned long end); 314e18c0412SDaniel Vetter bool drm_mm_scan_add_block(struct drm_mm_node *node); 315e18c0412SDaniel Vetter bool drm_mm_scan_remove_block(struct drm_mm_node *node); 316709ea971SDaniel Vetter 317e18c0412SDaniel Vetter void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 318fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 319fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 320fa8a1238SDave Airlie #endif 321fa8a1238SDave Airlie 322249d6048SJerome Glisse #endif 323