Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38;
From:   "Liam R. Howlett" <Liam.Howlett@oracle.com>
To:     Andrew Morton <akpm@linux-foundation.org>
Cc:     maple-tree@lists.infradead.org, linux-mm@kvack.org,
        linux-kernel@vger.kernel.org,
        "Liam R. Howlett" <Liam.Howlett@oracle.com>
Subject: [PATCH] maple_tree: Fix comments about MAS_*
Date:   Mon,  6 Nov 2023 10:41:24 -0500
Message-Id: <20231106154124.614247-1-Liam.Howlett@oracle.com>
In-Reply-To: <20231101171629.3612299-9-Liam.Howlett@oracle.com>
References: <20231101171629.3612299-9-Liam.Howlett@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?PijEg4JsQP9iuGMrdHikXpJUarcR1d8qNoGWi4rVLoqiKOHmOxqGK51TeKPT?=
 =?us-ascii?Q?U+KjwwzJAQ4MAc+V6xfSbmAsC6kwqdTTgVtteEX5ZYfnOUmI/YbZg/4QgsL6?=
 =?us-ascii?Q?x3Gw/xNskMfMGYQJXQVYmMLF4RdrhunXh+r9ui1w80RD6/lHL0gre4QKz7mU?=
 =?us-ascii?Q?3h+dqREkr91+Zw8avlx8Vl+G+YkcU+foONUj3gemcm2l5XXQX8WqkIIFTX6J?=
 =?us-ascii?Q?r2qevhZND8M6ThjYl0v+LHALK4QPHIdta6uOrEKnWhBWP9ZS3IYmXRG/AtOi?=
 =?us-ascii?Q?kqyqfLmHBC6xHlz7XdyiMjyfC4pm4uFHGL342OmbgVU8COqI/q5Er9jx8iJr?=
 =?us-ascii?Q?IK2MqVUJzLBJYTvAut/K+Dq9U1j9zGy0LxWd8ML35UoG/zviL5ymZBac+vUB?=
 =?us-ascii?Q?yZ5+zvQgvrRS3gdtVWCiuL29/f/ugka4mHHbYFqtCdqi0y7JbuGucHE/IlNI?=
 =?us-ascii?Q?dg8QP/Ds2BRrqb+dDe/aebvxDBX3S0JkB/DgIu3Bo+vR+Km+8G+gCcc6dDB+?=
 =?us-ascii?Q?EK906z7eGbZ7sDO1Sx6dWHeMubuZK16Z/OXVsz8SKYsJVSm7stYn6MU1LOXa?=
 =?us-ascii?Q?MmsfUIskgptMF0C6wIT4OlOZ4KnJ4f87Ih57dn3ODeobGEgdTYWBlhAa9zZv?=
 =?us-ascii?Q?+AYgRzZAabVAuxBO2nqrxMGowK1k5rufou9o0BdNcD6CQQ5c5ykZQBS+siYZ?=
 =?us-ascii?Q?EYrZ8IFYlVGLvAlagdxl8f50uFy6gTvdfKol2Mtp4kGn75o/G9SvCuXZizJK?=
 =?us-ascii?Q?LzwEHqf5sJF3zQdNhoKpMIZTh/FLQM4BC0Yq8rDKACI0T5wT+E0Mv+Ud8Pq4?=
 =?us-ascii?Q?IrcxYRLfK9XWHzQNdt+Ong3TUiKEZjajt7OaYfdCQb1LhCjrsxZa8N8jBbQl?=
 =?us-ascii?Q?hC9+KyEYjXuF1Ldz1XYK56ujI6nCtr6OUhVVQ8o+FhptZtqgR0Ov2qGhFYbG?=
 =?us-ascii?Q?pixlrBBWeVowEDyIPWpVv/w/oOM9CKUMrn+tS7xS4fJXLNfAbTANPODZLb+w?=
 =?us-ascii?Q?qcrV2vz/kNSocOPbO6IiAQmDY3bATzaxhjrQsgvCFUEb7QcDCzDjBh2Vwgz4?=
 =?us-ascii?Q?xEuxy39sGgiyDs8MJgna+Jdi9Jh/QzNc3UpGmANrnPWJvAxwn0pttjoUrLfd?=
 =?us-ascii?Q?2/nlMgVvj88qRxziedpUoN78a+rkx4uiSQhpl4Cmp8nxOBoIiHXm9hxGowK9?=
 =?us-ascii?Q?cJ1bhxsGgIbRnGEGesdV2ZduxU9yhgvqKdMwQzD3dsTMPvff1DUyroqSrbf9?=
 =?us-ascii?Q?vvGlpm3tCDHkbAyMicxVRoGTY2dw8zf/DBRWE90y0WBoBI5vNDt72uQW2Vs1?=
 =?us-ascii?Q?TdIZ6NlbBO825ASXh7EGjUpgW7CG4yQ6yyYPWLoVGoxRnc97V5vp7xXhJ6dp?=
 =?us-ascii?Q?aASUlb9tyMInelbayDo2L2JFgJ4MSS5bqKhCGrmMjeRW2qFomk+EcDgSY9jT?=
 =?us-ascii?Q?5peiqQSobdIoNCFOFrnUsfbpta44N5a+RXVsbKoupY+iOU3pe2bsgaJPnjk0?=
 =?us-ascii?Q?hJjhKvQlLbYq2O1c94LlQcghKls0gkSE0QVWJnB812eVAZtfJ5w38+Tztqhi?=
 =?us-ascii?Q?6Wk/AdCqXC1RiFXQf0IpYRNEg/p4elCI9FHuGN0e?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 5/YuuUsUHFch4sMvoAOdAvFI2FQ2rgNHPqwyUvaSIIsYiyAYxXAQ2SS4DntswJTW7sELeprpFXZ2DLRT3McQZki6BkwItYy9Y0czSI8TsKC+atIg5vygbM2LBAHs3n2lv2g/KkUHKfGAc983k1hcUtuUkfxc0QMAkceS/gQx+rlRHGzbbPX0tBEAX042jRvxUFIXAi+5w+Vrt8h1CyczzIabFeZ6PiOyW61Gw6KAqADPVWULreaGYpJg2UXlKLrfp1tK+QPlaOHaVhm2CAMkEln4aKGFevADejn2GMln6O6KbEZHOLC3IiPvlbzVzm5jIBKQHLR4+TFcpm4zr+uPRvIrsAQbXP6ie3NnVaPUQL0mdsC1mhOHqEgZ5wfHog6LWsLcVW+xKX3o2MB4FJb4A5CFMZnQk7E84Y/FsTlWM5X4N3IIbw8ReX3apA1KyaSzhLvkyeYl4rGd8M/k70lQu0NDHAr9bihZqucHolt8aA28FCHf6LoAyHIAvbNtTZ0Q5jRTR3QLWj6VA5gkMQSExuTQKrVJltzYbzSX/49mrNyFqDU/pPKNyj0pZDv6nvtmQ7MMUzha+KCqwPNYHtIPxjdK9k8f0r+uXoXz2vEJZtlKAkNbKcRSIHE+Hv7LetIkcXcSJOR7HMFUKoacFpVsCwoSUi4rmfdPdM7TOuFdyLQxQHN4VyM8A30oMySmgF8OgJH3PCPui9kvx14AVljTz60Rp/ngllrB1nVaMgU4EgjA5wsn7UjQWGxwNbBKBUt7X/lVrqS68y+ufm3++/Ta+0curJsktlC81ZlyFpO/+x+Jp/sB/mJ8zoIoTsv5dTZaeTIOmNG3EQE2k03fmLKzbBzr0UOrsoQ8Ri5MEUZ+5fURb1wDQsIecF7Hpp9AsJSSc/PELtKb3hzI8CkRRgmzMQ==
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a6878d07-7656-4940-2a1d-08dbdedee05b
X-MS-Exchange-CrossTenant-AuthSource: SN6PR10MB3022.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Nov 2023 15:41:43.2606
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 9BDFKZB2/D/e3XDufI+4XZ6lyJk8IG0eiwXsN1JIaKl4Y/JHAQGiZ4KUsuZpEazOPp/zFlw9gAztM7J0ivq8lQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR10MB6030
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.987,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2023-11-06_12,2023-11-02_03,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 mlxlogscore=999 mlxscore=0
 phishscore=0 malwarescore=0 spamscore=0 suspectscore=0 adultscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310240000
 definitions=main-2311060126
X-Proofpoint-ORIG-GUID: 2pVZvhVfjIZVEVyvKDD9ay6KFYb_Zo5a
X-Proofpoint-GUID: 2pVZvhVfjIZVEVyvKDD9ay6KFYb_Zo5a
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Mon, 06 Nov 2023 07:42:26 -0800 (PST)

Missed some documentation changes when separating the nodes from the
status of the maple state.

Signed-off-by: Liam R. Howlett <Liam.Howlett@oracle.com>
---
 lib/maple_tree.c | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

Andrew, please squash this into [PATCH 08/12] maple_tree: Separate
ma_state node from status.

I missed some comment changes.

diff --git a/lib/maple_tree.c b/lib/maple_tree.c
index 97ae58cd93ad..59dd0e2325e4 100644
--- a/lib/maple_tree.c
+++ b/lib/maple_tree.c
@@ -2219,12 +2219,10 @@ static inline bool mas_next_sibling(struct ma_state *mas)
 }
 
 /*
- * mte_node_or_node() - Return the encoded node or MAS_NONE.
+ * mte_node_or_none() - Set the enode and state.
  * @enode: The encoded maple node.
  *
- * Shorthand to avoid setting %NULLs in the tree or maple_subtree_state.
- *
- * Return: @enode or MAS_NONE
+ * Set the node to the enode and the status.
  */
 static inline void mas_node_or_none(struct ma_state *mas,
 		struct maple_enode *enode)
@@ -4359,11 +4357,13 @@ static __always_inline bool mas_rewalk_if_dead(struct ma_state *mas,
 
 /*
  * mas_prev_node() - Find the prev non-null entry at the same level in the
- * tree.  The prev value will be mas->node[mas->offset] or MAS_NONE.
+ * tree.  The prev value will be mas->node[mas->offset] or the status will be
+ * ma_none.
  * @mas: The maple state
  * @min: The lower limit to search
  *
- * The prev node value will be mas->node[mas->offset] or MAS_NONE.
+ * The prev node value will be mas->node[mas->offset] or the status will be
+ * ma_none.
  * Return: 1 if the node is dead, 0 otherwise.
  */
 static int mas_prev_node(struct ma_state *mas, unsigned long min)
@@ -4885,7 +4885,7 @@ static inline bool mas_anode_descend(struct ma_state *mas, unsigned long size)
  * @mas: The maple state.
  *
  * mas->index and mas->last will be set to the range if there is a value.  If
- * mas->node is MAS_NONE, reset to mas_start
+ * mas->status is ma_none, reset to ma_start
  *
  * Return: the entry at the location or %NULL.
  */
@@ -5854,7 +5854,7 @@ static bool mas_prev_setup(struct ma_state *mas, unsigned long min, void **entry
  * @min: The minimum value to check.
  *
  * Must hold rcu_read_lock or the write lock.
- * Will reset mas to MAS_START if the node is MAS_NONE.  Will stop on not
+ * Will reset mas to ma_start if the status is ma_none.  Will stop on not
  * searchable nodes.
  *
  * Return: the previous value or %NULL.
@@ -5877,7 +5877,7 @@ EXPORT_SYMBOL_GPL(mas_prev);
  *
  * Sets @mas->index and @mas->last to the range.
  * Must hold rcu_read_lock or the write lock.
- * Will reset mas to MAS_START if the node is MAS_NONE.  Will stop on not
+ * Will reset mas to ma_start if the node is ma_none.  Will stop on not
  * searchable nodes.
  *
  * Return: the previous value or %NULL.
@@ -6032,7 +6032,7 @@ static __always_inline bool mas_find_setup(struct ma_state *mas, unsigned long m
  *
  * Must hold rcu_read_lock or the write lock.
  * If an entry exists, last and index are updated accordingly.
- * May set @mas->node to MAS_NONE.
+ * May set @mas->status to ma_overflow.
  *
  * Return: The entry or %NULL.
  */
@@ -6059,7 +6059,7 @@ EXPORT_SYMBOL_GPL(mas_find);
  *
  * Must hold rcu_read_lock or the write lock.
  * If an entry exists, last and index are updated accordingly.
- * May set @mas->node to MAS_NONE.
+ * May set @mas->status to ma_overflow.
  *
  * Return: The entry or %NULL.
  */
@@ -6171,7 +6171,7 @@ static bool mas_find_rev_setup(struct ma_state *mas, unsigned long min,
  *
  * Must hold rcu_read_lock or the write lock.
  * If an entry exists, last and index are updated accordingly.
- * May set @mas->node to MAS_NONE.
+ * May set @mas->status to ma_underflow.
  *
  * Return: The entry or %NULL.
  */
@@ -6197,7 +6197,7 @@ EXPORT_SYMBOL_GPL(mas_find_rev);
  *
  * Must hold rcu_read_lock or the write lock.
  * If an entry exists, last and index are updated accordingly.
- * May set @mas->node to MAS_NONE.
+ * May set @mas->status to ma_underflow.
  *
  * Return: The entry or %NULL.
  */
-- 
2.40.1