Skip to contentSkip to conversation

bootdev: few fixes for automatic boot

PATCH Superseded [email protected] 2 participants 5 messages Jun 23 Block layer

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v4 cover bootdev: few fixes for automatic boot

This series addresses few findings in bootdev code.

Patch 1 fix for automatic boots in case higher-priority bootdevs fail
to be hunted.

Patch 2 adds unit test for patch 1.

Link to v3: https://lore.kernel.org/u-boot/[email protected]/
Link to CI: https://github.com/u-boot/u-boot/pull/994

Denis Mukhin (2):
bootdev: scan boot devices at each priority level
test: bootdev: scan with a broken high-priority device

 boot/bootdev-uclass.c           |  2 -
 drivers/block/Makefile          |  2 +-
 drivers/block/host-uclass.c     | 15 +++++++
 drivers/block/sandbox-bootdev.c | 73 +++++++++++++++++++++++++++++++++
 include/sandbox_host.h          | 18 ++++++++
 test/boot/bootdev.c             | 23 ++++++-----
 test/boot/bootflow.c            | 46 +++++++++++++++++++++
 test/boot/bootstd_common.h      |  5 ++-
 8 files changed, 169 insertions(+), 15 deletions(-)
 create mode 100644 drivers/block/sandbox-bootdev.c
Signature · 1 line
2.54.0
#1 lore raw

PATCH v4 1/2 bootdev: scan boot devices at each priority level

From: Denis Mukhin <[email protected]>

Currently, default 'bootflow scan -lb' will stop booting the board if any of higher-priority bootdevs fail to be hunted even if there are bootdevs of lower priority.

For example, if the board has both NVMe (priority 4) and USB MSD devices (priority 5), and if NVMe bootdev hunt fails (in the event of a bad NVMe firmware update), USB (which may be a recovery bootdev) is never hunted automatically, leaving the board at the U-Boot prompt (user intervention is needed, e.g. something like 'bootflow scan usb' to hunt USB).

Fix bootdev_next_prio() to scan bootdevs at the lower priority level by not exiting the scan loop early.

Keep the existing logging verbosity unchanged and rely on the failing subsystem to provide a suitable diagnostic message.

---
Changes since v3:
- n/a

Changes since v2:
- added Simon's R-b

Changes since v1:
- corrected the commit message

---
 boot/bootdev-uclass.c | 2 --
 1 file changed, 2 deletions(-)
boot/bootdev-uclass.c +0 -2
index 3f8dc2c3c4e6..73c3f050c225 100644
@@ -664,8 +664,6 @@ int bootdev_next_prio(struct bootflow_iter *iter, struct udevice **devp)
 							BOOTFLOWIF_SHOW);
 				log_debug("- bootdev_hunt_prio() ret %d\n",
 					  ret);
-				if (ret)
-					return log_msg_ret("hun", ret);
 			}
 		} else {
 			ret = device_probe(dev);
Signature · 1 line
2.54.0
#2 lore raw

PATCH v4 2/2 test: bootdev: scan with a broken high-priority device

In reply to [email protected]

From: Denis Mukhin <[email protected]>

Add bootdev_hunt_fallthrough() test to verify that 'bootflow scan -l' falls back to a lower-priority bootdev when a higher-priority hunter fails.

Introduce a simple 'sandbox-bootdev' device for the test. The new bootdev can be configured to produce an error at the hunting stage.

Introduce new host_set_flags_by_label() API and a flags field to 'host_sb_plat' to simulate a bootdev hunter failure for the test.

Adjust boot{dev,flow} tests which depend on bootdev hunters.

---
Changes since v3:
- addressed feedback from Simon:
https://lore.kernel.org/u-boot/CAFLszTgU3X2GUTny3oG3+HxAuuKrGu9di7-oGBM3xaP8ZRVA6w@mail.gmail.com/

Changes since v2:
- dropped 'flags' from 'host_priv'
- added description for 'flags' in host_sb_plat
- switched to log_xxx() calls in sandbox-bootdev.c
- corrected sandbox_bootdev_hunt()
- updated boot{dev,flow} tests which depend on bootdev hunters

Changes since v1:
- new patch

---
 drivers/block/Makefile          |  2 +-
 drivers/block/host-uclass.c     | 15 +++++++
 drivers/block/sandbox-bootdev.c | 73 +++++++++++++++++++++++++++++++++
 include/sandbox_host.h          | 18 ++++++++
 test/boot/bootdev.c             | 23 ++++++-----
 test/boot/bootflow.c            | 46 +++++++++++++++++++++
 test/boot/bootstd_common.h      |  5 ++-
 7 files changed, 169 insertions(+), 13 deletions(-)
 create mode 100644 drivers/block/sandbox-bootdev.c
drivers/block/Makefile +1 -1
index f5a9d8637a3c..c827fa81a2d8 100644
@@ -13,7 +13,7 @@ ifndef CONFIG_XPL_BUILD
 obj-$(CONFIG_IDE) += ide.o
 obj-$(CONFIG_RKMTD) += rkmtd.o
 endif
-obj-$(CONFIG_SANDBOX) += sandbox.o host-uclass.o host_dev.o
+obj-$(CONFIG_SANDBOX) += sandbox.o sandbox-bootdev.o host-uclass.o host_dev.o
 obj-$(CONFIG_$(PHASE_)BLOCK_CACHE) += blkcache.o
 obj-$(CONFIG_$(PHASE_)BLKMAP) += blkmap.o
 obj-$(CONFIG_$(PHASE_)BLKMAP) += blkmap_helper.o
drivers/block/host-uclass.c +15 -0
index cf42bd1e07ac..95b0b0b2ffea 100644
@@ -150,6 +150,21 @@ struct udevice *host_find_by_label(const char *label)
 	return NULL;
 }
 
+int host_set_flags_by_label(const char *label, unsigned int flags)
+{
+	struct udevice *dev;
+	struct host_sb_plat *plat;
+
+	dev = host_find_by_label(label);
+	if (!dev)
+		return -ENODEV;
+
+	plat = dev_get_plat(dev);
+	plat->flags = flags;
+
+	return 0;
+}
+
 struct udevice *host_get_cur_dev(void)
 {
 	struct uclass *uc = uclass_find(UCLASS_HOST);
drivers/block/sandbox-bootdev.c new file +73 -0

73 lines not on this page · raw message

include/sandbox_host.h +18 -0
index f7a5fc672300..1330358ef7ab 100644
@@ -8,17 +8,26 @@
 #ifndef __SANDBOX_HOST__
 #define __SANDBOX_HOST__
 
+/**
+ * Device flags.
+ */
+enum host_platform_flags {
+	HOST_FLAG_BROKEN		= BIT(0), /** Simulate broken device */
+};
+
 /**
  * struct host_sb_plat - platform data for a host device
  *
  * @label: Label for this device (allocated)
  * @filename: Name of file this is attached to, or NULL (allocated)
  * @fd: File descriptor of file, or 0 for none (file is not open)
+ * @flags: Device flags (e.g. for unit tests).
  */
 struct host_sb_plat {
 	char *label;
 	char *filename;
 	int fd;
+	unsigned int flags;
 };
 
 /**
@@ -122,4 +131,13 @@ struct udevice *host_get_cur_dev(void);
  */
 void host_set_cur_dev(struct udevice *dev);
 
+/**
+ * host_set_flags_by_label() - Set the host device test flags
+ *
+ * @label: Label of the attachment, e.g. "test1"
+ * @flags: Device flags
+ * Returns: 0 if OK, -ve on error
+ */
+int host_set_flags_by_label(const char *label, unsigned int flags);
+
 #endif /* __SANDBOX_HOST__ */
test/boot/bootdev.c +12 -11
index 0820bf10ee08..c2eaf0b2c559 100644
@@ -384,19 +384,19 @@ static int bootdev_test_hunter(struct unit_test_state *uts)
 	ut_assert_nextline("   2        mmc              mmc_bootdev");
 	ut_assert_nextline("   4        nvme             nvme_bootdev");
 	ut_assert_nextline("   4        qfw              qfw_bootdev");
+	ut_assert_nextline("   4        host             sandbox_bootdev");
 	ut_assert_nextline("   4        scsi             scsi_bootdev");
 	ut_assert_nextline("   4        spi_flash        sf_bootdev");
 	ut_assert_nextline("   5        usb              usb_bootdev");
 	ut_assert_nextline("   4        virtio           virtio_bootdev");
-	ut_assert_nextline("(total hunters: 9)");
+	ut_assert_nextline("(total hunters: 10)");
 	ut_assert_console_end();
 
 	ut_assertok(bootdev_hunt("usb1", false));
 	ut_assert_skip_to_line("Bus usb@1: 5 USB Device(s) found");
 	ut_assert_console_end();
 
-	/* USB is 8th in the list, so bit 7 */
-	ut_asserteq(BIT(7), std->hunters_used);
+	ut_asserteq(BIT(USB_HUNTER), std->hunters_used);
 
 	return 0;
 }
@@ -417,7 +417,7 @@ static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
 	ut_assert_nextline("Prio  Used  Uclass           Hunter");
 	ut_assert_nextlinen("----");
 	ut_assert_nextline("   6        ethernet         eth_bootdev");
-	ut_assert_skip_to_line("(total hunters: 9)");
+	ut_assert_skip_to_line("(total hunters: 10)");
 	ut_assert_console_end();
 
 	/* Use the MMC hunter and see that it updates */
@@ -425,7 +425,7 @@ static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
 	ut_assertok(run_command("bootdev hunt -l", 0));
 	ut_assert_skip_to_line("   5        ide              ide_bootdev");
 	ut_assert_nextline("   2     *  mmc              mmc_bootdev");
-	ut_assert_skip_to_line("(total hunters: 9)");
+	ut_assert_skip_to_line("(total hunters: 10)");
 	ut_assert_console_end();
 
 	/* Scan all hunters */
@@ -441,6 +441,7 @@ static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
 
 	ut_assert_nextline("Hunting with: nvme");
 	ut_assert_nextline("Hunting with: qfw");
+	ut_assert_nextline("Hunting with: host");
 	ut_assert_nextline("Hunting with: scsi");
 	ut_assert_nextline("scanning bus for devices...");
 	ut_assert_skip_to_line("Hunting with: spi_flash");
@@ -458,11 +459,12 @@ static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
 	ut_assert_nextline("   2     *  mmc              mmc_bootdev");
 	ut_assert_nextline("   4     *  nvme             nvme_bootdev");
 	ut_assert_nextline("   4     *  qfw              qfw_bootdev");
+	ut_assert_nextline("   4     *  host             sandbox_bootdev");
 	ut_assert_nextline("   4     *  scsi             scsi_bootdev");
 	ut_assert_nextline("   4     *  spi_flash        sf_bootdev");
 	ut_assert_nextline("   5     *  usb              usb_bootdev");
 	ut_assert_nextline("   4     *  virtio           virtio_bootdev");
-	ut_assert_nextline("(total hunters: 9)");
+	ut_assert_nextline("(total hunters: 10)");
 	ut_assert_console_end();
 
 	ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
@@ -646,8 +648,7 @@ static int bootdev_test_next_label(struct unit_test_state *uts)
 	ut_asserteq_str("scsi.id0lun0.bootdev", dev->name);
 	ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
 
-	/* SCSI is 6th in the list, so bit 5 */
-	ut_asserteq(BIT(MMC_HUNTER) | BIT(5), std->hunters_used);
+	ut_asserteq(BIT(MMC_HUNTER) | BIT(SCSI_HUNTER), std->hunters_used);
 
 	ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
 	ut_assert_console_end();
@@ -657,7 +658,7 @@ static int bootdev_test_next_label(struct unit_test_state *uts)
 		    mflags);
 
 	/* dhcp: Ethernet is first so bit 0 */
-	ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
+	ut_asserteq(BIT(MMC_HUNTER) | BIT(SCSI_HUNTER) | BIT(0), std->hunters_used);
 
 	ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
 	ut_assert_console_end();
@@ -667,7 +668,7 @@ static int bootdev_test_next_label(struct unit_test_state *uts)
 		    mflags);
 
 	/* pxe: Ethernet is first so bit 0 */
-	ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
+	ut_asserteq(BIT(MMC_HUNTER) | BIT(SCSI_HUNTER) | BIT(0), std->hunters_used);
 
 	mflags = 123;
 	ut_asserteq(-ENODEV, bootdev_next_label(&iter, &dev, &mflags));
@@ -675,7 +676,7 @@ static int bootdev_test_next_label(struct unit_test_state *uts)
 	ut_assert_console_end();
 
 	/* no change */
-	ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
+	ut_asserteq(BIT(MMC_HUNTER) | BIT(SCSI_HUNTER) | BIT(0), std->hunters_used);
 
 	return 0;
 }
test/boot/bootflow.c +46 -0

55 lines not on this page · raw message

test/boot/bootstd_common.h +4 -1
index dd769313a842..672917454a31 100644
@@ -21,8 +21,11 @@
 #define TEST_VERNUM		0x00010002
 
 enum {
-	MAX_HUNTER	= 8,
 	MMC_HUNTER	= 2,	/* ID of MMC hunter */
+	HOST_HUNTER	= 5,
+	SCSI_HUNTER	= 6,
+	USB_HUNTER	= 8,
+	MAX_HUNTER	= 9,
 };
 
 struct unit_test_state;
Signature · 1 line
2.54.0
Reviewed-by on v4 2/2
#3 lore raw

Re: [PATCH v4 2/2] test: bootdev: scan with a broken high-priority device

Hi Denis,

Quoted 16 lines · None

test: bootdev: scan with a broken high-priority device

Add bootdev_hunt_fallthrough() test to verify that 'bootflow scan -l' falls back to a lower-priority bootdev when a higher-priority hunter fails.

Introduce a simple 'sandbox-bootdev' device for the test. The new bootdev can be configured to produce an error at the hunting stage.

Introduce new host_set_flags_by_label() API and a flags field to 'host_sb_plat' to simulate a bootdev hunter failure for the test.

Adjust boot{dev,flow} tests which depend on bootdev hunters.

Quoted 8 lines

drivers/block/Makefile | 2 +-

 drivers/block/host-uclass.c     | 15 +++++++++
 drivers/block/sandbox-bootdev.c | 73 +++++++++++++++++++++++++++++++++++++++++
 include/sandbox_host.h          | 18 ++++++++++
 test/boot/bootdev.c             | 23 ++++++-------
 test/boot/bootflow.c            | 46 ++++++++++++++++++++++++++
 test/boot/bootstd_common.h      |  5 ++-
 7 files changed, 169 insertions(+), 13 deletions(-)

code-style nits below

drivers/block/sandbox-bootdev.c line 11

Quoted 13 lines
drivers/block/sandbox-bootdev.c +11 -0
@@ -0,0 +1,73 @@
+/**
+ * sandbox_bootdev_hunt() - Hunt host bootdev.
+ *
+ * Note, this hunter exists for bootdev testing to simulate a fail
+ * mode.  Do not use as an example of a real hunter.
+ *
+ * @info: Hunder details.
+ * @show: Enable extra printouts.
+ *
+ * Returns: 0 if OK, -ve on error (expected by the test)
+ */

Typo: Hunder -> Hunter. Also 'a fail mode' reads better as 'a failure mode'.

drivers/block/sandbox-bootdev.c line 6

Quoted 8 lines
drivers/block/sandbox-bootdev.c +6 -0
@@ -0,0 +1,73 @@
+             if (plat->flags & HOST_FLAG_BROKEN) {
+                     ret = -ETIME;
+                     log_debug("cannot hunt sandbox device '%s': %d\n",
+                                     plat->label, ret);
+                     return ret;
+             }

Please align the continuation with the character after the open parenthesis (tab + spaces) (patman will check this for you)

test/boot/bootflow.c static int bootstd_images(struct unit_test_state *uts) · line 1538

Quoted 7 lines
test/boot/bootflow.c +5 -0
@@ -1532,3 +1534,47 @@ static int bootstd_images(struct unit_test_state *uts)
+     ut_assert(!(std->hunters_used & BIT(HOST_HUNTER)));
+
+     /* USB was hunted despite the sandbox hunter failure */
+     ut_assert(std->hunters_used & BIT(USB_HUNTER));
+     ut_assert_skip_to_line("Bus usb@1: 5 USB Device(s) found");

It might be worth asserting that 'Hunting with: host' appears before the USB one, so we know the host hunter was attempted?

Regards,
Simon

#4 lore raw

Re: [PATCH v4 2/2] test: bootdev: scan with a broken high-priority device

Quoted 28 lines · Simon Glass

Hi Denis,

Quoted 16 lines · None

test: bootdev: scan with a broken high-priority device

Add bootdev_hunt_fallthrough() test to verify that 'bootflow scan -l' falls back to a lower-priority bootdev when a higher-priority hunter fails.

Introduce a simple 'sandbox-bootdev' device for the test. The new bootdev can be configured to produce an error at the hunting stage.

Introduce new host_set_flags_by_label() API and a flags field to 'host_sb_plat' to simulate a bootdev hunter failure for the test.

Adjust boot{dev,flow} tests which depend on bootdev hunters.

Quoted 8 lines

drivers/block/Makefile | 2 +-

 drivers/block/host-uclass.c     | 15 +++++++++
 drivers/block/sandbox-bootdev.c | 73 +++++++++++++++++++++++++++++++++++++++++
 include/sandbox_host.h          | 18 ++++++++++
 test/boot/bootdev.c             | 23 ++++++-------
 test/boot/bootflow.c            | 46 ++++++++++++++++++++++++++
 test/boot/bootstd_common.h      |  5 ++-
 7 files changed, 169 insertions(+), 13 deletions(-)
Quoted 1 line

Thanks a lot for review!

I've made adjustements and sent out v5:
https://lore.kernel.org/u-boot/[email protected]/

Quoted 44 lines

code-style nits below

drivers/block/sandbox-bootdev.c line 11

Quoted 13 lines
drivers/block/sandbox-bootdev.c +11 -0
@@ -0,0 +1,73 @@
+/**
+ * sandbox_bootdev_hunt() - Hunt host bootdev.
+ *
+ * Note, this hunter exists for bootdev testing to simulate a fail
+ * mode.  Do not use as an example of a real hunter.
+ *
+ * @info: Hunder details.
+ * @show: Enable extra printouts.
+ *
+ * Returns: 0 if OK, -ve on error (expected by the test)
+ */

Typo: Hunder -> Hunter. Also 'a fail mode' reads better as 'a failure mode'.

drivers/block/sandbox-bootdev.c line 6

Quoted 8 lines
drivers/block/sandbox-bootdev.c +6 -0
@@ -0,0 +1,73 @@
+             if (plat->flags & HOST_FLAG_BROKEN) {
+                     ret = -ETIME;
+                     log_debug("cannot hunt sandbox device '%s': %d\n",
+                                     plat->label, ret);
+                     return ret;
+             }

Please align the continuation with the character after the open parenthesis (tab + spaces) (patman will check this for you)

test/boot/bootflow.c static int bootstd_images(struct unit_test_state *uts) · line 1538

Quoted 7 lines
test/boot/bootflow.c +5 -0
@@ -1532,3 +1534,47 @@ static int bootstd_images(struct unit_test_state *uts)
+     ut_assert(!(std->hunters_used & BIT(HOST_HUNTER)));
+
+     /* USB was hunted despite the sandbox hunter failure */
+     ut_assert(std->hunters_used & BIT(USB_HUNTER));
+     ut_assert_skip_to_line("Bus usb@1: 5 USB Device(s) found");

It might be worth asserting that 'Hunting with: host' appears before the USB one, so we know the host hunter was attempted?

Regards,
Simon