• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright(c) 2013-2016 Intel Corporation. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of version 2 of the GNU General Public License as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  */
13 #include <linux/memremap.h>
14 #include <linux/blkdev.h>
15 #include <linux/device.h>
16 #include <linux/genhd.h>
17 #include <linux/sizes.h>
18 #include <linux/slab.h>
19 #include <linux/fs.h>
20 #include <linux/mm.h>
21 #include "nd-core.h"
22 #include "pfn.h"
23 #include "nd.h"
24 
nd_pfn_release(struct device * dev)25 static void nd_pfn_release(struct device *dev)
26 {
27 	struct nd_region *nd_region = to_nd_region(dev->parent);
28 	struct nd_pfn *nd_pfn = to_nd_pfn(dev);
29 
30 	dev_dbg(dev, "%s\n", __func__);
31 	nd_detach_ndns(&nd_pfn->dev, &nd_pfn->ndns);
32 	ida_simple_remove(&nd_region->pfn_ida, nd_pfn->id);
33 	kfree(nd_pfn->uuid);
34 	kfree(nd_pfn);
35 }
36 
37 static struct device_type nd_pfn_device_type = {
38 	.name = "nd_pfn",
39 	.release = nd_pfn_release,
40 };
41 
is_nd_pfn(struct device * dev)42 bool is_nd_pfn(struct device *dev)
43 {
44 	return dev ? dev->type == &nd_pfn_device_type : false;
45 }
46 EXPORT_SYMBOL(is_nd_pfn);
47 
to_nd_pfn(struct device * dev)48 struct nd_pfn *to_nd_pfn(struct device *dev)
49 {
50 	struct nd_pfn *nd_pfn = container_of(dev, struct nd_pfn, dev);
51 
52 	WARN_ON(!is_nd_pfn(dev));
53 	return nd_pfn;
54 }
55 EXPORT_SYMBOL(to_nd_pfn);
56 
mode_show(struct device * dev,struct device_attribute * attr,char * buf)57 static ssize_t mode_show(struct device *dev,
58 		struct device_attribute *attr, char *buf)
59 {
60 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
61 
62 	switch (nd_pfn->mode) {
63 	case PFN_MODE_RAM:
64 		return sprintf(buf, "ram\n");
65 	case PFN_MODE_PMEM:
66 		return sprintf(buf, "pmem\n");
67 	default:
68 		return sprintf(buf, "none\n");
69 	}
70 }
71 
mode_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)72 static ssize_t mode_store(struct device *dev,
73 		struct device_attribute *attr, const char *buf, size_t len)
74 {
75 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
76 	ssize_t rc = 0;
77 
78 	device_lock(dev);
79 	nvdimm_bus_lock(dev);
80 	if (dev->driver)
81 		rc = -EBUSY;
82 	else {
83 		size_t n = len - 1;
84 
85 		if (strncmp(buf, "pmem\n", n) == 0
86 				|| strncmp(buf, "pmem", n) == 0) {
87 			nd_pfn->mode = PFN_MODE_PMEM;
88 		} else if (strncmp(buf, "ram\n", n) == 0
89 				|| strncmp(buf, "ram", n) == 0)
90 			nd_pfn->mode = PFN_MODE_RAM;
91 		else if (strncmp(buf, "none\n", n) == 0
92 				|| strncmp(buf, "none", n) == 0)
93 			nd_pfn->mode = PFN_MODE_NONE;
94 		else
95 			rc = -EINVAL;
96 	}
97 	dev_dbg(dev, "%s: result: %zd wrote: %s%s", __func__,
98 			rc, buf, buf[len - 1] == '\n' ? "" : "\n");
99 	nvdimm_bus_unlock(dev);
100 	device_unlock(dev);
101 
102 	return rc ? rc : len;
103 }
104 static DEVICE_ATTR_RW(mode);
105 
align_show(struct device * dev,struct device_attribute * attr,char * buf)106 static ssize_t align_show(struct device *dev,
107 		struct device_attribute *attr, char *buf)
108 {
109 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
110 
111 	return sprintf(buf, "%ld\n", nd_pfn->align);
112 }
113 
nd_pfn_supported_alignments(void)114 static const unsigned long *nd_pfn_supported_alignments(void)
115 {
116 	/*
117 	 * This needs to be a non-static variable because the *_SIZE
118 	 * macros aren't always constants.
119 	 */
120 	const unsigned long supported_alignments[] = {
121 		PAGE_SIZE,
122 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
123 		HPAGE_PMD_SIZE,
124 #ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
125 		HPAGE_PUD_SIZE,
126 #endif
127 #endif
128 		0,
129 	};
130 	static unsigned long data[ARRAY_SIZE(supported_alignments)];
131 
132 	memcpy(data, supported_alignments, sizeof(data));
133 
134 	return data;
135 }
136 
align_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)137 static ssize_t align_store(struct device *dev,
138 		struct device_attribute *attr, const char *buf, size_t len)
139 {
140 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
141 	ssize_t rc;
142 
143 	device_lock(dev);
144 	nvdimm_bus_lock(dev);
145 	rc = nd_size_select_store(dev, buf, &nd_pfn->align,
146 			nd_pfn_supported_alignments());
147 	dev_dbg(dev, "%s: result: %zd wrote: %s%s", __func__,
148 			rc, buf, buf[len - 1] == '\n' ? "" : "\n");
149 	nvdimm_bus_unlock(dev);
150 	device_unlock(dev);
151 
152 	return rc ? rc : len;
153 }
154 static DEVICE_ATTR_RW(align);
155 
uuid_show(struct device * dev,struct device_attribute * attr,char * buf)156 static ssize_t uuid_show(struct device *dev,
157 		struct device_attribute *attr, char *buf)
158 {
159 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
160 
161 	if (nd_pfn->uuid)
162 		return sprintf(buf, "%pUb\n", nd_pfn->uuid);
163 	return sprintf(buf, "\n");
164 }
165 
uuid_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)166 static ssize_t uuid_store(struct device *dev,
167 		struct device_attribute *attr, const char *buf, size_t len)
168 {
169 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
170 	ssize_t rc;
171 
172 	device_lock(dev);
173 	rc = nd_uuid_store(dev, &nd_pfn->uuid, buf, len);
174 	dev_dbg(dev, "%s: result: %zd wrote: %s%s", __func__,
175 			rc, buf, buf[len - 1] == '\n' ? "" : "\n");
176 	device_unlock(dev);
177 
178 	return rc ? rc : len;
179 }
180 static DEVICE_ATTR_RW(uuid);
181 
namespace_show(struct device * dev,struct device_attribute * attr,char * buf)182 static ssize_t namespace_show(struct device *dev,
183 		struct device_attribute *attr, char *buf)
184 {
185 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
186 	ssize_t rc;
187 
188 	nvdimm_bus_lock(dev);
189 	rc = sprintf(buf, "%s\n", nd_pfn->ndns
190 			? dev_name(&nd_pfn->ndns->dev) : "");
191 	nvdimm_bus_unlock(dev);
192 	return rc;
193 }
194 
namespace_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)195 static ssize_t namespace_store(struct device *dev,
196 		struct device_attribute *attr, const char *buf, size_t len)
197 {
198 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
199 	ssize_t rc;
200 
201 	device_lock(dev);
202 	nvdimm_bus_lock(dev);
203 	rc = nd_namespace_store(dev, &nd_pfn->ndns, buf, len);
204 	dev_dbg(dev, "%s: result: %zd wrote: %s%s", __func__,
205 			rc, buf, buf[len - 1] == '\n' ? "" : "\n");
206 	nvdimm_bus_unlock(dev);
207 	device_unlock(dev);
208 
209 	return rc;
210 }
211 static DEVICE_ATTR_RW(namespace);
212 
resource_show(struct device * dev,struct device_attribute * attr,char * buf)213 static ssize_t resource_show(struct device *dev,
214 		struct device_attribute *attr, char *buf)
215 {
216 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
217 	ssize_t rc;
218 
219 	device_lock(dev);
220 	if (dev->driver) {
221 		struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
222 		u64 offset = __le64_to_cpu(pfn_sb->dataoff);
223 		struct nd_namespace_common *ndns = nd_pfn->ndns;
224 		u32 start_pad = __le32_to_cpu(pfn_sb->start_pad);
225 		struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
226 
227 		rc = sprintf(buf, "%#llx\n", (unsigned long long) nsio->res.start
228 				+ start_pad + offset);
229 	} else {
230 		/* no address to convey if the pfn instance is disabled */
231 		rc = -ENXIO;
232 	}
233 	device_unlock(dev);
234 
235 	return rc;
236 }
237 static DEVICE_ATTR_RO(resource);
238 
size_show(struct device * dev,struct device_attribute * attr,char * buf)239 static ssize_t size_show(struct device *dev,
240 		struct device_attribute *attr, char *buf)
241 {
242 	struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
243 	ssize_t rc;
244 
245 	device_lock(dev);
246 	if (dev->driver) {
247 		struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
248 		u64 offset = __le64_to_cpu(pfn_sb->dataoff);
249 		struct nd_namespace_common *ndns = nd_pfn->ndns;
250 		u32 start_pad = __le32_to_cpu(pfn_sb->start_pad);
251 		u32 end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
252 		struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
253 
254 		rc = sprintf(buf, "%llu\n", (unsigned long long)
255 				resource_size(&nsio->res) - start_pad
256 				- end_trunc - offset);
257 	} else {
258 		/* no size to convey if the pfn instance is disabled */
259 		rc = -ENXIO;
260 	}
261 	device_unlock(dev);
262 
263 	return rc;
264 }
265 static DEVICE_ATTR_RO(size);
266 
supported_alignments_show(struct device * dev,struct device_attribute * attr,char * buf)267 static ssize_t supported_alignments_show(struct device *dev,
268 		struct device_attribute *attr, char *buf)
269 {
270 	return nd_size_select_show(0, nd_pfn_supported_alignments(), buf);
271 }
272 static DEVICE_ATTR_RO(supported_alignments);
273 
274 static struct attribute *nd_pfn_attributes[] = {
275 	&dev_attr_mode.attr,
276 	&dev_attr_namespace.attr,
277 	&dev_attr_uuid.attr,
278 	&dev_attr_align.attr,
279 	&dev_attr_resource.attr,
280 	&dev_attr_size.attr,
281 	&dev_attr_supported_alignments.attr,
282 	NULL,
283 };
284 
pfn_visible(struct kobject * kobj,struct attribute * a,int n)285 static umode_t pfn_visible(struct kobject *kobj, struct attribute *a, int n)
286 {
287 	if (a == &dev_attr_resource.attr)
288 		return 0400;
289 	return a->mode;
290 }
291 
292 struct attribute_group nd_pfn_attribute_group = {
293 	.attrs = nd_pfn_attributes,
294 	.is_visible = pfn_visible,
295 };
296 
297 static const struct attribute_group *nd_pfn_attribute_groups[] = {
298 	&nd_pfn_attribute_group,
299 	&nd_device_attribute_group,
300 	&nd_numa_attribute_group,
301 	NULL,
302 };
303 
nd_pfn_devinit(struct nd_pfn * nd_pfn,struct nd_namespace_common * ndns)304 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
305 		struct nd_namespace_common *ndns)
306 {
307 	struct device *dev = &nd_pfn->dev;
308 
309 	if (!nd_pfn)
310 		return NULL;
311 
312 	nd_pfn->mode = PFN_MODE_NONE;
313 	nd_pfn->align = PFN_DEFAULT_ALIGNMENT;
314 	dev = &nd_pfn->dev;
315 	device_initialize(&nd_pfn->dev);
316 	if (ndns && !__nd_attach_ndns(&nd_pfn->dev, ndns, &nd_pfn->ndns)) {
317 		dev_dbg(&ndns->dev, "%s failed, already claimed by %s\n",
318 				__func__, dev_name(ndns->claim));
319 		put_device(dev);
320 		return NULL;
321 	}
322 	return dev;
323 }
324 
nd_pfn_alloc(struct nd_region * nd_region)325 static struct nd_pfn *nd_pfn_alloc(struct nd_region *nd_region)
326 {
327 	struct nd_pfn *nd_pfn;
328 	struct device *dev;
329 
330 	nd_pfn = kzalloc(sizeof(*nd_pfn), GFP_KERNEL);
331 	if (!nd_pfn)
332 		return NULL;
333 
334 	nd_pfn->id = ida_simple_get(&nd_region->pfn_ida, 0, 0, GFP_KERNEL);
335 	if (nd_pfn->id < 0) {
336 		kfree(nd_pfn);
337 		return NULL;
338 	}
339 
340 	dev = &nd_pfn->dev;
341 	dev_set_name(dev, "pfn%d.%d", nd_region->id, nd_pfn->id);
342 	dev->groups = nd_pfn_attribute_groups;
343 	dev->type = &nd_pfn_device_type;
344 	dev->parent = &nd_region->dev;
345 
346 	return nd_pfn;
347 }
348 
nd_pfn_create(struct nd_region * nd_region)349 struct device *nd_pfn_create(struct nd_region *nd_region)
350 {
351 	struct nd_pfn *nd_pfn;
352 	struct device *dev;
353 
354 	if (!is_memory(&nd_region->dev))
355 		return NULL;
356 
357 	nd_pfn = nd_pfn_alloc(nd_region);
358 	dev = nd_pfn_devinit(nd_pfn, NULL);
359 
360 	__nd_device_register(dev);
361 	return dev;
362 }
363 
364 /**
365  * nd_pfn_validate - read and validate info-block
366  * @nd_pfn: fsdax namespace runtime state / properties
367  * @sig: 'devdax' or 'fsdax' signature
368  *
369  * Upon return the info-block buffer contents (->pfn_sb) are
370  * indeterminate when validation fails, and a coherent info-block
371  * otherwise.
372  */
nd_pfn_validate(struct nd_pfn * nd_pfn,const char * sig)373 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
374 {
375 	u64 checksum, offset;
376 	enum nd_pfn_mode mode;
377 	struct nd_namespace_io *nsio;
378 	unsigned long align, start_pad;
379 	struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
380 	struct nd_namespace_common *ndns = nd_pfn->ndns;
381 	const u8 *parent_uuid = nd_dev_to_uuid(&ndns->dev);
382 
383 	if (!pfn_sb || !ndns)
384 		return -ENODEV;
385 
386 	if (!is_memory(nd_pfn->dev.parent))
387 		return -ENODEV;
388 
389 	if (nvdimm_read_bytes(ndns, SZ_4K, pfn_sb, sizeof(*pfn_sb), 0))
390 		return -ENXIO;
391 
392 	if (memcmp(pfn_sb->signature, sig, PFN_SIG_LEN) != 0)
393 		return -ENODEV;
394 
395 	checksum = le64_to_cpu(pfn_sb->checksum);
396 	pfn_sb->checksum = 0;
397 	if (checksum != nd_sb_checksum((struct nd_gen_sb *) pfn_sb))
398 		return -ENODEV;
399 	pfn_sb->checksum = cpu_to_le64(checksum);
400 
401 	if (memcmp(pfn_sb->parent_uuid, parent_uuid, 16) != 0)
402 		return -ENODEV;
403 
404 	if (__le16_to_cpu(pfn_sb->version_minor) < 1) {
405 		pfn_sb->start_pad = 0;
406 		pfn_sb->end_trunc = 0;
407 	}
408 
409 	if (__le16_to_cpu(pfn_sb->version_minor) < 2)
410 		pfn_sb->align = 0;
411 
412 	switch (le32_to_cpu(pfn_sb->mode)) {
413 	case PFN_MODE_RAM:
414 	case PFN_MODE_PMEM:
415 		break;
416 	default:
417 		return -ENXIO;
418 	}
419 
420 	align = le32_to_cpu(pfn_sb->align);
421 	offset = le64_to_cpu(pfn_sb->dataoff);
422 	start_pad = le32_to_cpu(pfn_sb->start_pad);
423 	if (align == 0)
424 		align = 1UL << ilog2(offset);
425 	mode = le32_to_cpu(pfn_sb->mode);
426 
427 	if (!nd_pfn->uuid) {
428 		/*
429 		 * When probing a namepace via nd_pfn_probe() the uuid
430 		 * is NULL (see: nd_pfn_devinit()) we init settings from
431 		 * pfn_sb
432 		 */
433 		nd_pfn->uuid = kmemdup(pfn_sb->uuid, 16, GFP_KERNEL);
434 		if (!nd_pfn->uuid)
435 			return -ENOMEM;
436 		nd_pfn->align = align;
437 		nd_pfn->mode = mode;
438 	} else {
439 		/*
440 		 * When probing a pfn / dax instance we validate the
441 		 * live settings against the pfn_sb
442 		 */
443 		if (memcmp(nd_pfn->uuid, pfn_sb->uuid, 16) != 0)
444 			return -ENODEV;
445 
446 		/*
447 		 * If the uuid validates, but other settings mismatch
448 		 * return EINVAL because userspace has managed to change
449 		 * the configuration without specifying new
450 		 * identification.
451 		 */
452 		if (nd_pfn->align != align || nd_pfn->mode != mode) {
453 			dev_err(&nd_pfn->dev,
454 					"init failed, settings mismatch\n");
455 			dev_dbg(&nd_pfn->dev, "align: %lx:%lx mode: %d:%d\n",
456 					nd_pfn->align, align, nd_pfn->mode,
457 					mode);
458 			return -EINVAL;
459 		}
460 	}
461 
462 	if (align > nvdimm_namespace_capacity(ndns)) {
463 		dev_err(&nd_pfn->dev, "alignment: %lx exceeds capacity %llx\n",
464 				align, nvdimm_namespace_capacity(ndns));
465 		return -EINVAL;
466 	}
467 
468 	/*
469 	 * These warnings are verbose because they can only trigger in
470 	 * the case where the physical address alignment of the
471 	 * namespace has changed since the pfn superblock was
472 	 * established.
473 	 */
474 	nsio = to_nd_namespace_io(&ndns->dev);
475 	if (offset >= resource_size(&nsio->res)) {
476 		dev_err(&nd_pfn->dev, "pfn array size exceeds capacity of %s\n",
477 				dev_name(&ndns->dev));
478 		return -EBUSY;
479 	}
480 
481 	if ((align && !IS_ALIGNED(nsio->res.start + offset + start_pad, align))
482 			|| !IS_ALIGNED(offset, PAGE_SIZE)) {
483 		dev_err(&nd_pfn->dev,
484 				"bad offset: %#llx dax disabled align: %#lx\n",
485 				offset, align);
486 		return -ENXIO;
487 	}
488 
489 	return 0;
490 }
491 EXPORT_SYMBOL(nd_pfn_validate);
492 
nd_pfn_probe(struct device * dev,struct nd_namespace_common * ndns)493 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns)
494 {
495 	int rc;
496 	struct nd_pfn *nd_pfn;
497 	struct device *pfn_dev;
498 	struct nd_pfn_sb *pfn_sb;
499 	struct nd_region *nd_region = to_nd_region(ndns->dev.parent);
500 
501 	if (ndns->force_raw)
502 		return -ENODEV;
503 
504 	switch (ndns->claim_class) {
505 	case NVDIMM_CCLASS_NONE:
506 	case NVDIMM_CCLASS_PFN:
507 		break;
508 	default:
509 		return -ENODEV;
510 	}
511 
512 	nvdimm_bus_lock(&ndns->dev);
513 	nd_pfn = nd_pfn_alloc(nd_region);
514 	pfn_dev = nd_pfn_devinit(nd_pfn, ndns);
515 	nvdimm_bus_unlock(&ndns->dev);
516 	if (!pfn_dev)
517 		return -ENOMEM;
518 	pfn_sb = devm_kmalloc(dev, sizeof(*pfn_sb), GFP_KERNEL);
519 	nd_pfn = to_nd_pfn(pfn_dev);
520 	nd_pfn->pfn_sb = pfn_sb;
521 	rc = nd_pfn_validate(nd_pfn, PFN_SIG);
522 	dev_dbg(dev, "%s: pfn: %s\n", __func__,
523 			rc == 0 ? dev_name(pfn_dev) : "<none>");
524 	if (rc < 0) {
525 		nd_detach_ndns(pfn_dev, &nd_pfn->ndns);
526 		put_device(pfn_dev);
527 	} else
528 		__nd_device_register(pfn_dev);
529 
530 	return rc;
531 }
532 EXPORT_SYMBOL(nd_pfn_probe);
533 
534 /*
535  * We hotplug memory at section granularity, pad the reserved area from
536  * the previous section base to the namespace base address.
537  */
init_altmap_base(resource_size_t base)538 static unsigned long init_altmap_base(resource_size_t base)
539 {
540 	unsigned long base_pfn = PHYS_PFN(base);
541 
542 	return PFN_SECTION_ALIGN_DOWN(base_pfn);
543 }
544 
init_altmap_reserve(resource_size_t base)545 static unsigned long init_altmap_reserve(resource_size_t base)
546 {
547 	unsigned long reserve = PFN_UP(SZ_8K);
548 	unsigned long base_pfn = PHYS_PFN(base);
549 
550 	reserve += base_pfn - PFN_SECTION_ALIGN_DOWN(base_pfn);
551 	return reserve;
552 }
553 
__nvdimm_setup_pfn(struct nd_pfn * nd_pfn,struct resource * res,struct vmem_altmap * altmap)554 static struct vmem_altmap *__nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
555 		struct resource *res, struct vmem_altmap *altmap)
556 {
557 	struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
558 	u64 offset = le64_to_cpu(pfn_sb->dataoff);
559 	u32 start_pad = __le32_to_cpu(pfn_sb->start_pad);
560 	u32 end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
561 	struct nd_namespace_common *ndns = nd_pfn->ndns;
562 	struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
563 	resource_size_t base = nsio->res.start + start_pad;
564 	struct vmem_altmap __altmap = {
565 		.base_pfn = init_altmap_base(base),
566 		.reserve = init_altmap_reserve(base),
567 	};
568 
569 	memcpy(res, &nsio->res, sizeof(*res));
570 	res->start += start_pad;
571 	res->end -= end_trunc;
572 
573 	if (nd_pfn->mode == PFN_MODE_RAM) {
574 		if (offset < SZ_8K)
575 			return ERR_PTR(-EINVAL);
576 		nd_pfn->npfns = le64_to_cpu(pfn_sb->npfns);
577 		altmap = NULL;
578 	} else if (nd_pfn->mode == PFN_MODE_PMEM) {
579 		nd_pfn->npfns = PFN_SECTION_ALIGN_UP((resource_size(res)
580 					- offset) / PAGE_SIZE);
581 		if (le64_to_cpu(nd_pfn->pfn_sb->npfns) > nd_pfn->npfns)
582 			dev_info(&nd_pfn->dev,
583 					"number of pfns truncated from %lld to %ld\n",
584 					le64_to_cpu(nd_pfn->pfn_sb->npfns),
585 					nd_pfn->npfns);
586 		memcpy(altmap, &__altmap, sizeof(*altmap));
587 		altmap->free = PHYS_PFN(offset - SZ_8K);
588 		altmap->alloc = 0;
589 	} else
590 		return ERR_PTR(-ENXIO);
591 
592 	return altmap;
593 }
594 
phys_pmem_align_down(struct nd_pfn * nd_pfn,u64 phys)595 static u64 phys_pmem_align_down(struct nd_pfn *nd_pfn, u64 phys)
596 {
597 	return min_t(u64, PHYS_SECTION_ALIGN_DOWN(phys),
598 			ALIGN_DOWN(phys, nd_pfn->align));
599 }
600 
601 /*
602  * Check if pmem collides with 'System RAM', or other regions when
603  * section aligned.  Trim it accordingly.
604  */
trim_pfn_device(struct nd_pfn * nd_pfn,u32 * start_pad,u32 * end_trunc)605 static void trim_pfn_device(struct nd_pfn *nd_pfn, u32 *start_pad, u32 *end_trunc)
606 {
607 	struct nd_namespace_common *ndns = nd_pfn->ndns;
608 	struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
609 	struct nd_region *nd_region = to_nd_region(nd_pfn->dev.parent);
610 	const resource_size_t start = nsio->res.start;
611 	const resource_size_t end = start + resource_size(&nsio->res);
612 	resource_size_t adjust, size;
613 
614 	*start_pad = 0;
615 	*end_trunc = 0;
616 
617 	adjust = start - PHYS_SECTION_ALIGN_DOWN(start);
618 	size = resource_size(&nsio->res) + adjust;
619 	if (region_intersects(start - adjust, size, IORESOURCE_SYSTEM_RAM,
620 				IORES_DESC_NONE) == REGION_MIXED
621 			|| nd_region_conflict(nd_region, start - adjust, size))
622 		*start_pad = PHYS_SECTION_ALIGN_UP(start) - start;
623 
624 	/* Now check that end of the range does not collide. */
625 	adjust = PHYS_SECTION_ALIGN_UP(end) - end;
626 	size = resource_size(&nsio->res) + adjust;
627 	if (region_intersects(start, size, IORESOURCE_SYSTEM_RAM,
628 				IORES_DESC_NONE) == REGION_MIXED
629 			|| !IS_ALIGNED(end, nd_pfn->align)
630 			|| nd_region_conflict(nd_region, start, size))
631 		*end_trunc = end - phys_pmem_align_down(nd_pfn, end);
632 }
633 
nd_pfn_init(struct nd_pfn * nd_pfn)634 static int nd_pfn_init(struct nd_pfn *nd_pfn)
635 {
636 	u32 dax_label_reserve = is_nd_dax(&nd_pfn->dev) ? SZ_128K : 0;
637 	struct nd_namespace_common *ndns = nd_pfn->ndns;
638 	struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
639 	resource_size_t start, size;
640 	struct nd_region *nd_region;
641 	u32 start_pad, end_trunc;
642 	struct nd_pfn_sb *pfn_sb;
643 	unsigned long npfns;
644 	phys_addr_t offset;
645 	const char *sig;
646 	u64 checksum;
647 	int rc;
648 
649 	pfn_sb = devm_kmalloc(&nd_pfn->dev, sizeof(*pfn_sb), GFP_KERNEL);
650 	if (!pfn_sb)
651 		return -ENOMEM;
652 
653 	nd_pfn->pfn_sb = pfn_sb;
654 	if (is_nd_dax(&nd_pfn->dev))
655 		sig = DAX_SIG;
656 	else
657 		sig = PFN_SIG;
658 
659 	rc = nd_pfn_validate(nd_pfn, sig);
660 	if (rc != -ENODEV)
661 		return rc;
662 
663 	/* no info block, do init */;
664 	memset(pfn_sb, 0, sizeof(*pfn_sb));
665 
666 	nd_region = to_nd_region(nd_pfn->dev.parent);
667 	if (nd_region->ro) {
668 		dev_info(&nd_pfn->dev,
669 				"%s is read-only, unable to init metadata\n",
670 				dev_name(&nd_region->dev));
671 		return -ENXIO;
672 	}
673 
674 	memset(pfn_sb, 0, sizeof(*pfn_sb));
675 
676 	trim_pfn_device(nd_pfn, &start_pad, &end_trunc);
677 	if (start_pad + end_trunc)
678 		dev_info(&nd_pfn->dev, "%s alignment collision, truncate %d bytes\n",
679 				dev_name(&ndns->dev), start_pad + end_trunc);
680 
681 	/*
682 	 * Note, we use 64 here for the standard size of struct page,
683 	 * debugging options may cause it to be larger in which case the
684 	 * implementation will limit the pfns advertised through
685 	 * ->direct_access() to those that are included in the memmap.
686 	 */
687 	start = nsio->res.start + start_pad;
688 	size = resource_size(&nsio->res);
689 	npfns = PFN_SECTION_ALIGN_UP((size - start_pad - end_trunc - SZ_8K)
690 			/ PAGE_SIZE);
691 	if (nd_pfn->mode == PFN_MODE_PMEM) {
692 		/*
693 		 * The altmap should be padded out to the block size used
694 		 * when populating the vmemmap. This *should* be equal to
695 		 * PMD_SIZE for most architectures.
696 		 */
697 		offset = ALIGN(start + SZ_8K + 64 * npfns + dax_label_reserve,
698 				max(nd_pfn->align, PMD_SIZE)) - start;
699 	} else if (nd_pfn->mode == PFN_MODE_RAM)
700 		offset = ALIGN(start + SZ_8K + dax_label_reserve,
701 				nd_pfn->align) - start;
702 	else
703 		return -ENXIO;
704 
705 	if (offset + start_pad + end_trunc >= size) {
706 		dev_err(&nd_pfn->dev, "%s unable to satisfy requested alignment\n",
707 				dev_name(&ndns->dev));
708 		return -ENXIO;
709 	}
710 
711 	npfns = (size - offset - start_pad - end_trunc) / SZ_4K;
712 	pfn_sb->mode = cpu_to_le32(nd_pfn->mode);
713 	pfn_sb->dataoff = cpu_to_le64(offset);
714 	pfn_sb->npfns = cpu_to_le64(npfns);
715 	memcpy(pfn_sb->signature, sig, PFN_SIG_LEN);
716 	memcpy(pfn_sb->uuid, nd_pfn->uuid, 16);
717 	memcpy(pfn_sb->parent_uuid, nd_dev_to_uuid(&ndns->dev), 16);
718 	pfn_sb->version_major = cpu_to_le16(1);
719 	pfn_sb->version_minor = cpu_to_le16(3);
720 	pfn_sb->start_pad = cpu_to_le32(start_pad);
721 	pfn_sb->end_trunc = cpu_to_le32(end_trunc);
722 	pfn_sb->align = cpu_to_le32(nd_pfn->align);
723 	checksum = nd_sb_checksum((struct nd_gen_sb *) pfn_sb);
724 	pfn_sb->checksum = cpu_to_le64(checksum);
725 
726 	return nvdimm_write_bytes(ndns, SZ_4K, pfn_sb, sizeof(*pfn_sb), 0);
727 }
728 
729 /*
730  * Determine the effective resource range and vmem_altmap from an nd_pfn
731  * instance.
732  */
nvdimm_setup_pfn(struct nd_pfn * nd_pfn,struct resource * res,struct vmem_altmap * altmap)733 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
734 		struct resource *res, struct vmem_altmap *altmap)
735 {
736 	int rc;
737 
738 	if (!nd_pfn->uuid || !nd_pfn->ndns)
739 		return ERR_PTR(-ENODEV);
740 
741 	rc = nd_pfn_init(nd_pfn);
742 	if (rc)
743 		return ERR_PTR(rc);
744 
745 	/* we need a valid pfn_sb before we can init a vmem_altmap */
746 	return __nvdimm_setup_pfn(nd_pfn, res, altmap);
747 }
748 EXPORT_SYMBOL_GPL(nvdimm_setup_pfn);
749