1 // SPDX-License-Identifier: GPL-2.0+
3 * cmd_gpt.c -- GPT (GUID Partition Table) handling command
6 * Lukasz Majewski <l.majewski@majess.pl>
8 * Copyright (C) 2012 Samsung Electronics
9 * author: Lukasz Majewski <l.majewski@samsung.com>
10 * author: Piotr Wilczek <p.wilczek@samsung.com>
20 #include <linux/ctype.h>
23 #include <linux/compat.h>
24 #include <linux/err.h>
25 #include <linux/sizes.h>
28 static LIST_HEAD(disk_partitions);
31 * extract_env(): Expand env name from string format '&{env_name}'
32 * and return pointer to the env (if the env is set)
34 * @param str - pointer to string
35 * @param env - pointer to pointer to extracted env
37 * @return - zero on successful expand and env is set
39 static int extract_env(const char *str, char **env)
43 #ifdef CONFIG_RANDOM_UUID
44 char uuid_str[UUID_STR_LEN + 1];
47 if (!str || strlen(str) < 4)
50 if (!((strncmp(str, "${", 2) == 0) && (str[strlen(str) - 1] == '}')))
57 memset(s + strlen(s) - 1, '\0', 1);
58 memmove(s, s + 2, strlen(s) - 1);
62 #ifdef CONFIG_RANDOM_UUID
63 debug("%s unset. ", str);
64 gen_rand_uuid_str(uuid_str, UUID_STR_FORMAT_GUID);
69 debug("Set to random.\n");
72 debug("Can't get random UUID.\n");
75 debug("%s unset.\n", str);
78 debug("%s get from environment.\n", str);
89 * extract_val(): Extract value from a key=value pair list (comma separated).
90 * Only value for the given key is returend.
91 * Function allocates memory for the value, remember to free!
93 * @param str - pointer to string with key=values pairs
94 * @param key - pointer to the key to search for
96 * @return - pointer to allocated string with the value
98 static char *extract_val(const char *str, const char *key)
104 strcopy = strdup(str);
116 if (strcmp(k, key) == 0) {
128 * found_key(): Found key without value in parameter list (comma separated).
130 * @param str - pointer to string with key
131 * @param key - pointer to the key to search for
133 * @return - true on found key
135 static bool found_key(const char *str, const char *key)
141 strcopy = strdup(str);
150 if (strcmp(k, key) == 0) {
161 static int calc_parts_list_len(int numparts)
163 int partlistlen = UUID_STR_LEN + 1 + strlen("uuid_disk=");
167 /* per-partition additions; numparts starts at 1, so this should be correct */
168 partlistlen += numparts * (strlen("name=,") + PART_NAME_LEN + 1);
169 /* see part.h for definition of struct disk_partition */
170 partlistlen += numparts * (strlen("start=MiB,") + sizeof(lbaint_t) + 1);
171 partlistlen += numparts * (strlen("size=MiB,") + sizeof(lbaint_t) + 1);
172 partlistlen += numparts * (strlen("uuid=;") + UUID_STR_LEN + 1);
173 /* for the terminating null */
175 debug("Length of partitions_list is %d for %d partitions\n", partlistlen,
180 #ifdef CONFIG_CMD_GPT_RENAME
181 static void del_gpt_info(void)
183 struct list_head *pos = &disk_partitions;
184 struct disk_part *curr;
185 while (!list_empty(pos)) {
186 curr = list_entry(pos->next, struct disk_part, list);
192 static struct disk_part *allocate_disk_part(struct disk_partition *info,
195 struct disk_part *newpart;
196 newpart = calloc(1, sizeof(struct disk_part));
198 return ERR_PTR(-ENOMEM);
200 newpart->gpt_part_info.start = info->start;
201 newpart->gpt_part_info.size = info->size;
202 newpart->gpt_part_info.blksz = info->blksz;
203 strncpy((char *)newpart->gpt_part_info.name, (const char *)info->name,
205 newpart->gpt_part_info.name[PART_NAME_LEN - 1] = '\0';
206 strncpy((char *)newpart->gpt_part_info.type, (const char *)info->type,
208 newpart->gpt_part_info.type[PART_TYPE_LEN - 1] = '\0';
209 newpart->gpt_part_info.bootable = info->bootable;
210 #ifdef CONFIG_PARTITION_UUIDS
211 strncpy(newpart->gpt_part_info.uuid, (const char *)info->uuid,
213 /* UUID_STR_LEN is correct, as uuid[]'s length is UUID_STR_LEN+1 chars */
214 newpart->gpt_part_info.uuid[UUID_STR_LEN] = '\0';
216 newpart->partnum = partnum;
221 static void prettyprint_part_size(char *sizestr, lbaint_t partsize,
224 unsigned long long partbytes, partmegabytes;
226 partbytes = partsize * blksize;
227 partmegabytes = lldiv(partbytes, SZ_1M);
228 snprintf(sizestr, 16, "%lluMiB", partmegabytes);
231 static void print_gpt_info(void)
233 struct list_head *pos;
234 struct disk_part *curr;
235 char partstartstr[16];
236 char partsizestr[16];
238 list_for_each(pos, &disk_partitions) {
239 curr = list_entry(pos, struct disk_part, list);
240 prettyprint_part_size(partstartstr, curr->gpt_part_info.start,
241 curr->gpt_part_info.blksz);
242 prettyprint_part_size(partsizestr, curr->gpt_part_info.size,
243 curr->gpt_part_info.blksz);
245 printf("Partition %d:\n", curr->partnum);
246 printf("Start %s, size %s\n", partstartstr, partsizestr);
247 printf("Block size %lu, name %s\n", curr->gpt_part_info.blksz,
248 curr->gpt_part_info.name);
249 printf("Type %s, bootable %d\n", curr->gpt_part_info.type,
250 curr->gpt_part_info.bootable & PART_BOOTABLE);
251 #ifdef CONFIG_PARTITION_UUIDS
252 printf("UUID %s\n", curr->gpt_part_info.uuid);
259 * create the string that upstream 'gpt write' command will accept as an
262 * From doc/README.gpt, Format of partitions layout:
263 * "uuid_disk=...;name=u-boot,size=60MiB,uuid=...;
264 * name=kernel,size=60MiB,uuid=...;"
265 * The fields 'name' and 'size' are mandatory for every partition.
266 * The field 'start' is optional. The fields 'uuid' and 'uuid_disk'
267 * are optional if CONFIG_RANDOM_UUID is enabled.
269 static int create_gpt_partitions_list(int numparts, const char *guid,
270 char *partitions_list)
272 struct list_head *pos;
273 struct disk_part *curr;
274 char partstr[PART_NAME_LEN + 1];
276 if (!partitions_list)
279 strcpy(partitions_list, "uuid_disk=");
280 strncat(partitions_list, guid, UUID_STR_LEN + 1);
281 strcat(partitions_list, ";");
283 list_for_each(pos, &disk_partitions) {
284 curr = list_entry(pos, struct disk_part, list);
285 strcat(partitions_list, "name=");
286 strncat(partitions_list, (const char *)curr->gpt_part_info.name,
288 sprintf(partstr, ",start=0x%llx",
289 (unsigned long long)curr->gpt_part_info.start *
290 curr->gpt_part_info.blksz);
291 /* one extra byte for NULL */
292 strncat(partitions_list, partstr, PART_NAME_LEN + 1);
293 sprintf(partstr, ",size=0x%llx",
294 (unsigned long long)curr->gpt_part_info.size *
295 curr->gpt_part_info.blksz);
296 strncat(partitions_list, partstr, PART_NAME_LEN + 1);
298 strcat(partitions_list, ",uuid=");
299 strncat(partitions_list, curr->gpt_part_info.uuid,
301 strcat(partitions_list, ";");
307 * read partition info into disk_partitions list where
308 * it can be printed or modified
310 static int get_gpt_info(struct blk_desc *dev_desc)
312 /* start partition numbering at 1, as U-Boot does */
313 int valid_parts = 0, p, ret;
314 struct disk_partition info;
315 struct disk_part *new_disk_part;
318 * Always re-read partition info from device, in case
321 INIT_LIST_HEAD(&disk_partitions);
323 for (p = 1; p <= MAX_SEARCH_PARTITIONS; p++) {
324 ret = part_get_info(dev_desc, p, &info);
328 /* Add 1 here because counter is zero-based but p1 is
329 the first partition */
330 new_disk_part = allocate_disk_part(&info, valid_parts+1);
331 if (IS_ERR(new_disk_part))
334 list_add_tail(&new_disk_part->list, &disk_partitions);
337 if (valid_parts == 0) {
338 printf("** No valid partitions found **\n");
343 if (valid_parts >= 1)
348 /* a wrapper to test get_gpt_info */
349 static int do_get_gpt_info(struct blk_desc *dev_desc)
353 ret = get_gpt_info(dev_desc);
364 * set_gpt_info(): Fill partition information from string
365 * function allocates memory, remember to free!
367 * @param dev_desc - pointer block device descriptor
368 * @param str_part - pointer to string with partition information
369 * @param str_disk_guid - pointer to pointer to allocated string with disk guid
370 * @param partitions - pointer to pointer to allocated partitions array
371 * @param parts_count - number of partitions
373 * @return - zero on success, otherwise error
376 static int set_gpt_info(struct blk_desc *dev_desc,
377 const char *str_part,
378 char **str_disk_guid,
379 struct disk_partition **partitions,
386 struct disk_partition *parts;
388 uint64_t size_ll, start_ll;
390 int max_str_part = calc_parts_list_len(MAX_SEARCH_PARTITIONS);
392 debug("%s: lba num: 0x%x %d\n", __func__,
393 (unsigned int)dev_desc->lba, (unsigned int)dev_desc->lba);
395 if (str_part == NULL)
398 str = strdup(str_part);
402 /* extract disk guid */
404 val = extract_val(str, "uuid_disk");
406 #ifdef CONFIG_RANDOM_UUID
407 *str_disk_guid = malloc(UUID_STR_LEN + 1);
408 if (*str_disk_guid == NULL)
410 gen_rand_uuid_str(*str_disk_guid, UUID_STR_FORMAT_STD);
416 val = strsep(&val, ";");
417 if (extract_env(val, &p))
419 *str_disk_guid = strdup(p);
421 /* Move s to first partition */
425 printf("Error: is the partitions string NULL-terminated?\n");
428 if (strnlen(s, max_str_part) == 0)
431 i = strnlen(s, max_str_part) - 1;
435 /* calculate expected number of partitions */
443 /* allocate memory for partitions */
444 parts = calloc(sizeof(struct disk_partition), p_count);
448 /* retrieve partitions data from string */
449 for (i = 0; i < p_count; i++) {
450 tok = strsep(&s, ";");
456 val = extract_val(tok, "uuid");
458 /* 'uuid' is optional if random uuid's are enabled */
459 #ifdef CONFIG_RANDOM_UUID
460 gen_rand_uuid_str(parts[i].uuid, UUID_STR_FORMAT_STD);
466 if (extract_env(val, &p))
468 if (strnlen(p, max_str_part) >= sizeof(parts[i].uuid)) {
469 printf("Wrong uuid format for partition %d\n", i);
473 strncpy((char *)parts[i].uuid, p, max_str_part);
476 #ifdef CONFIG_PARTITION_TYPE_GUID
478 val = extract_val(tok, "type");
480 /* 'type' is optional */
481 if (extract_env(val, &p))
483 if (strnlen(p, max_str_part) >= sizeof(parts[i].type_guid)) {
484 printf("Wrong type guid format for partition %d\n",
489 strncpy((char *)parts[i].type_guid, p, max_str_part);
494 val = extract_val(tok, "name");
495 if (!val) { /* name is mandatory */
499 if (extract_env(val, &p))
501 if (strnlen(p, max_str_part) >= sizeof(parts[i].name)) {
505 strncpy((char *)parts[i].name, p, max_str_part);
509 val = extract_val(tok, "size");
510 if (!val) { /* 'size' is mandatory */
514 if (extract_env(val, &p))
516 if ((strcmp(p, "-") == 0)) {
517 /* Let part efi module to auto extend the size */
520 size_ll = ustrtoull(p, &p, 0);
521 parts[i].size = lldiv(size_ll, dev_desc->blksz);
527 val = extract_val(tok, "start");
528 if (val) { /* start address is optional */
529 if (extract_env(val, &p))
531 start_ll = ustrtoull(p, &p, 0);
532 parts[i].start = lldiv(start_ll, dev_desc->blksz);
536 offset += parts[i].size + parts[i].start;
539 if (found_key(tok, "bootable"))
540 parts[i].bootable = PART_BOOTABLE;
543 *parts_count = p_count;
550 free(*str_disk_guid);
556 static int gpt_default(struct blk_desc *blk_dev_desc, const char *str_part)
561 struct disk_partition *partitions = NULL;
563 /* fill partitions */
564 ret = set_gpt_info(blk_dev_desc, str_part,
565 &str_disk_guid, &partitions, &part_count);
568 printf("No partition list provided\n");
570 printf("Missing disk guid\n");
571 if ((ret == -3) || (ret == -4))
572 printf("Partition list incomplete\n");
576 /* save partitions layout to disk */
577 ret = gpt_restore(blk_dev_desc, str_disk_guid, partitions, part_count);
584 static int gpt_verify(struct blk_desc *blk_dev_desc, const char *str_part)
586 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1,
587 blk_dev_desc->blksz);
588 struct disk_partition *partitions = NULL;
589 gpt_entry *gpt_pte = NULL;
594 /* fill partitions */
595 ret = set_gpt_info(blk_dev_desc, str_part,
596 &str_disk_guid, &partitions, &part_count);
599 printf("No partition list provided - only basic check\n");
600 ret = gpt_verify_headers(blk_dev_desc, gpt_head,
605 printf("Missing disk guid\n");
606 if ((ret == -3) || (ret == -4))
607 printf("Partition list incomplete\n");
611 /* Check partition layout with provided pattern */
612 ret = gpt_verify_partitions(blk_dev_desc, partitions, part_count,
621 static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
624 char disk_guid[UUID_STR_LEN + 1];
626 ret = get_disk_guid(dev_desc, disk_guid);
628 return CMD_RET_FAILURE;
631 env_set(namestr, disk_guid);
633 printf("%s\n", disk_guid);
638 #ifdef CONFIG_CMD_GPT_RENAME
639 static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
640 char *name1, char *name2)
642 struct list_head *pos;
643 struct disk_part *curr;
644 struct disk_partition *new_partitions = NULL;
645 char disk_guid[UUID_STR_LEN + 1];
646 char *partitions_list, *str_disk_guid = NULL;
648 int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
650 if ((subcomm == NULL) || (name1 == NULL) || (name2 == NULL) ||
651 (strcmp(subcomm, "swap") && (strcmp(subcomm, "rename"))))
654 ret = get_disk_guid(dev_desc, disk_guid);
658 * Allocates disk_partitions, requiring matching call to del_gpt_info()
661 numparts = get_gpt_info(dev_desc);
663 return numparts ? numparts : -ENODEV;
665 partlistlen = calc_parts_list_len(numparts);
666 partitions_list = malloc(partlistlen);
667 if (!partitions_list) {
671 memset(partitions_list, '\0', partlistlen);
673 ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
675 free(partitions_list);
679 * Uncomment the following line to print a string that 'gpt write'
680 * or 'gpt verify' will accept as input.
682 debug("OLD partitions_list is %s with %u chars\n", partitions_list,
683 (unsigned)strlen(partitions_list));
685 /* set_gpt_info allocates new_partitions and str_disk_guid */
686 ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
687 &new_partitions, &part_count);
691 if (!strcmp(subcomm, "swap")) {
692 if ((strlen(name1) > PART_NAME_LEN) || (strlen(name2) > PART_NAME_LEN)) {
693 printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
697 list_for_each(pos, &disk_partitions) {
698 curr = list_entry(pos, struct disk_part, list);
699 if (!strcmp((char *)curr->gpt_part_info.name, name1)) {
700 strcpy((char *)curr->gpt_part_info.name, name2);
702 } else if (!strcmp((char *)curr->gpt_part_info.name, name2)) {
703 strcpy((char *)curr->gpt_part_info.name, name1);
707 if ((ctr1 + ctr2 < 2) || (ctr1 != ctr2)) {
708 printf("Cannot swap partition names except in pairs.\n");
712 } else { /* rename */
713 if (strlen(name2) > PART_NAME_LEN) {
714 printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
718 partnum = (int)simple_strtol(name1, NULL, 10);
719 if ((partnum < 0) || (partnum > numparts)) {
720 printf("Illegal partition number %s\n", name1);
724 ret = part_get_info(dev_desc, partnum, new_partitions);
728 /* U-Boot partition numbering starts at 1 */
729 list_for_each(pos, &disk_partitions) {
730 curr = list_entry(pos, struct disk_part, list);
732 strcpy((char *)curr->gpt_part_info.name, name2);
739 ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
742 debug("NEW partitions_list is %s with %u chars\n", partitions_list,
743 (unsigned)strlen(partitions_list));
745 ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
746 &new_partitions, &part_count);
748 * Even though valid pointers are here passed into set_gpt_info(),
749 * it mallocs again, and there's no way to tell which failed.
754 debug("Writing new partition table\n");
755 ret = gpt_restore(dev_desc, disk_guid, new_partitions, numparts);
757 printf("Writing new partition table failed\n");
761 debug("Reading back new partition table\n");
763 * Empty the existing disk_partitions list, as otherwise the memory in
764 * the original list is unreachable.
767 numparts = get_gpt_info(dev_desc);
769 ret = numparts ? numparts : -ENODEV;
772 printf("new partition table with %d partitions is:\n", numparts);
776 #ifdef CONFIG_RANDOM_UUID
779 free(new_partitions);
780 free(partitions_list);
786 * do_gpt(): Perform GPT operations
788 * @param cmdtp - command name
793 * @return zero on success; otherwise error
795 static int do_gpt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
797 int ret = CMD_RET_SUCCESS;
800 struct blk_desc *blk_dev_desc = NULL;
802 #ifndef CONFIG_CMD_GPT_RENAME
803 if (argc < 4 || argc > 5)
805 if (argc < 4 || argc > 6)
807 return CMD_RET_USAGE;
809 dev = (int)simple_strtoul(argv[3], &ep, 10);
810 if (!ep || ep[0] != '\0') {
811 printf("'%s' is not a number\n", argv[3]);
812 return CMD_RET_USAGE;
814 blk_dev_desc = blk_get_dev(argv[2], dev);
816 printf("%s: %s dev %d NOT available\n",
817 __func__, argv[2], dev);
818 return CMD_RET_FAILURE;
821 if ((strcmp(argv[1], "write") == 0) && (argc == 5)) {
822 printf("Writing GPT: ");
823 ret = gpt_default(blk_dev_desc, argv[4]);
824 } else if ((strcmp(argv[1], "verify") == 0)) {
825 ret = gpt_verify(blk_dev_desc, argv[4]);
826 printf("Verify GPT: ");
827 } else if (strcmp(argv[1], "guid") == 0) {
828 ret = do_disk_guid(blk_dev_desc, argv[4]);
829 #ifdef CONFIG_CMD_GPT_RENAME
830 } else if (strcmp(argv[1], "read") == 0) {
831 ret = do_get_gpt_info(blk_dev_desc);
832 } else if ((strcmp(argv[1], "swap") == 0) ||
833 (strcmp(argv[1], "rename") == 0)) {
834 ret = do_rename_gpt_parts(blk_dev_desc, argv[1], argv[4], argv[5]);
837 return CMD_RET_USAGE;
842 return CMD_RET_FAILURE;
845 printf("success!\n");
846 return CMD_RET_SUCCESS;
849 U_BOOT_CMD(gpt, CONFIG_SYS_MAXARGS, 1, do_gpt,
850 "GUID Partition Table",
851 "<command> <interface> <dev> <partitions_list>\n"
852 " - GUID partition table restoration and validity check\n"
853 " Restore or verify GPT information on a device connected\n"
856 " gpt write mmc 0 $partitions\n"
857 " gpt verify mmc 0 $partitions\n"
858 " gpt guid <interface> <dev>\n"
859 " - print disk GUID\n"
860 " gpt guid <interface> <dev> <varname>\n"
861 " - set environment variable to disk GUID\n"
864 " gpt guid mmc 0 varname\n"
865 #ifdef CONFIG_CMD_GPT_RENAME
866 "gpt partition renaming commands:\n"
867 " gpt read <interface> <dev>\n"
868 " - read GPT into a data structure for manipulation\n"
869 " gpt swap <interface> <dev> <name1> <name2>\n"
870 " - change all partitions named name1 to name2\n"
872 " gpt rename <interface> <dev> <part> <name>\n"
873 " - rename the specified partition\n"
875 " gpt swap mmc 0 foo bar\n"
876 " gpt rename mmc 0 3 foo\n"