drivers/lightnvm/core.c

   1 /*
   2  * Copyright (C) 2015 IT University of Copenhagen. All rights reserved.
   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  * You should have received a copy of the GNU General Public License
  15  * along with this program; see the file COPYING.  If not, write to
  16  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
  17  * USA.
  18  *
  19  */
  20
  21 #include <linux/blkdev.h>
  22 #include <linux/blk-mq.h>
  23 #include <linux/list.h>
  24 #include <linux/types.h>
  25 #include <linux/sem.h>
  26 #include <linux/bitmap.h>
  27 #include <linux/module.h>
  28 #include <linux/miscdevice.h>
  29 #include <linux/lightnvm.h>
  30 #include <linux/sched/sysctl.h>
  31 #include <uapi/linux/lightnvm.h>
  32
  33 static LIST_HEAD(nvm_targets);
  34 static LIST_HEAD(nvm_mgrs);
  35 static LIST_HEAD(nvm_devices);
  36 static DECLARE_RWSEM(nvm_lock);
  37
  38 static struct nvm_tgt_type *nvm_find_target_type(const char *name)
  39 {
  40         struct nvm_tgt_type *tt;
  41
  42         list_for_each_entry(tt, &nvm_targets, list)
  43                 if (!strcmp(name, tt->name))
  44                         return tt;
  45
  46         return NULL;
  47 }
  48
  49 int nvm_register_target(struct nvm_tgt_type *tt)
  50 {
  51         int ret = 0;
  52
  53         down_write(&nvm_lock);
  54         if (nvm_find_target_type(tt->name))
  55                 ret = -EEXIST;
  56         else
  57                 list_add(&tt->list, &nvm_targets);
  58         up_write(&nvm_lock);
  59
  60         return ret;
  61 }
  62 EXPORT_SYMBOL(nvm_register_target);
  63
  64 void nvm_unregister_target(struct nvm_tgt_type *tt)
  65 {
  66         if (!tt)
  67                 return;
  68
  69         down_write(&nvm_lock);
  70         list_del(&tt->list);
  71         up_write(&nvm_lock);
  72 }
  73 EXPORT_SYMBOL(nvm_unregister_target);
  74
  75 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
  76                                                         dma_addr_t *dma_handler)
  77 {
  78         return dev->ops->dev_dma_alloc(dev, dev->ppalist_pool, mem_flags,
  79                                                                 dma_handler);
  80 }
  81 EXPORT_SYMBOL(nvm_dev_dma_alloc);
  82
  83 void nvm_dev_dma_free(struct nvm_dev *dev, void *ppa_list,
  84                                                         dma_addr_t dma_handler)
  85 {
  86         dev->ops->dev_dma_free(dev->ppalist_pool, ppa_list, dma_handler);
  87 }
  88 EXPORT_SYMBOL(nvm_dev_dma_free);
  89
  90 static struct nvmm_type *nvm_find_mgr_type(const char *name)
  91 {
  92         struct nvmm_type *mt;
  93
  94         list_for_each_entry(mt, &nvm_mgrs, list)
  95                 if (!strcmp(name, mt->name))
  96                         return mt;
  97
  98         return NULL;
  99 }
 100
 101 struct nvmm_type *nvm_init_mgr(struct nvm_dev *dev)
 102 {
 103         struct nvmm_type *mt;
 104         int ret;
 105
 106         lockdep_assert_held(&nvm_lock);
 107
 108         list_for_each_entry(mt, &nvm_mgrs, list) {
 109                 if (strncmp(dev->sb.mmtype, mt->name, NVM_MMTYPE_LEN))
 110                         continue;
 111
 112                 ret = mt->register_mgr(dev);
 113                 if (ret < 0) {
 114                         pr_err("nvm: media mgr failed to init (%d) on dev %s\n",
 115                                                                 ret, dev->name);
 116                         return NULL; /* initialization failed */
 117                 } else if (ret > 0)
 118                         return mt;
 119         }
 120
 121         return NULL;
 122 }
 123
 124 int nvm_register_mgr(struct nvmm_type *mt)
 125 {
 126         struct nvm_dev *dev;
 127         int ret = 0;
 128
 129         down_write(&nvm_lock);
 130         if (nvm_find_mgr_type(mt->name)) {
 131                 ret = -EEXIST;
 132                 goto finish;
 133         } else {
 134                 list_add(&mt->list, &nvm_mgrs);
 135         }
 136
 137         /* try to register media mgr if any device have none configured */
 138         list_for_each_entry(dev, &nvm_devices, devices) {
 139                 if (dev->mt)
 140                         continue;
 141
 142                 dev->mt = nvm_init_mgr(dev);
 143         }
 144 finish:
 145         up_write(&nvm_lock);
 146
 147         return ret;
 148 }
 149 EXPORT_SYMBOL(nvm_register_mgr);
 150
 151 void nvm_unregister_mgr(struct nvmm_type *mt)
 152 {
 153         if (!mt)
 154                 return;
 155
 156         down_write(&nvm_lock);
 157         list_del(&mt->list);
 158         up_write(&nvm_lock);
 159 }
 160 EXPORT_SYMBOL(nvm_unregister_mgr);
 161
 162 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
 163 {
 164         struct nvm_dev *dev;
 165
 166         list_for_each_entry(dev, &nvm_devices, devices)
 167                 if (!strcmp(name, dev->name))
 168                         return dev;
 169
 170         return NULL;
 171 }
 172
 173 struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *dev, struct nvm_lun *lun,
 174                                                         unsigned long flags)
 175 {
 176         return dev->mt->get_blk_unlocked(dev, lun, flags);
 177 }
 178 EXPORT_SYMBOL(nvm_get_blk_unlocked);
 179
 180 /* Assumes that all valid pages have already been moved on release to bm */
 181 void nvm_put_blk_unlocked(struct nvm_dev *dev, struct nvm_block *blk)
 182 {
 183         return dev->mt->put_blk_unlocked(dev, blk);
 184 }
 185 EXPORT_SYMBOL(nvm_put_blk_unlocked);
 186
 187 struct nvm_block *nvm_get_blk(struct nvm_dev *dev, struct nvm_lun *lun,
 188                                                         unsigned long flags)
 189 {
 190         return dev->mt->get_blk(dev, lun, flags);
 191 }
 192 EXPORT_SYMBOL(nvm_get_blk);
 193
 194 /* Assumes that all valid pages have already been moved on release to bm */
 195 void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
 196 {
 197         return dev->mt->put_blk(dev, blk);
 198 }
 199 EXPORT_SYMBOL(nvm_put_blk);
 200
 201 int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
 202 {
 203         return dev->mt->submit_io(dev, rqd);
 204 }
 205 EXPORT_SYMBOL(nvm_submit_io);
 206
 207 int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk)
 208 {
 209         return dev->mt->erase_blk(dev, blk, 0);
 210 }
 211 EXPORT_SYMBOL(nvm_erase_blk);
 212
 213 void nvm_addr_to_generic_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
 214 {
 215         int i;
 216
 217         if (rqd->nr_pages > 1) {
 218                 for (i = 0; i < rqd->nr_pages; i++)
 219                         rqd->ppa_list[i] = dev_to_generic_addr(dev,
 220                                                         rqd->ppa_list[i]);
 221         } else {
 222                 rqd->ppa_addr = dev_to_generic_addr(dev, rqd->ppa_addr);
 223         }
 224 }
 225 EXPORT_SYMBOL(nvm_addr_to_generic_mode);
 226
 227 void nvm_generic_to_addr_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
 228 {
 229         int i;
 230
 231         if (rqd->nr_pages > 1) {
 232                 for (i = 0; i < rqd->nr_pages; i++)
 233                         rqd->ppa_list[i] = generic_to_dev_addr(dev,
 234                                                         rqd->ppa_list[i]);
 235         } else {
 236                 rqd->ppa_addr = generic_to_dev_addr(dev, rqd->ppa_addr);
 237         }
 238 }
 239 EXPORT_SYMBOL(nvm_generic_to_addr_mode);
 240
 241 int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
 242                                         struct ppa_addr *ppas, int nr_ppas)
 243 {
 244         int i, plane_cnt, pl_idx;
 245
 246         if (dev->plane_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
 247                 rqd->nr_pages = 1;
 248                 rqd->ppa_addr = ppas[0];
 249
 250                 return 0;
 251         }
 252
 253         plane_cnt = dev->plane_mode;
 254         rqd->nr_pages = plane_cnt * nr_ppas;
 255
 256         if (dev->ops->max_phys_sect < rqd->nr_pages)
 257                 return -EINVAL;
 258
 259         rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
 260         if (!rqd->ppa_list) {
 261                 pr_err("nvm: failed to allocate dma memory\n");
 262                 return -ENOMEM;
 263         }
 264
 265         for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
 266                 for (i = 0; i < nr_ppas; i++) {
 267                         ppas[i].g.pl = pl_idx;
 268                         rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppas[i];
 269                 }
 270         }
 271
 272         return 0;
 273 }
 274 EXPORT_SYMBOL(nvm_set_rqd_ppalist);
 275
 276 void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
 277 {
 278         if (!rqd->ppa_list)
 279                 return;
 280
 281         nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
 282 }
 283 EXPORT_SYMBOL(nvm_free_rqd_ppalist);
 284
 285 int nvm_erase_ppa(struct nvm_dev *dev, struct ppa_addr *ppas, int nr_ppas)
 286 {
 287         struct nvm_rq rqd;
 288         int ret;
 289
 290         if (!dev->ops->erase_block)
 291                 return 0;
 292
 293         memset(&rqd, 0, sizeof(struct nvm_rq));
 294
 295         ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas);
 296         if (ret)
 297                 return ret;
 298
 299         nvm_generic_to_addr_mode(dev, &rqd);
 300
 301         ret = dev->ops->erase_block(dev, &rqd);
 302
 303         nvm_free_rqd_ppalist(dev, &rqd);
 304
 305         return ret;
 306 }
 307 EXPORT_SYMBOL(nvm_erase_ppa);
 308
 309 void nvm_end_io(struct nvm_rq *rqd, int error)
 310 {
 311         rqd->error = error;
 312         rqd->end_io(rqd);
 313 }
 314 EXPORT_SYMBOL(nvm_end_io);
 315
 316 static void nvm_end_io_sync(struct nvm_rq *rqd)
 317 {
 318         struct completion *waiting = rqd->wait;
 319
 320         rqd->wait = NULL;
 321
 322         complete(waiting);
 323 }
 324
 325 int nvm_submit_ppa(struct nvm_dev *dev, struct ppa_addr *ppa, int nr_ppas,
 326                                 int opcode, int flags, void *buf, int len)
 327 {
 328         DECLARE_COMPLETION_ONSTACK(wait);
 329         struct nvm_rq rqd;
 330         struct bio *bio;
 331         int ret;
 332         unsigned long hang_check;
 333
 334         bio = bio_map_kern(dev->q, buf, len, GFP_KERNEL);
 335         if (IS_ERR_OR_NULL(bio))
 336                 return -ENOMEM;
 337
 338         memset(&rqd, 0, sizeof(struct nvm_rq));
 339         ret = nvm_set_rqd_ppalist(dev, &rqd, ppa, nr_ppas);
 340         if (ret) {
 341                 bio_put(bio);
 342                 return ret;
 343         }
 344
 345         rqd.opcode = opcode;
 346         rqd.bio = bio;
 347         rqd.wait = &wait;
 348         rqd.dev = dev;
 349         rqd.end_io = nvm_end_io_sync;
 350         rqd.flags = flags;
 351         nvm_generic_to_addr_mode(dev, &rqd);
 352
 353         ret = dev->ops->submit_io(dev, &rqd);
 354         if (ret) {
 355                 nvm_free_rqd_ppalist(dev, &rqd);
 356                 bio_put(bio);
 357                 return ret;
 358         }
 359
 360         /* Prevent hang_check timer from firing at us during very long I/O */
 361         hang_check = sysctl_hung_task_timeout_secs;
 362         if (hang_check)
 363                 while (!wait_for_completion_io_timeout(&wait, hang_check * (HZ/2)));
 364         else
 365                 wait_for_completion_io(&wait);
 366
 367         nvm_free_rqd_ppalist(dev, &rqd);
 368
 369         return rqd.error;
 370 }
 371 EXPORT_SYMBOL(nvm_submit_ppa);
 372
 373 static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
 374 {
 375         int i;
 376
 377         dev->lps_per_blk = dev->pgs_per_blk;
 378         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
 379         if (!dev->lptbl)
 380                 return -ENOMEM;
 381
 382         /* Just a linear array */
 383         for (i = 0; i < dev->lps_per_blk; i++)
 384                 dev->lptbl[i] = i;
 385
 386         return 0;
 387 }
 388
 389 static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
 390 {
 391         int i, p;
 392         struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
 393
 394         if (!mlc->num_pairs)
 395                 return 0;
 396
 397         dev->lps_per_blk = mlc->num_pairs;
 398         dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
 399         if (!dev->lptbl)
 400                 return -ENOMEM;
 401
 402         /* The lower page table encoding consists of a list of bytes, where each
 403          * has a lower and an upper half. The first half byte maintains the
 404          * increment value and every value after is an offset added to the
 405          * previous incrementation value */
 406         dev->lptbl[0] = mlc->pairs[0] & 0xF;
 407         for (i = 1; i < dev->lps_per_blk; i++) {
 408                 p = mlc->pairs[i >> 1];
 409                 if (i & 0x1) /* upper */
 410                         dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
 411                 else /* lower */
 412                         dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
 413         }
 414
 415         return 0;
 416 }
 417
 418 static int nvm_core_init(struct nvm_dev *dev)
 419 {
 420         struct nvm_id *id = &dev->identity;
 421         struct nvm_id_group *grp = &id->groups[0];
 422
 423         /* device values */
 424         dev->nr_chnls = grp->num_ch;
 425         dev->luns_per_chnl = grp->num_lun;
 426         dev->pgs_per_blk = grp->num_pg;
 427         dev->blks_per_lun = grp->num_blk;
 428         dev->nr_planes = grp->num_pln;
 429         dev->sec_size = grp->csecs;
 430         dev->oob_size = grp->sos;
 431         dev->sec_per_pg = grp->fpg_sz / grp->csecs;
 432         dev->mccap = grp->mccap;
 433         memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
 434
 435         dev->plane_mode = NVM_PLANE_SINGLE;
 436         dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
 437
 438         if (grp->mtype != 0) {
 439                 pr_err("nvm: memory type not supported\n");
 440                 return -EINVAL;
 441         }
 442
 443         switch (grp->fmtype) {
 444         case NVM_ID_FMTYPE_SLC:
 445                 if (nvm_init_slc_tbl(dev, grp))
 446                         return -ENOMEM;
 447                 break;
 448         case NVM_ID_FMTYPE_MLC:
 449                 if (nvm_init_mlc_tbl(dev, grp))
 450                         return -ENOMEM;
 451                 break;
 452         default:
 453                 pr_err("nvm: flash type not supported\n");
 454                 return -EINVAL;
 455         }
 456
 457         if (!dev->lps_per_blk)
 458                 pr_info("nvm: lower page programming table missing\n");
 459
 460         if (grp->mpos & 0x020202)
 461                 dev->plane_mode = NVM_PLANE_DOUBLE;
 462         if (grp->mpos & 0x040404)
 463                 dev->plane_mode = NVM_PLANE_QUAD;
 464
 465         /* calculated values */
 466         dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
 467         dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
 468         dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
 469         dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
 470
 471         dev->total_secs = dev->nr_luns * dev->sec_per_lun;
 472         dev->lun_map = kcalloc(BITS_TO_LONGS(dev->nr_luns),
 473                                         sizeof(unsigned long), GFP_KERNEL);
 474         if (!dev->lun_map)
 475                 return -ENOMEM;
 476         INIT_LIST_HEAD(&dev->online_targets);
 477         mutex_init(&dev->mlock);
 478         spin_lock_init(&dev->lock);
 479
 480         return 0;
 481 }
 482
 483 static void nvm_free(struct nvm_dev *dev)
 484 {
 485         if (!dev)
 486                 return;
 487
 488         if (dev->mt)
 489                 dev->mt->unregister_mgr(dev);
 490
 491         kfree(dev->lptbl);
 492 }
 493
 494 static int nvm_init(struct nvm_dev *dev)
 495 {
 496         int ret = -EINVAL;
 497
 498         if (!dev->q || !dev->ops)
 499                 return ret;
 500
 501         if (dev->ops->identity(dev, &dev->identity)) {
 502                 pr_err("nvm: device could not be identified\n");
 503                 goto err;
 504         }
 505
 506         pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
 507                         dev->identity.ver_id, dev->identity.vmnt,
 508                                                         dev->identity.cgrps);
 509
 510         if (dev->identity.ver_id != 1) {
 511                 pr_err("nvm: device not supported by kernel.");
 512                 goto err;
 513         }
 514
 515         if (dev->identity.cgrps != 1) {
 516                 pr_err("nvm: only one group configuration supported.");
 517                 goto err;
 518         }
 519
 520         ret = nvm_core_init(dev);
 521         if (ret) {
 522                 pr_err("nvm: could not initialize core structures.\n");
 523                 goto err;
 524         }
 525
 526         pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
 527                         dev->name, dev->sec_per_pg, dev->nr_planes,
 528                         dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
 529                         dev->nr_chnls);
 530         return 0;
 531 err:
 532         pr_err("nvm: failed to initialize nvm\n");
 533         return ret;
 534 }
 535
 536 static void nvm_exit(struct nvm_dev *dev)
 537 {
 538         if (dev->ppalist_pool)
 539                 dev->ops->destroy_dma_pool(dev->ppalist_pool);
 540         nvm_free(dev);
 541
 542         pr_info("nvm: successfully unloaded\n");
 543 }
 544
 545 int nvm_register(struct request_queue *q, char *disk_name,
 546                                                         struct nvm_dev_ops *ops)
 547 {
 548         struct nvm_dev *dev;
 549         int ret;
 550
 551         if (!ops->identity)
 552                 return -EINVAL;
 553
 554         dev = kzalloc(sizeof(struct nvm_dev), GFP_KERNEL);
 555         if (!dev)
 556                 return -ENOMEM;
 557
 558         dev->q = q;
 559         dev->ops = ops;
 560         strncpy(dev->name, disk_name, DISK_NAME_LEN);
 561
 562         ret = nvm_init(dev);
 563         if (ret)
 564                 goto err_init;
 565
 566         if (dev->ops->max_phys_sect > 256) {
 567                 pr_info("nvm: max sectors supported is 256.\n");
 568                 ret = -EINVAL;
 569                 goto err_init;
 570         }
 571
 572         if (dev->ops->max_phys_sect > 1) {
 573                 dev->ppalist_pool = dev->ops->create_dma_pool(dev, "ppalist");
 574                 if (!dev->ppalist_pool) {
 575                         pr_err("nvm: could not create ppa pool\n");
 576                         ret = -ENOMEM;
 577                         goto err_init;
 578                 }
 579         }
 580
 581         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
 582                 ret = nvm_get_sysblock(dev, &dev->sb);
 583                 if (!ret)
 584                         pr_err("nvm: device not initialized.\n");
 585                 else if (ret < 0)
 586                         pr_err("nvm: err (%d) on device initialization\n", ret);
 587         }
 588
 589         /* register device with a supported media manager */
 590         down_write(&nvm_lock);
 591         if (ret > 0)
 592                 dev->mt = nvm_init_mgr(dev);
 593         list_add(&dev->devices, &nvm_devices);
 594         up_write(&nvm_lock);
 595
 596         return 0;
 597 err_init:
 598         kfree(dev->lun_map);
 599         kfree(dev);
 600         return ret;
 601 }
 602 EXPORT_SYMBOL(nvm_register);
 603
 604 void nvm_unregister(char *disk_name)
 605 {
 606         struct nvm_dev *dev;
 607
 608         down_write(&nvm_lock);
 609         dev = nvm_find_nvm_dev(disk_name);
 610         if (!dev) {
 611                 pr_err("nvm: could not find device %s to unregister\n",
 612                                                                 disk_name);
 613                 up_write(&nvm_lock);
 614                 return;
 615         }
 616
 617         list_del(&dev->devices);
 618         up_write(&nvm_lock);
 619
 620         nvm_exit(dev);
 621         kfree(dev->lun_map);
 622         kfree(dev);
 623 }
 624 EXPORT_SYMBOL(nvm_unregister);
 625
 626 static const struct block_device_operations nvm_fops = {
 627         .owner          = THIS_MODULE,
 628 };
 629
 630 static int nvm_create_target(struct nvm_dev *dev,
 631                                                 struct nvm_ioctl_create *create)
 632 {
 633         struct nvm_ioctl_create_simple *s = &create->conf.s;
 634         struct request_queue *tqueue;
 635         struct gendisk *tdisk;
 636         struct nvm_tgt_type *tt;
 637         struct nvm_target *t;
 638         void *targetdata;
 639
 640         if (!dev->mt) {
 641                 pr_info("nvm: device has no media manager registered.\n");
 642                 return -ENODEV;
 643         }
 644
 645         down_write(&nvm_lock);
 646         tt = nvm_find_target_type(create->tgttype);
 647         if (!tt) {
 648                 pr_err("nvm: target type %s not found\n", create->tgttype);
 649                 up_write(&nvm_lock);
 650                 return -EINVAL;
 651         }
 652
 653         list_for_each_entry(t, &dev->online_targets, list) {
 654                 if (!strcmp(create->tgtname, t->disk->disk_name)) {
 655                         pr_err("nvm: target name already exists.\n");
 656                         up_write(&nvm_lock);
 657                         return -EINVAL;
 658                 }
 659         }
 660         up_write(&nvm_lock);
 661
 662         t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
 663         if (!t)
 664                 return -ENOMEM;
 665
 666         tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
 667         if (!tqueue)
 668                 goto err_t;
 669         blk_queue_make_request(tqueue, tt->make_rq);
 670
 671         tdisk = alloc_disk(0);
 672         if (!tdisk)
 673                 goto err_queue;
 674
 675         sprintf(tdisk->disk_name, "%s", create->tgtname);
 676         tdisk->flags = GENHD_FL_EXT_DEVT;
 677         tdisk->major = 0;
 678         tdisk->first_minor = 0;
 679         tdisk->fops = &nvm_fops;
 680         tdisk->queue = tqueue;
 681
 682         targetdata = tt->init(dev, tdisk, s->lun_begin, s->lun_end);
 683         if (IS_ERR(targetdata))
 684                 goto err_init;
 685
 686         tdisk->private_data = targetdata;
 687         tqueue->queuedata = targetdata;
 688
 689         blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
 690
 691         set_capacity(tdisk, tt->capacity(targetdata));
 692         add_disk(tdisk);
 693
 694         t->type = tt;
 695         t->disk = tdisk;
 696
 697         down_write(&nvm_lock);
 698         list_add_tail(&t->list, &dev->online_targets);
 699         up_write(&nvm_lock);
 700
 701         return 0;
 702 err_init:
 703         put_disk(tdisk);
 704 err_queue:
 705         blk_cleanup_queue(tqueue);
 706 err_t:
 707         kfree(t);
 708         return -ENOMEM;
 709 }
 710
 711 static void nvm_remove_target(struct nvm_target *t)
 712 {
 713         struct nvm_tgt_type *tt = t->type;
 714         struct gendisk *tdisk = t->disk;
 715         struct request_queue *q = tdisk->queue;
 716
 717         lockdep_assert_held(&nvm_lock);
 718
 719         del_gendisk(tdisk);
 720         blk_cleanup_queue(q);
 721
 722         if (tt->exit)
 723                 tt->exit(tdisk->private_data);
 724
 725         put_disk(tdisk);
 726
 727         list_del(&t->list);
 728         kfree(t);
 729 }
 730
 731 static int __nvm_configure_create(struct nvm_ioctl_create *create)
 732 {
 733         struct nvm_dev *dev;
 734         struct nvm_ioctl_create_simple *s;
 735
 736         down_write(&nvm_lock);
 737         dev = nvm_find_nvm_dev(create->dev);
 738         up_write(&nvm_lock);
 739         if (!dev) {
 740                 pr_err("nvm: device not found\n");
 741                 return -EINVAL;
 742         }
 743
 744         if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
 745                 pr_err("nvm: config type not valid\n");
 746                 return -EINVAL;
 747         }
 748         s = &create->conf.s;
 749
 750         if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
 751                 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
 752                         s->lun_begin, s->lun_end, dev->nr_luns);
 753                 return -EINVAL;
 754         }
 755
 756         return nvm_create_target(dev, create);
 757 }
 758
 759 static int __nvm_configure_remove(struct nvm_ioctl_remove *remove)
 760 {
 761         struct nvm_target *t = NULL;
 762         struct nvm_dev *dev;
 763         int ret = -1;
 764
 765         down_write(&nvm_lock);
 766         list_for_each_entry(dev, &nvm_devices, devices)
 767                 list_for_each_entry(t, &dev->online_targets, list) {
 768                         if (!strcmp(remove->tgtname, t->disk->disk_name)) {
 769                                 nvm_remove_target(t);
 770                                 ret = 0;
 771                                 break;
 772                         }
 773                 }
 774         up_write(&nvm_lock);
 775
 776         if (ret) {
 777                 pr_err("nvm: target \"%s\" doesn't exist.\n", remove->tgtname);
 778                 return -EINVAL;
 779         }
 780
 781         return 0;
 782 }
 783
 784 #ifdef CONFIG_NVM_DEBUG
 785 static int nvm_configure_show(const char *val)
 786 {
 787         struct nvm_dev *dev;
 788         char opcode, devname[DISK_NAME_LEN];
 789         int ret;
 790
 791         ret = sscanf(val, "%c %32s", &opcode, devname);
 792         if (ret != 2) {
 793                 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
 794                 return -EINVAL;
 795         }
 796
 797         down_write(&nvm_lock);
 798         dev = nvm_find_nvm_dev(devname);
 799         up_write(&nvm_lock);
 800         if (!dev) {
 801                 pr_err("nvm: device not found\n");
 802                 return -EINVAL;
 803         }
 804
 805         if (!dev->mt)
 806                 return 0;
 807
 808         dev->mt->lun_info_print(dev);
 809
 810         return 0;
 811 }
 812
 813 static int nvm_configure_remove(const char *val)
 814 {
 815         struct nvm_ioctl_remove remove;
 816         char opcode;
 817         int ret;
 818
 819         ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
 820         if (ret != 2) {
 821                 pr_err("nvm: invalid command. Use \"d targetname\".\n");
 822                 return -EINVAL;
 823         }
 824
 825         remove.flags = 0;
 826
 827         return __nvm_configure_remove(&remove);
 828 }
 829
 830 static int nvm_configure_create(const char *val)
 831 {
 832         struct nvm_ioctl_create create;
 833         char opcode;
 834         int lun_begin, lun_end, ret;
 835
 836         ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
 837                                                 create.tgtname, create.tgttype,
 838                                                 &lun_begin, &lun_end);
 839         if (ret != 6) {
 840                 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
 841                 return -EINVAL;
 842         }
 843
 844         create.flags = 0;
 845         create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
 846         create.conf.s.lun_begin = lun_begin;
 847         create.conf.s.lun_end = lun_end;
 848
 849         return __nvm_configure_create(&create);
 850 }
 851
 852
 853 /* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
 854 static int nvm_configure_by_str_event(const char *val,
 855                                         const struct kernel_param *kp)
 856 {
 857         char opcode;
 858         int ret;
 859
 860         ret = sscanf(val, "%c", &opcode);
 861         if (ret != 1) {
 862                 pr_err("nvm: string must have the format of \"cmd ...\"\n");
 863                 return -EINVAL;
 864         }
 865
 866         switch (opcode) {
 867         case 'a':
 868                 return nvm_configure_create(val);
 869         case 'd':
 870                 return nvm_configure_remove(val);
 871         case 's':
 872                 return nvm_configure_show(val);
 873         default:
 874                 pr_err("nvm: invalid command\n");
 875                 return -EINVAL;
 876         }
 877
 878         return 0;
 879 }
 880
 881 static int nvm_configure_get(char *buf, const struct kernel_param *kp)
 882 {
 883         int sz;
 884         struct nvm_dev *dev;
 885
 886         sz = sprintf(buf, "available devices:\n");
 887         down_write(&nvm_lock);
 888         list_for_each_entry(dev, &nvm_devices, devices) {
 889                 if (sz > 4095 - DISK_NAME_LEN - 2)
 890                         break;
 891                 sz += sprintf(buf + sz, " %32s\n", dev->name);
 892         }
 893         up_write(&nvm_lock);
 894
 895         return sz;
 896 }
 897
 898 static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
 899         .set    = nvm_configure_by_str_event,
 900         .get    = nvm_configure_get,
 901 };
 902
 903 #undef MODULE_PARAM_PREFIX
 904 #define MODULE_PARAM_PREFIX     "lnvm."
 905
 906 module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
 907                                                                         0644);
 908
 909 #endif /* CONFIG_NVM_DEBUG */
 910
 911 static long nvm_ioctl_info(struct file *file, void __user *arg)
 912 {
 913         struct nvm_ioctl_info *info;
 914         struct nvm_tgt_type *tt;
 915         int tgt_iter = 0;
 916
 917         if (!capable(CAP_SYS_ADMIN))
 918                 return -EPERM;
 919
 920         info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
 921         if (IS_ERR(info))
 922                 return -EFAULT;
 923
 924         info->version[0] = NVM_VERSION_MAJOR;
 925         info->version[1] = NVM_VERSION_MINOR;
 926         info->version[2] = NVM_VERSION_PATCH;
 927
 928         down_write(&nvm_lock);
 929         list_for_each_entry(tt, &nvm_targets, list) {
 930                 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
 931
 932                 tgt->version[0] = tt->version[0];
 933                 tgt->version[1] = tt->version[1];
 934                 tgt->version[2] = tt->version[2];
 935                 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
 936
 937                 tgt_iter++;
 938         }
 939
 940         info->tgtsize = tgt_iter;
 941         up_write(&nvm_lock);
 942
 943         if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
 944                 kfree(info);
 945                 return -EFAULT;
 946         }
 947
 948         kfree(info);
 949         return 0;
 950 }
 951
 952 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
 953 {
 954         struct nvm_ioctl_get_devices *devices;
 955         struct nvm_dev *dev;
 956         int i = 0;
 957
 958         if (!capable(CAP_SYS_ADMIN))
 959                 return -EPERM;
 960
 961         devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
 962         if (!devices)
 963                 return -ENOMEM;
 964
 965         down_write(&nvm_lock);
 966         list_for_each_entry(dev, &nvm_devices, devices) {
 967                 struct nvm_ioctl_device_info *info = &devices->info[i];
 968
 969                 sprintf(info->devname, "%s", dev->name);
 970                 if (dev->mt) {
 971                         info->bmversion[0] = dev->mt->version[0];
 972                         info->bmversion[1] = dev->mt->version[1];
 973                         info->bmversion[2] = dev->mt->version[2];
 974                         sprintf(info->bmname, "%s", dev->mt->name);
 975                 } else {
 976                         sprintf(info->bmname, "none");
 977                 }
 978
 979                 i++;
 980                 if (i > 31) {
 981                         pr_err("nvm: max 31 devices can be reported.\n");
 982                         break;
 983                 }
 984         }
 985         up_write(&nvm_lock);
 986
 987         devices->nr_devices = i;
 988
 989         if (copy_to_user(arg, devices,
 990                          sizeof(struct nvm_ioctl_get_devices))) {
 991                 kfree(devices);
 992                 return -EFAULT;
 993         }
 994
 995         kfree(devices);
 996         return 0;
 997 }
 998
 999 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1000 {
1001         struct nvm_ioctl_create create;
1002
1003         if (!capable(CAP_SYS_ADMIN))
1004                 return -EPERM;
1005
1006         if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1007                 return -EFAULT;
1008
1009         create.dev[DISK_NAME_LEN - 1] = '\0';
1010         create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1011         create.tgtname[DISK_NAME_LEN - 1] = '\0';
1012
1013         if (create.flags != 0) {
1014                 pr_err("nvm: no flags supported\n");
1015                 return -EINVAL;
1016         }
1017
1018         return __nvm_configure_create(&create);
1019 }
1020
1021 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1022 {
1023         struct nvm_ioctl_remove remove;
1024
1025         if (!capable(CAP_SYS_ADMIN))
1026                 return -EPERM;
1027
1028         if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1029                 return -EFAULT;
1030
1031         remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1032
1033         if (remove.flags != 0) {
1034                 pr_err("nvm: no flags supported\n");
1035                 return -EINVAL;
1036         }
1037
1038         return __nvm_configure_remove(&remove);
1039 }
1040
1041 static void nvm_setup_nvm_sb_info(struct nvm_sb_info *info)
1042 {
1043         info->seqnr = 1;
1044         info->erase_cnt = 0;
1045         info->version = 1;
1046 }
1047
1048 static long __nvm_ioctl_dev_init(struct nvm_ioctl_dev_init *init)
1049 {
1050         struct nvm_dev *dev;
1051         struct nvm_sb_info info;
1052         int ret;
1053
1054         down_write(&nvm_lock);
1055         dev = nvm_find_nvm_dev(init->dev);
1056         up_write(&nvm_lock);
1057         if (!dev) {
1058                 pr_err("nvm: device not found\n");
1059                 return -EINVAL;
1060         }
1061
1062         nvm_setup_nvm_sb_info(&info);
1063
1064         strncpy(info.mmtype, init->mmtype, NVM_MMTYPE_LEN);
1065         info.fs_ppa.ppa = -1;
1066
1067         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
1068                 ret = nvm_init_sysblock(dev, &info);
1069                 if (ret)
1070                         return ret;
1071         }
1072
1073         memcpy(&dev->sb, &info, sizeof(struct nvm_sb_info));
1074
1075         down_write(&nvm_lock);
1076         dev->mt = nvm_init_mgr(dev);
1077         up_write(&nvm_lock);
1078
1079         return 0;
1080 }
1081
1082 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1083 {
1084         struct nvm_ioctl_dev_init init;
1085
1086         if (!capable(CAP_SYS_ADMIN))
1087                 return -EPERM;
1088
1089         if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1090                 return -EFAULT;
1091
1092         if (init.flags != 0) {
1093                 pr_err("nvm: no flags supported\n");
1094                 return -EINVAL;
1095         }
1096
1097         init.dev[DISK_NAME_LEN - 1] = '\0';
1098
1099         return __nvm_ioctl_dev_init(&init);
1100 }
1101
1102 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1103 {
1104         struct nvm_ioctl_dev_factory fact;
1105         struct nvm_dev *dev;
1106
1107         if (!capable(CAP_SYS_ADMIN))
1108                 return -EPERM;
1109
1110         if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1111                 return -EFAULT;
1112
1113         fact.dev[DISK_NAME_LEN - 1] = '\0';
1114
1115         if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1116                 return -EINVAL;
1117
1118         down_write(&nvm_lock);
1119         dev = nvm_find_nvm_dev(fact.dev);
1120         up_write(&nvm_lock);
1121         if (!dev) {
1122                 pr_err("nvm: device not found\n");
1123                 return -EINVAL;
1124         }
1125
1126         if (dev->mt) {
1127                 dev->mt->unregister_mgr(dev);
1128                 dev->mt = NULL;
1129         }
1130
1131         if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT)
1132                 return nvm_dev_factory(dev, fact.flags);
1133
1134         return 0;
1135 }
1136
1137 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1138 {
1139         void __user *argp = (void __user *)arg;
1140
1141         switch (cmd) {
1142         case NVM_INFO:
1143                 return nvm_ioctl_info(file, argp);
1144         case NVM_GET_DEVICES:
1145                 return nvm_ioctl_get_devices(file, argp);
1146         case NVM_DEV_CREATE:
1147                 return nvm_ioctl_dev_create(file, argp);
1148         case NVM_DEV_REMOVE:
1149                 return nvm_ioctl_dev_remove(file, argp);
1150         case NVM_DEV_INIT:
1151                 return nvm_ioctl_dev_init(file, argp);
1152         case NVM_DEV_FACTORY:
1153                 return nvm_ioctl_dev_factory(file, argp);
1154         }
1155         return 0;
1156 }
1157
1158 static const struct file_operations _ctl_fops = {
1159         .open = nonseekable_open,
1160         .unlocked_ioctl = nvm_ctl_ioctl,
1161         .owner = THIS_MODULE,
1162         .llseek  = noop_llseek,
1163 };
1164
1165 static struct miscdevice _nvm_misc = {
1166         .minor          = MISC_DYNAMIC_MINOR,
1167         .name           = "lightnvm",
1168         .nodename       = "lightnvm/control",
1169         .fops           = &_ctl_fops,
1170 };
1171
1172 MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
1173
1174 static int __init nvm_mod_init(void)
1175 {
1176         int ret;
1177
1178         ret = misc_register(&_nvm_misc);
1179         if (ret)
1180                 pr_err("nvm: misc_register failed for control device");
1181
1182         return ret;
1183 }
1184
1185 static void __exit nvm_mod_exit(void)
1186 {
1187         misc_deregister(&_nvm_misc);
1188 }
1189
1190 MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
1191 MODULE_LICENSE("GPL v2");
1192 MODULE_VERSION("0.1");
1193 module_init(nvm_mod_init);
1194 module_exit(nvm_mod_exit);