From: Nilay Shroff <nilay@linux.ibm.com>
To: kbusch@kernel.org, hch@lst.de, bvanassche@acm.org,
sagi@grimberg.me, axboe@kernel.dk, chaitanyak@nvidia.com
Cc: gjoyce@linux.ibm.com, elver@google.com,
linux-nvme@lists.infradead.org,
Nilay Shroff <nilay@linux.ibm.com>
Subject: [PATCH v2 05/22] nvmet: add context annotation for nvmet_ns::readonly
Date: Wed, 18 Nov 2026 13:04:46 +0530 [thread overview]
Message-ID: <20261118073505.288910-6-nilay@linux.ibm.com> (raw)
In-Reply-To: <20261118073505.288910-1-nilay@linux.ibm.com>
The nvmet_ns::readonly field is protected by nvmet_subsys::lock.
Annotate it with __guarded_by(&subsys->lock) to allow the Clang
context analyzer to validate accesses to this field.
The admin command handlers nvmet_get_feat_write_protect() and
nvmet_set_feat_write_protect() access nvmet_ns::readonly while
holding ns->subsys->lock. However, the context analyzer cannot
recognize that subsys->lock and ns->subsys->lock refer to the
same mutex. Use ns->subsys->lock directly in these functions
to avoid false positive warnings.
The admin identify functions, nvmet_execute_identify_ns() and
nvmet_execute_id_cs_indep() as well as I/O hotpath function
nvmet_io_cmd_check_access() read nvmet_ns::readonly without holding
the lock. These lockless reads may race with updates to the field,
potentially observing a transient value. Such races are acceptable
for these accesses.
Introduce nvmet_ns_readonly() to perform these lockless reads using
data_race(READ_ONCE()). This suppresses KCSAN reports for the
intentional races and informs the context analyzer that the access
is intentionally performed without holding the lock.
Use WRITE_ONCE() for updates to nvmet_ns::readonly in
nvmet_set_feat_write_protect() to pair with the lockless
READ_ONCE() accesses.
Signed-off-by: Nilay Shroff <nilay@linux.ibm.com>
---
drivers/nvme/target/admin-cmd.c | 15 +++++++--------
drivers/nvme/target/core.c | 2 +-
drivers/nvme/target/nvmet.h | 18 +++++++++++++++++-
3 files changed, 25 insertions(+), 10 deletions(-)
diff --git a/drivers/nvme/target/admin-cmd.c b/drivers/nvme/target/admin-cmd.c
index 756bf627c16e..1f553ff3800c 100644
--- a/drivers/nvme/target/admin-cmd.c
+++ b/drivers/nvme/target/admin-cmd.c
@@ -943,7 +943,7 @@ static void nvmet_execute_identify_ns(struct nvmet_req *req)
id->lbaf[0].ms = cpu_to_le16(req->ns->metadata_size);
}
- if (req->ns->readonly)
+ if (nvmet_ns_readonly(req->ns))
id->nsattr |= NVME_NS_ATTR_RO;
done:
if (!status)
@@ -1138,7 +1138,7 @@ static void nvmet_execute_id_cs_indep(struct nvmet_req *req)
id->nstat = NVME_NSTAT_NRDY;
id->anagrpid = cpu_to_le32(req->ns->anagrpid);
id->nmic = NVME_NS_NMIC_SHARED;
- if (req->ns->readonly)
+ if (nvmet_ns_readonly(req->ns))
id->nsattr |= NVME_NS_ATTR_RO;
if (nvmet_ns_bdev(req->ns) && bdev_rot(nvmet_ns_bdev(req->ns)))
id->nsfeat |= NVME_NS_ROTATIONAL;
@@ -1261,13 +1261,13 @@ static u16 nvmet_set_feat_write_protect(struct nvmet_req *req)
mutex_lock(&req->ns->subsys->lock);
switch (write_protect) {
case NVME_NS_WRITE_PROTECT:
- req->ns->readonly = true;
+ WRITE_ONCE(req->ns->readonly, true);
status = nvmet_write_protect_flush_sync(req);
if (status)
- req->ns->readonly = false;
+ WRITE_ONCE(req->ns->readonly, false);
break;
case NVME_NS_NO_WRITE_PROTECT:
- req->ns->readonly = false;
+ WRITE_ONCE(req->ns->readonly, false);
status = 0;
break;
default:
@@ -1458,20 +1458,19 @@ void nvmet_execute_set_features(struct nvmet_req *req)
static u16 nvmet_get_feat_write_protect(struct nvmet_req *req)
{
- struct nvmet_subsys *subsys = nvmet_req_subsys(req);
u32 result;
result = nvmet_req_find_ns(req);
if (result)
return result;
- mutex_lock(&subsys->lock);
+ mutex_lock(&req->ns->subsys->lock);
if (req->ns->readonly == true)
result = NVME_NS_WRITE_PROTECT;
else
result = NVME_NS_NO_WRITE_PROTECT;
nvmet_set_result(req, result);
- mutex_unlock(&subsys->lock);
+ mutex_unlock(&req->ns->subsys->lock);
return 0;
}
diff --git a/drivers/nvme/target/core.c b/drivers/nvme/target/core.c
index 0cf0f311ed10..2c60210c14d6 100644
--- a/drivers/nvme/target/core.c
+++ b/drivers/nvme/target/core.c
@@ -1082,7 +1082,7 @@ static inline u16 nvmet_check_ana_state(struct nvmet_port *port,
static inline u16 nvmet_io_cmd_check_access(struct nvmet_req *req)
{
- if (unlikely(req->ns->readonly)) {
+ if (unlikely(nvmet_ns_readonly(req->ns))) {
switch (req->cmd->common.opcode) {
case nvme_cmd_read:
case nvme_cmd_flush:
diff --git a/drivers/nvme/target/nvmet.h b/drivers/nvme/target/nvmet.h
index 256ffa3c08cc..5598edf53b76 100644
--- a/drivers/nvme/target/nvmet.h
+++ b/drivers/nvme/target/nvmet.h
@@ -155,7 +155,8 @@ struct nvmet_ns {
__guarded_by(&subsys->lock);
struct file *file
__guarded_by(&subsys->lock);
- bool readonly;
+ bool readonly
+ __guarded_by(&subsys->lock);
u32 nsid;
u32 blksize_shift;
loff_t size;
@@ -205,6 +206,21 @@ static inline _type nvmet_ns_##_name(struct nvmet_ns *ns) \
NVMET_NS_ACCESSOR(struct block_device *, bdev)
NVMET_NS_ACCESSOR(struct file *, file)
+/*
+ * These accessors use data_race() and READ_ONCE() marker to allow lockless
+ * access to the corresponding fields. The data_race() also helps silence the
+ * context analyser warning about lockless access to the marked field. Use them
+ * only in code paths where a concurrent update to the field is harmless and
+ * the resulting data race is acceptable.
+ */
+#define NVMET_NS_ACCESSOR_MARKED(_type, _name) \
+static inline _type nvmet_ns_##_name(struct nvmet_ns *ns) \
+{ \
+ return data_race(READ_ONCE(ns->_name)); \
+}
+
+NVMET_NS_ACCESSOR_MARKED(bool, readonly)
+
static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item)
{
return container_of(to_config_group(item), struct nvmet_ns, group);
--
2.53.0
next prev parent reply other threads:[~2026-11-18 7:36 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-18 7:34 [PATCH v2 00/22] nvmet: add context annotation for params in struct nvmet_ns Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 01/22] nvmet: add context annotation for nvmet_ns::bdev Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 02/22] nvmet: fix nvmet_ns::bdev access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 03/22] nvmet: add context annotation for nvmet_ns::file Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 04/22] nvmet: add context annotation for nvmet_ns::bdev_file Nilay Shroff
2026-11-18 7:34 ` Nilay Shroff [this message]
2026-11-18 7:34 ` [PATCH v2 06/22] nvmet: add context annotation for nvmet_ns::blksize_shift Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 07/22] nvmet: add context annotation for nvmet_ns::size Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 09/22] nvmet: add context annotation for nvmet_ns::uuid Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 10/22] nvmet: fix nvmet_ns::uuid access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 11/22] nvmet: add context annotation for nvmet_ns::buffered_io Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 12/22] nvmet: fix nvmet_ns::buffered_io access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 13/22] nvmet: add context annotation for nvmet_ns::enabled Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 14/22] nvmet: fix nvmet_ns::enable access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 15/22] nvmet: add context annotation for nvmet_ns::device_path Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 16/22] nvmet: fix nvmet_ns::device_path access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:34 ` [PATCH v2 17/22] nvmet: add context annotation for PCI P2P parameters in struct nvmet_ns Nilay Shroff
2026-11-18 7:35 ` [PATCH v2 19/22] nvmet: add context annotation for integrity params " Nilay Shroff
2026-11-18 7:35 ` [PATCH v2 20/22] nvmet: add context annotation for nvmet_ns::csi Nilay Shroff
2026-11-18 7:35 ` [PATCH v2 21/22] nvmet: fix nvmet_ns::csi access using nvmet_subsys::lock Nilay Shroff
2026-11-18 7:35 ` [PATCH v2 22/22] nvmet: add context annotation for nvmet_ns::debugfs_dir Nilay Shroff
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261118073505.288910-6-nilay@linux.ibm.com \
--to=nilay@linux.ibm.com \
--cc=axboe@kernel.dk \
--cc=bvanassche@acm.org \
--cc=chaitanyak@nvidia.com \
--cc=elver@google.com \
--cc=gjoyce@linux.ibm.com \
--cc=hch@lst.de \
--cc=kbusch@kernel.org \
--cc=linux-nvme@lists.infradead.org \
--cc=sagi@grimberg.me \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.