Skip to contentSkip to conversation

KVM: s390: Don't cast parameter in bit operations

PATCH In review Andy Shevchenko 6 participants 11 messages Feb 23, 2022 – Mar 3, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 KVM: s390: Don't cast parameter in bit operations

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

Fixes d77e64141e32 ("KVM: s390: implement GISA IPM related primitives")
---
 arch/s390/include/asm/kvm_host.h | 5 ++++-
 arch/s390/kvm/interrupt.c        | 6 +++---
 2 files changed, 7 insertions(+), 4 deletions(-)
arch/s390/include/asm/kvm_host.h +4 -1
index a22c9266ea05..f1c4a1b9b360 100644
@@ -867,7 +867,10 @@ struct kvm_s390_gisa {
 			u8  reserved03[11];
 			u32 airq_count;
 		} g1;
-		struct {
+		struct { /* as a 256-bit bitmap */
+			DECLARE_BITMAP(b, 256);
+		} bitmap;
+		struct { /* as a set of 64-bit words */
 			u64 word[4];
 		} u64;
 	};
arch/s390/kvm/interrupt.c +3 -3
index db933c252dbc..04e055cbd080 100644
@@ -304,7 +304,7 @@ static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa)
 
 static inline void gisa_set_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	set_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
 }
 
 static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
@@ -314,12 +314,12 @@ static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
 
 static inline void gisa_clear_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
 }
 
 static inline int gisa_tac_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
 }
 
 static inline unsigned long pending_irqs_no_gisa(struct kvm_vcpu *vcpu)
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 35 lines · On Wed, 23 Feb 2022 18:44:20 +0200 Andy Shevchenko…

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

Fixes d77e64141e32 ("KVM: s390: implement GISA IPM related primitives")
---
 arch/s390/include/asm/kvm_host.h | 5 ++++-
 arch/s390/kvm/interrupt.c        | 6 +++---
 2 files changed, 7 insertions(+), 4 deletions(-)
arch/s390/include/asm/kvm_host.h +4 -1
index a22c9266ea05..f1c4a1b9b360 100644
@@ -867,7 +867,10 @@ struct kvm_s390_gisa {
 			u8  reserved03[11];
 			u32 airq_count;
 		} g1;
-		struct {
+		struct { /* as a 256-bit bitmap */
+			DECLARE_BITMAP(b, 256);
+		} bitmap;
+		struct { /* as a set of 64-bit words */
 			u64 word[4];
 		} u64;
 	};
arch/s390/kvm/interrupt.c +0 -0
index db933c252dbc..04e055cbd080 100644

arch/s390/kvm/interrupt.c static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa) · line 307

Quoted 5 lines
arch/s390/kvm/interrupt.c +1 -1
@@ -304,7 +304,7 @@ static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa)
 
 static inline void gisa_set_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	set_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);

wouldn't it be enough to pass gisa->u64.word here? then no cast would be necessary

Quoted 18 lines
arch/s390/kvm/interrupt.c +2 -2
 }
 
 static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
@@ -314,12 +314,12 @@ static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
 
 static inline void gisa_clear_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
 }
 
 static inline int gisa_tac_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
 {
-	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
 }
 
 static inline unsigned long pending_irqs_no_gisa(struct kvm_vcpu *vcpu)
#2 lore raw
Quoted 39 lines · Claudio Imbrenda
Quoted 36 lines · On Wed, 23 Feb 2022 18:44:20 +0200 Andy Shevchenko…

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

Fixes d77e64141e32 ("KVM: s390: implement GISA IPM related primitives")
---
  arch/s390/include/asm/kvm_host.h | 5 ++++-
  arch/s390/kvm/interrupt.c        | 6 +++---
  2 files changed, 7 insertions(+), 4 deletions(-)
arch/s390/include/asm/kvm_host.h +4 -1
index a22c9266ea05..f1c4a1b9b360 100644
@@ -867,7 +867,10 @@ struct kvm_s390_gisa {
  			u8  reserved03[11];
  			u32 airq_count;
  		} g1;
-		struct {
+		struct { /* as a 256-bit bitmap */
+			DECLARE_BITMAP(b, 256);
+		} bitmap;
+		struct { /* as a set of 64-bit words */
  			u64 word[4];
  		} u64;
  	};
arch/s390/kvm/interrupt.c +0 -0
index db933c252dbc..04e055cbd080 100644
@@ -304,7 +304,7 @@ static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa)
 
Quoted 7 lines

arch/s390/kvm/interrupt.c static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa) · line 307

Quoted 4 lines
arch/s390/kvm/interrupt.c +1 -1
  static inline void gisa_set_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
  {
-	set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	set_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);

wouldn't it be enough to pass gisa->u64.word here? then no cast would be necessary

we do that at several places

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long *)&stfle_fac_list, MAX_FACILITY_BIT)
arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *) sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *) &sca->mcn);

Quoted 20 lines
Quoted 19 lines
arch/s390/kvm/interrupt.c +2 -2
  }
 
  static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
@@ -314,12 +314,12 @@ static inline u8 gisa_get_ipm(struct kvm_s390_gisa *gisa)
 
  static inline void gisa_clear_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
  {
-	clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
  }
 
  static inline int gisa_tac_ipm_gisc(struct kvm_s390_gisa *gisa, u32 gisc)
  {
-	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+	return test_and_clear_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
  }
 
  static inline unsigned long pending_irqs_no_gisa(struct kvm_vcpu *vcpu)
#3 lore raw
Quoted 1 line · Michael Mueller

On 24.02.22 12:36, Claudio Imbrenda wrote:

...

Quoted 1 line

we do that at several places

Thanks for pointing out.

Quoted 2 lines

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long
*)&stfle_fac_list, MAX_FACILITY_BIT)

This one requires a separate change, not related to this patch.

Quoted 2 lines

arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long
*) gisa);

This is done in the patch. Not sure how it appears in your list.

Quoted 4 lines

arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
&sca->mcn);

These two should be fixed in a separate change.

Also this kind of stuff:

	bitmap_copy(kvm->arch.cpu_feat, (unsigned long *) data.feat,
	            KVM_S390_VM_CPU_FEAT_NR_BITS);

might require a new API like

bitmap_from_u64_array()
bitmap_to_u64_array()

Yury?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#4 lore raw
Quoted 31 lines · Andy Shevchenko
Quoted 1 line · Michael Mueller

On 24.02.22 12:36, Claudio Imbrenda wrote:

...

Quoted 1 line

we do that at several places

Thanks for pointing out.

Quoted 2 lines

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long
*)&stfle_fac_list, MAX_FACILITY_BIT)

This one requires a separate change, not related to this patch.

Quoted 2 lines

arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long
*) gisa);

This is done in the patch. Not sure how it appears in your list.

Quoted 4 lines

arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
&sca->mcn);

These two should be fixed in a separate change.

Also this kind of stuff:

	bitmap_copy(kvm->arch.cpu_feat, (unsigned long *) data.feat,
	            KVM_S390_VM_CPU_FEAT_NR_BITS);
Quoted 6 lines

might require a new API like

bitmap_from_u64_array()
bitmap_to_u64_array()

Yury?

If BE32 is still the case then yes.

#5 lore raw
Quoted 32 lines · Yury Norov
Quoted 31 lines · Andy Shevchenko
Quoted 1 line · Michael Mueller

On 24.02.22 12:36, Claudio Imbrenda wrote:

...

Quoted 1 line

we do that at several places

Thanks for pointing out.

Quoted 2 lines

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long
*)&stfle_fac_list, MAX_FACILITY_BIT)

This one requires a separate change, not related to this patch.

Quoted 2 lines

arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long
*) gisa);

This is done in the patch. Not sure how it appears in your list.

Quoted 4 lines

arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
&sca->mcn);

These two should be fixed in a separate change.

Also this kind of stuff:

	bitmap_copy(kvm->arch.cpu_feat, (unsigned long *) data.feat,
	            KVM_S390_VM_CPU_FEAT_NR_BITS);
Quoted 8 lines
Quoted 6 lines

might require a new API like

bitmap_from_u64_array()
bitmap_to_u64_array()

Yury?

If BE32 is still the case then yes.

The whole point is to get rid of the bad pattern, while it may still work in the particular case.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#6 lore raw
Quoted 38 lines · Andy Shevchenko
Quoted 37 lines · Yury Norov
Quoted 36 lines · Andy Shevchenko
Quoted 1 line · Michael Mueller

On 24.02.22 12:36, Claudio Imbrenda wrote:

...

Quoted 1 line

we do that at several places

Thanks for pointing out.

Quoted 2 lines

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long
*)&stfle_fac_list, MAX_FACILITY_BIT)

This one requires a separate change, not related to this patch.

Quoted 2 lines

arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long
*) gisa);

This is done in the patch. Not sure how it appears in your list.

Quoted 4 lines

arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
&sca->mcn);

These two should be fixed in a separate change.

Also this kind of stuff:

	bitmap_copy(kvm->arch.cpu_feat, (unsigned long *) data.feat,
	            KVM_S390_VM_CPU_FEAT_NR_BITS);

might require a new API like

bitmap_from_u64_array()
bitmap_to_u64_array()

Quoted 6 lines
Quoted 3 lines
Quoted 1 line

Yury?

If BE32 is still the case then yes.

The whole point is to get rid of the bad pattern, while it may still work in the particular case.

Then yes unconditionally. Is it already on table of s390 folks? If no, I can do it myself.

We have bitmap_from_arr32 and bitmap_to_arr32, so for 64-bit versions, we'd start from that.

#7 lore raw
Quoted 43 lines · Yury Norov
Quoted 42 lines · Andy Shevchenko
Quoted 40 lines · Yury Norov
Quoted 31 lines · Andy Shevchenko
Quoted 1 line · Michael Mueller

On 24.02.22 12:36, Claudio Imbrenda wrote:

...

Quoted 1 line

we do that at several places

Thanks for pointing out.

Quoted 2 lines

arch/s390/kernel/processor.c: for_each_set_bit_inv(bit, (long
*)&stfle_fac_list, MAX_FACILITY_BIT)

This one requires a separate change, not related to this patch.

Quoted 2 lines

arch/s390/kvm/interrupt.c: set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long
*) gisa);

This is done in the patch. Not sure how it appears in your list.

Quoted 4 lines

arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
sca->mcn);
arch/s390/kvm/kvm-s390.c: set_bit_inv(vcpu->vcpu_id, (unsigned long *)
&sca->mcn);

These two should be fixed in a separate change.

Also this kind of stuff:

	bitmap_copy(kvm->arch.cpu_feat, (unsigned long *) data.feat,
	            KVM_S390_VM_CPU_FEAT_NR_BITS);
Quoted 6 lines

might require a new API like

bitmap_from_u64_array()
bitmap_to_u64_array()

Yury?

If BE32 is still the case then yes.

Quoted 8 lines
Quoted 2 lines

The whole point is to get rid of the bad pattern, while it may still work in the particular case.

Then yes unconditionally. Is it already on table of s390 folks? If no, I can do it myself.

We have bitmap_from_arr32 and bitmap_to_arr32, so for 64-bit versions, we'd start from that.

Yep, thanks!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw
In reply to Claudio Imbrenda
Quoted 10 lines · Claudio Imbrenda
Quoted 6 lines · On Wed, 23 Feb 2022 18:44:20 +0200 Andy Shevchenko…

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

...

Quoted 7 lines
Quoted 6 lines
arch/s390/include/asm/kvm_host.h +4 -0
+             struct { /* as a 256-bit bitmap */
+                     DECLARE_BITMAP(b, 256);
+             } bitmap;
+             struct { /* as a set of 64-bit words */
                      u64 word[4];
              } u64;
Quoted 5 lines

arch/s390/kvm/interrupt.c static inline int gisa_in_alert_list(struct kvm_s390_gisa *gisa) · line 307

Quoted 2 lines
arch/s390/kvm/interrupt.c +1 -1
-     set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+     set_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);

wouldn't it be enough to pass gisa->u64.word here? then no cast would be necessary

No, it will have the same hidden bugs. As I stated in the commit message, the pattern is quite bad even if in particular code it would work.

Thanks, Michael, for pointing out other places. They all need to be fixed.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#9 lore raw

From: Andy Shevchenko

Quoted 26 lines

Sent: 24 February 2022 19:51

Quoted 10 lines · Claudio Imbrenda
Quoted 6 lines · On Wed, 23 Feb 2022 18:44:20 +0200 Andy Shevchenko…

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

...

Quoted 10 lines
Quoted 9 lines
arch/s390/include/asm/kvm_host.h +5 -1
+             struct { /* as a 256-bit bitmap */
+                     DECLARE_BITMAP(b, 256);
+             } bitmap;
+             struct { /* as a set of 64-bit words */
                      u64 word[4];
              } u64;
 
-     set_bit_inv(IPM_BIT_OFFSET + gisc, (unsigned long *) gisa);
+     set_bit_inv(IPM_BIT_OFFSET + gisc, gisa->bitmap.b);
Quoted 8 lines
Quoted 2 lines

wouldn't it be enough to pass gisa->u64.word here? then no cast would be necessary

No, it will have the same hidden bugs. As I stated in the commit message, the pattern is quite bad even if in particular code it would work.

Thanks, Michael, for pointing out other places. They all need to be fixed.

It may even be worth writing some alternate bitmap functions that use u64[] and unlocked operations?

Although I think I'd still want to encapsulate the actual array (somehow) so that what is defined has to be the bitmap type.

David

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)

#10 lore raw
In reply to Andy Shevchenko
Quoted 6 lines · Andy Shevchenko

While in this particular case it would not be a (critical) issue, the pattern itself is bad and error prone in case somebody blindly copies to their code.

Don't cast parameter to unsigned long pointer in the bit operations. Instead copy to a local variable on stack of a proper type and use.

After looking into other similar cases I may conclude they
- need to be fixed
- out of scope of this change

Hence, can this fix be applied?

Signature · 2 lines
With Best Regards,
Andy Shevchenko