Skip to contentSkip to conversation

media: v4l2-event: Annotate struct v4l2_subscribed_event with __counted_by

PATCH Applied Kees Cook 3 participants 5 messages Sep 22, 2023 – Oct 8, 2023 Media (V4L/DVB)

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 media: v4l2-event: Annotate struct v4l2_subscribed_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 v4l2_subscribed_event. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

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

Cc Mauro Carvalho Chehab <[email protected]>
Cc Hans Verkuil <[email protected]>
Cc lijian <[email protected]>
---
 drivers/media/v4l2-core/v4l2-event.c | 2 +-
 include/media/v4l2-event.h           | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
drivers/media/v4l2-core/v4l2-event.c +1 -1
index c5ce9f11ad7b..3898ff7edddb 100644
@@ -238,6 +238,7 @@ int v4l2_event_subscribe(struct v4l2_fh *fh,
 	sev = kvzalloc(struct_size(sev, events, elems), GFP_KERNEL);
 	if (!sev)
 		return -ENOMEM;
+	sev->elems = elems;
 	for (i = 0; i < elems; i++)
 		sev->events[i].sev = sev;
 	sev->type = sub->type;
@@ -245,7 +246,6 @@ int v4l2_event_subscribe(struct v4l2_fh *fh,
 	sev->flags = sub->flags;
 	sev->fh = fh;
 	sev->ops = ops;
-	sev->elems = elems;
 
 	mutex_lock(&fh->subscribe_lock);
 
include/media/v4l2-event.h +1 -1
index 4ffa914ade3a..3a0e2588361c 100644
@@ -78,7 +78,7 @@ struct v4l2_subscribed_event {
 	unsigned int		elems;
 	unsigned int		first;
 	unsigned int		in_use;
-	struct v4l2_kevent	events[];
+	struct v4l2_kevent	events[] __counted_by(elems);
 };
 
 /**
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 v4l2_subscribed_event. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

Quoted 7 lines

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

Cc Mauro Carvalho Chehab <[email protected]>
Cc Hans Verkuil <[email protected]>
Cc lijian <[email protected]>

Thanks

Signature · 1 line
Gustavo
Quoted 38 lines
---
  drivers/media/v4l2-core/v4l2-event.c | 2 +-
  include/media/v4l2-event.h           | 2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)
drivers/media/v4l2-core/v4l2-event.c +1 -1
index c5ce9f11ad7b..3898ff7edddb 100644
@@ -238,6 +238,7 @@ int v4l2_event_subscribe(struct v4l2_fh *fh,
  	sev = kvzalloc(struct_size(sev, events, elems), GFP_KERNEL);
  	if (!sev)
  		return -ENOMEM;
+	sev->elems = elems;
  	for (i = 0; i < elems; i++)
  		sev->events[i].sev = sev;
  	sev->type = sub->type;
@@ -245,7 +246,6 @@ int v4l2_event_subscribe(struct v4l2_fh *fh,
  	sev->flags = sub->flags;
  	sev->fh = fh;
  	sev->ops = ops;
-	sev->elems = elems;
 
  	mutex_lock(&fh->subscribe_lock);
 
include/media/v4l2-event.h +1 -1
index 4ffa914ade3a..3a0e2588361c 100644
@@ -78,7 +78,7 @@ struct v4l2_subscribed_event {
  	unsigned int		elems;
  	unsigned int		first;
  	unsigned int		in_use;
-	struct v4l2_kevent	events[];
+	struct v4l2_kevent	events[] __counted_by(elems);
  };
 
  /**
author Applied
#2 lore raw
In reply to Kees Cook
Quoted 11 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 v4l2_subscribed_event. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

[...]

Since this is a trivial change and it's been 2 week without further discussion, I'll snag this patch.

Applied to for-next/hardening, thanks!

[1/1] media: v4l2-event: Annotate struct v4l2_subscribed_event with __counted_by

      https://git.kernel.org/kees/c/b1a20bbd4687

Take care,

Signature · 1 line
Kees Cook
#3 lore raw
Quoted 7 lines · Kees Cook
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 8 lines
Quoted 5 lines

As found with Coccinelle[1], add __counted_by for struct v4l2_subscribed_event. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

[...]

Since this is a trivial change and it's been 2 week without further discussion, I'll snag this patch.

Ah, I picked this up for media as well. Same for the other patch. You should have gotten an email from patchwork on Oct 3 that it was accepted.

I think I should be more pro-active and reply when I pick up patches from non-media developers instead of relying on patchwork. It seems that it is easy to miss emails from patchwork.

Regards,

Hans

Quoted 8 lines

Applied to for-next/hardening, thanks!

[1/1] media: v4l2-event: Annotate struct v4l2_subscribed_event with __counted_by

      https://git.kernel.org/kees/c/b1a20bbd4687

Take care,

author
#4 lore raw
Quoted 17 lines · Hans Verkuil
Quoted 7 lines · Kees Cook
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 8 lines
Quoted 5 lines

As found with Coccinelle[1], add __counted_by for struct v4l2_subscribed_event. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

[...]

Since this is a trivial change and it's been 2 week without further discussion, I'll snag this patch.

Quoted 6 lines

Ah, I picked this up for media as well. Same for the other patch. You should have gotten an email from patchwork on Oct 3 that it was accepted.

I think I should be more pro-active and reply when I pick up patches from non-media developers instead of relying on patchwork. It seems that it is easy to miss emails from patchwork.

Ah! Thanks for reminding me. I'll drop them from the hardening tree. :)

-Kees

Signature · 1 line
Kees Cook