Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
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 v2 06/36] maple_tree: Add debug BUG_ON and WARN_ON variants
Date:   Fri,  5 May 2023 13:41:34 -0400
Message-Id: <20230505174204.2665599-7-Liam.Howlett@oracle.com>
In-Reply-To: <20230505174204.2665599-1-Liam.Howlett@oracle.com>
References: <20230505174204.2665599-1-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?uPs27AAqHPLOhnXFDLdp6tMdzqTcBWvycD8cDDeigTxNRe2DmShZfGz2ok33?=
 =?us-ascii?Q?orUqlpnMnnapJhx40W3NAFysWNxb7G/RluKHY6EugWgiuNP0Ozr1hBTy0Wuv?=
 =?us-ascii?Q?oZiTvBTHrb9lweTdPnevv/lW1t66DJvoWAPoIQaqDi+HunY8twjpQh4bSr14?=
 =?us-ascii?Q?Qe+s614cZpGNEwtXuHS4w5JESgByjXH39uZomIrk5S1PHwrYSAsspiXCNCXd?=
 =?us-ascii?Q?CgIpfeSwMCo9DyzHBoLKPiMxfPmzDw4cCkL7/ginQaZ8BgTzyEN1f8nbei0l?=
 =?us-ascii?Q?HbS6S6P3LKTXtGuRjEcyuaQzoiIVnsenBjcrf8XIeZ6jmae1vcVpOUvh9WZ8?=
 =?us-ascii?Q?jBkhll8JDiR4TUU+/AYpw+aRaxOY/Q15Yx2PvjOlOD6ZXSWz/LwN0Z4uiRuZ?=
 =?us-ascii?Q?iSnwI4WR8EUAysM7o3kw/AkJELkokg4UPIM5dIWhmZm/Gm18rEklLmBckK59?=
 =?us-ascii?Q?GUaIjBV/DK234h3BNH0KC+fAdXArhUpcNWwcL4XAfaEvEV4j8ixtPY/5fnFM?=
 =?us-ascii?Q?AfpBJYMglP6etysCqut4HY6rVjVVy7GxRd6jNJOWSf76VtDksZ3GVK1x2Hvs?=
 =?us-ascii?Q?OhLtvfiZBswgtUMO6lrdSq4SNNNFgIBXMa+fvpISC4hkUzxQPzl3YZ4D5+4O?=
 =?us-ascii?Q?ZGSKn9pX+hmah4NrfZJe2QwiCHEn1yFzXZMvxgJY8nCS78NwgjXYFwU8MihX?=
 =?us-ascii?Q?GMY0FwBm4UKWkO8bZB/F0HG6KgdQRWVpRaCpypPd/GKZz9ycYb1ProINSMo/?=
 =?us-ascii?Q?7ckhjzInDClHAjYAckRltdu3a/gEnbiGIUcThL1wTn4PmBxSUm3EZaxq1oUJ?=
 =?us-ascii?Q?D/vqCElBWrobscCxBsK1VMLqsoL5kX0aLdVy39vA7EeuXI265eGOUEA3hieN?=
 =?us-ascii?Q?ijY3BP05aXq7bp9/r2UIwTxdmsDwrnXBOd9E8KWBV9R6S3/PsXnLB7kYsqRv?=
 =?us-ascii?Q?vdLrplvoIBknH3T+VOCG8qQwPCB71pPkZC2gnpMEGvZf1OMA3b0cYgv8YbGn?=
 =?us-ascii?Q?ZpDRFQZI9I7Yhvrr82nVOCqvNADFzEbV3UQjNNMpowe38yNNXmi7zW4dM6fo?=
 =?us-ascii?Q?aRmHtIikks9gnRvJ7B54pX/3kXk77oIYM285sswAxuCxjgCgt+VA6xYUcxS4?=
 =?us-ascii?Q?3rxmD7Gcr32xHBCAflx3nS/sdTQslWMzHJjjciClNaSSe2FulLv8QvpokC+Z?=
 =?us-ascii?Q?WQu4kbhTY4IJfxQRIyAfGQD9FbGLUa6kRhacr658OZJkH9WwJJg38alP1P3X?=
 =?us-ascii?Q?yceOBrxT6QRryuT7EhbF+h1PUWh0GR7kq3T+SE7M2mF8vFeo4MXDHZaVsE97?=
 =?us-ascii?Q?/nOThOBfuUBdxBv+dM8kvUNIxfDWfTyhIDE/meCBqMY9ZyKCCT/zEORhoCQd?=
 =?us-ascii?Q?infycuXTAgw/QaL6NJ5DdVBexxBgzcu4q6Pz+w72L4ay+CwoC3J1Y/K1meX6?=
 =?us-ascii?Q?vsLaqbIRx8xFNMeOIL/9RQJFvDie/UX0XOq1/78rebc1pJD44sd6greDQoI3?=
 =?us-ascii?Q?vlR2us6ckan5KGTzPxfypzo0cLwliUnyfRXBySDA1640X095ckpEM2LwqiAJ?=
 =?us-ascii?Q?R4E4wRxMZPuDBgDgfAiDXnz511THtNIlCWCZd7qz46XPIxYUkU7YQEnF+UFe?=
 =?us-ascii?Q?YA=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 0tqRSs8lqu2Z5v05hmol47nBAuTF35AkzHRtSTNunzOSRpqgcTUyBmGHjOSLOKVBsKbs03sCR3ZQxPdvFAHCUavtHgcjN53RGvghSPRCjUQ+iFYFff0RVWoHrttbvT07F4eHJW63iWIdyWt/Wq/zD3/5bjiizym+czCo8KBDFmSS2jvDPGKjbfp0eWlzLJGEnuKNuDmx6bKCWXaUnwni8dgHw+G6z02rjI48zCn3oQFNHfTjQALm+Qf8zxaFP0KbxGuZWyPhU8rzcza7y5hDrxro6M+bS1qFM08Lx1uuarALqYi+6qXnlzDSIlea+9MppZjLG+ggzDOK2abl8Agj2IcwnZSyFXsH3T0SjVPmYZUJSTg9+S/2nOASMlIaqIGdIewlH3H4h2U9YHqnuPsu073Je8gDQqOwgeu4Ah6tD7T2VkZplzsAuYt0wXqXiyTueKGRbat1pDqto9qimnGweyO09GZ24KKrPY8nsRhYMuKgZKz0U/bRhMCjd9diYIGRmABwOrAVy6QMxGi39vm09+trSOZmKbz+llOOrn6z1DMAssVWI1r2/XUMVkYI7mAT2UZylpt1PYZ0U8ayi0jw7Y8FTF+iSEBboeK+fpcqyCghzR82WlJBVPhGR/V9depwDHkzwgV7Vpp3DR0ZTWXmsRUDvFUD4eEKw6NR4PF9uNUzBq3J9z0OElyaVkfbE/YSeAI9HwG4h789LwyR9nMrdHusOasKjs6igCtRBcFOB77T1lCadBkS/ktjjk6ndYy/L6voGU81KSiXBmE60ow3zLbD4F7Pm4p/t5nq4jpOoC76ef9oQG+A6W3wcahBM0n0cSyuXzFQgMMoiJZSMNlRG8bZADo9uTC16JZ6HeCdlLga4qkn8pUEIYP21yldx+ai+49OWGCmTxyf4pfAeKeH9A==
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9d4bd6e8-1585-48e5-aadd-08db4d904bed
X-MS-Exchange-CrossTenant-AuthSource: SN6PR10MB3022.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 May 2023 17:43:54.8546
 (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: ArjaPRTLv1vxnpQN2x6cFjkcgVH6eIvdvLoeNbgTT+pp11F+wKcEtp+kg667FM3X/Vwm5e+qLWeHj+Mg2sTeWA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL3PR10MB6089
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22
 definitions=2023-05-05_24,2023-05-05_01,2023-02-09_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 bulkscore=0 spamscore=0
 mlxlogscore=999 mlxscore=0 adultscore=0 phishscore=0 suspectscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2303200000
 definitions=main-2305050146
X-Proofpoint-ORIG-GUID: nR6x51K2FWxajrG9MacuTRyZyrQW5SBf
X-Proofpoint-GUID: nR6x51K2FWxajrG9MacuTRyZyrQW5SBf
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Add debug macros to dump the maple state and/or the tree for both
warning and bug_on calls.

Signed-off-by: Liam R. Howlett <Liam.Howlett@oracle.com>
---
 include/linux/maple_tree.h | 100 +++++++++++++++++++++++++++++++++++--
 lib/maple_tree.c           |  34 ++++++++++++-
 2 files changed, 129 insertions(+), 5 deletions(-)

diff --git a/include/linux/maple_tree.h b/include/linux/maple_tree.h
index 140fb271be4a4..204d7941a39ec 100644
--- a/include/linux/maple_tree.h
+++ b/include/linux/maple_tree.h
@@ -482,13 +482,13 @@ static inline void mas_init(struct ma_state *mas, struct maple_tree *tree,
 }
 
 /* Checks if a mas has not found anything */
-static inline bool mas_is_none(struct ma_state *mas)
+static inline bool mas_is_none(const struct ma_state *mas)
 {
 	return mas->node == MAS_NONE;
 }
 
 /* Checks if a mas has been paused */
-static inline bool mas_is_paused(struct ma_state *mas)
+static inline bool mas_is_paused(const struct ma_state *mas)
 {
 	return mas->node == MAS_PAUSE;
 }
@@ -679,6 +679,8 @@ extern atomic_t maple_tree_tests_run;
 extern atomic_t maple_tree_tests_passed;
 
 void mt_dump(const struct maple_tree *mt, enum mt_dump_format format);
+void mas_dump(const struct ma_state *mas);
+void mas_wr_dump(const struct ma_wr_state *wr_mas);
 void mt_validate(struct maple_tree *mt);
 void mt_cache_shrink(void);
 #define MT_BUG_ON(__tree, __x) do {					\
@@ -695,8 +697,100 @@ void mt_cache_shrink(void);
 		atomic_inc(&maple_tree_tests_passed);			\
 	}								\
 } while (0)
+
+#define MAS_BUG_ON(__mas, __x) do {					\
+	atomic_inc(&maple_tree_tests_run);				\
+	if (__x) {							\
+		pr_info("BUG at %s:%d (%u)\n",				\
+		__func__, __LINE__, __x);				\
+		mas_dump(__mas);					\
+		mt_dump((__mas)->tree, mt_dump_hex);			\
+		pr_info("Pass: %u Run:%u\n",				\
+			atomic_read(&maple_tree_tests_passed),		\
+			atomic_read(&maple_tree_tests_run));		\
+		dump_stack();						\
+	} else {							\
+		atomic_inc(&maple_tree_tests_passed);			\
+	}								\
+} while (0)
+
+#define MAS_WR_BUG_ON(__wrmas, __x) do {				\
+	atomic_inc(&maple_tree_tests_run);				\
+	if (__x) {							\
+		pr_info("BUG at %s:%d (%u)\n",				\
+		__func__, __LINE__, __x);				\
+		mas_wr_dump(__wrmas);					\
+		mas_dump((__wrmas)->mas);				\
+		mt_dump((__wrmas)->mas->tree, mt_dump_hex);		\
+		pr_info("Pass: %u Run:%u\n",				\
+			atomic_read(&maple_tree_tests_passed),		\
+			atomic_read(&maple_tree_tests_run));		\
+		dump_stack();						\
+	} else {							\
+		atomic_inc(&maple_tree_tests_passed);			\
+	}								\
+} while (0)
+
+#define MT_WARN_ON(__tree, __x)  ({					\
+	int ret = !!(__x);						\
+	atomic_inc(&maple_tree_tests_run);				\
+	if (ret) {							\
+		pr_info("WARN at %s:%d (%u)\n",				\
+		__func__, __LINE__, __x);				\
+		mt_dump(__tree, mt_dump_hex);				\
+		pr_info("Pass: %u Run:%u\n",				\
+			atomic_read(&maple_tree_tests_passed),		\
+			atomic_read(&maple_tree_tests_run));		\
+		dump_stack();						\
+	} else {							\
+		atomic_inc(&maple_tree_tests_passed);			\
+	}								\
+	unlikely(ret);							\
+})
+
+#define MAS_WARN_ON(__mas, __x) ({					\
+	int ret = !!(__x);						\
+	atomic_inc(&maple_tree_tests_run);				\
+	if (ret) {							\
+		pr_info("WARN at %s:%d (%u)\n",				\
+		__func__, __LINE__, __x);				\
+		mas_dump(__mas);					\
+		mt_dump((__mas)->tree, mt_dump_hex);			\
+		pr_info("Pass: %u Run:%u\n",				\
+			atomic_read(&maple_tree_tests_passed),		\
+			atomic_read(&maple_tree_tests_run));		\
+		dump_stack();						\
+	} else {							\
+		atomic_inc(&maple_tree_tests_passed);			\
+	}								\
+	unlikely(ret);							\
+})
+
+#define MAS_WR_WARN_ON(__wrmas, __x) ({					\
+	int ret = !!(__x);						\
+	atomic_inc(&maple_tree_tests_run);				\
+	if (ret) {							\
+		pr_info("WARN at %s:%d (%u)\n",				\
+		__func__, __LINE__, __x);				\
+		mas_wr_dump(__wrmas);					\
+		mas_dump((__wrmas)->mas);				\
+		mt_dump((__wrmas)->mas->tree, mt_dump_hex);		\
+		pr_info("Pass: %u Run:%u\n",				\
+			atomic_read(&maple_tree_tests_passed),		\
+			atomic_read(&maple_tree_tests_run));		\
+		dump_stack();						\
+	} else {							\
+		atomic_inc(&maple_tree_tests_passed);			\
+	}								\
+	unlikely(ret);							\
+})
 #else
-#define MT_BUG_ON(__tree, __x) BUG_ON(__x)
+#define MT_BUG_ON(__tree, __x)		BUG_ON(__x)
+#define MAS_BUG_ON(__mas, __x)		BUG_ON(__x)
+#define MAS_WR_BUG_ON(__mas, __x)	BUG_ON(__x)
+#define MT_WARN_ON(__tree, __x)		WARN_ON(__x)
+#define MAS_WARN_ON(__mas, __x)		WARN_ON(__x)
+#define MAS_WR_WARN_ON(__mas, __x)	WARN_ON(__x)
 #endif /* CONFIG_DEBUG_MAPLE_TREE */
 
 #endif /*_LINUX_MAPLE_TREE_H */
diff --git a/lib/maple_tree.c b/lib/maple_tree.c
index 084868865849c..a28b021f740f1 100644
--- a/lib/maple_tree.c
+++ b/lib/maple_tree.c
@@ -240,12 +240,12 @@ static inline void mas_set_err(struct ma_state *mas, long err)
 	mas->node = MA_ERROR(err);
 }
 
-static inline bool mas_is_ptr(struct ma_state *mas)
+static inline bool mas_is_ptr(const struct ma_state *mas)
 {
 	return mas->node == MAS_ROOT;
 }
 
-static inline bool mas_is_start(struct ma_state *mas)
+static inline bool mas_is_start(const struct ma_state *mas)
 {
 	return mas->node == MAS_START;
 }
@@ -7251,4 +7251,34 @@ void mt_validate(struct maple_tree *mt)
 }
 EXPORT_SYMBOL_GPL(mt_validate);
 
+void mas_dump(const struct ma_state *mas)
+{
+	pr_err("MAS: tree=%p enode=%p ", mas->tree, mas->node);
+	if (mas_is_none(mas))
+		pr_err("(MAS_NONE) ");
+	else if (mas_is_ptr(mas))
+		pr_err("(MAS_ROOT) ");
+	else if (mas_is_start(mas))
+		 pr_err("(MAS_START) ");
+	else if (mas_is_paused(mas))
+		pr_err("(MAS_PAUSED) ");
+
+	pr_err("[%u] index=%lx last=%lx\n", mas->offset, mas->index, mas->last);
+	pr_err("     min=%lx max=%lx alloc=%p, depth=%u, flags=%x\n",
+	       mas->min, mas->max, mas->alloc, mas->depth, mas->mas_flags);
+	if (mas->index > mas->last)
+		pr_err("Check index & last\n");
+}
+EXPORT_SYMBOL_GPL(mas_dump);
+
+void mas_wr_dump(const struct ma_wr_state *wr_mas)
+{
+	pr_err("WR_MAS: node=%p r_min=%lx r_max=%lx\n",
+	       wr_mas->node, wr_mas->r_min, wr_mas->r_max);
+	pr_err("        type=%u off_end=%u, node_end=%u, end_piv=%lx\n",
+	       wr_mas->type, wr_mas->offset_end, wr_mas->node_end,
+	       wr_mas->end_piv);
+}
+EXPORT_SYMBOL_GPL(mas_wr_dump);
+
 #endif /* CONFIG_DEBUG_MAPLE_TREE */
-- 
2.39.2