]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/lightnvm/pblk-init.c
lightnvm: pblk: free full lines during recovery
[mirror_ubuntu-bionic-kernel.git] / drivers / lightnvm / pblk-init.c
CommitLineData
a4bd217b
JG
1/*
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>
6 *
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.
10 *
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.
15 *
16 * Implementation of a physical block-device target for Open-channel SSDs.
17 *
18 * pblk-init.c - pblk's initialization.
19 */
20
21#include "pblk.h"
22
b84ae4a8 23static struct kmem_cache *pblk_ws_cache, *pblk_rec_cache, *pblk_g_rq_cache,
e72ec1d3 24 *pblk_w_rq_cache;
a4bd217b 25static DECLARE_RWSEM(pblk_lock);
b25d5237 26struct bio_set *pblk_bio_set;
a4bd217b
JG
27
28static int pblk_rw_io(struct request_queue *q, struct pblk *pblk,
29 struct bio *bio)
30{
31 int ret;
32
33 /* Read requests must be <= 256kb due to NVMe's 64 bit completion bitmap
34 * constraint. Writes can be of arbitrary size.
35 */
36 if (bio_data_dir(bio) == READ) {
af67c31f 37 blk_queue_split(q, &bio);
a4bd217b
JG
38 ret = pblk_submit_read(pblk, bio);
39 if (ret == NVM_IO_DONE && bio_flagged(bio, BIO_CLONED))
40 bio_put(bio);
41
42 return ret;
43 }
44
45 /* Prevent deadlock in the case of a modest LUN configuration and large
46 * user I/Os. Unless stalled, the rate limiter leaves at least 256KB
47 * available for user I/O.
48 */
da67e68f 49 if (pblk_get_secs(bio) > pblk_rl_max_io(&pblk->rl))
af67c31f 50 blk_queue_split(q, &bio);
a4bd217b
JG
51
52 return pblk_write_to_cache(pblk, bio, PBLK_IOTYPE_USER);
53}
54
55static blk_qc_t pblk_make_rq(struct request_queue *q, struct bio *bio)
56{
57 struct pblk *pblk = q->queuedata;
58
59 if (bio_op(bio) == REQ_OP_DISCARD) {
60 pblk_discard(pblk, bio);
61 if (!(bio->bi_opf & REQ_PREFLUSH)) {
62 bio_endio(bio);
63 return BLK_QC_T_NONE;
64 }
65 }
66
67 switch (pblk_rw_io(q, pblk, bio)) {
68 case NVM_IO_ERR:
69 bio_io_error(bio);
70 break;
71 case NVM_IO_DONE:
72 bio_endio(bio);
73 break;
74 }
75
76 return BLK_QC_T_NONE;
77}
78
79static void pblk_l2p_free(struct pblk *pblk)
80{
81 vfree(pblk->trans_map);
82}
83
84static int pblk_l2p_init(struct pblk *pblk)
85{
86 sector_t i;
87 struct ppa_addr ppa;
88 int entry_size = 8;
89
90 if (pblk->ppaf_bitsize < 32)
91 entry_size = 4;
92
93 pblk->trans_map = vmalloc(entry_size * pblk->rl.nr_secs);
94 if (!pblk->trans_map)
95 return -ENOMEM;
96
97 pblk_ppa_set_empty(&ppa);
98
99 for (i = 0; i < pblk->rl.nr_secs; i++)
100 pblk_trans_map_set(pblk, i, ppa);
101
102 return 0;
103}
104
105static void pblk_rwb_free(struct pblk *pblk)
106{
107 if (pblk_rb_tear_down_check(&pblk->rwb))
108 pr_err("pblk: write buffer error on tear down\n");
109
110 pblk_rb_data_free(&pblk->rwb);
111 vfree(pblk_rb_entries_ref(&pblk->rwb));
112}
113
114static int pblk_rwb_init(struct pblk *pblk)
115{
116 struct nvm_tgt_dev *dev = pblk->dev;
117 struct nvm_geo *geo = &dev->geo;
118 struct pblk_rb_entry *entries;
119 unsigned long nr_entries;
120 unsigned int power_size, power_seg_sz;
121
122 nr_entries = pblk_rb_calculate_size(pblk->pgs_in_buffer);
123
124 entries = vzalloc(nr_entries * sizeof(struct pblk_rb_entry));
125 if (!entries)
126 return -ENOMEM;
127
128 power_size = get_count_order(nr_entries);
129 power_seg_sz = get_count_order(geo->sec_size);
130
131 return pblk_rb_init(&pblk->rwb, entries, power_size, power_seg_sz);
132}
133
134/* Minimum pages needed within a lun */
a4bd217b
JG
135#define ADDR_POOL_SIZE 64
136
137static int pblk_set_ppaf(struct pblk *pblk)
138{
139 struct nvm_tgt_dev *dev = pblk->dev;
140 struct nvm_geo *geo = &dev->geo;
141 struct nvm_addr_format ppaf = geo->ppaf;
142 int power_len;
143
144 /* Re-calculate channel and lun format to adapt to configuration */
145 power_len = get_count_order(geo->nr_chnls);
146 if (1 << power_len != geo->nr_chnls) {
147 pr_err("pblk: supports only power-of-two channel config.\n");
148 return -EINVAL;
149 }
150 ppaf.ch_len = power_len;
151
152 power_len = get_count_order(geo->luns_per_chnl);
153 if (1 << power_len != geo->luns_per_chnl) {
154 pr_err("pblk: supports only power-of-two LUN config.\n");
155 return -EINVAL;
156 }
157 ppaf.lun_len = power_len;
158
159 pblk->ppaf.sec_offset = 0;
160 pblk->ppaf.pln_offset = ppaf.sect_len;
161 pblk->ppaf.ch_offset = pblk->ppaf.pln_offset + ppaf.pln_len;
162 pblk->ppaf.lun_offset = pblk->ppaf.ch_offset + ppaf.ch_len;
163 pblk->ppaf.pg_offset = pblk->ppaf.lun_offset + ppaf.lun_len;
164 pblk->ppaf.blk_offset = pblk->ppaf.pg_offset + ppaf.pg_len;
165 pblk->ppaf.sec_mask = (1ULL << ppaf.sect_len) - 1;
166 pblk->ppaf.pln_mask = ((1ULL << ppaf.pln_len) - 1) <<
167 pblk->ppaf.pln_offset;
168 pblk->ppaf.ch_mask = ((1ULL << ppaf.ch_len) - 1) <<
169 pblk->ppaf.ch_offset;
170 pblk->ppaf.lun_mask = ((1ULL << ppaf.lun_len) - 1) <<
171 pblk->ppaf.lun_offset;
172 pblk->ppaf.pg_mask = ((1ULL << ppaf.pg_len) - 1) <<
173 pblk->ppaf.pg_offset;
174 pblk->ppaf.blk_mask = ((1ULL << ppaf.blk_len) - 1) <<
175 pblk->ppaf.blk_offset;
176
177 pblk->ppaf_bitsize = pblk->ppaf.blk_offset + ppaf.blk_len;
178
179 return 0;
180}
181
182static int pblk_init_global_caches(struct pblk *pblk)
183{
a4bd217b 184 down_write(&pblk_lock);
b84ae4a8 185 pblk_ws_cache = kmem_cache_create("pblk_blk_ws",
a4bd217b 186 sizeof(struct pblk_line_ws), 0, 0, NULL);
b84ae4a8 187 if (!pblk_ws_cache) {
a4bd217b
JG
188 up_write(&pblk_lock);
189 return -ENOMEM;
190 }
191
192 pblk_rec_cache = kmem_cache_create("pblk_rec",
193 sizeof(struct pblk_rec_ctx), 0, 0, NULL);
194 if (!pblk_rec_cache) {
b84ae4a8 195 kmem_cache_destroy(pblk_ws_cache);
a4bd217b
JG
196 up_write(&pblk_lock);
197 return -ENOMEM;
198 }
199
084ec9ba 200 pblk_g_rq_cache = kmem_cache_create("pblk_g_rq", pblk_g_rq_size,
a4bd217b 201 0, 0, NULL);
084ec9ba 202 if (!pblk_g_rq_cache) {
b84ae4a8 203 kmem_cache_destroy(pblk_ws_cache);
a4bd217b
JG
204 kmem_cache_destroy(pblk_rec_cache);
205 up_write(&pblk_lock);
206 return -ENOMEM;
207 }
208
209 pblk_w_rq_cache = kmem_cache_create("pblk_w_rq", pblk_w_rq_size,
210 0, 0, NULL);
211 if (!pblk_w_rq_cache) {
b84ae4a8 212 kmem_cache_destroy(pblk_ws_cache);
a4bd217b 213 kmem_cache_destroy(pblk_rec_cache);
084ec9ba 214 kmem_cache_destroy(pblk_g_rq_cache);
a4bd217b
JG
215 up_write(&pblk_lock);
216 return -ENOMEM;
217 }
a4bd217b
JG
218 up_write(&pblk_lock);
219
220 return 0;
221}
222
22a4e061
RP
223static void pblk_free_global_caches(struct pblk *pblk)
224{
225 kmem_cache_destroy(pblk_ws_cache);
226 kmem_cache_destroy(pblk_rec_cache);
227 kmem_cache_destroy(pblk_g_rq_cache);
228 kmem_cache_destroy(pblk_w_rq_cache);
229}
230
a4bd217b
JG
231static int pblk_core_init(struct pblk *pblk)
232{
233 struct nvm_tgt_dev *dev = pblk->dev;
234 struct nvm_geo *geo = &dev->geo;
a4bd217b 235
a4bd217b
JG
236 pblk->pgs_in_buffer = NVM_MEM_PAGE_WRITE * geo->sec_per_pg *
237 geo->nr_planes * geo->nr_luns;
238
a4bd217b
JG
239 if (pblk_init_global_caches(pblk))
240 return -ENOMEM;
241
b84ae4a8 242 /* Internal bios can be at most the sectors signaled by the device. */
bd432417
JG
243 pblk->page_bio_pool = mempool_create_page_pool(nvm_max_phys_sects(dev),
244 0);
245 if (!pblk->page_bio_pool)
22a4e061 246 goto free_global_caches;
a4bd217b 247
b84ae4a8
JG
248 pblk->gen_ws_pool = mempool_create_slab_pool(PBLK_GEN_WS_POOL_SIZE,
249 pblk_ws_cache);
250 if (!pblk->gen_ws_pool)
bd432417 251 goto free_page_bio_pool;
a4bd217b
JG
252
253 pblk->rec_pool = mempool_create_slab_pool(geo->nr_luns, pblk_rec_cache);
254 if (!pblk->rec_pool)
b84ae4a8 255 goto free_gen_ws_pool;
a4bd217b 256
0d880398 257 pblk->r_rq_pool = mempool_create_slab_pool(geo->nr_luns,
ef576494 258 pblk_g_rq_cache);
0d880398 259 if (!pblk->r_rq_pool)
a4bd217b
JG
260 goto free_rec_pool;
261
0d880398
JG
262 pblk->e_rq_pool = mempool_create_slab_pool(geo->nr_luns,
263 pblk_g_rq_cache);
264 if (!pblk->e_rq_pool)
265 goto free_r_rq_pool;
266
267 pblk->w_rq_pool = mempool_create_slab_pool(geo->nr_luns,
ef576494 268 pblk_w_rq_cache);
a4bd217b 269 if (!pblk->w_rq_pool)
0d880398 270 goto free_e_rq_pool;
a4bd217b 271
ef576494
JG
272 pblk->close_wq = alloc_workqueue("pblk-close-wq",
273 WQ_MEM_RECLAIM | WQ_UNBOUND, PBLK_NR_CLOSE_JOBS);
274 if (!pblk->close_wq)
e72ec1d3 275 goto free_w_rq_pool;
a4bd217b 276
ef576494
JG
277 pblk->bb_wq = alloc_workqueue("pblk-bb-wq",
278 WQ_MEM_RECLAIM | WQ_UNBOUND, 0);
279 if (!pblk->bb_wq)
280 goto free_close_wq;
281
7bd4d370
JG
282 pblk->r_end_wq = alloc_workqueue("pblk-read-end-wq",
283 WQ_MEM_RECLAIM | WQ_UNBOUND, 0);
284 if (!pblk->r_end_wq)
ef576494 285 goto free_bb_wq;
a4bd217b 286
7bd4d370
JG
287 if (pblk_set_ppaf(pblk))
288 goto free_r_end_wq;
289
a4bd217b 290 if (pblk_rwb_init(pblk))
7bd4d370 291 goto free_r_end_wq;
a4bd217b
JG
292
293 INIT_LIST_HEAD(&pblk->compl_list);
294 return 0;
295
7bd4d370
JG
296free_r_end_wq:
297 destroy_workqueue(pblk->r_end_wq);
ef576494
JG
298free_bb_wq:
299 destroy_workqueue(pblk->bb_wq);
300free_close_wq:
301 destroy_workqueue(pblk->close_wq);
a4bd217b
JG
302free_w_rq_pool:
303 mempool_destroy(pblk->w_rq_pool);
0d880398
JG
304free_e_rq_pool:
305 mempool_destroy(pblk->e_rq_pool);
306free_r_rq_pool:
307 mempool_destroy(pblk->r_rq_pool);
a4bd217b
JG
308free_rec_pool:
309 mempool_destroy(pblk->rec_pool);
b84ae4a8
JG
310free_gen_ws_pool:
311 mempool_destroy(pblk->gen_ws_pool);
bd432417
JG
312free_page_bio_pool:
313 mempool_destroy(pblk->page_bio_pool);
22a4e061
RP
314free_global_caches:
315 pblk_free_global_caches(pblk);
a4bd217b
JG
316 return -ENOMEM;
317}
318
319static void pblk_core_free(struct pblk *pblk)
320{
ef576494
JG
321 if (pblk->close_wq)
322 destroy_workqueue(pblk->close_wq);
323
7bd4d370
JG
324 if (pblk->r_end_wq)
325 destroy_workqueue(pblk->r_end_wq);
326
ef576494
JG
327 if (pblk->bb_wq)
328 destroy_workqueue(pblk->bb_wq);
a4bd217b 329
bd432417 330 mempool_destroy(pblk->page_bio_pool);
b84ae4a8 331 mempool_destroy(pblk->gen_ws_pool);
a4bd217b 332 mempool_destroy(pblk->rec_pool);
0d880398
JG
333 mempool_destroy(pblk->r_rq_pool);
334 mempool_destroy(pblk->e_rq_pool);
a4bd217b 335 mempool_destroy(pblk->w_rq_pool);
a4bd217b 336
22a4e061 337 pblk_free_global_caches(pblk);
a4bd217b
JG
338}
339
340static void pblk_luns_free(struct pblk *pblk)
341{
342 kfree(pblk->luns);
343}
344
dffdd960
JG
345static void pblk_free_line_bitmaps(struct pblk_line *line)
346{
347 kfree(line->blk_bitmap);
348 kfree(line->erase_bitmap);
349}
350
a4bd217b
JG
351static void pblk_lines_free(struct pblk *pblk)
352{
353 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
354 struct pblk_line *line;
355 int i;
356
357 spin_lock(&l_mg->free_lock);
358 for (i = 0; i < l_mg->nr_lines; i++) {
359 line = &pblk->lines[i];
360
361 pblk_line_free(pblk, line);
dffdd960 362 pblk_free_line_bitmaps(line);
a4bd217b
JG
363 }
364 spin_unlock(&l_mg->free_lock);
365}
366
367static void pblk_line_meta_free(struct pblk *pblk)
368{
369 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
370 int i;
371
372 kfree(l_mg->bb_template);
373 kfree(l_mg->bb_aux);
dd2a4343 374 kfree(l_mg->vsc_list);
a4bd217b 375
588726d3 376 spin_lock(&l_mg->free_lock);
a4bd217b 377 for (i = 0; i < PBLK_DATA_LINES; i++) {
f680f19a 378 kfree(l_mg->sline_meta[i]);
dd2a4343 379 pblk_mfree(l_mg->eline_meta[i]->buf, l_mg->emeta_alloc_type);
f680f19a 380 kfree(l_mg->eline_meta[i]);
a4bd217b 381 }
588726d3 382 spin_unlock(&l_mg->free_lock);
a4bd217b
JG
383
384 kfree(pblk->lines);
385}
386
387static int pblk_bb_discovery(struct nvm_tgt_dev *dev, struct pblk_lun *rlun)
388{
389 struct nvm_geo *geo = &dev->geo;
390 struct ppa_addr ppa;
391 u8 *blks;
392 int nr_blks, ret;
393
394 nr_blks = geo->blks_per_lun * geo->plane_mode;
395 blks = kmalloc(nr_blks, GFP_KERNEL);
396 if (!blks)
397 return -ENOMEM;
398
399 ppa.ppa = 0;
400 ppa.g.ch = rlun->bppa.g.ch;
401 ppa.g.lun = rlun->bppa.g.lun;
402
403 ret = nvm_get_tgt_bb_tbl(dev, ppa, blks);
404 if (ret)
405 goto out;
406
407 nr_blks = nvm_bb_tbl_fold(dev->parent, blks, nr_blks);
408 if (nr_blks < 0) {
a4bd217b 409 ret = nr_blks;
5136a4fd 410 goto out;
a4bd217b
JG
411 }
412
413 rlun->bb_list = blks;
414
5136a4fd 415 return 0;
a4bd217b 416out:
5136a4fd 417 kfree(blks);
a4bd217b
JG
418 return ret;
419}
420
dffdd960
JG
421static int pblk_bb_line(struct pblk *pblk, struct pblk_line *line,
422 int blk_per_line)
a4bd217b 423{
dffdd960
JG
424 struct nvm_tgt_dev *dev = pblk->dev;
425 struct nvm_geo *geo = &dev->geo;
a4bd217b
JG
426 struct pblk_lun *rlun;
427 int bb_cnt = 0;
428 int i;
429
dffdd960
JG
430 for (i = 0; i < blk_per_line; i++) {
431 rlun = &pblk->luns[i];
432 if (rlun->bb_list[line->id] == NVM_BLK_T_FREE)
433 continue;
434
435 set_bit(pblk_ppa_to_pos(geo, rlun->bppa), line->blk_bitmap);
436 bb_cnt++;
437 }
438
439 return bb_cnt;
440}
441
442static int pblk_alloc_line_bitmaps(struct pblk *pblk, struct pblk_line *line)
443{
444 struct pblk_line_meta *lm = &pblk->lm;
445
a4bd217b
JG
446 line->blk_bitmap = kzalloc(lm->blk_bitmap_len, GFP_KERNEL);
447 if (!line->blk_bitmap)
448 return -ENOMEM;
449
450 line->erase_bitmap = kzalloc(lm->blk_bitmap_len, GFP_KERNEL);
451 if (!line->erase_bitmap) {
452 kfree(line->blk_bitmap);
453 return -ENOMEM;
454 }
455
dffdd960 456 return 0;
a4bd217b
JG
457}
458
459static int pblk_luns_init(struct pblk *pblk, struct ppa_addr *luns)
460{
461 struct nvm_tgt_dev *dev = pblk->dev;
462 struct nvm_geo *geo = &dev->geo;
463 struct pblk_lun *rlun;
464 int i, ret;
465
466 /* TODO: Implement unbalanced LUN support */
467 if (geo->luns_per_chnl < 0) {
468 pr_err("pblk: unbalanced LUN config.\n");
469 return -EINVAL;
470 }
471
472 pblk->luns = kcalloc(geo->nr_luns, sizeof(struct pblk_lun), GFP_KERNEL);
473 if (!pblk->luns)
474 return -ENOMEM;
475
476 for (i = 0; i < geo->nr_luns; i++) {
477 /* Stripe across channels */
478 int ch = i % geo->nr_chnls;
479 int lun_raw = i / geo->nr_chnls;
480 int lunid = lun_raw + ch * geo->luns_per_chnl;
481
482 rlun = &pblk->luns[i];
483 rlun->bppa = luns[lunid];
484
485 sema_init(&rlun->wr_sem, 1);
486
487 ret = pblk_bb_discovery(dev, rlun);
488 if (ret) {
489 while (--i >= 0)
490 kfree(pblk->luns[i].bb_list);
491 return ret;
492 }
493 }
494
495 return 0;
496}
497
498static int pblk_lines_configure(struct pblk *pblk, int flags)
499{
500 struct pblk_line *line = NULL;
501 int ret = 0;
502
503 if (!(flags & NVM_TARGET_FACTORY)) {
504 line = pblk_recov_l2p(pblk);
505 if (IS_ERR(line)) {
506 pr_err("pblk: could not recover l2p table\n");
507 ret = -EFAULT;
508 }
509 }
510
37ce33d5
HH
511 /* Free full lines directly as GC has not been started yet */
512 pblk_gc_free_full_lines(pblk);
513
a4bd217b
JG
514 if (!line) {
515 /* Configure next line for user data */
516 line = pblk_line_get_first_data(pblk);
517 if (!line) {
518 pr_err("pblk: line list corrupted\n");
519 ret = -EFAULT;
520 }
521 }
522
523 return ret;
524}
525
526/* See comment over struct line_emeta definition */
dd2a4343 527static unsigned int calc_emeta_len(struct pblk *pblk)
a4bd217b 528{
dd2a4343
JG
529 struct pblk_line_meta *lm = &pblk->lm;
530 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
531 struct nvm_tgt_dev *dev = pblk->dev;
532 struct nvm_geo *geo = &dev->geo;
533
534 /* Round to sector size so that lba_list starts on its own sector */
535 lm->emeta_sec[1] = DIV_ROUND_UP(
536 sizeof(struct line_emeta) + lm->blk_bitmap_len,
537 geo->sec_size);
538 lm->emeta_len[1] = lm->emeta_sec[1] * geo->sec_size;
539
540 /* Round to sector size so that vsc_list starts on its own sector */
541 lm->dsec_per_line = lm->sec_per_line - lm->emeta_sec[0];
542 lm->emeta_sec[2] = DIV_ROUND_UP(lm->dsec_per_line * sizeof(u64),
543 geo->sec_size);
544 lm->emeta_len[2] = lm->emeta_sec[2] * geo->sec_size;
545
546 lm->emeta_sec[3] = DIV_ROUND_UP(l_mg->nr_lines * sizeof(u32),
547 geo->sec_size);
548 lm->emeta_len[3] = lm->emeta_sec[3] * geo->sec_size;
549
550 lm->vsc_list_len = l_mg->nr_lines * sizeof(u32);
551
552 return (lm->emeta_len[1] + lm->emeta_len[2] + lm->emeta_len[3]);
a4bd217b
JG
553}
554
555static void pblk_set_provision(struct pblk *pblk, long nr_free_blks)
556{
557 struct nvm_tgt_dev *dev = pblk->dev;
558 struct nvm_geo *geo = &dev->geo;
559 sector_t provisioned;
560
561 pblk->over_pct = 20;
562
563 provisioned = nr_free_blks;
564 provisioned *= (100 - pblk->over_pct);
565 sector_div(provisioned, 100);
566
567 /* Internally pblk manages all free blocks, but all calculations based
568 * on user capacity consider only provisioned blocks
569 */
570 pblk->rl.total_blocks = nr_free_blks;
571 pblk->rl.nr_secs = nr_free_blks * geo->sec_per_blk;
572 pblk->capacity = provisioned * geo->sec_per_blk;
573 atomic_set(&pblk->rl.free_blocks, nr_free_blks);
574}
575
dd2a4343
JG
576static int pblk_lines_alloc_metadata(struct pblk *pblk)
577{
578 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
579 struct pblk_line_meta *lm = &pblk->lm;
580 int i;
581
582 /* smeta is always small enough to fit on a kmalloc memory allocation,
583 * emeta depends on the number of LUNs allocated to the pblk instance
584 */
dd2a4343
JG
585 for (i = 0; i < PBLK_DATA_LINES; i++) {
586 l_mg->sline_meta[i] = kmalloc(lm->smeta_len, GFP_KERNEL);
587 if (!l_mg->sline_meta[i])
588 goto fail_free_smeta;
589 }
590
591 /* emeta allocates three different buffers for managing metadata with
592 * in-memory and in-media layouts
593 */
594 for (i = 0; i < PBLK_DATA_LINES; i++) {
595 struct pblk_emeta *emeta;
596
597 emeta = kmalloc(sizeof(struct pblk_emeta), GFP_KERNEL);
598 if (!emeta)
599 goto fail_free_emeta;
600
601 if (lm->emeta_len[0] > KMALLOC_MAX_CACHE_SIZE) {
602 l_mg->emeta_alloc_type = PBLK_VMALLOC_META;
603
604 emeta->buf = vmalloc(lm->emeta_len[0]);
605 if (!emeta->buf) {
606 kfree(emeta);
607 goto fail_free_emeta;
608 }
609
610 emeta->nr_entries = lm->emeta_sec[0];
611 l_mg->eline_meta[i] = emeta;
612 } else {
613 l_mg->emeta_alloc_type = PBLK_KMALLOC_META;
614
615 emeta->buf = kmalloc(lm->emeta_len[0], GFP_KERNEL);
616 if (!emeta->buf) {
617 kfree(emeta);
618 goto fail_free_emeta;
619 }
620
621 emeta->nr_entries = lm->emeta_sec[0];
622 l_mg->eline_meta[i] = emeta;
623 }
624 }
625
626 l_mg->vsc_list = kcalloc(l_mg->nr_lines, sizeof(__le32), GFP_KERNEL);
627 if (!l_mg->vsc_list)
628 goto fail_free_emeta;
629
630 for (i = 0; i < l_mg->nr_lines; i++)
631 l_mg->vsc_list[i] = cpu_to_le32(EMPTY_ENTRY);
632
633 return 0;
634
635fail_free_emeta:
636 while (--i >= 0) {
c9d84b35
RP
637 if (l_mg->emeta_alloc_type == PBLK_VMALLOC_META)
638 vfree(l_mg->eline_meta[i]->buf);
639 else
640 kfree(l_mg->eline_meta[i]->buf);
f680f19a 641 kfree(l_mg->eline_meta[i]);
dd2a4343
JG
642 }
643
644fail_free_smeta:
645 for (i = 0; i < PBLK_DATA_LINES; i++)
f680f19a 646 kfree(l_mg->sline_meta[i]);
dd2a4343
JG
647
648 return -ENOMEM;
649}
650
a4bd217b
JG
651static int pblk_lines_init(struct pblk *pblk)
652{
653 struct nvm_tgt_dev *dev = pblk->dev;
654 struct nvm_geo *geo = &dev->geo;
655 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
656 struct pblk_line_meta *lm = &pblk->lm;
657 struct pblk_line *line;
658 unsigned int smeta_len, emeta_len;
d624f371 659 long nr_bad_blks, nr_free_blks;
dd2a4343
JG
660 int bb_distance, max_write_ppas, mod;
661 int i, ret;
662
663 pblk->min_write_pgs = geo->sec_per_pl * (geo->sec_size / PAGE_SIZE);
664 max_write_ppas = pblk->min_write_pgs * geo->nr_luns;
665 pblk->max_write_pgs = (max_write_ppas < nvm_max_phys_sects(dev)) ?
666 max_write_ppas : nvm_max_phys_sects(dev);
667 pblk_set_sec_per_write(pblk, pblk->min_write_pgs);
668
669 if (pblk->max_write_pgs > PBLK_MAX_REQ_ADDRS) {
670 pr_err("pblk: cannot support device max_phys_sect\n");
671 return -EINVAL;
672 }
673
674 div_u64_rem(geo->sec_per_blk, pblk->min_write_pgs, &mod);
675 if (mod) {
676 pr_err("pblk: bad configuration of sectors/pages\n");
677 return -EINVAL;
678 }
679
680 l_mg->nr_lines = geo->blks_per_lun;
681 l_mg->log_line = l_mg->data_line = NULL;
682 l_mg->l_seq_nr = l_mg->d_seq_nr = 0;
683 l_mg->nr_free_lines = 0;
684 bitmap_zero(&l_mg->meta_bitmap, PBLK_DATA_LINES);
a4bd217b
JG
685
686 lm->sec_per_line = geo->sec_per_blk * geo->nr_luns;
687 lm->blk_per_line = geo->nr_luns;
688 lm->blk_bitmap_len = BITS_TO_LONGS(geo->nr_luns) * sizeof(long);
689 lm->sec_bitmap_len = BITS_TO_LONGS(lm->sec_per_line) * sizeof(long);
690 lm->lun_bitmap_len = BITS_TO_LONGS(geo->nr_luns) * sizeof(long);
27b97872
RP
691 lm->mid_thrs = lm->sec_per_line / 2;
692 lm->high_thrs = lm->sec_per_line / 4;
dd2a4343 693 lm->meta_distance = (geo->nr_luns / 2) * pblk->min_write_pgs;
a4bd217b
JG
694
695 /* Calculate necessary pages for smeta. See comment over struct
696 * line_smeta definition
697 */
a4bd217b
JG
698 i = 1;
699add_smeta_page:
700 lm->smeta_sec = i * geo->sec_per_pl;
701 lm->smeta_len = lm->smeta_sec * geo->sec_size;
702
dd2a4343 703 smeta_len = sizeof(struct line_smeta) + lm->lun_bitmap_len;
a4bd217b
JG
704 if (smeta_len > lm->smeta_len) {
705 i++;
706 goto add_smeta_page;
707 }
708
709 /* Calculate necessary pages for emeta. See comment over struct
710 * line_emeta definition
711 */
712 i = 1;
713add_emeta_page:
dd2a4343
JG
714 lm->emeta_sec[0] = i * geo->sec_per_pl;
715 lm->emeta_len[0] = lm->emeta_sec[0] * geo->sec_size;
a4bd217b 716
dd2a4343
JG
717 emeta_len = calc_emeta_len(pblk);
718 if (emeta_len > lm->emeta_len[0]) {
a4bd217b
JG
719 i++;
720 goto add_emeta_page;
721 }
a4bd217b 722
e6b754c2 723 lm->emeta_bb = geo->nr_luns > i ? geo->nr_luns - i : 0;
21d22871
JG
724
725 lm->min_blk_line = 1;
726 if (geo->nr_luns > 1)
727 lm->min_blk_line += DIV_ROUND_UP(lm->smeta_sec +
728 lm->emeta_sec[0], geo->sec_per_blk);
729
b5e063a2
JG
730 if (lm->min_blk_line > lm->blk_per_line) {
731 pr_err("pblk: config. not supported. Min. LUN in line:%d\n",
732 lm->blk_per_line);
733 ret = -EINVAL;
734 goto fail;
735 }
a4bd217b 736
dd2a4343
JG
737 ret = pblk_lines_alloc_metadata(pblk);
738 if (ret)
739 goto fail;
a4bd217b
JG
740
741 l_mg->bb_template = kzalloc(lm->sec_bitmap_len, GFP_KERNEL);
1c6286f2
DC
742 if (!l_mg->bb_template) {
743 ret = -ENOMEM;
a4bd217b 744 goto fail_free_meta;
1c6286f2 745 }
a4bd217b
JG
746
747 l_mg->bb_aux = kzalloc(lm->sec_bitmap_len, GFP_KERNEL);
1c6286f2
DC
748 if (!l_mg->bb_aux) {
749 ret = -ENOMEM;
a4bd217b 750 goto fail_free_bb_template;
1c6286f2 751 }
a4bd217b
JG
752
753 bb_distance = (geo->nr_luns) * geo->sec_per_pl;
754 for (i = 0; i < lm->sec_per_line; i += bb_distance)
755 bitmap_set(l_mg->bb_template, i, geo->sec_per_pl);
756
757 INIT_LIST_HEAD(&l_mg->free_list);
758 INIT_LIST_HEAD(&l_mg->corrupt_list);
759 INIT_LIST_HEAD(&l_mg->bad_list);
760 INIT_LIST_HEAD(&l_mg->gc_full_list);
761 INIT_LIST_HEAD(&l_mg->gc_high_list);
762 INIT_LIST_HEAD(&l_mg->gc_mid_list);
763 INIT_LIST_HEAD(&l_mg->gc_low_list);
764 INIT_LIST_HEAD(&l_mg->gc_empty_list);
765
dd2a4343
JG
766 INIT_LIST_HEAD(&l_mg->emeta_list);
767
a4bd217b
JG
768 l_mg->gc_lists[0] = &l_mg->gc_high_list;
769 l_mg->gc_lists[1] = &l_mg->gc_mid_list;
770 l_mg->gc_lists[2] = &l_mg->gc_low_list;
771
772 spin_lock_init(&l_mg->free_lock);
dd2a4343 773 spin_lock_init(&l_mg->close_lock);
a4bd217b
JG
774 spin_lock_init(&l_mg->gc_lock);
775
776 pblk->lines = kcalloc(l_mg->nr_lines, sizeof(struct pblk_line),
777 GFP_KERNEL);
1c6286f2
DC
778 if (!pblk->lines) {
779 ret = -ENOMEM;
a4bd217b 780 goto fail_free_bb_aux;
1c6286f2 781 }
a4bd217b
JG
782
783 nr_free_blks = 0;
784 for (i = 0; i < l_mg->nr_lines; i++) {
a44f53fa
JG
785 int blk_in_line;
786
a4bd217b
JG
787 line = &pblk->lines[i];
788
789 line->pblk = pblk;
790 line->id = i;
791 line->type = PBLK_LINETYPE_FREE;
792 line->state = PBLK_LINESTATE_FREE;
793 line->gc_group = PBLK_LINEGC_NONE;
dd2a4343 794 line->vsc = &l_mg->vsc_list[i];
a4bd217b
JG
795 spin_lock_init(&line->lock);
796
dffdd960
JG
797 ret = pblk_alloc_line_bitmaps(pblk, line);
798 if (ret)
799 goto fail_free_lines;
800
801 nr_bad_blks = pblk_bb_line(pblk, line, lm->blk_per_line);
1c6286f2 802 if (nr_bad_blks < 0 || nr_bad_blks > lm->blk_per_line) {
dffdd960 803 pblk_free_line_bitmaps(line);
1c6286f2 804 ret = -EINVAL;
a4bd217b 805 goto fail_free_lines;
1c6286f2 806 }
a4bd217b 807
a44f53fa
JG
808 blk_in_line = lm->blk_per_line - nr_bad_blks;
809 if (blk_in_line < lm->min_blk_line) {
a4bd217b
JG
810 line->state = PBLK_LINESTATE_BAD;
811 list_add_tail(&line->list, &l_mg->bad_list);
812 continue;
813 }
814
a44f53fa
JG
815 nr_free_blks += blk_in_line;
816 atomic_set(&line->blk_in_line, blk_in_line);
a4bd217b
JG
817
818 l_mg->nr_free_lines++;
819 list_add_tail(&line->list, &l_mg->free_list);
820 }
821
822 pblk_set_provision(pblk, nr_free_blks);
823
a4bd217b
JG
824 /* Cleanup per-LUN bad block lists - managed within lines on run-time */
825 for (i = 0; i < geo->nr_luns; i++)
826 kfree(pblk->luns[i].bb_list);
827
828 return 0;
829fail_free_lines:
dffdd960
JG
830 while (--i >= 0)
831 pblk_free_line_bitmaps(&pblk->lines[i]);
a4bd217b
JG
832fail_free_bb_aux:
833 kfree(l_mg->bb_aux);
834fail_free_bb_template:
835 kfree(l_mg->bb_template);
836fail_free_meta:
dd2a4343 837 pblk_line_meta_free(pblk);
a4bd217b
JG
838fail:
839 for (i = 0; i < geo->nr_luns; i++)
840 kfree(pblk->luns[i].bb_list);
841
842 return ret;
843}
844
845static int pblk_writer_init(struct pblk *pblk)
846{
847 setup_timer(&pblk->wtimer, pblk_write_timer_fn, (unsigned long)pblk);
848 mod_timer(&pblk->wtimer, jiffies + msecs_to_jiffies(100));
849
850 pblk->writer_ts = kthread_create(pblk_write_ts, pblk, "pblk-writer-t");
851 if (IS_ERR(pblk->writer_ts)) {
852 pr_err("pblk: could not allocate writer kthread\n");
1c6286f2 853 return PTR_ERR(pblk->writer_ts);
a4bd217b
JG
854 }
855
856 return 0;
857}
858
859static void pblk_writer_stop(struct pblk *pblk)
860{
ee8d5c1a
JG
861 /* The pipeline must be stopped and the write buffer emptied before the
862 * write thread is stopped
863 */
864 WARN(pblk_rb_read_count(&pblk->rwb),
865 "Stopping not fully persisted write buffer\n");
866
867 WARN(pblk_rb_sync_count(&pblk->rwb),
868 "Stopping not fully synced write buffer\n");
869
a4bd217b
JG
870 if (pblk->writer_ts)
871 kthread_stop(pblk->writer_ts);
872 del_timer(&pblk->wtimer);
873}
874
875static void pblk_free(struct pblk *pblk)
876{
877 pblk_luns_free(pblk);
878 pblk_lines_free(pblk);
879 pblk_line_meta_free(pblk);
880 pblk_core_free(pblk);
881 pblk_l2p_free(pblk);
882
883 kfree(pblk);
884}
885
886static void pblk_tear_down(struct pblk *pblk)
887{
588726d3 888 pblk_pipeline_stop(pblk);
a4bd217b
JG
889 pblk_writer_stop(pblk);
890 pblk_rb_sync_l2p(&pblk->rwb);
a4bd217b
JG
891 pblk_rwb_free(pblk);
892 pblk_rl_free(&pblk->rl);
893
894 pr_debug("pblk: consistent tear down\n");
895}
896
897static void pblk_exit(void *private)
898{
899 struct pblk *pblk = private;
900
901 down_write(&pblk_lock);
902 pblk_gc_exit(pblk);
903 pblk_tear_down(pblk);
904 pblk_free(pblk);
905 up_write(&pblk_lock);
906}
907
908static sector_t pblk_capacity(void *private)
909{
910 struct pblk *pblk = private;
911
912 return pblk->capacity * NR_PHY_IN_LOG;
913}
914
915static void *pblk_init(struct nvm_tgt_dev *dev, struct gendisk *tdisk,
916 int flags)
917{
918 struct nvm_geo *geo = &dev->geo;
919 struct request_queue *bqueue = dev->q;
920 struct request_queue *tqueue = tdisk->queue;
921 struct pblk *pblk;
922 int ret;
923
924 if (dev->identity.dom & NVM_RSP_L2P) {
4e76af53 925 pr_err("pblk: host-side L2P table not supported. (%x)\n",
a4bd217b
JG
926 dev->identity.dom);
927 return ERR_PTR(-EINVAL);
928 }
929
930 pblk = kzalloc(sizeof(struct pblk), GFP_KERNEL);
931 if (!pblk)
932 return ERR_PTR(-ENOMEM);
933
934 pblk->dev = dev;
935 pblk->disk = tdisk;
588726d3 936 pblk->state = PBLK_STATE_RUNNING;
3e3a5b8e 937 pblk->gc.gc_enabled = 0;
a4bd217b
JG
938
939 spin_lock_init(&pblk->trans_lock);
940 spin_lock_init(&pblk->lock);
941
942 if (flags & NVM_TARGET_FACTORY)
943 pblk_setup_uuid(pblk);
944
945#ifdef CONFIG_NVM_DEBUG
946 atomic_long_set(&pblk->inflight_writes, 0);
947 atomic_long_set(&pblk->padded_writes, 0);
948 atomic_long_set(&pblk->padded_wb, 0);
949 atomic_long_set(&pblk->nr_flush, 0);
950 atomic_long_set(&pblk->req_writes, 0);
951 atomic_long_set(&pblk->sub_writes, 0);
952 atomic_long_set(&pblk->sync_writes, 0);
a4bd217b 953 atomic_long_set(&pblk->inflight_reads, 0);
db7ada33 954 atomic_long_set(&pblk->cache_reads, 0);
a4bd217b
JG
955 atomic_long_set(&pblk->sync_reads, 0);
956 atomic_long_set(&pblk->recov_writes, 0);
957 atomic_long_set(&pblk->recov_writes, 0);
958 atomic_long_set(&pblk->recov_gc_writes, 0);
a1121176 959 atomic_long_set(&pblk->recov_gc_reads, 0);
a4bd217b
JG
960#endif
961
962 atomic_long_set(&pblk->read_failed, 0);
963 atomic_long_set(&pblk->read_empty, 0);
964 atomic_long_set(&pblk->read_high_ecc, 0);
965 atomic_long_set(&pblk->read_failed_gc, 0);
966 atomic_long_set(&pblk->write_failed, 0);
967 atomic_long_set(&pblk->erase_failed, 0);
968
969 ret = pblk_luns_init(pblk, dev->luns);
970 if (ret) {
971 pr_err("pblk: could not initialize luns\n");
972 goto fail;
973 }
974
975 ret = pblk_lines_init(pblk);
976 if (ret) {
977 pr_err("pblk: could not initialize lines\n");
978 goto fail_free_luns;
979 }
980
981 ret = pblk_core_init(pblk);
982 if (ret) {
983 pr_err("pblk: could not initialize core\n");
984 goto fail_free_line_meta;
985 }
986
987 ret = pblk_l2p_init(pblk);
988 if (ret) {
989 pr_err("pblk: could not initialize maps\n");
990 goto fail_free_core;
991 }
992
993 ret = pblk_lines_configure(pblk, flags);
994 if (ret) {
995 pr_err("pblk: could not configure lines\n");
996 goto fail_free_l2p;
997 }
998
999 ret = pblk_writer_init(pblk);
1000 if (ret) {
1001 pr_err("pblk: could not initialize write thread\n");
1002 goto fail_free_lines;
1003 }
1004
1005 ret = pblk_gc_init(pblk);
1006 if (ret) {
1007 pr_err("pblk: could not initialize gc\n");
1008 goto fail_stop_writer;
1009 }
1010
1011 /* inherit the size from the underlying device */
1012 blk_queue_logical_block_size(tqueue, queue_physical_block_size(bqueue));
1013 blk_queue_max_hw_sectors(tqueue, queue_max_hw_sectors(bqueue));
1014
1015 blk_queue_write_cache(tqueue, true, false);
1016
1017 tqueue->limits.discard_granularity = geo->pgs_per_blk * geo->pfpg_size;
1018 tqueue->limits.discard_alignment = 0;
1019 blk_queue_max_discard_sectors(tqueue, UINT_MAX >> 9);
1020 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, tqueue);
1021
1022 pr_info("pblk init: luns:%u, lines:%d, secs:%llu, buf entries:%u\n",
1023 geo->nr_luns, pblk->l_mg.nr_lines,
1024 (unsigned long long)pblk->rl.nr_secs,
1025 pblk->rwb.nr_entries);
1026
1027 wake_up_process(pblk->writer_ts);
1028 return pblk;
1029
1030fail_stop_writer:
1031 pblk_writer_stop(pblk);
1032fail_free_lines:
1033 pblk_lines_free(pblk);
1034fail_free_l2p:
1035 pblk_l2p_free(pblk);
1036fail_free_core:
1037 pblk_core_free(pblk);
1038fail_free_line_meta:
1039 pblk_line_meta_free(pblk);
1040fail_free_luns:
1041 pblk_luns_free(pblk);
1042fail:
1043 kfree(pblk);
1044 return ERR_PTR(ret);
1045}
1046
1047/* physical block device target */
1048static struct nvm_tgt_type tt_pblk = {
1049 .name = "pblk",
1050 .version = {1, 0, 0},
1051
1052 .make_rq = pblk_make_rq,
1053 .capacity = pblk_capacity,
1054
1055 .init = pblk_init,
1056 .exit = pblk_exit,
1057
1058 .sysfs_init = pblk_sysfs_init,
1059 .sysfs_exit = pblk_sysfs_exit,
90014829 1060 .owner = THIS_MODULE,
a4bd217b
JG
1061};
1062
1063static int __init pblk_module_init(void)
1064{
b25d5237
N
1065 int ret;
1066
1067 pblk_bio_set = bioset_create(BIO_POOL_SIZE, 0, 0);
1068 if (!pblk_bio_set)
1069 return -ENOMEM;
1070 ret = nvm_register_tgt_type(&tt_pblk);
1071 if (ret)
1072 bioset_free(pblk_bio_set);
1073 return ret;
a4bd217b
JG
1074}
1075
1076static void pblk_module_exit(void)
1077{
b25d5237 1078 bioset_free(pblk_bio_set);
a4bd217b
JG
1079 nvm_unregister_tgt_type(&tt_pblk);
1080}
1081
1082module_init(pblk_module_init);
1083module_exit(pblk_module_exit);
1084MODULE_AUTHOR("Javier Gonzalez <javier@cnexlabs.com>");
1085MODULE_AUTHOR("Matias Bjorling <matias@cnexlabs.com>");
1086MODULE_LICENSE("GPL v2");
1087MODULE_DESCRIPTION("Physical Block-Device for Open-Channel SSDs");