Skip to contentSkip to conversation

qcow2: don't leave partially initialized file on image creation

PATCH Superseded Maxim Levitsky 3 participants 10 messages Dec 8, 2020 Block layer

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v3 cover qcow2: don't leave partially initialized file on image creation

Use the bdrv_co_delete_file interface to delete the underlying file if qcow2 initialization fails (e.g due to bad encryption secret)

This makes the qcow2 driver behave the same way as the luks driver behaves.

V3: addressed review feedback and reworked commit messages

Best regards,
Maxim Levitsky

Maxim Levitsky (2):
crypto: luks: Fix tiny memory leak
block: qcow2: remove the created file on initialization error

 block/crypto.c |  2 ++
 block/qcow2.c  | 13 +++++++++++++
 2 files changed, 15 insertions(+)
Signature · 1 line
2.26.2
#1 lore raw

PATCH v3 1/2 crypto: luks: Fix tiny memory leak

When the underlying block device doesn't support the bdrv_co_delete_file interface, an 'Error' object was leaked.

---
 block/crypto.c | 2 ++
 1 file changed, 2 insertions(+)
block/crypto.c +2 -0
index aef5a5721a..b3a5275132 100644
@@ -735,6 +735,8 @@ fail:
          */
         if ((r_del < 0) && (r_del != -ENOTSUP)) {
             error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
         }
     }
 
Signature · 1 line
2.26.2
#3 lore raw

PATCH v3 2/2 block: qcow2: remove the created file on initialization error

In reply to Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

---
 block/qcow2.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)
block/qcow2.c +13 -0
index 3a90ef2786..3bc2096b72 100644
@@ -3848,6 +3848,19 @@ static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
     /* Create the qcow2 image (format layer) */
     ret = qcow2_co_create(create_options, errp);
     if (ret < 0) {
+
+        Error *local_delete_err = NULL;
+        int r_del = bdrv_co_delete_file(bs, &local_delete_err);
+        /*
+         * ENOTSUP will happen if the block driver doesn't support
+         * the 'bdrv_co_delete_file' interface. This is a predictable
+         * scenario and shouldn't be reported back to the user.
+         */
+        if ((r_del < 0) && (r_del != -ENOTSUP)) {
+            error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
+        }
         goto finish;
     }
 
Signature · 1 line
2.26.2
Reviewed-by on v3 2/2
#4 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

Quoted 6 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3852

Quoted 4 lines
     ret = qcow2_co_create(create_options, errp);
     if (ret < 0) {
block/qcow2.c +2 -0
+
+        Error *local_delete_err = NULL;

Why that empty line though?

Berto

#5 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

Quoted 8 lines · Alberto Garcia
Quoted 6 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

Quoted 8 lines

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3852

Quoted 4 lines
     ret = qcow2_co_create(create_options, errp);
     if (ret < 0) {
block/qcow2.c +2 -0
+
+        Error *local_delete_err = NULL;

Why that empty line though?

I didn't notice. I can send a new version if this is needed.

Thanks for the review!

Best regards,
Maxim Levitsky

Quoted 3 lines

Berto

#6 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

In reply to Maxim Levitsky
Quoted 25 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

---
  block/qcow2.c | 13 +++++++++++++
  1 file changed, 13 insertions(+)
block/qcow2.c +6 -0
index 3a90ef2786..3bc2096b72 100644
@@ -3848,6 +3848,19 @@ static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
      /* Create the qcow2 image (format layer) */
      ret = qcow2_co_create(create_options, errp);
      if (ret < 0) {
+
+        Error *local_delete_err = NULL;
+        int r_del = bdrv_co_delete_file(bs, &local_delete_err);
+        /*
+         * ENOTSUP will happen if the block driver doesn't support
+         * the 'bdrv_co_delete_file' interface. This is a predictable

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3866

Quoted 10 lines
block/qcow2.c +7 -0
+         * scenario and shouldn't be reported back to the user.
+         */
+        if ((r_del < 0) && (r_del != -ENOTSUP)) {
+            error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
+        }
          goto finish;
      }
 

Hi!

As I understand, qcow2_co_create is a new interface and qcow2_co_create_opts() is old, and now works as a wrapper on qcow2_co_create.

I think it's better to do the cleanup in qcow2_co_create, to bring the feature both to new and old interface in the same way.

Signature · 2 lines
Best regards,
Vladimir
#7 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

Quoted 39 lines · Vladimir Sementsov-Ogievskiy
Quoted 25 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

---
  block/qcow2.c | 13 +++++++++++++
  1 file changed, 13 insertions(+)
block/qcow2.c +6 -0
index 3a90ef2786..3bc2096b72 100644
@@ -3848,6 +3848,19 @@ static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
      /* Create the qcow2 image (format layer) */
      ret = qcow2_co_create(create_options, errp);
      if (ret < 0) {
+
+        Error *local_delete_err = NULL;
+        int r_del = bdrv_co_delete_file(bs, &local_delete_err);
+        /*
+         * ENOTSUP will happen if the block driver doesn't support
+         * the 'bdrv_co_delete_file' interface. This is a predictable

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3866

Quoted 10 lines
block/qcow2.c +7 -0
+         * scenario and shouldn't be reported back to the user.
+         */
+        if ((r_del < 0) && (r_del != -ENOTSUP)) {
+            error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
+        }
          goto finish;
      }
 

Hi!

Quoted 3 lines

As I understand, qcow2_co_create is a new interface and qcow2_co_create_opts() is old, and now works as a wrapper on qcow2_co_create.

I think it's better to do the cleanup in qcow2_co_create, to bring the feature both to new and old interface in the same way.

I think that the new interface doesn't need this fix, since using the new interface is only possible from qmp which forces the user to explicitly create and open the file prior to formatting it with qcow2 format.

Thus it is logical to make the user remove it as well if creation fails.

Best regards,
Maxim Levitsky

Quoted 2 lines
#8 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

Quoted 40 lines · Maxim Levitsky
Quoted 39 lines · Vladimir Sementsov-Ogievskiy
Quoted 25 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

---
   block/qcow2.c | 13 +++++++++++++
   1 file changed, 13 insertions(+)
block/qcow2.c +6 -0
index 3a90ef2786..3bc2096b72 100644
@@ -3848,6 +3848,19 @@ static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
       /* Create the qcow2 image (format layer) */
       ret = qcow2_co_create(create_options, errp);
       if (ret < 0) {
+
+        Error *local_delete_err = NULL;
+        int r_del = bdrv_co_delete_file(bs, &local_delete_err);
+        /*
+         * ENOTSUP will happen if the block driver doesn't support
+         * the 'bdrv_co_delete_file' interface. This is a predictable

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3866

Quoted 10 lines
block/qcow2.c +7 -0
+         * scenario and shouldn't be reported back to the user.
+         */
+        if ((r_del < 0) && (r_del != -ENOTSUP)) {
+            error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
+        }
           goto finish;
       }
 

Hi!

Quoted 9 lines
Quoted 3 lines

As I understand, qcow2_co_create is a new interface and qcow2_co_create_opts() is old, and now works as a wrapper on qcow2_co_create.

I think it's better to do the cleanup in qcow2_co_create, to bring the feature both to new and old interface in the same way.

I think that the new interface doesn't need this fix, since using the new interface is only possible from qmp which forces the user to explicitly create and open the file prior to formatting it with qcow2 format.

Oh yes, you are right. File is created by bdrv_create_file() in qcow2_co_create_opts() not in qcow2_co_create(). Still, I think, you should remove the file on any failure after bdrv_create_file() call, but you remove it only on the last failure point..

Signature · 2 lines
Best regards,
Vladimir
#9 lore raw

Re: [PATCH v3 2/2] block: qcow2: remove the created file on initialization error

Quoted 45 lines · Vladimir Sementsov-Ogievskiy
Quoted 44 lines · Maxim Levitsky
Quoted 42 lines · Vladimir Sementsov-Ogievskiy
Quoted 25 lines · Maxim Levitsky

If the qcow initialization fails, we should remove the file if it was already created, to avoid leaving stale files around.

We already do this for luks raw images.

---
   block/qcow2.c | 13 +++++++++++++
   1 file changed, 13 insertions(+)
block/qcow2.c +6 -0
index 3a90ef2786..3bc2096b72 100644
@@ -3848,6 +3848,19 @@ static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
       /* Create the qcow2 image (format layer) */
       ret = qcow2_co_create(create_options, errp);
       if (ret < 0) {
+
+        Error *local_delete_err = NULL;
+        int r_del = bdrv_co_delete_file(bs, &local_delete_err);
+        /*
+         * ENOTSUP will happen if the block driver doesn't support
+         * the 'bdrv_co_delete_file' interface. This is a predictable

block/qcow2.c static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, · line 3866

Quoted 10 lines
block/qcow2.c +7 -0
+         * scenario and shouldn't be reported back to the user.
+         */
+        if ((r_del < 0) && (r_del != -ENOTSUP)) {
+            error_report_err(local_delete_err);
+        } else {
+            error_free(local_delete_err);
+        }
           goto finish;
       }
 

Hi!

As I understand, qcow2_co_create is a new interface and qcow2_co_create_opts() is old, and now works as a wrapper on qcow2_co_create.

I think it's better to do the cleanup in qcow2_co_create, to bring the feature both to new and old interface in the same way.

Quoted 7 lines
Quoted 5 lines

I think that the new interface doesn't need this fix, since using the new interface is only possible from qmp which forces the user to explicitly create and open the file prior to formatting it with qcow2 format.

Oh yes, you are right. File is created by bdrv_create_file() in qcow2_co_create_opts() not in qcow2_co_create(). Still, I think, you should remove the file on any failure after bdrv_create_file() call, but you remove it only on the last failure point..

You are right! The bulk of the code that can fail is in qcow2_co_create_opts but there are indeed few error conditions prior to that.

Thanks for pointing that out.
I'll fix that.

Best regards,
Maxim Levitsky

Quoted 2 lines