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/list.h>
  22 #include <linux/types.h>
  23 #include <linux/sem.h>
  24 #include <linux/bitmap.h>
  25 #include <linux/module.h>
  26 #include <linux/moduleparam.h>
  27 #include <linux/miscdevice.h>
  28 #include <linux/lightnvm.h>
  29 #include <linux/sched/sysctl.h>
  30
  31 static LIST_HEAD(nvm_tgt_types);
  32 static DECLARE_RWSEM(nvm_tgtt_lock);
  33 static LIST_HEAD(nvm_devices);
  34 static DECLARE_RWSEM(nvm_lock);
  35
  36 /* Map between virtual and physical channel and lun */
  37 struct nvm_ch_map {
  38         int ch_off;
  39         int num_lun;
  40         int *lun_offs;
  41 };
  42
  43 struct nvm_dev_map {
  44         struct nvm_ch_map *chnls;
  45         int num_ch;
  46 };
  47
  48 static struct nvm_target *nvm_find_target(struct nvm_dev *dev, const char *name)
  49 {
  50         struct nvm_target *tgt;
  51
  52         list_for_each_entry(tgt, &dev->targets, list)
  53                 if (!strcmp(name, tgt->disk->disk_name))
  54                         return tgt;
  55
  56         return NULL;
  57 }
  58
  59 static bool nvm_target_exists(const char *name)
  60 {
  61         struct nvm_dev *dev;
  62         struct nvm_target *tgt;
  63         bool ret = false;
  64
  65         down_write(&nvm_lock);
  66         list_for_each_entry(dev, &nvm_devices, devices) {
  67                 mutex_lock(&dev->mlock);
  68                 list_for_each_entry(tgt, &dev->targets, list) {
  69                         if (!strcmp(name, tgt->disk->disk_name)) {
  70                                 ret = true;
  71                                 mutex_unlock(&dev->mlock);
  72                                 goto out;
  73                         }
  74                 }
  75                 mutex_unlock(&dev->mlock);
  76         }
  77
  78 out:
  79         up_write(&nvm_lock);
  80         return ret;
  81 }
  82
  83 static int nvm_reserve_luns(struct nvm_dev *dev, int lun_begin, int lun_end)
  84 {
  85         int i;
  86
  87         for (i = lun_begin; i <= lun_end; i++) {
  88                 if (test_and_set_bit(i, dev->lun_map)) {
  89                         pr_err("nvm: lun %d already allocated\n", i);
  90                         goto err;
  91                 }
  92         }
  93
  94         return 0;
  95 err:
  96         while (--i >= lun_begin)
  97                 clear_bit(i, dev->lun_map);
  98
  99         return -EBUSY;
 100 }
 101
 102 static void nvm_release_luns_err(struct nvm_dev *dev, int lun_begin,
 103                                  int lun_end)
 104 {
 105         int i;
 106
 107         for (i = lun_begin; i <= lun_end; i++)
 108                 WARN_ON(!test_and_clear_bit(i, dev->lun_map));
 109 }
 110
 111 static void nvm_remove_tgt_dev(struct nvm_tgt_dev *tgt_dev, int clear)
 112 {
 113         struct nvm_dev *dev = tgt_dev->parent;
 114         struct nvm_dev_map *dev_map = tgt_dev->map;
 115         int i, j;
 116
 117         for (i = 0; i < dev_map->num_ch; i++) {
 118                 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
 119                 int *lun_offs = ch_map->lun_offs;
 120                 int ch = i + ch_map->ch_off;
 121
 122                 if (clear) {
 123                         for (j = 0; j < ch_map->num_lun; j++) {
 124                                 int lun = j + lun_offs[j];
 125                                 int lunid = (ch * dev->geo.num_lun) + lun;
 126
 127                                 WARN_ON(!test_and_clear_bit(lunid,
 128                                                         dev->lun_map));
 129                         }
 130                 }
 131
 132                 kfree(ch_map->lun_offs);
 133         }
 134
 135         kfree(dev_map->chnls);
 136         kfree(dev_map);
 137
 138         kfree(tgt_dev->luns);
 139         kfree(tgt_dev);
 140 }
 141
 142 static struct nvm_tgt_dev *nvm_create_tgt_dev(struct nvm_dev *dev,
 143                                               u16 lun_begin, u16 lun_end,
 144                                               u16 op)
 145 {
 146         struct nvm_tgt_dev *tgt_dev = NULL;
 147         struct nvm_dev_map *dev_rmap = dev->rmap;
 148         struct nvm_dev_map *dev_map;
 149         struct ppa_addr *luns;
 150         int num_lun = lun_end - lun_begin + 1;
 151         int luns_left = num_lun;
 152         int num_ch = num_lun / dev->geo.num_lun;
 153         int num_ch_mod = num_lun % dev->geo.num_lun;
 154         int bch = lun_begin / dev->geo.num_lun;
 155         int blun = lun_begin % dev->geo.num_lun;
 156         int lunid = 0;
 157         int lun_balanced = 1;
 158         int sec_per_lun, prev_num_lun;
 159         int i, j;
 160
 161         num_ch = (num_ch_mod == 0) ? num_ch : num_ch + 1;
 162
 163         dev_map = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
 164         if (!dev_map)
 165                 goto err_dev;
 166
 167         dev_map->chnls = kcalloc(num_ch, sizeof(struct nvm_ch_map), GFP_KERNEL);
 168         if (!dev_map->chnls)
 169                 goto err_chnls;
 170
 171         luns = kcalloc(num_lun, sizeof(struct ppa_addr), GFP_KERNEL);
 172         if (!luns)
 173                 goto err_luns;
 174
 175         prev_num_lun = (luns_left > dev->geo.num_lun) ?
 176                                         dev->geo.num_lun : luns_left;
 177         for (i = 0; i < num_ch; i++) {
 178                 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[i + bch];
 179                 int *lun_roffs = ch_rmap->lun_offs;
 180                 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
 181                 int *lun_offs;
 182                 int luns_in_chnl = (luns_left > dev->geo.num_lun) ?
 183                                         dev->geo.num_lun : luns_left;
 184
 185                 if (lun_balanced && prev_num_lun != luns_in_chnl)
 186                         lun_balanced = 0;
 187
 188                 ch_map->ch_off = ch_rmap->ch_off = bch;
 189                 ch_map->num_lun = luns_in_chnl;
 190
 191                 lun_offs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
 192                 if (!lun_offs)
 193                         goto err_ch;
 194
 195                 for (j = 0; j < luns_in_chnl; j++) {
 196                         luns[lunid].ppa = 0;
 197                         luns[lunid].a.ch = i;
 198                         luns[lunid++].a.lun = j;
 199
 200                         lun_offs[j] = blun;
 201                         lun_roffs[j + blun] = blun;
 202                 }
 203
 204                 ch_map->lun_offs = lun_offs;
 205
 206                 /* when starting a new channel, lun offset is reset */
 207                 blun = 0;
 208                 luns_left -= luns_in_chnl;
 209         }
 210
 211         dev_map->num_ch = num_ch;
 212
 213         tgt_dev = kmalloc(sizeof(struct nvm_tgt_dev), GFP_KERNEL);
 214         if (!tgt_dev)
 215                 goto err_ch;
 216
 217         /* Inherit device geometry from parent */
 218         memcpy(&tgt_dev->geo, &dev->geo, sizeof(struct nvm_geo));
 219
 220         /* Target device only owns a portion of the physical device */
 221         tgt_dev->geo.num_ch = num_ch;
 222         tgt_dev->geo.num_lun = (lun_balanced) ? prev_num_lun : -1;
 223         tgt_dev->geo.all_luns = num_lun;
 224         tgt_dev->geo.all_chunks = num_lun * dev->geo.num_chk;
 225
 226         tgt_dev->geo.op = op;
 227
 228         sec_per_lun = dev->geo.clba * dev->geo.num_chk;
 229         tgt_dev->geo.total_secs = num_lun * sec_per_lun;
 230
 231         tgt_dev->q = dev->q;
 232         tgt_dev->map = dev_map;
 233         tgt_dev->luns = luns;
 234         tgt_dev->parent = dev;
 235
 236         return tgt_dev;
 237 err_ch:
 238         while (--i >= 0)
 239                 kfree(dev_map->chnls[i].lun_offs);
 240         kfree(luns);
 241 err_luns:
 242         kfree(dev_map->chnls);
 243 err_chnls:
 244         kfree(dev_map);
 245 err_dev:
 246         return tgt_dev;
 247 }
 248
 249 static const struct block_device_operations nvm_fops = {
 250         .owner          = THIS_MODULE,
 251 };
 252
 253 static struct nvm_tgt_type *__nvm_find_target_type(const char *name)
 254 {
 255         struct nvm_tgt_type *tt;
 256
 257         list_for_each_entry(tt, &nvm_tgt_types, list)
 258                 if (!strcmp(name, tt->name))
 259                         return tt;
 260
 261         return NULL;
 262 }
 263
 264 static struct nvm_tgt_type *nvm_find_target_type(const char *name)
 265 {
 266         struct nvm_tgt_type *tt;
 267
 268         down_write(&nvm_tgtt_lock);
 269         tt = __nvm_find_target_type(name);
 270         up_write(&nvm_tgtt_lock);
 271
 272         return tt;
 273 }
 274
 275 static int nvm_config_check_luns(struct nvm_geo *geo, int lun_begin,
 276                                  int lun_end)
 277 {
 278         if (lun_begin > lun_end || lun_end >= geo->all_luns) {
 279                 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
 280                         lun_begin, lun_end, geo->all_luns - 1);
 281                 return -EINVAL;
 282         }
 283
 284         return 0;
 285 }
 286
 287 static int __nvm_config_simple(struct nvm_dev *dev,
 288                                struct nvm_ioctl_create_simple *s)
 289 {
 290         struct nvm_geo *geo = &dev->geo;
 291
 292         if (s->lun_begin == -1 && s->lun_end == -1) {
 293                 s->lun_begin = 0;
 294                 s->lun_end = geo->all_luns - 1;
 295         }
 296
 297         return nvm_config_check_luns(geo, s->lun_begin, s->lun_end);
 298 }
 299
 300 static int __nvm_config_extended(struct nvm_dev *dev,
 301                                  struct nvm_ioctl_create_extended *e)
 302 {
 303         if (e->lun_begin == 0xFFFF && e->lun_end == 0xFFFF) {
 304                 e->lun_begin = 0;
 305                 e->lun_end = dev->geo.all_luns - 1;
 306         }
 307
 308         /* op not set falls into target's default */
 309         if (e->op == 0xFFFF) {
 310                 e->op = NVM_TARGET_DEFAULT_OP;
 311         } else if (e->op < NVM_TARGET_MIN_OP || e->op > NVM_TARGET_MAX_OP) {
 312                 pr_err("nvm: invalid over provisioning value\n");
 313                 return -EINVAL;
 314         }
 315
 316         return nvm_config_check_luns(&dev->geo, e->lun_begin, e->lun_end);
 317 }
 318
 319 static int nvm_create_tgt(struct nvm_dev *dev, struct nvm_ioctl_create *create)
 320 {
 321         struct nvm_ioctl_create_extended e;
 322         struct request_queue *tqueue;
 323         struct gendisk *tdisk;
 324         struct nvm_tgt_type *tt;
 325         struct nvm_target *t;
 326         struct nvm_tgt_dev *tgt_dev;
 327         void *targetdata;
 328         int ret;
 329
 330         switch (create->conf.type) {
 331         case NVM_CONFIG_TYPE_SIMPLE:
 332                 ret = __nvm_config_simple(dev, &create->conf.s);
 333                 if (ret)
 334                         return ret;
 335
 336                 e.lun_begin = create->conf.s.lun_begin;
 337                 e.lun_end = create->conf.s.lun_end;
 338                 e.op = NVM_TARGET_DEFAULT_OP;
 339                 break;
 340         case NVM_CONFIG_TYPE_EXTENDED:
 341                 ret = __nvm_config_extended(dev, &create->conf.e);
 342                 if (ret)
 343                         return ret;
 344
 345                 e = create->conf.e;
 346                 break;
 347         default:
 348                 pr_err("nvm: config type not valid\n");
 349                 return -EINVAL;
 350         }
 351
 352         tt = nvm_find_target_type(create->tgttype);
 353         if (!tt) {
 354                 pr_err("nvm: target type %s not found\n", create->tgttype);
 355                 return -EINVAL;
 356         }
 357
 358         if (nvm_target_exists(create->tgtname)) {
 359                 pr_err("nvm: target name already exists (%s)\n",
 360                                                         create->tgtname);
 361                 return -EINVAL;
 362         }
 363
 364         ret = nvm_reserve_luns(dev, e.lun_begin, e.lun_end);
 365         if (ret)
 366                 return ret;
 367
 368         t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
 369         if (!t) {
 370                 ret = -ENOMEM;
 371                 goto err_reserve;
 372         }
 373
 374         tgt_dev = nvm_create_tgt_dev(dev, e.lun_begin, e.lun_end, e.op);
 375         if (!tgt_dev) {
 376                 pr_err("nvm: could not create target device\n");
 377                 ret = -ENOMEM;
 378                 goto err_t;
 379         }
 380
 381         tdisk = alloc_disk(0);
 382         if (!tdisk) {
 383                 ret = -ENOMEM;
 384                 goto err_dev;
 385         }
 386
 387         tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node, NULL);
 388         if (!tqueue) {
 389                 ret = -ENOMEM;
 390                 goto err_disk;
 391         }
 392         blk_queue_make_request(tqueue, tt->make_rq);
 393
 394         strlcpy(tdisk->disk_name, create->tgtname, sizeof(tdisk->disk_name));
 395         tdisk->flags = GENHD_FL_EXT_DEVT;
 396         tdisk->major = 0;
 397         tdisk->first_minor = 0;
 398         tdisk->fops = &nvm_fops;
 399         tdisk->queue = tqueue;
 400
 401         targetdata = tt->init(tgt_dev, tdisk, create->flags);
 402         if (IS_ERR(targetdata)) {
 403                 ret = PTR_ERR(targetdata);
 404                 goto err_init;
 405         }
 406
 407         tdisk->private_data = targetdata;
 408         tqueue->queuedata = targetdata;
 409
 410         blk_queue_max_hw_sectors(tqueue,
 411                         (dev->geo.csecs >> 9) * NVM_MAX_VLBA);
 412
 413         set_capacity(tdisk, tt->capacity(targetdata));
 414         add_disk(tdisk);
 415
 416         if (tt->sysfs_init && tt->sysfs_init(tdisk)) {
 417                 ret = -ENOMEM;
 418                 goto err_sysfs;
 419         }
 420
 421         t->type = tt;
 422         t->disk = tdisk;
 423         t->dev = tgt_dev;
 424
 425         mutex_lock(&dev->mlock);
 426         list_add_tail(&t->list, &dev->targets);
 427         mutex_unlock(&dev->mlock);
 428
 429         __module_get(tt->owner);
 430
 431         return 0;
 432 err_sysfs:
 433         if (tt->exit)
 434                 tt->exit(targetdata, true);
 435 err_init:
 436         blk_cleanup_queue(tqueue);
 437         tdisk->queue = NULL;
 438 err_disk:
 439         put_disk(tdisk);
 440 err_dev:
 441         nvm_remove_tgt_dev(tgt_dev, 0);
 442 err_t:
 443         kfree(t);
 444 err_reserve:
 445         nvm_release_luns_err(dev, e.lun_begin, e.lun_end);
 446         return ret;
 447 }
 448
 449 static void __nvm_remove_target(struct nvm_target *t, bool graceful)
 450 {
 451         struct nvm_tgt_type *tt = t->type;
 452         struct gendisk *tdisk = t->disk;
 453         struct request_queue *q = tdisk->queue;
 454
 455         del_gendisk(tdisk);
 456         blk_cleanup_queue(q);
 457
 458         if (tt->sysfs_exit)
 459                 tt->sysfs_exit(tdisk);
 460
 461         if (tt->exit)
 462                 tt->exit(tdisk->private_data, graceful);
 463
 464         nvm_remove_tgt_dev(t->dev, 1);
 465         put_disk(tdisk);
 466         module_put(t->type->owner);
 467
 468         list_del(&t->list);
 469         kfree(t);
 470 }
 471
 472 /**
 473  * nvm_remove_tgt - Removes a target from the media manager
 474  * @dev:        device
 475  * @remove:     ioctl structure with target name to remove.
 476  *
 477  * Returns:
 478  * 0: on success
 479  * 1: on not found
 480  * <0: on error
 481  */
 482 static int nvm_remove_tgt(struct nvm_dev *dev, struct nvm_ioctl_remove *remove)
 483 {
 484         struct nvm_target *t;
 485
 486         mutex_lock(&dev->mlock);
 487         t = nvm_find_target(dev, remove->tgtname);
 488         if (!t) {
 489                 mutex_unlock(&dev->mlock);
 490                 return 1;
 491         }
 492         __nvm_remove_target(t, true);
 493         mutex_unlock(&dev->mlock);
 494
 495         return 0;
 496 }
 497
 498 static int nvm_register_map(struct nvm_dev *dev)
 499 {
 500         struct nvm_dev_map *rmap;
 501         int i, j;
 502
 503         rmap = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
 504         if (!rmap)
 505                 goto err_rmap;
 506
 507         rmap->chnls = kcalloc(dev->geo.num_ch, sizeof(struct nvm_ch_map),
 508                                                                 GFP_KERNEL);
 509         if (!rmap->chnls)
 510                 goto err_chnls;
 511
 512         for (i = 0; i < dev->geo.num_ch; i++) {
 513                 struct nvm_ch_map *ch_rmap;
 514                 int *lun_roffs;
 515                 int luns_in_chnl = dev->geo.num_lun;
 516
 517                 ch_rmap = &rmap->chnls[i];
 518
 519                 ch_rmap->ch_off = -1;
 520                 ch_rmap->num_lun = luns_in_chnl;
 521
 522                 lun_roffs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
 523                 if (!lun_roffs)
 524                         goto err_ch;
 525
 526                 for (j = 0; j < luns_in_chnl; j++)
 527                         lun_roffs[j] = -1;
 528
 529                 ch_rmap->lun_offs = lun_roffs;
 530         }
 531
 532         dev->rmap = rmap;
 533
 534         return 0;
 535 err_ch:
 536         while (--i >= 0)
 537                 kfree(rmap->chnls[i].lun_offs);
 538 err_chnls:
 539         kfree(rmap);
 540 err_rmap:
 541         return -ENOMEM;
 542 }
 543
 544 static void nvm_unregister_map(struct nvm_dev *dev)
 545 {
 546         struct nvm_dev_map *rmap = dev->rmap;
 547         int i;
 548
 549         for (i = 0; i < dev->geo.num_ch; i++)
 550                 kfree(rmap->chnls[i].lun_offs);
 551
 552         kfree(rmap->chnls);
 553         kfree(rmap);
 554 }
 555
 556 static void nvm_map_to_dev(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
 557 {
 558         struct nvm_dev_map *dev_map = tgt_dev->map;
 559         struct nvm_ch_map *ch_map = &dev_map->chnls[p->a.ch];
 560         int lun_off = ch_map->lun_offs[p->a.lun];
 561
 562         p->a.ch += ch_map->ch_off;
 563         p->a.lun += lun_off;
 564 }
 565
 566 static void nvm_map_to_tgt(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
 567 {
 568         struct nvm_dev *dev = tgt_dev->parent;
 569         struct nvm_dev_map *dev_rmap = dev->rmap;
 570         struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[p->a.ch];
 571         int lun_roff = ch_rmap->lun_offs[p->a.lun];
 572
 573         p->a.ch -= ch_rmap->ch_off;
 574         p->a.lun -= lun_roff;
 575 }
 576
 577 static void nvm_ppa_tgt_to_dev(struct nvm_tgt_dev *tgt_dev,
 578                                 struct ppa_addr *ppa_list, int nr_ppas)
 579 {
 580         int i;
 581
 582         for (i = 0; i < nr_ppas; i++) {
 583                 nvm_map_to_dev(tgt_dev, &ppa_list[i]);
 584                 ppa_list[i] = generic_to_dev_addr(tgt_dev->parent, ppa_list[i]);
 585         }
 586 }
 587
 588 static void nvm_ppa_dev_to_tgt(struct nvm_tgt_dev *tgt_dev,
 589                                 struct ppa_addr *ppa_list, int nr_ppas)
 590 {
 591         int i;
 592
 593         for (i = 0; i < nr_ppas; i++) {
 594                 ppa_list[i] = dev_to_generic_addr(tgt_dev->parent, ppa_list[i]);
 595                 nvm_map_to_tgt(tgt_dev, &ppa_list[i]);
 596         }
 597 }
 598
 599 static void nvm_rq_tgt_to_dev(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
 600 {
 601         if (rqd->nr_ppas == 1) {
 602                 nvm_ppa_tgt_to_dev(tgt_dev, &rqd->ppa_addr, 1);
 603                 return;
 604         }
 605
 606         nvm_ppa_tgt_to_dev(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
 607 }
 608
 609 static void nvm_rq_dev_to_tgt(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
 610 {
 611         if (rqd->nr_ppas == 1) {
 612                 nvm_ppa_dev_to_tgt(tgt_dev, &rqd->ppa_addr, 1);
 613                 return;
 614         }
 615
 616         nvm_ppa_dev_to_tgt(tgt_dev, rqd->ppa_list, rqd->nr_ppas);
 617 }
 618
 619 int nvm_register_tgt_type(struct nvm_tgt_type *tt)
 620 {
 621         int ret = 0;
 622
 623         down_write(&nvm_tgtt_lock);
 624         if (__nvm_find_target_type(tt->name))
 625                 ret = -EEXIST;
 626         else
 627                 list_add(&tt->list, &nvm_tgt_types);
 628         up_write(&nvm_tgtt_lock);
 629
 630         return ret;
 631 }
 632 EXPORT_SYMBOL(nvm_register_tgt_type);
 633
 634 void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
 635 {
 636         if (!tt)
 637                 return;
 638
 639         down_write(&nvm_tgtt_lock);
 640         list_del(&tt->list);
 641         up_write(&nvm_tgtt_lock);
 642 }
 643 EXPORT_SYMBOL(nvm_unregister_tgt_type);
 644
 645 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
 646                                                         dma_addr_t *dma_handler)
 647 {
 648         return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
 649                                                                 dma_handler);
 650 }
 651 EXPORT_SYMBOL(nvm_dev_dma_alloc);
 652
 653 void nvm_dev_dma_free(struct nvm_dev *dev, void *addr, dma_addr_t dma_handler)
 654 {
 655         dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
 656 }
 657 EXPORT_SYMBOL(nvm_dev_dma_free);
 658
 659 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
 660 {
 661         struct nvm_dev *dev;
 662
 663         list_for_each_entry(dev, &nvm_devices, devices)
 664                 if (!strcmp(name, dev->name))
 665                         return dev;
 666
 667         return NULL;
 668 }
 669
 670 static int nvm_set_rqd_ppalist(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd,
 671                         const struct ppa_addr *ppas, int nr_ppas)
 672 {
 673         struct nvm_dev *dev = tgt_dev->parent;
 674         struct nvm_geo *geo = &tgt_dev->geo;
 675         int i, plane_cnt, pl_idx;
 676         struct ppa_addr ppa;
 677
 678         if (geo->pln_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
 679                 rqd->nr_ppas = nr_ppas;
 680                 rqd->ppa_addr = ppas[0];
 681
 682                 return 0;
 683         }
 684
 685         rqd->nr_ppas = nr_ppas;
 686         rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
 687         if (!rqd->ppa_list) {
 688                 pr_err("nvm: failed to allocate dma memory\n");
 689                 return -ENOMEM;
 690         }
 691
 692         plane_cnt = geo->pln_mode;
 693         rqd->nr_ppas *= plane_cnt;
 694
 695         for (i = 0; i < nr_ppas; i++) {
 696                 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
 697                         ppa = ppas[i];
 698                         ppa.g.pl = pl_idx;
 699                         rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
 700                 }
 701         }
 702
 703         return 0;
 704 }
 705
 706 static void nvm_free_rqd_ppalist(struct nvm_tgt_dev *tgt_dev,
 707                         struct nvm_rq *rqd)
 708 {
 709         if (!rqd->ppa_list)
 710                 return;
 711
 712         nvm_dev_dma_free(tgt_dev->parent, rqd->ppa_list, rqd->dma_ppa_list);
 713 }
 714
 715 int nvm_get_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct nvm_chk_meta *meta,
 716                 struct ppa_addr ppa, int nchks)
 717 {
 718         struct nvm_dev *dev = tgt_dev->parent;
 719
 720         nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
 721
 722         return dev->ops->get_chk_meta(tgt_dev->parent, meta,
 723                                                 (sector_t)ppa.ppa, nchks);
 724 }
 725 EXPORT_SYMBOL(nvm_get_chunk_meta);
 726
 727 int nvm_set_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
 728                        int nr_ppas, int type)
 729 {
 730         struct nvm_dev *dev = tgt_dev->parent;
 731         struct nvm_rq rqd;
 732         int ret;
 733
 734         if (nr_ppas > NVM_MAX_VLBA) {
 735                 pr_err("nvm: unable to update all blocks atomically\n");
 736                 return -EINVAL;
 737         }
 738
 739         memset(&rqd, 0, sizeof(struct nvm_rq));
 740
 741         nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas);
 742         nvm_rq_tgt_to_dev(tgt_dev, &rqd);
 743
 744         ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
 745         nvm_free_rqd_ppalist(tgt_dev, &rqd);
 746         if (ret) {
 747                 pr_err("nvm: failed bb mark\n");
 748                 return -EINVAL;
 749         }
 750
 751         return 0;
 752 }
 753 EXPORT_SYMBOL(nvm_set_tgt_bb_tbl);
 754
 755 int nvm_submit_io(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
 756 {
 757         struct nvm_dev *dev = tgt_dev->parent;
 758         int ret;
 759
 760         if (!dev->ops->submit_io)
 761                 return -ENODEV;
 762
 763         nvm_rq_tgt_to_dev(tgt_dev, rqd);
 764
 765         rqd->dev = tgt_dev;
 766
 767         /* In case of error, fail with right address format */
 768         ret = dev->ops->submit_io(dev, rqd);
 769         if (ret)
 770                 nvm_rq_dev_to_tgt(tgt_dev, rqd);
 771         return ret;
 772 }
 773 EXPORT_SYMBOL(nvm_submit_io);
 774
 775 int nvm_submit_io_sync(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
 776 {
 777         struct nvm_dev *dev = tgt_dev->parent;
 778         int ret;
 779
 780         if (!dev->ops->submit_io_sync)
 781                 return -ENODEV;
 782
 783         nvm_rq_tgt_to_dev(tgt_dev, rqd);
 784
 785         rqd->dev = tgt_dev;
 786
 787         /* In case of error, fail with right address format */
 788         ret = dev->ops->submit_io_sync(dev, rqd);
 789         nvm_rq_dev_to_tgt(tgt_dev, rqd);
 790
 791         return ret;
 792 }
 793 EXPORT_SYMBOL(nvm_submit_io_sync);
 794
 795 void nvm_end_io(struct nvm_rq *rqd)
 796 {
 797         struct nvm_tgt_dev *tgt_dev = rqd->dev;
 798
 799         /* Convert address space */
 800         if (tgt_dev)
 801                 nvm_rq_dev_to_tgt(tgt_dev, rqd);
 802
 803         if (rqd->end_io)
 804                 rqd->end_io(rqd);
 805 }
 806 EXPORT_SYMBOL(nvm_end_io);
 807
 808 /*
 809  * folds a bad block list from its plane representation to its virtual
 810  * block representation. The fold is done in place and reduced size is
 811  * returned.
 812  *
 813  * If any of the planes status are bad or grown bad block, the virtual block
 814  * is marked bad. If not bad, the first plane state acts as the block state.
 815  */
 816 int nvm_bb_tbl_fold(struct nvm_dev *dev, u8 *blks, int nr_blks)
 817 {
 818         struct nvm_geo *geo = &dev->geo;
 819         int blk, offset, pl, blktype;
 820
 821         if (nr_blks != geo->num_chk * geo->pln_mode)
 822                 return -EINVAL;
 823
 824         for (blk = 0; blk < geo->num_chk; blk++) {
 825                 offset = blk * geo->pln_mode;
 826                 blktype = blks[offset];
 827
 828                 /* Bad blocks on any planes take precedence over other types */
 829                 for (pl = 0; pl < geo->pln_mode; pl++) {
 830                         if (blks[offset + pl] &
 831                                         (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
 832                                 blktype = blks[offset + pl];
 833                                 break;
 834                         }
 835                 }
 836
 837                 blks[blk] = blktype;
 838         }
 839
 840         return geo->num_chk;
 841 }
 842 EXPORT_SYMBOL(nvm_bb_tbl_fold);
 843
 844 int nvm_get_tgt_bb_tbl(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
 845                        u8 *blks)
 846 {
 847         struct nvm_dev *dev = tgt_dev->parent;
 848
 849         nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
 850
 851         return dev->ops->get_bb_tbl(dev, ppa, blks);
 852 }
 853 EXPORT_SYMBOL(nvm_get_tgt_bb_tbl);
 854
 855 static int nvm_core_init(struct nvm_dev *dev)
 856 {
 857         struct nvm_geo *geo = &dev->geo;
 858         int ret;
 859
 860         dev->lun_map = kcalloc(BITS_TO_LONGS(geo->all_luns),
 861                                         sizeof(unsigned long), GFP_KERNEL);
 862         if (!dev->lun_map)
 863                 return -ENOMEM;
 864
 865         INIT_LIST_HEAD(&dev->area_list);
 866         INIT_LIST_HEAD(&dev->targets);
 867         mutex_init(&dev->mlock);
 868         spin_lock_init(&dev->lock);
 869
 870         ret = nvm_register_map(dev);
 871         if (ret)
 872                 goto err_fmtype;
 873
 874         return 0;
 875 err_fmtype:
 876         kfree(dev->lun_map);
 877         return ret;
 878 }
 879
 880 static void nvm_free(struct nvm_dev *dev)
 881 {
 882         if (!dev)
 883                 return;
 884
 885         if (dev->dma_pool)
 886                 dev->ops->destroy_dma_pool(dev->dma_pool);
 887
 888         nvm_unregister_map(dev);
 889         kfree(dev->lun_map);
 890         kfree(dev);
 891 }
 892
 893 static int nvm_init(struct nvm_dev *dev)
 894 {
 895         struct nvm_geo *geo = &dev->geo;
 896         int ret = -EINVAL;
 897
 898         if (dev->ops->identity(dev)) {
 899                 pr_err("nvm: device could not be identified\n");
 900                 goto err;
 901         }
 902
 903         pr_debug("nvm: ver:%u.%u nvm_vendor:%x\n",
 904                                 geo->major_ver_id, geo->minor_ver_id,
 905                                 geo->vmnt);
 906
 907         ret = nvm_core_init(dev);
 908         if (ret) {
 909                 pr_err("nvm: could not initialize core structures.\n");
 910                 goto err;
 911         }
 912
 913         pr_info("nvm: registered %s [%u/%u/%u/%u/%u]\n",
 914                         dev->name, dev->geo.ws_min, dev->geo.ws_opt,
 915                         dev->geo.num_chk, dev->geo.all_luns,
 916                         dev->geo.num_ch);
 917         return 0;
 918 err:
 919         pr_err("nvm: failed to initialize nvm\n");
 920         return ret;
 921 }
 922
 923 struct nvm_dev *nvm_alloc_dev(int node)
 924 {
 925         return kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
 926 }
 927 EXPORT_SYMBOL(nvm_alloc_dev);
 928
 929 int nvm_register(struct nvm_dev *dev)
 930 {
 931         int ret;
 932
 933         if (!dev->q || !dev->ops)
 934                 return -EINVAL;
 935
 936         dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist");
 937         if (!dev->dma_pool) {
 938                 pr_err("nvm: could not create dma pool\n");
 939                 return -ENOMEM;
 940         }
 941
 942         ret = nvm_init(dev);
 943         if (ret)
 944                 goto err_init;
 945
 946         /* register device with a supported media manager */
 947         down_write(&nvm_lock);
 948         list_add(&dev->devices, &nvm_devices);
 949         up_write(&nvm_lock);
 950
 951         return 0;
 952 err_init:
 953         dev->ops->destroy_dma_pool(dev->dma_pool);
 954         return ret;
 955 }
 956 EXPORT_SYMBOL(nvm_register);
 957
 958 void nvm_unregister(struct nvm_dev *dev)
 959 {
 960         struct nvm_target *t, *tmp;
 961
 962         mutex_lock(&dev->mlock);
 963         list_for_each_entry_safe(t, tmp, &dev->targets, list) {
 964                 if (t->dev->parent != dev)
 965                         continue;
 966                 __nvm_remove_target(t, false);
 967         }
 968         mutex_unlock(&dev->mlock);
 969
 970         down_write(&nvm_lock);
 971         list_del(&dev->devices);
 972         up_write(&nvm_lock);
 973
 974         nvm_free(dev);
 975 }
 976 EXPORT_SYMBOL(nvm_unregister);
 977
 978 static int __nvm_configure_create(struct nvm_ioctl_create *create)
 979 {
 980         struct nvm_dev *dev;
 981
 982         down_write(&nvm_lock);
 983         dev = nvm_find_nvm_dev(create->dev);
 984         up_write(&nvm_lock);
 985
 986         if (!dev) {
 987                 pr_err("nvm: device not found\n");
 988                 return -EINVAL;
 989         }
 990
 991         return nvm_create_tgt(dev, create);
 992 }
 993
 994 static long nvm_ioctl_info(struct file *file, void __user *arg)
 995 {
 996         struct nvm_ioctl_info *info;
 997         struct nvm_tgt_type *tt;
 998         int tgt_iter = 0;
 999
1000         info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1001         if (IS_ERR(info))
1002                 return -EFAULT;
1003
1004         info->version[0] = NVM_VERSION_MAJOR;
1005         info->version[1] = NVM_VERSION_MINOR;
1006         info->version[2] = NVM_VERSION_PATCH;
1007
1008         down_write(&nvm_tgtt_lock);
1009         list_for_each_entry(tt, &nvm_tgt_types, list) {
1010                 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1011
1012                 tgt->version[0] = tt->version[0];
1013                 tgt->version[1] = tt->version[1];
1014                 tgt->version[2] = tt->version[2];
1015                 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1016
1017                 tgt_iter++;
1018         }
1019
1020         info->tgtsize = tgt_iter;
1021         up_write(&nvm_tgtt_lock);
1022
1023         if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1024                 kfree(info);
1025                 return -EFAULT;
1026         }
1027
1028         kfree(info);
1029         return 0;
1030 }
1031
1032 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1033 {
1034         struct nvm_ioctl_get_devices *devices;
1035         struct nvm_dev *dev;
1036         int i = 0;
1037
1038         devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1039         if (!devices)
1040                 return -ENOMEM;
1041
1042         down_write(&nvm_lock);
1043         list_for_each_entry(dev, &nvm_devices, devices) {
1044                 struct nvm_ioctl_device_info *info = &devices->info[i];
1045
1046                 strlcpy(info->devname, dev->name, sizeof(info->devname));
1047
1048                 /* kept for compatibility */
1049                 info->bmversion[0] = 1;
1050                 info->bmversion[1] = 0;
1051                 info->bmversion[2] = 0;
1052                 strlcpy(info->bmname, "gennvm", sizeof(info->bmname));
1053                 i++;
1054
1055                 if (i > 31) {
1056                         pr_err("nvm: max 31 devices can be reported.\n");
1057                         break;
1058                 }
1059         }
1060         up_write(&nvm_lock);
1061
1062         devices->nr_devices = i;
1063
1064         if (copy_to_user(arg, devices,
1065                          sizeof(struct nvm_ioctl_get_devices))) {
1066                 kfree(devices);
1067                 return -EFAULT;
1068         }
1069
1070         kfree(devices);
1071         return 0;
1072 }
1073
1074 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1075 {
1076         struct nvm_ioctl_create create;
1077
1078         if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1079                 return -EFAULT;
1080
1081         if (create.conf.type == NVM_CONFIG_TYPE_EXTENDED &&
1082             create.conf.e.rsv != 0) {
1083                 pr_err("nvm: reserved config field in use\n");
1084                 return -EINVAL;
1085         }
1086
1087         create.dev[DISK_NAME_LEN - 1] = '\0';
1088         create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1089         create.tgtname[DISK_NAME_LEN - 1] = '\0';
1090
1091         if (create.flags != 0) {
1092                 __u32 flags = create.flags;
1093
1094                 /* Check for valid flags */
1095                 if (flags & NVM_TARGET_FACTORY)
1096                         flags &= ~NVM_TARGET_FACTORY;
1097
1098                 if (flags) {
1099                         pr_err("nvm: flag not supported\n");
1100                         return -EINVAL;
1101                 }
1102         }
1103
1104         return __nvm_configure_create(&create);
1105 }
1106
1107 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1108 {
1109         struct nvm_ioctl_remove remove;
1110         struct nvm_dev *dev;
1111         int ret = 0;
1112
1113         if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1114                 return -EFAULT;
1115
1116         remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1117
1118         if (remove.flags != 0) {
1119                 pr_err("nvm: no flags supported\n");
1120                 return -EINVAL;
1121         }
1122
1123         list_for_each_entry(dev, &nvm_devices, devices) {
1124                 ret = nvm_remove_tgt(dev, &remove);
1125                 if (!ret)
1126                         break;
1127         }
1128
1129         return ret;
1130 }
1131
1132 /* kept for compatibility reasons */
1133 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1134 {
1135         struct nvm_ioctl_dev_init init;
1136
1137         if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1138                 return -EFAULT;
1139
1140         if (init.flags != 0) {
1141                 pr_err("nvm: no flags supported\n");
1142                 return -EINVAL;
1143         }
1144
1145         return 0;
1146 }
1147
1148 /* Kept for compatibility reasons */
1149 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1150 {
1151         struct nvm_ioctl_dev_factory fact;
1152
1153         if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1154                 return -EFAULT;
1155
1156         fact.dev[DISK_NAME_LEN - 1] = '\0';
1157
1158         if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1159                 return -EINVAL;
1160
1161         return 0;
1162 }
1163
1164 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1165 {
1166         void __user *argp = (void __user *)arg;
1167
1168         if (!capable(CAP_SYS_ADMIN))
1169                 return -EPERM;
1170
1171         switch (cmd) {
1172         case NVM_INFO:
1173                 return nvm_ioctl_info(file, argp);
1174         case NVM_GET_DEVICES:
1175                 return nvm_ioctl_get_devices(file, argp);
1176         case NVM_DEV_CREATE:
1177                 return nvm_ioctl_dev_create(file, argp);
1178         case NVM_DEV_REMOVE:
1179                 return nvm_ioctl_dev_remove(file, argp);
1180         case NVM_DEV_INIT:
1181                 return nvm_ioctl_dev_init(file, argp);
1182         case NVM_DEV_FACTORY:
1183                 return nvm_ioctl_dev_factory(file, argp);
1184         }
1185         return 0;
1186 }
1187
1188 static const struct file_operations _ctl_fops = {
1189         .open = nonseekable_open,
1190         .unlocked_ioctl = nvm_ctl_ioctl,
1191         .owner = THIS_MODULE,
1192         .llseek  = noop_llseek,
1193 };
1194
1195 static struct miscdevice _nvm_misc = {
1196         .minor          = MISC_DYNAMIC_MINOR,
1197         .name           = "lightnvm",
1198         .nodename       = "lightnvm/control",
1199         .fops           = &_ctl_fops,
1200 };
1201 builtin_misc_device(_nvm_misc);