Skip to contentSkip to conversation

scsi: advansys: Replace zero-length array with flexible-array member

PATCH Applied Gustavo A. R. Silva 4 participants 5 messages Feb 13, 2020 – Feb 18, 2020

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

PATCH 1/1 scsi: advansys: Replace zero-length array with flexible-array member

The current codebase makes use of the zero-length array language extension to the C90 standard, but the preferred mechanism to declare variable-length types such as these ones is a flexible array member[1][2], introduced in C99:

struct foo {
        int stuff;
        struct boo array[];
};

By making use of the mechanism above, we will get a compiler warning in case the flexible array does not occur last in the structure, which will help us prevent some kind of undefined behavior bugs from being inadvertently introduced[3] to the codebase from now on.

Also, notice that, dynamic memory allocations won't be affected by this change:

"Flexible array members have incomplete type, and so the sizeof operator may not be applied. As a quirk of the original implementation of zero-length arrays, sizeof evaluates to zero."[1]

This issue was found with the help of Coccinelle.

[1] https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
[2] https://github.com/KSPP/linux/issues/21
[3] commit 76497732932f ("cxgb3/l2t: Fix undefined behaviour")

---
 drivers/scsi/advansys.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/scsi/advansys.c +1 -1
index a242a62caaa1..c2c7850ff7b4 100644
@@ -316,7 +316,7 @@ typedef struct asc_sg_head {
 	ushort queue_cnt;
 	ushort entry_to_copy;
 	ushort res;
-	ASC_SG_LIST sg_list[0];
+	ASC_SG_LIST sg_list[];
 } ASC_SG_HEAD;
 
 typedef struct asc_scsi_q {
Signature · 1 line
2.23.0
maintainer
#1 lore raw
Quoted 2 lines · Gustavo A. R. Silva

Also, notice that, dynamic memory allocations won't be affected by this change:

Shouldn't you also convert this:

                asc_sg_head = kzalloc(sizeof(asc_scsi_q->sg_head) +
                        use_sg * sizeof(struct asc_sg_list), GFP_ATOMIC);

to use struct_size()?

#2 lore raw
Quoted 9 lines · Matthew Wilcox
Quoted 2 lines · Gustavo A. R. Silva

Also, notice that, dynamic memory allocations won't be affected by this change:

Shouldn't you also convert this:

                asc_sg_head = kzalloc(sizeof(asc_scsi_q->sg_head) +
                        use_sg * sizeof(struct asc_sg_list), GFP_ATOMIC);

to use struct_size()?

It's not a requirement to do that prior to applying the change proposed by this patch.

Thanks
--
Gustavo

Reviewed-by on v1 1/1
#3 lore raw
In reply to Gustavo A. R. Silva
Quoted 39 lines · Gustavo A. R. Silva

The current codebase makes use of the zero-length array language extension to the C90 standard, but the preferred mechanism to declare variable-length types such as these ones is a flexible array member[1][2], introduced in C99:

struct foo {
         int stuff;
         struct boo array[];
};

By making use of the mechanism above, we will get a compiler warning in case the flexible array does not occur last in the structure, which will help us prevent some kind of undefined behavior bugs from being inadvertently introduced[3] to the codebase from now on.

Also, notice that, dynamic memory allocations won't be affected by this change:

"Flexible array members have incomplete type, and so the sizeof operator may not be applied. As a quirk of the original implementation of zero-length arrays, sizeof evaluates to zero."[1]

This issue was found with the help of Coccinelle.

[1] https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
[2] https://github.com/KSPP/linux/issues/21
[3] commit 76497732932f ("cxgb3/l2t: Fix undefined behaviour")

---
  drivers/scsi/advansys.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/scsi/advansys.c +0 -0
index a242a62caaa1..c2c7850ff7b4 100644

drivers/scsi/advansys.c typedef struct asc_sg_head { · line 322

Quoted 8 lines
drivers/scsi/advansys.c +1 -1
@@ -316,7 +316,7 @@ typedef struct asc_sg_head {
  	ushort queue_cnt;
  	ushort entry_to_copy;
  	ushort res;
-	ASC_SG_LIST sg_list[0];
+	ASC_SG_LIST sg_list[];
  } ASC_SG_HEAD;
 
  typedef struct asc_scsi_q {

Cheers,

Hannes

Signature · 4 lines
Dr. Hannes Reinecke            Teamlead Storage & Networking
[email protected]                               +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), Geschäftsführer: Felix Imendörffer
#4 lore raw
In reply to Gustavo A. R. Silva

Gustavo,

Quoted 4 lines

The current codebase makes use of the zero-length array language extension to the C90 standard, but the preferred mechanism to declare variable-length types such as these ones is a flexible array member[1][2], introduced in C99:

Applied to 5.7/scsi-queue, thanks!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering