diff mbox series

[v4,1/5] disk: part: implement generic function part_get_info_by_uuid()

Message ID 20250513091710.3719292-2-quic_varada@quicinc.com
State Accepted
Delegated to: Tom Rini
Headers show
Series Enable env in SCSI | expand

Commit Message

Varadarajan Narayanan May 13, 2025, 9:17 a.m. UTC
Add function to search for a partition by UUID as partition
names may not be unique.

Signed-off-by: Varadarajan Narayanan <quic_varada@quicinc.com>
---
v4: Use if (!CONFIG_IS_ENABLED(PARTITION_UUIDS)) instead of '#if'

    Not breaking from the for loop if '->get_info()' returns non-zero
    to have similar behaviour as in part_get_info_by_name().
---
 disk/part.c    | 39 +++++++++++++++++++++++++++++++++++++++
 include/part.h | 20 ++++++++++++++++++++
 2 files changed, 59 insertions(+)

Comments

Heinrich Schuchardt June 1, 2025, 10:14 p.m. UTC | #1
On 5/13/25 11:17, Varadarajan Narayanan wrote:
> Add function to search for a partition by UUID as partition
> names may not be unique.
> 
> Signed-off-by: Varadarajan Narayanan <quic_varada@quicinc.com>
> ---
> v4: Use if (!CONFIG_IS_ENABLED(PARTITION_UUIDS)) instead of '#if'
> 
>      Not breaking from the for loop if '->get_info()' returns non-zero
>      to have similar behaviour as in part_get_info_by_name().
> ---
>   disk/part.c    | 39 +++++++++++++++++++++++++++++++++++++++
>   include/part.h | 20 ++++++++++++++++++++
>   2 files changed, 59 insertions(+)
> 
> diff --git a/disk/part.c b/disk/part.c
> index 303178161c0..8eefda39d7b 100644
> --- a/disk/part.c
> +++ b/disk/part.c
> @@ -698,6 +698,45 @@ int part_get_info_by_name(struct blk_desc *desc, const char *name,
>   	return -ENOENT;
>   }
>   
> +int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
> +			  struct disk_partition *info)
> +{
> +	struct part_driver *part_drv;
> +	int ret;
> +	int i;
> +
> +	if (!CONFIG_IS_ENABLED(PARTITION_UUIDS))
> +		return -ENOENT;
> +
> +	part_drv = part_driver_lookup_type(desc);
> +	if (!part_drv)
> +		return -1;
> +
> +	if (!part_drv->get_info) {
> +		log_debug("## Driver %s does not have the get_info() method\n",
> +			  part_drv->name);
> +		return -ENOSYS;
> +	}
> +
> +	for (i = 1; i < part_drv->max_entries; i++) {
> +		ret = part_drv->get_info(desc, i, info);
> +		if (ret != 0) {
> +			/*
> +			 * Partition with this index can't be obtained, but
> +			 * further partitions might be, so keep checking.
> +			 */
> +			continue;
> +		}
> +
> +		if (!strncasecmp(uuid, disk_partition_uuid(info), UUID_STR_LEN)) {
> +			/* matched */
> +			return i;
> +		}
> +	}
> +
> +	return -ENOENT;
> +}
> +
>   /**
>    * Get partition info from device number and partition name.
>    *
> diff --git a/include/part.h b/include/part.h
> index fcb3c13dea4..3e6eb0ec33f 100644
> --- a/include/part.h
> +++ b/include/part.h
> @@ -315,6 +315,20 @@ int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
>   int part_get_info_by_name(struct blk_desc *desc, const char *name,
>   			  struct disk_partition *info);
>   
> +/**
> + * part_get_info_by_uuid() - Search for a partition by uuid
> + *                           among all available registered partitions

When I read this I don't know if you mean:

* "partition type GUID" or
* "unique partition GUID".

The terms "partition type GUID" and "partition unique GUID" are defined 
in the UEFI specification.

https://uefi.org/specs/UEFI/2.11/05_GUID_Partition_Table_Format.html#gpt-partition-entry-array

Please, provide a concise description.

> + *
> + * @desc:	block device descriptor
> + * @uuid:	the specified table entry uuid

Every parameter is "specified". "Table entry uuid" isn't getting to the 
point, either. Please, use one of the established terms.

Calling a parameter "uuid" when the specification calls it "GUID" looks 
inconsistent.

Best regards

Heinrich

> + * @info:	the disk partition info
> + *
> + * Return: the partition number on match (starting on 1), -ENOENT on no match,
> + * otherwise error
> + */
> +int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
> +			  struct disk_partition *info);
> +
>   /**
>    * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
>    *					    and part name, or dev number and
> @@ -386,6 +400,12 @@ static inline int part_get_info_by_name(struct blk_desc *desc, const char *name,
>   	return -ENOENT;
>   }
>   
> +static inline int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
> +					struct disk_partition *info)
> +{
> +	return -ENOENT;
> +}
> +
>   static inline int
>   part_get_info_by_dev_and_name_or_num(const char *dev_iface,
>   				     const char *dev_part_str,
diff mbox series

Patch

diff --git a/disk/part.c b/disk/part.c
index 303178161c0..8eefda39d7b 100644
--- a/disk/part.c
+++ b/disk/part.c
@@ -698,6 +698,45 @@  int part_get_info_by_name(struct blk_desc *desc, const char *name,
 	return -ENOENT;
 }
 
+int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
+			  struct disk_partition *info)
+{
+	struct part_driver *part_drv;
+	int ret;
+	int i;
+
+	if (!CONFIG_IS_ENABLED(PARTITION_UUIDS))
+		return -ENOENT;
+
+	part_drv = part_driver_lookup_type(desc);
+	if (!part_drv)
+		return -1;
+
+	if (!part_drv->get_info) {
+		log_debug("## Driver %s does not have the get_info() method\n",
+			  part_drv->name);
+		return -ENOSYS;
+	}
+
+	for (i = 1; i < part_drv->max_entries; i++) {
+		ret = part_drv->get_info(desc, i, info);
+		if (ret != 0) {
+			/*
+			 * Partition with this index can't be obtained, but
+			 * further partitions might be, so keep checking.
+			 */
+			continue;
+		}
+
+		if (!strncasecmp(uuid, disk_partition_uuid(info), UUID_STR_LEN)) {
+			/* matched */
+			return i;
+		}
+	}
+
+	return -ENOENT;
+}
+
 /**
  * Get partition info from device number and partition name.
  *
diff --git a/include/part.h b/include/part.h
index fcb3c13dea4..3e6eb0ec33f 100644
--- a/include/part.h
+++ b/include/part.h
@@ -315,6 +315,20 @@  int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
 int part_get_info_by_name(struct blk_desc *desc, const char *name,
 			  struct disk_partition *info);
 
+/**
+ * part_get_info_by_uuid() - Search for a partition by uuid
+ *                           among all available registered partitions
+ *
+ * @desc:	block device descriptor
+ * @uuid:	the specified table entry uuid
+ * @info:	the disk partition info
+ *
+ * Return: the partition number on match (starting on 1), -ENOENT on no match,
+ * otherwise error
+ */
+int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
+			  struct disk_partition *info);
+
 /**
  * part_get_info_by_dev_and_name_or_num() - Get partition info from dev number
  *					    and part name, or dev number and
@@ -386,6 +400,12 @@  static inline int part_get_info_by_name(struct blk_desc *desc, const char *name,
 	return -ENOENT;
 }
 
+static inline int part_get_info_by_uuid(struct blk_desc *desc, const char *uuid,
+					struct disk_partition *info)
+{
+	return -ENOENT;
+}
+
 static inline int
 part_get_info_by_dev_and_name_or_num(const char *dev_iface,
 				     const char *dev_part_str,