Add STACK_FLEX_ARRAY_SIZE() helper
Gustavo A. R. Silva
reviewerv2 cover Add STACK_FLEX_ARRAY_SIZE() helper
Add new STACK_FLEX_ARRAY_SIZE() helper to get the size of a flexible-array member defined using DEFINE_FLEX()/DEFINE_RAW_FLEX() at compile time.
This is essentially the same as ARRAY_SIZE() but for on-stack flexible-array members.
Gustavo A. R. Silva (2):
overflow: Add STACK_FLEX_ARRAY_SIZE() helper kunit/overflow: Add tests for STACK_FLEX_ARRAY_SIZE() helper
include/linux/overflow.h | 15 +++++++++++++++ lib/tests/overflow_kunit.c | 4 ++++ 2 files changed, 19 insertions(+)
Signature · 1 line
2.43.0
Gustavo A. R. Silva
reviewerPATCH v2 1/2 overflow: Add STACK_FLEX_ARRAY_SIZE() helper
Add new STACK_FLEX_ARRAY_SIZE() helper to get the size of a flexible-array member defined using DEFINE_FLEX()/DEFINE_RAW_FLEX() at compile time.
This is essentially the same as ARRAY_SIZE() but for on-stack flexible-array members.
---
Changes in v2:
- Use "number of elements" instead of "size of" in kernel-doc blocks.
include/linux/overflow.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
include/linux/overflow.h +15 -0
@@ -420,6 +420,8 @@ static inline size_t __must_check size_sub(size_t minuend, size_t subtrahend)* flexible array member. * Use __struct_size(@name) to get compile-time size of it afterwards. * Use __member_size(@name->member) to get compile-time size of @name members. +* Use STACK_FLEX_ARRAY_SIZE(@name, @member) to get compile-time number of +* elements in array @member. */ #define DEFINE_RAW_FLEX (type, name, member, count) \ _DEFINE_FLEX(type, name, member, count, = {})
@@ -438,8 +440,21 @@ static inline size_t __must_check size_sub(size_t minuend, size_t subtrahend)* flexible array member. * Use __struct_size(@NAME) to get compile-time size of it afterwards. * Use __member_size(@NAME->member) to get compile-time size of @NAME members. +* Use STACK_FLEX_ARRAY_SIZE(@name, @member) to get compile-time number of +* elements in array @member. */ #define DEFINE_FLEX (TYPE ,NAME ,MEMBER ,COUNTER ,COUNT ) \ _DEFINE_FLEX(TYPE, NAME, MEMBER, COUNT, = { .obj.COUNTER = COUNT, }) +/** +* STACK_FLEX_ARRAY_SIZE() - helper macro for DEFINE_FLEX() family. +* Returns the number of elements in @array. +* +* @name: Name for a variable defined in DEFINE_RAW_FLEX()/DEFINE_FLEX(). +* @array: Name of the array member. +*/ +#define STACK_FLEX_ARRAY_SIZE (name, array) \ + (__member_size((name)->array) / sizeof(*(name)->array) + \ + __must_be_array((name)->array)) +#endif /* __LINUX_OVERFLOW_H */
Signature · 1 line
2.43.0
Gustavo A. R. Silva
reviewerPATCH v2 2/2 kunit/overflow: Add tests for STACK_FLEX_ARRAY_SIZE() helper
In reply to Gustavo A. R. SilvaAdd a couple of tests for new STACK_FLEX_ARRAY_SIZE() helper.
---
Changes v2:
- Add 0 test for empty instance.
lib/tests/overflow_kunit.c | 4 ++++ 1 file changed, 4 insertions(+)
lib/tests/overflow_kunit.c +4 -0
@@ -1210,6 +1210,10 @@ static void DEFINE_FLEX_test(struct kunit *test)KUNIT_EXPECT_EQ (test,__struct_size (empty->array),0 );KUNIT_EXPECT_EQ (test,__member_size (empty->array),0 ); +KUNIT_EXPECT_EQ (test,STACK_FLEX_ARRAY_SIZE (two, array),2 ); +KUNIT_EXPECT_EQ (test,STACK_FLEX_ARRAY_SIZE (eight, array),8 ); +KUNIT_EXPECT_EQ (test,STACK_FLEX_ARRAY_SIZE (empty, array),0 ); +/* If __counted_by is not being used, array size will have the on-stack size. */ if (!IS_ENABLED (CONFIG_CC_HAS_COUNTED_BY )) array_size_override =2 *sizeof (s16);
Signature · 1 line
2.43.0
Quoted 8 lines · Gustavo A. R. Silva
Add new
STACK_FLEX_ARRAY_SIZE()helper to get the size of a flexible-array member defined using DEFINE_FLEX()/DEFINE_RAW_FLEX() at compile time.This is essentially the same as
ARRAY_SIZE()but for on-stack flexible-array members.[...]
Applied to for-next/hardening, thanks!
[1/2] overflow: Add STACK_FLEX_ARRAY_SIZE() helper
https://git.kernel.org/kees/c/9cc4498acf3e [2/2] kunit/overflow: Add tests for STACK_FLEX_ARRAY_SIZE() helper https://git.kernel.org/kees/c/90961958f48f
Take care,
Signature · 1 line
Kees Cook