Skip to contentSkip to conversation

maple tree: Add some comments

PATCH Applied Dev Jain 2 participants 2 messages Jul 3, 2025 – Jul 4, 2025

Subsystems (3)
lore
Share & tools
lore

Dev Jain

author
#0 lore raw

PATCH v2 1/1 maple tree: Add some comments

Add comments explaining the fields for maple_metadata, since "end" is ambiguous and "gap" can be confused as the largest gap, whereas it is actually the offset of the largest gap.

Add comment for mas_ascend() to explain, whose min and max we are trying to find. Explain that, for example, if we are already on offset zero, then the parent min is mas->min, otherwise we need to walk up to find the implied pivot min.

---

v1->v2:
- Drop MAPLE_ROOT_NODE comment modification

v1:
- https://lore.kernel.org/all/[email protected]/

 include/linux/maple_tree.h | 4 ++--
 lib/maple_tree.c           | 8 +++++++-
 2 files changed, 9 insertions(+), 3 deletions(-)
include/linux/maple_tree.h +2 -2
index 9ef129038224..bafe143b1f78 100644
@@ -75,8 +75,8 @@
  * searching for gaps or any other code that needs to find the end of the data.
  */
 struct maple_metadata {
-	unsigned char end;
-	unsigned char gap;
+	unsigned char end;	/* end of data */
+	unsigned char gap;	/* offset of largest gap */
 };
 
 /*
lib/maple_tree.c +7 -1
index 0e85e92c5375..b4ee2d29d7a9 100644
@@ -1053,7 +1053,7 @@ static inline void mte_set_gap(const struct maple_enode *mn,
  * mas_ascend() - Walk up a level of the tree.
  * @mas: The maple state
  *
- * Sets the @mas->max and @mas->min to the correct values when walking up.  This
+ * Sets the @mas->max and @mas->min for the parent node of mas->node.  This
  * may cause several levels of walking up to find the correct min and max.
  * May find a dead node which will cause a premature return.
  * Return: 1 on dead node, 0 otherwise
@@ -1098,6 +1098,12 @@ static int mas_ascend(struct ma_state *mas)
 
 	min = 0;
 	max = ULONG_MAX;
+
+	/*
+	 * !mas->offset implies that parent node min == mas->min.
+	 * mas->offset > 0 implies that we need to walk up to find the
+	 * implied pivot min.
+	 */
 	if (!mas->offset) {
 		min = mas->min;
 		set_min = true;
Signature · 1 line
2.30.2
Reviewed-by on v2 1/1
#1 lore raw
Quoted 10 lines · Dev Jain

Add comments explaining the fields for maple_metadata, since "end" is ambiguous and "gap" can be confused as the largest gap, whereas it is actually the offset of the largest gap.

Add comment for mas_ascend() to explain, whose min and max we are trying to find. Explain that, for example, if we are already on offset zero, then the parent min is mas->min, otherwise we need to walk up to find the implied pivot min.

Thanks!

Quoted 61 lines

---

v1->v2:
- Drop MAPLE_ROOT_NODE comment modification

v1:
- https://lore.kernel.org/all/[email protected]/

 include/linux/maple_tree.h | 4 ++--
 lib/maple_tree.c           | 8 +++++++-
 2 files changed, 9 insertions(+), 3 deletions(-)
include/linux/maple_tree.h +2 -2
index 9ef129038224..bafe143b1f78 100644
@@ -75,8 +75,8 @@
  * searching for gaps or any other code that needs to find the end of the data.
  */
 struct maple_metadata {
-	unsigned char end;
-	unsigned char gap;
+	unsigned char end;	/* end of data */
+	unsigned char gap;	/* offset of largest gap */
 };
 
 /*
lib/maple_tree.c +7 -1
index 0e85e92c5375..b4ee2d29d7a9 100644
@@ -1053,7 +1053,7 @@ static inline void mte_set_gap(const struct maple_enode *mn,
  * mas_ascend() - Walk up a level of the tree.
  * @mas: The maple state
  *
- * Sets the @mas->max and @mas->min to the correct values when walking up.  This
+ * Sets the @mas->max and @mas->min for the parent node of mas->node.  This
  * may cause several levels of walking up to find the correct min and max.
  * May find a dead node which will cause a premature return.
  * Return: 1 on dead node, 0 otherwise
@@ -1098,6 +1098,12 @@ static int mas_ascend(struct ma_state *mas)
 
 	min = 0;
 	max = ULONG_MAX;
+
+	/*
+	 * !mas->offset implies that parent node min == mas->min.
+	 * mas->offset > 0 implies that we need to walk up to find the
+	 * implied pivot min.
+	 */
 	if (!mas->offset) {
 		min = mas->min;
 		set_min = true;
Signature · 7 lines
2.30.2


-- 
maple-tree mailing list
[email protected]
https://lists.infradead.org/mailman/listinfo/maple-tree