gpu: nova-core: bitfield: fix broken Default implementation
Subsystems (4)
PATCH 1/1 gpu: nova-core: bitfield: fix broken Default implementation
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
---
It doesn't actually set the default values for each field. I know that bitfields are being moved soon, so maybe this fix is unnecessary but I saw it and it's a simple fix.
--- drivers/gpu/nova-core/bitfield.rs | 50 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 3 deletions(-)
drivers/gpu/nova-core/bitfield.rs +47 -3
@@ -4,6 +4,8 @@//! //! Support for defining bitfields in Rust structures. Also used by the [`register!`] macro. +use kernel::prelude::*; +/// Defines a struct with accessors to access bits within an inner unsigned integer. /// /// # Syntax
@@ -314,12 +316,11 @@ fn fmt(&self, f: &mut ::kernel::fmt::Formatter<'_>) -> ::kernel::fmt::Result {/// Returns a value for the bitfield where all fields are set to their default value. impl ::core::default::Default for $name {fn default () ->Self { -#[allow(unused_mut)] -let mut value =Self (Default ::default ()); +let value =Self (Default ::default ()); ::kernel::macros::paste!( $( - value.[<set_ $field>](Default ::default ()); +let value = value.[<set_ $field>](Default ::default ()); )* );
@@ -328,3 +329,46 @@ fn default() -> Self { } }; } + +#[kunit_tests(nova_core_bitfield)] +mod tests { +use super ::*; + +#[derive( Debug , Clone , Copy , Default , PartialEq , Eq )] +enum State { +Inactive =0 , +#[default] +Active =1 , + } + +impl From <bool >for State { +fn from (value:bool ) ->Self { +if value { +State ::Active + }else { +State ::Inactive + } + } + } + +impl From <State >for bool { +fn from (state:State ) ->bool { +match state { +State ::Inactive =>false , +State ::Active =>true , + } + } + } + +bitfield! { +struct TestBitfield (u32 ) { +0 :0 stateas bool =>State ; + } + } + +#[test] +fn default_impl () ->Result { +assert_eq! (TestBitfield ::default ().state (),State ::Active ); +Ok (()) + } +}
---
base-commit: 7c50d748b4a635bc39802ea3f6b120e66b1b9067
change-id: 20260331-fix-bitfield-a03f6d1b9e00
Best regards,
Signature · 1 line
Eliot Courtney <[email protected]>
Gary Guo
reviewerQuoted 8 lines · Eliot Courtney
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
Signed-off-by Eliot Courtney <[email protected]>---
It doesn't actually set the default values for each field. I know that bitfields are being moved soon, so maybe this fix is unnecessary but I saw it and it's a simple fix.
Good catch! This is why I think it's important to use with_ for this sort of methods as they are confusingly non-mutating :)
Could you add a Fixes tag?
Best,
Gary
Quoted 87 lines
--- drivers/gpu/nova-core/bitfield.rs | 50 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 3 deletions(-)drivers/gpu/nova-core/bitfield.rs +47
-4@@ -4,6 +4,8 @@//! //! Support for defining bitfields in Rust structures. Also used by the [`register!`] macro. +use kernel::prelude::*; +/// Defines a struct with accessors to access bits within an inner unsigned integer. /// /// # Syntax @@ -314,12 +316,11 @@ fn fmt(&self, f: &mut ::kernel::fmt::Formatter<'_>) -> ::kernel::fmt::Result {/// Returns a value for the bitfield where all fields are set to their default value. impl ::core::default::Default for $name {fn default () ->Self { -#[allow(unused_mut)] -let mut value =Self (Default ::default ()); +let value =Self (Default ::default ()); ::kernel::macros::paste!( $( - value.[<set_ $field>](Default ::default ()); +let value = value.[<set_ $field>](Default ::default ()); )* );@@ -328,3 +329,46 @@ fn default() -> Self { } }; } + +#[kunit_tests(nova_core_bitfield)] +mod tests { +use super ::*; + +#[derive( Debug , Clone , Copy , Default , PartialEq , Eq )] +enum State { +Inactive =0 , +#[default] +Active =1 , + } + +impl From <bool >for State { +fn from (value:bool ) ->Self { +if value { +State ::Active + }else { +State ::Inactive + } + } + } + +impl From <State >for bool { +fn from (state:State ) ->bool { +match state { +State ::Inactive =>false , +State ::Active =>true , + } + } + } + +bitfield! { +struct TestBitfield (u32 ) { +0 :0 stateas bool =>State ; + } + } + +#[test] +fn default_impl () ->Result { +assert_eq! (TestBitfield ::default ().state (),State ::Active ); +Ok (()) + } +} ---base-commit:
7c50d748b4a635bc39802ea3f6b120e66b1b9067
change-id: 20260331-fix-bitfield-a03f6d1b9e00Best regards,
Signature · 1 line
Eliot Courtney <[email protected]>
Danilo Krummrich
maintainerQuoted 4 lines · Eliot Courtney
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
Signed-off-by Eliot Courtney <[email protected]>
Thanks for the fix!
Please add a Fixes: tag and separate the fix from the newly introduced Kunit test.
Maybe it is not worth adding the Kunit test in here as generic bitfields are being worked on, but I don't mind.
- Danilo
Quoted 4 lines · Danilo Krummrich
Quoted 3 lines · Eliot Courtney
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
Quoted 9 lines
Quoted 1 line
Signed-off-by Eliot Courtney <[email protected]>Thanks for the fix!
Please add a Fixes: tag and separate the fix from the newly introduced Kunit test.
Maybe it is not worth adding the Kunit test in here as generic bitfields are being worked on, but I don't mind.
If there is a chance that we won't need the Kunit test eventually, then please either delete it here, or add a TODO to delete it when generic bitfields cover this.
(Kunit, like any other test suite, is easy to add to, but also easy to avoid pruning--and so over time it risks being full of tests that are redundant or no longer needed.)
thanks,
Signature · 1 line
John Hubbard
Quoted 19 lines · John Hubbard
Quoted 4 lines · Danilo Krummrich
Quoted 3 lines · Eliot Courtney
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
Quoted 9 lines
Quoted 1 line
Signed-off-by Eliot Courtney <[email protected]>Thanks for the fix!
Please add a Fixes: tag and separate the fix from the newly introduced Kunit test.
Maybe it is not worth adding the Kunit test in here as generic bitfields are being worked on, but I don't mind.
If there is a chance that we won't need the Kunit test eventually, then please either delete it here, or add a TODO to delete it when generic bitfields cover this.
Quoted 5 lines
(Kunit, like any other test suite, is easy to add to, but also easy to avoid pruning--and so over time it risks being full of tests that are redundant or no longer needed.)
thanks,
I think this entire file will be deleted so it'll be gone regardless. I think we can skip it, just wrote it to test my change locally anyway.
Quoted 4 lines · Eliot Courtney
The current implementation does not actually set the default values for the fields in the bitfield. Set it and add a test.
Signed-off-by Eliot Courtney <[email protected]>
thanks,
--
Joel Fernandes
Quoted 92 lines
---
It doesn't actually set the default values for each field. I know that bitfields are being moved soon, so maybe this fix is unnecessary but I saw it and it's a simple fix.--- drivers/gpu/nova-core/bitfield.rs | 50 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 3 deletions(-)drivers/gpu/nova-core/bitfield.rs +47
-4@@ -4,6 +4,8 @@//! //! Support for defining bitfields in Rust structures. Also used by the [`register!`] macro. +use kernel::prelude::*; +/// Defines a struct with accessors to access bits within an inner unsigned integer. /// /// # Syntax @@ -314,12 +316,11 @@ fn fmt(&self, f: &mut ::kernel::fmt::Formatter<'_>) -> ::kernel::fmt::Result {/// Returns a value for the bitfield where all fields are set to their default value. impl ::core::default::Default for $name {fn default () ->Self { -#[allow(unused_mut)] -let mut value =Self (Default ::default ()); +let value =Self (Default ::default ()); ::kernel::macros::paste!( $( - value.[<set_ $field>](Default ::default ()); +let value = value.[<set_ $field>](Default ::default ()); )* );@@ -328,3 +329,46 @@ fn default() -> Self { } }; } + +#[kunit_tests(nova_core_bitfield)] +mod tests { +use super ::*; + +#[derive( Debug , Clone , Copy , Default , PartialEq , Eq )] +enum State { +Inactive =0 , +#[default] +Active =1 , + } + +impl From <bool >for State { +fn from (value:bool ) ->Self { +if value { +State ::Active + }else { +State ::Inactive + } + } + } + +impl From <State >for bool { +fn from (state:State ) ->bool { +match state { +State ::Inactive =>false , +State ::Active =>true , + } + } + } + +bitfield! { +struct TestBitfield (u32 ) { +0 :0 stateas bool =>State ; + } + } + +#[test] +fn default_impl () ->Result { +assert_eq! (TestBitfield ::default ().state (),State ::Active ); +Ok (()) + } +} ---base-commit:
7c50d748b4a635bc39802ea3f6b120e66b1b9067
change-id: 20260331-fix-bitfield-a03f6d1b9e00Best regards,
Signature · 1 line
Eliot Courtney <[email protected]>