hw/block/nvme: dulbe and dsm support
v3 cover hw/block/nvme: dulbe and dsm support
From: Klaus Jensen <[email protected]>
This adds support for the Deallocated or Unwritten Logical Block error recovery feature as well as the Dataset Management command.
I wanted to add support for the NPDG and NPDA fields such that the host could get a hint on how many blocks to request deallocation of for the deallocation to actually happen, but I cannot find a realiable way to get the actual block size of the underlying device. If it is an image on a file system we could typically use the host page size, but if it is a raw device, we might have 512 byte sectors that we can issue discards on. And QEMU doesn't seem to provide this without root privileges at least.
See the two patches for some gotchas.
I also integrated this into my zoned proposal. I'll spare you the v4, nobody cares anyway. But I put it in my repo[1] for posterity.
[1]: https://irrelevant.dk/g/pci-nvme.git/tag/?h=zoned-v4.
Klaus Jensen (2):
hw/block/nvme: add dulbe support hw/block/nvme: add the dataset management command
hw/block/nvme-ns.h | 4 + hw/block/nvme.h | 2 + include/block/nvme.h | 5 ++ hw/block/nvme-ns.c | 8 +- hw/block/nvme.c | 179 +++++++++++++++++++++++++++++++++++++++++- hw/block/trace-events | 4 + 6 files changed, 197 insertions(+), 5 deletions(-)
Signature · 1 line
2.28.0
PATCH v3 1/2 hw/block/nvme: add dulbe support
From: Klaus Jensen <[email protected]>
Add support for reporting the Deallocated or Unwritten Logical Block Error (DULBE).
Rely on the block status flags reported by the block layer and consider any block with the BDRV_BLOCK_ZERO flag to be deallocated.
Multiple factors affect when a Write Zeroes command result in deallocation of blocks.
* the underlying file system block size
* the blockdev format
* the 'discard' and 'logical_block_size' parameters
format | discard | wz (512b) wz (4kb) wz (64kb)
---------------------------------------------------
qcow2 ignore n n y
qcow2 unmap n n y
raw ignore n y y
raw unmap n y y
So, this works best with an image in raw format and 4kb LBAs, since holes can then be punched on a per-block basis (this assumes a file system with a 4kb block size, YMMV). A qcow2 image, uses a cluster size of 64kb by default and blocks will only be marked deallocated if a full cluster is zeroed or discarded. However, this *is* consistent with the spec since Write Zeroes "should" deallocate the block if the Deallocate attribute is set and "may" deallocate if the Deallocate attribute is not set. Thus, we always try to deallocate (the BDRV_REQ_MAY_UNMAP flag is always set).
--- hw/block/nvme-ns.h | 4 +++ include/block/nvme.h | 5 +++ hw/block/nvme-ns.c | 8 +++-- hw/block/nvme.c | 80 ++++++++++++++++++++++++++++++++++++++++++- hw/block/trace-events | 4 +++ 5 files changed, 97 insertions(+), 4 deletions(-)
hw/block/nvme-ns.h +4 -0
@@ -31,6 +31,10 @@ typedef struct NvmeNamespace {NvmeIdNs id_ns;NvmeNamespaceParams params; + +struct { +uint32_t err_rec; + } features; } NvmeNamespace;static inline uint32_t nvme_nsid (NvmeNamespace *ns)
include/block/nvme.h +5 -0
@@ -687,6 +687,7 @@ enum NvmeStatusCodes {NVME_E2E_REF_ERROR =0x0284 ,NVME_CMP_FAILURE =0x0285 ,NVME_ACCESS_DENIED =0x0286 , +NVME_DULB =0x0287 ,NVME_MORE =0x2000 ,NVME_DNR =0x4000 , NVME_NO_COMPLETE = 0xffff,
@@ -903,6 +904,9 @@ enum NvmeIdCtrlLpa {#define NVME_AEC_NS_ATTR (aec) ((aec >> 8) & 0x1)#define NVME_AEC_FW_ACTIVATION (aec) ((aec >> 9) & 0x1) +#define NVME_ERR_REC_TLER (err_rec) (err_rec & 0xffff) +#define NVME_ERR_REC_DULBE (err_rec) (err_rec & 0x10000) +enum NvmeFeatureIds {NVME_ARBITRATION =0x1 ,NVME_POWER_MANAGEMENT =0x2 ,
@@ -1023,6 +1027,7 @@ enum NvmeNsIdentifierType {#define NVME_ID_NS_NSFEAT_THIN (nsfeat) ((nsfeat & 0x1)) +#define NVME_ID_NS_NSFEAT_DULBE (nsfeat) ((nsfeat >> 2) & 0x1)#define NVME_ID_NS_FLBAS_EXTENDED (flbas) ((flbas >> 4) & 0x1)#define NVME_ID_NS_FLBAS_INDEX (flbas) ((flbas & 0xf))#define NVME_ID_NS_MC_SEPARATE (mc) ((mc >> 1) & 0x1)
hw/block/nvme-ns.c +5 -3
@@ -33,9 +33,7 @@ static void nvme_ns_init(NvmeNamespace *ns)NvmeIdNs *id_ns = &ns->id_ns;int lba_index =NVME_ID_NS_FLBAS_INDEX (ns->id_ns.flbas); -if (blk_get_flags (ns->blkconf.blk) &BDRV_O_UNMAP ) { - ns->id_ns.dlfeat =0x9 ; - } + ns->id_ns.dlfeat =0x9 ; id_ns->lbaf[lba_index].ds =31 -clz32 (ns->blkconf.logical_block_size);
@@ -44,6 +42,9 @@ static void nvme_ns_init(NvmeNamespace *ns)/* no thin provisioning */ id_ns->ncap = id_ns->nsze; id_ns->nuse = id_ns->ncap; + +/* support DULBE */ + id_ns->nsfeat |=0x4 ; }static int nvme_ns_init_blk (NvmeCtrl *n,NvmeNamespace *ns,Error **errp)
@@ -92,6 +93,7 @@ int nvme_ns_setup(NvmeCtrl *n, NvmeNamespace *ns, Error **errp) }nvme_ns_init (ns); +if (nvme_register_namespace (n, ns, errp)) {return -1 ; }
hw/block/nvme.c +79 -1
122 lines not on this page · raw message
hw/block/trace-events +4 -0
@@ -43,6 +43,10 @@ pci_nvme_admin_cmd(uint16_t cid, uint16_t sqid, uint8_t opcode, const char *opna pci_nvme_rw(uint16_t cid, const char *verb, uint32_t nsid, uint32_t nlb, uint64_t count, uint64_t lba) "cid %"PRIu16" opname '%s' nsid %"PRIu32" nlb %"PRIu32" count %"PRIu64" lba 0x%"PRIx64"" pci_nvme_rw_cb(uint16_t cid, const char *blkname) "cid %"PRIu16" blk '%s'" pci_nvme_write_zeroes(uint16_t cid, uint32_t nsid, uint64_t slba, uint32_t nlb) "cid %"PRIu16" nsid %"PRIu32" slba %"PRIu64" nlb %"PRIu32"" +pci_nvme_block_status(int64_t offset, int64_t bytes, int64_t pnum, int ret, bool zeroed) "offset %"PRId64" bytes %"PRId64" pnum %"PRId64" ret 0x%x zeroed %d" +pci_nvme_dsm(uint16_t cid, uint32_t nsid, uint32_t nr, uint32_t attr) "cid %"PRIu16" nsid %"PRIu32" nr %"PRIu32" attr 0x%"PRIx32"" +pci_nvme_dsm_deallocate(uint16_t cid, uint32_t nsid, uint64_t slba, uint32_t nlb) "cid %"PRIu16" nsid %"PRIu32" slba %"PRIu64" nlb %"PRIu32"" +pci_nvme_aio_discard_cb(uint16_t cid) "cid %"PRIu16"" pci_nvme_create_sq(uint64_t addr, uint16_t sqid, uint16_t cqid, uint16_t qsize, uint16_t qflags) "create submission queue, addr=0x%"PRIx64", sqid=%"PRIu16", cqid=%"PRIu16", qsize=%"PRIu16", qflags=%"PRIu16"" pci_nvme_create_cq(uint64_t addr, uint16_t cqid, uint16_t vector, uint16_t size, uint16_t qflags, int ien) "create completion queue, addr=0x%"PRIx64", cqid=%"PRIu16", vector=%"PRIu16", qsize=%"PRIu16", qflags=%"PRIu16", ien=%d" pci_nvme_del_sq(uint16_t qid) "deleting submission queue sqid=%"PRIu16""
Signature · 1 line
2.28.0
PATCH v3 2/2 hw/block/nvme: add the dataset management command
In reply to Klaus JensenFrom: Klaus Jensen <[email protected]>
Add support for the Dataset Management command and the Deallocate attribute. Deallocation results in discards being sent to the underlying block device. Whether of not the blocks are actually deallocated is affected by the same factors as Write Zeroes (see previous commit).
format | discard | dsm (512b) dsm (4kb) dsm (64kb)
------------------------------------------------------
qcow2 ignore n n n
qcow2 unmap n n y
raw ignore n n n
raw unmap n y y
Again, a raw format and 4kb LBAs are preferable.
See NVM Express 1.3d, Section 6.7 ("Dataset Management command").
--- hw/block/nvme.h | 2 + hw/block/nvme.c | 99 ++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 100 insertions(+), 1 deletion(-)
hw/block/nvme.h +2 -0
@@ -28,6 +28,7 @@ typedef struct NvmeRequest {struct NvmeNamespace *ns;BlockAIOCB *aiocb;uint16_t status; +void *opaque;NvmeCqe cqe;NvmeCmd cmd;BlockAcctCookie acct;
@@ -60,6 +61,7 @@ static inline const char *nvme_io_opc_str(uint8_t opc)case NVME_CMD_WRITE :return "NVME_NVM_CMD_WRITE" ;case NVME_CMD_READ :return "NVME_NVM_CMD_READ" ;case NVME_CMD_WRITE_ZEROES :return "NVME_NVM_CMD_WRITE_ZEROES" ; +case NVME_CMD_DSM :return "NVME_NVM_CMD_DSM" ;default :return "NVME_NVM_CMD_UNKNOWN" ; } }
hw/block/nvme.c +98 -1
117 lines not on this page · raw message
Signature · 1 line
2.28.0
Re: [PATCH v3 1/2] hw/block/nvme: add dulbe support
In reply to Klaus JensenQuoted 22 lines · Klaus Jensen
From: Klaus Jensen <[email protected]>
Add support for reporting the Deallocated or Unwritten Logical Block Error (DULBE).
Rely on the block status flags reported by the block layer and consider any block with the
BDRV_BLOCK_ZEROflag to be deallocated.Multiple factors affect when a Write Zeroes command result in deallocation of blocks.
* the underlying file system block size
* the blockdev format
* the 'discard' and 'logical_block_size' parametersformat | discard | wz (512b) wz (4kb) wz (64kb)
---------------------------------------------------
qcow2 ignore n n y
qcow2 unmap n n y
raw ignore n y y
raw unmap n y y
Quoted 9 lines
So, this works best with an image in raw format and 4kb LBAs, since holes can then be punched on a per-block basis (this assumes a file system with a 4kb block size, YMMV). A qcow2 image, uses a cluster size of 64kb by default and blocks will only be marked deallocated if a full cluster is zeroed or discarded. However, this *is* consistent with the spec since Write Zeroes "should" deallocate the block if the Deallocate attribute is set and "may" deallocate if the Deallocate attribute is not set. Thus, we always try to deallocate (the
BDRV_REQ_MAY_UNMAPflag is always set).
This looks fine. The constraints sound reasonable to me.
Re: [PATCH v3 2/2] hw/block/nvme: add the dataset management command
In reply to Klaus JensenQuoted 41 lines · Klaus Jensen
hw/block/nvme.c +41
-0+static void nvme_aio_discard_cb (void *opaque,int ret) +{ +NvmeRequest *req = opaque; +int *discards = req->opaque; + +trace_pci_nvme_aio_discard_cb (nvme_cid (req)); + +if (ret) { + req->status =NVME_INTERNAL_DEV_ERROR ; +trace_pci_nvme_err_aio (nvme_cid (req),strerror (ret), + req->status); + } + +if (discards && --(*discards) >0 ) { +return ; + } + +g_free (req->opaque); + req->opaque =NULL ; + +nvme_enqueue_req_completion (nvme_cq (req), req); +} + +static uint16_t nvme_dsm (NvmeCtrl *n,NvmeRequest *req) +{ +NvmeNamespace *ns = req->ns; +NvmeDsmCmd *dsm = (NvmeDsmCmd *) &req->cmd; +NvmeDsmRange *range =NULL ; +int *discards =NULL ; + +uint32_t attr =le32_to_cpu (dsm->attributes); +uint32_t nr = (le32_to_cpu (dsm->nr) &0xff ) +1 ; + +uint16_t status =NVME_SUCCESS ; + +trace_pci_nvme_dsm (nvme_cid (req),nvme_nsid (ns), nr, attr); + +if (attr &NVME_DSMGMT_AD ) { +int64_t offset; +size_t len; +
hw/block/nvme.c static void nvme_rw_cb(void *opaque, int ret) · line 1012
Quoted 10 lines
hw/block/nvme.c +10
-0+ range =g_new (NvmeDsmRange, nr); + + status =nvme_dma (n, (uint8_t *)range, nr *sizeof (NvmeDsmRange), +DMA_DIRECTION_TO_DEVICE , req); +if (status) { + goto out; + } + + discards =g_new0 (int,1 ); + req->opaque = discards;
I think you need to initialize discards to 1 so that this function is holding a reference on it while the asynchronous part is running. Otherwise, the callback may see 'discards' at 0 and free it while we're trying to discard the next range.
Quoted 14 lines
hw/block/nvme.c +14
-0+ +for (int i =0 ; i < nr; i++) { +uint64_t slba =le64_to_cpu (range[i].slba); +uint32_t nlb =le32_to_cpu (range[i].nlb); + +if (nvme_check_bounds (n, ns, slba, nlb)) { +trace_pci_nvme_err_invalid_lba_range (slba, nlb, + ns->id_ns.nsze); +continue ; + } + +trace_pci_nvme_dsm_deallocate (nvme_cid (req),nvme_nsid (ns), slba, + nlb); +
hw/block/nvme.c static void nvme_rw_cb(void *opaque, int ret) · line 1036
Quoted 10 lines
hw/block/nvme.c +10
-0+ offset =nvme_l2b (ns, slba); + len =nvme_l2b (ns, nlb); + +while (len) { +size_t bytes =MIN (BDRV_REQUEST_MAX_BYTES , len); + +blk_aio_pdiscard (ns->blkconf.blk, offset, bytes, + nvme_aio_discard_cb, req); + + (*discards)++;
The increment ought to be before the aio call so that the _cb can't see the value before it's accounted for.
Quoted 33 lines
hw/block/nvme.c +22
-0+ + offset += bytes; + len -= bytes; + } + } + +if (*discards) { + status =NVME_NO_COMPLETE ; + }else { +g_free (discards); + req->opaque =NULL ; + } + } + +out: +g_free (range); + +return status; +} +static uint16_t nvme_flush (NvmeCtrl *n,NvmeRequest *req) { block_acct_start(blk_get_stats(req->ns->blkconf.blk), &req->acct, 0,@@ -1088,6 +1183,8 @@ static uint16_t nvme_io_cmd(NvmeCtrl *n, NvmeRequest *req)case NVME_CMD_WRITE :case NVME_CMD_READ :return nvme_rw (n, req); +case NVME_CMD_DSM : +return nvme_dsm (n, req);default :trace_pci_nvme_err_invalid_opc (req->cmd.opcode);return NVME_INVALID_OPCODE |NVME_DNR ;
hw/block/nvme.c static void nvme_init_ctrl(NvmeCtrl *n, PCIDevice *pci_dev) · line 2910
Quoted 5 lines
hw/block/nvme.c +1
-1@@ -2810,7 +2907,7 @@ static void nvme_init_ctrl(NvmeCtrl *n, PCIDevice *pci_dev) id->cqes = (0x4 <<4 ) |0x4 ; id->nn =cpu_to_le32 (n->num_namespaces); id->oncs =cpu_to_le16 (NVME_ONCS_WRITE_ZEROES |NVME_ONCS_TIMESTAMP | -NVME_ONCS_FEATURES ); +NVME_ONCS_FEATURES |NVME_ONCS_DSM );
I think we should set ID_NS.NDPG and NDPA since there really is a preferred granularity and alignment.
Quoted 6 lines
hw/block/nvme.c +0
-0id->vwc =0x1 ; id->sgls = cpu_to_le32(NVME_CTRL_SGLS_SUPPORT_NO_ALIGN |Signature · 1 line
2.28.0
Re: [PATCH v3 1/2] hw/block/nvme: add dulbe support
In reply to Klaus JensenQuoted 1 line · Klaus Jensen
+ for (int i = 1; i <=
n->num_namespaces; i++) {
You can call me old-school, but I don't think C should have allowed mixed declarations with code.
Re: [PATCH v3 2/2] hw/block/nvme: add the dataset management command
In reply to Keith BuschQuoted 49 lines · Keith Busch
Quoted 48 lines · Klaus Jensen
hw/block/nvme.c +48
-0+static void nvme_aio_discard_cb (void *opaque,int ret) +{ +NvmeRequest *req = opaque; +int *discards = req->opaque; + +trace_pci_nvme_aio_discard_cb (nvme_cid (req)); + +if (ret) { + req->status =NVME_INTERNAL_DEV_ERROR ; +trace_pci_nvme_err_aio (nvme_cid (req),strerror (ret), + req->status); + } + +if (discards && --(*discards) >0 ) { +return ; + } + +g_free (req->opaque); + req->opaque =NULL ; + +nvme_enqueue_req_completion (nvme_cq (req), req); +} + +static uint16_t nvme_dsm (NvmeCtrl *n,NvmeRequest *req) +{ +NvmeNamespace *ns = req->ns; +NvmeDsmCmd *dsm = (NvmeDsmCmd *) &req->cmd; +NvmeDsmRange *range =NULL ; +int *discards =NULL ; + +uint32_t attr =le32_to_cpu (dsm->attributes); +uint32_t nr = (le32_to_cpu (dsm->nr) &0xff ) +1 ; + +uint16_t status =NVME_SUCCESS ; + +trace_pci_nvme_dsm (nvme_cid (req),nvme_nsid (ns), nr, attr); + +if (attr &NVME_DSMGMT_AD ) { +int64_t offset; +size_t len; + + range =g_new (NvmeDsmRange, nr); + + status =nvme_dma (n, (uint8_t *)range, nr *sizeof (NvmeDsmRange), +DMA_DIRECTION_TO_DEVICE , req); +if (status) { + goto out; + }
Quoted 9 lines
hw/block/nvme.c static void nvme_rw_cb(void *opaque, int ret) · line 1012
Quoted 3 lines
hw/block/nvme.c +3
-0+ + discards =g_new0 (int,1 ); + req->opaque = discards;I think you need to initialize discards to 1 so that this function is holding a reference on it while the asynchronous part is running. Otherwise, the callback may see 'discards' at 0 and free it while we're trying to discard the next range.
Yes - you are right. The callback might actually get called immediately in some cases.
Quoted 19 lines
Quoted 19 lines
hw/block/nvme.c +19
-0+ +for (int i =0 ; i < nr; i++) { +uint64_t slba =le64_to_cpu (range[i].slba); +uint32_t nlb =le32_to_cpu (range[i].nlb); + +if (nvme_check_bounds (n, ns, slba, nlb)) { +trace_pci_nvme_err_invalid_lba_range (slba, nlb, + ns->id_ns.nsze); +continue ; + } + +trace_pci_nvme_dsm_deallocate (nvme_cid (req),nvme_nsid (ns), slba, + nlb); + + offset =nvme_l2b (ns, slba); + len =nvme_l2b (ns, nlb); + +while (len) { +size_t bytes =MIN (BDRV_REQUEST_MAX_BYTES , len);
Quoted 9 lines
hw/block/nvme.c static void nvme_rw_cb(void *opaque, int ret) · line 1036
Quoted 5 lines
hw/block/nvme.c +5
-0+ +blk_aio_pdiscard (ns->blkconf.blk, offset, bytes, + nvme_aio_discard_cb, req); + + (*discards)++;The increment ought to be before the aio call so that the
_cbcan't see the value before it's accounted for.
Right. Same issue as above.
Quoted 7 lines
hw/block/nvme.c static void nvme_rw_cb(void *opaque, int ret) · line 1043
Quoted 7 lines
hw/block/nvme.c +7
-0+ + offset += bytes; + len -= bytes; + } + } + +if (*discards) {
And then we decrement here before checking for 0.
Thanks, looks better now.
Quoted 26 lines
Quoted 26 lines
hw/block/nvme.c +15
-0+ status =NVME_NO_COMPLETE ; + }else { +g_free (discards); + req->opaque =NULL ; + } + } + +out: +g_free (range); + +return status; +} +static uint16_t nvme_flush (NvmeCtrl *n,NvmeRequest *req) { block_acct_start(blk_get_stats(req->ns->blkconf.blk), &req->acct, 0,@@ -1088,6 +1183,8 @@ static uint16_t nvme_io_cmd(NvmeCtrl *n, NvmeRequest *req)case NVME_CMD_WRITE :case NVME_CMD_READ :return nvme_rw (n, req); +case NVME_CMD_DSM : +return nvme_dsm (n, req);default :trace_pci_nvme_err_invalid_opc (req->cmd.opcode);return NVME_INVALID_OPCODE |NVME_DNR ;@@ -2810,7 +2907,7 @@ static void nvme_init_ctrl(NvmeCtrl *n, PCIDevice *pci_dev)
Quoted 9 lines
hw/block/nvme.c static void nvme_init_ctrl(NvmeCtrl *n, PCIDevice *pci_dev) · line 2910
Quoted 5 lines
hw/block/nvme.c +1
-1id->cqes = (0x4 <<4 ) |0x4 ; id->nn =cpu_to_le32 (n->num_namespaces); id->oncs =cpu_to_le16 (NVME_ONCS_WRITE_ZEROES |NVME_ONCS_TIMESTAMP | -NVME_ONCS_FEATURES ); +NVME_ONCS_FEATURES |NVME_ONCS_DSM );I think we should set ID_NS.NDPG and NDPA since there really is a preferred granularity and alignment.
Yeah. I had some issues with doing this reliably. But I think I nailed it, see my v4.
Quoted 6 lines
Quoted 6 lines
hw/block/nvme.c +0
-0id->vwc =0x1 ; id->sgls = cpu_to_le32(NVME_CTRL_SGLS_SUPPORT_NO_ALIGN |Signature · 1 line
2.28.0
Signature · 1 line
One of us - No more doubt, silence or taboo about mental illness.
Re: [PATCH v3 1/2] hw/block/nvme: add dulbe support
In reply to Keith BuschQuoted 5 lines · Keith Busch
Quoted 1 line · Klaus Jensen
+ for (int i = 1; i <=
n->num_namespaces; i++) {You can call me old-school, but I don't think C should have allowed mixed declarations with code.
Since commit 7be41675f7c ("configure: Force the C standard to gnu99") it is acceptable at the maintainer discretion. IOW if you don't want declarations mixed with code, it is fine to ask contributors to not do it in your subsystem.
Regards,
Phil.