src/basic/terminal-util.c

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