Skip to contentSkip to conversation

qemu-io: fix EOF Ctrl-D handling in qemu-io readline code

PATCH Superseded Daniel P. Berrange 4 participants 7 messages Dec 6, 2017 – Dec 8, 2017

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 qemu-io: fix EOF Ctrl-D handling in qemu-io readline code

qemu-io puts the TTY into non-canonical mode, which means no EOF processing is done and thus getchar() will never return the EOF constant. Instead we have to check for an explicit Ctrl-D, aka 0x4, to detect EOF and exit the qemu-io shell. This fixes the regression that prevented Ctrl-D from triggering an exit of qemu-io that has existed since readline was first added in

commit 0cf17e181798063c3824c8200ba46f25f54faa1a
Author: Stefan Hajnoczi <[email protected]>
Date: Thu Nov 14 11:54:17 2013 +0100

qemu-io: use readline.c

---
 qemu-io.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
qemu-io.c +3 -1
index c70bde3eb1..2ea0bfbaf8 100644
@@ -322,7 +322,9 @@ static char *fetchline_readline(void)
     readline_start(readline_state, get_prompt(), 0, readline_func, &line);
     while (!line) {
         int ch = getchar();
-        if (ch == EOF) {
+        /* In non-canon tty mode we get 0x4 (Ctrl-D), not the stdio "EOF"
+         * constant */
+        if (ch == 0x4) {
             break;
         }
         readline_handle_byte(readline_state, ch);
Signature · 1 line
2.14.3
#1 lore raw
Quoted 19 lines · Daniel P. Berrange

qemu-io puts the TTY into non-canonical mode, which means no EOF processing is done and thus getchar() will never return the EOF constant. Instead we have to check for an explicit Ctrl-D, aka 0x4, to detect EOF and exit the qemu-io shell. This fixes the regression that prevented Ctrl-D from triggering an exit of qemu-io that has existed since readline was first added in

commit 0cf17e181798063c3824c8200ba46f25f54faa1a
Author: Stefan Hajnoczi <[email protected]>
Date: Thu Nov 14 11:54:17 2013 +0100

qemu-io: use readline.c

---
 qemu-io.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
     while (!line) {
         int ch = getchar();

qemu-io.c static char *fetchline_readline(void) · line 327

Quoted 4 lines
qemu-io.c +3 -1
-        if (ch == EOF) {
+        /* In non-canon tty mode we get 0x4 (Ctrl-D), not the stdio "EOF"
+         * constant */
+        if (ch == 0x4) {

Should we instead be looking for a match against the current termios() c_cc[VEOF] setting, in case the user prefers something other than ^D via stty? Does readline provide any functionality for automating this?

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org
#2 lore raw
Quoted 25 lines · Eric Blake
Quoted 19 lines · Daniel P. Berrange

qemu-io puts the TTY into non-canonical mode, which means no EOF processing is done and thus getchar() will never return the EOF constant. Instead we have to check for an explicit Ctrl-D, aka 0x4, to detect EOF and exit the qemu-io shell. This fixes the regression that prevented Ctrl-D from triggering an exit of qemu-io that has existed since readline was first added in

commit 0cf17e181798063c3824c8200ba46f25f54faa1a
Author: Stefan Hajnoczi <[email protected]>
Date: Thu Nov 14 11:54:17 2013 +0100

qemu-io: use readline.c

---
 qemu-io.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
     while (!line) {
         int ch = getchar();

qemu-io.c static char *fetchline_readline(void) · line 327

Quoted 4 lines
qemu-io.c +3 -1
-        if (ch == EOF) {
+        /* In non-canon tty mode we get 0x4 (Ctrl-D), not the stdio "EOF"
+         * constant */
+        if (ch == 0x4) {
Quoted 3 lines

Should we instead be looking for a match against the current termios() c_cc[VEOF] setting, in case the user prefers something other than ^D via stty? Does readline provide any functionality for automating this?

I was afraid someone was going to suggest doing that. I was being lazy by hardcoding Ctrl-D, but yes the real readline() library will honour the VEOF value. QEMU though is using a home-grown reimpl of readline...

Regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#3 lore raw
Quoted 7 lines · Daniel P. Berrange
Quoted 3 lines

Should we instead be looking for a match against the current termios() c_cc[VEOF] setting, in case the user prefers something other than ^D via stty? Does readline provide any functionality for automating this?

I was afraid someone was going to suggest doing that. I was being lazy by hardcoding Ctrl-D, but yes the real readline() library will honour the VEOF value. QEMU though is using a home-grown reimpl of readline...

I understand why we can't use modern libreadline (it is licensed GPLv3+, making it impossible to use with our GPLv2-only code) - but doesn't BSD have a readline-alike library with BSD licensing that we could use instead of implementing readline ourselves? (Was it named libinput?)

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org
#4 lore raw
Quoted 6 lines · Eric Blake
Quoted 4 lines · Daniel P. Berrange
Quoted 3 lines

Should we instead be looking for a match against the current termios() c_cc[VEOF] setting, in case the user prefers something other than ^D via stty? Does readline provide any functionality for automating this?

Quoted 8 lines
Quoted 3 lines

I was afraid someone was going to suggest doing that. I was being lazy by hardcoding Ctrl-D, but yes the real readline() library will honour the VEOF value. QEMU though is using a home-grown reimpl of readline...

I understand why we can't use modern libreadline (it is licensed GPLv3+, making it impossible to use with our GPLv2-only code) - but doesn't BSD have a readline-alike library with BSD licensing that we could use instead of implementing readline ourselves? (Was it named libinput?)

We've discussed this before. Short story: we can't use the original due to our foolish licensing mistake, and the clones don't cut the mustard. Long story:
http://lists.gnu.org/archive/html/qemu-devel/2016-10/msg02697.html

Reviewed-by on v1 1/1
#5 lore raw
In reply to Daniel P. Berrange
Quoted 22 lines · * Daniel P. Berrange ([email protected]) wrote:

qemu-io puts the TTY into non-canonical mode, which means no EOF processing is done and thus getchar() will never return the EOF constant. Instead we have to check for an explicit Ctrl-D, aka 0x4, to detect EOF and exit the qemu-io shell. This fixes the regression that prevented Ctrl-D from triggering an exit of qemu-io that has existed since readline was first added in

commit 0cf17e181798063c3824c8200ba46f25f54faa1a
Author: Stefan Hajnoczi <[email protected]>
Date: Thu Nov 14 11:54:17 2013 +0100

qemu-io: use readline.c

---
 qemu-io.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
qemu-io.c +0 -0
index c70bde3eb1..2ea0bfbaf8 100644

qemu-io.c static char *fetchline_readline(void) · line 327

Quoted 7 lines
qemu-io.c +3 -1
@@ -322,7 +322,9 @@ static char *fetchline_readline(void)
     readline_start(readline_state, get_prompt(), 0, readline_func, &line);
     while (!line) {
         int ch = getchar();
-        if (ch == EOF) {
+        /* In non-canon tty mode we get 0x4 (Ctrl-D), not the stdio "EOF"
+         * constant */
+        if (ch == 0x4) {

Personally I'd have made that EOF or 0x4 - but that's fine

(I don't see the point of reading the ioctl to figure out which EOF char we're using; it seems to turn a trivial check into something much more complex)

Quoted 7 lines
qemu-io.c +0 -0
             break;
         }
         readline_handle_byte(readline_state, ch);
Signature · 1 line
2.14.3

--
Dr. David Alan Gilbert / [email protected] / Manchester, UK

#6 lore raw
Quoted 18 lines · Dr. David Alan Gilbert
Quoted 17 lines · * Daniel P. Berrange ([email protected]) wrote:

qemu-io puts the TTY into non-canonical mode, which means no EOF processing is done and thus getchar() will never return the EOF constant. Instead we have to check for an explicit Ctrl-D, aka 0x4, to detect EOF and exit the qemu-io shell. This fixes the regression that prevented Ctrl-D from triggering an exit of qemu-io that has existed since readline was first added in

commit 0cf17e181798063c3824c8200ba46f25f54faa1a
Author: Stefan Hajnoczi <[email protected]>
Date: Thu Nov 14 11:54:17 2013 +0100

qemu-io: use readline.c

---
 qemu-io.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Quoted 14 lines

qemu-io.c static char *fetchline_readline(void) · line 327

Quoted 12 lines
qemu-io.c +3 -1
index c70bde3eb1..2ea0bfbaf8 100644
@@ -322,7 +322,9 @@ static char *fetchline_readline(void)
     readline_start(readline_state, get_prompt(), 0, readline_func, &line);
     while (!line) {
         int ch = getchar();
-        if (ch == EOF) {
+        /* In non-canon tty mode we get 0x4 (Ctrl-D), not the stdio "EOF"
+         * constant */
+        if (ch == 0x4) {

Personally I'd have made that EOF or 0x4 - but that's fine

I thought about that, but it is impossible to get 'EOF' when the terminal is in raw mode, so there's little point.

Quoted 3 lines

(I don't see the point of reading the ioctl to figure out which EOF char we're using; it seems to turn a trivial check into something much more complex)

I'd already done the work to read termios settings by time I read this comment, so I've sent a v2 anyway :-)

Quoted 1 line

Regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|