Skip to contentSkip to conversation

xfs: avoid firstused overflow in attr3 leaf header with 64k blocks

PATCH In review Brian Foster 3 participants 5 messages Feb 23, 2015 – Feb 24, 2015 XFS filesystem

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 xfs: avoid firstused overflow in attr3 leaf header with 64k blocks

The attr3 leaf header has a 16-bit firstused field that tracks the first used entry offset. This field is initialized to the block size in xfs_attr3_leaf_create() and updated accordingly in xfs_attr3_leaf_add_work() when new attributes are added.

The initialization of firstused overflows if the block size exceeds 16-bits. E.g., xfstests test generic/117 causes assert failures on a -bsize=64k fs on ppc64 because ichdr.firstused evaluates to 0.

Update the firstused initialization to not exceed the maximum value of an unsigned short. This avoids the overflow to 0 and allows firstused to be updated appropriately on subsequent xattr addition. Also update the freemap size calculation to use the actual block size rather than the potentially minimized version stored in firstused.

---
 fs/xfs/libxfs/xfs_attr_leaf.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/xfs/libxfs/xfs_attr_leaf.c +3 -2
index 15105db..dc7bda3 100644
@@ -970,7 +970,8 @@ xfs_attr3_leaf_create(
 	memset(leaf, 0, args->geo->blksize);
 
 	memset(&ichdr, 0, sizeof(ichdr));
-	ichdr.firstused = args->geo->blksize;
+	/* firstused is 16-bit */
+	ichdr.firstused = min_t(int, USHRT_MAX, args->geo->blksize);
 
 	if (xfs_sb_version_hascrc(&mp->m_sb)) {
 		struct xfs_da3_blkinfo *hdr3 = bp->b_addr;
@@ -986,7 +987,7 @@ xfs_attr3_leaf_create(
 		ichdr.magic = XFS_ATTR_LEAF_MAGIC;
 		ichdr.freemap[0].base = sizeof(struct xfs_attr_leaf_hdr);
 	}
-	ichdr.freemap[0].size = ichdr.firstused - ichdr.freemap[0].base;
+	ichdr.freemap[0].size = args->geo->blksize - ichdr.freemap[0].base;
 
 	xfs_attr3_leaf_hdr_to_disk(leaf, &ichdr);
 	xfs_trans_log_buf(args->trans, bp, 0, args->geo->blksize - 1);
Signature · 6 lines
1.9.3

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
#1 lore raw
Quoted 8 lines · Brian Foster

The attr3 leaf header has a 16-bit firstused field that tracks the first used entry offset. This field is initialized to the block size in xfs_attr3_leaf_create() and updated accordingly in xfs_attr3_leaf_add_work() when new attributes are added.

The initialization of firstused overflows if the block size exceeds 16-bits. E.g., xfstests test generic/117 causes assert failures on a -bsize=64k fs on ppc64 because ichdr.firstused evaluates to 0.

cool :)

Quoted 5 lines

Update the firstused initialization to not exceed the maximum value of an unsigned short. This avoids the overflow to 0 and allows firstused to be updated appropriately on subsequent xattr addition. Also update the freemap size calculation to use the actual block size rather than the potentially minimized version stored in firstused.

I'm a little scared by this; does this truncated value risk going to disk?
(Yes, I think so.) Is that ok? Does that ... mean we lose a byte of space
we'd otherwise have? Maybe that's ok ...

FWIW, I think the same problem exists in xfs_attr3_leaf_compact():

        /* Initialise the incore headers */
        ichdr_src = *ichdr_dst; /* struct copy */
        ichdr_dst->firstused = args->geo->blksize;

and xfs_attr3_leaf_unbalance():

                tmphdr.firstused = state->args->geo->blksize;
Quoted 20 lines
---
 fs/xfs/libxfs/xfs_attr_leaf.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/xfs/libxfs/xfs_attr_leaf.c +2 -1
index 15105db..dc7bda3 100644
@@ -970,7 +970,8 @@ xfs_attr3_leaf_create(
 	memset(leaf, 0, args->geo->blksize);
 
 	memset(&ichdr, 0, sizeof(ichdr));
-	ichdr.firstused = args->geo->blksize;
+	/* firstused is 16-bit */
+	ichdr.firstused = min_t(int, USHRT_MAX, args->geo->blksize);
 
 	if (xfs_sb_version_hascrc(&mp->m_sb)) {
 		struct xfs_da3_blkinfo *hdr3 = bp->b_addr;

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create( · line 990

Quoted 5 lines
fs/xfs/libxfs/xfs_attr_leaf.c +1 -1
@@ -986,7 +987,7 @@ xfs_attr3_leaf_create(
 		ichdr.magic = XFS_ATTR_LEAF_MAGIC;
 		ichdr.freemap[0].base = sizeof(struct xfs_attr_leaf_hdr);
 	}
-	ichdr.freemap[0].size = ichdr.firstused - ichdr.freemap[0].base;
+	ichdr.freemap[0].size = args->geo->blksize - ichdr.freemap[0].base;

But now freemap.size is out of sync with firstused; is that ok?

-Eric

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create(

Quoted 3 lines
fs/xfs/libxfs/xfs_attr_leaf.c +0 -0
 	xfs_attr3_leaf_hdr_to_disk(leaf, &ichdr);
 	xfs_trans_log_buf(args->trans, bp, 0, args->geo->blksize - 1);
 

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

#2 lore raw
Quoted 24 lines · Eric Sandeen
Quoted 8 lines · Brian Foster

The attr3 leaf header has a 16-bit firstused field that tracks the first used entry offset. This field is initialized to the block size in xfs_attr3_leaf_create() and updated accordingly in xfs_attr3_leaf_add_work() when new attributes are added.

The initialization of firstused overflows if the block size exceeds 16-bits. E.g., xfstests test generic/117 causes assert failures on a -bsize=64k fs on ppc64 because ichdr.firstused evaluates to 0.

cool :)

Quoted 5 lines

Update the firstused initialization to not exceed the maximum value of an unsigned short. This avoids the overflow to 0 and allows firstused to be updated appropriately on subsequent xattr addition. Also update the freemap size calculation to use the actual block size rather than the potentially minimized version stored in firstused.

I'm a little scared by this; does this truncated value risk going to disk?
(Yes, I think so.) Is that ok? Does that ... mean we lose a byte of space
we'd otherwise have? Maybe that's ok ...

FWIW, I think the same problem exists in xfs_attr3_leaf_compact():

Quoted 7 lines
        /* Initialise the incore headers */
        ichdr_src = *ichdr_dst; /* struct copy */
        ichdr_dst->firstused = args->geo->blksize;

and xfs_attr3_leaf_unbalance():

                tmphdr.firstused = state->args->geo->blksize;

And a loop in xfs_attr3_leaf_remove() that does:

		tmp = args->geo->blksize;
		.....
		ichdr.firstused = tmp;

so if the the loop in between does not modify tmp...

Cheers,

Dave.

Signature · 7 lines
Dave Chinner
[email protected]

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
#3 lore raw
In reply to Eric Sandeen
Quoted 18 lines · Eric Sandeen
Quoted 8 lines · Brian Foster

The attr3 leaf header has a 16-bit firstused field that tracks the first used entry offset. This field is initialized to the block size in xfs_attr3_leaf_create() and updated accordingly in xfs_attr3_leaf_add_work() when new attributes are added.

The initialization of firstused overflows if the block size exceeds 16-bits. E.g., xfstests test generic/117 causes assert failures on a -bsize=64k fs on ppc64 because ichdr.firstused evaluates to 0.

cool :)

Quoted 5 lines

Update the firstused initialization to not exceed the maximum value of an unsigned short. This avoids the overflow to 0 and allows firstused to be updated appropriately on subsequent xattr addition. Also update the freemap size calculation to use the actual block size rather than the potentially minimized version stored in firstused.

Quoted 4 lines

I'm a little scared by this; does this truncated value risk going to disk?
(Yes, I think so.) Is that ok? Does that ... mean we lose a byte of space
we'd otherwise have? Maybe that's ok ...

I don't think it goes to disk in this situation, but even if it does I'm not sure it matters. Either it's a sane value for the field or it isn't. :)

We've lost a byte according to the technical meaning of the field but I don't think that is the practical result. If you follow xfs_attr_shortform_to_leaf() down to xfs_attr3_leaf_add(), we use the freemap size and compare firstused against the base, so this is insignificant there. Continue further to xfs_attr3_leaf_add_work() where we do this:

        ichdr->freemap[mapindex].size -= xfs_attr_leaf_newentsize(args, &tmp);

        entry->nameidx = cpu_to_be16(ichdr->freemap[mapindex].base +
                                     ichdr->freemap[mapindex].size);

	...

        if (be16_to_cpu(entry->nameidx) < ichdr->firstused)
                ichdr->firstused = be16_to_cpu(entry->nameidx);
	...

... and it looks to me that firstused will be updated appropriately on first insertion just the same since the data structure to track the entry itself is larger than a single byte (I think there's also 4-byte alignment rules in play here).

All that said, that's just the insert after sf->leaf conversion case and I'm still working on grokking this code. I haven't considered the other compaction cases and whatnot yet. TBH, even if we do lose a byte in some circumstances, I think that's just a limitation of the on-disk format. We just have to make sure it's documented and handled correctly. Another question is what happens if one one of these blocks is emptied some time later (e.g., is conversion/removal guaranteed? maybe it's more appropriate to reduce the size as well, pretend the blocks are a few bytes shorter and avoid a landmine altogether).

Quoted 10 lines

FWIW, I think the same problem exists in xfs_attr3_leaf_compact():

        /* Initialise the incore headers */
        ichdr_src = *ichdr_dst; /* struct copy */
        ichdr_dst->firstused = args->geo->blksize;

and xfs_attr3_leaf_unbalance():

                tmphdr.firstused = state->args->geo->blksize;

Indeed, thanks for catching these. I'll look through them and the one Dave pointed out.

Quoted 17 lines
Quoted 17 lines
---
 fs/xfs/libxfs/xfs_attr_leaf.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/xfs/libxfs/xfs_attr_leaf.c +2 -1
index 15105db..dc7bda3 100644
@@ -970,7 +970,8 @@ xfs_attr3_leaf_create(
 	memset(leaf, 0, args->geo->blksize);
 
 	memset(&ichdr, 0, sizeof(ichdr));
-	ichdr.firstused = args->geo->blksize;
+	/* firstused is 16-bit */
+	ichdr.firstused = min_t(int, USHRT_MAX, args->geo->blksize);
 
Quoted 11 lines

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create( · line 990

Quoted 8 lines
fs/xfs/libxfs/xfs_attr_leaf.c +1 -1
 	if (xfs_sb_version_hascrc(&mp->m_sb)) {
 		struct xfs_da3_blkinfo *hdr3 = bp->b_addr;
@@ -986,7 +987,7 @@ xfs_attr3_leaf_create(
 		ichdr.magic = XFS_ATTR_LEAF_MAGIC;
 		ichdr.freemap[0].base = sizeof(struct xfs_attr_leaf_hdr);
 	}
-	ichdr.freemap[0].size = ichdr.firstused - ichdr.freemap[0].base;
+	ichdr.freemap[0].size = args->geo->blksize - ichdr.freemap[0].base;

But now freemap.size is out of sync with firstused; is that ok?

I think so, according to the above logic. I'll have to see about those other cases...

Brian

Quoted 10 lines

-Eric

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create(

Quoted 3 lines
fs/xfs/libxfs/xfs_attr_leaf.c +0 -0
 	xfs_attr3_leaf_hdr_to_disk(leaf, &ichdr);
 	xfs_trans_log_buf(args->trans, bp, 0, args->geo->blksize - 1);
 

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

#4 lore raw
In reply to Brian Foster
Quoted 25 lines · Brian Foster

The attr3 leaf header has a 16-bit firstused field that tracks the first used entry offset. This field is initialized to the block size in xfs_attr3_leaf_create() and updated accordingly in xfs_attr3_leaf_add_work() when new attributes are added.

The initialization of firstused overflows if the block size exceeds 16-bits. E.g., xfstests test generic/117 causes assert failures on a -bsize=64k fs on ppc64 because ichdr.firstused evaluates to 0.

Update the firstused initialization to not exceed the maximum value of an unsigned short. This avoids the overflow to 0 and allows firstused to be updated appropriately on subsequent xattr addition. Also update the freemap size calculation to use the actual block size rather than the potentially minimized version stored in firstused.

---
 fs/xfs/libxfs/xfs_attr_leaf.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/xfs/libxfs/xfs_attr_leaf.c +0 -0
index 15105db..dc7bda3 100644

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create( · line 974

Quoted 6 lines
fs/xfs/libxfs/xfs_attr_leaf.c +2 -1
@@ -970,7 +970,8 @@ xfs_attr3_leaf_create(
 	memset(leaf, 0, args->geo->blksize);
 
 	memset(&ichdr, 0, sizeof(ichdr));
-	ichdr.firstused = args->geo->blksize;
+	/* firstused is 16-bit */
+	ichdr.firstused = min_t(int, USHRT_MAX, args->geo->blksize);

Needs a better comment.

fs/xfs/libxfs/xfs_attr_leaf.c xfs_attr3_leaf_create( · line 990

Quoted 9 lines
fs/xfs/libxfs/xfs_attr_leaf.c +1 -1
 	if (xfs_sb_version_hascrc(&mp->m_sb)) {
 		struct xfs_da3_blkinfo *hdr3 = bp->b_addr;
@@ -986,7 +987,7 @@ xfs_attr3_leaf_create(
 		ichdr.magic = XFS_ATTR_LEAF_MAGIC;
 		ichdr.freemap[0].base = sizeof(struct xfs_attr_leaf_hdr);
 	}
-	ichdr.freemap[0].size = ichdr.firstused - ichdr.freemap[0].base;
+	ichdr.freemap[0].size = args->geo->blksize - ichdr.freemap[0].base;

And that also needs an explanation, too.

Cheers,

Dave.

Signature · 7 lines
Dave Chinner
[email protected]

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs