blob: 80f35668880305d84ad821afa1df5b31de995055 [file] [log] [blame]
Javier González02a15202018-10-09 13:12:06 +02001/* SPDX-License-Identifier: GPL-2.0 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02002/*
3 * Copyright (C) 2015 IT University of Copenhagen (rrpc.h)
4 * Copyright (C) 2016 CNEX Labs
5 * Initial release: Matias Bjorling <matias@cnexlabs.com>
6 * Write buffering: Javier Gonzalez <javier@cnexlabs.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * Implementation of a Physical Block-device target for Open-channel SSDs.
18 *
19 */
20
21#ifndef PBLK_H_
22#define PBLK_H_
23
24#include <linux/blkdev.h>
25#include <linux/blk-mq.h>
26#include <linux/bio.h>
27#include <linux/module.h>
28#include <linux/kthread.h>
29#include <linux/vmalloc.h>
30#include <linux/crc32.h>
31#include <linux/uuid.h>
32
33#include <linux/lightnvm.h>
34
35/* Run only GC if less than 1/X blocks are free */
36#define GC_LIMIT_INVERSE 5
37#define GC_TIME_MSECS 1000
38
39#define PBLK_SECTOR (512)
40#define PBLK_EXPOSED_PAGE_SIZE (4096)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020041
Javier Gonzálezef576492017-06-26 11:57:28 +020042#define PBLK_NR_CLOSE_JOBS (4)
43
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020044#define PBLK_CACHE_NAME_LEN (DISK_NAME_LEN + 16)
45
46#define PBLK_COMMAND_TIMEOUT_MS 30000
47
48/* Max 512 LUNs per device */
49#define PBLK_MAX_LUNS_BITMAP (4)
50
51#define NR_PHY_IN_LOG (PBLK_EXPOSED_PAGE_SIZE / PBLK_SECTOR)
52
Javier González0d880392017-10-13 14:46:08 +020053/* Static pool sizes */
Javier Gonzálezb84ae4a82017-10-13 14:46:07 +020054#define PBLK_GEN_WS_POOL_SIZE (2)
55
Javier Gonzáleze5392732018-01-05 14:16:14 +010056#define PBLK_DEFAULT_OP (11)
57
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020058enum {
Javier Gonzáleze2cddf22017-10-13 14:46:19 +020059 PBLK_READ = READ,
60 PBLK_WRITE = WRITE,/* Write from write buffer */
61 PBLK_WRITE_INT, /* Internal write - no write buffer */
Javier González8f554592018-01-05 14:16:16 +010062 PBLK_READ_RECOV, /* Recovery read - errors allowed */
Javier Gonzáleze2cddf22017-10-13 14:46:19 +020063 PBLK_ERASE,
64};
65
66enum {
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020067 /* IO Types */
68 PBLK_IOTYPE_USER = 1 << 0,
69 PBLK_IOTYPE_GC = 1 << 1,
70
71 /* Write buffer flags */
72 PBLK_FLUSH_ENTRY = 1 << 2,
73 PBLK_WRITTEN_DATA = 1 << 3,
74 PBLK_SUBMITTED_ENTRY = 1 << 4,
75 PBLK_WRITABLE_ENTRY = 1 << 5,
76};
77
78enum {
79 PBLK_BLK_ST_OPEN = 0x1,
80 PBLK_BLK_ST_CLOSED = 0x2,
81};
82
Hans Holmberg4209c312018-10-09 13:11:55 +020083enum {
84 PBLK_CHUNK_RESET_START,
85 PBLK_CHUNK_RESET_DONE,
86 PBLK_CHUNK_RESET_FAILED,
87};
88
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +020089struct pblk_sec_meta {
90 u64 reserved;
91 __le64 lba;
92};
93
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020094/* The number of GC lists and the rate-limiter states go together. This way the
95 * rate-limiter can dictate how much GC is needed based on resource utilization.
96 */
Hans Holmberg48b8d202018-06-01 16:41:06 +020097#define PBLK_GC_NR_LISTS 4
Javier Gonzáleza4bd2172017-04-15 20:55:50 +020098
99enum {
Hans Holmberg48b8d202018-06-01 16:41:06 +0200100 PBLK_RL_OFF = 0,
101 PBLK_RL_WERR = 1,
102 PBLK_RL_HIGH = 2,
103 PBLK_RL_MID = 3,
104 PBLK_RL_LOW = 4
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200105};
106
Matias Bjørlingafdc23c2018-10-09 13:11:37 +0200107#define pblk_dma_meta_size (sizeof(struct pblk_sec_meta) * NVM_MAX_VLBA)
108#define pblk_dma_ppa_size (sizeof(u64) * NVM_MAX_VLBA)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200109
Javier González084ec9b2017-06-26 16:27:13 -0600110/* write buffer completion context */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200111struct pblk_c_ctx {
112 struct list_head list; /* Head for out-of-order completion */
113
114 unsigned long *lun_bitmap; /* Luns used on current request */
115 unsigned int sentry;
116 unsigned int nr_valid;
117 unsigned int nr_padded;
118};
119
Javier Gonzáleza4809fe2017-10-13 14:46:22 +0200120/* read context */
Javier González084ec9b2017-06-26 16:27:13 -0600121struct pblk_g_ctx {
122 void *private;
Javier González998ba622018-01-05 14:16:20 +0100123 unsigned long start_time;
Javier Gonzáleza4809fe2017-10-13 14:46:22 +0200124 u64 lba;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200125};
126
Heiner Litz11f6ad62018-07-13 10:48:44 +0200127/* partial read context */
128struct pblk_pr_ctx {
129 struct bio *orig_bio;
130 DECLARE_BITMAP(bitmap, NVM_MAX_VLBA);
131 unsigned int orig_nr_secs;
132 unsigned int bio_init_idx;
133 void *ppa_ptr;
134 dma_addr_t dma_ppa_list;
Igor Konopkodd439492018-12-11 20:16:22 +0100135 __le64 lba_list_mem[NVM_MAX_VLBA];
136 __le64 lba_list_media[NVM_MAX_VLBA];
Heiner Litz11f6ad62018-07-13 10:48:44 +0200137};
138
Javier Gonzálezee8d5c12017-06-30 17:56:40 +0200139/* Pad context */
140struct pblk_pad_rq {
141 struct pblk *pblk;
142 struct completion wait;
143 struct kref ref;
144};
145
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200146/* Recovery context */
147struct pblk_rec_ctx {
148 struct pblk *pblk;
149 struct nvm_rq *rqd;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200150 struct work_struct ws_rec;
151};
152
153/* Write context */
154struct pblk_w_ctx {
155 struct bio_list bios; /* Original bios - used for completion
156 * in REQ_FUA, REQ_FLUSH case
157 */
Arnd Bergmannef697902017-04-19 19:39:13 +0200158 u64 lba; /* Logic addr. associated with entry */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200159 struct ppa_addr ppa; /* Physic addr. associated with entry */
160 int flags; /* Write context flags */
161};
162
163struct pblk_rb_entry {
164 struct ppa_addr cacheline; /* Cacheline for this entry */
165 void *data; /* Pointer to data on this entry */
166 struct pblk_w_ctx w_ctx; /* Context for this entry */
167 struct list_head index; /* List head to enable indexes */
168};
169
170#define EMPTY_ENTRY (~0U)
171
172struct pblk_rb_pages {
173 struct page *pages;
174 int order;
175 struct list_head list;
176};
177
178struct pblk_rb {
179 struct pblk_rb_entry *entries; /* Ring buffer entries */
180 unsigned int mem; /* Write offset - points to next
181 * writable entry in memory
182 */
183 unsigned int subm; /* Read offset - points to last entry
184 * that has been submitted to the media
185 * to be persisted
186 */
187 unsigned int sync; /* Synced - backpointer that signals
188 * the last submitted entry that has
189 * been successfully persisted to media
190 */
Hans Holmberg8154d292018-01-05 14:16:09 +0100191 unsigned int flush_point; /* Sync point - last entry that must be
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200192 * flushed to the media. Used with
193 * REQ_FLUSH and REQ_FUA
194 */
195 unsigned int l2p_update; /* l2p update point - next entry for
196 * which l2p mapping will be updated to
197 * contain a device ppa address (instead
198 * of a cacheline
199 */
200 unsigned int nr_entries; /* Number of entries in write buffer -
201 * must be a power of two
202 */
203 unsigned int seg_size; /* Size of the data segments being
204 * stored on each entry. Typically this
205 * will be 4KB
206 */
207
Javier González766c8ce2018-10-09 13:12:15 +0200208 unsigned int back_thres; /* Threshold that shall be maintained by
209 * the backpointer in order to respect
210 * geo->mw_cunits on a per chunk basis
211 */
212
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200213 struct list_head pages; /* List of data pages */
214
215 spinlock_t w_lock; /* Write lock */
216 spinlock_t s_lock; /* Sync lock */
217
Matias Bjørling880eda52018-07-13 10:48:37 +0200218#ifdef CONFIG_NVM_PBLK_DEBUG
Hans Holmberg8154d292018-01-05 14:16:09 +0100219 atomic_t inflight_flush_point; /* Not served REQ_FLUSH | REQ_FUA */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200220#endif
221};
222
223#define PBLK_RECOVERY_SECTORS 16
224
225struct pblk_lun {
226 struct ppa_addr bppa;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200227 struct semaphore wr_sem;
228};
229
230struct pblk_gc_rq {
231 struct pblk_line *line;
232 void *data;
Matias Bjørlingafdc23c2018-10-09 13:11:37 +0200233 u64 paddr_list[NVM_MAX_VLBA];
234 u64 lba_list[NVM_MAX_VLBA];
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200235 int nr_secs;
236 int secs_to_gc;
237 struct list_head list;
238};
239
240struct pblk_gc {
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200241 /* These states are not protected by a lock since (i) they are in the
242 * fast path, and (ii) they are not critical.
243 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200244 int gc_active;
245 int gc_enabled;
246 int gc_forced;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200247
248 struct task_struct *gc_ts;
249 struct task_struct *gc_writer_ts;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200250 struct task_struct *gc_reader_ts;
251
252 struct workqueue_struct *gc_line_reader_wq;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200253 struct workqueue_struct *gc_reader_wq;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200254
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200255 struct timer_list gc_timer;
256
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200257 struct semaphore gc_sem;
Hans Holmbergd6b992f2017-10-13 14:46:41 +0200258 atomic_t read_inflight_gc; /* Number of lines with inflight GC reads */
259 atomic_t pipeline_gc; /* Number of lines in the GC pipeline -
260 * started reads to finished writes
261 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200262 int w_entries;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200263
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200264 struct list_head w_list;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200265 struct list_head r_list;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200266
267 spinlock_t lock;
268 spinlock_t w_lock;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200269 spinlock_t r_lock;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200270};
271
272struct pblk_rl {
273 unsigned int high; /* Upper threshold for rate limiter (free run -
274 * user I/O rate limiter
275 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200276 unsigned int high_pw; /* High rounded up as a power of 2 */
277
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200278#define PBLK_USER_HIGH_THRS 8 /* Begin write limit at 12% available blks */
279#define PBLK_USER_LOW_THRS 10 /* Aggressive GC at 10% available blocks */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200280
281 int rb_windows_pw; /* Number of rate windows in the write buffer
282 * given as a power-of-2. This guarantees that
283 * when user I/O is being rate limited, there
284 * will be reserved enough space for the GC to
285 * place its payload. A window is of
286 * pblk->max_write_pgs size, which in NVMe is
287 * 64, i.e., 256kb.
288 */
289 int rb_budget; /* Total number of entries available for I/O */
290 int rb_user_max; /* Max buffer entries available for user I/O */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200291 int rb_gc_max; /* Max buffer entries available for GC I/O */
292 int rb_gc_rsv; /* Reserved buffer entries for GC I/O */
293 int rb_state; /* Rate-limiter current state */
Javier Gonzálezda67e68f2017-10-13 14:46:05 +0200294 int rb_max_io; /* Maximum size for an I/O giving the config */
Javier González588726d32017-06-26 11:57:29 +0200295
296 atomic_t rb_user_cnt; /* User I/O buffer counter */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200297 atomic_t rb_gc_cnt; /* GC I/O buffer counter */
Javier González588726d32017-06-26 11:57:29 +0200298 atomic_t rb_space; /* Space limit in case of reaching capacity */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200299
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200300 int rsv_blocks; /* Reserved blocks for GC */
301
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200302 int rb_user_active;
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200303 int rb_gc_active;
304
Hans Holmberg48b8d202018-06-01 16:41:06 +0200305 atomic_t werr_lines; /* Number of write error lines that needs gc */
306
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200307 struct timer_list u_timer;
308
309 unsigned long long nr_secs;
310 unsigned long total_blocks;
Javier Gonzáleza7689932018-01-05 14:16:13 +0100311
312 atomic_t free_blocks; /* Total number of free blocks (+ OP) */
313 atomic_t free_user_blocks; /* Number of user free blocks (no OP) */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200314};
315
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200316#define PBLK_LINE_EMPTY (~0U)
317
318enum {
319 /* Line Types */
320 PBLK_LINETYPE_FREE = 0,
321 PBLK_LINETYPE_LOG = 1,
322 PBLK_LINETYPE_DATA = 2,
323
324 /* Line state */
Javier González32ef9412018-03-30 00:05:20 +0200325 PBLK_LINESTATE_NEW = 9,
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200326 PBLK_LINESTATE_FREE = 10,
327 PBLK_LINESTATE_OPEN = 11,
328 PBLK_LINESTATE_CLOSED = 12,
329 PBLK_LINESTATE_GC = 13,
330 PBLK_LINESTATE_BAD = 14,
331 PBLK_LINESTATE_CORRUPT = 15,
332
333 /* GC group */
334 PBLK_LINEGC_NONE = 20,
335 PBLK_LINEGC_EMPTY = 21,
336 PBLK_LINEGC_LOW = 22,
337 PBLK_LINEGC_MID = 23,
338 PBLK_LINEGC_HIGH = 24,
339 PBLK_LINEGC_FULL = 25,
Hans Holmberg48b8d202018-06-01 16:41:06 +0200340 PBLK_LINEGC_WERR = 26
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200341};
342
343#define PBLK_MAGIC 0x70626c6b /*pblk*/
Hans Holmbergd0ab0b12018-03-30 00:04:51 +0200344
345/* emeta/smeta persistent storage format versions:
346 * Changes in major version requires offline migration.
347 * Changes in minor version are handled automatically during
348 * recovery.
349 */
350
351#define SMETA_VERSION_MAJOR (0)
352#define SMETA_VERSION_MINOR (1)
353
354#define EMETA_VERSION_MAJOR (0)
Hans Holmberg76758392018-03-30 00:04:52 +0200355#define EMETA_VERSION_MINOR (2)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200356
357struct line_header {
358 __le32 crc;
359 __le32 identifier; /* pblk identifier */
360 __u8 uuid[16]; /* instance uuid */
361 __le16 type; /* line type */
Hans Holmbergd0ab0b12018-03-30 00:04:51 +0200362 __u8 version_major; /* version major */
363 __u8 version_minor; /* version minor */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200364 __le32 id; /* line id for current line */
365};
366
367struct line_smeta {
368 struct line_header header;
369
370 __le32 crc; /* Full structure including struct crc */
371 /* Previous line metadata */
372 __le32 prev_id; /* Line id for previous line */
373
374 /* Current line metadata */
375 __le64 seq_nr; /* Sequence number for current line */
376
377 /* Active writers */
378 __le32 window_wr_lun; /* Number of parallel LUNs to write */
379
380 __le32 rsvd[2];
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200381
382 __le64 lun_bitmap[];
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200383};
384
Hans Holmberg76758392018-03-30 00:04:52 +0200385
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200386/*
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200387 * Metadata layout in media:
388 * First sector:
389 * 1. struct line_emeta
390 * 2. bad block bitmap (u64 * window_wr_lun)
Hans Holmberg76758392018-03-30 00:04:52 +0200391 * 3. write amplification counters
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200392 * Mid sectors (start at lbas_sector):
393 * 3. nr_lbas (u64) forming lba list
394 * Last sectors (start at vsc_sector):
395 * 4. u32 valid sector count (vsc) for all lines (~0U: free line)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200396 */
397struct line_emeta {
398 struct line_header header;
399
400 __le32 crc; /* Full structure including struct crc */
401
402 /* Previous line metadata */
403 __le32 prev_id; /* Line id for prev line */
404
405 /* Current line metadata */
406 __le64 seq_nr; /* Sequence number for current line */
407
408 /* Active writers */
409 __le32 window_wr_lun; /* Number of parallel LUNs to write */
410
411 /* Bookkeeping for recovery */
412 __le32 next_id; /* Line id for next line */
413 __le64 nr_lbas; /* Number of lbas mapped in line */
414 __le64 nr_valid_lbas; /* Number of valid lbas mapped in line */
Hans Holmberg76758392018-03-30 00:04:52 +0200415 __le64 bb_bitmap[]; /* Updated bad block bitmap for line */
416};
417
418
419/* Write amplification counters stored on media */
420struct wa_counters {
421 __le64 user; /* Number of user written sectors */
422 __le64 gc; /* Number of sectors written by GC*/
423 __le64 pad; /* Number of padded sectors */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200424};
425
426struct pblk_emeta {
427 struct line_emeta *buf; /* emeta buffer in media format */
428 int mem; /* Write offset - points to next
429 * writable entry in memory
430 */
431 atomic_t sync; /* Synced - backpointer that signals the
432 * last entry that has been successfully
433 * persisted to media
434 */
435 unsigned int nr_entries; /* Number of emeta entries */
436};
437
438struct pblk_smeta {
439 struct line_smeta *buf; /* smeta buffer in persistent format */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200440};
441
Hans Holmberg48b8d202018-06-01 16:41:06 +0200442struct pblk_w_err_gc {
443 int has_write_err;
444 __le64 *lba_list;
445};
446
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200447struct pblk_line {
448 struct pblk *pblk;
449 unsigned int id; /* Line number corresponds to the
450 * block line
451 */
452 unsigned int seq_nr; /* Unique line sequence number */
453
454 int state; /* PBLK_LINESTATE_X */
455 int type; /* PBLK_LINETYPE_X */
456 int gc_group; /* PBLK_LINEGC_X */
457 struct list_head list; /* Free, GC lists */
458
459 unsigned long *lun_bitmap; /* Bitmap for LUNs mapped in line */
460
Javier González32ef9412018-03-30 00:05:20 +0200461 struct nvm_chk_meta *chks; /* Chunks forming line */
462
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200463 struct pblk_smeta *smeta; /* Start metadata */
464 struct pblk_emeta *emeta; /* End medatada */
465
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200466 int meta_line; /* Metadata line id */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200467 int meta_distance; /* Distance between data and metadata */
468
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200469 u64 smeta_ssec; /* Sector where smeta starts */
470 u64 emeta_ssec; /* Sector where emeta starts */
471
472 unsigned int sec_in_line; /* Number of usable secs in line */
473
Javier Gonzáleza44f53f2017-04-22 01:32:49 +0200474 atomic_t blk_in_line; /* Number of good blocks in line */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200475 unsigned long *blk_bitmap; /* Bitmap for valid/invalid blocks */
476 unsigned long *erase_bitmap; /* Bitmap for erased blocks */
477
478 unsigned long *map_bitmap; /* Bitmap for mapped sectors in line */
479 unsigned long *invalid_bitmap; /* Bitmap for invalid sectors in line */
480
Javier Gonzáleza44f53f2017-04-22 01:32:49 +0200481 atomic_t left_eblks; /* Blocks left for erasing */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200482 atomic_t left_seblks; /* Blocks left for sync erasing */
483
484 int left_msecs; /* Sectors left for mapping */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200485 unsigned int cur_sec; /* Sector map pointer */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200486 unsigned int nr_valid_lbas; /* Number of valid lbas in line */
487
488 __le32 *vsc; /* Valid sector count in line */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200489
490 struct kref ref; /* Write buffer L2P references */
491
Hans Holmberg48b8d202018-06-01 16:41:06 +0200492 struct pblk_w_err_gc *w_err_gc; /* Write error gc recovery metadata */
493
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200494 spinlock_t lock; /* Necessary for invalid_bitmap only */
495};
496
Javier Gonzáleza44f53f2017-04-22 01:32:49 +0200497#define PBLK_DATA_LINES 4
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200498
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200499enum {
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200500 PBLK_KMALLOC_META = 1,
501 PBLK_VMALLOC_META = 2,
502};
503
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200504enum {
505 PBLK_EMETA_TYPE_HEADER = 1, /* struct line_emeta first sector */
506 PBLK_EMETA_TYPE_LLBA = 2, /* lba list - type: __le64 */
507 PBLK_EMETA_TYPE_VSC = 3, /* vsc list - type: __le32 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200508};
509
510struct pblk_line_mgmt {
511 int nr_lines; /* Total number of full lines */
512 int nr_free_lines; /* Number of full lines in free list */
513
514 /* Free lists - use free_lock */
515 struct list_head free_list; /* Full lines ready to use */
516 struct list_head corrupt_list; /* Full lines corrupted */
517 struct list_head bad_list; /* Full lines bad */
518
519 /* GC lists - use gc_lock */
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200520 struct list_head *gc_lists[PBLK_GC_NR_LISTS];
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200521 struct list_head gc_high_list; /* Full lines ready to GC, high isc */
522 struct list_head gc_mid_list; /* Full lines ready to GC, mid isc */
523 struct list_head gc_low_list; /* Full lines ready to GC, low isc */
524
Hans Holmberg48b8d202018-06-01 16:41:06 +0200525 struct list_head gc_werr_list; /* Write err recovery list */
526
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200527 struct list_head gc_full_list; /* Full lines ready to GC, no valid */
528 struct list_head gc_empty_list; /* Full lines close, all valid */
529
530 struct pblk_line *log_line; /* Current FTL log line */
531 struct pblk_line *data_line; /* Current data line */
532 struct pblk_line *log_next; /* Next FTL log line */
533 struct pblk_line *data_next; /* Next data line */
534
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200535 struct list_head emeta_list; /* Lines queued to schedule emeta */
536
537 __le32 *vsc_list; /* Valid sector counts for all lines */
538
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200539 /* Metadata allocation type: VMALLOC | KMALLOC */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200540 int emeta_alloc_type;
541
542 /* Pre-allocated metadata for data lines */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200543 struct pblk_smeta *sline_meta[PBLK_DATA_LINES];
544 struct pblk_emeta *eline_meta[PBLK_DATA_LINES];
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200545 unsigned long meta_bitmap;
546
Hans Holmberg53d82db2018-10-09 13:11:47 +0200547 /* Cache and mempool for map/invalid bitmaps */
548 struct kmem_cache *bitmap_cache;
549 mempool_t *bitmap_pool;
550
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200551 /* Helpers for fast bitmap calculations */
552 unsigned long *bb_template;
553 unsigned long *bb_aux;
554
555 unsigned long d_seq_nr; /* Data line unique sequence number */
556 unsigned long l_seq_nr; /* Log line unique sequence number */
557
558 spinlock_t free_lock;
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200559 spinlock_t close_lock;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200560 spinlock_t gc_lock;
561};
562
563struct pblk_line_meta {
564 unsigned int smeta_len; /* Total length for smeta */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200565 unsigned int smeta_sec; /* Sectors needed for smeta */
566
567 unsigned int emeta_len[4]; /* Lengths for emeta:
Hans Holmberg76758392018-03-30 00:04:52 +0200568 * [0]: Total
569 * [1]: struct line_emeta +
570 * bb_bitmap + struct wa_counters
571 * [2]: L2P portion
572 * [3]: vsc
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200573 */
574 unsigned int emeta_sec[4]; /* Sectors needed for emeta. Same layout
575 * as emeta_len
576 */
577
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200578 unsigned int emeta_bb; /* Boundary for bb that affects emeta */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200579
580 unsigned int vsc_list_len; /* Length for vsc list */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200581 unsigned int sec_bitmap_len; /* Length for sector bitmap in line */
582 unsigned int blk_bitmap_len; /* Length for block bitmap in line */
583 unsigned int lun_bitmap_len; /* Length for lun bitmap in line */
584
585 unsigned int blk_per_line; /* Number of blocks in a full line */
586 unsigned int sec_per_line; /* Number of sectors in a line */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200587 unsigned int dsec_per_line; /* Number of data sectors in a line */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200588 unsigned int min_blk_line; /* Min. number of good blocks in line */
589
590 unsigned int mid_thrs; /* Threshold for GC mid list */
591 unsigned int high_thrs; /* Threshold for GC high list */
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200592
593 unsigned int meta_distance; /* Distance between data and metadata */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200594};
595
Javier González588726d32017-06-26 11:57:29 +0200596enum {
597 PBLK_STATE_RUNNING = 0,
598 PBLK_STATE_STOPPING = 1,
599 PBLK_STATE_RECOVERING = 2,
600 PBLK_STATE_STOPPED = 3,
601};
602
Javier González3b2a3ad2018-03-30 00:05:21 +0200603/* Internal format to support not power-of-2 device formats */
604struct pblk_addrf {
605 /* gen to dev */
606 int sec_stripe;
607 int ch_stripe;
608 int lun_stripe;
609
610 /* dev to gen */
611 int sec_lun_stripe;
612 int sec_ws_stripe;
613};
614
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200615struct pblk {
616 struct nvm_tgt_dev *dev;
617 struct gendisk *disk;
618
619 struct kobject kobj;
620
621 struct pblk_lun *luns;
622
623 struct pblk_line *lines; /* Line array */
624 struct pblk_line_mgmt l_mg; /* Line management */
625 struct pblk_line_meta lm; /* Line metadata */
626
Javier González3b2a3ad2018-03-30 00:05:21 +0200627 struct nvm_addrf addrf; /* Aligned address format */
628 struct pblk_addrf uaddrf; /* Unaligned address format */
Javier Gonzálezbb845ae42018-03-30 00:05:19 +0200629 int addrf_len;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200630
631 struct pblk_rb rwb;
632
Javier González588726d32017-06-26 11:57:29 +0200633 int state; /* pblk line state */
634
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200635 int min_write_pgs; /* Minimum amount of pages required by controller */
636 int max_write_pgs; /* Maximum amount of pages supported by controller */
Igor Konopkofaa79f22018-12-11 20:16:23 +0100637 int oob_meta_size; /* Size of OOB sector metadata */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200638
639 sector_t capacity; /* Device capacity when bad blocks are subtracted */
Javier Gonzáleza7689932018-01-05 14:16:13 +0100640
641 int op; /* Percentage of device used for over-provisioning */
642 int op_blks; /* Number of blocks used for over-provisioning */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200643
644 /* pblk provisioning values. Used by rate limiter */
645 struct pblk_rl rl;
646
Javier Gonzálezc2e9f5d2017-06-26 11:57:14 +0200647 int sec_per_write;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200648
649 unsigned char instance_uuid[16];
Hans Holmberg76758392018-03-30 00:04:52 +0200650
651 /* Persistent write amplification counters, 4kb sector I/Os */
652 atomic64_t user_wa; /* Sectors written by user */
653 atomic64_t gc_wa; /* Sectors written by GC */
654 atomic64_t pad_wa; /* Padded sectors written */
655
656 /* Reset values for delta write amplification measurements */
657 u64 user_rst_wa;
658 u64 gc_rst_wa;
659 u64 pad_rst_wa;
660
Hans Holmberg5d149bf2018-03-30 00:04:55 +0200661 /* Counters used for calculating padding distribution */
662 atomic64_t *pad_dist; /* Padding distribution buckets */
663 u64 nr_flush_rst; /* Flushes reset value for pad dist.*/
664 atomic64_t nr_flush; /* Number of flush/fua I/O */
665
Matias Bjørling880eda52018-07-13 10:48:37 +0200666#ifdef CONFIG_NVM_PBLK_DEBUG
Hans Holmberg76758392018-03-30 00:04:52 +0200667 /* Non-persistent debug counters, 4kb sector I/Os */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200668 atomic_long_t inflight_writes; /* Inflight writes (user and gc) */
669 atomic_long_t padded_writes; /* Sectors padded due to flush/fua */
670 atomic_long_t padded_wb; /* Sectors padded in write buffer */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200671 atomic_long_t req_writes; /* Sectors stored on write buffer */
672 atomic_long_t sub_writes; /* Sectors submitted from buffer */
673 atomic_long_t sync_writes; /* Sectors synced to media */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200674 atomic_long_t inflight_reads; /* Inflight sector read requests */
Javier Gonzálezdb7ada32017-06-26 11:57:13 +0200675 atomic_long_t cache_reads; /* Read requests that hit the cache */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200676 atomic_long_t sync_reads; /* Completed sector read requests */
677 atomic_long_t recov_writes; /* Sectors submitted from recovery */
678 atomic_long_t recov_gc_writes; /* Sectors submitted from write GC */
679 atomic_long_t recov_gc_reads; /* Sectors submitted from read GC */
680#endif
681
682 spinlock_t lock;
683
684 atomic_long_t read_failed;
685 atomic_long_t read_empty;
686 atomic_long_t read_high_ecc;
687 atomic_long_t read_failed_gc;
688 atomic_long_t write_failed;
689 atomic_long_t erase_failed;
690
Javier González588726d32017-06-26 11:57:29 +0200691 atomic_t inflight_io; /* General inflight I/O counter */
692
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200693 struct task_struct *writer_ts;
694
695 /* Simple translation map of logical addresses to physical addresses.
696 * The logical addresses is known by the host system, while the physical
697 * addresses are used when writing to the disk block device.
698 */
699 unsigned char *trans_map;
700 spinlock_t trans_lock;
701
702 struct list_head compl_list;
703
Hans Holmberg6a3abf52018-06-01 16:41:05 +0200704 spinlock_t resubmit_lock; /* Resubmit list lock */
705 struct list_head resubmit_list; /* Resubmit list for failed writes*/
706
Kent Overstreetb906bbb2018-05-20 18:25:50 -0400707 mempool_t page_bio_pool;
708 mempool_t gen_ws_pool;
709 mempool_t rec_pool;
710 mempool_t r_rq_pool;
711 mempool_t w_rq_pool;
712 mempool_t e_rq_pool;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200713
Javier Gonzálezef576492017-06-26 11:57:28 +0200714 struct workqueue_struct *close_wq;
715 struct workqueue_struct *bb_wq;
Javier González7bd4d372017-10-13 14:46:23 +0200716 struct workqueue_struct *r_end_wq;
Javier Gonzálezef576492017-06-26 11:57:28 +0200717
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200718 struct timer_list wtimer;
719
720 struct pblk_gc gc;
721};
722
723struct pblk_line_ws {
724 struct pblk *pblk;
725 struct pblk_line *line;
726 void *priv;
727 struct work_struct ws;
728};
729
Javier González084ec9b2017-06-26 16:27:13 -0600730#define pblk_g_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_g_ctx))
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200731#define pblk_w_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_c_ctx))
732
Matias Bjørling4e495a42018-07-13 10:48:42 +0200733#define pblk_err(pblk, fmt, ...) \
734 pr_err("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
735#define pblk_info(pblk, fmt, ...) \
736 pr_info("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
737#define pblk_warn(pblk, fmt, ...) \
738 pr_warn("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
739#define pblk_debug(pblk, fmt, ...) \
740 pr_debug("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
741
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200742/*
743 * pblk ring buffer operations
744 */
Javier González766c8ce2018-10-09 13:12:15 +0200745int pblk_rb_init(struct pblk_rb *rb, unsigned int size, unsigned int threshold,
746 unsigned int seg_sz);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200747int pblk_rb_may_write_user(struct pblk_rb *rb, struct bio *bio,
748 unsigned int nr_entries, unsigned int *pos);
749int pblk_rb_may_write_gc(struct pblk_rb *rb, unsigned int nr_entries,
750 unsigned int *pos);
751void pblk_rb_write_entry_user(struct pblk_rb *rb, void *data,
752 struct pblk_w_ctx w_ctx, unsigned int pos);
753void pblk_rb_write_entry_gc(struct pblk_rb *rb, void *data,
Javier Gonzálezd3401212017-10-13 14:46:14 +0200754 struct pblk_w_ctx w_ctx, struct pblk_line *line,
755 u64 paddr, unsigned int pos);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200756struct pblk_w_ctx *pblk_rb_w_ctx(struct pblk_rb *rb, unsigned int pos);
Javier González588726d32017-06-26 11:57:29 +0200757void pblk_rb_flush(struct pblk_rb *rb);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200758
759void pblk_rb_sync_l2p(struct pblk_rb *rb);
Javier Gonzálezd624f372017-06-26 11:57:15 +0200760unsigned int pblk_rb_read_to_bio(struct pblk_rb *rb, struct nvm_rq *rqd,
Javier González875d94f2017-10-13 14:46:18 +0200761 unsigned int pos, unsigned int nr_entries,
762 unsigned int count);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200763int pblk_rb_copy_to_bio(struct pblk_rb *rb, struct bio *bio, sector_t lba,
Javier González75cb8e92017-07-28 15:13:16 +0200764 struct ppa_addr ppa, int bio_iter, bool advanced_bio);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200765unsigned int pblk_rb_read_commit(struct pblk_rb *rb, unsigned int entries);
766
767unsigned int pblk_rb_sync_init(struct pblk_rb *rb, unsigned long *flags);
768unsigned int pblk_rb_sync_advance(struct pblk_rb *rb, unsigned int nr_entries);
Javier González40b86572018-10-09 13:12:09 +0200769unsigned int pblk_rb_ptr_wrap(struct pblk_rb *rb, unsigned int p,
770 unsigned int nr_entries);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200771void pblk_rb_sync_end(struct pblk_rb *rb, unsigned long *flags);
Hans Holmberg8154d292018-01-05 14:16:09 +0100772unsigned int pblk_rb_flush_point_count(struct pblk_rb *rb);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200773
774unsigned int pblk_rb_read_count(struct pblk_rb *rb);
Javier Gonzálezee8d5c12017-06-30 17:56:40 +0200775unsigned int pblk_rb_sync_count(struct pblk_rb *rb);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200776unsigned int pblk_rb_wrap_pos(struct pblk_rb *rb, unsigned int pos);
777
778int pblk_rb_tear_down_check(struct pblk_rb *rb);
779int pblk_rb_pos_oob(struct pblk_rb *rb, u64 pos);
Javier González9bd1f872018-10-09 13:12:10 +0200780void pblk_rb_free(struct pblk_rb *rb);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200781ssize_t pblk_rb_sysfs(struct pblk_rb *rb, char *buf);
782
783/*
784 * pblk core
785 */
Javier González67bf26a2017-10-13 14:46:20 +0200786struct nvm_rq *pblk_alloc_rqd(struct pblk *pblk, int type);
787void pblk_free_rqd(struct pblk *pblk, struct nvm_rq *rqd, int type);
Javier González45dcf292018-10-09 13:12:02 +0200788int pblk_alloc_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
789void pblk_free_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
Javier Gonzálezc2e9f5d2017-06-26 11:57:14 +0200790void pblk_set_sec_per_write(struct pblk *pblk, int sec_per_write);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200791int pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
792 struct pblk_c_ctx *c_ctx);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200793void pblk_discard(struct pblk *pblk, struct bio *bio);
Matias Bjørlingaff3fb12018-10-09 13:11:36 +0200794struct nvm_chk_meta *pblk_get_chunk_meta(struct pblk *pblk);
Javier González32ef9412018-03-30 00:05:20 +0200795struct nvm_chk_meta *pblk_chunk_get_off(struct pblk *pblk,
796 struct nvm_chk_meta *lp,
797 struct ppa_addr ppa);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200798void pblk_log_write_err(struct pblk *pblk, struct nvm_rq *rqd);
799void pblk_log_read_err(struct pblk *pblk, struct nvm_rq *rqd);
800int pblk_submit_io(struct pblk *pblk, struct nvm_rq *rqd);
Javier González1a94b2d2017-10-13 14:46:47 +0200801int pblk_submit_io_sync(struct pblk *pblk, struct nvm_rq *rqd);
Javier González253babc2018-10-09 13:12:04 +0200802int pblk_submit_io_sync_sem(struct pblk *pblk, struct nvm_rq *rqd);
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200803int pblk_submit_meta_io(struct pblk *pblk, struct pblk_line *meta_line);
Hans Holmberg4c44abf2018-10-09 13:11:52 +0200804void pblk_check_chunk_state_update(struct pblk *pblk, struct nvm_rq *rqd);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200805struct bio *pblk_bio_map_addr(struct pblk *pblk, void *data,
806 unsigned int nr_secs, unsigned int len,
Javier Gonzálezde54e702017-06-30 17:56:39 +0200807 int alloc_type, gfp_t gfp_mask);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200808struct pblk_line *pblk_line_get(struct pblk *pblk);
809struct pblk_line *pblk_line_get_first_data(struct pblk *pblk);
Javier González21d22872017-10-13 14:46:26 +0200810struct pblk_line *pblk_line_replace_data(struct pblk *pblk);
Matias Bjørlingae14cc02018-10-09 13:11:40 +0200811void pblk_ppa_to_line_put(struct pblk *pblk, struct ppa_addr ppa);
812void pblk_rq_to_line_put(struct pblk *pblk, struct nvm_rq *rqd);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200813int pblk_line_recov_alloc(struct pblk *pblk, struct pblk_line *line);
814void pblk_line_recov_close(struct pblk *pblk, struct pblk_line *line);
815struct pblk_line *pblk_line_get_data(struct pblk *pblk);
Javier Gonzálezd624f372017-06-26 11:57:15 +0200816struct pblk_line *pblk_line_get_erase(struct pblk *pblk);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200817int pblk_line_erase(struct pblk *pblk, struct pblk_line *line);
818int pblk_line_is_full(struct pblk_line *line);
Javier González8e55c072018-06-01 15:04:22 +0200819void pblk_line_free(struct pblk_line *line);
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200820void pblk_line_close_meta(struct pblk *pblk, struct pblk_line *line);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200821void pblk_line_close(struct pblk *pblk, struct pblk_line *line);
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200822void pblk_line_close_ws(struct work_struct *work);
Javier González588726d32017-06-26 11:57:29 +0200823void pblk_pipeline_stop(struct pblk *pblk);
Javier Gonzáleza7c9e912018-06-01 15:04:24 +0200824void __pblk_pipeline_stop(struct pblk *pblk);
825void __pblk_pipeline_flush(struct pblk *pblk);
Javier Gonzálezb84ae4a82017-10-13 14:46:07 +0200826void pblk_gen_run_ws(struct pblk *pblk, struct pblk_line *line, void *priv,
827 void (*work)(struct work_struct *), gfp_t gfp_mask,
828 struct workqueue_struct *wq);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200829u64 pblk_line_smeta_start(struct pblk *pblk, struct pblk_line *line);
Javier Gonzálezaf3fac12018-10-09 13:12:03 +0200830int pblk_line_smeta_read(struct pblk *pblk, struct pblk_line *line);
831int pblk_line_emeta_read(struct pblk *pblk, struct pblk_line *line,
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200832 void *emeta_buf);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200833int pblk_blk_erase_async(struct pblk *pblk, struct ppa_addr erase_ppa);
834void pblk_line_put(struct kref *ref);
Javier González7bd4d372017-10-13 14:46:23 +0200835void pblk_line_put_wq(struct kref *ref);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200836struct list_head *pblk_line_gc_list(struct pblk *pblk, struct pblk_line *line);
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200837u64 pblk_lookup_page(struct pblk *pblk, struct pblk_line *line);
838void pblk_dealloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200839u64 pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200840u64 __pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200841int pblk_calc_secs(struct pblk *pblk, unsigned long secs_avail,
842 unsigned long secs_to_flush);
Matias Bjørling43241cf2018-10-09 13:11:51 +0200843void pblk_down_rq(struct pblk *pblk, struct ppa_addr ppa,
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200844 unsigned long *lun_bitmap);
Matias Bjørling43241cf2018-10-09 13:11:51 +0200845void pblk_down_chunk(struct pblk *pblk, struct ppa_addr ppa);
846void pblk_up_chunk(struct pblk *pblk, struct ppa_addr ppa);
Hans Holmberge99e8022018-10-09 13:11:48 +0200847void pblk_up_rq(struct pblk *pblk, unsigned long *lun_bitmap);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200848int pblk_bio_add_pages(struct pblk *pblk, struct bio *bio, gfp_t flags,
849 int nr_pages);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200850void pblk_bio_free_pages(struct pblk *pblk, struct bio *bio, int off,
851 int nr_pages);
852void pblk_map_invalidate(struct pblk *pblk, struct ppa_addr ppa);
Javier González0880a9a2017-06-26 11:57:19 +0200853void __pblk_map_invalidate(struct pblk *pblk, struct pblk_line *line,
854 u64 paddr);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200855void pblk_update_map(struct pblk *pblk, sector_t lba, struct ppa_addr ppa);
856void pblk_update_map_cache(struct pblk *pblk, sector_t lba,
857 struct ppa_addr ppa);
858void pblk_update_map_dev(struct pblk *pblk, sector_t lba,
859 struct ppa_addr ppa, struct ppa_addr entry_line);
860int pblk_update_map_gc(struct pblk *pblk, sector_t lba, struct ppa_addr ppa,
Javier Gonzálezd3401212017-10-13 14:46:14 +0200861 struct pblk_line *gc_line, u64 paddr);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200862void pblk_lookup_l2p_rand(struct pblk *pblk, struct ppa_addr *ppas,
863 u64 *lba_list, int nr_secs);
864void pblk_lookup_l2p_seq(struct pblk *pblk, struct ppa_addr *ppas,
865 sector_t blba, int nr_secs);
866
867/*
868 * pblk user I/O write path
869 */
870int pblk_write_to_cache(struct pblk *pblk, struct bio *bio,
871 unsigned long flags);
Javier Gonzálezd3401212017-10-13 14:46:14 +0200872int pblk_write_gc_to_cache(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200873
874/*
875 * pblk map
876 */
Hans Holmberg525f7bb2018-12-11 20:16:12 +0100877int pblk_map_erase_rq(struct pblk *pblk, struct nvm_rq *rqd,
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200878 unsigned int sentry, unsigned long *lun_bitmap,
879 unsigned int valid_secs, struct ppa_addr *erase_ppa);
Hans Holmberg525f7bb2018-12-11 20:16:12 +0100880int pblk_map_rq(struct pblk *pblk, struct nvm_rq *rqd, unsigned int sentry,
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200881 unsigned long *lun_bitmap, unsigned int valid_secs,
882 unsigned int off);
883
884/*
885 * pblk write thread
886 */
887int pblk_write_ts(void *data);
Kees Cook87c1d2d2017-10-17 21:10:19 -0700888void pblk_write_timer_fn(struct timer_list *t);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200889void pblk_write_should_kick(struct pblk *pblk);
Hans Holmbergcc9c9a02018-06-01 16:41:13 +0200890void pblk_write_kick(struct pblk *pblk);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200891
892/*
893 * pblk read path
894 */
Kent Overstreetb906bbb2018-05-20 18:25:50 -0400895extern struct bio_set pblk_bio_set;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200896int pblk_submit_read(struct pblk *pblk, struct bio *bio);
Javier Gonzálezd3401212017-10-13 14:46:14 +0200897int pblk_submit_read_gc(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200898/*
899 * pblk recovery
900 */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200901struct pblk_line *pblk_recov_l2p(struct pblk *pblk);
Javier González588726d32017-06-26 11:57:29 +0200902int pblk_recov_pad(struct pblk *pblk);
Hans Holmberg06bc0722018-01-05 14:16:08 +0100903int pblk_recov_check_emeta(struct pblk *pblk, struct line_emeta *emeta);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200904
905/*
906 * pblk gc
907 */
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200908#define PBLK_GC_MAX_READERS 8 /* Max number of outstanding GC reader jobs */
Javier González36278962017-10-13 14:46:11 +0200909#define PBLK_GC_RQ_QD 128 /* Queue depth for inflight GC requests */
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200910#define PBLK_GC_L_QD 4 /* Queue depth for inflight GC lines */
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200911
912int pblk_gc_init(struct pblk *pblk);
Javier Gonzáleza7c9e912018-06-01 15:04:24 +0200913void pblk_gc_exit(struct pblk *pblk, bool graceful);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200914void pblk_gc_should_start(struct pblk *pblk);
915void pblk_gc_should_stop(struct pblk *pblk);
Hans Holmberg03661b52017-10-13 14:46:37 +0200916void pblk_gc_should_kick(struct pblk *pblk);
Hans Holmberg37ce33d2017-10-13 14:46:36 +0200917void pblk_gc_free_full_lines(struct pblk *pblk);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200918void pblk_gc_sysfs_state_show(struct pblk *pblk, int *gc_enabled,
919 int *gc_active);
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200920int pblk_gc_sysfs_force(struct pblk *pblk, int force);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200921
922/*
923 * pblk rate limiter
924 */
925void pblk_rl_init(struct pblk_rl *rl, int budget);
926void pblk_rl_free(struct pblk_rl *rl);
Hans Holmberg03661b52017-10-13 14:46:37 +0200927void pblk_rl_update_rates(struct pblk_rl *rl);
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200928int pblk_rl_high_thrs(struct pblk_rl *rl);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200929unsigned long pblk_rl_nr_free_blks(struct pblk_rl *rl);
Javier Gonzáleza7689932018-01-05 14:16:13 +0100930unsigned long pblk_rl_nr_user_free_blks(struct pblk_rl *rl);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200931int pblk_rl_user_may_insert(struct pblk_rl *rl, int nr_entries);
Javier González588726d32017-06-26 11:57:29 +0200932void pblk_rl_inserted(struct pblk_rl *rl, int nr_entries);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200933void pblk_rl_user_in(struct pblk_rl *rl, int nr_entries);
934int pblk_rl_gc_may_insert(struct pblk_rl *rl, int nr_entries);
935void pblk_rl_gc_in(struct pblk_rl *rl, int nr_entries);
936void pblk_rl_out(struct pblk_rl *rl, int nr_user, int nr_gc);
Javier Gonzálezda67e68f2017-10-13 14:46:05 +0200937int pblk_rl_max_io(struct pblk_rl *rl);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200938void pblk_rl_free_lines_inc(struct pblk_rl *rl, struct pblk_line *line);
Javier Gonzáleza7689932018-01-05 14:16:13 +0100939void pblk_rl_free_lines_dec(struct pblk_rl *rl, struct pblk_line *line,
940 bool used);
Javier González588726d32017-06-26 11:57:29 +0200941int pblk_rl_is_limit(struct pblk_rl *rl);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200942
Hans Holmberg48b8d202018-06-01 16:41:06 +0200943void pblk_rl_werr_line_in(struct pblk_rl *rl);
944void pblk_rl_werr_line_out(struct pblk_rl *rl);
945
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200946/*
947 * pblk sysfs
948 */
949int pblk_sysfs_init(struct gendisk *tdisk);
950void pblk_sysfs_exit(struct gendisk *tdisk);
951
952static inline void *pblk_malloc(size_t size, int type, gfp_t flags)
953{
954 if (type == PBLK_KMALLOC_META)
955 return kmalloc(size, flags);
956 return vmalloc(size);
957}
958
959static inline void pblk_mfree(void *ptr, int type)
960{
961 if (type == PBLK_KMALLOC_META)
962 kfree(ptr);
963 else
964 vfree(ptr);
965}
966
967static inline struct nvm_rq *nvm_rq_from_c_ctx(void *c_ctx)
968{
969 return c_ctx - sizeof(struct nvm_rq);
970}
971
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200972static inline void *emeta_to_bb(struct line_emeta *emeta)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200973{
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200974 return emeta->bb_bitmap;
975}
976
Hans Holmberg76758392018-03-30 00:04:52 +0200977static inline void *emeta_to_wa(struct pblk_line_meta *lm,
978 struct line_emeta *emeta)
979{
980 return emeta->bb_bitmap + lm->blk_bitmap_len;
981}
982
Javier Gonzálezdd2a4342017-06-26 11:57:17 +0200983static inline void *emeta_to_lbas(struct pblk *pblk, struct line_emeta *emeta)
984{
985 return ((void *)emeta + pblk->lm.emeta_len[1]);
986}
987
988static inline void *emeta_to_vsc(struct pblk *pblk, struct line_emeta *emeta)
989{
990 return (emeta_to_lbas(pblk, emeta) + pblk->lm.emeta_len[2]);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200991}
992
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200993static inline int pblk_line_vsc(struct pblk_line *line)
994{
Javier Gonzálezd3401212017-10-13 14:46:14 +0200995 return le32_to_cpu(*line->vsc);
Javier Gonzálezb20ba1b2017-06-26 11:57:27 +0200996}
997
Javier Gonzálezcb216652018-10-09 13:11:42 +0200998static inline int pblk_ppa_to_line_id(struct ppa_addr p)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +0200999{
Javier González69471512018-03-30 00:05:15 +02001000 return p.a.blk;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001001}
1002
Javier Gonzálezcb216652018-10-09 13:11:42 +02001003static inline struct pblk_line *pblk_ppa_to_line(struct pblk *pblk,
1004 struct ppa_addr p)
1005{
1006 return &pblk->lines[pblk_ppa_to_line_id(p)];
1007}
1008
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001009static inline int pblk_ppa_to_pos(struct nvm_geo *geo, struct ppa_addr p)
1010{
Javier González69471512018-03-30 00:05:15 +02001011 return p.a.lun * geo->num_ch + p.a.ch;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001012}
1013
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001014static inline struct ppa_addr addr_to_gen_ppa(struct pblk *pblk, u64 paddr,
1015 u64 line_id)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001016{
Javier González3b2a3ad2018-03-30 00:05:21 +02001017 struct nvm_tgt_dev *dev = pblk->dev;
1018 struct nvm_geo *geo = &dev->geo;
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001019 struct ppa_addr ppa;
1020
Javier González3b2a3ad2018-03-30 00:05:21 +02001021 if (geo->version == NVM_OCSSD_SPEC_12) {
1022 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
1023
1024 ppa.ppa = 0;
1025 ppa.g.blk = line_id;
1026 ppa.g.pg = (paddr & ppaf->pg_mask) >> ppaf->pg_offset;
1027 ppa.g.lun = (paddr & ppaf->lun_mask) >> ppaf->lun_offset;
1028 ppa.g.ch = (paddr & ppaf->ch_mask) >> ppaf->ch_offset;
1029 ppa.g.pl = (paddr & ppaf->pln_mask) >> ppaf->pln_offset;
1030 ppa.g.sec = (paddr & ppaf->sec_mask) >> ppaf->sec_offset;
1031 } else {
1032 struct pblk_addrf *uaddrf = &pblk->uaddrf;
1033 int secs, chnls, luns;
1034
1035 ppa.ppa = 0;
1036
1037 ppa.m.chk = line_id;
1038
1039 paddr = div_u64_rem(paddr, uaddrf->sec_stripe, &secs);
1040 ppa.m.sec = secs;
1041
1042 paddr = div_u64_rem(paddr, uaddrf->ch_stripe, &chnls);
1043 ppa.m.grp = chnls;
1044
1045 paddr = div_u64_rem(paddr, uaddrf->lun_stripe, &luns);
1046 ppa.m.pu = luns;
1047
1048 ppa.m.sec += uaddrf->sec_stripe * paddr;
1049 }
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001050
1051 return ppa;
1052}
1053
Javier González2cf99bb2018-10-09 13:11:41 +02001054static inline struct nvm_chk_meta *pblk_dev_ppa_to_chunk(struct pblk *pblk,
1055 struct ppa_addr p)
1056{
1057 struct nvm_tgt_dev *dev = pblk->dev;
1058 struct nvm_geo *geo = &dev->geo;
Javier Gonzálezcb216652018-10-09 13:11:42 +02001059 struct pblk_line *line = pblk_ppa_to_line(pblk, p);
Javier González2cf99bb2018-10-09 13:11:41 +02001060 int pos = pblk_ppa_to_pos(geo, p);
1061
1062 return &line->chks[pos];
1063}
1064
1065static inline u64 pblk_dev_ppa_to_chunk_addr(struct pblk *pblk,
1066 struct ppa_addr p)
1067{
1068 struct nvm_tgt_dev *dev = pblk->dev;
1069
1070 return dev_to_chunk_addr(dev->parent, &pblk->addrf, p);
1071}
1072
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001073static inline u64 pblk_dev_ppa_to_line_addr(struct pblk *pblk,
1074 struct ppa_addr p)
1075{
Javier González3b2a3ad2018-03-30 00:05:21 +02001076 struct nvm_tgt_dev *dev = pblk->dev;
1077 struct nvm_geo *geo = &dev->geo;
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001078 u64 paddr;
1079
Javier González3b2a3ad2018-03-30 00:05:21 +02001080 if (geo->version == NVM_OCSSD_SPEC_12) {
1081 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
1082
1083 paddr = (u64)p.g.ch << ppaf->ch_offset;
1084 paddr |= (u64)p.g.lun << ppaf->lun_offset;
1085 paddr |= (u64)p.g.pg << ppaf->pg_offset;
1086 paddr |= (u64)p.g.pl << ppaf->pln_offset;
1087 paddr |= (u64)p.g.sec << ppaf->sec_offset;
1088 } else {
1089 struct pblk_addrf *uaddrf = &pblk->uaddrf;
1090 u64 secs = p.m.sec;
1091 int sec_stripe;
1092
1093 paddr = (u64)p.m.grp * uaddrf->sec_stripe;
1094 paddr += (u64)p.m.pu * uaddrf->sec_lun_stripe;
1095
1096 secs = div_u64_rem(secs, uaddrf->sec_stripe, &sec_stripe);
1097 paddr += secs * uaddrf->sec_ws_stripe;
1098 paddr += sec_stripe;
1099 }
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001100
1101 return paddr;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001102}
1103
1104static inline struct ppa_addr pblk_ppa32_to_ppa64(struct pblk *pblk, u32 ppa32)
1105{
Javier González7f985f92018-10-09 13:11:56 +02001106 struct nvm_tgt_dev *dev = pblk->dev;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001107
Javier González7f985f92018-10-09 13:11:56 +02001108 return nvm_ppa32_to_ppa64(dev->parent, &pblk->addrf, ppa32);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001109}
1110
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001111static inline u32 pblk_ppa64_to_ppa32(struct pblk *pblk, struct ppa_addr ppa64)
1112{
Javier González7f985f92018-10-09 13:11:56 +02001113 struct nvm_tgt_dev *dev = pblk->dev;
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001114
Javier González7f985f92018-10-09 13:11:56 +02001115 return nvm_ppa64_to_ppa32(dev->parent, &pblk->addrf, ppa64);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001116}
1117
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001118static inline struct ppa_addr pblk_trans_map_get(struct pblk *pblk,
1119 sector_t lba)
1120{
1121 struct ppa_addr ppa;
1122
Javier Gonzálezbb845ae42018-03-30 00:05:19 +02001123 if (pblk->addrf_len < 32) {
Javier Gonzálezb1bcfda2018-01-05 14:16:06 +01001124 u32 *map = (u32 *)pblk->trans_map;
1125
1126 ppa = pblk_ppa32_to_ppa64(pblk, map[lba]);
1127 } else {
1128 struct ppa_addr *map = (struct ppa_addr *)pblk->trans_map;
1129
1130 ppa = map[lba];
1131 }
1132
1133 return ppa;
1134}
1135
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001136static inline void pblk_trans_map_set(struct pblk *pblk, sector_t lba,
1137 struct ppa_addr ppa)
1138{
Javier Gonzálezbb845ae42018-03-30 00:05:19 +02001139 if (pblk->addrf_len < 32) {
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001140 u32 *map = (u32 *)pblk->trans_map;
1141
1142 map[lba] = pblk_ppa64_to_ppa32(pblk, ppa);
1143 } else {
1144 u64 *map = (u64 *)pblk->trans_map;
1145
1146 map[lba] = ppa.ppa;
1147 }
1148}
1149
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001150static inline int pblk_ppa_empty(struct ppa_addr ppa_addr)
1151{
1152 return (ppa_addr.ppa == ADDR_EMPTY);
1153}
1154
1155static inline void pblk_ppa_set_empty(struct ppa_addr *ppa_addr)
1156{
1157 ppa_addr->ppa = ADDR_EMPTY;
1158}
1159
Javier González076984662017-06-30 17:56:42 +02001160static inline bool pblk_ppa_comp(struct ppa_addr lppa, struct ppa_addr rppa)
1161{
Matias Bjørling8b7bc842018-01-05 14:16:21 +01001162 return (lppa.ppa == rppa.ppa);
Javier González076984662017-06-30 17:56:42 +02001163}
1164
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001165static inline int pblk_addr_in_cache(struct ppa_addr ppa)
1166{
1167 return (ppa.ppa != ADDR_EMPTY && ppa.c.is_cached);
1168}
1169
1170static inline int pblk_addr_to_cacheline(struct ppa_addr ppa)
1171{
1172 return ppa.c.line;
1173}
1174
1175static inline struct ppa_addr pblk_cacheline_to_addr(int addr)
1176{
1177 struct ppa_addr p;
1178
1179 p.c.line = addr;
1180 p.c.is_cached = 1;
1181
1182 return p;
1183}
1184
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001185static inline u32 pblk_calc_meta_header_crc(struct pblk *pblk,
Javier Gonzálezdd2a4342017-06-26 11:57:17 +02001186 struct line_header *header)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001187{
1188 u32 crc = ~(u32)0;
1189
Javier Gonzálezdd2a4342017-06-26 11:57:17 +02001190 crc = crc32_le(crc, (unsigned char *)header + sizeof(crc),
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001191 sizeof(struct line_header) - sizeof(crc));
1192
1193 return crc;
1194}
1195
1196static inline u32 pblk_calc_smeta_crc(struct pblk *pblk,
1197 struct line_smeta *smeta)
1198{
1199 struct pblk_line_meta *lm = &pblk->lm;
1200 u32 crc = ~(u32)0;
1201
1202 crc = crc32_le(crc, (unsigned char *)smeta +
1203 sizeof(struct line_header) + sizeof(crc),
1204 lm->smeta_len -
1205 sizeof(struct line_header) - sizeof(crc));
1206
1207 return crc;
1208}
1209
1210static inline u32 pblk_calc_emeta_crc(struct pblk *pblk,
1211 struct line_emeta *emeta)
1212{
1213 struct pblk_line_meta *lm = &pblk->lm;
1214 u32 crc = ~(u32)0;
1215
1216 crc = crc32_le(crc, (unsigned char *)emeta +
1217 sizeof(struct line_header) + sizeof(crc),
Javier Gonzálezdd2a4342017-06-26 11:57:17 +02001218 lm->emeta_len[0] -
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001219 sizeof(struct line_header) - sizeof(crc));
1220
1221 return crc;
1222}
1223
Javier Gonzálezf9c10152017-06-26 11:57:20 +02001224static inline int pblk_io_aligned(struct pblk *pblk, int nr_secs)
1225{
1226 return !(nr_secs % pblk->min_write_pgs);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001227}
1228
Matias Bjørling880eda52018-07-13 10:48:37 +02001229#ifdef CONFIG_NVM_PBLK_DEBUG
Matias Bjørling4e495a42018-07-13 10:48:42 +02001230static inline void print_ppa(struct pblk *pblk, struct ppa_addr *p,
Javier González3b2a3ad2018-03-30 00:05:21 +02001231 char *msg, int error)
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001232{
Matias Bjørling4e495a42018-07-13 10:48:42 +02001233 struct nvm_geo *geo = &pblk->dev->geo;
1234
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001235 if (p->c.is_cached) {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001236 pblk_err(pblk, "ppa: (%s: %x) cache line: %llu\n",
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001237 msg, error, (u64)p->c.line);
Javier González3b2a3ad2018-03-30 00:05:21 +02001238 } else if (geo->version == NVM_OCSSD_SPEC_12) {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001239 pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,blk:%d,pg:%d,pl:%d,sec:%d\n",
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001240 msg, error,
1241 p->g.ch, p->g.lun, p->g.blk,
1242 p->g.pg, p->g.pl, p->g.sec);
Javier González3b2a3ad2018-03-30 00:05:21 +02001243 } else {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001244 pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,chk:%d,sec:%d\n",
Javier González3b2a3ad2018-03-30 00:05:21 +02001245 msg, error,
1246 p->m.grp, p->m.pu, p->m.chk, p->m.sec);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001247 }
1248}
1249
1250static inline void pblk_print_failed_rqd(struct pblk *pblk, struct nvm_rq *rqd,
1251 int error)
1252{
1253 int bit = -1;
1254
1255 if (rqd->nr_ppas == 1) {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001256 print_ppa(pblk, &rqd->ppa_addr, "rqd", error);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001257 return;
1258 }
1259
1260 while ((bit = find_next_bit((void *)&rqd->ppa_status, rqd->nr_ppas,
1261 bit + 1)) < rqd->nr_ppas) {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001262 print_ppa(pblk, &rqd->ppa_list[bit], "rqd", error);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001263 }
1264
Matias Bjørling4e495a42018-07-13 10:48:42 +02001265 pblk_err(pblk, "error:%d, ppa_status:%llx\n", error, rqd->ppa_status);
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001266}
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001267
1268static inline int pblk_boundary_ppa_checks(struct nvm_tgt_dev *tgt_dev,
1269 struct ppa_addr *ppas, int nr_ppas)
1270{
1271 struct nvm_geo *geo = &tgt_dev->geo;
1272 struct ppa_addr *ppa;
1273 int i;
1274
1275 for (i = 0; i < nr_ppas; i++) {
1276 ppa = &ppas[i];
1277
Javier González3b2a3ad2018-03-30 00:05:21 +02001278 if (geo->version == NVM_OCSSD_SPEC_12) {
1279 if (!ppa->c.is_cached &&
1280 ppa->g.ch < geo->num_ch &&
1281 ppa->g.lun < geo->num_lun &&
1282 ppa->g.pl < geo->num_pln &&
1283 ppa->g.blk < geo->num_chk &&
1284 ppa->g.pg < geo->num_pg &&
1285 ppa->g.sec < geo->ws_min)
1286 continue;
1287 } else {
1288 if (!ppa->c.is_cached &&
1289 ppa->m.grp < geo->num_ch &&
1290 ppa->m.pu < geo->num_lun &&
1291 ppa->m.chk < geo->num_chk &&
1292 ppa->m.sec < geo->clba)
1293 continue;
1294 }
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001295
Matias Bjørling4e495a42018-07-13 10:48:42 +02001296 print_ppa(tgt_dev->q->queuedata, ppa, "boundary", i);
Javier González1a94b2d2017-10-13 14:46:47 +02001297
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001298 return 1;
1299 }
1300 return 0;
1301}
1302
Javier González1a94b2d2017-10-13 14:46:47 +02001303static inline int pblk_check_io(struct pblk *pblk, struct nvm_rq *rqd)
1304{
1305 struct nvm_tgt_dev *dev = pblk->dev;
Hans Holmbergd68a9342018-10-09 13:11:46 +02001306 struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
Javier González1a94b2d2017-10-13 14:46:47 +02001307
1308 if (pblk_boundary_ppa_checks(dev, ppa_list, rqd->nr_ppas)) {
1309 WARN_ON(1);
1310 return -EINVAL;
1311 }
1312
1313 if (rqd->opcode == NVM_OP_PWRITE) {
1314 struct pblk_line *line;
Javier González1a94b2d2017-10-13 14:46:47 +02001315 int i;
1316
1317 for (i = 0; i < rqd->nr_ppas; i++) {
Javier Gonzálezcb216652018-10-09 13:11:42 +02001318 line = pblk_ppa_to_line(pblk, ppa_list[i]);
Javier González1a94b2d2017-10-13 14:46:47 +02001319
1320 spin_lock(&line->lock);
1321 if (line->state != PBLK_LINESTATE_OPEN) {
Matias Bjørling4e495a42018-07-13 10:48:42 +02001322 pblk_err(pblk, "bad ppa: line:%d,state:%d\n",
Javier González1a94b2d2017-10-13 14:46:47 +02001323 line->id, line->state);
1324 WARN_ON(1);
1325 spin_unlock(&line->lock);
1326 return -EINVAL;
1327 }
1328 spin_unlock(&line->lock);
1329 }
1330 }
1331
1332 return 0;
1333}
1334#endif
1335
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001336static inline int pblk_boundary_paddr_checks(struct pblk *pblk, u64 paddr)
1337{
1338 struct pblk_line_meta *lm = &pblk->lm;
1339
1340 if (paddr > lm->sec_per_line)
1341 return 1;
1342
1343 return 0;
1344}
1345
1346static inline unsigned int pblk_get_bi_idx(struct bio *bio)
1347{
1348 return bio->bi_iter.bi_idx;
1349}
1350
1351static inline sector_t pblk_get_lba(struct bio *bio)
1352{
1353 return bio->bi_iter.bi_sector / NR_PHY_IN_LOG;
1354}
1355
1356static inline unsigned int pblk_get_secs(struct bio *bio)
1357{
1358 return bio->bi_iter.bi_size / PBLK_EXPOSED_PAGE_SIZE;
1359}
1360
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001361static inline void pblk_setup_uuid(struct pblk *pblk)
1362{
1363 uuid_le uuid;
1364
1365 uuid_le_gen(&uuid);
1366 memcpy(pblk->instance_uuid, uuid.b, 16);
1367}
Hans Holmberg4c44abf2018-10-09 13:11:52 +02001368
1369static inline char *pblk_disk_name(struct pblk *pblk)
1370{
1371 struct gendisk *disk = pblk->disk;
1372
1373 return disk->disk_name;
1374}
Hans Holmberg3bcebc52018-12-11 20:16:13 +01001375
1376static inline unsigned int pblk_get_min_chks(struct pblk *pblk)
1377{
1378 struct pblk_line_meta *lm = &pblk->lm;
1379 /* In a worst-case scenario every line will have OP invalid sectors.
1380 * We will then need a minimum of 1/OP lines to free up a single line
1381 */
1382
1383 return DIV_ROUND_UP(100, pblk->op) * lm->blk_per_line;
Igor Konopkofaa79f22018-12-11 20:16:23 +01001384}
Hans Holmberg3bcebc52018-12-11 20:16:13 +01001385
Igor Konopkofaa79f22018-12-11 20:16:23 +01001386static inline struct pblk_sec_meta *pblk_get_meta(struct pblk *pblk,
1387 void *meta, int index)
1388{
1389 return meta + pblk->oob_meta_size * index;
Hans Holmberg3bcebc52018-12-11 20:16:13 +01001390}
Javier Gonzáleza4bd2172017-04-15 20:55:50 +02001391#endif /* PBLK_H_ */