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