drivers:tty:pty: Fix a race causing data loss on close
PATCH 1/1 drivers:tty:pty: Fix a race causing data loss on close
From: Corey Minyard <[email protected]>
If you write to a pty master an immediately close the pty master, the receiver might get a chunk of data dropped, but then receive some later data. That's obviously something rather unexpected for a user. It certainly confused my test program.
It turns out that tty_vhangup() gets called from pty_close(), and that causes the data on the slave side to be flushed, but due to races more data can be copied into the slave side's buffer after that. Consider the following sequence:
thread1 thread2 thread3
write data into buffer,
n_tty buffer is filled
pty_close()
tty_vhangup()
tty_ldisc_hangup()
n_tty_flush_buffer()
reset_buffer_flags()n_tty_read()
up_read(&tty->termios_rwsem);
down_read(&tty->termios_rwsem);
clear n_tty buffer contents
up_read(&tty->termios_rwsem);
tty_buffer_flush_work()
schedules work calling
flush_to_ldisc()
flush_to_ldisc()
receive_buf()
tty_port_default_receive_buf()
tty_ldisc_receive_buf()
tty_ldisc_receive_buf()
n_tty_receive_buf2()
n_tty_receive_buf_common()
down_read(&tty->termios_rwsem);
__receive_buf()
copies data into n_tty buffer
up_read(&tty->termios_rwsem);
down_read(&tty->termios_rwsem);
copy buffer data to userThis change checks to see if the tty is being hung up before copying anything in n_tty_receive_buf_common(). It has to be done after the tty->termios_rwsem semaphore is claimed, for reasons that should be apparent from the sequence above.
---
I sent a program to reproduce this, I extended it to prove it wasn't the test program that caused the issue, and I've uploaded it to:
http://sourceforge.net/projects/ser2net/files/tmp/testpty.c
if you want to run it. It has a lot of comments that explain what is going on.
This is not a very satisfying fix, though. It works reliably, but it doesn't seem right to me. My inclination was to remove the up and down semaphore around tty_buffer_flush_work() in n_tty_read(), as it just schedules some work, no need to unlock for that. But that resulted in a deadlock elsewhere, so that up/down on the semaphore is there for another reason.
The locking in the tty code is really hard to follow. I believe this is actually a locking problem, but fixing it looks daunting to me.
-corey
drivers/tty/n_tty.c | 4 ++++ 1 file changed, 4 insertions(+)
drivers/tty/n_tty.c +4 -0
@@ -1704,6 +1704,9 @@ n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,down_read (&tty->termios_rwsem); +if (test_bit (TTY_HUPPING , &tty->flags)) + goto out_upsem; + do { /* * When PARMRK is set, each input char may take up to 3 chars
@@ -1760,6 +1763,7 @@ n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp, }else n_tty_check_throttle (tty); +out_upsem:up_read (&tty->termios_rwsem);return rcvd;
Signature · 1 line
2.17.1
Greg Kroah-Hartman
maintainerQuoted 33 lines · On Thu, Oct 01, 2020 at 09:16:30PM -0500, [email protected] wrote:
From: Corey Minyard <[email protected]>
If you write to a pty master an immediately close the pty master, the receiver might get a chunk of data dropped, but then receive some later data. That's obviously something rather unexpected for a user. It certainly confused my test program.
It turns out that
tty_vhangup()gets called frompty_close(), and that causes the data on the slave side to be flushed, but due to races more data can be copied into the slave side's buffer after that. Consider the following sequence:thread1 thread2 thread3
write data into buffer,
n_ttybuffer is filled
pty_close()
tty_vhangup()
tty_ldisc_hangup()
n_tty_flush_buffer()
reset_buffer_flags()n_tty_read()up_read(&tty->termios_rwsem); down_read(&tty->termios_rwsem); clear n_tty buffer contents up_read(&tty->termios_rwsem); tty_buffer_flush_work() schedules work calling flush_to_ldisc() flush_to_ldisc() receive_buf() tty_port_default_receive_buf() tty_ldisc_receive_buf() tty_ldisc_receive_buf()
Quoted 8 lines
n_tty_receive_buf2()
n_tty_receive_buf_common()
down_read(&tty->termios_rwsem);
__receive_buf()
copies data into n_tty buffer
up_read(&tty->termios_rwsem);
down_read(&tty->termios_rwsem);
copy buffer data to userYour text got line-wrapped here for this explaination and it doesn't make much sense :(
Can you resend this?
Quoted 4 lines
This change checks to see if the tty is being hung up before copying anything in
n_tty_receive_buf_common(). It has to be done after thetty->termios_rwsemsemaphore is claimed, for reasons that should be apparent from the sequence above.
That kind of makes sense, but it's tricky, if you resend with the above fixed it might be more obvious...
thanks,
greg k-h