2 * Copyright (C) 2015 Matias Bjorling <m@bjorling.me>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License version
6 * 2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; see the file COPYING. If not, write to
15 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
18 * Implementation of a generic nvm manager for Open-Channel SSDs.
23 static void gennvm_blocks_free(struct nvm_dev *dev)
25 struct gen_nvm *gn = dev->mp;
29 gennvm_for_each_lun(gn, lun, i) {
30 if (!lun->vlun.blocks)
32 vfree(lun->vlun.blocks);
36 static void gennvm_luns_free(struct nvm_dev *dev)
38 struct gen_nvm *gn = dev->mp;
43 static int gennvm_luns_init(struct nvm_dev *dev, struct gen_nvm *gn)
48 gn->luns = kcalloc(dev->nr_luns, sizeof(struct gen_lun), GFP_KERNEL);
52 gennvm_for_each_lun(gn, lun, i) {
53 spin_lock_init(&lun->vlun.lock);
54 INIT_LIST_HEAD(&lun->free_list);
55 INIT_LIST_HEAD(&lun->used_list);
56 INIT_LIST_HEAD(&lun->bb_list);
58 lun->reserved_blocks = 2; /* for GC only */
60 lun->vlun.lun_id = i % dev->luns_per_chnl;
61 lun->vlun.chnl_id = i / dev->luns_per_chnl;
62 lun->vlun.nr_free_blocks = dev->blks_per_lun;
63 lun->vlun.nr_open_blocks = 0;
64 lun->vlun.nr_closed_blocks = 0;
65 lun->vlun.nr_bad_blocks = 0;
70 static int gennvm_block_bb(struct ppa_addr ppa, int nr_blocks, u8 *blks,
73 struct gen_nvm *gn = private;
74 struct nvm_dev *dev = gn->dev;
76 struct nvm_block *blk;
79 lun = &gn->luns[(dev->luns_per_chnl * ppa.g.ch) + ppa.g.lun];
81 for (i = 0; i < nr_blocks; i++) {
85 blk = &lun->vlun.blocks[i];
87 pr_err("gennvm: BB data is out of bounds.\n");
91 list_move_tail(&blk->list, &lun->bb_list);
92 lun->vlun.nr_bad_blocks++;
93 lun->vlun.nr_free_blocks--;
99 static int gennvm_block_map(u64 slba, u32 nlb, __le64 *entries, void *private)
101 struct nvm_dev *dev = private;
102 struct gen_nvm *gn = dev->mp;
103 u64 elba = slba + nlb;
105 struct nvm_block *blk;
109 if (unlikely(elba > dev->total_secs)) {
110 pr_err("gennvm: L2P data from device is out of bounds!\n");
114 for (i = 0; i < nlb; i++) {
115 u64 pba = le64_to_cpu(entries[i]);
117 if (unlikely(pba >= dev->total_secs && pba != U64_MAX)) {
118 pr_err("gennvm: L2P data entry is out of bounds!\n");
122 /* Address zero is a special one. The first page on a disk is
123 * protected. It often holds internal device boot
129 /* resolve block from physical address */
130 lun_id = div_u64(pba, dev->sec_per_lun);
131 lun = &gn->luns[lun_id];
133 /* Calculate block offset into lun */
134 pba = pba - (dev->sec_per_lun * lun_id);
135 blk = &lun->vlun.blocks[div_u64(pba, dev->sec_per_blk)];
138 /* at this point, we don't know anything about the
139 * block. It's up to the FTL on top to re-etablish the
140 * block state. The block is assumed to be open.
142 list_move_tail(&blk->list, &lun->used_list);
143 blk->state = NVM_BLK_ST_OPEN;
144 lun->vlun.nr_free_blocks--;
145 lun->vlun.nr_open_blocks++;
152 static int gennvm_blocks_init(struct nvm_dev *dev, struct gen_nvm *gn)
155 struct nvm_block *block;
156 sector_t lun_iter, blk_iter, cur_block_id = 0;
159 gennvm_for_each_lun(gn, lun, lun_iter) {
160 lun->vlun.blocks = vzalloc(sizeof(struct nvm_block) *
162 if (!lun->vlun.blocks)
165 for (blk_iter = 0; blk_iter < dev->blks_per_lun; blk_iter++) {
166 block = &lun->vlun.blocks[blk_iter];
168 INIT_LIST_HEAD(&block->list);
170 block->lun = &lun->vlun;
171 block->id = cur_block_id++;
173 /* First block is reserved for device */
174 if (unlikely(lun_iter == 0 && blk_iter == 0)) {
175 lun->vlun.nr_free_blocks--;
179 list_add_tail(&block->list, &lun->free_list);
182 if (dev->ops->get_bb_tbl) {
186 ppa.g.ch = lun->vlun.chnl_id;
187 ppa.g.lun = lun->vlun.id;
188 ppa = generic_to_dev_addr(dev, ppa);
190 ret = dev->ops->get_bb_tbl(dev, ppa,
192 gennvm_block_bb, gn);
194 pr_err("gennvm: could not read BB table\n");
198 if (dev->ops->get_l2p_tbl) {
199 ret = dev->ops->get_l2p_tbl(dev, 0, dev->total_secs,
200 gennvm_block_map, dev);
202 pr_err("gennvm: could not read L2P table.\n");
203 pr_warn("gennvm: default block initialization");
210 static void gennvm_free(struct nvm_dev *dev)
212 gennvm_blocks_free(dev);
213 gennvm_luns_free(dev);
218 static int gennvm_register(struct nvm_dev *dev)
223 if (!try_module_get(THIS_MODULE))
226 gn = kzalloc(sizeof(struct gen_nvm), GFP_KERNEL);
231 gn->nr_luns = dev->nr_luns;
234 ret = gennvm_luns_init(dev, gn);
236 pr_err("gennvm: could not initialize luns\n");
240 ret = gennvm_blocks_init(dev, gn);
242 pr_err("gennvm: could not initialize blocks\n");
249 module_put(THIS_MODULE);
253 static void gennvm_unregister(struct nvm_dev *dev)
256 module_put(THIS_MODULE);
259 static struct nvm_block *gennvm_get_blk_unlocked(struct nvm_dev *dev,
260 struct nvm_lun *vlun, unsigned long flags)
262 struct gen_lun *lun = container_of(vlun, struct gen_lun, vlun);
263 struct nvm_block *blk = NULL;
264 int is_gc = flags & NVM_IOTYPE_GC;
266 assert_spin_locked(&vlun->lock);
268 if (list_empty(&lun->free_list)) {
269 pr_err_ratelimited("gennvm: lun %u have no free pages available",
274 if (!is_gc && lun->vlun.nr_free_blocks < lun->reserved_blocks)
277 blk = list_first_entry(&lun->free_list, struct nvm_block, list);
278 list_move_tail(&blk->list, &lun->used_list);
279 blk->state = NVM_BLK_ST_OPEN;
281 lun->vlun.nr_free_blocks--;
282 lun->vlun.nr_open_blocks++;
288 static struct nvm_block *gennvm_get_blk(struct nvm_dev *dev,
289 struct nvm_lun *vlun, unsigned long flags)
291 struct nvm_block *blk;
293 spin_lock(&vlun->lock);
294 blk = gennvm_get_blk_unlocked(dev, vlun, flags);
295 spin_unlock(&vlun->lock);
299 static void gennvm_put_blk_unlocked(struct nvm_dev *dev, struct nvm_block *blk)
301 struct nvm_lun *vlun = blk->lun;
302 struct gen_lun *lun = container_of(vlun, struct gen_lun, vlun);
304 assert_spin_locked(&vlun->lock);
306 if (blk->state & NVM_BLK_ST_OPEN) {
307 list_move_tail(&blk->list, &lun->free_list);
308 lun->vlun.nr_open_blocks--;
309 lun->vlun.nr_free_blocks++;
310 blk->state = NVM_BLK_ST_FREE;
311 } else if (blk->state & NVM_BLK_ST_CLOSED) {
312 list_move_tail(&blk->list, &lun->free_list);
313 lun->vlun.nr_closed_blocks--;
314 lun->vlun.nr_free_blocks++;
315 blk->state = NVM_BLK_ST_FREE;
316 } else if (blk->state & NVM_BLK_ST_BAD) {
317 list_move_tail(&blk->list, &lun->bb_list);
318 lun->vlun.nr_bad_blocks++;
319 blk->state = NVM_BLK_ST_BAD;
322 pr_err("gennvm: erroneous block type (%lu -> %u)\n",
323 blk->id, blk->state);
324 list_move_tail(&blk->list, &lun->bb_list);
325 lun->vlun.nr_bad_blocks++;
326 blk->state = NVM_BLK_ST_BAD;
330 static void gennvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
332 struct nvm_lun *vlun = blk->lun;
334 spin_lock(&vlun->lock);
335 gennvm_put_blk_unlocked(dev, blk);
336 spin_unlock(&vlun->lock);
339 static void gennvm_blk_set_type(struct nvm_dev *dev, struct ppa_addr *ppa,
342 struct gen_nvm *gn = dev->mp;
344 struct nvm_block *blk;
346 if (unlikely(ppa->g.ch > dev->nr_chnls ||
347 ppa->g.lun > dev->luns_per_chnl ||
348 ppa->g.blk > dev->blks_per_lun)) {
350 pr_err("gennvm: ppa broken (ch: %u > %u lun: %u > %u blk: %u > %u",
351 ppa->g.ch, dev->nr_chnls,
352 ppa->g.lun, dev->luns_per_chnl,
353 ppa->g.blk, dev->blks_per_lun);
357 lun = &gn->luns[ppa->g.lun * ppa->g.ch];
358 blk = &lun->vlun.blocks[ppa->g.blk];
360 /* will be moved to bb list on put_blk from target */
364 /* mark block bad. It is expected the target recover from the error. */
365 static void gennvm_mark_blk_bad(struct nvm_dev *dev, struct nvm_rq *rqd)
369 if (!dev->ops->set_bb_tbl)
372 if (dev->ops->set_bb_tbl(dev, rqd, 1))
375 nvm_addr_to_generic_mode(dev, rqd);
377 /* look up blocks and mark them as bad */
378 if (rqd->nr_pages > 1)
379 for (i = 0; i < rqd->nr_pages; i++)
380 gennvm_blk_set_type(dev, &rqd->ppa_list[i],
383 gennvm_blk_set_type(dev, &rqd->ppa_addr, NVM_BLK_ST_BAD);
386 static void gennvm_end_io(struct nvm_rq *rqd)
388 struct nvm_tgt_instance *ins = rqd->ins;
390 switch (rqd->error) {
391 case NVM_RSP_SUCCESS:
392 case NVM_RSP_ERR_EMPTYPAGE:
394 case NVM_RSP_ERR_FAILWRITE:
395 gennvm_mark_blk_bad(rqd->dev, rqd);
398 ins->tt->end_io(rqd);
401 static int gennvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
403 if (!dev->ops->submit_io)
406 /* Convert address space */
407 nvm_generic_to_addr_mode(dev, rqd);
410 rqd->end_io = gennvm_end_io;
411 return dev->ops->submit_io(dev, rqd);
414 static int gennvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk,
417 struct ppa_addr addr = block_to_ppa(dev, blk);
419 return nvm_erase_ppa(dev, &addr, 1);
422 static struct nvm_lun *gennvm_get_lun(struct nvm_dev *dev, int lunid)
424 struct gen_nvm *gn = dev->mp;
426 return &gn->luns[lunid].vlun;
429 static void gennvm_lun_info_print(struct nvm_dev *dev)
431 struct gen_nvm *gn = dev->mp;
436 gennvm_for_each_lun(gn, lun, i) {
437 spin_lock(&lun->vlun.lock);
439 pr_info("%s: lun%8u\t%u\t%u\t%u\t%u\n",
441 lun->vlun.nr_free_blocks,
442 lun->vlun.nr_open_blocks,
443 lun->vlun.nr_closed_blocks,
444 lun->vlun.nr_bad_blocks);
446 spin_unlock(&lun->vlun.lock);
450 static struct nvmm_type gennvm = {
452 .version = {0, 1, 0},
454 .register_mgr = gennvm_register,
455 .unregister_mgr = gennvm_unregister,
457 .get_blk_unlocked = gennvm_get_blk_unlocked,
458 .put_blk_unlocked = gennvm_put_blk_unlocked,
460 .get_blk = gennvm_get_blk,
461 .put_blk = gennvm_put_blk,
463 .submit_io = gennvm_submit_io,
464 .erase_blk = gennvm_erase_blk,
466 .get_lun = gennvm_get_lun,
467 .lun_info_print = gennvm_lun_info_print,
470 static int __init gennvm_module_init(void)
472 return nvm_register_mgr(&gennvm);
475 static void gennvm_module_exit(void)
477 nvm_unregister_mgr(&gennvm);
480 module_init(gennvm_module_init);
481 module_exit(gennvm_module_exit);
482 MODULE_LICENSE("GPL v2");
483 MODULE_DESCRIPTION("Generic media manager for Open-Channel SSDs");