Skip to contentSkip to conversation

ALSA: usx2y: Annotate struct snd_usx2y_urb_seq with __counted_by

PATCH In review Kees Cook 3 participants 3 messages Sep 22, 2023 – Sep 23, 2023 Sound

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 ALSA: usx2y: Annotate struct snd_usx2y_urb_seq 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 snd_usx2y_urb_seq. 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 Jaroslav Kysela <[email protected]>
Cc Takashi Iwai <[email protected]>
---
 sound/usb/usx2y/usbusx2y.h      | 2 +-
 sound/usb/usx2y/usbusx2yaudio.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
sound/usb/usx2y/usbusx2y.h +1 -1
index 8d82f5cc2fe1..391fd7b4ed5e 100644
@@ -18,7 +18,7 @@ struct snd_usx2y_async_seq {
 struct snd_usx2y_urb_seq {
 	int	submitted;
 	int	len;
-	struct urb	*urb[];
+	struct urb	*urb[] __counted_by(len);
 };
 
 #include "usx2yhwdeppcm.h"
sound/usb/usx2y/usbusx2yaudio.c +1 -1
index 5197599e7aa6..ca7888495a9f 100644
@@ -681,6 +681,7 @@ static int usx2y_rate_set(struct usx2ydev *usx2y, int rate)
 			err = -ENOMEM;
 			goto cleanup;
 		}
+		us->len = NOOF_SETRATE_URBS;
 		usbdata = kmalloc_array(NOOF_SETRATE_URBS, sizeof(int),
 					GFP_KERNEL);
 		if (!usbdata) {
@@ -702,7 +703,6 @@ static int usx2y_rate_set(struct usx2ydev *usx2y, int rate)
 		if (err < 0)
 			goto cleanup;
 		us->submitted =	0;
-		us->len =	NOOF_SETRATE_URBS;
 		usx2y->us04 =	us;
 		wait_event_timeout(usx2y->in04_wait_queue, !us->len, HZ);
 		usx2y->us04 =	NULL;
Signature · 1 line
2.34.1
#1 lore raw
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 snd_usx2y_urb_seq. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

Quoted 6 lines

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

Cc Jaroslav Kysela <[email protected]>
Cc Takashi Iwai <[email protected]>

Applied now. Thanks.

Takashi

Reviewed-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 snd_usx2y_urb_seq. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

Quoted 6 lines

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

Cc Jaroslav Kysela <[email protected]>
Cc Takashi Iwai <[email protected]>

Thanks

Signature · 1 line
Gustavo
Quoted 38 lines
---
  sound/usb/usx2y/usbusx2y.h      | 2 +-
  sound/usb/usx2y/usbusx2yaudio.c | 2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)
sound/usb/usx2y/usbusx2y.h +1 -1
index 8d82f5cc2fe1..391fd7b4ed5e 100644
@@ -18,7 +18,7 @@ struct snd_usx2y_async_seq {
  struct snd_usx2y_urb_seq {
  	int	submitted;
  	int	len;
-	struct urb	*urb[];
+	struct urb	*urb[] __counted_by(len);
  };
 
  #include "usx2yhwdeppcm.h"
sound/usb/usx2y/usbusx2yaudio.c +1 -1
index 5197599e7aa6..ca7888495a9f 100644
@@ -681,6 +681,7 @@ static int usx2y_rate_set(struct usx2ydev *usx2y, int rate)
  			err = -ENOMEM;
  			goto cleanup;
  		}
+		us->len = NOOF_SETRATE_URBS;
  		usbdata = kmalloc_array(NOOF_SETRATE_URBS, sizeof(int),
  					GFP_KERNEL);
  		if (!usbdata) {
@@ -702,7 +703,6 @@ static int usx2y_rate_set(struct usx2ydev *usx2y, int rate)
  		if (err < 0)
  			goto cleanup;
  		us->submitted =	0;
-		us->len =	NOOF_SETRATE_URBS;
  		usx2y->us04 =	us;
  		wait_event_timeout(usx2y->in04_wait_queue, !us->len, HZ);
  		usx2y->us04 =	NULL;