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