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> 40202b52b7SChris Wilson #include <linux/rbtree.h> 4186e81f0eSDavid Herrmann #include <linux/kernel.h> 42249d6048SJerome Glisse #include <linux/list.h> 4386e81f0eSDavid Herrmann #include <linux/spinlock.h> 44f1938cd6SDave Airlie #ifdef CONFIG_DEBUG_FS 45f1938cd6SDave Airlie #include <linux/seq_file.h> 46f1938cd6SDave Airlie #endif 475705670dSChris Wilson #ifdef CONFIG_DRM_DEBUG_MM 485705670dSChris Wilson #include <linux/stackdepot.h> 495705670dSChris Wilson #endif 50249d6048SJerome Glisse 5131e5d7c6SDavid Herrmann enum drm_mm_search_flags { 5231e5d7c6SDavid Herrmann DRM_MM_SEARCH_DEFAULT = 0, 5331e5d7c6SDavid Herrmann DRM_MM_SEARCH_BEST = 1 << 0, 5462347f9eSLauri Kasanen DRM_MM_SEARCH_BELOW = 1 << 1, 5531e5d7c6SDavid Herrmann }; 5631e5d7c6SDavid Herrmann 5762347f9eSLauri Kasanen enum drm_mm_allocator_flags { 5862347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT = 0, 5962347f9eSLauri Kasanen DRM_MM_CREATE_TOP = 1 << 0, 6062347f9eSLauri Kasanen }; 6162347f9eSLauri Kasanen 6262347f9eSLauri Kasanen #define DRM_MM_BOTTOMUP DRM_MM_SEARCH_DEFAULT, DRM_MM_CREATE_DEFAULT 6362347f9eSLauri Kasanen #define DRM_MM_TOPDOWN DRM_MM_SEARCH_BELOW, DRM_MM_CREATE_TOP 6462347f9eSLauri Kasanen 65249d6048SJerome Glisse struct drm_mm_node { 66d1024ce9SDaniel Vetter struct list_head node_list; 67ea7b1dd4SDaniel Vetter struct list_head hole_stack; 68202b52b7SChris Wilson struct rb_node rb; 69ea7b1dd4SDaniel Vetter unsigned hole_follows : 1; 70709ea971SDaniel Vetter unsigned scanned_block : 1; 71709ea971SDaniel Vetter unsigned scanned_prev_free : 1; 72709ea971SDaniel Vetter unsigned scanned_next_free : 1; 73ea7b1dd4SDaniel Vetter unsigned scanned_preceeds_hole : 1; 74b0b7af18SDaniel Vetter unsigned allocated : 1; 756b9d89b4SChris Wilson unsigned long color; 76440fd528SThierry Reding u64 start; 77440fd528SThierry Reding u64 size; 78202b52b7SChris Wilson u64 __subtree_last; 79249d6048SJerome Glisse struct drm_mm *mm; 805705670dSChris Wilson #ifdef CONFIG_DRM_DEBUG_MM 815705670dSChris Wilson depot_stack_handle_t stack; 825705670dSChris Wilson #endif 83249d6048SJerome Glisse }; 84249d6048SJerome Glisse 85249d6048SJerome Glisse struct drm_mm { 8625985edcSLucas De Marchi /* List of all memory nodes that immediately precede a free hole. */ 87ea7b1dd4SDaniel Vetter struct list_head hole_stack; 88ea7b1dd4SDaniel Vetter /* head_node.node_list is the list of all memory nodes, ordered 89ea7b1dd4SDaniel Vetter * according to the (increasing) start address of the memory node. */ 90ea7b1dd4SDaniel Vetter struct drm_mm_node head_node; 91202b52b7SChris Wilson /* Keep an interval_tree for fast lookup of drm_mm_nodes by address. */ 92202b52b7SChris Wilson struct rb_root interval_tree; 93202b52b7SChris Wilson 94d935cc61SDaniel Vetter unsigned int scan_check_range : 1; 95709ea971SDaniel Vetter unsigned scan_alignment; 966b9d89b4SChris Wilson unsigned long scan_color; 97440fd528SThierry Reding u64 scan_size; 98440fd528SThierry Reding u64 scan_hit_start; 99440fd528SThierry Reding u64 scan_hit_end; 100709ea971SDaniel Vetter unsigned scanned_blocks; 101440fd528SThierry Reding u64 scan_start; 102440fd528SThierry Reding u64 scan_end; 103ae0cec28SDaniel Vetter struct drm_mm_node *prev_scanned_node; 1046b9d89b4SChris Wilson 1056b9d89b4SChris Wilson void (*color_adjust)(struct drm_mm_node *node, unsigned long color, 106440fd528SThierry Reding u64 *start, u64 *end); 107249d6048SJerome Glisse }; 108249d6048SJerome Glisse 109e18c0412SDaniel Vetter /** 110e18c0412SDaniel Vetter * drm_mm_node_allocated - checks whether a node is allocated 111e18c0412SDaniel Vetter * @node: drm_mm_node to check 112e18c0412SDaniel Vetter * 113e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 114e18c0412SDaniel Vetter * internals. 115e18c0412SDaniel Vetter * 116e18c0412SDaniel Vetter * Returns: 117e18c0412SDaniel Vetter * True if the @node is allocated. 118e18c0412SDaniel Vetter */ 119b0b7af18SDaniel Vetter static inline bool drm_mm_node_allocated(struct drm_mm_node *node) 120b0b7af18SDaniel Vetter { 121b0b7af18SDaniel Vetter return node->allocated; 122b0b7af18SDaniel Vetter } 123b0b7af18SDaniel Vetter 124e18c0412SDaniel Vetter /** 125e18c0412SDaniel Vetter * drm_mm_initialized - checks whether an allocator is initialized 126e18c0412SDaniel Vetter * @mm: drm_mm to check 127e18c0412SDaniel Vetter * 128e18c0412SDaniel Vetter * Drivers should use this helpers for proper encapusulation of drm_mm 129e18c0412SDaniel Vetter * internals. 130e18c0412SDaniel Vetter * 131e18c0412SDaniel Vetter * Returns: 132e18c0412SDaniel Vetter * True if the @mm is initialized. 133e18c0412SDaniel Vetter */ 13431a5b8ceSDaniel Vetter static inline bool drm_mm_initialized(struct drm_mm *mm) 13531a5b8ceSDaniel Vetter { 136ea7b1dd4SDaniel Vetter return mm->hole_stack.next; 13731a5b8ceSDaniel Vetter } 1389e8944abSChris Wilson 139440fd528SThierry Reding static inline u64 __drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1409e8944abSChris Wilson { 1419e8944abSChris Wilson return hole_node->start + hole_node->size; 1429e8944abSChris Wilson } 1439e8944abSChris Wilson 144e18c0412SDaniel Vetter /** 145e18c0412SDaniel Vetter * drm_mm_hole_node_start - computes the start of the hole following @node 146e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 147e18c0412SDaniel Vetter * 148e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 149e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 150e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 151e18c0412SDaniel Vetter * 152e18c0412SDaniel Vetter * Returns: 153e18c0412SDaniel Vetter * Start of the subsequent hole. 154e18c0412SDaniel Vetter */ 155440fd528SThierry Reding static inline u64 drm_mm_hole_node_start(struct drm_mm_node *hole_node) 1569e8944abSChris Wilson { 1579e8944abSChris Wilson BUG_ON(!hole_node->hole_follows); 1589e8944abSChris Wilson return __drm_mm_hole_node_start(hole_node); 1599e8944abSChris Wilson } 1609e8944abSChris Wilson 161440fd528SThierry Reding static inline u64 __drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1629e8944abSChris Wilson { 16387069f44SGeliang Tang return list_next_entry(hole_node, node_list)->start; 1649e8944abSChris Wilson } 1659e8944abSChris Wilson 166e18c0412SDaniel Vetter /** 167e18c0412SDaniel Vetter * drm_mm_hole_node_end - computes the end of the hole following @node 168e18c0412SDaniel Vetter * @hole_node: drm_mm_node which implicitly tracks the following hole 169e18c0412SDaniel Vetter * 170e18c0412SDaniel Vetter * This is useful for driver-sepific debug dumpers. Otherwise drivers should not 171e18c0412SDaniel Vetter * inspect holes themselves. Drivers must check first whether a hole indeed 172e18c0412SDaniel Vetter * follows by looking at node->hole_follows. 173e18c0412SDaniel Vetter * 174e18c0412SDaniel Vetter * Returns: 175e18c0412SDaniel Vetter * End of the subsequent hole. 176e18c0412SDaniel Vetter */ 177440fd528SThierry Reding static inline u64 drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1789e8944abSChris Wilson { 1799e8944abSChris Wilson return __drm_mm_hole_node_end(hole_node); 1809e8944abSChris Wilson } 1819e8944abSChris Wilson 182e18c0412SDaniel Vetter /** 183e18c0412SDaniel Vetter * drm_mm_for_each_node - iterator to walk over all allocated nodes 184e18c0412SDaniel Vetter * @entry: drm_mm_node structure to assign to in each iteration step 185e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 186e18c0412SDaniel Vetter * 187e18c0412SDaniel Vetter * This iterator walks over all nodes in the range allocator. It is implemented 188e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. 189e18c0412SDaniel Vetter */ 190ea7b1dd4SDaniel Vetter #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \ 191ea7b1dd4SDaniel Vetter &(mm)->head_node.node_list, \ 1922bbd4492SDaniel Vetter node_list) 1939e8944abSChris Wilson 19418b40c58SGeliang Tang #define __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, backwards) \ 19518b40c58SGeliang Tang for (entry = list_entry((backwards) ? (mm)->hole_stack.prev : (mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 19618b40c58SGeliang Tang &entry->hole_stack != &(mm)->hole_stack ? \ 19718b40c58SGeliang Tang hole_start = drm_mm_hole_node_start(entry), \ 19818b40c58SGeliang Tang hole_end = drm_mm_hole_node_end(entry), \ 19918b40c58SGeliang Tang 1 : 0; \ 20018b40c58SGeliang Tang entry = list_entry((backwards) ? entry->hole_stack.prev : entry->hole_stack.next, struct drm_mm_node, hole_stack)) 20118b40c58SGeliang Tang 202e18c0412SDaniel Vetter /** 203e18c0412SDaniel Vetter * drm_mm_for_each_hole - iterator to walk over all holes 204e18c0412SDaniel Vetter * @entry: drm_mm_node used internally to track progress 205e18c0412SDaniel Vetter * @mm: drm_mm allocator to walk 206e18c0412SDaniel Vetter * @hole_start: ulong variable to assign the hole start to on each iteration 207e18c0412SDaniel Vetter * @hole_end: ulong variable to assign the hole end to on each iteration 208e18c0412SDaniel Vetter * 209e18c0412SDaniel Vetter * This iterator walks over all holes in the range allocator. It is implemented 210e18c0412SDaniel Vetter * with list_for_each, so not save against removal of elements. @entry is used 211e18c0412SDaniel Vetter * internally and will not reflect a real drm_mm_node for the very first hole. 212e18c0412SDaniel Vetter * Hence users of this iterator may not access it. 213e18c0412SDaniel Vetter * 214e18c0412SDaniel Vetter * Implementation Note: 215e18c0412SDaniel Vetter * We need to inline list_for_each_entry in order to be able to set hole_start 216e18c0412SDaniel Vetter * and hole_end on each iteration while keeping the macro sane. 21762347f9eSLauri Kasanen * 21862347f9eSLauri Kasanen * The __drm_mm_for_each_hole version is similar, but with added support for 21962347f9eSLauri Kasanen * going backwards. 2209e8944abSChris Wilson */ 2219e8944abSChris Wilson #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 22218b40c58SGeliang Tang __drm_mm_for_each_hole(entry, mm, hole_start, hole_end, 0) 22362347f9eSLauri Kasanen 224249d6048SJerome Glisse /* 225249d6048SJerome Glisse * Basic range manager support (drm_mm.c) 226249d6048SJerome Glisse */ 227e18c0412SDaniel Vetter int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 228b8103450SChris Wilson 229e18c0412SDaniel Vetter int drm_mm_insert_node_generic(struct drm_mm *mm, 230b8103450SChris Wilson struct drm_mm_node *node, 231440fd528SThierry Reding u64 size, 232b8103450SChris Wilson unsigned alignment, 23331e5d7c6SDavid Herrmann unsigned long color, 23462347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 23562347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 236e18c0412SDaniel Vetter /** 237e18c0412SDaniel Vetter * drm_mm_insert_node - search for space and insert @node 238e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 239e18c0412SDaniel Vetter * @node: preallocate node to insert 240e18c0412SDaniel Vetter * @size: size of the allocation 241e18c0412SDaniel Vetter * @alignment: alignment of the allocation 242e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 243e18c0412SDaniel Vetter * 244e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_generic() with @color set 245e18c0412SDaniel Vetter * to 0. 246e18c0412SDaniel Vetter * 247e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 248e18c0412SDaniel Vetter * 249e18c0412SDaniel Vetter * Returns: 250e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 251e18c0412SDaniel Vetter */ 25231e5d7c6SDavid Herrmann static inline int drm_mm_insert_node(struct drm_mm *mm, 25331e5d7c6SDavid Herrmann struct drm_mm_node *node, 254440fd528SThierry Reding u64 size, 25531e5d7c6SDavid Herrmann unsigned alignment, 25631e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 25731e5d7c6SDavid Herrmann { 25862347f9eSLauri Kasanen return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags, 25962347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 26031e5d7c6SDavid Herrmann } 26131e5d7c6SDavid Herrmann 262e18c0412SDaniel Vetter int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 263b8103450SChris Wilson struct drm_mm_node *node, 264440fd528SThierry Reding u64 size, 265b8103450SChris Wilson unsigned alignment, 266b8103450SChris Wilson unsigned long color, 267440fd528SThierry Reding u64 start, 268440fd528SThierry Reding u64 end, 26962347f9eSLauri Kasanen enum drm_mm_search_flags sflags, 27062347f9eSLauri Kasanen enum drm_mm_allocator_flags aflags); 271e18c0412SDaniel Vetter /** 272e18c0412SDaniel Vetter * drm_mm_insert_node_in_range - ranged search for space and insert @node 273e18c0412SDaniel Vetter * @mm: drm_mm to allocate from 274e18c0412SDaniel Vetter * @node: preallocate node to insert 275e18c0412SDaniel Vetter * @size: size of the allocation 276e18c0412SDaniel Vetter * @alignment: alignment of the allocation 277e18c0412SDaniel Vetter * @start: start of the allowed range for this node 278e18c0412SDaniel Vetter * @end: end of the allowed range for this node 279e18c0412SDaniel Vetter * @flags: flags to fine-tune the allocation 280e18c0412SDaniel Vetter * 281e18c0412SDaniel Vetter * This is a simplified version of drm_mm_insert_node_in_range_generic() with 282e18c0412SDaniel Vetter * @color set to 0. 283e18c0412SDaniel Vetter * 284e18c0412SDaniel Vetter * The preallocated node must be cleared to 0. 285e18c0412SDaniel Vetter * 286e18c0412SDaniel Vetter * Returns: 287e18c0412SDaniel Vetter * 0 on success, -ENOSPC if there's no suitable hole. 288e18c0412SDaniel Vetter */ 28931e5d7c6SDavid Herrmann static inline int drm_mm_insert_node_in_range(struct drm_mm *mm, 29031e5d7c6SDavid Herrmann struct drm_mm_node *node, 291440fd528SThierry Reding u64 size, 29231e5d7c6SDavid Herrmann unsigned alignment, 293440fd528SThierry Reding u64 start, 294440fd528SThierry Reding u64 end, 29531e5d7c6SDavid Herrmann enum drm_mm_search_flags flags) 29631e5d7c6SDavid Herrmann { 29731e5d7c6SDavid Herrmann return drm_mm_insert_node_in_range_generic(mm, node, size, alignment, 29862347f9eSLauri Kasanen 0, start, end, flags, 29962347f9eSLauri Kasanen DRM_MM_CREATE_DEFAULT); 30031e5d7c6SDavid Herrmann } 30131e5d7c6SDavid Herrmann 302e18c0412SDaniel Vetter void drm_mm_remove_node(struct drm_mm_node *node); 303e18c0412SDaniel Vetter void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 304e18c0412SDaniel Vetter void drm_mm_init(struct drm_mm *mm, 305440fd528SThierry Reding u64 start, 306440fd528SThierry Reding u64 size); 307e18c0412SDaniel Vetter void drm_mm_takedown(struct drm_mm *mm); 308e18c0412SDaniel Vetter bool drm_mm_clean(struct drm_mm *mm); 309249d6048SJerome Glisse 310202b52b7SChris Wilson struct drm_mm_node * 311522e85ddSChris Wilson __drm_mm_interval_first(struct drm_mm *mm, u64 start, u64 last); 312202b52b7SChris Wilson 313522e85ddSChris Wilson /** 314522e85ddSChris Wilson * drm_mm_for_each_node_in_range - iterator to walk over a range of 315522e85ddSChris Wilson * allocated nodes 316522e85ddSChris Wilson * @node: drm_mm_node structure to assign to in each iteration step 317522e85ddSChris Wilson * @mm: drm_mm allocator to walk 318522e85ddSChris Wilson * @start: starting offset, the first node will overlap this 319522e85ddSChris Wilson * @end: ending offset, the last node will start before this (but may overlap) 320522e85ddSChris Wilson * 321522e85ddSChris Wilson * This iterator walks over all nodes in the range allocator that lie 322522e85ddSChris Wilson * between @start and @end. It is implemented similarly to list_for_each(), 323522e85ddSChris Wilson * but using the internal interval tree to accelerate the search for the 324522e85ddSChris Wilson * starting node, and so not safe against removal of elements. It assumes 325522e85ddSChris Wilson * that @end is within (or is the upper limit of) the drm_mm allocator. 326522e85ddSChris Wilson */ 327522e85ddSChris Wilson #define drm_mm_for_each_node_in_range(node, mm, start, end) \ 328522e85ddSChris Wilson for (node = __drm_mm_interval_first((mm), (start), (end)-1); \ 329522e85ddSChris Wilson node && node->start < (end); \ 330522e85ddSChris Wilson node = list_next_entry(node, node_list)) \ 331202b52b7SChris Wilson 3326b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 333440fd528SThierry Reding u64 size, 334d935cc61SDaniel Vetter unsigned alignment, 3356b9d89b4SChris Wilson unsigned long color); 3366b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 337440fd528SThierry Reding u64 size, 3386b9d89b4SChris Wilson unsigned alignment, 3396b9d89b4SChris Wilson unsigned long color, 340440fd528SThierry Reding u64 start, 341440fd528SThierry Reding u64 end); 342e18c0412SDaniel Vetter bool drm_mm_scan_add_block(struct drm_mm_node *node); 343e18c0412SDaniel Vetter bool drm_mm_scan_remove_block(struct drm_mm_node *node); 344709ea971SDaniel Vetter 345e18c0412SDaniel Vetter void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 346fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 347fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 348fa8a1238SDave Airlie #endif 349fa8a1238SDave Airlie 350249d6048SJerome Glisse #endif 351