dart-sdk/runtime/bin/stdio_linux.cc

140 lines
3.3 KiB
C++
Raw Normal View History

// Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
#include "platform/globals.h"
#if defined(DART_HOST_OS_LINUX)
#include "bin/stdio.h"
#include <errno.h> // NOLINT
#include <sys/ioctl.h> // NOLINT
#include <termios.h> // NOLINT
#include "bin/fdutils.h"
#include "platform/signal_blocker.h"
namespace dart {
namespace bin {
bool Stdin::ReadByte(intptr_t fd, int* byte) {
unsigned char b;
ssize_t s = TEMP_FAILURE_RETRY(read(fd, &b, 1));
if (s < 0) {
return false;
}
*byte = (s == 0) ? -1 : b;
return true;
}
bool Stdin::GetEchoMode(intptr_t fd, bool* enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
*enabled = ((term.c_lflag & ECHO) != 0);
return true;
}
bool Stdin::SetEchoMode(intptr_t fd, bool enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
if (enabled) {
[io] Don't restore terminal state on exit. This is breaking change #45630. The Dart VM has until now restored the terminal settings upon exit to their initial values for stdin, stdout, and stderr. This change removes that automatic behavior in favor of having the program do the restoration. Previously the intention was that dart programs can enable/disable echoing and line buffering and not worry about restoring the original settings. However, the VM doing so unconditionally leads to undesirable behavior e.g. when the program does not care about terminal settings and is sharing a process group with a program that does care. E.g. if dart's output is piped into less(1), then there is a race condition where dart might see the raw terminal settings set by less(1), and if the dart VM exits after less(1) has exited, then it will restore the raw terminal settings, leaving the user with a seemingly defective shell with echo disabled. This race condition can be reproduced using: cat > yes.dart << EOF main() { for (int i = 0; i < 1000000; i++) { print("yes"); } } EOF stty; (sleep 1 && dart yes.dart) | less; stty; stty sane The user will end up with a shell with echo behavior disabled. The stty command shows the current terminal settings, where the difference can be seen, and 'stty sane' fixes the settings before returning to the shell prompt. The 'stty sane' call can be omitted to see the defective shell prompt. This change removes the terminal restoring behavior (added in Dart 2.0.0) and instead asks applications to do the restoration themselves. The new design matches how programs in other programming languages implement interactive input that changes terminal settings. Furthermore the `echoMode` setting now only controls the `echo` local mode and no longer sets the `echonl` local mode on POSIX systems (which controls whether newline are echoed even if the regular echo mode is disabled). The `echonl` local mode is usually turned off in common shell environments. Programs that wish to control the `echonl` local mode can use the new `echoNewlineMode` setting. This change is required to prevent the reoccurence of #30318 when programs manually restore `echoMode`. Windows has further considerations: It also saves the console code pages and restore them if they were not UTF-8. This behavior is retained as it is useful and needed for Dart's output to function properly. ANSI output sequences are also turned on via ENABLE_VIRTUAL_TERMINAL_PROCESSING, which is slightly changed in this change to only rsetore that setting if it wasn't already on for consistency. Closes https://github.com/dart-lang/sdk/issues/36453 Closes https://github.com/dart-lang/sdk/issues/45630 TEST=Reproduced with less as above Change-Id: I2991f9c7f47b97fe475c1ad6edeb769024f8d0db Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/190484 Reviewed-by: Lasse Nielsen <lrn@google.com> Commit-Queue: Alexander Aprelev <aam@google.com> Reviewed-by: Jonas Termansen <sortie@google.com> Reviewed-by: Alexander Aprelev <aam@google.com>
2022-05-31 15:36:33 +00:00
term.c_lflag |= ECHO;
} else {
[io] Don't restore terminal state on exit. This is breaking change #45630. The Dart VM has until now restored the terminal settings upon exit to their initial values for stdin, stdout, and stderr. This change removes that automatic behavior in favor of having the program do the restoration. Previously the intention was that dart programs can enable/disable echoing and line buffering and not worry about restoring the original settings. However, the VM doing so unconditionally leads to undesirable behavior e.g. when the program does not care about terminal settings and is sharing a process group with a program that does care. E.g. if dart's output is piped into less(1), then there is a race condition where dart might see the raw terminal settings set by less(1), and if the dart VM exits after less(1) has exited, then it will restore the raw terminal settings, leaving the user with a seemingly defective shell with echo disabled. This race condition can be reproduced using: cat > yes.dart << EOF main() { for (int i = 0; i < 1000000; i++) { print("yes"); } } EOF stty; (sleep 1 && dart yes.dart) | less; stty; stty sane The user will end up with a shell with echo behavior disabled. The stty command shows the current terminal settings, where the difference can be seen, and 'stty sane' fixes the settings before returning to the shell prompt. The 'stty sane' call can be omitted to see the defective shell prompt. This change removes the terminal restoring behavior (added in Dart 2.0.0) and instead asks applications to do the restoration themselves. The new design matches how programs in other programming languages implement interactive input that changes terminal settings. Furthermore the `echoMode` setting now only controls the `echo` local mode and no longer sets the `echonl` local mode on POSIX systems (which controls whether newline are echoed even if the regular echo mode is disabled). The `echonl` local mode is usually turned off in common shell environments. Programs that wish to control the `echonl` local mode can use the new `echoNewlineMode` setting. This change is required to prevent the reoccurence of #30318 when programs manually restore `echoMode`. Windows has further considerations: It also saves the console code pages and restore them if they were not UTF-8. This behavior is retained as it is useful and needed for Dart's output to function properly. ANSI output sequences are also turned on via ENABLE_VIRTUAL_TERMINAL_PROCESSING, which is slightly changed in this change to only rsetore that setting if it wasn't already on for consistency. Closes https://github.com/dart-lang/sdk/issues/36453 Closes https://github.com/dart-lang/sdk/issues/45630 TEST=Reproduced with less as above Change-Id: I2991f9c7f47b97fe475c1ad6edeb769024f8d0db Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/190484 Reviewed-by: Lasse Nielsen <lrn@google.com> Commit-Queue: Alexander Aprelev <aam@google.com> Reviewed-by: Jonas Termansen <sortie@google.com> Reviewed-by: Alexander Aprelev <aam@google.com>
2022-05-31 15:36:33 +00:00
term.c_lflag &= ~(ECHO);
}
status = NO_RETRY_EXPECTED(tcsetattr(fd, TCSANOW, &term));
return (status == 0);
}
bool Stdin::GetEchoNewlineMode(intptr_t fd, bool* enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
*enabled = ((term.c_lflag & ECHONL) != 0);
return true;
}
bool Stdin::SetEchoNewlineMode(intptr_t fd, bool enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
if (enabled) {
term.c_lflag |= ECHONL;
} else {
term.c_lflag &= ~(ECHONL);
}
status = NO_RETRY_EXPECTED(tcsetattr(fd, TCSANOW, &term));
return (status == 0);
}
bool Stdin::GetLineMode(intptr_t fd, bool* enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
*enabled = ((term.c_lflag & ICANON) != 0);
return true;
}
bool Stdin::SetLineMode(intptr_t fd, bool enabled) {
struct termios term;
int status = NO_RETRY_EXPECTED(tcgetattr(fd, &term));
if (status != 0) {
return false;
}
if (enabled) {
term.c_lflag |= ICANON;
} else {
term.c_lflag &= ~(ICANON);
}
status = NO_RETRY_EXPECTED(tcsetattr(fd, TCSANOW, &term));
return (status == 0);
}
static bool TermIsKnownToSupportAnsi() {
const char* term = getenv("TERM");
if (term == nullptr) {
return false;
}
return strstr(term, "xterm") != nullptr ||
strstr(term, "screen") != nullptr || strstr(term, "rxvt") != nullptr;
}
bool Stdin::AnsiSupported(intptr_t fd, bool* supported) {
*supported = (isatty(fd) != 0) && TermIsKnownToSupportAnsi();
return true;
}
bool Stdout::GetTerminalSize(intptr_t fd, int size[2]) {
struct winsize w;
int status = NO_RETRY_EXPECTED(ioctl(fd, TIOCGWINSZ, &w));
if ((status == 0) && ((w.ws_col != 0) || (w.ws_row != 0))) {
size[0] = w.ws_col;
size[1] = w.ws_row;
return true;
}
return false;
}
bool Stdout::AnsiSupported(intptr_t fd, bool* supported) {
*supported = (isatty(fd) != 0) && TermIsKnownToSupportAnsi();
return true;
}
} // namespace bin
} // namespace dart
#endif // defined(DART_HOST_OS_LINUX)