Skip to contentSkip to conversation

staging: greybus: Replace zero-length array with flexible-array

PATCH In review Gustavo A. R. Silva 3 participants 5 messages May 7, 2020 – May 13, 2020 Greybus

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: greybus: 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/greybus/arpc.h                    |    2 -
 include/linux/greybus/greybus_protocols.h |   44 +++++++++++++++---------------
 2 files changed, 23 insertions(+), 23 deletions(-)
drivers/greybus/arpc.h +1 -1
index c8b83c5cfa79..b9ea81b55b29 100644
@@ -21,7 +21,7 @@ struct arpc_request_message {
 	__le16	id;		/* RPC unique id */
 	__le16	size;		/* Size in bytes of header + payload */
 	__u8	type;		/* RPC type */
-	__u8	data[0];	/* ARPC data */
+	__u8	data[];	/* ARPC data */
 } __packed;
 
 struct arpc_response_message {
include/linux/greybus/greybus_protocols.h +22 -22

175 lines not on this page · raw message

maintainer
#1 lore raw
Quoted 31 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.

Quoted 8 lines

[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/greybus/arpc.h                    |    2 -
 include/linux/greybus/greybus_protocols.h |   44 +++++++++++++++---------------

I noticed Greg just applied this one to his -testing branch, but do we really want this in greybus_protocols.h, which is meant to be shared with the firmware side? Perhaps not an issue, just figured I'd point this out.

Johan

#2 lore raw
Quoted 41 lines · Johan Hovold
Quoted 31 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.

Quoted 8 lines

[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/greybus/arpc.h                    |    2 -
 include/linux/greybus/greybus_protocols.h |   44 +++++++++++++++---------------
Quoted 4 lines

I noticed Greg just applied this one to his -testing branch, but do we really want this in greybus_protocols.h, which is meant to be shared with the firmware side? Perhaps not an issue, just figured I'd point this out.

Why not, it should be the same thing, right? No logic has changed that I see.

thanks,

greg k-h

maintainer
#3 lore raw
Quoted 15 lines · Greg Kroah-Hartman
Quoted 14 lines · Johan Hovold
Quoted 12 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[];
};
 drivers/greybus/arpc.h                    |    2 -
 include/linux/greybus/greybus_protocols.h |   44 +++++++++++++++---------------
Quoted 7 lines
Quoted 4 lines

I noticed Greg just applied this one to his -testing branch, but do we really want this in greybus_protocols.h, which is meant to be shared with the firmware side? Perhaps not an issue, just figured I'd point this out.

Why not, it should be the same thing, right? No logic has changed that I see.

Yes, the structure's the same, but the firmware toolchain may not expect flexible arrays. I believe we're holding back on these changes for uapi headers as well for that reason?

Again, perhaps not an issue. We can just mandate fw toolchains that support C99 if you want to use an unmodified header, I guess.

Johan

#4 lore raw
Quoted 24 lines · Johan Hovold
Quoted 15 lines · Greg Kroah-Hartman
Quoted 14 lines · Johan Hovold
Quoted 12 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[];
};
 drivers/greybus/arpc.h                    |    2 -
 include/linux/greybus/greybus_protocols.h |   44 +++++++++++++++---------------
Quoted 7 lines
Quoted 4 lines

I noticed Greg just applied this one to his -testing branch, but do we really want this in greybus_protocols.h, which is meant to be shared with the firmware side? Perhaps not an issue, just figured I'd point this out.

Why not, it should be the same thing, right? No logic has changed that I see.

Quoted 6 lines

Yes, the structure's the same, but the firmware toolchain may not expect flexible arrays. I believe we're holding back on these changes for uapi headers as well for that reason?

Again, perhaps not an issue. We can just mandate fw toolchains that support C99 if you want to use an unmodified header, I guess.

I think we can mandate that for now, let's see if anyone actually builds firmware against this header file anymore :)

greg k-h