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