2 * Copyright (C) 2015 IT University of Copenhagen (rrpc.c)
3 * Copyright (C) 2016 CNEX Labs
4 * Initial release: Javier Gonzalez <javier@cnexlabs.com>
5 * Matias Bjorling <matias@cnexlabs.com>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * Implementation of a physical block-device target for Open-channel SSDs.
18 * pblk-init.c - pblk's initialization.
22 #include "pblk-trace.h"
24 static unsigned int write_buffer_size;
26 module_param(write_buffer_size, uint, 0644);
27 MODULE_PARM_DESC(write_buffer_size, "number of entries in a write buffer");
29 static struct kmem_cache *pblk_ws_cache, *pblk_rec_cache, *pblk_g_rq_cache,
31 static DECLARE_RWSEM(pblk_lock);
32 struct bio_set pblk_bio_set;
34 static int pblk_rw_io(struct request_queue *q, struct pblk *pblk,
39 /* Read requests must be <= 256kb due to NVMe's 64 bit completion bitmap
40 * constraint. Writes can be of arbitrary size.
42 if (bio_data_dir(bio) == READ) {
43 blk_queue_split(q, &bio);
44 ret = pblk_submit_read(pblk, bio);
45 if (ret == NVM_IO_DONE && bio_flagged(bio, BIO_CLONED))
51 /* Prevent deadlock in the case of a modest LUN configuration and large
52 * user I/Os. Unless stalled, the rate limiter leaves at least 256KB
53 * available for user I/O.
55 if (pblk_get_secs(bio) > pblk_rl_max_io(&pblk->rl))
56 blk_queue_split(q, &bio);
58 return pblk_write_to_cache(pblk, bio, PBLK_IOTYPE_USER);
61 static blk_qc_t pblk_make_rq(struct request_queue *q, struct bio *bio)
63 struct pblk *pblk = q->queuedata;
65 if (bio_op(bio) == REQ_OP_DISCARD) {
66 pblk_discard(pblk, bio);
67 if (!(bio->bi_opf & REQ_PREFLUSH)) {
73 switch (pblk_rw_io(q, pblk, bio)) {
85 static size_t pblk_trans_map_size(struct pblk *pblk)
89 if (pblk->addrf_len < 32)
92 return entry_size * pblk->rl.nr_secs;
95 #ifdef CONFIG_NVM_PBLK_DEBUG
96 static u32 pblk_l2p_crc(struct pblk *pblk)
101 map_size = pblk_trans_map_size(pblk);
102 crc = crc32_le(crc, pblk->trans_map, map_size);
107 static void pblk_l2p_free(struct pblk *pblk)
109 vfree(pblk->trans_map);
112 static int pblk_l2p_recover(struct pblk *pblk, bool factory_init)
114 struct pblk_line *line = NULL;
117 pblk_setup_uuid(pblk);
119 line = pblk_recov_l2p(pblk);
121 pblk_err(pblk, "could not recover l2p table\n");
126 #ifdef CONFIG_NVM_PBLK_DEBUG
127 pblk_info(pblk, "init: L2P CRC: %x\n", pblk_l2p_crc(pblk));
130 /* Free full lines directly as GC has not been started yet */
131 pblk_gc_free_full_lines(pblk);
134 /* Configure next line for user data */
135 line = pblk_line_get_first_data(pblk);
143 static int pblk_l2p_init(struct pblk *pblk, bool factory_init)
150 map_size = pblk_trans_map_size(pblk);
151 pblk->trans_map = vmalloc(map_size);
152 if (!pblk->trans_map)
155 pblk_ppa_set_empty(&ppa);
157 for (i = 0; i < pblk->rl.nr_secs; i++)
158 pblk_trans_map_set(pblk, i, ppa);
160 ret = pblk_l2p_recover(pblk, factory_init);
162 vfree(pblk->trans_map);
167 static void pblk_rwb_free(struct pblk *pblk)
169 if (pblk_rb_tear_down_check(&pblk->rwb))
170 pblk_err(pblk, "write buffer error on tear down\n");
172 pblk_rb_data_free(&pblk->rwb);
173 vfree(pblk_rb_entries_ref(&pblk->rwb));
176 static int pblk_rwb_init(struct pblk *pblk)
178 struct nvm_tgt_dev *dev = pblk->dev;
179 struct nvm_geo *geo = &dev->geo;
180 struct pblk_rb_entry *entries;
181 unsigned long nr_entries, buffer_size;
182 unsigned int power_size, power_seg_sz;
185 pgs_in_buffer = max(geo->mw_cunits, geo->ws_opt) * geo->all_luns;
187 if (write_buffer_size && (write_buffer_size > pgs_in_buffer))
188 buffer_size = write_buffer_size;
190 buffer_size = pgs_in_buffer;
192 nr_entries = pblk_rb_calculate_size(buffer_size);
194 entries = vzalloc(array_size(nr_entries, sizeof(struct pblk_rb_entry)));
198 power_size = get_count_order(nr_entries);
199 power_seg_sz = get_count_order(geo->csecs);
201 return pblk_rb_init(&pblk->rwb, entries, power_size, power_seg_sz);
204 /* Minimum pages needed within a lun */
205 #define ADDR_POOL_SIZE 64
207 static int pblk_set_addrf_12(struct pblk *pblk, struct nvm_geo *geo,
208 struct nvm_addrf_12 *dst)
210 struct nvm_addrf_12 *src = (struct nvm_addrf_12 *)&geo->addrf;
213 /* Re-calculate channel and lun format to adapt to configuration */
214 power_len = get_count_order(geo->num_ch);
215 if (1 << power_len != geo->num_ch) {
216 pblk_err(pblk, "supports only power-of-two channel config.\n");
219 dst->ch_len = power_len;
221 power_len = get_count_order(geo->num_lun);
222 if (1 << power_len != geo->num_lun) {
223 pblk_err(pblk, "supports only power-of-two LUN config.\n");
226 dst->lun_len = power_len;
228 dst->blk_len = src->blk_len;
229 dst->pg_len = src->pg_len;
230 dst->pln_len = src->pln_len;
231 dst->sec_len = src->sec_len;
234 dst->pln_offset = dst->sec_len;
235 dst->ch_offset = dst->pln_offset + dst->pln_len;
236 dst->lun_offset = dst->ch_offset + dst->ch_len;
237 dst->pg_offset = dst->lun_offset + dst->lun_len;
238 dst->blk_offset = dst->pg_offset + dst->pg_len;
240 dst->sec_mask = ((1ULL << dst->sec_len) - 1) << dst->sec_offset;
241 dst->pln_mask = ((1ULL << dst->pln_len) - 1) << dst->pln_offset;
242 dst->ch_mask = ((1ULL << dst->ch_len) - 1) << dst->ch_offset;
243 dst->lun_mask = ((1ULL << dst->lun_len) - 1) << dst->lun_offset;
244 dst->pg_mask = ((1ULL << dst->pg_len) - 1) << dst->pg_offset;
245 dst->blk_mask = ((1ULL << dst->blk_len) - 1) << dst->blk_offset;
247 return dst->blk_offset + src->blk_len;
250 static int pblk_set_addrf_20(struct nvm_geo *geo, struct nvm_addrf *adst,
251 struct pblk_addrf *udst)
253 struct nvm_addrf *src = &geo->addrf;
255 adst->ch_len = get_count_order(geo->num_ch);
256 adst->lun_len = get_count_order(geo->num_lun);
257 adst->chk_len = src->chk_len;
258 adst->sec_len = src->sec_len;
260 adst->sec_offset = 0;
261 adst->ch_offset = adst->sec_len;
262 adst->lun_offset = adst->ch_offset + adst->ch_len;
263 adst->chk_offset = adst->lun_offset + adst->lun_len;
265 adst->sec_mask = ((1ULL << adst->sec_len) - 1) << adst->sec_offset;
266 adst->chk_mask = ((1ULL << adst->chk_len) - 1) << adst->chk_offset;
267 adst->lun_mask = ((1ULL << adst->lun_len) - 1) << adst->lun_offset;
268 adst->ch_mask = ((1ULL << adst->ch_len) - 1) << adst->ch_offset;
270 udst->sec_stripe = geo->ws_opt;
271 udst->ch_stripe = geo->num_ch;
272 udst->lun_stripe = geo->num_lun;
274 udst->sec_lun_stripe = udst->sec_stripe * udst->ch_stripe;
275 udst->sec_ws_stripe = udst->sec_lun_stripe * udst->lun_stripe;
277 return adst->chk_offset + adst->chk_len;
280 static int pblk_set_addrf(struct pblk *pblk)
282 struct nvm_tgt_dev *dev = pblk->dev;
283 struct nvm_geo *geo = &dev->geo;
286 switch (geo->version) {
287 case NVM_OCSSD_SPEC_12:
288 div_u64_rem(geo->clba, pblk->min_write_pgs, &mod);
290 pblk_err(pblk, "bad configuration of sectors/pages\n");
294 pblk->addrf_len = pblk_set_addrf_12(pblk, geo,
295 (void *)&pblk->addrf);
297 case NVM_OCSSD_SPEC_20:
298 pblk->addrf_len = pblk_set_addrf_20(geo, (void *)&pblk->addrf,
302 pblk_err(pblk, "OCSSD revision not supported (%d)\n",
310 static int pblk_init_global_caches(struct pblk *pblk)
312 down_write(&pblk_lock);
313 pblk_ws_cache = kmem_cache_create("pblk_blk_ws",
314 sizeof(struct pblk_line_ws), 0, 0, NULL);
315 if (!pblk_ws_cache) {
316 up_write(&pblk_lock);
320 pblk_rec_cache = kmem_cache_create("pblk_rec",
321 sizeof(struct pblk_rec_ctx), 0, 0, NULL);
322 if (!pblk_rec_cache) {
323 kmem_cache_destroy(pblk_ws_cache);
324 up_write(&pblk_lock);
328 pblk_g_rq_cache = kmem_cache_create("pblk_g_rq", pblk_g_rq_size,
330 if (!pblk_g_rq_cache) {
331 kmem_cache_destroy(pblk_ws_cache);
332 kmem_cache_destroy(pblk_rec_cache);
333 up_write(&pblk_lock);
337 pblk_w_rq_cache = kmem_cache_create("pblk_w_rq", pblk_w_rq_size,
339 if (!pblk_w_rq_cache) {
340 kmem_cache_destroy(pblk_ws_cache);
341 kmem_cache_destroy(pblk_rec_cache);
342 kmem_cache_destroy(pblk_g_rq_cache);
343 up_write(&pblk_lock);
346 up_write(&pblk_lock);
351 static void pblk_free_global_caches(struct pblk *pblk)
353 kmem_cache_destroy(pblk_ws_cache);
354 kmem_cache_destroy(pblk_rec_cache);
355 kmem_cache_destroy(pblk_g_rq_cache);
356 kmem_cache_destroy(pblk_w_rq_cache);
359 static int pblk_core_init(struct pblk *pblk)
361 struct nvm_tgt_dev *dev = pblk->dev;
362 struct nvm_geo *geo = &dev->geo;
363 int ret, max_write_ppas;
365 atomic64_set(&pblk->user_wa, 0);
366 atomic64_set(&pblk->pad_wa, 0);
367 atomic64_set(&pblk->gc_wa, 0);
368 pblk->user_rst_wa = 0;
369 pblk->pad_rst_wa = 0;
372 atomic64_set(&pblk->nr_flush, 0);
373 pblk->nr_flush_rst = 0;
375 pblk->min_write_pgs = geo->ws_opt;
376 max_write_ppas = pblk->min_write_pgs * geo->all_luns;
377 pblk->max_write_pgs = min_t(int, max_write_ppas, NVM_MAX_VLBA);
378 pblk_set_sec_per_write(pblk, pblk->min_write_pgs);
380 pblk->pad_dist = kcalloc(pblk->min_write_pgs - 1, sizeof(atomic64_t),
385 if (pblk_init_global_caches(pblk))
386 goto fail_free_pad_dist;
388 /* Internal bios can be at most the sectors signaled by the device. */
389 ret = mempool_init_page_pool(&pblk->page_bio_pool, NVM_MAX_VLBA, 0);
391 goto free_global_caches;
393 ret = mempool_init_slab_pool(&pblk->gen_ws_pool, PBLK_GEN_WS_POOL_SIZE,
396 goto free_page_bio_pool;
398 ret = mempool_init_slab_pool(&pblk->rec_pool, geo->all_luns,
401 goto free_gen_ws_pool;
403 ret = mempool_init_slab_pool(&pblk->r_rq_pool, geo->all_luns,
408 ret = mempool_init_slab_pool(&pblk->e_rq_pool, geo->all_luns,
413 ret = mempool_init_slab_pool(&pblk->w_rq_pool, geo->all_luns,
418 pblk->close_wq = alloc_workqueue("pblk-close-wq",
419 WQ_MEM_RECLAIM | WQ_UNBOUND, PBLK_NR_CLOSE_JOBS);
423 pblk->bb_wq = alloc_workqueue("pblk-bb-wq",
424 WQ_MEM_RECLAIM | WQ_UNBOUND, 0);
428 pblk->r_end_wq = alloc_workqueue("pblk-read-end-wq",
429 WQ_MEM_RECLAIM | WQ_UNBOUND, 0);
433 if (pblk_set_addrf(pblk))
436 INIT_LIST_HEAD(&pblk->compl_list);
437 INIT_LIST_HEAD(&pblk->resubmit_list);
442 destroy_workqueue(pblk->r_end_wq);
444 destroy_workqueue(pblk->bb_wq);
446 destroy_workqueue(pblk->close_wq);
448 mempool_exit(&pblk->w_rq_pool);
450 mempool_exit(&pblk->e_rq_pool);
452 mempool_exit(&pblk->r_rq_pool);
454 mempool_exit(&pblk->rec_pool);
456 mempool_exit(&pblk->gen_ws_pool);
458 mempool_exit(&pblk->page_bio_pool);
460 pblk_free_global_caches(pblk);
462 kfree(pblk->pad_dist);
466 static void pblk_core_free(struct pblk *pblk)
469 destroy_workqueue(pblk->close_wq);
472 destroy_workqueue(pblk->r_end_wq);
475 destroy_workqueue(pblk->bb_wq);
477 mempool_exit(&pblk->page_bio_pool);
478 mempool_exit(&pblk->gen_ws_pool);
479 mempool_exit(&pblk->rec_pool);
480 mempool_exit(&pblk->r_rq_pool);
481 mempool_exit(&pblk->e_rq_pool);
482 mempool_exit(&pblk->w_rq_pool);
484 pblk_free_global_caches(pblk);
485 kfree(pblk->pad_dist);
488 static void pblk_line_mg_free(struct pblk *pblk)
490 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
493 kfree(l_mg->bb_template);
495 kfree(l_mg->vsc_list);
497 for (i = 0; i < PBLK_DATA_LINES; i++) {
498 kfree(l_mg->sline_meta[i]);
499 pblk_mfree(l_mg->eline_meta[i]->buf, l_mg->emeta_alloc_type);
500 kfree(l_mg->eline_meta[i]);
503 mempool_destroy(l_mg->bitmap_pool);
504 kmem_cache_destroy(l_mg->bitmap_cache);
507 static void pblk_line_meta_free(struct pblk_line_mgmt *l_mg,
508 struct pblk_line *line)
510 struct pblk_w_err_gc *w_err_gc = line->w_err_gc;
512 kfree(line->blk_bitmap);
513 kfree(line->erase_bitmap);
516 pblk_mfree(w_err_gc->lba_list, l_mg->emeta_alloc_type);
520 static void pblk_lines_free(struct pblk *pblk)
522 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
523 struct pblk_line *line;
526 spin_lock(&l_mg->free_lock);
527 for (i = 0; i < l_mg->nr_lines; i++) {
528 line = &pblk->lines[i];
530 pblk_line_free(line);
531 pblk_line_meta_free(l_mg, line);
533 spin_unlock(&l_mg->free_lock);
535 pblk_line_mg_free(pblk);
541 static int pblk_luns_init(struct pblk *pblk)
543 struct nvm_tgt_dev *dev = pblk->dev;
544 struct nvm_geo *geo = &dev->geo;
545 struct pblk_lun *rlun;
548 /* TODO: Implement unbalanced LUN support */
549 if (geo->num_lun < 0) {
550 pblk_err(pblk, "unbalanced LUN config.\n");
554 pblk->luns = kcalloc(geo->all_luns, sizeof(struct pblk_lun),
559 for (i = 0; i < geo->all_luns; i++) {
560 /* Stripe across channels */
561 int ch = i % geo->num_ch;
562 int lun_raw = i / geo->num_ch;
563 int lunid = lun_raw + ch * geo->num_lun;
565 rlun = &pblk->luns[i];
566 rlun->bppa = dev->luns[lunid];
568 sema_init(&rlun->wr_sem, 1);
574 /* See comment over struct line_emeta definition */
575 static unsigned int calc_emeta_len(struct pblk *pblk)
577 struct pblk_line_meta *lm = &pblk->lm;
578 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
579 struct nvm_tgt_dev *dev = pblk->dev;
580 struct nvm_geo *geo = &dev->geo;
582 /* Round to sector size so that lba_list starts on its own sector */
583 lm->emeta_sec[1] = DIV_ROUND_UP(
584 sizeof(struct line_emeta) + lm->blk_bitmap_len +
585 sizeof(struct wa_counters), geo->csecs);
586 lm->emeta_len[1] = lm->emeta_sec[1] * geo->csecs;
588 /* Round to sector size so that vsc_list starts on its own sector */
589 lm->dsec_per_line = lm->sec_per_line - lm->emeta_sec[0];
590 lm->emeta_sec[2] = DIV_ROUND_UP(lm->dsec_per_line * sizeof(u64),
592 lm->emeta_len[2] = lm->emeta_sec[2] * geo->csecs;
594 lm->emeta_sec[3] = DIV_ROUND_UP(l_mg->nr_lines * sizeof(u32),
596 lm->emeta_len[3] = lm->emeta_sec[3] * geo->csecs;
598 lm->vsc_list_len = l_mg->nr_lines * sizeof(u32);
600 return (lm->emeta_len[1] + lm->emeta_len[2] + lm->emeta_len[3]);
603 static void pblk_set_provision(struct pblk *pblk, long nr_free_blks)
605 struct nvm_tgt_dev *dev = pblk->dev;
606 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
607 struct pblk_line_meta *lm = &pblk->lm;
608 struct nvm_geo *geo = &dev->geo;
609 sector_t provisioned;
610 int sec_meta, blk_meta;
612 if (geo->op == NVM_TARGET_DEFAULT_OP)
613 pblk->op = PBLK_DEFAULT_OP;
617 provisioned = nr_free_blks;
618 provisioned *= (100 - pblk->op);
619 sector_div(provisioned, 100);
621 pblk->op_blks = nr_free_blks - provisioned;
623 /* Internally pblk manages all free blocks, but all calculations based
624 * on user capacity consider only provisioned blocks
626 pblk->rl.total_blocks = nr_free_blks;
627 pblk->rl.nr_secs = nr_free_blks * geo->clba;
629 /* Consider sectors used for metadata */
630 sec_meta = (lm->smeta_sec + lm->emeta_sec[0]) * l_mg->nr_free_lines;
631 blk_meta = DIV_ROUND_UP(sec_meta, geo->clba);
633 pblk->capacity = (provisioned - blk_meta) * geo->clba;
635 atomic_set(&pblk->rl.free_blocks, nr_free_blks);
636 atomic_set(&pblk->rl.free_user_blocks, nr_free_blks);
639 static int pblk_setup_line_meta_chk(struct pblk *pblk, struct pblk_line *line,
640 struct nvm_chk_meta *meta)
642 struct nvm_tgt_dev *dev = pblk->dev;
643 struct nvm_geo *geo = &dev->geo;
644 struct pblk_line_meta *lm = &pblk->lm;
645 int i, nr_bad_chks = 0;
647 for (i = 0; i < lm->blk_per_line; i++) {
648 struct pblk_lun *rlun = &pblk->luns[i];
649 struct nvm_chk_meta *chunk;
650 struct nvm_chk_meta *chunk_meta;
655 pos = pblk_ppa_to_pos(geo, ppa);
656 chunk = &line->chks[pos];
658 ppa.m.chk = line->id;
659 chunk_meta = pblk_chunk_get_off(pblk, meta, ppa);
661 chunk->state = chunk_meta->state;
662 chunk->type = chunk_meta->type;
663 chunk->wi = chunk_meta->wi;
664 chunk->slba = chunk_meta->slba;
665 chunk->cnlb = chunk_meta->cnlb;
666 chunk->wp = chunk_meta->wp;
668 trace_pblk_chunk_state(pblk_disk_name(pblk), &ppa,
671 if (chunk->type & NVM_CHK_TP_SZ_SPEC) {
672 WARN_ONCE(1, "pblk: custom-sized chunks unsupported\n");
676 if (!(chunk->state & NVM_CHK_ST_OFFLINE))
679 set_bit(pos, line->blk_bitmap);
686 static long pblk_setup_line_meta(struct pblk *pblk, struct pblk_line *line,
687 void *chunk_meta, int line_id)
689 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
690 struct pblk_line_meta *lm = &pblk->lm;
691 long nr_bad_chks, chk_in_line;
695 line->type = PBLK_LINETYPE_FREE;
696 line->state = PBLK_LINESTATE_NEW;
697 line->gc_group = PBLK_LINEGC_NONE;
698 line->vsc = &l_mg->vsc_list[line_id];
699 spin_lock_init(&line->lock);
701 nr_bad_chks = pblk_setup_line_meta_chk(pblk, line, chunk_meta);
703 chk_in_line = lm->blk_per_line - nr_bad_chks;
704 if (nr_bad_chks < 0 || nr_bad_chks > lm->blk_per_line ||
705 chk_in_line < lm->min_blk_line) {
706 line->state = PBLK_LINESTATE_BAD;
707 list_add_tail(&line->list, &l_mg->bad_list);
711 atomic_set(&line->blk_in_line, chk_in_line);
712 list_add_tail(&line->list, &l_mg->free_list);
713 l_mg->nr_free_lines++;
718 static int pblk_alloc_line_meta(struct pblk *pblk, struct pblk_line *line)
720 struct pblk_line_meta *lm = &pblk->lm;
722 line->blk_bitmap = kzalloc(lm->blk_bitmap_len, GFP_KERNEL);
723 if (!line->blk_bitmap)
726 line->erase_bitmap = kzalloc(lm->blk_bitmap_len, GFP_KERNEL);
727 if (!line->erase_bitmap)
728 goto free_blk_bitmap;
731 line->chks = kmalloc_array(lm->blk_per_line,
732 sizeof(struct nvm_chk_meta), GFP_KERNEL);
734 goto free_erase_bitmap;
736 line->w_err_gc = kzalloc(sizeof(struct pblk_w_err_gc), GFP_KERNEL);
745 kfree(line->erase_bitmap);
747 kfree(line->blk_bitmap);
751 static int pblk_line_mg_init(struct pblk *pblk)
753 struct nvm_tgt_dev *dev = pblk->dev;
754 struct nvm_geo *geo = &dev->geo;
755 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
756 struct pblk_line_meta *lm = &pblk->lm;
759 l_mg->nr_lines = geo->num_chk;
760 l_mg->log_line = l_mg->data_line = NULL;
761 l_mg->l_seq_nr = l_mg->d_seq_nr = 0;
762 l_mg->nr_free_lines = 0;
763 bitmap_zero(&l_mg->meta_bitmap, PBLK_DATA_LINES);
765 INIT_LIST_HEAD(&l_mg->free_list);
766 INIT_LIST_HEAD(&l_mg->corrupt_list);
767 INIT_LIST_HEAD(&l_mg->bad_list);
768 INIT_LIST_HEAD(&l_mg->gc_full_list);
769 INIT_LIST_HEAD(&l_mg->gc_high_list);
770 INIT_LIST_HEAD(&l_mg->gc_mid_list);
771 INIT_LIST_HEAD(&l_mg->gc_low_list);
772 INIT_LIST_HEAD(&l_mg->gc_empty_list);
773 INIT_LIST_HEAD(&l_mg->gc_werr_list);
775 INIT_LIST_HEAD(&l_mg->emeta_list);
777 l_mg->gc_lists[0] = &l_mg->gc_werr_list;
778 l_mg->gc_lists[1] = &l_mg->gc_high_list;
779 l_mg->gc_lists[2] = &l_mg->gc_mid_list;
780 l_mg->gc_lists[3] = &l_mg->gc_low_list;
782 spin_lock_init(&l_mg->free_lock);
783 spin_lock_init(&l_mg->close_lock);
784 spin_lock_init(&l_mg->gc_lock);
786 l_mg->vsc_list = kcalloc(l_mg->nr_lines, sizeof(__le32), GFP_KERNEL);
790 l_mg->bb_template = kzalloc(lm->sec_bitmap_len, GFP_KERNEL);
791 if (!l_mg->bb_template)
792 goto fail_free_vsc_list;
794 l_mg->bb_aux = kzalloc(lm->sec_bitmap_len, GFP_KERNEL);
796 goto fail_free_bb_template;
798 /* smeta is always small enough to fit on a kmalloc memory allocation,
799 * emeta depends on the number of LUNs allocated to the pblk instance
801 for (i = 0; i < PBLK_DATA_LINES; i++) {
802 l_mg->sline_meta[i] = kmalloc(lm->smeta_len, GFP_KERNEL);
803 if (!l_mg->sline_meta[i])
804 goto fail_free_smeta;
807 l_mg->bitmap_cache = kmem_cache_create("pblk_lm_bitmap",
808 lm->sec_bitmap_len, 0, 0, NULL);
809 if (!l_mg->bitmap_cache)
810 goto fail_free_smeta;
812 /* the bitmap pool is used for both valid and map bitmaps */
813 l_mg->bitmap_pool = mempool_create_slab_pool(PBLK_DATA_LINES * 2,
815 if (!l_mg->bitmap_pool)
816 goto fail_destroy_bitmap_cache;
818 /* emeta allocates three different buffers for managing metadata with
819 * in-memory and in-media layouts
821 for (i = 0; i < PBLK_DATA_LINES; i++) {
822 struct pblk_emeta *emeta;
824 emeta = kmalloc(sizeof(struct pblk_emeta), GFP_KERNEL);
826 goto fail_free_emeta;
828 if (lm->emeta_len[0] > KMALLOC_MAX_CACHE_SIZE) {
829 l_mg->emeta_alloc_type = PBLK_VMALLOC_META;
831 emeta->buf = vmalloc(lm->emeta_len[0]);
834 goto fail_free_emeta;
837 emeta->nr_entries = lm->emeta_sec[0];
838 l_mg->eline_meta[i] = emeta;
840 l_mg->emeta_alloc_type = PBLK_KMALLOC_META;
842 emeta->buf = kmalloc(lm->emeta_len[0], GFP_KERNEL);
845 goto fail_free_emeta;
848 emeta->nr_entries = lm->emeta_sec[0];
849 l_mg->eline_meta[i] = emeta;
853 for (i = 0; i < l_mg->nr_lines; i++)
854 l_mg->vsc_list[i] = cpu_to_le32(EMPTY_ENTRY);
856 bb_distance = (geo->all_luns) * geo->ws_opt;
857 for (i = 0; i < lm->sec_per_line; i += bb_distance)
858 bitmap_set(l_mg->bb_template, i, geo->ws_opt);
864 if (l_mg->emeta_alloc_type == PBLK_VMALLOC_META)
865 vfree(l_mg->eline_meta[i]->buf);
867 kfree(l_mg->eline_meta[i]->buf);
868 kfree(l_mg->eline_meta[i]);
871 mempool_destroy(l_mg->bitmap_pool);
872 fail_destroy_bitmap_cache:
873 kmem_cache_destroy(l_mg->bitmap_cache);
875 for (i = 0; i < PBLK_DATA_LINES; i++)
876 kfree(l_mg->sline_meta[i]);
878 fail_free_bb_template:
879 kfree(l_mg->bb_template);
881 kfree(l_mg->vsc_list);
886 static int pblk_line_meta_init(struct pblk *pblk)
888 struct nvm_tgt_dev *dev = pblk->dev;
889 struct nvm_geo *geo = &dev->geo;
890 struct pblk_line_meta *lm = &pblk->lm;
891 unsigned int smeta_len, emeta_len;
894 lm->sec_per_line = geo->clba * geo->all_luns;
895 lm->blk_per_line = geo->all_luns;
896 lm->blk_bitmap_len = BITS_TO_LONGS(geo->all_luns) * sizeof(long);
897 lm->sec_bitmap_len = BITS_TO_LONGS(lm->sec_per_line) * sizeof(long);
898 lm->lun_bitmap_len = BITS_TO_LONGS(geo->all_luns) * sizeof(long);
899 lm->mid_thrs = lm->sec_per_line / 2;
900 lm->high_thrs = lm->sec_per_line / 4;
901 lm->meta_distance = (geo->all_luns / 2) * pblk->min_write_pgs;
903 /* Calculate necessary pages for smeta. See comment over struct
904 * line_smeta definition
908 lm->smeta_sec = i * geo->ws_opt;
909 lm->smeta_len = lm->smeta_sec * geo->csecs;
911 smeta_len = sizeof(struct line_smeta) + lm->lun_bitmap_len;
912 if (smeta_len > lm->smeta_len) {
917 /* Calculate necessary pages for emeta. See comment over struct
918 * line_emeta definition
922 lm->emeta_sec[0] = i * geo->ws_opt;
923 lm->emeta_len[0] = lm->emeta_sec[0] * geo->csecs;
925 emeta_len = calc_emeta_len(pblk);
926 if (emeta_len > lm->emeta_len[0]) {
931 lm->emeta_bb = geo->all_luns > i ? geo->all_luns - i : 0;
933 lm->min_blk_line = 1;
934 if (geo->all_luns > 1)
935 lm->min_blk_line += DIV_ROUND_UP(lm->smeta_sec +
936 lm->emeta_sec[0], geo->clba);
938 if (lm->min_blk_line > lm->blk_per_line) {
939 pblk_err(pblk, "config. not supported. Min. LUN in line:%d\n",
947 static int pblk_lines_init(struct pblk *pblk)
949 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
950 struct pblk_line *line;
952 long nr_free_chks = 0;
955 ret = pblk_line_meta_init(pblk);
959 ret = pblk_line_mg_init(pblk);
963 ret = pblk_luns_init(pblk);
967 chunk_meta = pblk_get_chunk_meta(pblk);
968 if (IS_ERR(chunk_meta)) {
969 ret = PTR_ERR(chunk_meta);
973 pblk->lines = kcalloc(l_mg->nr_lines, sizeof(struct pblk_line),
977 goto fail_free_chunk_meta;
980 for (i = 0; i < l_mg->nr_lines; i++) {
981 line = &pblk->lines[i];
983 ret = pblk_alloc_line_meta(pblk, line);
985 goto fail_free_lines;
987 nr_free_chks += pblk_setup_line_meta(pblk, line, chunk_meta, i);
989 trace_pblk_line_state(pblk_disk_name(pblk), line->id,
994 pblk_err(pblk, "too many bad blocks prevent for sane instance\n");
998 pblk_set_provision(pblk, nr_free_chks);
1005 pblk_line_meta_free(l_mg, &pblk->lines[i]);
1007 fail_free_chunk_meta:
1012 pblk_line_mg_free(pblk);
1017 static int pblk_writer_init(struct pblk *pblk)
1019 pblk->writer_ts = kthread_create(pblk_write_ts, pblk, "pblk-writer-t");
1020 if (IS_ERR(pblk->writer_ts)) {
1021 int err = PTR_ERR(pblk->writer_ts);
1024 pblk_err(pblk, "could not allocate writer kthread (%d)\n",
1029 timer_setup(&pblk->wtimer, pblk_write_timer_fn, 0);
1030 mod_timer(&pblk->wtimer, jiffies + msecs_to_jiffies(100));
1035 static void pblk_writer_stop(struct pblk *pblk)
1037 /* The pipeline must be stopped and the write buffer emptied before the
1038 * write thread is stopped
1040 WARN(pblk_rb_read_count(&pblk->rwb),
1041 "Stopping not fully persisted write buffer\n");
1043 WARN(pblk_rb_sync_count(&pblk->rwb),
1044 "Stopping not fully synced write buffer\n");
1046 del_timer_sync(&pblk->wtimer);
1047 if (pblk->writer_ts)
1048 kthread_stop(pblk->writer_ts);
1051 static void pblk_free(struct pblk *pblk)
1053 pblk_lines_free(pblk);
1054 pblk_l2p_free(pblk);
1055 pblk_rwb_free(pblk);
1056 pblk_core_free(pblk);
1061 static void pblk_tear_down(struct pblk *pblk, bool graceful)
1064 __pblk_pipeline_flush(pblk);
1065 __pblk_pipeline_stop(pblk);
1066 pblk_writer_stop(pblk);
1067 pblk_rb_sync_l2p(&pblk->rwb);
1068 pblk_rl_free(&pblk->rl);
1070 pblk_debug(pblk, "consistent tear down (graceful:%d)\n", graceful);
1073 static void pblk_exit(void *private, bool graceful)
1075 struct pblk *pblk = private;
1077 down_write(&pblk_lock);
1078 pblk_gc_exit(pblk, graceful);
1079 pblk_tear_down(pblk, graceful);
1081 #ifdef CONFIG_NVM_PBLK_DEBUG
1082 pblk_info(pblk, "exit: L2P CRC: %x\n", pblk_l2p_crc(pblk));
1086 up_write(&pblk_lock);
1089 static sector_t pblk_capacity(void *private)
1091 struct pblk *pblk = private;
1093 return pblk->capacity * NR_PHY_IN_LOG;
1096 static void *pblk_init(struct nvm_tgt_dev *dev, struct gendisk *tdisk,
1099 struct nvm_geo *geo = &dev->geo;
1100 struct request_queue *bqueue = dev->q;
1101 struct request_queue *tqueue = tdisk->queue;
1105 pblk = kzalloc(sizeof(struct pblk), GFP_KERNEL);
1107 return ERR_PTR(-ENOMEM);
1111 pblk->state = PBLK_STATE_RUNNING;
1112 pblk->gc.gc_enabled = 0;
1114 if (!(geo->version == NVM_OCSSD_SPEC_12 ||
1115 geo->version == NVM_OCSSD_SPEC_20)) {
1116 pblk_err(pblk, "OCSSD version not supported (%u)\n",
1119 return ERR_PTR(-EINVAL);
1122 spin_lock_init(&pblk->resubmit_lock);
1123 spin_lock_init(&pblk->trans_lock);
1124 spin_lock_init(&pblk->lock);
1126 #ifdef CONFIG_NVM_PBLK_DEBUG
1127 atomic_long_set(&pblk->inflight_writes, 0);
1128 atomic_long_set(&pblk->padded_writes, 0);
1129 atomic_long_set(&pblk->padded_wb, 0);
1130 atomic_long_set(&pblk->req_writes, 0);
1131 atomic_long_set(&pblk->sub_writes, 0);
1132 atomic_long_set(&pblk->sync_writes, 0);
1133 atomic_long_set(&pblk->inflight_reads, 0);
1134 atomic_long_set(&pblk->cache_reads, 0);
1135 atomic_long_set(&pblk->sync_reads, 0);
1136 atomic_long_set(&pblk->recov_writes, 0);
1137 atomic_long_set(&pblk->recov_writes, 0);
1138 atomic_long_set(&pblk->recov_gc_writes, 0);
1139 atomic_long_set(&pblk->recov_gc_reads, 0);
1142 atomic_long_set(&pblk->read_failed, 0);
1143 atomic_long_set(&pblk->read_empty, 0);
1144 atomic_long_set(&pblk->read_high_ecc, 0);
1145 atomic_long_set(&pblk->read_failed_gc, 0);
1146 atomic_long_set(&pblk->write_failed, 0);
1147 atomic_long_set(&pblk->erase_failed, 0);
1149 ret = pblk_core_init(pblk);
1151 pblk_err(pblk, "could not initialize core\n");
1155 ret = pblk_lines_init(pblk);
1157 pblk_err(pblk, "could not initialize lines\n");
1158 goto fail_free_core;
1161 ret = pblk_rwb_init(pblk);
1163 pblk_err(pblk, "could not initialize write buffer\n");
1164 goto fail_free_lines;
1167 ret = pblk_l2p_init(pblk, flags & NVM_TARGET_FACTORY);
1169 pblk_err(pblk, "could not initialize maps\n");
1173 ret = pblk_writer_init(pblk);
1176 pblk_err(pblk, "could not initialize write thread\n");
1180 ret = pblk_gc_init(pblk);
1182 pblk_err(pblk, "could not initialize gc\n");
1183 goto fail_stop_writer;
1186 /* inherit the size from the underlying device */
1187 blk_queue_logical_block_size(tqueue, queue_physical_block_size(bqueue));
1188 blk_queue_max_hw_sectors(tqueue, queue_max_hw_sectors(bqueue));
1190 blk_queue_write_cache(tqueue, true, false);
1192 tqueue->limits.discard_granularity = geo->clba * geo->csecs;
1193 tqueue->limits.discard_alignment = 0;
1194 blk_queue_max_discard_sectors(tqueue, UINT_MAX >> 9);
1195 blk_queue_flag_set(QUEUE_FLAG_DISCARD, tqueue);
1197 pblk_info(pblk, "luns:%u, lines:%d, secs:%llu, buf entries:%u\n",
1198 geo->all_luns, pblk->l_mg.nr_lines,
1199 (unsigned long long)pblk->rl.nr_secs,
1200 pblk->rwb.nr_entries);
1202 wake_up_process(pblk->writer_ts);
1204 /* Check if we need to start GC */
1205 pblk_gc_should_kick(pblk);
1210 pblk_writer_stop(pblk);
1212 pblk_l2p_free(pblk);
1214 pblk_rwb_free(pblk);
1216 pblk_lines_free(pblk);
1218 pblk_core_free(pblk);
1221 return ERR_PTR(ret);
1224 /* physical block device target */
1225 static struct nvm_tgt_type tt_pblk = {
1227 .version = {1, 0, 0},
1229 .make_rq = pblk_make_rq,
1230 .capacity = pblk_capacity,
1235 .sysfs_init = pblk_sysfs_init,
1236 .sysfs_exit = pblk_sysfs_exit,
1237 .owner = THIS_MODULE,
1240 static int __init pblk_module_init(void)
1244 ret = bioset_init(&pblk_bio_set, BIO_POOL_SIZE, 0, 0);
1247 ret = nvm_register_tgt_type(&tt_pblk);
1249 bioset_exit(&pblk_bio_set);
1253 static void pblk_module_exit(void)
1255 bioset_exit(&pblk_bio_set);
1256 nvm_unregister_tgt_type(&tt_pblk);
1259 module_init(pblk_module_init);
1260 module_exit(pblk_module_exit);
1261 MODULE_AUTHOR("Javier Gonzalez <javier@cnexlabs.com>");
1262 MODULE_AUTHOR("Matias Bjorling <matias@cnexlabs.com>");
1263 MODULE_LICENSE("GPL v2");
1264 MODULE_DESCRIPTION("Physical Block-Device for Open-Channel SSDs");