lightnvm: manage open and closed blocks separately
[linux-2.6-block.git] / drivers / lightnvm / core.c
CommitLineData
cd9e9808
MB
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>
91276162 30#include <linux/sched/sysctl.h>
cd9e9808
MB
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{
16f26c3a 78 return dev->ops->dev_dma_alloc(dev, dev->ppalist_pool, mem_flags,
cd9e9808
MB
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
762796bc
MB
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 ret = mt->register_mgr(dev);
110 if (ret < 0) {
111 pr_err("nvm: media mgr failed to init (%d) on dev %s\n",
112 ret, dev->name);
113 return NULL; /* initialization failed */
114 } else if (ret > 0)
115 return mt;
116 }
117
118 return NULL;
119}
120
cd9e9808
MB
121int nvm_register_mgr(struct nvmm_type *mt)
122{
762796bc 123 struct nvm_dev *dev;
cd9e9808
MB
124 int ret = 0;
125
126 down_write(&nvm_lock);
762796bc 127 if (nvm_find_mgr_type(mt->name)) {
cd9e9808 128 ret = -EEXIST;
762796bc
MB
129 goto finish;
130 } else {
cd9e9808 131 list_add(&mt->list, &nvm_mgrs);
762796bc
MB
132 }
133
134 /* try to register media mgr if any device have none configured */
135 list_for_each_entry(dev, &nvm_devices, devices) {
136 if (dev->mt)
137 continue;
138
139 dev->mt = nvm_init_mgr(dev);
140 }
141finish:
cd9e9808
MB
142 up_write(&nvm_lock);
143
144 return ret;
145}
146EXPORT_SYMBOL(nvm_register_mgr);
147
148void nvm_unregister_mgr(struct nvmm_type *mt)
149{
150 if (!mt)
151 return;
152
153 down_write(&nvm_lock);
154 list_del(&mt->list);
155 up_write(&nvm_lock);
156}
157EXPORT_SYMBOL(nvm_unregister_mgr);
158
159static struct nvm_dev *nvm_find_nvm_dev(const char *name)
160{
161 struct nvm_dev *dev;
162
163 list_for_each_entry(dev, &nvm_devices, devices)
164 if (!strcmp(name, dev->name))
165 return dev;
166
167 return NULL;
168}
169
ff0e498b
JG
170struct nvm_block *nvm_get_blk_unlocked(struct nvm_dev *dev, struct nvm_lun *lun,
171 unsigned long flags)
172{
173 return dev->mt->get_blk_unlocked(dev, lun, flags);
174}
175EXPORT_SYMBOL(nvm_get_blk_unlocked);
176
177/* Assumes that all valid pages have already been moved on release to bm */
178void nvm_put_blk_unlocked(struct nvm_dev *dev, struct nvm_block *blk)
179{
180 return dev->mt->put_blk_unlocked(dev, blk);
181}
182EXPORT_SYMBOL(nvm_put_blk_unlocked);
183
cd9e9808
MB
184struct nvm_block *nvm_get_blk(struct nvm_dev *dev, struct nvm_lun *lun,
185 unsigned long flags)
186{
187 return dev->mt->get_blk(dev, lun, flags);
188}
189EXPORT_SYMBOL(nvm_get_blk);
190
191/* Assumes that all valid pages have already been moved on release to bm */
192void nvm_put_blk(struct nvm_dev *dev, struct nvm_block *blk)
193{
194 return dev->mt->put_blk(dev, blk);
195}
196EXPORT_SYMBOL(nvm_put_blk);
197
198int nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
199{
200 return dev->mt->submit_io(dev, rqd);
201}
202EXPORT_SYMBOL(nvm_submit_io);
203
204int nvm_erase_blk(struct nvm_dev *dev, struct nvm_block *blk)
205{
206 return dev->mt->erase_blk(dev, blk, 0);
207}
208EXPORT_SYMBOL(nvm_erase_blk);
209
069368e9
MB
210void nvm_addr_to_generic_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
211{
212 int i;
213
214 if (rqd->nr_pages > 1) {
215 for (i = 0; i < rqd->nr_pages; i++)
216 rqd->ppa_list[i] = dev_to_generic_addr(dev,
217 rqd->ppa_list[i]);
218 } else {
219 rqd->ppa_addr = dev_to_generic_addr(dev, rqd->ppa_addr);
220 }
221}
222EXPORT_SYMBOL(nvm_addr_to_generic_mode);
223
224void nvm_generic_to_addr_mode(struct nvm_dev *dev, struct nvm_rq *rqd)
225{
226 int i;
227
228 if (rqd->nr_pages > 1) {
229 for (i = 0; i < rqd->nr_pages; i++)
230 rqd->ppa_list[i] = generic_to_dev_addr(dev,
231 rqd->ppa_list[i]);
232 } else {
233 rqd->ppa_addr = generic_to_dev_addr(dev, rqd->ppa_addr);
234 }
235}
236EXPORT_SYMBOL(nvm_generic_to_addr_mode);
237
abd805ec
MB
238int nvm_set_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd,
239 struct ppa_addr *ppas, int nr_ppas)
069368e9 240{
abd805ec
MB
241 int i, plane_cnt, pl_idx;
242
243 if (dev->plane_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
244 rqd->nr_pages = 1;
245 rqd->ppa_addr = ppas[0];
069368e9 246
069368e9 247 return 0;
abd805ec 248 }
069368e9 249
abd805ec
MB
250 plane_cnt = (1 << dev->plane_mode);
251 rqd->nr_pages = plane_cnt * nr_ppas;
069368e9 252
abd805ec
MB
253 if (dev->ops->max_phys_sect < rqd->nr_pages)
254 return -EINVAL;
255
256 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
257 if (!rqd->ppa_list) {
258 pr_err("nvm: failed to allocate dma memory\n");
259 return -ENOMEM;
260 }
261
556755e9
MB
262 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
263 for (i = 0; i < nr_ppas; i++) {
abd805ec 264 ppas[i].g.pl = pl_idx;
556755e9 265 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppas[i];
069368e9
MB
266 }
267 }
268
abd805ec
MB
269 return 0;
270}
271EXPORT_SYMBOL(nvm_set_rqd_ppalist);
272
273void nvm_free_rqd_ppalist(struct nvm_dev *dev, struct nvm_rq *rqd)
274{
275 if (!rqd->ppa_list)
276 return;
277
278 nvm_dev_dma_free(dev, rqd->ppa_list, rqd->dma_ppa_list);
279}
280EXPORT_SYMBOL(nvm_free_rqd_ppalist);
281
81e681d3 282int nvm_erase_ppa(struct nvm_dev *dev, struct ppa_addr *ppas, int nr_ppas)
abd805ec
MB
283{
284 struct nvm_rq rqd;
285 int ret;
286
287 if (!dev->ops->erase_block)
288 return 0;
289
290 memset(&rqd, 0, sizeof(struct nvm_rq));
291
81e681d3 292 ret = nvm_set_rqd_ppalist(dev, &rqd, ppas, nr_ppas);
abd805ec
MB
293 if (ret)
294 return ret;
295
069368e9
MB
296 nvm_generic_to_addr_mode(dev, &rqd);
297
298 ret = dev->ops->erase_block(dev, &rqd);
299
abd805ec 300 nvm_free_rqd_ppalist(dev, &rqd);
069368e9
MB
301
302 return ret;
303}
304EXPORT_SYMBOL(nvm_erase_ppa);
305
91276162
MB
306void nvm_end_io(struct nvm_rq *rqd, int error)
307{
72d256ec
MB
308 rqd->error = error;
309 rqd->end_io(rqd);
91276162
MB
310}
311EXPORT_SYMBOL(nvm_end_io);
312
09719b62 313static void nvm_end_io_sync(struct nvm_rq *rqd)
91276162
MB
314{
315 struct completion *waiting = rqd->wait;
316
317 rqd->wait = NULL;
318
319 complete(waiting);
320}
321
09719b62
MB
322int nvm_submit_ppa(struct nvm_dev *dev, struct ppa_addr *ppa, int nr_ppas,
323 int opcode, int flags, void *buf, int len)
324{
325 DECLARE_COMPLETION_ONSTACK(wait);
326 struct nvm_rq rqd;
327 struct bio *bio;
328 int ret;
329 unsigned long hang_check;
330
331 bio = bio_map_kern(dev->q, buf, len, GFP_KERNEL);
332 if (IS_ERR_OR_NULL(bio))
333 return -ENOMEM;
334
335 memset(&rqd, 0, sizeof(struct nvm_rq));
336 ret = nvm_set_rqd_ppalist(dev, &rqd, ppa, nr_ppas);
337 if (ret) {
338 bio_put(bio);
339 return ret;
340 }
341
342 rqd.opcode = opcode;
343 rqd.bio = bio;
344 rqd.wait = &wait;
345 rqd.dev = dev;
346 rqd.end_io = nvm_end_io_sync;
347 rqd.flags = flags;
348 nvm_generic_to_addr_mode(dev, &rqd);
349
350 ret = dev->ops->submit_io(dev, &rqd);
351
352 /* Prevent hang_check timer from firing at us during very long I/O */
353 hang_check = sysctl_hung_task_timeout_secs;
354 if (hang_check)
355 while (!wait_for_completion_io_timeout(&wait, hang_check * (HZ/2)));
356 else
357 wait_for_completion_io(&wait);
358
359 nvm_free_rqd_ppalist(dev, &rqd);
360
361 return rqd.error;
362}
363EXPORT_SYMBOL(nvm_submit_ppa);
364
cd9e9808
MB
365static int nvm_core_init(struct nvm_dev *dev)
366{
367 struct nvm_id *id = &dev->identity;
368 struct nvm_id_group *grp = &id->groups[0];
369
370 /* device values */
371 dev->nr_chnls = grp->num_ch;
372 dev->luns_per_chnl = grp->num_lun;
373 dev->pgs_per_blk = grp->num_pg;
374 dev->blks_per_lun = grp->num_blk;
375 dev->nr_planes = grp->num_pln;
376 dev->sec_size = grp->csecs;
377 dev->oob_size = grp->sos;
378 dev->sec_per_pg = grp->fpg_sz / grp->csecs;
7386af27 379 memcpy(&dev->ppaf, &id->ppaf, sizeof(struct nvm_addr_format));
cd9e9808
MB
380
381 dev->plane_mode = NVM_PLANE_SINGLE;
382 dev->max_rq_size = dev->ops->max_phys_sect * dev->sec_size;
383
4264c980
MB
384 if (grp->mtype != 0) {
385 pr_err("nvm: memory type not supported\n");
386 return -EINVAL;
387 }
388
389 if (grp->fmtype != 0 && grp->fmtype != 1) {
390 pr_err("nvm: flash type not supported\n");
391 return -EINVAL;
392 }
393
cd9e9808
MB
394 if (grp->mpos & 0x020202)
395 dev->plane_mode = NVM_PLANE_DOUBLE;
396 if (grp->mpos & 0x040404)
397 dev->plane_mode = NVM_PLANE_QUAD;
398
399 /* calculated values */
400 dev->sec_per_pl = dev->sec_per_pg * dev->nr_planes;
401 dev->sec_per_blk = dev->sec_per_pl * dev->pgs_per_blk;
402 dev->sec_per_lun = dev->sec_per_blk * dev->blks_per_lun;
403 dev->nr_luns = dev->luns_per_chnl * dev->nr_chnls;
404
405 dev->total_blocks = dev->nr_planes *
406 dev->blks_per_lun *
407 dev->luns_per_chnl *
408 dev->nr_chnls;
409 dev->total_pages = dev->total_blocks * dev->pgs_per_blk;
410 INIT_LIST_HEAD(&dev->online_targets);
411
412 return 0;
413}
414
415static void nvm_free(struct nvm_dev *dev)
416{
417 if (!dev)
418 return;
419
420 if (dev->mt)
421 dev->mt->unregister_mgr(dev);
cd9e9808
MB
422}
423
424static int nvm_init(struct nvm_dev *dev)
425{
480fc0db 426 int ret = -EINVAL;
cd9e9808
MB
427
428 if (!dev->q || !dev->ops)
480fc0db 429 return ret;
cd9e9808 430
16f26c3a 431 if (dev->ops->identity(dev, &dev->identity)) {
cd9e9808 432 pr_err("nvm: device could not be identified\n");
cd9e9808
MB
433 goto err;
434 }
435
436 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
437 dev->identity.ver_id, dev->identity.vmnt,
438 dev->identity.cgrps);
439
440 if (dev->identity.ver_id != 1) {
441 pr_err("nvm: device not supported by kernel.");
442 goto err;
443 }
444
445 if (dev->identity.cgrps != 1) {
446 pr_err("nvm: only one group configuration supported.");
447 goto err;
448 }
449
450 ret = nvm_core_init(dev);
451 if (ret) {
452 pr_err("nvm: could not initialize core structures.\n");
453 goto err;
454 }
455
cd9e9808
MB
456 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
457 dev->name, dev->sec_per_pg, dev->nr_planes,
458 dev->pgs_per_blk, dev->blks_per_lun, dev->nr_luns,
459 dev->nr_chnls);
460 return 0;
461err:
cd9e9808
MB
462 pr_err("nvm: failed to initialize nvm\n");
463 return ret;
464}
465
466static void nvm_exit(struct nvm_dev *dev)
467{
468 if (dev->ppalist_pool)
469 dev->ops->destroy_dma_pool(dev->ppalist_pool);
470 nvm_free(dev);
471
472 pr_info("nvm: successfully unloaded\n");
473}
474
475int nvm_register(struct request_queue *q, char *disk_name,
476 struct nvm_dev_ops *ops)
477{
478 struct nvm_dev *dev;
479 int ret;
480
481 if (!ops->identity)
482 return -EINVAL;
483
484 dev = kzalloc(sizeof(struct nvm_dev), GFP_KERNEL);
485 if (!dev)
486 return -ENOMEM;
487
488 dev->q = q;
489 dev->ops = ops;
490 strncpy(dev->name, disk_name, DISK_NAME_LEN);
491
492 ret = nvm_init(dev);
493 if (ret)
494 goto err_init;
495
d160147b
WT
496 if (dev->ops->max_phys_sect > 256) {
497 pr_info("nvm: max sectors supported is 256.\n");
498 ret = -EINVAL;
499 goto err_init;
500 }
501
cd9e9808 502 if (dev->ops->max_phys_sect > 1) {
16f26c3a 503 dev->ppalist_pool = dev->ops->create_dma_pool(dev, "ppalist");
cd9e9808
MB
504 if (!dev->ppalist_pool) {
505 pr_err("nvm: could not create ppa pool\n");
93e70c1f
MB
506 ret = -ENOMEM;
507 goto err_init;
cd9e9808 508 }
cd9e9808
MB
509 }
510
762796bc 511 /* register device with a supported media manager */
edad2e66 512 down_write(&nvm_lock);
762796bc 513 dev->mt = nvm_init_mgr(dev);
edad2e66
MB
514 list_add(&dev->devices, &nvm_devices);
515 up_write(&nvm_lock);
516
cd9e9808
MB
517 return 0;
518err_init:
519 kfree(dev);
520 return ret;
521}
522EXPORT_SYMBOL(nvm_register);
523
524void nvm_unregister(char *disk_name)
525{
d0a712ce 526 struct nvm_dev *dev;
cd9e9808 527
d0a712ce
WT
528 down_write(&nvm_lock);
529 dev = nvm_find_nvm_dev(disk_name);
cd9e9808
MB
530 if (!dev) {
531 pr_err("nvm: could not find device %s to unregister\n",
532 disk_name);
d0a712ce 533 up_write(&nvm_lock);
cd9e9808
MB
534 return;
535 }
536
cd9e9808
MB
537 list_del(&dev->devices);
538 up_write(&nvm_lock);
c1480ad5
MB
539
540 nvm_exit(dev);
541 kfree(dev);
cd9e9808
MB
542}
543EXPORT_SYMBOL(nvm_unregister);
544
545static const struct block_device_operations nvm_fops = {
546 .owner = THIS_MODULE,
547};
548
549static int nvm_create_target(struct nvm_dev *dev,
550 struct nvm_ioctl_create *create)
551{
552 struct nvm_ioctl_create_simple *s = &create->conf.s;
553 struct request_queue *tqueue;
cd9e9808
MB
554 struct gendisk *tdisk;
555 struct nvm_tgt_type *tt;
556 struct nvm_target *t;
557 void *targetdata;
cd9e9808
MB
558
559 if (!dev->mt) {
762796bc
MB
560 pr_info("nvm: device has no media manager registered.\n");
561 return -ENODEV;
cd9e9808
MB
562 }
563
762796bc 564 down_write(&nvm_lock);
cd9e9808
MB
565 tt = nvm_find_target_type(create->tgttype);
566 if (!tt) {
567 pr_err("nvm: target type %s not found\n", create->tgttype);
d0a712ce 568 up_write(&nvm_lock);
cd9e9808
MB
569 return -EINVAL;
570 }
571
cd9e9808
MB
572 list_for_each_entry(t, &dev->online_targets, list) {
573 if (!strcmp(create->tgtname, t->disk->disk_name)) {
574 pr_err("nvm: target name already exists.\n");
575 up_write(&nvm_lock);
576 return -EINVAL;
577 }
578 }
579 up_write(&nvm_lock);
580
581 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
582 if (!t)
583 return -ENOMEM;
584
585 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node);
586 if (!tqueue)
587 goto err_t;
588 blk_queue_make_request(tqueue, tt->make_rq);
589
590 tdisk = alloc_disk(0);
591 if (!tdisk)
592 goto err_queue;
593
594 sprintf(tdisk->disk_name, "%s", create->tgtname);
595 tdisk->flags = GENHD_FL_EXT_DEVT;
596 tdisk->major = 0;
597 tdisk->first_minor = 0;
598 tdisk->fops = &nvm_fops;
599 tdisk->queue = tqueue;
600
601 targetdata = tt->init(dev, tdisk, s->lun_begin, s->lun_end);
602 if (IS_ERR(targetdata))
603 goto err_init;
604
605 tdisk->private_data = targetdata;
606 tqueue->queuedata = targetdata;
607
608 blk_queue_max_hw_sectors(tqueue, 8 * dev->ops->max_phys_sect);
609
610 set_capacity(tdisk, tt->capacity(targetdata));
611 add_disk(tdisk);
612
613 t->type = tt;
614 t->disk = tdisk;
615
616 down_write(&nvm_lock);
617 list_add_tail(&t->list, &dev->online_targets);
618 up_write(&nvm_lock);
619
620 return 0;
621err_init:
622 put_disk(tdisk);
623err_queue:
624 blk_cleanup_queue(tqueue);
625err_t:
626 kfree(t);
627 return -ENOMEM;
628}
629
630static void nvm_remove_target(struct nvm_target *t)
631{
632 struct nvm_tgt_type *tt = t->type;
633 struct gendisk *tdisk = t->disk;
634 struct request_queue *q = tdisk->queue;
635
636 lockdep_assert_held(&nvm_lock);
637
638 del_gendisk(tdisk);
d09f9581
JG
639 blk_cleanup_queue(q);
640
cd9e9808
MB
641 if (tt->exit)
642 tt->exit(tdisk->private_data);
643
cd9e9808
MB
644 put_disk(tdisk);
645
646 list_del(&t->list);
647 kfree(t);
648}
649
650static int __nvm_configure_create(struct nvm_ioctl_create *create)
651{
652 struct nvm_dev *dev;
653 struct nvm_ioctl_create_simple *s;
654
d0a712ce 655 down_write(&nvm_lock);
cd9e9808 656 dev = nvm_find_nvm_dev(create->dev);
d0a712ce 657 up_write(&nvm_lock);
cd9e9808
MB
658 if (!dev) {
659 pr_err("nvm: device not found\n");
660 return -EINVAL;
661 }
662
663 if (create->conf.type != NVM_CONFIG_TYPE_SIMPLE) {
664 pr_err("nvm: config type not valid\n");
665 return -EINVAL;
666 }
667 s = &create->conf.s;
668
669 if (s->lun_begin > s->lun_end || s->lun_end > dev->nr_luns) {
670 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
671 s->lun_begin, s->lun_end, dev->nr_luns);
672 return -EINVAL;
673 }
674
675 return nvm_create_target(dev, create);
676}
677
678static int __nvm_configure_remove(struct nvm_ioctl_remove *remove)
679{
680 struct nvm_target *t = NULL;
681 struct nvm_dev *dev;
682 int ret = -1;
683
684 down_write(&nvm_lock);
685 list_for_each_entry(dev, &nvm_devices, devices)
686 list_for_each_entry(t, &dev->online_targets, list) {
687 if (!strcmp(remove->tgtname, t->disk->disk_name)) {
688 nvm_remove_target(t);
689 ret = 0;
690 break;
691 }
692 }
693 up_write(&nvm_lock);
694
695 if (ret) {
696 pr_err("nvm: target \"%s\" doesn't exist.\n", remove->tgtname);
697 return -EINVAL;
698 }
699
700 return 0;
701}
702
703#ifdef CONFIG_NVM_DEBUG
704static int nvm_configure_show(const char *val)
705{
706 struct nvm_dev *dev;
707 char opcode, devname[DISK_NAME_LEN];
708 int ret;
709
710 ret = sscanf(val, "%c %32s", &opcode, devname);
711 if (ret != 2) {
712 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
713 return -EINVAL;
714 }
715
d0a712ce 716 down_write(&nvm_lock);
cd9e9808 717 dev = nvm_find_nvm_dev(devname);
d0a712ce 718 up_write(&nvm_lock);
cd9e9808
MB
719 if (!dev) {
720 pr_err("nvm: device not found\n");
721 return -EINVAL;
722 }
723
724 if (!dev->mt)
725 return 0;
726
2fde0e48 727 dev->mt->lun_info_print(dev);
cd9e9808
MB
728
729 return 0;
730}
731
732static int nvm_configure_remove(const char *val)
733{
734 struct nvm_ioctl_remove remove;
735 char opcode;
736 int ret;
737
738 ret = sscanf(val, "%c %256s", &opcode, remove.tgtname);
739 if (ret != 2) {
740 pr_err("nvm: invalid command. Use \"d targetname\".\n");
741 return -EINVAL;
742 }
743
744 remove.flags = 0;
745
746 return __nvm_configure_remove(&remove);
747}
748
749static int nvm_configure_create(const char *val)
750{
751 struct nvm_ioctl_create create;
752 char opcode;
753 int lun_begin, lun_end, ret;
754
755 ret = sscanf(val, "%c %256s %256s %48s %u:%u", &opcode, create.dev,
756 create.tgtname, create.tgttype,
757 &lun_begin, &lun_end);
758 if (ret != 6) {
759 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
760 return -EINVAL;
761 }
762
763 create.flags = 0;
764 create.conf.type = NVM_CONFIG_TYPE_SIMPLE;
765 create.conf.s.lun_begin = lun_begin;
766 create.conf.s.lun_end = lun_end;
767
768 return __nvm_configure_create(&create);
769}
770
771
772/* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
773static int nvm_configure_by_str_event(const char *val,
774 const struct kernel_param *kp)
775{
776 char opcode;
777 int ret;
778
779 ret = sscanf(val, "%c", &opcode);
780 if (ret != 1) {
781 pr_err("nvm: string must have the format of \"cmd ...\"\n");
782 return -EINVAL;
783 }
784
785 switch (opcode) {
786 case 'a':
787 return nvm_configure_create(val);
788 case 'd':
789 return nvm_configure_remove(val);
790 case 's':
791 return nvm_configure_show(val);
792 default:
793 pr_err("nvm: invalid command\n");
794 return -EINVAL;
795 }
796
797 return 0;
798}
799
800static int nvm_configure_get(char *buf, const struct kernel_param *kp)
801{
802 int sz = 0;
803 char *buf_start = buf;
804 struct nvm_dev *dev;
805
806 buf += sprintf(buf, "available devices:\n");
807 down_write(&nvm_lock);
808 list_for_each_entry(dev, &nvm_devices, devices) {
809 if (sz > 4095 - DISK_NAME_LEN)
810 break;
811 buf += sprintf(buf, " %32s\n", dev->name);
812 }
813 up_write(&nvm_lock);
814
815 return buf - buf_start - 1;
816}
817
818static const struct kernel_param_ops nvm_configure_by_str_event_param_ops = {
819 .set = nvm_configure_by_str_event,
820 .get = nvm_configure_get,
821};
822
823#undef MODULE_PARAM_PREFIX
824#define MODULE_PARAM_PREFIX "lnvm."
825
826module_param_cb(configure_debug, &nvm_configure_by_str_event_param_ops, NULL,
827 0644);
828
829#endif /* CONFIG_NVM_DEBUG */
830
831static long nvm_ioctl_info(struct file *file, void __user *arg)
832{
833 struct nvm_ioctl_info *info;
834 struct nvm_tgt_type *tt;
835 int tgt_iter = 0;
836
837 if (!capable(CAP_SYS_ADMIN))
838 return -EPERM;
839
840 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
841 if (IS_ERR(info))
842 return -EFAULT;
843
844 info->version[0] = NVM_VERSION_MAJOR;
845 info->version[1] = NVM_VERSION_MINOR;
846 info->version[2] = NVM_VERSION_PATCH;
847
848 down_write(&nvm_lock);
849 list_for_each_entry(tt, &nvm_targets, list) {
850 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
851
852 tgt->version[0] = tt->version[0];
853 tgt->version[1] = tt->version[1];
854 tgt->version[2] = tt->version[2];
855 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
856
857 tgt_iter++;
858 }
859
860 info->tgtsize = tgt_iter;
861 up_write(&nvm_lock);
862
76e25081
SM
863 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
864 kfree(info);
cd9e9808 865 return -EFAULT;
76e25081 866 }
cd9e9808
MB
867
868 kfree(info);
869 return 0;
870}
871
872static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
873{
874 struct nvm_ioctl_get_devices *devices;
875 struct nvm_dev *dev;
876 int i = 0;
877
878 if (!capable(CAP_SYS_ADMIN))
879 return -EPERM;
880
881 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
882 if (!devices)
883 return -ENOMEM;
884
885 down_write(&nvm_lock);
886 list_for_each_entry(dev, &nvm_devices, devices) {
887 struct nvm_ioctl_device_info *info = &devices->info[i];
888
889 sprintf(info->devname, "%s", dev->name);
890 if (dev->mt) {
891 info->bmversion[0] = dev->mt->version[0];
892 info->bmversion[1] = dev->mt->version[1];
893 info->bmversion[2] = dev->mt->version[2];
894 sprintf(info->bmname, "%s", dev->mt->name);
895 } else {
896 sprintf(info->bmname, "none");
897 }
898
899 i++;
900 if (i > 31) {
901 pr_err("nvm: max 31 devices can be reported.\n");
902 break;
903 }
904 }
905 up_write(&nvm_lock);
906
907 devices->nr_devices = i;
908
76e25081
SM
909 if (copy_to_user(arg, devices,
910 sizeof(struct nvm_ioctl_get_devices))) {
911 kfree(devices);
cd9e9808 912 return -EFAULT;
76e25081 913 }
cd9e9808
MB
914
915 kfree(devices);
916 return 0;
917}
918
919static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
920{
921 struct nvm_ioctl_create create;
922
923 if (!capable(CAP_SYS_ADMIN))
924 return -EPERM;
925
926 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
927 return -EFAULT;
928
929 create.dev[DISK_NAME_LEN - 1] = '\0';
930 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
931 create.tgtname[DISK_NAME_LEN - 1] = '\0';
932
933 if (create.flags != 0) {
934 pr_err("nvm: no flags supported\n");
935 return -EINVAL;
936 }
937
938 return __nvm_configure_create(&create);
939}
940
941static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
942{
943 struct nvm_ioctl_remove remove;
944
945 if (!capable(CAP_SYS_ADMIN))
946 return -EPERM;
947
948 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
949 return -EFAULT;
950
951 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
952
953 if (remove.flags != 0) {
954 pr_err("nvm: no flags supported\n");
955 return -EINVAL;
956 }
957
958 return __nvm_configure_remove(&remove);
959}
960
961static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
962{
963 void __user *argp = (void __user *)arg;
964
965 switch (cmd) {
966 case NVM_INFO:
967 return nvm_ioctl_info(file, argp);
968 case NVM_GET_DEVICES:
969 return nvm_ioctl_get_devices(file, argp);
970 case NVM_DEV_CREATE:
971 return nvm_ioctl_dev_create(file, argp);
972 case NVM_DEV_REMOVE:
973 return nvm_ioctl_dev_remove(file, argp);
974 }
975 return 0;
976}
977
978static const struct file_operations _ctl_fops = {
979 .open = nonseekable_open,
980 .unlocked_ioctl = nvm_ctl_ioctl,
981 .owner = THIS_MODULE,
982 .llseek = noop_llseek,
983};
984
985static struct miscdevice _nvm_misc = {
986 .minor = MISC_DYNAMIC_MINOR,
987 .name = "lightnvm",
988 .nodename = "lightnvm/control",
989 .fops = &_ctl_fops,
990};
991
992MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR);
993
994static int __init nvm_mod_init(void)
995{
996 int ret;
997
998 ret = misc_register(&_nvm_misc);
999 if (ret)
1000 pr_err("nvm: misc_register failed for control device");
1001
1002 return ret;
1003}
1004
1005static void __exit nvm_mod_exit(void)
1006{
1007 misc_deregister(&_nvm_misc);
1008}
1009
1010MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
1011MODULE_LICENSE("GPL v2");
1012MODULE_VERSION("0.1");
1013module_init(nvm_mod_init);
1014module_exit(nvm_mod_exit);