Skip to contentSkip to conversation

watch_queue: Annotate struct watch_filter with __counted_by

PATCH Applied Kees Cook 4 participants 4 messages Sep 22, 2023 – Sep 24, 2023

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 watch_queue: Annotate struct watch_filter 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 watch_filter.

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

Cc David Howells <[email protected]>
Cc Randy Dunlap <[email protected]>
Cc Al Viro <[email protected]>
Cc Christian Brauner <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Siddh Raman Pant <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc Qian Cai <[email protected]>
---
 include/linux/watch_queue.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/watch_queue.h +1 -1
index 45cd42f55d49..429c7b6afead 100644
@@ -32,7 +32,7 @@ struct watch_filter {
 		DECLARE_BITMAP(type_filter, WATCH_TYPE__NR);
 	};
 	u32			nr_filters;	/* Number of filters */
-	struct watch_type_filter filters[];
+	struct watch_type_filter filters[] __counted_by(nr_filters);
 };
 
 struct watch_queue {
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 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 watch_filter.

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

Quoted 9 lines
Cc David Howells <[email protected]>
Cc Randy Dunlap <[email protected]>
Cc Al Viro <[email protected]>
Cc Christian Brauner <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Siddh Raman Pant <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc Qian Cai <[email protected]>

Thanks

Signature · 1 line
Gustavo
Quoted 17 lines
---
  include/linux/watch_queue.h | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/watch_queue.h +1 -1
index 45cd42f55d49..429c7b6afead 100644
@@ -32,7 +32,7 @@ struct watch_filter {
  		DECLARE_BITMAP(type_filter, WATCH_TYPE__NR);
  	};
  	u32			nr_filters;	/* Number of filters */
-	struct watch_type_filter filters[];
+	struct watch_type_filter filters[] __counted_by(nr_filters);
  };
 
  struct watch_queue {
Tested-by on v1 1/1
#2 lore raw
In reply to Kees Cook
Quoted 10 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 watch_filter.

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

Quoted 9 lines
Cc David Howells <[email protected]>
Cc Randy Dunlap <[email protected]>
Cc Al Viro <[email protected]>
Cc Christian Brauner <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Siddh Raman Pant <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc Qian Cai <[email protected]>

Tested with keyutils testsuite.

Thanks,
Siddh

Quoted 19 lines
---
 include/linux/watch_queue.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/watch_queue.h +1 -1
index 45cd42f55d49..429c7b6afead 100644
@@ -32,7 +32,7 @@ struct watch_filter {
 		DECLARE_BITMAP(type_filter, WATCH_TYPE__NR);
 	};
 	u32			nr_filters;	/* Number of filters */
-	struct watch_type_filter filters[];
+	struct watch_type_filter filters[] __counted_by(nr_filters);
 };
 
 struct watch_queue {
Signature · 1 line
2.34.1
#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 watch_filter.

[...]

Applied to the vfs.misc branch of the vfs/vfs.git tree. Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] watch_queue: Annotate struct watch_filter with __counted_by

      https://git.kernel.org/vfs/vfs/c/6b601adb5e79