[08/23] libnvdimm/labels: Add claim class helpers

Message ID	162854811000.1980150.8798912622256692357.stgit@dwillia2-desk3.amr.corp.intel.com
State	Superseded
Headers	show Return-Path: <linux-cxl-owner@kernel.org> Subject: [PATCH 08/23] libnvdimm/labels: Add claim class helpers From: Dan Williams <dan.j.williams@intel.com> To: linux-cxl@vger.kernel.org Cc: nvdimm@lists.linux.dev, Jonathan.Cameron@huawei.com, ben.widawsky@intel.com, vishal.l.verma@intel.com, alison.schofield@intel.com, ira.weiny@intel.com Date: Mon, 09 Aug 2021 15:28:30 -0700 Message-ID: <162854811000.1980150.8798912622256692357.stgit@dwillia2-desk3.amr.corp.intel.com> In-Reply-To: <162854806653.1980150.3354618413963083778.stgit@dwillia2-desk3.amr.corp.intel.com> References: <162854806653.1980150.3354618413963083778.stgit@dwillia2-desk3.amr.corp.intel.com> User-Agent: StGit/0.18-3-g996c MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Precedence: bulk
Series	cxl_test: Enable CXL Topology and UAPI regression tests \| expand [00/23] cxl_test: Enable CXL Topology and UAPI regression tests [01/23] libnvdimm/labels: Introduce getters for namespace label fields [02/23] libnvdimm/labels: Add isetcookie validation helper [03/23] libnvdimm/labels: Introduce label setter helpers [04/23] libnvdimm/labels: Add a checksum calculation helper [05/23] libnvdimm/labels: Add blk isetcookie set / validation helpers [06/23] libnvdimm/labels: Add blk special cases for nlabel and position helpers [07/23] libnvdimm/labels: Add type-guid helpers [08/23] libnvdimm/labels: Add claim class helpers [09/23] libnvdimm/labels: Add address-abstraction uuid definitions [10/23] libnvdimm/labels: Add uuid helpers [11/23] libnvdimm/labels: Introduce CXL labels [12/23] cxl/pci: Make 'struct cxl_mem' device type generic [13/23] cxl/mbox: Introduce the mbox_send operation [14/23] cxl/mbox: Move mailbox and other non-PCI specific infrastructure to the core [15/23] cxl/pci: Use module_pci_driver [16/23] cxl/mbox: Convert 'enabled_cmds' to DECLARE_BITMAP [17/23] cxl/mbox: Add exclusive kernel command support [18/23] cxl/pmem: Translate NVDIMM label commands to CXL label commands [19/23] cxl/pmem: Add support for multiple nvdimm-bridge objects [20/23] tools/testing/cxl: Introduce a mocked-up CXL port hierarchy [21/23] cxl/bus: Populate the target list at decoder create [22/23] cxl/mbox: Move command definitions to common location [23/23] tools/testing/cxl: Introduce a mock memory device + driver

Message ID

162854811000.1980150.8798912622256692357.stgit@dwillia2-desk3.amr.corp.intel.com

State

Superseded

Headers

Subject: [PATCH 08/23] libnvdimm/labels: Add claim class helpers
From: Dan Williams <dan.j.williams@intel.com>
To: linux-cxl@vger.kernel.org
Cc: nvdimm@lists.linux.dev, Jonathan.Cameron@huawei.com,
        ben.widawsky@intel.com, vishal.l.verma@intel.com,
        alison.schofield@intel.com, ira.weiny@intel.com
Date: Mon, 09 Aug 2021 15:28:30 -0700
Message-ID: 
 <162854811000.1980150.8798912622256692357.stgit@dwillia2-desk3.amr.corp.intel.com>
In-Reply-To: 
 <162854806653.1980150.3354618413963083778.stgit@dwillia2-desk3.amr.corp.intel.com>
References: 
 <162854806653.1980150.3354618413963083778.stgit@dwillia2-desk3.amr.corp.intel.com>
User-Agent: StGit/0.18-3-g996c
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Precedence: bulk

Series

cxl_test: Enable CXL Topology and UAPI regression tests | expand

Commit Message

Dan Williams Aug. 9, 2021, 10:28 p.m. UTC

In preparation for LIBNVDIMM to manage labels on CXL devices deploy
helpers that abstract the label type from the implementation. The CXL
label format is mostly similar to the EFI label format with concepts /
fields added, like dynamic region creation and label type guids, and
other concepts removed like BLK-mode and interleave-set-cookie ids.

CXL labels do have the concept of a claim class represented by an
"abstraction" identifier. It turns out both label implementations use
the same ids, but EFI encodes them as GUIDs and CXL labels encode them
as UUIDs. For now abstract out the claim class such that the UUID vs
GUID distinction can later be hidden in the helper.

Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
 drivers/nvdimm/label.c          |   31 ++++++++++++++++++++++---------
 drivers/nvdimm/label.h          |    1 -
 drivers/nvdimm/namespace_devs.c |   13 ++++---------
 drivers/nvdimm/nd.h             |    2 ++
 4 files changed, 28 insertions(+), 19 deletions(-)

Comments

Jonathan Cameron Aug. 11, 2021, 6:46 p.m. UTC | #1

On Mon, 9 Aug 2021 15:28:30 -0700
Dan Williams <dan.j.williams@intel.com> wrote:

> In preparation for LIBNVDIMM to manage labels on CXL devices deploy
> helpers that abstract the label type from the implementation. The CXL
> label format is mostly similar to the EFI label format with concepts /
> fields added, like dynamic region creation and label type guids, and
> other concepts removed like BLK-mode and interleave-set-cookie ids.
> 
> CXL labels do have the concept of a claim class represented by an
> "abstraction" identifier. It turns out both label implementations use
> the same ids, but EFI encodes them as GUIDs and CXL labels encode them
> as UUIDs. For now abstract out the claim class such that the UUID vs
> GUID distinction can later be hidden in the helper.
> 
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  drivers/nvdimm/label.c          |   31 ++++++++++++++++++++++---------
>  drivers/nvdimm/label.h          |    1 -
>  drivers/nvdimm/namespace_devs.c |   13 ++++---------
>  drivers/nvdimm/nd.h             |    2 ++
>  4 files changed, 28 insertions(+), 19 deletions(-)
> 
> diff --git a/drivers/nvdimm/label.c b/drivers/nvdimm/label.c
> index 294ffc3cb582..7f473f9db300 100644
> --- a/drivers/nvdimm/label.c
> +++ b/drivers/nvdimm/label.c
> @@ -724,7 +724,7 @@ static unsigned long nd_label_offset(struct nvdimm_drvdata *ndd,
>  		- (unsigned long) to_namespace_index(ndd, 0);
>  }
>  
> -enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid)
> +static enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid)
>  {
>  	if (guid_equal(guid, &nvdimm_btt_guid))
>  		return NVDIMM_CCLASS_BTT;
> @@ -792,6 +792,25 @@ bool nsl_validate_type_guid(struct nvdimm_drvdata *ndd,
>  	return true;
>  }
>  
> +static void nsl_set_claim_class(struct nvdimm_drvdata *ndd,
> +				struct nd_namespace_label *nd_label,
> +				enum nvdimm_claim_class claim_class)
> +{
> +	if (!namespace_label_has(ndd, abstraction_guid))
> +		return;
> +	guid_copy(&nd_label->abstraction_guid,
> +		  to_abstraction_guid(claim_class,
> +				      &nd_label->abstraction_guid));
> +}
> +
> +enum nvdimm_claim_class nsl_get_claim_class(struct nvdimm_drvdata *ndd,
> +					    struct nd_namespace_label *nd_label)
> +{
> +	if (!namespace_label_has(ndd, abstraction_guid))
> +		return NVDIMM_CCLASS_NONE;
> +	return to_nvdimm_cclass(&nd_label->abstraction_guid);
> +}
> +
>  static int __pmem_label_update(struct nd_region *nd_region,
>  		struct nd_mapping *nd_mapping, struct nd_namespace_pmem *nspm,
>  		int pos, unsigned long flags)
> @@ -843,10 +862,7 @@ static int __pmem_label_update(struct nd_region *nd_region,
>  	nsl_set_dpa(ndd, nd_label, res->start);
>  	nsl_set_slot(ndd, nd_label, slot);
>  	nsl_set_type_guid(ndd, nd_label, &nd_set->type_guid);
> -	if (namespace_label_has(ndd, abstraction_guid))
> -		guid_copy(&nd_label->abstraction_guid,
> -				to_abstraction_guid(ndns->claim_class,
> -					&nd_label->abstraction_guid));
> +	nsl_set_claim_class(ndd, nd_label, ndns->claim_class);
>  	nsl_calculate_checksum(ndd, nd_label);
>  	nd_dbg_dpa(nd_region, ndd, res, "\n");
>  
> @@ -1111,10 +1127,7 @@ static int __blk_label_update(struct nd_region *nd_region,
>  		nsl_set_lbasize(ndd, nd_label, nsblk->lbasize);
>  		nsl_set_slot(ndd, nd_label, slot);
>  		nsl_set_type_guid(ndd, nd_label, &nd_set->type_guid);
> -		if (namespace_label_has(ndd, abstraction_guid))
> -			guid_copy(&nd_label->abstraction_guid,
> -					to_abstraction_guid(ndns->claim_class,
> -						&nd_label->abstraction_guid));
> +		nsl_set_claim_class(ndd, nd_label, ndns->claim_class);
>  		nsl_calculate_checksum(ndd, nd_label);
>  
>  		/* update label */
> diff --git a/drivers/nvdimm/label.h b/drivers/nvdimm/label.h
> index 956b6d1bd8cc..31f94fad7b92 100644
> --- a/drivers/nvdimm/label.h
> +++ b/drivers/nvdimm/label.h
> @@ -135,7 +135,6 @@ struct nd_namespace_label *nd_label_active(struct nvdimm_drvdata *ndd, int n);
>  u32 nd_label_alloc_slot(struct nvdimm_drvdata *ndd);
>  bool nd_label_free_slot(struct nvdimm_drvdata *ndd, u32 slot);
>  u32 nd_label_nfree(struct nvdimm_drvdata *ndd);
> -enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid);
>  struct nd_region;
>  struct nd_namespace_pmem;
>  struct nd_namespace_blk;
> diff --git a/drivers/nvdimm/namespace_devs.c b/drivers/nvdimm/namespace_devs.c
> index af5a31dd3147..58c76d74127a 100644
> --- a/drivers/nvdimm/namespace_devs.c
> +++ b/drivers/nvdimm/namespace_devs.c
> @@ -2042,10 +2042,8 @@ static struct device *create_namespace_pmem(struct nd_region *nd_region,
>  		nspm->uuid = kmemdup((void __force *) label0->uuid,
>  				NSLABEL_UUID_LEN, GFP_KERNEL);
>  		nspm->lbasize = nsl_get_lbasize(ndd, label0);
> -		if (namespace_label_has(ndd, abstraction_guid))
> -			nspm->nsio.common.claim_class
> -				= to_nvdimm_cclass(&label0->abstraction_guid);
> -
> +		nspm->nsio.common.claim_class =
> +			nsl_get_claim_class(ndd, label0);
>  	}
>  
>  	if (!nspm->alt_name || !nspm->uuid) {
> @@ -2273,11 +2271,8 @@ static struct device *create_namespace_blk(struct nd_region *nd_region,
>  	dev->parent = &nd_region->dev;
>  	nsblk->id = -1;
>  	nsblk->lbasize = nsl_get_lbasize(ndd, nd_label);
> -	nsblk->uuid = kmemdup(nd_label->uuid, NSLABEL_UUID_LEN,
> -			GFP_KERNEL);
> -	if (namespace_label_has(ndd, abstraction_guid))
> -		nsblk->common.claim_class
> -			= to_nvdimm_cclass(&nd_label->abstraction_guid);
> +	nsblk->uuid = kmemdup(nd_label->uuid, NSLABEL_UUID_LEN, GFP_KERNEL);
> +	nsblk->common.claim_class = nsl_get_claim_class(ndd, nd_label);
>  	if (!nsblk->uuid)
>  		goto blk_err;
>  	nsl_get_name(ndd, nd_label, name);
> diff --git a/drivers/nvdimm/nd.h b/drivers/nvdimm/nd.h
> index f3c364df9449..ac80d9680367 100644
> --- a/drivers/nvdimm/nd.h
> +++ b/drivers/nvdimm/nd.h
> @@ -181,6 +181,8 @@ bool nsl_validate_blk_isetcookie(struct nvdimm_drvdata *ndd,
>  				 u64 isetcookie);
>  bool nsl_validate_type_guid(struct nvdimm_drvdata *ndd,
>  			    struct nd_namespace_label *nd_label, guid_t *guid);
> +enum nvdimm_claim_class nsl_get_claim_class(struct nvdimm_drvdata *ndd,
> +					    struct nd_namespace_label *nd_label);
>  
>  struct nd_region_data {
>  	int ns_count;
>

diff --git a/drivers/nvdimm/label.c b/drivers/nvdimm/label.c
index 294ffc3cb582..7f473f9db300 100644
--- a/drivers/nvdimm/label.c
+++ b/drivers/nvdimm/label.c
@@ -724,7 +724,7 @@  static unsigned long nd_label_offset(struct nvdimm_drvdata *ndd,
 		- (unsigned long) to_namespace_index(ndd, 0);
 }
 
-enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid)
+static enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid)
 {
 	if (guid_equal(guid, &nvdimm_btt_guid))
 		return NVDIMM_CCLASS_BTT;
@@ -792,6 +792,25 @@  bool nsl_validate_type_guid(struct nvdimm_drvdata *ndd,
 	return true;
 }
 
+static void nsl_set_claim_class(struct nvdimm_drvdata *ndd,
+				struct nd_namespace_label *nd_label,
+				enum nvdimm_claim_class claim_class)
+{
+	if (!namespace_label_has(ndd, abstraction_guid))
+		return;
+	guid_copy(&nd_label->abstraction_guid,
+		  to_abstraction_guid(claim_class,
+				      &nd_label->abstraction_guid));
+}
+
+enum nvdimm_claim_class nsl_get_claim_class(struct nvdimm_drvdata *ndd,
+					    struct nd_namespace_label *nd_label)
+{
+	if (!namespace_label_has(ndd, abstraction_guid))
+		return NVDIMM_CCLASS_NONE;
+	return to_nvdimm_cclass(&nd_label->abstraction_guid);
+}
+
 static int __pmem_label_update(struct nd_region *nd_region,
 		struct nd_mapping *nd_mapping, struct nd_namespace_pmem *nspm,
 		int pos, unsigned long flags)
@@ -843,10 +862,7 @@  static int __pmem_label_update(struct nd_region *nd_region,
 	nsl_set_dpa(ndd, nd_label, res->start);
 	nsl_set_slot(ndd, nd_label, slot);
 	nsl_set_type_guid(ndd, nd_label, &nd_set->type_guid);
-	if (namespace_label_has(ndd, abstraction_guid))
-		guid_copy(&nd_label->abstraction_guid,
-				to_abstraction_guid(ndns->claim_class,
-					&nd_label->abstraction_guid));
+	nsl_set_claim_class(ndd, nd_label, ndns->claim_class);
 	nsl_calculate_checksum(ndd, nd_label);
 	nd_dbg_dpa(nd_region, ndd, res, "\n");
 
@@ -1111,10 +1127,7 @@  static int __blk_label_update(struct nd_region *nd_region,
 		nsl_set_lbasize(ndd, nd_label, nsblk->lbasize);
 		nsl_set_slot(ndd, nd_label, slot);
 		nsl_set_type_guid(ndd, nd_label, &nd_set->type_guid);
-		if (namespace_label_has(ndd, abstraction_guid))
-			guid_copy(&nd_label->abstraction_guid,
-					to_abstraction_guid(ndns->claim_class,
-						&nd_label->abstraction_guid));
+		nsl_set_claim_class(ndd, nd_label, ndns->claim_class);
 		nsl_calculate_checksum(ndd, nd_label);
 
 		/* update label */
diff --git a/drivers/nvdimm/label.h b/drivers/nvdimm/label.h
index 956b6d1bd8cc..31f94fad7b92 100644
--- a/drivers/nvdimm/label.h
+++ b/drivers/nvdimm/label.h
@@ -135,7 +135,6 @@  struct nd_namespace_label *nd_label_active(struct nvdimm_drvdata *ndd, int n);
 u32 nd_label_alloc_slot(struct nvdimm_drvdata *ndd);
 bool nd_label_free_slot(struct nvdimm_drvdata *ndd, u32 slot);
 u32 nd_label_nfree(struct nvdimm_drvdata *ndd);
-enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid);
 struct nd_region;
 struct nd_namespace_pmem;
 struct nd_namespace_blk;
diff --git a/drivers/nvdimm/namespace_devs.c b/drivers/nvdimm/namespace_devs.c
index af5a31dd3147..58c76d74127a 100644
--- a/drivers/nvdimm/namespace_devs.c
+++ b/drivers/nvdimm/namespace_devs.c
@@ -2042,10 +2042,8 @@  static struct device *create_namespace_pmem(struct nd_region *nd_region,
 		nspm->uuid = kmemdup((void __force *) label0->uuid,
 				NSLABEL_UUID_LEN, GFP_KERNEL);
 		nspm->lbasize = nsl_get_lbasize(ndd, label0);
-		if (namespace_label_has(ndd, abstraction_guid))
-			nspm->nsio.common.claim_class
-				= to_nvdimm_cclass(&label0->abstraction_guid);
-
+		nspm->nsio.common.claim_class =
+			nsl_get_claim_class(ndd, label0);
 	}
 
 	if (!nspm->alt_name || !nspm->uuid) {
@@ -2273,11 +2271,8 @@  static struct device *create_namespace_blk(struct nd_region *nd_region,
 	dev->parent = &nd_region->dev;
 	nsblk->id = -1;
 	nsblk->lbasize = nsl_get_lbasize(ndd, nd_label);
-	nsblk->uuid = kmemdup(nd_label->uuid, NSLABEL_UUID_LEN,
-			GFP_KERNEL);
-	if (namespace_label_has(ndd, abstraction_guid))
-		nsblk->common.claim_class
-			= to_nvdimm_cclass(&nd_label->abstraction_guid);
+	nsblk->uuid = kmemdup(nd_label->uuid, NSLABEL_UUID_LEN, GFP_KERNEL);
+	nsblk->common.claim_class = nsl_get_claim_class(ndd, nd_label);
 	if (!nsblk->uuid)
 		goto blk_err;
 	nsl_get_name(ndd, nd_label, name);
diff --git a/drivers/nvdimm/nd.h b/drivers/nvdimm/nd.h
index f3c364df9449..ac80d9680367 100644
--- a/drivers/nvdimm/nd.h
+++ b/drivers/nvdimm/nd.h
@@ -181,6 +181,8 @@  bool nsl_validate_blk_isetcookie(struct nvdimm_drvdata *ndd,
 				 u64 isetcookie);
 bool nsl_validate_type_guid(struct nvdimm_drvdata *ndd,
 			    struct nd_namespace_label *nd_label, guid_t *guid);
+enum nvdimm_claim_class nsl_get_claim_class(struct nvdimm_drvdata *ndd,
+					    struct nd_namespace_label *nd_label);
 
 struct nd_region_data {
 	int ns_count;

[08/23] libnvdimm/labels: Add claim class helpers

Commit Message

Comments

Patch