drivers/lightnvm/pblk.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   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)
  41
  42 #define PBLK_NR_CLOSE_JOBS (4)
  43
  44 #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
  53 /* Static pool sizes */
  54 #define PBLK_GEN_WS_POOL_SIZE (2)
  55
  56 #define PBLK_DEFAULT_OP (11)
  57
  58 enum {
  59         PBLK_READ               = READ,
  60         PBLK_WRITE              = WRITE,/* Write from write buffer */
  61         PBLK_WRITE_INT,                 /* Internal write - no write buffer */
  62         PBLK_READ_RECOV,                /* Recovery read - errors allowed */
  63         PBLK_ERASE,
  64 };
  65
  66 enum {
  67         /* 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
  78 enum {
  79         PBLK_BLK_ST_OPEN =      0x1,
  80         PBLK_BLK_ST_CLOSED =    0x2,
  81 };
  82
  83 enum {
  84         PBLK_CHUNK_RESET_START,
  85         PBLK_CHUNK_RESET_DONE,
  86         PBLK_CHUNK_RESET_FAILED,
  87 };
  88
  89 struct pblk_sec_meta {
  90         u64 reserved;
  91         __le64 lba;
  92 };
  93
  94 /* 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  */
  97 #define PBLK_GC_NR_LISTS 4
  98
  99 enum {
 100         PBLK_RL_OFF = 0,
 101         PBLK_RL_WERR = 1,
 102         PBLK_RL_HIGH = 2,
 103         PBLK_RL_MID = 3,
 104         PBLK_RL_LOW = 4
 105 };
 106
 107 #define pblk_dma_meta_size (sizeof(struct pblk_sec_meta) * NVM_MAX_VLBA)
 108 #define pblk_dma_ppa_size (sizeof(u64) * NVM_MAX_VLBA)
 109
 110 /* write buffer completion context */
 111 struct 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
 120 /* read context */
 121 struct pblk_g_ctx {
 122         void *private;
 123         unsigned long start_time;
 124         u64 lba;
 125 };
 126
 127 /* partial read context */
 128 struct 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;
 135 };
 136
 137 /* Pad context */
 138 struct pblk_pad_rq {
 139         struct pblk *pblk;
 140         struct completion wait;
 141         struct kref ref;
 142 };
 143
 144 /* Recovery context */
 145 struct pblk_rec_ctx {
 146         struct pblk *pblk;
 147         struct nvm_rq *rqd;
 148         struct work_struct ws_rec;
 149 };
 150
 151 /* Write context */
 152 struct pblk_w_ctx {
 153         struct bio_list bios;           /* Original bios - used for completion
 154                                          * in REQ_FUA, REQ_FLUSH case
 155                                          */
 156         u64 lba;                        /* Logic addr. associated with entry */
 157         struct ppa_addr ppa;            /* Physic addr. associated with entry */
 158         int flags;                      /* Write context flags */
 159 };
 160
 161 struct pblk_rb_entry {
 162         struct ppa_addr cacheline;      /* Cacheline for this entry */
 163         void *data;                     /* Pointer to data on this entry */
 164         struct pblk_w_ctx w_ctx;        /* Context for this entry */
 165         struct list_head index;         /* List head to enable indexes */
 166 };
 167
 168 #define EMPTY_ENTRY (~0U)
 169
 170 struct pblk_rb_pages {
 171         struct page *pages;
 172         int order;
 173         struct list_head list;
 174 };
 175
 176 struct pblk_rb {
 177         struct pblk_rb_entry *entries;  /* Ring buffer entries */
 178         unsigned int mem;               /* Write offset - points to next
 179                                          * writable entry in memory
 180                                          */
 181         unsigned int subm;              /* Read offset - points to last entry
 182                                          * that has been submitted to the media
 183                                          * to be persisted
 184                                          */
 185         unsigned int sync;              /* Synced - backpointer that signals
 186                                          * the last submitted entry that has
 187                                          * been successfully persisted to media
 188                                          */
 189         unsigned int flush_point;       /* Sync point - last entry that must be
 190                                          * flushed to the media. Used with
 191                                          * REQ_FLUSH and REQ_FUA
 192                                          */
 193         unsigned int l2p_update;        /* l2p update point - next entry for
 194                                          * which l2p mapping will be updated to
 195                                          * contain a device ppa address (instead
 196                                          * of a cacheline
 197                                          */
 198         unsigned int nr_entries;        /* Number of entries in write buffer -
 199                                          * must be a power of two
 200                                          */
 201         unsigned int seg_size;          /* Size of the data segments being
 202                                          * stored on each entry. Typically this
 203                                          * will be 4KB
 204                                          */
 205
 206         struct list_head pages;         /* List of data pages */
 207
 208         spinlock_t w_lock;              /* Write lock */
 209         spinlock_t s_lock;              /* Sync lock */
 210
 211 #ifdef CONFIG_NVM_PBLK_DEBUG
 212         atomic_t inflight_flush_point;  /* Not served REQ_FLUSH | REQ_FUA */
 213 #endif
 214 };
 215
 216 #define PBLK_RECOVERY_SECTORS 16
 217
 218 struct pblk_lun {
 219         struct ppa_addr bppa;
 220         struct semaphore wr_sem;
 221 };
 222
 223 struct pblk_gc_rq {
 224         struct pblk_line *line;
 225         void *data;
 226         u64 paddr_list[NVM_MAX_VLBA];
 227         u64 lba_list[NVM_MAX_VLBA];
 228         int nr_secs;
 229         int secs_to_gc;
 230         struct list_head list;
 231 };
 232
 233 struct pblk_gc {
 234         /* These states are not protected by a lock since (i) they are in the
 235          * fast path, and (ii) they are not critical.
 236          */
 237         int gc_active;
 238         int gc_enabled;
 239         int gc_forced;
 240
 241         struct task_struct *gc_ts;
 242         struct task_struct *gc_writer_ts;
 243         struct task_struct *gc_reader_ts;
 244
 245         struct workqueue_struct *gc_line_reader_wq;
 246         struct workqueue_struct *gc_reader_wq;
 247
 248         struct timer_list gc_timer;
 249
 250         struct semaphore gc_sem;
 251         atomic_t read_inflight_gc; /* Number of lines with inflight GC reads */
 252         atomic_t pipeline_gc;      /* Number of lines in the GC pipeline -
 253                                     * started reads to finished writes
 254                                     */
 255         int w_entries;
 256
 257         struct list_head w_list;
 258         struct list_head r_list;
 259
 260         spinlock_t lock;
 261         spinlock_t w_lock;
 262         spinlock_t r_lock;
 263 };
 264
 265 struct pblk_rl {
 266         unsigned int high;      /* Upper threshold for rate limiter (free run -
 267                                  * user I/O rate limiter
 268                                  */
 269         unsigned int high_pw;   /* High rounded up as a power of 2 */
 270
 271 #define PBLK_USER_HIGH_THRS 8   /* Begin write limit at 12% available blks */
 272 #define PBLK_USER_LOW_THRS 10   /* Aggressive GC at 10% available blocks */
 273
 274         int rb_windows_pw;      /* Number of rate windows in the write buffer
 275                                  * given as a power-of-2. This guarantees that
 276                                  * when user I/O is being rate limited, there
 277                                  * will be reserved enough space for the GC to
 278                                  * place its payload. A window is of
 279                                  * pblk->max_write_pgs size, which in NVMe is
 280                                  * 64, i.e., 256kb.
 281                                  */
 282         int rb_budget;          /* Total number of entries available for I/O */
 283         int rb_user_max;        /* Max buffer entries available for user I/O */
 284         int rb_gc_max;          /* Max buffer entries available for GC I/O */
 285         int rb_gc_rsv;          /* Reserved buffer entries for GC I/O */
 286         int rb_state;           /* Rate-limiter current state */
 287         int rb_max_io;          /* Maximum size for an I/O giving the config */
 288
 289         atomic_t rb_user_cnt;   /* User I/O buffer counter */
 290         atomic_t rb_gc_cnt;     /* GC I/O buffer counter */
 291         atomic_t rb_space;      /* Space limit in case of reaching capacity */
 292
 293         int rsv_blocks;         /* Reserved blocks for GC */
 294
 295         int rb_user_active;
 296         int rb_gc_active;
 297
 298         atomic_t werr_lines;    /* Number of write error lines that needs gc */
 299
 300         struct timer_list u_timer;
 301
 302         unsigned long long nr_secs;
 303         unsigned long total_blocks;
 304
 305         atomic_t free_blocks;           /* Total number of free blocks (+ OP) */
 306         atomic_t free_user_blocks;      /* Number of user free blocks (no OP) */
 307 };
 308
 309 #define PBLK_LINE_EMPTY (~0U)
 310
 311 enum {
 312         /* Line Types */
 313         PBLK_LINETYPE_FREE = 0,
 314         PBLK_LINETYPE_LOG = 1,
 315         PBLK_LINETYPE_DATA = 2,
 316
 317         /* Line state */
 318         PBLK_LINESTATE_NEW = 9,
 319         PBLK_LINESTATE_FREE = 10,
 320         PBLK_LINESTATE_OPEN = 11,
 321         PBLK_LINESTATE_CLOSED = 12,
 322         PBLK_LINESTATE_GC = 13,
 323         PBLK_LINESTATE_BAD = 14,
 324         PBLK_LINESTATE_CORRUPT = 15,
 325
 326         /* GC group */
 327         PBLK_LINEGC_NONE = 20,
 328         PBLK_LINEGC_EMPTY = 21,
 329         PBLK_LINEGC_LOW = 22,
 330         PBLK_LINEGC_MID = 23,
 331         PBLK_LINEGC_HIGH = 24,
 332         PBLK_LINEGC_FULL = 25,
 333         PBLK_LINEGC_WERR = 26
 334 };
 335
 336 #define PBLK_MAGIC 0x70626c6b /*pblk*/
 337
 338 /* emeta/smeta persistent storage format versions:
 339  * Changes in major version requires offline migration.
 340  * Changes in minor version are handled automatically during
 341  * recovery.
 342  */
 343
 344 #define SMETA_VERSION_MAJOR (0)
 345 #define SMETA_VERSION_MINOR (1)
 346
 347 #define EMETA_VERSION_MAJOR (0)
 348 #define EMETA_VERSION_MINOR (2)
 349
 350 struct line_header {
 351         __le32 crc;
 352         __le32 identifier;      /* pblk identifier */
 353         __u8 uuid[16];          /* instance uuid */
 354         __le16 type;            /* line type */
 355         __u8 version_major;     /* version major */
 356         __u8 version_minor;     /* version minor */
 357         __le32 id;              /* line id for current line */
 358 };
 359
 360 struct line_smeta {
 361         struct line_header header;
 362
 363         __le32 crc;             /* Full structure including struct crc */
 364         /* Previous line metadata */
 365         __le32 prev_id;         /* Line id for previous line */
 366
 367         /* Current line metadata */
 368         __le64 seq_nr;          /* Sequence number for current line */
 369
 370         /* Active writers */
 371         __le32 window_wr_lun;   /* Number of parallel LUNs to write */
 372
 373         __le32 rsvd[2];
 374
 375         __le64 lun_bitmap[];
 376 };
 377
 378
 379 /*
 380  * Metadata layout in media:
 381  *      First sector:
 382  *              1. struct line_emeta
 383  *              2. bad block bitmap (u64 * window_wr_lun)
 384  *              3. write amplification counters
 385  *      Mid sectors (start at lbas_sector):
 386  *              3. nr_lbas (u64) forming lba list
 387  *      Last sectors (start at vsc_sector):
 388  *              4. u32 valid sector count (vsc) for all lines (~0U: free line)
 389  */
 390 struct line_emeta {
 391         struct line_header header;
 392
 393         __le32 crc;             /* Full structure including struct crc */
 394
 395         /* Previous line metadata */
 396         __le32 prev_id;         /* Line id for prev line */
 397
 398         /* Current line metadata */
 399         __le64 seq_nr;          /* Sequence number for current line */
 400
 401         /* Active writers */
 402         __le32 window_wr_lun;   /* Number of parallel LUNs to write */
 403
 404         /* Bookkeeping for recovery */
 405         __le32 next_id;         /* Line id for next line */
 406         __le64 nr_lbas;         /* Number of lbas mapped in line */
 407         __le64 nr_valid_lbas;   /* Number of valid lbas mapped in line */
 408         __le64 bb_bitmap[];     /* Updated bad block bitmap for line */
 409 };
 410
 411
 412 /* Write amplification counters stored on media */
 413 struct wa_counters {
 414         __le64 user;            /* Number of user written sectors */
 415         __le64 gc;              /* Number of sectors written by GC*/
 416         __le64 pad;             /* Number of padded sectors */
 417 };
 418
 419 struct pblk_emeta {
 420         struct line_emeta *buf;         /* emeta buffer in media format */
 421         int mem;                        /* Write offset - points to next
 422                                          * writable entry in memory
 423                                          */
 424         atomic_t sync;                  /* Synced - backpointer that signals the
 425                                          * last entry that has been successfully
 426                                          * persisted to media
 427                                          */
 428         unsigned int nr_entries;        /* Number of emeta entries */
 429 };
 430
 431 struct pblk_smeta {
 432         struct line_smeta *buf;         /* smeta buffer in persistent format */
 433 };
 434
 435 struct pblk_w_err_gc {
 436         int has_write_err;
 437         __le64 *lba_list;
 438 };
 439
 440 struct pblk_line {
 441         struct pblk *pblk;
 442         unsigned int id;                /* Line number corresponds to the
 443                                          * block line
 444                                          */
 445         unsigned int seq_nr;            /* Unique line sequence number */
 446
 447         int state;                      /* PBLK_LINESTATE_X */
 448         int type;                       /* PBLK_LINETYPE_X */
 449         int gc_group;                   /* PBLK_LINEGC_X */
 450         struct list_head list;          /* Free, GC lists */
 451
 452         unsigned long *lun_bitmap;      /* Bitmap for LUNs mapped in line */
 453
 454         struct nvm_chk_meta *chks;      /* Chunks forming line */
 455
 456         struct pblk_smeta *smeta;       /* Start metadata */
 457         struct pblk_emeta *emeta;       /* End medatada */
 458
 459         int meta_line;                  /* Metadata line id */
 460         int meta_distance;              /* Distance between data and metadata */
 461
 462         u64 smeta_ssec;                 /* Sector where smeta starts */
 463         u64 emeta_ssec;                 /* Sector where emeta starts */
 464
 465         unsigned int sec_in_line;       /* Number of usable secs in line */
 466
 467         atomic_t blk_in_line;           /* Number of good blocks in line */
 468         unsigned long *blk_bitmap;      /* Bitmap for valid/invalid blocks */
 469         unsigned long *erase_bitmap;    /* Bitmap for erased blocks */
 470
 471         unsigned long *map_bitmap;      /* Bitmap for mapped sectors in line */
 472         unsigned long *invalid_bitmap;  /* Bitmap for invalid sectors in line */
 473
 474         atomic_t left_eblks;            /* Blocks left for erasing */
 475         atomic_t left_seblks;           /* Blocks left for sync erasing */
 476
 477         int left_msecs;                 /* Sectors left for mapping */
 478         unsigned int cur_sec;           /* Sector map pointer */
 479         unsigned int nr_valid_lbas;     /* Number of valid lbas in line */
 480
 481         __le32 *vsc;                    /* Valid sector count in line */
 482
 483         struct kref ref;                /* Write buffer L2P references */
 484
 485         struct pblk_w_err_gc *w_err_gc; /* Write error gc recovery metadata */
 486
 487         spinlock_t lock;                /* Necessary for invalid_bitmap only */
 488 };
 489
 490 #define PBLK_DATA_LINES 4
 491
 492 enum {
 493         PBLK_KMALLOC_META = 1,
 494         PBLK_VMALLOC_META = 2,
 495 };
 496
 497 enum {
 498         PBLK_EMETA_TYPE_HEADER = 1,     /* struct line_emeta first sector */
 499         PBLK_EMETA_TYPE_LLBA = 2,       /* lba list - type: __le64 */
 500         PBLK_EMETA_TYPE_VSC = 3,        /* vsc list - type: __le32 */
 501 };
 502
 503 struct pblk_line_mgmt {
 504         int nr_lines;                   /* Total number of full lines */
 505         int nr_free_lines;              /* Number of full lines in free list */
 506
 507         /* Free lists - use free_lock */
 508         struct list_head free_list;     /* Full lines ready to use */
 509         struct list_head corrupt_list;  /* Full lines corrupted */
 510         struct list_head bad_list;      /* Full lines bad */
 511
 512         /* GC lists - use gc_lock */
 513         struct list_head *gc_lists[PBLK_GC_NR_LISTS];
 514         struct list_head gc_high_list;  /* Full lines ready to GC, high isc */
 515         struct list_head gc_mid_list;   /* Full lines ready to GC, mid isc */
 516         struct list_head gc_low_list;   /* Full lines ready to GC, low isc */
 517
 518         struct list_head gc_werr_list;  /* Write err recovery list */
 519
 520         struct list_head gc_full_list;  /* Full lines ready to GC, no valid */
 521         struct list_head gc_empty_list; /* Full lines close, all valid */
 522
 523         struct pblk_line *log_line;     /* Current FTL log line */
 524         struct pblk_line *data_line;    /* Current data line */
 525         struct pblk_line *log_next;     /* Next FTL log line */
 526         struct pblk_line *data_next;    /* Next data line */
 527
 528         struct list_head emeta_list;    /* Lines queued to schedule emeta */
 529
 530         __le32 *vsc_list;               /* Valid sector counts for all lines */
 531
 532         /* Metadata allocation type: VMALLOC | KMALLOC */
 533         int emeta_alloc_type;
 534
 535         /* Pre-allocated metadata for data lines */
 536         struct pblk_smeta *sline_meta[PBLK_DATA_LINES];
 537         struct pblk_emeta *eline_meta[PBLK_DATA_LINES];
 538         unsigned long meta_bitmap;
 539
 540         /* Cache and mempool for map/invalid bitmaps */
 541         struct kmem_cache *bitmap_cache;
 542         mempool_t *bitmap_pool;
 543
 544         /* Helpers for fast bitmap calculations */
 545         unsigned long *bb_template;
 546         unsigned long *bb_aux;
 547
 548         unsigned long d_seq_nr;         /* Data line unique sequence number */
 549         unsigned long l_seq_nr;         /* Log line unique sequence number */
 550
 551         spinlock_t free_lock;
 552         spinlock_t close_lock;
 553         spinlock_t gc_lock;
 554 };
 555
 556 struct pblk_line_meta {
 557         unsigned int smeta_len;         /* Total length for smeta */
 558         unsigned int smeta_sec;         /* Sectors needed for smeta */
 559
 560         unsigned int emeta_len[4];      /* Lengths for emeta:
 561                                          *  [0]: Total
 562                                          *  [1]: struct line_emeta +
 563                                          *       bb_bitmap + struct wa_counters
 564                                          *  [2]: L2P portion
 565                                          *  [3]: vsc
 566                                          */
 567         unsigned int emeta_sec[4];      /* Sectors needed for emeta. Same layout
 568                                          * as emeta_len
 569                                          */
 570
 571         unsigned int emeta_bb;          /* Boundary for bb that affects emeta */
 572
 573         unsigned int vsc_list_len;      /* Length for vsc list */
 574         unsigned int sec_bitmap_len;    /* Length for sector bitmap in line */
 575         unsigned int blk_bitmap_len;    /* Length for block bitmap in line */
 576         unsigned int lun_bitmap_len;    /* Length for lun bitmap in line */
 577
 578         unsigned int blk_per_line;      /* Number of blocks in a full line */
 579         unsigned int sec_per_line;      /* Number of sectors in a line */
 580         unsigned int dsec_per_line;     /* Number of data sectors in a line */
 581         unsigned int min_blk_line;      /* Min. number of good blocks in line */
 582
 583         unsigned int mid_thrs;          /* Threshold for GC mid list */
 584         unsigned int high_thrs;         /* Threshold for GC high list */
 585
 586         unsigned int meta_distance;     /* Distance between data and metadata */
 587 };
 588
 589 enum {
 590         PBLK_STATE_RUNNING = 0,
 591         PBLK_STATE_STOPPING = 1,
 592         PBLK_STATE_RECOVERING = 2,
 593         PBLK_STATE_STOPPED = 3,
 594 };
 595
 596 /* Internal format to support not power-of-2 device formats */
 597 struct pblk_addrf {
 598         /* gen to dev */
 599         int sec_stripe;
 600         int ch_stripe;
 601         int lun_stripe;
 602
 603         /* dev to gen */
 604         int sec_lun_stripe;
 605         int sec_ws_stripe;
 606 };
 607
 608 struct pblk {
 609         struct nvm_tgt_dev *dev;
 610         struct gendisk *disk;
 611
 612         struct kobject kobj;
 613
 614         struct pblk_lun *luns;
 615
 616         struct pblk_line *lines;                /* Line array */
 617         struct pblk_line_mgmt l_mg;             /* Line management */
 618         struct pblk_line_meta lm;               /* Line metadata */
 619
 620         struct nvm_addrf addrf;         /* Aligned address format */
 621         struct pblk_addrf uaddrf;       /* Unaligned address format */
 622         int addrf_len;
 623
 624         struct pblk_rb rwb;
 625
 626         int state;                      /* pblk line state */
 627
 628         int min_write_pgs; /* Minimum amount of pages required by controller */
 629         int max_write_pgs; /* Maximum amount of pages supported by controller */
 630
 631         sector_t capacity; /* Device capacity when bad blocks are subtracted */
 632
 633         int op;      /* Percentage of device used for over-provisioning */
 634         int op_blks; /* Number of blocks used for over-provisioning */
 635
 636         /* pblk provisioning values. Used by rate limiter */
 637         struct pblk_rl rl;
 638
 639         int sec_per_write;
 640
 641         unsigned char instance_uuid[16];
 642
 643         /* Persistent write amplification counters, 4kb sector I/Os */
 644         atomic64_t user_wa;             /* Sectors written by user */
 645         atomic64_t gc_wa;               /* Sectors written by GC */
 646         atomic64_t pad_wa;              /* Padded sectors written */
 647
 648         /* Reset values for delta write amplification measurements */
 649         u64 user_rst_wa;
 650         u64 gc_rst_wa;
 651         u64 pad_rst_wa;
 652
 653         /* Counters used for calculating padding distribution */
 654         atomic64_t *pad_dist;           /* Padding distribution buckets */
 655         u64 nr_flush_rst;               /* Flushes reset value for pad dist.*/
 656         atomic64_t nr_flush;            /* Number of flush/fua I/O */
 657
 658 #ifdef CONFIG_NVM_PBLK_DEBUG
 659         /* Non-persistent debug counters, 4kb sector I/Os */
 660         atomic_long_t inflight_writes;  /* Inflight writes (user and gc) */
 661         atomic_long_t padded_writes;    /* Sectors padded due to flush/fua */
 662         atomic_long_t padded_wb;        /* Sectors padded in write buffer */
 663         atomic_long_t req_writes;       /* Sectors stored on write buffer */
 664         atomic_long_t sub_writes;       /* Sectors submitted from buffer */
 665         atomic_long_t sync_writes;      /* Sectors synced to media */
 666         atomic_long_t inflight_reads;   /* Inflight sector read requests */
 667         atomic_long_t cache_reads;      /* Read requests that hit the cache */
 668         atomic_long_t sync_reads;       /* Completed sector read requests */
 669         atomic_long_t recov_writes;     /* Sectors submitted from recovery */
 670         atomic_long_t recov_gc_writes;  /* Sectors submitted from write GC */
 671         atomic_long_t recov_gc_reads;   /* Sectors submitted from read GC */
 672 #endif
 673
 674         spinlock_t lock;
 675
 676         atomic_long_t read_failed;
 677         atomic_long_t read_empty;
 678         atomic_long_t read_high_ecc;
 679         atomic_long_t read_failed_gc;
 680         atomic_long_t write_failed;
 681         atomic_long_t erase_failed;
 682
 683         atomic_t inflight_io;           /* General inflight I/O counter */
 684
 685         struct task_struct *writer_ts;
 686
 687         /* Simple translation map of logical addresses to physical addresses.
 688          * The logical addresses is known by the host system, while the physical
 689          * addresses are used when writing to the disk block device.
 690          */
 691         unsigned char *trans_map;
 692         spinlock_t trans_lock;
 693
 694         struct list_head compl_list;
 695
 696         spinlock_t resubmit_lock;        /* Resubmit list lock */
 697         struct list_head resubmit_list; /* Resubmit list for failed writes*/
 698
 699         mempool_t page_bio_pool;
 700         mempool_t gen_ws_pool;
 701         mempool_t rec_pool;
 702         mempool_t r_rq_pool;
 703         mempool_t w_rq_pool;
 704         mempool_t e_rq_pool;
 705
 706         struct workqueue_struct *close_wq;
 707         struct workqueue_struct *bb_wq;
 708         struct workqueue_struct *r_end_wq;
 709
 710         struct timer_list wtimer;
 711
 712         struct pblk_gc gc;
 713 };
 714
 715 struct pblk_line_ws {
 716         struct pblk *pblk;
 717         struct pblk_line *line;
 718         void *priv;
 719         struct work_struct ws;
 720 };
 721
 722 #define pblk_g_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_g_ctx))
 723 #define pblk_w_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_c_ctx))
 724
 725 #define pblk_err(pblk, fmt, ...)                        \
 726         pr_err("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
 727 #define pblk_info(pblk, fmt, ...)                       \
 728         pr_info("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
 729 #define pblk_warn(pblk, fmt, ...)                       \
 730         pr_warn("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
 731 #define pblk_debug(pblk, fmt, ...)                      \
 732         pr_debug("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
 733
 734 /*
 735  * pblk ring buffer operations
 736  */
 737 int pblk_rb_init(struct pblk_rb *rb, struct pblk_rb_entry *rb_entry_base,
 738                  unsigned int power_size, unsigned int power_seg_sz);
 739 unsigned int pblk_rb_calculate_size(unsigned int nr_entries);
 740 void *pblk_rb_entries_ref(struct pblk_rb *rb);
 741 int pblk_rb_may_write_user(struct pblk_rb *rb, struct bio *bio,
 742                            unsigned int nr_entries, unsigned int *pos);
 743 int pblk_rb_may_write_gc(struct pblk_rb *rb, unsigned int nr_entries,
 744                          unsigned int *pos);
 745 void pblk_rb_write_entry_user(struct pblk_rb *rb, void *data,
 746                               struct pblk_w_ctx w_ctx, unsigned int pos);
 747 void pblk_rb_write_entry_gc(struct pblk_rb *rb, void *data,
 748                             struct pblk_w_ctx w_ctx, struct pblk_line *line,
 749                             u64 paddr, unsigned int pos);
 750 struct pblk_w_ctx *pblk_rb_w_ctx(struct pblk_rb *rb, unsigned int pos);
 751 void pblk_rb_flush(struct pblk_rb *rb);
 752
 753 void pblk_rb_sync_l2p(struct pblk_rb *rb);
 754 unsigned int pblk_rb_read_to_bio(struct pblk_rb *rb, struct nvm_rq *rqd,
 755                                  unsigned int pos, unsigned int nr_entries,
 756                                  unsigned int count);
 757 int pblk_rb_copy_to_bio(struct pblk_rb *rb, struct bio *bio, sector_t lba,
 758                         struct ppa_addr ppa, int bio_iter, bool advanced_bio);
 759 unsigned int pblk_rb_read_commit(struct pblk_rb *rb, unsigned int entries);
 760
 761 unsigned int pblk_rb_sync_init(struct pblk_rb *rb, unsigned long *flags);
 762 unsigned int pblk_rb_sync_advance(struct pblk_rb *rb, unsigned int nr_entries);
 763 struct pblk_rb_entry *pblk_rb_sync_scan_entry(struct pblk_rb *rb,
 764                                               struct ppa_addr *ppa);
 765 void pblk_rb_sync_end(struct pblk_rb *rb, unsigned long *flags);
 766 unsigned int pblk_rb_flush_point_count(struct pblk_rb *rb);
 767
 768 unsigned int pblk_rb_read_count(struct pblk_rb *rb);
 769 unsigned int pblk_rb_sync_count(struct pblk_rb *rb);
 770 unsigned int pblk_rb_wrap_pos(struct pblk_rb *rb, unsigned int pos);
 771
 772 int pblk_rb_tear_down_check(struct pblk_rb *rb);
 773 int pblk_rb_pos_oob(struct pblk_rb *rb, u64 pos);
 774 void pblk_rb_data_free(struct pblk_rb *rb);
 775 ssize_t pblk_rb_sysfs(struct pblk_rb *rb, char *buf);
 776
 777 /*
 778  * pblk core
 779  */
 780 struct nvm_rq *pblk_alloc_rqd(struct pblk *pblk, int type);
 781 void pblk_free_rqd(struct pblk *pblk, struct nvm_rq *rqd, int type);
 782 int pblk_alloc_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
 783 void pblk_free_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
 784 void pblk_set_sec_per_write(struct pblk *pblk, int sec_per_write);
 785 int pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
 786                         struct pblk_c_ctx *c_ctx);
 787 void pblk_discard(struct pblk *pblk, struct bio *bio);
 788 struct nvm_chk_meta *pblk_get_chunk_meta(struct pblk *pblk);
 789 struct nvm_chk_meta *pblk_chunk_get_off(struct pblk *pblk,
 790                                               struct nvm_chk_meta *lp,
 791                                               struct ppa_addr ppa);
 792 void pblk_log_write_err(struct pblk *pblk, struct nvm_rq *rqd);
 793 void pblk_log_read_err(struct pblk *pblk, struct nvm_rq *rqd);
 794 int pblk_submit_io(struct pblk *pblk, struct nvm_rq *rqd);
 795 int pblk_submit_io_sync(struct pblk *pblk, struct nvm_rq *rqd);
 796 int pblk_submit_io_sync_sem(struct pblk *pblk, struct nvm_rq *rqd);
 797 int pblk_submit_meta_io(struct pblk *pblk, struct pblk_line *meta_line);
 798 void pblk_check_chunk_state_update(struct pblk *pblk, struct nvm_rq *rqd);
 799 struct bio *pblk_bio_map_addr(struct pblk *pblk, void *data,
 800                               unsigned int nr_secs, unsigned int len,
 801                               int alloc_type, gfp_t gfp_mask);
 802 struct pblk_line *pblk_line_get(struct pblk *pblk);
 803 struct pblk_line *pblk_line_get_first_data(struct pblk *pblk);
 804 struct pblk_line *pblk_line_replace_data(struct pblk *pblk);
 805 void pblk_ppa_to_line_put(struct pblk *pblk, struct ppa_addr ppa);
 806 void pblk_rq_to_line_put(struct pblk *pblk, struct nvm_rq *rqd);
 807 int pblk_line_recov_alloc(struct pblk *pblk, struct pblk_line *line);
 808 void pblk_line_recov_close(struct pblk *pblk, struct pblk_line *line);
 809 struct pblk_line *pblk_line_get_data(struct pblk *pblk);
 810 struct pblk_line *pblk_line_get_erase(struct pblk *pblk);
 811 int pblk_line_erase(struct pblk *pblk, struct pblk_line *line);
 812 int pblk_line_is_full(struct pblk_line *line);
 813 void pblk_line_free(struct pblk_line *line);
 814 void pblk_line_close_meta(struct pblk *pblk, struct pblk_line *line);
 815 void pblk_line_close(struct pblk *pblk, struct pblk_line *line);
 816 void pblk_line_close_ws(struct work_struct *work);
 817 void pblk_pipeline_stop(struct pblk *pblk);
 818 void __pblk_pipeline_stop(struct pblk *pblk);
 819 void __pblk_pipeline_flush(struct pblk *pblk);
 820 void pblk_gen_run_ws(struct pblk *pblk, struct pblk_line *line, void *priv,
 821                      void (*work)(struct work_struct *), gfp_t gfp_mask,
 822                      struct workqueue_struct *wq);
 823 u64 pblk_line_smeta_start(struct pblk *pblk, struct pblk_line *line);
 824 int pblk_line_smeta_read(struct pblk *pblk, struct pblk_line *line);
 825 int pblk_line_emeta_read(struct pblk *pblk, struct pblk_line *line,
 826                          void *emeta_buf);
 827 int pblk_blk_erase_async(struct pblk *pblk, struct ppa_addr erase_ppa);
 828 void pblk_line_put(struct kref *ref);
 829 void pblk_line_put_wq(struct kref *ref);
 830 struct list_head *pblk_line_gc_list(struct pblk *pblk, struct pblk_line *line);
 831 u64 pblk_lookup_page(struct pblk *pblk, struct pblk_line *line);
 832 void pblk_dealloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 833 u64 pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 834 u64 __pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
 835 int pblk_calc_secs(struct pblk *pblk, unsigned long secs_avail,
 836                    unsigned long secs_to_flush);
 837 void pblk_down_rq(struct pblk *pblk, struct ppa_addr ppa,
 838                   unsigned long *lun_bitmap);
 839 void pblk_down_chunk(struct pblk *pblk, struct ppa_addr ppa);
 840 void pblk_up_chunk(struct pblk *pblk, struct ppa_addr ppa);
 841 void pblk_up_rq(struct pblk *pblk, unsigned long *lun_bitmap);
 842 int pblk_bio_add_pages(struct pblk *pblk, struct bio *bio, gfp_t flags,
 843                        int nr_pages);
 844 void pblk_bio_free_pages(struct pblk *pblk, struct bio *bio, int off,
 845                          int nr_pages);
 846 void pblk_map_invalidate(struct pblk *pblk, struct ppa_addr ppa);
 847 void __pblk_map_invalidate(struct pblk *pblk, struct pblk_line *line,
 848                            u64 paddr);
 849 void pblk_update_map(struct pblk *pblk, sector_t lba, struct ppa_addr ppa);
 850 void pblk_update_map_cache(struct pblk *pblk, sector_t lba,
 851                            struct ppa_addr ppa);
 852 void pblk_update_map_dev(struct pblk *pblk, sector_t lba,
 853                          struct ppa_addr ppa, struct ppa_addr entry_line);
 854 int pblk_update_map_gc(struct pblk *pblk, sector_t lba, struct ppa_addr ppa,
 855                        struct pblk_line *gc_line, u64 paddr);
 856 void pblk_lookup_l2p_rand(struct pblk *pblk, struct ppa_addr *ppas,
 857                           u64 *lba_list, int nr_secs);
 858 void pblk_lookup_l2p_seq(struct pblk *pblk, struct ppa_addr *ppas,
 859                          sector_t blba, int nr_secs);
 860
 861 /*
 862  * pblk user I/O write path
 863  */
 864 int pblk_write_to_cache(struct pblk *pblk, struct bio *bio,
 865                         unsigned long flags);
 866 int pblk_write_gc_to_cache(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
 867
 868 /*
 869  * pblk map
 870  */
 871 void pblk_map_erase_rq(struct pblk *pblk, struct nvm_rq *rqd,
 872                        unsigned int sentry, unsigned long *lun_bitmap,
 873                        unsigned int valid_secs, struct ppa_addr *erase_ppa);
 874 void pblk_map_rq(struct pblk *pblk, struct nvm_rq *rqd, unsigned int sentry,
 875                  unsigned long *lun_bitmap, unsigned int valid_secs,
 876                  unsigned int off);
 877
 878 /*
 879  * pblk write thread
 880  */
 881 int pblk_write_ts(void *data);
 882 void pblk_write_timer_fn(struct timer_list *t);
 883 void pblk_write_should_kick(struct pblk *pblk);
 884 void pblk_write_kick(struct pblk *pblk);
 885
 886 /*
 887  * pblk read path
 888  */
 889 extern struct bio_set pblk_bio_set;
 890 int pblk_submit_read(struct pblk *pblk, struct bio *bio);
 891 int pblk_submit_read_gc(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
 892 /*
 893  * pblk recovery
 894  */
 895 struct pblk_line *pblk_recov_l2p(struct pblk *pblk);
 896 int pblk_recov_pad(struct pblk *pblk);
 897 int pblk_recov_check_emeta(struct pblk *pblk, struct line_emeta *emeta);
 898
 899 /*
 900  * pblk gc
 901  */
 902 #define PBLK_GC_MAX_READERS 8   /* Max number of outstanding GC reader jobs */
 903 #define PBLK_GC_RQ_QD 128       /* Queue depth for inflight GC requests */
 904 #define PBLK_GC_L_QD 4          /* Queue depth for inflight GC lines */
 905 #define PBLK_GC_RSV_LINE 1      /* Reserved lines for GC */
 906
 907 int pblk_gc_init(struct pblk *pblk);
 908 void pblk_gc_exit(struct pblk *pblk, bool graceful);
 909 void pblk_gc_should_start(struct pblk *pblk);
 910 void pblk_gc_should_stop(struct pblk *pblk);
 911 void pblk_gc_should_kick(struct pblk *pblk);
 912 void pblk_gc_free_full_lines(struct pblk *pblk);
 913 void pblk_gc_sysfs_state_show(struct pblk *pblk, int *gc_enabled,
 914                               int *gc_active);
 915 int pblk_gc_sysfs_force(struct pblk *pblk, int force);
 916
 917 /*
 918  * pblk rate limiter
 919  */
 920 void pblk_rl_init(struct pblk_rl *rl, int budget);
 921 void pblk_rl_free(struct pblk_rl *rl);
 922 void pblk_rl_update_rates(struct pblk_rl *rl);
 923 int pblk_rl_high_thrs(struct pblk_rl *rl);
 924 unsigned long pblk_rl_nr_free_blks(struct pblk_rl *rl);
 925 unsigned long pblk_rl_nr_user_free_blks(struct pblk_rl *rl);
 926 int pblk_rl_user_may_insert(struct pblk_rl *rl, int nr_entries);
 927 void pblk_rl_inserted(struct pblk_rl *rl, int nr_entries);
 928 void pblk_rl_user_in(struct pblk_rl *rl, int nr_entries);
 929 int pblk_rl_gc_may_insert(struct pblk_rl *rl, int nr_entries);
 930 void pblk_rl_gc_in(struct pblk_rl *rl, int nr_entries);
 931 void pblk_rl_out(struct pblk_rl *rl, int nr_user, int nr_gc);
 932 int pblk_rl_max_io(struct pblk_rl *rl);
 933 void pblk_rl_free_lines_inc(struct pblk_rl *rl, struct pblk_line *line);
 934 void pblk_rl_free_lines_dec(struct pblk_rl *rl, struct pblk_line *line,
 935                             bool used);
 936 int pblk_rl_is_limit(struct pblk_rl *rl);
 937
 938 void pblk_rl_werr_line_in(struct pblk_rl *rl);
 939 void pblk_rl_werr_line_out(struct pblk_rl *rl);
 940
 941 /*
 942  * pblk sysfs
 943  */
 944 int pblk_sysfs_init(struct gendisk *tdisk);
 945 void pblk_sysfs_exit(struct gendisk *tdisk);
 946
 947 static inline void *pblk_malloc(size_t size, int type, gfp_t flags)
 948 {
 949         if (type == PBLK_KMALLOC_META)
 950                 return kmalloc(size, flags);
 951         return vmalloc(size);
 952 }
 953
 954 static inline void pblk_mfree(void *ptr, int type)
 955 {
 956         if (type == PBLK_KMALLOC_META)
 957                 kfree(ptr);
 958         else
 959                 vfree(ptr);
 960 }
 961
 962 static inline struct nvm_rq *nvm_rq_from_c_ctx(void *c_ctx)
 963 {
 964         return c_ctx - sizeof(struct nvm_rq);
 965 }
 966
 967 static inline void *emeta_to_bb(struct line_emeta *emeta)
 968 {
 969         return emeta->bb_bitmap;
 970 }
 971
 972 static inline void *emeta_to_wa(struct pblk_line_meta *lm,
 973                                 struct line_emeta *emeta)
 974 {
 975         return emeta->bb_bitmap + lm->blk_bitmap_len;
 976 }
 977
 978 static inline void *emeta_to_lbas(struct pblk *pblk, struct line_emeta *emeta)
 979 {
 980         return ((void *)emeta + pblk->lm.emeta_len[1]);
 981 }
 982
 983 static inline void *emeta_to_vsc(struct pblk *pblk, struct line_emeta *emeta)
 984 {
 985         return (emeta_to_lbas(pblk, emeta) + pblk->lm.emeta_len[2]);
 986 }
 987
 988 static inline int pblk_line_vsc(struct pblk_line *line)
 989 {
 990         return le32_to_cpu(*line->vsc);
 991 }
 992
 993 static inline int pblk_ppa_to_line_id(struct ppa_addr p)
 994 {
 995         return p.a.blk;
 996 }
 997
 998 static inline struct pblk_line *pblk_ppa_to_line(struct pblk *pblk,
 999                                                  struct ppa_addr p)
1000 {
1001         return &pblk->lines[pblk_ppa_to_line_id(p)];
1002 }
1003
1004 static inline int pblk_ppa_to_pos(struct nvm_geo *geo, struct ppa_addr p)
1005 {
1006         return p.a.lun * geo->num_ch + p.a.ch;
1007 }
1008
1009 static inline struct ppa_addr addr_to_gen_ppa(struct pblk *pblk, u64 paddr,
1010                                               u64 line_id)
1011 {
1012         struct nvm_tgt_dev *dev = pblk->dev;
1013         struct nvm_geo *geo = &dev->geo;
1014         struct ppa_addr ppa;
1015
1016         if (geo->version == NVM_OCSSD_SPEC_12) {
1017                 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
1018
1019                 ppa.ppa = 0;
1020                 ppa.g.blk = line_id;
1021                 ppa.g.pg = (paddr & ppaf->pg_mask) >> ppaf->pg_offset;
1022                 ppa.g.lun = (paddr & ppaf->lun_mask) >> ppaf->lun_offset;
1023                 ppa.g.ch = (paddr & ppaf->ch_mask) >> ppaf->ch_offset;
1024                 ppa.g.pl = (paddr & ppaf->pln_mask) >> ppaf->pln_offset;
1025                 ppa.g.sec = (paddr & ppaf->sec_mask) >> ppaf->sec_offset;
1026         } else {
1027                 struct pblk_addrf *uaddrf = &pblk->uaddrf;
1028                 int secs, chnls, luns;
1029
1030                 ppa.ppa = 0;
1031
1032                 ppa.m.chk = line_id;
1033
1034                 paddr = div_u64_rem(paddr, uaddrf->sec_stripe, &secs);
1035                 ppa.m.sec = secs;
1036
1037                 paddr = div_u64_rem(paddr, uaddrf->ch_stripe, &chnls);
1038                 ppa.m.grp = chnls;
1039
1040                 paddr = div_u64_rem(paddr, uaddrf->lun_stripe, &luns);
1041                 ppa.m.pu = luns;
1042
1043                 ppa.m.sec += uaddrf->sec_stripe * paddr;
1044         }
1045
1046         return ppa;
1047 }
1048
1049 static inline struct nvm_chk_meta *pblk_dev_ppa_to_chunk(struct pblk *pblk,
1050                                                         struct ppa_addr p)
1051 {
1052         struct nvm_tgt_dev *dev = pblk->dev;
1053         struct nvm_geo *geo = &dev->geo;
1054         struct pblk_line *line = pblk_ppa_to_line(pblk, p);
1055         int pos = pblk_ppa_to_pos(geo, p);
1056
1057         return &line->chks[pos];
1058 }
1059
1060 static inline u64 pblk_dev_ppa_to_chunk_addr(struct pblk *pblk,
1061                                                         struct ppa_addr p)
1062 {
1063         struct nvm_tgt_dev *dev = pblk->dev;
1064
1065         return dev_to_chunk_addr(dev->parent, &pblk->addrf, p);
1066 }
1067
1068 static inline u64 pblk_dev_ppa_to_line_addr(struct pblk *pblk,
1069                                                         struct ppa_addr p)
1070 {
1071         struct nvm_tgt_dev *dev = pblk->dev;
1072         struct nvm_geo *geo = &dev->geo;
1073         u64 paddr;
1074
1075         if (geo->version == NVM_OCSSD_SPEC_12) {
1076                 struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
1077
1078                 paddr = (u64)p.g.ch << ppaf->ch_offset;
1079                 paddr |= (u64)p.g.lun << ppaf->lun_offset;
1080                 paddr |= (u64)p.g.pg << ppaf->pg_offset;
1081                 paddr |= (u64)p.g.pl << ppaf->pln_offset;
1082                 paddr |= (u64)p.g.sec << ppaf->sec_offset;
1083         } else {
1084                 struct pblk_addrf *uaddrf = &pblk->uaddrf;
1085                 u64 secs = p.m.sec;
1086                 int sec_stripe;
1087
1088                 paddr = (u64)p.m.grp * uaddrf->sec_stripe;
1089                 paddr += (u64)p.m.pu * uaddrf->sec_lun_stripe;
1090
1091                 secs = div_u64_rem(secs, uaddrf->sec_stripe, &sec_stripe);
1092                 paddr += secs * uaddrf->sec_ws_stripe;
1093                 paddr += sec_stripe;
1094         }
1095
1096         return paddr;
1097 }
1098
1099 static inline struct ppa_addr pblk_ppa32_to_ppa64(struct pblk *pblk, u32 ppa32)
1100 {
1101         struct nvm_tgt_dev *dev = pblk->dev;
1102
1103         return nvm_ppa32_to_ppa64(dev->parent, &pblk->addrf, ppa32);
1104 }
1105
1106 static inline u32 pblk_ppa64_to_ppa32(struct pblk *pblk, struct ppa_addr ppa64)
1107 {
1108         struct nvm_tgt_dev *dev = pblk->dev;
1109
1110         return nvm_ppa64_to_ppa32(dev->parent, &pblk->addrf, ppa64);
1111 }
1112
1113 static inline struct ppa_addr pblk_trans_map_get(struct pblk *pblk,
1114                                                                 sector_t lba)
1115 {
1116         struct ppa_addr ppa;
1117
1118         if (pblk->addrf_len < 32) {
1119                 u32 *map = (u32 *)pblk->trans_map;
1120
1121                 ppa = pblk_ppa32_to_ppa64(pblk, map[lba]);
1122         } else {
1123                 struct ppa_addr *map = (struct ppa_addr *)pblk->trans_map;
1124
1125                 ppa = map[lba];
1126         }
1127
1128         return ppa;
1129 }
1130
1131 static inline void pblk_trans_map_set(struct pblk *pblk, sector_t lba,
1132                                                 struct ppa_addr ppa)
1133 {
1134         if (pblk->addrf_len < 32) {
1135                 u32 *map = (u32 *)pblk->trans_map;
1136
1137                 map[lba] = pblk_ppa64_to_ppa32(pblk, ppa);
1138         } else {
1139                 u64 *map = (u64 *)pblk->trans_map;
1140
1141                 map[lba] = ppa.ppa;
1142         }
1143 }
1144
1145 static inline int pblk_ppa_empty(struct ppa_addr ppa_addr)
1146 {
1147         return (ppa_addr.ppa == ADDR_EMPTY);
1148 }
1149
1150 static inline void pblk_ppa_set_empty(struct ppa_addr *ppa_addr)
1151 {
1152         ppa_addr->ppa = ADDR_EMPTY;
1153 }
1154
1155 static inline bool pblk_ppa_comp(struct ppa_addr lppa, struct ppa_addr rppa)
1156 {
1157         return (lppa.ppa == rppa.ppa);
1158 }
1159
1160 static inline int pblk_addr_in_cache(struct ppa_addr ppa)
1161 {
1162         return (ppa.ppa != ADDR_EMPTY && ppa.c.is_cached);
1163 }
1164
1165 static inline int pblk_addr_to_cacheline(struct ppa_addr ppa)
1166 {
1167         return ppa.c.line;
1168 }
1169
1170 static inline struct ppa_addr pblk_cacheline_to_addr(int addr)
1171 {
1172         struct ppa_addr p;
1173
1174         p.c.line = addr;
1175         p.c.is_cached = 1;
1176
1177         return p;
1178 }
1179
1180 static inline u32 pblk_calc_meta_header_crc(struct pblk *pblk,
1181                                             struct line_header *header)
1182 {
1183         u32 crc = ~(u32)0;
1184
1185         crc = crc32_le(crc, (unsigned char *)header + sizeof(crc),
1186                                 sizeof(struct line_header) - sizeof(crc));
1187
1188         return crc;
1189 }
1190
1191 static inline u32 pblk_calc_smeta_crc(struct pblk *pblk,
1192                                       struct line_smeta *smeta)
1193 {
1194         struct pblk_line_meta *lm = &pblk->lm;
1195         u32 crc = ~(u32)0;
1196
1197         crc = crc32_le(crc, (unsigned char *)smeta +
1198                                 sizeof(struct line_header) + sizeof(crc),
1199                                 lm->smeta_len -
1200                                 sizeof(struct line_header) - sizeof(crc));
1201
1202         return crc;
1203 }
1204
1205 static inline u32 pblk_calc_emeta_crc(struct pblk *pblk,
1206                                       struct line_emeta *emeta)
1207 {
1208         struct pblk_line_meta *lm = &pblk->lm;
1209         u32 crc = ~(u32)0;
1210
1211         crc = crc32_le(crc, (unsigned char *)emeta +
1212                                 sizeof(struct line_header) + sizeof(crc),
1213                                 lm->emeta_len[0] -
1214                                 sizeof(struct line_header) - sizeof(crc));
1215
1216         return crc;
1217 }
1218
1219 static inline int pblk_io_aligned(struct pblk *pblk, int nr_secs)
1220 {
1221         return !(nr_secs % pblk->min_write_pgs);
1222 }
1223
1224 #ifdef CONFIG_NVM_PBLK_DEBUG
1225 static inline void print_ppa(struct pblk *pblk, struct ppa_addr *p,
1226                              char *msg, int error)
1227 {
1228         struct nvm_geo *geo = &pblk->dev->geo;
1229
1230         if (p->c.is_cached) {
1231                 pblk_err(pblk, "ppa: (%s: %x) cache line: %llu\n",
1232                                 msg, error, (u64)p->c.line);
1233         } else if (geo->version == NVM_OCSSD_SPEC_12) {
1234                 pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,blk:%d,pg:%d,pl:%d,sec:%d\n",
1235                         msg, error,
1236                         p->g.ch, p->g.lun, p->g.blk,
1237                         p->g.pg, p->g.pl, p->g.sec);
1238         } else {
1239                 pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,chk:%d,sec:%d\n",
1240                         msg, error,
1241                         p->m.grp, p->m.pu, p->m.chk, p->m.sec);
1242         }
1243 }
1244
1245 static inline void pblk_print_failed_rqd(struct pblk *pblk, struct nvm_rq *rqd,
1246                                          int error)
1247 {
1248         int bit = -1;
1249
1250         if (rqd->nr_ppas ==  1) {
1251                 print_ppa(pblk, &rqd->ppa_addr, "rqd", error);
1252                 return;
1253         }
1254
1255         while ((bit = find_next_bit((void *)&rqd->ppa_status, rqd->nr_ppas,
1256                                                 bit + 1)) < rqd->nr_ppas) {
1257                 print_ppa(pblk, &rqd->ppa_list[bit], "rqd", error);
1258         }
1259
1260         pblk_err(pblk, "error:%d, ppa_status:%llx\n", error, rqd->ppa_status);
1261 }
1262
1263 static inline int pblk_boundary_ppa_checks(struct nvm_tgt_dev *tgt_dev,
1264                                        struct ppa_addr *ppas, int nr_ppas)
1265 {
1266         struct nvm_geo *geo = &tgt_dev->geo;
1267         struct ppa_addr *ppa;
1268         int i;
1269
1270         for (i = 0; i < nr_ppas; i++) {
1271                 ppa = &ppas[i];
1272
1273                 if (geo->version == NVM_OCSSD_SPEC_12) {
1274                         if (!ppa->c.is_cached &&
1275                                         ppa->g.ch < geo->num_ch &&
1276                                         ppa->g.lun < geo->num_lun &&
1277                                         ppa->g.pl < geo->num_pln &&
1278                                         ppa->g.blk < geo->num_chk &&
1279                                         ppa->g.pg < geo->num_pg &&
1280                                         ppa->g.sec < geo->ws_min)
1281                                 continue;
1282                 } else {
1283                         if (!ppa->c.is_cached &&
1284                                         ppa->m.grp < geo->num_ch &&
1285                                         ppa->m.pu < geo->num_lun &&
1286                                         ppa->m.chk < geo->num_chk &&
1287                                         ppa->m.sec < geo->clba)
1288                                 continue;
1289                 }
1290
1291                 print_ppa(tgt_dev->q->queuedata, ppa, "boundary", i);
1292
1293                 return 1;
1294         }
1295         return 0;
1296 }
1297
1298 static inline int pblk_check_io(struct pblk *pblk, struct nvm_rq *rqd)
1299 {
1300         struct nvm_tgt_dev *dev = pblk->dev;
1301         struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
1302
1303         if (pblk_boundary_ppa_checks(dev, ppa_list, rqd->nr_ppas)) {
1304                 WARN_ON(1);
1305                 return -EINVAL;
1306         }
1307
1308         if (rqd->opcode == NVM_OP_PWRITE) {
1309                 struct pblk_line *line;
1310                 int i;
1311
1312                 for (i = 0; i < rqd->nr_ppas; i++) {
1313                         line = pblk_ppa_to_line(pblk, ppa_list[i]);
1314
1315                         spin_lock(&line->lock);
1316                         if (line->state != PBLK_LINESTATE_OPEN) {
1317                                 pblk_err(pblk, "bad ppa: line:%d,state:%d\n",
1318                                                         line->id, line->state);
1319                                 WARN_ON(1);
1320                                 spin_unlock(&line->lock);
1321                                 return -EINVAL;
1322                         }
1323                         spin_unlock(&line->lock);
1324                 }
1325         }
1326
1327         return 0;
1328 }
1329 #endif
1330
1331 static inline int pblk_boundary_paddr_checks(struct pblk *pblk, u64 paddr)
1332 {
1333         struct pblk_line_meta *lm = &pblk->lm;
1334
1335         if (paddr > lm->sec_per_line)
1336                 return 1;
1337
1338         return 0;
1339 }
1340
1341 static inline unsigned int pblk_get_bi_idx(struct bio *bio)
1342 {
1343         return bio->bi_iter.bi_idx;
1344 }
1345
1346 static inline sector_t pblk_get_lba(struct bio *bio)
1347 {
1348         return bio->bi_iter.bi_sector / NR_PHY_IN_LOG;
1349 }
1350
1351 static inline unsigned int pblk_get_secs(struct bio *bio)
1352 {
1353         return  bio->bi_iter.bi_size / PBLK_EXPOSED_PAGE_SIZE;
1354 }
1355
1356 static inline void pblk_setup_uuid(struct pblk *pblk)
1357 {
1358         uuid_le uuid;
1359
1360         uuid_le_gen(&uuid);
1361         memcpy(pblk->instance_uuid, uuid.b, 16);
1362 }
1363
1364 static inline char *pblk_disk_name(struct pblk *pblk)
1365 {
1366         struct gendisk *disk = pblk->disk;
1367
1368         return disk->disk_name;
1369 }
1370 #endif /* PBLK_H_ */