Skip to content

Commit 230f6fa

Browse files
committed
overflow: Provide constant expression struct_size
There have been cases where struct_size() (or flex_array_size()) needs to be calculated for an initializer, which requires it be a constant expression. This is possible when the "count" argument is a constant expression, so provide this ability for the helpers. Cc: Gustavo A. R. Silva <gustavoars@kernel.org> Cc: Nathan Chancellor <nathan@kernel.org> Cc: Nick Desaulniers <ndesaulniers@google.com> Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk> Signed-off-by: Kees Cook <keescook@chromium.org> Reviewed-by: Gustavo A. R. Silva <gustavoars@kernel.org> Tested-by: Gustavo A. R. Silva <gustavoars@kernel.org> Link: https://lore.kernel.org/lkml/20220210010407.GA701603@embeddedor
1 parent e1be43d commit 230f6fa

2 files changed

Lines changed: 24 additions & 12 deletions

File tree

include/linux/overflow.h

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
#include <linux/compiler.h>
66
#include <linux/limits.h>
7+
#include <linux/const.h>
78

89
/*
910
* We need to compute the minimum and maximum values representable in a given
@@ -221,8 +222,9 @@ static inline size_t __must_check size_sub(size_t minuend, size_t subtrahend)
221222
* Return: number of bytes needed or SIZE_MAX on overflow.
222223
*/
223224
#define flex_array_size(p, member, count) \
224-
size_mul(count, \
225-
sizeof(*(p)->member) + __must_be_array((p)->member))
225+
__builtin_choose_expr(__is_constexpr(count), \
226+
(count) * sizeof(*(p)->member) + __must_be_array((p)->member), \
227+
size_mul(count, sizeof(*(p)->member) + __must_be_array((p)->member)))
226228

227229
/**
228230
* struct_size() - Calculate size of structure with trailing flexible array.
@@ -237,6 +239,8 @@ static inline size_t __must_check size_sub(size_t minuend, size_t subtrahend)
237239
* Return: number of bytes needed or SIZE_MAX on overflow.
238240
*/
239241
#define struct_size(p, member, count) \
240-
size_add(sizeof(*(p)), flex_array_size(p, member, count))
242+
__builtin_choose_expr(__is_constexpr(count), \
243+
sizeof(*(p)) + flex_array_size(p, member, count), \
244+
size_add(sizeof(*(p)), flex_array_size(p, member, count)))
241245

242246
#endif /* __LINUX_OVERFLOW_H */

lib/test_overflow.c

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -602,10 +602,18 @@ struct __test_flex_array {
602602

603603
static int __init test_overflow_size_helpers(void)
604604
{
605+
/* Make sure struct_size() can be used in a constant expression. */
606+
u8 ce_array[struct_size((struct __test_flex_array *)0, data, 55)];
605607
struct __test_flex_array *obj;
606608
int count = 0;
607609
int err = 0;
608610
int var;
611+
volatile int unconst = 0;
612+
613+
/* Verify constant expression against runtime version. */
614+
var = 55;
615+
OPTIMIZER_HIDE_VAR(var);
616+
err |= sizeof(ce_array) != struct_size(obj, data, var);
609617

610618
#define check_one_size_helper(expected, func, args...) ({ \
611619
bool __failure = false; \
@@ -663,28 +671,28 @@ static int __init test_overflow_size_helpers(void)
663671
flex_array_size, obj, data, var++);
664672
err |= check_one_size_helper(5 * sizeof(*obj->data),
665673
flex_array_size, obj, data, var++);
666-
err |= check_one_size_helper(0, flex_array_size, obj, data, 0);
674+
err |= check_one_size_helper(0, flex_array_size, obj, data, 0 + unconst);
667675
err |= check_one_size_helper(sizeof(*obj->data),
668-
flex_array_size, obj, data, 1);
676+
flex_array_size, obj, data, 1 + unconst);
669677
err |= check_one_size_helper(7 * sizeof(*obj->data),
670-
flex_array_size, obj, data, 7);
678+
flex_array_size, obj, data, 7 + unconst);
671679
err |= check_one_size_helper(SIZE_MAX,
672-
flex_array_size, obj, data, -1);
680+
flex_array_size, obj, data, -1 + unconst);
673681
err |= check_one_size_helper(SIZE_MAX,
674-
flex_array_size, obj, data, SIZE_MAX - 4);
682+
flex_array_size, obj, data, SIZE_MAX - 4 + unconst);
675683

676684
var = 4;
677685
err |= check_one_size_helper(sizeof(*obj) + (4 * sizeof(*obj->data)),
678686
struct_size, obj, data, var++);
679687
err |= check_one_size_helper(sizeof(*obj) + (5 * sizeof(*obj->data)),
680688
struct_size, obj, data, var++);
681-
err |= check_one_size_helper(sizeof(*obj), struct_size, obj, data, 0);
689+
err |= check_one_size_helper(sizeof(*obj), struct_size, obj, data, 0 + unconst);
682690
err |= check_one_size_helper(sizeof(*obj) + sizeof(*obj->data),
683-
struct_size, obj, data, 1);
691+
struct_size, obj, data, 1 + unconst);
684692
err |= check_one_size_helper(SIZE_MAX,
685-
struct_size, obj, data, -3);
693+
struct_size, obj, data, -3 + unconst);
686694
err |= check_one_size_helper(SIZE_MAX,
687-
struct_size, obj, data, SIZE_MAX - 3);
695+
struct_size, obj, data, SIZE_MAX - 3 + unconst);
688696

689697
pr_info("%d overflow size helper tests finished\n", count);
690698

0 commit comments

Comments
 (0)