[PATCH v3 6/8] cmd: gpt: Preserve type GUID if enabled

[Heinrich Schuchardt]

On 8/25/23 21:38, Joshua Watt wrote:
> If CONFIG_PARTITION_TYPE_GUID is enabled, the type GUID will be
> preserved when writing out the partition string. It was already
> respected when writing out partitions; this ensures that if you capture
> the current partition layout and write it back (such as when renaming),
> the type GUIDs are preserved.
> 
> Signed-off-by: Joshua Watt <JPEWhacker at gmail.com>
> Reviewed-by: Simon Glass <sjg at chromium.org>
> ---
>   cmd/gpt.c                 | 16 ++++++++++
>   test/py/tests/test_gpt.py | 66 +++++++++++++++++++++++++++++++++++++++
>   2 files changed, 82 insertions(+)
> 
> diff --git a/cmd/gpt.c b/cmd/gpt.c
> index 1fe7f1a7db..b7d861aa1e 100644
> --- a/cmd/gpt.c
> +++ b/cmd/gpt.c
> @@ -173,6 +173,9 @@ static int calc_parts_list_len(int numparts)
>   	/* see part.h for definition of struct disk_partition */
>   	partlistlen += numparts * (strlen("start=MiB,") + sizeof(lbaint_t) + 1);
>   	partlistlen += numparts * (strlen("size=MiB,") + sizeof(lbaint_t) + 1);
> +#ifdef CONFIG_PARTITION_TYPE_GUID
> +	partlistlen += numparts * (strlen("type=,") + UUID_STR_LEN + 1);
> +#endif
>   	partlistlen += numparts * (strlen("uuid=;") + UUID_STR_LEN + 1);
>   	/* for the terminating null */
>   	partlistlen++;
> @@ -211,6 +214,11 @@ static struct disk_part *allocate_disk_part(struct disk_partition *info,
>   		PART_TYPE_LEN);
>   	newpart->gpt_part_info.type[PART_TYPE_LEN - 1] = '\0';
>   	newpart->gpt_part_info.bootable = info->bootable;
> +#ifdef CONFIG_PARTITION_TYPE_GUID
> +	strncpy(newpart->gpt_part_info.type_guid, (const char *)info->type_guid,
> +		UUID_STR_LEN);
> +	newpart->gpt_part_info.type_guid[UUID_STR_LEN] = '\0';
> +#endif
>   #ifdef CONFIG_PARTITION_UUIDS
>   	strncpy(newpart->gpt_part_info.uuid, (const char *)info->uuid,
>   		UUID_STR_LEN);
> @@ -252,6 +260,9 @@ static void print_gpt_info(void)
>   		       curr->gpt_part_info.name);
>   		printf("Type %s, bootable %d\n", curr->gpt_part_info.type,
>   		       curr->gpt_part_info.bootable & PART_BOOTABLE);
> +#ifdef CONFIG_PARTITION_TYPE_GUID
> +		printf("Type GUID %s\n", curr->gpt_part_info.type_guid);
> +#endif
>   #ifdef CONFIG_PARTITION_UUIDS
>   		printf("UUID %s\n", curr->gpt_part_info.uuid);
>   #endif
> @@ -299,6 +310,11 @@ static int create_gpt_partitions_list(int numparts, const char *guid,
>   					    curr->gpt_part_info.blksz);
>   		strncat(partitions_list, partstr, PART_NAME_LEN + 1);
>   
> +#ifdef CONFIG_PARTITION_TYPE_GUID
> +		strcat(partitions_list, ",type=");
> +		strncat(partitions_list, curr->gpt_part_info.type_guid,
> +			UUID_STR_LEN + 1);
> +#endif
>   		strcat(partitions_list, ",uuid=");
>   		strncat(partitions_list, curr->gpt_part_info.uuid,
>   			UUID_STR_LEN + 1);
> diff --git a/test/py/tests/test_gpt.py b/test/py/tests/test_gpt.py
> index 5d23f9b292..09a90f026f 100644
> --- a/test/py/tests/test_gpt.py
> +++ b/test/py/tests/test_gpt.py
> @@ -16,6 +16,35 @@ the test.
>   # Mark all tests here as slow
>   pytestmark = pytest.mark.slow
>   
> +def parse_gpt_parts(disk_str):
> +    """Parser a partition string into a list of partitions.
> +
> +    Args:
> +        disk_str: The disk description string, as returned by `gpt read`
> +
> +    Returns:
> +        A list of parsed partitions. Each partition is a dictionary with the
> +        string value from each specified key in the partition description, or a
> +        key with with the value True for a boolean flag
> +    """
> +    parts = []
> +    for part_str in disk_str.split(';'):
> +        part = {}
> +        for option in part_str.split(","):
> +            if not option:
> +                continue
> +
> +            if "=" in option:
> +                k, v = option.split("=")

This results in a pylint warning:

C0103: Variable name "v" doesn't conform to snake_case naming style 
(invalid-name)

How about key, value?

> +                part[k] = v
> +            else:
> +                part[option] = True
> +
> +        if part:
> +            parts.append(part)
> +
> +    return parts
> +
>   class GptTestDiskImage(object):
>       """Disk Image used by the GPT tests."""
>   
> @@ -49,11 +78,13 @@ class GptTestDiskImage(object):
>                   u_boot_utils.run_and_log(u_boot_console, cmd)
>                   # part1 offset 1MB size 1MB
>                   cmd = ('sgdisk', '--new=1:2048:4095', '--change-name=1:part1',
> +                    '--partition-guid=1:33194895-67f6-4561-8457-6fdeed4f50a3',
>                       '-A 1:set:2',
>                       persistent)
>                   # part2 offset 2MB size 1.5MB
>                   u_boot_utils.run_and_log(u_boot_console, cmd)
>                   cmd = ('sgdisk', '--new=2:4096:7167', '--change-name=2:part2',
> +                    '--partition-guid=2:cc9c6e4a-6551-4cb5-87be-3210f96c86fb',
>                       persistent)
>                   u_boot_utils.run_and_log(u_boot_console, cmd)
>                   cmd = ('sgdisk', '--load-backup=' + persistent)
> @@ -88,6 +119,40 @@ def test_gpt_read(state_disk_image, u_boot_console):
>       assert '0x00000800	0x00000fff	"part1"' in output
>       assert '0x00001000	0x00001bff	"part2"' in output
>   
> + at pytest.mark.boardspec('sandbox')
> + at pytest.mark.buildconfigspec('cmd_gpt')
> + at pytest.mark.buildconfigspec('partition_type_guid')
> + at pytest.mark.requiredtool('sgdisk')
> +def test_gpt_read_var(state_disk_image, u_boot_console):
> +    """Test the gpt read command."""
> +
> +    u_boot_console.run_command('host bind 0 ' + state_disk_image.path)
> +    output = u_boot_console.run_command('gpt read host 0 gpt_parts')
> +    assert 'success!' in output
> +
> +    output = u_boot_console.run_command('echo ${gpt_parts}')
> +    parts = parse_gpt_parts(output.rstrip())
> +
> +    assert parts == [
> +        {
> +            "uuid_disk": "375a56f7-d6c9-4e81-b5f0-09d41ca89efe",
> +        },
> +        {
> +            "name": "part1",
> +            "start": "0x100000",
> +            "size": "0x100000",
> +            "type": "0fc63daf-8483-4772-8e79-3d69d8477de4",
> +            "uuid": "33194895-67f6-4561-8457-6fdeed4f50a3",
> +        },
> +        {
> +            "name": "part2",
> +            "start": "0x200000",
> +            "size": "0x180000",
> +            "type": "0fc63daf-8483-4772-8e79-3d69d8477de4",
> +            "uuid": "cc9c6e4a-6551-4cb5-87be-3210f96c86fb",
> +        },
> +    ]
> +
>   @pytest.mark.boardspec('sandbox')
>   @pytest.mark.buildconfigspec('cmd_gpt')
>   @pytest.mark.requiredtool('sgdisk')
> @@ -263,3 +328,4 @@ def test_gpt_write(state_disk_image, u_boot_console):
>       assert '0x00001000	0x00001bff	"second"' in output
>       output = u_boot_console.run_command('gpt guid host 0')
>       assert '375a56f7-d6c9-4e81-b5f0-09d41ca89efe' in output
> +

Please, remove this white space line.

Best regards

Heinrich