Received-SPF: pass (google.com: domain of linux-kernel+bounces-190015-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Yang Yang <yang.yang@vivo.com>
To: Jens Axboe <axboe@kernel.dk>,
	Andrew Morton <akpm@linux-foundation.org>,
	Yang Yang <yang.yang@vivo.com>,
	Pavel Begunkov <asml.silence@gmail.com>,
	linux-kernel@vger.kernel.org,
	linux-block@vger.kernel.org
Subject: [RFC PATCH] sbitmap: fix io hung due to race on sbitmap_word::cleared
Date: Mon, 27 May 2024 12:26:50 +0800
Message-Id: <20240527042654.2404-1-yang.yang@vivo.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?chODXHFHATKDubhwM272/6ETJ12MDn7uj46RTKW0k+iQ2XhdMr4wbM0iaUZZ?=
 =?us-ascii?Q?jML+rN8xPiK5rG1IBxqQ3T32tSkT61VVoNxcmyQuZDJjGHvolLidG1efCGYP?=
 =?us-ascii?Q?CUhSB6eLKN9g/wOd5oq68ZVs3/McvtGRK+K62QB+MXiUqlTo6egza7Wub85G?=
 =?us-ascii?Q?GCScfRPpZWkdzZE+6Bwaeg/ZOI7xdTyBsa718pQFsxc7X51KL2VTAU2AgoX4?=
 =?us-ascii?Q?paKs4pYqshrNp4moaZqLyq//mQhQiJnFaDLnnK6ZlVfje5qPat3C80F1UhRp?=
 =?us-ascii?Q?pqWPXyJ4e+Bk8uEFEhtBqmkMWgarESmpZmXXoUQsRk4MFKKAwbNGbk+dTZI9?=
 =?us-ascii?Q?JQaV/JHXp4lKwWzurIBJUykcXHi0jEDM1WgZBry2gKKzEnK/Bt+Ex6NwXprE?=
 =?us-ascii?Q?w6zMR3T9+56aasU27XoA8I9Cafkr31q6c3xUiNA0czSi4xjvhJz+Fo4BRE6A?=
 =?us-ascii?Q?T7Xgp5ouXNUsbA5LN8t3OhvClll4Y9mHbnZG4DLtjkCXV+rUBgurKyy0oCQV?=
 =?us-ascii?Q?n3eUsKz01YP9Xa+CEX2fpxwKlySm2Ln9+sG6fIxSNUAhgN9NzKTUSQMiKAnY?=
 =?us-ascii?Q?V5qtOBZ7KmcDI4Kvg2F8z9r0ap/wiamfGPpou/Hf7jZtqP086wc4iFNSMzNy?=
 =?us-ascii?Q?+PMqYERs6YKsrIMz+RjsXOwDZh4xv7jg9xdcCHMg6EY68pOmNdEBBIcdI6hZ?=
 =?us-ascii?Q?Id16v5kFbH8KXMEQhpKaADzEhuZoqntuabBFOHsbuavJIybtvEpWlLcBdHa1?=
 =?us-ascii?Q?t2nAgOLISIOGhEaySl/3UKP2GD22bf9X06ihTf+oTxDqapRlAeNoB85EzcQM?=
 =?us-ascii?Q?HRSacX8aLNaQD8Y49Nb0qOtaoCBifmGhnZ5NdFAPMgED52k3QLX1CiMSR17C?=
 =?us-ascii?Q?Z3CWVMuJ3AJcWlCzP32vzXZpDFgohybOM1d5KqLF/3hq9euDspLfJoXH8q/L?=
 =?us-ascii?Q?OTmvmAdTy9stRPA7dZgyNoKjgAyKTP3qYLDl4vi0nj2i0jNOmrnWnZFtdy0k?=
 =?us-ascii?Q?WUvB9YOaZLfKqtbzQ4kzmiSTOT6W66l7dshfvUh3e47g4Z8z6N6jxEGhOO+I?=
 =?us-ascii?Q?0NBJ7aRSs0gxeGfBJLIATAsjFcLh4Jqw0Xs60CVtF+L2uRN4tAnL6sEDtcFS?=
 =?us-ascii?Q?YTihvX+zao5Ae/FlnuHgS+VNm0xQMzeSK9uzgL3aKgUf0cZcsTtRI0rt9HGa?=
 =?us-ascii?Q?p4M3izaKaizvzQ5OJFpy3Xi2vM2/n4UCJrA7OSgaNH+JPQnZVJUT05MK8Bff?=
 =?us-ascii?Q?ZxQvm0MRQmMVRcg3svOl0HKqQCWSWzL6banG2TY9i95C3Rb+aObw+5tjd+0k?=
 =?us-ascii?Q?X8Tf8nPKJU0zL6ijnsOKRdj+33m9ssbXuutSKYWYNiPBezIiJDOYRHlrBAAh?=
 =?us-ascii?Q?ajRiJv0S6MM9a5M0e9OSDcJnVsAJBuyzAm5w3lEENHPtCGXw6eBDze8HTD/1?=
 =?us-ascii?Q?u3J8cFXvbC2WPLW6vbRkvvZjblUDR3lSq10oSbd9o8413JXXw+zNzYTXMEoR?=
 =?us-ascii?Q?iRgwj8mwprOggR8XyY0p5zP4T6Ms9W75ljnjOpiWLcF6Mieq6hfLt6pCzoEs?=
 =?us-ascii?Q?lTMdJgy9aw17KnoZFo4WilPiUXKnLBI55+AYiXmV?=
X-OriginatorOrg: vivo.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 63bae6fa-45e8-466e-cf83-08dc7e05773c
X-MS-Exchange-CrossTenant-AuthSource: KL1PR06MB7401.apcprd06.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 May 2024 04:28:32.1549
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 923e42dc-48d5-4cbe-b582-1a797a6412ed
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: LShssbvktRTB7JthA8oXi8f6czC/8QfKv9Yx4cPliuupmhA2FGIPsYUuAwhmNzeGwDz1WpgtUtZXJZjUfS2zoQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SEZPR06MB5504

Configuration for sbq:
  depth=64, wake_batch=6, shift=6, map_nr=1

1. There are 64 requests in progress:
  map->word = 0xFFFFFFFFFFFFFFFF
2. After all the 64 requests complete, and no more requests come:
  map->word = 0xFFFFFFFFFFFFFFFF, map->cleared = 0xFFFFFFFFFFFFFFFF
3. Now two tasks try to allocate requests:
  T1:                                       T2:
  __blk_mq_get_tag                          .
  __sbitmap_queue_get                       .
  sbitmap_get                               .
  sbitmap_find_bit                          .
  sbitmap_find_bit_in_word                  .
  __sbitmap_get_word  -> nr=-1              __blk_mq_get_tag
  sbitmap_deferred_clear                    __sbitmap_queue_get
  /* map->cleared=0xFFFFFFFFFFFFFFFF */     sbitmap_find_bit
    if (!READ_ONCE(map->cleared))           sbitmap_find_bit_in_word
      return false;                         __sbitmap_get_word -> nr=-1
    mask = xchg(&map->cleared, 0)           sbitmap_deferred_clear
    atomic_long_andnot()                    /* map->cleared=0 */
                                              if (!(map->cleared))
                                                return false;
                                     /*
                                      * map->cleared is cleared by T1
                                      * T2 fail to acquire the tag
                                      */

4. T2 is the sole tag waiter. When T1 puts the tag, T2 cannot be woken
up due to the wake_batch being set at 6. If no more requests come, T1
will wait here indefinitely.

Fix this issue by adding a new flag swap_inprogress to indicate whether
the swap is ongoing.

Fixes: 661d4f55a794 ("sbitmap: remove swap_lock")
Signed-off-by: Yang Yang <yang.yang@vivo.com>
---
 include/linux/sbitmap.h |  5 +++++
 lib/sbitmap.c           | 22 ++++++++++++++++++++--
 2 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/include/linux/sbitmap.h b/include/linux/sbitmap.h
index d662cf136021..b88a9e4997ab 100644
--- a/include/linux/sbitmap.h
+++ b/include/linux/sbitmap.h
@@ -36,6 +36,11 @@ struct sbitmap_word {
 	 * @cleared: word holding cleared bits
 	 */
 	unsigned long cleared ____cacheline_aligned_in_smp;
+
+	/**
+	 * @swap_inprogress: set to 1 when swapping word <-> cleared
+	 */
+	atomic_t swap_inprogress;
 } ____cacheline_aligned_in_smp;
 
 /**
diff --git a/lib/sbitmap.c b/lib/sbitmap.c
index 1e453f825c05..d4bb258fe8b0 100644
--- a/lib/sbitmap.c
+++ b/lib/sbitmap.c
@@ -62,10 +62,19 @@ static inline void update_alloc_hint_after_get(struct sbitmap *sb,
  */
 static inline bool sbitmap_deferred_clear(struct sbitmap_word *map)
 {
-	unsigned long mask;
+	unsigned long mask, flags;
+	int zero = 0;
 
-	if (!READ_ONCE(map->cleared))
+	if (!READ_ONCE(map->cleared)) {
+		if (atomic_read(&map->swap_inprogress))
+			goto out_wait;
 		return false;
+	}
+
+	if (!atomic_try_cmpxchg(&map->swap_inprogress, &zero, 1))
+		goto out_wait;
+
+	local_irq_save(flags);
 
 	/*
 	 * First get a stable cleared mask, setting the old mask to 0.
@@ -77,6 +86,15 @@ static inline bool sbitmap_deferred_clear(struct sbitmap_word *map)
 	 */
 	atomic_long_andnot(mask, (atomic_long_t *)&map->word);
 	BUILD_BUG_ON(sizeof(atomic_long_t) != sizeof(map->word));
+
+	atomic_set(&map->swap_inprogress, 0);
+	smp_mb__after_atomic();
+	local_irq_restore(flags);
+	return true;
+
+out_wait:
+	while (atomic_read(&map->swap_inprogress))
+		;
 	return true;
 }
 
-- 
2.34.1