Skip to contentSkip to conversation

nvmet: add missing lock around nvmet_ns_changed in nvmet_ns_revalidate

PATCH In review Niels Dossche 2 participants 3 messages Mar 13, 2022 – Mar 14, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 nvmet: add missing lock around nvmet_ns_changed in nvmet_ns_revalidate

nvmet_ns_changed states via lockdep that the ns->subsys->lock must be held. The only caller of nvmet_ns_changed which does not acquire that lock is nvmet_ns_revalidate. nvmet_ns_revalidate has 3 callers, of which 2 do not acquire that lock: nvmet_execute_identify_cns_cs_ns and nvmet_execute_identify_ns. The other caller nvmet_ns_revalidate_size_store does acquire the lock.

The solution is to remove the locking from the one callsite that acquires the lock, and place all the locking necessary for the call to nvmet_ns_changed inside the check in nvmet_ns_revalidate.

Both of those identify functions are called from a common function nvmet_execute_identify, which itself is called indirectly via the req->execute function pointer.

This issue was found using a static type-based analyser and manually verified.

---

Changes in v4:
- do the locking locally unconditionally

Changes in v3:
- improve commit description
- do the locking locally

Changes in v2:
- added sentence about how the issue was found.
- added missing &

 drivers/nvme/target/configfs.c | 3 ---
 drivers/nvme/target/core.c     | 5 ++++-
 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/nvme/target/configfs.c +0 -3
index 091a0ca16361..b67ea5772d99 100644
@@ -580,14 +580,11 @@ static ssize_t nvmet_ns_revalidate_size_store(struct config_item *item,
 	if (!val)
 		return -EINVAL;
 
-	mutex_lock(&ns->subsys->lock);
 	if (!ns->enabled) {
 		pr_err("enable ns before revalidate.\n");
-		mutex_unlock(&ns->subsys->lock);
 		return -EINVAL;
 	}
 	nvmet_ns_revalidate(ns);
-	mutex_unlock(&ns->subsys->lock);
 	return count;
 }
 
drivers/nvme/target/core.c +4 -1
index 5119c687de68..a9a2d2b02dee 100644
@@ -540,8 +540,11 @@ void nvmet_ns_revalidate(struct nvmet_ns *ns)
 	else
 		nvmet_file_ns_revalidate(ns);
 
-	if (oldsize != ns->size)
+	if (oldsize != ns->size) {
+		mutex_lock(&ns->subsys->lock);
 		nvmet_ns_changed(ns->subsys, ns->nsid);
+		mutex_unlock(&ns->subsys->lock);
+	}
 }
 
 int nvmet_ns_enable(struct nvmet_ns *ns)
Signature · 1 line
2.35.1
#1 lore raw

Review

Quoted 10 lines · Niels Dossche
(quoted diff) +0 -3
-	mutex_lock(&ns->subsys->lock);
 	if (!ns->enabled) {
 		pr_err("enable ns before revalidate.\n");
-		mutex_unlock(&ns->subsys->lock);
 		return -EINVAL;
 	}
 	nvmet_ns_revalidate(ns);
-	mutex_unlock(&ns->subsys->lock);
 	return count;
 }

And now we lose the atomicy vs the enabled check. I think we'll need something like:

drivers/nvme/target/admin-cmd.c +5 -1
index 6fb24746de069..46d0dab686dd6 100644
@@ -511,7 +511,11 @@ static void nvmet_execute_identify_ns(struct nvmet_req *req)
 		goto done;
 	}
 
-	nvmet_ns_revalidate(req->ns);
+	if (nvmet_ns_revalidate(req->ns)) {
+		mutex_lock(&req->ns->subsys->lock);
+		nvmet_ns_changed(req->ns->subsys, req->ns->nsid);
+		mutex_unlock(&req->ns->subsys->lock);
+	}
 
 	/*
 	 * nuse = ncap = nsze isn't always true, but we have no way to find
drivers/nvme/target/configfs.c +2 -1
index 091a0ca16361c..06ba477fbf771 100644
@@ -586,7 +586,8 @@ static ssize_t nvmet_ns_revalidate_size_store(struct config_item *item,
 		mutex_unlock(&ns->subsys->lock);
 		return -EINVAL;
 	}
-	nvmet_ns_revalidate(ns);
+	if (nvmet_ns_revalidate(ns))
+		nvmet_ns_changed(ns->subsys, ns->nsid);
 	mutex_unlock(&ns->subsys->lock);
 	return count;
 }
drivers/nvme/target/core.c +2 -3
index 5119c687de683..17cc1cda836cc 100644
@@ -531,7 +531,7 @@ static void nvmet_p2pmem_ns_add_p2p(struct nvmet_ctrl *ctrl,
 		ns->nsid);
 }
 
-void nvmet_ns_revalidate(struct nvmet_ns *ns)
+bool nvmet_ns_revalidate(struct nvmet_ns *ns)
 {
 	loff_t oldsize = ns->size;
 
@@ -540,8 +540,7 @@ void nvmet_ns_revalidate(struct nvmet_ns *ns)
 	else
 		nvmet_file_ns_revalidate(ns);
 
-	if (oldsize != ns->size)
-		nvmet_ns_changed(ns->subsys, ns->nsid);
+	return oldsize != ns->size;
 }
 
 int nvmet_ns_enable(struct nvmet_ns *ns)
drivers/nvme/target/nvmet.h +1 -1
index af193423c10bb..731f529e11a51 100644
@@ -542,7 +542,7 @@ u16 nvmet_file_flush(struct nvmet_req *req);
 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
 void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns);
 int nvmet_file_ns_revalidate(struct nvmet_ns *ns);
-void nvmet_ns_revalidate(struct nvmet_ns *ns);
+bool nvmet_ns_revalidate(struct nvmet_ns *ns);
 u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts);
 
 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns);
drivers/nvme/target/zns.c +5 -1
index 46bc30fe85d2b..56c20502b7ef3 100644
@@ -123,7 +123,11 @@ void nvmet_execute_identify_cns_cs_ns(struct nvmet_req *req)
 		goto done;
 	}
 
-	nvmet_ns_revalidate(req->ns);
+	if (nvmet_ns_revalidate(req->ns)) {
+		mutex_lock(&req->ns->subsys->lock);
+		nvmet_ns_changed(req->ns->subsys, req->ns->nsid);
+		mutex_unlock(&req->ns->subsys->lock);
+	}
 	zsze = (bdev_zone_sectors(req->ns->bdev) << 9) >>
 					req->ns->blksize_shift;
 	id_zns->lbafe[0].zsze = cpu_to_le64(zsze);
#2 lore raw
Quoted 90 lines · Christoph Hellwig

Review

Quoted 10 lines · Niels Dossche
(quoted diff) +0 -3
-	mutex_lock(&ns->subsys->lock);
 	if (!ns->enabled) {
 		pr_err("enable ns before revalidate.\n");
-		mutex_unlock(&ns->subsys->lock);
 		return -EINVAL;
 	}
 	nvmet_ns_revalidate(ns);
-	mutex_unlock(&ns->subsys->lock);
 	return count;
 }

And now we lose the atomicy vs the enabled check. I think we'll need something like:

drivers/nvme/target/admin-cmd.c +5 -1
index 6fb24746de069..46d0dab686dd6 100644
@@ -511,7 +511,11 @@ static void nvmet_execute_identify_ns(struct nvmet_req *req)
 		goto done;
 	}
 
-	nvmet_ns_revalidate(req->ns);
+	if (nvmet_ns_revalidate(req->ns)) {
+		mutex_lock(&req->ns->subsys->lock);
+		nvmet_ns_changed(req->ns->subsys, req->ns->nsid);
+		mutex_unlock(&req->ns->subsys->lock);
+	}
 
 	/*
 	 * nuse = ncap = nsze isn't always true, but we have no way to find
drivers/nvme/target/configfs.c +2 -1
index 091a0ca16361c..06ba477fbf771 100644
@@ -586,7 +586,8 @@ static ssize_t nvmet_ns_revalidate_size_store(struct config_item *item,
 		mutex_unlock(&ns->subsys->lock);
 		return -EINVAL;
 	}
-	nvmet_ns_revalidate(ns);
+	if (nvmet_ns_revalidate(ns))
+		nvmet_ns_changed(ns->subsys, ns->nsid);
 	mutex_unlock(&ns->subsys->lock);
 	return count;
 }
drivers/nvme/target/core.c +2 -3
index 5119c687de683..17cc1cda836cc 100644
@@ -531,7 +531,7 @@ static void nvmet_p2pmem_ns_add_p2p(struct nvmet_ctrl *ctrl,
 		ns->nsid);
 }
 
-void nvmet_ns_revalidate(struct nvmet_ns *ns)
+bool nvmet_ns_revalidate(struct nvmet_ns *ns)
 {
 	loff_t oldsize = ns->size;
 
@@ -540,8 +540,7 @@ void nvmet_ns_revalidate(struct nvmet_ns *ns)
 	else
 		nvmet_file_ns_revalidate(ns);
 
-	if (oldsize != ns->size)
-		nvmet_ns_changed(ns->subsys, ns->nsid);
+	return oldsize != ns->size;
 }
 
 int nvmet_ns_enable(struct nvmet_ns *ns)
drivers/nvme/target/nvmet.h +1 -1
index af193423c10bb..731f529e11a51 100644
@@ -542,7 +542,7 @@ u16 nvmet_file_flush(struct nvmet_req *req);
 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
 void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns);
 int nvmet_file_ns_revalidate(struct nvmet_ns *ns);
-void nvmet_ns_revalidate(struct nvmet_ns *ns);
+bool nvmet_ns_revalidate(struct nvmet_ns *ns);
 u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts);
 
 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns);
drivers/nvme/target/zns.c +0 -0
index 46bc30fe85d2b..56c20502b7ef3 100644
@@ -123,7 +123,11 @@ void nvmet_execute_identify_cns_cs_ns(struct nvmet_req *req)
 		goto done;
 	}

drivers/nvme/target/zns.c void nvmet_execute_identify_cns_cs_ns(struct nvmet_req *req) · line 133

Quoted 10 lines
drivers/nvme/target/zns.c +5 -1
 
-	nvmet_ns_revalidate(req->ns);
+	if (nvmet_ns_revalidate(req->ns)) {
+		mutex_lock(&req->ns->subsys->lock);
+		nvmet_ns_changed(req->ns->subsys, req->ns->nsid);
+		mutex_unlock(&req->ns->subsys->lock);
+	}
 	zsze = (bdev_zone_sectors(req->ns->bdev) << 9) >>
 					req->ns->blksize_shift;
 	id_zns->lbafe[0].zsze = cpu_to_le64(zsze);

Thank you for your time, this seems like a nice solution.