Skip to contentSkip to conversation

jbd2: enforce power-of-two default revoke hash size at compile time

PATCH In review Milos Nikic 4 participants 5 messages Apr 13 – Apr 16 Journalling layer for block devices (JBD2)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 jbd2: enforce power-of-two default revoke hash size at compile time

The jbd2 revoke table relies on bitwise AND operations for fast hash indexing, which requires the hash table size to be a strict power of two.

Currently, this requirement is only enforced at runtime via a J_ASSERT in jbd2_journal_init_revoke(). While this successfully catches invalid dynamic allocations, it means a developer accidentally modifying the hardcoded JOURNAL_REVOKE_DEFAULT_HASH macro will experience a system panic upon mounting the filesystem during testing.

Add a BUILD_BUG_ON() in journal_init_common() to validate the default macro at compile time. This acts as an immediate, zero-overhead safeguard, preventing compilation entirely if the default hash size is mathematically invalid.

---
 fs/jbd2/journal.c | 1 +
 1 file changed, 1 insertion(+)
fs/jbd2/journal.c +1 -0
index 4f397fcdb13c..62b36a2fc4e2 100644
@@ -1565,6 +1565,7 @@ static journal_t *journal_init_common(struct block_device *bdev,
 	/* The journal is marked for error until we succeed with recovery! */
 	journal->j_flags = JBD2_ABORT;
 
+	BUILD_BUG_ON(!is_power_of_2(JOURNAL_REVOKE_DEFAULT_HASH));
 	/* Set up a default-sized revoke table for the new mount. */
 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
 	if (err)
Signature · 1 line
2.53.0
#1 lore raw
Quoted 9 lines · Milos Nikic

The jbd2 revoke table relies on bitwise AND operations for fast hash indexing, which requires the hash table size to be a strict power of two.

Currently, this requirement is only enforced at runtime via a J_ASSERT in jbd2_journal_init_revoke(). While this successfully catches invalid dynamic allocations, it means a developer accidentally modifying the hardcoded JOURNAL_REVOKE_DEFAULT_HASH macro will experience a system panic upon mounting the filesystem during testing.

Quoted 6 lines

Add a BUILD_BUG_ON() in journal_init_common() to validate the default macro at compile time. This acts as an immediate, zero-overhead safeguard, preventing compilation entirely if the default hash size is mathematically invalid.

Eh, if you modify JOURNAL_REVOKE_DEFAULT_HASH you should better know what you are doing and if you mess up, then the kernel failing with assertion isn't that difficult to diagnose. So sorry I don't think this "cleanup" is useful either.

Honza

Quoted 19 lines
---
 fs/jbd2/journal.c | 1 +
 1 file changed, 1 insertion(+)
fs/jbd2/journal.c +1 -0
index 4f397fcdb13c..62b36a2fc4e2 100644
@@ -1565,6 +1565,7 @@ static journal_t *journal_init_common(struct block_device *bdev,
 	/* The journal is marked for error until we succeed with recovery! */
 	journal->j_flags = JBD2_ABORT;
 
+	BUILD_BUG_ON(!is_power_of_2(JOURNAL_REVOKE_DEFAULT_HASH));
 	/* Set up a default-sized revoke table for the new mount. */
 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
 	if (err)
Signature · 1 line
2.53.0
Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR
#2 lore raw
Quoted 16 lines · Jan Kara
Quoted 14 lines · Milos Nikic

The jbd2 revoke table relies on bitwise AND operations for fast hash indexing, which requires the hash table size to be a strict power of two.

Currently, this requirement is only enforced at runtime via a J_ASSERT in jbd2_journal_init_revoke(). While this successfully catches invalid dynamic allocations, it means a developer accidentally modifying the hardcoded JOURNAL_REVOKE_DEFAULT_HASH macro will experience a system panic upon mounting the filesystem during testing.

Add a BUILD_BUG_ON() in journal_init_common() to validate the default macro at compile time. This acts as an immediate, zero-overhead safeguard, preventing compilation entirely if the default hash size is mathematically invalid.

Quoted 6 lines
Quoted 1 line

Eh, if you modify JOURNAL_REVOKE_DEFAULT_HASH you should better know what you are doing and if you mess up, then the kernel failing with assertion isn't that difficult to diagnose. So sorry I don't think this "cleanup" is useful either.

Jan,
this is a BUILD_BUG_ON() so it won't cause any runtime assertion.

Cheers, Andreas

Quoted 14 lines

Honza

Quoted 12 lines

---
fs/jbd2/journal.c | 1 +

1 file changed, 1 insertion(+)
fs/jbd2/journal.c +0 -0
index 4f397fcdb13c..62b36a2fc4e2 100644
@@ -1565,6 +1565,7 @@ static journal_t *journal_init_common(struct 
 	/* The journal is marked for error until we succeed with recovery! */
 	journal->j_flags = JBD2_ABORT;
 
Quoted 11 lines
Quoted 7 lines
fs/jbd2/journal.c +1 -0
+	BUILD_BUG_ON(!is_power_of_2(JOURNAL_REVOKE_DEFAULT_HASH));
 	/* Set up a default-sized revoke table for the new mount. */
 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
 	if (err)
Signature · 1 line
2.53.0
Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR

Cheers, Andreas

#3 lore raw

Hi!

Quoted 18 lines · Andreas Dilger
Quoted 17 lines · Jan Kara
Quoted 15 lines · Milos Nikic

The jbd2 revoke table relies on bitwise AND operations for fast hash indexing, which requires the hash table size to be a strict power of two.

Currently, this requirement is only enforced at runtime via a J_ASSERT in jbd2_journal_init_revoke(). While this successfully catches invalid dynamic allocations, it means a developer accidentally modifying the hardcoded JOURNAL_REVOKE_DEFAULT_HASH macro will experience a system panic upon mounting the filesystem during testing.

Add a BUILD_BUG_ON() in journal_init_common() to validate the default macro at compile time. This acts as an immediate, zero-overhead safeguard, preventing compilation entirely if the default hash size is mathematically invalid.

Quoted 7 lines
Quoted 4 lines

Eh, if you modify JOURNAL_REVOKE_DEFAULT_HASH you should better know what you are doing and if you mess up, then the kernel failing with assertion isn't that difficult to diagnose. So sorry I don't think this "cleanup" is useful either.

Jan,
this is a BUILD_BUG_ON() so it won't cause any runtime assertion.

Yes, I know. But there is already a runtime assertion in jbd2_journal_init_revoke() making sure the passed value is a power of two which is verifying also other callers that aren't using JOURNAL_REVOKE_DEFAULT_HASH value. I don't see a value in the *additional* BUILD_BUG_ON when we already have that runtime check.

Honza

Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR
maintainer
#4 lore raw
Quoted 6 lines · Jan Kara

Yes, I know. But there is already a runtime assertion in jbd2_journal_init_revoke() making sure the passed value is a power of two which is verifying also other callers that aren't using JOURNAL_REVOKE_DEFAULT_HASH value. I don't see a value in the *additional* BUILD_BUG_ON when we already have that runtime check.

... and if a developer doesn't run regression tests before bothering the list with a patch... that's not a developer we want to cater to.

Milos, my recommended to workflow is to use kvm-xfstests[1], and just do:

% install-kconfig
% kbuild
% kvm-xfstests smoke

[1] https://github.com/tytso/xfstests-bld/blob/master/Documentation/kvm-quickstart.md

For a successful run, "kvm-xfstests smoke" will run take 15-20 minutes. In the case of screwing up the default power-of-two default revoke hash size, "kvm-xfstests smoke" will report a failure in less than a minute.

- Ted