dilim/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2026-08-09 09:32:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

terminal-util: add CLEANUP_TERMIOS_RESET() for automatic termios restore

Browse Source 
Add TERMIOS_NULL sentinel, TermiosResetContext, and CLEANUP_TERMIOS_RESET()
macro (modeled after CLEANUP_ARRAY()) to automatically restore terminal
settings when leaving scope, replacing manual goto+tcsetattr patterns.

Migrate ask_string_full(), terminal_get_cursor_position(),
get_default_background_color(), terminal_get_terminfo_by_dcs(),
terminal_get_size_by_dsr() and terminal_get_size_by_csi18() to use the new
cleanup macro, removing the goto-based cleanup labels and replacing them
with direct returns.

Co-developed-by: Claude Opus 4.6 <noreply@anthropic.com>
(cherry picked from commit 9fc49a4ca7)
This commit is contained in:
Daan De Meyer
2026-03-31 07:55:18 +00:00
committed by Zbigniew Jędrzejewski-Szmek
parent ad47ad9cee
commit 7eb219751b
2 changed files with 119 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

220
src/basic/terminal-util.c
View File

@@ -311,13 +311,17 @@ int ask_string_full(
* swapping out stdin/stdout. */
int fd_input = fileno(stdin);
int fd_output = fileno(stdout);
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(fd_input, old_termios);
if (fd_input < 0 || fd_output < 0 || same_fd(fd_input, fd_output) <= 0)
goto fallback;
/* Try to disable echo, which also tells us if this even is a terminal */
struct termios old_termios;
if (tcgetattr(fd_input, &old_termios) < 0)
if (tcgetattr(fd_input, &old_termios) < 0) {
old_termios = TERMIOS_NULL;
goto fallback;
}
struct termios new_termios = old_termios;
termios_disable_echo(&new_termios);
@@ -344,15 +348,13 @@ int ask_string_full(
if (get_completions) {
r = get_completions(string, &completions, userdata);
if (r < 0)
goto fail;
return r;
}
_cleanup_free_ char *new_string = NULL;
CompletionResult cr = pick_completion(string, completions, &new_string);
if (cr < 0) {
r = cr;
goto fail;
}
if (cr < 0)
return cr;
if (IN_SET(cr, COMPLETION_PARTIAL, COMPLETION_FULL)) {
/* Output the new suffix we learned */
fputs(ASSERT_PTR(startswith(new_string, strempty(string))), stdout);
@@ -371,10 +373,8 @@ int ask_string_full(
fputc('\n', stdout);
_cleanup_strv_free_ char **filtered = strv_filter_prefix(completions, string);
if (!filtered) {
r = -ENOMEM;
goto fail;
}
if (!filtered)
return -ENOMEM;
r = show_menu(filtered,
/* n_columns= */ SIZE_MAX,
@@ -383,7 +383,7 @@ int ask_string_full(
/* grey_prefix= */ string,
/* with_numbers= */ false);
if (r < 0)
goto fail;
return r;
/* Show the prompt again */
fputs(ansi_highlight(), stdout);
@@ -421,8 +421,7 @@ int ask_string_full(
} else if (c == 4) {
/* Ctrl-d → cancel this field input */
r = -ECANCELED;
goto fail;
return -ECANCELED;
} else if (char_is_cc(c) || n >= LINE_MAX)
/* refuse control characters and too long strings */
@@ -430,10 +429,8 @@ int ask_string_full(
else {
/* Regular char */
if (!GREEDY_REALLOC(string, n+2)) {
r = -ENOMEM;
goto fail;
}
if (!GREEDY_REALLOC(string, n+2))
return -ENOMEM;
string[n++] = (char) c;
string[n] = 0;
@@ -444,9 +441,6 @@ int ask_string_full(
fflush(stdout);
}
if (tcsetattr(fd_input, TCSANOW, &old_termios) < 0)
return -errno;
if (!string) {
string = strdup("");
if (!string)
@@ -456,10 +450,6 @@ int ask_string_full(
*ret = TAKE_PTR(string);
return 0;
fail:
(void) tcsetattr(fd_input, TCSANOW, &old_termios);
return r;
fallback:
/* A simple fallback without TTY magic */
r = read_line(stdin, LONG_LINE_MAX, &string);
@@ -2000,7 +1990,11 @@ int terminal_get_cursor_position(
if (r < 0)
return log_debug_errno(r, "Called with distinct input/output fds: %m");
struct termios old_termios;
/* Failure to reset the terminal is ignored here and in similar cases below.
* We already have our result; if cleanup fails it doesn't change the validity of the result. */
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(input_fd, old_termios);
if (tcgetattr(input_fd, &old_termios) < 0)
return log_debug_errno(errno, "Failed to get terminal settings: %m");
@@ -2013,14 +2007,14 @@ int terminal_get_cursor_position(
/* Request cursor position (DSR/CPR) */
r = loop_write(output_fd, "\x1B[6n", SIZE_MAX);
if (r < 0)
goto finish;
return r;
/* Open a 2nd input fd, in non-blocking mode, so that we won't ever hang in read() should someone
* else process the POLLIN. */
nonblock_input_fd = r = fd_reopen(input_fd, O_RDONLY|O_CLOEXEC|O_NONBLOCK|O_NOCTTY);
if (r < 0)
goto finish;
return r;
usec_t end = usec_add(now(CLOCK_MONOTONIC), CONSOLE_REPLY_WAIT_USEC);
char buf[STRLEN("\x1B[1;1R")]; /* The shortest valid reply possible */
@@ -2030,18 +2024,14 @@ int terminal_get_cursor_position(
for (bool first = true;; first = false) {
if (buf_full == 0) {
usec_t n = now(CLOCK_MONOTONIC);
if (n >= end) {
r = -EOPNOTSUPP;
goto finish;
}
if (n >= end)
return -EOPNOTSUPP;
r = fd_wait_for_event(nonblock_input_fd, POLLIN, usec_sub_unsigned(end, n));
if (r < 0)
goto finish;
if (r == 0) {
r = -EOPNOTSUPP;
goto finish;
}
return r;
if (r == 0)
return -EOPNOTSUPP;
/* On the first try, read multiple characters, i.e. the shortest valid
* reply. Afterwards read byte-wise, since we don't want to read too much, and
@@ -2051,8 +2041,7 @@ int terminal_get_cursor_position(
if (errno == EAGAIN)
continue;
r = -errno;
goto finish;
return -errno;
}
assert((size_t) l <= sizeof(buf));
@@ -2062,7 +2051,7 @@ int terminal_get_cursor_position(
size_t processed;
r = scan_cursor_position_response(&context, buf, buf_full, &processed);
if (r < 0)
goto finish;
return r;
assert(processed <= buf_full);
buf_full -= processed;
@@ -2070,26 +2059,17 @@ int terminal_get_cursor_position(
if (r > 0) {
/* Superficial validity check */
if (context.row >= 32766 || context.column >= 32766) {
r = -ENODATA;
goto finish;
}
if (context.row >= 32766 || context.column >= 32766)
return -ENODATA;
if (ret_row)
*ret_row = context.row;
if (ret_column)
*ret_column = context.column;
r = 0;
goto finish;
return 0;
}
}
finish:
/* We ignore failure here and in similar cases below. We already got a reply and if cleanup fails,
* this doesn't change the validity of the result. */
(void) tcsetattr(input_fd, TCSANOW, &old_termios);
return r;
}
int terminal_reset_defensive(int fd, TerminalResetFlags flags) {
@@ -2131,6 +2111,23 @@ void termios_disable_echo(struct termios *termios) {
termios->c_cc[VTIME] = 0;
}
static bool termios_is_null(const struct termios *t) {
if (!t)
return true;
return t->c_iflag == UINT_MAX &&
t->c_oflag == UINT_MAX &&
t->c_cflag == UINT_MAX &&
t->c_lflag == UINT_MAX;
}
void termios_reset(const TermiosResetContext *c) {
assert(c);
if (c->fd && *c->fd >= 0 && !termios_is_null(c->termios))
(void) tcsetattr(*c->fd, TCSANOW, c->termios);
}
typedef enum BackgroundColorState {
BACKGROUND_TEXT,
BACKGROUND_ESCAPE,
@@ -2302,7 +2299,9 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
if (r < 0)
return r;
struct termios old_termios;
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(nonblock_input_fd, old_termios);
if (tcgetattr(nonblock_input_fd, &old_termios) < 0)
return -errno;
@@ -2314,7 +2313,7 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
r = loop_write(STDOUT_FILENO, ANSI_OSC "11;?" ANSI_ST, SIZE_MAX);
if (r < 0)
goto finish;
return r;
usec_t end = usec_add(now(CLOCK_MONOTONIC), CONSOLE_REPLY_WAIT_USEC);
char buf[STRLEN(ANSI_OSC "11;rgb:0/0/0" ANSI_ST)]; /* shortest possible reply */
@@ -2324,18 +2323,14 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
for (bool first = true;; first = false) {
if (buf_full == 0) {
usec_t n = now(CLOCK_MONOTONIC);
if (n >= end) {
r = -EOPNOTSUPP;
goto finish;
}
if (n >= end)
return -EOPNOTSUPP;
r = fd_wait_for_event(nonblock_input_fd, POLLIN, usec_sub_unsigned(end, n));
if (r < 0)
goto finish;
if (r == 0) {
r = -EOPNOTSUPP;
goto finish;
}
return r;
if (r == 0)
return -EOPNOTSUPP;
/* On the first try, read multiple characters, i.e. the shortest valid
* reply. Afterwards read byte-wise, since we don't want to read too much, and
@@ -2344,8 +2339,7 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
if (l < 0) {
if (errno == EAGAIN)
continue;
r = -errno;
goto finish;
return -errno;
}
assert((size_t) l <= sizeof(buf));
@@ -2355,7 +2349,7 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
size_t processed;
r = scan_background_color_response(&context, buf, buf_full, &processed);
if (r < 0)
goto finish;
return r;
assert(processed <= buf_full);
buf_full -= processed;
@@ -2368,14 +2362,9 @@ int get_default_background_color(double *ret_red, double *ret_green, double *ret
*ret_green = (double) context.green / ((UINT64_C(1) << context.green_bits) - 1);
assert(context.blue_bits > 0);
*ret_blue = (double) context.blue / ((UINT64_C(1) << context.blue_bits) - 1);
r = 0;
goto finish;
return 0;
}
}
finish:
(void) tcsetattr(nonblock_input_fd, TCSANOW, &old_termios);
return r;
}
int terminal_get_size_by_dsr(
@@ -2412,7 +2401,9 @@ int terminal_get_size_by_dsr(
if (r < 0)
return r;
struct termios old_termios;
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(nonblock_input_fd, old_termios);
if (tcgetattr(nonblock_input_fd, &old_termios) < 0)
return log_debug_errno(errno, "Failed to get terminal settings: %m");
@@ -2523,7 +2514,6 @@ finish:
/* Restore cursor position */
if (saved_row > 0 && saved_column > 0)
(void) terminal_set_cursor_position(output_fd, saved_row, saved_column);
(void) tcsetattr(nonblock_input_fd, TCSANOW, &old_termios);
return r;
}
@@ -2589,7 +2579,9 @@ int terminal_get_size_by_csi18(
if (r < 0)
return r;
struct termios old_termios;
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(nonblock_input_fd, old_termios);
if (tcgetattr(nonblock_input_fd, &old_termios) < 0)
return log_debug_errno(errno, "Failed to get terminal settings: %m");
@@ -2601,7 +2593,7 @@ int terminal_get_size_by_csi18(
r = loop_write(output_fd, CSI18_Q, SIZE_MAX);
if (r < 0)
goto finish;
return r;
usec_t end = usec_add(now(CLOCK_MONOTONIC), CONSOLE_REPLY_WAIT_USEC);
char buf[STRLEN(CSI18_R1)];
@@ -2609,18 +2601,14 @@ int terminal_get_size_by_csi18(
for (;;) {
usec_t n = now(CLOCK_MONOTONIC);
if (n >= end) {
r = -EOPNOTSUPP;
break;
}
if (n >= end)
return -EOPNOTSUPP;
r = fd_wait_for_event(nonblock_input_fd, POLLIN, usec_sub_unsigned(end, n));
if (r < 0)
break;
if (r == 0) {
r = -EOPNOTSUPP;
break;
}
return r;
if (r == 0)
return -EOPNOTSUPP;
/* On the first read, read multiple characters, i.e. the shortest valid reply. Afterwards
* read byte by byte, since we don't want to read too much and drop characters from the input
@@ -2629,8 +2617,7 @@ int terminal_get_size_by_csi18(
if (l < 0) {
if (errno == EAGAIN)
continue;
r = -errno;
break;
return -errno;
}
assert((size_t) l <= sizeof(buf) - bytes);
@@ -2638,20 +2625,14 @@ int terminal_get_size_by_csi18(
r = scan_text_area_size_response(buf, bytes, ret_rows, ret_columns);
if (r != -EAGAIN)
break;
return r;
if (bytes == sizeof(buf)) {
r = -EOPNOTSUPP; /* The response has the right prefix, but we didn't find a valid
* answer with a terminator in the allotted space. Something is
* wrong, possibly some unrelated bytes got injected into the
* answer. */
break;
}
if (bytes == sizeof(buf))
return -EOPNOTSUPP; /* The response has the right prefix, but we didn't find a valid
* answer with a terminator in the allotted space. Something is
* wrong, possibly some unrelated bytes got injected into the
* answer. */
}
finish:
(void) tcsetattr(nonblock_input_fd, TCSANOW, &old_termios);
return r;
}
int terminal_fix_size(int input_fd, int output_fd) {
@@ -2752,7 +2733,9 @@ int terminal_get_terminfo_by_dcs(int fd, char **ret_name) {
/* Note: fd must be in non-blocking read-write mode! */
struct termios old_termios;
struct termios old_termios = TERMIOS_NULL;
CLEANUP_TERMIOS_RESET(fd, old_termios);
if (tcgetattr(fd, &old_termios) < 0)
return -errno;
@@ -2764,7 +2747,7 @@ int terminal_get_terminfo_by_dcs(int fd, char **ret_name) {
r = loop_write(fd, DCS_TERMINFO_Q, SIZE_MAX);
if (r < 0)
goto finish;
return r;
usec_t end = usec_add(now(CLOCK_MONOTONIC), CONSOLE_REPLY_WAIT_USEC);
char buf[STRLEN(DCS_TERMINFO_R1) + MAX_TERMINFO_LENGTH + STRLEN(ANSI_ST)];
@@ -2772,18 +2755,14 @@ int terminal_get_terminfo_by_dcs(int fd, char **ret_name) {
for (;;) {
usec_t n = now(CLOCK_MONOTONIC);
if (n >= end) {
r = -EOPNOTSUPP;
break;
}
if (n >= end)
return -EOPNOTSUPP;
r = fd_wait_for_event(fd, POLLIN, usec_sub_unsigned(end, n));
if (r < 0)
break;
if (r == 0) {
r = -EOPNOTSUPP;
break;
}
return r;
if (r == 0)
return -EOPNOTSUPP;
/* On the first read, read multiple characters, i.e. the shortest valid reply. Afterwards
* read byte by byte, since we don't want to read too much and drop characters from the input
@@ -2792,8 +2771,7 @@ int terminal_get_terminfo_by_dcs(int fd, char **ret_name) {
if (l < 0) {
if (errno == EAGAIN)
continue;
r = -errno;
break;
return -errno;
}
assert((size_t) l <= sizeof(buf) - bytes);
@@ -2801,20 +2779,14 @@ int terminal_get_terminfo_by_dcs(int fd, char **ret_name) {
r = scan_terminfo_response(buf, bytes, ret_name);
if (r != -EAGAIN)
break;
return r;
if (bytes == sizeof(buf)) {
r = -EOPNOTSUPP; /* The response has the right prefix, but we didn't find a valid
* answer with a terminator in the allotted space. Something is
* wrong, possibly some unrelated bytes got injected into the
* answer. */
break;
}
if (bytes == sizeof(buf))
return -EOPNOTSUPP; /* The response has the right prefix, but we didn't find a valid
* answer with a terminator in the allotted space. Something is
* wrong, possibly some unrelated bytes got injected into the
* answer. */
}
finish:
(void) tcsetattr(fd, TCSANOW, &old_termios);
return r;
}
int have_terminfo_file(const char *name) {

23
src/basic/terminal-util.h
View File

@@ -145,6 +145,29 @@ assert_cc((TTY_MODE & 0711) == 0600);
void termios_disable_echo(struct termios *termios);
/* A termios sentinel with all flag fields set to all-ones-bits. No real tcgetattr() result will ever
* match this because the multi-bit sub-fields (CSIZE, CBAUD, …) can't validly have every bit set. */
#define TERMIOS_NULL (struct termios) { \
.c_iflag = UINT_MAX, \
.c_oflag = UINT_MAX, \
.c_cflag = UINT_MAX, \
.c_lflag = UINT_MAX, \
}
typedef struct TermiosResetContext {
int *fd;
struct termios *termios;
} TermiosResetContext;
void termios_reset(const TermiosResetContext *c);
#define CLEANUP_TERMIOS_RESET(_fd, _termios) \
_cleanup_(termios_reset) _unused_ const TermiosResetContext \
CONCATENATE(_cleanup_termios_, UNIQ) = { \
.fd = &(_fd), \
.termios = &(_termios), \
}
/* The $TERM value we use for terminals other than the Linux console */
#define FALLBACK_TERM "vt220"