Skip to contentSkip to conversation

tty: Avoid the use of one-element arrays

PATCH Superseded Gustavo A. R. Silva 4 participants 6 messages Jul 16, 2020 – Jul 23, 2020 TTY layer and serial drivers

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tty: Avoid the use of one-element arrays

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

[1] https://github.com/KSPP/linux/issues/79
[2] https://github.com/KSPP/linux/issues/86

---
 drivers/tty/tty_io.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/tty/tty_io.c +4 -4
index 5a6f36b391d9..505bcba5ee02 100644
@@ -2683,7 +2683,7 @@ struct serial_struct32 {
         compat_int_t    baud_base;
         unsigned short  close_delay;
         char    io_type;
-        char    reserved_char[1];
+	char    reserved_char;
         compat_int_t    hub6;
         unsigned short  closing_wait; /* time to wait before closing */
         unsigned short  closing_wait2; /* no longer used... */
@@ -2691,7 +2691,7 @@ struct serial_struct32 {
         unsigned short  iomem_reg_shift;
         unsigned int    port_high;
      /* compat_ulong_t  iomap_base FIXME */
-        compat_int_t    reserved[1];
+	compat_int_t    reserved;
 };
 
 static int compat_tty_tiocsserial(struct tty_struct *tty,
@@ -2705,7 +2705,7 @@ static int compat_tty_tiocsserial(struct tty_struct *tty,
 	struct serial_struct v;
 	int flags;
 
-	if (copy_from_user(&v32, ss, sizeof(struct serial_struct32)))
+	if (copy_from_user(&v32, ss, sizeof(*ss)))
 		return -EFAULT;
 
 	memcpy(&v, &v32, offsetof(struct serial_struct32, iomem_base));
@@ -2743,7 +2743,7 @@ static int compat_tty_tiocgserial(struct tty_struct *tty,
 			0xfffffff : ptr_to_compat(v.iomem_base);
 		v32.iomem_reg_shift = v.iomem_reg_shift;
 		v32.port_high = v.port_high;
-		if (copy_to_user(ss, &v32, sizeof(struct serial_struct32)))
+		if (copy_to_user(ss, &v32, sizeof(v32)))
 			err = -EFAULT;
 	}
 	return err;
Signature · 1 line
2.27.0
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 14 lines · Gustavo A. R. Silva

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

Quoted 8 lines

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

May I ask you to send a follow-up patch to fix the whole structure's indentation?

Quoted 6 lines

[1] https://github.com/KSPP/linux/issues/79
[2] https://github.com/KSPP/linux/issues/86

thanks,

Signature · 2 lines
js
suse labs
#2 lore raw
Quoted 18 lines · Jiri Slaby
Quoted 17 lines · Gustavo A. R. Silva

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

Quoted 9 lines
Quoted 5 lines

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

May I ask you to send a follow-up patch to fix the whole structure's indentation?

Hi Jiri,

Sure thing. I'll fix that up and send v2, shortly.

Thanks
--
Gustavo

Quoted 11 lines
Quoted 6 lines

[1] https://github.com/KSPP/linux/issues/79
[2] https://github.com/KSPP/linux/issues/86

thanks,

maintainer
#3 lore raw
Quoted 27 lines · Gustavo A. R. Silva
Quoted 24 lines · Jiri Slaby
Quoted 22 lines · Gustavo A. R. Silva

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

Quoted 7 lines
Quoted 3 lines

May I ask you to send a follow-up patch to fix the whole structure's indentation?

Hi Jiri,

Sure thing. I'll fix that up and send v2, shortly.

Hi,

by a follow-up patch I meant a separate patch. Looking at it once again, I would do 3 patches:
1) remove [1] arrays
2) change sizeofs
3) fix white space

thanks,

Signature · 2 lines
js
suse labs
#4 lore raw
Quoted 36 lines · Jiri Slaby
Quoted 27 lines · Gustavo A. R. Silva
Quoted 24 lines · Jiri Slaby
Quoted 22 lines · Gustavo A. R. Silva

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

Quoted 7 lines
Quoted 3 lines

May I ask you to send a follow-up patch to fix the whole structure's indentation?

Hi Jiri,

Sure thing. I'll fix that up and send v2, shortly.

Quoted 7 lines

Hi,

by a follow-up patch I meant a separate patch. Looking at it once again, I would do 3 patches:
1) remove [1] arrays
2) change sizeofs
3) fix white space

I agree, that would be the ideal series.

thanks,

greg k-h

#5 lore raw
Quoted 39 lines · Greg Kroah-Hartman
Quoted 38 lines · Jiri Slaby
Quoted 27 lines · Gustavo A. R. Silva
Quoted 24 lines · Jiri Slaby
Quoted 22 lines · Gustavo A. R. Silva

One-element arrays are being deprecated[1]. Replace the one-element arrays with simple value types 'char reserved_char' and 'compat_int_t reserved'[2], once it seems these are just placeholders for alignment.

Also, while there, use the preferred form for passing a size of a struct. The alternative form where struct name is spelled out hurts readability and introduces an opportunity for a bug when the variable type is changed but the corresponding sizeof that is passed as argument is not.

Lastly, fix the checkpatch.pl warnings below:

ERROR: code indent should use tabs where possible
+ char reserved_char;$

WARNING: please, no spaces at the start of a line
+ char reserved_char;$

ERROR: code indent should use tabs where possible
+ compat_int_t reserved;$

WARNING: please, no spaces at the start of a line
+ compat_int_t reserved;$

Quoted 7 lines
Quoted 3 lines

May I ask you to send a follow-up patch to fix the whole structure's indentation?

Hi Jiri,

Sure thing. I'll fix that up and send v2, shortly.

Hi,

Quoted 8 lines
Quoted 5 lines

by a follow-up patch I meant a separate patch. Looking at it once again, I would do 3 patches:
1) remove [1] arrays
2) change sizeofs
3) fix white space

I agree, that would be the ideal series.

OK. No problem. I'll turn this into a patch series then. :)

Thanks
--
Gustavo