perf python: Do not force closing original perf descriptor in evlist.get_pollfd()
[linux/fpc-iii.git] / drivers / lightnvm / core.c
blobefb976a863d2295a77a47d32b699819a90f75dde
1 /*
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,
17 * USA.
21 #include <linux/list.h>
22 #include <linux/types.h>
23 #include <linux/sem.h>
24 #include <linux/bitmap.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/miscdevice.h>
28 #include <linux/lightnvm.h>
29 #include <linux/sched/sysctl.h>
31 static LIST_HEAD(nvm_tgt_types);
32 static DECLARE_RWSEM(nvm_tgtt_lock);
33 static LIST_HEAD(nvm_devices);
34 static DECLARE_RWSEM(nvm_lock);
36 /* Map between virtual and physical channel and lun */
37 struct nvm_ch_map {
38 int ch_off;
39 int num_lun;
40 int *lun_offs;
43 struct nvm_dev_map {
44 struct nvm_ch_map *chnls;
45 int num_ch;
48 static struct nvm_target *nvm_find_target(struct nvm_dev *dev, const char *name)
50 struct nvm_target *tgt;
52 list_for_each_entry(tgt, &dev->targets, list)
53 if (!strcmp(name, tgt->disk->disk_name))
54 return tgt;
56 return NULL;
59 static bool nvm_target_exists(const char *name)
61 struct nvm_dev *dev;
62 struct nvm_target *tgt;
63 bool ret = false;
65 down_write(&nvm_lock);
66 list_for_each_entry(dev, &nvm_devices, devices) {
67 mutex_lock(&dev->mlock);
68 list_for_each_entry(tgt, &dev->targets, list) {
69 if (!strcmp(name, tgt->disk->disk_name)) {
70 ret = true;
71 mutex_unlock(&dev->mlock);
72 goto out;
75 mutex_unlock(&dev->mlock);
78 out:
79 up_write(&nvm_lock);
80 return ret;
83 static int nvm_reserve_luns(struct nvm_dev *dev, int lun_begin, int lun_end)
85 int i;
87 for (i = lun_begin; i <= lun_end; i++) {
88 if (test_and_set_bit(i, dev->lun_map)) {
89 pr_err("nvm: lun %d already allocated\n", i);
90 goto err;
94 return 0;
95 err:
96 while (--i >= lun_begin)
97 clear_bit(i, dev->lun_map);
99 return -EBUSY;
102 static void nvm_release_luns_err(struct nvm_dev *dev, int lun_begin,
103 int lun_end)
105 int i;
107 for (i = lun_begin; i <= lun_end; i++)
108 WARN_ON(!test_and_clear_bit(i, dev->lun_map));
111 static void nvm_remove_tgt_dev(struct nvm_tgt_dev *tgt_dev, int clear)
113 struct nvm_dev *dev = tgt_dev->parent;
114 struct nvm_dev_map *dev_map = tgt_dev->map;
115 int i, j;
117 for (i = 0; i < dev_map->num_ch; i++) {
118 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
119 int *lun_offs = ch_map->lun_offs;
120 int ch = i + ch_map->ch_off;
122 if (clear) {
123 for (j = 0; j < ch_map->num_lun; j++) {
124 int lun = j + lun_offs[j];
125 int lunid = (ch * dev->geo.num_lun) + lun;
127 WARN_ON(!test_and_clear_bit(lunid,
128 dev->lun_map));
132 kfree(ch_map->lun_offs);
135 kfree(dev_map->chnls);
136 kfree(dev_map);
138 kfree(tgt_dev->luns);
139 kfree(tgt_dev);
142 static struct nvm_tgt_dev *nvm_create_tgt_dev(struct nvm_dev *dev,
143 u16 lun_begin, u16 lun_end,
144 u16 op)
146 struct nvm_tgt_dev *tgt_dev = NULL;
147 struct nvm_dev_map *dev_rmap = dev->rmap;
148 struct nvm_dev_map *dev_map;
149 struct ppa_addr *luns;
150 int num_lun = lun_end - lun_begin + 1;
151 int luns_left = num_lun;
152 int num_ch = num_lun / dev->geo.num_lun;
153 int num_ch_mod = num_lun % dev->geo.num_lun;
154 int bch = lun_begin / dev->geo.num_lun;
155 int blun = lun_begin % dev->geo.num_lun;
156 int lunid = 0;
157 int lun_balanced = 1;
158 int sec_per_lun, prev_num_lun;
159 int i, j;
161 num_ch = (num_ch_mod == 0) ? num_ch : num_ch + 1;
163 dev_map = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
164 if (!dev_map)
165 goto err_dev;
167 dev_map->chnls = kcalloc(num_ch, sizeof(struct nvm_ch_map), GFP_KERNEL);
168 if (!dev_map->chnls)
169 goto err_chnls;
171 luns = kcalloc(num_lun, sizeof(struct ppa_addr), GFP_KERNEL);
172 if (!luns)
173 goto err_luns;
175 prev_num_lun = (luns_left > dev->geo.num_lun) ?
176 dev->geo.num_lun : luns_left;
177 for (i = 0; i < num_ch; i++) {
178 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[i + bch];
179 int *lun_roffs = ch_rmap->lun_offs;
180 struct nvm_ch_map *ch_map = &dev_map->chnls[i];
181 int *lun_offs;
182 int luns_in_chnl = (luns_left > dev->geo.num_lun) ?
183 dev->geo.num_lun : luns_left;
185 if (lun_balanced && prev_num_lun != luns_in_chnl)
186 lun_balanced = 0;
188 ch_map->ch_off = ch_rmap->ch_off = bch;
189 ch_map->num_lun = luns_in_chnl;
191 lun_offs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
192 if (!lun_offs)
193 goto err_ch;
195 for (j = 0; j < luns_in_chnl; j++) {
196 luns[lunid].ppa = 0;
197 luns[lunid].a.ch = i;
198 luns[lunid++].a.lun = j;
200 lun_offs[j] = blun;
201 lun_roffs[j + blun] = blun;
204 ch_map->lun_offs = lun_offs;
206 /* when starting a new channel, lun offset is reset */
207 blun = 0;
208 luns_left -= luns_in_chnl;
211 dev_map->num_ch = num_ch;
213 tgt_dev = kmalloc(sizeof(struct nvm_tgt_dev), GFP_KERNEL);
214 if (!tgt_dev)
215 goto err_ch;
217 /* Inherit device geometry from parent */
218 memcpy(&tgt_dev->geo, &dev->geo, sizeof(struct nvm_geo));
220 /* Target device only owns a portion of the physical device */
221 tgt_dev->geo.num_ch = num_ch;
222 tgt_dev->geo.num_lun = (lun_balanced) ? prev_num_lun : -1;
223 tgt_dev->geo.all_luns = num_lun;
224 tgt_dev->geo.all_chunks = num_lun * dev->geo.num_chk;
226 tgt_dev->geo.op = op;
228 sec_per_lun = dev->geo.clba * dev->geo.num_chk;
229 tgt_dev->geo.total_secs = num_lun * sec_per_lun;
231 tgt_dev->q = dev->q;
232 tgt_dev->map = dev_map;
233 tgt_dev->luns = luns;
234 tgt_dev->parent = dev;
236 return tgt_dev;
237 err_ch:
238 while (--i >= 0)
239 kfree(dev_map->chnls[i].lun_offs);
240 kfree(luns);
241 err_luns:
242 kfree(dev_map->chnls);
243 err_chnls:
244 kfree(dev_map);
245 err_dev:
246 return tgt_dev;
249 static const struct block_device_operations nvm_fops = {
250 .owner = THIS_MODULE,
253 static struct nvm_tgt_type *__nvm_find_target_type(const char *name)
255 struct nvm_tgt_type *tt;
257 list_for_each_entry(tt, &nvm_tgt_types, list)
258 if (!strcmp(name, tt->name))
259 return tt;
261 return NULL;
264 static struct nvm_tgt_type *nvm_find_target_type(const char *name)
266 struct nvm_tgt_type *tt;
268 down_write(&nvm_tgtt_lock);
269 tt = __nvm_find_target_type(name);
270 up_write(&nvm_tgtt_lock);
272 return tt;
275 static int nvm_config_check_luns(struct nvm_geo *geo, int lun_begin,
276 int lun_end)
278 if (lun_begin > lun_end || lun_end >= geo->all_luns) {
279 pr_err("nvm: lun out of bound (%u:%u > %u)\n",
280 lun_begin, lun_end, geo->all_luns - 1);
281 return -EINVAL;
284 return 0;
287 static int __nvm_config_simple(struct nvm_dev *dev,
288 struct nvm_ioctl_create_simple *s)
290 struct nvm_geo *geo = &dev->geo;
292 if (s->lun_begin == -1 && s->lun_end == -1) {
293 s->lun_begin = 0;
294 s->lun_end = geo->all_luns - 1;
297 return nvm_config_check_luns(geo, s->lun_begin, s->lun_end);
300 static int __nvm_config_extended(struct nvm_dev *dev,
301 struct nvm_ioctl_create_extended *e)
303 if (e->lun_begin == 0xFFFF && e->lun_end == 0xFFFF) {
304 e->lun_begin = 0;
305 e->lun_end = dev->geo.all_luns - 1;
308 /* op not set falls into target's default */
309 if (e->op == 0xFFFF) {
310 e->op = NVM_TARGET_DEFAULT_OP;
311 } else if (e->op < NVM_TARGET_MIN_OP || e->op > NVM_TARGET_MAX_OP) {
312 pr_err("nvm: invalid over provisioning value\n");
313 return -EINVAL;
316 return nvm_config_check_luns(&dev->geo, e->lun_begin, e->lun_end);
319 static int nvm_create_tgt(struct nvm_dev *dev, struct nvm_ioctl_create *create)
321 struct nvm_ioctl_create_extended e;
322 struct request_queue *tqueue;
323 struct gendisk *tdisk;
324 struct nvm_tgt_type *tt;
325 struct nvm_target *t;
326 struct nvm_tgt_dev *tgt_dev;
327 void *targetdata;
328 int ret;
330 switch (create->conf.type) {
331 case NVM_CONFIG_TYPE_SIMPLE:
332 ret = __nvm_config_simple(dev, &create->conf.s);
333 if (ret)
334 return ret;
336 e.lun_begin = create->conf.s.lun_begin;
337 e.lun_end = create->conf.s.lun_end;
338 e.op = NVM_TARGET_DEFAULT_OP;
339 break;
340 case NVM_CONFIG_TYPE_EXTENDED:
341 ret = __nvm_config_extended(dev, &create->conf.e);
342 if (ret)
343 return ret;
345 e = create->conf.e;
346 break;
347 default:
348 pr_err("nvm: config type not valid\n");
349 return -EINVAL;
352 tt = nvm_find_target_type(create->tgttype);
353 if (!tt) {
354 pr_err("nvm: target type %s not found\n", create->tgttype);
355 return -EINVAL;
358 if ((tt->flags & NVM_TGT_F_HOST_L2P) != (dev->geo.dom & NVM_RSP_L2P)) {
359 pr_err("nvm: device is incompatible with target L2P type.\n");
360 return -EINVAL;
363 if (nvm_target_exists(create->tgtname)) {
364 pr_err("nvm: target name already exists (%s)\n",
365 create->tgtname);
366 return -EINVAL;
369 ret = nvm_reserve_luns(dev, e.lun_begin, e.lun_end);
370 if (ret)
371 return ret;
373 t = kmalloc(sizeof(struct nvm_target), GFP_KERNEL);
374 if (!t) {
375 ret = -ENOMEM;
376 goto err_reserve;
379 tgt_dev = nvm_create_tgt_dev(dev, e.lun_begin, e.lun_end, e.op);
380 if (!tgt_dev) {
381 pr_err("nvm: could not create target device\n");
382 ret = -ENOMEM;
383 goto err_t;
386 tdisk = alloc_disk(0);
387 if (!tdisk) {
388 ret = -ENOMEM;
389 goto err_dev;
392 tqueue = blk_alloc_queue_node(GFP_KERNEL, dev->q->node, NULL);
393 if (!tqueue) {
394 ret = -ENOMEM;
395 goto err_disk;
397 blk_queue_make_request(tqueue, tt->make_rq);
399 strlcpy(tdisk->disk_name, create->tgtname, sizeof(tdisk->disk_name));
400 tdisk->flags = GENHD_FL_EXT_DEVT;
401 tdisk->major = 0;
402 tdisk->first_minor = 0;
403 tdisk->fops = &nvm_fops;
404 tdisk->queue = tqueue;
406 targetdata = tt->init(tgt_dev, tdisk, create->flags);
407 if (IS_ERR(targetdata)) {
408 ret = PTR_ERR(targetdata);
409 goto err_init;
412 tdisk->private_data = targetdata;
413 tqueue->queuedata = targetdata;
415 blk_queue_max_hw_sectors(tqueue,
416 (dev->geo.csecs >> 9) * NVM_MAX_VLBA);
418 set_capacity(tdisk, tt->capacity(targetdata));
419 add_disk(tdisk);
421 if (tt->sysfs_init && tt->sysfs_init(tdisk)) {
422 ret = -ENOMEM;
423 goto err_sysfs;
426 t->type = tt;
427 t->disk = tdisk;
428 t->dev = tgt_dev;
430 mutex_lock(&dev->mlock);
431 list_add_tail(&t->list, &dev->targets);
432 mutex_unlock(&dev->mlock);
434 __module_get(tt->owner);
436 return 0;
437 err_sysfs:
438 if (tt->exit)
439 tt->exit(targetdata, true);
440 err_init:
441 blk_cleanup_queue(tqueue);
442 tdisk->queue = NULL;
443 err_disk:
444 put_disk(tdisk);
445 err_dev:
446 nvm_remove_tgt_dev(tgt_dev, 0);
447 err_t:
448 kfree(t);
449 err_reserve:
450 nvm_release_luns_err(dev, e.lun_begin, e.lun_end);
451 return ret;
454 static void __nvm_remove_target(struct nvm_target *t, bool graceful)
456 struct nvm_tgt_type *tt = t->type;
457 struct gendisk *tdisk = t->disk;
458 struct request_queue *q = tdisk->queue;
460 del_gendisk(tdisk);
461 blk_cleanup_queue(q);
463 if (tt->sysfs_exit)
464 tt->sysfs_exit(tdisk);
466 if (tt->exit)
467 tt->exit(tdisk->private_data, graceful);
469 nvm_remove_tgt_dev(t->dev, 1);
470 put_disk(tdisk);
471 module_put(t->type->owner);
473 list_del(&t->list);
474 kfree(t);
478 * nvm_remove_tgt - Removes a target from the media manager
479 * @dev: device
480 * @remove: ioctl structure with target name to remove.
482 * Returns:
483 * 0: on success
484 * 1: on not found
485 * <0: on error
487 static int nvm_remove_tgt(struct nvm_dev *dev, struct nvm_ioctl_remove *remove)
489 struct nvm_target *t;
491 mutex_lock(&dev->mlock);
492 t = nvm_find_target(dev, remove->tgtname);
493 if (!t) {
494 mutex_unlock(&dev->mlock);
495 return 1;
497 __nvm_remove_target(t, true);
498 mutex_unlock(&dev->mlock);
500 return 0;
503 static int nvm_register_map(struct nvm_dev *dev)
505 struct nvm_dev_map *rmap;
506 int i, j;
508 rmap = kmalloc(sizeof(struct nvm_dev_map), GFP_KERNEL);
509 if (!rmap)
510 goto err_rmap;
512 rmap->chnls = kcalloc(dev->geo.num_ch, sizeof(struct nvm_ch_map),
513 GFP_KERNEL);
514 if (!rmap->chnls)
515 goto err_chnls;
517 for (i = 0; i < dev->geo.num_ch; i++) {
518 struct nvm_ch_map *ch_rmap;
519 int *lun_roffs;
520 int luns_in_chnl = dev->geo.num_lun;
522 ch_rmap = &rmap->chnls[i];
524 ch_rmap->ch_off = -1;
525 ch_rmap->num_lun = luns_in_chnl;
527 lun_roffs = kcalloc(luns_in_chnl, sizeof(int), GFP_KERNEL);
528 if (!lun_roffs)
529 goto err_ch;
531 for (j = 0; j < luns_in_chnl; j++)
532 lun_roffs[j] = -1;
534 ch_rmap->lun_offs = lun_roffs;
537 dev->rmap = rmap;
539 return 0;
540 err_ch:
541 while (--i >= 0)
542 kfree(rmap->chnls[i].lun_offs);
543 err_chnls:
544 kfree(rmap);
545 err_rmap:
546 return -ENOMEM;
549 static void nvm_unregister_map(struct nvm_dev *dev)
551 struct nvm_dev_map *rmap = dev->rmap;
552 int i;
554 for (i = 0; i < dev->geo.num_ch; i++)
555 kfree(rmap->chnls[i].lun_offs);
557 kfree(rmap->chnls);
558 kfree(rmap);
561 static void nvm_map_to_dev(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
563 struct nvm_dev_map *dev_map = tgt_dev->map;
564 struct nvm_ch_map *ch_map = &dev_map->chnls[p->a.ch];
565 int lun_off = ch_map->lun_offs[p->a.lun];
567 p->a.ch += ch_map->ch_off;
568 p->a.lun += lun_off;
571 static void nvm_map_to_tgt(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *p)
573 struct nvm_dev *dev = tgt_dev->parent;
574 struct nvm_dev_map *dev_rmap = dev->rmap;
575 struct nvm_ch_map *ch_rmap = &dev_rmap->chnls[p->a.ch];
576 int lun_roff = ch_rmap->lun_offs[p->a.lun];
578 p->a.ch -= ch_rmap->ch_off;
579 p->a.lun -= lun_roff;
582 static void nvm_ppa_tgt_to_dev(struct nvm_tgt_dev *tgt_dev,
583 struct ppa_addr *ppa_list, int nr_ppas)
585 int i;
587 for (i = 0; i < nr_ppas; i++) {
588 nvm_map_to_dev(tgt_dev, &ppa_list[i]);
589 ppa_list[i] = generic_to_dev_addr(tgt_dev->parent, ppa_list[i]);
593 static void nvm_ppa_dev_to_tgt(struct nvm_tgt_dev *tgt_dev,
594 struct ppa_addr *ppa_list, int nr_ppas)
596 int i;
598 for (i = 0; i < nr_ppas; i++) {
599 ppa_list[i] = dev_to_generic_addr(tgt_dev->parent, ppa_list[i]);
600 nvm_map_to_tgt(tgt_dev, &ppa_list[i]);
604 static void nvm_rq_tgt_to_dev(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
606 struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
608 nvm_ppa_tgt_to_dev(tgt_dev, ppa_list, rqd->nr_ppas);
611 static void nvm_rq_dev_to_tgt(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
613 struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
615 nvm_ppa_dev_to_tgt(tgt_dev, ppa_list, rqd->nr_ppas);
618 int nvm_register_tgt_type(struct nvm_tgt_type *tt)
620 int ret = 0;
622 down_write(&nvm_tgtt_lock);
623 if (__nvm_find_target_type(tt->name))
624 ret = -EEXIST;
625 else
626 list_add(&tt->list, &nvm_tgt_types);
627 up_write(&nvm_tgtt_lock);
629 return ret;
631 EXPORT_SYMBOL(nvm_register_tgt_type);
633 void nvm_unregister_tgt_type(struct nvm_tgt_type *tt)
635 if (!tt)
636 return;
638 down_write(&nvm_tgtt_lock);
639 list_del(&tt->list);
640 up_write(&nvm_tgtt_lock);
642 EXPORT_SYMBOL(nvm_unregister_tgt_type);
644 void *nvm_dev_dma_alloc(struct nvm_dev *dev, gfp_t mem_flags,
645 dma_addr_t *dma_handler)
647 return dev->ops->dev_dma_alloc(dev, dev->dma_pool, mem_flags,
648 dma_handler);
650 EXPORT_SYMBOL(nvm_dev_dma_alloc);
652 void nvm_dev_dma_free(struct nvm_dev *dev, void *addr, dma_addr_t dma_handler)
654 dev->ops->dev_dma_free(dev->dma_pool, addr, dma_handler);
656 EXPORT_SYMBOL(nvm_dev_dma_free);
658 static struct nvm_dev *nvm_find_nvm_dev(const char *name)
660 struct nvm_dev *dev;
662 list_for_each_entry(dev, &nvm_devices, devices)
663 if (!strcmp(name, dev->name))
664 return dev;
666 return NULL;
669 static int nvm_set_rqd_ppalist(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd,
670 const struct ppa_addr *ppas, int nr_ppas)
672 struct nvm_dev *dev = tgt_dev->parent;
673 struct nvm_geo *geo = &tgt_dev->geo;
674 int i, plane_cnt, pl_idx;
675 struct ppa_addr ppa;
677 if (geo->pln_mode == NVM_PLANE_SINGLE && nr_ppas == 1) {
678 rqd->nr_ppas = nr_ppas;
679 rqd->ppa_addr = ppas[0];
681 return 0;
684 rqd->nr_ppas = nr_ppas;
685 rqd->ppa_list = nvm_dev_dma_alloc(dev, GFP_KERNEL, &rqd->dma_ppa_list);
686 if (!rqd->ppa_list) {
687 pr_err("nvm: failed to allocate dma memory\n");
688 return -ENOMEM;
691 plane_cnt = geo->pln_mode;
692 rqd->nr_ppas *= plane_cnt;
694 for (i = 0; i < nr_ppas; i++) {
695 for (pl_idx = 0; pl_idx < plane_cnt; pl_idx++) {
696 ppa = ppas[i];
697 ppa.g.pl = pl_idx;
698 rqd->ppa_list[(pl_idx * nr_ppas) + i] = ppa;
702 return 0;
705 static void nvm_free_rqd_ppalist(struct nvm_tgt_dev *tgt_dev,
706 struct nvm_rq *rqd)
708 if (!rqd->ppa_list)
709 return;
711 nvm_dev_dma_free(tgt_dev->parent, rqd->ppa_list, rqd->dma_ppa_list);
714 static int nvm_set_flags(struct nvm_geo *geo, struct nvm_rq *rqd)
716 int flags = 0;
718 if (geo->version == NVM_OCSSD_SPEC_20)
719 return 0;
721 if (rqd->is_seq)
722 flags |= geo->pln_mode >> 1;
724 if (rqd->opcode == NVM_OP_PREAD)
725 flags |= (NVM_IO_SCRAMBLE_ENABLE | NVM_IO_SUSPEND);
726 else if (rqd->opcode == NVM_OP_PWRITE)
727 flags |= NVM_IO_SCRAMBLE_ENABLE;
729 return flags;
732 int nvm_submit_io(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
734 struct nvm_dev *dev = tgt_dev->parent;
735 int ret;
737 if (!dev->ops->submit_io)
738 return -ENODEV;
740 nvm_rq_tgt_to_dev(tgt_dev, rqd);
742 rqd->dev = tgt_dev;
743 rqd->flags = nvm_set_flags(&tgt_dev->geo, rqd);
745 /* In case of error, fail with right address format */
746 ret = dev->ops->submit_io(dev, rqd);
747 if (ret)
748 nvm_rq_dev_to_tgt(tgt_dev, rqd);
749 return ret;
751 EXPORT_SYMBOL(nvm_submit_io);
753 int nvm_submit_io_sync(struct nvm_tgt_dev *tgt_dev, struct nvm_rq *rqd)
755 struct nvm_dev *dev = tgt_dev->parent;
756 int ret;
758 if (!dev->ops->submit_io_sync)
759 return -ENODEV;
761 nvm_rq_tgt_to_dev(tgt_dev, rqd);
763 rqd->dev = tgt_dev;
764 rqd->flags = nvm_set_flags(&tgt_dev->geo, rqd);
766 /* In case of error, fail with right address format */
767 ret = dev->ops->submit_io_sync(dev, rqd);
768 nvm_rq_dev_to_tgt(tgt_dev, rqd);
770 return ret;
772 EXPORT_SYMBOL(nvm_submit_io_sync);
774 void nvm_end_io(struct nvm_rq *rqd)
776 struct nvm_tgt_dev *tgt_dev = rqd->dev;
778 /* Convert address space */
779 if (tgt_dev)
780 nvm_rq_dev_to_tgt(tgt_dev, rqd);
782 if (rqd->end_io)
783 rqd->end_io(rqd);
785 EXPORT_SYMBOL(nvm_end_io);
787 static int nvm_submit_io_sync_raw(struct nvm_dev *dev, struct nvm_rq *rqd)
789 if (!dev->ops->submit_io_sync)
790 return -ENODEV;
792 rqd->flags = nvm_set_flags(&dev->geo, rqd);
794 return dev->ops->submit_io_sync(dev, rqd);
797 static int nvm_bb_chunk_sense(struct nvm_dev *dev, struct ppa_addr ppa)
799 struct nvm_rq rqd = { NULL };
800 struct bio bio;
801 struct bio_vec bio_vec;
802 struct page *page;
803 int ret;
805 page = alloc_page(GFP_KERNEL);
806 if (!page)
807 return -ENOMEM;
809 bio_init(&bio, &bio_vec, 1);
810 bio_add_page(&bio, page, PAGE_SIZE, 0);
811 bio_set_op_attrs(&bio, REQ_OP_READ, 0);
813 rqd.bio = &bio;
814 rqd.opcode = NVM_OP_PREAD;
815 rqd.is_seq = 1;
816 rqd.nr_ppas = 1;
817 rqd.ppa_addr = generic_to_dev_addr(dev, ppa);
819 ret = nvm_submit_io_sync_raw(dev, &rqd);
820 if (ret)
821 return ret;
823 __free_page(page);
825 return rqd.error;
829 * Scans a 1.2 chunk first and last page to determine if its state.
830 * If the chunk is found to be open, also scan it to update the write
831 * pointer.
833 static int nvm_bb_chunk_scan(struct nvm_dev *dev, struct ppa_addr ppa,
834 struct nvm_chk_meta *meta)
836 struct nvm_geo *geo = &dev->geo;
837 int ret, pg, pl;
839 /* sense first page */
840 ret = nvm_bb_chunk_sense(dev, ppa);
841 if (ret < 0) /* io error */
842 return ret;
843 else if (ret == 0) /* valid data */
844 meta->state = NVM_CHK_ST_OPEN;
845 else if (ret > 0) {
847 * If empty page, the chunk is free, else it is an
848 * actual io error. In that case, mark it offline.
850 switch (ret) {
851 case NVM_RSP_ERR_EMPTYPAGE:
852 meta->state = NVM_CHK_ST_FREE;
853 return 0;
854 case NVM_RSP_ERR_FAILCRC:
855 case NVM_RSP_ERR_FAILECC:
856 case NVM_RSP_WARN_HIGHECC:
857 meta->state = NVM_CHK_ST_OPEN;
858 goto scan;
859 default:
860 return -ret; /* other io error */
864 /* sense last page */
865 ppa.g.pg = geo->num_pg - 1;
866 ppa.g.pl = geo->num_pln - 1;
868 ret = nvm_bb_chunk_sense(dev, ppa);
869 if (ret < 0) /* io error */
870 return ret;
871 else if (ret == 0) { /* Chunk fully written */
872 meta->state = NVM_CHK_ST_CLOSED;
873 meta->wp = geo->clba;
874 return 0;
875 } else if (ret > 0) {
876 switch (ret) {
877 case NVM_RSP_ERR_EMPTYPAGE:
878 case NVM_RSP_ERR_FAILCRC:
879 case NVM_RSP_ERR_FAILECC:
880 case NVM_RSP_WARN_HIGHECC:
881 meta->state = NVM_CHK_ST_OPEN;
882 break;
883 default:
884 return -ret; /* other io error */
888 scan:
890 * chunk is open, we scan sequentially to update the write pointer.
891 * We make the assumption that targets write data across all planes
892 * before moving to the next page.
894 for (pg = 0; pg < geo->num_pg; pg++) {
895 for (pl = 0; pl < geo->num_pln; pl++) {
896 ppa.g.pg = pg;
897 ppa.g.pl = pl;
899 ret = nvm_bb_chunk_sense(dev, ppa);
900 if (ret < 0) /* io error */
901 return ret;
902 else if (ret == 0) {
903 meta->wp += geo->ws_min;
904 } else if (ret > 0) {
905 switch (ret) {
906 case NVM_RSP_ERR_EMPTYPAGE:
907 return 0;
908 case NVM_RSP_ERR_FAILCRC:
909 case NVM_RSP_ERR_FAILECC:
910 case NVM_RSP_WARN_HIGHECC:
911 meta->wp += geo->ws_min;
912 break;
913 default:
914 return -ret; /* other io error */
920 return 0;
924 * folds a bad block list from its plane representation to its
925 * chunk representation.
927 * If any of the planes status are bad or grown bad, the chunk is marked
928 * offline. If not bad, the first plane state acts as the chunk state.
930 static int nvm_bb_to_chunk(struct nvm_dev *dev, struct ppa_addr ppa,
931 u8 *blks, int nr_blks, struct nvm_chk_meta *meta)
933 struct nvm_geo *geo = &dev->geo;
934 int ret, blk, pl, offset, blktype;
936 for (blk = 0; blk < geo->num_chk; blk++) {
937 offset = blk * geo->pln_mode;
938 blktype = blks[offset];
940 for (pl = 0; pl < geo->pln_mode; pl++) {
941 if (blks[offset + pl] &
942 (NVM_BLK_T_BAD|NVM_BLK_T_GRWN_BAD)) {
943 blktype = blks[offset + pl];
944 break;
948 ppa.g.blk = blk;
950 meta->wp = 0;
951 meta->type = NVM_CHK_TP_W_SEQ;
952 meta->wi = 0;
953 meta->slba = generic_to_dev_addr(dev, ppa).ppa;
954 meta->cnlb = dev->geo.clba;
956 if (blktype == NVM_BLK_T_FREE) {
957 ret = nvm_bb_chunk_scan(dev, ppa, meta);
958 if (ret)
959 return ret;
960 } else {
961 meta->state = NVM_CHK_ST_OFFLINE;
964 meta++;
967 return 0;
970 static int nvm_get_bb_meta(struct nvm_dev *dev, sector_t slba,
971 int nchks, struct nvm_chk_meta *meta)
973 struct nvm_geo *geo = &dev->geo;
974 struct ppa_addr ppa;
975 u8 *blks;
976 int ch, lun, nr_blks;
977 int ret;
979 ppa.ppa = slba;
980 ppa = dev_to_generic_addr(dev, ppa);
982 if (ppa.g.blk != 0)
983 return -EINVAL;
985 if ((nchks % geo->num_chk) != 0)
986 return -EINVAL;
988 nr_blks = geo->num_chk * geo->pln_mode;
990 blks = kmalloc(nr_blks, GFP_KERNEL);
991 if (!blks)
992 return -ENOMEM;
994 for (ch = ppa.g.ch; ch < geo->num_ch; ch++) {
995 for (lun = ppa.g.lun; lun < geo->num_lun; lun++) {
996 struct ppa_addr ppa_gen, ppa_dev;
998 if (!nchks)
999 goto done;
1001 ppa_gen.ppa = 0;
1002 ppa_gen.g.ch = ch;
1003 ppa_gen.g.lun = lun;
1004 ppa_dev = generic_to_dev_addr(dev, ppa_gen);
1006 ret = dev->ops->get_bb_tbl(dev, ppa_dev, blks);
1007 if (ret)
1008 goto done;
1010 ret = nvm_bb_to_chunk(dev, ppa_gen, blks, nr_blks,
1011 meta);
1012 if (ret)
1013 goto done;
1015 meta += geo->num_chk;
1016 nchks -= geo->num_chk;
1019 done:
1020 kfree(blks);
1021 return ret;
1024 int nvm_get_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr ppa,
1025 int nchks, struct nvm_chk_meta *meta)
1027 struct nvm_dev *dev = tgt_dev->parent;
1029 nvm_ppa_tgt_to_dev(tgt_dev, &ppa, 1);
1031 if (dev->geo.version == NVM_OCSSD_SPEC_12)
1032 return nvm_get_bb_meta(dev, (sector_t)ppa.ppa, nchks, meta);
1034 return dev->ops->get_chk_meta(dev, (sector_t)ppa.ppa, nchks, meta);
1036 EXPORT_SYMBOL_GPL(nvm_get_chunk_meta);
1038 int nvm_set_chunk_meta(struct nvm_tgt_dev *tgt_dev, struct ppa_addr *ppas,
1039 int nr_ppas, int type)
1041 struct nvm_dev *dev = tgt_dev->parent;
1042 struct nvm_rq rqd;
1043 int ret;
1045 if (dev->geo.version == NVM_OCSSD_SPEC_20)
1046 return 0;
1048 if (nr_ppas > NVM_MAX_VLBA) {
1049 pr_err("nvm: unable to update all blocks atomically\n");
1050 return -EINVAL;
1053 memset(&rqd, 0, sizeof(struct nvm_rq));
1055 nvm_set_rqd_ppalist(tgt_dev, &rqd, ppas, nr_ppas);
1056 nvm_rq_tgt_to_dev(tgt_dev, &rqd);
1058 ret = dev->ops->set_bb_tbl(dev, &rqd.ppa_addr, rqd.nr_ppas, type);
1059 nvm_free_rqd_ppalist(tgt_dev, &rqd);
1060 if (ret)
1061 return -EINVAL;
1063 return 0;
1065 EXPORT_SYMBOL_GPL(nvm_set_chunk_meta);
1067 static int nvm_core_init(struct nvm_dev *dev)
1069 struct nvm_geo *geo = &dev->geo;
1070 int ret;
1072 dev->lun_map = kcalloc(BITS_TO_LONGS(geo->all_luns),
1073 sizeof(unsigned long), GFP_KERNEL);
1074 if (!dev->lun_map)
1075 return -ENOMEM;
1077 INIT_LIST_HEAD(&dev->area_list);
1078 INIT_LIST_HEAD(&dev->targets);
1079 mutex_init(&dev->mlock);
1080 spin_lock_init(&dev->lock);
1082 ret = nvm_register_map(dev);
1083 if (ret)
1084 goto err_fmtype;
1086 return 0;
1087 err_fmtype:
1088 kfree(dev->lun_map);
1089 return ret;
1092 static void nvm_free(struct nvm_dev *dev)
1094 if (!dev)
1095 return;
1097 if (dev->dma_pool)
1098 dev->ops->destroy_dma_pool(dev->dma_pool);
1100 nvm_unregister_map(dev);
1101 kfree(dev->lun_map);
1102 kfree(dev);
1105 static int nvm_init(struct nvm_dev *dev)
1107 struct nvm_geo *geo = &dev->geo;
1108 int ret = -EINVAL;
1110 if (dev->ops->identity(dev)) {
1111 pr_err("nvm: device could not be identified\n");
1112 goto err;
1115 pr_debug("nvm: ver:%u.%u nvm_vendor:%x\n",
1116 geo->major_ver_id, geo->minor_ver_id,
1117 geo->vmnt);
1119 ret = nvm_core_init(dev);
1120 if (ret) {
1121 pr_err("nvm: could not initialize core structures.\n");
1122 goto err;
1125 pr_info("nvm: registered %s [%u/%u/%u/%u/%u]\n",
1126 dev->name, dev->geo.ws_min, dev->geo.ws_opt,
1127 dev->geo.num_chk, dev->geo.all_luns,
1128 dev->geo.num_ch);
1129 return 0;
1130 err:
1131 pr_err("nvm: failed to initialize nvm\n");
1132 return ret;
1135 struct nvm_dev *nvm_alloc_dev(int node)
1137 return kzalloc_node(sizeof(struct nvm_dev), GFP_KERNEL, node);
1139 EXPORT_SYMBOL(nvm_alloc_dev);
1141 int nvm_register(struct nvm_dev *dev)
1143 int ret;
1145 if (!dev->q || !dev->ops)
1146 return -EINVAL;
1148 dev->dma_pool = dev->ops->create_dma_pool(dev, "ppalist");
1149 if (!dev->dma_pool) {
1150 pr_err("nvm: could not create dma pool\n");
1151 return -ENOMEM;
1154 ret = nvm_init(dev);
1155 if (ret)
1156 goto err_init;
1158 /* register device with a supported media manager */
1159 down_write(&nvm_lock);
1160 list_add(&dev->devices, &nvm_devices);
1161 up_write(&nvm_lock);
1163 return 0;
1164 err_init:
1165 dev->ops->destroy_dma_pool(dev->dma_pool);
1166 return ret;
1168 EXPORT_SYMBOL(nvm_register);
1170 void nvm_unregister(struct nvm_dev *dev)
1172 struct nvm_target *t, *tmp;
1174 mutex_lock(&dev->mlock);
1175 list_for_each_entry_safe(t, tmp, &dev->targets, list) {
1176 if (t->dev->parent != dev)
1177 continue;
1178 __nvm_remove_target(t, false);
1180 mutex_unlock(&dev->mlock);
1182 down_write(&nvm_lock);
1183 list_del(&dev->devices);
1184 up_write(&nvm_lock);
1186 nvm_free(dev);
1188 EXPORT_SYMBOL(nvm_unregister);
1190 static int __nvm_configure_create(struct nvm_ioctl_create *create)
1192 struct nvm_dev *dev;
1194 down_write(&nvm_lock);
1195 dev = nvm_find_nvm_dev(create->dev);
1196 up_write(&nvm_lock);
1198 if (!dev) {
1199 pr_err("nvm: device not found\n");
1200 return -EINVAL;
1203 return nvm_create_tgt(dev, create);
1206 static long nvm_ioctl_info(struct file *file, void __user *arg)
1208 struct nvm_ioctl_info *info;
1209 struct nvm_tgt_type *tt;
1210 int tgt_iter = 0;
1212 info = memdup_user(arg, sizeof(struct nvm_ioctl_info));
1213 if (IS_ERR(info))
1214 return -EFAULT;
1216 info->version[0] = NVM_VERSION_MAJOR;
1217 info->version[1] = NVM_VERSION_MINOR;
1218 info->version[2] = NVM_VERSION_PATCH;
1220 down_write(&nvm_tgtt_lock);
1221 list_for_each_entry(tt, &nvm_tgt_types, list) {
1222 struct nvm_ioctl_info_tgt *tgt = &info->tgts[tgt_iter];
1224 tgt->version[0] = tt->version[0];
1225 tgt->version[1] = tt->version[1];
1226 tgt->version[2] = tt->version[2];
1227 strncpy(tgt->tgtname, tt->name, NVM_TTYPE_NAME_MAX);
1229 tgt_iter++;
1232 info->tgtsize = tgt_iter;
1233 up_write(&nvm_tgtt_lock);
1235 if (copy_to_user(arg, info, sizeof(struct nvm_ioctl_info))) {
1236 kfree(info);
1237 return -EFAULT;
1240 kfree(info);
1241 return 0;
1244 static long nvm_ioctl_get_devices(struct file *file, void __user *arg)
1246 struct nvm_ioctl_get_devices *devices;
1247 struct nvm_dev *dev;
1248 int i = 0;
1250 devices = kzalloc(sizeof(struct nvm_ioctl_get_devices), GFP_KERNEL);
1251 if (!devices)
1252 return -ENOMEM;
1254 down_write(&nvm_lock);
1255 list_for_each_entry(dev, &nvm_devices, devices) {
1256 struct nvm_ioctl_device_info *info = &devices->info[i];
1258 strlcpy(info->devname, dev->name, sizeof(info->devname));
1260 /* kept for compatibility */
1261 info->bmversion[0] = 1;
1262 info->bmversion[1] = 0;
1263 info->bmversion[2] = 0;
1264 strlcpy(info->bmname, "gennvm", sizeof(info->bmname));
1265 i++;
1267 if (i > 31) {
1268 pr_err("nvm: max 31 devices can be reported.\n");
1269 break;
1272 up_write(&nvm_lock);
1274 devices->nr_devices = i;
1276 if (copy_to_user(arg, devices,
1277 sizeof(struct nvm_ioctl_get_devices))) {
1278 kfree(devices);
1279 return -EFAULT;
1282 kfree(devices);
1283 return 0;
1286 static long nvm_ioctl_dev_create(struct file *file, void __user *arg)
1288 struct nvm_ioctl_create create;
1290 if (copy_from_user(&create, arg, sizeof(struct nvm_ioctl_create)))
1291 return -EFAULT;
1293 if (create.conf.type == NVM_CONFIG_TYPE_EXTENDED &&
1294 create.conf.e.rsv != 0) {
1295 pr_err("nvm: reserved config field in use\n");
1296 return -EINVAL;
1299 create.dev[DISK_NAME_LEN - 1] = '\0';
1300 create.tgttype[NVM_TTYPE_NAME_MAX - 1] = '\0';
1301 create.tgtname[DISK_NAME_LEN - 1] = '\0';
1303 if (create.flags != 0) {
1304 __u32 flags = create.flags;
1306 /* Check for valid flags */
1307 if (flags & NVM_TARGET_FACTORY)
1308 flags &= ~NVM_TARGET_FACTORY;
1310 if (flags) {
1311 pr_err("nvm: flag not supported\n");
1312 return -EINVAL;
1316 return __nvm_configure_create(&create);
1319 static long nvm_ioctl_dev_remove(struct file *file, void __user *arg)
1321 struct nvm_ioctl_remove remove;
1322 struct nvm_dev *dev;
1323 int ret = 0;
1325 if (copy_from_user(&remove, arg, sizeof(struct nvm_ioctl_remove)))
1326 return -EFAULT;
1328 remove.tgtname[DISK_NAME_LEN - 1] = '\0';
1330 if (remove.flags != 0) {
1331 pr_err("nvm: no flags supported\n");
1332 return -EINVAL;
1335 list_for_each_entry(dev, &nvm_devices, devices) {
1336 ret = nvm_remove_tgt(dev, &remove);
1337 if (!ret)
1338 break;
1341 return ret;
1344 /* kept for compatibility reasons */
1345 static long nvm_ioctl_dev_init(struct file *file, void __user *arg)
1347 struct nvm_ioctl_dev_init init;
1349 if (copy_from_user(&init, arg, sizeof(struct nvm_ioctl_dev_init)))
1350 return -EFAULT;
1352 if (init.flags != 0) {
1353 pr_err("nvm: no flags supported\n");
1354 return -EINVAL;
1357 return 0;
1360 /* Kept for compatibility reasons */
1361 static long nvm_ioctl_dev_factory(struct file *file, void __user *arg)
1363 struct nvm_ioctl_dev_factory fact;
1365 if (copy_from_user(&fact, arg, sizeof(struct nvm_ioctl_dev_factory)))
1366 return -EFAULT;
1368 fact.dev[DISK_NAME_LEN - 1] = '\0';
1370 if (fact.flags & ~(NVM_FACTORY_NR_BITS - 1))
1371 return -EINVAL;
1373 return 0;
1376 static long nvm_ctl_ioctl(struct file *file, uint cmd, unsigned long arg)
1378 void __user *argp = (void __user *)arg;
1380 if (!capable(CAP_SYS_ADMIN))
1381 return -EPERM;
1383 switch (cmd) {
1384 case NVM_INFO:
1385 return nvm_ioctl_info(file, argp);
1386 case NVM_GET_DEVICES:
1387 return nvm_ioctl_get_devices(file, argp);
1388 case NVM_DEV_CREATE:
1389 return nvm_ioctl_dev_create(file, argp);
1390 case NVM_DEV_REMOVE:
1391 return nvm_ioctl_dev_remove(file, argp);
1392 case NVM_DEV_INIT:
1393 return nvm_ioctl_dev_init(file, argp);
1394 case NVM_DEV_FACTORY:
1395 return nvm_ioctl_dev_factory(file, argp);
1397 return 0;
1400 static const struct file_operations _ctl_fops = {
1401 .open = nonseekable_open,
1402 .unlocked_ioctl = nvm_ctl_ioctl,
1403 .owner = THIS_MODULE,
1404 .llseek = noop_llseek,
1407 static struct miscdevice _nvm_misc = {
1408 .minor = MISC_DYNAMIC_MINOR,
1409 .name = "lightnvm",
1410 .nodename = "lightnvm/control",
1411 .fops = &_ctl_fops,
1413 builtin_misc_device(_nvm_misc);