drivers/lightnvm/pblk.h

   1 /*
   2  * Copyright (C) 2015 IT University of Copenhagen (rrpc.h)
   3  * Copyright (C) 2016 CNEX Labs
   4  * Initial release: Matias Bjorling <matias@cnexlabs.com>
   5  * Write buffering: Javier Gonzalez <javier@cnexlabs.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License version
   9  * 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * Implementation of a Physical Block-device target for Open-channel SSDs.
  17  *
  18  */
  19
  20 #ifndef PBLK_H_
  21 #define PBLK_H_
  22
  23 #include <linux/blkdev.h>
  24 #include <linux/blk-mq.h>
  25 #include <linux/bio.h>
  26 #include <linux/module.h>
  27 #include <linux/kthread.h>
  28 #include <linux/vmalloc.h>
  29 #include <linux/crc32.h>
  30 #include <linux/uuid.h>
  31
  32 #include <linux/lightnvm.h>
  33
  34 /* Run only GC if less than 1/X blocks are free */
  35 #define GC_LIMIT_INVERSE 5
  36 #define GC_TIME_MSECS 1000
  37
  38 #define PBLK_SECTOR (512)
  39 #define PBLK_EXPOSED_PAGE_SIZE (4096)
  40 #define PBLK_MAX_REQ_ADDRS (64)
  41 #define PBLK_MAX_REQ_ADDRS_PW (6)
  42
  43 #define PBLK_WS_POOL_SIZE (128)
  44 #define PBLK_META_POOL_SIZE (128)
  45 #define PBLK_READ_REQ_POOL_SIZE (1024)
  46
  47 #define PBLK_NR_CLOSE_JOBS (4)
  48
  49 #define PBLK_CACHE_NAME_LEN (DISK_NAME_LEN + 16)
  50
  51 #define PBLK_COMMAND_TIMEOUT_MS 30000
  52
  53 /* Max 512 LUNs per device */
  54 #define PBLK_MAX_LUNS_BITMAP (4)
  55
  56 #define NR_PHY_IN_LOG (PBLK_EXPOSED_PAGE_SIZE / PBLK_SECTOR)
  57
  58 #define pblk_for_each_lun(pblk, rlun, i) \
  59                 for ((i) = 0, rlun = &(pblk)->luns[0]; \
  60                         (i) < (pblk)->nr_luns; (i)++, rlun = &(pblk)->luns[(i)])
  61
  62 #define ERASE 2 /* READ = 0, WRITE = 1 */
  63
  64 enum {
  65         /* IO Types */
  66         PBLK_IOTYPE_USER        = 1 << 0,
  67         PBLK_IOTYPE_GC          = 1 << 1,
  68
  69         /* Write buffer flags */
  70         PBLK_FLUSH_ENTRY        = 1 << 2,
  71         PBLK_WRITTEN_DATA       = 1 << 3,
  72         PBLK_SUBMITTED_ENTRY    = 1 << 4,
  73         PBLK_WRITABLE_ENTRY     = 1 << 5,
  74 };
  75
  76 enum {
  77         PBLK_BLK_ST_OPEN =      0x1,
  78         PBLK_BLK_ST_CLOSED =    0x2,
  79 };
  80
  81 struct pblk_sec_meta {
  82         u64 reserved;
  83         __le64 lba;
  84 };
  85
  86 /* The number of GC lists and the rate-limiter states go together. This way the
  87  * rate-limiter can dictate how much GC is needed based on resource utilization.
  88  */
  89 #define PBLK_GC_NR_LISTS 3
  90
  91 enum {
  92         PBLK_RL_HIGH = 1,
  93         PBLK_RL_MID = 2,
  94         PBLK_RL_LOW = 3,
  95 };
  96
  97 #define pblk_dma_meta_size (sizeof(struct pblk_sec_meta) * PBLK_MAX_REQ_ADDRS)
  98
  99 /* write buffer completion context */
 100 struct pblk_c_ctx {
 101         struct list_head list;          /* Head for out-of-order completion */
 102
 103         unsigned long *lun_bitmap;      /* Luns used on current request */
 104         unsigned int sentry;
 105         unsigned int nr_valid;
 106         unsigned int nr_padded;
 107 };
 108
 109 /* generic context */
 110 struct pblk_g_ctx {
 111         void *private;
 112 };
 113
 114 /* Pad context */
 115 struct pblk_pad_rq {
 116         struct pblk *pblk;
 117         struct completion wait;
 118         struct kref ref;
 119 };
 120
 121 /* Recovery context */
 122 struct pblk_rec_ctx {
 123         struct pblk *pblk;
 124         struct nvm_rq *rqd;
 125         struct list_head failed;
 126         struct work_struct ws_rec;
 127 };
 128
 129 /* Write context */
 130 struct pblk_w_ctx {
 131         struct bio_list bios;           /* Original bios - used for completion
 132                                          * in REQ_FUA, REQ_FLUSH case
 133                                          */
 134         u64 lba;                        /* Logic addr. associated with entry */
 135         struct ppa_addr ppa;            /* Physic addr. associated with entry */
 136         int flags;                      /* Write context flags */
 137 };
 138
 139 struct pblk_rb_entry {
 140         struct ppa_addr cacheline;      /* Cacheline for this entry */
 141         void *data;                     /* Pointer to data on this entry */
 142         struct pblk_w_ctx w_ctx;        /* Context for this entry */
 143         struct list_head index;         /* List head to enable indexes */
 144 };
 145
 146 #define EMPTY_ENTRY (~0U)
 147
 148 struct pblk_rb_pages {
 149         struct page *pages;
 150         int order;
 151         struct list_head list;
 152 };
 153
 154 struct pblk_rb {
 155         struct pblk_rb_entry *entries;  /* Ring buffer entries */
 156         unsigned int mem;               /* Write offset - points to next
 157                                          * writable entry in memory
 158                                          */
 159         unsigned int subm;              /* Read offset - points to last entry
 160                                          * that has been submitted to the media
 161                                          * to be persisted
 162                                          */
 163         unsigned int sync;              /* Synced - backpointer that signals
 164                                          * the last submitted entry that has
 165                                          * been successfully persisted to media
 166                                          */
 167         unsigned int sync_point;        /* Sync point - last entry that must be
 168                                          * flushed to the media. Used with
 169                                          * REQ_FLUSH and REQ_FUA
 170                                          */
 171         unsigned int l2p_update;        /* l2p update point - next entry for
 172                                          * which l2p mapping will be updated to
 173                                          * contain a device ppa address (instead
 174                                          * of a cacheline
 175                                          */
 176         unsigned int nr_entries;        /* Number of entries in write buffer -
 177                                          * must be a power of two
 178                                          */
 179         unsigned int seg_size;          /* Size of the data segments being
 180                                          * stored on each entry. Typically this
 181                                          * will be 4KB
 182                                          */
 183
 184         struct list_head pages;         /* List of data pages */
 185
 186         spinlock_t w_lock;              /* Write lock */
 187         spinlock_t s_lock;              /* Sync lock */
 188
 189 #ifdef CONFIG_NVM_DEBUG
 190         atomic_t inflight_sync_point;   /* Not served REQ_FLUSH | REQ_FUA */
 191 #endif
 192 };
 193
 194 #define PBLK_RECOVERY_SECTORS 16
 195
 196 struct pblk_lun {
 197         struct ppa_addr bppa;
 198
 199         u8 *bb_list;                    /* Bad block list for LUN. Only used on
 200                                          * bring up. Bad blocks are managed
 201                                          * within lines on run-time.
 202                                          */
 203
 204         struct semaphore wr_sem;
 205 };
 206
 207 struct pblk_gc_rq {
 208         struct pblk_line *line;
 209         void *data;
 210         u64 lba_list[PBLK_MAX_REQ_ADDRS];
 211         int nr_secs;
 212         int secs_to_gc;
 213         struct list_head list;
 214 };
 215
 216 struct pblk_gc {
 217         /* These states are not protected by a lock since (i) they are in the
 218          * fast path, and (ii) they are not critical.
 219          */
 220         int gc_active;
 221         int gc_enabled;
 222         int gc_forced;
 223
 224         struct task_struct *gc_ts;
 225         struct task_struct *gc_writer_ts;
 226         struct task_struct *gc_reader_ts;
 227
 228         struct workqueue_struct *gc_line_reader_wq;
 229         struct workqueue_struct *gc_reader_wq;
 230
 231         struct timer_list gc_timer;
 232
 233         struct semaphore gc_sem;
 234         atomic_t inflight_gc;
 235         int w_entries;
 236
 237         struct list_head w_list;
 238         struct list_head r_list;
 239
 240         spinlock_t lock;
 241         spinlock_t w_lock;
 242         spinlock_t r_lock;
 243 };
 244
 245 struct pblk_rl {
 246         unsigned int high;      /* Upper threshold for rate limiter (free run -
 247                                  * user I/O rate limiter
 248                                  */
 249         unsigned int low;       /* Lower threshold for rate limiter (user I/O
 250                                  * rate limiter - stall)
 251                                  */
 252         unsigned int high_pw;   /* High rounded up as a power of 2 */
 253
 254 #define PBLK_USER_HIGH_THRS 8   /* Begin write limit at 12% available blks */
 255 #define PBLK_USER_LOW_THRS 10   /* Aggressive GC at 10% available blocks */
 256
 257         int rb_windows_pw;      /* Number of rate windows in the write buffer
 258                                  * given as a power-of-2. This guarantees that
 259                                  * when user I/O is being rate limited, there
 260                                  * will be reserved enough space for the GC to
 261                                  * place its payload. A window is of
 262                                  * pblk->max_write_pgs size, which in NVMe is
 263                                  * 64, i.e., 256kb.
 264                                  */
 265         int rb_budget;          /* Total number of entries available for I/O */
 266         int rb_user_max;        /* Max buffer entries available for user I/O */
 267         int rb_gc_max;          /* Max buffer entries available for GC I/O */
 268         int rb_gc_rsv;          /* Reserved buffer entries for GC I/O */
 269         int rb_state;           /* Rate-limiter current state */
 270         int rb_max_io;          /* Maximum size for an I/O giving the config */
 271
 272         atomic_t rb_user_cnt;   /* User I/O buffer counter */
 273         atomic_t rb_gc_cnt;     /* GC I/O buffer counter */
 274         atomic_t rb_space;      /* Space limit in case of reaching capacity */
 275
 276         int rsv_blocks;         /* Reserved blocks for GC */
 277
 278         int rb_user_active;
 279         int rb_gc_active;
 280
 281         struct timer_list u_timer;
 282
 283         unsigned long long nr_secs;
 284         unsigned long total_blocks;
 285         atomic_t free_blocks;
 286 };
 287
 288 #define PBLK_LINE_EMPTY (~0U)
 289
 290 enum {
 291         /* Line Types */
 292         PBLK_LINETYPE_FREE = 0,
 293         PBLK_LINETYPE_LOG = 1,
 294         PBLK_LINETYPE_DATA = 2,
 295
 296         /* Line state */
 297         PBLK_LINESTATE_FREE = 10,
 298         PBLK_LINESTATE_OPEN = 11,
 299         PBLK_LINESTATE_CLOSED = 12,
 300         PBLK_LINESTATE_GC = 13,
 301         PBLK_LINESTATE_BAD = 14,
 302         PBLK_LINESTATE_CORRUPT = 15,
 303
 304         /* GC group */
 305         PBLK_LINEGC_NONE = 20,
 306         PBLK_LINEGC_EMPTY = 21,
 307         PBLK_LINEGC_LOW = 22,
 308         PBLK_LINEGC_MID = 23,
 309         PBLK_LINEGC_HIGH = 24,
 310         PBLK_LINEGC_FULL = 25,
 311 };
 312
 313 #define PBLK_MAGIC 0x70626c6b /*pblk*/
 314 #define SMETA_VERSION cpu_to_le16(1)
 315
 316 struct line_header {
 317         __le32 crc;
 318         __le32 identifier;      /* pblk identifier */
 319         __u8 uuid[16];          /* instance uuid */
 320         __le16 type;            /* line type */
 321         __le16 version;         /* type version */
 322         __le32 id;              /* line id for current line */
 323 };
 324
 325 struct line_smeta {
 326         struct line_header header;
 327
 328         __le32 crc;             /* Full structure including struct crc */
 329         /* Previous line metadata */
 330         __le32 prev_id;         /* Line id for previous line */
 331
 332         /* Current line metadata */
 333         __le64 seq_nr;          /* Sequence number for current line */
 334
 335         /* Active writers */
 336         __le32 window_wr_lun;   /* Number of parallel LUNs to write */
 337
 338         __le32 rsvd[2];
 339
 340         __le64 lun_bitmap[];
 341 };
 342
 343 /*
 344  * Metadata layout in media:
 345  *      First sector:
 346  *              1. struct line_emeta
 347  *              2. bad block bitmap (u64 * window_wr_lun)
 348  *      Mid sectors (start at lbas_sector):
 349  *              3. nr_lbas (u64) forming lba list
 350  *      Last sectors (start at vsc_sector):
 351  *              4. u32 valid sector count (vsc) for all lines (~0U: free line)
 352  */
 353 struct line_emeta {
 354         struct line_header header;
 355
 356         __le32 crc;             /* Full structure including struct crc */
 357
 358         /* Previous line metadata */
 359         __le32 prev_id;         /* Line id for prev line */
 360
 361         /* Current line metadata */
 362         __le64 seq_nr;          /* Sequence number for current line */
 363
 364         /* Active writers */
 365         __le32 window_wr_lun;   /* Number of parallel LUNs to write */
 366
 367         /* Bookkeeping for recovery */
 368         __le32 next_id;         /* Line id for next line */
 369         __le64 nr_lbas;         /* Number of lbas mapped in line */
 370         __le64 nr_valid_lbas;   /* Number of valid lbas mapped in line */
 371         __le64 bb_bitmap[];     /* Updated bad block bitmap for line */
 372 };
 373
 374 struct pblk_emeta {
 375         struct line_emeta *buf;         /* emeta buffer in media format */
 376         int mem;                        /* Write offset - points to next
 377                                          * writable entry in memory
 378                                          */
 379         atomic_t sync;                  /* Synced - backpointer that signals the
 380                                          * last entry that has been successfully
 381                                          * persisted to media
 382                                          */
 383         unsigned int nr_entries;        /* Number of emeta entries */
 384 };
 385
 386 struct pblk_smeta {
 387         struct line_smeta *buf;         /* smeta buffer in persistent format */
 388 };
 389
 390 struct pblk_line {
 391         struct pblk *pblk;
 392         unsigned int id;                /* Line number corresponds to the
 393                                          * block line
 394                                          */
 395         unsigned int seq_nr;            /* Unique line sequence number */
 396
 397         int state;                      /* PBLK_LINESTATE_X */
 398         int type;                       /* PBLK_LINETYPE_X */
 399         int gc_group;                   /* PBLK_LINEGC_X */
 400         struct list_head list;          /* Free, GC lists */
 401
 402         unsigned long *lun_bitmap;      /* Bitmap for LUNs mapped in line */
 403
 404         struct pblk_smeta *smeta;       /* Start metadata */
 405         struct pblk_emeta *emeta;       /* End medatada */
 406
 407         int meta_line;                  /* Metadata line id */
 408         int meta_distance;              /* Distance between data and metadata */
 409
 410         u64 smeta_ssec;                 /* Sector where smeta starts */
 411         u64 emeta_ssec;                 /* Sector where emeta starts */
 412
 413         unsigned int sec_in_line;       /* Number of usable secs in line */
 414
 415         atomic_t blk_in_line;           /* Number of good blocks in line */
 416         unsigned long *blk_bitmap;      /* Bitmap for valid/invalid blocks */
 417         unsigned long *erase_bitmap;    /* Bitmap for erased blocks */
 418
 419         unsigned long *map_bitmap;      /* Bitmap for mapped sectors in line */
 420         unsigned long *invalid_bitmap;  /* Bitmap for invalid sectors in line */
 421
 422         atomic_t left_eblks;            /* Blocks left for erasing */
 423         atomic_t left_seblks;           /* Blocks left for sync erasing */
 424
 425         int left_msecs;                 /* Sectors left for mapping */
 426         unsigned int cur_sec;           /* Sector map pointer */
 427         unsigned int nr_valid_lbas;     /* Number of valid lbas in line */
 428
 429         __le32 *vsc;                    /* Valid sector count in line */
 430
 431         struct kref ref;                /* Write buffer L2P references */
 432
 433         spinlock_t lock;                /* Necessary for invalid_bitmap only */
 434 };
 435
 436 #define PBLK_DATA_LINES 4
 437
 438 enum {
 439         PBLK_KMALLOC_META = 1,
 440         PBLK_VMALLOC_META = 2,
 441 };
 442
 443 enum {
 444         PBLK_EMETA_TYPE_HEADER = 1,     /* struct line_emeta first sector */
 445         PBLK_EMETA_TYPE_LLBA = 2,       /* lba list - type: __le64 */
 446         PBLK_EMETA_TYPE_VSC = 3,        /* vsc list - type: __le32 */
 447 };
 448
 449 struct pblk_line_mgmt {
 450         int nr_lines;                   /* Total number of full lines */
 451         int nr_free_lines;              /* Number of full lines in free list */
 452
 453         /* Free lists - use free_lock */
 454         struct list_head free_list;     /* Full lines ready to use */
 455         struct list_head corrupt_list;  /* Full lines corrupted */
 456         struct list_head bad_list;      /* Full lines bad */
 457
 458         /* GC lists - use gc_lock */
 459         struct list_head *gc_lists[PBLK_GC_NR_LISTS];
 460         struct list_head gc_high_list;  /* Full lines ready to GC, high isc */
 461         struct list_head gc_mid_list;   /* Full lines ready to GC, mid isc */
 462         struct list_head gc_low_list;   /* Full lines ready to GC, low isc */
 463
 464         struct list_head gc_full_list;  /* Full lines ready to GC, no valid */
 465         struct list_head gc_empty_list; /* Full lines close, all valid */
 466
 467         struct pblk_line *log_line;     /* Current FTL log line */
 468         struct pblk_line *data_line;    /* Current data line */
 469         struct pblk_line *log_next;     /* Next FTL log line */
 470         struct pblk_line *data_next;    /* Next data line */
 471
 472         struct list_head emeta_list;    /* Lines queued to schedule emeta */
 473
 474         __le32 *vsc_list;               /* Valid sector counts for all lines */
 475
 476         /* Metadata allocation type: VMALLOC | KMALLOC */
 477         int emeta_alloc_type;
 478
 479         /* Pre-allocated metadata for data lines */
 480         struct pblk_smeta *sline_meta[PBLK_DATA_LINES];
 481         struct pblk_emeta *eline_meta[PBLK_DATA_LINES];
 482         unsigned long meta_bitmap;
 483
 484         /* Helpers for fast bitmap calculations */
 485         unsigned long *bb_template;
 486         unsigned long *bb_aux;
 487
 488         unsigned long d_seq_nr;         /* Data line unique sequence number */
 489         unsigned long l_seq_nr;         /* Log line unique sequence number */
 490
 491         spinlock_t free_lock;
 492         spinlock_t close_lock;
 493         spinlock_t gc_lock;
 494 };
 495
 496 struct pblk_line_meta {
 497         unsigned int smeta_len;         /* Total length for smeta */
 498         unsigned int smeta_sec;         /* Sectors needed for smeta */
 499
 500         unsigned int emeta_len[4];      /* Lengths for emeta:
 501                                          *  [0]: Total length
 502                                          *  [1]: struct line_emeta length
 503                                          *  [2]: L2P portion length
 504                                          *  [3]: vsc list length
 505                                          */
 506         unsigned int emeta_sec[4];      /* Sectors needed for emeta. Same layout
 507                                          * as emeta_len
 508                                          */
 509
 510         unsigned int emeta_bb;          /* Boundary for bb that affects emeta */
 511
 512         unsigned int vsc_list_len;      /* Length for vsc list */
 513         unsigned int sec_bitmap_len;    /* Length for sector bitmap in line */
 514         unsigned int blk_bitmap_len;    /* Length for block bitmap in line */
 515         unsigned int lun_bitmap_len;    /* Length for lun bitmap in line */
 516
 517         unsigned int blk_per_line;      /* Number of blocks in a full line */
 518         unsigned int sec_per_line;      /* Number of sectors in a line */
 519         unsigned int dsec_per_line;     /* Number of data sectors in a line */
 520         unsigned int min_blk_line;      /* Min. number of good blocks in line */
 521
 522         unsigned int mid_thrs;          /* Threshold for GC mid list */
 523         unsigned int high_thrs;         /* Threshold for GC high list */
 524
 525         unsigned int meta_distance;     /* Distance between data and metadata */
 526 };
 527
 528 struct pblk_addr_format {
 529         u64     ch_mask;
 530         u64     lun_mask;
 531         u64     pln_mask;
 532         u64     blk_mask;
 533         u64     pg_mask;
 534         u64     sec_mask;
 535         u8      ch_offset;
 536         u8      lun_offset;
 537         u8      pln_offset;
 538         u8      blk_offset;
 539         u8      pg_offset;
 540         u8      sec_offset;
 541 };
 542
 543 enum {
 544         PBLK_STATE_RUNNING = 0,
 545         PBLK_STATE_STOPPING = 1,
 546         PBLK_STATE_RECOVERING = 2,
 547         PBLK_STATE_STOPPED = 3,
 548 };
 549
 550 struct pblk {
 551         struct nvm_tgt_dev *dev;
 552         struct gendisk *disk;
 553
 554         struct kobject kobj;
 555
 556         struct pblk_lun *luns;
 557
 558         struct pblk_line *lines;                /* Line array */
 559         struct pblk_line_mgmt l_mg;             /* Line management */
 560         struct pblk_line_meta lm;               /* Line metadata */
 561
 562         int ppaf_bitsize;
 563         struct pblk_addr_format ppaf;
 564
 565         struct pblk_rb rwb;
 566
 567         int state;                      /* pblk line state */
 568
 569         int min_write_pgs; /* Minimum amount of pages required by controller */
 570         int max_write_pgs; /* Maximum amount of pages supported by controller */
 571         int pgs_in_buffer; /* Number of pages that need to be held in buffer to
 572                             * guarantee successful reads.
 573                             */
 574
 575         sector_t capacity; /* Device capacity when bad blocks are subtracted */
 576         int over_pct;      /* Percentage of device used for over-provisioning */
 577
 578         /* pblk provisioning values. Used by rate limiter */
 579         struct pblk_rl rl;
 580
 581         int sec_per_write;
 582
 583         unsigned char instance_uuid[16];
 584 #ifdef CONFIG_NVM_DEBUG
 585         /* All debug counters apply to 4kb sector I/Os */
 586         atomic_long_t inflight_writes;  /* Inflight writes (user and gc) */
 587         atomic_long_t padded_writes;    /* Sectors padded due to flush/fua */
 588         atomic_long_t padded_wb;        /* Sectors padded in write buffer */
 589         atomic_long_t nr_flush;         /* Number of flush/fua I/O */
 590         atomic_long_t req_writes;       /* Sectors stored on write buffer */
 591         atomic_long_t sub_writes;       /* Sectors submitted from buffer */
 592         atomic_long_t sync_writes;      /* Sectors synced to media */
 593         atomic_long_t inflight_reads;   /* Inflight sector read requests */
 594         atomic_long_t cache_reads;      /* Read requests that hit the cache */
 595         atomic_long_t sync_reads;       /* Completed sector read requests */
 596         atomic_long_t recov_writes;     /* Sectors submitted from recovery */
 597         atomic_long_t recov_gc_writes;  /* Sectors submitted from write GC */
 598         atomic_long_t recov_gc_reads;   /* Sectors submitted from read GC */
 599 #endif
 600
 601         spinlock_t lock;
 602
 603         atomic_long_t read_failed;
 604         atomic_long_t read_empty;
 605         atomic_long_t read_high_ecc;
 606         atomic_long_t read_failed_gc;
 607         atomic_long_t write_failed;
 608         atomic_long_t erase_failed;
 609
 610         atomic_t inflight_io;           /* General inflight I/O counter */
 611
 612         struct task_struct *writer_ts;
 613
 614         /* Simple translation map of logical addresses to physical addresses.
 615          * The logical addresses is known by the host system, while the physical
 616          * addresses are used when writing to the disk block device.
 617          */
 618         unsigned char *trans_map;
 619         spinlock_t trans_lock;
 620
 621         struct list_head compl_list;
 622
 623         mempool_t *page_pool;
 624         mempool_t *line_ws_pool;
 625         mempool_t *rec_pool;
 626         mempool_t *g_rq_pool;
 627         mempool_t *w_rq_pool;
 628         mempool_t *line_meta_pool;
 629
 630         struct workqueue_struct *close_wq;
 631         struct workqueue_struct *bb_wq;
 632
 633         struct timer_list wtimer;
 634
 635         struct pblk_gc gc;
 636 };
 637
 638 struct pblk_line_ws {
 639         struct pblk *pblk;
 640         struct pblk_line *line;
 641         void *priv;
 642         struct work_struct ws;
 643 };
 644
 645 #define pblk_g_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_g_ctx))
 646 #define pblk_w_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_c_ctx))
 647
 648 /*
 649  * pblk ring buffer operations
 650  */
 651 int pblk_rb_init(struct pblk_rb *rb, struct pblk_rb_entry *rb_entry_base,
 652                  unsigned int power_size, unsigned int power_seg_sz);
 653 unsigned int pblk_rb_calculate_size(unsigned int nr_entries);
 654 void *pblk_rb_entries_ref(struct pblk_rb *rb);
 655 int pblk_rb_may_write_user(struct pblk_rb *rb, struct bio *bio,
 656                            unsigned int nr_entries, unsigned int *pos);
 657 int pblk_rb_may_write_gc(struct pblk_rb *rb, unsigned int nr_entries,
 658                          unsigned int *pos);
 659 void pblk_rb_write_entry_user(struct pblk_rb *rb, void *data,
 660                               struct pblk_w_ctx w_ctx, unsigned int pos);
 661 void pblk_rb_write_entry_gc(struct pblk_rb *rb, void *data,
 662                             struct pblk_w_ctx w_ctx, struct pblk_line *gc_line,
 663                             unsigned int pos);
 664 struct pblk_w_ctx *pblk_rb_w_ctx(struct pblk_rb *rb, unsigned int pos);
 665 void pblk_rb_flush(struct pblk_rb *rb);
 666
 667 void pblk_rb_sync_l2p(struct pblk_rb *rb);
 668 unsigned int pblk_rb_read_to_bio(struct pblk_rb *rb, struct nvm_rq *rqd,
 669                                  struct bio *bio, unsigned int pos,
 670                                  unsigned int nr_entries, unsigned int count);
 671 unsigned int pblk_rb_read_to_bio_list(struct pblk_rb *rb, struct bio *bio,
 672                                       struct list_head *list,
 673                                       unsigned int max);
 674 int pblk_rb_copy_to_bio(struct pblk_rb *rb, struct bio *bio, sector_t lba,
 675                         struct ppa_addr ppa, int bio_iter, bool advanced_bio);
 676 unsigned int pblk_rb_read_commit(struct pblk_rb *rb, unsigned int entries);
 677
 678 unsigned int pblk_rb_sync_init(struct pblk_rb *rb, unsigned long *flags);
 679 unsigned int pblk_rb_sync_advance(struct pblk_rb *rb, unsigned int nr_entries);
 680 struct pblk_rb_entry *pblk_rb_sync_scan_entry(struct pblk_rb *rb,
 681                                               struct ppa_addr *ppa);
 682 void pblk_rb_sync_end(struct pblk_rb *rb, unsigned long *flags);
 683 unsigned int pblk_rb_sync_point_count(struct pblk_rb *rb);
 684
 685 unsigned int pblk_rb_read_count(struct pblk_rb *rb);
 686 unsigned int pblk_rb_sync_count(struct pblk_rb *rb);
 687 unsigned int pblk_rb_wrap_pos(struct pblk_rb *rb, unsigned int pos);
 688
 689 int pblk_rb_tear_down_check(struct pblk_rb *rb);
 690 int pblk_rb_pos_oob(struct pblk_rb *rb, u64 pos);
 691 void pblk_rb_data_free(struct pblk_rb *rb);
 692 ssize_t pblk_rb_sysfs(struct pblk_rb *rb, char *buf);
 693
 694 /*
 695  * pblk core
 696  */
 697 struct nvm_rq *pblk_alloc_rqd(struct pblk *pblk, int rw);
 698 void pblk_set_sec_per_write(struct pblk *pblk, int sec_per_write);
 699 int pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
 700                         struct pblk_c_ctx *c_ctx);
 701 void pblk_free_rqd(struct pblk *pblk, struct nvm_rq *rqd, int rw);
 702 void pblk_wait_for_meta(struct pblk *pblk);
 703 struct ppa_addr pblk_get_lba_map(struct pblk *pblk, sector_t lba);
 704 void pblk_discard(struct pblk *pblk, struct bio *bio);
 705 void pblk_log_write_err(struct pblk *pblk, struct nvm_rq *rqd);
 706 void pblk_log_read_err(struct pblk *pblk, struct nvm_rq *rqd);
 707 int pblk_submit_io(struct pblk *pblk, struct nvm_rq *rqd);
 708 int pblk_submit_meta_io(struct pblk *pblk, struct pblk_line *meta_line);
 709 struct bio *pblk_bio_map_addr(struct pblk *pblk, void *data,
 710                               unsigned int nr_secs, unsigned int len,
 711                               int alloc_type, gfp_t gfp_mask);
 712 struct pblk_line *pblk_line_get(struct pblk *pblk);
 713 struct pblk_line *pblk_line_get_first_data(struct pblk *pblk);
 714 void pblk_line_replace_data(struct pblk *pblk);
 715 int pblk_line_recov_alloc(struct pblk *pblk, struct pblk_line *line);
 716 void pblk_line_recov_close(struct pblk *pblk, struct pblk_line *line);
 717 struct pblk_line *pblk_line_get_data(struct pblk *pblk);
 718 struct pblk_line *pblk_line_get_erase(struct pblk *pblk);
 719 int pblk_line_erase(struct pblk *pblk, struct pblk_line *line);
 720 int pblk_line_is_full(struct pblk_line *line);
 721 void pblk_line_free(struct pblk *pblk, struct pblk_line *line);
 722 void pblk_line_close_meta(struct pblk *pblk, struct pblk_line *line);
 723 void pblk_line_close(struct pblk *pblk, struct pblk_line *line);
 724 void pblk_line_close_meta_sync(struct pblk *pblk);
 725 void pblk_line_close_ws(struct work_struct *work);
 726 void pblk_pipeline_stop(struct pblk *pblk);
 727 void pblk_line_mark_bb(struct work_struct *work);
 728 void pblk_line_run_ws(struct pblk *pblk, struct pblk_line *line, void *priv,
 729                       void (*work)(struct work_struct *),
 730                       struct workqueue_struct *wq);
 731 u64 pblk_line_smeta_start(struct pblk *pblk, struct pblk_line *line);
 732 int pblk_line_read_smeta(struct pblk *pblk, struct pblk_line *line);
 733 int pblk_line_read_emeta(struct pblk *pblk, struct pblk_line *line,
 734                          void *emeta_buf);
 735 int pblk_blk_erase_async(struct pblk *pblk, struct ppa_addr erase_ppa);
 736 void pblk_line_put(struct kref *ref);
 737 struct list_head *pblk_line_gc_list(struct pblk *pblk, struct pblk_line *line);
 738 u64 pblk_lookup_page(struct pblk *pblk, struct pblk_line *line);
 739 void pblk_dealloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 740 u64 pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 741 u64 __pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 742 int pblk_calc_secs(struct pblk *pblk, unsigned long secs_avail,
 743                    unsigned long secs_to_flush);
 744 void pblk_up_page(struct pblk *pblk, struct ppa_addr *ppa_list, int nr_ppas);
 745 void pblk_down_rq(struct pblk *pblk, struct ppa_addr *ppa_list, int nr_ppas,
 746                   unsigned long *lun_bitmap);
 747 void pblk_down_page(struct pblk *pblk, struct ppa_addr *ppa_list, int nr_ppas);
 748 void pblk_up_rq(struct pblk *pblk, struct ppa_addr *ppa_list, int nr_ppas,
 749                 unsigned long *lun_bitmap);
 750 void pblk_end_bio_sync(struct bio *bio);
 751 void pblk_end_io_sync(struct nvm_rq *rqd);
 752 int pblk_bio_add_pages(struct pblk *pblk, struct bio *bio, gfp_t flags,
 753                        int nr_pages);
 754 void pblk_bio_free_pages(struct pblk *pblk, struct bio *bio, int off,
 755                          int nr_pages);
 756 void pblk_map_invalidate(struct pblk *pblk, struct ppa_addr ppa);
 757 void __pblk_map_invalidate(struct pblk *pblk, struct pblk_line *line,
 758                            u64 paddr);
 759 void pblk_update_map(struct pblk *pblk, sector_t lba, struct ppa_addr ppa);
 760 void pblk_update_map_cache(struct pblk *pblk, sector_t lba,
 761                            struct ppa_addr ppa);
 762 void pblk_update_map_dev(struct pblk *pblk, sector_t lba,
 763                          struct ppa_addr ppa, struct ppa_addr entry_line);
 764 int pblk_update_map_gc(struct pblk *pblk, sector_t lba, struct ppa_addr ppa,
 765                        struct pblk_line *gc_line);
 766 void pblk_lookup_l2p_rand(struct pblk *pblk, struct ppa_addr *ppas,
 767                           u64 *lba_list, int nr_secs);
 768 void pblk_lookup_l2p_seq(struct pblk *pblk, struct ppa_addr *ppas,
 769                          sector_t blba, int nr_secs);
 770
 771 /*
 772  * pblk user I/O write path
 773  */
 774 int pblk_write_to_cache(struct pblk *pblk, struct bio *bio,
 775                         unsigned long flags);
 776 int pblk_write_gc_to_cache(struct pblk *pblk, void *data, u64 *lba_list,
 777                            unsigned int nr_entries, unsigned int nr_rec_entries,
 778                            struct pblk_line *gc_line, unsigned long flags);
 779
 780 /*
 781  * pblk map
 782  */
 783 void pblk_map_erase_rq(struct pblk *pblk, struct nvm_rq *rqd,
 784                        unsigned int sentry, unsigned long *lun_bitmap,
 785                        unsigned int valid_secs, struct ppa_addr *erase_ppa);
 786 void pblk_map_rq(struct pblk *pblk, struct nvm_rq *rqd, unsigned int sentry,
 787                  unsigned long *lun_bitmap, unsigned int valid_secs,
 788                  unsigned int off);
 789
 790 /*
 791  * pblk write thread
 792  */
 793 int pblk_write_ts(void *data);
 794 void pblk_write_timer_fn(unsigned long data);
 795 void pblk_write_should_kick(struct pblk *pblk);
 796
 797 /*
 798  * pblk read path
 799  */
 800 extern struct bio_set *pblk_bio_set;
 801 int pblk_submit_read(struct pblk *pblk, struct bio *bio);
 802 int pblk_submit_read_gc(struct pblk *pblk, u64 *lba_list, void *data,
 803                         unsigned int nr_secs, unsigned int *secs_to_gc,
 804                         struct pblk_line *line);
 805 /*
 806  * pblk recovery
 807  */
 808 void pblk_submit_rec(struct work_struct *work);
 809 struct pblk_line *pblk_recov_l2p(struct pblk *pblk);
 810 int pblk_recov_pad(struct pblk *pblk);
 811 __le64 *pblk_recov_get_lba_list(struct pblk *pblk, struct line_emeta *emeta);
 812 int pblk_recov_setup_rq(struct pblk *pblk, struct pblk_c_ctx *c_ctx,
 813                         struct pblk_rec_ctx *recovery, u64 *comp_bits,
 814                         unsigned int comp);
 815
 816 /*
 817  * pblk gc
 818  */
 819 #define PBLK_GC_MAX_READERS 8   /* Max number of outstanding GC reader jobs */
 820 #define PBLK_GC_W_QD 128        /* Queue depth for inflight GC write I/Os */
 821 #define PBLK_GC_L_QD 4          /* Queue depth for inflight GC lines */
 822 #define PBLK_GC_RSV_LINE 1      /* Reserved lines for GC */
 823
 824 int pblk_gc_init(struct pblk *pblk);
 825 void pblk_gc_exit(struct pblk *pblk);
 826 void pblk_gc_should_start(struct pblk *pblk);
 827 void pblk_gc_should_stop(struct pblk *pblk);
 828 void pblk_gc_kick(struct pblk *pblk);
 829 void pblk_gc_sysfs_state_show(struct pblk *pblk, int *gc_enabled,
 830                               int *gc_active);
 831 int pblk_gc_sysfs_force(struct pblk *pblk, int force);
 832
 833 /*
 834  * pblk rate limiter
 835  */
 836 void pblk_rl_init(struct pblk_rl *rl, int budget);
 837 void pblk_rl_free(struct pblk_rl *rl);
 838 int pblk_rl_high_thrs(struct pblk_rl *rl);
 839 int pblk_rl_low_thrs(struct pblk_rl *rl);
 840 unsigned long pblk_rl_nr_free_blks(struct pblk_rl *rl);
 841 int pblk_rl_user_may_insert(struct pblk_rl *rl, int nr_entries);
 842 void pblk_rl_inserted(struct pblk_rl *rl, int nr_entries);
 843 void pblk_rl_user_in(struct pblk_rl *rl, int nr_entries);
 844 int pblk_rl_gc_may_insert(struct pblk_rl *rl, int nr_entries);
 845 void pblk_rl_gc_in(struct pblk_rl *rl, int nr_entries);
 846 void pblk_rl_out(struct pblk_rl *rl, int nr_user, int nr_gc);
 847 int pblk_rl_sysfs_rate_show(struct pblk_rl *rl);
 848 int pblk_rl_max_io(struct pblk_rl *rl);
 849 void pblk_rl_free_lines_inc(struct pblk_rl *rl, struct pblk_line *line);
 850 void pblk_rl_free_lines_dec(struct pblk_rl *rl, struct pblk_line *line);
 851 void pblk_rl_set_space_limit(struct pblk_rl *rl, int entries_left);
 852 int pblk_rl_is_limit(struct pblk_rl *rl);
 853
 854 /*
 855  * pblk sysfs
 856  */
 857 int pblk_sysfs_init(struct gendisk *tdisk);
 858 void pblk_sysfs_exit(struct gendisk *tdisk);
 859
 860 static inline void *pblk_malloc(size_t size, int type, gfp_t flags)
 861 {
 862         if (type == PBLK_KMALLOC_META)
 863                 return kmalloc(size, flags);
 864         return vmalloc(size);
 865 }
 866
 867 static inline void pblk_mfree(void *ptr, int type)
 868 {
 869         if (type == PBLK_KMALLOC_META)
 870                 kfree(ptr);
 871         else
 872                 vfree(ptr);
 873 }
 874
 875 static inline struct nvm_rq *nvm_rq_from_c_ctx(void *c_ctx)
 876 {
 877         return c_ctx - sizeof(struct nvm_rq);
 878 }
 879
 880 static inline void *emeta_to_bb(struct line_emeta *emeta)
 881 {
 882         return emeta->bb_bitmap;
 883 }
 884
 885 static inline void *emeta_to_lbas(struct pblk *pblk, struct line_emeta *emeta)
 886 {
 887         return ((void *)emeta + pblk->lm.emeta_len[1]);
 888 }
 889
 890 static inline void *emeta_to_vsc(struct pblk *pblk, struct line_emeta *emeta)
 891 {
 892         return (emeta_to_lbas(pblk, emeta) + pblk->lm.emeta_len[2]);
 893 }
 894
 895 static inline int pblk_line_vsc(struct pblk_line *line)
 896 {
 897         int vsc;
 898
 899         spin_lock(&line->lock);
 900         vsc = le32_to_cpu(*line->vsc);
 901         spin_unlock(&line->lock);
 902
 903         return vsc;
 904 }
 905
 906 #define NVM_MEM_PAGE_WRITE (8)
 907
 908 static inline int pblk_pad_distance(struct pblk *pblk)
 909 {
 910         struct nvm_tgt_dev *dev = pblk->dev;
 911         struct nvm_geo *geo = &dev->geo;
 912
 913         return NVM_MEM_PAGE_WRITE * geo->nr_luns * geo->sec_per_pl;
 914 }
 915
 916 static inline int pblk_dev_ppa_to_line(struct ppa_addr p)
 917 {
 918         return p.g.blk;
 919 }
 920
 921 static inline int pblk_tgt_ppa_to_line(struct ppa_addr p)
 922 {
 923         return p.g.blk;
 924 }
 925
 926 static inline int pblk_ppa_to_pos(struct nvm_geo *geo, struct ppa_addr p)
 927 {
 928         return p.g.lun * geo->nr_chnls + p.g.ch;
 929 }
 930
 931 /* A block within a line corresponds to the lun */
 932 static inline int pblk_dev_ppa_to_pos(struct nvm_geo *geo, struct ppa_addr p)
 933 {
 934         return p.g.lun * geo->nr_chnls + p.g.ch;
 935 }
 936
 937 static inline struct ppa_addr pblk_ppa32_to_ppa64(struct pblk *pblk, u32 ppa32)
 938 {
 939         struct ppa_addr ppa64;
 940
 941         ppa64.ppa = 0;
 942
 943         if (ppa32 == -1) {
 944                 ppa64.ppa = ADDR_EMPTY;
 945         } else if (ppa32 & (1U << 31)) {
 946                 ppa64.c.line = ppa32 & ((~0U) >> 1);
 947                 ppa64.c.is_cached = 1;
 948         } else {
 949                 ppa64.g.blk = (ppa32 & pblk->ppaf.blk_mask) >>
 950                                                         pblk->ppaf.blk_offset;
 951                 ppa64.g.pg = (ppa32 & pblk->ppaf.pg_mask) >>
 952                                                         pblk->ppaf.pg_offset;
 953                 ppa64.g.lun = (ppa32 & pblk->ppaf.lun_mask) >>
 954                                                         pblk->ppaf.lun_offset;
 955                 ppa64.g.ch = (ppa32 & pblk->ppaf.ch_mask) >>
 956                                                         pblk->ppaf.ch_offset;
 957                 ppa64.g.pl = (ppa32 & pblk->ppaf.pln_mask) >>
 958                                                         pblk->ppaf.pln_offset;
 959                 ppa64.g.sec = (ppa32 & pblk->ppaf.sec_mask) >>
 960                                                         pblk->ppaf.sec_offset;
 961         }
 962
 963         return ppa64;
 964 }
 965
 966 static inline struct ppa_addr pblk_trans_map_get(struct pblk *pblk,
 967                                                                 sector_t lba)
 968 {
 969         struct ppa_addr ppa;
 970
 971         if (pblk->ppaf_bitsize < 32) {
 972                 u32 *map = (u32 *)pblk->trans_map;
 973
 974                 ppa = pblk_ppa32_to_ppa64(pblk, map[lba]);
 975         } else {
 976                 struct ppa_addr *map = (struct ppa_addr *)pblk->trans_map;
 977
 978                 ppa = map[lba];
 979         }
 980
 981         return ppa;
 982 }
 983
 984 static inline u32 pblk_ppa64_to_ppa32(struct pblk *pblk, struct ppa_addr ppa64)
 985 {
 986         u32 ppa32 = 0;
 987
 988         if (ppa64.ppa == ADDR_EMPTY) {
 989                 ppa32 = ~0U;
 990         } else if (ppa64.c.is_cached) {
 991                 ppa32 |= ppa64.c.line;
 992                 ppa32 |= 1U << 31;
 993         } else {
 994                 ppa32 |= ppa64.g.blk << pblk->ppaf.blk_offset;
 995                 ppa32 |= ppa64.g.pg << pblk->ppaf.pg_offset;
 996                 ppa32 |= ppa64.g.lun << pblk->ppaf.lun_offset;
 997                 ppa32 |= ppa64.g.ch << pblk->ppaf.ch_offset;
 998                 ppa32 |= ppa64.g.pl << pblk->ppaf.pln_offset;
 999                 ppa32 |= ppa64.g.sec << pblk->ppaf.sec_offset;
1000         }
1001
1002         return ppa32;
1003 }
1004
1005 static inline void pblk_trans_map_set(struct pblk *pblk, sector_t lba,
1006                                                 struct ppa_addr ppa)
1007 {
1008         if (pblk->ppaf_bitsize < 32) {
1009                 u32 *map = (u32 *)pblk->trans_map;
1010
1011                 map[lba] = pblk_ppa64_to_ppa32(pblk, ppa);
1012         } else {
1013                 u64 *map = (u64 *)pblk->trans_map;
1014
1015                 map[lba] = ppa.ppa;
1016         }
1017 }
1018
1019 static inline u64 pblk_dev_ppa_to_line_addr(struct pblk *pblk,
1020                                                         struct ppa_addr p)
1021 {
1022         u64 paddr;
1023
1024         paddr = 0;
1025         paddr |= (u64)p.g.pg << pblk->ppaf.pg_offset;
1026         paddr |= (u64)p.g.lun << pblk->ppaf.lun_offset;
1027         paddr |= (u64)p.g.ch << pblk->ppaf.ch_offset;
1028         paddr |= (u64)p.g.pl << pblk->ppaf.pln_offset;
1029         paddr |= (u64)p.g.sec << pblk->ppaf.sec_offset;
1030
1031         return paddr;
1032 }
1033
1034 static inline int pblk_ppa_empty(struct ppa_addr ppa_addr)
1035 {
1036         return (ppa_addr.ppa == ADDR_EMPTY);
1037 }
1038
1039 static inline void pblk_ppa_set_empty(struct ppa_addr *ppa_addr)
1040 {
1041         ppa_addr->ppa = ADDR_EMPTY;
1042 }
1043
1044 static inline bool pblk_ppa_comp(struct ppa_addr lppa, struct ppa_addr rppa)
1045 {
1046         if (lppa.ppa == rppa.ppa)
1047                 return true;
1048
1049         return false;
1050 }
1051
1052 static inline int pblk_addr_in_cache(struct ppa_addr ppa)
1053 {
1054         return (ppa.ppa != ADDR_EMPTY && ppa.c.is_cached);
1055 }
1056
1057 static inline int pblk_addr_to_cacheline(struct ppa_addr ppa)
1058 {
1059         return ppa.c.line;
1060 }
1061
1062 static inline struct ppa_addr pblk_cacheline_to_addr(int addr)
1063 {
1064         struct ppa_addr p;
1065
1066         p.c.line = addr;
1067         p.c.is_cached = 1;
1068
1069         return p;
1070 }
1071
1072 static inline struct ppa_addr addr_to_gen_ppa(struct pblk *pblk, u64 paddr,
1073                                               u64 line_id)
1074 {
1075         struct ppa_addr ppa;
1076
1077         ppa.ppa = 0;
1078         ppa.g.blk = line_id;
1079         ppa.g.pg = (paddr & pblk->ppaf.pg_mask) >> pblk->ppaf.pg_offset;
1080         ppa.g.lun = (paddr & pblk->ppaf.lun_mask) >> pblk->ppaf.lun_offset;
1081         ppa.g.ch = (paddr & pblk->ppaf.ch_mask) >> pblk->ppaf.ch_offset;
1082         ppa.g.pl = (paddr & pblk->ppaf.pln_mask) >> pblk->ppaf.pln_offset;
1083         ppa.g.sec = (paddr & pblk->ppaf.sec_mask) >> pblk->ppaf.sec_offset;
1084
1085         return ppa;
1086 }
1087
1088 static inline struct ppa_addr addr_to_pblk_ppa(struct pblk *pblk, u64 paddr,
1089                                          u64 line_id)
1090 {
1091         struct ppa_addr ppa;
1092
1093         ppa = addr_to_gen_ppa(pblk, paddr, line_id);
1094
1095         return ppa;
1096 }
1097
1098 static inline u32 pblk_calc_meta_header_crc(struct pblk *pblk,
1099                                             struct line_header *header)
1100 {
1101         u32 crc = ~(u32)0;
1102
1103         crc = crc32_le(crc, (unsigned char *)header + sizeof(crc),
1104                                 sizeof(struct line_header) - sizeof(crc));
1105
1106         return crc;
1107 }
1108
1109 static inline u32 pblk_calc_smeta_crc(struct pblk *pblk,
1110                                       struct line_smeta *smeta)
1111 {
1112         struct pblk_line_meta *lm = &pblk->lm;
1113         u32 crc = ~(u32)0;
1114
1115         crc = crc32_le(crc, (unsigned char *)smeta +
1116                                 sizeof(struct line_header) + sizeof(crc),
1117                                 lm->smeta_len -
1118                                 sizeof(struct line_header) - sizeof(crc));
1119
1120         return crc;
1121 }
1122
1123 static inline u32 pblk_calc_emeta_crc(struct pblk *pblk,
1124                                       struct line_emeta *emeta)
1125 {
1126         struct pblk_line_meta *lm = &pblk->lm;
1127         u32 crc = ~(u32)0;
1128
1129         crc = crc32_le(crc, (unsigned char *)emeta +
1130                                 sizeof(struct line_header) + sizeof(crc),
1131                                 lm->emeta_len[0] -
1132                                 sizeof(struct line_header) - sizeof(crc));
1133
1134         return crc;
1135 }
1136
1137 static inline int pblk_set_progr_mode(struct pblk *pblk, int type)
1138 {
1139         struct nvm_tgt_dev *dev = pblk->dev;
1140         struct nvm_geo *geo = &dev->geo;
1141         int flags;
1142
1143         flags = geo->plane_mode >> 1;
1144
1145         if (type == WRITE)
1146                 flags |= NVM_IO_SCRAMBLE_ENABLE;
1147
1148         return flags;
1149 }
1150
1151 enum {
1152         PBLK_READ_RANDOM        = 0,
1153         PBLK_READ_SEQUENTIAL    = 1,
1154 };
1155
1156 static inline int pblk_set_read_mode(struct pblk *pblk, int type)
1157 {
1158         struct nvm_tgt_dev *dev = pblk->dev;
1159         struct nvm_geo *geo = &dev->geo;
1160         int flags;
1161
1162         flags = NVM_IO_SUSPEND | NVM_IO_SCRAMBLE_ENABLE;
1163         if (type == PBLK_READ_SEQUENTIAL)
1164                 flags |= geo->plane_mode >> 1;
1165
1166         return flags;
1167 }
1168
1169 static inline int pblk_io_aligned(struct pblk *pblk, int nr_secs)
1170 {
1171         return !(nr_secs % pblk->min_write_pgs);
1172 }
1173
1174 #ifdef CONFIG_NVM_DEBUG
1175 static inline void print_ppa(struct ppa_addr *p, char *msg, int error)
1176 {
1177         if (p->c.is_cached) {
1178                 pr_err("ppa: (%s: %x) cache line: %llu\n",
1179                                 msg, error, (u64)p->c.line);
1180         } else {
1181                 pr_err("ppa: (%s: %x):ch:%d,lun:%d,blk:%d,pg:%d,pl:%d,sec:%d\n",
1182                         msg, error,
1183                         p->g.ch, p->g.lun, p->g.blk,
1184                         p->g.pg, p->g.pl, p->g.sec);
1185         }
1186 }
1187
1188 static inline void pblk_print_failed_rqd(struct pblk *pblk, struct nvm_rq *rqd,
1189                                          int error)
1190 {
1191         int bit = -1;
1192
1193         if (rqd->nr_ppas ==  1) {
1194                 print_ppa(&rqd->ppa_addr, "rqd", error);
1195                 return;
1196         }
1197
1198         while ((bit = find_next_bit((void *)&rqd->ppa_status, rqd->nr_ppas,
1199                                                 bit + 1)) < rqd->nr_ppas) {
1200                 print_ppa(&rqd->ppa_list[bit], "rqd", error);
1201         }
1202
1203         pr_err("error:%d, ppa_status:%llx\n", error, rqd->ppa_status);
1204 }
1205 #endif
1206
1207 static inline int pblk_boundary_ppa_checks(struct nvm_tgt_dev *tgt_dev,
1208                                        struct ppa_addr *ppas, int nr_ppas)
1209 {
1210         struct nvm_geo *geo = &tgt_dev->geo;
1211         struct ppa_addr *ppa;
1212         int i;
1213
1214         for (i = 0; i < nr_ppas; i++) {
1215                 ppa = &ppas[i];
1216
1217                 if (!ppa->c.is_cached &&
1218                                 ppa->g.ch < geo->nr_chnls &&
1219                                 ppa->g.lun < geo->luns_per_chnl &&
1220                                 ppa->g.pl < geo->nr_planes &&
1221                                 ppa->g.blk < geo->blks_per_lun &&
1222                                 ppa->g.pg < geo->pgs_per_blk &&
1223                                 ppa->g.sec < geo->sec_per_pg)
1224                         continue;
1225
1226 #ifdef CONFIG_NVM_DEBUG
1227                 print_ppa(ppa, "boundary", i);
1228 #endif
1229                 return 1;
1230         }
1231         return 0;
1232 }
1233
1234 static inline int pblk_boundary_paddr_checks(struct pblk *pblk, u64 paddr)
1235 {
1236         struct pblk_line_meta *lm = &pblk->lm;
1237
1238         if (paddr > lm->sec_per_line)
1239                 return 1;
1240
1241         return 0;
1242 }
1243
1244 static inline unsigned int pblk_get_bi_idx(struct bio *bio)
1245 {
1246         return bio->bi_iter.bi_idx;
1247 }
1248
1249 static inline sector_t pblk_get_lba(struct bio *bio)
1250 {
1251         return bio->bi_iter.bi_sector / NR_PHY_IN_LOG;
1252 }
1253
1254 static inline unsigned int pblk_get_secs(struct bio *bio)
1255 {
1256         return  bio->bi_iter.bi_size / PBLK_EXPOSED_PAGE_SIZE;
1257 }
1258
1259 static inline sector_t pblk_get_sector(sector_t lba)
1260 {
1261         return lba * NR_PHY_IN_LOG;
1262 }
1263
1264 static inline void pblk_setup_uuid(struct pblk *pblk)
1265 {
1266         uuid_le uuid;
1267
1268         uuid_le_gen(&uuid);
1269         memcpy(pblk->instance_uuid, uuid.b, 16);
1270 }
1271 #endif /* PBLK_H_ */