Skip to contentSkip to conversation

dmaengine: qcom: bam_dma: Replace zero-length array with flexible-array

PATCH In review Gustavo A. R. Silva 2 participants 5 messages May 7, 2020 – May 8, 2020

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

PATCH 1/1 dmaengine: qcom: bam_dma: Replace zero-length array with flexible-array

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]

sizeof(flexible-array-member) triggers a warning because flexible array members have incomplete type[1]. There are some instances of code in which the sizeof operator is being incorrectly/erroneously applied to zero-length arrays and the result is zero. Such instances may be hiding some bugs. So, this work (flexible-array member conversions) will also help to get completely rid of those sorts of issues.

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/dma/qcom/bam_dma.c         |    2 +-
 drivers/firmware/qcom_scm-legacy.c |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
drivers/dma/qcom/bam_dma.c +1 -1
index ef73f65224b1..5a08dd0d3388 100644
@@ -74,7 +74,7 @@ struct bam_async_desc {
 	struct list_head desc_node;
 	enum dma_transfer_direction dir;
 	size_t length;
-	struct bam_desc_hw desc[0];
+	struct bam_desc_hw desc[];
 };
 
 enum bam_reg {
drivers/firmware/qcom_scm-legacy.c +1 -1
index 8532e7c78ef7..eba6b60bfb61 100644
@@ -56,7 +56,7 @@ struct scm_legacy_command {
 	__le32 buf_offset;
 	__le32 resp_hdr_offset;
 	__le32 id;
-	__le32 buf[0];
+	__le32 buf[];
 };
 
 /**
#1 lore raw
Quoted 35 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]

sizeof(flexible-array-member) triggers a warning because flexible array members have incomplete type[1]. There are some instances of code in which the sizeof operator is being incorrectly/erroneously applied to zero-length arrays and the result is zero. Such instances may be hiding some bugs. So, this work (flexible-array member conversions) will also help to get completely rid of those sorts of issues.

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")

Quoted 6 lines
---
  drivers/dma/qcom/bam_dma.c         |    2 +-
  drivers/firmware/qcom_scm-legacy.c |    2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)

Shouldn't these two files be two different patches?

Signature · 3 lines
Jeffrey Hugo
Qualcomm Technologies, Inc. is a member of the
Code Aurora Forum, a Linux Foundation Collaborative Project.
#2 lore raw
Quoted 7 lines · Jeffrey Hugo
Quoted 4 lines
  drivers/dma/qcom/bam_dma.c         |    2 +-
  drivers/firmware/qcom_scm-legacy.c |    2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)

Shouldn't these two files be two different patches?

I believe so... I'll split this patch up into two patches.

Thanks
--
Gustavo

Reviewed-by
#3 lore raw
Quoted 6 lines · Gustavo A. R. Silva
Quoted 5 lines · Jeffrey Hugo
Quoted 4 lines
   drivers/dma/qcom/bam_dma.c         |    2 +-
   drivers/firmware/qcom_scm-legacy.c |    2 +-
   2 files changed, 2 insertions(+), 2 deletions(-)
Quoted 9 lines
Quoted 2 lines

Shouldn't these two files be two different patches?

I believe so... I'll split this patch up into two patches.

Thanks
--
Gustavo

Sounds good to me. When you do, you can add the following if you like

Signature · 3 lines
Jeffrey Hugo
Qualcomm Technologies, Inc. is a member of the
Code Aurora Forum, a Linux Foundation Collaborative Project.
#4 lore raw
Quoted 12 lines · Jeffrey Hugo
Quoted 11 lines · Gustavo A. R. Silva
Quoted 7 lines · Jeffrey Hugo
Quoted 4 lines
   drivers/dma/qcom/bam_dma.c         |    2 +-
   drivers/firmware/qcom_scm-legacy.c |    2 +-
   2 files changed, 2 insertions(+), 2 deletions(-)

Shouldn't these two files be two different patches?

I believe so... I'll split this patch up into two patches.

Quoted 9 lines
Quoted 4 lines

Thanks
--
Gustavo

Sounds good to me. When you do, you can add the following if you like

Awesome. :)

Thanks
--
Gustavo