Skip to contentSkip to conversation

scsi: support packing multi-segment in UNMAP command

PATCH Superseded Chao Yu 2 participants 3 messages Jun 15, 2022 – Jun 16, 2022 SCSI

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Chao Yu

author
#0 lore raw

PATCH v3 1/1 scsi: support packing multi-segment in UNMAP command

As SCSI SBC4 specification section 5.30.2 describes that it can support unmapping one or more LBA range in single UNMAP command, however, previously we only pack one LBA range in UNMAP command by default no matter device gives the block limits that says it can support in-batch UNMAP.

This patch tries to set max_discard_segments config according to block limits of device, and supports in-batch UNMAP.

---
v3:
- update commit message.
- clean up codes.

 drivers/scsi/sd.c | 31 ++++++++++++++++++++-----------
 drivers/scsi/sd.h |  1 +
 2 files changed, 21 insertions(+), 11 deletions(-)
drivers/scsi/sd.c +20 -11
index 895b56c8f25e..ab543f027640 100644
@@ -790,6 +790,7 @@ static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
 	q->limits.discard_granularity =
 		max(sdkp->physical_block_size,
 		    sdkp->unmap_granularity * logical_block_size);
+	blk_queue_max_discard_segments(q, sdkp->max_block_desc_count);
 	sdkp->provisioning_mode = mode;
 
 	switch (mode) {
@@ -836,9 +837,10 @@ static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
 	struct scsi_device *sdp = cmd->device;
 	struct request *rq = scsi_cmd_to_rq(cmd);
 	struct scsi_disk *sdkp = scsi_disk(rq->q->disk);
-	u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
-	u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
-	unsigned int data_len = 24;
+	unsigned short segments = blk_rq_nr_discard_segments(rq);
+	unsigned int data_len = 8 + 16 * segments;
+	unsigned int data_offset = 8;
+	struct bio *bio;
 	char *buf;
 
 	rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
@@ -851,13 +853,20 @@ static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
 
 	cmd->cmd_len = 10;
 	cmd->cmnd[0] = UNMAP;
-	cmd->cmnd[8] = 24;
+	cmd->cmnd[8] = data_len;
 
 	buf = bvec_virt(&rq->special_vec);
-	put_unaligned_be16(6 + 16, &buf[0]);
-	put_unaligned_be16(16, &buf[2]);
-	put_unaligned_be64(lba, &buf[8]);
-	put_unaligned_be32(nr_blocks, &buf[16]);
+	put_unaligned_be16(6 + 16 * segments, &buf[0]);
+	put_unaligned_be16(16 * segments, &buf[2]);
+
+	__rq_for_each_bio(bio, rq) {
+		u64 lba = sectors_to_logical(sdp, bio->bi_iter.bi_sector);
+		u32 nr_blocks = sectors_to_logical(sdp, bio_sectors(bio));
+
+		put_unaligned_be64(lba, &buf[data_offset]);
+		put_unaligned_be32(nr_blocks, &buf[data_offset + 8]);
+		data_offset += 16;
+	}
 
 	cmd->allowed = sdkp->max_retries;
 	cmd->transfersize = data_len;
@@ -2862,7 +2871,7 @@ static void sd_read_block_limits(struct scsi_disk *sdkp)
 	sdkp->opt_xfer_blocks = get_unaligned_be32(&vpd->data[12]);
 
 	if (vpd->len >= 64) {
-		unsigned int lba_count, desc_count;
+		unsigned int lba_count;
 
 		sdkp->max_ws_blocks = (u32)get_unaligned_be64(&vpd->data[36]);
 
@@ -2870,9 +2879,9 @@ static void sd_read_block_limits(struct scsi_disk *sdkp)
 			goto out;
 
 		lba_count = get_unaligned_be32(&vpd->data[20]);
-		desc_count = get_unaligned_be32(&vpd->data[24]);
+		sdkp->max_block_desc_count = get_unaligned_be32(&vpd->data[24]);
 
-		if (lba_count && desc_count)
+		if (lba_count && sdkp->max_block_desc_count)
 			sdkp->max_unmap_blocks = lba_count;
 
 		sdkp->unmap_granularity = get_unaligned_be32(&vpd->data[28]);
drivers/scsi/sd.h +1 -0
index 5eea762f84d1..bda9db5e2322 100644
@@ -119,6 +119,7 @@ struct scsi_disk {
 	u32		opt_xfer_blocks;
 	u32		max_ws_blocks;
 	u32		max_unmap_blocks;
+	u32		max_block_desc_count;
 	u32		unmap_granularity;
 	u32		unmap_alignment;
 	u32		index;
Signature · 1 line
2.25.1
#1 lore raw
Quoted 5 lines · Chao Yu

As SCSI SBC4 specification section 5.30.2 describes that it can support unmapping one or more LBA range in single UNMAP command, however, previously we only pack one LBA range in UNMAP command by default no matter device gives the block limits that says it can support in-batch UNMAP.

The above sentence is too long. Please split it.

Quoted 1 line

This patch tries to set max_discard_segments config according to

             ^^^^^^^^^^^^

Consider changing "tries to set" into "sets".

Quoted 1 line

block limits of device, and supports in-batch UNMAP.

Consider changing "in-batch UNMAP" into "unmapping multiple LBA ranges with a single UNMAP command".

drivers/scsi/sd.c static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode) · line 793

Quoted 1 line
drivers/scsi/sd.c +1 -0
+	blk_queue_max_discard_segments(q, sdkp->max_block_desc_count);

sdkp->max_block_desc_count is 32 bits wide while blk_queue_max_discard_segments() accepts an unsigned short as second argument. So the value 0x10002 will be converted into 2, which is not correct. Consider changing the second argument into min(U16_MAX, sdkp->max_block_desc_count).

drivers/scsi/sd.c static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd) · line 842

Quoted 13 lines
  	sdkp->provisioning_mode = mode;
  
  	switch (mode) {
drivers/scsi/sd.c +3 -3
@@ -836,9 +837,10 @@ static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
  	struct scsi_device *sdp = cmd->device;
  	struct request *rq = scsi_cmd_to_rq(cmd);
  	struct scsi_disk *sdkp = scsi_disk(rq->q->disk);
-	u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
-	u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
-	unsigned int data_len = 24;
+	unsigned short segments = blk_rq_nr_discard_segments(rq);
+	unsigned int data_len = 8 + 16 * segments;
+	unsigned int data_offset = 8;

Please rename 'data_offset' into 'descriptor_offset' to match the SBC-4 terminology.

drivers/scsi/sd.c static void sd_read_block_limits(struct scsi_disk *sdkp) · line 2882

Quoted 6 lines
drivers/scsi/sd.c +1 -1
@@ -2870,9 +2879,9 @@ static void sd_read_block_limits(struct scsi_disk *sdkp)
  			goto out;
 
  		lba_count = get_unaligned_be32(&vpd->data[20]);
-		desc_count = get_unaligned_be32(&vpd->data[24]);
+		sdkp->max_block_desc_count = get_unaligned_be32(&vpd->data[24]);

Consider adding /* Extract the MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT. */ above the above statement.

drivers/scsi/sd.h struct scsi_disk { · line 122

Quoted 9 lines
drivers/scsi/sd.h +1 -0
index 5eea762f84d1..bda9db5e2322 100644
@@ -119,6 +119,7 @@ struct scsi_disk {
  	u32		opt_xfer_blocks;
  	u32		max_ws_blocks;
  	u32		max_unmap_blocks;
+	u32		max_block_desc_count;

I do not agree with the choice of the name of this member variable. The name used in SBC-4 is "MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT". Leaving out "unmap" when abbreviating that description into a member name makes it impossible to guess what the purpose of that member variable is.

Thanks,

Bart.

author
#2 lore raw
Quoted 44 lines · Bart Van Assche
Quoted 5 lines · Chao Yu

As SCSI SBC4 specification section 5.30.2 describes that it can support unmapping one or more LBA range in single UNMAP command, however, previously we only pack one LBA range in UNMAP command by default no matter device gives the block limits that says it can support in-batch UNMAP.

The above sentence is too long. Please split it.

Quoted 1 line

This patch tries to set max_discard_segments config according to

             ^^^^^^^^^^^^
Consider changing "tries to set" into "sets".

Quoted 1 line

block limits of device, and supports in-batch UNMAP.

Consider changing "in-batch UNMAP" into "unmapping multiple LBA ranges with a single UNMAP command".

Quoted 1 line

+    blk_queue_max_discard_segments(q, sdkp->max_block_desc_count);

sdkp->max_block_desc_count is 32 bits wide while blk_queue_max_discard_segments() accepts an unsigned short as second argument. So the value 0x10002 will be converted into 2, which is not correct. Consider changing the second argument into min(U16_MAX, sdkp->max_block_desc_count).

drivers/scsi/sd.c static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd) · line 842

Quoted 12 lines

      sdkp->provisioning_mode = mode;
      switch (mode) {

drivers/scsi/sd.c +3 -3
@@ -836,9 +837,10 @@ static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
       struct scsi_device *sdp = cmd->device;
       struct request *rq = scsi_cmd_to_rq(cmd);
       struct scsi_disk *sdkp = scsi_disk(rq->q->disk);
-    u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
-    u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
-    unsigned int data_len = 24;
+    unsigned short segments = blk_rq_nr_discard_segments(rq);
+    unsigned int data_len = 8 + 16 * segments;
+    unsigned int data_offset = 8;

Please rename 'data_offset' into 'descriptor_offset' to match the SBC-4 terminology.

drivers/scsi/sd.c static void sd_read_block_limits(struct scsi_disk *sdkp) · line 2881

Quoted 5 lines
drivers/scsi/sd.c +1 -1
@@ -2870,9 +2879,9 @@ static void sd_read_block_limits(struct scsi_disk *sdkp)
               goto out;
           lba_count = get_unaligned_be32(&vpd->data[20]);
-        desc_count = get_unaligned_be32(&vpd->data[24]);
+        sdkp->max_block_desc_count = get_unaligned_be32(&vpd->data[24]);

Consider adding /* Extract the MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT. */ above the above statement.

Quoted 11 lines

drivers/scsi/sd.h struct scsi_disk { · line 122

Quoted 9 lines
drivers/scsi/sd.h +1 -0
index 5eea762f84d1..bda9db5e2322 100644
@@ -119,6 +119,7 @@ struct scsi_disk {
       u32        opt_xfer_blocks;
       u32        max_ws_blocks;
       u32        max_unmap_blocks;
+    u32        max_block_desc_count;

I do not agree with the choice of the name of this member variable. The name used in SBC-4 is "MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT". Leaving out "unmap" when abbreviating that description into a member name makes it impossible to guess what the purpose of that member variable is.

Agreed, thanks for the review. I've updated the patch as you suggested.

Thanks,

Quoted 4 lines

Thanks,

Bart.