Merge branch 'for-4.18/dax' into libnvdimm-for-next
[muen/linux.git] / drivers / nvdimm / pmem.c
1 /*
2  * Persistent Memory Driver
3  *
4  * Copyright (c) 2014-2015, Intel Corporation.
5  * Copyright (c) 2015, Christoph Hellwig <hch@lst.de>.
6  * Copyright (c) 2015, Boaz Harrosh <boaz@plexistor.com>.
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms and conditions of the GNU General Public License,
10  * version 2, as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  * more details.
16  */
17
18 #include <asm/cacheflush.h>
19 #include <linux/blkdev.h>
20 #include <linux/hdreg.h>
21 #include <linux/init.h>
22 #include <linux/platform_device.h>
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/badblocks.h>
26 #include <linux/memremap.h>
27 #include <linux/vmalloc.h>
28 #include <linux/blk-mq.h>
29 #include <linux/pfn_t.h>
30 #include <linux/slab.h>
31 #include <linux/uio.h>
32 #include <linux/dax.h>
33 #include <linux/nd.h>
34 #include <linux/backing-dev.h>
35 #include "pmem.h"
36 #include "pfn.h"
37 #include "nd.h"
38 #include "nd-core.h"
39
40 static struct device *to_dev(struct pmem_device *pmem)
41 {
42         /*
43          * nvdimm bus services need a 'dev' parameter, and we record the device
44          * at init in bb.dev.
45          */
46         return pmem->bb.dev;
47 }
48
49 static struct nd_region *to_region(struct pmem_device *pmem)
50 {
51         return to_nd_region(to_dev(pmem)->parent);
52 }
53
54 static blk_status_t pmem_clear_poison(struct pmem_device *pmem,
55                 phys_addr_t offset, unsigned int len)
56 {
57         struct device *dev = to_dev(pmem);
58         sector_t sector;
59         long cleared;
60         blk_status_t rc = BLK_STS_OK;
61
62         sector = (offset - pmem->data_offset) / 512;
63
64         cleared = nvdimm_clear_poison(dev, pmem->phys_addr + offset, len);
65         if (cleared < len)
66                 rc = BLK_STS_IOERR;
67         if (cleared > 0 && cleared / 512) {
68                 cleared /= 512;
69                 dev_dbg(dev, "%#llx clear %ld sector%s\n",
70                                 (unsigned long long) sector, cleared,
71                                 cleared > 1 ? "s" : "");
72                 badblocks_clear(&pmem->bb, sector, cleared);
73                 if (pmem->bb_state)
74                         sysfs_notify_dirent(pmem->bb_state);
75         }
76
77         arch_invalidate_pmem(pmem->virt_addr + offset, len);
78
79         return rc;
80 }
81
82 static void write_pmem(void *pmem_addr, struct page *page,
83                 unsigned int off, unsigned int len)
84 {
85         unsigned int chunk;
86         void *mem;
87
88         while (len) {
89                 mem = kmap_atomic(page);
90                 chunk = min_t(unsigned int, len, PAGE_SIZE);
91                 memcpy_flushcache(pmem_addr, mem + off, chunk);
92                 kunmap_atomic(mem);
93                 len -= chunk;
94                 off = 0;
95                 page++;
96                 pmem_addr += PAGE_SIZE;
97         }
98 }
99
100 static blk_status_t read_pmem(struct page *page, unsigned int off,
101                 void *pmem_addr, unsigned int len)
102 {
103         unsigned int chunk;
104         int rc;
105         void *mem;
106
107         while (len) {
108                 mem = kmap_atomic(page);
109                 chunk = min_t(unsigned int, len, PAGE_SIZE);
110                 rc = memcpy_mcsafe(mem + off, pmem_addr, chunk);
111                 kunmap_atomic(mem);
112                 if (rc)
113                         return BLK_STS_IOERR;
114                 len -= chunk;
115                 off = 0;
116                 page++;
117                 pmem_addr += PAGE_SIZE;
118         }
119         return BLK_STS_OK;
120 }
121
122 static blk_status_t pmem_do_bvec(struct pmem_device *pmem, struct page *page,
123                         unsigned int len, unsigned int off, bool is_write,
124                         sector_t sector)
125 {
126         blk_status_t rc = BLK_STS_OK;
127         bool bad_pmem = false;
128         phys_addr_t pmem_off = sector * 512 + pmem->data_offset;
129         void *pmem_addr = pmem->virt_addr + pmem_off;
130
131         if (unlikely(is_bad_pmem(&pmem->bb, sector, len)))
132                 bad_pmem = true;
133
134         if (!is_write) {
135                 if (unlikely(bad_pmem))
136                         rc = BLK_STS_IOERR;
137                 else {
138                         rc = read_pmem(page, off, pmem_addr, len);
139                         flush_dcache_page(page);
140                 }
141         } else {
142                 /*
143                  * Note that we write the data both before and after
144                  * clearing poison.  The write before clear poison
145                  * handles situations where the latest written data is
146                  * preserved and the clear poison operation simply marks
147                  * the address range as valid without changing the data.
148                  * In this case application software can assume that an
149                  * interrupted write will either return the new good
150                  * data or an error.
151                  *
152                  * However, if pmem_clear_poison() leaves the data in an
153                  * indeterminate state we need to perform the write
154                  * after clear poison.
155                  */
156                 flush_dcache_page(page);
157                 write_pmem(pmem_addr, page, off, len);
158                 if (unlikely(bad_pmem)) {
159                         rc = pmem_clear_poison(pmem, pmem_off, len);
160                         write_pmem(pmem_addr, page, off, len);
161                 }
162         }
163
164         return rc;
165 }
166
167 static blk_qc_t pmem_make_request(struct request_queue *q, struct bio *bio)
168 {
169         blk_status_t rc = 0;
170         bool do_acct;
171         unsigned long start;
172         struct bio_vec bvec;
173         struct bvec_iter iter;
174         struct pmem_device *pmem = q->queuedata;
175         struct nd_region *nd_region = to_region(pmem);
176
177         if (bio->bi_opf & REQ_PREFLUSH)
178                 nvdimm_flush(nd_region);
179
180         do_acct = nd_iostat_start(bio, &start);
181         bio_for_each_segment(bvec, bio, iter) {
182                 rc = pmem_do_bvec(pmem, bvec.bv_page, bvec.bv_len,
183                                 bvec.bv_offset, op_is_write(bio_op(bio)),
184                                 iter.bi_sector);
185                 if (rc) {
186                         bio->bi_status = rc;
187                         break;
188                 }
189         }
190         if (do_acct)
191                 nd_iostat_end(bio, start);
192
193         if (bio->bi_opf & REQ_FUA)
194                 nvdimm_flush(nd_region);
195
196         bio_endio(bio);
197         return BLK_QC_T_NONE;
198 }
199
200 static int pmem_rw_page(struct block_device *bdev, sector_t sector,
201                        struct page *page, bool is_write)
202 {
203         struct pmem_device *pmem = bdev->bd_queue->queuedata;
204         blk_status_t rc;
205
206         rc = pmem_do_bvec(pmem, page, hpage_nr_pages(page) * PAGE_SIZE,
207                           0, is_write, sector);
208
209         /*
210          * The ->rw_page interface is subtle and tricky.  The core
211          * retries on any error, so we can only invoke page_endio() in
212          * the successful completion case.  Otherwise, we'll see crashes
213          * caused by double completion.
214          */
215         if (rc == 0)
216                 page_endio(page, is_write, 0);
217
218         return blk_status_to_errno(rc);
219 }
220
221 /* see "strong" declaration in tools/testing/nvdimm/pmem-dax.c */
222 __weak long __pmem_direct_access(struct pmem_device *pmem, pgoff_t pgoff,
223                 long nr_pages, void **kaddr, pfn_t *pfn)
224 {
225         resource_size_t offset = PFN_PHYS(pgoff) + pmem->data_offset;
226
227         if (unlikely(is_bad_pmem(&pmem->bb, PFN_PHYS(pgoff) / 512,
228                                         PFN_PHYS(nr_pages))))
229                 return -EIO;
230         *kaddr = pmem->virt_addr + offset;
231         *pfn = phys_to_pfn_t(pmem->phys_addr + offset, pmem->pfn_flags);
232
233         /*
234          * If badblocks are present, limit known good range to the
235          * requested range.
236          */
237         if (unlikely(pmem->bb.count))
238                 return nr_pages;
239         return PHYS_PFN(pmem->size - pmem->pfn_pad - offset);
240 }
241
242 static const struct block_device_operations pmem_fops = {
243         .owner =                THIS_MODULE,
244         .rw_page =              pmem_rw_page,
245         .revalidate_disk =      nvdimm_revalidate_disk,
246 };
247
248 static long pmem_dax_direct_access(struct dax_device *dax_dev,
249                 pgoff_t pgoff, long nr_pages, void **kaddr, pfn_t *pfn)
250 {
251         struct pmem_device *pmem = dax_get_private(dax_dev);
252
253         return __pmem_direct_access(pmem, pgoff, nr_pages, kaddr, pfn);
254 }
255
256 static size_t pmem_copy_from_iter(struct dax_device *dax_dev, pgoff_t pgoff,
257                 void *addr, size_t bytes, struct iov_iter *i)
258 {
259         return copy_from_iter_flushcache(addr, bytes, i);
260 }
261
262 static const struct dax_operations pmem_dax_ops = {
263         .direct_access = pmem_dax_direct_access,
264         .copy_from_iter = pmem_copy_from_iter,
265 };
266
267 static const struct attribute_group *pmem_attribute_groups[] = {
268         &dax_attribute_group,
269         NULL,
270 };
271
272 static void pmem_release_queue(void *q)
273 {
274         blk_cleanup_queue(q);
275 }
276
277 static void pmem_freeze_queue(void *q)
278 {
279         blk_freeze_queue_start(q);
280 }
281
282 static void pmem_release_disk(void *__pmem)
283 {
284         struct pmem_device *pmem = __pmem;
285
286         kill_dax(pmem->dax_dev);
287         put_dax(pmem->dax_dev);
288         del_gendisk(pmem->disk);
289         put_disk(pmem->disk);
290 }
291
292 static void pmem_release_pgmap_ops(void *__pgmap)
293 {
294         dev_pagemap_put_ops();
295 }
296
297 static void fsdax_pagefree(struct page *page, void *data)
298 {
299         wake_up_var(&page->_refcount);
300 }
301
302 static int setup_pagemap_fsdax(struct device *dev, struct dev_pagemap *pgmap)
303 {
304         dev_pagemap_get_ops();
305         if (devm_add_action_or_reset(dev, pmem_release_pgmap_ops, pgmap))
306                 return -ENOMEM;
307         pgmap->type = MEMORY_DEVICE_FS_DAX;
308         pgmap->page_free = fsdax_pagefree;
309
310         return 0;
311 }
312
313 static int pmem_attach_disk(struct device *dev,
314                 struct nd_namespace_common *ndns)
315 {
316         struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
317         struct nd_region *nd_region = to_nd_region(dev->parent);
318         int nid = dev_to_node(dev), fua;
319         struct resource *res = &nsio->res;
320         struct resource bb_res;
321         struct nd_pfn *nd_pfn = NULL;
322         struct dax_device *dax_dev;
323         struct nd_pfn_sb *pfn_sb;
324         struct pmem_device *pmem;
325         struct request_queue *q;
326         struct device *gendev;
327         struct gendisk *disk;
328         void *addr;
329         int rc;
330
331         pmem = devm_kzalloc(dev, sizeof(*pmem), GFP_KERNEL);
332         if (!pmem)
333                 return -ENOMEM;
334
335         /* while nsio_rw_bytes is active, parse a pfn info block if present */
336         if (is_nd_pfn(dev)) {
337                 nd_pfn = to_nd_pfn(dev);
338                 rc = nvdimm_setup_pfn(nd_pfn, &pmem->pgmap);
339                 if (rc)
340                         return rc;
341         }
342
343         /* we're attaching a block device, disable raw namespace access */
344         devm_nsio_disable(dev, nsio);
345
346         dev_set_drvdata(dev, pmem);
347         pmem->phys_addr = res->start;
348         pmem->size = resource_size(res);
349         fua = nvdimm_has_flush(nd_region);
350         if (!IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) || fua < 0) {
351                 dev_warn(dev, "unable to guarantee persistence of writes\n");
352                 fua = 0;
353         }
354
355         if (!devm_request_mem_region(dev, res->start, resource_size(res),
356                                 dev_name(&ndns->dev))) {
357                 dev_warn(dev, "could not reserve region %pR\n", res);
358                 return -EBUSY;
359         }
360
361         q = blk_alloc_queue_node(GFP_KERNEL, dev_to_node(dev), NULL);
362         if (!q)
363                 return -ENOMEM;
364
365         if (devm_add_action_or_reset(dev, pmem_release_queue, q))
366                 return -ENOMEM;
367
368         pmem->pfn_flags = PFN_DEV;
369         pmem->pgmap.ref = &q->q_usage_counter;
370         if (is_nd_pfn(dev)) {
371                 if (setup_pagemap_fsdax(dev, &pmem->pgmap))
372                         return -ENOMEM;
373                 addr = devm_memremap_pages(dev, &pmem->pgmap);
374                 pfn_sb = nd_pfn->pfn_sb;
375                 pmem->data_offset = le64_to_cpu(pfn_sb->dataoff);
376                 pmem->pfn_pad = resource_size(res) -
377                         resource_size(&pmem->pgmap.res);
378                 pmem->pfn_flags |= PFN_MAP;
379                 memcpy(&bb_res, &pmem->pgmap.res, sizeof(bb_res));
380                 bb_res.start += pmem->data_offset;
381         } else if (pmem_should_map_pages(dev)) {
382                 memcpy(&pmem->pgmap.res, &nsio->res, sizeof(pmem->pgmap.res));
383                 pmem->pgmap.altmap_valid = false;
384                 if (setup_pagemap_fsdax(dev, &pmem->pgmap))
385                         return -ENOMEM;
386                 addr = devm_memremap_pages(dev, &pmem->pgmap);
387                 pmem->pfn_flags |= PFN_MAP;
388                 memcpy(&bb_res, &pmem->pgmap.res, sizeof(bb_res));
389         } else
390                 addr = devm_memremap(dev, pmem->phys_addr,
391                                 pmem->size, ARCH_MEMREMAP_PMEM);
392
393         /*
394          * At release time the queue must be frozen before
395          * devm_memremap_pages is unwound
396          */
397         if (devm_add_action_or_reset(dev, pmem_freeze_queue, q))
398                 return -ENOMEM;
399
400         if (IS_ERR(addr))
401                 return PTR_ERR(addr);
402         pmem->virt_addr = addr;
403
404         blk_queue_write_cache(q, true, fua);
405         blk_queue_make_request(q, pmem_make_request);
406         blk_queue_physical_block_size(q, PAGE_SIZE);
407         blk_queue_logical_block_size(q, pmem_sector_size(ndns));
408         blk_queue_max_hw_sectors(q, UINT_MAX);
409         blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
410         blk_queue_flag_set(QUEUE_FLAG_DAX, q);
411         q->queuedata = pmem;
412
413         disk = alloc_disk_node(0, nid);
414         if (!disk)
415                 return -ENOMEM;
416         pmem->disk = disk;
417
418         disk->fops              = &pmem_fops;
419         disk->queue             = q;
420         disk->flags             = GENHD_FL_EXT_DEVT;
421         disk->queue->backing_dev_info->capabilities |= BDI_CAP_SYNCHRONOUS_IO;
422         nvdimm_namespace_disk_name(ndns, disk->disk_name);
423         set_capacity(disk, (pmem->size - pmem->pfn_pad - pmem->data_offset)
424                         / 512);
425         if (devm_init_badblocks(dev, &pmem->bb))
426                 return -ENOMEM;
427         nvdimm_badblocks_populate(nd_region, &pmem->bb, &bb_res);
428         disk->bb = &pmem->bb;
429
430         dax_dev = alloc_dax(pmem, disk->disk_name, &pmem_dax_ops);
431         if (!dax_dev) {
432                 put_disk(disk);
433                 return -ENOMEM;
434         }
435         dax_write_cache(dax_dev, nvdimm_has_cache(nd_region));
436         pmem->dax_dev = dax_dev;
437
438         gendev = disk_to_dev(disk);
439         gendev->groups = pmem_attribute_groups;
440
441         device_add_disk(dev, disk);
442         if (devm_add_action_or_reset(dev, pmem_release_disk, pmem))
443                 return -ENOMEM;
444
445         revalidate_disk(disk);
446
447         pmem->bb_state = sysfs_get_dirent(disk_to_dev(disk)->kobj.sd,
448                                           "badblocks");
449         if (!pmem->bb_state)
450                 dev_warn(dev, "'badblocks' notification disabled\n");
451
452         return 0;
453 }
454
455 static int nd_pmem_probe(struct device *dev)
456 {
457         struct nd_namespace_common *ndns;
458
459         ndns = nvdimm_namespace_common_probe(dev);
460         if (IS_ERR(ndns))
461                 return PTR_ERR(ndns);
462
463         if (devm_nsio_enable(dev, to_nd_namespace_io(&ndns->dev)))
464                 return -ENXIO;
465
466         if (is_nd_btt(dev))
467                 return nvdimm_namespace_attach_btt(ndns);
468
469         if (is_nd_pfn(dev))
470                 return pmem_attach_disk(dev, ndns);
471
472         /* if we find a valid info-block we'll come back as that personality */
473         if (nd_btt_probe(dev, ndns) == 0 || nd_pfn_probe(dev, ndns) == 0
474                         || nd_dax_probe(dev, ndns) == 0)
475                 return -ENXIO;
476
477         /* ...otherwise we're just a raw pmem device */
478         return pmem_attach_disk(dev, ndns);
479 }
480
481 static int nd_pmem_remove(struct device *dev)
482 {
483         struct pmem_device *pmem = dev_get_drvdata(dev);
484
485         if (is_nd_btt(dev))
486                 nvdimm_namespace_detach_btt(to_nd_btt(dev));
487         else {
488                 /*
489                  * Note, this assumes device_lock() context to not race
490                  * nd_pmem_notify()
491                  */
492                 sysfs_put(pmem->bb_state);
493                 pmem->bb_state = NULL;
494         }
495         nvdimm_flush(to_nd_region(dev->parent));
496
497         return 0;
498 }
499
500 static void nd_pmem_shutdown(struct device *dev)
501 {
502         nvdimm_flush(to_nd_region(dev->parent));
503 }
504
505 static void nd_pmem_notify(struct device *dev, enum nvdimm_event event)
506 {
507         struct nd_region *nd_region;
508         resource_size_t offset = 0, end_trunc = 0;
509         struct nd_namespace_common *ndns;
510         struct nd_namespace_io *nsio;
511         struct resource res;
512         struct badblocks *bb;
513         struct kernfs_node *bb_state;
514
515         if (event != NVDIMM_REVALIDATE_POISON)
516                 return;
517
518         if (is_nd_btt(dev)) {
519                 struct nd_btt *nd_btt = to_nd_btt(dev);
520
521                 ndns = nd_btt->ndns;
522                 nd_region = to_nd_region(ndns->dev.parent);
523                 nsio = to_nd_namespace_io(&ndns->dev);
524                 bb = &nsio->bb;
525                 bb_state = NULL;
526         } else {
527                 struct pmem_device *pmem = dev_get_drvdata(dev);
528
529                 nd_region = to_region(pmem);
530                 bb = &pmem->bb;
531                 bb_state = pmem->bb_state;
532
533                 if (is_nd_pfn(dev)) {
534                         struct nd_pfn *nd_pfn = to_nd_pfn(dev);
535                         struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
536
537                         ndns = nd_pfn->ndns;
538                         offset = pmem->data_offset +
539                                         __le32_to_cpu(pfn_sb->start_pad);
540                         end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
541                 } else {
542                         ndns = to_ndns(dev);
543                 }
544
545                 nsio = to_nd_namespace_io(&ndns->dev);
546         }
547
548         res.start = nsio->res.start + offset;
549         res.end = nsio->res.end - end_trunc;
550         nvdimm_badblocks_populate(nd_region, bb, &res);
551         if (bb_state)
552                 sysfs_notify_dirent(bb_state);
553 }
554
555 MODULE_ALIAS("pmem");
556 MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_IO);
557 MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_PMEM);
558 static struct nd_device_driver nd_pmem_driver = {
559         .probe = nd_pmem_probe,
560         .remove = nd_pmem_remove,
561         .notify = nd_pmem_notify,
562         .shutdown = nd_pmem_shutdown,
563         .drv = {
564                 .name = "nd_pmem",
565         },
566         .type = ND_DRIVER_NAMESPACE_IO | ND_DRIVER_NAMESPACE_PMEM,
567 };
568
569 module_nd_driver(nd_pmem_driver);
570
571 MODULE_AUTHOR("Ross Zwisler <ross.zwisler@linux.intel.com>");
572 MODULE_LICENSE("GPL v2");