2 This file is part of systemd.
4 Copyright 2010 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 #include <linux/tiocl.h>
27 #include <sys/ioctl.h>
29 #include <sys/types.h>
35 #include "path-util.h"
36 #include "process-util.h"
37 #include "string-util.h"
38 #include "time-util.h"
40 #include "terminal-util.h"
42 static volatile unsigned cached_columns
= 0;
43 static volatile unsigned cached_lines
= 0;
46 _cleanup_close_
int fd
;
48 fd
= open_terminal("/dev/tty0", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
54 TIOCL_GETKMSGREDIRECT
,
58 if (ioctl(fd
, TIOCLINUX
, tiocl
) < 0)
61 vt
= tiocl
[0] <= 0 ? 1 : tiocl
[0];
64 if (ioctl(fd
, VT_ACTIVATE
, vt
) < 0)
70 int read_one_char(FILE *f
, char *ret
, usec_t t
, bool *need_nl
) {
71 struct termios old_termios
, new_termios
;
72 char c
, line
[LINE_MAX
];
77 if (tcgetattr(fileno(f
), &old_termios
) >= 0) {
78 new_termios
= old_termios
;
80 new_termios
.c_lflag
&= ~ICANON
;
81 new_termios
.c_cc
[VMIN
] = 1;
82 new_termios
.c_cc
[VTIME
] = 0;
84 if (tcsetattr(fileno(f
), TCSADRAIN
, &new_termios
) >= 0) {
87 if (t
!= USEC_INFINITY
) {
88 if (fd_wait_for_event(fileno(f
), POLLIN
, t
) <= 0) {
89 tcsetattr(fileno(f
), TCSADRAIN
, &old_termios
);
94 k
= fread(&c
, 1, 1, f
);
96 tcsetattr(fileno(f
), TCSADRAIN
, &old_termios
);
102 *need_nl
= c
!= '\n';
109 if (t
!= USEC_INFINITY
) {
110 if (fd_wait_for_event(fileno(f
), POLLIN
, t
) <= 0)
115 if (!fgets(line
, sizeof(line
), f
))
116 return errno
? -errno
: -EIO
;
120 if (strlen(line
) != 1)
130 int ask_char(char *ret
, const char *replies
, const char *text
, ...) {
143 fputs(ANSI_HIGHLIGHT
, stdout
);
150 fputs(ANSI_NORMAL
, stdout
);
154 r
= read_one_char(stdin
, &c
, USEC_INFINITY
, &need_nl
);
158 puts("Bad input, please try again.");
169 if (strchr(replies
, c
)) {
174 puts("Read unexpected character, please try again.");
178 int ask_string(char **ret
, const char *text
, ...) {
187 fputs(ANSI_HIGHLIGHT
, stdout
);
194 fputs(ANSI_NORMAL
, stdout
);
199 if (!fgets(line
, sizeof(line
), stdin
))
200 return errno
? -errno
: -EIO
;
202 if (!endswith(line
, "\n"))
221 int reset_terminal_fd(int fd
, bool switch_to_text
) {
222 struct termios termios
;
225 /* Set terminal to some sane defaults */
229 /* We leave locked terminal attributes untouched, so that
230 * Plymouth may set whatever it wants to set, and we don't
231 * interfere with that. */
233 /* Disable exclusive mode, just in case */
234 (void) ioctl(fd
, TIOCNXCL
);
236 /* Switch to text mode */
238 (void) ioctl(fd
, KDSETMODE
, KD_TEXT
);
240 /* Enable console unicode mode */
241 (void) ioctl(fd
, KDSKBMODE
, K_UNICODE
);
243 if (tcgetattr(fd
, &termios
) < 0) {
248 /* We only reset the stuff that matters to the software. How
249 * hardware is set up we don't touch assuming that somebody
250 * else will do that for us */
252 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| ISTRIP
| INLCR
| IGNCR
| IUCLC
);
253 termios
.c_iflag
|= ICRNL
| IMAXBEL
| IUTF8
;
254 termios
.c_oflag
|= ONLCR
;
255 termios
.c_cflag
|= CREAD
;
256 termios
.c_lflag
= ISIG
| ICANON
| IEXTEN
| ECHO
| ECHOE
| ECHOK
| ECHOCTL
| ECHOPRT
| ECHOKE
;
258 termios
.c_cc
[VINTR
] = 03; /* ^C */
259 termios
.c_cc
[VQUIT
] = 034; /* ^\ */
260 termios
.c_cc
[VERASE
] = 0177;
261 termios
.c_cc
[VKILL
] = 025; /* ^X */
262 termios
.c_cc
[VEOF
] = 04; /* ^D */
263 termios
.c_cc
[VSTART
] = 021; /* ^Q */
264 termios
.c_cc
[VSTOP
] = 023; /* ^S */
265 termios
.c_cc
[VSUSP
] = 032; /* ^Z */
266 termios
.c_cc
[VLNEXT
] = 026; /* ^V */
267 termios
.c_cc
[VWERASE
] = 027; /* ^W */
268 termios
.c_cc
[VREPRINT
] = 022; /* ^R */
269 termios
.c_cc
[VEOL
] = 0;
270 termios
.c_cc
[VEOL2
] = 0;
272 termios
.c_cc
[VTIME
] = 0;
273 termios
.c_cc
[VMIN
] = 1;
275 if (tcsetattr(fd
, TCSANOW
, &termios
) < 0)
279 /* Just in case, flush all crap out */
280 (void) tcflush(fd
, TCIOFLUSH
);
285 int reset_terminal(const char *name
) {
286 _cleanup_close_
int fd
= -1;
288 /* We open the terminal with O_NONBLOCK here, to ensure we
289 * don't block on carrier if this is a terminal with carrier
292 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
296 return reset_terminal_fd(fd
, true);
299 int open_terminal(const char *name
, int mode
) {
304 * If a TTY is in the process of being closed opening it might
305 * cause EIO. This is horribly awful, but unlikely to be
306 * changed in the kernel. Hence we work around this problem by
307 * retrying a couple of times.
309 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/554172/comments/245
316 fd
= open(name
, mode
, 0);
323 /* Max 1s in total */
327 usleep(50 * USEC_PER_MSEC
);
345 int acquire_terminal(
349 bool ignore_tiocstty_eperm
,
352 int fd
= -1, notify
= -1, r
= 0, wd
= -1;
357 /* We use inotify to be notified when the tty is closed. We
358 * create the watch before checking if we can actually acquire
359 * it, so that we don't lose any event.
361 * Note: strictly speaking this actually watches for the
362 * device being closed, it does *not* really watch whether a
363 * tty loses its controlling process. However, unless some
364 * rogue process uses TIOCNOTTY on /dev/tty *after* closing
365 * its tty otherwise this will not become a problem. As long
366 * as the administrator makes sure not configure any service
367 * on the same tty as an untrusted user this should not be a
368 * problem. (Which he probably should not do anyway.) */
370 if (timeout
!= USEC_INFINITY
)
371 ts
= now(CLOCK_MONOTONIC
);
373 if (!fail
&& !force
) {
374 notify
= inotify_init1(IN_CLOEXEC
| (timeout
!= USEC_INFINITY
? IN_NONBLOCK
: 0));
380 wd
= inotify_add_watch(notify
, name
, IN_CLOSE
);
388 struct sigaction sa_old
, sa_new
= {
389 .sa_handler
= SIG_IGN
,
390 .sa_flags
= SA_RESTART
,
394 r
= flush_fd(notify
);
399 /* We pass here O_NOCTTY only so that we can check the return
400 * value TIOCSCTTY and have a reliable way to figure out if we
401 * successfully became the controlling process of the tty */
402 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
406 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
407 * if we already own the tty. */
408 assert_se(sigaction(SIGHUP
, &sa_new
, &sa_old
) == 0);
410 /* First, try to get the tty */
411 if (ioctl(fd
, TIOCSCTTY
, force
) < 0)
414 assert_se(sigaction(SIGHUP
, &sa_old
, NULL
) == 0);
416 /* Sometimes it makes sense to ignore TIOCSCTTY
417 * returning EPERM, i.e. when very likely we already
418 * are have this controlling terminal. */
419 if (r
< 0 && r
== -EPERM
&& ignore_tiocstty_eperm
)
422 if (r
< 0 && (force
|| fail
|| r
!= -EPERM
))
433 union inotify_event_buffer buffer
;
434 struct inotify_event
*e
;
437 if (timeout
!= USEC_INFINITY
) {
440 n
= now(CLOCK_MONOTONIC
);
441 if (ts
+ timeout
< n
) {
446 r
= fd_wait_for_event(fd
, POLLIN
, ts
+ timeout
- n
);
456 l
= read(notify
, &buffer
, sizeof(buffer
));
458 if (errno
== EINTR
|| errno
== EAGAIN
)
465 FOREACH_INOTIFY_EVENT(e
, buffer
, l
) {
466 if (e
->wd
!= wd
|| !(e
->mask
& IN_CLOSE
)) {
475 /* We close the tty fd here since if the old session
476 * ended our handle will be dead. It's important that
477 * we do this after sleeping, so that we don't enter
478 * an endless loop. */
493 int release_terminal(void) {
494 static const struct sigaction sa_new
= {
495 .sa_handler
= SIG_IGN
,
496 .sa_flags
= SA_RESTART
,
499 _cleanup_close_
int fd
= -1;
500 struct sigaction sa_old
;
503 fd
= open("/dev/tty", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
507 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
508 * by our own TIOCNOTTY */
509 assert_se(sigaction(SIGHUP
, &sa_new
, &sa_old
) == 0);
511 if (ioctl(fd
, TIOCNOTTY
) < 0)
514 assert_se(sigaction(SIGHUP
, &sa_old
, NULL
) == 0);
519 int terminal_vhangup_fd(int fd
) {
522 if (ioctl(fd
, TIOCVHANGUP
) < 0)
528 int terminal_vhangup(const char *name
) {
529 _cleanup_close_
int fd
;
531 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
535 return terminal_vhangup_fd(fd
);
538 int vt_disallocate(const char *name
) {
539 _cleanup_close_
int fd
= -1;
543 /* Deallocate the VT if possible. If not possible
544 * (i.e. because it is the active one), at least clear it
545 * entirely (including the scrollback buffer) */
547 if (!startswith(name
, "/dev/"))
550 if (!tty_is_vc(name
)) {
551 /* So this is not a VT. I guess we cannot deallocate
552 * it then. But let's at least clear the screen */
554 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
559 "\033[r" /* clear scrolling region */
560 "\033[H" /* move home */
561 "\033[2J", /* clear screen */
566 if (!startswith(name
, "/dev/tty"))
569 r
= safe_atou(name
+8, &u
);
576 /* Try to deallocate */
577 fd
= open_terminal("/dev/tty0", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
581 r
= ioctl(fd
, VT_DISALLOCATE
, u
);
590 /* Couldn't deallocate, so let's clear it fully with
592 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
597 "\033[r" /* clear scrolling region */
598 "\033[H" /* move home */
599 "\033[3J", /* clear screen including scrollback, requires Linux 2.6.40 */
604 int make_console_stdio(void) {
607 /* Make /dev/console the controlling terminal and stdin/stdout/stderr */
609 fd
= acquire_terminal("/dev/console", false, true, true, USEC_INFINITY
);
611 return log_error_errno(fd
, "Failed to acquire terminal: %m");
613 r
= reset_terminal_fd(fd
, true);
615 log_warning_errno(r
, "Failed to reset terminal, ignoring: %m");
619 return log_error_errno(r
, "Failed to duplicate terminal fd: %m");
624 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) {
625 static const char status_indent
[] = " "; /* "[" STATUS "] " */
626 _cleanup_free_
char *s
= NULL
;
627 _cleanup_close_
int fd
= -1;
628 struct iovec iovec
[6] = {};
630 static bool prev_ephemeral
;
634 /* This is independent of logging, as status messages are
635 * optional and go exclusively to the console. */
637 if (vasprintf(&s
, format
, ap
) < 0)
640 fd
= open_terminal("/dev/console", O_WRONLY
|O_NOCTTY
|O_CLOEXEC
);
653 sl
= status
? sizeof(status_indent
)-1 : 0;
659 e
= ellipsize(s
, emax
, 50);
667 IOVEC_SET_STRING(iovec
[n
++], "\r" ANSI_ERASE_TO_END_OF_LINE
);
668 prev_ephemeral
= ephemeral
;
671 if (!isempty(status
)) {
672 IOVEC_SET_STRING(iovec
[n
++], "[");
673 IOVEC_SET_STRING(iovec
[n
++], status
);
674 IOVEC_SET_STRING(iovec
[n
++], "] ");
676 IOVEC_SET_STRING(iovec
[n
++], status_indent
);
679 IOVEC_SET_STRING(iovec
[n
++], s
);
681 IOVEC_SET_STRING(iovec
[n
++], "\n");
683 if (writev(fd
, iovec
, n
) < 0)
689 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) {
695 va_start(ap
, format
);
696 r
= status_vprintf(status
, ellipse
, ephemeral
, format
, ap
);
702 bool tty_is_vc(const char *tty
) {
705 return vtnr_from_tty(tty
) >= 0;
708 bool tty_is_console(const char *tty
) {
711 if (startswith(tty
, "/dev/"))
714 return streq(tty
, "console");
717 int vtnr_from_tty(const char *tty
) {
722 if (startswith(tty
, "/dev/"))
725 if (!startswith(tty
, "tty") )
728 if (tty
[3] < '0' || tty
[3] > '9')
731 r
= safe_atoi(tty
+3, &i
);
741 char *resolve_dev_console(char **active
) {
744 /* Resolve where /dev/console is pointing to, if /sys is actually ours
745 * (i.e. not read-only-mounted which is a sign for container setups) */
747 if (path_is_read_only_fs("/sys") > 0)
750 if (read_one_line_file("/sys/class/tty/console/active", active
) < 0)
753 /* If multiple log outputs are configured the last one is what
754 * /dev/console points to */
755 tty
= strrchr(*active
, ' ');
761 if (streq(tty
, "tty0")) {
764 /* Get the active VC (e.g. tty1) */
765 if (read_one_line_file("/sys/class/tty/tty0/active", &tmp
) >= 0) {
774 bool tty_is_vc_resolve(const char *tty
) {
775 _cleanup_free_
char *active
= NULL
;
779 if (startswith(tty
, "/dev/"))
782 if (streq(tty
, "console")) {
783 tty
= resolve_dev_console(&active
);
788 return tty_is_vc(tty
);
791 const char *default_term_for_tty(const char *tty
) {
794 return tty_is_vc_resolve(tty
) ? "TERM=linux" : "TERM=vt220";
797 int fd_columns(int fd
) {
798 struct winsize ws
= {};
800 if (ioctl(fd
, TIOCGWINSZ
, &ws
) < 0)
809 unsigned columns(void) {
813 if (_likely_(cached_columns
> 0))
814 return cached_columns
;
817 e
= getenv("COLUMNS");
819 (void) safe_atoi(e
, &c
);
822 c
= fd_columns(STDOUT_FILENO
);
828 return cached_columns
;
831 int fd_lines(int fd
) {
832 struct winsize ws
= {};
834 if (ioctl(fd
, TIOCGWINSZ
, &ws
) < 0)
843 unsigned lines(void) {
847 if (_likely_(cached_lines
> 0))
853 (void) safe_atoi(e
, &l
);
856 l
= fd_lines(STDOUT_FILENO
);
865 /* intended to be used as a SIGWINCH sighandler */
866 void columns_lines_cache_reset(int signum
) {
872 static int cached_on_tty
= -1;
874 if (_unlikely_(cached_on_tty
< 0))
875 cached_on_tty
= isatty(STDOUT_FILENO
) > 0;
877 return cached_on_tty
;
880 int make_stdio(int fd
) {
885 r
= dup2(fd
, STDIN_FILENO
);
886 s
= dup2(fd
, STDOUT_FILENO
);
887 t
= dup2(fd
, STDERR_FILENO
);
892 if (r
< 0 || s
< 0 || t
< 0)
895 /* Explicitly unset O_CLOEXEC, since if fd was < 3, then
896 * dup2() was a NOP and the bit hence possibly set. */
897 fd_cloexec(STDIN_FILENO
, false);
898 fd_cloexec(STDOUT_FILENO
, false);
899 fd_cloexec(STDERR_FILENO
, false);
904 int make_null_stdio(void) {
907 null_fd
= open("/dev/null", O_RDWR
|O_NOCTTY
);
911 return make_stdio(null_fd
);
914 int getttyname_malloc(int fd
, char **ret
) {
924 r
= ttyname_r(fd
, path
, sizeof(path
));
929 p
= startswith(path
, "/dev/");
930 c
= strdup(p
?: path
);
947 int getttyname_harder(int fd
, char **r
) {
951 k
= getttyname_malloc(fd
, &s
);
955 if (streq(s
, "tty")) {
957 return get_ctty(0, NULL
, r
);
964 int get_ctty_devnr(pid_t pid
, dev_t
*d
) {
966 _cleanup_free_
char *line
= NULL
;
972 p
= procfs_file_alloca(pid
, "stat");
973 r
= read_one_line_file(p
, &line
);
977 p
= strrchr(line
, ')');
992 if (major(ttynr
) == 0 && minor(ttynr
) == 0)
1001 int get_ctty(pid_t pid
, dev_t
*_devnr
, char **r
) {
1002 char fn
[sizeof("/dev/char/")-1 + 2*DECIMAL_STR_MAX(unsigned) + 1 + 1], *b
= NULL
;
1003 _cleanup_free_
char *s
= NULL
;
1010 k
= get_ctty_devnr(pid
, &devnr
);
1014 sprintf(fn
, "/dev/char/%u:%u", major(devnr
), minor(devnr
));
1016 k
= readlink_malloc(fn
, &s
);
1022 /* This is an ugly hack */
1023 if (major(devnr
) == 136) {
1024 if (asprintf(&b
, "pts/%u", minor(devnr
)) < 0)
1027 /* Probably something like the ptys which have no
1028 * symlink in /dev/char. Let's return something
1029 * vaguely useful. */
1036 if (startswith(s
, "/dev/"))
1038 else if (startswith(s
, "../"))
1055 int ptsname_malloc(int fd
, char **ret
) {
1068 if (ptsname_r(fd
, c
, l
) == 0) {
1072 if (errno
!= ERANGE
) {
1082 int ptsname_namespace(int pty
, char **ret
) {
1085 /* Like ptsname(), but doesn't assume that the path is
1086 * accessible in the local namespace. */
1088 r
= ioctl(pty
, TIOCGPTN
, &no
);
1095 if (asprintf(ret
, "/dev/pts/%i", no
) < 0)
1101 int openpt_in_namespace(pid_t pid
, int flags
) {
1102 _cleanup_close_
int pidnsfd
= -1, mntnsfd
= -1, usernsfd
= -1, rootfd
= -1;
1103 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1110 r
= namespace_open(pid
, &pidnsfd
, &mntnsfd
, NULL
, &usernsfd
, &rootfd
);
1114 if (socketpair(AF_UNIX
, SOCK_DGRAM
, 0, pair
) < 0)
1124 pair
[0] = safe_close(pair
[0]);
1126 r
= namespace_enter(pidnsfd
, mntnsfd
, -1, usernsfd
, rootfd
);
1128 _exit(EXIT_FAILURE
);
1130 master
= posix_openpt(flags
|O_NOCTTY
|O_CLOEXEC
);
1132 _exit(EXIT_FAILURE
);
1134 if (unlockpt(master
) < 0)
1135 _exit(EXIT_FAILURE
);
1137 if (send_one_fd(pair
[1], master
, 0) < 0)
1138 _exit(EXIT_FAILURE
);
1140 _exit(EXIT_SUCCESS
);
1143 pair
[1] = safe_close(pair
[1]);
1145 r
= wait_for_terminate(child
, &si
);
1148 if (si
.si_code
!= CLD_EXITED
|| si
.si_status
!= EXIT_SUCCESS
)
1151 return receive_one_fd(pair
[0], 0);
1154 int open_terminal_in_namespace(pid_t pid
, const char *name
, int mode
) {
1155 _cleanup_close_
int pidnsfd
= -1, mntnsfd
= -1, usernsfd
= -1, rootfd
= -1;
1156 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1161 r
= namespace_open(pid
, &pidnsfd
, &mntnsfd
, NULL
, &usernsfd
, &rootfd
);
1165 if (socketpair(AF_UNIX
, SOCK_DGRAM
, 0, pair
) < 0)
1175 pair
[0] = safe_close(pair
[0]);
1177 r
= namespace_enter(pidnsfd
, mntnsfd
, -1, usernsfd
, rootfd
);
1179 _exit(EXIT_FAILURE
);
1181 master
= open_terminal(name
, mode
|O_NOCTTY
|O_CLOEXEC
);
1183 _exit(EXIT_FAILURE
);
1185 if (send_one_fd(pair
[1], master
, 0) < 0)
1186 _exit(EXIT_FAILURE
);
1188 _exit(EXIT_SUCCESS
);
1191 pair
[1] = safe_close(pair
[1]);
1193 r
= wait_for_terminate(child
, &si
);
1196 if (si
.si_code
!= CLD_EXITED
|| si
.si_status
!= EXIT_SUCCESS
)
1199 return receive_one_fd(pair
[0], 0);