platform/chrome: Fix -Warray-bounds warnings
Subsystems (2)
PATCH 1/1 platform/chrome: Fix -Warray-bounds warnings
GCC-13 (and Clang) does not like having a partially allocated object, since it cannot reason about it for bounds checking.
Notice that the compiler is legitimately complaining about accessing an object (params, in this case) for which not enough memory was allocated.
The object is of size 20 bytes:
struct ec_params_vbnvcontext {
uint32_t op; /* 0 4 */
uint8_t block[16]; /* 4 16 */
/* size: 20, cachelines: 1, members: 2 */
/* last cacheline: 20 bytes */
};but only 16 bytes are allocated:
sizeof(struct ec_response_vbnvcontext) == 16
In this case, as only enough space for the op field is allocated, we can use an object of type uint32_t instead of a whole struct ec_params_vbnvcontext (for which not enough memory is allocated).
Fix the following warning seen under GCC 13:drivers/platform/chrome/cros_ec_vbc.c: In function ‘vboot_context_read’:drivers/platform/chrome/cros_ec_vbc.c:36:15: warning: array subscript ‘struct ec_params_vbnvcontext[1]’ is partly outside array bounds of ‘unsigned char[36]’ [-Warray-bounds=]
36 | params->op = EC_VBNV_CONTEXT_OP_READ;
| ^~
In file included from drivers/platform/chrome/cros_ec_vbc.c:12:
In function ‘kmalloc’,
inlined from ‘vboot_context_read’ at drivers/platform/chrome/cros_ec_vbc.c:30:8:./include/linux/slab.h:580:24: note: at offset 20 into object of size 36 allocated by ‘kmalloc_trace’
580 | return kmalloc_trace(
| ^~~~~~~~~~~~~~
581 | kmalloc_caches[kmalloc_type(flags)][index],
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
582 | flags, size);
| ~~~~~~~~~~~~--- drivers/platform/chrome/cros_ec_vbc.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)
drivers/platform/chrome/cros_ec_vbc.c +8 -4
@@ -20,10 +20,14 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,struct device *dev =kobj_to_dev (kobj);struct cros_ec_dev *ec =to_cros_ec_dev (dev);struct cros_ec_device *ecdev = ec->ec_dev; -struct ec_params_vbnvcontext *params;struct cros_ec_command *msg; +/* +* This should be a pointer to the same type as op field in +* struct ec_params_vbnvcontext. +*/ +uint32_t *params_op;int err; -const size_t para_sz =sizeof (params->op); +const size_t para_sz =sizeof (*params_op);const size_t resp_sz =sizeof (struct ec_response_vbnvcontext );const size_t payload =max (para_sz, resp_sz);
@@ -32,8 +36,8 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,return -ENOMEM ;/* NB: we only kmalloc()ated enough space for the op field */ - params = (struct ec_params_vbnvcontext *)msg->data; - params->op =EC_VBNV_CONTEXT_OP_READ ; + params_op = (uint32_t *)msg->data; + *params_op =EC_VBNV_CONTEXT_OP_READ ; msg->version =EC_VER_VBNV_CONTEXT ; msg->command =EC_CMD_VBNV_CONTEXT ;
Signature · 1 line
2.34.1
Tzung-Bi Shih
maintainerQuoted 4 lines · Gustavo A. R. Silva
In this case, as only enough space for the op field is allocated, we can use an object of type
uint32_tinstead of a whole structec_params_vbnvcontext(for which not enough memory is allocated).
It doesn't make sense to me. See comments below.
Quoted 9 lines
Fix the following warning seen under GCC 13:
drivers/platform/chrome/cros_ec_vbc.c: In function ‘vboot_context_read’:drivers/platform/chrome/cros_ec_vbc.c:36:15: warning: array subscript ‘struct ec_params_vbnvcontext[1]’ is partly outside array bounds of ‘unsigned char[36]’ [-Warray-bounds=]
36 |params->op=EC_VBNV_CONTEXT_OP_READ;
| ^~
In file included fromdrivers/platform/chrome/cros_ec_vbc.c:12:
In function ‘kmalloc’,
inlined from ‘vboot_context_read’ atdrivers/platform/chrome/cros_ec_vbc.c:30:8:./include/linux/slab.h:580:24: note: at offset 20 into object of size 36 allocated by ‘kmalloc_trace’
Quoted 6 lines
580 | return kmalloc_trace(
| ^~~~~~~~~~~~~~
581 | kmalloc_caches[kmalloc_type(flags)][index],
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
582 | flags, size);
| ~~~~~~~~~~~~Please trim the commit message a bit and try to wrap at 75 columns as
[1] suggested.
[1]: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#the-canonical-patch-format
Quoted 18 lines
drivers/platform/chrome/cros_ec_vbc.c +6
-2@@ -20,10 +20,14 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,struct device *dev =kobj_to_dev (kobj);struct cros_ec_dev *ec =to_cros_ec_dev (dev);struct cros_ec_device *ecdev = ec->ec_dev; -struct ec_params_vbnvcontext *params;struct cros_ec_command *msg; +/* +* This should be a pointer to the same type as op field in +* struct ec_params_vbnvcontext. +*/ +uint32_t *params_op;int err; -const size_t para_sz =sizeof (params->op); +const size_t para_sz =sizeof (*params_op);const size_t resp_sz =sizeof (struct ec_response_vbnvcontext );const size_t payload =max (para_sz, resp_sz);
drivers/platform/chrome/cros_ec_vbc.c static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj, · line 40
Quoted 7 lines
drivers/platform/chrome/cros_ec_vbc.c +2
-2@@ -32,8 +36,8 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,return -ENOMEM ;/* NB: we only kmalloc()ated enough space for the op field */ - params = (struct ec_params_vbnvcontext *)msg->data; - params->op =EC_VBNV_CONTEXT_OP_READ ; + params_op = (uint32_t *)msg->data; + *params_op =EC_VBNV_CONTEXT_OP_READ ;
I don't see a good reason to partially allocate memory here. Perhaps, just let para_sz = sizeof(struct ec_params_vbnvcontext)? If it also makes sense to you, please remove the comment "NB: we only..." as well.
Quoted 24 lines · Tzung-Bi Shih
Quoted 4 lines · Gustavo A. R. Silva
In this case, as only enough space for the op field is allocated, we can use an object of type
uint32_tinstead of a whole structec_params_vbnvcontext(for which not enough memory is allocated).It doesn't make sense to me. See comments below.
Quoted 9 lines
Fix the following warning seen under GCC 13:
drivers/platform/chrome/cros_ec_vbc.c: In function ‘vboot_context_read’:drivers/platform/chrome/cros_ec_vbc.c:36:15: warning: array subscript ‘struct ec_params_vbnvcontext[1]’ is partly outside array bounds of ‘unsigned char[36]’ [-Warray-bounds=]
36 |params->op=EC_VBNV_CONTEXT_OP_READ;
| ^~
In file included fromdrivers/platform/chrome/cros_ec_vbc.c:12:
In function ‘kmalloc’,
inlined from ‘vboot_context_read’ atdrivers/platform/chrome/cros_ec_vbc.c:30:8:./include/linux/slab.h:580:24: note: at offset 20 into object of size 36 allocated by ‘kmalloc_trace’Quoted 6 lines
580 | return kmalloc_trace( | ^~~~~~~~~~~~~~ 581 | kmalloc_caches[kmalloc_type(flags)][index], | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 582 | flags, size); | ~~~~~~~~~~~~
Quoted 4 lines
Please trim the commit message a bit and try to wrap at 75 columns as
[1] suggested.[1]: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#the-canonical-patch-format
For outputs from tools like this, going over 75 columns is fine, no need to ever line-wrap stuff like this, that would just make it unreadable.
thanks,
greg k-h
Quoted 10 lines
drivers/platform/chrome/cros_ec_vbc.c static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj, · line 40
Quoted 6 lines
/* NB: we only kmalloc()ated enough space for the op field */
drivers/platform/chrome/cros_ec_vbc.c +2
-2- params = (struct ec_params_vbnvcontext *)msg->data; - params->op =EC_VBNV_CONTEXT_OP_READ ; + params_op = (uint32_t *)msg->data; + *params_op =EC_VBNV_CONTEXT_OP_READ ;I don't see a good reason to partially allocate memory here. Perhaps, just let
para_sz = sizeof(struct ec_params_vbnvcontext)? If it also makes sense to you, please remove the comment "NB: we only..." as well.
It looks funny to me, too. However, I think that's material for a different patch.
What I want to get fixed here is the -Warray-bounds warning, while not messing too much with the original implementation. :)
Thanks
--
Gustavo
Quoted 42 lines · Gustavo A. R. Silva
GCC-13 (and Clang) does not like having a partially allocated object, since it cannot reason about it for bounds checking.
Notice that the compiler is legitimately complaining about accessing an object (params, in this case) for which not enough memory was allocated.
The object is of size 20 bytes:
struct ec_params_vbnvcontext { uint32_t op; /* 0 4 */ uint8_t block[16]; /* 4 16 */ /* size: 20, cachelines: 1, members: 2 */ /* last cacheline: 20 bytes */ };but only 16 bytes are allocated:
sizeof(struct ec_response_vbnvcontext)== 16In this case, as only enough space for the op field is allocated, we can use an object of type
uint32_tinstead of a whole structec_params_vbnvcontext(for which not enough memory is allocated).Fix the following warning seen under GCC 13:
drivers/platform/chrome/cros_ec_vbc.c: In function ‘vboot_context_read’:drivers/platform/chrome/cros_ec_vbc.c:36:15: warning: array subscript ‘struct ec_params_vbnvcontext[1]’ is partly outside array bounds of ‘unsigned char[36]’ [-Warray-bounds=]
36 |params->op=EC_VBNV_CONTEXT_OP_READ;
| ^~
In file included fromdrivers/platform/chrome/cros_ec_vbc.c:12:
In function ‘kmalloc’,
inlined from ‘vboot_context_read’ atdrivers/platform/chrome/cros_ec_vbc.c:30:8:./include/linux/slab.h:580:24: note: at offset 20 into object of size 36 allocated by ‘kmalloc_trace’580 | return kmalloc_trace( | ^~~~~~~~~~~~~~ 581 | kmalloc_caches[kmalloc_type(flags)][index], | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 582 | flags, size); | ~~~~~~~~~~~~
Quoted 2 lines
This patch seems to have gotten lost? Looking at the conversation, I think it should land as-is rather than changing the allocation size.
I can pick this up via my tree if that helps...
-Kees
Quoted 39 lines
--- drivers/platform/chrome/cros_ec_vbc.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)drivers/platform/chrome/cros_ec_vbc.c +8
-4@@ -20,10 +20,14 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,struct device *dev =kobj_to_dev (kobj);struct cros_ec_dev *ec =to_cros_ec_dev (dev);struct cros_ec_device *ecdev = ec->ec_dev; -struct ec_params_vbnvcontext *params;struct cros_ec_command *msg; +/* +* This should be a pointer to the same type as op field in +* struct ec_params_vbnvcontext. +*/ +uint32_t *params_op;int err; -const size_t para_sz =sizeof (params->op); +const size_t para_sz =sizeof (*params_op);const size_t resp_sz =sizeof (struct ec_response_vbnvcontext );const size_t payload =max (para_sz, resp_sz);@@ -32,8 +36,8 @@ static ssize_t vboot_context_read(struct file *filp, struct kobject *kobj,return -ENOMEM ;/* NB: we only kmalloc()ated enough space for the op field */ - params = (struct ec_params_vbnvcontext *)msg->data; - params->op =EC_VBNV_CONTEXT_OP_READ ; + params_op = (uint32_t *)msg->data; + *params_op =EC_VBNV_CONTEXT_OP_READ ; msg->version =EC_VER_VBNV_CONTEXT ; msg->command =EC_CMD_VBNV_CONTEXT ;Signature · 1 line
2.34.1
Signature · 1 line
Kees Cook
Quoted 42 lines · Gustavo A. R. Silva
GCC-13 (and Clang) does not like having a partially allocated object, since it cannot reason about it for bounds checking.
Notice that the compiler is legitimately complaining about accessing an object (params, in this case) for which not enough memory was allocated.
The object is of size 20 bytes:
struct ec_params_vbnvcontext { uint32_t op; /* 0 4 */ uint8_t block[16]; /* 4 16 */ /* size: 20, cachelines: 1, members: 2 */ /* last cacheline: 20 bytes */ };but only 16 bytes are allocated:
sizeof(struct ec_response_vbnvcontext)== 16In this case, as only enough space for the op field is allocated, we can use an object of type
uint32_tinstead of a whole structec_params_vbnvcontext(for which not enough memory is allocated).Fix the following warning seen under GCC 13:
drivers/platform/chrome/cros_ec_vbc.c: In function ‘vboot_context_read’:drivers/platform/chrome/cros_ec_vbc.c:36:15: warning: array subscript ‘struct ec_params_vbnvcontext[1]’ is partly outside array bounds of ‘unsigned char[36]’ [-Warray-bounds=]
36 |params->op=EC_VBNV_CONTEXT_OP_READ;
| ^~
In file included fromdrivers/platform/chrome/cros_ec_vbc.c:12:
In function ‘kmalloc’,
inlined from ‘vboot_context_read’ atdrivers/platform/chrome/cros_ec_vbc.c:30:8:./include/linux/slab.h:580:24: note: at offset 20 into object of size 36 allocated by ‘kmalloc_trace’580 | return kmalloc_trace( | ^~~~~~~~~~~~~~ 581 | kmalloc_caches[kmalloc_type(flags)][index], | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 582 | flags, size); | ~~~~~~~~~~~~
Quoted 2 lines
FWIW, I think this is the right change that disrupts the code the least.
-Kees
Signature · 1 line
Kees Cook
Quoted 8 lines · Gustavo A. R. Silva
GCC-13 (and Clang) does not like having a partially allocated object, since it cannot reason about it for bounds checking.
Notice that the compiler is legitimately complaining about accessing an object (params, in this case) for which not enough memory was allocated.
[...]
Applied, thanks!
[1/1] platform/chrome: Fix -Warray-bounds warnings
commit: 59a9ccf19ee03179faf047822bbec76cac7467a4