]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
maple docs
authorLiam R. Howlett <Liam.Howlett@Oracle.com>
Mon, 5 Jul 2021 19:32:39 +0000 (15:32 -0400)
committerLiam R. Howlett <Liam.Howlett@Oracle.com>
Mon, 5 Jul 2021 19:32:39 +0000 (15:32 -0400)
Signed-off-by: Liam R. Howlett <Liam.Howlett@Oracle.com>
Documentation/core-api/maple-tree.rst

index 8855b79bf6abc06a2bc887efed72d566bff69df2..eebb3469db43d37a67b37e336928da05936bb175 100644 (file)
@@ -97,6 +97,8 @@ Takes RCU read lock:
  * mtree_load()
  * mt_find()
  * mt_for_each()
+ * mt_next()
+ * mt_prev()
 
 Takes ma_lock internally:
  * mtree_store()
@@ -174,7 +176,12 @@ mas_pause().
 
 Using a maple state allows mas_next() and mas_prev() to function as if the tree
 was a linked list.  With such a high branching factor the amortized performance
-penalty is outweighed by cache optimization.
+penalty is outweighed by cache optimization.  mas_next() will return the next
+entry which occurs after the entry at index.  mas_prev() will return the
+previous entry which occurs before the entry at index.
+
+mas_find() will find the first entry which exists at or above index on the
+first call, and the next entry from every subsequent calls.
 
 There are a few extra interfaces provided when using an allocation tree.  If
 you wish to search for a gap within a range, then mas_empty_area() or