]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/basic/terminal-util.c
core: drop spurious newline
[thirdparty/systemd.git] / src / basic / terminal-util.c
CommitLineData
288a74cc
RC
1/***
2 This file is part of systemd.
3
4 Copyright 2010 Lennart Poettering
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18***/
19
11c3a366 20#include <errno.h>
07630cea 21#include <fcntl.h>
11c3a366
TA
22#include <limits.h>
23#include <stdarg.h>
24#include <stddef.h>
25#include <stdlib.h>
26#include <string.h>
27#include <sys/inotify.h>
28#include <sys/socket.h>
29#include <sys/sysmacros.h>
30#include <sys/time.h>
07630cea
LP
31#include <linux/kd.h>
32#include <linux/tiocl.h>
33#include <linux/vt.h>
34#include <poll.h>
35#include <signal.h>
288a74cc 36#include <sys/ioctl.h>
07630cea 37#include <sys/types.h>
288a74cc 38#include <termios.h>
07630cea 39#include <unistd.h>
288a74cc 40
b5efdb8a 41#include "alloc-util.h"
3ffd4af2 42#include "fd-util.h"
288a74cc 43#include "fileio.h"
f4f15635 44#include "fs-util.h"
c004493c 45#include "io-util.h"
93cc7779
TA
46#include "log.h"
47#include "macro.h"
6bedfcbb 48#include "parse-util.h"
07630cea 49#include "process-util.h"
2583fbea 50#include "socket-util.h"
8fcde012 51#include "stat-util.h"
07630cea 52#include "string-util.h"
6af62124 53#include "strv.h"
3ffd4af2 54#include "terminal-util.h"
07630cea
LP
55#include "time-util.h"
56#include "util.h"
288a74cc
RC
57
58static volatile unsigned cached_columns = 0;
59static volatile unsigned cached_lines = 0;
60
61int chvt(int vt) {
62 _cleanup_close_ int fd;
63
0a8b555c 64 fd = open_terminal("/dev/tty0", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
288a74cc
RC
65 if (fd < 0)
66 return -errno;
67
b9e74c39 68 if (vt <= 0) {
288a74cc
RC
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
86int read_one_char(FILE *f, char *ret, usec_t t, bool *need_nl) {
87 struct termios old_termios, new_termios;
88 char c, line[LINE_MAX];
89
90 assert(f);
91 assert(ret);
92
93 if (tcgetattr(fileno(f), &old_termios) >= 0) {
94 new_termios = old_termios;
95
96 new_termios.c_lflag &= ~ICANON;
97 new_termios.c_cc[VMIN] = 1;
98 new_termios.c_cc[VTIME] = 0;
99
100 if (tcsetattr(fileno(f), TCSADRAIN, &new_termios) >= 0) {
101 size_t k;
102
103 if (t != USEC_INFINITY) {
104 if (fd_wait_for_event(fileno(f), POLLIN, t) <= 0) {
105 tcsetattr(fileno(f), TCSADRAIN, &old_termios);
106 return -ETIMEDOUT;
107 }
108 }
109
110 k = fread(&c, 1, 1, f);
111
112 tcsetattr(fileno(f), TCSADRAIN, &old_termios);
113
114 if (k <= 0)
115 return -EIO;
116
117 if (need_nl)
118 *need_nl = c != '\n';
119
120 *ret = c;
121 return 0;
122 }
123 }
124
125 if (t != USEC_INFINITY) {
126 if (fd_wait_for_event(fileno(f), POLLIN, t) <= 0)
127 return -ETIMEDOUT;
128 }
129
130 errno = 0;
131 if (!fgets(line, sizeof(line), f))
f5e5c28f 132 return errno > 0 ? -errno : -EIO;
288a74cc
RC
133
134 truncate_nl(line);
135
136 if (strlen(line) != 1)
137 return -EBADMSG;
138
139 if (need_nl)
140 *need_nl = false;
141
142 *ret = line[0];
143 return 0;
144}
145
146int ask_char(char *ret, const char *replies, const char *text, ...) {
147 int r;
148
149 assert(ret);
150 assert(replies);
151 assert(text);
152
153 for (;;) {
154 va_list ap;
155 char c;
156 bool need_nl = true;
157
7565bb98 158 if (colors_enabled())
1fc464f6 159 fputs(ANSI_HIGHLIGHT, stdout);
288a74cc
RC
160
161 va_start(ap, text);
162 vprintf(text, ap);
163 va_end(ap);
164
7565bb98 165 if (colors_enabled())
1fc464f6 166 fputs(ANSI_NORMAL, stdout);
288a74cc
RC
167
168 fflush(stdout);
169
170 r = read_one_char(stdin, &c, USEC_INFINITY, &need_nl);
171 if (r < 0) {
172
173 if (r == -EBADMSG) {
174 puts("Bad input, please try again.");
175 continue;
176 }
177
178 putchar('\n');
179 return r;
180 }
181
182 if (need_nl)
183 putchar('\n');
184
185 if (strchr(replies, c)) {
186 *ret = c;
187 return 0;
188 }
189
190 puts("Read unexpected character, please try again.");
191 }
192}
193
194int ask_string(char **ret, const char *text, ...) {
195 assert(ret);
196 assert(text);
197
198 for (;;) {
199 char line[LINE_MAX];
200 va_list ap;
201
7565bb98 202 if (colors_enabled())
1fc464f6 203 fputs(ANSI_HIGHLIGHT, stdout);
288a74cc
RC
204
205 va_start(ap, text);
206 vprintf(text, ap);
207 va_end(ap);
208
7565bb98 209 if (colors_enabled())
1fc464f6 210 fputs(ANSI_NORMAL, stdout);
288a74cc
RC
211
212 fflush(stdout);
213
214 errno = 0;
215 if (!fgets(line, sizeof(line), stdin))
f5e5c28f 216 return errno > 0 ? -errno : -EIO;
288a74cc
RC
217
218 if (!endswith(line, "\n"))
219 putchar('\n');
220 else {
221 char *s;
222
223 if (isempty(line))
224 continue;
225
226 truncate_nl(line);
227 s = strdup(line);
228 if (!s)
229 return -ENOMEM;
230
231 *ret = s;
232 return 0;
233 }
234 }
235}
236
237int reset_terminal_fd(int fd, bool switch_to_text) {
238 struct termios termios;
239 int r = 0;
240
241 /* Set terminal to some sane defaults */
242
243 assert(fd >= 0);
244
245 /* We leave locked terminal attributes untouched, so that
246 * Plymouth may set whatever it wants to set, and we don't
247 * interfere with that. */
248
249 /* Disable exclusive mode, just in case */
7d927c9a 250 (void) ioctl(fd, TIOCNXCL);
288a74cc
RC
251
252 /* Switch to text mode */
253 if (switch_to_text)
7d927c9a 254 (void) ioctl(fd, KDSETMODE, KD_TEXT);
288a74cc
RC
255
256 /* Enable console unicode mode */
7d927c9a 257 (void) ioctl(fd, KDSKBMODE, K_UNICODE);
288a74cc
RC
258
259 if (tcgetattr(fd, &termios) < 0) {
260 r = -errno;
261 goto finish;
262 }
263
264 /* We only reset the stuff that matters to the software. How
265 * hardware is set up we don't touch assuming that somebody
266 * else will do that for us */
267
268 termios.c_iflag &= ~(IGNBRK | BRKINT | ISTRIP | INLCR | IGNCR | IUCLC);
269 termios.c_iflag |= ICRNL | IMAXBEL | IUTF8;
270 termios.c_oflag |= ONLCR;
271 termios.c_cflag |= CREAD;
272 termios.c_lflag = ISIG | ICANON | IEXTEN | ECHO | ECHOE | ECHOK | ECHOCTL | ECHOPRT | ECHOKE;
273
274 termios.c_cc[VINTR] = 03; /* ^C */
275 termios.c_cc[VQUIT] = 034; /* ^\ */
276 termios.c_cc[VERASE] = 0177;
277 termios.c_cc[VKILL] = 025; /* ^X */
278 termios.c_cc[VEOF] = 04; /* ^D */
279 termios.c_cc[VSTART] = 021; /* ^Q */
280 termios.c_cc[VSTOP] = 023; /* ^S */
281 termios.c_cc[VSUSP] = 032; /* ^Z */
282 termios.c_cc[VLNEXT] = 026; /* ^V */
283 termios.c_cc[VWERASE] = 027; /* ^W */
284 termios.c_cc[VREPRINT] = 022; /* ^R */
285 termios.c_cc[VEOL] = 0;
286 termios.c_cc[VEOL2] = 0;
287
288 termios.c_cc[VTIME] = 0;
289 termios.c_cc[VMIN] = 1;
290
291 if (tcsetattr(fd, TCSANOW, &termios) < 0)
292 r = -errno;
293
294finish:
295 /* Just in case, flush all crap out */
7d927c9a 296 (void) tcflush(fd, TCIOFLUSH);
288a74cc
RC
297
298 return r;
299}
300
301int reset_terminal(const char *name) {
302 _cleanup_close_ int fd = -1;
303
0a8b555c
LP
304 /* We open the terminal with O_NONBLOCK here, to ensure we
305 * don't block on carrier if this is a terminal with carrier
306 * configured. */
307
308 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
288a74cc
RC
309 if (fd < 0)
310 return fd;
311
312 return reset_terminal_fd(fd, true);
313}
314
315int open_terminal(const char *name, int mode) {
316 int fd, r;
317 unsigned c = 0;
318
319 /*
320 * If a TTY is in the process of being closed opening it might
321 * cause EIO. This is horribly awful, but unlikely to be
322 * changed in the kernel. Hence we work around this problem by
323 * retrying a couple of times.
324 *
325 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/554172/comments/245
326 */
327
35bdab77
LP
328 if (mode & O_CREAT)
329 return -EINVAL;
288a74cc
RC
330
331 for (;;) {
332 fd = open(name, mode, 0);
333 if (fd >= 0)
334 break;
335
336 if (errno != EIO)
337 return -errno;
338
339 /* Max 1s in total */
340 if (c >= 20)
341 return -errno;
342
343 usleep(50 * USEC_PER_MSEC);
344 c++;
345 }
346
347 r = isatty(fd);
348 if (r < 0) {
349 safe_close(fd);
350 return -errno;
351 }
352
353 if (!r) {
354 safe_close(fd);
355 return -ENOTTY;
356 }
357
358 return fd;
359}
360
361int acquire_terminal(
362 const char *name,
363 bool fail,
364 bool force,
365 bool ignore_tiocstty_eperm,
366 usec_t timeout) {
367
368 int fd = -1, notify = -1, r = 0, wd = -1;
369 usec_t ts = 0;
370
371 assert(name);
372
373 /* We use inotify to be notified when the tty is closed. We
374 * create the watch before checking if we can actually acquire
375 * it, so that we don't lose any event.
376 *
377 * Note: strictly speaking this actually watches for the
378 * device being closed, it does *not* really watch whether a
379 * tty loses its controlling process. However, unless some
380 * rogue process uses TIOCNOTTY on /dev/tty *after* closing
381 * its tty otherwise this will not become a problem. As long
382 * as the administrator makes sure not configure any service
383 * on the same tty as an untrusted user this should not be a
384 * problem. (Which he probably should not do anyway.) */
385
386 if (timeout != USEC_INFINITY)
387 ts = now(CLOCK_MONOTONIC);
388
389 if (!fail && !force) {
390 notify = inotify_init1(IN_CLOEXEC | (timeout != USEC_INFINITY ? IN_NONBLOCK : 0));
391 if (notify < 0) {
392 r = -errno;
393 goto fail;
394 }
395
396 wd = inotify_add_watch(notify, name, IN_CLOSE);
397 if (wd < 0) {
398 r = -errno;
399 goto fail;
400 }
401 }
402
403 for (;;) {
404 struct sigaction sa_old, sa_new = {
405 .sa_handler = SIG_IGN,
406 .sa_flags = SA_RESTART,
407 };
408
409 if (notify >= 0) {
410 r = flush_fd(notify);
411 if (r < 0)
412 goto fail;
413 }
414
415 /* We pass here O_NOCTTY only so that we can check the return
416 * value TIOCSCTTY and have a reliable way to figure out if we
417 * successfully became the controlling process of the tty */
418 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC);
419 if (fd < 0)
420 return fd;
421
422 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
423 * if we already own the tty. */
424 assert_se(sigaction(SIGHUP, &sa_new, &sa_old) == 0);
425
426 /* First, try to get the tty */
427 if (ioctl(fd, TIOCSCTTY, force) < 0)
428 r = -errno;
429
430 assert_se(sigaction(SIGHUP, &sa_old, NULL) == 0);
431
b938cb90 432 /* Sometimes, it makes sense to ignore TIOCSCTTY
288a74cc
RC
433 * returning EPERM, i.e. when very likely we already
434 * are have this controlling terminal. */
435 if (r < 0 && r == -EPERM && ignore_tiocstty_eperm)
436 r = 0;
437
7d927c9a 438 if (r < 0 && (force || fail || r != -EPERM))
288a74cc 439 goto fail;
288a74cc
RC
440
441 if (r >= 0)
442 break;
443
444 assert(!fail);
445 assert(!force);
446 assert(notify >= 0);
447
448 for (;;) {
449 union inotify_event_buffer buffer;
450 struct inotify_event *e;
451 ssize_t l;
452
453 if (timeout != USEC_INFINITY) {
454 usec_t n;
455
456 n = now(CLOCK_MONOTONIC);
457 if (ts + timeout < n) {
458 r = -ETIMEDOUT;
459 goto fail;
460 }
461
462 r = fd_wait_for_event(fd, POLLIN, ts + timeout - n);
463 if (r < 0)
464 goto fail;
465
466 if (r == 0) {
467 r = -ETIMEDOUT;
468 goto fail;
469 }
470 }
471
472 l = read(notify, &buffer, sizeof(buffer));
473 if (l < 0) {
474 if (errno == EINTR || errno == EAGAIN)
475 continue;
476
477 r = -errno;
478 goto fail;
479 }
480
481 FOREACH_INOTIFY_EVENT(e, buffer, l) {
482 if (e->wd != wd || !(e->mask & IN_CLOSE)) {
483 r = -EIO;
484 goto fail;
485 }
486 }
487
488 break;
489 }
490
491 /* We close the tty fd here since if the old session
492 * ended our handle will be dead. It's important that
493 * we do this after sleeping, so that we don't enter
494 * an endless loop. */
495 fd = safe_close(fd);
496 }
497
498 safe_close(notify);
499
288a74cc
RC
500 return fd;
501
502fail:
503 safe_close(fd);
504 safe_close(notify);
505
506 return r;
507}
508
509int release_terminal(void) {
510 static const struct sigaction sa_new = {
511 .sa_handler = SIG_IGN,
512 .sa_flags = SA_RESTART,
513 };
514
515 _cleanup_close_ int fd = -1;
516 struct sigaction sa_old;
517 int r = 0;
518
0a8b555c 519 fd = open("/dev/tty", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
288a74cc
RC
520 if (fd < 0)
521 return -errno;
522
523 /* Temporarily ignore SIGHUP, so that we don't get SIGHUP'ed
524 * by our own TIOCNOTTY */
525 assert_se(sigaction(SIGHUP, &sa_new, &sa_old) == 0);
526
527 if (ioctl(fd, TIOCNOTTY) < 0)
528 r = -errno;
529
530 assert_se(sigaction(SIGHUP, &sa_old, NULL) == 0);
531
532 return r;
533}
534
535int terminal_vhangup_fd(int fd) {
536 assert(fd >= 0);
537
538 if (ioctl(fd, TIOCVHANGUP) < 0)
539 return -errno;
540
541 return 0;
542}
543
544int terminal_vhangup(const char *name) {
545 _cleanup_close_ int fd;
546
0a8b555c 547 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
288a74cc
RC
548 if (fd < 0)
549 return fd;
550
551 return terminal_vhangup_fd(fd);
552}
553
554int vt_disallocate(const char *name) {
1ba23931 555 _cleanup_close_ int fd = -1;
288a74cc 556 unsigned u;
1ba23931 557 int r;
288a74cc
RC
558
559 /* Deallocate the VT if possible. If not possible
560 * (i.e. because it is the active one), at least clear it
561 * entirely (including the scrollback buffer) */
562
563 if (!startswith(name, "/dev/"))
564 return -EINVAL;
565
566 if (!tty_is_vc(name)) {
567 /* So this is not a VT. I guess we cannot deallocate
568 * it then. But let's at least clear the screen */
569
570 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC);
571 if (fd < 0)
572 return fd;
573
574 loop_write(fd,
575 "\033[r" /* clear scrolling region */
576 "\033[H" /* move home */
577 "\033[2J", /* clear screen */
578 10, false);
288a74cc
RC
579 return 0;
580 }
581
582 if (!startswith(name, "/dev/tty"))
583 return -EINVAL;
584
585 r = safe_atou(name+8, &u);
586 if (r < 0)
587 return r;
588
589 if (u <= 0)
590 return -EINVAL;
591
592 /* Try to deallocate */
0a8b555c 593 fd = open_terminal("/dev/tty0", O_RDWR|O_NOCTTY|O_CLOEXEC|O_NONBLOCK);
288a74cc
RC
594 if (fd < 0)
595 return fd;
596
597 r = ioctl(fd, VT_DISALLOCATE, u);
1ba23931 598 fd = safe_close(fd);
288a74cc
RC
599
600 if (r >= 0)
601 return 0;
602
603 if (errno != EBUSY)
604 return -errno;
605
606 /* Couldn't deallocate, so let's clear it fully with
607 * scrollback */
608 fd = open_terminal(name, O_RDWR|O_NOCTTY|O_CLOEXEC);
609 if (fd < 0)
610 return fd;
611
612 loop_write(fd,
613 "\033[r" /* clear scrolling region */
614 "\033[H" /* move home */
615 "\033[3J", /* clear screen including scrollback, requires Linux 2.6.40 */
616 10, false);
288a74cc
RC
617 return 0;
618}
619
288a74cc
RC
620int make_console_stdio(void) {
621 int fd, r;
622
623 /* Make /dev/console the controlling terminal and stdin/stdout/stderr */
624
625 fd = acquire_terminal("/dev/console", false, true, true, USEC_INFINITY);
626 if (fd < 0)
627 return log_error_errno(fd, "Failed to acquire terminal: %m");
628
3d18b167
LP
629 r = reset_terminal_fd(fd, true);
630 if (r < 0)
631 log_warning_errno(r, "Failed to reset terminal, ignoring: %m");
632
288a74cc
RC
633 r = make_stdio(fd);
634 if (r < 0)
635 return log_error_errno(r, "Failed to duplicate terminal fd: %m");
636
637 return 0;
638}
639
288a74cc
RC
640bool tty_is_vc(const char *tty) {
641 assert(tty);
642
643 return vtnr_from_tty(tty) >= 0;
644}
645
646bool tty_is_console(const char *tty) {
647 assert(tty);
648
649 if (startswith(tty, "/dev/"))
650 tty += 5;
651
652 return streq(tty, "console");
653}
654
655int vtnr_from_tty(const char *tty) {
656 int i, r;
657
658 assert(tty);
659
660 if (startswith(tty, "/dev/"))
661 tty += 5;
662
663 if (!startswith(tty, "tty") )
664 return -EINVAL;
665
666 if (tty[3] < '0' || tty[3] > '9')
667 return -EINVAL;
668
669 r = safe_atoi(tty+3, &i);
670 if (r < 0)
671 return r;
672
673 if (i < 0 || i > 63)
674 return -EINVAL;
675
676 return i;
677}
678
679char *resolve_dev_console(char **active) {
680 char *tty;
681
682 /* Resolve where /dev/console is pointing to, if /sys is actually ours
683 * (i.e. not read-only-mounted which is a sign for container setups) */
684
685 if (path_is_read_only_fs("/sys") > 0)
686 return NULL;
687
688 if (read_one_line_file("/sys/class/tty/console/active", active) < 0)
689 return NULL;
690
691 /* If multiple log outputs are configured the last one is what
692 * /dev/console points to */
693 tty = strrchr(*active, ' ');
694 if (tty)
695 tty++;
696 else
697 tty = *active;
698
699 if (streq(tty, "tty0")) {
700 char *tmp;
701
702 /* Get the active VC (e.g. tty1) */
703 if (read_one_line_file("/sys/class/tty/tty0/active", &tmp) >= 0) {
704 free(*active);
705 tty = *active = tmp;
706 }
707 }
708
709 return tty;
710}
711
6af62124
WF
712int get_kernel_consoles(char ***consoles) {
713 _cleanup_strv_free_ char **con = NULL;
714 _cleanup_free_ char *line = NULL;
715 const char *active;
716 int r;
717
718 assert(consoles);
719
720 r = read_one_line_file("/sys/class/tty/console/active", &line);
721 if (r < 0)
722 return r;
723
724 active = line;
725 for (;;) {
726 _cleanup_free_ char *tty = NULL;
727 char *path;
728
729 r = extract_first_word(&active, &tty, NULL, 0);
730 if (r < 0)
731 return r;
732 if (r == 0)
733 break;
734
735 if (streq(tty, "tty0")) {
736 tty = mfree(tty);
737 r = read_one_line_file("/sys/class/tty/tty0/active", &tty);
738 if (r < 0)
739 return r;
740 }
741
742 path = strappend("/dev/", tty);
743 if (!path)
744 return -ENOMEM;
745
746 if (access(path, F_OK) < 0) {
747 log_debug_errno(errno, "Console device %s is not accessible, skipping: %m", path);
748 free(path);
749 continue;
750 }
751
752 r = strv_consume(&con, path);
753 if (r < 0)
754 return r;
755 }
756
757 if (strv_isempty(con)) {
758 log_debug("No devices found for system console");
759
760 r = strv_extend(&con, "/dev/console");
761 if (r < 0)
762 return r;
763 }
764
765 *consoles = con;
766 con = NULL;
767 return 0;
768}
769
288a74cc
RC
770bool tty_is_vc_resolve(const char *tty) {
771 _cleanup_free_ char *active = NULL;
772
773 assert(tty);
774
775 if (startswith(tty, "/dev/"))
776 tty += 5;
777
778 if (streq(tty, "console")) {
779 tty = resolve_dev_console(&active);
780 if (!tty)
781 return false;
782 }
783
784 return tty_is_vc(tty);
785}
786
787const char *default_term_for_tty(const char *tty) {
1e22b5cd 788 return tty && tty_is_vc_resolve(tty) ? "TERM=linux" : "TERM=vt220";
288a74cc
RC
789}
790
791int fd_columns(int fd) {
792 struct winsize ws = {};
793
794 if (ioctl(fd, TIOCGWINSZ, &ws) < 0)
795 return -errno;
796
797 if (ws.ws_col <= 0)
798 return -EIO;
799
800 return ws.ws_col;
801}
802
803unsigned columns(void) {
804 const char *e;
805 int c;
806
807 if (_likely_(cached_columns > 0))
808 return cached_columns;
809
810 c = 0;
811 e = getenv("COLUMNS");
812 if (e)
813 (void) safe_atoi(e, &c);
814
815 if (c <= 0)
816 c = fd_columns(STDOUT_FILENO);
817
818 if (c <= 0)
819 c = 80;
820
821 cached_columns = c;
822 return cached_columns;
823}
824
825int fd_lines(int fd) {
826 struct winsize ws = {};
827
828 if (ioctl(fd, TIOCGWINSZ, &ws) < 0)
829 return -errno;
830
831 if (ws.ws_row <= 0)
832 return -EIO;
833
834 return ws.ws_row;
835}
836
837unsigned lines(void) {
838 const char *e;
839 int l;
840
841 if (_likely_(cached_lines > 0))
842 return cached_lines;
843
844 l = 0;
845 e = getenv("LINES");
846 if (e)
847 (void) safe_atoi(e, &l);
848
849 if (l <= 0)
850 l = fd_lines(STDOUT_FILENO);
851
852 if (l <= 0)
853 l = 24;
854
855 cached_lines = l;
856 return cached_lines;
857}
858
859/* intended to be used as a SIGWINCH sighandler */
860void columns_lines_cache_reset(int signum) {
861 cached_columns = 0;
862 cached_lines = 0;
863}
864
865bool on_tty(void) {
866 static int cached_on_tty = -1;
867
868 if (_unlikely_(cached_on_tty < 0))
869 cached_on_tty = isatty(STDOUT_FILENO) > 0;
870
871 return cached_on_tty;
872}
873
874int make_stdio(int fd) {
875 int r, s, t;
876
877 assert(fd >= 0);
878
879 r = dup2(fd, STDIN_FILENO);
880 s = dup2(fd, STDOUT_FILENO);
881 t = dup2(fd, STDERR_FILENO);
882
883 if (fd >= 3)
884 safe_close(fd);
885
886 if (r < 0 || s < 0 || t < 0)
887 return -errno;
888
889 /* Explicitly unset O_CLOEXEC, since if fd was < 3, then
890 * dup2() was a NOP and the bit hence possibly set. */
913f38e4 891 stdio_unset_cloexec();
288a74cc
RC
892
893 return 0;
894}
895
896int make_null_stdio(void) {
897 int null_fd;
898
899 null_fd = open("/dev/null", O_RDWR|O_NOCTTY);
900 if (null_fd < 0)
901 return -errno;
902
903 return make_stdio(null_fd);
904}
905
906int getttyname_malloc(int fd, char **ret) {
907 size_t l = 100;
908 int r;
909
910 assert(fd >= 0);
911 assert(ret);
912
913 for (;;) {
914 char path[l];
915
916 r = ttyname_r(fd, path, sizeof(path));
917 if (r == 0) {
918 const char *p;
919 char *c;
920
921 p = startswith(path, "/dev/");
922 c = strdup(p ?: path);
923 if (!c)
924 return -ENOMEM;
925
926 *ret = c;
927 return 0;
928 }
929
930 if (r != ERANGE)
931 return -r;
932
933 l *= 2;
934 }
935
936 return 0;
937}
938
939int getttyname_harder(int fd, char **r) {
940 int k;
941 char *s = NULL;
942
943 k = getttyname_malloc(fd, &s);
944 if (k < 0)
945 return k;
946
947 if (streq(s, "tty")) {
948 free(s);
949 return get_ctty(0, NULL, r);
950 }
951
952 *r = s;
953 return 0;
954}
955
956int get_ctty_devnr(pid_t pid, dev_t *d) {
957 int r;
958 _cleanup_free_ char *line = NULL;
959 const char *p;
960 unsigned long ttynr;
961
962 assert(pid >= 0);
963
964 p = procfs_file_alloca(pid, "stat");
965 r = read_one_line_file(p, &line);
966 if (r < 0)
967 return r;
968
969 p = strrchr(line, ')');
970 if (!p)
971 return -EIO;
972
973 p++;
974
975 if (sscanf(p, " "
976 "%*c " /* state */
977 "%*d " /* ppid */
978 "%*d " /* pgrp */
979 "%*d " /* session */
980 "%lu ", /* ttynr */
981 &ttynr) != 1)
982 return -EIO;
983
984 if (major(ttynr) == 0 && minor(ttynr) == 0)
cfeaa44a 985 return -ENXIO;
288a74cc
RC
986
987 if (d)
988 *d = (dev_t) ttynr;
989
990 return 0;
991}
992
993int get_ctty(pid_t pid, dev_t *_devnr, char **r) {
994 char fn[sizeof("/dev/char/")-1 + 2*DECIMAL_STR_MAX(unsigned) + 1 + 1], *b = NULL;
995 _cleanup_free_ char *s = NULL;
996 const char *p;
997 dev_t devnr;
998 int k;
999
1000 assert(r);
1001
1002 k = get_ctty_devnr(pid, &devnr);
1003 if (k < 0)
1004 return k;
1005
1006 sprintf(fn, "/dev/char/%u:%u", major(devnr), minor(devnr));
1007
1008 k = readlink_malloc(fn, &s);
1009 if (k < 0) {
1010
1011 if (k != -ENOENT)
1012 return k;
1013
1014 /* This is an ugly hack */
1015 if (major(devnr) == 136) {
1016 if (asprintf(&b, "pts/%u", minor(devnr)) < 0)
1017 return -ENOMEM;
1018 } else {
1019 /* Probably something like the ptys which have no
1020 * symlink in /dev/char. Let's return something
1021 * vaguely useful. */
1022
1023 b = strdup(fn + 5);
1024 if (!b)
1025 return -ENOMEM;
1026 }
1027 } else {
1028 if (startswith(s, "/dev/"))
1029 p = s + 5;
1030 else if (startswith(s, "../"))
1031 p = s + 3;
1032 else
1033 p = s;
1034
1035 b = strdup(p);
1036 if (!b)
1037 return -ENOMEM;
1038 }
1039
1040 *r = b;
1041 if (_devnr)
1042 *_devnr = devnr;
1043
1044 return 0;
1045}
a07c35c3 1046
66cb2fde
LP
1047int ptsname_malloc(int fd, char **ret) {
1048 size_t l = 100;
1049
1050 assert(fd >= 0);
1051 assert(ret);
1052
1053 for (;;) {
1054 char *c;
1055
1056 c = new(char, l);
1057 if (!c)
1058 return -ENOMEM;
1059
1060 if (ptsname_r(fd, c, l) == 0) {
1061 *ret = c;
1062 return 0;
1063 }
1064 if (errno != ERANGE) {
1065 free(c);
1066 return -errno;
1067 }
1068
1069 free(c);
1070 l *= 2;
1071 }
1072}
1073
a07c35c3
LP
1074int ptsname_namespace(int pty, char **ret) {
1075 int no = -1, r;
1076
1077 /* Like ptsname(), but doesn't assume that the path is
1078 * accessible in the local namespace. */
1079
1080 r = ioctl(pty, TIOCGPTN, &no);
1081 if (r < 0)
1082 return -errno;
1083
1084 if (no < 0)
1085 return -EIO;
1086
1087 if (asprintf(ret, "/dev/pts/%i", no) < 0)
1088 return -ENOMEM;
1089
1090 return 0;
1091}
66cb2fde
LP
1092
1093int openpt_in_namespace(pid_t pid, int flags) {
1094 _cleanup_close_ int pidnsfd = -1, mntnsfd = -1, usernsfd = -1, rootfd = -1;
1095 _cleanup_close_pair_ int pair[2] = { -1, -1 };
1096 siginfo_t si;
1097 pid_t child;
1098 int r;
1099
1100 assert(pid > 0);
1101
1102 r = namespace_open(pid, &pidnsfd, &mntnsfd, NULL, &usernsfd, &rootfd);
1103 if (r < 0)
1104 return r;
1105
1106 if (socketpair(AF_UNIX, SOCK_DGRAM, 0, pair) < 0)
1107 return -errno;
1108
1109 child = fork();
1110 if (child < 0)
1111 return -errno;
1112
1113 if (child == 0) {
1114 int master;
1115
1116 pair[0] = safe_close(pair[0]);
1117
1118 r = namespace_enter(pidnsfd, mntnsfd, -1, usernsfd, rootfd);
1119 if (r < 0)
1120 _exit(EXIT_FAILURE);
1121
1122 master = posix_openpt(flags|O_NOCTTY|O_CLOEXEC);
1123 if (master < 0)
1124 _exit(EXIT_FAILURE);
1125
1126 if (unlockpt(master) < 0)
1127 _exit(EXIT_FAILURE);
1128
1129 if (send_one_fd(pair[1], master, 0) < 0)
1130 _exit(EXIT_FAILURE);
1131
1132 _exit(EXIT_SUCCESS);
1133 }
1134
1135 pair[1] = safe_close(pair[1]);
1136
1137 r = wait_for_terminate(child, &si);
1138 if (r < 0)
1139 return r;
1140 if (si.si_code != CLD_EXITED || si.si_status != EXIT_SUCCESS)
1141 return -EIO;
1142
1143 return receive_one_fd(pair[0], 0);
1144}
40e1f4ea
LP
1145
1146int open_terminal_in_namespace(pid_t pid, const char *name, int mode) {
1147 _cleanup_close_ int pidnsfd = -1, mntnsfd = -1, usernsfd = -1, rootfd = -1;
1148 _cleanup_close_pair_ int pair[2] = { -1, -1 };
1149 siginfo_t si;
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 child = fork();
1161 if (child < 0)
1162 return -errno;
1163
1164 if (child == 0) {
1165 int master;
1166
1167 pair[0] = safe_close(pair[0]);
1168
1169 r = namespace_enter(pidnsfd, mntnsfd, -1, usernsfd, rootfd);
1170 if (r < 0)
1171 _exit(EXIT_FAILURE);
1172
1173 master = open_terminal(name, mode|O_NOCTTY|O_CLOEXEC);
1174 if (master < 0)
1175 _exit(EXIT_FAILURE);
1176
1177 if (send_one_fd(pair[1], master, 0) < 0)
1178 _exit(EXIT_FAILURE);
1179
1180 _exit(EXIT_SUCCESS);
1181 }
1182
1183 pair[1] = safe_close(pair[1]);
1184
1185 r = wait_for_terminate(child, &si);
1186 if (r < 0)
1187 return r;
1188 if (si.si_code != CLD_EXITED || si.si_status != EXIT_SUCCESS)
1189 return -EIO;
1190
1191 return receive_one_fd(pair[0], 0);
1192}
40c9fe4c 1193
ac96418b
LP
1194bool terminal_is_dumb(void) {
1195 const char *e;
1196
1197 if (!on_tty())
1198 return true;
1199
1200 e = getenv("TERM");
1201 if (!e)
1202 return true;
1203
1204 return streq(e, "dumb");
1205}
1206
40c9fe4c 1207bool colors_enabled(void) {
ae5b3958 1208 static int enabled = -1;
40c9fe4c 1209
ae5b3958
ZJS
1210 if (_unlikely_(enabled < 0)) {
1211 const char *colors;
1212
1213 colors = getenv("SYSTEMD_COLORS");
1214 if (colors)
1215 enabled = parse_boolean(colors) != 0;
ae5b3958 1216 else
ac96418b 1217 enabled = !terminal_is_dumb();
40c9fe4c
JS
1218 }
1219
ae5b3958 1220 return enabled;
40c9fe4c 1221}