Skip to contentSkip to conversation

mwifiex: usb: Replace one-element array with flexible-array member

PATCH In review Gustavo A. R. Silva 4 participants 4 messages Aug 9, 2021 – Aug 21, 2021

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

PATCH 1/1 mwifiex: usb: Replace one-element array with flexible-array member

There is a regular need in the kernel to provide a way to declare having a dynamically sized set of trailing elements in a structure. Kernel code should always use “flexible array members”[1] for these cases. The older style of one-element or zero-length arrays should no longer be used[2].

This helps with the ongoing efforts to globally enable -Warray-bounds and get us closer to being able to tighten the FORTIFY_SOURCE routines on memcpy().

This issue was found with the help of Coccinelle and audited and fixed, manually.

[1] https://en.wikipedia.org/wiki/Flexible_array_member
[2] https://www.kernel.org/doc/html/v5.10/process/deprecated.html#zero-length-and-one-element-arrays

---
 drivers/net/wireless/marvell/mwifiex/usb.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/wireless/marvell/mwifiex/usb.h +1 -1
index d822ec15b7e6..61a96b7fbf21 100644
@@ -134,7 +134,7 @@ struct fw_sync_header {
 struct fw_data {
 	struct fw_header fw_hdr;
 	__le32 seq_num;
-	u8 data[1];
+	u8 data[];
 } __packed;
 
 #endif /*_MWIFIEX_USB_H */
Signature · 1 line
2.27.0
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 13 lines · Gustavo A. R. Silva

There is a regular need in the kernel to provide a way to declare having a dynamically sized set of trailing elements in a structure. Kernel code should always use “flexible array members”[1] for these cases. The older style of one-element or zero-length arrays should no longer be used[2].

This helps with the ongoing efforts to globally enable -Warray-bounds and get us closer to being able to tighten the FORTIFY_SOURCE routines on memcpy().

This issue was found with the help of Coccinelle and audited and fixed, manually.

Quoted 6 lines

[1] https://en.wikipedia.org/wiki/Flexible_array_member
[2] https://www.kernel.org/doc/html/v5.10/process/deprecated.html#zero-length-and-one-element-arrays

An important part of your patch rationale should include determining that the 1-length wasn't actually important anywhere. I double checked for you, and nobody seemed to be relying on 'sizeof struct fw_data' at all, so this should be OK:

#2 lore raw
Quoted 18 lines · Brian Norris
Quoted 16 lines · Gustavo A. R. Silva

There is a regular need in the kernel to provide a way to declare having a dynamically sized set of trailing elements in a structure. Kernel code should always use “flexible array members”[1] for these cases. The older style of one-element or zero-length arrays should no longer be used[2].

This helps with the ongoing efforts to globally enable -Warray-bounds and get us closer to being able to tighten the FORTIFY_SOURCE routines on memcpy().

This issue was found with the help of Coccinelle and audited and fixed, manually.

[1] https://en.wikipedia.org/wiki/Flexible_array_member
[2] https://www.kernel.org/doc/html/v5.10/process/deprecated.html#zero-length-and-one-element-arrays

Quoted 8 lines
Quoted 3 lines

An important part of your patch rationale should include determining that the 1-length wasn't actually important anywhere. I double checked for you, and nobody seemed to be relying on 'sizeof struct fw_data' at all, so this should be OK:

I always do that. That's the reason why I included this line in the changelog text:

"This issue was found with the help of Coccinelle and audited and fixed, manually."

Thanks for double-checking, though. :)

Quoted 1 line

Thanks
--
Gustavo

#3 lore raw
In reply to Gustavo A. R. Silva
Quoted 12 lines · Gustavo A. R. Silva

There is a regular need in the kernel to provide a way to declare having a dynamically sized set of trailing elements in a structure. Kernel code should always use “flexible array members”[1] for these cases. The older style of one-element or zero-length arrays should no longer be used[2].

This helps with the ongoing efforts to globally enable -Warray-bounds and get us closer to being able to tighten the FORTIFY_SOURCE routines on memcpy().

This issue was found with the help of Coccinelle and audited and fixed, manually.

Quoted 7 lines

[1] https://en.wikipedia.org/wiki/Flexible_array_member
[2] https://www.kernel.org/doc/html/v5.10/process/deprecated.html#zero-length-and-one-element-arrays

Patch applied to wireless-drivers-next.git, thanks.

090f2c5d3d07 mwifiex: usb: Replace one-element array with flexible-array member

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/patch/20210809211134.GA22488@embeddedor/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches