Skip to contentSkip to conversation

platform/surface: aggregator: Annotate struct ssam_event with __counted_by

PATCH In review Kees Cook 4 participants 4 messages Sep 22, 2023 – Sep 26, 2023

Subsystems (2)
lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 platform/surface: aggregator: Annotate struct ssam_event with __counted_by

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct ssam_event.

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

---
 include/linux/surface_aggregator/controller.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/surface_aggregator/controller.h +1 -1
index cb7980805920..5b67f0f47d80 100644
@@ -44,7 +44,7 @@ struct ssam_event {
 	u8 command_id;
 	u8 instance_id;
 	u16 length;
-	u8 data[];
+	u8 data[] __counted_by(length);
 };
 
 /**
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Kees Cook

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

Quoted 7 lines

As found with Coccinelle[1], add __counted_by for struct ssam_event.

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

Thanks
--
Gustavo

Quoted 21 lines
---
 include/linux/surface_aggregator/controller.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/surface_aggregator/controller.h +1 -1
index cb7980805920..5b67f0f47d80 100644
@@ -44,7 +44,7 @@ struct ssam_event {
 	u8 command_id;
 	u8 instance_id;
 	u16 length;
-	u8 data[];
+	u8 data[] __counted_by(length);
 };
 
 /**
Signature · 1 line
2.34.1
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Kees Cook
Quoted 22 lines · Kees Cook

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct ssam_event.

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

---
  include/linux/surface_aggregator/controller.h | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/surface_aggregator/controller.h +0 -0
index cb7980805920..5b67f0f47d80 100644

include/linux/surface_aggregator/controller.h struct ssam_event { · line 50

Quoted 8 lines
include/linux/surface_aggregator/controller.h +1 -1
@@ -44,7 +44,7 @@ struct ssam_event {
  	u8 command_id;
  	u8 instance_id;
  	u16 length;
-	u8 data[];
+	u8 data[] __counted_by(length);
  };
 
  /**

Thanks!

maintainer
#3 lore raw
In reply to Kees Cook
Quoted 9 lines · Kees Cook

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct ssam_event.

[...]

Thank you for your contribution, it has been applied to my local review-ilpo branch. Note it will show up in the public platform-drivers-x86/review-ilpo branch only once I've pushed my local branch there, which might take a while.

Once I've run some tests on the review-ilpo branch the patches there will be added to the platform-drivers-x86/for-next branch and eventually will be included in the pdx86 pull-request to Linus for the next merge-window.

The list of commits applied:
[1/1] platform/surface: aggregator: Annotate struct ssam_event with __counted_by

      commit: 9cf63f3a33e929f7eca36409914b8c12102b9984

--
i.