Fix Uberblock Label and Path Handling Issues related to AUX vdevs #15737

ixhamza · 2024-01-04T19:36:43Z

This PR addresses three similar issues for AUX vdevs:

Ensure uberblock label always dumped: When spare or l2cache (aux) vdev is added during pool creation, spa->spa_uberblock is not dumped until that point. Subsequently, the aux label is never synchronized after its initial creation, resulting in the uberblock label remaining undumped. The uberblock is crucial for lib_blkid in identifying the ZFS partition type. To address this issue, we now ensure sync of the uberblock label once if it's not dumped initially.
Extend aux label to add path information: Pool import logic uses vdev paths, so it makes sense to add path information on AUX vdev as well.
Add path handling for aux vdevs in label_path: If the AUX vdev is added using UUID, importing the pool falls back AUX vdev to open it with disk name instead of UUID due to the absence of path information for AUX vdevs previously. Since AUX label now have path information, this PR adds path handling for it in label_path.

How Has This Been Tested?

Uberblock label issue (Used by libblkid to identify zfs partition type)

Before this patch

# zpool create tank sdb spare sdc
# dd if=/dev/sdc1 bs=256K count=1 | hexdump -C -v | grep "0c b1 ba"
# udevadm info /dev/sdc1 | grep zfs_member

After this patch:

# zpool create tank sdb spare sdc
# dd if=/dev/sdc1 bs=256K count=1 | hexdump -C -v | grep "0c b1 ba"
00021000  0c b1 ba 00 00 00 00 00  88 13 00 00 00 00 00 00  |................|
# udevadm info /dev/sdc1 | grep zfs_member
E: ID_FS_TYPE=zfs_member

Extended AUX label

Before the patch

# zdb -l /dev/sdc1
------------------------------------
LABEL 0 
------------------------------------
    version: 5000
    state: 3
    guid: 15986349143942038035
    labels = 0 1 2 3

After the patch:

# zdb -l /dev/sdc1
------------------------------------
LABEL 0 
------------------------------------
    version: 5000
    state: 3
    guid: 15986349143942038035
    path: '/dev/sdc1'
    devid: 'scsi-0QEMU_QEMU_HARDDISK_drive4-part1'
    phys_path: 'pci-0000:00:05.0-scsi-0:0:1:1'
    labels = 0 1 2 3

Issue with AUX UUID during pool import

Before the patch:

# zpool create tank 59768b84-1aea-b649-82f8-e837a54be4ff
# zpool add tank spare 2e0105d0-f092-1f43-bb14-52d1e858116f
# zpool status
  pool: tank
 state: ONLINE
config:
	NAME                                    STATE     READ WRITE CKSUM
	tank                                    ONLINE       0     0     0
	  59768b84-1aea-b649-82f8-e837a54be4ff  ONLINE       0     0     0
	spares
	  2e0105d0-f092-1f43-bb14-52d1e858116f  AVAIL   
# zpool export tank
# zpool import tank
# zpool status
  pool: tank
 state: ONLINE
config:
	NAME                                    STATE     READ WRITE CKSUM
	tank                                    ONLINE       0     0     0
	  59768b84-1aea-b649-82f8-e837a54be4ff  ONLINE       0     0     0
	spares
	  sdc  AVAIL

After the patch:

# zpool create tank 59768b84-1aea-b649-82f8-e837a54be4ff
# zpool add tank spare 2e0105d0-f092-1f43-bb14-52d1e858116f
# zpool status
  pool: tank
 state: ONLINE
config:
	NAME                                    STATE     READ WRITE CKSUM
	tank                                    ONLINE       0     0     0
	  59768b84-1aea-b649-82f8-e837a54be4ff  ONLINE       0     0     0
	spares
	  2e0105d0-f092-1f43-bb14-52d1e858116f  AVAIL   
# zpool export tank
# zpool import tank
# zpool status
  pool: tank
 state: ONLINE
config:
	NAME                                    STATE     READ WRITE CKSUM
	tank                                    ONLINE       0     0     0
	  59768b84-1aea-b649-82f8-e837a54be4ff  ONLINE       0     0     0
	spares
	  2e0105d0-f092-1f43-bb14-52d1e858116f  AVAIL

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Performance enhancement (non-breaking change which improves efficiency)
Code cleanup (non-breaking change which makes code smaller or more readable)
Breaking change (fix or feature that would cause existing functionality to change)
Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
Documentation (a change to man pages or other documentation)

Checklist:

My code follows the OpenZFS code style requirements.
I have updated the documentation accordingly.
I have read the contributing document.
I have added tests to cover my changes.
I have run the ZFS Test Suite with this change applied.
All commit messages are properly formatted and contain Signed-off-by.

amotin

Generally looks good to me, just few cosmetic nits.

lib/libzutil/zutil_import.c

module/zfs/vdev_label.c

When spare or l2cache (aux) vdev is added during pool creation, spa->spa_uberblock is not dumped until that point. Subsequently, the aux label is never synchronized after its initial creation, resulting in the uberblock label remaining undumped. The uberblock is crucial for lib_blkid in identifying the ZFS partition type. To address this issue, we now ensure sync of the uberblock label once if it's not dumped initially. Signed-off-by: Ameer Hamza <[email protected]>

Pool import logic uses vdev paths, so it makes sense to add path information on AUX vdev as well. Signed-off-by: Ameer Hamza <[email protected]>

lib/libzutil/zutil_import.c

If the AUX vdev is added using UUID, importing the pool falls back AUX vdev to open it with disk name instead of UUID due to the absence of path information for AUX vdevs. Since AUX label now have path information, this PR adds path handling for it in `label_path`. Signed-off-by: Ameer Hamza <[email protected]>

Pool import logic uses vdev paths, so it makes sense to add path information on AUX vdev as well. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes #15737

If the AUX vdev is added using UUID, importing the pool falls back AUX vdev to open it with disk name instead of UUID due to the absence of path information for AUX vdevs. Since AUX label now have path information, this PR adds path handling for it in `label_path`. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes #15737

When spare or l2cache (aux) vdev is added during pool creation, spa->spa_uberblock is not dumped until that point. Subsequently, the aux label is never synchronized after its initial creation, resulting in the uberblock label remaining undumped. The uberblock is crucial for lib_blkid in identifying the ZFS partition type. To address this issue, we now ensure sync of the uberblock label once if it's not dumped initially. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes openzfs#15737

Pool import logic uses vdev paths, so it makes sense to add path information on AUX vdev as well. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes openzfs#15737

If the AUX vdev is added using UUID, importing the pool falls back AUX vdev to open it with disk name instead of UUID due to the absence of path information for AUX vdevs. Since AUX label now have path information, this PR adds path handling for it in `label_path`. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes openzfs#15737

When spare or l2cache (aux) vdev is added during pool creation, spa->spa_uberblock is not dumped until that point. Subsequently, the aux label is never synchronized after its initial creation, resulting in the uberblock label remaining undumped. The uberblock is crucial for lib_blkid in identifying the ZFS partition type. To address this issue, we now ensure sync of the uberblock label once if it's not dumped initially. Reviewed-by: Umer Saleem <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Ameer Hamza <[email protected]> Closes #15737