summaryrefslogtreecommitdiff
path: root/Documentation/core-api
diff options
context:
space:
mode:
authorLiam R. Howlett <Liam.Howlett@Oracle.com>2020-07-24 13:02:52 -0400
committerLiam R. Howlett <Liam.Howlett@Oracle.com>2020-07-24 13:03:43 -0400
commitf154ced8aeb1c3f03a462281a5e234cd44b1b64b (patch)
tree4a2a6dfb050aa1683eff45e73e382924d0f75784 /Documentation/core-api
parente19d24f64807b157c7d020c1e44e26d4a0d312ee (diff)
Maple Tree: Add new data structure
The Maple Tree is a new data structure optimised for storing ranges. Signed-off-by: Liam Howlett <Liam.Howlett@oracle.com> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Diffstat (limited to 'Documentation/core-api')
-rw-r--r--Documentation/core-api/index.rst1
-rw-r--r--Documentation/core-api/maple-tree.rst36
2 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 15ab86112627..c20558e76653 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -39,6 +39,7 @@ Library functionality that is used throughout the kernel.
rbtree
generic-radix-tree
packing
+ maple-tree
timekeeping
errseq
diff --git a/Documentation/core-api/maple-tree.rst b/Documentation/core-api/maple-tree.rst
new file mode 100644
index 000000000000..6d71d4b1f145
--- /dev/null
+++ b/Documentation/core-api/maple-tree.rst
@@ -0,0 +1,36 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+
+==========
+Maple Tree
+==========
+
+:Author: Liam R. Howlett
+
+Overview
+========
+
+The Maple Tree is an RCU safe Range tree based on the B-Tree.
+
+Normal API
+==========
+
+Allocating Nodes
+----------------
+
+Locking
+-------
+
+Advanced API
+============
+
+
+Internal Entries
+----------------
+
+Functions and structures
+========================
+
+.. kernel-doc:: include/linux/maple_tree.c
+.. kernel-doc:: lib/maple_tree.c
+