Skip to contentSkip to conversation

btrfs: propagate error from function unpin_extent_cache()

PATCH Superseded Luís Henriques 2 participants 3 messages Jul 20, 2023 – Jul 21, 2023 Btrfs file system

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 btrfs: propagate error from function unpin_extent_cache()

Function unpin_extent_cache() doesn't propagate an error if the call to lookup_extent_mapping() fails. This patch adds an error return (EINVAL) and simply logs it in the only caller.

---
Hi!

As per David and Johannes reviews, I'm now proposing a different approach. Note that I kept the WARN_ON() instead of replacing it by an ASSERT(). In fact, I considered removing the WARN_ON() completely and simply return the error if em->start != start. But I guess it may useful for debug.

Changes since v1:
Instead of changing unpin_extent_cache() into a void function, make it propage an error code instead.

 fs/btrfs/extent_map.c | 4 +++-
 fs/btrfs/inode.c      | 8 ++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)
fs/btrfs/extent_map.c +3 -1
index 0cdb3e86f29b..f4e7956edc05 100644
@@ -304,8 +304,10 @@ int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len,
 
 	WARN_ON(!em || em->start != start);
 
-	if (!em)
+	if (!em) {
+		ret = -EINVAL;
 		goto out;
+	}
 
 	em->generation = gen;
 	clear_bit(EXTENT_FLAG_PINNED, &em->flags);
fs/btrfs/inode.c +6 -2
index dbbb67293e34..21eb66fcc0df 100644
@@ -3273,8 +3273,12 @@ int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent)
 						ordered_extent->disk_num_bytes);
 		}
 	}
-	unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
-			   ordered_extent->num_bytes, trans->transid);
+
+	/* Proceed even if we fail to unpin extent from cache */
+	if (unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
+			       ordered_extent->num_bytes, trans->transid) < 0)
+		btrfs_warn(fs_info, "failed to unpin extent from cache");
+
 	if (ret < 0) {
 		btrfs_abort_transaction(trans, ret);
 		goto out;
#1 lore raw
Quoted 43 lines · Luís Henriques

Function unpin_extent_cache() doesn't propagate an error if the call to lookup_extent_mapping() fails. This patch adds an error return (EINVAL) and simply logs it in the only caller.

---
Hi!

As per David and Johannes reviews, I'm now proposing a different approach. Note that I kept the WARN_ON() instead of replacing it by an ASSERT(). In fact, I considered removing the WARN_ON() completely and simply return the error if em->start != start. But I guess it may useful for debug.

Changes since v1:
Instead of changing unpin_extent_cache() into a void function, make it propage an error code instead.

 fs/btrfs/extent_map.c | 4 +++-
 fs/btrfs/inode.c      | 8 ++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)
fs/btrfs/extent_map.c +3 -1
index 0cdb3e86f29b..f4e7956edc05 100644
@@ -304,8 +304,10 @@ int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len,
 
        WARN_ON(!em || em->start != start);
 
-       if (!em)
+       if (!em) {
+               ret = -EINVAL;
                goto out;
+       }
 
        em->generation = gen;
        clear_bit(EXTENT_FLAG_PINNED, &em->flags);
fs/btrfs/inode.c +0 -0
index dbbb67293e34..21eb66fcc0df 100644

fs/btrfs/inode.c int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent) · line 3280

Quoted 10 lines
fs/btrfs/inode.c +5 -2
@@ -3273,8 +3273,12 @@ int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent)
                                                ordered_extent->disk_num_bytes);
                }
        }
-       unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
-                          ordered_extent->num_bytes, trans->transid);
+
+       /* Proceed even if we fail to unpin extent from cache */
+       if (unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
+                              ordered_extent->num_bytes, trans->transid) < 0)
+               btrfs_warn(fs_info, "failed to unpin extent from cache");

Well, this is not very useful. It doesn't provide any more useful information than what we get from the WARN_ON() at unpin_extent_cache(), making the patch not useful.

This warning has actually happened a few times when running fstests that exercise relocation (not sure if it's gone and accidently fixed by something recently).
But to make this more useful, I would place the message at unpin_extent_cache() with useful information such as:

- inode number
- id of the root the inode belongs to
- the file offset (the start argument) and extent length (or end offset)
- why the warning triggered: we didn't find the extent map or we found one with a different start offset
- if we found an unexpected extent map, dump its flags (so we can see if it happens only with compressed or prealloc extents for e.g.) and other details (length/end offset for e.g.)

Thanks.

Quoted 4 lines
fs/btrfs/inode.c +1 -0
+
        if (ret < 0) {
                btrfs_abort_transaction(trans, ret);
                goto out;
#2 lore raw
Quoted 59 lines · Filipe Manana
Quoted 43 lines · Luís Henriques

Function unpin_extent_cache() doesn't propagate an error if the call to lookup_extent_mapping() fails. This patch adds an error return (EINVAL) and simply logs it in the only caller.

---
Hi!

As per David and Johannes reviews, I'm now proposing a different approach. Note that I kept the WARN_ON() instead of replacing it by an ASSERT(). In fact, I considered removing the WARN_ON() completely and simply return the error if em->start != start. But I guess it may useful for debug.

Changes since v1:
Instead of changing unpin_extent_cache() into a void function, make it propage an error code instead.

 fs/btrfs/extent_map.c | 4 +++-
 fs/btrfs/inode.c      | 8 ++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)
fs/btrfs/extent_map.c +3 -1
index 0cdb3e86f29b..f4e7956edc05 100644
@@ -304,8 +304,10 @@ int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len,
 
        WARN_ON(!em || em->start != start);
 
-       if (!em)
+       if (!em) {
+               ret = -EINVAL;
                goto out;
+       }
 
        em->generation = gen;
        clear_bit(EXTENT_FLAG_PINNED, &em->flags);
fs/btrfs/inode.c +0 -0
index dbbb67293e34..21eb66fcc0df 100644

fs/btrfs/inode.c int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent) · line 3280

Quoted 10 lines
fs/btrfs/inode.c +5 -2
@@ -3273,8 +3273,12 @@ int btrfs_finish_one_ordered(struct btrfs_ordered_extent *ordered_extent)
                                                ordered_extent->disk_num_bytes);
                }
        }
-       unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
-                          ordered_extent->num_bytes, trans->transid);
+
+       /* Proceed even if we fail to unpin extent from cache */
+       if (unpin_extent_cache(&inode->extent_tree, ordered_extent->file_offset,
+                              ordered_extent->num_bytes, trans->transid) < 0)
+               btrfs_warn(fs_info, "failed to unpin extent from cache");

Well, this is not very useful. It doesn't provide any more useful information than what we get from the WARN_ON() at unpin_extent_cache(), making the patch not useful.

Quoted 3 lines

This warning has actually happened a few times when running fstests that exercise relocation (not sure if it's gone and accidently fixed by something recently).

Oh! In that case replacing the WARN_ON() by an ASSERT() would have definitely be a bad idea.

Quoted 11 lines

But to make this more useful, I would place the message at unpin_extent_cache() with useful information such as:

- inode number
- id of the root the inode belongs to
- the file offset (the start argument) and extent length (or end offset)
- why the warning triggered: we didn't find the extent map or we found one with a different start offset
- if we found an unexpected extent map, dump its flags (so we can see if it happens only with compressed or prealloc extents for e.g.) and other details (length/end offset for e.g.)

Thanks, Filipe. This all makes sense. And in this case I guess I should go back to the initial approach of changing the function to a void function, but adding all this useful information.

Cheers,

Signature · 1 line
Luís