Skip to contentSkip to conversation

overflow.h: Add flex_array_size() helper

PATCH Superseded Gustavo A. R. Silva 3 participants 4 messages Jun 8, 2020 – Jun 9, 2020 Kernel hardening (not covered by other areas)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Gustavo A. R. Silva

author reviewer
#0 lore raw

PATCH 1/1 overflow.h: Add flex_array_size() helper

Add flex_array_size() helper for the calculation of the size, in bytes, of a flexible array member contained within an enclosing structure.

Example of usage:

struct something {
	size_t count;
	struct foo items[];
};

struct something *instance;

instance = kmalloc(struct_size(instance, items, count), GFP_KERNEL); instance->count = count;

memcpy(instance->items, source, flex_array_size(instance, items, instance->count));

The helper returns SIZE_MAX on overflow instead of wrapping around.

(Additionally replace parameter n with count in struct_size() for homogeneity).

---
 include/linux/overflow.h | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)
include/linux/overflow.h +21 -4
index 659045046468f..473af79f11ccf 100644
@@ -304,16 +304,33 @@ static inline __must_check size_t __ab_c_size(size_t a, size_t b, size_t c)
  * struct_size() - Calculate size of structure with trailing array.
  * @p: Pointer to the structure.
  * @member: Name of the array member.
- * @n: Number of elements in the array.
+ * @count: Number of elements in the array.
  *
  * Calculates size of memory needed for structure @p followed by an
- * array of @n @member elements.
+ * array of @count @member elements.
  *
  * Return: number of bytes needed or SIZE_MAX on overflow.
  */
-#define struct_size(p, member, n)					\
-	__ab_c_size(n,							\
+#define struct_size(p, member, count)					\
+	__ab_c_size(count,							\
 		    sizeof(*(p)->member) + __must_be_array((p)->member),\
 		    sizeof(*(p)))
 
+/**
+ * flex_array_size() - Calculate size of a flexible array member within
+ * an enclosing structure.
+ *
+ * @p: Pointer to the structure.
+ * @member: Name of the flexible array member.
+ * @count: Number of elements in the array.
+ *
+ * Calculates size of memory needed for flexible array @member of @count
+ * elements within structure @p.
+ *
+ * Return: number of bytes needed or SIZE_MAX on overflow.
+ */
+#define flex_array_size(p, member, count)					\
+	array_size(count,							\
+		    sizeof((p)->member[0]) + __must_be_array((p)->member))
+
 #endif /* __LINUX_OVERFLOW_H */
Signature · 1 line
2.27.0
#1 lore raw
Quoted 11 lines · Gustavo A. R. Silva

Add flex_array_size() helper for the calculation of the size, in bytes, of a flexible array member contained within an enclosing structure.

Example of usage:
foo

struct something {
	size_t count;
	struct foo items[];
};

struct something *instance;

[]

include/linux/overflow.h

Quoted 1 line
include/linux/overflow.h +0 -0

[]

Quoted 3 lines

+/**
+ * flex_array_size() - Calculate size of a flexible array member within
+ * an enclosing structure.

These comment descriptions do not match

Quoted 2 lines

+ * Calculates size of memory needed for flexible array @member of @count
+ * elements within structure @p.

The first comment shows the size of an array member. The second shows the size of an array member * count

Also the struct_size and flex_array_size definitions are using two different forms:

		sizeof(*(p)->member) + __must_be_array((p)->member),\
and
		sizeof((p)->member[0]) + __must_be_array((p)->member))

Consistency would be nice.

author reviewer
#2 lore raw
Quoted 27 lines · Joe Perches
Quoted 11 lines · Gustavo A. R. Silva

Add flex_array_size() helper for the calculation of the size, in bytes, of a flexible array member contained within an enclosing structure.

Example of usage:
foo

struct something {
	size_t count;
	struct foo items[];
};

struct something *instance;

[]

include/linux/overflow.h

Quoted 1 line
include/linux/overflow.h +0 -0

[]

Quoted 3 lines

+/**
+ * flex_array_size() - Calculate size of a flexible array member within
+ * an enclosing structure.

These comment descriptions do not match

Quoted 2 lines

+ * Calculates size of memory needed for flexible array @member of @count
+ * elements within structure @p.

The first comment shows the size of an array member. The second shows the size of an array member * count

Quoted 7 lines

Also the struct_size and flex_array_size definitions are using two different forms:

		sizeof(*(p)->member) + __must_be_array((p)->member),\
and
		sizeof((p)->member[0]) + __must_be_array((p)->member))

Good catch.

Thanks
--
Gustavo

#3 lore raw
In reply to Joe Perches
Quoted 19 lines · Joe Perches
Quoted 11 lines · Gustavo A. R. Silva

Add flex_array_size() helper for the calculation of the size, in bytes, of a flexible array member contained within an enclosing structure.

Example of usage:
foo

struct something {
	size_t count;
	struct foo items[];
};

struct something *instance;

[]

include/linux/overflow.h

Quoted 1 line
include/linux/overflow.h +0 -0

[]

Quoted 3 lines

+/**
+ * flex_array_size() - Calculate size of a flexible array member within
+ * an enclosing structure.

Quoted 6 lines

These comment descriptions do not match

Quoted 2 lines

+ * Calculates size of memory needed for flexible array @member of @count
+ * elements within structure @p.

The first comment shows the size of an array member.

Ah, I see what you mean. I was parsing it as "flexible-array structure member" but it does say "a" and "array member". Perhaps:

Calculate size needed for entire flexible array contents within an enclosing structure.

?

Signature · 1 line
Kees Cook