Merge ~rafaeldtinoco/ubuntu/+source/ndctl:lp1811785-bionic into ubuntu/+source/ndctl:ubuntu/bionic-devel

[Rafael David Tinoco]

An XML file for a KVM guest (example) can be found here:

https://bugs.launchpad.net/ubuntu/+source/ndctl/+bug/1853506/comments/2

And an example on how to test ndctl can be found here:

https://bugs.launchpad.net/ubuntu/+source/ndctl/+bug/1853506/comments/1

PPA: https://launchpad.net/~rafaeldtinoco/+archive/ubuntu/lp1811785

[Christian Ehrhardt  (paelzer)]

I think the fix itself is good, but a few things need cleanup.

changelog: we usually name the patch before the colon:
so instead
     * ndctl/init-labels: Fix label slot accounting per UEFI 2.7 (LP: #1811785)
maybe:
     * d/p/ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch: Fix label slot accounting per UEFI 2.7 (LP: #1811785)

Furthermore the bug should get a proper SRU Template before sponsoring it into -unapproved.

review: Needs Fixing

[Rafael David Tinoco (rafaeldtinoco)]

I'm removing it from canonical-server view based on:

https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1811785/comments/21

and

https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1811785/comments/22

If end-user chooses to continue the SRU, I'll get back to this.

[Rafael David Tinoco (rafaeldtinoco)]

review: Needs Fixing

[Christian Ehrhardt  (paelzer)]

No activity on this one, setting rejected to get off our overview.
Please revive if needed.

Unmerged commits

319dc82... by Rafael David Tinoco on 2019-11-23

changelog

a02fb3a... by Rafael David Tinoco on 2019-11-23

 * ndctl/init-labels: Fix label slot accounting per UEFI 2.7 (LP: #1811785)

diff --git a/debian/changelog b/debian/changelog
index 00774c3..f9e03a6 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+ndctl (61.2-0ubuntu2~18.04.1) bionic; urgency=medium
+
+  * d/p/ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch (LP: #1811785)
+
+ -- Rafael David Tinoco <[e-mail]>  Sat, 23 Nov 2019 00:44:53 +0000
+
 ndctl (61.2-0ubuntu1~18.04.1) bionic; urgency=medium
 
   * Backport to bionic (LP: #1781268)
diff --git a/debian/patches/ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch b/debian/patches/ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch
new file mode 100644
index 0000000..ea32ae0
--- /dev/null
+++ b/debian/patches/ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch
@@ -0,0 +1,92 @@
+From 9c6aae5635ebe8d0ca56a3ed949eef88639cb1b5 Mon Sep 17 00:00:00 2001
+From: Dan Williams <[e-mail]>
+Date: Mon, 14 Jan 2019 19:51:45 -0800
+Subject: [PATCH] ndctl/init-labels: Fix label slot accounting per UEFI 2.7
+
+Quoting from Linux kernel commit 9e694d9c18dd "libnvdimm, label: change
+nvdimm_num_label_slots per UEFI 2.7":
+
+    sizeof_namespace_index() fails when NVDIMM devices have the minimum
+    1024 bytes label storage area.  nvdimm_num_label_slots() returns 3
+    slots while the area is only big enough for 2 slots.
+
+    Change nvdimm_num_label_slots() to calculate a number of label slots
+    according to UEFI 2.7 spec.
+
+Without this fix attempts to initialize labels on a small (1K) label
+area results in the following:
+
+libndctl: sizeof_namespace_index: nmem2: label area (1024) too small to host (128 byte) labels
+libndctl: sizeof_namespace_index: nmem2: label area (1024) too small to host (256 byte) labels
+
+Based on an original patch by Toshi Kani
+Fixes: bdaec95463ca ("ndctl: introduce ndctl_dimm_{validate_labels,init_labels}")
+Reported-by: Sujith Pandel <[e-mail]>
+Link: https://github.com/pmem/ndctl/issues/78
+Signed-off-by: Dan Williams <[e-mail]>
+Signed-off-by: Vishal Verma <[e-mail]>
+---
+ ndctl/lib/dimm.c | 35 +++++++++++++++++++++++++----------
+ 1 file changed, 25 insertions(+), 10 deletions(-)
+
+diff --git a/ndctl/lib/dimm.c b/ndctl/lib/dimm.c
+index b3e032e..108d795 100644
+--- a/ndctl/lib/dimm.c
++++ b/ndctl/lib/dimm.c
+@@ -66,9 +66,27 @@ static unsigned int sizeof_namespace_label(struct nvdimm_data *ndd)
+ 	return ndctl_dimm_sizeof_namespace_label(to_dimm(ndd));
+ }
+ 
++static size_t __sizeof_namespace_index(u32 nslot)
++{
++	return ALIGN(sizeof(struct namespace_index) + DIV_ROUND_UP(nslot, 8),
++			NSINDEX_ALIGN);
++}
++
++static int __nvdimm_num_label_slots(struct nvdimm_data *ndd,
++		size_t index_size)
++{
++	return (ndd->config_size - index_size * 2) /
++		sizeof_namespace_label(ndd);
++}
++
+ static int nvdimm_num_label_slots(struct nvdimm_data *ndd)
+ {
+-	return ndd->config_size / (sizeof_namespace_label(ndd) + 1);
++	u32 tmp_nslot, n;
++
++	tmp_nslot = ndd->config_size / sizeof_namespace_label(ndd);
++	n = __sizeof_namespace_index(tmp_nslot) / NSINDEX_ALIGN;
++
++	return __nvdimm_num_label_slots(ndd, NSINDEX_ALIGN * n);
+ }
+ 
+ static unsigned int sizeof_namespace_index(struct nvdimm_data *ndd)
+@@ -78,18 +96,15 @@ static unsigned int sizeof_namespace_index(struct nvdimm_data *ndd)
+ 	struct ndctl_ctx *ctx = ndctl_dimm_get_ctx(dimm);
+ 
+ 	/*
+-	 * The minimum index space is 512 bytes, with that amount of
+-	 * index we can describe ~1400 labels which is less than a byte
+-	 * of overhead per label.  Round up to a byte of overhead per
+-	 * label and determine the size of the index region.  Yes, this
+-	 * starts to waste space at larger config_sizes, but it's
+-	 * unlikely we'll ever see anything but 128K.
++	 * Per UEFI 2.7, the minimum size of the Label Storage Area is
++	 * large enough to hold 2 index blocks and 2 labels.  The
++	 * minimum index block size is 256 bytes, and the minimum label
++	 * size is 256 bytes.
+ 	 */
+ 	nslot = nvdimm_num_label_slots(ndd);
+ 	space = ndd->config_size - nslot * sizeof_namespace_label(ndd);
+-	size = ALIGN(sizeof(struct namespace_index) + DIV_ROUND_UP(nslot, 8),
+-			NSINDEX_ALIGN) * 2;
+-	if (size <= space)
++	size = __sizeof_namespace_index(nslot) * 2;
++	if (size <= space && nslot >= 2)
+ 		return size / 2;
+ 
+ 	err(ctx, "%s: label area (%ld) too small to host (%d byte) labels\n",
+-- 
+2.20.1
+
diff --git a/debian/patches/series b/debian/patches/series
new file mode 100644
index 0000000..084e496
--- /dev/null
+++ b/debian/patches/series
@@ -0,0 +1 @@
+ndctl-init-labels-Fix-label-slot-accounting-per-UEFI.patch