drivers/lightnvm/rrpc.h

   1 /*
   2  * Copyright (C) 2015 IT University of Copenhagen
   3  * Initial release: Matias Bjorling <m@bjorling.me>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License version
   7  * 2 as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * Implementation of a Round-robin page-based Hybrid FTL for Open-channel SSDs.
  15  */
  16
  17 #ifndef RRPC_H_
  18 #define RRPC_H_
  19
  20 #include <linux/blkdev.h>
  21 #include <linux/blk-mq.h>
  22 #include <linux/bio.h>
  23 #include <linux/module.h>
  24 #include <linux/kthread.h>
  25 #include <linux/vmalloc.h>
  26
  27 #include <linux/lightnvm.h>
  28
  29 /* Run only GC if less than 1/X blocks are free */
  30 #define GC_LIMIT_INVERSE 10
  31 #define GC_TIME_SECS 100
  32
  33 #define RRPC_SECTOR (512)
  34 #define RRPC_EXPOSED_PAGE_SIZE (4096)
  35
  36 #define NR_PHY_IN_LOG (RRPC_EXPOSED_PAGE_SIZE / RRPC_SECTOR)
  37
  38 struct rrpc_inflight {
  39         struct list_head reqs;
  40         spinlock_t lock;
  41 };
  42
  43 struct rrpc_inflight_rq {
  44         struct list_head list;
  45         sector_t l_start;
  46         sector_t l_end;
  47 };
  48
  49 struct rrpc_rq {
  50         struct rrpc_inflight_rq inflight_rq;
  51         struct rrpc_addr *addr;
  52         unsigned long flags;
  53 };
  54
  55 struct rrpc_block {
  56         struct nvm_block *parent;
  57         struct rrpc_lun *rlun;
  58         struct list_head prio;
  59
  60 #define MAX_INVALID_PAGES_STORAGE 8
  61         /* Bitmap for invalid page intries */
  62         unsigned long invalid_pages[MAX_INVALID_PAGES_STORAGE];
  63         /* points to the next writable page within a block */
  64         unsigned int next_page;
  65         /* number of pages that are invalid, wrt host page size */
  66         unsigned int nr_invalid_pages;
  67
  68         spinlock_t lock;
  69         atomic_t data_cmnt_size; /* data pages committed to stable storage */
  70 };
  71
  72 struct rrpc_lun {
  73         struct rrpc *rrpc;
  74         struct nvm_lun *parent;
  75         struct rrpc_block *cur, *gc_cur;
  76         struct rrpc_block *blocks;      /* Reference to block allocation */
  77
  78         struct list_head prio_list;     /* Blocks that may be GC'ed */
  79
  80         struct work_struct ws_gc;
  81
  82         spinlock_t lock;
  83 };
  84
  85 struct rrpc {
  86         /* instance must be kept in top to resolve rrpc in unprep */
  87         struct nvm_tgt_instance instance;
  88
  89         struct nvm_dev *dev;
  90         struct gendisk *disk;
  91
  92         sector_t soffset; /* logical sector offset */
  93         u64 poffset; /* physical page offset */
  94         int lun_offset;
  95
  96         int nr_luns;
  97         struct rrpc_lun *luns;
  98
  99         /* calculated values */
 100         unsigned long long nr_sects;
 101         unsigned long total_blocks;
 102
 103         /* Write strategy variables. Move these into each for structure for each
 104          * strategy
 105          */
 106         atomic_t next_lun; /* Whenever a page is written, this is updated
 107                             * to point to the next write lun
 108                             */
 109
 110         spinlock_t bio_lock;
 111         struct bio_list requeue_bios;
 112         struct work_struct ws_requeue;
 113
 114         /* Simple translation map of logical addresses to physical addresses.
 115          * The logical addresses is known by the host system, while the physical
 116          * addresses are used when writing to the disk block device.
 117          */
 118         struct rrpc_addr *trans_map;
 119         /* also store a reverse map for garbage collection */
 120         struct rrpc_rev_addr *rev_trans_map;
 121         spinlock_t rev_lock;
 122
 123         struct rrpc_inflight inflights;
 124
 125         mempool_t *addr_pool;
 126         mempool_t *page_pool;
 127         mempool_t *gcb_pool;
 128         mempool_t *rq_pool;
 129
 130         struct timer_list gc_timer;
 131         struct workqueue_struct *krqd_wq;
 132         struct workqueue_struct *kgc_wq;
 133 };
 134
 135 struct rrpc_block_gc {
 136         struct rrpc *rrpc;
 137         struct rrpc_block *rblk;
 138         struct work_struct ws_gc;
 139 };
 140
 141 /* Logical to physical mapping */
 142 struct rrpc_addr {
 143         u64 addr;
 144         struct rrpc_block *rblk;
 145 };
 146
 147 /* Physical to logical mapping */
 148 struct rrpc_rev_addr {
 149         u64 addr;
 150 };
 151
 152 static inline struct rrpc_block *rrpc_get_rblk(struct rrpc_lun *rlun,
 153                                                                 int blk_id)
 154 {
 155         struct rrpc *rrpc = rlun->rrpc;
 156         int lun_blk = blk_id % rrpc->dev->blks_per_lun;
 157
 158         return &rlun->blocks[lun_blk];
 159 }
 160
 161 static inline sector_t rrpc_get_laddr(struct bio *bio)
 162 {
 163         return bio->bi_iter.bi_sector / NR_PHY_IN_LOG;
 164 }
 165
 166 static inline unsigned int rrpc_get_pages(struct bio *bio)
 167 {
 168         return  bio->bi_iter.bi_size / RRPC_EXPOSED_PAGE_SIZE;
 169 }
 170
 171 static inline sector_t rrpc_get_sector(sector_t laddr)
 172 {
 173         return laddr * NR_PHY_IN_LOG;
 174 }
 175
 176 static inline int request_intersects(struct rrpc_inflight_rq *r,
 177                                 sector_t laddr_start, sector_t laddr_end)
 178 {
 179         return (laddr_end >= r->l_start) && (laddr_start <= r->l_end);
 180 }
 181
 182 static int __rrpc_lock_laddr(struct rrpc *rrpc, sector_t laddr,
 183                              unsigned int pages, struct rrpc_inflight_rq *r)
 184 {
 185         sector_t laddr_end = laddr + pages - 1;
 186         struct rrpc_inflight_rq *rtmp;
 187
 188         WARN_ON(irqs_disabled());
 189
 190         spin_lock_irq(&rrpc->inflights.lock);
 191         list_for_each_entry(rtmp, &rrpc->inflights.reqs, list) {
 192                 if (unlikely(request_intersects(rtmp, laddr, laddr_end))) {
 193                         /* existing, overlapping request, come back later */
 194                         spin_unlock_irq(&rrpc->inflights.lock);
 195                         return 1;
 196                 }
 197         }
 198
 199         r->l_start = laddr;
 200         r->l_end = laddr_end;
 201
 202         list_add_tail(&r->list, &rrpc->inflights.reqs);
 203         spin_unlock_irq(&rrpc->inflights.lock);
 204         return 0;
 205 }
 206
 207 static inline int rrpc_lock_laddr(struct rrpc *rrpc, sector_t laddr,
 208                                  unsigned int pages,
 209                                  struct rrpc_inflight_rq *r)
 210 {
 211         BUG_ON((laddr + pages) > rrpc->nr_sects);
 212
 213         return __rrpc_lock_laddr(rrpc, laddr, pages, r);
 214 }
 215
 216 static inline struct rrpc_inflight_rq *rrpc_get_inflight_rq(struct nvm_rq *rqd)
 217 {
 218         struct rrpc_rq *rrqd = nvm_rq_to_pdu(rqd);
 219
 220         return &rrqd->inflight_rq;
 221 }
 222
 223 static inline int rrpc_lock_rq(struct rrpc *rrpc, struct bio *bio,
 224                                                         struct nvm_rq *rqd)
 225 {
 226         sector_t laddr = rrpc_get_laddr(bio);
 227         unsigned int pages = rrpc_get_pages(bio);
 228         struct rrpc_inflight_rq *r = rrpc_get_inflight_rq(rqd);
 229
 230         return rrpc_lock_laddr(rrpc, laddr, pages, r);
 231 }
 232
 233 static inline void rrpc_unlock_laddr(struct rrpc *rrpc,
 234                                                 struct rrpc_inflight_rq *r)
 235 {
 236         unsigned long flags;
 237
 238         spin_lock_irqsave(&rrpc->inflights.lock, flags);
 239         list_del_init(&r->list);
 240         spin_unlock_irqrestore(&rrpc->inflights.lock, flags);
 241 }
 242
 243 static inline void rrpc_unlock_rq(struct rrpc *rrpc, struct nvm_rq *rqd)
 244 {
 245         struct rrpc_inflight_rq *r = rrpc_get_inflight_rq(rqd);
 246         uint8_t pages = rqd->nr_ppas;
 247
 248         BUG_ON((r->l_start + pages) > rrpc->nr_sects);
 249
 250         rrpc_unlock_laddr(rrpc, r);
 251 }
 252
 253 #endif /* RRPC_H_ */