Skip to contentSkip to conversation

ACPICA: Replace one-element array and use struct_size() helper

PATCH In review Gustavo A. R. Silva 4 participants 6 messages May 18, 2020 – May 21, 2020

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

PATCH 1/1 ACPICA: Replace one-element array and use struct_size() helper

The current codebase makes use of one-element arrays in the following form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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, make use of the new struct_size() helper to properly calculate the size of struct acpi_pnp_device_id_list.

This issue was found with the help of Coccinellea and, audited and fixed _manually_.

[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/acpi/acpica/utids.c | 4 +---
 include/acpi/actypes.h      | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
drivers/acpi/acpica/utids.c +1 -3
index 3bb06935a2ad3..c2f819a39424a 100644
@@ -262,9 +262,7 @@ acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
 	 * 2) Size of the CID PNP_DEVICE_ID array +
 	 * 3) Size of the actual CID strings
 	 */
-	cid_list_size = sizeof(struct acpi_pnp_device_id_list) +
-	    ((count - 1) * sizeof(struct acpi_pnp_device_id)) +
-	    string_area_size;
+	cid_list_size = struct_size(cid_list, ids, count) + string_area_size;
 
 	cid_list = ACPI_ALLOCATE_ZEROED(cid_list_size);
 	if (!cid_list) {
include/acpi/actypes.h +1 -1
index 4defed58ea338..c7bcda0ad366a 100644
@@ -1145,7 +1145,7 @@ struct acpi_pnp_device_id {
 struct acpi_pnp_device_id_list {
 	u32 count;		/* Number of IDs in Ids array */
 	u32 list_size;		/* Size of list, including ID strings */
-	struct acpi_pnp_device_id ids[1];	/* ID array */
+	struct acpi_pnp_device_id ids[];	/* ID array */
 };
 
 /*
Signature · 1 line
2.26.2
#1 lore raw
Quoted 23 lines · Gustavo A. R. Silva

The current codebase makes use of one-element arrays in the following form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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[];
};
Quoted 4 lines

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.

However, the ACPICA code in the kernel comes from an external project and changes of this type are generally not applicable to it unless accepted upstream.

I'll let Erik and Bob take over.

Quoted 47 lines

Also, make use of the new struct_size() helper to properly calculate the size of struct acpi_pnp_device_id_list.

This issue was found with the help of Coccinellea and, audited and fixed _manually_.

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

Signed-off-by Gustavo A. R. Silva <gustavoars(a)kernel.org>
---
 drivers/acpi/acpica/utids.c | 4 +---
 include/acpi/actypes.h      | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
drivers/acpi/acpica/utids.c +1 -3
index 3bb06935a2ad3..c2f819a39424a 100644
@@ -262,9 +262,7 @@ acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
         * 2) Size of the CID PNP_DEVICE_ID array +
         * 3) Size of the actual CID strings
         */
-       cid_list_size = sizeof(struct acpi_pnp_device_id_list) +
-           ((count - 1) * sizeof(struct acpi_pnp_device_id)) +
-           string_area_size;
+       cid_list_size = struct_size(cid_list, ids, count) + string_area_size;
 
        cid_list = ACPI_ALLOCATE_ZEROED(cid_list_size);
        if (!cid_list) {
include/acpi/actypes.h +1 -2
index 4defed58ea338..c7bcda0ad366a 100644
@@ -1145,7 +1145,7 @@ struct acpi_pnp_device_id {
 struct acpi_pnp_device_id_list {
        u32 count;              /* Number of IDs in Ids array */
        u32 list_size;          /* Size of list, including ID strings */
-       struct acpi_pnp_device_id ids[1];       /* ID array */
+       struct acpi_pnp_device_id ids[];        /* ID array */
 };
 
 /*
--

2.26.2

#2 lore raw
Quoted 25 lines · Rafael J. Wysocki
Quoted 23 lines · Gustavo A. R. Silva

The current codebase makes use of one-element arrays in the following form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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[];
};
Quoted 8 lines
Quoted 4 lines

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.

However, the ACPICA code in the kernel comes from an external project and changes of this type are generally not applicable to it unless accepted upstream.

Hi Rafael,

By _accepted upstream_, in this case, you mean the adoption of the flexible-arrays in the whole codebase, first? If this is the case notice that there are hundreds of these flexible-array conversions in mainline, already:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/log/?qt=grep&q=flexible-array

Is this what you mean?

Thanks
--
Gustavo

Quoted 50 lines

I'll let Erik and Bob take over.

Quoted 47 lines

Also, make use of the new struct_size() helper to properly calculate the size of struct acpi_pnp_device_id_list.

This issue was found with the help of Coccinellea and, audited and fixed _manually_.

[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/acpi/acpica/utids.c | 4 +---
 include/acpi/actypes.h      | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
drivers/acpi/acpica/utids.c +1 -3
index 3bb06935a2ad3..c2f819a39424a 100644
@@ -262,9 +262,7 @@ acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
         * 2) Size of the CID PNP_DEVICE_ID array +
         * 3) Size of the actual CID strings
         */
-       cid_list_size = sizeof(struct acpi_pnp_device_id_list) +
-           ((count - 1) * sizeof(struct acpi_pnp_device_id)) +
-           string_area_size;
+       cid_list_size = struct_size(cid_list, ids, count) + string_area_size;
 
        cid_list = ACPI_ALLOCATE_ZEROED(cid_list_size);
        if (!cid_list) {
include/acpi/actypes.h +1 -2
index 4defed58ea338..c7bcda0ad366a 100644
@@ -1145,7 +1145,7 @@ struct acpi_pnp_device_id {
 struct acpi_pnp_device_id_list {
        u32 count;              /* Number of IDs in Ids array */
        u32 list_size;          /* Size of list, including ID strings */
-       struct acpi_pnp_device_id ids[1];       /* ID array */
+       struct acpi_pnp_device_id ids[];        /* ID array */
 };
 
 /*
--

2.26.2

#3 lore raw
Quoted 32 lines · Gustavo A. R. Silva
Quoted 30 lines · Rafael J. Wysocki
Quoted 27 lines · Gustavo A. R. Silva

The current codebase makes use of one-element arrays in the following form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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.

Quoted 8 lines
Quoted 3 lines

However, the ACPICA code in the kernel comes from an external project and changes of this type are generally not applicable to it unless accepted upstream.

Hi Rafael,

By _accepted upstream_, in this case, you mean the adoption of the flexible-arrays in the whole codebase, first?

I meant whether or not the patch is accepted by the ACPICA upstream.

Quoted 7 lines

If this is the case
notice that there are hundreds of these flexible-array conversions in mainline, already:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/log/?qt=grep&q=flexible-array

Is this what you mean?

I'm not actually sure what you mean here.

#4 lore raw
Quoted 38 lines · Rafael J. Wysocki
Quoted 36 lines · Gustavo A. R. Silva
Quoted 33 lines · Rafael J. Wysocki
Quoted 23 lines · Gustavo A. R. Silva

The current codebase makes use of one-element arrays in the following form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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[];
};
Quoted 4 lines

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.

However, the ACPICA code in the kernel comes from an external project and changes of this type are generally not applicable to it unless accepted upstream.

Quoted 6 lines
Quoted 4 lines

Hi Rafael,

By _accepted upstream_, in this case, you mean the adoption of the flexible-arrays in the whole codebase, first?

I meant whether or not the patch is accepted by the ACPICA upstream.

Is that here? https://github.com/acpica/acpica/commits/master

Quoted 10 lines
Quoted 8 lines

If this is the case
notice that there are hundreds of these flexible-array conversions in mainline, already:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/log/?qt=grep&q=flexible-array

Is this what you mean?

I'm not actually sure what you mean here.

I think this was just a misunderstanding about what "upstream" meant. :)

I hope ACPICA will take these changes -- it seems like we keep running into these issues with the kernel's language feature clean-ups and ACPICA upstream, though each have been resolved so far! :) Flexible array members are a C99 feature, so it's hardly a new way to express things. In fact, it looks like ACPICA already builds with -c99 by default:
https://github.com/acpica/acpica/blob/master/generate/unix/Makefile.config#L202
https://github.com/acpica/acpica/blob/master/generate/efi/Makefile.config#L93

MSVC has supported them (called "unsized arrays") since 7.1 in 2003.

Gustavo, can you build a merge request for the ACPICA project directly?

Signature · 1 line
Kees Cook
#5 lore raw
Quoted 91 lines

-----Original Message-----
From: [email protected] <linux-acpi- [email protected]> On Behalf Of Kees Cook
Sent: Wednesday, May 20, 2020 8:41 AM
To: Rafael J. Wysocki <[email protected]>
Cc: Gustavo A. R. Silva <[email protected]>; Moore, Robert <[email protected]>; Kaneda, Erik <[email protected]>; Wysocki, Rafael J <[email protected]>; Len Brown <[email protected]>; ACPI Devel Maling List <[email protected]>; open list:ACPI COMPONENT ARCHITECTURE (ACPICA) <[email protected]>; Linux Kernel Mailing List <[email protected]>; Gustavo A. R. Silva <[email protected]>
Subject: Re: [PATCH] ACPICA: Replace one-element array and use struct_size() helper

Quoted 30 lines · Rafael J. Wysocki
Quoted 28 lines · Gustavo A. R. Silva
Quoted 26 lines · Rafael J. Wysocki
Quoted 24 lines · Gustavo A. R. Silva

The current codebase makes use of one-element arrays in the following
form:

struct something {
    int length;
    u8 data[1];
};

struct something *instance;

instance = kmalloc(sizeof(*instance) + size, GFP_KERNEL); instance->length = size;
memcpy(instance->data, source, size);

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[];
};
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

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.

Quoted 11 lines
Quoted 9 lines
Quoted 4 lines

However, the ACPICA code in the kernel comes from an external project and changes of this type are generally not applicable to it unless accepted upstream.

Hi Rafael,

By _accepted upstream_, in this case, you mean the adoption of the flexible-arrays in the whole codebase, first?

I meant whether or not the patch is accepted by the ACPICA upstream.

Is that here? https://github.com/acpica/acpica/commits/master

Quoted 11 lines
Quoted 9 lines

If this is the case
notice that there are hundreds of these flexible-array conversions in mainline, already:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/l
og/?qt=grep&q=flexible-array

Is this what you mean?

I'm not actually sure what you mean here.

I think this was just a misunderstanding about what "upstream" meant. :)

I hope ACPICA will take these changes -- it seems like we keep running into these issues with the kernel's language feature clean-ups and ACPICA upstream, though each have been resolved so far! :) Flexible array members are a C99 feature, so it's hardly a new way to express things. In fact, it looks like ACPICA already builds with -c99 by default:
https://github.com/acpica/acpica/blob/master/generate/unix/Makefile.conf
ig#L202
https://github.com/acpica/acpica/blob/master/generate/efi/Makefile.config
#L93

Quoted 3 lines

MSVC has supported them (called "unsized arrays") since 7.1 in 2003.

Gustavo, can you build a merge request for the ACPICA project directly?

The flexible array members will be fine.

The struct_size helper uses the typeof operator which is a GCC extension.

ACPICA codebase is intended to be compiled by many different compilers (not just GCC and MSVC) so we cannot support struct_size.

Erik

Quoted 3 lines

--
Kees Cook