On Wed, Apr 15, 2020 at 06:05:10PM +0900, Johannes Thumshirn wrote:
> Emulate ZONE_APPEND for SCSI disks using a regular WRITE(16) command
> with a start LBA set to the target zone write pointer position.
>
> In order to always know the write pointer position of a sequential write
> zone, the write pointer of all zones is tracked using an array of 32bits
> zone write pointer offset attached to the scsi disk structure. Each
> entry of the array indicate a zone write pointer position relative to
> the zone start sector. The write pointer offsets are maintained in sync
> with the device as follows:
> 1) the write pointer offset of a zone is reset to 0 when a
> REQ_OP_ZONE_RESET command completes.
> 2) the write pointer offset of a zone is set to the zone size when a
> REQ_OP_ZONE_FINISH command completes.
> 3) the write pointer offset of a zone is incremented by the number of
> 512B sectors written when a write, write same or a zone append
> command completes.
> 4) the write pointer offset of all zones is reset to 0 when a
> REQ_OP_ZONE_RESET_ALL command completes.
>
> Since the block layer does not write lock zones for zone append
> commands, to ensure a sequential ordering of the regular write commands
> used for the emulation, the target zone of a zone append command is
> locked when the function sd_zbc_prepare_zone_append() is called from
> sd_setup_read_write_cmnd(). If the zone write lock cannot be obtained
> (e.g. a zone append is in-flight or a regular write has already locked
> the zone), the zone append command dispatching is delayed by returning
> BLK_STS_ZONE_RESOURCE.
>
> To avoid the need for write locking all zones for REQ_OP_ZONE_RESET_ALL
> requests, use a spinlock to protect accesses and modifications of the
> zone write pointer offsets. This spinlock is initialized from sd_probe()
> using the new function sd_zbc_init().
>
> Co-developed-by: Damien Le Moal <Damien.LeMoal@xxxxxxx>
> Signed-off-by: Johannes Thumshirn <johannes.thumshirn@xxxxxxx>
> ---
> drivers/scsi/sd.c | 24 +++-
> drivers/scsi/sd.h | 43 +++++-
> drivers/scsi/sd_zbc.c | 323 ++++++++++++++++++++++++++++++++++++++++--
> 3 files changed, 370 insertions(+), 20 deletions(-)
>
> diff --git a/drivers/scsi/sd.c b/drivers/scsi/sd.c
> index a793cb08d025..66ff5f04c0ce 100644
> --- a/drivers/scsi/sd.c
> +++ b/drivers/scsi/sd.c
> @@ -1206,6 +1206,12 @@ static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
> }
> }
>
> + if (req_op(rq) == REQ_OP_ZONE_APPEND) {
> + ret = sd_zbc_prepare_zone_append(cmd, &lba, nr_blocks);
> + if (ret)
> + return ret;
> + }
> +
> fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
> dix = scsi_prot_sg_count(cmd);
> dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
> @@ -1287,6 +1293,7 @@ static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
> return sd_setup_flush_cmnd(cmd);
> case REQ_OP_READ:
> case REQ_OP_WRITE:
> + case REQ_OP_ZONE_APPEND:
> return sd_setup_read_write_cmnd(cmd);
> case REQ_OP_ZONE_RESET:
> return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
> @@ -2055,7 +2062,7 @@ static int sd_done(struct scsi_cmnd *SCpnt)
>
> out:
> if (sd_is_zoned(sdkp))
> - sd_zbc_complete(SCpnt, good_bytes, &sshdr);
> + good_bytes = sd_zbc_complete(SCpnt, good_bytes, &sshdr);
>
> SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
> "sd_done: completed %d of %d bytes\n",
> @@ -3372,6 +3379,10 @@ static int sd_probe(struct device *dev)
> sdkp->first_scan = 1;
> sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
>
> + error = sd_zbc_init_disk(sdkp);
> + if (error)
> + goto out_free_index;
> +
> sd_revalidate_disk(gd);
>
> gd->flags = GENHD_FL_EXT_DEVT;
> @@ -3409,6 +3420,7 @@ static int sd_probe(struct device *dev)
> out_put:
> put_disk(gd);
> out_free:
> + sd_zbc_release_disk(sdkp);
> kfree(sdkp);
> out:
> scsi_autopm_put_device(sdp);
> @@ -3485,6 +3497,8 @@ static void scsi_disk_release(struct device *dev)
> put_disk(disk);
> put_device(&sdkp->device->sdev_gendev);
>
> + sd_zbc_release_disk(sdkp);
> +
> kfree(sdkp);
> }
>
> @@ -3665,19 +3679,19 @@ static int __init init_sd(void)
> if (!sd_page_pool) {
> printk(KERN_ERR "sd: can't init discard page pool\n");
> err = -ENOMEM;
> - goto err_out_ppool;
> + goto err_out_cdb_pool;
> }
>
> err = scsi_register_driver(&sd_template.gendrv);
> if (err)
> - goto err_out_driver;
> + goto err_out_ppool;
>
> return 0;
>
> -err_out_driver:
> +err_out_ppool:
> mempool_destroy(sd_page_pool);
>
> -err_out_ppool:
> +err_out_cdb_pool:
> mempool_destroy(sd_cdb_pool);
>
> err_out_cache:
> diff --git a/drivers/scsi/sd.h b/drivers/scsi/sd.h
> index 50fff0bf8c8e..6009311105ef 100644
> --- a/drivers/scsi/sd.h
> +++ b/drivers/scsi/sd.h
> @@ -79,6 +79,12 @@ struct scsi_disk {
> u32 zones_optimal_open;
> u32 zones_optimal_nonseq;
> u32 zones_max_open;
> + u32 *zones_wp_ofst;
> + spinlock_t zones_wp_ofst_lock;
> + u32 *rev_wp_ofst;
> + struct mutex rev_mutex;
> + struct work_struct zone_wp_ofst_work;
> + char *zone_wp_update_buf;
> #endif
> atomic_t openers;
> sector_t capacity; /* size in logical blocks */
> @@ -207,17 +213,35 @@ static inline int sd_is_zoned(struct scsi_disk *sdkp)
>
> #ifdef CONFIG_BLK_DEV_ZONED
>
> +int sd_zbc_init_disk(struct scsi_disk *sdkp);
> +void sd_zbc_release_disk(struct scsi_disk *sdkp);
> extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
> extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
> blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
> unsigned char op, bool all);
> -extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
> - struct scsi_sense_hdr *sshdr);
> +unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
> + struct scsi_sense_hdr *sshdr);
> int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
> unsigned int nr_zones, report_zones_cb cb, void *data);
>
> +blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
> + unsigned int nr_blocks);
> +
> #else /* CONFIG_BLK_DEV_ZONED */
>
> +static inline int sd_zbc_init(void)
> +{
> + return 0;
> +}
> +
> +static inline int sd_zbc_init_disk(struct scsi_disk *sdkp)
> +{
> + return 0;
> +}
> +
> +static inline void sd_zbc_exit(void) {}
> +static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
> +
> static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
> unsigned char *buf)
> {
> @@ -233,9 +257,18 @@ static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
> return BLK_STS_TARGET;
> }
>
> -static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
> - unsigned int good_bytes,
> - struct scsi_sense_hdr *sshdr) {}
> +static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
> + unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
> +{
> + return 0;
> +}
> +
> +static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
> + sector_t *lba,
> + unsigned int nr_blocks)
> +{
> + return BLK_STS_TARGET;
> +}
>
> #define sd_zbc_report_zones NULL
>
> diff --git a/drivers/scsi/sd_zbc.c b/drivers/scsi/sd_zbc.c
> index ee156fbf3780..91002720c66c 100644
> --- a/drivers/scsi/sd_zbc.c
> +++ b/drivers/scsi/sd_zbc.c
> @@ -11,6 +11,7 @@
> #include <linux/blkdev.h>
> #include <linux/vmalloc.h>
> #include <linux/sched/mm.h>
> +#include <linux/mutex.h>
>
> #include <asm/unaligned.h>
>
> @@ -19,11 +20,36 @@
>
> #include "sd.h"
>
> +static unsigned int sd_zbc_get_zone_wp_ofst(struct blk_zone *zone)
> +{
> + if (zone->type == ZBC_ZONE_TYPE_CONV)
> + return 0;
> +
> + switch (zone->cond) {
> + case BLK_ZONE_COND_IMP_OPEN:
> + case BLK_ZONE_COND_EXP_OPEN:
> + case BLK_ZONE_COND_CLOSED:
> + return zone->wp - zone->start;
> + case BLK_ZONE_COND_FULL:
> + return zone->len;
> + case BLK_ZONE_COND_EMPTY:
> + case BLK_ZONE_COND_OFFLINE:
> + case BLK_ZONE_COND_READONLY:
> + default:
> + /*
> + * Offline and read-only zones do not have a valid
> + * write pointer. Use 0 as for an empty zone.
> + */
> + return 0;
> + }
> +}
> +
> static int sd_zbc_parse_report(struct scsi_disk *sdkp, u8 *buf,
> unsigned int idx, report_zones_cb cb, void *data)
> {
> struct scsi_device *sdp = sdkp->device;
> struct blk_zone zone = { 0 };
> + int ret;
>
> zone.type = buf[0] & 0x0f;
> zone.cond = (buf[1] >> 4) & 0xf;
> @@ -39,7 +65,14 @@ static int sd_zbc_parse_report(struct scsi_disk *sdkp, u8 *buf,
> zone.cond == ZBC_ZONE_COND_FULL)
> zone.wp = zone.start + zone.len;
>
> - return cb(&zone, idx, data);
> + ret = cb(&zone, idx, data);
> + if (ret)
> + return ret;
> +
> + if (sdkp->rev_wp_ofst)
> + sdkp->rev_wp_ofst[idx] = sd_zbc_get_zone_wp_ofst(&zone);
> +
> + return 0;
> }
>
> /**
> @@ -229,6 +262,116 @@ static blk_status_t sd_zbc_cmnd_checks(struct scsi_cmnd *cmd)
> return BLK_STS_OK;
> }
>
> +#define SD_ZBC_INVALID_WP_OFST (~0u)
> +#define SD_ZBC_UPDATING_WP_OFST (SD_ZBC_INVALID_WP_OFST - 1)
> +
> +static int sd_zbc_update_wp_ofst_cb(struct blk_zone *zone, unsigned int idx,
> + void *data)
> +{
> + struct scsi_disk *sdkp = data;
> +
> + lockdep_assert_held(&sdkp->zones_wp_ofst_lock);
> +
> + sdkp->zones_wp_ofst[idx] = sd_zbc_get_zone_wp_ofst(zone);
> +
> + return 0;
> +}
> +
> +static void sd_zbc_update_wp_ofst_workfn(struct work_struct *work)
> +{
> + struct scsi_disk *sdkp;
> + unsigned int zno;
> + int ret;
> +
> + sdkp = container_of(work, struct scsi_disk, zone_wp_ofst_work);
> +
> + spin_lock_bh(&sdkp->zones_wp_ofst_lock);
> + for (zno = 0; zno < sdkp->nr_zones; zno++) {
> + if (sdkp->zones_wp_ofst[zno] != SD_ZBC_UPDATING_WP_OFST)
> + continue;
> +
> + spin_unlock_bh(&sdkp->zones_wp_ofst_lock);
> + ret = sd_zbc_do_report_zones(sdkp, sdkp->zone_wp_update_buf,
> + SD_BUF_SIZE,
> + zno * sdkp->zone_blocks, true);
> + spin_lock_bh(&sdkp->zones_wp_ofst_lock);
> + if (!ret)
> + sd_zbc_parse_report(sdkp, sdkp->zone_wp_update_buf + 64,
> + zno, sd_zbc_update_wp_ofst_cb,
> + sdkp);
> + }
> + spin_unlock_bh(&sdkp->zones_wp_ofst_lock);
> +
> + scsi_device_put(sdkp->device);
> +}
> +
> +/**
> + * sd_zbc_prepare_zone_append() - Prepare an emulated ZONE_APPEND command.
> + * @cmd: the command to setup
> + * @lba: the LBA to patch
> + * @nr_blocks: the number of LBAs to be written
> + *
> + * Called from sd_setup_read_write_cmnd() for REQ_OP_ZONE_APPEND.
> + * @sd_zbc_prepare_zone_append() handles the necessary zone wrote locking and
> + * patching of the lba for an emulated ZONE_APPEND command.
> + *
> + * In case the cached write pointer offset is %SD_ZBC_INVALID_WP_OFST it will
> + * schedule a REPORT ZONES command and return BLK_STS_IOERR.
> + */
> +blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
> + unsigned int nr_blocks)
> +{
> + struct request *rq = cmd->request;
> + struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
> + unsigned int wp_ofst, zno = blk_rq_zone_no(rq);
> + blk_status_t ret;
> +
> + ret = sd_zbc_cmnd_checks(cmd);
> + if (ret != BLK_STS_OK)
> + return ret;
> +
> + if (!blk_rq_zone_is_seq(rq))
> + return BLK_STS_IOERR;
> +
> + /* Unlock of the write lock will happen in sd_zbc_complete() */
> + if (!blk_req_zone_write_trylock(rq))
> + return BLK_STS_ZONE_RESOURCE;
> +
> + spin_lock_bh(&sdkp->zones_wp_ofst_lock);
> + wp_ofst = sdkp->zones_wp_ofst[zno];
> + switch (wp_ofst) {
> + case SD_ZBC_INVALID_WP_OFST:
> + /*
> + * We are about to schedule work to update a zone write pointer offset,
> + * which will cause the zone append command to be requeued. So make
This adds two lines > 80 chars.
Otherwise this looks good:
Reviewed-by: Christoph Hellwig <hch@xxxxxx>
