xref: /linux/drivers/nvdimm/pmem.c (revision 7f063b2f17eaba2a35e251aa53627f2a70d536e2)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Persistent Memory Driver
4  *
5  * Copyright (c) 2014-2015, Intel Corporation.
6  * Copyright (c) 2015, Christoph Hellwig <hch@lst.de>.
7  * Copyright (c) 2015, Boaz Harrosh <boaz@plexistor.com>.
8  */
9 
10 #include <linux/blkdev.h>
11 #include <linux/pagemap.h>
12 #include <linux/hdreg.h>
13 #include <linux/init.h>
14 #include <linux/platform_device.h>
15 #include <linux/set_memory.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/badblocks.h>
19 #include <linux/memremap.h>
20 #include <linux/kstrtox.h>
21 #include <linux/vmalloc.h>
22 #include <linux/blk-mq.h>
23 #include <linux/slab.h>
24 #include <linux/uio.h>
25 #include <linux/dax.h>
26 #include <linux/nd.h>
27 #include <linux/mm.h>
28 #include <asm/cacheflush.h>
29 #include "pmem.h"
30 #include "btt.h"
31 #include "pfn.h"
32 #include "nd.h"
33 
to_dev(struct pmem_device * pmem)34 static struct device *to_dev(struct pmem_device *pmem)
35 {
36 	/*
37 	 * nvdimm bus services need a 'dev' parameter, and we record the device
38 	 * at init in bb.dev.
39 	 */
40 	return pmem->bb.dev;
41 }
42 
to_region(struct pmem_device * pmem)43 static struct nd_region *to_region(struct pmem_device *pmem)
44 {
45 	return to_nd_region(to_dev(pmem)->parent);
46 }
47 
pmem_to_phys(struct pmem_device * pmem,phys_addr_t offset)48 static phys_addr_t pmem_to_phys(struct pmem_device *pmem, phys_addr_t offset)
49 {
50 	return pmem->phys_addr + offset;
51 }
52 
to_sect(struct pmem_device * pmem,phys_addr_t offset)53 static sector_t to_sect(struct pmem_device *pmem, phys_addr_t offset)
54 {
55 	return (offset - pmem->data_offset) >> SECTOR_SHIFT;
56 }
57 
to_offset(struct pmem_device * pmem,sector_t sector)58 static phys_addr_t to_offset(struct pmem_device *pmem, sector_t sector)
59 {
60 	return (sector << SECTOR_SHIFT) + pmem->data_offset;
61 }
62 
pmem_mkpage_present(struct pmem_device * pmem,phys_addr_t offset,unsigned int len)63 static void pmem_mkpage_present(struct pmem_device *pmem, phys_addr_t offset,
64 		unsigned int len)
65 {
66 	phys_addr_t phys = pmem_to_phys(pmem, offset);
67 	unsigned long pfn_start, pfn_end, pfn;
68 
69 	/* only pmem in the linear map supports HWPoison */
70 	if (is_vmalloc_addr(pmem->virt_addr))
71 		return;
72 
73 	pfn_start = PHYS_PFN(phys);
74 	pfn_end = pfn_start + PHYS_PFN(len);
75 	for (pfn = pfn_start; pfn < pfn_end; pfn++) {
76 		struct page *page = pfn_to_page(pfn);
77 
78 		/*
79 		 * Note, no need to hold a get_dev_pagemap() reference
80 		 * here since we're in the driver I/O path and
81 		 * outstanding I/O requests pin the dev_pagemap.
82 		 */
83 		if (test_and_clear_pmem_poison(page))
84 			clear_mce_nospec(pfn);
85 	}
86 }
87 
pmem_clear_bb(struct pmem_device * pmem,sector_t sector,long blks)88 static void pmem_clear_bb(struct pmem_device *pmem, sector_t sector, long blks)
89 {
90 	if (blks == 0)
91 		return;
92 	badblocks_clear(&pmem->bb, sector, blks);
93 	if (pmem->bb_state)
94 		sysfs_notify_dirent(pmem->bb_state);
95 }
96 
__pmem_clear_poison(struct pmem_device * pmem,phys_addr_t offset,unsigned int len)97 static long __pmem_clear_poison(struct pmem_device *pmem,
98 		phys_addr_t offset, unsigned int len)
99 {
100 	phys_addr_t phys = pmem_to_phys(pmem, offset);
101 	long cleared = nvdimm_clear_poison(to_dev(pmem), phys, len);
102 
103 	if (cleared > 0) {
104 		pmem_mkpage_present(pmem, offset, cleared);
105 		arch_invalidate_pmem(pmem->virt_addr + offset, len);
106 	}
107 	return cleared;
108 }
109 
pmem_clear_poison(struct pmem_device * pmem,phys_addr_t offset,unsigned int len)110 static blk_status_t pmem_clear_poison(struct pmem_device *pmem,
111 		phys_addr_t offset, unsigned int len)
112 {
113 	long cleared = __pmem_clear_poison(pmem, offset, len);
114 
115 	if (cleared < 0)
116 		return BLK_STS_IOERR;
117 
118 	pmem_clear_bb(pmem, to_sect(pmem, offset), cleared >> SECTOR_SHIFT);
119 	if (cleared < len)
120 		return BLK_STS_IOERR;
121 	return BLK_STS_OK;
122 }
123 
write_pmem(void * pmem_addr,struct page * page,unsigned int off,unsigned int len)124 static void write_pmem(void *pmem_addr, struct page *page,
125 		unsigned int off, unsigned int len)
126 {
127 	unsigned int chunk;
128 	void *mem;
129 
130 	while (len) {
131 		mem = kmap_local_page(page);
132 		chunk = min_t(unsigned int, len, PAGE_SIZE - off);
133 		memcpy_flushcache(pmem_addr, mem + off, chunk);
134 		kunmap_local(mem);
135 		len -= chunk;
136 		off = 0;
137 		page++;
138 		pmem_addr += chunk;
139 	}
140 }
141 
read_pmem(struct page * page,unsigned int off,void * pmem_addr,unsigned int len)142 static blk_status_t read_pmem(struct page *page, unsigned int off,
143 		void *pmem_addr, unsigned int len)
144 {
145 	unsigned int chunk;
146 	unsigned long rem;
147 	void *mem;
148 
149 	while (len) {
150 		mem = kmap_local_page(page);
151 		chunk = min_t(unsigned int, len, PAGE_SIZE - off);
152 		rem = copy_mc_to_kernel(mem + off, pmem_addr, chunk);
153 		kunmap_local(mem);
154 		if (rem)
155 			return BLK_STS_IOERR;
156 		len -= chunk;
157 		off = 0;
158 		page++;
159 		pmem_addr += chunk;
160 	}
161 	return BLK_STS_OK;
162 }
163 
pmem_do_read(struct pmem_device * pmem,struct page * page,unsigned int page_off,sector_t sector,unsigned int len)164 static blk_status_t pmem_do_read(struct pmem_device *pmem,
165 			struct page *page, unsigned int page_off,
166 			sector_t sector, unsigned int len)
167 {
168 	blk_status_t rc;
169 	phys_addr_t pmem_off = to_offset(pmem, sector);
170 	void *pmem_addr = pmem->virt_addr + pmem_off;
171 
172 	if (unlikely(is_bad_pmem(&pmem->bb, sector, len)))
173 		return BLK_STS_IOERR;
174 
175 	rc = read_pmem(page, page_off, pmem_addr, len);
176 	flush_dcache_page(page);
177 	return rc;
178 }
179 
pmem_do_write(struct pmem_device * pmem,struct page * page,unsigned int page_off,sector_t sector,unsigned int len)180 static blk_status_t pmem_do_write(struct pmem_device *pmem,
181 			struct page *page, unsigned int page_off,
182 			sector_t sector, unsigned int len)
183 {
184 	phys_addr_t pmem_off = to_offset(pmem, sector);
185 	void *pmem_addr = pmem->virt_addr + pmem_off;
186 
187 	if (unlikely(is_bad_pmem(&pmem->bb, sector, len))) {
188 		blk_status_t rc = pmem_clear_poison(pmem, pmem_off, len);
189 
190 		if (rc != BLK_STS_OK)
191 			return rc;
192 	}
193 
194 	flush_dcache_page(page);
195 	write_pmem(pmem_addr, page, page_off, len);
196 
197 	return BLK_STS_OK;
198 }
199 
pmem_submit_bio(struct bio * bio)200 static void pmem_submit_bio(struct bio *bio)
201 {
202 	int ret = 0;
203 	blk_status_t rc = 0;
204 	bool do_acct;
205 	unsigned long start;
206 	struct bio_vec bvec;
207 	struct bvec_iter iter;
208 	struct pmem_device *pmem = bio->bi_bdev->bd_disk->private_data;
209 	struct nd_region *nd_region = to_region(pmem);
210 
211 	if (bio->bi_opf & REQ_PREFLUSH) {
212 		ret = nvdimm_flush(nd_region, NULL);
213 		if (ret) {
214 			bio->bi_status = errno_to_blk_status(ret);
215 			bio_endio(bio);
216 			return;
217 		}
218 	}
219 
220 	if (bio_has_data(bio)) {
221 		do_acct = blk_queue_io_stat(bio->bi_bdev->bd_disk->queue);
222 		if (do_acct)
223 			start = bio_start_io_acct(bio);
224 		bio_for_each_segment(bvec, bio, iter) {
225 			if (op_is_write(bio_op(bio)))
226 				rc = pmem_do_write(pmem, bvec.bv_page,
227 						   bvec.bv_offset,
228 						   iter.bi_sector,
229 						   bvec.bv_len);
230 			else
231 				rc = pmem_do_read(pmem, bvec.bv_page,
232 						  bvec.bv_offset,
233 						  iter.bi_sector,
234 						  bvec.bv_len);
235 			if (rc) {
236 				bio->bi_status = rc;
237 				break;
238 			}
239 		}
240 		if (do_acct)
241 			bio_end_io_acct(bio, start);
242 	}
243 
244 	if ((bio->bi_opf & REQ_FUA) && !bio->bi_status) {
245 		ret = nvdimm_flush(nd_region, bio);
246 		if (ret == NVDIMM_FLUSH_ASYNC)
247 			return;
248 	}
249 
250 	if (ret)
251 		bio->bi_status = errno_to_blk_status(ret);
252 
253 	bio_endio(bio);
254 }
255 
256 /* see "strong" declaration in tools/testing/nvdimm/pmem-dax.c */
__pmem_direct_access(struct pmem_device * pmem,pgoff_t pgoff,long nr_pages,enum dax_access_mode mode,void ** kaddr,unsigned long * pfn)257 __weak long __pmem_direct_access(struct pmem_device *pmem, pgoff_t pgoff,
258 		long nr_pages, enum dax_access_mode mode, void **kaddr,
259 		unsigned long *pfn)
260 {
261 	resource_size_t offset = PFN_PHYS(pgoff) + pmem->data_offset;
262 	sector_t sector = PFN_PHYS(pgoff) >> SECTOR_SHIFT;
263 	unsigned int num = PFN_PHYS(nr_pages) >> SECTOR_SHIFT;
264 	struct badblocks *bb = &pmem->bb;
265 	sector_t first_bad;
266 	sector_t num_bad;
267 
268 	if (kaddr)
269 		*kaddr = pmem->virt_addr + offset;
270 	if (pfn)
271 		*pfn = PHYS_PFN(pmem->phys_addr + offset);
272 
273 	if (bb->count &&
274 	    badblocks_check(bb, sector, num, &first_bad, &num_bad)) {
275 		long actual_nr;
276 
277 		if (mode != DAX_RECOVERY_WRITE)
278 			return -EHWPOISON;
279 
280 		/*
281 		 * Set the recovery stride is set to kernel page size because
282 		 * the underlying driver and firmware clear poison functions
283 		 * don't appear to handle large chunk(such as 2MiB) reliably.
284 		 */
285 		actual_nr = PHYS_PFN(
286 			PAGE_ALIGN((first_bad - sector) << SECTOR_SHIFT));
287 		dev_dbg(pmem->bb.dev, "start sector(%llu), nr_pages(%ld), first_bad(%llu), actual_nr(%ld)\n",
288 				sector, nr_pages, first_bad, actual_nr);
289 		if (actual_nr)
290 			return actual_nr;
291 		return 1;
292 	}
293 
294 	/*
295 	 * If badblocks are present but not in the range, limit known good range
296 	 * to the requested range.
297 	 */
298 	if (bb->count)
299 		return nr_pages;
300 	return PHYS_PFN(pmem->size - pmem->pfn_pad - offset);
301 }
302 
303 static const struct block_device_operations pmem_fops = {
304 	.owner =		THIS_MODULE,
305 	.submit_bio =		pmem_submit_bio,
306 };
307 
pmem_dax_zero_page_range(struct dax_device * dax_dev,pgoff_t pgoff,size_t nr_pages)308 static int pmem_dax_zero_page_range(struct dax_device *dax_dev, pgoff_t pgoff,
309 				    size_t nr_pages)
310 {
311 	struct pmem_device *pmem = dax_get_private(dax_dev);
312 
313 	return blk_status_to_errno(pmem_do_write(pmem, ZERO_PAGE(0), 0,
314 				   PFN_PHYS(pgoff) >> SECTOR_SHIFT,
315 				   PAGE_SIZE));
316 }
317 
pmem_dax_direct_access(struct dax_device * dax_dev,pgoff_t pgoff,long nr_pages,enum dax_access_mode mode,void ** kaddr,unsigned long * pfn)318 static long pmem_dax_direct_access(struct dax_device *dax_dev,
319 		pgoff_t pgoff, long nr_pages, enum dax_access_mode mode,
320 		void **kaddr, unsigned long *pfn)
321 {
322 	struct pmem_device *pmem = dax_get_private(dax_dev);
323 
324 	return __pmem_direct_access(pmem, pgoff, nr_pages, mode, kaddr, pfn);
325 }
326 
327 /*
328  * The recovery write thread started out as a normal pwrite thread and
329  * when the filesystem was told about potential media error in the
330  * range, filesystem turns the normal pwrite to a dax_recovery_write.
331  *
332  * The recovery write consists of clearing media poison, clearing page
333  * HWPoison bit, re-enable page-wide read-write permission, flush the
334  * caches and finally write.  A competing pread thread will be held
335  * off during the recovery process since data read back might not be
336  * valid, and this is achieved by clearing the badblock records after
337  * the recovery write is complete. Competing recovery write threads
338  * are already serialized by writer lock held by dax_iomap_rw().
339  */
pmem_recovery_write(struct dax_device * dax_dev,pgoff_t pgoff,void * addr,size_t bytes,struct iov_iter * i)340 static size_t pmem_recovery_write(struct dax_device *dax_dev, pgoff_t pgoff,
341 		void *addr, size_t bytes, struct iov_iter *i)
342 {
343 	struct pmem_device *pmem = dax_get_private(dax_dev);
344 	size_t olen, len, off;
345 	phys_addr_t pmem_off;
346 	struct device *dev = pmem->bb.dev;
347 	long cleared;
348 
349 	off = offset_in_page(addr);
350 	len = PFN_PHYS(PFN_UP(off + bytes));
351 	if (!is_bad_pmem(&pmem->bb, PFN_PHYS(pgoff) >> SECTOR_SHIFT, len))
352 		return _copy_from_iter_flushcache(addr, bytes, i);
353 
354 	/*
355 	 * Not page-aligned range cannot be recovered. This should not
356 	 * happen unless something else went wrong.
357 	 */
358 	if (off || !PAGE_ALIGNED(bytes)) {
359 		dev_dbg(dev, "Found poison, but addr(%p) or bytes(%#zx) not page aligned\n",
360 			addr, bytes);
361 		return 0;
362 	}
363 
364 	pmem_off = PFN_PHYS(pgoff) + pmem->data_offset;
365 	cleared = __pmem_clear_poison(pmem, pmem_off, len);
366 	if (cleared > 0 && cleared < len) {
367 		dev_dbg(dev, "poison cleared only %ld out of %zu bytes\n",
368 			cleared, len);
369 		return 0;
370 	}
371 	if (cleared < 0) {
372 		dev_dbg(dev, "poison clear failed: %ld\n", cleared);
373 		return 0;
374 	}
375 
376 	olen = _copy_from_iter_flushcache(addr, bytes, i);
377 	pmem_clear_bb(pmem, to_sect(pmem, pmem_off), cleared >> SECTOR_SHIFT);
378 
379 	return olen;
380 }
381 
382 static const struct dax_operations pmem_dax_ops = {
383 	.direct_access = pmem_dax_direct_access,
384 	.zero_page_range = pmem_dax_zero_page_range,
385 	.recovery_write = pmem_recovery_write,
386 };
387 
write_cache_show(struct device * dev,struct device_attribute * attr,char * buf)388 static ssize_t write_cache_show(struct device *dev,
389 		struct device_attribute *attr, char *buf)
390 {
391 	struct pmem_device *pmem = dev_to_disk(dev)->private_data;
392 
393 	return sprintf(buf, "%d\n", !!dax_write_cache_enabled(pmem->dax_dev));
394 }
395 
write_cache_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)396 static ssize_t write_cache_store(struct device *dev,
397 		struct device_attribute *attr, const char *buf, size_t len)
398 {
399 	struct pmem_device *pmem = dev_to_disk(dev)->private_data;
400 	bool write_cache;
401 	int rc;
402 
403 	rc = kstrtobool(buf, &write_cache);
404 	if (rc)
405 		return rc;
406 	dax_write_cache(pmem->dax_dev, write_cache);
407 	return len;
408 }
409 static DEVICE_ATTR_RW(write_cache);
410 
dax_visible(struct kobject * kobj,struct attribute * a,int n)411 static umode_t dax_visible(struct kobject *kobj, struct attribute *a, int n)
412 {
413 #ifndef CONFIG_ARCH_HAS_PMEM_API
414 	if (a == &dev_attr_write_cache.attr)
415 		return 0;
416 #endif
417 	return a->mode;
418 }
419 
420 static struct attribute *dax_attributes[] = {
421 	&dev_attr_write_cache.attr,
422 	NULL,
423 };
424 
425 static const struct attribute_group dax_attribute_group = {
426 	.name		= "dax",
427 	.attrs		= dax_attributes,
428 	.is_visible	= dax_visible,
429 };
430 
431 static const struct attribute_group *pmem_attribute_groups[] = {
432 	&dax_attribute_group,
433 	NULL,
434 };
435 
pmem_release_disk(void * __pmem)436 static void pmem_release_disk(void *__pmem)
437 {
438 	struct pmem_device *pmem = __pmem;
439 
440 	dax_remove_host(pmem->disk);
441 	kill_dax(pmem->dax_dev);
442 	put_dax(pmem->dax_dev);
443 	del_gendisk(pmem->disk);
444 
445 	put_disk(pmem->disk);
446 }
447 
pmem_pagemap_memory_failure(struct dev_pagemap * pgmap,unsigned long pfn,unsigned long nr_pages,int mf_flags)448 static int pmem_pagemap_memory_failure(struct dev_pagemap *pgmap,
449 		unsigned long pfn, unsigned long nr_pages, int mf_flags)
450 {
451 	struct pmem_device *pmem =
452 			container_of(pgmap, struct pmem_device, pgmap);
453 	u64 offset = PFN_PHYS(pfn) - pmem->phys_addr - pmem->data_offset;
454 	u64 len = nr_pages << PAGE_SHIFT;
455 
456 	return dax_holder_notify_failure(pmem->dax_dev, offset, len, mf_flags);
457 }
458 
459 static const struct dev_pagemap_ops fsdax_pagemap_ops = {
460 	.memory_failure		= pmem_pagemap_memory_failure,
461 };
462 
pmem_attach_disk(struct device * dev,struct nd_namespace_common * ndns)463 static int pmem_attach_disk(struct device *dev,
464 		struct nd_namespace_common *ndns)
465 {
466 	struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
467 	struct nd_region *nd_region = to_nd_region(dev->parent);
468 	struct queue_limits lim = {
469 		.logical_block_size	= pmem_sector_size(ndns),
470 		.physical_block_size	= PAGE_SIZE,
471 		.max_hw_sectors		= UINT_MAX,
472 		.features		= BLK_FEAT_WRITE_CACHE |
473 					  BLK_FEAT_SYNCHRONOUS,
474 	};
475 	int nid = dev_to_node(dev), fua;
476 	struct resource *res = &nsio->res;
477 	struct range bb_range;
478 	struct nd_pfn *nd_pfn = NULL;
479 	struct dax_device *dax_dev;
480 	struct nd_pfn_sb *pfn_sb;
481 	struct pmem_device *pmem;
482 	struct gendisk *disk;
483 	void *addr;
484 	int rc;
485 
486 	pmem = devm_kzalloc(dev, sizeof(*pmem), GFP_KERNEL);
487 	if (!pmem)
488 		return -ENOMEM;
489 
490 	rc = devm_namespace_enable(dev, ndns, nd_info_block_reserve());
491 	if (rc)
492 		return rc;
493 
494 	/* while nsio_rw_bytes is active, parse a pfn info block if present */
495 	if (is_nd_pfn(dev)) {
496 		nd_pfn = to_nd_pfn(dev);
497 		rc = nvdimm_setup_pfn(nd_pfn, &pmem->pgmap);
498 		if (rc)
499 			return rc;
500 	}
501 
502 	/* we're attaching a block device, disable raw namespace access */
503 	devm_namespace_disable(dev, ndns);
504 
505 	dev_set_drvdata(dev, pmem);
506 	pmem->phys_addr = res->start;
507 	pmem->size = resource_size(res);
508 	fua = nvdimm_has_flush(nd_region);
509 	if (!IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) || fua < 0) {
510 		dev_warn(dev, "unable to guarantee persistence of writes\n");
511 		fua = 0;
512 	}
513 	if (fua)
514 		lim.features |= BLK_FEAT_FUA;
515 	if (is_nd_pfn(dev) || pmem_should_map_pages(dev))
516 		lim.features |= BLK_FEAT_DAX;
517 
518 	if (!devm_request_mem_region(dev, res->start, resource_size(res),
519 				dev_name(&ndns->dev))) {
520 		dev_warn(dev, "could not reserve region %pR\n", res);
521 		return -EBUSY;
522 	}
523 
524 	disk = blk_alloc_disk(&lim, nid);
525 	if (IS_ERR(disk))
526 		return PTR_ERR(disk);
527 
528 	pmem->disk = disk;
529 	pmem->pgmap.owner = pmem;
530 	if (is_nd_pfn(dev)) {
531 		pmem->pgmap.type = MEMORY_DEVICE_FS_DAX;
532 		pmem->pgmap.ops = &fsdax_pagemap_ops;
533 		addr = devm_memremap_pages(dev, &pmem->pgmap);
534 		pfn_sb = nd_pfn->pfn_sb;
535 		pmem->data_offset = le64_to_cpu(pfn_sb->dataoff);
536 		pmem->pfn_pad = resource_size(res) -
537 			range_len(&pmem->pgmap.range);
538 		bb_range = pmem->pgmap.range;
539 		bb_range.start += pmem->data_offset;
540 	} else if (pmem_should_map_pages(dev)) {
541 		pmem->pgmap.range.start = res->start;
542 		pmem->pgmap.range.end = res->end;
543 		pmem->pgmap.nr_range = 1;
544 		pmem->pgmap.type = MEMORY_DEVICE_FS_DAX;
545 		pmem->pgmap.ops = &fsdax_pagemap_ops;
546 		addr = devm_memremap_pages(dev, &pmem->pgmap);
547 		bb_range = pmem->pgmap.range;
548 	} else {
549 		addr = devm_memremap(dev, pmem->phys_addr,
550 				pmem->size, ARCH_MEMREMAP_PMEM);
551 		bb_range.start =  res->start;
552 		bb_range.end = res->end;
553 	}
554 
555 	if (IS_ERR(addr)) {
556 		rc = PTR_ERR(addr);
557 		goto out;
558 	}
559 	pmem->virt_addr = addr;
560 
561 	disk->fops		= &pmem_fops;
562 	disk->private_data	= pmem;
563 	nvdimm_namespace_disk_name(ndns, disk->disk_name);
564 	set_capacity(disk, (pmem->size - pmem->pfn_pad - pmem->data_offset)
565 			/ 512);
566 	if (devm_init_badblocks(dev, &pmem->bb))
567 		return -ENOMEM;
568 	nvdimm_badblocks_populate(nd_region, &pmem->bb, &bb_range);
569 	disk->bb = &pmem->bb;
570 
571 	dax_dev = alloc_dax(pmem, &pmem_dax_ops);
572 	if (IS_ERR(dax_dev)) {
573 		rc = PTR_ERR(dax_dev);
574 		if (rc != -EOPNOTSUPP)
575 			goto out;
576 	} else {
577 		set_dax_nocache(dax_dev);
578 		set_dax_nomc(dax_dev);
579 		if (is_nvdimm_sync(nd_region))
580 			set_dax_synchronous(dax_dev);
581 		pmem->dax_dev = dax_dev;
582 		rc = dax_add_host(dax_dev, disk);
583 		if (rc)
584 			goto out_cleanup_dax;
585 		dax_write_cache(dax_dev, nvdimm_has_cache(nd_region));
586 	}
587 	rc = device_add_disk(dev, disk, pmem_attribute_groups);
588 	if (rc)
589 		goto out_remove_host;
590 	if (devm_add_action_or_reset(dev, pmem_release_disk, pmem))
591 		return -ENOMEM;
592 
593 	nvdimm_check_and_set_ro(disk);
594 
595 	pmem->bb_state = sysfs_get_dirent(disk_to_dev(disk)->kobj.sd,
596 					  "badblocks");
597 	if (!pmem->bb_state)
598 		dev_warn(dev, "'badblocks' notification disabled\n");
599 	return 0;
600 
601 out_remove_host:
602 	dax_remove_host(pmem->disk);
603 out_cleanup_dax:
604 	kill_dax(pmem->dax_dev);
605 	put_dax(pmem->dax_dev);
606 out:
607 	put_disk(pmem->disk);
608 	return rc;
609 }
610 
nd_pmem_probe(struct device * dev)611 static int nd_pmem_probe(struct device *dev)
612 {
613 	int ret;
614 	struct nd_namespace_common *ndns;
615 
616 	ndns = nvdimm_namespace_common_probe(dev);
617 	if (IS_ERR(ndns))
618 		return PTR_ERR(ndns);
619 
620 	if (is_nd_btt(dev))
621 		return nvdimm_namespace_attach_btt(ndns);
622 
623 	if (is_nd_pfn(dev))
624 		return pmem_attach_disk(dev, ndns);
625 
626 	ret = devm_namespace_enable(dev, ndns, nd_info_block_reserve());
627 	if (ret)
628 		return ret;
629 
630 	ret = nd_btt_probe(dev, ndns);
631 	if (ret == 0)
632 		return -ENXIO;
633 
634 	/*
635 	 * We have two failure conditions here, there is no
636 	 * info reserver block or we found a valid info reserve block
637 	 * but failed to initialize the pfn superblock.
638 	 *
639 	 * For the first case consider namespace as a raw pmem namespace
640 	 * and attach a disk.
641 	 *
642 	 * For the latter, consider this a success and advance the namespace
643 	 * seed.
644 	 */
645 	ret = nd_pfn_probe(dev, ndns);
646 	if (ret == 0)
647 		return -ENXIO;
648 	else if (ret == -EOPNOTSUPP)
649 		return ret;
650 
651 	ret = nd_dax_probe(dev, ndns);
652 	if (ret == 0)
653 		return -ENXIO;
654 	else if (ret == -EOPNOTSUPP)
655 		return ret;
656 
657 	/* probe complete, attach handles namespace enabling */
658 	devm_namespace_disable(dev, ndns);
659 
660 	return pmem_attach_disk(dev, ndns);
661 }
662 
nd_pmem_remove(struct device * dev)663 static void nd_pmem_remove(struct device *dev)
664 {
665 	struct pmem_device *pmem = dev_get_drvdata(dev);
666 
667 	if (is_nd_btt(dev))
668 		nvdimm_namespace_detach_btt(to_nd_btt(dev));
669 	else {
670 		/*
671 		 * Note, this assumes device_lock() context to not
672 		 * race nd_pmem_notify()
673 		 */
674 		sysfs_put(pmem->bb_state);
675 		pmem->bb_state = NULL;
676 	}
677 	nvdimm_flush(to_nd_region(dev->parent), NULL);
678 }
679 
nd_pmem_shutdown(struct device * dev)680 static void nd_pmem_shutdown(struct device *dev)
681 {
682 	nvdimm_flush(to_nd_region(dev->parent), NULL);
683 }
684 
pmem_revalidate_poison(struct device * dev)685 static void pmem_revalidate_poison(struct device *dev)
686 {
687 	struct nd_region *nd_region;
688 	resource_size_t offset = 0, end_trunc = 0;
689 	struct nd_namespace_common *ndns;
690 	struct nd_namespace_io *nsio;
691 	struct badblocks *bb;
692 	struct range range;
693 	struct kernfs_node *bb_state;
694 
695 	if (is_nd_btt(dev)) {
696 		struct nd_btt *nd_btt = to_nd_btt(dev);
697 
698 		ndns = nd_btt->ndns;
699 		nd_region = to_nd_region(ndns->dev.parent);
700 		nsio = to_nd_namespace_io(&ndns->dev);
701 		bb = &nsio->bb;
702 		bb_state = NULL;
703 	} else {
704 		struct pmem_device *pmem = dev_get_drvdata(dev);
705 
706 		nd_region = to_region(pmem);
707 		bb = &pmem->bb;
708 		bb_state = pmem->bb_state;
709 
710 		if (is_nd_pfn(dev)) {
711 			struct nd_pfn *nd_pfn = to_nd_pfn(dev);
712 			struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
713 
714 			ndns = nd_pfn->ndns;
715 			offset = pmem->data_offset +
716 					__le32_to_cpu(pfn_sb->start_pad);
717 			end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
718 		} else {
719 			ndns = to_ndns(dev);
720 		}
721 
722 		nsio = to_nd_namespace_io(&ndns->dev);
723 	}
724 
725 	range.start = nsio->res.start + offset;
726 	range.end = nsio->res.end - end_trunc;
727 	nvdimm_badblocks_populate(nd_region, bb, &range);
728 	if (bb_state)
729 		sysfs_notify_dirent(bb_state);
730 }
731 
pmem_revalidate_region(struct device * dev)732 static void pmem_revalidate_region(struct device *dev)
733 {
734 	struct pmem_device *pmem;
735 
736 	if (is_nd_btt(dev)) {
737 		struct nd_btt *nd_btt = to_nd_btt(dev);
738 		struct btt *btt = nd_btt->btt;
739 
740 		nvdimm_check_and_set_ro(btt->btt_disk);
741 		return;
742 	}
743 
744 	pmem = dev_get_drvdata(dev);
745 	nvdimm_check_and_set_ro(pmem->disk);
746 }
747 
nd_pmem_notify(struct device * dev,enum nvdimm_event event)748 static void nd_pmem_notify(struct device *dev, enum nvdimm_event event)
749 {
750 	switch (event) {
751 	case NVDIMM_REVALIDATE_POISON:
752 		pmem_revalidate_poison(dev);
753 		break;
754 	case NVDIMM_REVALIDATE_REGION:
755 		pmem_revalidate_region(dev);
756 		break;
757 	default:
758 		dev_WARN_ONCE(dev, 1, "notify: unknown event: %d\n", event);
759 		break;
760 	}
761 }
762 
763 MODULE_ALIAS("pmem");
764 MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_IO);
765 MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_PMEM);
766 static struct nd_device_driver nd_pmem_driver = {
767 	.probe = nd_pmem_probe,
768 	.remove = nd_pmem_remove,
769 	.notify = nd_pmem_notify,
770 	.shutdown = nd_pmem_shutdown,
771 	.drv = {
772 		.name = "nd_pmem",
773 	},
774 	.type = ND_DRIVER_NAMESPACE_IO | ND_DRIVER_NAMESPACE_PMEM,
775 };
776 
777 module_nd_driver(nd_pmem_driver);
778 
779 MODULE_AUTHOR("Ross Zwisler <ross.zwisler@linux.intel.com>");
780 MODULE_DESCRIPTION("NVDIMM Persistent Memory Driver");
781 MODULE_LICENSE("GPL v2");
782