Skip to contentSkip to conversation

scsi: smartpqi: Replace one-element array with flexible-array member

PATCH Applied Gustavo A. R. Silva 3 participants 4 messages Aug 10, 2021 – Aug 24, 2021

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

PATCH 1/1 scsi: smartpqi: 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].

Refactor the code a bit according to the use of a flexible-array member in struct pqi_event_config instead of a one-element array, and use the struct_size() helper.

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/scsi/smartpqi/smartpqi.h      | 2 +-
 drivers/scsi/smartpqi/smartpqi_init.c | 3 +--
 2 files changed, 2 insertions(+), 3 deletions(-)
drivers/scsi/smartpqi/smartpqi.h +1 -1
index f340afc011b5..70eca203d72f 100644
@@ -415,7 +415,7 @@ struct pqi_event_config {
 	u8	reserved[2];
 	u8	num_event_descriptors;
 	u8	reserved1;
-	struct pqi_event_descriptor descriptors[1];
+	struct pqi_event_descriptor descriptors[];
 };
 
 #define PQI_MAX_EVENT_DESCRIPTORS	255
drivers/scsi/smartpqi/smartpqi_init.c +1 -2
index c1f0f8da9fe2..f9107127bd6e 100644
@@ -4740,8 +4740,7 @@ static int pqi_create_queues(struct pqi_ctrl_info *ctrl_info)
 }
 
 #define PQI_REPORT_EVENT_CONFIG_BUFFER_LENGTH	\
-	(offsetof(struct pqi_event_config, descriptors) + \
-	(PQI_MAX_EVENT_DESCRIPTORS * sizeof(struct pqi_event_descriptor)))
+	struct_size((struct pqi_event_config *)0, descriptors, PQI_MAX_EVENT_DESCRIPTORS)
 
 static int pqi_configure_events(struct pqi_ctrl_info *ctrl_info,
 	bool enable_events)
Signature · 1 line
2.27.0
#1 lore raw

Gustavo,

Quoted 5 lines

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].

Applied to 5.15/scsi-staging, thanks!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering
#2 lore raw

Hi Martin,

Quoted 10 lines · Martin K. Petersen

Gustavo,

Quoted 5 lines

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].

Applied to 5.15/scsi-staging, thanks!

Thanks for this. :)

Could you take this series too, please:

https://lore.kernel.org/linux-hardening/[email protected]/

Thanks!
--
Gustavo

#3 lore raw
In reply to Gustavo A. R. Silva
Quoted 10 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].

Refactor the code a bit according to the use of a flexible-array member in struct pqi_event_config instead of a one-element array, and use the struct_size() helper.

[...]

Applied to 5.15/scsi-queue, thanks!

[1/1] scsi: smartpqi: Replace one-element array with flexible-array member

      https://git.kernel.org/mkp/scsi/c/5f492a7aa13b
Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering