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>
36 #include "path-util.h"
37 #include "process-util.h"
38 #include "string-util.h"
39 #include "terminal-util.h"
40 #include "time-util.h"
43 static volatile unsigned cached_columns
= 0;
44 static volatile unsigned cached_lines
= 0;
47 _cleanup_close_
int fd
;
49 fd
= open_terminal("/dev/tty0", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
55 TIOCL_GETKMSGREDIRECT
,
59 if (ioctl(fd
, TIOCLINUX
, tiocl
) < 0)
62 vt
= tiocl
[0] <= 0 ? 1 : tiocl
[0];
65 if (ioctl(fd
, VT_ACTIVATE
, vt
) < 0)
71 int read_one_char(FILE *f
, char *ret
, usec_t t
, bool *need_nl
) {
72 struct termios old_termios
, new_termios
;
73 char c
, line
[LINE_MAX
];
78 if (tcgetattr(fileno(f
), &old_termios
) >= 0) {
79 new_termios
= old_termios
;
81 new_termios
.c_lflag
&= ~ICANON
;
82 new_termios
.c_cc
[VMIN
] = 1;
83 new_termios
.c_cc
[VTIME
] = 0;
85 if (tcsetattr(fileno(f
), TCSADRAIN
, &new_termios
) >= 0) {
88 if (t
!= USEC_INFINITY
) {
89 if (fd_wait_for_event(fileno(f
), POLLIN
, t
) <= 0) {
90 tcsetattr(fileno(f
), TCSADRAIN
, &old_termios
);
95 k
= fread(&c
, 1, 1, f
);
97 tcsetattr(fileno(f
), TCSADRAIN
, &old_termios
);
103 *need_nl
= c
!= '\n';
110 if (t
!= USEC_INFINITY
) {
111 if (fd_wait_for_event(fileno(f
), POLLIN
, t
) <= 0)
116 if (!fgets(line
, sizeof(line
), f
))
117 return errno
? -errno
: -EIO
;
121 if (strlen(line
) != 1)
131 int ask_char(char *ret
, const char *replies
, const char *text
, ...) {
144 fputs(ANSI_HIGHLIGHT
, stdout
);
151 fputs(ANSI_NORMAL
, stdout
);
155 r
= read_one_char(stdin
, &c
, USEC_INFINITY
, &need_nl
);
159 puts("Bad input, please try again.");
170 if (strchr(replies
, c
)) {
175 puts("Read unexpected character, please try again.");
179 int ask_string(char **ret
, const char *text
, ...) {
188 fputs(ANSI_HIGHLIGHT
, stdout
);
195 fputs(ANSI_NORMAL
, stdout
);
200 if (!fgets(line
, sizeof(line
), stdin
))
201 return errno
? -errno
: -EIO
;
203 if (!endswith(line
, "\n"))
222 int reset_terminal_fd(int fd
, bool switch_to_text
) {
223 struct termios termios
;
226 /* Set terminal to some sane defaults */
230 /* We leave locked terminal attributes untouched, so that
231 * Plymouth may set whatever it wants to set, and we don't
232 * interfere with that. */
234 /* Disable exclusive mode, just in case */
235 (void) ioctl(fd
, TIOCNXCL
);
237 /* Switch to text mode */
239 (void) ioctl(fd
, KDSETMODE
, KD_TEXT
);
241 /* Enable console unicode mode */
242 (void) ioctl(fd
, KDSKBMODE
, K_UNICODE
);
244 if (tcgetattr(fd
, &termios
) < 0) {
249 /* We only reset the stuff that matters to the software. How
250 * hardware is set up we don't touch assuming that somebody
251 * else will do that for us */
253 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| ISTRIP
| INLCR
| IGNCR
| IUCLC
);
254 termios
.c_iflag
|= ICRNL
| IMAXBEL
| IUTF8
;
255 termios
.c_oflag
|= ONLCR
;
256 termios
.c_cflag
|= CREAD
;
257 termios
.c_lflag
= ISIG
| ICANON
| IEXTEN
| ECHO
| ECHOE
| ECHOK
| ECHOCTL
| ECHOPRT
| ECHOKE
;
259 termios
.c_cc
[VINTR
] = 03; /* ^C */
260 termios
.c_cc
[VQUIT
] = 034; /* ^\ */
261 termios
.c_cc
[VERASE
] = 0177;
262 termios
.c_cc
[VKILL
] = 025; /* ^X */
263 termios
.c_cc
[VEOF
] = 04; /* ^D */
264 termios
.c_cc
[VSTART
] = 021; /* ^Q */
265 termios
.c_cc
[VSTOP
] = 023; /* ^S */
266 termios
.c_cc
[VSUSP
] = 032; /* ^Z */
267 termios
.c_cc
[VLNEXT
] = 026; /* ^V */
268 termios
.c_cc
[VWERASE
] = 027; /* ^W */
269 termios
.c_cc
[VREPRINT
] = 022; /* ^R */
270 termios
.c_cc
[VEOL
] = 0;
271 termios
.c_cc
[VEOL2
] = 0;
273 termios
.c_cc
[VTIME
] = 0;
274 termios
.c_cc
[VMIN
] = 1;
276 if (tcsetattr(fd
, TCSANOW
, &termios
) < 0)
280 /* Just in case, flush all crap out */
281 (void) tcflush(fd
, TCIOFLUSH
);
286 int reset_terminal(const char *name
) {
287 _cleanup_close_
int fd
= -1;
289 /* We open the terminal with O_NONBLOCK here, to ensure we
290 * don't block on carrier if this is a terminal with carrier
293 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
297 return reset_terminal_fd(fd
, true);
300 int open_terminal(const char *name
, int mode
) {
305 * If a TTY is in the process of being closed opening it might
306 * cause EIO. This is horribly awful, but unlikely to be
307 * changed in the kernel. Hence we work around this problem by
308 * retrying a couple of times.
310 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/554172/comments/245
317 fd
= open(name
, mode
, 0);
324 /* Max 1s in total */
328 usleep(50 * USEC_PER_MSEC
);
346 int acquire_terminal(
350 bool ignore_tiocstty_eperm
,
353 int fd
= -1, notify
= -1, r
= 0, wd
= -1;
358 /* We use inotify to be notified when the tty is closed. We
359 * create the watch before checking if we can actually acquire
360 * it, so that we don't lose any event.
362 * Note: strictly speaking this actually watches for the
363 * device being closed, it does *not* really watch whether a
364 * tty loses its controlling process. However, unless some
365 * rogue process uses TIOCNOTTY on /dev/tty *after* closing
366 * its tty otherwise this will not become a problem. As long
367 * as the administrator makes sure not configure any service
368 * on the same tty as an untrusted user this should not be a
369 * problem. (Which he probably should not do anyway.) */
371 if (timeout
!= USEC_INFINITY
)
372 ts
= now(CLOCK_MONOTONIC
);
374 if (!fail
&& !force
) {
375 notify
= inotify_init1(IN_CLOEXEC
| (timeout
!= USEC_INFINITY
? IN_NONBLOCK
: 0));
381 wd
= inotify_add_watch(notify
, name
, IN_CLOSE
);
389 struct sigaction sa_old
, sa_new
= {
390 .sa_handler
= SIG_IGN
,
391 .sa_flags
= SA_RESTART
,
395 r
= flush_fd(notify
);
400 /* We pass here O_NOCTTY only so that we can check the return
401 * value TIOCSCTTY and have a reliable way to figure out if we
402 * successfully became the controlling process of the tty */
403 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
407 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
408 * if we already own the tty. */
409 assert_se(sigaction(SIGHUP
, &sa_new
, &sa_old
) == 0);
411 /* First, try to get the tty */
412 if (ioctl(fd
, TIOCSCTTY
, force
) < 0)
415 assert_se(sigaction(SIGHUP
, &sa_old
, NULL
) == 0);
417 /* Sometimes it makes sense to ignore TIOCSCTTY
418 * returning EPERM, i.e. when very likely we already
419 * are have this controlling terminal. */
420 if (r
< 0 && r
== -EPERM
&& ignore_tiocstty_eperm
)
423 if (r
< 0 && (force
|| fail
|| r
!= -EPERM
))
434 union inotify_event_buffer buffer
;
435 struct inotify_event
*e
;
438 if (timeout
!= USEC_INFINITY
) {
441 n
= now(CLOCK_MONOTONIC
);
442 if (ts
+ timeout
< n
) {
447 r
= fd_wait_for_event(fd
, POLLIN
, ts
+ timeout
- n
);
457 l
= read(notify
, &buffer
, sizeof(buffer
));
459 if (errno
== EINTR
|| errno
== EAGAIN
)
466 FOREACH_INOTIFY_EVENT(e
, buffer
, l
) {
467 if (e
->wd
!= wd
|| !(e
->mask
& IN_CLOSE
)) {
476 /* We close the tty fd here since if the old session
477 * ended our handle will be dead. It's important that
478 * we do this after sleeping, so that we don't enter
479 * an endless loop. */
494 int release_terminal(void) {
495 static const struct sigaction sa_new
= {
496 .sa_handler
= SIG_IGN
,
497 .sa_flags
= SA_RESTART
,
500 _cleanup_close_
int fd
= -1;
501 struct sigaction sa_old
;
504 fd
= open("/dev/tty", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
508 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
509 * by our own TIOCNOTTY */
510 assert_se(sigaction(SIGHUP
, &sa_new
, &sa_old
) == 0);
512 if (ioctl(fd
, TIOCNOTTY
) < 0)
515 assert_se(sigaction(SIGHUP
, &sa_old
, NULL
) == 0);
520 int terminal_vhangup_fd(int fd
) {
523 if (ioctl(fd
, TIOCVHANGUP
) < 0)
529 int terminal_vhangup(const char *name
) {
530 _cleanup_close_
int fd
;
532 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
536 return terminal_vhangup_fd(fd
);
539 int vt_disallocate(const char *name
) {
540 _cleanup_close_
int fd
= -1;
544 /* Deallocate the VT if possible. If not possible
545 * (i.e. because it is the active one), at least clear it
546 * entirely (including the scrollback buffer) */
548 if (!startswith(name
, "/dev/"))
551 if (!tty_is_vc(name
)) {
552 /* So this is not a VT. I guess we cannot deallocate
553 * it then. But let's at least clear the screen */
555 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
560 "\033[r" /* clear scrolling region */
561 "\033[H" /* move home */
562 "\033[2J", /* clear screen */
567 if (!startswith(name
, "/dev/tty"))
570 r
= safe_atou(name
+8, &u
);
577 /* Try to deallocate */
578 fd
= open_terminal("/dev/tty0", O_RDWR
|O_NOCTTY
|O_CLOEXEC
|O_NONBLOCK
);
582 r
= ioctl(fd
, VT_DISALLOCATE
, u
);
591 /* Couldn't deallocate, so let's clear it fully with
593 fd
= open_terminal(name
, O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
598 "\033[r" /* clear scrolling region */
599 "\033[H" /* move home */
600 "\033[3J", /* clear screen including scrollback, requires Linux 2.6.40 */
605 int make_console_stdio(void) {
608 /* Make /dev/console the controlling terminal and stdin/stdout/stderr */
610 fd
= acquire_terminal("/dev/console", false, true, true, USEC_INFINITY
);
612 return log_error_errno(fd
, "Failed to acquire terminal: %m");
614 r
= reset_terminal_fd(fd
, true);
616 log_warning_errno(r
, "Failed to reset terminal, ignoring: %m");
620 return log_error_errno(r
, "Failed to duplicate terminal fd: %m");
625 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) {
626 static const char status_indent
[] = " "; /* "[" STATUS "] " */
627 _cleanup_free_
char *s
= NULL
;
628 _cleanup_close_
int fd
= -1;
629 struct iovec iovec
[6] = {};
631 static bool prev_ephemeral
;
635 /* This is independent of logging, as status messages are
636 * optional and go exclusively to the console. */
638 if (vasprintf(&s
, format
, ap
) < 0)
641 fd
= open_terminal("/dev/console", O_WRONLY
|O_NOCTTY
|O_CLOEXEC
);
654 sl
= status
? sizeof(status_indent
)-1 : 0;
660 e
= ellipsize(s
, emax
, 50);
668 IOVEC_SET_STRING(iovec
[n
++], "\r" ANSI_ERASE_TO_END_OF_LINE
);
669 prev_ephemeral
= ephemeral
;
672 if (!isempty(status
)) {
673 IOVEC_SET_STRING(iovec
[n
++], "[");
674 IOVEC_SET_STRING(iovec
[n
++], status
);
675 IOVEC_SET_STRING(iovec
[n
++], "] ");
677 IOVEC_SET_STRING(iovec
[n
++], status_indent
);
680 IOVEC_SET_STRING(iovec
[n
++], s
);
682 IOVEC_SET_STRING(iovec
[n
++], "\n");
684 if (writev(fd
, iovec
, n
) < 0)
690 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) {
696 va_start(ap
, format
);
697 r
= status_vprintf(status
, ellipse
, ephemeral
, format
, ap
);
703 bool tty_is_vc(const char *tty
) {
706 return vtnr_from_tty(tty
) >= 0;
709 bool tty_is_console(const char *tty
) {
712 if (startswith(tty
, "/dev/"))
715 return streq(tty
, "console");
718 int vtnr_from_tty(const char *tty
) {
723 if (startswith(tty
, "/dev/"))
726 if (!startswith(tty
, "tty") )
729 if (tty
[3] < '0' || tty
[3] > '9')
732 r
= safe_atoi(tty
+3, &i
);
742 char *resolve_dev_console(char **active
) {
745 /* Resolve where /dev/console is pointing to, if /sys is actually ours
746 * (i.e. not read-only-mounted which is a sign for container setups) */
748 if (path_is_read_only_fs("/sys") > 0)
751 if (read_one_line_file("/sys/class/tty/console/active", active
) < 0)
754 /* If multiple log outputs are configured the last one is what
755 * /dev/console points to */
756 tty
= strrchr(*active
, ' ');
762 if (streq(tty
, "tty0")) {
765 /* Get the active VC (e.g. tty1) */
766 if (read_one_line_file("/sys/class/tty/tty0/active", &tmp
) >= 0) {
775 bool tty_is_vc_resolve(const char *tty
) {
776 _cleanup_free_
char *active
= NULL
;
780 if (startswith(tty
, "/dev/"))
783 if (streq(tty
, "console")) {
784 tty
= resolve_dev_console(&active
);
789 return tty_is_vc(tty
);
792 const char *default_term_for_tty(const char *tty
) {
795 return tty_is_vc_resolve(tty
) ? "TERM=linux" : "TERM=vt220";
798 int fd_columns(int fd
) {
799 struct winsize ws
= {};
801 if (ioctl(fd
, TIOCGWINSZ
, &ws
) < 0)
810 unsigned columns(void) {
814 if (_likely_(cached_columns
> 0))
815 return cached_columns
;
818 e
= getenv("COLUMNS");
820 (void) safe_atoi(e
, &c
);
823 c
= fd_columns(STDOUT_FILENO
);
829 return cached_columns
;
832 int fd_lines(int fd
) {
833 struct winsize ws
= {};
835 if (ioctl(fd
, TIOCGWINSZ
, &ws
) < 0)
844 unsigned lines(void) {
848 if (_likely_(cached_lines
> 0))
854 (void) safe_atoi(e
, &l
);
857 l
= fd_lines(STDOUT_FILENO
);
866 /* intended to be used as a SIGWINCH sighandler */
867 void columns_lines_cache_reset(int signum
) {
873 static int cached_on_tty
= -1;
875 if (_unlikely_(cached_on_tty
< 0))
876 cached_on_tty
= isatty(STDOUT_FILENO
) > 0;
878 return cached_on_tty
;
881 int make_stdio(int fd
) {
886 r
= dup2(fd
, STDIN_FILENO
);
887 s
= dup2(fd
, STDOUT_FILENO
);
888 t
= dup2(fd
, STDERR_FILENO
);
893 if (r
< 0 || s
< 0 || t
< 0)
896 /* Explicitly unset O_CLOEXEC, since if fd was < 3, then
897 * dup2() was a NOP and the bit hence possibly set. */
898 fd_cloexec(STDIN_FILENO
, false);
899 fd_cloexec(STDOUT_FILENO
, false);
900 fd_cloexec(STDERR_FILENO
, false);
905 int make_null_stdio(void) {
908 null_fd
= open("/dev/null", O_RDWR
|O_NOCTTY
);
912 return make_stdio(null_fd
);
915 int getttyname_malloc(int fd
, char **ret
) {
925 r
= ttyname_r(fd
, path
, sizeof(path
));
930 p
= startswith(path
, "/dev/");
931 c
= strdup(p
?: path
);
948 int getttyname_harder(int fd
, char **r
) {
952 k
= getttyname_malloc(fd
, &s
);
956 if (streq(s
, "tty")) {
958 return get_ctty(0, NULL
, r
);
965 int get_ctty_devnr(pid_t pid
, dev_t
*d
) {
967 _cleanup_free_
char *line
= NULL
;
973 p
= procfs_file_alloca(pid
, "stat");
974 r
= read_one_line_file(p
, &line
);
978 p
= strrchr(line
, ')');
993 if (major(ttynr
) == 0 && minor(ttynr
) == 0)
1002 int get_ctty(pid_t pid
, dev_t
*_devnr
, char **r
) {
1003 char fn
[sizeof("/dev/char/")-1 + 2*DECIMAL_STR_MAX(unsigned) + 1 + 1], *b
= NULL
;
1004 _cleanup_free_
char *s
= NULL
;
1011 k
= get_ctty_devnr(pid
, &devnr
);
1015 sprintf(fn
, "/dev/char/%u:%u", major(devnr
), minor(devnr
));
1017 k
= readlink_malloc(fn
, &s
);
1023 /* This is an ugly hack */
1024 if (major(devnr
) == 136) {
1025 if (asprintf(&b
, "pts/%u", minor(devnr
)) < 0)
1028 /* Probably something like the ptys which have no
1029 * symlink in /dev/char. Let's return something
1030 * vaguely useful. */
1037 if (startswith(s
, "/dev/"))
1039 else if (startswith(s
, "../"))
1056 int ptsname_malloc(int fd
, char **ret
) {
1069 if (ptsname_r(fd
, c
, l
) == 0) {
1073 if (errno
!= ERANGE
) {
1083 int ptsname_namespace(int pty
, char **ret
) {
1086 /* Like ptsname(), but doesn't assume that the path is
1087 * accessible in the local namespace. */
1089 r
= ioctl(pty
, TIOCGPTN
, &no
);
1096 if (asprintf(ret
, "/dev/pts/%i", no
) < 0)
1102 int openpt_in_namespace(pid_t pid
, int flags
) {
1103 _cleanup_close_
int pidnsfd
= -1, mntnsfd
= -1, usernsfd
= -1, rootfd
= -1;
1104 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1111 r
= namespace_open(pid
, &pidnsfd
, &mntnsfd
, NULL
, &usernsfd
, &rootfd
);
1115 if (socketpair(AF_UNIX
, SOCK_DGRAM
, 0, pair
) < 0)
1125 pair
[0] = safe_close(pair
[0]);
1127 r
= namespace_enter(pidnsfd
, mntnsfd
, -1, usernsfd
, rootfd
);
1129 _exit(EXIT_FAILURE
);
1131 master
= posix_openpt(flags
|O_NOCTTY
|O_CLOEXEC
);
1133 _exit(EXIT_FAILURE
);
1135 if (unlockpt(master
) < 0)
1136 _exit(EXIT_FAILURE
);
1138 if (send_one_fd(pair
[1], master
, 0) < 0)
1139 _exit(EXIT_FAILURE
);
1141 _exit(EXIT_SUCCESS
);
1144 pair
[1] = safe_close(pair
[1]);
1146 r
= wait_for_terminate(child
, &si
);
1149 if (si
.si_code
!= CLD_EXITED
|| si
.si_status
!= EXIT_SUCCESS
)
1152 return receive_one_fd(pair
[0], 0);
1155 int open_terminal_in_namespace(pid_t pid
, const char *name
, int mode
) {
1156 _cleanup_close_
int pidnsfd
= -1, mntnsfd
= -1, usernsfd
= -1, rootfd
= -1;
1157 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1162 r
= namespace_open(pid
, &pidnsfd
, &mntnsfd
, NULL
, &usernsfd
, &rootfd
);
1166 if (socketpair(AF_UNIX
, SOCK_DGRAM
, 0, pair
) < 0)
1176 pair
[0] = safe_close(pair
[0]);
1178 r
= namespace_enter(pidnsfd
, mntnsfd
, -1, usernsfd
, rootfd
);
1180 _exit(EXIT_FAILURE
);
1182 master
= open_terminal(name
, mode
|O_NOCTTY
|O_CLOEXEC
);
1184 _exit(EXIT_FAILURE
);
1186 if (send_one_fd(pair
[1], master
, 0) < 0)
1187 _exit(EXIT_FAILURE
);
1189 _exit(EXIT_SUCCESS
);
1192 pair
[1] = safe_close(pair
[1]);
1194 r
= wait_for_terminate(child
, &si
);
1197 if (si
.si_code
!= CLD_EXITED
|| si
.si_status
!= EXIT_SUCCESS
)
1200 return receive_one_fd(pair
[0], 0);