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>
10 #include "dax-private.h"
13 static DEFINE_MUTEX(dax_bus_lock);
15 #define DAX_NAME_LEN 30
17 struct list_head list;
18 char dev_name[DAX_NAME_LEN];
21 static int dax_bus_uevent(const struct device *dev, struct kobj_uevent_env *env)
24 * We only ever expect to handle device-dax instances, i.e. the
25 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
27 return add_uevent_var(env, "MODALIAS=" DAX_DEVICE_MODALIAS_FMT, 0);
30 static struct dax_device_driver *to_dax_drv(struct device_driver *drv)
32 return container_of(drv, struct dax_device_driver, drv);
35 static struct dax_id *__dax_match_id(struct dax_device_driver *dax_drv,
38 struct dax_id *dax_id;
40 lockdep_assert_held(&dax_bus_lock);
42 list_for_each_entry(dax_id, &dax_drv->ids, list)
43 if (sysfs_streq(dax_id->dev_name, dev_name))
48 static int dax_match_id(struct dax_device_driver *dax_drv, struct device *dev)
52 mutex_lock(&dax_bus_lock);
53 match = !!__dax_match_id(dax_drv, dev_name(dev));
54 mutex_unlock(&dax_bus_lock);
59 static int dax_match_type(struct dax_device_driver *dax_drv, struct device *dev)
61 enum dax_driver_type type = DAXDRV_DEVICE_TYPE;
62 struct dev_dax *dev_dax = to_dev_dax(dev);
64 if (dev_dax->region->res.flags & IORESOURCE_DAX_KMEM)
65 type = DAXDRV_KMEM_TYPE;
67 if (dax_drv->type == type)
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))
83 static ssize_t do_id_store(struct device_driver *drv, const char *buf,
84 size_t count, enum id_action action)
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;
93 fields = sscanf(buf, "dax%d.%d", ®ion_id, &id);
96 sprintf(devname, "dax%d.%d", region_id, id);
97 if (!sysfs_streq(buf, devname))
100 mutex_lock(&dax_bus_lock);
101 dax_id = __dax_match_id(dax_drv, buf);
103 if (action == ID_ADD) {
104 dax_id = kzalloc(sizeof(*dax_id), GFP_KERNEL);
106 strscpy(dax_id->dev_name, buf, DAX_NAME_LEN);
107 list_add(&dax_id->list, &dax_drv->ids);
111 } else if (action == ID_REMOVE) {
112 list_del(&dax_id->list);
115 mutex_unlock(&dax_bus_lock);
119 if (action == ID_ADD)
120 rc = driver_attach(drv);
126 static ssize_t new_id_store(struct device_driver *drv, const char *buf,
129 return do_id_store(drv, buf, count, ID_ADD);
131 static DRIVER_ATTR_WO(new_id);
133 static ssize_t remove_id_store(struct device_driver *drv, const char *buf,
136 return do_id_store(drv, buf, count, ID_REMOVE);
138 static DRIVER_ATTR_WO(remove_id);
140 static struct attribute *dax_drv_attrs[] = {
141 &driver_attr_new_id.attr,
142 &driver_attr_remove_id.attr,
145 ATTRIBUTE_GROUPS(dax_drv);
147 static int dax_bus_match(struct device *dev, struct device_driver *drv);
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)
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.
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()).
167 static bool is_static(struct dax_region *dax_region)
169 return (dax_region->res.flags & IORESOURCE_DAX_STATIC) != 0;
172 bool static_dev_dax(struct dev_dax *dev_dax)
174 return is_static(dev_dax->region);
176 EXPORT_SYMBOL_GPL(static_dev_dax);
178 static u64 dev_dax_size(struct dev_dax *dev_dax)
183 device_lock_assert(&dev_dax->dev);
185 for (i = 0; i < dev_dax->nr_range; i++)
186 size += range_len(&dev_dax->ranges[i].range);
191 static int dax_bus_probe(struct device *dev)
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;
198 if (dev_dax_size(dev_dax) == 0 || dev_dax->id < 0)
201 rc = dax_drv->probe(dev_dax);
203 if (rc || is_static(dax_region))
207 * Track new seed creation only after successful probe of the
210 if (dax_region->seed == dev)
211 dax_region->seed = NULL;
216 static void dax_bus_remove(struct device *dev)
218 struct dax_device_driver *dax_drv = to_dax_drv(dev->driver);
219 struct dev_dax *dev_dax = to_dev_dax(dev);
222 dax_drv->remove(dev_dax);
225 static struct bus_type dax_bus_type = {
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,
234 static int dax_bus_match(struct device *dev, struct device_driver *drv)
236 struct dax_device_driver *dax_drv = to_dax_drv(drv);
238 if (dax_match_id(dax_drv, dev))
240 return dax_match_type(dax_drv, dev);
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.
248 static ssize_t id_show(struct device *dev,
249 struct device_attribute *attr, char *buf)
251 struct dax_region *dax_region = dev_get_drvdata(dev);
253 return sprintf(buf, "%d\n", dax_region->id);
255 static DEVICE_ATTR_RO(id);
257 static ssize_t region_size_show(struct device *dev,
258 struct device_attribute *attr, char *buf)
260 struct dax_region *dax_region = dev_get_drvdata(dev);
262 return sprintf(buf, "%llu\n", (unsigned long long)
263 resource_size(&dax_region->res));
265 static struct device_attribute dev_attr_region_size = __ATTR(size, 0444,
266 region_size_show, NULL);
268 static ssize_t region_align_show(struct device *dev,
269 struct device_attribute *attr, char *buf)
271 struct dax_region *dax_region = dev_get_drvdata(dev);
273 return sprintf(buf, "%u\n", dax_region->align);
275 static struct device_attribute dev_attr_region_align =
276 __ATTR(align, 0400, region_align_show, NULL);
278 #define for_each_dax_region_resource(dax_region, res) \
279 for (res = (dax_region)->res.child; res; res = res->sibling)
281 static unsigned long long dax_region_avail_size(struct dax_region *dax_region)
283 resource_size_t size = resource_size(&dax_region->res);
284 struct resource *res;
286 device_lock_assert(dax_region->dev);
288 for_each_dax_region_resource(dax_region, res)
289 size -= resource_size(res);
293 static ssize_t available_size_show(struct device *dev,
294 struct device_attribute *attr, char *buf)
296 struct dax_region *dax_region = dev_get_drvdata(dev);
297 unsigned long long size;
300 size = dax_region_avail_size(dax_region);
303 return sprintf(buf, "%llu\n", size);
305 static DEVICE_ATTR_RO(available_size);
307 static ssize_t seed_show(struct device *dev,
308 struct device_attribute *attr, char *buf)
310 struct dax_region *dax_region = dev_get_drvdata(dev);
314 if (is_static(dax_region))
318 seed = dax_region->seed;
319 rc = sprintf(buf, "%s\n", seed ? dev_name(seed) : "");
324 static DEVICE_ATTR_RO(seed);
326 static ssize_t create_show(struct device *dev,
327 struct device_attribute *attr, char *buf)
329 struct dax_region *dax_region = dev_get_drvdata(dev);
330 struct device *youngest;
333 if (is_static(dax_region))
337 youngest = dax_region->youngest;
338 rc = sprintf(buf, "%s\n", youngest ? dev_name(youngest) : "");
344 static ssize_t create_store(struct device *dev, struct device_attribute *attr,
345 const char *buf, size_t len)
347 struct dax_region *dax_region = dev_get_drvdata(dev);
348 unsigned long long avail;
352 if (is_static(dax_region))
355 rc = kstrtoint(buf, 0, &val);
362 avail = dax_region_avail_size(dax_region);
366 struct dev_dax_data data = {
367 .dax_region = dax_region,
371 struct dev_dax *dev_dax = devm_create_dev_dax(&data);
374 rc = PTR_ERR(dev_dax);
377 * In support of crafting multiple new devices
378 * simultaneously multiple seeds can be created,
379 * but only the first one that has not been
380 * successfully bound is tracked as the region
383 if (!dax_region->seed)
384 dax_region->seed = &dev_dax->dev;
385 dax_region->youngest = &dev_dax->dev;
393 static DEVICE_ATTR_RW(create);
395 void kill_dev_dax(struct dev_dax *dev_dax)
397 struct dax_device *dax_dev = dev_dax->dax_dev;
398 struct inode *inode = dax_inode(dax_dev);
401 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
404 * Dynamic dax region have the pgmap allocated via dev_kzalloc()
405 * and thus freed by devm. Clear the pgmap to not have stale pgmap
406 * ranges on probe() from previous reconfigurations of region devices.
408 if (!static_dev_dax(dev_dax))
409 dev_dax->pgmap = NULL;
411 EXPORT_SYMBOL_GPL(kill_dev_dax);
413 static void trim_dev_dax_range(struct dev_dax *dev_dax)
415 int i = dev_dax->nr_range - 1;
416 struct range *range = &dev_dax->ranges[i].range;
417 struct dax_region *dax_region = dev_dax->region;
419 device_lock_assert(dax_region->dev);
420 dev_dbg(&dev_dax->dev, "delete range[%d]: %#llx:%#llx\n", i,
421 (unsigned long long)range->start,
422 (unsigned long long)range->end);
424 __release_region(&dax_region->res, range->start, range_len(range));
425 if (--dev_dax->nr_range == 0) {
426 kfree(dev_dax->ranges);
427 dev_dax->ranges = NULL;
431 static void free_dev_dax_ranges(struct dev_dax *dev_dax)
433 while (dev_dax->nr_range)
434 trim_dev_dax_range(dev_dax);
437 static void unregister_dev_dax(void *dev)
439 struct dev_dax *dev_dax = to_dev_dax(dev);
441 dev_dbg(dev, "%s\n", __func__);
443 kill_dev_dax(dev_dax);
445 free_dev_dax_ranges(dev_dax);
449 static void dax_region_free(struct kref *kref)
451 struct dax_region *dax_region;
453 dax_region = container_of(kref, struct dax_region, kref);
457 static void dax_region_put(struct dax_region *dax_region)
459 kref_put(&dax_region->kref, dax_region_free);
462 /* a return value >= 0 indicates this invocation invalidated the id */
463 static int __free_dev_dax_id(struct dev_dax *dev_dax)
465 struct device *dev = &dev_dax->dev;
466 struct dax_region *dax_region;
467 int rc = dev_dax->id;
469 device_lock_assert(dev);
471 if (!dev_dax->dyn_id || dev_dax->id < 0)
473 dax_region = dev_dax->region;
474 ida_free(&dax_region->ida, dev_dax->id);
475 dax_region_put(dax_region);
480 static int free_dev_dax_id(struct dev_dax *dev_dax)
482 struct device *dev = &dev_dax->dev;
486 rc = __free_dev_dax_id(dev_dax);
491 static int alloc_dev_dax_id(struct dev_dax *dev_dax)
493 struct dax_region *dax_region = dev_dax->region;
496 id = ida_alloc(&dax_region->ida, GFP_KERNEL);
499 kref_get(&dax_region->kref);
500 dev_dax->dyn_id = true;
505 static ssize_t delete_store(struct device *dev, struct device_attribute *attr,
506 const char *buf, size_t len)
508 struct dax_region *dax_region = dev_get_drvdata(dev);
509 struct dev_dax *dev_dax;
510 struct device *victim;
514 if (is_static(dax_region))
517 victim = device_find_child_by_name(dax_region->dev, buf);
523 dev_dax = to_dev_dax(victim);
524 if (victim->driver || dev_dax_size(dev_dax))
528 * Invalidate the device so it does not become active
529 * again, but always preserve device-id-0 so that
530 * /sys/bus/dax/ is guaranteed to be populated while any
531 * dax_region is registered.
533 if (dev_dax->id > 0) {
534 do_del = __free_dev_dax_id(dev_dax) >= 0;
536 if (dax_region->seed == victim)
537 dax_region->seed = NULL;
538 if (dax_region->youngest == victim)
539 dax_region->youngest = NULL;
543 device_unlock(victim);
545 /* won the race to invalidate the device, clean it up */
547 devm_release_action(dev, unregister_dev_dax, victim);
553 static DEVICE_ATTR_WO(delete);
555 static umode_t dax_region_visible(struct kobject *kobj, struct attribute *a,
558 struct device *dev = container_of(kobj, struct device, kobj);
559 struct dax_region *dax_region = dev_get_drvdata(dev);
561 if (is_static(dax_region))
562 if (a == &dev_attr_available_size.attr
563 || a == &dev_attr_create.attr
564 || a == &dev_attr_seed.attr
565 || a == &dev_attr_delete.attr)
570 static struct attribute *dax_region_attributes[] = {
571 &dev_attr_available_size.attr,
572 &dev_attr_region_size.attr,
573 &dev_attr_region_align.attr,
574 &dev_attr_create.attr,
576 &dev_attr_delete.attr,
581 static const struct attribute_group dax_region_attribute_group = {
582 .name = "dax_region",
583 .attrs = dax_region_attributes,
584 .is_visible = dax_region_visible,
587 static const struct attribute_group *dax_region_attribute_groups[] = {
588 &dax_region_attribute_group,
592 static void dax_region_unregister(void *region)
594 struct dax_region *dax_region = region;
596 sysfs_remove_groups(&dax_region->dev->kobj,
597 dax_region_attribute_groups);
598 dax_region_put(dax_region);
601 struct dax_region *alloc_dax_region(struct device *parent, int region_id,
602 struct range *range, int target_node, unsigned int align,
605 struct dax_region *dax_region;
608 * The DAX core assumes that it can store its private data in
609 * parent->driver_data. This WARN is a reminder / safeguard for
610 * developers of device-dax drivers.
612 if (dev_get_drvdata(parent)) {
613 dev_WARN(parent, "dax core failed to setup private data\n");
617 if (!IS_ALIGNED(range->start, align)
618 || !IS_ALIGNED(range_len(range), align))
621 dax_region = kzalloc(sizeof(*dax_region), GFP_KERNEL);
625 dev_set_drvdata(parent, dax_region);
626 kref_init(&dax_region->kref);
627 dax_region->id = region_id;
628 dax_region->align = align;
629 dax_region->dev = parent;
630 dax_region->target_node = target_node;
631 ida_init(&dax_region->ida);
632 dax_region->res = (struct resource) {
633 .start = range->start,
635 .flags = IORESOURCE_MEM | flags,
638 if (sysfs_create_groups(&parent->kobj, dax_region_attribute_groups)) {
643 if (devm_add_action_or_reset(parent, dax_region_unregister, dax_region))
647 EXPORT_SYMBOL_GPL(alloc_dax_region);
649 static void dax_mapping_release(struct device *dev)
651 struct dax_mapping *mapping = to_dax_mapping(dev);
652 struct device *parent = dev->parent;
653 struct dev_dax *dev_dax = to_dev_dax(parent);
655 ida_free(&dev_dax->ida, mapping->id);
660 static void unregister_dax_mapping(void *data)
662 struct device *dev = data;
663 struct dax_mapping *mapping = to_dax_mapping(dev);
664 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
665 struct dax_region *dax_region = dev_dax->region;
667 dev_dbg(dev, "%s\n", __func__);
669 device_lock_assert(dax_region->dev);
671 dev_dax->ranges[mapping->range_id].mapping = NULL;
672 mapping->range_id = -1;
674 device_unregister(dev);
677 static struct dev_dax_range *get_dax_range(struct device *dev)
679 struct dax_mapping *mapping = to_dax_mapping(dev);
680 struct dev_dax *dev_dax = to_dev_dax(dev->parent);
681 struct dax_region *dax_region = dev_dax->region;
683 device_lock(dax_region->dev);
684 if (mapping->range_id < 0) {
685 device_unlock(dax_region->dev);
689 return &dev_dax->ranges[mapping->range_id];
692 static void put_dax_range(struct dev_dax_range *dax_range)
694 struct dax_mapping *mapping = dax_range->mapping;
695 struct dev_dax *dev_dax = to_dev_dax(mapping->dev.parent);
696 struct dax_region *dax_region = dev_dax->region;
698 device_unlock(dax_region->dev);
701 static ssize_t start_show(struct device *dev,
702 struct device_attribute *attr, char *buf)
704 struct dev_dax_range *dax_range;
707 dax_range = get_dax_range(dev);
710 rc = sprintf(buf, "%#llx\n", dax_range->range.start);
711 put_dax_range(dax_range);
715 static DEVICE_ATTR(start, 0400, start_show, NULL);
717 static ssize_t end_show(struct device *dev,
718 struct device_attribute *attr, char *buf)
720 struct dev_dax_range *dax_range;
723 dax_range = get_dax_range(dev);
726 rc = sprintf(buf, "%#llx\n", dax_range->range.end);
727 put_dax_range(dax_range);
731 static DEVICE_ATTR(end, 0400, end_show, NULL);
733 static ssize_t pgoff_show(struct device *dev,
734 struct device_attribute *attr, char *buf)
736 struct dev_dax_range *dax_range;
739 dax_range = get_dax_range(dev);
742 rc = sprintf(buf, "%#lx\n", dax_range->pgoff);
743 put_dax_range(dax_range);
747 static DEVICE_ATTR(page_offset, 0400, pgoff_show, NULL);
749 static struct attribute *dax_mapping_attributes[] = {
750 &dev_attr_start.attr,
752 &dev_attr_page_offset.attr,
756 static const struct attribute_group dax_mapping_attribute_group = {
757 .attrs = dax_mapping_attributes,
760 static const struct attribute_group *dax_mapping_attribute_groups[] = {
761 &dax_mapping_attribute_group,
765 static struct device_type dax_mapping_type = {
766 .release = dax_mapping_release,
767 .groups = dax_mapping_attribute_groups,
770 static int devm_register_dax_mapping(struct dev_dax *dev_dax, int range_id)
772 struct dax_region *dax_region = dev_dax->region;
773 struct dax_mapping *mapping;
777 device_lock_assert(dax_region->dev);
779 if (dev_WARN_ONCE(&dev_dax->dev, !dax_region->dev->driver,
780 "region disabled\n"))
783 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
786 mapping->range_id = range_id;
787 mapping->id = ida_alloc(&dev_dax->ida, GFP_KERNEL);
788 if (mapping->id < 0) {
792 dev_dax->ranges[range_id].mapping = mapping;
794 device_initialize(dev);
795 dev->parent = &dev_dax->dev;
796 get_device(dev->parent);
797 dev->type = &dax_mapping_type;
798 dev_set_name(dev, "mapping%d", mapping->id);
799 rc = device_add(dev);
805 rc = devm_add_action_or_reset(dax_region->dev, unregister_dax_mapping,
812 static int alloc_dev_dax_range(struct dev_dax *dev_dax, u64 start,
813 resource_size_t size)
815 struct dax_region *dax_region = dev_dax->region;
816 struct resource *res = &dax_region->res;
817 struct device *dev = &dev_dax->dev;
818 struct dev_dax_range *ranges;
819 unsigned long pgoff = 0;
820 struct resource *alloc;
823 device_lock_assert(dax_region->dev);
825 /* handle the seed alloc special case */
827 if (dev_WARN_ONCE(dev, dev_dax->nr_range,
828 "0-size allocation must be first\n"))
830 /* nr_range == 0 is elsewhere special cased as 0-size device */
834 alloc = __request_region(res, start, size, dev_name(dev), 0);
838 ranges = krealloc(dev_dax->ranges, sizeof(*ranges)
839 * (dev_dax->nr_range + 1), GFP_KERNEL);
841 __release_region(res, alloc->start, resource_size(alloc));
845 for (i = 0; i < dev_dax->nr_range; i++)
846 pgoff += PHYS_PFN(range_len(&ranges[i].range));
847 dev_dax->ranges = ranges;
848 ranges[dev_dax->nr_range++] = (struct dev_dax_range) {
851 .start = alloc->start,
856 dev_dbg(dev, "alloc range[%d]: %pa:%pa\n", dev_dax->nr_range - 1,
857 &alloc->start, &alloc->end);
859 * A dev_dax instance must be registered before mapping device
860 * children can be added. Defer to devm_create_dev_dax() to add
861 * the initial mapping device.
863 if (!device_is_registered(&dev_dax->dev))
866 rc = devm_register_dax_mapping(dev_dax, dev_dax->nr_range - 1);
868 trim_dev_dax_range(dev_dax);
873 static int adjust_dev_dax_range(struct dev_dax *dev_dax, struct resource *res, resource_size_t size)
875 int last_range = dev_dax->nr_range - 1;
876 struct dev_dax_range *dax_range = &dev_dax->ranges[last_range];
877 struct dax_region *dax_region = dev_dax->region;
878 bool is_shrink = resource_size(res) > size;
879 struct range *range = &dax_range->range;
880 struct device *dev = &dev_dax->dev;
883 device_lock_assert(dax_region->dev);
885 if (dev_WARN_ONCE(dev, !size, "deletion is handled by dev_dax_shrink\n"))
888 rc = adjust_resource(res, range->start, size);
892 *range = (struct range) {
893 .start = range->start,
894 .end = range->start + size - 1,
897 dev_dbg(dev, "%s range[%d]: %#llx:%#llx\n", is_shrink ? "shrink" : "extend",
898 last_range, (unsigned long long) range->start,
899 (unsigned long long) range->end);
904 static ssize_t size_show(struct device *dev,
905 struct device_attribute *attr, char *buf)
907 struct dev_dax *dev_dax = to_dev_dax(dev);
908 unsigned long long size;
911 size = dev_dax_size(dev_dax);
914 return sprintf(buf, "%llu\n", size);
917 static bool alloc_is_aligned(struct dev_dax *dev_dax, resource_size_t size)
920 * The minimum mapping granularity for a device instance is a
921 * single subsection, unless the arch says otherwise.
923 return IS_ALIGNED(size, max_t(unsigned long, dev_dax->align, memremap_compat_align()));
926 static int dev_dax_shrink(struct dev_dax *dev_dax, resource_size_t size)
928 resource_size_t to_shrink = dev_dax_size(dev_dax) - size;
929 struct dax_region *dax_region = dev_dax->region;
930 struct device *dev = &dev_dax->dev;
933 for (i = dev_dax->nr_range - 1; i >= 0; i--) {
934 struct range *range = &dev_dax->ranges[i].range;
935 struct dax_mapping *mapping = dev_dax->ranges[i].mapping;
936 struct resource *adjust = NULL, *res;
937 resource_size_t shrink;
939 shrink = min_t(u64, to_shrink, range_len(range));
940 if (shrink >= range_len(range)) {
941 devm_release_action(dax_region->dev,
942 unregister_dax_mapping, &mapping->dev);
943 trim_dev_dax_range(dev_dax);
950 for_each_dax_region_resource(dax_region, res)
951 if (strcmp(res->name, dev_name(dev)) == 0
952 && res->start == range->start) {
957 if (dev_WARN_ONCE(dev, !adjust || i != dev_dax->nr_range - 1,
958 "failed to find matching resource\n"))
960 return adjust_dev_dax_range(dev_dax, adjust, range_len(range)
967 * Only allow adjustments that preserve the relative pgoff of existing
968 * allocations. I.e. the dev_dax->ranges array is ordered by increasing pgoff.
970 static bool adjust_ok(struct dev_dax *dev_dax, struct resource *res)
972 struct dev_dax_range *last;
975 if (dev_dax->nr_range == 0)
977 if (strcmp(res->name, dev_name(&dev_dax->dev)) != 0)
979 last = &dev_dax->ranges[dev_dax->nr_range - 1];
980 if (last->range.start != res->start || last->range.end != res->end)
982 for (i = 0; i < dev_dax->nr_range - 1; i++) {
983 struct dev_dax_range *dax_range = &dev_dax->ranges[i];
985 if (dax_range->pgoff > last->pgoff)
992 static ssize_t dev_dax_resize(struct dax_region *dax_region,
993 struct dev_dax *dev_dax, resource_size_t size)
995 resource_size_t avail = dax_region_avail_size(dax_region), to_alloc;
996 resource_size_t dev_size = dev_dax_size(dev_dax);
997 struct resource *region_res = &dax_region->res;
998 struct device *dev = &dev_dax->dev;
999 struct resource *res, *first;
1000 resource_size_t alloc = 0;
1005 if (size == dev_size)
1007 if (size > dev_size && size - dev_size > avail)
1009 if (size < dev_size)
1010 return dev_dax_shrink(dev_dax, size);
1012 to_alloc = size - dev_size;
1013 if (dev_WARN_ONCE(dev, !alloc_is_aligned(dev_dax, to_alloc),
1014 "resize of %pa misaligned\n", &to_alloc))
1018 * Expand the device into the unused portion of the region. This
1019 * may involve adjusting the end of an existing resource, or
1020 * allocating a new resource.
1023 first = region_res->child;
1025 return alloc_dev_dax_range(dev_dax, dax_region->res.start, to_alloc);
1028 for (res = first; res; res = res->sibling) {
1029 struct resource *next = res->sibling;
1031 /* space at the beginning of the region */
1032 if (res == first && res->start > dax_region->res.start) {
1033 alloc = min(res->start - dax_region->res.start, to_alloc);
1034 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, alloc);
1039 /* space between allocations */
1040 if (next && next->start > res->end + 1)
1041 alloc = min(next->start - (res->end + 1), to_alloc);
1043 /* space at the end of the region */
1044 if (!alloc && !next && res->end < region_res->end)
1045 alloc = min(region_res->end - res->end, to_alloc);
1050 if (adjust_ok(dev_dax, res)) {
1051 rc = adjust_dev_dax_range(dev_dax, res, resource_size(res) + alloc);
1054 rc = alloc_dev_dax_range(dev_dax, res->end + 1, alloc);
1065 static ssize_t size_store(struct device *dev, struct device_attribute *attr,
1066 const char *buf, size_t len)
1069 unsigned long long val;
1070 struct dev_dax *dev_dax = to_dev_dax(dev);
1071 struct dax_region *dax_region = dev_dax->region;
1073 rc = kstrtoull(buf, 0, &val);
1077 if (!alloc_is_aligned(dev_dax, val)) {
1078 dev_dbg(dev, "%s: size: %lld misaligned\n", __func__, val);
1082 device_lock(dax_region->dev);
1083 if (!dax_region->dev->driver) {
1084 device_unlock(dax_region->dev);
1088 rc = dev_dax_resize(dax_region, dev_dax, val);
1090 device_unlock(dax_region->dev);
1092 return rc == 0 ? len : rc;
1094 static DEVICE_ATTR_RW(size);
1096 static ssize_t range_parse(const char *opt, size_t len, struct range *range)
1098 unsigned long long addr = 0;
1099 char *start, *end, *str;
1100 ssize_t rc = -EINVAL;
1102 str = kstrdup(opt, GFP_KERNEL);
1107 start = strsep(&end, "-");
1111 rc = kstrtoull(start, 16, &addr);
1114 range->start = addr;
1116 rc = kstrtoull(end, 16, &addr);
1126 static ssize_t mapping_store(struct device *dev, struct device_attribute *attr,
1127 const char *buf, size_t len)
1129 struct dev_dax *dev_dax = to_dev_dax(dev);
1130 struct dax_region *dax_region = dev_dax->region;
1135 rc = range_parse(buf, len, &r);
1140 device_lock(dax_region->dev);
1141 if (!dax_region->dev->driver) {
1142 device_unlock(dax_region->dev);
1147 to_alloc = range_len(&r);
1148 if (alloc_is_aligned(dev_dax, to_alloc))
1149 rc = alloc_dev_dax_range(dev_dax, r.start, to_alloc);
1151 device_unlock(dax_region->dev);
1153 return rc == 0 ? len : rc;
1155 static DEVICE_ATTR_WO(mapping);
1157 static ssize_t align_show(struct device *dev,
1158 struct device_attribute *attr, char *buf)
1160 struct dev_dax *dev_dax = to_dev_dax(dev);
1162 return sprintf(buf, "%d\n", dev_dax->align);
1165 static ssize_t dev_dax_validate_align(struct dev_dax *dev_dax)
1167 struct device *dev = &dev_dax->dev;
1170 for (i = 0; i < dev_dax->nr_range; i++) {
1171 size_t len = range_len(&dev_dax->ranges[i].range);
1173 if (!alloc_is_aligned(dev_dax, len)) {
1174 dev_dbg(dev, "%s: align %u invalid for range %d\n",
1175 __func__, dev_dax->align, i);
1183 static ssize_t align_store(struct device *dev, struct device_attribute *attr,
1184 const char *buf, size_t len)
1186 struct dev_dax *dev_dax = to_dev_dax(dev);
1187 struct dax_region *dax_region = dev_dax->region;
1188 unsigned long val, align_save;
1191 rc = kstrtoul(buf, 0, &val);
1195 if (!dax_align_valid(val))
1198 device_lock(dax_region->dev);
1199 if (!dax_region->dev->driver) {
1200 device_unlock(dax_region->dev);
1210 align_save = dev_dax->align;
1211 dev_dax->align = val;
1212 rc = dev_dax_validate_align(dev_dax);
1214 dev_dax->align = align_save;
1217 device_unlock(dax_region->dev);
1218 return rc == 0 ? len : rc;
1220 static DEVICE_ATTR_RW(align);
1222 static int dev_dax_target_node(struct dev_dax *dev_dax)
1224 struct dax_region *dax_region = dev_dax->region;
1226 return dax_region->target_node;
1229 static ssize_t target_node_show(struct device *dev,
1230 struct device_attribute *attr, char *buf)
1232 struct dev_dax *dev_dax = to_dev_dax(dev);
1234 return sprintf(buf, "%d\n", dev_dax_target_node(dev_dax));
1236 static DEVICE_ATTR_RO(target_node);
1238 static ssize_t resource_show(struct device *dev,
1239 struct device_attribute *attr, char *buf)
1241 struct dev_dax *dev_dax = to_dev_dax(dev);
1242 struct dax_region *dax_region = dev_dax->region;
1243 unsigned long long start;
1245 if (dev_dax->nr_range < 1)
1246 start = dax_region->res.start;
1248 start = dev_dax->ranges[0].range.start;
1250 return sprintf(buf, "%#llx\n", start);
1252 static DEVICE_ATTR(resource, 0400, resource_show, NULL);
1254 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
1258 * We only ever expect to handle device-dax instances, i.e. the
1259 * @type argument to MODULE_ALIAS_DAX_DEVICE() is always zero
1261 return sprintf(buf, DAX_DEVICE_MODALIAS_FMT "\n", 0);
1263 static DEVICE_ATTR_RO(modalias);
1265 static ssize_t numa_node_show(struct device *dev,
1266 struct device_attribute *attr, char *buf)
1268 return sprintf(buf, "%d\n", dev_to_node(dev));
1270 static DEVICE_ATTR_RO(numa_node);
1272 static umode_t dev_dax_visible(struct kobject *kobj, struct attribute *a, int n)
1274 struct device *dev = container_of(kobj, struct device, kobj);
1275 struct dev_dax *dev_dax = to_dev_dax(dev);
1276 struct dax_region *dax_region = dev_dax->region;
1278 if (a == &dev_attr_target_node.attr && dev_dax_target_node(dev_dax) < 0)
1280 if (a == &dev_attr_numa_node.attr && !IS_ENABLED(CONFIG_NUMA))
1282 if (a == &dev_attr_mapping.attr && is_static(dax_region))
1284 if ((a == &dev_attr_align.attr ||
1285 a == &dev_attr_size.attr) && is_static(dax_region))
1290 static struct attribute *dev_dax_attributes[] = {
1291 &dev_attr_modalias.attr,
1292 &dev_attr_size.attr,
1293 &dev_attr_mapping.attr,
1294 &dev_attr_target_node.attr,
1295 &dev_attr_align.attr,
1296 &dev_attr_resource.attr,
1297 &dev_attr_numa_node.attr,
1301 static const struct attribute_group dev_dax_attribute_group = {
1302 .attrs = dev_dax_attributes,
1303 .is_visible = dev_dax_visible,
1306 static const struct attribute_group *dax_attribute_groups[] = {
1307 &dev_dax_attribute_group,
1311 static void dev_dax_release(struct device *dev)
1313 struct dev_dax *dev_dax = to_dev_dax(dev);
1314 struct dax_device *dax_dev = dev_dax->dax_dev;
1317 free_dev_dax_id(dev_dax);
1318 kfree(dev_dax->pgmap);
1322 static const struct device_type dev_dax_type = {
1323 .release = dev_dax_release,
1324 .groups = dax_attribute_groups,
1327 struct dev_dax *devm_create_dev_dax(struct dev_dax_data *data)
1329 struct dax_region *dax_region = data->dax_region;
1330 struct device *parent = dax_region->dev;
1331 struct dax_device *dax_dev;
1332 struct dev_dax *dev_dax;
1333 struct inode *inode;
1337 dev_dax = kzalloc(sizeof(*dev_dax), GFP_KERNEL);
1339 return ERR_PTR(-ENOMEM);
1341 dev_dax->region = dax_region;
1342 if (is_static(dax_region)) {
1343 if (dev_WARN_ONCE(parent, data->id < 0,
1344 "dynamic id specified to static region\n")) {
1349 dev_dax->id = data->id;
1351 if (dev_WARN_ONCE(parent, data->id >= 0,
1352 "static id specified to dynamic region\n")) {
1357 rc = alloc_dev_dax_id(dev_dax);
1362 dev = &dev_dax->dev;
1363 device_initialize(dev);
1364 dev_set_name(dev, "dax%d.%d", dax_region->id, dev_dax->id);
1366 rc = alloc_dev_dax_range(dev_dax, dax_region->res.start, data->size);
1371 dev_WARN_ONCE(parent, !is_static(dax_region),
1372 "custom dev_pagemap requires a static dax_region\n");
1374 dev_dax->pgmap = kmemdup(data->pgmap,
1375 sizeof(struct dev_pagemap), GFP_KERNEL);
1376 if (!dev_dax->pgmap) {
1383 * No dax_operations since there is no access to this device outside of
1384 * mmap of the resulting character device.
1386 dax_dev = alloc_dax(dev_dax, NULL);
1387 if (IS_ERR(dax_dev)) {
1388 rc = PTR_ERR(dax_dev);
1391 set_dax_synchronous(dax_dev);
1392 set_dax_nocache(dax_dev);
1393 set_dax_nomc(dax_dev);
1395 /* a device_dax instance is dead while the driver is not attached */
1398 dev_dax->dax_dev = dax_dev;
1399 dev_dax->target_node = dax_region->target_node;
1400 dev_dax->align = dax_region->align;
1401 ida_init(&dev_dax->ida);
1403 inode = dax_inode(dax_dev);
1404 dev->devt = inode->i_rdev;
1405 dev->bus = &dax_bus_type;
1406 dev->parent = parent;
1407 dev->type = &dev_dax_type;
1409 rc = device_add(dev);
1411 kill_dev_dax(dev_dax);
1416 rc = devm_add_action_or_reset(dax_region->dev, unregister_dev_dax, dev);
1420 /* register mapping device for the initial allocation range */
1421 if (dev_dax->nr_range && range_len(&dev_dax->ranges[0].range)) {
1422 rc = devm_register_dax_mapping(dev_dax, 0);
1430 kfree(dev_dax->pgmap);
1432 free_dev_dax_ranges(dev_dax);
1434 free_dev_dax_id(dev_dax);
1440 EXPORT_SYMBOL_GPL(devm_create_dev_dax);
1442 int __dax_driver_register(struct dax_device_driver *dax_drv,
1443 struct module *module, const char *mod_name)
1445 struct device_driver *drv = &dax_drv->drv;
1448 * dax_bus_probe() calls dax_drv->probe() unconditionally.
1449 * So better be safe than sorry and ensure it is provided.
1451 if (!dax_drv->probe)
1454 INIT_LIST_HEAD(&dax_drv->ids);
1455 drv->owner = module;
1456 drv->name = mod_name;
1457 drv->mod_name = mod_name;
1458 drv->bus = &dax_bus_type;
1460 return driver_register(drv);
1462 EXPORT_SYMBOL_GPL(__dax_driver_register);
1464 void dax_driver_unregister(struct dax_device_driver *dax_drv)
1466 struct device_driver *drv = &dax_drv->drv;
1467 struct dax_id *dax_id, *_id;
1469 mutex_lock(&dax_bus_lock);
1470 list_for_each_entry_safe(dax_id, _id, &dax_drv->ids, list) {
1471 list_del(&dax_id->list);
1474 mutex_unlock(&dax_bus_lock);
1475 driver_unregister(drv);
1477 EXPORT_SYMBOL_GPL(dax_driver_unregister);
1479 int __init dax_bus_init(void)
1481 return bus_register(&dax_bus_type);
1484 void __exit dax_bus_exit(void)
1486 bus_unregister(&dax_bus_type);