2 * Copyright (C) 2015 IT University of Copenhagen. All rights reserved.
3 * Initial release: Matias Bjorling <m@bjorling.me>
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.
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.
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,
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 <uapi/linux/lightnvm.h>
32 static LIST_HEAD(nvm_targets
);
33 static LIST_HEAD(nvm_mgrs
);
34 static LIST_HEAD(nvm_devices
);
35 static DECLARE_RWSEM(nvm_lock
);
37 static struct nvm_tgt_type
*nvm_find_target_type(const char *name
)
39 struct nvm_tgt_type
*tt
;
41 list_for_each_entry(tt
, &nvm_targets
, list
)
42 if (!strcmp(name
, tt
->name
))
48 int nvm_register_target(struct nvm_tgt_type
*tt
)
52 down_write(&nvm_lock
);
53 if (nvm_find_target_type(tt
->name
))
56 list_add(&tt
->list
, &nvm_targets
);
61 EXPORT_SYMBOL(nvm_register_target
);
63 void nvm_unregister_target(struct nvm_tgt_type
*tt
)
68 down_write(&nvm_lock
);
72 EXPORT_SYMBOL(nvm_unregister_target
);
74 void *nvm_dev_dma_alloc(struct nvm_dev
*dev
, gfp_t mem_flags
,
75 dma_addr_t
*dma_handler
)
77 return dev
->ops
->dev_dma_alloc(dev
->q
, dev
->ppalist_pool
, mem_flags
,
80 EXPORT_SYMBOL(nvm_dev_dma_alloc
);
82 void nvm_dev_dma_free(struct nvm_dev
*dev
, void *ppa_list
,
83 dma_addr_t dma_handler
)
85 dev
->ops
->dev_dma_free(dev
->ppalist_pool
, ppa_list
, dma_handler
);
87 EXPORT_SYMBOL(nvm_dev_dma_free
);
89 static struct nvmm_type
*nvm_find_mgr_type(const char *name
)
93 list_for_each_entry(mt
, &nvm_mgrs
, list
)
94 if (!strcmp(name
, mt
->name
))
100 int nvm_register_mgr(struct nvmm_type
*mt
)
104 down_write(&nvm_lock
);
105 if (nvm_find_mgr_type(mt
->name
))
108 list_add(&mt
->list
, &nvm_mgrs
);
113 EXPORT_SYMBOL(nvm_register_mgr
);
115 void nvm_unregister_mgr(struct nvmm_type
*mt
)
120 down_write(&nvm_lock
);
124 EXPORT_SYMBOL(nvm_unregister_mgr
);
126 static struct nvm_dev
*nvm_find_nvm_dev(const char *name
)
130 list_for_each_entry(dev
, &nvm_devices
, devices
)
131 if (!strcmp(name
, dev
->name
))
137 struct nvm_block
*nvm_get_blk(struct nvm_dev
*dev
, struct nvm_lun
*lun
,
140 return dev
->mt
->get_blk(dev
, lun
, flags
);
142 EXPORT_SYMBOL(nvm_get_blk
);
144 /* Assumes that all valid pages have already been moved on release to bm */
145 void nvm_put_blk(struct nvm_dev
*dev
, struct nvm_block
*blk
)
147 return dev
->mt
->put_blk(dev
, blk
);
149 EXPORT_SYMBOL(nvm_put_blk
);
151 int nvm_submit_io(struct nvm_dev
*dev
, struct nvm_rq
*rqd
)
153 return dev
->mt
->submit_io(dev
, rqd
);
155 EXPORT_SYMBOL(nvm_submit_io
);
157 int nvm_erase_blk(struct nvm_dev
*dev
, struct nvm_block
*blk
)
159 return dev
->mt
->erase_blk(dev
, blk
, 0);
161 EXPORT_SYMBOL(nvm_erase_blk
);
163 static void nvm_core_free(struct nvm_dev
*dev
)
168 static int nvm_core_init(struct nvm_dev
*dev
)
170 struct nvm_id
*id
= &dev
->identity
;
171 struct nvm_id_group
*grp
= &id
->groups
[0];
174 dev
->nr_chnls
= grp
->num_ch
;
175 dev
->luns_per_chnl
= grp
->num_lun
;
176 dev
->pgs_per_blk
= grp
->num_pg
;
177 dev
->blks_per_lun
= grp
->num_blk
;
178 dev
->nr_planes
= grp
->num_pln
;
179 dev
->sec_size
= grp
->csecs
;
180 dev
->oob_size
= grp
->sos
;
181 dev
->sec_per_pg
= grp
->fpg_sz
/ grp
->csecs
;
182 dev
->addr_mode
= id
->ppat
;
183 dev
->addr_format
= id
->ppaf
;
185 dev
->plane_mode
= NVM_PLANE_SINGLE
;
186 dev
->max_rq_size
= dev
->ops
->max_phys_sect
* dev
->sec_size
;
188 if (grp
->mpos
& 0x020202)
189 dev
->plane_mode
= NVM_PLANE_DOUBLE
;
190 if (grp
->mpos
& 0x040404)
191 dev
->plane_mode
= NVM_PLANE_QUAD
;
193 /* calculated values */
194 dev
->sec_per_pl
= dev
->sec_per_pg
* dev
->nr_planes
;
195 dev
->sec_per_blk
= dev
->sec_per_pl
* dev
->pgs_per_blk
;
196 dev
->sec_per_lun
= dev
->sec_per_blk
* dev
->blks_per_lun
;
197 dev
->nr_luns
= dev
->luns_per_chnl
* dev
->nr_chnls
;
199 dev
->total_blocks
= dev
->nr_planes
*
203 dev
->total_pages
= dev
->total_blocks
* dev
->pgs_per_blk
;
204 INIT_LIST_HEAD(&dev
->online_targets
);
209 static void nvm_free(struct nvm_dev
*dev
)
215 dev
->mt
->unregister_mgr(dev
);
220 static int nvm_init(struct nvm_dev
*dev
)
222 struct nvmm_type
*mt
;
225 if (!dev
->q
|| !dev
->ops
)
228 if (dev
->ops
->identity(dev
->q
, &dev
->identity
)) {
229 pr_err("nvm: device could not be identified\n");
234 pr_debug("nvm: ver:%x nvm_vendor:%x groups:%u\n",
235 dev
->identity
.ver_id
, dev
->identity
.vmnt
,
236 dev
->identity
.cgrps
);
238 if (dev
->identity
.ver_id
!= 1) {
239 pr_err("nvm: device not supported by kernel.");
243 if (dev
->identity
.cgrps
!= 1) {
244 pr_err("nvm: only one group configuration supported.");
248 ret
= nvm_core_init(dev
);
250 pr_err("nvm: could not initialize core structures.\n");
254 /* register with device with a supported manager */
255 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
256 ret
= mt
->register_mgr(dev
);
258 goto err
; /* initialization failed */
261 break; /* successfully initialized */
266 pr_info("nvm: no compatible manager found.\n");
270 pr_info("nvm: registered %s [%u/%u/%u/%u/%u/%u]\n",
271 dev
->name
, dev
->sec_per_pg
, dev
->nr_planes
,
272 dev
->pgs_per_blk
, dev
->blks_per_lun
, dev
->nr_luns
,
277 pr_err("nvm: failed to initialize nvm\n");
281 static void nvm_exit(struct nvm_dev
*dev
)
283 if (dev
->ppalist_pool
)
284 dev
->ops
->destroy_dma_pool(dev
->ppalist_pool
);
287 pr_info("nvm: successfully unloaded\n");
290 int nvm_register(struct request_queue
*q
, char *disk_name
,
291 struct nvm_dev_ops
*ops
)
299 dev
= kzalloc(sizeof(struct nvm_dev
), GFP_KERNEL
);
305 strncpy(dev
->name
, disk_name
, DISK_NAME_LEN
);
311 down_write(&nvm_lock
);
312 list_add(&dev
->devices
, &nvm_devices
);
315 if (dev
->ops
->max_phys_sect
> 1) {
316 dev
->ppalist_pool
= dev
->ops
->create_dma_pool(dev
->q
,
318 if (!dev
->ppalist_pool
) {
319 pr_err("nvm: could not create ppa pool\n");
322 } else if (dev
->ops
->max_phys_sect
> 256) {
323 pr_info("nvm: max sectors supported is 256.\n");
332 EXPORT_SYMBOL(nvm_register
);
334 void nvm_unregister(char *disk_name
)
336 struct nvm_dev
*dev
= nvm_find_nvm_dev(disk_name
);
339 pr_err("nvm: could not find device %s to unregister\n",
346 down_write(&nvm_lock
);
347 list_del(&dev
->devices
);
350 EXPORT_SYMBOL(nvm_unregister
);
352 static const struct block_device_operations nvm_fops
= {
353 .owner
= THIS_MODULE
,
356 static int nvm_create_target(struct nvm_dev
*dev
,
357 struct nvm_ioctl_create
*create
)
359 struct nvm_ioctl_create_simple
*s
= &create
->conf
.s
;
360 struct request_queue
*tqueue
;
361 struct nvmm_type
*mt
;
362 struct gendisk
*tdisk
;
363 struct nvm_tgt_type
*tt
;
364 struct nvm_target
*t
;
369 /* register with device with a supported NVM manager */
370 list_for_each_entry(mt
, &nvm_mgrs
, list
) {
371 ret
= mt
->register_mgr(dev
);
373 return ret
; /* initialization failed */
376 break; /* successfully initialized */
381 pr_info("nvm: no compatible nvm manager found.\n");
386 tt
= nvm_find_target_type(create
->tgttype
);
388 pr_err("nvm: target type %s not found\n", create
->tgttype
);
392 down_write(&nvm_lock
);
393 list_for_each_entry(t
, &dev
->online_targets
, list
) {
394 if (!strcmp(create
->tgtname
, t
->disk
->disk_name
)) {
395 pr_err("nvm: target name already exists.\n");
402 t
= kmalloc(sizeof(struct nvm_target
), GFP_KERNEL
);
406 tqueue
= blk_alloc_queue_node(GFP_KERNEL
, dev
->q
->node
);
409 blk_queue_make_request(tqueue
, tt
->make_rq
);
411 tdisk
= alloc_disk(0);
415 sprintf(tdisk
->disk_name
, "%s", create
->tgtname
);
416 tdisk
->flags
= GENHD_FL_EXT_DEVT
;
418 tdisk
->first_minor
= 0;
419 tdisk
->fops
= &nvm_fops
;
420 tdisk
->queue
= tqueue
;
422 targetdata
= tt
->init(dev
, tdisk
, s
->lun_begin
, s
->lun_end
);
423 if (IS_ERR(targetdata
))
426 tdisk
->private_data
= targetdata
;
427 tqueue
->queuedata
= targetdata
;
429 blk_queue_max_hw_sectors(tqueue
, 8 * dev
->ops
->max_phys_sect
);
431 set_capacity(tdisk
, tt
->capacity(targetdata
));
437 down_write(&nvm_lock
);
438 list_add_tail(&t
->list
, &dev
->online_targets
);
445 blk_cleanup_queue(tqueue
);
451 static void nvm_remove_target(struct nvm_target
*t
)
453 struct nvm_tgt_type
*tt
= t
->type
;
454 struct gendisk
*tdisk
= t
->disk
;
455 struct request_queue
*q
= tdisk
->queue
;
457 lockdep_assert_held(&nvm_lock
);
461 tt
->exit(tdisk
->private_data
);
463 blk_cleanup_queue(q
);
471 static int __nvm_configure_create(struct nvm_ioctl_create
*create
)
474 struct nvm_ioctl_create_simple
*s
;
476 dev
= nvm_find_nvm_dev(create
->dev
);
478 pr_err("nvm: device not found\n");
482 if (create
->conf
.type
!= NVM_CONFIG_TYPE_SIMPLE
) {
483 pr_err("nvm: config type not valid\n");
488 if (s
->lun_begin
> s
->lun_end
|| s
->lun_end
> dev
->nr_luns
) {
489 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
490 s
->lun_begin
, s
->lun_end
, dev
->nr_luns
);
494 return nvm_create_target(dev
, create
);
497 static int __nvm_configure_remove(struct nvm_ioctl_remove
*remove
)
499 struct nvm_target
*t
= NULL
;
503 down_write(&nvm_lock
);
504 list_for_each_entry(dev
, &nvm_devices
, devices
)
505 list_for_each_entry(t
, &dev
->online_targets
, list
) {
506 if (!strcmp(remove
->tgtname
, t
->disk
->disk_name
)) {
507 nvm_remove_target(t
);
515 pr_err("nvm: target \"%s\" doesn't exist.\n", remove
->tgtname
);
522 #ifdef CONFIG_NVM_DEBUG
523 static int nvm_configure_show(const char *val
)
526 char opcode
, devname
[DISK_NAME_LEN
];
529 ret
= sscanf(val
, "%c %32s", &opcode
, devname
);
531 pr_err("nvm: invalid command. Use \"opcode devicename\".\n");
535 dev
= nvm_find_nvm_dev(devname
);
537 pr_err("nvm: device not found\n");
544 dev
->mt
->free_blocks_print(dev
);
549 static int nvm_configure_remove(const char *val
)
551 struct nvm_ioctl_remove remove
;
555 ret
= sscanf(val
, "%c %256s", &opcode
, remove
.tgtname
);
557 pr_err("nvm: invalid command. Use \"d targetname\".\n");
563 return __nvm_configure_remove(&remove
);
566 static int nvm_configure_create(const char *val
)
568 struct nvm_ioctl_create create
;
570 int lun_begin
, lun_end
, ret
;
572 ret
= sscanf(val
, "%c %256s %256s %48s %u:%u", &opcode
, create
.dev
,
573 create
.tgtname
, create
.tgttype
,
574 &lun_begin
, &lun_end
);
576 pr_err("nvm: invalid command. Use \"opcode device name tgttype lun_begin:lun_end\".\n");
581 create
.conf
.type
= NVM_CONFIG_TYPE_SIMPLE
;
582 create
.conf
.s
.lun_begin
= lun_begin
;
583 create
.conf
.s
.lun_end
= lun_end
;
585 return __nvm_configure_create(&create
);
589 /* Exposes administrative interface through /sys/module/lnvm/configure_by_str */
590 static int nvm_configure_by_str_event(const char *val
,
591 const struct kernel_param
*kp
)
596 ret
= sscanf(val
, "%c", &opcode
);
598 pr_err("nvm: string must have the format of \"cmd ...\"\n");
604 return nvm_configure_create(val
);
606 return nvm_configure_remove(val
);
608 return nvm_configure_show(val
);
610 pr_err("nvm: invalid command\n");
617 static int nvm_configure_get(char *buf
, const struct kernel_param
*kp
)
620 char *buf_start
= buf
;
623 buf
+= sprintf(buf
, "available devices:\n");
624 down_write(&nvm_lock
);
625 list_for_each_entry(dev
, &nvm_devices
, devices
) {
626 if (sz
> 4095 - DISK_NAME_LEN
)
628 buf
+= sprintf(buf
, " %32s\n", dev
->name
);
632 return buf
- buf_start
- 1;
635 static const struct kernel_param_ops nvm_configure_by_str_event_param_ops
= {
636 .set
= nvm_configure_by_str_event
,
637 .get
= nvm_configure_get
,
640 #undef MODULE_PARAM_PREFIX
641 #define MODULE_PARAM_PREFIX "lnvm."
643 module_param_cb(configure_debug
, &nvm_configure_by_str_event_param_ops
, NULL
,
646 #endif /* CONFIG_NVM_DEBUG */
648 static long nvm_ioctl_info(struct file
*file
, void __user
*arg
)
650 struct nvm_ioctl_info
*info
;
651 struct nvm_tgt_type
*tt
;
654 if (!capable(CAP_SYS_ADMIN
))
657 info
= memdup_user(arg
, sizeof(struct nvm_ioctl_info
));
661 info
->version
[0] = NVM_VERSION_MAJOR
;
662 info
->version
[1] = NVM_VERSION_MINOR
;
663 info
->version
[2] = NVM_VERSION_PATCH
;
665 down_write(&nvm_lock
);
666 list_for_each_entry(tt
, &nvm_targets
, list
) {
667 struct nvm_ioctl_info_tgt
*tgt
= &info
->tgts
[tgt_iter
];
669 tgt
->version
[0] = tt
->version
[0];
670 tgt
->version
[1] = tt
->version
[1];
671 tgt
->version
[2] = tt
->version
[2];
672 strncpy(tgt
->tgtname
, tt
->name
, NVM_TTYPE_NAME_MAX
);
677 info
->tgtsize
= tgt_iter
;
680 if (copy_to_user(arg
, info
, sizeof(struct nvm_ioctl_info
)))
687 static long nvm_ioctl_get_devices(struct file
*file
, void __user
*arg
)
689 struct nvm_ioctl_get_devices
*devices
;
693 if (!capable(CAP_SYS_ADMIN
))
696 devices
= kzalloc(sizeof(struct nvm_ioctl_get_devices
), GFP_KERNEL
);
700 down_write(&nvm_lock
);
701 list_for_each_entry(dev
, &nvm_devices
, devices
) {
702 struct nvm_ioctl_device_info
*info
= &devices
->info
[i
];
704 sprintf(info
->devname
, "%s", dev
->name
);
706 info
->bmversion
[0] = dev
->mt
->version
[0];
707 info
->bmversion
[1] = dev
->mt
->version
[1];
708 info
->bmversion
[2] = dev
->mt
->version
[2];
709 sprintf(info
->bmname
, "%s", dev
->mt
->name
);
711 sprintf(info
->bmname
, "none");
716 pr_err("nvm: max 31 devices can be reported.\n");
722 devices
->nr_devices
= i
;
724 if (copy_to_user(arg
, devices
, sizeof(struct nvm_ioctl_get_devices
)))
731 static long nvm_ioctl_dev_create(struct file
*file
, void __user
*arg
)
733 struct nvm_ioctl_create create
;
735 if (!capable(CAP_SYS_ADMIN
))
738 if (copy_from_user(&create
, arg
, sizeof(struct nvm_ioctl_create
)))
741 create
.dev
[DISK_NAME_LEN
- 1] = '\0';
742 create
.tgttype
[NVM_TTYPE_NAME_MAX
- 1] = '\0';
743 create
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
745 if (create
.flags
!= 0) {
746 pr_err("nvm: no flags supported\n");
750 return __nvm_configure_create(&create
);
753 static long nvm_ioctl_dev_remove(struct file
*file
, void __user
*arg
)
755 struct nvm_ioctl_remove remove
;
757 if (!capable(CAP_SYS_ADMIN
))
760 if (copy_from_user(&remove
, arg
, sizeof(struct nvm_ioctl_remove
)))
763 remove
.tgtname
[DISK_NAME_LEN
- 1] = '\0';
765 if (remove
.flags
!= 0) {
766 pr_err("nvm: no flags supported\n");
770 return __nvm_configure_remove(&remove
);
773 static long nvm_ctl_ioctl(struct file
*file
, uint cmd
, unsigned long arg
)
775 void __user
*argp
= (void __user
*)arg
;
779 return nvm_ioctl_info(file
, argp
);
780 case NVM_GET_DEVICES
:
781 return nvm_ioctl_get_devices(file
, argp
);
783 return nvm_ioctl_dev_create(file
, argp
);
785 return nvm_ioctl_dev_remove(file
, argp
);
790 static const struct file_operations _ctl_fops
= {
791 .open
= nonseekable_open
,
792 .unlocked_ioctl
= nvm_ctl_ioctl
,
793 .owner
= THIS_MODULE
,
794 .llseek
= noop_llseek
,
797 static struct miscdevice _nvm_misc
= {
798 .minor
= MISC_DYNAMIC_MINOR
,
800 .nodename
= "lightnvm/control",
804 MODULE_ALIAS_MISCDEV(MISC_DYNAMIC_MINOR
);
806 static int __init
nvm_mod_init(void)
810 ret
= misc_register(&_nvm_misc
);
812 pr_err("nvm: misc_register failed for control device");
817 static void __exit
nvm_mod_exit(void)
819 misc_deregister(&_nvm_misc
);
822 MODULE_AUTHOR("Matias Bjorling <m@bjorling.me>");
823 MODULE_LICENSE("GPL v2");
824 MODULE_VERSION("0.1");
825 module_init(nvm_mod_init
);
826 module_exit(nvm_mod_exit
);