[thirdparty/linux.git] / drivers / nvdimm / region.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
 */
#include <linux/cpumask.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/nd.h>
#include "nd-core.h"
#include "nd.h"

static int nd_region_probe(struct device *dev)
{
	int err, rc;
	static unsigned long once;
	struct nd_region_data *ndrd;
	struct nd_region *nd_region = to_nd_region(dev);

	if (nd_region->num_lanes > num_online_cpus()
			&& nd_region->num_lanes < num_possible_cpus()
			&& !test_and_set_bit(0, &once)) {
		dev_dbg(dev, "online cpus (%d) < concurrent i/o lanes (%d) < possible cpus (%d)\n",
				num_online_cpus(), nd_region->num_lanes,
				num_possible_cpus());
		dev_dbg(dev, "setting nr_cpus=%d may yield better libnvdimm device performance\n",
				nd_region->num_lanes);
	}

	rc = nd_region_activate(nd_region);
	if (rc)
		return rc;

	rc = nd_blk_region_init(nd_region);
	if (rc)
		return rc;

	if (is_nd_pmem(&nd_region->dev)) {
		struct resource ndr_res;

		if (devm_init_badblocks(dev, &nd_region->bb))
			return -ENODEV;
		nd_region->bb_state = sysfs_get_dirent(nd_region->dev.kobj.sd,
						       "badblocks");
		if (!nd_region->bb_state)
			dev_warn(&nd_region->dev,
					"'badblocks' notification disabled\n");
		ndr_res.start = nd_region->ndr_start;
		ndr_res.end = nd_region->ndr_start + nd_region->ndr_size - 1;
		nvdimm_badblocks_populate(nd_region, &nd_region->bb, &ndr_res);
	}

	rc = nd_region_register_namespaces(nd_region, &err);
	if (rc < 0)
		return rc;

	ndrd = dev_get_drvdata(dev);
	ndrd->ns_active = rc;
	ndrd->ns_count = rc + err;

	if (rc && err && rc == err)
		return -ENODEV;

	nd_region->btt_seed = nd_btt_create(nd_region);
	nd_region->pfn_seed = nd_pfn_create(nd_region);
	nd_region->dax_seed = nd_dax_create(nd_region);
	if (err == 0)
		return 0;

	/*
	 * Given multiple namespaces per region, we do not want to
	 * disable all the successfully registered peer namespaces upon
	 * a single registration failure.  If userspace is missing a
	 * namespace that it expects it can disable/re-enable the region
	 * to retry discovery after correcting the failure.
	 * <regionX>/namespaces returns the current
	 * "<async-registered>/<total>" namespace count.
	 */
	dev_err(dev, "failed to register %d namespace%s, continuing...\n",
			err, err == 1 ? "" : "s");
	return 0;
}

static int child_unregister(struct device *dev, void *data)
{
	nd_device_unregister(dev, ND_SYNC);
	return 0;
}

static int nd_region_remove(struct device *dev)
{
	struct nd_region *nd_region = to_nd_region(dev);

	device_for_each_child(dev, NULL, child_unregister);

	/* flush attribute readers and disable */
	nvdimm_bus_lock(dev);
	nd_region->ns_seed = NULL;
	nd_region->btt_seed = NULL;
	nd_region->pfn_seed = NULL;
	nd_region->dax_seed = NULL;
	dev_set_drvdata(dev, NULL);
	nvdimm_bus_unlock(dev);

	/*
	 * Note, this assumes nd_device_lock() context to not race
	 * nd_region_notify()
	 */
	sysfs_put(nd_region->bb_state);
	nd_region->bb_state = NULL;

	return 0;
}

static int child_notify(struct device *dev, void *data)
{
	nd_device_notify(dev, *(enum nvdimm_event *) data);
	return 0;
}

static void nd_region_notify(struct device *dev, enum nvdimm_event event)
{
	if (event == NVDIMM_REVALIDATE_POISON) {
		struct nd_region *nd_region = to_nd_region(dev);
		struct resource res;

		if (is_nd_pmem(&nd_region->dev)) {
			res.start = nd_region->ndr_start;
			res.end = nd_region->ndr_start +
				nd_region->ndr_size - 1;
			nvdimm_badblocks_populate(nd_region,
					&nd_region->bb, &res);
			if (nd_region->bb_state)
				sysfs_notify_dirent(nd_region->bb_state);
		}
	}
	device_for_each_child(dev, &event, child_notify);
}

static struct nd_device_driver nd_region_driver = {
	.probe = nd_region_probe,
	.remove = nd_region_remove,
	.notify = nd_region_notify,
	.drv = {
		.name = "nd_region",
	},
	.type = ND_DRIVER_REGION_BLK | ND_DRIVER_REGION_PMEM,
};

int __init nd_region_init(void)
{
	return nd_driver_register(&nd_region_driver);
}

void nd_region_exit(void)
{
	driver_unregister(&nd_region_driver.drv);
}

MODULE_ALIAS_ND_DEVICE(ND_DEVICE_REGION_PMEM);
MODULE_ALIAS_ND_DEVICE(ND_DEVICE_REGION_BLK);
Commit	Line	Data
5b497af4	1	// SPDX-License-Identifier: GPL-2.0-only
3d88002e DW	2	/*
3d88002e DW	3	* Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
3d88002e	4	*/
5212e11f	5	#include <linux/cpumask.h>
3d88002e DW	6	#include <linux/module.h>
	7	#include <linux/device.h>
	8	#include <linux/nd.h>
6a6bef90	9	#include "nd-core.h"
3d88002e DW	10	#include "nd.h"
	11
	12	static int nd_region_probe(struct device *dev)
	13	{
047fc8a1	14	int err, rc;
5212e11f	15	static unsigned long once;
e5ae3b25	16	struct nd_region_data *ndrd;
3d88002e	17	struct nd_region *nd_region = to_nd_region(dev);
3d88002e	18
5212e11f VV	19	if (nd_region->num_lanes > num_online_cpus()
	20	&& nd_region->num_lanes < num_possible_cpus()
	21	&& !test_and_set_bit(0, &once)) {
60ce0f93	22	dev_dbg(dev, "online cpus (%d) < concurrent i/o lanes (%d) < possible cpus (%d)\n",
5212e11f VV	23	num_online_cpus(), nd_region->num_lanes,
5212e11f VV	24	num_possible_cpus());
60ce0f93	25	dev_dbg(dev, "setting nr_cpus=%d may yield better libnvdimm device performance\n",
5212e11f VV	26	nd_region->num_lanes);
	27	}
	28
e5ae3b25 DW	29	rc = nd_region_activate(nd_region);
	30	if (rc)
	31	return rc;
	32
047fc8a1 RZ	33	rc = nd_blk_region_init(nd_region);
	34	if (rc)
	35	return rc;
	36
6a6bef90 DJ	37	if (is_nd_pmem(&nd_region->dev)) {
	38	struct resource ndr_res;
	39
	40	if (devm_init_badblocks(dev, &nd_region->bb))
	41	return -ENODEV;
975750a9 TK	42	nd_region->bb_state = sysfs_get_dirent(nd_region->dev.kobj.sd,
975750a9 TK	43	"badblocks");
6aa734a2	44	if (!nd_region->bb_state)
975750a9	45	dev_warn(&nd_region->dev,
6aa734a2	46	"'badblocks' notification disabled\n");
6a6bef90 DJ	47	ndr_res.start = nd_region->ndr_start;
6a6bef90 DJ	48	ndr_res.end = nd_region->ndr_start + nd_region->ndr_size - 1;
975750a9	49	nvdimm_badblocks_populate(nd_region, &nd_region->bb, &ndr_res);
6a6bef90 DJ	50	}
6a6bef90 DJ	51
700cd033 DW	52	rc = nd_region_register_namespaces(nd_region, &err);
	53	if (rc < 0)
	54	return rc;
	55
	56	ndrd = dev_get_drvdata(dev);
	57	ndrd->ns_active = rc;
	58	ndrd->ns_count = rc + err;
	59
	60	if (rc && err && rc == err)
	61	return -ENODEV;
	62
8c2f7e86	63	nd_region->btt_seed = nd_btt_create(nd_region);
e1455744	64	nd_region->pfn_seed = nd_pfn_create(nd_region);
cd03412a	65	nd_region->dax_seed = nd_dax_create(nd_region);
3d88002e DW	66	if (err == 0)
	67	return 0;
	68
3d88002e DW	69	/*
	70	* Given multiple namespaces per region, we do not want to
	71	* disable all the successfully registered peer namespaces upon
	72	* a single registration failure. If userspace is missing a
	73	* namespace that it expects it can disable/re-enable the region
	74	* to retry discovery after correcting the failure.
	75	* <regionX>/namespaces returns the current
	76	* "<async-registered>/<total>" namespace count.
	77	*/
	78	dev_err(dev, "failed to register %d namespace%s, continuing...\n",
	79	err, err == 1 ? "" : "s");
	80	return 0;
	81	}
	82
	83	static int child_unregister(struct device dev, void data)
	84	{
	85	nd_device_unregister(dev, ND_SYNC);
	86	return 0;
	87	}
	88
	89	static int nd_region_remove(struct device *dev)
	90	{
bf9bccc1 DW	91	struct nd_region *nd_region = to_nd_region(dev);
bf9bccc1 DW	92
a8f72022 DW	93	device_for_each_child(dev, NULL, child_unregister);
a8f72022 DW	94
3d88002e DW	95	/* flush attribute readers and disable */
3d88002e DW	96	nvdimm_bus_lock(dev);
bf9bccc1	97	nd_region->ns_seed = NULL;
8c2f7e86	98	nd_region->btt_seed = NULL;
e1455744	99	nd_region->pfn_seed = NULL;
cd03412a	100	nd_region->dax_seed = NULL;
3d88002e DW	101	dev_set_drvdata(dev, NULL);
	102	nvdimm_bus_unlock(dev);
	103
6aa734a2	104	/*
87a30e1f	105	* Note, this assumes nd_device_lock() context to not race
6aa734a2 DW	106	* nd_region_notify()
	107	*/
	108	sysfs_put(nd_region->bb_state);
	109	nd_region->bb_state = NULL;
	110
3d88002e DW	111	return 0;
	112	}
	113
71999466 DW	114	static int child_notify(struct device dev, void data)
	115	{
	116	nd_device_notify(dev, (enum nvdimm_event ) data);
	117	return 0;
	118	}
	119
	120	static void nd_region_notify(struct device *dev, enum nvdimm_event event)
	121	{
6a6bef90 DJ	122	if (event == NVDIMM_REVALIDATE_POISON) {
	123	struct nd_region *nd_region = to_nd_region(dev);
	124	struct resource res;
	125
	126	if (is_nd_pmem(&nd_region->dev)) {
	127	res.start = nd_region->ndr_start;
	128	res.end = nd_region->ndr_start +
	129	nd_region->ndr_size - 1;
	130	nvdimm_badblocks_populate(nd_region,
	131	&nd_region->bb, &res);
975750a9 TK	132	if (nd_region->bb_state)
975750a9 TK	133	sysfs_notify_dirent(nd_region->bb_state);
6a6bef90 DJ	134	}
6a6bef90 DJ	135	}
71999466 DW	136	device_for_each_child(dev, &event, child_notify);
	137	}
	138
3d88002e DW	139	static struct nd_device_driver nd_region_driver = {
	140	.probe = nd_region_probe,
	141	.remove = nd_region_remove,
71999466	142	.notify = nd_region_notify,
3d88002e DW	143	.drv = {
	144	.name = "nd_region",
	145	},
	146	.type = ND_DRIVER_REGION_BLK \| ND_DRIVER_REGION_PMEM,
	147	};
	148
	149	int __init nd_region_init(void)
	150	{
	151	return nd_driver_register(&nd_region_driver);
	152	}
	153
	154	void nd_region_exit(void)
	155	{
	156	driver_unregister(&nd_region_driver.drv);
	157	}
	158
	159	MODULE_ALIAS_ND_DEVICE(ND_DEVICE_REGION_PMEM);
	160	MODULE_ALIAS_ND_DEVICE(ND_DEVICE_REGION_BLK);