Loading...
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright(c) 2017-2018 Intel Corporation. All rights reserved. */
3#include <linux/memremap.h>
4#include <linux/device.h>
5#include <linux/mutex.h>
6#include <linux/list.h>
7#include <linux/slab.h>
8#include <linux/dax.h>
9#include <linux/io.h>
10#include "dax-private.h"
11#include "bus.h"
12
13static DEFINE_MUTEX(dax_bus_lock);
14
15#define DAX_NAME_LEN 30
16struct dax_id {
17 struct list_head list;
18 char dev_name[DAX_NAME_LEN];
19};
20
21static int dax_bus_uevent(const struct device *dev, struct kobj_uevent_env *env)
22{
23 /*
24 * We only ever expect to handle device-dax instances, i.e. the
25 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
26 */
27 return add_uevent_var(env, "MODALIAS=" DAX_DEVICE_MODALIAS_FMT, 0);
28}
29
30static struct dax_device_driver *to_dax_drv(struct device_driver *drv)
31{
32 return container_of(drv, struct dax_device_driver, drv);
33}
34
35static struct dax_id *__dax_match_id(struct dax_device_driver *dax_drv,
36 const char *dev_name)
37{
38 struct dax_id *dax_id;
39
40 lockdep_assert_held(&dax_bus_lock);
41
42 list_for_each_entry(dax_id, &dax_drv->ids, list)
43 if (sysfs_streq(dax_id->dev_name, dev_name))
44 return dax_id;
45 return NULL;
46}
47
48static int dax_match_id(struct dax_device_driver *dax_drv, struct device *dev)
49{
50 int match;
51
52 mutex_lock(&dax_bus_lock);
53 match = !!__dax_match_id(dax_drv, dev_name(dev));
54 mutex_unlock(&dax_bus_lock);
55
56 return match;
57}
58
59static int dax_match_type(struct dax_device_driver *dax_drv, struct device *dev)
60{
61 enum dax_driver_type type = DAXDRV_DEVICE_TYPE;
62 struct dev_dax *dev_dax = to_dev_dax(dev);
63
64 if (dev_dax->region->res.flags & IORESOURCE_DAX_KMEM)
65 type = DAXDRV_KMEM_TYPE;
66
67 if (dax_drv->type == type)
68 return 1;
69
70 /* default to device mode if dax_kmem is disabled */
71 if (dax_drv->type == DAXDRV_DEVICE_TYPE &&
72 !IS_ENABLED(CONFIG_DEV_DAX_KMEM))
73 return 1;
74
75 return 0;
76}
77
78enum id_action {
79 ID_REMOVE,
80 ID_ADD,
81};
82
83static ssize_t do_id_store(struct device_driver *drv, const char *buf,
84 size_t count, enum id_action action)
85{
86 struct dax_device_driver *dax_drv = to_dax_drv(drv);
87 unsigned int region_id, id;
88 char devname[DAX_NAME_LEN];
89 struct dax_id *dax_id;
90 ssize_t rc = count;
91 int fields;
92
93 fields = sscanf(buf, "dax%d.%d", ®ion_id, &id);
94 if (fields != 2)
95 return -EINVAL;
96 sprintf(devname, "dax%d.%d", region_id, id);
97 if (!sysfs_streq(buf, devname))
98 return -EINVAL;
99
100 mutex_lock(&dax_bus_lock);
101 dax_id = __dax_match_id(dax_drv, buf);
102 if (!dax_id) {
103 if (action == ID_ADD) {
104 dax_id = kzalloc(sizeof(*dax_id), GFP_KERNEL);
105 if (dax_id) {
106 strscpy(dax_id->dev_name, buf, DAX_NAME_LEN);
107 list_add(&dax_id->list, &dax_drv->ids);
108 } else
109 rc = -ENOMEM;
110 }
111 } else if (action == ID_REMOVE) {
112 list_del(&dax_id->list);
113 kfree(dax_id);
114 }
115 mutex_unlock(&dax_bus_lock);
116
117 if (rc < 0)
118 return rc;
119 if (action == ID_ADD)
120 rc = driver_attach(drv);
121 if (rc)
122 return rc;
123 return count;
124}
125
126static ssize_t new_id_store(struct device_driver *drv, const char *buf,
127 size_t count)
128{
129 return do_id_store(drv, buf, count, ID_ADD);
130}
131static DRIVER_ATTR_WO(new_id);
132
133static ssize_t remove_id_store(struct device_driver *drv, const char *buf,
134 size_t count)
135{
136 return do_id_store(drv, buf, count, ID_REMOVE);
137}
138static DRIVER_ATTR_WO(remove_id);
139
140static struct attribute *dax_drv_attrs[] = {
141 &driver_attr_new_id.attr,
142 &driver_attr_remove_id.attr,
143 NULL,
144};
145ATTRIBUTE_GROUPS(dax_drv);
146
147static int dax_bus_match(struct device *dev, struct device_driver *drv);
148
149/*
150 * Static dax regions are regions created by an external subsystem
151 * nvdimm where a single range is assigned. Its boundaries are by the external
152 * subsystem and are usually limited to one physical memory range. For example,
153 * for PMEM it is usually defined by NVDIMM Namespace boundaries (i.e. a
154 * single contiguous range)
155 *
156 * On dynamic dax regions, the assigned region can be partitioned by dax core
157 * into multiple subdivisions. A subdivision is represented into one
158 * /dev/daxN.M device composed by one or more potentially discontiguous ranges.
159 *
160 * When allocating a dax region, drivers must set whether it's static
161 * (IORESOURCE_DAX_STATIC). On static dax devices, the @pgmap is pre-assigned
162 * to dax core when calling devm_create_dev_dax(), whereas in dynamic dax
163 * devices it is NULL but afterwards allocated by dax core on device ->probe().
164 * Care is needed to make sure that dynamic dax devices are torn down with a
165 * cleared @pgmap field (see kill_dev_dax()).
166 */
167static bool is_static(struct dax_region *dax_region)
168{
169 return (dax_region->res.flags & IORESOURCE_DAX_STATIC) != 0;
170}
171
172bool static_dev_dax(struct dev_dax *dev_dax)
173{
174 return is_static(dev_dax->region);
175}
176EXPORT_SYMBOL_GPL(static_dev_dax);
177
178static u64 dev_dax_size(struct dev_dax *dev_dax)
179{
180 u64 size = 0;
181 int i;
182
183 device_lock_assert(&dev_dax->dev);
184
185 for (i = 0; i < dev_dax->nr_range; i++)
186 size += range_len(&dev_dax->ranges[i].range);
187
188 return size;
189}
190
191static int dax_bus_probe(struct device *dev)
192{
193 struct dax_device_driver *dax_drv = to_dax_drv(dev->driver);
194 struct dev_dax *dev_dax = to_dev_dax(dev);
195 struct dax_region *dax_region = dev_dax->region;
196 int rc;
197
198 if (dev_dax_size(dev_dax) == 0 || dev_dax->id < 0)
199 return -ENXIO;
200
201 rc = dax_drv->probe(dev_dax);
202
203 if (rc || is_static(dax_region))
204 return rc;
205
206 /*
207 * Track new seed creation only after successful probe of the
208 * previous seed.
209 */
210 if (dax_region->seed == dev)
211 dax_region->seed = NULL;
212
213 return 0;
214}
215
216static void dax_bus_remove(struct device *dev)
217{
218 struct dax_device_driver *dax_drv = to_dax_drv(dev->driver);
219 struct dev_dax *dev_dax = to_dev_dax(dev);
220
221 if (dax_drv->remove)
222 dax_drv->remove(dev_dax);
223}
224
225static struct bus_type dax_bus_type = {
226 .name = "dax",
227 .uevent = dax_bus_uevent,
228 .match = dax_bus_match,
229 .probe = dax_bus_probe,
230 .remove = dax_bus_remove,
231 .drv_groups = dax_drv_groups,
232};
233
234static int dax_bus_match(struct device *dev, struct device_driver *drv)
235{
236 struct dax_device_driver *dax_drv = to_dax_drv(drv);
237
238 if (dax_match_id(dax_drv, dev))
239 return 1;
240 return dax_match_type(dax_drv, dev);
241}
242
243/*
244 * Rely on the fact that drvdata is set before the attributes are
245 * registered, and that the attributes are unregistered before drvdata
246 * is cleared to assume that drvdata is always valid.
247 */
248static ssize_t id_show(struct device *dev,
249 struct device_attribute *attr, char *buf)
250{
251 struct dax_region *dax_region = dev_get_drvdata(dev);
252
253 return sprintf(buf, "%d\n", dax_region->id);
254}
255static DEVICE_ATTR_RO(id);
256
257static ssize_t region_size_show(struct device *dev,
258 struct device_attribute *attr, char *buf)
259{
260 struct dax_region *dax_region = dev_get_drvdata(dev);
261
262 return sprintf(buf, "%llu\n", (unsigned long long)
263 resource_size(&dax_region->res));
264}
265static struct device_attribute dev_attr_region_size = __ATTR(size, 0444,
266 region_size_show, NULL);
267
268static ssize_t region_align_show(struct device *dev,
269 struct device_attribute *attr, char *buf)
270{
271 struct dax_region *dax_region = dev_get_drvdata(dev);
272
273 return sprintf(buf, "%u\n", dax_region->align);
274}
275static struct device_attribute dev_attr_region_align =
276 __ATTR(align, 0400, region_align_show, NULL);
277
278#define for_each_dax_region_resource(dax_region, res) \
279 for (res = (dax_region)->res.child; res; res = res->sibling)
280
281static unsigned long long dax_region_avail_size(struct dax_region *dax_region)
282{
283 resource_size_t size = resource_size(&dax_region->res);
284 struct resource *res;
285
286 device_lock_assert(dax_region->dev);
287
288 for_each_dax_region_resource(dax_region, res)
289 size -= resource_size(res);
290 return size;
291}
292
293static ssize_t available_size_show(struct device *dev,
294 struct device_attribute *attr, char *buf)
295{
296 struct dax_region *dax_region = dev_get_drvdata(dev);
297 unsigned long long size;
298
299 device_lock(dev);
300 size = dax_region_avail_size(dax_region);
301 device_unlock(dev);
302
303 return sprintf(buf, "%llu\n", size);
304}
305static DEVICE_ATTR_RO(available_size);
306
307static ssize_t seed_show(struct device *dev,
308 struct device_attribute *attr, char *buf)
309{
310 struct dax_region *dax_region = dev_get_drvdata(dev);
311 struct device *seed;
312 ssize_t rc;
313
314 if (is_static(dax_region))
315 return -EINVAL;
316
317 device_lock(dev);
318 seed = dax_region->seed;
319 rc = sprintf(buf, "%s\n", seed ? dev_name(seed) : "");
320 device_unlock(dev);
321
322 return rc;
323}
324static DEVICE_ATTR_RO(seed);
325
326static ssize_t create_show(struct device *dev,
327 struct device_attribute *attr, char *buf)
328{
329 struct dax_region *dax_region = dev_get_drvdata(dev);
330 struct device *youngest;
331 ssize_t rc;
332
333 if (is_static(dax_region))
334 return -EINVAL;
335
336 device_lock(dev);
337 youngest = dax_region->youngest;
338 rc = sprintf(buf, "%s\n", youngest ? dev_name(youngest) : "");
339 device_unlock(dev);
340
341 return rc;
342}
343
344static ssize_t create_store(struct device *dev, struct device_attribute *attr,
345 const char *buf, size_t len)
346{
347 struct dax_region *dax_region = dev_get_drvdata(dev);
348 unsigned long long avail;
349 ssize_t rc;
350 int val;
351
352 if (is_static(dax_region))
353 return -EINVAL;
354
355 rc = kstrtoint(buf, 0, &val);
356 if (rc)
357 return rc;
358 if (val != 1)
359 return -EINVAL;
360
361 device_lock(dev);
362 avail = dax_region_avail_size(dax_region);
363 if (avail == 0)
364 rc = -ENOSPC;
365 else {
366 struct dev_dax_data data = {
367 .dax_region = dax_region,
368 .size = 0,
369 .id = -1,
370 .memmap_on_memory = false,
371 };
372 struct dev_dax *dev_dax = devm_create_dev_dax(&data);
373
374 if (IS_ERR(dev_dax))
375 rc = PTR_ERR(dev_dax);
376 else {
377 /*
378 * In support of crafting multiple new devices
379 * simultaneously multiple seeds can be created,
380 * but only the first one that has not been
381 * successfully bound is tracked as the region
382 * seed.
383 */
384 if (!dax_region->seed)
385 dax_region->seed = &dev_dax->dev;
386 dax_region->youngest = &dev_dax->dev;
387 rc = len;
388 }
389 }
390 device_unlock(dev);
391
392 return rc;
393}
394static DEVICE_ATTR_RW(create);
395
396void kill_dev_dax(struct dev_dax *dev_dax)
397{
398 struct dax_device *dax_dev = dev_dax->dax_dev;
399 struct inode *inode = dax_inode(dax_dev);
400
401 kill_dax(dax_dev);
402 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
403
404 /*
405 * Dynamic dax region have the pgmap allocated via dev_kzalloc()
406 * and thus freed by devm. Clear the pgmap to not have stale pgmap
407 * ranges on probe() from previous reconfigurations of region devices.
408 */
409 if (!static_dev_dax(dev_dax))
410 dev_dax->pgmap = NULL;
411}
412EXPORT_SYMBOL_GPL(kill_dev_dax);
413
414static void trim_dev_dax_range(struct dev_dax *dev_dax)
415{
416 int i = dev_dax->nr_range - 1;
417 struct range *range = &dev_dax->ranges[i].range;
418 struct dax_region *dax_region = dev_dax->region;
419
420 device_lock_assert(dax_region->dev);
421 dev_dbg(&dev_dax->dev, "delete range[%d]: %#llx:%#llx\n", i,
422 (unsigned long long)range->start,
423 (unsigned long long)range->end);
424
425 __release_region(&dax_region->res, range->start, range_len(range));
426 if (--dev_dax->nr_range == 0) {
427 kfree(dev_dax->ranges);
428 dev_dax->ranges = NULL;
429 }
430}
431
432static void free_dev_dax_ranges(struct dev_dax *dev_dax)
433{
434 while (dev_dax->nr_range)
435 trim_dev_dax_range(dev_dax);
436}
437
438static void unregister_dev_dax(void *dev)
439{
440 struct dev_dax *dev_dax = to_dev_dax(dev);
441
442 dev_dbg(dev, "%s\n", __func__);
443
444 kill_dev_dax(dev_dax);
445 device_del(dev);
446 free_dev_dax_ranges(dev_dax);
447 put_device(dev);
448}
449
450static void dax_region_free(struct kref *kref)
451{
452 struct dax_region *dax_region;
453
454 dax_region = container_of(kref, struct dax_region, kref);
455 kfree(dax_region);
456}
457
458static void dax_region_put(struct dax_region *dax_region)
459{
460 kref_put(&dax_region->kref, dax_region_free);
461}
462
463/* a return value >= 0 indicates this invocation invalidated the id */
464static int __free_dev_dax_id(struct dev_dax *dev_dax)
465{
466 struct device *dev = &dev_dax->dev;
467 struct dax_region *dax_region;
468 int rc = dev_dax->id;
469
470 device_lock_assert(dev);
471
472 if (!dev_dax->dyn_id || dev_dax->id < 0)
473 return -1;
474 dax_region = dev_dax->region;
475 ida_free(&dax_region->ida, dev_dax->id);
476 dax_region_put(dax_region);
477 dev_dax->id = -1;
478 return rc;
479}
480
481static int free_dev_dax_id(struct dev_dax *dev_dax)
482{
483 struct device *dev = &dev_dax->dev;
484 int rc;
485
486 device_lock(dev);
487 rc = __free_dev_dax_id(dev_dax);
488 device_unlock(dev);
489 return rc;
490}
491
492static int alloc_dev_dax_id(struct dev_dax *dev_dax)
493{
494 struct dax_region *dax_region = dev_dax->region;
495 int id;
496
497 id = ida_alloc(&dax_region->ida, GFP_KERNEL);
498 if (id < 0)
499 return id;
500 kref_get(&dax_region->kref);
501 dev_dax->dyn_id = true;
502 dev_dax->id = id;
503 return id;
504}
505
506static ssize_t delete_store(struct device *dev, struct device_attribute *attr,
507 const char *buf, size_t len)
508{
509 struct dax_region *dax_region = dev_get_drvdata(dev);
510 struct dev_dax *dev_dax;
511 struct device *victim;
512 bool do_del = false;
513 int rc;
514
515 if (is_static(dax_region))
516 return -EINVAL;
517
518 victim = device_find_child_by_name(dax_region->dev, buf);
519 if (!victim)
520 return -ENXIO;
521
522 device_lock(dev);
523 device_lock(victim);
524 dev_dax = to_dev_dax(victim);
525 if (victim->driver || dev_dax_size(dev_dax))
526 rc = -EBUSY;
527 else {
528 /*
529 * Invalidate the device so it does not become active
530 * again, but always preserve device-id-0 so that
531 * /sys/bus/dax/ is guaranteed to be populated while any
532 * dax_region is registered.
533 */
534 if (dev_dax->id > 0) {
535 do_del = __free_dev_dax_id(dev_dax) >= 0;
536 rc = len;
537 if (dax_region->seed == victim)
538 dax_region->seed = NULL;
539 if (dax_region->youngest == victim)
540 dax_region->youngest = NULL;
541 } else
542 rc = -EBUSY;
543 }
544 device_unlock(victim);
545
546 /* won the race to invalidate the device, clean it up */
547 if (do_del)
548 devm_release_action(dev, unregister_dev_dax, victim);
549 device_unlock(dev);
550 put_device(victim);
551
552 return rc;
553}
554static DEVICE_ATTR_WO(delete);
555
556static umode_t dax_region_visible(struct kobject *kobj, struct attribute *a,
557 int n)
558{
559 struct device *dev = container_of(kobj, struct device, kobj);
560 struct dax_region *dax_region = dev_get_drvdata(dev);
561
562 if (is_static(dax_region))
563 if (a == &dev_attr_available_size.attr
564 || a == &dev_attr_create.attr
565 || a == &dev_attr_seed.attr
566 || a == &dev_attr_delete.attr)
567 return 0;
568 return a->mode;
569}
570
571static struct attribute *dax_region_attributes[] = {
572 &dev_attr_available_size.attr,
573 &dev_attr_region_size.attr,
574 &dev_attr_region_align.attr,
575 &dev_attr_create.attr,
576 &dev_attr_seed.attr,
577 &dev_attr_delete.attr,
578 &dev_attr_id.attr,
579 NULL,
580};
581
582static const struct attribute_group dax_region_attribute_group = {
583 .name = "dax_region",
584 .attrs = dax_region_attributes,
585 .is_visible = dax_region_visible,
586};
587
588static const struct attribute_group *dax_region_attribute_groups[] = {
589 &dax_region_attribute_group,
590 NULL,
591};
592
593static void dax_region_unregister(void *region)
594{
595 struct dax_region *dax_region = region;
596
597 sysfs_remove_groups(&dax_region->dev->kobj,
598 dax_region_attribute_groups);
599 dax_region_put(dax_region);
600}
601
602struct dax_region *alloc_dax_region(struct device *parent, int region_id,
603 struct range *range, int target_node, unsigned int align,
604 unsigned long flags)
605{
606 struct dax_region *dax_region;
607
608 /*
609 * The DAX core assumes that it can store its private data in
610 * parent->driver_data. This WARN is a reminder / safeguard for
611 * developers of device-dax drivers.
612 */
613 if (dev_get_drvdata(parent)) {
614 dev_WARN(parent, "dax core failed to setup private data\n");
615 return NULL;
616 }
617
618 if (!IS_ALIGNED(range->start, align)
619 || !IS_ALIGNED(range_len(range), align))
620 return NULL;
621
622 dax_region = kzalloc(sizeof(*dax_region), GFP_KERNEL);
623 if (!dax_region)
624 return NULL;
625
626 dev_set_drvdata(parent, dax_region);
627 kref_init(&dax_region->kref);
628 dax_region->id = region_id;
629 dax_region->align = align;
630 dax_region->dev = parent;
631 dax_region->target_node = target_node;
632 ida_init(&dax_region->ida);
633 dax_region->res = (struct resource) {
634 .start = range->start,
635 .end = range->end,
636 .flags = IORESOURCE_MEM | flags,
637 };
638
639 if (sysfs_create_groups(&parent->kobj, dax_region_attribute_groups)) {
640 kfree(dax_region);
641 return NULL;
642 }
643
644 if (devm_add_action_or_reset(parent, dax_region_unregister, dax_region))
645 return NULL;
646 return dax_region;
647}
648EXPORT_SYMBOL_GPL(alloc_dax_region);
649
650static void dax_mapping_release(struct device *dev)
651{
652 struct dax_mapping *mapping = to_dax_mapping(dev);
653 struct device *parent = dev->parent;
654 struct dev_dax *dev_dax = to_dev_dax(parent);
655
656 ida_free(&dev_dax->ida, mapping->id);
657 kfree(mapping);
658 put_device(parent);
659}
660
661static void unregister_dax_mapping(void *data)
662{
663 struct device *dev = data;
664 struct dax_mapping *mapping = to_dax_mapping(dev);
665 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
666 struct dax_region *dax_region = dev_dax->region;
667
668 dev_dbg(dev, "%s\n", __func__);
669
670 device_lock_assert(dax_region->dev);
671
672 dev_dax->ranges[mapping->range_id].mapping = NULL;
673 mapping->range_id = -1;
674
675 device_unregister(dev);
676}
677
678static struct dev_dax_range *get_dax_range(struct device *dev)
679{
680 struct dax_mapping *mapping = to_dax_mapping(dev);
681 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
682 struct dax_region *dax_region = dev_dax->region;
683
684 device_lock(dax_region->dev);
685 if (mapping->range_id < 0) {
686 device_unlock(dax_region->dev);
687 return NULL;
688 }
689
690 return &dev_dax->ranges[mapping->range_id];
691}
692
693static void put_dax_range(struct dev_dax_range *dax_range)
694{
695 struct dax_mapping *mapping = dax_range->mapping;
696 struct dev_dax *dev_dax = to_dev_dax(mapping->dev.parent);
697 struct dax_region *dax_region = dev_dax->region;
698
699 device_unlock(dax_region->dev);
700}
701
702static ssize_t start_show(struct device *dev,
703 struct device_attribute *attr, char *buf)
704{
705 struct dev_dax_range *dax_range;
706 ssize_t rc;
707
708 dax_range = get_dax_range(dev);
709 if (!dax_range)
710 return -ENXIO;
711 rc = sprintf(buf, "%#llx\n", dax_range->range.start);
712 put_dax_range(dax_range);
713
714 return rc;
715}
716static DEVICE_ATTR(start, 0400, start_show, NULL);
717
718static ssize_t end_show(struct device *dev,
719 struct device_attribute *attr, char *buf)
720{
721 struct dev_dax_range *dax_range;
722 ssize_t rc;
723
724 dax_range = get_dax_range(dev);
725 if (!dax_range)
726 return -ENXIO;
727 rc = sprintf(buf, "%#llx\n", dax_range->range.end);
728 put_dax_range(dax_range);
729
730 return rc;
731}
732static DEVICE_ATTR(end, 0400, end_show, NULL);
733
734static ssize_t pgoff_show(struct device *dev,
735 struct device_attribute *attr, char *buf)
736{
737 struct dev_dax_range *dax_range;
738 ssize_t rc;
739
740 dax_range = get_dax_range(dev);
741 if (!dax_range)
742 return -ENXIO;
743 rc = sprintf(buf, "%#lx\n", dax_range->pgoff);
744 put_dax_range(dax_range);
745
746 return rc;
747}
748static DEVICE_ATTR(page_offset, 0400, pgoff_show, NULL);
749
750static struct attribute *dax_mapping_attributes[] = {
751 &dev_attr_start.attr,
752 &dev_attr_end.attr,
753 &dev_attr_page_offset.attr,
754 NULL,
755};
756
757static const struct attribute_group dax_mapping_attribute_group = {
758 .attrs = dax_mapping_attributes,
759};
760
761static const struct attribute_group *dax_mapping_attribute_groups[] = {
762 &dax_mapping_attribute_group,
763 NULL,
764};
765
766static struct device_type dax_mapping_type = {
767 .release = dax_mapping_release,
768 .groups = dax_mapping_attribute_groups,
769};
770
771static int devm_register_dax_mapping(struct dev_dax *dev_dax, int range_id)
772{
773 struct dax_region *dax_region = dev_dax->region;
774 struct dax_mapping *mapping;
775 struct device *dev;
776 int rc;
777
778 device_lock_assert(dax_region->dev);
779
780 if (dev_WARN_ONCE(&dev_dax->dev, !dax_region->dev->driver,
781 "region disabled\n"))
782 return -ENXIO;
783
784 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
785 if (!mapping)
786 return -ENOMEM;
787 mapping->range_id = range_id;
788 mapping->id = ida_alloc(&dev_dax->ida, GFP_KERNEL);
789 if (mapping->id < 0) {
790 kfree(mapping);
791 return -ENOMEM;
792 }
793 dev_dax->ranges[range_id].mapping = mapping;
794 dev = &mapping->dev;
795 device_initialize(dev);
796 dev->parent = &dev_dax->dev;
797 get_device(dev->parent);
798 dev->type = &dax_mapping_type;
799 dev_set_name(dev, "mapping%d", mapping->id);
800 rc = device_add(dev);
801 if (rc) {
802 put_device(dev);
803 return rc;
804 }
805
806 rc = devm_add_action_or_reset(dax_region->dev, unregister_dax_mapping,
807 dev);
808 if (rc)
809 return rc;
810 return 0;
811}
812
813static int alloc_dev_dax_range(struct dev_dax *dev_dax, u64 start,
814 resource_size_t size)
815{
816 struct dax_region *dax_region = dev_dax->region;
817 struct resource *res = &dax_region->res;
818 struct device *dev = &dev_dax->dev;
819 struct dev_dax_range *ranges;
820 unsigned long pgoff = 0;
821 struct resource *alloc;
822 int i, rc;
823
824 device_lock_assert(dax_region->dev);
825
826 /* handle the seed alloc special case */
827 if (!size) {
828 if (dev_WARN_ONCE(dev, dev_dax->nr_range,
829 "0-size allocation must be first\n"))
830 return -EBUSY;
831 /* nr_range == 0 is elsewhere special cased as 0-size device */
832 return 0;
833 }
834
835 alloc = __request_region(res, start, size, dev_name(dev), 0);
836 if (!alloc)
837 return -ENOMEM;
838
839 ranges = krealloc(dev_dax->ranges, sizeof(*ranges)
840 * (dev_dax->nr_range + 1), GFP_KERNEL);
841 if (!ranges) {
842 __release_region(res, alloc->start, resource_size(alloc));
843 return -ENOMEM;
844 }
845
846 for (i = 0; i < dev_dax->nr_range; i++)
847 pgoff += PHYS_PFN(range_len(&ranges[i].range));
848 dev_dax->ranges = ranges;
849 ranges[dev_dax->nr_range++] = (struct dev_dax_range) {
850 .pgoff = pgoff,
851 .range = {
852 .start = alloc->start,
853 .end = alloc->end,
854 },
855 };
856
857 dev_dbg(dev, "alloc range[%d]: %pa:%pa\n", dev_dax->nr_range - 1,
858 &alloc->start, &alloc->end);
859 /*
860 * A dev_dax instance must be registered before mapping device
861 * children can be added. Defer to devm_create_dev_dax() to add
862 * the initial mapping device.
863 */
864 if (!device_is_registered(&dev_dax->dev))
865 return 0;
866
867 rc = devm_register_dax_mapping(dev_dax, dev_dax->nr_range - 1);
868 if (rc)
869 trim_dev_dax_range(dev_dax);
870
871 return rc;
872}
873
874static int adjust_dev_dax_range(struct dev_dax *dev_dax, struct resource *res, resource_size_t size)
875{
876 int last_range = dev_dax->nr_range - 1;
877 struct dev_dax_range *dax_range = &dev_dax->ranges[last_range];
878 struct dax_region *dax_region = dev_dax->region;
879 bool is_shrink = resource_size(res) > size;
880 struct range *range = &dax_range->range;
881 struct device *dev = &dev_dax->dev;
882 int rc;
883
884 device_lock_assert(dax_region->dev);
885
886 if (dev_WARN_ONCE(dev, !size, "deletion is handled by dev_dax_shrink\n"))
887 return -EINVAL;
888
889 rc = adjust_resource(res, range->start, size);
890 if (rc)
891 return rc;
892
893 *range = (struct range) {
894 .start = range->start,
895 .end = range->start + size - 1,
896 };
897
898 dev_dbg(dev, "%s range[%d]: %#llx:%#llx\n", is_shrink ? "shrink" : "extend",
899 last_range, (unsigned long long) range->start,
900 (unsigned long long) range->end);
901
902 return 0;
903}
904
905static ssize_t size_show(struct device *dev,
906 struct device_attribute *attr, char *buf)
907{
908 struct dev_dax *dev_dax = to_dev_dax(dev);
909 unsigned long long size;
910
911 device_lock(dev);
912 size = dev_dax_size(dev_dax);
913 device_unlock(dev);
914
915 return sprintf(buf, "%llu\n", size);
916}
917
918static bool alloc_is_aligned(struct dev_dax *dev_dax, resource_size_t size)
919{
920 /*
921 * The minimum mapping granularity for a device instance is a
922 * single subsection, unless the arch says otherwise.
923 */
924 return IS_ALIGNED(size, max_t(unsigned long, dev_dax->align, memremap_compat_align()));
925}
926
927static int dev_dax_shrink(struct dev_dax *dev_dax, resource_size_t size)
928{
929 resource_size_t to_shrink = dev_dax_size(dev_dax) - size;
930 struct dax_region *dax_region = dev_dax->region;
931 struct device *dev = &dev_dax->dev;
932 int i;
933
934 for (i = dev_dax->nr_range - 1; i >= 0; i--) {
935 struct range *range = &dev_dax->ranges[i].range;
936 struct dax_mapping *mapping = dev_dax->ranges[i].mapping;
937 struct resource *adjust = NULL, *res;
938 resource_size_t shrink;
939
940 shrink = min_t(u64, to_shrink, range_len(range));
941 if (shrink >= range_len(range)) {
942 devm_release_action(dax_region->dev,
943 unregister_dax_mapping, &mapping->dev);
944 trim_dev_dax_range(dev_dax);
945 to_shrink -= shrink;
946 if (!to_shrink)
947 break;
948 continue;
949 }
950
951 for_each_dax_region_resource(dax_region, res)
952 if (strcmp(res->name, dev_name(dev)) == 0
953 && res->start == range->start) {
954 adjust = res;
955 break;
956 }
957
958 if (dev_WARN_ONCE(dev, !adjust || i != dev_dax->nr_range - 1,
959 "failed to find matching resource\n"))
960 return -ENXIO;
961 return adjust_dev_dax_range(dev_dax, adjust, range_len(range)
962 - shrink);
963 }
964 return 0;
965}
966
967/*
968 * Only allow adjustments that preserve the relative pgoff of existing
969 * allocations. I.e. the dev_dax->ranges array is ordered by increasing pgoff.
970 */
971static bool adjust_ok(struct dev_dax *dev_dax, struct resource *res)
972{
973 struct dev_dax_range *last;
974 int i;
975
976 if (dev_dax->nr_range == 0)
977 return false;
978 if (strcmp(res->name, dev_name(&dev_dax->dev)) != 0)
979 return false;
980 last = &dev_dax->ranges[dev_dax->nr_range - 1];
981 if (last->range.start != res->start || last->range.end != res->end)
982 return false;
983 for (i = 0; i < dev_dax->nr_range - 1; i++) {
984 struct dev_dax_range *dax_range = &dev_dax->ranges[i];
985
986 if (dax_range->pgoff > last->pgoff)
987 return false;
988 }
989
990 return true;
991}
992
993static ssize_t dev_dax_resize(struct dax_region *dax_region,
994 struct dev_dax *dev_dax, resource_size_t size)
995{
996 resource_size_t avail = dax_region_avail_size(dax_region), to_alloc;
997 resource_size_t dev_size = dev_dax_size(dev_dax);
998 struct resource *region_res = &dax_region->res;
999 struct device *dev = &dev_dax->dev;
1000 struct resource *res, *first;
1001 resource_size_t alloc = 0;
1002 int rc;
1003
1004 if (dev->driver)
1005 return -EBUSY;
1006 if (size == dev_size)
1007 return 0;
1008 if (size > dev_size && size - dev_size > avail)
1009 return -ENOSPC;
1010 if (size < dev_size)
1011 return dev_dax_shrink(dev_dax, size);
1012
1013 to_alloc = size - dev_size;
1014 if (dev_WARN_ONCE(dev, !alloc_is_aligned(dev_dax, to_alloc),
1015 "resize of %pa misaligned\n", &to_alloc))
1016 return -ENXIO;
1017
1018 /*
1019 * Expand the device into the unused portion of the region. This
1020 * may involve adjusting the end of an existing resource, or
1021 * allocating a new resource.
1022 */
1023retry:
1024 first = region_res->child;
1025 if (!first)
1026 return alloc_dev_dax_range(dev_dax, dax_region->res.start, to_alloc);
1027
1028 rc = -ENOSPC;
1029 for (res = first; res; res = res->sibling) {
1030 struct resource *next = res->sibling;
1031
1032 /* space at the beginning of the region */
1033 if (res == first && res->start > dax_region->res.start) {
1034 alloc = min(res->start - dax_region->res.start, to_alloc);
1035 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, alloc);
1036 break;
1037 }
1038
1039 alloc = 0;
1040 /* space between allocations */
1041 if (next && next->start > res->end + 1)
1042 alloc = min(next->start - (res->end + 1), to_alloc);
1043
1044 /* space at the end of the region */
1045 if (!alloc && !next && res->end < region_res->end)
1046 alloc = min(region_res->end - res->end, to_alloc);
1047
1048 if (!alloc)
1049 continue;
1050
1051 if (adjust_ok(dev_dax, res)) {
1052 rc = adjust_dev_dax_range(dev_dax, res, resource_size(res) + alloc);
1053 break;
1054 }
1055 rc = alloc_dev_dax_range(dev_dax, res->end + 1, alloc);
1056 break;
1057 }
1058 if (rc)
1059 return rc;
1060 to_alloc -= alloc;
1061 if (to_alloc)
1062 goto retry;
1063 return 0;
1064}
1065
1066static ssize_t size_store(struct device *dev, struct device_attribute *attr,
1067 const char *buf, size_t len)
1068{
1069 ssize_t rc;
1070 unsigned long long val;
1071 struct dev_dax *dev_dax = to_dev_dax(dev);
1072 struct dax_region *dax_region = dev_dax->region;
1073
1074 rc = kstrtoull(buf, 0, &val);
1075 if (rc)
1076 return rc;
1077
1078 if (!alloc_is_aligned(dev_dax, val)) {
1079 dev_dbg(dev, "%s: size: %lld misaligned\n", __func__, val);
1080 return -EINVAL;
1081 }
1082
1083 device_lock(dax_region->dev);
1084 if (!dax_region->dev->driver) {
1085 device_unlock(dax_region->dev);
1086 return -ENXIO;
1087 }
1088 device_lock(dev);
1089 rc = dev_dax_resize(dax_region, dev_dax, val);
1090 device_unlock(dev);
1091 device_unlock(dax_region->dev);
1092
1093 return rc == 0 ? len : rc;
1094}
1095static DEVICE_ATTR_RW(size);
1096
1097static ssize_t range_parse(const char *opt, size_t len, struct range *range)
1098{
1099 unsigned long long addr = 0;
1100 char *start, *end, *str;
1101 ssize_t rc = -EINVAL;
1102
1103 str = kstrdup(opt, GFP_KERNEL);
1104 if (!str)
1105 return rc;
1106
1107 end = str;
1108 start = strsep(&end, "-");
1109 if (!start || !end)
1110 goto err;
1111
1112 rc = kstrtoull(start, 16, &addr);
1113 if (rc)
1114 goto err;
1115 range->start = addr;
1116
1117 rc = kstrtoull(end, 16, &addr);
1118 if (rc)
1119 goto err;
1120 range->end = addr;
1121
1122err:
1123 kfree(str);
1124 return rc;
1125}
1126
1127static ssize_t mapping_store(struct device *dev, struct device_attribute *attr,
1128 const char *buf, size_t len)
1129{
1130 struct dev_dax *dev_dax = to_dev_dax(dev);
1131 struct dax_region *dax_region = dev_dax->region;
1132 size_t to_alloc;
1133 struct range r;
1134 ssize_t rc;
1135
1136 rc = range_parse(buf, len, &r);
1137 if (rc)
1138 return rc;
1139
1140 rc = -ENXIO;
1141 device_lock(dax_region->dev);
1142 if (!dax_region->dev->driver) {
1143 device_unlock(dax_region->dev);
1144 return rc;
1145 }
1146 device_lock(dev);
1147
1148 to_alloc = range_len(&r);
1149 if (alloc_is_aligned(dev_dax, to_alloc))
1150 rc = alloc_dev_dax_range(dev_dax, r.start, to_alloc);
1151 device_unlock(dev);
1152 device_unlock(dax_region->dev);
1153
1154 return rc == 0 ? len : rc;
1155}
1156static DEVICE_ATTR_WO(mapping);
1157
1158static ssize_t align_show(struct device *dev,
1159 struct device_attribute *attr, char *buf)
1160{
1161 struct dev_dax *dev_dax = to_dev_dax(dev);
1162
1163 return sprintf(buf, "%d\n", dev_dax->align);
1164}
1165
1166static ssize_t dev_dax_validate_align(struct dev_dax *dev_dax)
1167{
1168 struct device *dev = &dev_dax->dev;
1169 int i;
1170
1171 for (i = 0; i < dev_dax->nr_range; i++) {
1172 size_t len = range_len(&dev_dax->ranges[i].range);
1173
1174 if (!alloc_is_aligned(dev_dax, len)) {
1175 dev_dbg(dev, "%s: align %u invalid for range %d\n",
1176 __func__, dev_dax->align, i);
1177 return -EINVAL;
1178 }
1179 }
1180
1181 return 0;
1182}
1183
1184static ssize_t align_store(struct device *dev, struct device_attribute *attr,
1185 const char *buf, size_t len)
1186{
1187 struct dev_dax *dev_dax = to_dev_dax(dev);
1188 struct dax_region *dax_region = dev_dax->region;
1189 unsigned long val, align_save;
1190 ssize_t rc;
1191
1192 rc = kstrtoul(buf, 0, &val);
1193 if (rc)
1194 return -ENXIO;
1195
1196 if (!dax_align_valid(val))
1197 return -EINVAL;
1198
1199 device_lock(dax_region->dev);
1200 if (!dax_region->dev->driver) {
1201 device_unlock(dax_region->dev);
1202 return -ENXIO;
1203 }
1204
1205 device_lock(dev);
1206 if (dev->driver) {
1207 rc = -EBUSY;
1208 goto out_unlock;
1209 }
1210
1211 align_save = dev_dax->align;
1212 dev_dax->align = val;
1213 rc = dev_dax_validate_align(dev_dax);
1214 if (rc)
1215 dev_dax->align = align_save;
1216out_unlock:
1217 device_unlock(dev);
1218 device_unlock(dax_region->dev);
1219 return rc == 0 ? len : rc;
1220}
1221static DEVICE_ATTR_RW(align);
1222
1223static int dev_dax_target_node(struct dev_dax *dev_dax)
1224{
1225 struct dax_region *dax_region = dev_dax->region;
1226
1227 return dax_region->target_node;
1228}
1229
1230static ssize_t target_node_show(struct device *dev,
1231 struct device_attribute *attr, char *buf)
1232{
1233 struct dev_dax *dev_dax = to_dev_dax(dev);
1234
1235 return sprintf(buf, "%d\n", dev_dax_target_node(dev_dax));
1236}
1237static DEVICE_ATTR_RO(target_node);
1238
1239static ssize_t resource_show(struct device *dev,
1240 struct device_attribute *attr, char *buf)
1241{
1242 struct dev_dax *dev_dax = to_dev_dax(dev);
1243 struct dax_region *dax_region = dev_dax->region;
1244 unsigned long long start;
1245
1246 if (dev_dax->nr_range < 1)
1247 start = dax_region->res.start;
1248 else
1249 start = dev_dax->ranges[0].range.start;
1250
1251 return sprintf(buf, "%#llx\n", start);
1252}
1253static DEVICE_ATTR(resource, 0400, resource_show, NULL);
1254
1255static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
1256 char *buf)
1257{
1258 /*
1259 * We only ever expect to handle device-dax instances, i.e. the
1260 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
1261 */
1262 return sprintf(buf, DAX_DEVICE_MODALIAS_FMT "\n", 0);
1263}
1264static DEVICE_ATTR_RO(modalias);
1265
1266static ssize_t numa_node_show(struct device *dev,
1267 struct device_attribute *attr, char *buf)
1268{
1269 return sprintf(buf, "%d\n", dev_to_node(dev));
1270}
1271static DEVICE_ATTR_RO(numa_node);
1272
1273static umode_t dev_dax_visible(struct kobject *kobj, struct attribute *a, int n)
1274{
1275 struct device *dev = container_of(kobj, struct device, kobj);
1276 struct dev_dax *dev_dax = to_dev_dax(dev);
1277 struct dax_region *dax_region = dev_dax->region;
1278
1279 if (a == &dev_attr_target_node.attr && dev_dax_target_node(dev_dax) < 0)
1280 return 0;
1281 if (a == &dev_attr_numa_node.attr && !IS_ENABLED(CONFIG_NUMA))
1282 return 0;
1283 if (a == &dev_attr_mapping.attr && is_static(dax_region))
1284 return 0;
1285 if ((a == &dev_attr_align.attr ||
1286 a == &dev_attr_size.attr) && is_static(dax_region))
1287 return 0444;
1288 return a->mode;
1289}
1290
1291static struct attribute *dev_dax_attributes[] = {
1292 &dev_attr_modalias.attr,
1293 &dev_attr_size.attr,
1294 &dev_attr_mapping.attr,
1295 &dev_attr_target_node.attr,
1296 &dev_attr_align.attr,
1297 &dev_attr_resource.attr,
1298 &dev_attr_numa_node.attr,
1299 NULL,
1300};
1301
1302static const struct attribute_group dev_dax_attribute_group = {
1303 .attrs = dev_dax_attributes,
1304 .is_visible = dev_dax_visible,
1305};
1306
1307static const struct attribute_group *dax_attribute_groups[] = {
1308 &dev_dax_attribute_group,
1309 NULL,
1310};
1311
1312static void dev_dax_release(struct device *dev)
1313{
1314 struct dev_dax *dev_dax = to_dev_dax(dev);
1315 struct dax_device *dax_dev = dev_dax->dax_dev;
1316
1317 put_dax(dax_dev);
1318 free_dev_dax_id(dev_dax);
1319 kfree(dev_dax->pgmap);
1320 kfree(dev_dax);
1321}
1322
1323static const struct device_type dev_dax_type = {
1324 .release = dev_dax_release,
1325 .groups = dax_attribute_groups,
1326};
1327
1328struct dev_dax *devm_create_dev_dax(struct dev_dax_data *data)
1329{
1330 struct dax_region *dax_region = data->dax_region;
1331 struct device *parent = dax_region->dev;
1332 struct dax_device *dax_dev;
1333 struct dev_dax *dev_dax;
1334 struct inode *inode;
1335 struct device *dev;
1336 int rc;
1337
1338 dev_dax = kzalloc(sizeof(*dev_dax), GFP_KERNEL);
1339 if (!dev_dax)
1340 return ERR_PTR(-ENOMEM);
1341
1342 dev_dax->region = dax_region;
1343 if (is_static(dax_region)) {
1344 if (dev_WARN_ONCE(parent, data->id < 0,
1345 "dynamic id specified to static region\n")) {
1346 rc = -EINVAL;
1347 goto err_id;
1348 }
1349
1350 dev_dax->id = data->id;
1351 } else {
1352 if (dev_WARN_ONCE(parent, data->id >= 0,
1353 "static id specified to dynamic region\n")) {
1354 rc = -EINVAL;
1355 goto err_id;
1356 }
1357
1358 rc = alloc_dev_dax_id(dev_dax);
1359 if (rc < 0)
1360 goto err_id;
1361 }
1362
1363 dev = &dev_dax->dev;
1364 device_initialize(dev);
1365 dev_set_name(dev, "dax%d.%d", dax_region->id, dev_dax->id);
1366
1367 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, data->size);
1368 if (rc)
1369 goto err_range;
1370
1371 if (data->pgmap) {
1372 dev_WARN_ONCE(parent, !is_static(dax_region),
1373 "custom dev_pagemap requires a static dax_region\n");
1374
1375 dev_dax->pgmap = kmemdup(data->pgmap,
1376 sizeof(struct dev_pagemap), GFP_KERNEL);
1377 if (!dev_dax->pgmap) {
1378 rc = -ENOMEM;
1379 goto err_pgmap;
1380 }
1381 }
1382
1383 /*
1384 * No dax_operations since there is no access to this device outside of
1385 * mmap of the resulting character device.
1386 */
1387 dax_dev = alloc_dax(dev_dax, NULL);
1388 if (IS_ERR(dax_dev)) {
1389 rc = PTR_ERR(dax_dev);
1390 goto err_alloc_dax;
1391 }
1392 set_dax_synchronous(dax_dev);
1393 set_dax_nocache(dax_dev);
1394 set_dax_nomc(dax_dev);
1395
1396 /* a device_dax instance is dead while the driver is not attached */
1397 kill_dax(dax_dev);
1398
1399 dev_dax->dax_dev = dax_dev;
1400 dev_dax->target_node = dax_region->target_node;
1401 dev_dax->align = dax_region->align;
1402 ida_init(&dev_dax->ida);
1403
1404 dev_dax->memmap_on_memory = data->memmap_on_memory;
1405
1406 inode = dax_inode(dax_dev);
1407 dev->devt = inode->i_rdev;
1408 dev->bus = &dax_bus_type;
1409 dev->parent = parent;
1410 dev->type = &dev_dax_type;
1411
1412 rc = device_add(dev);
1413 if (rc) {
1414 kill_dev_dax(dev_dax);
1415 put_device(dev);
1416 return ERR_PTR(rc);
1417 }
1418
1419 rc = devm_add_action_or_reset(dax_region->dev, unregister_dev_dax, dev);
1420 if (rc)
1421 return ERR_PTR(rc);
1422
1423 /* register mapping device for the initial allocation range */
1424 if (dev_dax->nr_range && range_len(&dev_dax->ranges[0].range)) {
1425 rc = devm_register_dax_mapping(dev_dax, 0);
1426 if (rc)
1427 return ERR_PTR(rc);
1428 }
1429
1430 return dev_dax;
1431
1432err_alloc_dax:
1433 kfree(dev_dax->pgmap);
1434err_pgmap:
1435 free_dev_dax_ranges(dev_dax);
1436err_range:
1437 free_dev_dax_id(dev_dax);
1438err_id:
1439 kfree(dev_dax);
1440
1441 return ERR_PTR(rc);
1442}
1443EXPORT_SYMBOL_GPL(devm_create_dev_dax);
1444
1445int __dax_driver_register(struct dax_device_driver *dax_drv,
1446 struct module *module, const char *mod_name)
1447{
1448 struct device_driver *drv = &dax_drv->drv;
1449
1450 /*
1451 * dax_bus_probe() calls dax_drv->probe() unconditionally.
1452 * So better be safe than sorry and ensure it is provided.
1453 */
1454 if (!dax_drv->probe)
1455 return -EINVAL;
1456
1457 INIT_LIST_HEAD(&dax_drv->ids);
1458 drv->owner = module;
1459 drv->name = mod_name;
1460 drv->mod_name = mod_name;
1461 drv->bus = &dax_bus_type;
1462
1463 return driver_register(drv);
1464}
1465EXPORT_SYMBOL_GPL(__dax_driver_register);
1466
1467void dax_driver_unregister(struct dax_device_driver *dax_drv)
1468{
1469 struct device_driver *drv = &dax_drv->drv;
1470 struct dax_id *dax_id, *_id;
1471
1472 mutex_lock(&dax_bus_lock);
1473 list_for_each_entry_safe(dax_id, _id, &dax_drv->ids, list) {
1474 list_del(&dax_id->list);
1475 kfree(dax_id);
1476 }
1477 mutex_unlock(&dax_bus_lock);
1478 driver_unregister(drv);
1479}
1480EXPORT_SYMBOL_GPL(dax_driver_unregister);
1481
1482int __init dax_bus_init(void)
1483{
1484 return bus_register(&dax_bus_type);
1485}
1486
1487void __exit dax_bus_exit(void)
1488{
1489 bus_unregister(&dax_bus_type);
1490}
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright(c) 2017-2018 Intel Corporation. All rights reserved. */
3#include <linux/memremap.h>
4#include <linux/device.h>
5#include <linux/mutex.h>
6#include <linux/list.h>
7#include <linux/slab.h>
8#include <linux/dax.h>
9#include <linux/io.h>
10#include "dax-private.h"
11#include "bus.h"
12
13static struct class *dax_class;
14
15static DEFINE_MUTEX(dax_bus_lock);
16
17#define DAX_NAME_LEN 30
18struct dax_id {
19 struct list_head list;
20 char dev_name[DAX_NAME_LEN];
21};
22
23static int dax_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
24{
25 /*
26 * We only ever expect to handle device-dax instances, i.e. the
27 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
28 */
29 return add_uevent_var(env, "MODALIAS=" DAX_DEVICE_MODALIAS_FMT, 0);
30}
31
32static struct dax_device_driver *to_dax_drv(struct device_driver *drv)
33{
34 return container_of(drv, struct dax_device_driver, drv);
35}
36
37static struct dax_id *__dax_match_id(struct dax_device_driver *dax_drv,
38 const char *dev_name)
39{
40 struct dax_id *dax_id;
41
42 lockdep_assert_held(&dax_bus_lock);
43
44 list_for_each_entry(dax_id, &dax_drv->ids, list)
45 if (sysfs_streq(dax_id->dev_name, dev_name))
46 return dax_id;
47 return NULL;
48}
49
50static int dax_match_id(struct dax_device_driver *dax_drv, struct device *dev)
51{
52 int match;
53
54 mutex_lock(&dax_bus_lock);
55 match = !!__dax_match_id(dax_drv, dev_name(dev));
56 mutex_unlock(&dax_bus_lock);
57
58 return match;
59}
60
61enum id_action {
62 ID_REMOVE,
63 ID_ADD,
64};
65
66static ssize_t do_id_store(struct device_driver *drv, const char *buf,
67 size_t count, enum id_action action)
68{
69 struct dax_device_driver *dax_drv = to_dax_drv(drv);
70 unsigned int region_id, id;
71 char devname[DAX_NAME_LEN];
72 struct dax_id *dax_id;
73 ssize_t rc = count;
74 int fields;
75
76 fields = sscanf(buf, "dax%d.%d", ®ion_id, &id);
77 if (fields != 2)
78 return -EINVAL;
79 sprintf(devname, "dax%d.%d", region_id, id);
80 if (!sysfs_streq(buf, devname))
81 return -EINVAL;
82
83 mutex_lock(&dax_bus_lock);
84 dax_id = __dax_match_id(dax_drv, buf);
85 if (!dax_id) {
86 if (action == ID_ADD) {
87 dax_id = kzalloc(sizeof(*dax_id), GFP_KERNEL);
88 if (dax_id) {
89 strncpy(dax_id->dev_name, buf, DAX_NAME_LEN);
90 list_add(&dax_id->list, &dax_drv->ids);
91 } else
92 rc = -ENOMEM;
93 }
94 } else if (action == ID_REMOVE) {
95 list_del(&dax_id->list);
96 kfree(dax_id);
97 }
98 mutex_unlock(&dax_bus_lock);
99
100 if (rc < 0)
101 return rc;
102 if (action == ID_ADD)
103 rc = driver_attach(drv);
104 if (rc)
105 return rc;
106 return count;
107}
108
109static ssize_t new_id_store(struct device_driver *drv, const char *buf,
110 size_t count)
111{
112 return do_id_store(drv, buf, count, ID_ADD);
113}
114static DRIVER_ATTR_WO(new_id);
115
116static ssize_t remove_id_store(struct device_driver *drv, const char *buf,
117 size_t count)
118{
119 return do_id_store(drv, buf, count, ID_REMOVE);
120}
121static DRIVER_ATTR_WO(remove_id);
122
123static struct attribute *dax_drv_attrs[] = {
124 &driver_attr_new_id.attr,
125 &driver_attr_remove_id.attr,
126 NULL,
127};
128ATTRIBUTE_GROUPS(dax_drv);
129
130static int dax_bus_match(struct device *dev, struct device_driver *drv);
131
132static bool is_static(struct dax_region *dax_region)
133{
134 return (dax_region->res.flags & IORESOURCE_DAX_STATIC) != 0;
135}
136
137static u64 dev_dax_size(struct dev_dax *dev_dax)
138{
139 u64 size = 0;
140 int i;
141
142 device_lock_assert(&dev_dax->dev);
143
144 for (i = 0; i < dev_dax->nr_range; i++)
145 size += range_len(&dev_dax->ranges[i].range);
146
147 return size;
148}
149
150static int dax_bus_probe(struct device *dev)
151{
152 struct dax_device_driver *dax_drv = to_dax_drv(dev->driver);
153 struct dev_dax *dev_dax = to_dev_dax(dev);
154 struct dax_region *dax_region = dev_dax->region;
155 int rc;
156
157 if (dev_dax_size(dev_dax) == 0 || dev_dax->id < 0)
158 return -ENXIO;
159
160 rc = dax_drv->probe(dev_dax);
161
162 if (rc || is_static(dax_region))
163 return rc;
164
165 /*
166 * Track new seed creation only after successful probe of the
167 * previous seed.
168 */
169 if (dax_region->seed == dev)
170 dax_region->seed = NULL;
171
172 return 0;
173}
174
175static int dax_bus_remove(struct device *dev)
176{
177 struct dax_device_driver *dax_drv = to_dax_drv(dev->driver);
178 struct dev_dax *dev_dax = to_dev_dax(dev);
179
180 if (dax_drv->remove)
181 dax_drv->remove(dev_dax);
182
183 return 0;
184}
185
186static struct bus_type dax_bus_type = {
187 .name = "dax",
188 .uevent = dax_bus_uevent,
189 .match = dax_bus_match,
190 .probe = dax_bus_probe,
191 .remove = dax_bus_remove,
192 .drv_groups = dax_drv_groups,
193};
194
195static int dax_bus_match(struct device *dev, struct device_driver *drv)
196{
197 struct dax_device_driver *dax_drv = to_dax_drv(drv);
198
199 /*
200 * All but the 'device-dax' driver, which has 'match_always'
201 * set, requires an exact id match.
202 */
203 if (dax_drv->match_always)
204 return 1;
205
206 return dax_match_id(dax_drv, dev);
207}
208
209/*
210 * Rely on the fact that drvdata is set before the attributes are
211 * registered, and that the attributes are unregistered before drvdata
212 * is cleared to assume that drvdata is always valid.
213 */
214static ssize_t id_show(struct device *dev,
215 struct device_attribute *attr, char *buf)
216{
217 struct dax_region *dax_region = dev_get_drvdata(dev);
218
219 return sprintf(buf, "%d\n", dax_region->id);
220}
221static DEVICE_ATTR_RO(id);
222
223static ssize_t region_size_show(struct device *dev,
224 struct device_attribute *attr, char *buf)
225{
226 struct dax_region *dax_region = dev_get_drvdata(dev);
227
228 return sprintf(buf, "%llu\n", (unsigned long long)
229 resource_size(&dax_region->res));
230}
231static struct device_attribute dev_attr_region_size = __ATTR(size, 0444,
232 region_size_show, NULL);
233
234static ssize_t region_align_show(struct device *dev,
235 struct device_attribute *attr, char *buf)
236{
237 struct dax_region *dax_region = dev_get_drvdata(dev);
238
239 return sprintf(buf, "%u\n", dax_region->align);
240}
241static struct device_attribute dev_attr_region_align =
242 __ATTR(align, 0400, region_align_show, NULL);
243
244#define for_each_dax_region_resource(dax_region, res) \
245 for (res = (dax_region)->res.child; res; res = res->sibling)
246
247static unsigned long long dax_region_avail_size(struct dax_region *dax_region)
248{
249 resource_size_t size = resource_size(&dax_region->res);
250 struct resource *res;
251
252 device_lock_assert(dax_region->dev);
253
254 for_each_dax_region_resource(dax_region, res)
255 size -= resource_size(res);
256 return size;
257}
258
259static ssize_t available_size_show(struct device *dev,
260 struct device_attribute *attr, char *buf)
261{
262 struct dax_region *dax_region = dev_get_drvdata(dev);
263 unsigned long long size;
264
265 device_lock(dev);
266 size = dax_region_avail_size(dax_region);
267 device_unlock(dev);
268
269 return sprintf(buf, "%llu\n", size);
270}
271static DEVICE_ATTR_RO(available_size);
272
273static ssize_t seed_show(struct device *dev,
274 struct device_attribute *attr, char *buf)
275{
276 struct dax_region *dax_region = dev_get_drvdata(dev);
277 struct device *seed;
278 ssize_t rc;
279
280 if (is_static(dax_region))
281 return -EINVAL;
282
283 device_lock(dev);
284 seed = dax_region->seed;
285 rc = sprintf(buf, "%s\n", seed ? dev_name(seed) : "");
286 device_unlock(dev);
287
288 return rc;
289}
290static DEVICE_ATTR_RO(seed);
291
292static ssize_t create_show(struct device *dev,
293 struct device_attribute *attr, char *buf)
294{
295 struct dax_region *dax_region = dev_get_drvdata(dev);
296 struct device *youngest;
297 ssize_t rc;
298
299 if (is_static(dax_region))
300 return -EINVAL;
301
302 device_lock(dev);
303 youngest = dax_region->youngest;
304 rc = sprintf(buf, "%s\n", youngest ? dev_name(youngest) : "");
305 device_unlock(dev);
306
307 return rc;
308}
309
310static ssize_t create_store(struct device *dev, struct device_attribute *attr,
311 const char *buf, size_t len)
312{
313 struct dax_region *dax_region = dev_get_drvdata(dev);
314 unsigned long long avail;
315 ssize_t rc;
316 int val;
317
318 if (is_static(dax_region))
319 return -EINVAL;
320
321 rc = kstrtoint(buf, 0, &val);
322 if (rc)
323 return rc;
324 if (val != 1)
325 return -EINVAL;
326
327 device_lock(dev);
328 avail = dax_region_avail_size(dax_region);
329 if (avail == 0)
330 rc = -ENOSPC;
331 else {
332 struct dev_dax_data data = {
333 .dax_region = dax_region,
334 .size = 0,
335 .id = -1,
336 };
337 struct dev_dax *dev_dax = devm_create_dev_dax(&data);
338
339 if (IS_ERR(dev_dax))
340 rc = PTR_ERR(dev_dax);
341 else {
342 /*
343 * In support of crafting multiple new devices
344 * simultaneously multiple seeds can be created,
345 * but only the first one that has not been
346 * successfully bound is tracked as the region
347 * seed.
348 */
349 if (!dax_region->seed)
350 dax_region->seed = &dev_dax->dev;
351 dax_region->youngest = &dev_dax->dev;
352 rc = len;
353 }
354 }
355 device_unlock(dev);
356
357 return rc;
358}
359static DEVICE_ATTR_RW(create);
360
361void kill_dev_dax(struct dev_dax *dev_dax)
362{
363 struct dax_device *dax_dev = dev_dax->dax_dev;
364 struct inode *inode = dax_inode(dax_dev);
365
366 kill_dax(dax_dev);
367 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
368}
369EXPORT_SYMBOL_GPL(kill_dev_dax);
370
371static void trim_dev_dax_range(struct dev_dax *dev_dax)
372{
373 int i = dev_dax->nr_range - 1;
374 struct range *range = &dev_dax->ranges[i].range;
375 struct dax_region *dax_region = dev_dax->region;
376
377 device_lock_assert(dax_region->dev);
378 dev_dbg(&dev_dax->dev, "delete range[%d]: %#llx:%#llx\n", i,
379 (unsigned long long)range->start,
380 (unsigned long long)range->end);
381
382 __release_region(&dax_region->res, range->start, range_len(range));
383 if (--dev_dax->nr_range == 0) {
384 kfree(dev_dax->ranges);
385 dev_dax->ranges = NULL;
386 }
387}
388
389static void free_dev_dax_ranges(struct dev_dax *dev_dax)
390{
391 while (dev_dax->nr_range)
392 trim_dev_dax_range(dev_dax);
393}
394
395static void unregister_dev_dax(void *dev)
396{
397 struct dev_dax *dev_dax = to_dev_dax(dev);
398
399 dev_dbg(dev, "%s\n", __func__);
400
401 kill_dev_dax(dev_dax);
402 free_dev_dax_ranges(dev_dax);
403 device_del(dev);
404 put_device(dev);
405}
406
407/* a return value >= 0 indicates this invocation invalidated the id */
408static int __free_dev_dax_id(struct dev_dax *dev_dax)
409{
410 struct dax_region *dax_region = dev_dax->region;
411 struct device *dev = &dev_dax->dev;
412 int rc = dev_dax->id;
413
414 device_lock_assert(dev);
415
416 if (is_static(dax_region) || dev_dax->id < 0)
417 return -1;
418 ida_free(&dax_region->ida, dev_dax->id);
419 dev_dax->id = -1;
420 return rc;
421}
422
423static int free_dev_dax_id(struct dev_dax *dev_dax)
424{
425 struct device *dev = &dev_dax->dev;
426 int rc;
427
428 device_lock(dev);
429 rc = __free_dev_dax_id(dev_dax);
430 device_unlock(dev);
431 return rc;
432}
433
434static ssize_t delete_store(struct device *dev, struct device_attribute *attr,
435 const char *buf, size_t len)
436{
437 struct dax_region *dax_region = dev_get_drvdata(dev);
438 struct dev_dax *dev_dax;
439 struct device *victim;
440 bool do_del = false;
441 int rc;
442
443 if (is_static(dax_region))
444 return -EINVAL;
445
446 victim = device_find_child_by_name(dax_region->dev, buf);
447 if (!victim)
448 return -ENXIO;
449
450 device_lock(dev);
451 device_lock(victim);
452 dev_dax = to_dev_dax(victim);
453 if (victim->driver || dev_dax_size(dev_dax))
454 rc = -EBUSY;
455 else {
456 /*
457 * Invalidate the device so it does not become active
458 * again, but always preserve device-id-0 so that
459 * /sys/bus/dax/ is guaranteed to be populated while any
460 * dax_region is registered.
461 */
462 if (dev_dax->id > 0) {
463 do_del = __free_dev_dax_id(dev_dax) >= 0;
464 rc = len;
465 if (dax_region->seed == victim)
466 dax_region->seed = NULL;
467 if (dax_region->youngest == victim)
468 dax_region->youngest = NULL;
469 } else
470 rc = -EBUSY;
471 }
472 device_unlock(victim);
473
474 /* won the race to invalidate the device, clean it up */
475 if (do_del)
476 devm_release_action(dev, unregister_dev_dax, victim);
477 device_unlock(dev);
478 put_device(victim);
479
480 return rc;
481}
482static DEVICE_ATTR_WO(delete);
483
484static umode_t dax_region_visible(struct kobject *kobj, struct attribute *a,
485 int n)
486{
487 struct device *dev = container_of(kobj, struct device, kobj);
488 struct dax_region *dax_region = dev_get_drvdata(dev);
489
490 if (is_static(dax_region))
491 if (a == &dev_attr_available_size.attr
492 || a == &dev_attr_create.attr
493 || a == &dev_attr_seed.attr
494 || a == &dev_attr_delete.attr)
495 return 0;
496 return a->mode;
497}
498
499static struct attribute *dax_region_attributes[] = {
500 &dev_attr_available_size.attr,
501 &dev_attr_region_size.attr,
502 &dev_attr_region_align.attr,
503 &dev_attr_create.attr,
504 &dev_attr_seed.attr,
505 &dev_attr_delete.attr,
506 &dev_attr_id.attr,
507 NULL,
508};
509
510static const struct attribute_group dax_region_attribute_group = {
511 .name = "dax_region",
512 .attrs = dax_region_attributes,
513 .is_visible = dax_region_visible,
514};
515
516static const struct attribute_group *dax_region_attribute_groups[] = {
517 &dax_region_attribute_group,
518 NULL,
519};
520
521static void dax_region_free(struct kref *kref)
522{
523 struct dax_region *dax_region;
524
525 dax_region = container_of(kref, struct dax_region, kref);
526 kfree(dax_region);
527}
528
529void dax_region_put(struct dax_region *dax_region)
530{
531 kref_put(&dax_region->kref, dax_region_free);
532}
533EXPORT_SYMBOL_GPL(dax_region_put);
534
535static void dax_region_unregister(void *region)
536{
537 struct dax_region *dax_region = region;
538
539 sysfs_remove_groups(&dax_region->dev->kobj,
540 dax_region_attribute_groups);
541 dax_region_put(dax_region);
542}
543
544struct dax_region *alloc_dax_region(struct device *parent, int region_id,
545 struct range *range, int target_node, unsigned int align,
546 unsigned long flags)
547{
548 struct dax_region *dax_region;
549
550 /*
551 * The DAX core assumes that it can store its private data in
552 * parent->driver_data. This WARN is a reminder / safeguard for
553 * developers of device-dax drivers.
554 */
555 if (dev_get_drvdata(parent)) {
556 dev_WARN(parent, "dax core failed to setup private data\n");
557 return NULL;
558 }
559
560 if (!IS_ALIGNED(range->start, align)
561 || !IS_ALIGNED(range_len(range), align))
562 return NULL;
563
564 dax_region = kzalloc(sizeof(*dax_region), GFP_KERNEL);
565 if (!dax_region)
566 return NULL;
567
568 dev_set_drvdata(parent, dax_region);
569 kref_init(&dax_region->kref);
570 dax_region->id = region_id;
571 dax_region->align = align;
572 dax_region->dev = parent;
573 dax_region->target_node = target_node;
574 ida_init(&dax_region->ida);
575 dax_region->res = (struct resource) {
576 .start = range->start,
577 .end = range->end,
578 .flags = IORESOURCE_MEM | flags,
579 };
580
581 if (sysfs_create_groups(&parent->kobj, dax_region_attribute_groups)) {
582 kfree(dax_region);
583 return NULL;
584 }
585
586 kref_get(&dax_region->kref);
587 if (devm_add_action_or_reset(parent, dax_region_unregister, dax_region))
588 return NULL;
589 return dax_region;
590}
591EXPORT_SYMBOL_GPL(alloc_dax_region);
592
593static void dax_mapping_release(struct device *dev)
594{
595 struct dax_mapping *mapping = to_dax_mapping(dev);
596 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
597
598 ida_free(&dev_dax->ida, mapping->id);
599 kfree(mapping);
600}
601
602static void unregister_dax_mapping(void *data)
603{
604 struct device *dev = data;
605 struct dax_mapping *mapping = to_dax_mapping(dev);
606 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
607 struct dax_region *dax_region = dev_dax->region;
608
609 dev_dbg(dev, "%s\n", __func__);
610
611 device_lock_assert(dax_region->dev);
612
613 dev_dax->ranges[mapping->range_id].mapping = NULL;
614 mapping->range_id = -1;
615
616 device_del(dev);
617 put_device(dev);
618}
619
620static struct dev_dax_range *get_dax_range(struct device *dev)
621{
622 struct dax_mapping *mapping = to_dax_mapping(dev);
623 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
624 struct dax_region *dax_region = dev_dax->region;
625
626 device_lock(dax_region->dev);
627 if (mapping->range_id < 0) {
628 device_unlock(dax_region->dev);
629 return NULL;
630 }
631
632 return &dev_dax->ranges[mapping->range_id];
633}
634
635static void put_dax_range(struct dev_dax_range *dax_range)
636{
637 struct dax_mapping *mapping = dax_range->mapping;
638 struct dev_dax *dev_dax = to_dev_dax(mapping->dev.parent);
639 struct dax_region *dax_region = dev_dax->region;
640
641 device_unlock(dax_region->dev);
642}
643
644static ssize_t start_show(struct device *dev,
645 struct device_attribute *attr, char *buf)
646{
647 struct dev_dax_range *dax_range;
648 ssize_t rc;
649
650 dax_range = get_dax_range(dev);
651 if (!dax_range)
652 return -ENXIO;
653 rc = sprintf(buf, "%#llx\n", dax_range->range.start);
654 put_dax_range(dax_range);
655
656 return rc;
657}
658static DEVICE_ATTR(start, 0400, start_show, NULL);
659
660static ssize_t end_show(struct device *dev,
661 struct device_attribute *attr, char *buf)
662{
663 struct dev_dax_range *dax_range;
664 ssize_t rc;
665
666 dax_range = get_dax_range(dev);
667 if (!dax_range)
668 return -ENXIO;
669 rc = sprintf(buf, "%#llx\n", dax_range->range.end);
670 put_dax_range(dax_range);
671
672 return rc;
673}
674static DEVICE_ATTR(end, 0400, end_show, NULL);
675
676static ssize_t pgoff_show(struct device *dev,
677 struct device_attribute *attr, char *buf)
678{
679 struct dev_dax_range *dax_range;
680 ssize_t rc;
681
682 dax_range = get_dax_range(dev);
683 if (!dax_range)
684 return -ENXIO;
685 rc = sprintf(buf, "%#lx\n", dax_range->pgoff);
686 put_dax_range(dax_range);
687
688 return rc;
689}
690static DEVICE_ATTR(page_offset, 0400, pgoff_show, NULL);
691
692static struct attribute *dax_mapping_attributes[] = {
693 &dev_attr_start.attr,
694 &dev_attr_end.attr,
695 &dev_attr_page_offset.attr,
696 NULL,
697};
698
699static const struct attribute_group dax_mapping_attribute_group = {
700 .attrs = dax_mapping_attributes,
701};
702
703static const struct attribute_group *dax_mapping_attribute_groups[] = {
704 &dax_mapping_attribute_group,
705 NULL,
706};
707
708static struct device_type dax_mapping_type = {
709 .release = dax_mapping_release,
710 .groups = dax_mapping_attribute_groups,
711};
712
713static int devm_register_dax_mapping(struct dev_dax *dev_dax, int range_id)
714{
715 struct dax_region *dax_region = dev_dax->region;
716 struct dax_mapping *mapping;
717 struct device *dev;
718 int rc;
719
720 device_lock_assert(dax_region->dev);
721
722 if (dev_WARN_ONCE(&dev_dax->dev, !dax_region->dev->driver,
723 "region disabled\n"))
724 return -ENXIO;
725
726 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
727 if (!mapping)
728 return -ENOMEM;
729 mapping->range_id = range_id;
730 mapping->id = ida_alloc(&dev_dax->ida, GFP_KERNEL);
731 if (mapping->id < 0) {
732 kfree(mapping);
733 return -ENOMEM;
734 }
735 dev_dax->ranges[range_id].mapping = mapping;
736 dev = &mapping->dev;
737 device_initialize(dev);
738 dev->parent = &dev_dax->dev;
739 dev->type = &dax_mapping_type;
740 dev_set_name(dev, "mapping%d", mapping->id);
741 rc = device_add(dev);
742 if (rc) {
743 put_device(dev);
744 return rc;
745 }
746
747 rc = devm_add_action_or_reset(dax_region->dev, unregister_dax_mapping,
748 dev);
749 if (rc)
750 return rc;
751 return 0;
752}
753
754static int alloc_dev_dax_range(struct dev_dax *dev_dax, u64 start,
755 resource_size_t size)
756{
757 struct dax_region *dax_region = dev_dax->region;
758 struct resource *res = &dax_region->res;
759 struct device *dev = &dev_dax->dev;
760 struct dev_dax_range *ranges;
761 unsigned long pgoff = 0;
762 struct resource *alloc;
763 int i, rc;
764
765 device_lock_assert(dax_region->dev);
766
767 /* handle the seed alloc special case */
768 if (!size) {
769 if (dev_WARN_ONCE(dev, dev_dax->nr_range,
770 "0-size allocation must be first\n"))
771 return -EBUSY;
772 /* nr_range == 0 is elsewhere special cased as 0-size device */
773 return 0;
774 }
775
776 alloc = __request_region(res, start, size, dev_name(dev), 0);
777 if (!alloc)
778 return -ENOMEM;
779
780 ranges = krealloc(dev_dax->ranges, sizeof(*ranges)
781 * (dev_dax->nr_range + 1), GFP_KERNEL);
782 if (!ranges) {
783 __release_region(res, alloc->start, resource_size(alloc));
784 return -ENOMEM;
785 }
786
787 for (i = 0; i < dev_dax->nr_range; i++)
788 pgoff += PHYS_PFN(range_len(&ranges[i].range));
789 dev_dax->ranges = ranges;
790 ranges[dev_dax->nr_range++] = (struct dev_dax_range) {
791 .pgoff = pgoff,
792 .range = {
793 .start = alloc->start,
794 .end = alloc->end,
795 },
796 };
797
798 dev_dbg(dev, "alloc range[%d]: %pa:%pa\n", dev_dax->nr_range - 1,
799 &alloc->start, &alloc->end);
800 /*
801 * A dev_dax instance must be registered before mapping device
802 * children can be added. Defer to devm_create_dev_dax() to add
803 * the initial mapping device.
804 */
805 if (!device_is_registered(&dev_dax->dev))
806 return 0;
807
808 rc = devm_register_dax_mapping(dev_dax, dev_dax->nr_range - 1);
809 if (rc)
810 trim_dev_dax_range(dev_dax);
811
812 return rc;
813}
814
815static int adjust_dev_dax_range(struct dev_dax *dev_dax, struct resource *res, resource_size_t size)
816{
817 int last_range = dev_dax->nr_range - 1;
818 struct dev_dax_range *dax_range = &dev_dax->ranges[last_range];
819 struct dax_region *dax_region = dev_dax->region;
820 bool is_shrink = resource_size(res) > size;
821 struct range *range = &dax_range->range;
822 struct device *dev = &dev_dax->dev;
823 int rc;
824
825 device_lock_assert(dax_region->dev);
826
827 if (dev_WARN_ONCE(dev, !size, "deletion is handled by dev_dax_shrink\n"))
828 return -EINVAL;
829
830 rc = adjust_resource(res, range->start, size);
831 if (rc)
832 return rc;
833
834 *range = (struct range) {
835 .start = range->start,
836 .end = range->start + size - 1,
837 };
838
839 dev_dbg(dev, "%s range[%d]: %#llx:%#llx\n", is_shrink ? "shrink" : "extend",
840 last_range, (unsigned long long) range->start,
841 (unsigned long long) range->end);
842
843 return 0;
844}
845
846static ssize_t size_show(struct device *dev,
847 struct device_attribute *attr, char *buf)
848{
849 struct dev_dax *dev_dax = to_dev_dax(dev);
850 unsigned long long size;
851
852 device_lock(dev);
853 size = dev_dax_size(dev_dax);
854 device_unlock(dev);
855
856 return sprintf(buf, "%llu\n", size);
857}
858
859static bool alloc_is_aligned(struct dev_dax *dev_dax, resource_size_t size)
860{
861 /*
862 * The minimum mapping granularity for a device instance is a
863 * single subsection, unless the arch says otherwise.
864 */
865 return IS_ALIGNED(size, max_t(unsigned long, dev_dax->align, memremap_compat_align()));
866}
867
868static int dev_dax_shrink(struct dev_dax *dev_dax, resource_size_t size)
869{
870 resource_size_t to_shrink = dev_dax_size(dev_dax) - size;
871 struct dax_region *dax_region = dev_dax->region;
872 struct device *dev = &dev_dax->dev;
873 int i;
874
875 for (i = dev_dax->nr_range - 1; i >= 0; i--) {
876 struct range *range = &dev_dax->ranges[i].range;
877 struct dax_mapping *mapping = dev_dax->ranges[i].mapping;
878 struct resource *adjust = NULL, *res;
879 resource_size_t shrink;
880
881 shrink = min_t(u64, to_shrink, range_len(range));
882 if (shrink >= range_len(range)) {
883 devm_release_action(dax_region->dev,
884 unregister_dax_mapping, &mapping->dev);
885 trim_dev_dax_range(dev_dax);
886 to_shrink -= shrink;
887 if (!to_shrink)
888 break;
889 continue;
890 }
891
892 for_each_dax_region_resource(dax_region, res)
893 if (strcmp(res->name, dev_name(dev)) == 0
894 && res->start == range->start) {
895 adjust = res;
896 break;
897 }
898
899 if (dev_WARN_ONCE(dev, !adjust || i != dev_dax->nr_range - 1,
900 "failed to find matching resource\n"))
901 return -ENXIO;
902 return adjust_dev_dax_range(dev_dax, adjust, range_len(range)
903 - shrink);
904 }
905 return 0;
906}
907
908/*
909 * Only allow adjustments that preserve the relative pgoff of existing
910 * allocations. I.e. the dev_dax->ranges array is ordered by increasing pgoff.
911 */
912static bool adjust_ok(struct dev_dax *dev_dax, struct resource *res)
913{
914 struct dev_dax_range *last;
915 int i;
916
917 if (dev_dax->nr_range == 0)
918 return false;
919 if (strcmp(res->name, dev_name(&dev_dax->dev)) != 0)
920 return false;
921 last = &dev_dax->ranges[dev_dax->nr_range - 1];
922 if (last->range.start != res->start || last->range.end != res->end)
923 return false;
924 for (i = 0; i < dev_dax->nr_range - 1; i++) {
925 struct dev_dax_range *dax_range = &dev_dax->ranges[i];
926
927 if (dax_range->pgoff > last->pgoff)
928 return false;
929 }
930
931 return true;
932}
933
934static ssize_t dev_dax_resize(struct dax_region *dax_region,
935 struct dev_dax *dev_dax, resource_size_t size)
936{
937 resource_size_t avail = dax_region_avail_size(dax_region), to_alloc;
938 resource_size_t dev_size = dev_dax_size(dev_dax);
939 struct resource *region_res = &dax_region->res;
940 struct device *dev = &dev_dax->dev;
941 struct resource *res, *first;
942 resource_size_t alloc = 0;
943 int rc;
944
945 if (dev->driver)
946 return -EBUSY;
947 if (size == dev_size)
948 return 0;
949 if (size > dev_size && size - dev_size > avail)
950 return -ENOSPC;
951 if (size < dev_size)
952 return dev_dax_shrink(dev_dax, size);
953
954 to_alloc = size - dev_size;
955 if (dev_WARN_ONCE(dev, !alloc_is_aligned(dev_dax, to_alloc),
956 "resize of %pa misaligned\n", &to_alloc))
957 return -ENXIO;
958
959 /*
960 * Expand the device into the unused portion of the region. This
961 * may involve adjusting the end of an existing resource, or
962 * allocating a new resource.
963 */
964retry:
965 first = region_res->child;
966 if (!first)
967 return alloc_dev_dax_range(dev_dax, dax_region->res.start, to_alloc);
968
969 rc = -ENOSPC;
970 for (res = first; res; res = res->sibling) {
971 struct resource *next = res->sibling;
972
973 /* space at the beginning of the region */
974 if (res == first && res->start > dax_region->res.start) {
975 alloc = min(res->start - dax_region->res.start, to_alloc);
976 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, alloc);
977 break;
978 }
979
980 alloc = 0;
981 /* space between allocations */
982 if (next && next->start > res->end + 1)
983 alloc = min(next->start - (res->end + 1), to_alloc);
984
985 /* space at the end of the region */
986 if (!alloc && !next && res->end < region_res->end)
987 alloc = min(region_res->end - res->end, to_alloc);
988
989 if (!alloc)
990 continue;
991
992 if (adjust_ok(dev_dax, res)) {
993 rc = adjust_dev_dax_range(dev_dax, res, resource_size(res) + alloc);
994 break;
995 }
996 rc = alloc_dev_dax_range(dev_dax, res->end + 1, alloc);
997 break;
998 }
999 if (rc)
1000 return rc;
1001 to_alloc -= alloc;
1002 if (to_alloc)
1003 goto retry;
1004 return 0;
1005}
1006
1007static ssize_t size_store(struct device *dev, struct device_attribute *attr,
1008 const char *buf, size_t len)
1009{
1010 ssize_t rc;
1011 unsigned long long val;
1012 struct dev_dax *dev_dax = to_dev_dax(dev);
1013 struct dax_region *dax_region = dev_dax->region;
1014
1015 rc = kstrtoull(buf, 0, &val);
1016 if (rc)
1017 return rc;
1018
1019 if (!alloc_is_aligned(dev_dax, val)) {
1020 dev_dbg(dev, "%s: size: %lld misaligned\n", __func__, val);
1021 return -EINVAL;
1022 }
1023
1024 device_lock(dax_region->dev);
1025 if (!dax_region->dev->driver) {
1026 device_unlock(dax_region->dev);
1027 return -ENXIO;
1028 }
1029 device_lock(dev);
1030 rc = dev_dax_resize(dax_region, dev_dax, val);
1031 device_unlock(dev);
1032 device_unlock(dax_region->dev);
1033
1034 return rc == 0 ? len : rc;
1035}
1036static DEVICE_ATTR_RW(size);
1037
1038static ssize_t range_parse(const char *opt, size_t len, struct range *range)
1039{
1040 unsigned long long addr = 0;
1041 char *start, *end, *str;
1042 ssize_t rc = -EINVAL;
1043
1044 str = kstrdup(opt, GFP_KERNEL);
1045 if (!str)
1046 return rc;
1047
1048 end = str;
1049 start = strsep(&end, "-");
1050 if (!start || !end)
1051 goto err;
1052
1053 rc = kstrtoull(start, 16, &addr);
1054 if (rc)
1055 goto err;
1056 range->start = addr;
1057
1058 rc = kstrtoull(end, 16, &addr);
1059 if (rc)
1060 goto err;
1061 range->end = addr;
1062
1063err:
1064 kfree(str);
1065 return rc;
1066}
1067
1068static ssize_t mapping_store(struct device *dev, struct device_attribute *attr,
1069 const char *buf, size_t len)
1070{
1071 struct dev_dax *dev_dax = to_dev_dax(dev);
1072 struct dax_region *dax_region = dev_dax->region;
1073 size_t to_alloc;
1074 struct range r;
1075 ssize_t rc;
1076
1077 rc = range_parse(buf, len, &r);
1078 if (rc)
1079 return rc;
1080
1081 rc = -ENXIO;
1082 device_lock(dax_region->dev);
1083 if (!dax_region->dev->driver) {
1084 device_unlock(dax_region->dev);
1085 return rc;
1086 }
1087 device_lock(dev);
1088
1089 to_alloc = range_len(&r);
1090 if (alloc_is_aligned(dev_dax, to_alloc))
1091 rc = alloc_dev_dax_range(dev_dax, r.start, to_alloc);
1092 device_unlock(dev);
1093 device_unlock(dax_region->dev);
1094
1095 return rc == 0 ? len : rc;
1096}
1097static DEVICE_ATTR_WO(mapping);
1098
1099static ssize_t align_show(struct device *dev,
1100 struct device_attribute *attr, char *buf)
1101{
1102 struct dev_dax *dev_dax = to_dev_dax(dev);
1103
1104 return sprintf(buf, "%d\n", dev_dax->align);
1105}
1106
1107static ssize_t dev_dax_validate_align(struct dev_dax *dev_dax)
1108{
1109 struct device *dev = &dev_dax->dev;
1110 int i;
1111
1112 for (i = 0; i < dev_dax->nr_range; i++) {
1113 size_t len = range_len(&dev_dax->ranges[i].range);
1114
1115 if (!alloc_is_aligned(dev_dax, len)) {
1116 dev_dbg(dev, "%s: align %u invalid for range %d\n",
1117 __func__, dev_dax->align, i);
1118 return -EINVAL;
1119 }
1120 }
1121
1122 return 0;
1123}
1124
1125static ssize_t align_store(struct device *dev, struct device_attribute *attr,
1126 const char *buf, size_t len)
1127{
1128 struct dev_dax *dev_dax = to_dev_dax(dev);
1129 struct dax_region *dax_region = dev_dax->region;
1130 unsigned long val, align_save;
1131 ssize_t rc;
1132
1133 rc = kstrtoul(buf, 0, &val);
1134 if (rc)
1135 return -ENXIO;
1136
1137 if (!dax_align_valid(val))
1138 return -EINVAL;
1139
1140 device_lock(dax_region->dev);
1141 if (!dax_region->dev->driver) {
1142 device_unlock(dax_region->dev);
1143 return -ENXIO;
1144 }
1145
1146 device_lock(dev);
1147 if (dev->driver) {
1148 rc = -EBUSY;
1149 goto out_unlock;
1150 }
1151
1152 align_save = dev_dax->align;
1153 dev_dax->align = val;
1154 rc = dev_dax_validate_align(dev_dax);
1155 if (rc)
1156 dev_dax->align = align_save;
1157out_unlock:
1158 device_unlock(dev);
1159 device_unlock(dax_region->dev);
1160 return rc == 0 ? len : rc;
1161}
1162static DEVICE_ATTR_RW(align);
1163
1164static int dev_dax_target_node(struct dev_dax *dev_dax)
1165{
1166 struct dax_region *dax_region = dev_dax->region;
1167
1168 return dax_region->target_node;
1169}
1170
1171static ssize_t target_node_show(struct device *dev,
1172 struct device_attribute *attr, char *buf)
1173{
1174 struct dev_dax *dev_dax = to_dev_dax(dev);
1175
1176 return sprintf(buf, "%d\n", dev_dax_target_node(dev_dax));
1177}
1178static DEVICE_ATTR_RO(target_node);
1179
1180static ssize_t resource_show(struct device *dev,
1181 struct device_attribute *attr, char *buf)
1182{
1183 struct dev_dax *dev_dax = to_dev_dax(dev);
1184 struct dax_region *dax_region = dev_dax->region;
1185 unsigned long long start;
1186
1187 if (dev_dax->nr_range < 1)
1188 start = dax_region->res.start;
1189 else
1190 start = dev_dax->ranges[0].range.start;
1191
1192 return sprintf(buf, "%#llx\n", start);
1193}
1194static DEVICE_ATTR(resource, 0400, resource_show, NULL);
1195
1196static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
1197 char *buf)
1198{
1199 /*
1200 * We only ever expect to handle device-dax instances, i.e. the
1201 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
1202 */
1203 return sprintf(buf, DAX_DEVICE_MODALIAS_FMT "\n", 0);
1204}
1205static DEVICE_ATTR_RO(modalias);
1206
1207static ssize_t numa_node_show(struct device *dev,
1208 struct device_attribute *attr, char *buf)
1209{
1210 return sprintf(buf, "%d\n", dev_to_node(dev));
1211}
1212static DEVICE_ATTR_RO(numa_node);
1213
1214static umode_t dev_dax_visible(struct kobject *kobj, struct attribute *a, int n)
1215{
1216 struct device *dev = container_of(kobj, struct device, kobj);
1217 struct dev_dax *dev_dax = to_dev_dax(dev);
1218 struct dax_region *dax_region = dev_dax->region;
1219
1220 if (a == &dev_attr_target_node.attr && dev_dax_target_node(dev_dax) < 0)
1221 return 0;
1222 if (a == &dev_attr_numa_node.attr && !IS_ENABLED(CONFIG_NUMA))
1223 return 0;
1224 if (a == &dev_attr_mapping.attr && is_static(dax_region))
1225 return 0;
1226 if ((a == &dev_attr_align.attr ||
1227 a == &dev_attr_size.attr) && is_static(dax_region))
1228 return 0444;
1229 return a->mode;
1230}
1231
1232static struct attribute *dev_dax_attributes[] = {
1233 &dev_attr_modalias.attr,
1234 &dev_attr_size.attr,
1235 &dev_attr_mapping.attr,
1236 &dev_attr_target_node.attr,
1237 &dev_attr_align.attr,
1238 &dev_attr_resource.attr,
1239 &dev_attr_numa_node.attr,
1240 NULL,
1241};
1242
1243static const struct attribute_group dev_dax_attribute_group = {
1244 .attrs = dev_dax_attributes,
1245 .is_visible = dev_dax_visible,
1246};
1247
1248static const struct attribute_group *dax_attribute_groups[] = {
1249 &dev_dax_attribute_group,
1250 NULL,
1251};
1252
1253static void dev_dax_release(struct device *dev)
1254{
1255 struct dev_dax *dev_dax = to_dev_dax(dev);
1256 struct dax_region *dax_region = dev_dax->region;
1257 struct dax_device *dax_dev = dev_dax->dax_dev;
1258
1259 put_dax(dax_dev);
1260 free_dev_dax_id(dev_dax);
1261 dax_region_put(dax_region);
1262 kfree(dev_dax->pgmap);
1263 kfree(dev_dax);
1264}
1265
1266static const struct device_type dev_dax_type = {
1267 .release = dev_dax_release,
1268 .groups = dax_attribute_groups,
1269};
1270
1271struct dev_dax *devm_create_dev_dax(struct dev_dax_data *data)
1272{
1273 struct dax_region *dax_region = data->dax_region;
1274 struct device *parent = dax_region->dev;
1275 struct dax_device *dax_dev;
1276 struct dev_dax *dev_dax;
1277 struct inode *inode;
1278 struct device *dev;
1279 int rc;
1280
1281 dev_dax = kzalloc(sizeof(*dev_dax), GFP_KERNEL);
1282 if (!dev_dax)
1283 return ERR_PTR(-ENOMEM);
1284
1285 if (is_static(dax_region)) {
1286 if (dev_WARN_ONCE(parent, data->id < 0,
1287 "dynamic id specified to static region\n")) {
1288 rc = -EINVAL;
1289 goto err_id;
1290 }
1291
1292 dev_dax->id = data->id;
1293 } else {
1294 if (dev_WARN_ONCE(parent, data->id >= 0,
1295 "static id specified to dynamic region\n")) {
1296 rc = -EINVAL;
1297 goto err_id;
1298 }
1299
1300 rc = ida_alloc(&dax_region->ida, GFP_KERNEL);
1301 if (rc < 0)
1302 goto err_id;
1303 dev_dax->id = rc;
1304 }
1305
1306 dev_dax->region = dax_region;
1307 dev = &dev_dax->dev;
1308 device_initialize(dev);
1309 dev_set_name(dev, "dax%d.%d", dax_region->id, dev_dax->id);
1310
1311 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, data->size);
1312 if (rc)
1313 goto err_range;
1314
1315 if (data->pgmap) {
1316 dev_WARN_ONCE(parent, !is_static(dax_region),
1317 "custom dev_pagemap requires a static dax_region\n");
1318
1319 dev_dax->pgmap = kmemdup(data->pgmap,
1320 sizeof(struct dev_pagemap), GFP_KERNEL);
1321 if (!dev_dax->pgmap) {
1322 rc = -ENOMEM;
1323 goto err_pgmap;
1324 }
1325 }
1326
1327 /*
1328 * No 'host' or dax_operations since there is no access to this
1329 * device outside of mmap of the resulting character device.
1330 */
1331 dax_dev = alloc_dax(dev_dax, NULL, NULL, DAXDEV_F_SYNC);
1332 if (IS_ERR(dax_dev)) {
1333 rc = PTR_ERR(dax_dev);
1334 goto err_alloc_dax;
1335 }
1336
1337 /* a device_dax instance is dead while the driver is not attached */
1338 kill_dax(dax_dev);
1339
1340 dev_dax->dax_dev = dax_dev;
1341 dev_dax->target_node = dax_region->target_node;
1342 dev_dax->align = dax_region->align;
1343 ida_init(&dev_dax->ida);
1344 kref_get(&dax_region->kref);
1345
1346 inode = dax_inode(dax_dev);
1347 dev->devt = inode->i_rdev;
1348 if (data->subsys == DEV_DAX_BUS)
1349 dev->bus = &dax_bus_type;
1350 else
1351 dev->class = dax_class;
1352 dev->parent = parent;
1353 dev->type = &dev_dax_type;
1354
1355 rc = device_add(dev);
1356 if (rc) {
1357 kill_dev_dax(dev_dax);
1358 put_device(dev);
1359 return ERR_PTR(rc);
1360 }
1361
1362 rc = devm_add_action_or_reset(dax_region->dev, unregister_dev_dax, dev);
1363 if (rc)
1364 return ERR_PTR(rc);
1365
1366 /* register mapping device for the initial allocation range */
1367 if (dev_dax->nr_range && range_len(&dev_dax->ranges[0].range)) {
1368 rc = devm_register_dax_mapping(dev_dax, 0);
1369 if (rc)
1370 return ERR_PTR(rc);
1371 }
1372
1373 return dev_dax;
1374
1375err_alloc_dax:
1376 kfree(dev_dax->pgmap);
1377err_pgmap:
1378 free_dev_dax_ranges(dev_dax);
1379err_range:
1380 free_dev_dax_id(dev_dax);
1381err_id:
1382 kfree(dev_dax);
1383
1384 return ERR_PTR(rc);
1385}
1386EXPORT_SYMBOL_GPL(devm_create_dev_dax);
1387
1388static int match_always_count;
1389
1390int __dax_driver_register(struct dax_device_driver *dax_drv,
1391 struct module *module, const char *mod_name)
1392{
1393 struct device_driver *drv = &dax_drv->drv;
1394 int rc = 0;
1395
1396 /*
1397 * dax_bus_probe() calls dax_drv->probe() unconditionally.
1398 * So better be safe than sorry and ensure it is provided.
1399 */
1400 if (!dax_drv->probe)
1401 return -EINVAL;
1402
1403 INIT_LIST_HEAD(&dax_drv->ids);
1404 drv->owner = module;
1405 drv->name = mod_name;
1406 drv->mod_name = mod_name;
1407 drv->bus = &dax_bus_type;
1408
1409 /* there can only be one default driver */
1410 mutex_lock(&dax_bus_lock);
1411 match_always_count += dax_drv->match_always;
1412 if (match_always_count > 1) {
1413 match_always_count--;
1414 WARN_ON(1);
1415 rc = -EINVAL;
1416 }
1417 mutex_unlock(&dax_bus_lock);
1418 if (rc)
1419 return rc;
1420
1421 rc = driver_register(drv);
1422 if (rc && dax_drv->match_always) {
1423 mutex_lock(&dax_bus_lock);
1424 match_always_count -= dax_drv->match_always;
1425 mutex_unlock(&dax_bus_lock);
1426 }
1427
1428 return rc;
1429}
1430EXPORT_SYMBOL_GPL(__dax_driver_register);
1431
1432void dax_driver_unregister(struct dax_device_driver *dax_drv)
1433{
1434 struct device_driver *drv = &dax_drv->drv;
1435 struct dax_id *dax_id, *_id;
1436
1437 mutex_lock(&dax_bus_lock);
1438 match_always_count -= dax_drv->match_always;
1439 list_for_each_entry_safe(dax_id, _id, &dax_drv->ids, list) {
1440 list_del(&dax_id->list);
1441 kfree(dax_id);
1442 }
1443 mutex_unlock(&dax_bus_lock);
1444 driver_unregister(drv);
1445}
1446EXPORT_SYMBOL_GPL(dax_driver_unregister);
1447
1448int __init dax_bus_init(void)
1449{
1450 int rc;
1451
1452 if (IS_ENABLED(CONFIG_DEV_DAX_PMEM_COMPAT)) {
1453 dax_class = class_create(THIS_MODULE, "dax");
1454 if (IS_ERR(dax_class))
1455 return PTR_ERR(dax_class);
1456 }
1457
1458 rc = bus_register(&dax_bus_type);
1459 if (rc)
1460 class_destroy(dax_class);
1461 return rc;
1462}
1463
1464void __exit dax_bus_exit(void)
1465{
1466 bus_unregister(&dax_bus_type);
1467 class_destroy(dax_class);
1468}