env: Move env_set() to env.h
[oweals/u-boot.git] / cmd / gpt.c
index 9c920fa320799fd80403f373f10d553122460108..0c4349f4b2494a2bc6a4045e3eca62ee278b1691 100644 (file)
--- a/cmd/gpt.c
+++ b/cmd/gpt.c
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * cmd_gpt.c -- GPT (GUID Partition Table) handling command
  *
@@ -7,11 +8,10 @@
  * Copyright (C) 2012 Samsung Electronics
  * author: Lukasz Majewski <l.majewski@samsung.com>
  * author: Piotr Wilczek <p.wilczek@samsung.com>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
+#include <env.h>
 #include <malloc.h>
 #include <command.h>
 #include <part_efi.h>
@@ -20,6 +20,8 @@
 #include <div64.h>
 #include <memalign.h>
 #include <linux/compat.h>
+#include <linux/sizes.h>
+#include <stdlib.h>
 
 static LIST_HEAD(disk_partitions);
 
@@ -53,14 +55,14 @@ static int extract_env(const char *str, char **env)
        memset(s + strlen(s) - 1, '\0', 1);
        memmove(s, s + 2, strlen(s) - 1);
 
-       e = getenv(s);
+       e = env_get(s);
        if (e == NULL) {
 #ifdef CONFIG_RANDOM_UUID
                debug("%s unset. ", str);
                gen_rand_uuid_str(uuid_str, UUID_STR_FORMAT_GUID);
-               setenv(s, uuid_str);
+               env_set(s, uuid_str);
 
-               e = getenv(s);
+               e = env_get(s);
                if (e) {
                        debug("Set to random.\n");
                        ret = 0;
@@ -154,6 +156,25 @@ static bool found_key(const char *str, const char *key)
        return result;
 }
 
+static int calc_parts_list_len(int numparts)
+{
+       int partlistlen = UUID_STR_LEN + 1 + strlen("uuid_disk=");
+       /* for the comma */
+       partlistlen++;
+
+       /* per-partition additions; numparts starts at 1, so this should be correct */
+       partlistlen += numparts * (strlen("name=,") + PART_NAME_LEN + 1);
+       /* 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);
+       partlistlen += numparts * (strlen("uuid=;") + UUID_STR_LEN + 1);
+       /* for the terminating null */
+       partlistlen++;
+       debug("Length of partitions_list is %d for %d partitions\n", partlistlen,
+             numparts);
+       return partlistlen;
+}
+
 #ifdef CONFIG_CMD_GPT_RENAME
 static void del_gpt_info(void)
 {
@@ -169,10 +190,9 @@ static void del_gpt_info(void)
 static struct disk_part *allocate_disk_part(disk_partition_t *info, int partnum)
 {
        struct disk_part *newpart;
-       newpart = malloc(sizeof(*newpart));
+       newpart = calloc(1, sizeof(struct disk_part));
        if (!newpart)
                return ERR_PTR(-ENOMEM);
-       memset(newpart, '\0', sizeof(newpart));
 
        newpart->gpt_part_info.start = info->start;
        newpart->gpt_part_info.size = info->size;
@@ -195,16 +215,32 @@ static struct disk_part *allocate_disk_part(disk_partition_t *info, int partnum)
        return newpart;
 }
 
+static void prettyprint_part_size(char *sizestr, lbaint_t partsize,
+                                 lbaint_t blksize)
+{
+       unsigned long long partbytes, partmegabytes;
+
+       partbytes = partsize * blksize;
+       partmegabytes = lldiv(partbytes, SZ_1M);
+       snprintf(sizestr, 16, "%lluMiB", partmegabytes);
+}
+
 static void print_gpt_info(void)
 {
        struct list_head *pos;
        struct disk_part *curr;
+       char partstartstr[16];
+       char partsizestr[16];
 
        list_for_each(pos, &disk_partitions) {
                curr = list_entry(pos, struct disk_part, list);
+               prettyprint_part_size(partstartstr, curr->gpt_part_info.start,
+                                     curr->gpt_part_info.blksz);
+               prettyprint_part_size(partsizestr, curr->gpt_part_info.size,
+                                     curr->gpt_part_info.blksz);
+
                printf("Partition %d:\n", curr->partnum);
-               printf("1st block %x, size %x\n", (unsigned)curr->gpt_part_info.start,
-                      (unsigned)curr->gpt_part_info.size);
+               printf("Start %s, size %s\n", partstartstr, partsizestr);
                printf("Block size %lu, name %s\n", curr->gpt_part_info.blksz,
                       curr->gpt_part_info.name);
                printf("Type %s, bootable %d\n", curr->gpt_part_info.type,
@@ -216,6 +252,54 @@ static void print_gpt_info(void)
        }
 }
 
+/*
+ * create the string that upstream 'gpt write' command will accept as an
+ * argument
+ *
+ * From doc/README.gpt, Format of partitions layout:
+ *    "uuid_disk=...;name=u-boot,size=60MiB,uuid=...;
+ *     name=kernel,size=60MiB,uuid=...;"
+ * The fields 'name' and 'size' are mandatory for every partition.
+ * The field 'start' is optional. The fields 'uuid' and 'uuid_disk'
+ * are optional if CONFIG_RANDOM_UUID is enabled.
+ */
+static int create_gpt_partitions_list(int numparts, const char *guid,
+                                     char *partitions_list)
+{
+       struct list_head *pos;
+       struct disk_part *curr;
+       char partstr[PART_NAME_LEN + 1];
+
+       if (!partitions_list)
+               return -EINVAL;
+
+       strcpy(partitions_list, "uuid_disk=");
+       strncat(partitions_list, guid, UUID_STR_LEN + 1);
+       strcat(partitions_list, ";");
+
+       list_for_each(pos, &disk_partitions) {
+               curr = list_entry(pos, struct disk_part, list);
+               strcat(partitions_list, "name=");
+               strncat(partitions_list, (const char *)curr->gpt_part_info.name,
+                       PART_NAME_LEN + 1);
+               sprintf(partstr, ",start=0x%llx",
+                       (unsigned long long)curr->gpt_part_info.start *
+                                           curr->gpt_part_info.blksz);
+               /* one extra byte for NULL */
+               strncat(partitions_list, partstr, PART_NAME_LEN + 1);
+               sprintf(partstr, ",size=0x%llx",
+                       (unsigned long long)curr->gpt_part_info.size *
+                                           curr->gpt_part_info.blksz);
+               strncat(partitions_list, partstr, PART_NAME_LEN + 1);
+
+               strcat(partitions_list, ",uuid=");
+               strncat(partitions_list, curr->gpt_part_info.uuid,
+                       UUID_STR_LEN + 1);
+               strcat(partitions_list, ";");
+       }
+       return 0;
+}
+
 /*
  * read partition info into disk_partitions list where
  * it can be printed or modified
@@ -227,8 +311,11 @@ static int get_gpt_info(struct blk_desc *dev_desc)
        disk_partition_t info;
        struct disk_part *new_disk_part;
 
-       if (disk_partitions.next == NULL)
-               INIT_LIST_HEAD(&disk_partitions);
+       /*
+        * Always re-read partition info from device, in case
+        * it has changed
+        */
+       INIT_LIST_HEAD(&disk_partitions);
 
        for (p = 1; p <= MAX_SEARCH_PARTITIONS; p++) {
                ret = part_get_info(dev_desc, p, &info);
@@ -297,6 +384,7 @@ static int set_gpt_info(struct blk_desc *dev_desc,
        int errno = 0;
        uint64_t size_ll, start_ll;
        lbaint_t offset = 0;
+       int max_str_part = calc_parts_list_len(MAX_SEARCH_PARTITIONS);
 
        debug("%s:  lba num: 0x%x %d\n", __func__,
              (unsigned int)dev_desc->lba, (unsigned int)dev_desc->lba);
@@ -305,6 +393,8 @@ static int set_gpt_info(struct blk_desc *dev_desc,
                return -1;
 
        str = strdup(str_part);
+       if (str == NULL)
+               return -ENOMEM;
 
        /* extract disk guid */
        s = str;
@@ -312,6 +402,8 @@ static int set_gpt_info(struct blk_desc *dev_desc,
        if (!val) {
 #ifdef CONFIG_RANDOM_UUID
                *str_disk_guid = malloc(UUID_STR_LEN + 1);
+               if (*str_disk_guid == NULL)
+                       return -ENOMEM;
                gen_rand_uuid_str(*str_disk_guid, UUID_STR_FORMAT_STD);
 #else
                free(str);
@@ -326,10 +418,14 @@ static int set_gpt_info(struct blk_desc *dev_desc,
                /* Move s to first partition */
                strsep(&s, ";");
        }
-       if (strlen(s) == 0)
+       if (s == NULL) {
+               printf("Error: is the partitions string NULL-terminated?\n");
+               return -EINVAL;
+       }
+       if (strnlen(s, max_str_part) == 0)
                return -3;
 
-       i = strlen(s) - 1;
+       i = strnlen(s, max_str_part) - 1;
        if (s[i] == ';')
                s[i] = '\0';
 
@@ -343,6 +439,8 @@ static int set_gpt_info(struct blk_desc *dev_desc,
 
        /* allocate memory for partitions */
        parts = calloc(sizeof(disk_partition_t), p_count);
+       if (parts == NULL)
+               return -ENOMEM;
 
        /* retrieve partitions data from string */
        for (i = 0; i < p_count; i++) {
@@ -364,12 +462,12 @@ static int set_gpt_info(struct blk_desc *dev_desc,
                } else {
                        if (extract_env(val, &p))
                                p = val;
-                       if (strlen(p) >= sizeof(parts[i].uuid)) {
+                       if (strnlen(p, max_str_part) >= sizeof(parts[i].uuid)) {
                                printf("Wrong uuid format for partition %d\n", i);
                                errno = -4;
                                goto err;
                        }
-                       strcpy((char *)parts[i].uuid, p);
+                       strncpy((char *)parts[i].uuid, p, max_str_part);
                        free(val);
                }
 #ifdef CONFIG_PARTITION_TYPE_GUID
@@ -379,13 +477,13 @@ static int set_gpt_info(struct blk_desc *dev_desc,
                        /* 'type' is optional */
                        if (extract_env(val, &p))
                                p = val;
-                       if (strlen(p) >= sizeof(parts[i].type_guid)) {
+                       if (strnlen(p, max_str_part) >= sizeof(parts[i].type_guid)) {
                                printf("Wrong type guid format for partition %d\n",
                                       i);
                                errno = -4;
                                goto err;
                        }
-                       strcpy((char *)parts[i].type_guid, p);
+                       strncpy((char *)parts[i].type_guid, p, max_str_part);
                        free(val);
                }
 #endif
@@ -397,11 +495,11 @@ static int set_gpt_info(struct blk_desc *dev_desc,
                }
                if (extract_env(val, &p))
                        p = val;
-               if (strlen(p) >= sizeof(parts[i].name)) {
+               if (strnlen(p, max_str_part) >= sizeof(parts[i].name)) {
                        errno = -4;
                        goto err;
                }
-               strcpy((char *)parts[i].name, p);
+               strncpy((char *)parts[i].name, p, max_str_part);
                free(val);
 
                /* size */
@@ -527,13 +625,185 @@ static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
                return CMD_RET_FAILURE;
 
        if (namestr)
-               setenv(namestr, disk_guid);
+               env_set(namestr, disk_guid);
        else
                printf("%s\n", disk_guid);
 
        return ret;
 }
 
+#ifdef CONFIG_CMD_GPT_RENAME
+/*
+ * There are 3 malloc() calls in set_gpt_info() and there is no info about which
+ * failed.
+ */
+static void set_gpt_cleanup(char **str_disk_guid,
+                           disk_partition_t **partitions)
+{
+#ifdef CONFIG_RANDOM_UUID
+       if (str_disk_guid)
+               free(str_disk_guid);
+#endif
+       if (partitions)
+               free(partitions);
+}
+
+static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
+                              char *name1, char *name2)
+{
+       struct list_head *pos;
+       struct disk_part *curr;
+       disk_partition_t *new_partitions = NULL;
+       char disk_guid[UUID_STR_LEN + 1];
+       char *partitions_list, *str_disk_guid;
+       u8 part_count = 0;
+       int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
+
+       if ((subcomm == NULL) || (name1 == NULL) || (name2 == NULL) ||
+           (strcmp(subcomm, "swap") && (strcmp(subcomm, "rename"))))
+               return -EINVAL;
+
+       ret = get_disk_guid(dev_desc, disk_guid);
+       if (ret < 0)
+               return ret;
+       /*
+        * Allocates disk_partitions, requiring matching call to del_gpt_info()
+        * if successful.
+        */
+       numparts = get_gpt_info(dev_desc);
+       if (numparts <=  0)
+               return numparts ? numparts : -ENODEV;
+
+       partlistlen = calc_parts_list_len(numparts);
+       partitions_list = malloc(partlistlen);
+       if (!partitions_list) {
+               del_gpt_info();
+               return -ENOMEM;
+       }
+       memset(partitions_list, '\0', partlistlen);
+
+       ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
+       if (ret < 0) {
+               free(partitions_list);
+               return ret;
+       }
+       /*
+        * Uncomment the following line to print a string that 'gpt write'
+        * or 'gpt verify' will accept as input.
+        */
+       debug("OLD partitions_list is %s with %u chars\n", partitions_list,
+             (unsigned)strlen(partitions_list));
+
+       /* set_gpt_info allocates new_partitions and str_disk_guid */
+       ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
+                          &new_partitions, &part_count);
+       if (ret < 0) {
+               del_gpt_info();
+               free(partitions_list);
+               if (ret == -ENOMEM)
+                       set_gpt_cleanup(&str_disk_guid, &new_partitions);
+               else
+                       goto out;
+       }
+
+       if (!strcmp(subcomm, "swap")) {
+               if ((strlen(name1) > PART_NAME_LEN) || (strlen(name2) > PART_NAME_LEN)) {
+                       printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
+                       ret = -EINVAL;
+                       goto out;
+               }
+               list_for_each(pos, &disk_partitions) {
+                       curr = list_entry(pos, struct disk_part, list);
+                       if (!strcmp((char *)curr->gpt_part_info.name, name1)) {
+                               strcpy((char *)curr->gpt_part_info.name, name2);
+                               ctr1++;
+                       } else if (!strcmp((char *)curr->gpt_part_info.name, name2)) {
+                               strcpy((char *)curr->gpt_part_info.name, name1);
+                               ctr2++;
+                       }
+               }
+               if ((ctr1 + ctr2 < 2) || (ctr1 != ctr2)) {
+                       printf("Cannot swap partition names except in pairs.\n");
+                       ret = -EINVAL;
+                       goto out;
+               }
+       } else { /* rename */
+               if (strlen(name2) > PART_NAME_LEN) {
+                       printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
+                       ret = -EINVAL;
+                       goto out;
+               }
+               partnum = (int)simple_strtol(name1, NULL, 10);
+               if ((partnum < 0) || (partnum > numparts)) {
+                       printf("Illegal partition number %s\n", name1);
+                       ret = -EINVAL;
+                       goto out;
+               }
+               ret = part_get_info(dev_desc, partnum, new_partitions);
+               if (ret < 0)
+                       goto out;
+
+               /* U-Boot partition numbering starts at 1 */
+               list_for_each(pos, &disk_partitions) {
+                       curr = list_entry(pos, struct disk_part, list);
+                       if (i == partnum) {
+                               strcpy((char *)curr->gpt_part_info.name, name2);
+                               break;
+                       }
+                       i++;
+               }
+       }
+
+       ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
+       if (ret < 0)
+               goto out;
+       debug("NEW partitions_list is %s with %u chars\n", partitions_list,
+             (unsigned)strlen(partitions_list));
+
+       ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
+                          &new_partitions, &part_count);
+       /*
+        * Even though valid pointers are here passed into set_gpt_info(),
+        * it mallocs again, and there's no way to tell which failed.
+        */
+       if (ret < 0) {
+               del_gpt_info();
+               free(partitions_list);
+               if (ret == -ENOMEM)
+                       set_gpt_cleanup(&str_disk_guid, &new_partitions);
+               else
+                       goto out;
+       }
+
+       debug("Writing new partition table\n");
+       ret = gpt_restore(dev_desc, disk_guid, new_partitions, numparts);
+       if (ret < 0) {
+               printf("Writing new partition table failed\n");
+               goto out;
+       }
+
+       debug("Reading back new partition table\n");
+       /*
+        * Empty the existing disk_partitions list, as otherwise the memory in
+        * the original list is unreachable.
+        */
+       del_gpt_info();
+       numparts = get_gpt_info(dev_desc);
+       if (numparts <=  0) {
+               ret = numparts ? numparts : -ENODEV;
+               goto out;
+       }
+       printf("new partition table with %d partitions is:\n", numparts);
+       print_gpt_info();
+       del_gpt_info();
+ out:
+       free(new_partitions);
+       free(str_disk_guid);
+       free(partitions_list);
+       return ret;
+}
+#endif
+
 /**
  * do_gpt(): Perform GPT operations
  *
@@ -551,7 +821,11 @@ static int do_gpt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
        char *ep;
        struct blk_desc *blk_dev_desc = NULL;
 
+#ifndef CONFIG_CMD_GPT_RENAME
        if (argc < 4 || argc > 5)
+#else
+       if (argc < 4 || argc > 6)
+#endif
                return CMD_RET_USAGE;
 
        dev = (int)simple_strtoul(argv[3], &ep, 10);
@@ -577,6 +851,9 @@ static int do_gpt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 #ifdef CONFIG_CMD_GPT_RENAME
        } else if (strcmp(argv[1], "read") == 0) {
                ret = do_get_gpt_info(blk_dev_desc);
+       } else if ((strcmp(argv[1], "swap") == 0) ||
+                  (strcmp(argv[1], "rename") == 0)) {
+               ret = do_rename_gpt_parts(blk_dev_desc, argv[1], argv[4], argv[5]);
 #endif
        } else {
                return CMD_RET_USAGE;
@@ -600,13 +877,24 @@ U_BOOT_CMD(gpt, CONFIG_SYS_MAXARGS, 1, do_gpt,
        " Example usage:\n"
        " gpt write mmc 0 $partitions\n"
        " gpt verify mmc 0 $partitions\n"
-       " read <interface> <dev>\n"
-       "    - read GPT into a data structure for manipulation\n"
-       " guid <interface> <dev>\n"
+       " gpt guid <interface> <dev>\n"
        "    - print disk GUID\n"
-       " guid <interface> <dev> <varname>\n"
+       " gpt guid <interface> <dev> <varname>\n"
        "    - set environment variable to disk GUID\n"
        " Example usage:\n"
        " gpt guid mmc 0\n"
        " gpt guid mmc 0 varname\n"
+#ifdef CONFIG_CMD_GPT_RENAME
+       "gpt partition renaming commands:\n"
+       " gpt read <interface> <dev>\n"
+       "    - read GPT into a data structure for manipulation\n"
+       " gpt swap <interface> <dev> <name1> <name2>\n"
+       "    - change all partitions named name1 to name2\n"
+       "      and vice-versa\n"
+       " gpt rename <interface> <dev> <part> <name>\n"
+       "    - rename the specified partition\n"
+       " Example usage:\n"
+       " gpt swap mmc 0 foo bar\n"
+       " gpt rename mmc 0 3 foo\n"
+#endif
 );