bdev: remove all aliases on unregister

All aliases are removed when bdev is unregistered.

Change-Id: I2b15eb49572d4fc2eedec8eb8b2dcad5d5406b1f
Signed-off-by: Tiago Castro <[email protected]>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/27179
Reviewed-by: Jim Harris <[email protected]>
Tested-by: SPDK Automated Test System <[email protected]>
Community-CI: Mellanox Build Bot
Reviewed-by: Jacek Kalwas <[email protected]>

Author: tiagolobocastro

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## v25.05.1: (Upcoming Release)
 
+### bdev
+
+All aliases are now removed from the block device names list upon unregistration.
+
 ## v25.05: NVMe PCIe interrupt mode, DIF insert/strip, mlx5 accel platform driver
 
 ### accel_mlx5

include/spdk/bdev_module.h

@@ -1243,6 +1243,7 @@ void spdk_bdev_module_fini_start_done(void);
 /**
  * Add alias to block device names list.
  * Aliases can be add only to registered bdev.
+ * All aliases are removed when bdev is unregistered.
  *
  * \param bdev Block device to query.
  * \param alias Alias to be added to list.

lib/bdev/bdev.c

@@ -5054,18 +5054,24 @@ spdk_bdev_alias_del(struct spdk_bdev *bdev, const char *alias)
 	return rc;
 }
 
-void
-spdk_bdev_alias_del_all(struct spdk_bdev *bdev)
+static void
+bdev_alias_del_all(struct spdk_bdev *bdev, void (*alias_del_fn)(struct spdk_bdev_name *n))
 {
 	struct spdk_bdev_alias *p, *tmp;
 
 	TAILQ_FOREACH_SAFE(p, &bdev->aliases, tailq, tmp) {
 		TAILQ_REMOVE(&bdev->aliases, p, tailq);
-		bdev_name_del(&p->alias);
+		alias_del_fn(&p->alias);
 		free(p);
 	}
 }
 
+void
+spdk_bdev_alias_del_all(struct spdk_bdev *bdev)
+{
+	bdev_alias_del_all(bdev, bdev_name_del);
+}
+
 struct spdk_io_channel *
 spdk_bdev_get_io_channel(struct spdk_bdev_desc *desc)
 {
@@ -8408,7 +8414,6 @@ bdev_unregister_unsafe(struct spdk_bdev *bdev)
 	struct spdk_bdev_desc	*desc, *tmp;
 	struct spdk_bdev_alias	*alias;
 	int			rc = 0;
-	char			uuid[SPDK_UUID_STRING_LEN];
 
 	assert(spdk_spin_held(&g_bdev_mgr.spinlock));
 	assert(spdk_spin_held(&bdev->internal.spinlock));
@@ -8431,13 +8436,12 @@ bdev_unregister_unsafe(struct spdk_bdev *bdev)
 		TAILQ_FOREACH(alias, &bdev->aliases, tailq) {
 			bdev_examine_allowlist_remove(alias->alias.name);
 		}
+		bdev_alias_del_all(bdev, bdev_name_del_unsafe);
 		TAILQ_REMOVE(&g_bdev_mgr.bdevs, bdev, internal.link);
 		SPDK_DEBUGLOG(bdev, "Removing bdev %s from list done\n", bdev->name);
 
-		/* Delete the name and the UUID alias */
-		spdk_uuid_fmt_lower(uuid, sizeof(uuid), &bdev->uuid);
+		/* Delete the name */
 		bdev_name_del_unsafe(&bdev->internal.bdev_name);
-		bdev_alias_del(bdev, uuid, bdev_name_del_unsafe);
 
 		spdk_notify_send("bdev_unregister", spdk_bdev_get_name(bdev));
 

test/unit/lib/bdev/bdev.c/bdev_ut.c

@@ -1132,6 +1132,45 @@ alias_add_del_test(void)
 	ut_fini_bdev();
 }
 
+static void
+alias_add_del_all_test(void)
+{
+	struct spdk_bdev *bdev;
+	char uuid[SPDK_UUID_STRING_LEN];
+	int rc;
+
+	ut_init_bdev(NULL);
+
+	bdev = allocate_bdev("bdev");
+	SPDK_CU_ASSERT_FATAL(bdev != 0);
+
+	poll_threads();
+
+	/* Check that an UUID alias was registered */
+	spdk_uuid_fmt_lower(uuid, sizeof(uuid), &bdev->uuid);
+	CU_ASSERT_EQUAL(spdk_bdev_get_by_name(uuid), bdev);
+
+	rc = spdk_bdev_alias_add(bdev, "custom-alias");
+	CU_ASSERT(rc == 0);
+
+	CU_ASSERT_PTR_NOT_NULL(spdk_bdev_get_by_name(uuid));
+	CU_ASSERT_PTR_NOT_NULL(spdk_bdev_get_by_name("bdev"));
+	CU_ASSERT_PTR_NOT_NULL(spdk_bdev_get_by_name("custom-alias"));
+
+	/* Unregister and free bdev */
+	spdk_bdev_unregister(bdev, NULL, NULL);
+
+	poll_threads();
+
+	CU_ASSERT_PTR_NULL(spdk_bdev_get_by_name(uuid));
+	CU_ASSERT_PTR_NULL(spdk_bdev_get_by_name("bdev"));
+	CU_ASSERT_PTR_NULL(spdk_bdev_get_by_name("custom-alias"));
+
+	free(bdev);
+
+	ut_fini_bdev();
+}
+
 static void
 io_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
 {
@@ -7772,6 +7811,7 @@ main(int argc, char **argv)
 	CU_ADD_TEST(suite, open_write_test);
 	CU_ADD_TEST(suite, claim_test);
 	CU_ADD_TEST(suite, alias_add_del_test);
+	CU_ADD_TEST(suite, alias_add_del_all_test);
 	CU_ADD_TEST(suite, get_device_stat_test);
 	CU_ADD_TEST(suite, bdev_io_types_test);
 	CU_ADD_TEST(suite, bdev_io_wait_test);