1 // SPDX-License-Identifier: GPL-2.0
3 * NVMe ZNS-ZBD command implementation.
4 * Copyright (C) 2021 Western Digital Corporation or its affiliates.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <linux/nvme.h>
8 #include <linux/blkdev.h>
12 * We set the Memory Page Size Minimum (MPSMIN) for target controller to 0
13 * which gets added by 12 in the nvme_enable_ctrl() which results in 2^12 = 4k
14 * as page_shift value. When calculating the ZASL use shift by 12.
16 #define NVMET_MPSMIN_SHIFT 12
18 static inline u8 nvmet_zasl(unsigned int zone_append_sects)
21 * Zone Append Size Limit (zasl) is expressed as a power of 2 value
22 * with the minimum memory page size (i.e. 12) as unit.
24 return ilog2(zone_append_sects >> (NVMET_MPSMIN_SHIFT - 9));
27 static int validate_conv_zones_cb(struct blk_zone *z,
28 unsigned int i, void *data)
30 if (z->type == BLK_ZONE_TYPE_CONVENTIONAL)
35 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns)
37 u8 zasl = nvmet_zasl(bdev_max_zone_append_sectors(ns->bdev));
38 struct gendisk *bd_disk = ns->bdev->bd_disk;
41 if (ns->subsys->zasl) {
42 if (ns->subsys->zasl > zasl)
45 ns->subsys->zasl = zasl;
48 * Generic zoned block devices may have a smaller last zone which is
49 * not supported by ZNS. Exclude zoned drives that have such smaller
52 if (get_capacity(bd_disk) & (bdev_zone_sectors(ns->bdev) - 1))
55 * ZNS does not define a conventional zone type. If the underlying
56 * device has a bitmap set indicating the existence of conventional
57 * zones, reject the device. Otherwise, use report zones to detect if
58 * the device has conventional zones.
60 if (ns->bdev->bd_disk->conv_zones_bitmap)
63 ret = blkdev_report_zones(ns->bdev, 0, bdev_nr_zones(ns->bdev),
64 validate_conv_zones_cb, NULL);
68 ns->blksize_shift = blksize_bits(bdev_logical_block_size(ns->bdev));
73 void nvmet_execute_identify_ctrl_zns(struct nvmet_req *req)
75 u8 zasl = req->sq->ctrl->subsys->zasl;
76 struct nvmet_ctrl *ctrl = req->sq->ctrl;
77 struct nvme_id_ctrl_zns *id;
80 id = kzalloc(sizeof(*id), GFP_KERNEL);
82 status = NVME_SC_INTERNAL;
86 if (ctrl->ops->get_mdts)
87 id->zasl = min_t(u8, ctrl->ops->get_mdts(ctrl), zasl);
91 status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
95 nvmet_req_complete(req, status);
98 void nvmet_execute_identify_ns_zns(struct nvmet_req *req)
100 struct nvme_id_ns_zns *id_zns = NULL;
105 if (le32_to_cpu(req->cmd->identify.nsid) == NVME_NSID_ALL) {
106 req->error_loc = offsetof(struct nvme_identify, nsid);
107 status = NVME_SC_INVALID_NS | NVME_SC_DNR;
111 id_zns = kzalloc(sizeof(*id_zns), GFP_KERNEL);
113 status = NVME_SC_INTERNAL;
117 status = nvmet_req_find_ns(req);
121 if (nvmet_ns_revalidate(req->ns)) {
122 mutex_lock(&req->ns->subsys->lock);
123 nvmet_ns_changed(req->ns->subsys, req->ns->nsid);
124 mutex_unlock(&req->ns->subsys->lock);
127 if (!bdev_is_zoned(req->ns->bdev)) {
128 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
129 req->error_loc = offsetof(struct nvme_identify, nsid);
133 zsze = (bdev_zone_sectors(req->ns->bdev) << 9) >>
134 req->ns->blksize_shift;
135 id_zns->lbafe[0].zsze = cpu_to_le64(zsze);
137 mor = bdev_max_open_zones(req->ns->bdev);
142 id_zns->mor = cpu_to_le32(mor);
144 mar = bdev_max_active_zones(req->ns->bdev);
149 id_zns->mar = cpu_to_le32(mar);
152 status = nvmet_copy_to_sgl(req, 0, id_zns, sizeof(*id_zns));
155 nvmet_req_complete(req, status);
158 static u16 nvmet_bdev_validate_zone_mgmt_recv(struct nvmet_req *req)
160 sector_t sect = nvmet_lba_to_sect(req->ns, req->cmd->zmr.slba);
161 u32 out_bufsize = (le32_to_cpu(req->cmd->zmr.numd) + 1) << 2;
163 if (sect >= get_capacity(req->ns->bdev->bd_disk)) {
164 req->error_loc = offsetof(struct nvme_zone_mgmt_recv_cmd, slba);
165 return NVME_SC_LBA_RANGE | NVME_SC_DNR;
168 if (out_bufsize < sizeof(struct nvme_zone_report)) {
169 req->error_loc = offsetof(struct nvme_zone_mgmt_recv_cmd, numd);
170 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
173 if (req->cmd->zmr.zra != NVME_ZRA_ZONE_REPORT) {
174 req->error_loc = offsetof(struct nvme_zone_mgmt_recv_cmd, zra);
175 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
178 switch (req->cmd->zmr.pr) {
183 req->error_loc = offsetof(struct nvme_zone_mgmt_recv_cmd, pr);
184 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
187 switch (req->cmd->zmr.zrasf) {
188 case NVME_ZRASF_ZONE_REPORT_ALL:
189 case NVME_ZRASF_ZONE_STATE_EMPTY:
190 case NVME_ZRASF_ZONE_STATE_IMP_OPEN:
191 case NVME_ZRASF_ZONE_STATE_EXP_OPEN:
192 case NVME_ZRASF_ZONE_STATE_CLOSED:
193 case NVME_ZRASF_ZONE_STATE_FULL:
194 case NVME_ZRASF_ZONE_STATE_READONLY:
195 case NVME_ZRASF_ZONE_STATE_OFFLINE:
199 offsetof(struct nvme_zone_mgmt_recv_cmd, zrasf);
200 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
203 return NVME_SC_SUCCESS;
206 struct nvmet_report_zone_data {
207 struct nvmet_req *req;
214 static int nvmet_bdev_report_zone_cb(struct blk_zone *z, unsigned i, void *d)
216 static const unsigned int nvme_zrasf_to_blk_zcond[] = {
217 [NVME_ZRASF_ZONE_STATE_EMPTY] = BLK_ZONE_COND_EMPTY,
218 [NVME_ZRASF_ZONE_STATE_IMP_OPEN] = BLK_ZONE_COND_IMP_OPEN,
219 [NVME_ZRASF_ZONE_STATE_EXP_OPEN] = BLK_ZONE_COND_EXP_OPEN,
220 [NVME_ZRASF_ZONE_STATE_CLOSED] = BLK_ZONE_COND_CLOSED,
221 [NVME_ZRASF_ZONE_STATE_READONLY] = BLK_ZONE_COND_READONLY,
222 [NVME_ZRASF_ZONE_STATE_FULL] = BLK_ZONE_COND_FULL,
223 [NVME_ZRASF_ZONE_STATE_OFFLINE] = BLK_ZONE_COND_OFFLINE,
225 struct nvmet_report_zone_data *rz = d;
227 if (rz->zrasf != NVME_ZRASF_ZONE_REPORT_ALL &&
228 z->cond != nvme_zrasf_to_blk_zcond[rz->zrasf])
231 if (rz->nr_zones < rz->out_nr_zones) {
232 struct nvme_zone_descriptor zdesc = { };
235 zdesc.zcap = nvmet_sect_to_lba(rz->req->ns, z->capacity);
236 zdesc.zslba = nvmet_sect_to_lba(rz->req->ns, z->start);
237 zdesc.wp = nvmet_sect_to_lba(rz->req->ns, z->wp);
238 zdesc.za = z->reset ? 1 << 2 : 0;
239 zdesc.zs = z->cond << 4;
242 status = nvmet_copy_to_sgl(rz->req, rz->out_buf_offset, &zdesc,
247 rz->out_buf_offset += sizeof(zdesc);
255 static unsigned long nvmet_req_nr_zones_from_slba(struct nvmet_req *req)
257 unsigned int sect = nvmet_lba_to_sect(req->ns, req->cmd->zmr.slba);
259 return bdev_nr_zones(req->ns->bdev) - bdev_zone_no(req->ns->bdev, sect);
262 static unsigned long get_nr_zones_from_buf(struct nvmet_req *req, u32 bufsize)
264 if (bufsize <= sizeof(struct nvme_zone_report))
267 return (bufsize - sizeof(struct nvme_zone_report)) /
268 sizeof(struct nvme_zone_descriptor);
271 static void nvmet_bdev_zone_zmgmt_recv_work(struct work_struct *w)
273 struct nvmet_req *req = container_of(w, struct nvmet_req, z.zmgmt_work);
274 sector_t start_sect = nvmet_lba_to_sect(req->ns, req->cmd->zmr.slba);
275 unsigned long req_slba_nr_zones = nvmet_req_nr_zones_from_slba(req);
276 u32 out_bufsize = (le32_to_cpu(req->cmd->zmr.numd) + 1) << 2;
280 struct nvmet_report_zone_data rz_data = {
281 .out_nr_zones = get_nr_zones_from_buf(req, out_bufsize),
282 /* leave the place for report zone header */
283 .out_buf_offset = sizeof(struct nvme_zone_report),
284 .zrasf = req->cmd->zmr.zrasf,
289 status = nvmet_bdev_validate_zone_mgmt_recv(req);
293 if (!req_slba_nr_zones) {
294 status = NVME_SC_SUCCESS;
298 ret = blkdev_report_zones(req->ns->bdev, start_sect, req_slba_nr_zones,
299 nvmet_bdev_report_zone_cb, &rz_data);
301 status = NVME_SC_INTERNAL;
306 * When partial bit is set nr_zones must indicate the number of zone
307 * descriptors actually transferred.
309 if (req->cmd->zmr.pr)
310 rz_data.nr_zones = min(rz_data.nr_zones, rz_data.out_nr_zones);
312 nr_zones = cpu_to_le64(rz_data.nr_zones);
313 status = nvmet_copy_to_sgl(req, 0, &nr_zones, sizeof(nr_zones));
316 nvmet_req_complete(req, status);
319 void nvmet_bdev_execute_zone_mgmt_recv(struct nvmet_req *req)
321 INIT_WORK(&req->z.zmgmt_work, nvmet_bdev_zone_zmgmt_recv_work);
322 queue_work(zbd_wq, &req->z.zmgmt_work);
325 static inline enum req_op zsa_req_op(u8 zsa)
329 return REQ_OP_ZONE_OPEN;
330 case NVME_ZONE_CLOSE:
331 return REQ_OP_ZONE_CLOSE;
332 case NVME_ZONE_FINISH:
333 return REQ_OP_ZONE_FINISH;
334 case NVME_ZONE_RESET:
335 return REQ_OP_ZONE_RESET;
341 static u16 blkdev_zone_mgmt_errno_to_nvme_status(int ret)
345 return NVME_SC_SUCCESS;
348 return NVME_SC_ZONE_INVALID_TRANSITION | NVME_SC_DNR;
350 return NVME_SC_INTERNAL;
354 struct nvmet_zone_mgmt_send_all_data {
355 unsigned long *zbitmap;
356 struct nvmet_req *req;
359 static int zmgmt_send_scan_cb(struct blk_zone *z, unsigned i, void *d)
361 struct nvmet_zone_mgmt_send_all_data *data = d;
363 switch (zsa_req_op(data->req->cmd->zms.zsa)) {
364 case REQ_OP_ZONE_OPEN:
366 case BLK_ZONE_COND_CLOSED:
372 case REQ_OP_ZONE_CLOSE:
374 case BLK_ZONE_COND_IMP_OPEN:
375 case BLK_ZONE_COND_EXP_OPEN:
381 case REQ_OP_ZONE_FINISH:
383 case BLK_ZONE_COND_IMP_OPEN:
384 case BLK_ZONE_COND_EXP_OPEN:
385 case BLK_ZONE_COND_CLOSED:
395 set_bit(i, data->zbitmap);
400 static u16 nvmet_bdev_zone_mgmt_emulate_all(struct nvmet_req *req)
402 struct block_device *bdev = req->ns->bdev;
403 unsigned int nr_zones = bdev_nr_zones(bdev);
404 struct bio *bio = NULL;
407 struct nvmet_zone_mgmt_send_all_data d = {
411 d.zbitmap = kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(*(d.zbitmap)),
412 GFP_NOIO, bdev->bd_disk->node_id);
418 /* Scan and build bitmap of the eligible zones */
419 ret = blkdev_report_zones(bdev, 0, nr_zones, zmgmt_send_scan_cb, &d);
420 if (ret != nr_zones) {
425 /* We scanned all the zones */
429 while (sector < bdev_nr_sectors(bdev)) {
430 if (test_bit(disk_zone_no(bdev->bd_disk, sector), d.zbitmap)) {
431 bio = blk_next_bio(bio, bdev, 0,
432 zsa_req_op(req->cmd->zms.zsa) | REQ_SYNC,
434 bio->bi_iter.bi_sector = sector;
435 /* This may take a while, so be nice to others */
438 sector += bdev_zone_sectors(bdev);
442 ret = submit_bio_wait(bio);
449 return blkdev_zone_mgmt_errno_to_nvme_status(ret);
452 static u16 nvmet_bdev_execute_zmgmt_send_all(struct nvmet_req *req)
456 switch (zsa_req_op(req->cmd->zms.zsa)) {
457 case REQ_OP_ZONE_RESET:
458 ret = blkdev_zone_mgmt(req->ns->bdev, REQ_OP_ZONE_RESET, 0,
459 get_capacity(req->ns->bdev->bd_disk));
461 return blkdev_zone_mgmt_errno_to_nvme_status(ret);
463 case REQ_OP_ZONE_OPEN:
464 case REQ_OP_ZONE_CLOSE:
465 case REQ_OP_ZONE_FINISH:
466 return nvmet_bdev_zone_mgmt_emulate_all(req);
468 /* this is needed to quiet compiler warning */
469 req->error_loc = offsetof(struct nvme_zone_mgmt_send_cmd, zsa);
470 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
473 return NVME_SC_SUCCESS;
476 static void nvmet_bdev_zmgmt_send_work(struct work_struct *w)
478 struct nvmet_req *req = container_of(w, struct nvmet_req, z.zmgmt_work);
479 sector_t sect = nvmet_lba_to_sect(req->ns, req->cmd->zms.slba);
480 enum req_op op = zsa_req_op(req->cmd->zms.zsa);
481 struct block_device *bdev = req->ns->bdev;
482 sector_t zone_sectors = bdev_zone_sectors(bdev);
483 u16 status = NVME_SC_SUCCESS;
486 if (op == REQ_OP_LAST) {
487 req->error_loc = offsetof(struct nvme_zone_mgmt_send_cmd, zsa);
488 status = NVME_SC_ZONE_INVALID_TRANSITION | NVME_SC_DNR;
492 /* when select all bit is set slba field is ignored */
493 if (req->cmd->zms.select_all) {
494 status = nvmet_bdev_execute_zmgmt_send_all(req);
498 if (sect >= get_capacity(bdev->bd_disk)) {
499 req->error_loc = offsetof(struct nvme_zone_mgmt_send_cmd, slba);
500 status = NVME_SC_LBA_RANGE | NVME_SC_DNR;
504 if (sect & (zone_sectors - 1)) {
505 req->error_loc = offsetof(struct nvme_zone_mgmt_send_cmd, slba);
506 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
510 ret = blkdev_zone_mgmt(bdev, op, sect, zone_sectors);
512 status = blkdev_zone_mgmt_errno_to_nvme_status(ret);
515 nvmet_req_complete(req, status);
518 void nvmet_bdev_execute_zone_mgmt_send(struct nvmet_req *req)
520 INIT_WORK(&req->z.zmgmt_work, nvmet_bdev_zmgmt_send_work);
521 queue_work(zbd_wq, &req->z.zmgmt_work);
524 static void nvmet_bdev_zone_append_bio_done(struct bio *bio)
526 struct nvmet_req *req = bio->bi_private;
528 if (bio->bi_status == BLK_STS_OK) {
529 req->cqe->result.u64 =
530 nvmet_sect_to_lba(req->ns, bio->bi_iter.bi_sector);
533 nvmet_req_complete(req, blk_to_nvme_status(req, bio->bi_status));
534 nvmet_req_bio_put(req, bio);
537 void nvmet_bdev_execute_zone_append(struct nvmet_req *req)
539 sector_t sect = nvmet_lba_to_sect(req->ns, req->cmd->rw.slba);
540 const blk_opf_t opf = REQ_OP_ZONE_APPEND | REQ_SYNC | REQ_IDLE;
541 u16 status = NVME_SC_SUCCESS;
542 unsigned int total_len = 0;
543 struct scatterlist *sg;
547 /* Request is completed on len mismatch in nvmet_check_transter_len() */
548 if (!nvmet_check_transfer_len(req, nvmet_rw_data_len(req)))
552 nvmet_req_complete(req, 0);
556 if (sect >= get_capacity(req->ns->bdev->bd_disk)) {
557 req->error_loc = offsetof(struct nvme_rw_command, slba);
558 status = NVME_SC_LBA_RANGE | NVME_SC_DNR;
562 if (sect & (bdev_zone_sectors(req->ns->bdev) - 1)) {
563 req->error_loc = offsetof(struct nvme_rw_command, slba);
564 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
568 if (nvmet_use_inline_bvec(req)) {
569 bio = &req->z.inline_bio;
570 bio_init(bio, req->ns->bdev, req->inline_bvec,
571 ARRAY_SIZE(req->inline_bvec), opf);
573 bio = bio_alloc(req->ns->bdev, req->sg_cnt, opf, GFP_KERNEL);
576 bio->bi_end_io = nvmet_bdev_zone_append_bio_done;
577 bio->bi_iter.bi_sector = sect;
578 bio->bi_private = req;
579 if (req->cmd->rw.control & cpu_to_le16(NVME_RW_FUA))
580 bio->bi_opf |= REQ_FUA;
582 for_each_sg(req->sg, sg, req->sg_cnt, sg_cnt) {
583 struct page *p = sg_page(sg);
584 unsigned int l = sg->length;
585 unsigned int o = sg->offset;
588 ret = bio_add_zone_append_page(bio, p, l, o);
589 if (ret != sg->length) {
590 status = NVME_SC_INTERNAL;
593 total_len += sg->length;
596 if (total_len != nvmet_rw_data_len(req)) {
597 status = NVME_SC_INTERNAL | NVME_SC_DNR;
605 nvmet_req_bio_put(req, bio);
607 nvmet_req_complete(req, status);
610 u16 nvmet_bdev_zns_parse_io_cmd(struct nvmet_req *req)
612 struct nvme_command *cmd = req->cmd;
614 switch (cmd->common.opcode) {
615 case nvme_cmd_zone_append:
616 req->execute = nvmet_bdev_execute_zone_append;
618 case nvme_cmd_zone_mgmt_recv:
619 req->execute = nvmet_bdev_execute_zone_mgmt_recv;
621 case nvme_cmd_zone_mgmt_send:
622 req->execute = nvmet_bdev_execute_zone_mgmt_send;
625 return nvmet_bdev_parse_io_cmd(req);