Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2015 IT University of Copenhagen. All rights reserved.
4 * Initial release: Matias Bjorling <m@bjorling.me>
5 */
6
7#define pr_fmt(fmt) "nvm: " fmt
8
9#include <linux/list.h>
10#include <linux/types.h>
11#include <linux/sem.h>
12#include <linux/bitmap.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/miscdevice.h>
16#include <linux/lightnvm.h>
17#include <linux/sched/sysctl.h>
18
19static LIST_HEAD(nvm_tgt_types);
20static DECLARE_RWSEM(nvm_tgtt_lock);
21static LIST_HEAD(nvm_devices);
22static DECLARE_RWSEM(nvm_lock);
23
24/* Map between virtual and physical channel and lun */
25struct nvm_ch_map {
26 int ch_off;
27 int num_lun;
28 int *lun_offs;
29};
30
31struct nvm_dev_map {
32 struct nvm_ch_map *chnls;
33 int num_ch;
34};
35
36static void nvm_free(struct kref *ref);
37
38static struct nvm_target *nvm_find_target(struct nvm_dev *dev, const char *name)
39{
40 struct nvm_target *tgt;
41
42 list_for_each_entry(tgt, &dev->targets, list)
43 if (!strcmp(name, tgt->disk->disk_name))
44 return tgt;
45
46 return NULL;
47}
48
49static bool nvm_target_exists(const char *name)
50{
51 struct nvm_dev *dev;
52 struct nvm_target *tgt;
53 bool ret = false;
54
55 down_write(&nvm_lock);
56 list_for_each_entry(dev, &nvm_devices, devices) {
57 mutex_lock(&dev->mlock);
58 list_for_each_entry(tgt, &dev->targets, list) {
59 if (!strcmp(name, tgt->disk->disk_name)) {
60 ret = true;
61 mutex_unlock(&dev->mlock);
62 goto out;
63 }
64 }
65 mutex_unlock(&dev->mlock);
66 }
67
68out:
69 up_write(&nvm_lock);
70 return ret;
71}
72
73static int nvm_reserve_luns(struct nvm_dev *dev, int lun_begin, int lun_end)
74{
75 int i;
76
77 for (i = lun_begin; i <= lun_end; i++) {
78 if (test_and_set_bit(i, dev->lun_map)) {
79 pr_err("lun %d already allocated\n", i);
80 goto err;
81 }
82 }
83
84 return 0;
85err:
86 while (--i >= lun_begin)
87 clear_bit(i, dev->lun_map);
88
89 return -EBUSY;
90}
91
92static void nvm_release_luns_err(struct nvm_dev *dev, int lun_begin,
93 int lun_end)
94{
95 int i;
96
97 for (i = lun_begin; i <= lun_end; i++)
98 WARN_ON(!test_and_clear_bit(i, dev->lun_map));
99}
100
101static void nvm_remove_tgt_dev(struct nvm_tgt_dev *tgt_dev, int clear)
102{
103 struct nvm_dev *dev = tgt_dev->parent;
104 struct nvm_dev_map *dev_map = tgt_dev->map;
105 int i, j;
106
107 for (i = 0; i < dev_map->num_ch; i++) {
108 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
109 int *lun_offs = ch_map->lun_offs;
110 int ch = i + ch_map->ch_off;
111
112 if (clear) {
113 for (j = 0; j < ch_map->num_lun; j++) {
114 int lun = j + lun_offs[j];
115 int lunid = (ch * dev->geo.num_lun) + lun;
116
117 WARN_ON(!test_and_clear_bit(lunid,
118 dev->lun_map));
119 }
120 }
121
122 kfree(ch_map->lun_offs);
123 }
124
125 kfree(dev_map->chnls);
126 kfree(dev_map);
127
128 kfree(tgt_dev->luns);
129 kfree(tgt_dev);
130}
131
132static struct nvm_tgt_dev *nvm_create_tgt_dev(struct nvm_dev *dev,
133 u16 lun_begin, u16 lun_end,
134 u16 op)
135{
136 struct nvm_tgt_dev *tgt_dev = NULL;
137 struct nvm_dev_map *dev_rmap = dev->rmap;
138 struct nvm_dev_map *dev_map;
139 struct ppa_addr *luns;
140 int num_lun = lun_end - lun_begin + 1;
141 int luns_left = num_lun;
142 int num_ch = num_lun / dev->geo.num_lun;
143 int num_ch_mod = num_lun % dev->geo.num_lun;
144 int bch = lun_begin / dev->geo.num_lun;
145 int blun = lun_begin % dev->geo.num_lun;
146 int lunid = 0;
147 int lun_balanced = 1;
148 int sec_per_lun, prev_num_lun;
149 int i, j;
150
151 num_ch = (num_ch_mod == 0) ? num_ch : num_ch + 1;
152
153 dev_map = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
154 if (!dev_map)
155 goto err_dev;
156
157 dev_map->chnls = kcalloc(num_ch, sizeof(struct nvm_ch_map), GFP_KERNEL);
158 if (!dev_map->chnls)
159 goto err_chnls;
160
161 luns = kcalloc(num_lun, sizeof(struct ppa_addr), GFP_KERNEL);
162 if (!luns)
163 goto err_luns;
164
165 prev_num_lun = (luns_left > dev->geo.num_lun) ?
166 dev->geo.num_lun : luns_left;
167 for (i = 0; i < num_ch; i++) {
168 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[i + bch];
169 int *lun_roffs = ch_rmap->lun_offs;
170 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
171 int *lun_offs;
172 int luns_in_chnl = (luns_left > dev->geo.num_lun) ?
173 dev->geo.num_lun : luns_left;
174
175 if (lun_balanced && prev_num_lun != luns_in_chnl)
176 lun_balanced = 0;
177
178 ch_map->ch_off = ch_rmap->ch_off = bch;
179 ch_map->num_lun = luns_in_chnl;
180
181 lun_offs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
182 if (!lun_offs)
183 goto err_ch;
184
185 for (j = 0; j < luns_in_chnl; j++) {
186 luns[lunid].ppa = 0;
187 luns[lunid].a.ch = i;
188 luns[lunid++].a.lun = j;
189
190 lun_offs[j] = blun;
191 lun_roffs[j + blun] = blun;
192 }
193
194 ch_map->lun_offs = lun_offs;
195
196 /* when starting a new channel, lun offset is reset */
197 blun = 0;
198 luns_left -= luns_in_chnl;
199 }
200
201 dev_map->num_ch = num_ch;
202
203 tgt_dev = kmalloc(sizeof(struct nvm_tgt_dev), GFP_KERNEL);
204 if (!tgt_dev)
205 goto err_ch;
206
207 /* Inherit device geometry from parent */
208 memcpy(&tgt_dev->geo, &dev->geo, sizeof(struct nvm_geo));
209
210 /* Target device only owns a portion of the physical device */
211 tgt_dev->geo.num_ch = num_ch;
212 tgt_dev->geo.num_lun = (lun_balanced) ? prev_num_lun : -1;
213 tgt_dev->geo.all_luns = num_lun;
214 tgt_dev->geo.all_chunks = num_lun * dev->geo.num_chk;
215
216 tgt_dev->geo.op = op;
217
218 sec_per_lun = dev->geo.clba * dev->geo.num_chk;
219 tgt_dev->geo.total_secs = num_lun * sec_per_lun;
220
221 tgt_dev->q = dev->q;
222 tgt_dev->map = dev_map;
223 tgt_dev->luns = luns;
224 tgt_dev->parent = dev;
225
226 return tgt_dev;
227err_ch:
228 while (--i >= 0)
229 kfree(dev_map->chnls[i].lun_offs);
230 kfree(luns);
231err_luns:
232 kfree(dev_map->chnls);
233err_chnls:
234 kfree(dev_map);
235err_dev:
236 return tgt_dev;
237}
238
239static struct nvm_tgt_type *__nvm_find_target_type(const char *name)
240{
241 struct nvm_tgt_type *tt;
242
243 list_for_each_entry(tt, &nvm_tgt_types, list)
244 if (!strcmp(name, tt->name))
245 return tt;
246
247 return NULL;
248}
249
250static struct nvm_tgt_type *nvm_find_target_type(const char *name)
251{
252 struct nvm_tgt_type *tt;
253
254 down_write(&nvm_tgtt_lock);
255 tt = __nvm_find_target_type(name);
256 up_write(&nvm_tgtt_lock);
257
258 return tt;
259}
260
261static int nvm_config_check_luns(struct nvm_geo *geo, int lun_begin,
262 int lun_end)
263{
264 if (lun_begin > lun_end || lun_end >= geo->all_luns) {
265 pr_err("lun out of bound (%u:%u > %u)\n",
266 lun_begin, lun_end, geo->all_luns - 1);
267 return -EINVAL;
268 }
269
270 return 0;
271}
272
273static int __nvm_config_simple(struct nvm_dev *dev,
274 struct nvm_ioctl_create_simple *s)
275{
276 struct nvm_geo *geo = &dev->geo;
277
278 if (s->lun_begin == -1 && s->lun_end == -1) {
279 s->lun_begin = 0;
280 s->lun_end = geo->all_luns - 1;
281 }
282
283 return nvm_config_check_luns(geo, s->lun_begin, s->lun_end);
284}
285
286static int __nvm_config_extended(struct nvm_dev *dev,
287 struct nvm_ioctl_create_extended *e)
288{
289 if (e->lun_begin == 0xFFFF && e->lun_end == 0xFFFF) {
290 e->lun_begin = 0;
291 e->lun_end = dev->geo.all_luns - 1;
292 }
293
294 /* op not set falls into target's default */
295 if (e->op == 0xFFFF) {
296 e->op = NVM_TARGET_DEFAULT_OP;
297 } else if (e->op < NVM_TARGET_MIN_OP || e->op > NVM_TARGET_MAX_OP) {
298 pr_err("invalid over provisioning value\n");
299 return -EINVAL;
300 }
301
302 return nvm_config_check_luns(&dev->geo, e->lun_begin, e->lun_end);
303}
304
305static int nvm_create_tgt(struct nvm_dev *dev, struct nvm_ioctl_create *create)
306{
307 struct nvm_ioctl_create_extended e;
308 struct request_queue *tqueue;
309 struct gendisk *tdisk;
310 struct nvm_tgt_type *tt;
311 struct nvm_target *t;
312 struct nvm_tgt_dev *tgt_dev;
313 void *targetdata;
314 unsigned int mdts;
315 int ret;
316
317 switch (create->conf.type) {
318 case NVM_CONFIG_TYPE_SIMPLE:
319 ret = __nvm_config_simple(dev, &create->conf.s);
320 if (ret)
321 return ret;
322
323 e.lun_begin = create->conf.s.lun_begin;
324 e.lun_end = create->conf.s.lun_end;
325 e.op = NVM_TARGET_DEFAULT_OP;
326 break;
327 case NVM_CONFIG_TYPE_EXTENDED:
328 ret = __nvm_config_extended(dev, &create->conf.e);
329 if (ret)
330 return ret;
331
332 e = create->conf.e;
333 break;
334 default:
335 pr_err("config type not valid\n");
336 return -EINVAL;
337 }
338
339 tt = nvm_find_target_type(create->tgttype);
340 if (!tt) {
341 pr_err("target type %s not found\n", create->tgttype);
342 return -EINVAL;
343 }
344
345 if ((tt->flags & NVM_TGT_F_HOST_L2P) != (dev->geo.dom & NVM_RSP_L2P)) {
346 pr_err("device is incompatible with target L2P type.\n");
347 return -EINVAL;
348 }
349
350 if (nvm_target_exists(create->tgtname)) {
351 pr_err("target name already exists (%s)\n",
352 create->tgtname);
353 return -EINVAL;
354 }
355
356 ret = nvm_reserve_luns(dev, e.lun_begin, e.lun_end);
357 if (ret)
358 return ret;
359
360 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
361 if (!t) {
362 ret = -ENOMEM;
363 goto err_reserve;
364 }
365
366 tgt_dev = nvm_create_tgt_dev(dev, e.lun_begin, e.lun_end, e.op);
367 if (!tgt_dev) {
368 pr_err("could not create target device\n");
369 ret = -ENOMEM;
370 goto err_t;
371 }
372
373 tdisk = alloc_disk(0);
374 if (!tdisk) {
375 ret = -ENOMEM;
376 goto err_dev;
377 }
378
379 tqueue = blk_alloc_queue(dev->q->node);
380 if (!tqueue) {
381 ret = -ENOMEM;
382 goto err_disk;
383 }
384
385 strlcpy(tdisk->disk_name, create->tgtname, sizeof(tdisk->disk_name));
386 tdisk->flags = GENHD_FL_EXT_DEVT;
387 tdisk->major = 0;
388 tdisk->first_minor = 0;
389 tdisk->fops = tt->bops;
390 tdisk->queue = tqueue;
391
392 targetdata = tt->init(tgt_dev, tdisk, create->flags);
393 if (IS_ERR(targetdata)) {
394 ret = PTR_ERR(targetdata);
395 goto err_init;
396 }
397
398 tdisk->private_data = targetdata;
399 tqueue->queuedata = targetdata;
400
401 mdts = (dev->geo.csecs >> 9) * NVM_MAX_VLBA;
402 if (dev->geo.mdts) {
403 mdts = min_t(u32, dev->geo.mdts,
404 (dev->geo.csecs >> 9) * NVM_MAX_VLBA);
405 }
406 blk_queue_max_hw_sectors(tqueue, mdts);
407
408 set_capacity(tdisk, tt->capacity(targetdata));
409 add_disk(tdisk);
410
411 if (tt->sysfs_init && tt->sysfs_init(tdisk)) {
412 ret = -ENOMEM;
413 goto err_sysfs;
414 }
415
416 t->type = tt;
417 t->disk = tdisk;
418 t->dev = tgt_dev;
419
420 mutex_lock(&dev->mlock);
421 list_add_tail(&t->list, &dev->targets);
422 mutex_unlock(&dev->mlock);
423
424 __module_get(tt->owner);
425
426 return 0;
427err_sysfs:
428 if (tt->exit)
429 tt->exit(targetdata, true);
430err_init:
431 blk_cleanup_queue(tqueue);
432 tdisk->queue = NULL;
433err_disk:
434 put_disk(tdisk);
435err_dev:
436 nvm_remove_tgt_dev(tgt_dev, 0);
437err_t:
438 kfree(t);
439err_reserve:
440 nvm_release_luns_err(dev, e.lun_begin, e.lun_end);
441 return ret;
442}
443
444static void __nvm_remove_target(struct nvm_target *t, bool graceful)
445{
446 struct nvm_tgt_type *tt = t->type;
447 struct gendisk *tdisk = t->disk;
448 struct request_queue *q = tdisk->queue;
449
450 del_gendisk(tdisk);
451 blk_cleanup_queue(q);
452
453 if (tt->sysfs_exit)
454 tt->sysfs_exit(tdisk);
455
456 if (tt->exit)
457 tt->exit(tdisk->private_data, graceful);
458
459 nvm_remove_tgt_dev(t->dev, 1);
460 put_disk(tdisk);
461 module_put(t->type->owner);
462
463 list_del(&t->list);
464 kfree(t);
465}
466
467/**
468 * nvm_remove_tgt - Removes a target from the media manager
469 * @remove: ioctl structure with target name to remove.
470 *
471 * Returns:
472 * 0: on success
473 * 1: on not found
474 * <0: on error
475 */
476static int nvm_remove_tgt(struct nvm_ioctl_remove *remove)
477{
478 struct nvm_target *t = NULL;
479 struct nvm_dev *dev;
480
481 down_read(&nvm_lock);
482 list_for_each_entry(dev, &nvm_devices, devices) {
483 mutex_lock(&dev->mlock);
484 t = nvm_find_target(dev, remove->tgtname);
485 if (t) {
486 mutex_unlock(&dev->mlock);
487 break;
488 }
489 mutex_unlock(&dev->mlock);
490 }
491 up_read(&nvm_lock);
492
493 if (!t) {
494 pr_err("failed to remove target %s\n",
495 remove->tgtname);
496 return 1;
497 }
498
499 __nvm_remove_target(t, true);
500 kref_put(&dev->ref, nvm_free);
501
502 return 0;
503}
504
505static int nvm_register_map(struct nvm_dev *dev)
506{
507 struct nvm_dev_map *rmap;
508 int i, j;
509
510 rmap = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
511 if (!rmap)
512 goto err_rmap;
513
514 rmap->chnls = kcalloc(dev->geo.num_ch, sizeof(struct nvm_ch_map),
515 GFP_KERNEL);
516 if (!rmap->chnls)
517 goto err_chnls;
518
519 for (i = 0; i < dev->geo.num_ch; i++) {
520 struct nvm_ch_map *ch_rmap;
521 int *lun_roffs;
522 int luns_in_chnl = dev->geo.num_lun;
523
524 ch_rmap = &rmap->chnls[i];
525
526 ch_rmap->ch_off = -1;
527 ch_rmap->num_lun = luns_in_chnl;
528
529 lun_roffs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
530 if (!lun_roffs)
531 goto err_ch;
532
533 for (j = 0; j < luns_in_chnl; j++)
534 lun_roffs[j] = -1;
535
536 ch_rmap->lun_offs = lun_roffs;
537 }
538
539 dev->rmap = rmap;
540
541 return 0;
542err_ch:
543 while (--i >= 0)
544 kfree(rmap->chnls[i].lun_offs);
545err_chnls:
546 kfree(rmap);
547err_rmap:
548 return -ENOMEM;
549}
550
551static void nvm_unregister_map(struct nvm_dev *dev)
552{
553 struct nvm_dev_map *rmap = dev->rmap;
554 int i;
555
556 for (i = 0; i < dev->geo.num_ch; i++)
557 kfree(rmap->chnls[i].lun_offs);
558
559 kfree(rmap->chnls);
560 kfree(rmap);
561}
562
563static void nvm_map_to_dev(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
564{
565 struct nvm_dev_map *dev_map = tgt_dev->map;
566 struct nvm_ch_map *ch_map = &dev_map->chnls[p->a.ch];
567 int lun_off = ch_map->lun_offs[p->a.lun];
568
569 p->a.ch += ch_map->ch_off;
570 p->a.lun += lun_off;
571}
572
573static void nvm_map_to_tgt(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
574{
575 struct nvm_dev *dev = tgt_dev->parent;
576 struct nvm_dev_map *dev_rmap = dev->rmap;
577 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[p->a.ch];
578 int lun_roff = ch_rmap->lun_offs[p->a.lun];
579
580 p->a.ch -= ch_rmap->ch_off;
581 p->a.lun -= lun_roff;
582}
583
584static void nvm_ppa_tgt_to_dev(struct nvm_tgt_dev *tgt_dev,
585 struct ppa_addr *ppa_list, int nr_ppas)
586{
587 int i;
588
589 for (i = 0; i < nr_ppas; i++) {
590 nvm_map_to_dev(tgt_dev, &ppa_list[i]);
591 ppa_list[i] = generic_to_dev_addr(tgt_dev->parent, ppa_list[i]);
592 }
593}
594
595static void nvm_ppa_dev_to_tgt(struct nvm_tgt_dev *tgt_dev,
596 struct ppa_addr *ppa_list, int nr_ppas)
597{
598 int i;
599
600 for (i = 0; i < nr_ppas; i++) {
601 ppa_list[i] = dev_to_generic_addr(tgt_dev->parent, ppa_list[i]);
602 nvm_map_to_tgt(tgt_dev, &ppa_list[i]);
603 }
604}
605
606static void nvm_rq_tgt_to_dev(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
607{
608 struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
609
610 nvm_ppa_tgt_to_dev(tgt_dev, ppa_list, rqd->nr_ppas);
611}
612
613static void nvm_rq_dev_to_tgt(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
614{
615 struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
616
617 nvm_ppa_dev_to_tgt(tgt_dev, ppa_list, rqd->nr_ppas);
618}
619
620int nvm_register_tgt_type(struct nvm_tgt_type *tt)
621{
622 int ret = 0;
623
624 down_write(&nvm_tgtt_lock);
625 if (__nvm_find_target_type(tt->name))
626 ret = -EEXIST;
627 else
628 list_add(&tt->list, &nvm_tgt_types);
629 up_write(&nvm_tgtt_lock);
630
631 return ret;
632}
633EXPORT_SYMBOL(nvm_register_tgt_type);
634
635void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
636{
637 if (!tt)
638 return;
639
640 down_write(&nvm_tgtt_lock);
641 list_del(&tt->list);
642 up_write(&nvm_tgtt_lock);
643}
644EXPORT_SYMBOL(nvm_unregister_tgt_type);
645
646void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
647 dma_addr_t *dma_handler)
648{
649 return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
650 dma_handler);
651}
652EXPORT_SYMBOL(nvm_dev_dma_alloc);
653
654void nvm_dev_dma_free(struct nvm_dev *dev, void *addr, dma_addr_t dma_handler)
655{
656 dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
657}
658EXPORT_SYMBOL(nvm_dev_dma_free);
659
660static struct nvm_dev *nvm_find_nvm_dev(const char *name)
661{
662 struct nvm_dev *dev;
663
664 list_for_each_entry(dev, &nvm_devices, devices)
665 if (!strcmp(name, dev->name))
666 return dev;
667
668 return NULL;
669}
670
671static int nvm_set_rqd_ppalist(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd,
672 const struct ppa_addr *ppas, int nr_ppas)
673{
674 struct nvm_dev *dev = tgt_dev->parent;
675 struct nvm_geo *geo = &tgt_dev->geo;
676 int i, plane_cnt, pl_idx;
677 struct ppa_addr ppa;
678
679 if (geo->pln_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
680 rqd->nr_ppas = nr_ppas;
681 rqd->ppa_addr = ppas[0];
682
683 return 0;
684 }
685
686 rqd->nr_ppas = nr_ppas;
687 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
688 if (!rqd->ppa_list) {
689 pr_err("failed to allocate dma memory\n");
690 return -ENOMEM;
691 }
692
693 plane_cnt = geo->pln_mode;
694 rqd->nr_ppas *= plane_cnt;
695
696 for (i = 0; i < nr_ppas; i++) {
697 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
698 ppa = ppas[i];
699 ppa.g.pl = pl_idx;
700 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
701 }
702 }
703
704 return 0;
705}
706
707static void nvm_free_rqd_ppalist(struct nvm_tgt_dev *tgt_dev,
708 struct nvm_rq *rqd)
709{
710 if (!rqd->ppa_list)
711 return;
712
713 nvm_dev_dma_free(tgt_dev->parent, rqd->ppa_list, rqd->dma_ppa_list);
714}
715
716static int nvm_set_flags(struct nvm_geo *geo, struct nvm_rq *rqd)
717{
718 int flags = 0;
719
720 if (geo->version == NVM_OCSSD_SPEC_20)
721 return 0;
722
723 if (rqd->is_seq)
724 flags |= geo->pln_mode >> 1;
725
726 if (rqd->opcode == NVM_OP_PREAD)
727 flags |= (NVM_IO_SCRAMBLE_ENABLE | NVM_IO_SUSPEND);
728 else if (rqd->opcode == NVM_OP_PWRITE)
729 flags |= NVM_IO_SCRAMBLE_ENABLE;
730
731 return flags;
732}
733
734int nvm_submit_io(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd, void *buf)
735{
736 struct nvm_dev *dev = tgt_dev->parent;
737 int ret;
738
739 if (!dev->ops->submit_io)
740 return -ENODEV;
741
742 nvm_rq_tgt_to_dev(tgt_dev, rqd);
743
744 rqd->dev = tgt_dev;
745 rqd->flags = nvm_set_flags(&tgt_dev->geo, rqd);
746
747 /* In case of error, fail with right address format */
748 ret = dev->ops->submit_io(dev, rqd, buf);
749 if (ret)
750 nvm_rq_dev_to_tgt(tgt_dev, rqd);
751 return ret;
752}
753EXPORT_SYMBOL(nvm_submit_io);
754
755static void nvm_sync_end_io(struct nvm_rq *rqd)
756{
757 struct completion *waiting = rqd->private;
758
759 complete(waiting);
760}
761
762static int nvm_submit_io_wait(struct nvm_dev *dev, struct nvm_rq *rqd,
763 void *buf)
764{
765 DECLARE_COMPLETION_ONSTACK(wait);
766 int ret = 0;
767
768 rqd->end_io = nvm_sync_end_io;
769 rqd->private = &wait;
770
771 ret = dev->ops->submit_io(dev, rqd, buf);
772 if (ret)
773 return ret;
774
775 wait_for_completion_io(&wait);
776
777 return 0;
778}
779
780int nvm_submit_io_sync(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd,
781 void *buf)
782{
783 struct nvm_dev *dev = tgt_dev->parent;
784 int ret;
785
786 if (!dev->ops->submit_io)
787 return -ENODEV;
788
789 nvm_rq_tgt_to_dev(tgt_dev, rqd);
790
791 rqd->dev = tgt_dev;
792 rqd->flags = nvm_set_flags(&tgt_dev->geo, rqd);
793
794 ret = nvm_submit_io_wait(dev, rqd, buf);
795
796 return ret;
797}
798EXPORT_SYMBOL(nvm_submit_io_sync);
799
800void nvm_end_io(struct nvm_rq *rqd)
801{
802 struct nvm_tgt_dev *tgt_dev = rqd->dev;
803
804 /* Convert address space */
805 if (tgt_dev)
806 nvm_rq_dev_to_tgt(tgt_dev, rqd);
807
808 if (rqd->end_io)
809 rqd->end_io(rqd);
810}
811EXPORT_SYMBOL(nvm_end_io);
812
813static int nvm_submit_io_sync_raw(struct nvm_dev *dev, struct nvm_rq *rqd)
814{
815 if (!dev->ops->submit_io)
816 return -ENODEV;
817
818 rqd->dev = NULL;
819 rqd->flags = nvm_set_flags(&dev->geo, rqd);
820
821 return nvm_submit_io_wait(dev, rqd, NULL);
822}
823
824static int nvm_bb_chunk_sense(struct nvm_dev *dev, struct ppa_addr ppa)
825{
826 struct nvm_rq rqd = { NULL };
827 struct bio bio;
828 struct bio_vec bio_vec;
829 struct page *page;
830 int ret;
831
832 page = alloc_page(GFP_KERNEL);
833 if (!page)
834 return -ENOMEM;
835
836 bio_init(&bio, &bio_vec, 1);
837 bio_add_page(&bio, page, PAGE_SIZE, 0);
838 bio_set_op_attrs(&bio, REQ_OP_READ, 0);
839
840 rqd.bio = &bio;
841 rqd.opcode = NVM_OP_PREAD;
842 rqd.is_seq = 1;
843 rqd.nr_ppas = 1;
844 rqd.ppa_addr = generic_to_dev_addr(dev, ppa);
845
846 ret = nvm_submit_io_sync_raw(dev, &rqd);
847 if (ret)
848 return ret;
849
850 __free_page(page);
851
852 return rqd.error;
853}
854
855/*
856 * Scans a 1.2 chunk first and last page to determine if its state.
857 * If the chunk is found to be open, also scan it to update the write
858 * pointer.
859 */
860static int nvm_bb_chunk_scan(struct nvm_dev *dev, struct ppa_addr ppa,
861 struct nvm_chk_meta *meta)
862{
863 struct nvm_geo *geo = &dev->geo;
864 int ret, pg, pl;
865
866 /* sense first page */
867 ret = nvm_bb_chunk_sense(dev, ppa);
868 if (ret < 0) /* io error */
869 return ret;
870 else if (ret == 0) /* valid data */
871 meta->state = NVM_CHK_ST_OPEN;
872 else if (ret > 0) {
873 /*
874 * If empty page, the chunk is free, else it is an
875 * actual io error. In that case, mark it offline.
876 */
877 switch (ret) {
878 case NVM_RSP_ERR_EMPTYPAGE:
879 meta->state = NVM_CHK_ST_FREE;
880 return 0;
881 case NVM_RSP_ERR_FAILCRC:
882 case NVM_RSP_ERR_FAILECC:
883 case NVM_RSP_WARN_HIGHECC:
884 meta->state = NVM_CHK_ST_OPEN;
885 goto scan;
886 default:
887 return -ret; /* other io error */
888 }
889 }
890
891 /* sense last page */
892 ppa.g.pg = geo->num_pg - 1;
893 ppa.g.pl = geo->num_pln - 1;
894
895 ret = nvm_bb_chunk_sense(dev, ppa);
896 if (ret < 0) /* io error */
897 return ret;
898 else if (ret == 0) { /* Chunk fully written */
899 meta->state = NVM_CHK_ST_CLOSED;
900 meta->wp = geo->clba;
901 return 0;
902 } else if (ret > 0) {
903 switch (ret) {
904 case NVM_RSP_ERR_EMPTYPAGE:
905 case NVM_RSP_ERR_FAILCRC:
906 case NVM_RSP_ERR_FAILECC:
907 case NVM_RSP_WARN_HIGHECC:
908 meta->state = NVM_CHK_ST_OPEN;
909 break;
910 default:
911 return -ret; /* other io error */
912 }
913 }
914
915scan:
916 /*
917 * chunk is open, we scan sequentially to update the write pointer.
918 * We make the assumption that targets write data across all planes
919 * before moving to the next page.
920 */
921 for (pg = 0; pg < geo->num_pg; pg++) {
922 for (pl = 0; pl < geo->num_pln; pl++) {
923 ppa.g.pg = pg;
924 ppa.g.pl = pl;
925
926 ret = nvm_bb_chunk_sense(dev, ppa);
927 if (ret < 0) /* io error */
928 return ret;
929 else if (ret == 0) {
930 meta->wp += geo->ws_min;
931 } else if (ret > 0) {
932 switch (ret) {
933 case NVM_RSP_ERR_EMPTYPAGE:
934 return 0;
935 case NVM_RSP_ERR_FAILCRC:
936 case NVM_RSP_ERR_FAILECC:
937 case NVM_RSP_WARN_HIGHECC:
938 meta->wp += geo->ws_min;
939 break;
940 default:
941 return -ret; /* other io error */
942 }
943 }
944 }
945 }
946
947 return 0;
948}
949
950/*
951 * folds a bad block list from its plane representation to its
952 * chunk representation.
953 *
954 * If any of the planes status are bad or grown bad, the chunk is marked
955 * offline. If not bad, the first plane state acts as the chunk state.
956 */
957static int nvm_bb_to_chunk(struct nvm_dev *dev, struct ppa_addr ppa,
958 u8 *blks, int nr_blks, struct nvm_chk_meta *meta)
959{
960 struct nvm_geo *geo = &dev->geo;
961 int ret, blk, pl, offset, blktype;
962
963 for (blk = 0; blk < geo->num_chk; blk++) {
964 offset = blk * geo->pln_mode;
965 blktype = blks[offset];
966
967 for (pl = 0; pl < geo->pln_mode; pl++) {
968 if (blks[offset + pl] &
969 (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
970 blktype = blks[offset + pl];
971 break;
972 }
973 }
974
975 ppa.g.blk = blk;
976
977 meta->wp = 0;
978 meta->type = NVM_CHK_TP_W_SEQ;
979 meta->wi = 0;
980 meta->slba = generic_to_dev_addr(dev, ppa).ppa;
981 meta->cnlb = dev->geo.clba;
982
983 if (blktype == NVM_BLK_T_FREE) {
984 ret = nvm_bb_chunk_scan(dev, ppa, meta);
985 if (ret)
986 return ret;
987 } else {
988 meta->state = NVM_CHK_ST_OFFLINE;
989 }
990
991 meta++;
992 }
993
994 return 0;
995}
996
997static int nvm_get_bb_meta(struct nvm_dev *dev, sector_t slba,
998 int nchks, struct nvm_chk_meta *meta)
999{
1000 struct nvm_geo *geo = &dev->geo;
1001 struct ppa_addr ppa;
1002 u8 *blks;
1003 int ch, lun, nr_blks;
1004 int ret = 0;
1005
1006 ppa.ppa = slba;
1007 ppa = dev_to_generic_addr(dev, ppa);
1008
1009 if (ppa.g.blk != 0)
1010 return -EINVAL;
1011
1012 if ((nchks % geo->num_chk) != 0)
1013 return -EINVAL;
1014
1015 nr_blks = geo->num_chk * geo->pln_mode;
1016
1017 blks = kmalloc(nr_blks, GFP_KERNEL);
1018 if (!blks)
1019 return -ENOMEM;
1020
1021 for (ch = ppa.g.ch; ch < geo->num_ch; ch++) {
1022 for (lun = ppa.g.lun; lun < geo->num_lun; lun++) {
1023 struct ppa_addr ppa_gen, ppa_dev;
1024
1025 if (!nchks)
1026 goto done;
1027
1028 ppa_gen.ppa = 0;
1029 ppa_gen.g.ch = ch;
1030 ppa_gen.g.lun = lun;
1031 ppa_dev = generic_to_dev_addr(dev, ppa_gen);
1032
1033 ret = dev->ops->get_bb_tbl(dev, ppa_dev, blks);
1034 if (ret)
1035 goto done;
1036
1037 ret = nvm_bb_to_chunk(dev, ppa_gen, blks, nr_blks,
1038 meta);
1039 if (ret)
1040 goto done;
1041
1042 meta += geo->num_chk;
1043 nchks -= geo->num_chk;
1044 }
1045 }
1046done:
1047 kfree(blks);
1048 return ret;
1049}
1050
1051int nvm_get_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
1052 int nchks, struct nvm_chk_meta *meta)
1053{
1054 struct nvm_dev *dev = tgt_dev->parent;
1055
1056 nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
1057
1058 if (dev->geo.version == NVM_OCSSD_SPEC_12)
1059 return nvm_get_bb_meta(dev, (sector_t)ppa.ppa, nchks, meta);
1060
1061 return dev->ops->get_chk_meta(dev, (sector_t)ppa.ppa, nchks, meta);
1062}
1063EXPORT_SYMBOL_GPL(nvm_get_chunk_meta);
1064
1065int nvm_set_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
1066 int nr_ppas, int type)
1067{
1068 struct nvm_dev *dev = tgt_dev->parent;
1069 struct nvm_rq rqd;
1070 int ret;
1071
1072 if (dev->geo.version == NVM_OCSSD_SPEC_20)
1073 return 0;
1074
1075 if (nr_ppas > NVM_MAX_VLBA) {
1076 pr_err("unable to update all blocks atomically\n");
1077 return -EINVAL;
1078 }
1079
1080 memset(&rqd, 0, sizeof(struct nvm_rq));
1081
1082 nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas);
1083 nvm_rq_tgt_to_dev(tgt_dev, &rqd);
1084
1085 ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
1086 nvm_free_rqd_ppalist(tgt_dev, &rqd);
1087 if (ret)
1088 return -EINVAL;
1089
1090 return 0;
1091}
1092EXPORT_SYMBOL_GPL(nvm_set_chunk_meta);
1093
1094static int nvm_core_init(struct nvm_dev *dev)
1095{
1096 struct nvm_geo *geo = &dev->geo;
1097 int ret;
1098
1099 dev->lun_map = kcalloc(BITS_TO_LONGS(geo->all_luns),
1100 sizeof(unsigned long), GFP_KERNEL);
1101 if (!dev->lun_map)
1102 return -ENOMEM;
1103
1104 INIT_LIST_HEAD(&dev->area_list);
1105 INIT_LIST_HEAD(&dev->targets);
1106 mutex_init(&dev->mlock);
1107 spin_lock_init(&dev->lock);
1108
1109 ret = nvm_register_map(dev);
1110 if (ret)
1111 goto err_fmtype;
1112
1113 return 0;
1114err_fmtype:
1115 kfree(dev->lun_map);
1116 return ret;
1117}
1118
1119static void nvm_free(struct kref *ref)
1120{
1121 struct nvm_dev *dev = container_of(ref, struct nvm_dev, ref);
1122
1123 if (dev->dma_pool)
1124 dev->ops->destroy_dma_pool(dev->dma_pool);
1125
1126 if (dev->rmap)
1127 nvm_unregister_map(dev);
1128
1129 kfree(dev->lun_map);
1130 kfree(dev);
1131}
1132
1133static int nvm_init(struct nvm_dev *dev)
1134{
1135 struct nvm_geo *geo = &dev->geo;
1136 int ret = -EINVAL;
1137
1138 if (dev->ops->identity(dev)) {
1139 pr_err("device could not be identified\n");
1140 goto err;
1141 }
1142
1143 pr_debug("ver:%u.%u nvm_vendor:%x\n", geo->major_ver_id,
1144 geo->minor_ver_id, geo->vmnt);
1145
1146 ret = nvm_core_init(dev);
1147 if (ret) {
1148 pr_err("could not initialize core structures.\n");
1149 goto err;
1150 }
1151
1152 pr_info("registered %s [%u/%u/%u/%u/%u]\n",
1153 dev->name, dev->geo.ws_min, dev->geo.ws_opt,
1154 dev->geo.num_chk, dev->geo.all_luns,
1155 dev->geo.num_ch);
1156 return 0;
1157err:
1158 pr_err("failed to initialize nvm\n");
1159 return ret;
1160}
1161
1162struct nvm_dev *nvm_alloc_dev(int node)
1163{
1164 struct nvm_dev *dev;
1165
1166 dev = kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
1167 if (dev)
1168 kref_init(&dev->ref);
1169
1170 return dev;
1171}
1172EXPORT_SYMBOL(nvm_alloc_dev);
1173
1174int nvm_register(struct nvm_dev *dev)
1175{
1176 int ret, exp_pool_size;
1177
1178 if (!dev->q || !dev->ops) {
1179 kref_put(&dev->ref, nvm_free);
1180 return -EINVAL;
1181 }
1182
1183 ret = nvm_init(dev);
1184 if (ret) {
1185 kref_put(&dev->ref, nvm_free);
1186 return ret;
1187 }
1188
1189 exp_pool_size = max_t(int, PAGE_SIZE,
1190 (NVM_MAX_VLBA * (sizeof(u64) + dev->geo.sos)));
1191 exp_pool_size = round_up(exp_pool_size, PAGE_SIZE);
1192
1193 dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist",
1194 exp_pool_size);
1195 if (!dev->dma_pool) {
1196 pr_err("could not create dma pool\n");
1197 kref_put(&dev->ref, nvm_free);
1198 return -ENOMEM;
1199 }
1200
1201 /* register device with a supported media manager */
1202 down_write(&nvm_lock);
1203 list_add(&dev->devices, &nvm_devices);
1204 up_write(&nvm_lock);
1205
1206 return 0;
1207}
1208EXPORT_SYMBOL(nvm_register);
1209
1210void nvm_unregister(struct nvm_dev *dev)
1211{
1212 struct nvm_target *t, *tmp;
1213
1214 mutex_lock(&dev->mlock);
1215 list_for_each_entry_safe(t, tmp, &dev->targets, list) {
1216 if (t->dev->parent != dev)
1217 continue;
1218 __nvm_remove_target(t, false);
1219 kref_put(&dev->ref, nvm_free);
1220 }
1221 mutex_unlock(&dev->mlock);
1222
1223 down_write(&nvm_lock);
1224 list_del(&dev->devices);
1225 up_write(&nvm_lock);
1226
1227 kref_put(&dev->ref, nvm_free);
1228}
1229EXPORT_SYMBOL(nvm_unregister);
1230
1231static int __nvm_configure_create(struct nvm_ioctl_create *create)
1232{
1233 struct nvm_dev *dev;
1234 int ret;
1235
1236 down_write(&nvm_lock);
1237 dev = nvm_find_nvm_dev(create->dev);
1238 up_write(&nvm_lock);
1239
1240 if (!dev) {
1241 pr_err("device not found\n");
1242 return -EINVAL;
1243 }
1244
1245 kref_get(&dev->ref);
1246 ret = nvm_create_tgt(dev, create);
1247 if (ret)
1248 kref_put(&dev->ref, nvm_free);
1249
1250 return ret;
1251}
1252
1253static long nvm_ioctl_info(struct file *file, void __user *arg)
1254{
1255 struct nvm_ioctl_info *info;
1256 struct nvm_tgt_type *tt;
1257 int tgt_iter = 0;
1258
1259 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1260 if (IS_ERR(info))
1261 return -EFAULT;
1262
1263 info->version[0] = NVM_VERSION_MAJOR;
1264 info->version[1] = NVM_VERSION_MINOR;
1265 info->version[2] = NVM_VERSION_PATCH;
1266
1267 down_write(&nvm_tgtt_lock);
1268 list_for_each_entry(tt, &nvm_tgt_types, list) {
1269 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1270
1271 tgt->version[0] = tt->version[0];
1272 tgt->version[1] = tt->version[1];
1273 tgt->version[2] = tt->version[2];
1274 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1275
1276 tgt_iter++;
1277 }
1278
1279 info->tgtsize = tgt_iter;
1280 up_write(&nvm_tgtt_lock);
1281
1282 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1283 kfree(info);
1284 return -EFAULT;
1285 }
1286
1287 kfree(info);
1288 return 0;
1289}
1290
1291static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1292{
1293 struct nvm_ioctl_get_devices *devices;
1294 struct nvm_dev *dev;
1295 int i = 0;
1296
1297 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1298 if (!devices)
1299 return -ENOMEM;
1300
1301 down_write(&nvm_lock);
1302 list_for_each_entry(dev, &nvm_devices, devices) {
1303 struct nvm_ioctl_device_info *info = &devices->info[i];
1304
1305 strlcpy(info->devname, dev->name, sizeof(info->devname));
1306
1307 /* kept for compatibility */
1308 info->bmversion[0] = 1;
1309 info->bmversion[1] = 0;
1310 info->bmversion[2] = 0;
1311 strlcpy(info->bmname, "gennvm", sizeof(info->bmname));
1312 i++;
1313
1314 if (i > 31) {
1315 pr_err("max 31 devices can be reported.\n");
1316 break;
1317 }
1318 }
1319 up_write(&nvm_lock);
1320
1321 devices->nr_devices = i;
1322
1323 if (copy_to_user(arg, devices,
1324 sizeof(struct nvm_ioctl_get_devices))) {
1325 kfree(devices);
1326 return -EFAULT;
1327 }
1328
1329 kfree(devices);
1330 return 0;
1331}
1332
1333static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1334{
1335 struct nvm_ioctl_create create;
1336
1337 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1338 return -EFAULT;
1339
1340 if (create.conf.type == NVM_CONFIG_TYPE_EXTENDED &&
1341 create.conf.e.rsv != 0) {
1342 pr_err("reserved config field in use\n");
1343 return -EINVAL;
1344 }
1345
1346 create.dev[DISK_NAME_LEN - 1] = '\0';
1347 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1348 create.tgtname[DISK_NAME_LEN - 1] = '\0';
1349
1350 if (create.flags != 0) {
1351 __u32 flags = create.flags;
1352
1353 /* Check for valid flags */
1354 if (flags & NVM_TARGET_FACTORY)
1355 flags &= ~NVM_TARGET_FACTORY;
1356
1357 if (flags) {
1358 pr_err("flag not supported\n");
1359 return -EINVAL;
1360 }
1361 }
1362
1363 return __nvm_configure_create(&create);
1364}
1365
1366static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1367{
1368 struct nvm_ioctl_remove remove;
1369
1370 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1371 return -EFAULT;
1372
1373 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1374
1375 if (remove.flags != 0) {
1376 pr_err("no flags supported\n");
1377 return -EINVAL;
1378 }
1379
1380 return nvm_remove_tgt(&remove);
1381}
1382
1383/* kept for compatibility reasons */
1384static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1385{
1386 struct nvm_ioctl_dev_init init;
1387
1388 if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1389 return -EFAULT;
1390
1391 if (init.flags != 0) {
1392 pr_err("no flags supported\n");
1393 return -EINVAL;
1394 }
1395
1396 return 0;
1397}
1398
1399/* Kept for compatibility reasons */
1400static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1401{
1402 struct nvm_ioctl_dev_factory fact;
1403
1404 if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1405 return -EFAULT;
1406
1407 fact.dev[DISK_NAME_LEN - 1] = '\0';
1408
1409 if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1410 return -EINVAL;
1411
1412 return 0;
1413}
1414
1415static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1416{
1417 void __user *argp = (void __user *)arg;
1418
1419 if (!capable(CAP_SYS_ADMIN))
1420 return -EPERM;
1421
1422 switch (cmd) {
1423 case NVM_INFO:
1424 return nvm_ioctl_info(file, argp);
1425 case NVM_GET_DEVICES:
1426 return nvm_ioctl_get_devices(file, argp);
1427 case NVM_DEV_CREATE:
1428 return nvm_ioctl_dev_create(file, argp);
1429 case NVM_DEV_REMOVE:
1430 return nvm_ioctl_dev_remove(file, argp);
1431 case NVM_DEV_INIT:
1432 return nvm_ioctl_dev_init(file, argp);
1433 case NVM_DEV_FACTORY:
1434 return nvm_ioctl_dev_factory(file, argp);
1435 }
1436 return 0;
1437}
1438
1439static const struct file_operations _ctl_fops = {
1440 .open = nonseekable_open,
1441 .unlocked_ioctl = nvm_ctl_ioctl,
1442 .owner = THIS_MODULE,
1443 .llseek = noop_llseek,
1444};
1445
1446static struct miscdevice _nvm_misc = {
1447 .minor = MISC_DYNAMIC_MINOR,
1448 .name = "lightnvm",
1449 .nodename = "lightnvm/control",
1450 .fops = &_ctl_fops,
1451};
1452builtin_misc_device(_nvm_misc);
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
33static LIST_HEAD(nvm_targets);
34static LIST_HEAD(nvm_mgrs);
35static LIST_HEAD(nvm_devices);
36static DECLARE_RWSEM(nvm_lock);
37
38static 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
49int 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}
62EXPORT_SYMBOL(nvm_register_target);
63
64void 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}
73EXPORT_SYMBOL(nvm_unregister_target);
74
75void *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}
81EXPORT_SYMBOL(nvm_dev_dma_alloc);
82
83void 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}
88EXPORT_SYMBOL(nvm_dev_dma_free);
89
90static 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
101struct 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
124int 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 }
144finish:
145 up_write(&nvm_lock);
146
147 return ret;
148}
149EXPORT_SYMBOL(nvm_register_mgr);
150
151void 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}
160EXPORT_SYMBOL(nvm_unregister_mgr);
161
162static 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
173struct 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}
178EXPORT_SYMBOL(nvm_get_blk_unlocked);
179
180/* Assumes that all valid pages have already been moved on release to bm */
181void nvm_put_blk_unlocked(struct nvm_dev *dev, struct nvm_block *blk)
182{
183 return dev->mt->put_blk_unlocked(dev, blk);
184}
185EXPORT_SYMBOL(nvm_put_blk_unlocked);
186
187struct 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}
192EXPORT_SYMBOL(nvm_get_blk);
193
194/* Assumes that all valid pages have already been moved on release to bm */
195void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
196{
197 return dev->mt->put_blk(dev, blk);
198}
199EXPORT_SYMBOL(nvm_put_blk);
200
201int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
202{
203 return dev->mt->submit_io(dev, rqd);
204}
205EXPORT_SYMBOL(nvm_submit_io);
206
207int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk)
208{
209 return dev->mt->erase_blk(dev, blk, 0);
210}
211EXPORT_SYMBOL(nvm_erase_blk);
212
213void 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}
225EXPORT_SYMBOL(nvm_addr_to_generic_mode);
226
227void 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}
239EXPORT_SYMBOL(nvm_generic_to_addr_mode);
240
241int 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}
274EXPORT_SYMBOL(nvm_set_rqd_ppalist);
275
276void 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}
283EXPORT_SYMBOL(nvm_free_rqd_ppalist);
284
285int 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}
307EXPORT_SYMBOL(nvm_erase_ppa);
308
309void nvm_end_io(struct nvm_rq *rqd, int error)
310{
311 rqd->error = error;
312 rqd->end_io(rqd);
313}
314EXPORT_SYMBOL(nvm_end_io);
315
316static 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
325int 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
355 /* Prevent hang_check timer from firing at us during very long I/O */
356 hang_check = sysctl_hung_task_timeout_secs;
357 if (hang_check)
358 while (!wait_for_completion_io_timeout(&wait, hang_check * (HZ/2)));
359 else
360 wait_for_completion_io(&wait);
361
362 nvm_free_rqd_ppalist(dev, &rqd);
363
364 return rqd.error;
365}
366EXPORT_SYMBOL(nvm_submit_ppa);
367
368static int nvm_init_slc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
369{
370 int i;
371
372 dev->lps_per_blk = dev->pgs_per_blk;
373 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
374 if (!dev->lptbl)
375 return -ENOMEM;
376
377 /* Just a linear array */
378 for (i = 0; i < dev->lps_per_blk; i++)
379 dev->lptbl[i] = i;
380
381 return 0;
382}
383
384static int nvm_init_mlc_tbl(struct nvm_dev *dev, struct nvm_id_group *grp)
385{
386 int i, p;
387 struct nvm_id_lp_mlc *mlc = &grp->lptbl.mlc;
388
389 if (!mlc->num_pairs)
390 return 0;
391
392 dev->lps_per_blk = mlc->num_pairs;
393 dev->lptbl = kcalloc(dev->lps_per_blk, sizeof(int), GFP_KERNEL);
394 if (!dev->lptbl)
395 return -ENOMEM;
396
397 /* The lower page table encoding consists of a list of bytes, where each
398 * has a lower and an upper half. The first half byte maintains the
399 * increment value and every value after is an offset added to the
400 * previous incrementation value */
401 dev->lptbl[0] = mlc->pairs[0] & 0xF;
402 for (i = 1; i < dev->lps_per_blk; i++) {
403 p = mlc->pairs[i >> 1];
404 if (i & 0x1) /* upper */
405 dev->lptbl[i] = dev->lptbl[i - 1] + ((p & 0xF0) >> 4);
406 else /* lower */
407 dev->lptbl[i] = dev->lptbl[i - 1] + (p & 0xF);
408 }
409
410 return 0;
411}
412
413static int nvm_core_init(struct nvm_dev *dev)
414{
415 struct nvm_id *id = &dev->identity;
416 struct nvm_id_group *grp = &id->groups[0];
417
418 /* device values */
419 dev->nr_chnls = grp->num_ch;
420 dev->luns_per_chnl = grp->num_lun;
421 dev->pgs_per_blk = grp->num_pg;
422 dev->blks_per_lun = grp->num_blk;
423 dev->nr_planes = grp->num_pln;
424 dev->sec_size = grp->csecs;
425 dev->oob_size = grp->sos;
426 dev->sec_per_pg = grp->fpg_sz / grp->csecs;
427 dev->mccap = grp->mccap;
428 memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
429
430 dev->plane_mode = NVM_PLANE_SINGLE;
431 dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
432
433 if (grp->mtype != 0) {
434 pr_err("nvm: memory type not supported\n");
435 return -EINVAL;
436 }
437
438 switch (grp->fmtype) {
439 case NVM_ID_FMTYPE_SLC:
440 if (nvm_init_slc_tbl(dev, grp))
441 return -ENOMEM;
442 break;
443 case NVM_ID_FMTYPE_MLC:
444 if (nvm_init_mlc_tbl(dev, grp))
445 return -ENOMEM;
446 break;
447 default:
448 pr_err("nvm: flash type not supported\n");
449 return -EINVAL;
450 }
451
452 if (!dev->lps_per_blk)
453 pr_info("nvm: lower page programming table missing\n");
454
455 if (grp->mpos & 0x020202)
456 dev->plane_mode = NVM_PLANE_DOUBLE;
457 if (grp->mpos & 0x040404)
458 dev->plane_mode = NVM_PLANE_QUAD;
459
460 /* calculated values */
461 dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
462 dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
463 dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
464 dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
465
466 dev->total_secs = dev->nr_luns * dev->sec_per_lun;
467 dev->lun_map = kcalloc(BITS_TO_LONGS(dev->nr_luns),
468 sizeof(unsigned long), GFP_KERNEL);
469 if (!dev->lun_map)
470 return -ENOMEM;
471 INIT_LIST_HEAD(&dev->online_targets);
472 mutex_init(&dev->mlock);
473 spin_lock_init(&dev->lock);
474
475 return 0;
476}
477
478static void nvm_free(struct nvm_dev *dev)
479{
480 if (!dev)
481 return;
482
483 if (dev->mt)
484 dev->mt->unregister_mgr(dev);
485
486 kfree(dev->lptbl);
487}
488
489static int nvm_init(struct nvm_dev *dev)
490{
491 int ret = -EINVAL;
492
493 if (!dev->q || !dev->ops)
494 return ret;
495
496 if (dev->ops->identity(dev, &dev->identity)) {
497 pr_err("nvm: device could not be identified\n");
498 goto err;
499 }
500
501 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
502 dev->identity.ver_id, dev->identity.vmnt,
503 dev->identity.cgrps);
504
505 if (dev->identity.ver_id != 1) {
506 pr_err("nvm: device not supported by kernel.");
507 goto err;
508 }
509
510 if (dev->identity.cgrps != 1) {
511 pr_err("nvm: only one group configuration supported.");
512 goto err;
513 }
514
515 ret = nvm_core_init(dev);
516 if (ret) {
517 pr_err("nvm: could not initialize core structures.\n");
518 goto err;
519 }
520
521 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
522 dev->name, dev->sec_per_pg, dev->nr_planes,
523 dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
524 dev->nr_chnls);
525 return 0;
526err:
527 pr_err("nvm: failed to initialize nvm\n");
528 return ret;
529}
530
531static void nvm_exit(struct nvm_dev *dev)
532{
533 if (dev->ppalist_pool)
534 dev->ops->destroy_dma_pool(dev->ppalist_pool);
535 nvm_free(dev);
536
537 pr_info("nvm: successfully unloaded\n");
538}
539
540int nvm_register(struct request_queue *q, char *disk_name,
541 struct nvm_dev_ops *ops)
542{
543 struct nvm_dev *dev;
544 int ret;
545
546 if (!ops->identity)
547 return -EINVAL;
548
549 dev = kzalloc(sizeof(struct nvm_dev), GFP_KERNEL);
550 if (!dev)
551 return -ENOMEM;
552
553 dev->q = q;
554 dev->ops = ops;
555 strncpy(dev->name, disk_name, DISK_NAME_LEN);
556
557 ret = nvm_init(dev);
558 if (ret)
559 goto err_init;
560
561 if (dev->ops->max_phys_sect > 256) {
562 pr_info("nvm: max sectors supported is 256.\n");
563 ret = -EINVAL;
564 goto err_init;
565 }
566
567 if (dev->ops->max_phys_sect > 1) {
568 dev->ppalist_pool = dev->ops->create_dma_pool(dev, "ppalist");
569 if (!dev->ppalist_pool) {
570 pr_err("nvm: could not create ppa pool\n");
571 ret = -ENOMEM;
572 goto err_init;
573 }
574 }
575
576 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
577 ret = nvm_get_sysblock(dev, &dev->sb);
578 if (!ret)
579 pr_err("nvm: device not initialized.\n");
580 else if (ret < 0)
581 pr_err("nvm: err (%d) on device initialization\n", ret);
582 }
583
584 /* register device with a supported media manager */
585 down_write(&nvm_lock);
586 if (ret > 0)
587 dev->mt = nvm_init_mgr(dev);
588 list_add(&dev->devices, &nvm_devices);
589 up_write(&nvm_lock);
590
591 return 0;
592err_init:
593 kfree(dev->lun_map);
594 kfree(dev);
595 return ret;
596}
597EXPORT_SYMBOL(nvm_register);
598
599void nvm_unregister(char *disk_name)
600{
601 struct nvm_dev *dev;
602
603 down_write(&nvm_lock);
604 dev = nvm_find_nvm_dev(disk_name);
605 if (!dev) {
606 pr_err("nvm: could not find device %s to unregister\n",
607 disk_name);
608 up_write(&nvm_lock);
609 return;
610 }
611
612 list_del(&dev->devices);
613 up_write(&nvm_lock);
614
615 nvm_exit(dev);
616 kfree(dev->lun_map);
617 kfree(dev);
618}
619EXPORT_SYMBOL(nvm_unregister);
620
621static const struct block_device_operations nvm_fops = {
622 .owner = THIS_MODULE,
623};
624
625static int nvm_create_target(struct nvm_dev *dev,
626 struct nvm_ioctl_create *create)
627{
628 struct nvm_ioctl_create_simple *s = &create->conf.s;
629 struct request_queue *tqueue;
630 struct gendisk *tdisk;
631 struct nvm_tgt_type *tt;
632 struct nvm_target *t;
633 void *targetdata;
634
635 if (!dev->mt) {
636 pr_info("nvm: device has no media manager registered.\n");
637 return -ENODEV;
638 }
639
640 down_write(&nvm_lock);
641 tt = nvm_find_target_type(create->tgttype);
642 if (!tt) {
643 pr_err("nvm: target type %s not found\n", create->tgttype);
644 up_write(&nvm_lock);
645 return -EINVAL;
646 }
647
648 list_for_each_entry(t, &dev->online_targets, list) {
649 if (!strcmp(create->tgtname, t->disk->disk_name)) {
650 pr_err("nvm: target name already exists.\n");
651 up_write(&nvm_lock);
652 return -EINVAL;
653 }
654 }
655 up_write(&nvm_lock);
656
657 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
658 if (!t)
659 return -ENOMEM;
660
661 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
662 if (!tqueue)
663 goto err_t;
664 blk_queue_make_request(tqueue, tt->make_rq);
665
666 tdisk = alloc_disk(0);
667 if (!tdisk)
668 goto err_queue;
669
670 sprintf(tdisk->disk_name, "%s", create->tgtname);
671 tdisk->flags = GENHD_FL_EXT_DEVT;
672 tdisk->major = 0;
673 tdisk->first_minor = 0;
674 tdisk->fops = &nvm_fops;
675 tdisk->queue = tqueue;
676
677 targetdata = tt->init(dev, tdisk, s->lun_begin, s->lun_end);
678 if (IS_ERR(targetdata))
679 goto err_init;
680
681 tdisk->private_data = targetdata;
682 tqueue->queuedata = targetdata;
683
684 blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
685
686 set_capacity(tdisk, tt->capacity(targetdata));
687 add_disk(tdisk);
688
689 t->type = tt;
690 t->disk = tdisk;
691
692 down_write(&nvm_lock);
693 list_add_tail(&t->list, &dev->online_targets);
694 up_write(&nvm_lock);
695
696 return 0;
697err_init:
698 put_disk(tdisk);
699err_queue:
700 blk_cleanup_queue(tqueue);
701err_t:
702 kfree(t);
703 return -ENOMEM;
704}
705
706static void nvm_remove_target(struct nvm_target *t)
707{
708 struct nvm_tgt_type *tt = t->type;
709 struct gendisk *tdisk = t->disk;
710 struct request_queue *q = tdisk->queue;
711
712 lockdep_assert_held(&nvm_lock);
713
714 del_gendisk(tdisk);
715 blk_cleanup_queue(q);
716
717 if (tt->exit)
718 tt->exit(tdisk->private_data);
719
720 put_disk(tdisk);
721
722 list_del(&t->list);
723 kfree(t);
724}
725
726static int __nvm_configure_create(struct nvm_ioctl_create *create)
727{
728 struct nvm_dev *dev;
729 struct nvm_ioctl_create_simple *s;
730
731 down_write(&nvm_lock);
732 dev = nvm_find_nvm_dev(create->dev);
733 up_write(&nvm_lock);
734 if (!dev) {
735 pr_err("nvm: device not found\n");
736 return -EINVAL;
737 }
738
739 if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
740 pr_err("nvm: config type not valid\n");
741 return -EINVAL;
742 }
743 s = &create->conf.s;
744
745 if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
746 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
747 s->lun_begin, s->lun_end, dev->nr_luns);
748 return -EINVAL;
749 }
750
751 return nvm_create_target(dev, create);
752}
753
754static int __nvm_configure_remove(struct nvm_ioctl_remove *remove)
755{
756 struct nvm_target *t = NULL;
757 struct nvm_dev *dev;
758 int ret = -1;
759
760 down_write(&nvm_lock);
761 list_for_each_entry(dev, &nvm_devices, devices)
762 list_for_each_entry(t, &dev->online_targets, list) {
763 if (!strcmp(remove->tgtname, t->disk->disk_name)) {
764 nvm_remove_target(t);
765 ret = 0;
766 break;
767 }
768 }
769 up_write(&nvm_lock);
770
771 if (ret) {
772 pr_err("nvm: target \"%s\" doesn't exist.\n", remove->tgtname);
773 return -EINVAL;
774 }
775
776 return 0;
777}
778
779#ifdef CONFIG_NVM_DEBUG
780static int nvm_configure_show(const char *val)
781{
782 struct nvm_dev *dev;
783 char opcode, devname[DISK_NAME_LEN];
784 int ret;
785
786 ret = sscanf(val, "%c %32s", &opcode, devname);
787 if (ret != 2) {
788 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
789 return -EINVAL;
790 }
791
792 down_write(&nvm_lock);
793 dev = nvm_find_nvm_dev(devname);
794 up_write(&nvm_lock);
795 if (!dev) {
796 pr_err("nvm: device not found\n");
797 return -EINVAL;
798 }
799
800 if (!dev->mt)
801 return 0;
802
803 dev->mt->lun_info_print(dev);
804
805 return 0;
806}
807
808static int nvm_configure_remove(const char *val)
809{
810 struct nvm_ioctl_remove remove;
811 char opcode;
812 int ret;
813
814 ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
815 if (ret != 2) {
816 pr_err("nvm: invalid command. Use \"d targetname\".\n");
817 return -EINVAL;
818 }
819
820 remove.flags = 0;
821
822 return __nvm_configure_remove(&remove);
823}
824
825static int nvm_configure_create(const char *val)
826{
827 struct nvm_ioctl_create create;
828 char opcode;
829 int lun_begin, lun_end, ret;
830
831 ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
832 create.tgtname, create.tgttype,
833 &lun_begin, &lun_end);
834 if (ret != 6) {
835 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
836 return -EINVAL;
837 }
838
839 create.flags = 0;
840 create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
841 create.conf.s.lun_begin = lun_begin;
842 create.conf.s.lun_end = lun_end;
843
844 return __nvm_configure_create(&create);
845}
846
847
848/* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
849static int nvm_configure_by_str_event(const char *val,
850 const struct kernel_param *kp)
851{
852 char opcode;
853 int ret;
854
855 ret = sscanf(val, "%c", &opcode);
856 if (ret != 1) {
857 pr_err("nvm: string must have the format of \"cmd ...\"\n");
858 return -EINVAL;
859 }
860
861 switch (opcode) {
862 case 'a':
863 return nvm_configure_create(val);
864 case 'd':
865 return nvm_configure_remove(val);
866 case 's':
867 return nvm_configure_show(val);
868 default:
869 pr_err("nvm: invalid command\n");
870 return -EINVAL;
871 }
872
873 return 0;
874}
875
876static int nvm_configure_get(char *buf, const struct kernel_param *kp)
877{
878 int sz;
879 struct nvm_dev *dev;
880
881 sz = sprintf(buf, "available devices:\n");
882 down_write(&nvm_lock);
883 list_for_each_entry(dev, &nvm_devices, devices) {
884 if (sz > 4095 - DISK_NAME_LEN - 2)
885 break;
886 sz += sprintf(buf + sz, " %32s\n", dev->name);
887 }
888 up_write(&nvm_lock);
889
890 return sz;
891}
892
893static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
894 .set = nvm_configure_by_str_event,
895 .get = nvm_configure_get,
896};
897
898#undef MODULE_PARAM_PREFIX
899#define MODULE_PARAM_PREFIX "lnvm."
900
901module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
902 0644);
903
904#endif /* CONFIG_NVM_DEBUG */
905
906static long nvm_ioctl_info(struct file *file, void __user *arg)
907{
908 struct nvm_ioctl_info *info;
909 struct nvm_tgt_type *tt;
910 int tgt_iter = 0;
911
912 if (!capable(CAP_SYS_ADMIN))
913 return -EPERM;
914
915 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
916 if (IS_ERR(info))
917 return -EFAULT;
918
919 info->version[0] = NVM_VERSION_MAJOR;
920 info->version[1] = NVM_VERSION_MINOR;
921 info->version[2] = NVM_VERSION_PATCH;
922
923 down_write(&nvm_lock);
924 list_for_each_entry(tt, &nvm_targets, list) {
925 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
926
927 tgt->version[0] = tt->version[0];
928 tgt->version[1] = tt->version[1];
929 tgt->version[2] = tt->version[2];
930 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
931
932 tgt_iter++;
933 }
934
935 info->tgtsize = tgt_iter;
936 up_write(&nvm_lock);
937
938 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
939 kfree(info);
940 return -EFAULT;
941 }
942
943 kfree(info);
944 return 0;
945}
946
947static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
948{
949 struct nvm_ioctl_get_devices *devices;
950 struct nvm_dev *dev;
951 int i = 0;
952
953 if (!capable(CAP_SYS_ADMIN))
954 return -EPERM;
955
956 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
957 if (!devices)
958 return -ENOMEM;
959
960 down_write(&nvm_lock);
961 list_for_each_entry(dev, &nvm_devices, devices) {
962 struct nvm_ioctl_device_info *info = &devices->info[i];
963
964 sprintf(info->devname, "%s", dev->name);
965 if (dev->mt) {
966 info->bmversion[0] = dev->mt->version[0];
967 info->bmversion[1] = dev->mt->version[1];
968 info->bmversion[2] = dev->mt->version[2];
969 sprintf(info->bmname, "%s", dev->mt->name);
970 } else {
971 sprintf(info->bmname, "none");
972 }
973
974 i++;
975 if (i > 31) {
976 pr_err("nvm: max 31 devices can be reported.\n");
977 break;
978 }
979 }
980 up_write(&nvm_lock);
981
982 devices->nr_devices = i;
983
984 if (copy_to_user(arg, devices,
985 sizeof(struct nvm_ioctl_get_devices))) {
986 kfree(devices);
987 return -EFAULT;
988 }
989
990 kfree(devices);
991 return 0;
992}
993
994static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
995{
996 struct nvm_ioctl_create create;
997
998 if (!capable(CAP_SYS_ADMIN))
999 return -EPERM;
1000
1001 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1002 return -EFAULT;
1003
1004 create.dev[DISK_NAME_LEN - 1] = '\0';
1005 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1006 create.tgtname[DISK_NAME_LEN - 1] = '\0';
1007
1008 if (create.flags != 0) {
1009 pr_err("nvm: no flags supported\n");
1010 return -EINVAL;
1011 }
1012
1013 return __nvm_configure_create(&create);
1014}
1015
1016static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1017{
1018 struct nvm_ioctl_remove remove;
1019
1020 if (!capable(CAP_SYS_ADMIN))
1021 return -EPERM;
1022
1023 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1024 return -EFAULT;
1025
1026 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1027
1028 if (remove.flags != 0) {
1029 pr_err("nvm: no flags supported\n");
1030 return -EINVAL;
1031 }
1032
1033 return __nvm_configure_remove(&remove);
1034}
1035
1036static void nvm_setup_nvm_sb_info(struct nvm_sb_info *info)
1037{
1038 info->seqnr = 1;
1039 info->erase_cnt = 0;
1040 info->version = 1;
1041}
1042
1043static long __nvm_ioctl_dev_init(struct nvm_ioctl_dev_init *init)
1044{
1045 struct nvm_dev *dev;
1046 struct nvm_sb_info info;
1047 int ret;
1048
1049 down_write(&nvm_lock);
1050 dev = nvm_find_nvm_dev(init->dev);
1051 up_write(&nvm_lock);
1052 if (!dev) {
1053 pr_err("nvm: device not found\n");
1054 return -EINVAL;
1055 }
1056
1057 nvm_setup_nvm_sb_info(&info);
1058
1059 strncpy(info.mmtype, init->mmtype, NVM_MMTYPE_LEN);
1060 info.fs_ppa.ppa = -1;
1061
1062 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT) {
1063 ret = nvm_init_sysblock(dev, &info);
1064 if (ret)
1065 return ret;
1066 }
1067
1068 memcpy(&dev->sb, &info, sizeof(struct nvm_sb_info));
1069
1070 down_write(&nvm_lock);
1071 dev->mt = nvm_init_mgr(dev);
1072 up_write(&nvm_lock);
1073
1074 return 0;
1075}
1076
1077static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1078{
1079 struct nvm_ioctl_dev_init init;
1080
1081 if (!capable(CAP_SYS_ADMIN))
1082 return -EPERM;
1083
1084 if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1085 return -EFAULT;
1086
1087 if (init.flags != 0) {
1088 pr_err("nvm: no flags supported\n");
1089 return -EINVAL;
1090 }
1091
1092 init.dev[DISK_NAME_LEN - 1] = '\0';
1093
1094 return __nvm_ioctl_dev_init(&init);
1095}
1096
1097static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1098{
1099 struct nvm_ioctl_dev_factory fact;
1100 struct nvm_dev *dev;
1101
1102 if (!capable(CAP_SYS_ADMIN))
1103 return -EPERM;
1104
1105 if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1106 return -EFAULT;
1107
1108 fact.dev[DISK_NAME_LEN - 1] = '\0';
1109
1110 if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1111 return -EINVAL;
1112
1113 down_write(&nvm_lock);
1114 dev = nvm_find_nvm_dev(fact.dev);
1115 up_write(&nvm_lock);
1116 if (!dev) {
1117 pr_err("nvm: device not found\n");
1118 return -EINVAL;
1119 }
1120
1121 if (dev->mt) {
1122 dev->mt->unregister_mgr(dev);
1123 dev->mt = NULL;
1124 }
1125
1126 if (dev->identity.cap & NVM_ID_DCAP_BBLKMGMT)
1127 return nvm_dev_factory(dev, fact.flags);
1128
1129 return 0;
1130}
1131
1132static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1133{
1134 void __user *argp = (void __user *)arg;
1135
1136 switch (cmd) {
1137 case NVM_INFO:
1138 return nvm_ioctl_info(file, argp);
1139 case NVM_GET_DEVICES:
1140 return nvm_ioctl_get_devices(file, argp);
1141 case NVM_DEV_CREATE:
1142 return nvm_ioctl_dev_create(file, argp);
1143 case NVM_DEV_REMOVE:
1144 return nvm_ioctl_dev_remove(file, argp);
1145 case NVM_DEV_INIT:
1146 return nvm_ioctl_dev_init(file, argp);
1147 case NVM_DEV_FACTORY:
1148 return nvm_ioctl_dev_factory(file, argp);
1149 }
1150 return 0;
1151}
1152
1153static const struct file_operations _ctl_fops = {
1154 .open = nonseekable_open,
1155 .unlocked_ioctl = nvm_ctl_ioctl,
1156 .owner = THIS_MODULE,
1157 .llseek = noop_llseek,
1158};
1159
1160static struct miscdevice _nvm_misc = {
1161 .minor = MISC_DYNAMIC_MINOR,
1162 .name = "lightnvm",
1163 .nodename = "lightnvm/control",
1164 .fops = &_ctl_fops,
1165};
1166
1167MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
1168
1169static int __init nvm_mod_init(void)
1170{
1171 int ret;
1172
1173 ret = misc_register(&_nvm_misc);
1174 if (ret)
1175 pr_err("nvm: misc_register failed for control device");
1176
1177 return ret;
1178}
1179
1180static void __exit nvm_mod_exit(void)
1181{
1182 misc_deregister(&_nvm_misc);
1183}
1184
1185MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
1186MODULE_LICENSE("GPL v2");
1187MODULE_VERSION("0.1");
1188module_init(nvm_mod_init);
1189module_exit(nvm_mod_exit);