Skip to contentSkip to conversation

cmd/gpt: Address error cases during gpt rename more correctly

PATCH Superseded Tom Rini 2 participants 3 messages Jan 20, 2020 – Jan 21, 2020

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Tom Rini

author
#0 lore raw

PATCH v2 1/1 cmd/gpt: Address error cases during gpt rename more correctly

New analysis by the tool has shown that we have some cases where we weren't handling the error exit condition correctly. When we ran into the ENOMEM case we wouldn't exit the function and thus incorrect things could happen. Rework the unwinding such that we don't need a helper function now and free what we may have allocated.

Fixes 18030d04d25d ("GPT: fix memory leaks identified by Coverity")
Reported-by Coverity (CID: 275475, 275476)
Cc Alison Chaiken <[email protected]>
Cc Simon Goldschmidt <[email protected]>

---
Changes in v2:
- Initialize str_disk_guid to NULL to be sure we can test that it has been set later on (Simon, Jordy).

 cmd/gpt.c | 37 +++++++++----------------------------
 1 file changed, 9 insertions(+), 28 deletions(-)
cmd/gpt.c +9 -28
index 0c4349f4b249..c0e3c5161789 100644
@@ -633,21 +633,6 @@ static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
 }
 
 #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)
 {
@@ -655,7 +640,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
 	struct disk_part *curr;
 	disk_partition_t *new_partitions = NULL;
 	char disk_guid[UUID_STR_LEN + 1];
-	char *partitions_list, *str_disk_guid;
+	char *partitions_list, *str_disk_guid = NULL;
 	u8 part_count = 0;
 	int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
 
@@ -699,11 +684,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
 			   &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;
+		goto out;
 	}
 
 	if (!strcmp(subcomm, "swap")) {
@@ -768,11 +749,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
 	 */
 	if (ret < 0) {
 		del_gpt_info();
-		free(partitions_list);
-		if (ret == -ENOMEM)
-			set_gpt_cleanup(&str_disk_guid, &new_partitions);
-		else
-			goto out;
+		goto out;
 	}
 
 	debug("Writing new partition table\n");
@@ -797,8 +774,12 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
 	print_gpt_info();
 	del_gpt_info();
  out:
-	free(new_partitions);
-	free(str_disk_guid);
+#ifdef CONFIG_RANDOM_UUID
+	if (str_disk_guid)
+		free(str_disk_guid);
+#endif
+	if (new_partitions)
+		free(new_partitions);
 	free(partitions_list);
 	return ret;
 }
Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/1 cmd/gpt: Address error cases during gpt rename more correctly

Quoted 84 lines · Tom Rini

New analysis by the tool has shown that we have some cases where we weren't handling the error exit condition correctly. When we ran into the ENOMEM case we wouldn't exit the function and thus incorrect things could happen. Rework the unwinding such that we don't need a helper function now and free what we may have allocated.

Fixes 18030d04d25d ("GPT: fix memory leaks identified by Coverity")
Reported-by Coverity (CID: 275475, 275476)
Cc Alison Chaiken <[email protected]>
Cc Simon Goldschmidt <[email protected]>

---
Changes in v2:
- Initialize str_disk_guid to NULL to be sure we can test that it has been set later on (Simon, Jordy).

 cmd/gpt.c | 37 +++++++++----------------------------
 1 file changed, 9 insertions(+), 28 deletions(-)
cmd/gpt.c +3 -26
index 0c4349f4b249..c0e3c5161789 100644
@@ -633,21 +633,6 @@ static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
 }
 
 #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)
 {
@@ -655,7 +640,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
        struct disk_part *curr;
        disk_partition_t *new_partitions = NULL;
        char disk_guid[UUID_STR_LEN + 1];
-       char *partitions_list, *str_disk_guid;
+       char *partitions_list, *str_disk_guid = NULL;
        u8 part_count = 0;
        int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
 
@@ -699,11 +684,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
                           &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;
+               goto out;
        }
 
        if (!strcmp(subcomm, "swap")) {
@@ -768,11 +749,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
         */
        if (ret < 0) {
                del_gpt_info();
-               free(partitions_list);
-               if (ret == -ENOMEM)
-                       set_gpt_cleanup(&str_disk_guid, &new_partitions);
-               else
-                       goto out;
+               goto out;
        }
 
        debug("Writing new partition table\n");

cmd/gpt.c static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm, · line 776

Quoted 3 lines
cmd/gpt.c +0 -0
@@ -797,8 +774,12 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
        print_gpt_info();
        del_gpt_info();
  out:

OK, so the freeing below looks good to me now. However, what worries me is that when reaching 'out:' via different code flows, del_gpt_info is not always called. I think that could lead to memory leaks when calling this code again, as get_gpt_info just reinitializes the list head without checking if there's actually something allocated in the list.

Maybe we should move the last call to del_gpt_info below 'out:' so that it is always called?

Regards,
Simon

Quoted 13 lines
cmd/gpt.c +6 -3
-       free(new_partitions);
-       free(str_disk_guid);
+#ifdef CONFIG_RANDOM_UUID
+       if (str_disk_guid)
+               free(str_disk_guid);
+#endif
+       if (new_partitions)
+               free(new_partitions);
        free(partitions_list);
        return ret;
 }
--

2.17.1

author
#2 lore raw

PATCH v2 1/1 cmd/gpt: Address error cases during gpt rename more correctly

Quoted 95 lines · Simon Goldschmidt
Quoted 84 lines · Tom Rini

New analysis by the tool has shown that we have some cases where we weren't handling the error exit condition correctly. When we ran into the ENOMEM case we wouldn't exit the function and thus incorrect things could happen. Rework the unwinding such that we don't need a helper function now and free what we may have allocated.

Fixes 18030d04d25d ("GPT: fix memory leaks identified by Coverity")
Reported-by Coverity (CID: 275475, 275476)
Cc Alison Chaiken <[email protected]>
Cc Simon Goldschmidt <[email protected]>

---
Changes in v2:
- Initialize str_disk_guid to NULL to be sure we can test that it has been set later on (Simon, Jordy).

 cmd/gpt.c | 37 +++++++++----------------------------
 1 file changed, 9 insertions(+), 28 deletions(-)
cmd/gpt.c +3 -26
index 0c4349f4b249..c0e3c5161789 100644
@@ -633,21 +633,6 @@ static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
 }
 
 #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)
 {
@@ -655,7 +640,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
        struct disk_part *curr;
        disk_partition_t *new_partitions = NULL;
        char disk_guid[UUID_STR_LEN + 1];
-       char *partitions_list, *str_disk_guid;
+       char *partitions_list, *str_disk_guid = NULL;
        u8 part_count = 0;
        int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
 
@@ -699,11 +684,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
                           &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;
+               goto out;
        }
 
        if (!strcmp(subcomm, "swap")) {
@@ -768,11 +749,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
         */
        if (ret < 0) {
                del_gpt_info();
-               free(partitions_list);
-               if (ret == -ENOMEM)
-                       set_gpt_cleanup(&str_disk_guid, &new_partitions);
-               else
-                       goto out;
+               goto out;
        }
 
        debug("Writing new partition table\n");

cmd/gpt.c static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm, · line 776

Quoted 3 lines
cmd/gpt.c +0 -0
@@ -797,8 +774,12 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
        print_gpt_info();
        del_gpt_info();
  out:

OK, so the freeing below looks good to me now. However, what worries me is that when reaching 'out:' via different code flows, del_gpt_info is not always called. I think that could lead to memory leaks when calling this code again, as get_gpt_info just reinitializes the list head without checking if there's actually something allocated in the list.

Quoted 2 lines

Maybe we should move the last call to del_gpt_info below 'out:' so that it is always called?

I think that's safe to do, yes. v3 coming up..

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200121/284686e2/attachment.sig>