lightnvm: move bad block and chunk state logic to core

pblk implements two data paths for recovery line state. One for 1.2
and another for 2.0, instead of having pblk implement these, combine
them in the core to reduce complexity and make available to other
targets.

The new interface will adhere to the 2.0 chunk definition,
including managing open chunks with an active write pointer. To provide
this interface, a 1.2 device recovers the state of the chunks by
manually detecting if a chunk is either free/open/close/offline, and if
open, scanning the flash pages sequentially to find the next writeable
page. This process takes on average ~10 seconds on a device with 64 dies,
1024 blocks and 60us read access time. The process can be parallelized
but is left out for maintenance simplicity, as the 1.2 specification is
deprecated. For 2.0 devices, the logic is maintained internally in the
drive and retrieved through the 2.0 interface.

Signed-off-by: Matias Bjørling <mb@lightnvm.io>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

5 files changed, 260 insertions, 177 deletions

diff --git a/drivers/lightnvm/core.c b/drivers/lightnvm/core.c
index 964352720a03..8df188e0767e 100644
--- a/drivers/lightnvm/core.c
+++ b/drivers/lightnvm/core.c
@@ -717,46 +717,6 @@ static void nvm_free_rqd_ppalist(struct nvm_tgt_dev *tgt_dev,
         nvm_dev_dma_free(tgt_dev->parent, rqd->ppa_list, rqd->dma_ppa_list);
 }
 
-int nvm_get_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct nvm_chk_meta *meta,
-                struct ppa_addr ppa, int nchks)
-{
-        struct nvm_dev *dev = tgt_dev->parent;
-
-        nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
-
-        return dev->ops->get_chk_meta(tgt_dev->parent, meta,
-                                                (sector_t)ppa.ppa, nchks);
-}
-EXPORT_SYMBOL(nvm_get_chunk_meta);
-
-int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
-                       int nr_ppas, int type)
-{
-        struct nvm_dev *dev = tgt_dev->parent;
-        struct nvm_rq rqd;
-        int ret;
-
-        if (nr_ppas > NVM_MAX_VLBA) {
-                pr_err("nvm: unable to update all blocks atomically\n");
-                return -EINVAL;
-        }
-
-        memset(&rqd, 0, sizeof(struct nvm_rq));
-
-        nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas);
-        nvm_rq_tgt_to_dev(tgt_dev, &rqd);
-
-        ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
-        nvm_free_rqd_ppalist(tgt_dev, &rqd);
-        if (ret) {
-                pr_err("nvm: failed bb mark\n");
-                return -EINVAL;
-        }
-
-        return 0;
-}
-EXPORT_SYMBOL(nvm_set_tgt_bb_tbl);
-
 static int nvm_set_flags(struct nvm_geo *geo, struct nvm_rq *rqd)
 {
         int flags = 0;
@@ -830,27 +790,159 @@ void nvm_end_io(struct nvm_rq *rqd)
 }
 EXPORT_SYMBOL(nvm_end_io);
 
+static int nvm_submit_io_sync_raw(struct nvm_dev *dev, struct nvm_rq *rqd)
+{
+        if (!dev->ops->submit_io_sync)
+                return -ENODEV;
+
+        rqd->flags = nvm_set_flags(&dev->geo, rqd);
+
+        return dev->ops->submit_io_sync(dev, rqd);
+}
+
+static int nvm_bb_chunk_sense(struct nvm_dev *dev, struct ppa_addr ppa)
+{
+        struct nvm_rq rqd = { NULL };
+        struct bio bio;
+        struct bio_vec bio_vec;
+        struct page *page;
+        int ret;
+
+        page = alloc_page(GFP_KERNEL);
+        if (!page)
+                return -ENOMEM;
+
+        bio_init(&bio, &bio_vec, 1);
+        bio_add_page(&bio, page, PAGE_SIZE, 0);
+        bio_set_op_attrs(&bio, REQ_OP_READ, 0);
+
+        rqd.bio = &bio;
+        rqd.opcode = NVM_OP_PREAD;
+        rqd.is_seq = 1;
+        rqd.nr_ppas = 1;
+        rqd.ppa_addr = generic_to_dev_addr(dev, ppa);
+
+        ret = nvm_submit_io_sync_raw(dev, &rqd);
+        if (ret)
+                return ret;
+
+        __free_page(page);
+
+        return rqd.error;
+}
+
 /*
- * folds a bad block list from its plane representation to its virtual
- * block representation. The fold is done in place and reduced size is
- * returned.
- *
- * If any of the planes status are bad or grown bad block, the virtual block
- * is marked bad. If not bad, the first plane state acts as the block state.
+ * Scans a 1.2 chunk first and last page to determine if its state.
+ * If the chunk is found to be open, also scan it to update the write
+ * pointer.
  */
-int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
+static int nvm_bb_chunk_scan(struct nvm_dev *dev, struct ppa_addr ppa,
+                             struct nvm_chk_meta *meta)
 {
         struct nvm_geo *geo = &dev->geo;
-        int blk, offset, pl, blktype;
+        int ret, pg, pl;
 
-        if (nr_blks != geo->num_chk * geo->pln_mode)
-                return -EINVAL;
+        /* sense first page */
+        ret = nvm_bb_chunk_sense(dev, ppa);
+        if (ret < 0) /* io error */
+                return ret;
+        else if (ret == 0) /* valid data */
+                meta->state = NVM_CHK_ST_OPEN;
+        else if (ret > 0) {
+                /*
+                 * If empty page, the chunk is free, else it is an
+                 * actual io error. In that case, mark it offline.
+                 */
+                switch (ret) {
+                case NVM_RSP_ERR_EMPTYPAGE:
+                        meta->state = NVM_CHK_ST_FREE;
+                        return 0;
+                case NVM_RSP_ERR_FAILCRC:
+                case NVM_RSP_ERR_FAILECC:
+                case NVM_RSP_WARN_HIGHECC:
+                        meta->state = NVM_CHK_ST_OPEN;
+                        goto scan;
+                default:
+                        return -ret; /* other io error */
+                }
+        }
+
+        /* sense last page */
+        ppa.g.pg = geo->num_pg - 1;
+        ppa.g.pl = geo->num_pln - 1;
+
+        ret = nvm_bb_chunk_sense(dev, ppa);
+        if (ret < 0) /* io error */
+                return ret;
+        else if (ret == 0) { /* Chunk fully written */
+                meta->state = NVM_CHK_ST_CLOSED;
+                meta->wp = geo->clba;
+                return 0;
+        } else if (ret > 0) {
+                switch (ret) {
+                case NVM_RSP_ERR_EMPTYPAGE:
+                case NVM_RSP_ERR_FAILCRC:
+                case NVM_RSP_ERR_FAILECC:
+                case NVM_RSP_WARN_HIGHECC:
+                        meta->state = NVM_CHK_ST_OPEN;
+                        break;
+                default:
+                        return -ret; /* other io error */
+                }
+        }
+
+scan:
+        /*
+         * chunk is open, we scan sequentially to update the write pointer.
+         * We make the assumption that targets write data across all planes
+         * before moving to the next page.
+         */
+        for (pg = 0; pg < geo->num_pg; pg++) {
+                for (pl = 0; pl < geo->num_pln; pl++) {
+                        ppa.g.pg = pg;
+                        ppa.g.pl = pl;
+
+                        ret = nvm_bb_chunk_sense(dev, ppa);
+                        if (ret < 0) /* io error */
+                                return ret;
+                        else if (ret == 0) {
+                                meta->wp += geo->ws_min;
+                        } else if (ret > 0) {
+                                switch (ret) {
+                                case NVM_RSP_ERR_EMPTYPAGE:
+                                        return 0;
+                                case NVM_RSP_ERR_FAILCRC:
+                                case NVM_RSP_ERR_FAILECC:
+                                case NVM_RSP_WARN_HIGHECC:
+                                        meta->wp += geo->ws_min;
+                                        break;
+                                default:
+                                        return -ret; /* other io error */
+                                }
+                        }
+                }
+        }
+
+        return 0;
+}
+
+/*
+ * folds a bad block list from its plane representation to its
+ * chunk representation.
+ *
+ * If any of the planes status are bad or grown bad, the chunk is marked
+ * offline. If not bad, the first plane state acts as the chunk state.
+ */
+static int nvm_bb_to_chunk(struct nvm_dev *dev, struct ppa_addr ppa,
+                           u8 *blks, int nr_blks, struct nvm_chk_meta *meta)
+{
+        struct nvm_geo *geo = &dev->geo;
+        int ret, blk, pl, offset, blktype;
 
         for (blk = 0; blk < geo->num_chk; blk++) {
                 offset = blk * geo->pln_mode;
                 blktype = blks[offset];
 
-                /* Bad blocks on any planes take precedence over other types */
                 for (pl = 0; pl < geo->pln_mode; pl++) {
                         if (blks[offset + pl] &
                                         (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
@@ -859,23 +951,124 @@ int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
                         }
                 }
 
-                blks[blk] = blktype;
+                ppa.g.blk = blk;
+
+                meta->wp = 0;
+                meta->type = NVM_CHK_TP_W_SEQ;
+                meta->wi = 0;
+                meta->slba = generic_to_dev_addr(dev, ppa).ppa;
+                meta->cnlb = dev->geo.clba;
+
+                if (blktype == NVM_BLK_T_FREE) {
+                        ret = nvm_bb_chunk_scan(dev, ppa, meta);
+                        if (ret)
+                                return ret;
+                } else {
+                        meta->state = NVM_CHK_ST_OFFLINE;
+                }
+
+                meta++;
         }
 
-        return geo->num_chk;
+        return 0;
+}
+
+static int nvm_get_bb_meta(struct nvm_dev *dev, sector_t slba,
+                           int nchks, struct nvm_chk_meta *meta)
+{
+        struct nvm_geo *geo = &dev->geo;
+        struct ppa_addr ppa;
+        u8 *blks;
+        int ch, lun, nr_blks;
+        int ret;
+
+        ppa.ppa = slba;
+        ppa = dev_to_generic_addr(dev, ppa);
+
+        if (ppa.g.blk != 0)
+                return -EINVAL;
+
+        if ((nchks % geo->num_chk) != 0)
+                return -EINVAL;
+
+        nr_blks = geo->num_chk * geo->pln_mode;
+
+        blks = kmalloc(nr_blks, GFP_KERNEL);
+        if (!blks)
+                return -ENOMEM;
+
+        for (ch = ppa.g.ch; ch < geo->num_ch; ch++) {
+                for (lun = ppa.g.lun; lun < geo->num_lun; lun++) {
+                        struct ppa_addr ppa_gen, ppa_dev;
+
+                        if (!nchks)
+                                goto done;
+
+                        ppa_gen.ppa = 0;
+                        ppa_gen.g.ch = ch;
+                        ppa_gen.g.lun = lun;
+                        ppa_dev = generic_to_dev_addr(dev, ppa_gen);
+
+                        ret = dev->ops->get_bb_tbl(dev, ppa_dev, blks);
+                        if (ret)
+                                goto done;
+
+                        ret = nvm_bb_to_chunk(dev, ppa_gen, blks, nr_blks,
+                                                                        meta);
+                        if (ret)
+                                goto done;
+
+                        meta += geo->num_chk;
+                        nchks -= geo->num_chk;
+                }
+        }
+done:
+        kfree(blks);
+        return ret;
 }
-EXPORT_SYMBOL(nvm_bb_tbl_fold);
 
-int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
-                       u8 *blks)
+int nvm_get_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
+                       int nchks, struct nvm_chk_meta *meta)
 {
         struct nvm_dev *dev = tgt_dev->parent;
 
         nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
 
-        return dev->ops->get_bb_tbl(dev, ppa, blks);
+        if (dev->geo.version == NVM_OCSSD_SPEC_12)
+                return nvm_get_bb_meta(dev, (sector_t)ppa.ppa, nchks, meta);
+
+        return dev->ops->get_chk_meta(dev, (sector_t)ppa.ppa, nchks, meta);
+}
+EXPORT_SYMBOL_GPL(nvm_get_chunk_meta);
+
+int nvm_set_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
+                       int nr_ppas, int type)
+{
+        struct nvm_dev *dev = tgt_dev->parent;
+        struct nvm_rq rqd;
+        int ret;
+
+        if (dev->geo.version == NVM_OCSSD_SPEC_20)
+                return 0;
+
+        if (nr_ppas > NVM_MAX_VLBA) {
+                pr_err("nvm: unable to update all blocks atomically\n");
+                return -EINVAL;
+        }
+
+        memset(&rqd, 0, sizeof(struct nvm_rq));
+
+        nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas);
+        nvm_rq_tgt_to_dev(tgt_dev, &rqd);
+
+        ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
+        nvm_free_rqd_ppalist(tgt_dev, &rqd);
+        if (ret)
+                return -EINVAL;
+
+        return 0;
 }
-EXPORT_SYMBOL(nvm_get_tgt_bb_tbl);
+EXPORT_SYMBOL_GPL(nvm_set_chunk_meta);
 
 static int nvm_core_init(struct nvm_dev *dev)
 {
diff --git a/drivers/lightnvm/pblk-core.c b/drivers/lightnvm/pblk-core.c
index 72de7456845b..e0b513d07e14 100644
--- a/drivers/lightnvm/pblk-core.c
+++ b/drivers/lightnvm/pblk-core.c
@@ -27,7 +27,7 @@ static void pblk_line_mark_bb(struct work_struct *work)
         struct ppa_addr *ppa = line_ws->priv;
         int ret;
 
-        ret = nvm_set_tgt_bb_tbl(dev, ppa, 1, NVM_BLK_T_GRWN_BAD);
+        ret = nvm_set_chunk_meta(dev, ppa, 1, NVM_BLK_T_GRWN_BAD);
         if (ret) {
                 struct pblk_line *line;
                 int pos;
@@ -110,7 +110,7 @@ static void pblk_end_io_erase(struct nvm_rq *rqd)
  *
  * The caller is responsible for freeing the returned structure
  */
-struct nvm_chk_meta *pblk_chunk_get_info(struct pblk *pblk)
+struct nvm_chk_meta *pblk_get_chunk_meta(struct pblk *pblk)
 {
         struct nvm_tgt_dev *dev = pblk->dev;
         struct nvm_geo *geo = &dev->geo;
@@ -126,7 +126,7 @@ struct nvm_chk_meta *pblk_chunk_get_info(struct pblk *pblk)
         if (!meta)
                 return ERR_PTR(-ENOMEM);
 
-        ret = nvm_get_chunk_meta(dev, meta, ppa, geo->all_chunks);
+        ret = nvm_get_chunk_meta(dev, ppa, geo->all_chunks, meta);
         if (ret) {
                 kfree(meta);
                 return ERR_PTR(-EIO);
diff --git a/drivers/lightnvm/pblk-init.c b/drivers/lightnvm/pblk-init.c
index 039f62d05e84..53bd52114aee 100644
--- a/drivers/lightnvm/pblk-init.c
+++ b/drivers/lightnvm/pblk-init.c
@@ -540,67 +540,6 @@ static void pblk_lines_free(struct pblk *pblk)
         kfree(pblk->lines);
 }
 
-static int pblk_bb_get_tbl(struct nvm_tgt_dev *dev, struct pblk_lun *rlun,
-                           u8 *blks, int nr_blks)
-{
-        struct ppa_addr ppa;
-        int ret;
-
-        ppa.ppa = 0;
-        ppa.g.ch = rlun->bppa.g.ch;
-        ppa.g.lun = rlun->bppa.g.lun;
-
-        ret = nvm_get_tgt_bb_tbl(dev, ppa, blks);
-        if (ret)
-                return ret;
-
-        nr_blks = nvm_bb_tbl_fold(dev->parent, blks, nr_blks);
-        if (nr_blks < 0)
-                return -EIO;
-
-        return 0;
-}
-
-static void *pblk_bb_get_meta(struct pblk *pblk)
-{
-        struct nvm_tgt_dev *dev = pblk->dev;
-        struct nvm_geo *geo = &dev->geo;
-        u8 *meta;
-        int i, nr_blks, blk_per_lun;
-        int ret;
-
-        blk_per_lun = geo->num_chk * geo->pln_mode;
-        nr_blks = blk_per_lun * geo->all_luns;
-
-        meta = kmalloc(nr_blks, GFP_KERNEL);
-        if (!meta)
-                return ERR_PTR(-ENOMEM);
-
-        for (i = 0; i < geo->all_luns; i++) {
-                struct pblk_lun *rlun = &pblk->luns[i];
-                u8 *meta_pos = meta + i * blk_per_lun;
-
-                ret = pblk_bb_get_tbl(dev, rlun, meta_pos, blk_per_lun);
-                if (ret) {
-                        kfree(meta);
-                        return ERR_PTR(-EIO);
-                }
-        }
-
-        return meta;
-}
-
-static void *pblk_chunk_get_meta(struct pblk *pblk)
-{
-        struct nvm_tgt_dev *dev = pblk->dev;
-        struct nvm_geo *geo = &dev->geo;
-
-        if (geo->version == NVM_OCSSD_SPEC_12)
-                return pblk_bb_get_meta(pblk);
-        else
-                return pblk_chunk_get_info(pblk);
-}
-
 static int pblk_luns_init(struct pblk *pblk)
 {
         struct nvm_tgt_dev *dev = pblk->dev;
@@ -699,51 +638,7 @@ static void pblk_set_provision(struct pblk *pblk, long nr_free_blks)
         atomic_set(&pblk->rl.free_user_blocks, nr_free_blks);
 }
 
-static int pblk_setup_line_meta_12(struct pblk *pblk, struct pblk_line *line,
-                                   void *chunk_meta)
-{
-        struct nvm_tgt_dev *dev = pblk->dev;
-        struct nvm_geo *geo = &dev->geo;
-        struct pblk_line_meta *lm = &pblk->lm;
-        int i, chk_per_lun, nr_bad_chks = 0;
-
-        chk_per_lun = geo->num_chk * geo->pln_mode;
-
-        for (i = 0; i < lm->blk_per_line; i++) {
-                struct pblk_lun *rlun = &pblk->luns[i];
-                struct nvm_chk_meta *chunk;
-                int pos = pblk_ppa_to_pos(geo, rlun->bppa);
-                u8 *lun_bb_meta = chunk_meta + pos * chk_per_lun;
-
-                chunk = &line->chks[pos];
-
-                /*
-                 * In 1.2 spec. chunk state is not persisted by the device. Thus
-                 * some of the values are reset each time pblk is instantiated,
-                 * so we have to assume that the block is closed.
-                 */
-                if (lun_bb_meta[line->id] == NVM_BLK_T_FREE)
-                        chunk->state =  NVM_CHK_ST_CLOSED;
-                else
-                        chunk->state = NVM_CHK_ST_OFFLINE;
-
-                chunk->type = NVM_CHK_TP_W_SEQ;
-                chunk->wi = 0;
-                chunk->slba = -1;
-                chunk->cnlb = geo->clba;
-                chunk->wp = 0;
-
-                if (!(chunk->state & NVM_CHK_ST_OFFLINE))
-                        continue;
-
-                set_bit(pos, line->blk_bitmap);
-                nr_bad_chks++;
-        }
-
-        return nr_bad_chks;
-}
-
-static int pblk_setup_line_meta_20(struct pblk *pblk, struct pblk_line *line,
+static int pblk_setup_line_meta_chk(struct pblk *pblk, struct pblk_line *line,
                                    struct nvm_chk_meta *meta)
 {
         struct nvm_tgt_dev *dev = pblk->dev;
@@ -790,8 +685,6 @@ static int pblk_setup_line_meta_20(struct pblk *pblk, struct pblk_line *line,
 static long pblk_setup_line_meta(struct pblk *pblk, struct pblk_line *line,
                                  void *chunk_meta, int line_id)
 {
-        struct nvm_tgt_dev *dev = pblk->dev;
-        struct nvm_geo *geo = &dev->geo;
         struct pblk_line_mgmt *l_mg = &pblk->l_mg;
         struct pblk_line_meta *lm = &pblk->lm;
         long nr_bad_chks, chk_in_line;
@@ -804,10 +697,7 @@ static long pblk_setup_line_meta(struct pblk *pblk, struct pblk_line *line,
         line->vsc = &l_mg->vsc_list[line_id];
         spin_lock_init(&line->lock);
 
-        if (geo->version == NVM_OCSSD_SPEC_12)
-                nr_bad_chks = pblk_setup_line_meta_12(pblk, line, chunk_meta);
-        else
-                nr_bad_chks = pblk_setup_line_meta_20(pblk, line, chunk_meta);
+        nr_bad_chks = pblk_setup_line_meta_chk(pblk, line, chunk_meta);
 
         chk_in_line = lm->blk_per_line - nr_bad_chks;
         if (nr_bad_chks < 0 || nr_bad_chks > lm->blk_per_line ||
@@ -1058,7 +948,7 @@ static int pblk_lines_init(struct pblk *pblk)
         if (ret)
                 goto fail_free_meta;
 
-        chunk_meta = pblk_chunk_get_meta(pblk);
+        chunk_meta = pblk_get_chunk_meta(pblk);
         if (IS_ERR(chunk_meta)) {
                 ret = PTR_ERR(chunk_meta);
                 goto fail_free_luns;
diff --git a/drivers/lightnvm/pblk.h b/drivers/lightnvm/pblk.h
index 48b3035df3c4..579b4ea9716c 100644
--- a/drivers/lightnvm/pblk.h
+++ b/drivers/lightnvm/pblk.h
@@ -774,7 +774,7 @@ void pblk_set_sec_per_write(struct pblk *pblk, int sec_per_write);
 int pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
                         struct pblk_c_ctx *c_ctx);
 void pblk_discard(struct pblk *pblk, struct bio *bio);
-struct nvm_chk_meta *pblk_chunk_get_info(struct pblk *pblk);
+struct nvm_chk_meta *pblk_get_chunk_meta(struct pblk *pblk);
 struct nvm_chk_meta *pblk_chunk_get_off(struct pblk *pblk,
                                               struct nvm_chk_meta *lp,
                                               struct ppa_addr ppa);
diff --git a/drivers/nvme/host/lightnvm.c b/drivers/nvme/host/lightnvm.c
index 1e4f97538838..e42af7771fe5 100644
--- a/drivers/nvme/host/lightnvm.c
+++ b/drivers/nvme/host/lightnvm.c
@@ -567,8 +567,8 @@ static int nvme_nvm_set_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr *ppas,
  * Expect the lba in device format
  */
 static int nvme_nvm_get_chk_meta(struct nvm_dev *ndev,
-                                 struct nvm_chk_meta *meta,
-                                 sector_t slba, int nchks)
+                                 sector_t slba, int nchks,
+                                 struct nvm_chk_meta *meta)
 {
         struct nvm_geo *geo = &ndev->geo;
         struct nvme_ns *ns = ndev->q->queuedata;