tty: cumulate and document tty_struct::flow* members
authorJiri Slaby <jslaby@suse.cz>
Wed, 5 May 2021 09:19:05 +0000 (11:19 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 13 May 2021 14:57:16 +0000 (16:57 +0200)
commit6e94dbc7a4e49a028b81302d755bba1a518f973b
treef96593e04f90e65cdca2110661b239cface50743
parent0f3dcf3b5d76669123bf99fec812b8b0acd60375
tty: cumulate and document tty_struct::flow* members

Group the flow flags under a single struct called flow. The new struct
contains 'stopped' and 'tco_stopped' bools which used to be bits in a
bitfield. The struct also contains the lock protecting them to
potentially share the same cache line.

Note that commit c545b66c6922b (tty: Serialize tcflow() with other tty
flow control changes) added a padding to the original bitfield. It was
for the bitfield to occupy a whole 64b word to avoid interferring stores
on Alpha (cannot we evaporate this arch with weird implications to C
code yet?). But it doesn't work as expected as the padding
(tty_struct::unused) is aligned to a 8B boundary too and occupies some
bytes from the next word.

So make it reliable by:
1) setting __aligned of the struct -- that aligns the start, and
2) making 'unsigned long unused[0]' as the last member of the struct --
   pads the end.

This is also the perfect time to start the documentation of tty_struct
where all this lives. So we start by documenting what these bools
actually serve for. And why we do all the alignment dances. Only the few
up-to-date information from the Theodore's comment made it into this new
Kerneldoc comment.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: Heiko Carstens <hca@linux.ibm.com>
Cc: Vasily Gorbik <gor@linux.ibm.com>
Cc: Christian Borntraeger <borntraeger@de.ibm.com>
Cc: Shawn Guo <shawnguo@kernel.org>
Cc: Sascha Hauer <s.hauer@pengutronix.de>
Cc: Vineet Gupta <vgupta@synopsys.com>
Cc: "Maciej W. Rozycki" <macro@orcam.me.uk>
Link: https://lore.kernel.org/r/20210505091928.22010-13-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
22 files changed:
Documentation/networking/caif/caif.rst
drivers/char/pcmcia/synclink_cs.c
drivers/mmc/core/sdio_uart.c
drivers/net/caif/caif_serial.c
drivers/s390/char/tty3270.c
drivers/staging/fwserial/fwserial.c
drivers/tty/amiserial.c
drivers/tty/moxa.c
drivers/tty/mxser.c
drivers/tty/n_tty.c
drivers/tty/pty.c
drivers/tty/serial/arc_uart.c
drivers/tty/serial/dz.c
drivers/tty/synclink_gt.c
drivers/tty/tty_io.c
drivers/tty/tty_ioctl.c
drivers/tty/tty_port.c
drivers/tty/vt/keyboard.c
drivers/tty/vt/vt.c
include/linux/serial_core.h
include/linux/tty.h
include/linux/tty_driver.h