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:     linux-kernel@vger.kernel.org, linux-mm@kvack.org,
        maple-tree@lists.infradead.org,
        "Liam R. Howlett" <Liam.Howlett@oracle.com>
Subject: [PATCH 06/34] maple_tree: Add debug BUG_ON and WARN_ON variants
Date:   Tue, 25 Apr 2023 10:09:27 -0400
Message-Id: <20230425140955.3834476-7-Liam.Howlett@oracle.com>
In-Reply-To: <20230425140955.3834476-1-Liam.Howlett@oracle.com>
References: <20230425140955.3834476-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?oToTAqOtNx7Z/cUzwYfPBJxf5vCQ8v+proE5dYh8bZtPbHzok4lwcYlLYoj0?=
 =?us-ascii?Q?gmbd4CGSv+DqwzdEUjXOozOg6JOD/OS2pbhvaSWJ3HImDP/H9Z8mN5EjENk7?=
 =?us-ascii?Q?YqjwrTSUZmfG8qUzxmP3c7BCj01cO8Q0NRy4MFkZssERcmv9jRXHwft8bOTs?=
 =?us-ascii?Q?okcRQw/nfsKAS9uRMPSEVjG8AbxWvypViGCERWAmwIjnBckzBKzpgIzgVZJR?=
 =?us-ascii?Q?tXFj68ID/7tlusAD7TZuhVTU7G23TugWwspkxuO8w4UF4MVNT02MF/HRbzby?=
 =?us-ascii?Q?zFf9K/v9IzItDcxn1MigP192FepBPxOMDMaFLcsuIXLK8clu8iklHHBLSkqd?=
 =?us-ascii?Q?0G1VUJPjywBhq6Kj/PHCTF9QFcJvAgwkT/fx7s72Txf+WauKU+776t2QQpnp?=
 =?us-ascii?Q?7RoE3LTVIcwdZFPjI0Pl2VekViorwgSCOBCo7tmK5iRqYiCgqiq6U73UxFGI?=
 =?us-ascii?Q?tsZA28byVl/VVkDJM9/iZqTu3uwdgT5WoBwX2whaRani0TLLJJ0V8ABwVCux?=
 =?us-ascii?Q?bNlrUfCBoHcvT3/6sQEaqGZS7UadzGd9KYarXL1zeqmYo5D1IV+TCTE8Akt3?=
 =?us-ascii?Q?Kijv1p+C++sotjl0YNVrShq+ZvgheJJ049uRswFF4T5dO8d0YGIhsSj90t/s?=
 =?us-ascii?Q?UGJH++Ojx2YjpnjcVKgSwK3g4IuyCNMEuivUAE9NlD7UZevJUXFDRTCOR4Ju?=
 =?us-ascii?Q?vVkGiW2BE89MReL97tn9LQvbRUdsqJXTD3tGZKBFdwieUpVDHTV+iRoJgUHv?=
 =?us-ascii?Q?xJIPpH6J0n061MIbR5mHxyQZRFO0w/7mP/Yhyy8xe+nAkEI7IDqigSuNCwx4?=
 =?us-ascii?Q?Wz7sTR5FjrVFhUOENVbY/lDDxhjNP+ylhrr4fVkXDNrdj8mR/j3JrjCIFtGY?=
 =?us-ascii?Q?vGmt5oiY7HT/3nkazf376b1XyjESTpAkPM9OMekWRngYO7PBFJuqmjgo5pti?=
 =?us-ascii?Q?EmYWxbtNgCoPg0Q0iaZ4j2/2utT3zmL8tWj+gNY8L8R22bBw97p0Z7/I/r6Q?=
 =?us-ascii?Q?3t6wUNgAVcStDF6AcZ0x+nAMLMhtx+xtGYE3EjRrnqlBHA9AtEmVQBQn283q?=
 =?us-ascii?Q?gFJvWFuLGkSoIycXlPdr5v5VGbLyND6yD9waRGnHmcRpVG+z25hSzNnu/WXc?=
 =?us-ascii?Q?NIK5d3WaTNcUKkIwJhMvrMpViJy6LfWbeTJVs6hy49vxePKp+zpdq7IgglMO?=
 =?us-ascii?Q?XXOxMyxoqQSH+hQmnBMPaTH9JZB5nKu0hjfMiQ4m8RxnGccfBsstWLV+yfwX?=
 =?us-ascii?Q?kV7Qg1EsmRa+GPowuCr+irdemTpQHcx6Hs7r9kqtVvqwWJO6WwnqcOWiv+Ne?=
 =?us-ascii?Q?QibaLxRGrKLUxgcmLImQPyqdGB9WyJj9ozvXAW+RI9hWPJpZvZp5av3Vs/Cd?=
 =?us-ascii?Q?g569yr3FMYzhwPKLrCJ0+VnBRW7XmntjyEq+aTm+/ZcxvV7oGmVLLQNeVGtF?=
 =?us-ascii?Q?+BKp6evtGJCEmgd9OVT2tgZeb/OwudSk2E2hbOIYwmMYep7yJSyAhDKkEqQM?=
 =?us-ascii?Q?9Tk0eaQZ4AU5GjEv8c/arZ8sirtXO/fW1Mn+KEfC2SC0vrDVpFFyHDqUgISD?=
 =?us-ascii?Q?+wJH84uRwAby7RyNHz0a/Vh1IJGrdRD4ltB+HeSafWzOn8qDYgayg3LwiY+2?=
 =?us-ascii?Q?Yw=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: XkXV2nY2olg/j2RlT6He+d072etFRgvtsOnLMX2PDnLNUVYg2t0nuShj6MoBSA0bv3h9sEuBg9JaH7FVUk5oNUQJ1X7SYknvv4IlsahRKlL5r+glmS7Er/d5WjtZGWy1bcETNANVTLL+NDzDIiQAtXgmHvdU9svUPb9SctKYv+GK7OG48hHfZMJ4Te9q2memJIFxqw0mPU2Po79ViMaX6eaBQLyLJdz0AZhTh+TFmdeHGgFIEULWuFKT0MO10obijyTd244W31IImGVBofiIbGO0xbCzQbXJLAegvLiRiEHJ8KQWJT2BoUHIqEkDy1Ow1+SGrp+yj+uIYnR/Wr4c2hcLaUCaDgKt4erhEaOT6D6+b+4U4hlLy7kRyop7lvFDJxrxm/p4wcpQMpvl3M3faPds6AKvwQKOn9Mz1TujMVW0qGFTVvkjvZmAZ7Ox0zNAvWsZF1Bel2TSu/u1iTTbJigINKhf+ECUJO+QiKn1fDOOMy0reLBvd5Geeko+q0lsf8UyEXKqXy2vCbfK68tKT3mMQXVMEfUOXyZvkL3Kzhryi14UXqcVRchrcIOQJmp3m0/sie81YHG/eGL3msctXJLlNMmNHe0JGyzV7ZAhuNFPFmi4pb5ncHCqB6mzNjRcnemDhp/MG3f3nIesKWGaPYh5BjfzkVIRNJNU96oqUB9QqE+VY3VuI5/6A3sHSMAQUihg2R883rPMGw9cjL6aKF1uwNASDlOsBnTggZ/yzC45HeOVbioYTiz1JxxBTGhi4YVhUaqZ+SJUnMOdQcnSOzL/LnxjoHb3VCKkFIR+4Dorf34fL0PIc6I86g6OAWZLh1MSYnEOfWlmfXT3dLVmSvsPJcRClwwreOBFdoY2V9uueO4pRxjgApBPkoywljrFl3S/EB6jUtEGFarDvByEyw==
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: fbf0ac81-85cd-4a43-e343-08db4596d5cc
X-MS-Exchange-CrossTenant-AuthSource: SN6PR10MB3022.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Apr 2023 14:10:33.8184
 (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: HzIrNTi0dWFLv6FVqxqap7zExmmphW0gtvHOsvjsCUd4I6ufNF7PLvDNxXt/r1Z+oz+Fy7oK7okJ6msu6A0kTA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR10MB6081
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-04-25_06,2023-04-25_01,2023-02-09_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 phishscore=0 bulkscore=0
 mlxlogscore=999 malwarescore=0 mlxscore=0 spamscore=0 adultscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2303200000
 definitions=main-2304250128
X-Proofpoint-GUID: V9ALBE7ECjArrnrEYKvFk5M2NUIC2kRi
X-Proofpoint-ORIG-GUID: V9ALBE7ECjArrnrEYKvFk5M2NUIC2kRi
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 535efc39f7758..a4c880192333e 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;
 }
@@ -7252,4 +7252,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