2 * Copyright (C) 2016 CNEX Labs
3 * Initial release: Javier Gonzalez <javier@cnexlabs.com>
4 * Matias Bjorling <matias@cnexlabs.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * pblk-write.c - pblk's write path from write buffer to media
20 static unsigned long pblk_end_w_bio(struct pblk *pblk, struct nvm_rq *rqd,
21 struct pblk_c_ctx *c_ctx)
23 struct nvm_tgt_dev *dev = pblk->dev;
24 struct bio *original_bio;
28 for (i = 0; i < c_ctx->nr_valid; i++) {
29 struct pblk_w_ctx *w_ctx;
31 w_ctx = pblk_rb_w_ctx(&pblk->rwb, c_ctx->sentry + i);
32 while ((original_bio = bio_list_pop(&w_ctx->bios)))
33 bio_endio(original_bio);
36 #ifdef CONFIG_NVM_DEBUG
37 atomic_long_add(c_ctx->nr_valid, &pblk->sync_writes);
40 ret = pblk_rb_sync_advance(&pblk->rwb, c_ctx->nr_valid);
43 nvm_dev_dma_free(dev->parent, rqd->meta_list,
47 pblk_free_rqd(pblk, rqd, WRITE);
52 static unsigned long pblk_end_queued_w_bio(struct pblk *pblk,
54 struct pblk_c_ctx *c_ctx)
56 list_del(&c_ctx->list);
57 return pblk_end_w_bio(pblk, rqd, c_ctx);
60 static void pblk_complete_write(struct pblk *pblk, struct nvm_rq *rqd,
61 struct pblk_c_ctx *c_ctx)
63 struct pblk_c_ctx *c, *r;
67 #ifdef CONFIG_NVM_DEBUG
68 atomic_long_sub(c_ctx->nr_valid, &pblk->inflight_writes);
71 pblk_up_rq(pblk, rqd->ppa_list, rqd->nr_ppas, c_ctx->lun_bitmap);
73 pos = pblk_rb_sync_init(&pblk->rwb, &flags);
74 if (pos == c_ctx->sentry) {
75 pos = pblk_end_w_bio(pblk, rqd, c_ctx);
78 list_for_each_entry_safe(c, r, &pblk->compl_list, list) {
79 rqd = nvm_rq_from_c_ctx(c);
80 if (c->sentry == pos) {
81 pos = pblk_end_queued_w_bio(pblk, rqd, c);
86 WARN_ON(nvm_rq_from_c_ctx(c_ctx) != rqd);
87 list_add_tail(&c_ctx->list, &pblk->compl_list);
89 pblk_rb_sync_end(&pblk->rwb, &flags);
92 /* When a write fails, we are not sure whether the block has grown bad or a page
93 * range is more susceptible to write errors. If a high number of pages fail, we
94 * assume that the block is bad and we mark it accordingly. In all cases, we
95 * remap and resubmit the failed entries as fast as possible; if a flush is
96 * waiting on a completion, the whole stack would stall otherwise.
98 static void pblk_end_w_fail(struct pblk *pblk, struct nvm_rq *rqd)
100 void *comp_bits = &rqd->ppa_status;
101 struct pblk_c_ctx *c_ctx = nvm_rq_to_pdu(rqd);
102 struct pblk_rec_ctx *recovery;
103 struct ppa_addr *ppa_list = rqd->ppa_list;
104 int nr_ppas = rqd->nr_ppas;
105 unsigned int c_entries;
108 if (unlikely(nr_ppas == 1))
109 ppa_list = &rqd->ppa_addr;
111 recovery = mempool_alloc(pblk->rec_pool, GFP_ATOMIC);
113 pr_err("pblk: could not allocate recovery context\n");
116 INIT_LIST_HEAD(&recovery->failed);
119 while ((bit = find_next_bit(comp_bits, nr_ppas, bit + 1)) < nr_ppas) {
120 struct pblk_rb_entry *entry;
124 if (bit > c_ctx->nr_valid) {
125 WARN_ONCE(1, "pblk: corrupted write request\n");
126 mempool_free(recovery, pblk->rec_pool);
131 entry = pblk_rb_sync_scan_entry(&pblk->rwb, &ppa);
133 pr_err("pblk: could not scan entry on write failure\n");
134 mempool_free(recovery, pblk->rec_pool);
138 /* The list is filled first and emptied afterwards. No need for
139 * protecting it with a lock
141 list_add_tail(&entry->index, &recovery->failed);
144 c_entries = find_first_bit(comp_bits, nr_ppas);
145 ret = pblk_recov_setup_rq(pblk, c_ctx, recovery, comp_bits, c_entries);
147 pr_err("pblk: could not recover from write failure\n");
148 mempool_free(recovery, pblk->rec_pool);
152 INIT_WORK(&recovery->ws_rec, pblk_submit_rec);
153 queue_work(pblk->kw_wq, &recovery->ws_rec);
156 pblk_complete_write(pblk, rqd, c_ctx);
159 static void pblk_end_io_write(struct nvm_rq *rqd)
161 struct pblk *pblk = rqd->private;
162 struct pblk_c_ctx *c_ctx = nvm_rq_to_pdu(rqd);
165 pblk_log_write_err(pblk, rqd);
166 return pblk_end_w_fail(pblk, rqd);
168 #ifdef CONFIG_NVM_DEBUG
170 WARN_ONCE(rqd->bio->bi_status, "pblk: corrupted write error\n");
173 pblk_complete_write(pblk, rqd, c_ctx);
176 static void pblk_end_io_write_meta(struct nvm_rq *rqd)
178 struct pblk *pblk = rqd->private;
179 struct nvm_tgt_dev *dev = pblk->dev;
180 struct nvm_geo *geo = &dev->geo;
181 struct pblk_g_ctx *m_ctx = nvm_rq_to_pdu(rqd);
182 struct pblk_line *line = m_ctx->private;
183 struct pblk_emeta *emeta = line->emeta;
184 int pos = pblk_ppa_to_pos(geo, rqd->ppa_list[0]);
185 struct pblk_lun *rlun = &pblk->luns[pos];
191 pblk_log_write_err(pblk, rqd);
192 pr_err("pblk: metadata I/O failed\n");
194 #ifdef CONFIG_NVM_DEBUG
196 WARN_ONCE(rqd->bio->bi_status, "pblk: corrupted write error\n");
199 sync = atomic_add_return(rqd->nr_ppas, &emeta->sync);
200 if (sync == emeta->nr_entries)
201 pblk_line_run_ws(pblk, line, NULL, pblk_line_close_ws);
204 pblk_free_rqd(pblk, rqd, READ);
207 static int pblk_alloc_w_rq(struct pblk *pblk, struct nvm_rq *rqd,
208 unsigned int nr_secs,
209 nvm_end_io_fn(*end_io))
211 struct nvm_tgt_dev *dev = pblk->dev;
213 /* Setup write request */
214 rqd->opcode = NVM_OP_PWRITE;
215 rqd->nr_ppas = nr_secs;
216 rqd->flags = pblk_set_progr_mode(pblk, WRITE);
218 rqd->end_io = end_io;
220 rqd->meta_list = nvm_dev_dma_alloc(dev->parent, GFP_KERNEL,
221 &rqd->dma_meta_list);
225 if (unlikely(nr_secs == 1))
228 rqd->ppa_list = rqd->meta_list + pblk_dma_meta_size;
229 rqd->dma_ppa_list = rqd->dma_meta_list + pblk_dma_meta_size;
234 static int pblk_setup_w_rq(struct pblk *pblk, struct nvm_rq *rqd,
235 struct pblk_c_ctx *c_ctx, struct ppa_addr *erase_ppa)
237 struct pblk_line_meta *lm = &pblk->lm;
238 struct pblk_line *e_line = pblk_line_get_erase(pblk);
239 unsigned int valid = c_ctx->nr_valid;
240 unsigned int padded = c_ctx->nr_padded;
241 unsigned int nr_secs = valid + padded;
242 unsigned long *lun_bitmap;
245 lun_bitmap = kzalloc(lm->lun_bitmap_len, GFP_KERNEL);
248 c_ctx->lun_bitmap = lun_bitmap;
250 ret = pblk_alloc_w_rq(pblk, rqd, nr_secs, pblk_end_io_write);
256 if (likely(!atomic_read(&e_line->left_eblks) || !e_line))
257 pblk_map_rq(pblk, rqd, c_ctx->sentry, lun_bitmap, valid, 0);
259 pblk_map_erase_rq(pblk, rqd, c_ctx->sentry, lun_bitmap,
265 int pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
266 struct pblk_c_ctx *c_ctx)
268 struct pblk_line_meta *lm = &pblk->lm;
269 unsigned long *lun_bitmap;
272 lun_bitmap = kzalloc(lm->lun_bitmap_len, GFP_KERNEL);
276 c_ctx->lun_bitmap = lun_bitmap;
278 ret = pblk_alloc_w_rq(pblk, rqd, rqd->nr_ppas, pblk_end_io_write);
282 pblk_map_rq(pblk, rqd, c_ctx->sentry, lun_bitmap, c_ctx->nr_valid, 0);
284 rqd->ppa_status = (u64)0;
285 rqd->flags = pblk_set_progr_mode(pblk, WRITE);
290 static int pblk_calc_secs_to_sync(struct pblk *pblk, unsigned int secs_avail,
291 unsigned int secs_to_flush)
295 secs_to_sync = pblk_calc_secs(pblk, secs_avail, secs_to_flush);
297 #ifdef CONFIG_NVM_DEBUG
298 if ((!secs_to_sync && secs_to_flush)
299 || (secs_to_sync < 0)
300 || (secs_to_sync > secs_avail && !secs_to_flush)) {
301 pr_err("pblk: bad sector calculation (a:%d,s:%d,f:%d)\n",
302 secs_avail, secs_to_sync, secs_to_flush);
309 static inline int pblk_valid_meta_ppa(struct pblk *pblk,
310 struct pblk_line *meta_line,
311 struct ppa_addr *ppa_list, int nr_ppas)
313 struct nvm_tgt_dev *dev = pblk->dev;
314 struct nvm_geo *geo = &dev->geo;
315 struct pblk_line *data_line;
316 struct ppa_addr ppa, ppa_opt;
320 data_line = &pblk->lines[pblk_dev_ppa_to_line(ppa_list[0])];
321 paddr = pblk_lookup_page(pblk, meta_line);
322 ppa = addr_to_gen_ppa(pblk, paddr, 0);
324 if (test_bit(pblk_ppa_to_pos(geo, ppa), data_line->blk_bitmap))
327 /* Schedule a metadata I/O that is half the distance from the data I/O
328 * with regards to the number of LUNs forming the pblk instance. This
329 * balances LUN conflicts across every I/O.
331 * When the LUN configuration changes (e.g., due to GC), this distance
332 * can align, which would result on a LUN deadlock. In this case, modify
333 * the distance to not be optimal, but allow metadata I/Os to succeed.
335 ppa_opt = addr_to_gen_ppa(pblk, paddr + data_line->meta_distance, 0);
336 if (unlikely(ppa_opt.ppa == ppa.ppa)) {
337 data_line->meta_distance--;
341 for (i = 0; i < nr_ppas; i += pblk->min_write_pgs)
342 if (ppa_list[i].g.ch == ppa_opt.g.ch &&
343 ppa_list[i].g.lun == ppa_opt.g.lun)
346 if (test_bit(pblk_ppa_to_pos(geo, ppa_opt), data_line->blk_bitmap)) {
347 for (i = 0; i < nr_ppas; i += pblk->min_write_pgs)
348 if (ppa_list[i].g.ch == ppa.g.ch &&
349 ppa_list[i].g.lun == ppa.g.lun)
358 int pblk_submit_meta_io(struct pblk *pblk, struct pblk_line *meta_line)
360 struct nvm_tgt_dev *dev = pblk->dev;
361 struct nvm_geo *geo = &dev->geo;
362 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
363 struct pblk_line_meta *lm = &pblk->lm;
364 struct pblk_emeta *emeta = meta_line->emeta;
365 struct pblk_g_ctx *m_ctx;
366 struct pblk_lun *rlun;
371 int rq_ppas = pblk->min_write_pgs;
372 int id = meta_line->id;
377 rqd = pblk_alloc_rqd(pblk, READ);
379 pr_err("pblk: cannot allocate write req.\n");
382 m_ctx = nvm_rq_to_pdu(rqd);
383 m_ctx->private = meta_line;
385 rq_len = rq_ppas * geo->sec_size;
386 data = ((void *)emeta->buf) + emeta->mem;
388 bio = pblk_bio_map_addr(pblk, data, rq_ppas, rq_len, GFP_KERNEL);
393 bio->bi_iter.bi_sector = 0; /* internal bio */
394 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
397 ret = pblk_alloc_w_rq(pblk, rqd, rq_ppas, pblk_end_io_write_meta);
401 for (i = 0; i < rqd->nr_ppas; ) {
402 spin_lock(&meta_line->lock);
403 paddr = __pblk_alloc_page(pblk, meta_line, rq_ppas);
404 spin_unlock(&meta_line->lock);
405 for (j = 0; j < rq_ppas; j++, i++, paddr++)
406 rqd->ppa_list[i] = addr_to_gen_ppa(pblk, paddr, id);
409 rlun = &pblk->luns[pblk_ppa_to_pos(geo, rqd->ppa_list[0])];
410 ret = down_timeout(&rlun->wr_sem, msecs_to_jiffies(5000));
412 pr_err("pblk: lun semaphore timed out (%d)\n", ret);
416 emeta->mem += rq_len;
417 if (emeta->mem >= lm->emeta_len[0]) {
418 spin_lock(&l_mg->close_lock);
419 list_del(&meta_line->list);
420 WARN(!bitmap_full(meta_line->map_bitmap, lm->sec_per_line),
421 "pblk: corrupt meta line %d\n", meta_line->id);
422 spin_unlock(&l_mg->close_lock);
425 ret = pblk_submit_io(pblk, rqd);
427 pr_err("pblk: emeta I/O submission failed: %d\n", ret);
434 spin_lock(&l_mg->close_lock);
435 pblk_dealloc_page(pblk, meta_line, rq_ppas);
436 list_add(&meta_line->list, &meta_line->list);
437 spin_unlock(&l_mg->close_lock);
439 if (likely(l_mg->emeta_alloc_type == PBLK_VMALLOC_META))
442 pblk_free_rqd(pblk, rqd, READ);
446 static int pblk_sched_meta_io(struct pblk *pblk, struct ppa_addr *prev_list,
449 struct pblk_line_meta *lm = &pblk->lm;
450 struct pblk_line_mgmt *l_mg = &pblk->l_mg;
451 struct pblk_line *meta_line;
453 spin_lock(&l_mg->close_lock);
455 if (list_empty(&l_mg->emeta_list)) {
456 spin_unlock(&l_mg->close_lock);
459 meta_line = list_first_entry(&l_mg->emeta_list, struct pblk_line, list);
460 if (bitmap_full(meta_line->map_bitmap, lm->sec_per_line))
462 spin_unlock(&l_mg->close_lock);
464 if (!pblk_valid_meta_ppa(pblk, meta_line, prev_list, prev_n))
467 return pblk_submit_meta_io(pblk, meta_line);
470 static int pblk_submit_io_set(struct pblk *pblk, struct nvm_rq *rqd)
472 struct pblk_c_ctx *c_ctx = nvm_rq_to_pdu(rqd);
473 struct ppa_addr erase_ppa;
476 ppa_set_empty(&erase_ppa);
478 /* Assign lbas to ppas and populate request structure */
479 err = pblk_setup_w_rq(pblk, rqd, c_ctx, &erase_ppa);
481 pr_err("pblk: could not setup write request: %d\n", err);
485 if (likely(ppa_empty(erase_ppa))) {
486 /* Submit metadata write for previous data line */
487 err = pblk_sched_meta_io(pblk, rqd->ppa_list, rqd->nr_ppas);
489 pr_err("pblk: metadata I/O submission failed: %d", err);
493 /* Submit data write for current data line */
494 err = pblk_submit_io(pblk, rqd);
496 pr_err("pblk: data I/O submission failed: %d\n", err);
500 /* Submit data write for current data line */
501 err = pblk_submit_io(pblk, rqd);
503 pr_err("pblk: data I/O submission failed: %d\n", err);
507 /* Submit available erase for next data line */
508 if (pblk_blk_erase_async(pblk, erase_ppa)) {
509 struct pblk_line *e_line = pblk_line_get_erase(pblk);
510 struct nvm_tgt_dev *dev = pblk->dev;
511 struct nvm_geo *geo = &dev->geo;
514 atomic_inc(&e_line->left_eblks);
515 bit = pblk_ppa_to_pos(geo, erase_ppa);
516 WARN_ON(!test_and_clear_bit(bit, e_line->erase_bitmap));
523 static void pblk_free_write_rqd(struct pblk *pblk, struct nvm_rq *rqd)
525 struct pblk_c_ctx *c_ctx = nvm_rq_to_pdu(rqd);
526 struct bio *bio = rqd->bio;
528 if (c_ctx->nr_padded)
529 pblk_bio_free_pages(pblk, bio, rqd->nr_ppas, c_ctx->nr_padded);
532 static int pblk_submit_write(struct pblk *pblk)
536 unsigned int secs_avail, secs_to_sync, secs_to_com;
537 unsigned int secs_to_flush;
540 /* If there are no sectors in the cache, flushes (bios without data)
541 * will be cleared on the cache threads
543 secs_avail = pblk_rb_read_count(&pblk->rwb);
547 secs_to_flush = pblk_rb_sync_point_count(&pblk->rwb);
548 if (!secs_to_flush && secs_avail < pblk->min_write_pgs)
551 rqd = pblk_alloc_rqd(pblk, WRITE);
553 pr_err("pblk: cannot allocate write req.\n");
557 bio = bio_alloc(GFP_KERNEL, pblk->max_write_pgs);
559 pr_err("pblk: cannot allocate write bio\n");
562 bio->bi_iter.bi_sector = 0; /* internal bio */
563 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
566 secs_to_sync = pblk_calc_secs_to_sync(pblk, secs_avail, secs_to_flush);
567 if (secs_to_sync > pblk->max_write_pgs) {
568 pr_err("pblk: bad buffer sync calculation\n");
572 secs_to_com = (secs_to_sync > secs_avail) ? secs_avail : secs_to_sync;
573 pos = pblk_rb_read_commit(&pblk->rwb, secs_to_com);
575 if (pblk_rb_read_to_bio(&pblk->rwb, rqd, bio, pos, secs_to_sync,
577 pr_err("pblk: corrupted write bio\n");
581 if (pblk_submit_io_set(pblk, rqd))
584 #ifdef CONFIG_NVM_DEBUG
585 atomic_long_add(secs_to_sync, &pblk->sub_writes);
591 pblk_free_write_rqd(pblk, rqd);
595 pblk_free_rqd(pblk, rqd, WRITE);
600 int pblk_write_ts(void *data)
602 struct pblk *pblk = data;
604 while (!kthread_should_stop()) {
605 if (!pblk_submit_write(pblk))
607 set_current_state(TASK_INTERRUPTIBLE);