pblk-rb.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. /*
  2. * Copyright (C) 2016 CNEX Labs
  3. * Initial release: Javier Gonzalez <javier@cnexlabs.com>
  4. *
  5. * Based upon the circular ringbuffer.
  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. * pblk-rb.c - pblk's write buffer
  17. */
  18. #include <linux/circ_buf.h>
  19. #include "pblk.h"
  20. static DECLARE_RWSEM(pblk_rb_lock);
  21. void pblk_rb_data_free(struct pblk_rb *rb)
  22. {
  23. struct pblk_rb_pages *p, *t;
  24. down_write(&pblk_rb_lock);
  25. list_for_each_entry_safe(p, t, &rb->pages, list) {
  26. free_pages((unsigned long)page_address(p->pages), p->order);
  27. list_del(&p->list);
  28. kfree(p);
  29. }
  30. up_write(&pblk_rb_lock);
  31. }
  32. /*
  33. * Initialize ring buffer. The data and metadata buffers must be previously
  34. * allocated and their size must be a power of two
  35. * (Documentation/circular-buffers.txt)
  36. */
  37. int pblk_rb_init(struct pblk_rb *rb, struct pblk_rb_entry *rb_entry_base,
  38. unsigned int power_size, unsigned int power_seg_sz)
  39. {
  40. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  41. unsigned int init_entry = 0;
  42. unsigned int alloc_order = power_size;
  43. unsigned int max_order = MAX_ORDER - 1;
  44. unsigned int order, iter;
  45. down_write(&pblk_rb_lock);
  46. rb->entries = rb_entry_base;
  47. rb->seg_size = (1 << power_seg_sz);
  48. rb->nr_entries = (1 << power_size);
  49. rb->mem = rb->subm = rb->sync = rb->l2p_update = 0;
  50. rb->sync_point = EMPTY_ENTRY;
  51. spin_lock_init(&rb->w_lock);
  52. spin_lock_init(&rb->s_lock);
  53. INIT_LIST_HEAD(&rb->pages);
  54. if (alloc_order >= max_order) {
  55. order = max_order;
  56. iter = (1 << (alloc_order - max_order));
  57. } else {
  58. order = alloc_order;
  59. iter = 1;
  60. }
  61. do {
  62. struct pblk_rb_entry *entry;
  63. struct pblk_rb_pages *page_set;
  64. void *kaddr;
  65. unsigned long set_size;
  66. int i;
  67. page_set = kmalloc(sizeof(struct pblk_rb_pages), GFP_KERNEL);
  68. if (!page_set) {
  69. up_write(&pblk_rb_lock);
  70. return -ENOMEM;
  71. }
  72. page_set->order = order;
  73. page_set->pages = alloc_pages(GFP_KERNEL, order);
  74. if (!page_set->pages) {
  75. kfree(page_set);
  76. pblk_rb_data_free(rb);
  77. up_write(&pblk_rb_lock);
  78. return -ENOMEM;
  79. }
  80. kaddr = page_address(page_set->pages);
  81. entry = &rb->entries[init_entry];
  82. entry->data = kaddr;
  83. entry->cacheline = pblk_cacheline_to_addr(init_entry++);
  84. entry->w_ctx.flags = PBLK_WRITABLE_ENTRY;
  85. set_size = (1 << order);
  86. for (i = 1; i < set_size; i++) {
  87. entry = &rb->entries[init_entry];
  88. entry->cacheline = pblk_cacheline_to_addr(init_entry++);
  89. entry->data = kaddr + (i * rb->seg_size);
  90. entry->w_ctx.flags = PBLK_WRITABLE_ENTRY;
  91. bio_list_init(&entry->w_ctx.bios);
  92. }
  93. list_add_tail(&page_set->list, &rb->pages);
  94. iter--;
  95. } while (iter > 0);
  96. up_write(&pblk_rb_lock);
  97. #ifdef CONFIG_NVM_DEBUG
  98. atomic_set(&rb->inflight_sync_point, 0);
  99. #endif
  100. /*
  101. * Initialize rate-limiter, which controls access to the write buffer
  102. * but user and GC I/O
  103. */
  104. pblk_rl_init(&pblk->rl, rb->nr_entries);
  105. return 0;
  106. }
  107. /*
  108. * pblk_rb_calculate_size -- calculate the size of the write buffer
  109. */
  110. unsigned int pblk_rb_calculate_size(unsigned int nr_entries)
  111. {
  112. /* Alloc a write buffer that can at least fit 128 entries */
  113. return (1 << max(get_count_order(nr_entries), 7));
  114. }
  115. void *pblk_rb_entries_ref(struct pblk_rb *rb)
  116. {
  117. return rb->entries;
  118. }
  119. static void clean_wctx(struct pblk_w_ctx *w_ctx)
  120. {
  121. int flags;
  122. try:
  123. flags = READ_ONCE(w_ctx->flags);
  124. if (!(flags & PBLK_SUBMITTED_ENTRY))
  125. goto try;
  126. /* Release flags on context. Protect from writes and reads */
  127. smp_store_release(&w_ctx->flags, PBLK_WRITABLE_ENTRY);
  128. pblk_ppa_set_empty(&w_ctx->ppa);
  129. }
  130. #define pblk_rb_ring_count(head, tail, size) CIRC_CNT(head, tail, size)
  131. #define pblk_rb_ring_space(rb, head, tail, size) \
  132. (CIRC_SPACE(head, tail, size))
  133. /*
  134. * Buffer space is calculated with respect to the back pointer signaling
  135. * synchronized entries to the media.
  136. */
  137. static unsigned int pblk_rb_space(struct pblk_rb *rb)
  138. {
  139. unsigned int mem = READ_ONCE(rb->mem);
  140. unsigned int sync = READ_ONCE(rb->sync);
  141. return pblk_rb_ring_space(rb, mem, sync, rb->nr_entries);
  142. }
  143. /*
  144. * Buffer count is calculated with respect to the submission entry signaling the
  145. * entries that are available to send to the media
  146. */
  147. unsigned int pblk_rb_read_count(struct pblk_rb *rb)
  148. {
  149. unsigned int mem = READ_ONCE(rb->mem);
  150. unsigned int subm = READ_ONCE(rb->subm);
  151. return pblk_rb_ring_count(mem, subm, rb->nr_entries);
  152. }
  153. unsigned int pblk_rb_read_commit(struct pblk_rb *rb, unsigned int nr_entries)
  154. {
  155. unsigned int subm;
  156. subm = READ_ONCE(rb->subm);
  157. /* Commit read means updating submission pointer */
  158. smp_store_release(&rb->subm,
  159. (subm + nr_entries) & (rb->nr_entries - 1));
  160. return subm;
  161. }
  162. static int __pblk_rb_update_l2p(struct pblk_rb *rb, unsigned int *l2p_upd,
  163. unsigned int to_update)
  164. {
  165. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  166. struct pblk_line *line;
  167. struct pblk_rb_entry *entry;
  168. struct pblk_w_ctx *w_ctx;
  169. unsigned int i;
  170. for (i = 0; i < to_update; i++) {
  171. entry = &rb->entries[*l2p_upd];
  172. w_ctx = &entry->w_ctx;
  173. pblk_update_map_dev(pblk, w_ctx->lba, w_ctx->ppa,
  174. entry->cacheline);
  175. line = &pblk->lines[pblk_tgt_ppa_to_line(w_ctx->ppa)];
  176. kref_put(&line->ref, pblk_line_put);
  177. clean_wctx(w_ctx);
  178. *l2p_upd = (*l2p_upd + 1) & (rb->nr_entries - 1);
  179. }
  180. return 0;
  181. }
  182. /*
  183. * When we move the l2p_update pointer, we update the l2p table - lookups will
  184. * point to the physical address instead of to the cacheline in the write buffer
  185. * from this moment on.
  186. */
  187. static int pblk_rb_update_l2p(struct pblk_rb *rb, unsigned int nr_entries,
  188. unsigned int mem, unsigned int sync)
  189. {
  190. unsigned int space, count;
  191. int ret = 0;
  192. lockdep_assert_held(&rb->w_lock);
  193. /* Update l2p only as buffer entries are being overwritten */
  194. space = pblk_rb_ring_space(rb, mem, rb->l2p_update, rb->nr_entries);
  195. if (space > nr_entries)
  196. goto out;
  197. count = nr_entries - space;
  198. /* l2p_update used exclusively under rb->w_lock */
  199. ret = __pblk_rb_update_l2p(rb, &rb->l2p_update, count);
  200. out:
  201. return ret;
  202. }
  203. /*
  204. * Update the l2p entry for all sectors stored on the write buffer. This means
  205. * that all future lookups to the l2p table will point to a device address, not
  206. * to the cacheline in the write buffer.
  207. */
  208. void pblk_rb_sync_l2p(struct pblk_rb *rb)
  209. {
  210. unsigned int sync;
  211. unsigned int to_update;
  212. spin_lock(&rb->w_lock);
  213. /* Protect from reads and writes */
  214. sync = smp_load_acquire(&rb->sync);
  215. to_update = pblk_rb_ring_count(sync, rb->l2p_update, rb->nr_entries);
  216. __pblk_rb_update_l2p(rb, &rb->l2p_update, to_update);
  217. spin_unlock(&rb->w_lock);
  218. }
  219. /*
  220. * Write @nr_entries to ring buffer from @data buffer if there is enough space.
  221. * Typically, 4KB data chunks coming from a bio will be copied to the ring
  222. * buffer, thus the write will fail if not all incoming data can be copied.
  223. *
  224. */
  225. static void __pblk_rb_write_entry(struct pblk_rb *rb, void *data,
  226. struct pblk_w_ctx w_ctx,
  227. struct pblk_rb_entry *entry)
  228. {
  229. memcpy(entry->data, data, rb->seg_size);
  230. entry->w_ctx.lba = w_ctx.lba;
  231. entry->w_ctx.ppa = w_ctx.ppa;
  232. }
  233. void pblk_rb_write_entry_user(struct pblk_rb *rb, void *data,
  234. struct pblk_w_ctx w_ctx, unsigned int ring_pos)
  235. {
  236. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  237. struct pblk_rb_entry *entry;
  238. int flags;
  239. entry = &rb->entries[ring_pos];
  240. flags = READ_ONCE(entry->w_ctx.flags);
  241. #ifdef CONFIG_NVM_DEBUG
  242. /* Caller must guarantee that the entry is free */
  243. BUG_ON(!(flags & PBLK_WRITABLE_ENTRY));
  244. #endif
  245. __pblk_rb_write_entry(rb, data, w_ctx, entry);
  246. pblk_update_map_cache(pblk, w_ctx.lba, entry->cacheline);
  247. flags = w_ctx.flags | PBLK_WRITTEN_DATA;
  248. /* Release flags on write context. Protect from writes */
  249. smp_store_release(&entry->w_ctx.flags, flags);
  250. }
  251. void pblk_rb_write_entry_gc(struct pblk_rb *rb, void *data,
  252. struct pblk_w_ctx w_ctx, struct pblk_line *gc_line,
  253. unsigned int ring_pos)
  254. {
  255. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  256. struct pblk_rb_entry *entry;
  257. int flags;
  258. entry = &rb->entries[ring_pos];
  259. flags = READ_ONCE(entry->w_ctx.flags);
  260. #ifdef CONFIG_NVM_DEBUG
  261. /* Caller must guarantee that the entry is free */
  262. BUG_ON(!(flags & PBLK_WRITABLE_ENTRY));
  263. #endif
  264. __pblk_rb_write_entry(rb, data, w_ctx, entry);
  265. if (!pblk_update_map_gc(pblk, w_ctx.lba, entry->cacheline, gc_line))
  266. entry->w_ctx.lba = ADDR_EMPTY;
  267. flags = w_ctx.flags | PBLK_WRITTEN_DATA;
  268. /* Release flags on write context. Protect from writes */
  269. smp_store_release(&entry->w_ctx.flags, flags);
  270. }
  271. static int pblk_rb_sync_point_set(struct pblk_rb *rb, struct bio *bio,
  272. unsigned int pos)
  273. {
  274. struct pblk_rb_entry *entry;
  275. unsigned int subm, sync_point;
  276. int flags;
  277. subm = READ_ONCE(rb->subm);
  278. #ifdef CONFIG_NVM_DEBUG
  279. atomic_inc(&rb->inflight_sync_point);
  280. #endif
  281. if (pos == subm)
  282. return 0;
  283. sync_point = (pos == 0) ? (rb->nr_entries - 1) : (pos - 1);
  284. entry = &rb->entries[sync_point];
  285. flags = READ_ONCE(entry->w_ctx.flags);
  286. flags |= PBLK_FLUSH_ENTRY;
  287. /* Release flags on context. Protect from writes */
  288. smp_store_release(&entry->w_ctx.flags, flags);
  289. /* Protect syncs */
  290. smp_store_release(&rb->sync_point, sync_point);
  291. spin_lock_irq(&rb->s_lock);
  292. bio_list_add(&entry->w_ctx.bios, bio);
  293. spin_unlock_irq(&rb->s_lock);
  294. return 1;
  295. }
  296. static int __pblk_rb_may_write(struct pblk_rb *rb, unsigned int nr_entries,
  297. unsigned int *pos)
  298. {
  299. unsigned int mem;
  300. unsigned int sync;
  301. sync = READ_ONCE(rb->sync);
  302. mem = READ_ONCE(rb->mem);
  303. if (pblk_rb_ring_space(rb, mem, sync, rb->nr_entries) < nr_entries)
  304. return 0;
  305. if (pblk_rb_update_l2p(rb, nr_entries, mem, sync))
  306. return 0;
  307. *pos = mem;
  308. return 1;
  309. }
  310. static int pblk_rb_may_write(struct pblk_rb *rb, unsigned int nr_entries,
  311. unsigned int *pos)
  312. {
  313. if (!__pblk_rb_may_write(rb, nr_entries, pos))
  314. return 0;
  315. /* Protect from read count */
  316. smp_store_release(&rb->mem, (*pos + nr_entries) & (rb->nr_entries - 1));
  317. return 1;
  318. }
  319. static int pblk_rb_may_write_flush(struct pblk_rb *rb, unsigned int nr_entries,
  320. unsigned int *pos, struct bio *bio,
  321. int *io_ret)
  322. {
  323. unsigned int mem;
  324. if (!__pblk_rb_may_write(rb, nr_entries, pos))
  325. return 0;
  326. mem = (*pos + nr_entries) & (rb->nr_entries - 1);
  327. *io_ret = NVM_IO_DONE;
  328. if (bio->bi_opf & REQ_PREFLUSH) {
  329. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  330. #ifdef CONFIG_NVM_DEBUG
  331. atomic_long_inc(&pblk->nr_flush);
  332. #endif
  333. if (pblk_rb_sync_point_set(&pblk->rwb, bio, mem))
  334. *io_ret = NVM_IO_OK;
  335. }
  336. /* Protect from read count */
  337. smp_store_release(&rb->mem, mem);
  338. return 1;
  339. }
  340. /*
  341. * Atomically check that (i) there is space on the write buffer for the
  342. * incoming I/O, and (ii) the current I/O type has enough budget in the write
  343. * buffer (rate-limiter).
  344. */
  345. int pblk_rb_may_write_user(struct pblk_rb *rb, struct bio *bio,
  346. unsigned int nr_entries, unsigned int *pos)
  347. {
  348. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  349. int flush_done;
  350. spin_lock(&rb->w_lock);
  351. if (!pblk_rl_user_may_insert(&pblk->rl, nr_entries)) {
  352. spin_unlock(&rb->w_lock);
  353. return NVM_IO_REQUEUE;
  354. }
  355. if (!pblk_rb_may_write_flush(rb, nr_entries, pos, bio, &flush_done)) {
  356. spin_unlock(&rb->w_lock);
  357. return NVM_IO_REQUEUE;
  358. }
  359. pblk_rl_user_in(&pblk->rl, nr_entries);
  360. spin_unlock(&rb->w_lock);
  361. return flush_done;
  362. }
  363. /*
  364. * Look at pblk_rb_may_write_user comment
  365. */
  366. int pblk_rb_may_write_gc(struct pblk_rb *rb, unsigned int nr_entries,
  367. unsigned int *pos)
  368. {
  369. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  370. spin_lock(&rb->w_lock);
  371. if (!pblk_rl_gc_may_insert(&pblk->rl, nr_entries)) {
  372. spin_unlock(&rb->w_lock);
  373. return 0;
  374. }
  375. if (!pblk_rb_may_write(rb, nr_entries, pos)) {
  376. spin_unlock(&rb->w_lock);
  377. return 0;
  378. }
  379. pblk_rl_gc_in(&pblk->rl, nr_entries);
  380. spin_unlock(&rb->w_lock);
  381. return 1;
  382. }
  383. /*
  384. * The caller of this function must ensure that the backpointer will not
  385. * overwrite the entries passed on the list.
  386. */
  387. unsigned int pblk_rb_read_to_bio_list(struct pblk_rb *rb, struct bio *bio,
  388. struct list_head *list,
  389. unsigned int max)
  390. {
  391. struct pblk_rb_entry *entry, *tentry;
  392. struct page *page;
  393. unsigned int read = 0;
  394. int ret;
  395. list_for_each_entry_safe(entry, tentry, list, index) {
  396. if (read > max) {
  397. pr_err("pblk: too many entries on list\n");
  398. goto out;
  399. }
  400. page = virt_to_page(entry->data);
  401. if (!page) {
  402. pr_err("pblk: could not allocate write bio page\n");
  403. goto out;
  404. }
  405. ret = bio_add_page(bio, page, rb->seg_size, 0);
  406. if (ret != rb->seg_size) {
  407. pr_err("pblk: could not add page to write bio\n");
  408. goto out;
  409. }
  410. list_del(&entry->index);
  411. read++;
  412. }
  413. out:
  414. return read;
  415. }
  416. /*
  417. * Read available entries on rb and add them to the given bio. To avoid a memory
  418. * copy, a page reference to the write buffer is used to be added to the bio.
  419. *
  420. * This function is used by the write thread to form the write bio that will
  421. * persist data on the write buffer to the media.
  422. */
  423. unsigned int pblk_rb_read_to_bio(struct pblk_rb *rb, struct bio *bio,
  424. struct pblk_c_ctx *c_ctx,
  425. unsigned int pos,
  426. unsigned int nr_entries,
  427. unsigned int count)
  428. {
  429. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  430. struct pblk_rb_entry *entry;
  431. struct page *page;
  432. unsigned int pad = 0, read = 0, to_read = nr_entries;
  433. unsigned int user_io = 0, gc_io = 0;
  434. unsigned int i;
  435. int flags;
  436. int ret;
  437. if (count < nr_entries) {
  438. pad = nr_entries - count;
  439. to_read = count;
  440. }
  441. c_ctx->sentry = pos;
  442. c_ctx->nr_valid = to_read;
  443. c_ctx->nr_padded = pad;
  444. for (i = 0; i < to_read; i++) {
  445. entry = &rb->entries[pos];
  446. /* A write has been allowed into the buffer, but data is still
  447. * being copied to it. It is ok to busy wait.
  448. */
  449. try:
  450. flags = READ_ONCE(entry->w_ctx.flags);
  451. if (!(flags & PBLK_WRITTEN_DATA))
  452. goto try;
  453. if (flags & PBLK_IOTYPE_USER)
  454. user_io++;
  455. else if (flags & PBLK_IOTYPE_GC)
  456. gc_io++;
  457. else
  458. WARN(1, "pblk: unknown IO type\n");
  459. page = virt_to_page(entry->data);
  460. if (!page) {
  461. pr_err("pblk: could not allocate write bio page\n");
  462. flags &= ~PBLK_WRITTEN_DATA;
  463. flags |= PBLK_SUBMITTED_ENTRY;
  464. /* Release flags on context. Protect from writes */
  465. smp_store_release(&entry->w_ctx.flags, flags);
  466. goto out;
  467. }
  468. ret = bio_add_page(bio, page, rb->seg_size, 0);
  469. if (ret != rb->seg_size) {
  470. pr_err("pblk: could not add page to write bio\n");
  471. flags &= ~PBLK_WRITTEN_DATA;
  472. flags |= PBLK_SUBMITTED_ENTRY;
  473. /* Release flags on context. Protect from writes */
  474. smp_store_release(&entry->w_ctx.flags, flags);
  475. goto out;
  476. }
  477. if (flags & PBLK_FLUSH_ENTRY) {
  478. unsigned int sync_point;
  479. sync_point = READ_ONCE(rb->sync_point);
  480. if (sync_point == pos) {
  481. /* Protect syncs */
  482. smp_store_release(&rb->sync_point, EMPTY_ENTRY);
  483. }
  484. flags &= ~PBLK_FLUSH_ENTRY;
  485. #ifdef CONFIG_NVM_DEBUG
  486. atomic_dec(&rb->inflight_sync_point);
  487. #endif
  488. }
  489. flags &= ~PBLK_WRITTEN_DATA;
  490. flags |= PBLK_SUBMITTED_ENTRY;
  491. /* Release flags on context. Protect from writes */
  492. smp_store_release(&entry->w_ctx.flags, flags);
  493. pos = (pos + 1) & (rb->nr_entries - 1);
  494. }
  495. read = to_read;
  496. pblk_rl_out(&pblk->rl, user_io, gc_io);
  497. #ifdef CONFIG_NVM_DEBUG
  498. atomic_long_add(pad, &((struct pblk *)
  499. (container_of(rb, struct pblk, rwb)))->padded_writes);
  500. #endif
  501. out:
  502. return read;
  503. }
  504. /*
  505. * Copy to bio only if the lba matches the one on the given cache entry.
  506. * Otherwise, it means that the entry has been overwritten, and the bio should
  507. * be directed to disk.
  508. */
  509. int pblk_rb_copy_to_bio(struct pblk_rb *rb, struct bio *bio, sector_t lba,
  510. u64 pos, int bio_iter)
  511. {
  512. struct pblk_rb_entry *entry;
  513. struct pblk_w_ctx *w_ctx;
  514. void *data;
  515. int flags;
  516. int ret = 1;
  517. spin_lock(&rb->w_lock);
  518. #ifdef CONFIG_NVM_DEBUG
  519. /* Caller must ensure that the access will not cause an overflow */
  520. BUG_ON(pos >= rb->nr_entries);
  521. #endif
  522. entry = &rb->entries[pos];
  523. w_ctx = &entry->w_ctx;
  524. flags = READ_ONCE(w_ctx->flags);
  525. /* Check if the entry has been overwritten or is scheduled to be */
  526. if (w_ctx->lba != lba || flags & PBLK_WRITABLE_ENTRY) {
  527. ret = 0;
  528. goto out;
  529. }
  530. /* Only advance the bio if it hasn't been advanced already. If advanced,
  531. * this bio is at least a partial bio (i.e., it has partially been
  532. * filled with data from the cache). If part of the data resides on the
  533. * media, we will read later on
  534. */
  535. if (unlikely(!bio->bi_iter.bi_idx))
  536. bio_advance(bio, bio_iter * PBLK_EXPOSED_PAGE_SIZE);
  537. data = bio_data(bio);
  538. memcpy(data, entry->data, rb->seg_size);
  539. out:
  540. spin_unlock(&rb->w_lock);
  541. return ret;
  542. }
  543. struct pblk_w_ctx *pblk_rb_w_ctx(struct pblk_rb *rb, unsigned int pos)
  544. {
  545. unsigned int entry = pos & (rb->nr_entries - 1);
  546. return &rb->entries[entry].w_ctx;
  547. }
  548. unsigned int pblk_rb_sync_init(struct pblk_rb *rb, unsigned long *flags)
  549. __acquires(&rb->s_lock)
  550. {
  551. if (flags)
  552. spin_lock_irqsave(&rb->s_lock, *flags);
  553. else
  554. spin_lock_irq(&rb->s_lock);
  555. return rb->sync;
  556. }
  557. void pblk_rb_sync_end(struct pblk_rb *rb, unsigned long *flags)
  558. __releases(&rb->s_lock)
  559. {
  560. lockdep_assert_held(&rb->s_lock);
  561. if (flags)
  562. spin_unlock_irqrestore(&rb->s_lock, *flags);
  563. else
  564. spin_unlock_irq(&rb->s_lock);
  565. }
  566. unsigned int pblk_rb_sync_advance(struct pblk_rb *rb, unsigned int nr_entries)
  567. {
  568. unsigned int sync;
  569. unsigned int i;
  570. lockdep_assert_held(&rb->s_lock);
  571. sync = READ_ONCE(rb->sync);
  572. for (i = 0; i < nr_entries; i++)
  573. sync = (sync + 1) & (rb->nr_entries - 1);
  574. /* Protect from counts */
  575. smp_store_release(&rb->sync, sync);
  576. return sync;
  577. }
  578. unsigned int pblk_rb_sync_point_count(struct pblk_rb *rb)
  579. {
  580. unsigned int subm, sync_point;
  581. unsigned int count;
  582. /* Protect syncs */
  583. sync_point = smp_load_acquire(&rb->sync_point);
  584. if (sync_point == EMPTY_ENTRY)
  585. return 0;
  586. subm = READ_ONCE(rb->subm);
  587. /* The sync point itself counts as a sector to sync */
  588. count = pblk_rb_ring_count(sync_point, subm, rb->nr_entries) + 1;
  589. return count;
  590. }
  591. /*
  592. * Scan from the current position of the sync pointer to find the entry that
  593. * corresponds to the given ppa. This is necessary since write requests can be
  594. * completed out of order. The assumption is that the ppa is close to the sync
  595. * pointer thus the search will not take long.
  596. *
  597. * The caller of this function must guarantee that the sync pointer will no
  598. * reach the entry while it is using the metadata associated with it. With this
  599. * assumption in mind, there is no need to take the sync lock.
  600. */
  601. struct pblk_rb_entry *pblk_rb_sync_scan_entry(struct pblk_rb *rb,
  602. struct ppa_addr *ppa)
  603. {
  604. unsigned int sync, subm, count;
  605. unsigned int i;
  606. sync = READ_ONCE(rb->sync);
  607. subm = READ_ONCE(rb->subm);
  608. count = pblk_rb_ring_count(subm, sync, rb->nr_entries);
  609. for (i = 0; i < count; i++)
  610. sync = (sync + 1) & (rb->nr_entries - 1);
  611. return NULL;
  612. }
  613. int pblk_rb_tear_down_check(struct pblk_rb *rb)
  614. {
  615. struct pblk_rb_entry *entry;
  616. int i;
  617. int ret = 0;
  618. spin_lock(&rb->w_lock);
  619. spin_lock_irq(&rb->s_lock);
  620. if ((rb->mem == rb->subm) && (rb->subm == rb->sync) &&
  621. (rb->sync == rb->l2p_update) &&
  622. (rb->sync_point == EMPTY_ENTRY)) {
  623. goto out;
  624. }
  625. if (!rb->entries) {
  626. ret = 1;
  627. goto out;
  628. }
  629. for (i = 0; i < rb->nr_entries; i++) {
  630. entry = &rb->entries[i];
  631. if (!entry->data) {
  632. ret = 1;
  633. goto out;
  634. }
  635. }
  636. out:
  637. spin_unlock(&rb->w_lock);
  638. spin_unlock_irq(&rb->s_lock);
  639. return ret;
  640. }
  641. unsigned int pblk_rb_wrap_pos(struct pblk_rb *rb, unsigned int pos)
  642. {
  643. return (pos & (rb->nr_entries - 1));
  644. }
  645. int pblk_rb_pos_oob(struct pblk_rb *rb, u64 pos)
  646. {
  647. return (pos >= rb->nr_entries);
  648. }
  649. ssize_t pblk_rb_sysfs(struct pblk_rb *rb, char *buf)
  650. {
  651. struct pblk *pblk = container_of(rb, struct pblk, rwb);
  652. struct pblk_c_ctx *c;
  653. ssize_t offset;
  654. int queued_entries = 0;
  655. spin_lock_irq(&rb->s_lock);
  656. list_for_each_entry(c, &pblk->compl_list, list)
  657. queued_entries++;
  658. spin_unlock_irq(&rb->s_lock);
  659. if (rb->sync_point != EMPTY_ENTRY)
  660. offset = scnprintf(buf, PAGE_SIZE,
  661. "%u\t%u\t%u\t%u\t%u\t%u\t%u - %u/%u/%u - %d\n",
  662. rb->nr_entries,
  663. rb->mem,
  664. rb->subm,
  665. rb->sync,
  666. rb->l2p_update,
  667. #ifdef CONFIG_NVM_DEBUG
  668. atomic_read(&rb->inflight_sync_point),
  669. #else
  670. 0,
  671. #endif
  672. rb->sync_point,
  673. pblk_rb_read_count(rb),
  674. pblk_rb_space(rb),
  675. pblk_rb_sync_point_count(rb),
  676. queued_entries);
  677. else
  678. offset = scnprintf(buf, PAGE_SIZE,
  679. "%u\t%u\t%u\t%u\t%u\t%u\tNULL - %u/%u/%u - %d\n",
  680. rb->nr_entries,
  681. rb->mem,
  682. rb->subm,
  683. rb->sync,
  684. rb->l2p_update,
  685. #ifdef CONFIG_NVM_DEBUG
  686. atomic_read(&rb->inflight_sync_point),
  687. #else
  688. 0,
  689. #endif
  690. pblk_rb_read_count(rb),
  691. pblk_rb_space(rb),
  692. pblk_rb_sync_point_count(rb),
  693. queued_entries);
  694. return offset;
  695. }