src/basic/terminal-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <errno.h>
   4 #include <fcntl.h>
   5 #include <limits.h>
   6 #include <linux/kd.h>
   7 #include <linux/tiocl.h>
   8 #include <linux/vt.h>
   9 #include <poll.h>
  10 #include <signal.h>
  11 #include <stdarg.h>
  12 #include <stddef.h>
  13 #include <stdlib.h>
  14 #include <sys/inotify.h>
  15 #include <sys/ioctl.h>
  16 #include <sys/sysmacros.h>
  17 #include <sys/time.h>
  18 #include <sys/types.h>
  19 #include <sys/utsname.h>
  20 #include <termios.h>
  21 #include <unistd.h>
  22
  23 #include "alloc-util.h"
  24 #include "def.h"
  25 #include "env-util.h"
  26 #include "fd-util.h"
  27 #include "fileio.h"
  28 #include "fs-util.h"
  29 #include "inotify-util.h"
  30 #include "io-util.h"
  31 #include "log.h"
  32 #include "macro.h"
  33 #include "namespace-util.h"
  34 #include "parse-util.h"
  35 #include "path-util.h"
  36 #include "proc-cmdline.h"
  37 #include "process-util.h"
  38 #include "socket-util.h"
  39 #include "stat-util.h"
  40 #include "stdio-util.h"
  41 #include "string-util.h"
  42 #include "strv.h"
  43 #include "terminal-util.h"
  44 #include "time-util.h"
  45 #include "user-util.h"
  46 #include "util.h"
  47
  48 static volatile unsigned cached_columns = 0;
  49 static volatile unsigned cached_lines = 0;
  50
  51 static volatile int cached_on_tty = -1;
  52 static volatile int cached_color_mode = _COLOR_INVALID;
  53 static volatile int cached_underline_enabled = -1;
  54
  55 int chvt(int vt) {
  56         _cleanup_close_ int fd = -1;
  57
  58         /* Switch to the specified vt number. If the VT is specified <= 0 switch to the VT the kernel log messages go,
  59          * if that's configured. */
  60
  61         fd = open_terminal("/dev/tty0", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
  62         if (fd < 0)
  63                 return -errno;
  64
  65         if (vt <= 0) {
  66                 int tiocl[2] = {
  67                         TIOCL_GETKMSGREDIRECT,
  68                         0
  69                 };
  70
  71                 if (ioctl(fd, TIOCLINUX, tiocl) < 0)
  72                         return -errno;
  73
  74                 vt = tiocl[0] <= 0 ? 1 : tiocl[0];
  75         }
  76
  77         if (ioctl(fd, VT_ACTIVATE, vt) < 0)
  78                 return -errno;
  79
  80         return 0;
  81 }
  82
  83 int read_one_char(FILE *f, char *ret, usec_t t, bool *need_nl) {
  84         _cleanup_free_ char *line = NULL;
  85         struct termios old_termios;
  86         int r, fd;
  87
  88         assert(f);
  89         assert(ret);
  90
  91         /* If this is a terminal, then switch canonical mode off, so that we can read a single
  92          * character. (Note that fmemopen() streams do not have an fd associated with them, let's handle that
  93          * nicely.) */
  94         fd = fileno(f);
  95         if (fd >= 0 && tcgetattr(fd, &old_termios) >= 0) {
  96                 struct termios new_termios = old_termios;
  97
  98                 new_termios.c_lflag &= ~ICANON;
  99                 new_termios.c_cc[VMIN] = 1;
 100                 new_termios.c_cc[VTIME] = 0;
 101
 102                 if (tcsetattr(fd, TCSADRAIN, &new_termios) >= 0) {
 103                         char c;
 104
 105                         if (t != USEC_INFINITY) {
 106                                 if (fd_wait_for_event(fd, POLLIN, t) <= 0) {
 107                                         (void) tcsetattr(fd, TCSADRAIN, &old_termios);
 108                                         return -ETIMEDOUT;
 109                                 }
 110                         }
 111
 112                         r = safe_fgetc(f, &c);
 113                         (void) tcsetattr(fd, TCSADRAIN, &old_termios);
 114                         if (r < 0)
 115                                 return r;
 116                         if (r == 0)
 117                                 return -EIO;
 118
 119                         if (need_nl)
 120                                 *need_nl = c != '\n';
 121
 122                         *ret = c;
 123                         return 0;
 124                 }
 125         }
 126
 127         if (t != USEC_INFINITY && fd > 0) {
 128                 /* Let's wait the specified amount of time for input. When we have no fd we skip this, under
 129                  * the assumption that this is an fmemopen() stream or so where waiting doesn't make sense
 130                  * anyway, as the data is either already in the stream or cannot possible be placed there
 131                  * while we access the stream */
 132
 133                 if (fd_wait_for_event(fd, POLLIN, t) <= 0)
 134                         return -ETIMEDOUT;
 135         }
 136
 137         /* If this is not a terminal, then read a full line instead */
 138
 139         r = read_line(f, 16, &line); /* longer than necessary, to eat up UTF-8 chars/vt100 key sequences */
 140         if (r < 0)
 141                 return r;
 142         if (r == 0)
 143                 return -EIO;
 144
 145         if (strlen(line) != 1)
 146                 return -EBADMSG;
 147
 148         if (need_nl)
 149                 *need_nl = false;
 150
 151         *ret = line[0];
 152         return 0;
 153 }
 154
 155 #define DEFAULT_ASK_REFRESH_USEC (2*USEC_PER_SEC)
 156
 157 int ask_char(char *ret, const char *replies, const char *fmt, ...) {
 158         int r;
 159
 160         assert(ret);
 161         assert(replies);
 162         assert(fmt);
 163
 164         for (;;) {
 165                 va_list ap;
 166                 char c;
 167                 bool need_nl = true;
 168
 169                 fputs(ansi_highlight(), stdout);
 170
 171                 putchar('\r');
 172
 173                 va_start(ap, fmt);
 174                 vprintf(fmt, ap);
 175                 va_end(ap);
 176
 177                 fputs(ansi_normal(), stdout);
 178
 179                 fflush(stdout);
 180
 181                 r = read_one_char(stdin, &c, DEFAULT_ASK_REFRESH_USEC, &need_nl);
 182                 if (r < 0) {
 183
 184                         if (r == -ETIMEDOUT)
 185                                 continue;
 186
 187                         if (r == -EBADMSG) {
 188                                 puts("Bad input, please try again.");
 189                                 continue;
 190                         }
 191
 192                         putchar('\n');
 193                         return r;
 194                 }
 195
 196                 if (need_nl)
 197                         putchar('\n');
 198
 199                 if (strchr(replies, c)) {
 200                         *ret = c;
 201                         return 0;
 202                 }
 203
 204                 puts("Read unexpected character, please try again.");
 205         }
 206 }
 207
 208 int ask_string(char **ret, const char *text, ...) {
 209         _cleanup_free_ char *line = NULL;
 210         va_list ap;
 211         int r;
 212
 213         assert(ret);
 214         assert(text);
 215
 216         fputs(ansi_highlight(), stdout);
 217
 218         va_start(ap, text);
 219         vprintf(text, ap);
 220         va_end(ap);
 221
 222         fputs(ansi_normal(), stdout);
 223
 224         fflush(stdout);
 225
 226         r = read_line(stdin, LONG_LINE_MAX, &line);
 227         if (r < 0)
 228                 return r;
 229         if (r == 0)
 230                 return -EIO;
 231
 232         *ret = TAKE_PTR(line);
 233         return 0;
 234 }
 235
 236 int reset_terminal_fd(int fd, bool switch_to_text) {
 237         struct termios termios;
 238         int r = 0;
 239
 240         /* Set terminal to some sane defaults */
 241
 242         assert(fd >= 0);
 243
 244         if (isatty(fd) < 1)
 245                 return log_debug_errno(errno, "Asked to reset a terminal that actually isn't a terminal: %m");
 246
 247         /* We leave locked terminal attributes untouched, so that Plymouth may set whatever it wants to set,
 248          * and we don't interfere with that. */
 249
 250         /* Disable exclusive mode, just in case */
 251         if (ioctl(fd, TIOCNXCL) < 0)
 252                 log_debug_errno(errno, "TIOCNXCL ioctl failed on TTY, ignoring: %m");
 253
 254         /* Switch to text mode */
 255         if (switch_to_text)
 256                 if (ioctl(fd, KDSETMODE, KD_TEXT) < 0)
 257                         log_debug_errno(errno, "KDSETMODE ioctl for switching to text mode failed on TTY, ignoring: %m");
 258
 259
 260         /* Set default keyboard mode */
 261         (void) vt_reset_keyboard(fd);
 262
 263         if (tcgetattr(fd, &termios) < 0) {
 264                 r = log_debug_errno(errno, "Failed to get terminal parameters: %m");
 265                 goto finish;
 266         }
 267
 268         /* We only reset the stuff that matters to the software. How
 269          * hardware is set up we don't touch assuming that somebody
 270          * else will do that for us */
 271
 272         termios.c_iflag &= ~(IGNBRK | BRKINT | ISTRIP | INLCR | IGNCR | IUCLC);
 273         termios.c_iflag |= ICRNL | IMAXBEL | IUTF8;
 274         termios.c_oflag |= ONLCR;
 275         termios.c_cflag |= CREAD;
 276         termios.c_lflag = ISIG | ICANON | IEXTEN | ECHO | ECHOE | ECHOK | ECHOCTL | ECHOPRT | ECHOKE;
 277
 278         termios.c_cc[VINTR]    =   03;  /* ^C */
 279         termios.c_cc[VQUIT]    =  034;  /* ^\ */
 280         termios.c_cc[VERASE]   = 0177;
 281         termios.c_cc[VKILL]    =  025;  /* ^X */
 282         termios.c_cc[VEOF]     =   04;  /* ^D */
 283         termios.c_cc[VSTART]   =  021;  /* ^Q */
 284         termios.c_cc[VSTOP]    =  023;  /* ^S */
 285         termios.c_cc[VSUSP]    =  032;  /* ^Z */
 286         termios.c_cc[VLNEXT]   =  026;  /* ^V */
 287         termios.c_cc[VWERASE]  =  027;  /* ^W */
 288         termios.c_cc[VREPRINT] =  022;  /* ^R */
 289         termios.c_cc[VEOL]     =    0;
 290         termios.c_cc[VEOL2]    =    0;
 291
 292         termios.c_cc[VTIME]  = 0;
 293         termios.c_cc[VMIN]   = 1;
 294
 295         if (tcsetattr(fd, TCSANOW, &termios) < 0)
 296                 r = -errno;
 297
 298 finish:
 299         /* Just in case, flush all crap out */
 300         (void) tcflush(fd, TCIOFLUSH);
 301
 302         return r;
 303 }
 304
 305 int reset_terminal(const char *name) {
 306         _cleanup_close_ int fd = -1;
 307
 308         /* We open the terminal with O_NONBLOCK here, to ensure we
 309          * don't block on carrier if this is a terminal with carrier
 310          * configured. */
 311
 312         fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
 313         if (fd < 0)
 314                 return fd;
 315
 316         return reset_terminal_fd(fd, true);
 317 }
 318
 319 int open_terminal(const char *name, int mode) {
 320         _cleanup_close_ int fd = -1;
 321         unsigned c = 0;
 322
 323         /*
 324          * If a TTY is in the process of being closed opening it might cause EIO. This is horribly awful, but
 325          * unlikely to be changed in the kernel. Hence we work around this problem by retrying a couple of
 326          * times.
 327          *
 328          * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/554172/comments/245
 329          */
 330
 331         if (mode & O_CREAT)
 332                 return -EINVAL;
 333
 334         for (;;) {
 335                 fd = open(name, mode, 0);
 336                 if (fd >= 0)
 337                         break;
 338
 339                 if (errno != EIO)
 340                         return -errno;
 341
 342                 /* Max 1s in total */
 343                 if (c >= 20)
 344                         return -errno;
 345
 346                 (void) usleep(50 * USEC_PER_MSEC);
 347                 c++;
 348         }
 349
 350         if (isatty(fd) < 1)
 351                 return negative_errno();
 352
 353         return TAKE_FD(fd);
 354 }
 355
 356 int acquire_terminal(
 357                 const char *name,
 358                 AcquireTerminalFlags flags,
 359                 usec_t timeout) {
 360
 361         _cleanup_close_ int notify = -1, fd = -1;
 362         usec_t ts = USEC_INFINITY;
 363         int r, wd = -1;
 364
 365         assert(name);
 366         assert(IN_SET(flags & ~ACQUIRE_TERMINAL_PERMISSIVE, ACQUIRE_TERMINAL_TRY, ACQUIRE_TERMINAL_FORCE, ACQUIRE_TERMINAL_WAIT));
 367
 368         /* We use inotify to be notified when the tty is closed. We create the watch before checking if we can actually
 369          * acquire it, so that we don't lose any event.
 370          *
 371          * Note: strictly speaking this actually watches for the device being closed, it does *not* really watch
 372          * whether a tty loses its controlling process. However, unless some rogue process uses TIOCNOTTY on /dev/tty
 373          * *after* closing its tty otherwise this will not become a problem. As long as the administrator makes sure to
 374          * not configure any service on the same tty as an untrusted user this should not be a problem. (Which they
 375          * probably should not do anyway.) */
 376
 377         if ((flags & ~ACQUIRE_TERMINAL_PERMISSIVE) == ACQUIRE_TERMINAL_WAIT) {
 378                 notify = inotify_init1(IN_CLOEXEC | (timeout != USEC_INFINITY ? IN_NONBLOCK : 0));
 379                 if (notify < 0)
 380                         return -errno;
 381
 382                 wd = inotify_add_watch(notify, name, IN_CLOSE);
 383                 if (wd < 0)
 384                         return -errno;
 385
 386                 if (timeout != USEC_INFINITY)
 387                         ts = now(CLOCK_MONOTONIC);
 388         }
 389
 390         for (;;) {
 391                 struct sigaction sa_old, sa_new = {
 392                         .sa_handler = SIG_IGN,
 393                         .sa_flags = SA_RESTART,
 394                 };
 395
 396                 if (notify >= 0) {
 397                         r = flush_fd(notify);
 398                         if (r < 0)
 399                                 return r;
 400                 }
 401
 402                 /* We pass here O_NOCTTY only so that we can check the return value TIOCSCTTY and have a reliable way
 403                  * to figure out if we successfully became the controlling process of the tty */
 404                 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC);
 405                 if (fd < 0)
 406                         return fd;
 407
 408                 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed if we already own the tty. */
 409                 assert_se(sigaction(SIGHUP, &sa_new, &sa_old) == 0);
 410
 411                 /* First, try to get the tty */
 412                 r = ioctl(fd, TIOCSCTTY,
 413                           (flags & ~ACQUIRE_TERMINAL_PERMISSIVE) == ACQUIRE_TERMINAL_FORCE) < 0 ? -errno : 0;
 414
 415                 /* Reset signal handler to old value */
 416                 assert_se(sigaction(SIGHUP, &sa_old, NULL) == 0);
 417
 418                 /* Success? Exit the loop now! */
 419                 if (r >= 0)
 420                         break;
 421
 422                 /* Any failure besides -EPERM? Fail, regardless of the mode. */
 423                 if (r != -EPERM)
 424                         return r;
 425
 426                 if (flags & ACQUIRE_TERMINAL_PERMISSIVE) /* If we are in permissive mode, then EPERM is fine, turn this
 427                                                           * into a success. Note that EPERM is also returned if we
 428                                                           * already are the owner of the TTY. */
 429                         break;
 430
 431                 if (flags != ACQUIRE_TERMINAL_WAIT) /* If we are in TRY or FORCE mode, then propagate EPERM as EPERM */
 432                         return r;
 433
 434                 assert(notify >= 0);
 435                 assert(wd >= 0);
 436
 437                 for (;;) {
 438                         union inotify_event_buffer buffer;
 439                         struct inotify_event *e;
 440                         ssize_t l;
 441
 442                         if (timeout != USEC_INFINITY) {
 443                                 usec_t n;
 444
 445                                 assert(ts != USEC_INFINITY);
 446
 447                                 n = usec_sub_unsigned(now(CLOCK_MONOTONIC), ts);
 448                                 if (n >= timeout)
 449                                         return -ETIMEDOUT;
 450
 451                                 r = fd_wait_for_event(notify, POLLIN, usec_sub_unsigned(timeout, n));
 452                                 if (r < 0)
 453                                         return r;
 454                                 if (r == 0)
 455                                         return -ETIMEDOUT;
 456                         }
 457
 458                         l = read(notify, &buffer, sizeof(buffer));
 459                         if (l < 0) {
 460                                 if (IN_SET(errno, EINTR, EAGAIN))
 461                                         continue;
 462
 463                                 return -errno;
 464                         }
 465
 466                         FOREACH_INOTIFY_EVENT(e, buffer, l) {
 467                                 if (e->mask & IN_Q_OVERFLOW) /* If we hit an inotify queue overflow, simply check if the terminal is up for grabs now. */
 468                                         break;
 469
 470                                 if (e->wd != wd || !(e->mask & IN_CLOSE)) /* Safety checks */
 471                                         return -EIO;
 472                         }
 473
 474                         break;
 475                 }
 476
 477                 /* We close the tty fd here since if the old session ended our handle will be dead. It's important that
 478                  * we do this after sleeping, so that we don't enter an endless loop. */
 479                 fd = safe_close(fd);
 480         }
 481
 482         return TAKE_FD(fd);
 483 }
 484
 485 int release_terminal(void) {
 486         static const struct sigaction sa_new = {
 487                 .sa_handler = SIG_IGN,
 488                 .sa_flags = SA_RESTART,
 489         };
 490
 491         _cleanup_close_ int fd = -1;
 492         struct sigaction sa_old;
 493         int r;
 494
 495         fd = open("/dev/tty", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
 496         if (fd < 0)
 497                 return -errno;
 498
 499         /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
 500          * by our own TIOCNOTTY */
 501         assert_se(sigaction(SIGHUP, &sa_new, &sa_old) == 0);
 502
 503         r = ioctl(fd, TIOCNOTTY) < 0 ? -errno : 0;
 504
 505         assert_se(sigaction(SIGHUP, &sa_old, NULL) == 0);
 506
 507         return r;
 508 }
 509
 510 int terminal_vhangup_fd(int fd) {
 511         assert(fd >= 0);
 512
 513         if (ioctl(fd, TIOCVHANGUP) < 0)
 514                 return -errno;
 515
 516         return 0;
 517 }
 518
 519 int terminal_vhangup(const char *name) {
 520         _cleanup_close_ int fd = -1;
 521
 522         fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
 523         if (fd < 0)
 524                 return fd;
 525
 526         return terminal_vhangup_fd(fd);
 527 }
 528
 529 int vt_disallocate(const char *name) {
 530         const char *e;
 531         int r;
 532
 533         /* Deallocate the VT if possible. If not possible
 534          * (i.e. because it is the active one), at least clear it
 535          * entirely (including the scrollback buffer). */
 536
 537         e = path_startswith(name, "/dev/");
 538         if (!e)
 539                 return -EINVAL;
 540
 541         if (tty_is_vc(name)) {
 542                 _cleanup_close_ int fd = -1;
 543                 unsigned u;
 544                 const char *n;
 545
 546                 n = startswith(e, "tty");
 547                 if (!n)
 548                         return -EINVAL;
 549
 550                 r = safe_atou(n, &u);
 551                 if (r < 0)
 552                         return r;
 553
 554                 if (u <= 0)
 555                         return -EINVAL;
 556
 557                 /* Try to deallocate */
 558                 fd = open_terminal("/dev/tty0", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
 559                 if (fd < 0)
 560                         return fd;
 561
 562                 r = ioctl(fd, VT_DISALLOCATE, u);
 563                 if (r >= 0)
 564                         return 0;
 565                 if (errno != EBUSY)
 566                         return -errno;
 567         }
 568
 569         /* So this is not a VT (in which case we cannot deallocate it),
 570          * or we failed to deallocate. Let's at least clear the screen. */
 571
 572         _cleanup_close_ int fd2 = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC);
 573         if (fd2 < 0)
 574                 return fd2;
 575
 576         (void) loop_write(fd2,
 577                           "\033[r"   /* clear scrolling region */
 578                           "\033[H"   /* move home */
 579                           "\033[3J", /* clear screen including scrollback, requires Linux 2.6.40 */
 580                           10, false);
 581         return 0;
 582 }
 583
 584 int make_console_stdio(void) {
 585         int fd, r;
 586
 587         /* Make /dev/console the controlling terminal and stdin/stdout/stderr, if we can. If we can't use
 588          * /dev/null instead. This is particularly useful if /dev/console is turned off, e.g. if console=null
 589          * is specified on the kernel command line. */
 590
 591         fd = acquire_terminal("/dev/console", ACQUIRE_TERMINAL_FORCE|ACQUIRE_TERMINAL_PERMISSIVE, USEC_INFINITY);
 592         if (fd < 0) {
 593                 log_warning_errno(fd, "Failed to acquire terminal, using /dev/null stdin/stdout/stderr instead: %m");
 594
 595                 r = make_null_stdio();
 596                 if (r < 0)
 597                         return log_error_errno(r, "Failed to make /dev/null stdin/stdout/stderr: %m");
 598
 599         } else {
 600                 r = reset_terminal_fd(fd, true);
 601                 if (r < 0)
 602                         log_warning_errno(r, "Failed to reset terminal, ignoring: %m");
 603
 604                 r = rearrange_stdio(fd, fd, fd); /* This invalidates 'fd' both on success and on failure. */
 605                 if (r < 0)
 606                         return log_error_errno(r, "Failed to make terminal stdin/stdout/stderr: %m");
 607         }
 608
 609         reset_terminal_feature_caches();
 610         return 0;
 611 }
 612
 613 bool tty_is_vc(const char *tty) {
 614         assert(tty);
 615
 616         return vtnr_from_tty(tty) >= 0;
 617 }
 618
 619 bool tty_is_console(const char *tty) {
 620         assert(tty);
 621
 622         return streq(skip_dev_prefix(tty), "console");
 623 }
 624
 625 int vtnr_from_tty(const char *tty) {
 626         int i, r;
 627
 628         assert(tty);
 629
 630         tty = skip_dev_prefix(tty);
 631
 632         if (!startswith(tty, "tty") )
 633                 return -EINVAL;
 634
 635         if (tty[3] < '0' || tty[3] > '9')
 636                 return -EINVAL;
 637
 638         r = safe_atoi(tty+3, &i);
 639         if (r < 0)
 640                 return r;
 641
 642         if (i < 0 || i > 63)
 643                 return -EINVAL;
 644
 645         return i;
 646 }
 647
 648  int resolve_dev_console(char **ret) {
 649         _cleanup_free_ char *active = NULL;
 650         char *tty;
 651         int r;
 652
 653         assert(ret);
 654
 655         /* Resolve where /dev/console is pointing to, if /sys is actually ours (i.e. not read-only-mounted which is a
 656          * sign for container setups) */
 657
 658         if (path_is_read_only_fs("/sys") > 0)
 659                 return -ENOMEDIUM;
 660
 661         r = read_one_line_file("/sys/class/tty/console/active", &active);
 662         if (r < 0)
 663                 return r;
 664
 665         /* If multiple log outputs are configured the last one is what /dev/console points to */
 666         tty = strrchr(active, ' ');
 667         if (tty)
 668                 tty++;
 669         else
 670                 tty = active;
 671
 672         if (streq(tty, "tty0")) {
 673                 active = mfree(active);
 674
 675                 /* Get the active VC (e.g. tty1) */
 676                 r = read_one_line_file("/sys/class/tty/tty0/active", &active);
 677                 if (r < 0)
 678                         return r;
 679
 680                 tty = active;
 681         }
 682
 683         if (tty == active)
 684                 *ret = TAKE_PTR(active);
 685         else {
 686                 char *tmp;
 687
 688                 tmp = strdup(tty);
 689                 if (!tmp)
 690                         return -ENOMEM;
 691
 692                 *ret = tmp;
 693         }
 694
 695         return 0;
 696 }
 697
 698 int get_kernel_consoles(char ***ret) {
 699         _cleanup_strv_free_ char **l = NULL;
 700         _cleanup_free_ char *line = NULL;
 701         const char *p;
 702         int r;
 703
 704         assert(ret);
 705
 706         /* If /sys is mounted read-only this means we are running in some kind of container environment. In that
 707          * case /sys would reflect the host system, not us, hence ignore the data we can read from it. */
 708         if (path_is_read_only_fs("/sys") > 0)
 709                 goto fallback;
 710
 711         r = read_one_line_file("/sys/class/tty/console/active", &line);
 712         if (r < 0)
 713                 return r;
 714
 715         p = line;
 716         for (;;) {
 717                 _cleanup_free_ char *tty = NULL, *path = NULL;
 718
 719                 r = extract_first_word(&p, &tty, NULL, 0);
 720                 if (r < 0)
 721                         return r;
 722                 if (r == 0)
 723                         break;
 724
 725                 if (streq(tty, "tty0")) {
 726                         tty = mfree(tty);
 727                         r = read_one_line_file("/sys/class/tty/tty0/active", &tty);
 728                         if (r < 0)
 729                                 return r;
 730                 }
 731
 732                 path = path_join("/dev", tty);
 733                 if (!path)
 734                         return -ENOMEM;
 735
 736                 if (access(path, F_OK) < 0) {
 737                         log_debug_errno(errno, "Console device %s is not accessible, skipping: %m", path);
 738                         continue;
 739                 }
 740
 741                 r = strv_consume(&l, TAKE_PTR(path));
 742                 if (r < 0)
 743                         return r;
 744         }
 745
 746         if (strv_isempty(l)) {
 747                 log_debug("No devices found for system console");
 748                 goto fallback;
 749         }
 750
 751         *ret = TAKE_PTR(l);
 752
 753         return 0;
 754
 755 fallback:
 756         r = strv_extend(&l, "/dev/console");
 757         if (r < 0)
 758                 return r;
 759
 760         *ret = TAKE_PTR(l);
 761
 762         return 0;
 763 }
 764
 765 bool tty_is_vc_resolve(const char *tty) {
 766         _cleanup_free_ char *resolved = NULL;
 767
 768         assert(tty);
 769
 770         tty = skip_dev_prefix(tty);
 771
 772         if (streq(tty, "console")) {
 773                 if (resolve_dev_console(&resolved) < 0)
 774                         return false;
 775
 776                 tty = resolved;
 777         }
 778
 779         return tty_is_vc(tty);
 780 }
 781
 782 const char *default_term_for_tty(const char *tty) {
 783         return tty && tty_is_vc_resolve(tty) ? "linux" : "vt220";
 784 }
 785
 786 int fd_columns(int fd) {
 787         struct winsize ws = {};
 788
 789         if (fd < 0)
 790                 return -EBADF;
 791
 792         if (ioctl(fd, TIOCGWINSZ, &ws) < 0)
 793                 return -errno;
 794
 795         if (ws.ws_col <= 0)
 796                 return -EIO;
 797
 798         return ws.ws_col;
 799 }
 800
 801 unsigned columns(void) {
 802         const char *e;
 803         int c;
 804
 805         if (cached_columns > 0)
 806                 return cached_columns;
 807
 808         c = 0;
 809         e = getenv("COLUMNS");
 810         if (e)
 811                 (void) safe_atoi(e, &c);
 812
 813         if (c <= 0 || c > USHRT_MAX) {
 814                 c = fd_columns(STDOUT_FILENO);
 815                 if (c <= 0)
 816                         c = 80;
 817         }
 818
 819         cached_columns = c;
 820         return cached_columns;
 821 }
 822
 823 int fd_lines(int fd) {
 824         struct winsize ws = {};
 825
 826         if (fd < 0)
 827                 return -EBADF;
 828
 829         if (ioctl(fd, TIOCGWINSZ, &ws) < 0)
 830                 return -errno;
 831
 832         if (ws.ws_row <= 0)
 833                 return -EIO;
 834
 835         return ws.ws_row;
 836 }
 837
 838 unsigned lines(void) {
 839         const char *e;
 840         int l;
 841
 842         if (cached_lines > 0)
 843                 return cached_lines;
 844
 845         l = 0;
 846         e = getenv("LINES");
 847         if (e)
 848                 (void) safe_atoi(e, &l);
 849
 850         if (l <= 0 || l > USHRT_MAX) {
 851                 l = fd_lines(STDOUT_FILENO);
 852                 if (l <= 0)
 853                         l = 24;
 854         }
 855
 856         cached_lines = l;
 857         return cached_lines;
 858 }
 859
 860 /* intended to be used as a SIGWINCH sighandler */
 861 void columns_lines_cache_reset(int signum) {
 862         cached_columns = 0;
 863         cached_lines = 0;
 864 }
 865
 866 void reset_terminal_feature_caches(void) {
 867         cached_columns = 0;
 868         cached_lines = 0;
 869
 870         cached_color_mode = _COLOR_INVALID;
 871         cached_underline_enabled = -1;
 872         cached_on_tty = -1;
 873 }
 874
 875 bool on_tty(void) {
 876
 877         /* We check both stdout and stderr, so that situations where pipes on the shell are used are reliably
 878          * recognized, regardless if only the output or the errors are piped to some place. Since on_tty() is generally
 879          * used to default to a safer, non-interactive, non-color mode of operation it's probably good to be defensive
 880          * here, and check for both. Note that we don't check for STDIN_FILENO, because it should fine to use fancy
 881          * terminal functionality when outputting stuff, even if the input is piped to us. */
 882
 883         if (cached_on_tty < 0)
 884                 cached_on_tty =
 885                         isatty(STDOUT_FILENO) > 0 &&
 886                         isatty(STDERR_FILENO) > 0;
 887
 888         return cached_on_tty;
 889 }
 890
 891 int getttyname_malloc(int fd, char **ret) {
 892         char path[PATH_MAX], *c; /* PATH_MAX is counted *with* the trailing NUL byte */
 893         int r;
 894
 895         assert(fd >= 0);
 896         assert(ret);
 897
 898         r = ttyname_r(fd, path, sizeof path); /* positive error */
 899         assert(r >= 0);
 900         if (r == ERANGE)
 901                 return -ENAMETOOLONG;
 902         if (r > 0)
 903                 return -r;
 904
 905         c = strdup(skip_dev_prefix(path));
 906         if (!c)
 907                 return -ENOMEM;
 908
 909         *ret = c;
 910         return 0;
 911 }
 912
 913 int getttyname_harder(int fd, char **ret) {
 914         _cleanup_free_ char *s = NULL;
 915         int r;
 916
 917         r = getttyname_malloc(fd, &s);
 918         if (r < 0)
 919                 return r;
 920
 921         if (streq(s, "tty"))
 922                 return get_ctty(0, NULL, ret);
 923
 924         *ret = TAKE_PTR(s);
 925         return 0;
 926 }
 927
 928 int get_ctty_devnr(pid_t pid, dev_t *d) {
 929         int r;
 930         _cleanup_free_ char *line = NULL;
 931         const char *p;
 932         unsigned long ttynr;
 933
 934         assert(pid >= 0);
 935
 936         p = procfs_file_alloca(pid, "stat");
 937         r = read_one_line_file(p, &line);
 938         if (r < 0)
 939                 return r;
 940
 941         p = strrchr(line, ')');
 942         if (!p)
 943                 return -EIO;
 944
 945         p++;
 946
 947         if (sscanf(p, " "
 948                    "%*c "  /* state */
 949                    "%*d "  /* ppid */
 950                    "%*d "  /* pgrp */
 951                    "%*d "  /* session */
 952                    "%lu ", /* ttynr */
 953                    &ttynr) != 1)
 954                 return -EIO;
 955
 956         if (major(ttynr) == 0 && minor(ttynr) == 0)
 957                 return -ENXIO;
 958
 959         if (d)
 960                 *d = (dev_t) ttynr;
 961
 962         return 0;
 963 }
 964
 965 int get_ctty(pid_t pid, dev_t *ret_devnr, char **ret) {
 966         char pty[STRLEN("/dev/pts/") + DECIMAL_STR_MAX(dev_t) + 1];
 967         _cleanup_free_ char *buf = NULL;
 968         const char *fn = NULL, *w;
 969         dev_t devnr;
 970         int r;
 971
 972         r = get_ctty_devnr(pid, &devnr);
 973         if (r < 0)
 974                 return r;
 975
 976         r = device_path_make_canonical(S_IFCHR, devnr, &buf);
 977         if (r < 0) {
 978                 struct stat st;
 979
 980                 if (r != -ENOENT) /* No symlink for this in /dev/char/? */
 981                         return r;
 982
 983                 /* Maybe this is PTY? PTY devices are not listed in /dev/char/, as they don't follow the
 984                  * Linux device model and hence device_path_make_canonical() doesn't work for them. Let's
 985                  * assume this is a PTY for a moment, and check if the device node this would then map to in
 986                  * /dev/pts/ matches the one we are looking for. This way we don't have to hardcode the major
 987                  * number (which is 136 btw), but we still rely on the fact that PTY numbers map directly to
 988                  * the minor number of the pty. */
 989                 xsprintf(pty, "/dev/pts/%u", minor(devnr));
 990
 991                 if (stat(pty, &st) < 0) {
 992                         if (errno != ENOENT)
 993                                 return -errno;
 994
 995                 } else if (S_ISCHR(st.st_mode) && devnr == st.st_rdev) /* Bingo! */
 996                         fn = pty;
 997
 998                 if (!fn) {
 999                         /* Doesn't exist, or not a PTY? Probably something similar to the PTYs which have no
1000                          * symlink in /dev/char/. Let's return something vaguely useful. */
1001                         r = device_path_make_major_minor(S_IFCHR, devnr, &buf);
1002                         if (r < 0)
1003                                 return r;
1004
1005                         fn = buf;
1006                 }
1007         } else
1008                 fn = buf;
1009
1010         w = path_startswith(fn, "/dev/");
1011         if (!w)
1012                 return -EINVAL;
1013
1014         if (ret) {
1015                 _cleanup_free_ char *b = NULL;
1016
1017                 b = strdup(w);
1018                 if (!b)
1019                         return -ENOMEM;
1020
1021                 *ret = TAKE_PTR(b);
1022         }
1023
1024         if (ret_devnr)
1025                 *ret_devnr = devnr;
1026
1027         return 0;
1028 }
1029
1030 int ptsname_malloc(int fd, char **ret) {
1031         size_t l = 100;
1032
1033         assert(fd >= 0);
1034         assert(ret);
1035
1036         for (;;) {
1037                 char *c;
1038
1039                 c = new(char, l);
1040                 if (!c)
1041                         return -ENOMEM;
1042
1043                 if (ptsname_r(fd, c, l) == 0) {
1044                         *ret = c;
1045                         return 0;
1046                 }
1047                 if (errno != ERANGE) {
1048                         free(c);
1049                         return -errno;
1050                 }
1051
1052                 free(c);
1053
1054                 if (l > SIZE_MAX / 2)
1055                         return -ENOMEM;
1056
1057                 l *= 2;
1058         }
1059 }
1060
1061 int openpt_allocate(int flags, char **ret_slave) {
1062         _cleanup_close_ int fd = -1;
1063         _cleanup_free_ char *p = NULL;
1064         int r;
1065
1066         fd = posix_openpt(flags|O_NOCTTY|O_CLOEXEC);
1067         if (fd < 0)
1068                 return -errno;
1069
1070         if (ret_slave) {
1071                 r = ptsname_malloc(fd, &p);
1072                 if (r < 0)
1073                         return r;
1074
1075                 if (!path_startswith(p, "/dev/pts/"))
1076                         return -EINVAL;
1077         }
1078
1079         if (unlockpt(fd) < 0)
1080                 return -errno;
1081
1082         if (ret_slave)
1083                 *ret_slave = TAKE_PTR(p);
1084
1085         return TAKE_FD(fd);
1086 }
1087
1088 static int ptsname_namespace(int pty, char **ret) {
1089         int no = -1, r;
1090
1091         /* Like ptsname(), but doesn't assume that the path is
1092          * accessible in the local namespace. */
1093
1094         r = ioctl(pty, TIOCGPTN, &no);
1095         if (r < 0)
1096                 return -errno;
1097
1098         if (no < 0)
1099                 return -EIO;
1100
1101         if (asprintf(ret, "/dev/pts/%i", no) < 0)
1102                 return -ENOMEM;
1103
1104         return 0;
1105 }
1106
1107 int openpt_allocate_in_namespace(pid_t pid, int flags, char **ret_slave) {
1108         _cleanup_close_ int pidnsfd = -1, mntnsfd = -1, usernsfd = -1, rootfd = -1, fd = -1;
1109         _cleanup_close_pair_ int pair[2] = { -1, -1 };
1110         pid_t child;
1111         int r;
1112
1113         assert(pid > 0);
1114
1115         r = namespace_open(pid, &pidnsfd, &mntnsfd, NULL, &usernsfd, &rootfd);
1116         if (r < 0)
1117                 return r;
1118
1119         if (socketpair(AF_UNIX, SOCK_DGRAM, 0, pair) < 0)
1120                 return -errno;
1121
1122         r = namespace_fork("(sd-openptns)", "(sd-openpt)", NULL, 0, FORK_RESET_SIGNALS|FORK_DEATHSIG,
1123                            pidnsfd, mntnsfd, -1, usernsfd, rootfd, &child);
1124         if (r < 0)
1125                 return r;
1126         if (r == 0) {
1127                 pair[0] = safe_close(pair[0]);
1128
1129                 fd = openpt_allocate(flags, NULL);
1130                 if (fd < 0)
1131                         _exit(EXIT_FAILURE);
1132
1133                 if (send_one_fd(pair[1], fd, 0) < 0)
1134                         _exit(EXIT_FAILURE);
1135
1136                 _exit(EXIT_SUCCESS);
1137         }
1138
1139         pair[1] = safe_close(pair[1]);
1140
1141         r = wait_for_terminate_and_check("(sd-openptns)", child, 0);
1142         if (r < 0)
1143                 return r;
1144         if (r != EXIT_SUCCESS)
1145                 return -EIO;
1146
1147         fd = receive_one_fd(pair[0], 0);
1148         if (fd < 0)
1149                 return fd;
1150
1151         if (ret_slave) {
1152                 r = ptsname_namespace(fd, ret_slave);
1153                 if (r < 0)
1154                         return r;
1155         }
1156
1157         return TAKE_FD(fd);
1158 }
1159
1160 int open_terminal_in_namespace(pid_t pid, const char *name, int mode) {
1161         _cleanup_close_ int pidnsfd = -1, mntnsfd = -1, usernsfd = -1, rootfd = -1;
1162         _cleanup_close_pair_ int pair[2] = { -1, -1 };
1163         pid_t child;
1164         int r;
1165
1166         r = namespace_open(pid, &pidnsfd, &mntnsfd, NULL, &usernsfd, &rootfd);
1167         if (r < 0)
1168                 return r;
1169
1170         if (socketpair(AF_UNIX, SOCK_DGRAM, 0, pair) < 0)
1171                 return -errno;
1172
1173         r = namespace_fork("(sd-terminalns)", "(sd-terminal)", NULL, 0, FORK_RESET_SIGNALS|FORK_DEATHSIG,
1174                            pidnsfd, mntnsfd, -1, usernsfd, rootfd, &child);
1175         if (r < 0)
1176                 return r;
1177         if (r == 0) {
1178                 int master;
1179
1180                 pair[0] = safe_close(pair[0]);
1181
1182                 master = open_terminal(name, mode|O_NOCTTY|O_CLOEXEC);
1183                 if (master < 0)
1184                         _exit(EXIT_FAILURE);
1185
1186                 if (send_one_fd(pair[1], master, 0) < 0)
1187                         _exit(EXIT_FAILURE);
1188
1189                 _exit(EXIT_SUCCESS);
1190         }
1191
1192         pair[1] = safe_close(pair[1]);
1193
1194         r = wait_for_terminate_and_check("(sd-terminalns)", child, 0);
1195         if (r < 0)
1196                 return r;
1197         if (r != EXIT_SUCCESS)
1198                 return -EIO;
1199
1200         return receive_one_fd(pair[0], 0);
1201 }
1202
1203 static bool getenv_terminal_is_dumb(void) {
1204         const char *e;
1205
1206         e = getenv("TERM");
1207         if (!e)
1208                 return true;
1209
1210         return streq(e, "dumb");
1211 }
1212
1213 bool terminal_is_dumb(void) {
1214         if (!on_tty())
1215                 return true;
1216
1217         return getenv_terminal_is_dumb();
1218 }
1219
1220 static ColorMode parse_systemd_colors(void) {
1221         const char *e;
1222         int r;
1223
1224         e = getenv("SYSTEMD_COLORS");
1225         if (!e)
1226                 return _COLOR_INVALID;
1227         if (streq(e, "16"))
1228                 return COLOR_16;
1229         if (streq(e, "256"))
1230                 return COLOR_256;
1231         r = parse_boolean(e);
1232         if (r >= 0)
1233                 return r > 0 ? COLOR_ON : COLOR_OFF;
1234         return _COLOR_INVALID;
1235 }
1236
1237 ColorMode get_color_mode(void) {
1238
1239         /* Returns the mode used to choose output colors. The possible modes are COLOR_OFF for no colors,
1240          * COLOR_16 for only the base 16 ANSI colors, COLOR_256 for more colors and COLOR_ON for unrestricted
1241          * color output. For that we check $SYSTEMD_COLORS first (which is the explicit way to
1242          * change the mode). If that didn't work we turn colors off unless we are on a TTY. And if we are on a TTY
1243          * we turn it off if $TERM is set to "dumb". There's one special tweak though: if we are PID 1 then we do not
1244          * check whether we are connected to a TTY, because we don't keep /dev/console open continuously due to fear
1245          * of SAK, and hence things are a bit weird. */
1246         ColorMode m;
1247
1248         if (cached_color_mode < 0) {
1249                 m = parse_systemd_colors();
1250                 if (m >= 0)
1251                         cached_color_mode = m;
1252                 else if (getenv("NO_COLOR"))
1253                         /* We only check for the presence of the variable; value is ignored. */
1254                         cached_color_mode = COLOR_OFF;
1255
1256                 else if (getpid_cached() == 1)
1257                         /* PID1 outputs to the console without holding it open all the time.
1258                          *
1259                          * Note that the Linux console can only display 16 colors. We still enable 256 color
1260                          * mode even for PID1 output though (which typically goes to the Linux console),
1261                          * since the Linux console is able to parse the 256 color sequences and automatically
1262                          * map them to the closest color in the 16 color palette (since kernel 3.16). Doing
1263                          * 256 colors is nice for people who invoke systemd in a container or via a serial
1264                          * link or such, and use a true 256 color terminal to do so. */
1265                         cached_color_mode = getenv_terminal_is_dumb() ? COLOR_OFF : COLOR_256;
1266                 else
1267                         cached_color_mode = terminal_is_dumb() ? COLOR_OFF : COLOR_256;
1268         }
1269
1270         return cached_color_mode;
1271 }
1272
1273 bool dev_console_colors_enabled(void) {
1274         _cleanup_free_ char *s = NULL;
1275         ColorMode m;
1276
1277         /* Returns true if we assume that color is supported on /dev/console.
1278          *
1279          * For that we first check if we explicitly got told to use colors or not, by checking $SYSTEMD_COLORS. If that
1280          * isn't set we check whether PID 1 has $TERM set, and if not, whether TERM is set on the kernel command
1281          * line. If we find $TERM set we assume color if it's not set to "dumb", similarly to how regular
1282          * colors_enabled() operates. */
1283
1284         m = parse_systemd_colors();
1285         if (m >= 0)
1286                 return m;
1287
1288         if (getenv("NO_COLOR"))
1289                 return false;
1290
1291         if (getenv_for_pid(1, "TERM", &s) <= 0)
1292                 (void) proc_cmdline_get_key("TERM", 0, &s);
1293
1294         return !streq_ptr(s, "dumb");
1295 }
1296
1297 bool underline_enabled(void) {
1298
1299         if (cached_underline_enabled < 0) {
1300
1301                 /* The Linux console doesn't support underlining, turn it off, but only there. */
1302
1303                 if (colors_enabled())
1304                         cached_underline_enabled = !streq_ptr(getenv("TERM"), "linux");
1305                 else
1306                         cached_underline_enabled = false;
1307         }
1308
1309         return cached_underline_enabled;
1310 }
1311
1312 int vt_default_utf8(void) {
1313         _cleanup_free_ char *b = NULL;
1314         int r;
1315
1316         /* Read the default VT UTF8 setting from the kernel */
1317
1318         r = read_one_line_file("/sys/module/vt/parameters/default_utf8", &b);
1319         if (r < 0)
1320                 return r;
1321
1322         return parse_boolean(b);
1323 }
1324
1325 int vt_reset_keyboard(int fd) {
1326         int kb;
1327
1328         /* If we can't read the default, then default to unicode. It's 2017 after all. */
1329         kb = vt_default_utf8() != 0 ? K_UNICODE : K_XLATE;
1330
1331         if (ioctl(fd, KDSKBMODE, kb) < 0)
1332                 return -errno;
1333
1334         return 0;
1335 }
1336
1337 int vt_restore(int fd) {
1338         static const struct vt_mode mode = {
1339                 .mode = VT_AUTO,
1340         };
1341         int r, q = 0;
1342
1343         if (isatty(fd) < 1)
1344                 return log_debug_errno(errno, "Asked to restore the VT for an fd that does not refer to a terminal: %m");
1345
1346         if (ioctl(fd, KDSETMODE, KD_TEXT) < 0)
1347                 q = log_debug_errno(errno, "Failed to set VT in text mode, ignoring: %m");
1348
1349         r = vt_reset_keyboard(fd);
1350         if (r < 0) {
1351                 log_debug_errno(r, "Failed to reset keyboard mode, ignoring: %m");
1352                 if (q >= 0)
1353                         q = r;
1354         }
1355
1356         if (ioctl(fd, VT_SETMODE, &mode) < 0) {
1357                 log_debug_errno(errno, "Failed to set VT_AUTO mode, ignoring: %m");
1358                 if (q >= 0)
1359                         q = -errno;
1360         }
1361
1362         r = fchmod_and_chown(fd, TTY_MODE, 0, GID_INVALID);
1363         if (r < 0) {
1364                 log_debug_errno(r, "Failed to chmod()/chown() VT, ignoring: %m");
1365                 if (q >= 0)
1366                         q = r;
1367         }
1368
1369         return q;
1370 }
1371
1372 int vt_release(int fd, bool restore) {
1373         assert(fd >= 0);
1374
1375         /* This function releases the VT by acknowledging the VT-switch signal
1376          * sent by the kernel and optionally reset the VT in text and auto
1377          * VT-switching modes. */
1378
1379         if (isatty(fd) < 1)
1380                 return log_debug_errno(errno, "Asked to release the VT for an fd that does not refer to a terminal: %m");
1381
1382         if (ioctl(fd, VT_RELDISP, 1) < 0)
1383                 return -errno;
1384
1385         if (restore)
1386                 return vt_restore(fd);
1387
1388         return 0;
1389 }
1390
1391 void get_log_colors(int priority, const char **on, const char **off, const char **highlight) {
1392         /* Note that this will initialize output variables only when there's something to output.
1393          * The caller must pre-initialize to "" or NULL as appropriate. */
1394
1395         if (priority <= LOG_ERR) {
1396                 if (on)
1397                         *on = ansi_highlight_red();
1398                 if (off)
1399                         *off = ansi_normal();
1400                 if (highlight)
1401                         *highlight = ansi_highlight();
1402
1403         } else if (priority <= LOG_WARNING) {
1404                 if (on)
1405                         *on = ansi_highlight_yellow();
1406                 if (off)
1407                         *off = ansi_normal();
1408                 if (highlight)
1409                         *highlight = ansi_highlight();
1410
1411         } else if (priority <= LOG_NOTICE) {
1412                 if (on)
1413                         *on = ansi_highlight();
1414                 if (off)
1415                         *off = ansi_normal();
1416                 if (highlight)
1417                         *highlight = ansi_highlight_red();
1418
1419         } else if (priority >= LOG_DEBUG) {
1420                 if (on)
1421                         *on = ansi_grey();
1422                 if (off)
1423                         *off = ansi_normal();
1424                 if (highlight)
1425                         *highlight = ansi_highlight_red();
1426         }
1427 }